@graphprotocol/hypergraph 0.3.0 → 0.4.0

package/src/mapping/Mapping.ts

@@ -10,30 +10,30 @@ import { namesAreUnique, toCamelCase, toPascalCase } from './Utils.js';
  */
 export type MappingEntry = {
   /**
-   * Array of the `Id.Id` of the type in the Knowledge Graph.
+   * Array of the `Id` of the type in the Knowledge Graph.
    * Is an array because a type can belong to multiple spaces/extend multiple types.
    *
    * @since 0.2.0
    */
-  typeIds: Array<Grc20Id.Id>;
+  typeIds: Array<Grc20Id>;
   /**
-   * Record of property names to the `Id.Id` of the type in the Knowledge Graph
+   * Record of property names to the `Id` of the type in the Knowledge Graph
    *
    * @since 0.2.0
    */
   properties?:
     | {
-        [key: string]: Grc20Id.Id;
+        [key: string]: Grc20Id;
       }
     | undefined;
   /**
-   * Record of relation properties to the `Id.Id` of the type in the Knowledge Graph
+   * Record of relation properties to the `Id` of the type in the Knowledge Graph
    *
    * @since 0.2.0
    */
   relations?:
     | {
-        [key: string]: Grc20Id.Id;
+        [key: string]: Grc20Id;
       }
     | undefined;
 };
