npm - @graphprotocol/hypergraph - Versions diffs - 0.4.2 → 0.5.0-alpha - Mend

@graphprotocol/hypergraph 0.4.2 → 0.5.0-alpha

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (52) hide show

package/dist/cli/Cli.js +1 -1
package/dist/cli/bin.js +0 -0
package/dist/cli/bin.js.map +1 -1
package/dist/cli/bun.js +0 -0
package/dist/cli/services/Model.d.ts +99 -0
package/dist/cli/services/Model.d.ts.map +1 -0
package/dist/cli/services/Model.js +52 -0
package/dist/cli/services/Model.js.map +1 -0
package/dist/cli/services/Typesync.d.ts +7 -4
package/dist/cli/services/Typesync.d.ts.map +1 -1
package/dist/cli/services/Typesync.js +106 -4
package/dist/cli/services/Typesync.js.map +1 -1
package/dist/cli/services/Utils.d.ts +81 -0
package/dist/cli/services/Utils.d.ts.map +1 -1
package/dist/cli/services/Utils.js +198 -8
package/dist/cli/services/Utils.js.map +1 -1
package/dist/cli/subcommands/typesync.d.ts +13 -2
package/dist/cli/subcommands/typesync.d.ts.map +1 -1
package/dist/cli/subcommands/typesync.js +141 -21
package/dist/cli/subcommands/typesync.js.map +1 -1
package/dist/entity/findMany.d.ts.map +1 -1
package/dist/entity/findMany.js +21 -13
package/dist/entity/findMany.js.map +1 -1
package/dist/entity/types.d.ts +0 -6
package/dist/entity/types.d.ts.map +1 -1
package/dist/index.d.ts +1 -0
package/dist/index.d.ts.map +1 -1
package/dist/index.js +1 -0
package/dist/index.js.map +1 -1
package/dist/mapping/Mapping.d.ts +24 -12
package/dist/mapping/Mapping.d.ts.map +1 -1
package/dist/mapping/Mapping.js +12 -4
package/dist/mapping/Mapping.js.map +1 -1
package/dist/typesync-studio/dist/assets/authenticate-callback-XTxFqKgn.js +1 -0
package/dist/typesync-studio/dist/assets/ccip-_s3urR1L.js +1 -0
package/dist/typesync-studio/dist/assets/index-B-tctDXW.js +88 -0
package/dist/typesync-studio/dist/assets/index-BHBkzpXd.css +1 -0
package/dist/typesync-studio/dist/assets/index-bioTPE3q.js +215 -0
package/dist/typesync-studio/dist/index.html +30 -0
package/dist/typesync-studio/dist/manifest.json +20 -0
package/dist/typesync-studio/dist/robots.txt +3 -0
package/package.json +9 -8
package/src/cli/Cli.ts +1 -1
package/src/cli/bin.ts +0 -1
package/src/cli/services/Model.ts +87 -0
package/src/cli/services/Typesync.ts +137 -9
package/src/cli/services/Utils.ts +231 -11
package/src/cli/subcommands/typesync.ts +251 -42
package/src/entity/findMany.ts +27 -15
package/src/entity/types.ts +0 -6
package/src/index.ts +1 -0
package/src/mapping/Mapping.ts +21 -6

package/dist/typesync-studio/dist/index.html ADDED Viewed

@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html
+  lang="en"
+  class="h-full min-h-screen w-full p-0 m-0 dark:bg-slate-950 dark:text-white bg-white text-gray-950 font-mono"
+>
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <link
+      rel="icon"
+      type="image/png"
+      sizes="64x64"
+      href="https://storage.thegraph.com/favicons/64x64.png"
+    />
+    <link
+      rel="icon"
+      type="image/png"
+      sizes="256x256"
+      href="https://storage.thegraph.com/favicons/256x256.png"
+    />
+    <title>Graph Protocol | Hypergraph TypeSync</title>
+    <link rel="preconnect" href="https://fonts.googleapis.com" />
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
+    <script type="module" crossorigin src="/assets/index-bioTPE3q.js"></script>
+    <link rel="stylesheet" crossorigin href="/assets/index-BHBkzpXd.css">
+  </head>
+  <body class="h-full w-full">
+    <div id="root"></div>
+  </body>
+</html>

package/dist/typesync-studio/dist/manifest.json ADDED Viewed

