Added SHA1 value type support (#92)

* added autonumber support

* added uuid

* changed switch

* added tests

* added sha1

* fixed tests

* fixed sha1

* removed empty line

* updated README

Author: Denis Gursky

README.md

@@ -112,6 +112,9 @@ their corresponding JavaScript equivalents. Full mapping:
 | Bool                                                       | boolean                                              |
 | FilePos                                                    | bigint                                               |
 | Missing                                                    | null                                                 |
+| AutoNumber                                                 | bigint                                               |
+| UUID                                                       | string                                               |
+| SHA1                                                       | string                                               |
 
 ## Support
 

src/results/resultUtils.ts

@@ -272,6 +272,11 @@ export function convertValue<T extends RelTypedValue>(
     }
     case 'UUID':
       return toUuid(Array.from(value));
+    case 'SHA1': {
+      const val = value.toArray ? value.toArray() : value;
+
+      return toSha1(Array.from(val[0]), val[1]);
+    }
     case 'Unknown':
       return value && value.toJSON ? value.toJSON() : value;
   }
@@ -300,6 +305,7 @@ export function getDisplayValue(
   switch (val.type) {
     case 'String':
     case 'UUID':
+    case 'SHA1':
       return JSON.stringify(val.value);
     case 'Bool':
       return val.value ? 'true' : 'false';
@@ -415,7 +421,6 @@ function uint128ToBigInt(tuple: bigint[]) {
 
 function toUuid(tuple: bigint[]) {
   const num = uint128ToBigInt(tuple);
-
   const str = num.toString(16).padStart(32, '0');
   const parts = [
     str.slice(0, 8),
@@ -428,6 +433,13 @@ function toUuid(tuple: bigint[]) {
   return parts.join('-');
 }
 
+function toSha1(a: bigint[], b: Number) {
+  return (
+    uint128ToBigInt(a).toString(16).padStart(32, '0') +
+    b.toString(16).padStart(8, '0')
+  );
+}
+
 function mapPrimitiveValue(val: PrimitiveValue) {
   switch (val.value.oneofKind) {
     case 'stringVal':
@@ -501,6 +513,7 @@ function mapValueType(typeDef: Omit<ValueTypeValue, 'value'>): RelTypeDef {
     case 'Hash':
     case 'AutoNumber':
     case 'UUID':
+    case 'SHA1':
       return {
         type: standardValueType,
       };
@@ -592,7 +605,8 @@ function unflattenConstantValue(typeDef: RelTypeDef, value: PrimitiveValue[]) {
       case 'Rational32':
       case 'Rational64':
       case 'Rational128':
-        // Rationals take 2 values
+      case 'SHA1':
+        // These types take 2 values
         result.push(values.splice(0, 2));
         break;
       default: {

src/results/tests.ts

@@ -604,6 +604,20 @@ export const standardTypeTests: Test[] = [
     values: ['22b4a8a1-e548-4eeb-9270-60426d66a48e'],
     displayValues: ['"22b4a8a1-e548-4eeb-9270-60426d66a48e"'],
   },
+  {
+    name: 'SHA1',
+    query: `
+      with rel:base use ^SHA1
+      def output = ^SHA1[0x0d7d4a744fd92effd1ed88e48ac8231e, 0x7f7e9e6c]
+    `,
+    typeDefs: [
+      {
+        type: 'SHA1',
+      },
+    ],
+    values: ['0d7d4a744fd92effd1ed88e48ac8231e7f7e9e6c'],
+    displayValues: ['"0d7d4a744fd92effd1ed88e48ac8231e7f7e9e6c"'],
+  },
 ];
 
 export const specializationTests: Test[] = [
@@ -1439,6 +1453,25 @@ export const specializationTests: Test[] = [
     values: ['22b4a8a1-e548-4eeb-9270-60426d66a48e'],
     displayValues: ['"22b4a8a1-e548-4eeb-9270-60426d66a48e"'],
   },
+  {
+    name: 'SHA1',
+    query: `
+      with rel:base use ^SHA1
+      def v = ^SHA1[0x0d7d4a744fd92effd1ed88e48ac8231e, 0x7f7e9e6c]
+      def output = #(v)
+    `,
+    typeDefs: [
+      {
+        type: 'Constant',
+        value: {
+          type: 'SHA1',
+          value: '0d7d4a744fd92effd1ed88e48ac8231e7f7e9e6c',
+        },
+      },
+    ],
+    values: ['0d7d4a744fd92effd1ed88e48ac8231e7f7e9e6c'],
+    displayValues: ['"0d7d4a744fd92effd1ed88e48ac8231e7f7e9e6c"'],
+  },
 ];
 
 export const valueTypeTests: Test[] = [
@@ -2619,6 +2652,34 @@ export const valueTypeTests: Test[] = [
     values: [[':MyType', 1n, '22b4a8a1-e548-4eeb-9270-60426d66a48e']],
     displayValues: ['(:MyType, 1, "22b4a8a1-e548-4eeb-9270-60426d66a48e")'],
   },
+  {
+    name: 'SHA1',
+    query: `
+      with rel:base use ^SHA1, SHA1
+      def sha1 = ^SHA1[0x0d7d4a744fd92effd1ed88e48ac8231e, 0x7f7e9e6c]
+      value type MyType = Int, SHA1
+      def output = ^MyType[1, sha1]
+    `,
+    typeDefs: [
+      {
+        type: 'ValueType',
+        typeDefs: [
+          {
+            type: 'Constant',
+            value: { type: 'String', value: ':MyType' },
+          },
+          {
+            type: 'Int64',
+          },
+          {
+            type: 'SHA1',
+          },
+        ],
+      },
+    ],
+    values: [[':MyType', 1n, '0d7d4a744fd92effd1ed88e48ac8231e7f7e9e6c']],
+    displayValues: ['(:MyType, 1, "0d7d4a744fd92effd1ed88e48ac8231e7f7e9e6c")'],
+  },
 ];
 
 export const miscValueTypeTests: Test[] = [
@@ -4200,4 +4261,37 @@ export const valueTypeSpecializationTests: Test[] = [
     values: [[':MyType', '22b4a8a1-e548-4eeb-9270-60426d66a48e', 1n]],
     displayValues: ['(:MyType, "22b4a8a1-e548-4eeb-9270-60426d66a48e", 1)'],
   },
+  {
+    name: 'SHA1',
+    query: `
+      with rel:base use ^SHA1, SHA1
+      def sha1 = ^SHA1[0x0d7d4a744fd92effd1ed88e48ac8231e, 0x7f7e9e6c]
+      value type MyType = SHA1, Int
+      def v = ^MyType[sha1, 1]
+      def output = #(v)
+    `,
+    typeDefs: [
+      {
+        type: 'Constant',
+        value: {
+          type: 'ValueType',
+          typeDefs: [
+            {
+              type: 'Constant',
+              value: { type: 'String', value: ':MyType' },
+            },
+            {
+              type: 'SHA1',
+            },
+            {
+              type: 'Int64',
+            },
+          ],
+          value: [':MyType', '0d7d4a744fd92effd1ed88e48ac8231e7f7e9e6c', 1n],
+        },
+      },
+    ],
+    values: [[':MyType', '0d7d4a744fd92effd1ed88e48ac8231e7f7e9e6c', 1n]],
+    displayValues: ['(:MyType, "0d7d4a744fd92effd1ed88e48ac8231e7f7e9e6c", 1)'],
+  },
 ];

src/results/types.ts

@@ -61,7 +61,8 @@ export type RelBaseTypedValue =
   | Rational64Value
   | Rational128Value
   | AutoNumber
-  | UUID;
+  | UUID
+  | SHA1;
 
 export type RelTypedValue = RelBaseTypedValue | ValueTypeValue | UnknownType;
 
@@ -108,6 +109,7 @@ export type RelTypeDef =
   | Omit<Rational128Value, 'value'>
   | Omit<AutoNumber, 'value'>
   | Omit<UUID, 'value'>
+  | Omit<SHA1, 'value'>
   | ConstantValue
   | Omit<ValueTypeValue, 'value'>
   | Omit<UnknownType, 'value'>;
@@ -352,6 +354,11 @@ export type UUID = {
   value: string;
 };
 
+export type SHA1 = {
+  type: 'SHA1';
+  value: string;
+};
+
 // TODO: should be removed with JSON based metadata implementation?
 export type UnknownType = {
   type: 'Unknown';