@@ -46,20 +46,20 @@ export type MappingEntry = {
  *
  * const mapping: Mapping = {
  *   Account: {
- *     typeIds: [Id.Id('a5fd07b1-120f-46c6-b46f-387ef98396a6')],
+ *     typeIds: [Id('a5fd07b1-120f-46c6-b46f-387ef98396a6')],
  *     properties: {
- *       username: Id.Id('994edcff-6996-4a77-9797-a13e5e3efad8'),
- *       createdAt: Id.Id('64bfba51-a69b-4746-be4b-213214a879fe')
+ *       username: Id('994edcff-6996-4a77-9797-a13e5e3efad8'),
+ *       createdAt: Id('64bfba51-a69b-4746-be4b-213214a879fe')
  *     }
  *   },
  *   Event: {
- *     typeIds: [Id.Id('0349187b-526f-435f-b2bb-9e9caf23127a')],
+ *     typeIds: [Id('0349187b-526f-435f-b2bb-9e9caf23127a')],
  *     properties: {
- *       name: Id.Id('3808e060-fb4a-4d08-8069-35b8c8a1902b'),
- *       description: Id.Id('1f0d9007-8da2-4b28-ab9f-3bc0709f4837'),
+ *       name: Id('3808e060-fb4a-4d08-8069-35b8c8a1902b'),
+ *       description: Id('1f0d9007-8da2-4b28-ab9f-3bc0709f4837'),
  *     },
  *     relations: {
- *       speaker: Id.Id('a5fd07b1-120f-46c6-b46f-387ef98396a6')
+ *       speaker: Id('a5fd07b1-120f-46c6-b46f-387ef98396a6')
  *     }
  *   }
  * }
@@ -99,6 +99,12 @@ export const SchemaDataTypePrimitive = EffectSchema.Literal('String', 'Number',
  * @since 0.2.0
  */
 export type SchemaDataTypePrimitive = typeof SchemaDataTypePrimitive.Type;
+/**
+ * @since 0.4.0
+ */
+export function isDataTypePrimitive(val: string): val is SchemaDataTypePrimitive {
+  return ['String', 'Number', 'Boolean', 'Date', 'Point'].includes(val);
+}
 /**
  * @since 0.2.0
  */
@@ -107,6 +113,22 @@ export const SchemaDataType = EffectSchema.Union(SchemaDataTypePrimitive, Schema
  * @since 0.2.0
  */
 export type SchemaDataType = typeof SchemaDataType.Type;
+/**
+ * @since 0.4.0
+ */
+export function isDataType(val: string): val is SchemaDataType {
+  return isDataTypePrimitive(val) || isDataTypeRelation(val);
+}
+/**
+ * @since 0.4.0
+ */
+export function getDataType(val: string): SchemaDataType {
+  const dataType = isDataTypePrimitive(val) || isDataTypeRelation(val);
+  if (dataType) {
+    return val;
+  }
+  throw new Error(`Passed dataType ${val} is not supported`);
+}
 /**
  * @since 0.2.0
  */
@@ -238,7 +260,7 @@ export const SchemaUnknownDecoder = EffectSchema.decodeUnknownSync(Schema);
  *     properties: [
  *       {
  *         name: "username",
- *         dataType: "Text",
+ *         dataType: "String",
  *         knowledgeGraphId: null
  *       }
  *     ]
@@ -297,8 +319,8 @@ export function allRelationPropertyTypesExist(types: ReadonlyArray<SchemaType>):
 export type GenerateMappingResult = [mapping: Mapping, ops: ReadonlyArray<Op>];
 
 // Helper types for internal processing
-type PropertyIdMapping = { propName: string; id: Grc20Id.Id };
-type TypeIdMapping = Map<string, Grc20Id.Id | null>;
+type PropertyIdMapping = { propName: string; id: Grc20Id };
+type TypeIdMapping = Map<string, Grc20Id | null>;
 type ProcessedProperty =
   | { type: 'resolved'; mapping: PropertyIdMapping; ops: Array<Op> }
   | { type: 'deferred'; property: SchemaTypePropertyRelation };
@@ -342,7 +364,7 @@ function createPropertyWithOps(
   if (property.knowledgeGraphId) {
     return {
       type: 'resolved',
-      mapping: { propName: property.name, id: Grc20Id.Id(property.knowledgeGraphId) },
+      mapping: { propName: property.name, id: Grc20Id(property.knowledgeGraphId) },
       ops: [],
     };
   }
@@ -421,7 +443,7 @@ function processType(type: SchemaType, typeIdMap: TypeIdMapping): ProcessedType
   if (type.knowledgeGraphId) {
     const entry: MappingEntry & { typeName: string } = {
       typeName: toPascalCase(type.name),
-      typeIds: [Grc20Id.Id(type.knowledgeGraphId)],
+      typeIds: [Grc20Id(type.knowledgeGraphId)],
     };
 
     if (EffectArray.isNonEmptyArray(primitiveProperties)) {
@@ -487,7 +509,7 @@ function processType(type: SchemaType, typeIdMap: TypeIdMapping): ProcessedType
  * @example
  * ```ts
  * import { Id } from "@graphprotocol/grc-20"
- * import { generateMapping } from "@graphprotocol/typesync"
+ * import { generateMapping } from "@graphprotocol/hypergraph"
  *
  * const schema: Schema = {
  *   types: [
@@ -497,7 +519,7 @@ function processType(type: SchemaType, typeIdMap: TypeIdMapping): ProcessedType
  *       properties: [
  *         {
  *           name: "username",
- *           dataType: "Text",
+ *           dataType: "String",
  *           knowledgeGraphId: "994edcff-6996-4a77-9797-a13e5e3efad8"
  *         },
  *         {
@@ -513,12 +535,12 @@ function processType(type: SchemaType, typeIdMap: TypeIdMapping): ProcessedType
  *       properties: [
  *         {
  *           name: "name",
- *           dataType: "Text",
+ *           dataType: "String",
  *           knowledgeGraphId: "3808e060-fb4a-4d08-8069-35b8c8a1902b"
  *         },
  *         {
  *           name: "description",
- *           dataType: "Text",
+ *           dataType: "String",
  *           knowledgeGraphId: null
  *         },
  *         {
@@ -535,20 +557,20 @@ function processType(type: SchemaType, typeIdMap: TypeIdMapping): ProcessedType
  *
  * expect(mapping).toEqual({
  *   Account: {
- *     typeIds: [Id.Id("a5fd07b1-120f-46c6-b46f-387ef98396a6")], // comes from input schema
+ *     typeIds: [Id("a5fd07b1-120f-46c6-b46f-387ef98396a6")], // comes from input schema
  *     properties: {
- *       username: Id.Id("994edcff-6996-4a77-9797-a13e5e3efad8"), // comes from input schema
- *       createdAt: Id.Id("8cd7d9ac-a878-4287-8000-e71e6f853117"), // generated from Graph.createProperty Op
+ *       username: Id("994edcff-6996-4a77-9797-a13e5e3efad8"), // comes from input schema
+ *       createdAt: Id("8cd7d9ac-a878-4287-8000-e71e6f853117"), // generated from Graph.createProperty Op
  *     }
  *   },
  *   Event: {
- *     typeIds: [Id.Id("20b3fe39-8e62-41a0-b9cb-92743fd760da")], // generated from Graph.createType Op
+ *     typeIds: [Id("20b3fe39-8e62-41a0-b9cb-92743fd760da")], // generated from Graph.createType Op
  *     properties: {
- *       name: Id.Id("3808e060-fb4a-4d08-8069-35b8c8a1902b"), // comes from input schema
- *       description: Id.Id("8fc4e17c-7581-4d6c-a712-943385afc7b5"), // generated from Graph.createProperty Op
+ *       name: Id("3808e060-fb4a-4d08-8069-35b8c8a1902b"), // comes from input schema
+ *       description: Id("8fc4e17c-7581-4d6c-a712-943385afc7b5"), // generated from Graph.createProperty Op
  *     },
  *     relations: {
- *       speaker: Id.Id("651ce59f-643b-4931-bf7a-5dc0ca0f5a47"), // generated from Graph.createProperty Op
+ *       speaker: Id("651ce59f-643b-4931-bf7a-5dc0ca0f5a47"), // generated from Graph.createProperty Op
  *     }
  *   }
  * })
@@ -557,23 +579,23 @@ function processType(type: SchemaType, typeIdMap: TypeIdMapping): ProcessedType
  *   {
  *     type: "CREATE_PROPERTY",
  *     property: {
- *       id: Id.Id("8cd7d9ac-a878-4287-8000-e71e6f853117"),
- *       dataType: "TEXT"
+ *       id: Id("8cd7d9ac-a878-4287-8000-e71e6f853117"),
+ *       dataType: "String"
  *     }
  *   },
  *   // Graph.createProperty Op for Event.description property
  *   {
  *     type: "CREATE_PROPERTY",
  *     property: {
- *       id: Id.Id("8fc4e17c-7581-4d6c-a712-943385afc7b5"),
- *       dataType: "TEXT"
+ *       id: Id("8fc4e17c-7581-4d6c-a712-943385afc7b5"),
+ *       dataType: "String"
  *     }
  *   },
  *   // Graph.createProperty Op for Event.speaker property
  *   {
  *     type: "CREATE_PROPERTY",
  *     property: {
- *       id: Id.Id("651ce59f-643b-4931-bf7a-5dc0ca0f5a47"),
+ *       id: Id("651ce59f-643b-4931-bf7a-5dc0ca0f5a47"),
  *       dataType: "RELATION"
  *     }
  *   },
@@ -581,7 +603,7 @@ function processType(type: SchemaType, typeIdMap: TypeIdMapping): ProcessedType
  *   {
  *     type: "CREATE_PROPERTY",
  *     property: {
- *       id: Id.Id("651ce59f-643b-4931-bf7a-5dc0ca0f5a47"),
+ *       id: Id("651ce59f-643b-4931-bf7a-5dc0ca0f5a47"),
  *       dataType: "RELATION"
  *     }
  *   },
@@ -600,8 +622,8 @@ export function generateMapping(input: Schema): GenerateMappingResult {
   // Build initial type ID map
   const typeIdMap: TypeIdMapping = pipe(
     schema.types,
-    EffectArray.reduce(new Map<string, Grc20Id.Id | null>(), (map, type) =>
-      map.set(type.name, type.knowledgeGraphId != null ? Grc20Id.Id(type.knowledgeGraphId) : null),
+    EffectArray.reduce(new Map<string, Grc20Id | null>(), (map, type) =>
+      map.set(type.name, type.knowledgeGraphId != null ? Grc20Id(type.knowledgeGraphId) : null),
     ),
   );
 
@@ -750,7 +772,7 @@ export class RelationValueTypeDoesNotExistError extends Data.TaggedError(
 export function mapSchemaDataTypeToGRC20PropDataType(dataType: SchemaDataType): CreatePropertyParams['dataType'] {
   switch (true) {
     case dataType === 'Boolean': {
-      return 'CHECKBOX';
+      return 'BOOLEAN';
     }
     case dataType === 'Date': {
       return 'TIME';
@@ -765,7 +787,7 @@ export function mapSchemaDataTypeToGRC20PropDataType(dataType: SchemaDataType):
       return 'RELATION';
     }
     default: {
-      return 'TEXT';
+      return 'STRING';
     }
   }
 }