@@ -0,0 +1,20 @@
+{
+  "short_name": "Hypergraph Typesync Studio",
+  "name": "Graph Protocol Hypergraph Typesync Studio",
+  "icons": [
+    {
+      "src": "https://storage.thegraph.com/favicons/64x64.png",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/png"
+    },
+    {
+      "src": "https://storage.thegraph.com/favicons/256x256.png",
+      "type": "image/png",
+      "sizes": "256x256"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}

package/dist/typesync-studio/dist/robots.txt ADDED Viewed

@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow:

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/hypergraph",
-  "version": "0.4.2",
+  "version": "0.5.0-alpha",
   "description": "SDK for building performant, type-safe, local-first dapps on top of The Graph ecosystem knowledge graphs.",
   "repository": {
     "type": "git",
@@ -28,12 +28,13 @@
     "./space-info": "./dist/space-info/index.js",
     "./store": "./dist/store.js",
     "./store-connect": "./dist/store-connect.js",
-    "./types": "./dist/types.js"
+    "./types": "./dist/types.js",
+    "./typesync": "./dist/cli/services/Model.js"
   },
   "dependencies": {
-    "@automerge/automerge": "^2.2.9",
-    "@automerge/automerge-repo": "^2.0.6",
-    "@effect/experimental": "^0.51.1",
+    "@automerge/automerge": "^3.1.1",
+    "@automerge/automerge-repo": "^2.2.0",
+    "@effect/experimental": "^0.54.3",
     "@graphprotocol/grc-20": "^0.24.1",
     "@noble/ciphers": "^1.3.0",
     "@noble/curves": "^1.9.0",
@@ -43,15 +44,15 @@
     "@serenity-kit/noble-sodium": "^0.2.1",
     "@xstate/store": "^3.5.1",
     "bs58check": "^4.0.0",
-    "effect": "^3.17.3",
+    "effect": "^3.17.6",
     "permissionless": "^0.2.47",
     "siwe": "^3.0.0",
     "uuid": "^11.1.0",
     "viem": "^2.30.6"
   },
   "bin": {
-    "hypergraph": "./dist/cli/bin.js",
-    "hg": "./dist/cli/bin.js"
+    "hypergraph": "./dist/cli/bun.js",
+    "hg": "./dist/cli/bun.js"
   },
   "publishConfig": {
     "provenance": false

package/src/cli/Cli.ts CHANGED Viewed

@@ -11,5 +11,5 @@ const hypergraph = Command.make('hypergraph').pipe(
 export const run = Command.run(hypergraph, {
   name: 'hypergraph',
-  version: '0.3.0',
+  version: '0.4.2',
 });

package/src/cli/bin.ts CHANGED Viewed

@@ -6,7 +6,6 @@ import * as AnsiDoc from '@effect/printer-ansi/AnsiDoc';
 import * as Effect from 'effect/Effect';
 import * as Logger from 'effect/Logger';
 import * as LogLevel from 'effect/LogLevel';
 import { run } from './Cli.js';
 import { AnsiDocLogger } from './Logger.js';

package/src/cli/services/Model.ts ADDED Viewed

@@ -0,0 +1,87 @@
+import { Schema } from 'effect';
+import * as Mapping from '../../mapping/Mapping.js';
+import * as Utils from '../../mapping/Utils.js';
+export const TypesyncHypergraphSchemaStatus = Schema.NullOr(
+  Schema.Literal(
+    // the type/property has been synced to the schema file and published to the Knowledge Graph
+    'published',
+    // the type/property has been synced to the schema file, but requires publishing to the Knowledge Graph
+    'synced',
+    // the type/property exists in the Knowledge Graph, has been added to the users schema through the Typesync UI, but requires syncing to the schema file
+    'published_not_synced',
+  ),
+);
+export type TypesyncHypergraphSchemaStatus = typeof TypesyncHypergraphSchemaStatus.Type;
+export const TypesyncHypergraphSchemaTypeProperty = Schema.Union(
+  Mapping.SchemaTypePropertyPrimitive,
+  Mapping.SchemaTypePropertyRelation,
+).pipe(
+  Schema.extend(
+    Schema.Struct({
+      status: TypesyncHypergraphSchemaStatus,
+    }),
+  ),
+);
+export type TypesyncHypergraphSchemaTypeProperty = typeof TypesyncHypergraphSchemaTypeProperty.Type;
+export class TypesyncHypergraphSchemaType extends Schema.Class<TypesyncHypergraphSchemaType>(
+  '/Hypergraph/cli/models/TypesyncHypergraphSchemaType',
+)({
+  ...Mapping.SchemaType.omit('properties').fields,
+  status: TypesyncHypergraphSchemaStatus,
+  properties: Schema.Array(TypesyncHypergraphSchemaTypeProperty).pipe(
+    Schema.minItems(1),
+    Schema.filter(Utils.namesAreUnique, {
+      identifier: 'DuplicatePropertyNames',
+      jsonSchema: {},
+      description: 'The property.name must be unique across all properties in the type',
+    }),
+  ),
+}) {}
+export class TypesyncHypergraphSchema extends Schema.Class<TypesyncHypergraphSchema>(
+  '/Hypergraph/cli/models/TypesyncHypergraphSchema',
+)({
+  types: Schema.Array(TypesyncHypergraphSchemaType).pipe(
+    Schema.minItems(1),
+    Schema.filter(Utils.namesAreUnique, {
+      identifier: 'DuplicateTypeNames',
+      jsonSchema: {},
+      description: 'The type.name must be unique across all types in the schema',
+    }),
+    Schema.filter(Mapping.allRelationPropertyTypesExist, {
+      identifier: 'AllRelationTypesExist',
+      jsonSchema: {},
+      description: 'Each type property of dataType RELATION must have a type of the same name in the schema',
+    }),
+  ),
+}) {}
+/**
+ * Extending the hypergraph [Mapping definition](../../mapping/Mapping.ts) to make it an effect Schema instance.
+ * Allows decoding as well as passing in the api request payload
+ */
+export const TypesyncHypergraphMapping = Schema.Record({
+  key: Schema.NonEmptyTrimmedString,
+  value: Schema.Struct({
+    typeIds: Schema.Array(Schema.UUID).pipe(Schema.minItems(1)),
+    properties: Schema.optional(
+      Schema.UndefinedOr(
+        Schema.Record({
+          key: Schema.NonEmptyTrimmedString,
+          value: Schema.UUID,
+        }),
+      ),
+    ),
+    relations: Schema.optional(
+      Schema.UndefinedOr(
+        Schema.Record({
+          key: Schema.NonEmptyTrimmedString,
+          value: Schema.UUID,
+        }),
+      ),
+    ),
+  }),
+});
+export type TypesyncHypergraphMapping = typeof TypesyncHypergraphMapping.Type;

package/src/cli/services/Typesync.ts CHANGED Viewed

@@ -1,21 +1,32 @@
-import { FileSystem, Path } from '@effect/platform';
+import { FileSystem, KeyValueStore, Path } from '@effect/platform';
 import { NodeFileSystem } from '@effect/platform-node';
 import { AnsiDoc } from '@effect/printer-ansi';
 import { Cause, Data, Effect, Array as EffectArray, Option, Stream } from 'effect';
 import type { NonEmptyReadonlyArray } from 'effect/Array';
-import type { Schema as HypergraphSchema, Mapping } from '../../mapping/Mapping.js';
-import { parseHypergraphMapping, parseSchema } from './Utils.js';
+import { type Mapping, propertyIsRelation } from '../../mapping/Mapping.js';
+import { toCamelCase, toPascalCase } from '../../mapping/Utils.js';
+import {
+  type TypesyncHypergraphMapping,
+  TypesyncHypergraphSchema,
+  TypesyncHypergraphSchemaType,
+  type TypesyncHypergraphSchemaTypeProperty,
+} from './Model.js';
+import { buildMappingFile, buildSchemaFile, parseHypergraphMapping, parseSchema } from './Utils.js';
 export class TypesyncSchemaStreamBuilder extends Effect.Service<TypesyncSchemaStreamBuilder>()(
   '/Hypergraph/cli/services/TypesyncSchemaStreamBuilder',
   {
-    dependencies: [NodeFileSystem.layer],
+    dependencies: [NodeFileSystem.layer, KeyValueStore.layerMemory],
     effect: Effect.gen(function* () {
       const fs = yield* FileSystem.FileSystem;
       const path = yield* Path.Path;
+      const kv = yield* KeyValueStore.KeyValueStore;
       const encoder = new TextEncoder();
+      const SCHEMA_FILE_PATH_STORAGE_KEY = 'SCHEMA_FILE_PATH';
+      const MAPPING_FILE_PATH_STORAGE_KEY = 'MAPPING_FILE_PATH';
       const schemaCandidates = (cwd = '.') =>
         EffectArray.make(
           path.resolve(cwd, 'schema.ts'),
@@ -81,7 +92,7 @@ export class TypesyncSchemaStreamBuilder extends Effect.Service<TypesyncSchemaSt
       const currentSchemaStream = (
         schemaFilePath: Option.Option<string>,
         mappingFilePath: Option.Option<string>,
-      ): Stream.Stream<HypergraphSchema, never, never> =>
+      ): Stream.Stream<TypesyncHypergraphSchema, never, never> =>
         Stream.fromEffect(
           Effect.gen(function* () {
             const schema = yield* Option.match(schemaFilePath, {
@@ -102,7 +113,7 @@ export class TypesyncSchemaStreamBuilder extends Effect.Service<TypesyncSchemaSt
             ),
           ),
           // if failure, don't bubble to return and just return empty schema
-          Stream.orElseSucceed(() => ({ types: [] }) satisfies HypergraphSchema),
+          Stream.orElseSucceed(() => ({ types: [] }) satisfies TypesyncHypergraphSchema),
         );
       /**
        * Reads the schema.ts file, and maybe reads the mapping.ts file (if exists).
@@ -117,7 +128,7 @@ export class TypesyncSchemaStreamBuilder extends Effect.Service<TypesyncSchemaSt
       const watchSchemaStream = (
         schemaFilePath: Option.Option<string>,
         mappingFilePath: Option.Option<string>,
-      ): Stream.Stream<HypergraphSchema, never, never> => {
+      ): Stream.Stream<TypesyncHypergraphSchema, never, never> => {
         const schemaWatch = Option.match(schemaFilePath, {
           // @todo watch the root here so if a schema is created, it will get picked up
           onNone: () => Stream.empty,
@@ -147,7 +158,7 @@ export class TypesyncSchemaStreamBuilder extends Effect.Service<TypesyncSchemaSt
             Effect.logError(AnsiDoc.text('Failure parsing schema changes into types'), { cause: Cause.pretty(cause) }),
           ),
           // if failure, don't bubble to return and just return empty schema
-          Stream.orElseSucceed(() => ({ types: [] }) satisfies HypergraphSchema),
+          Stream.orElseSucceed(() => ({ types: [] }) satisfies TypesyncHypergraphSchema),
         );
       };
@@ -162,10 +173,17 @@ export class TypesyncSchemaStreamBuilder extends Effect.Service<TypesyncSchemaSt
               AnsiDoc.text('No Hypergraph schema file found. Searched:'),
               AnsiDoc.cats(schemaFileCandidates.map((candidate) => AnsiDoc.text(candidate))),
             );
+          } else if (Option.isSome(schemaFilePath)) {
+            // store schema file location in KeyValueStore for reference
+            yield* kv.set(SCHEMA_FILE_PATH_STORAGE_KEY, schemaFilePath.value);
           }
           // Fetch the Mapping definition from any mapping.ts in the directory.
           // If exists, use it to get the knowledgeGraphId for each type/property in the parsed schema
           const mappingFilePath = yield* findHypergraphSchema(mappingCandidates(cwd));
+          if (Option.isSome(mappingFilePath)) {
+            // store mapping file location in KeyValueStore for reference
+            yield* kv.set(MAPPING_FILE_PATH_STORAGE_KEY, mappingFilePath.value);
+          }
           return currentSchemaStream(schemaFilePath, mappingFilePath).pipe(
             Stream.concat(watchSchemaStream(schemaFilePath, mappingFilePath)),
@@ -177,7 +195,117 @@ export class TypesyncSchemaStreamBuilder extends Effect.Service<TypesyncSchemaSt
           );
         });
-      return { hypergraphSchemaStream } as const;
+      /**
+       * Write the user-submitted Hypergraph schema to the schema.ts file in the users repo.
+       *
+       * @param schema the user-submitted Hypergraph schema from the Typesync UI
+       * @returns the updated Hypergraph schema
+       */
+      const syncSchema = (schema: TypesyncHypergraphSchema) =>
+        Effect.gen(function* () {
+          const cwd = process.cwd();
+          const schemaFilePath = yield* kv
+            .get(SCHEMA_FILE_PATH_STORAGE_KEY)
+            .pipe(Effect.map(Option.getOrElse(() => path.join(cwd, 'src', 'schema.ts'))));
+          // update schema file with updated content from the typesync studio UI
+          yield* fs.writeFileString(schemaFilePath, buildSchemaFile(schema));
+          return TypesyncHypergraphSchema.make({
+            types: EffectArray.map(schema.types, (type) =>
+              TypesyncHypergraphSchemaType.make({
+                name: type.name,
+                knowledgeGraphId: type.knowledgeGraphId,
+                status: type.knowledgeGraphId != null ? 'published' : 'synced',
+                properties: EffectArray.map(type.properties, (prop) => {
+                  if (propertyIsRelation(prop)) {
+                    return {
+                      name: prop.name,
+                      knowledgeGraphId: prop.knowledgeGraphId,
+                      dataType: prop.dataType,
+                      relationType: prop.relationType,
+                      status: prop.knowledgeGraphId != null ? 'published' : 'synced',
+                    } satisfies TypesyncHypergraphSchemaTypeProperty;
+                  }
+                  return {
+                    name: prop.name,
+                    knowledgeGraphId: prop.knowledgeGraphId,
+                    dataType: prop.dataType,
+                    status: prop.knowledgeGraphId != null ? 'published' : 'synced',
+                  } satisfies TypesyncHypergraphSchemaTypeProperty;
+                }),
+              }),
+            ),
+          });
+        });
+      /**
+       * Update the mapping.ts file in the users repo with the up-to-date, published to the Knowledge Graph, mapping
+       *
+       * @param schema the Hypergraph schema
+       * @param mapping the up-to-date Hypergraph Mapping with all types/properties having Id
+       * @returns the updated schema with connected knowledgeGraphIds
+       */
+      const syncMapping = (schema: TypesyncHypergraphSchema, mapping: TypesyncHypergraphMapping) =>
+        Effect.gen(function* () {
+          const cwd = process.cwd();
+          const mappingFilePath = yield* kv
+            .get(MAPPING_FILE_PATH_STORAGE_KEY)
+            .pipe(Effect.map(Option.getOrElse(() => path.join(cwd, 'src', 'mapping.ts'))));
+          // update mapping file with updated content from the typesync studio UI
+          yield* fs.writeFileString(mappingFilePath, buildMappingFile(mapping));
+          // update Schema to update with generated GRC-20 Ids for types/properties
+          return TypesyncHypergraphSchema.make({
+            types: EffectArray.map(schema.types, (type) => {
+              const mappingEntry = mapping[toPascalCase(type.name)];
+              let knowledgeGraphId = type.knowledgeGraphId;
+              if (!knowledgeGraphId) {
+                const typeKnowledgeGraphId = mappingEntry?.typeIds?.[0] ? mappingEntry.typeIds[0] : null;
+                if (typeKnowledgeGraphId) {
+                  knowledgeGraphId = typeKnowledgeGraphId;
+                }
+              }
+              return TypesyncHypergraphSchemaType.make({
+                name: type.name,
+                knowledgeGraphId,
+                status: knowledgeGraphId != null ? 'published' : 'synced',
+                properties: EffectArray.map(type.properties, (prop) => {
+                  const propName = toCamelCase(prop.name);
+                  if (propertyIsRelation(prop)) {
+                    const relKnowledgeGraphId = prop.knowledgeGraphId || mappingEntry?.relations?.[propName] || null;
+                    return {
+                      name: prop.name,
+                      knowledgeGraphId: relKnowledgeGraphId,
+                      dataType: prop.dataType,
+                      relationType: prop.relationType,
+                      status: relKnowledgeGraphId != null ? 'published' : 'synced',
+                    } satisfies TypesyncHypergraphSchemaTypeProperty;
+                  }
+                  const propKnowledgeGraphId = prop.knowledgeGraphId || mappingEntry?.properties?.[propName] || null;
+                  return {
+                    name: prop.name,
+                    knowledgeGraphId: propKnowledgeGraphId,
+                    dataType: prop.dataType,
+                    status: propKnowledgeGraphId != null ? 'published' : 'synced',
+                  } satisfies TypesyncHypergraphSchemaTypeProperty;
+                }),
+              });
+            }),
+          });
+        });
+      return {
+        hypergraphSchemaStream,
+        syncSchema,
+        syncMapping,
+      } as const;
     }),
   },
 ) {}