graphql alias per relation + backlinks support (#557)

Author: nikgraf

.changeset/plain-turkeys-matter.md

@@ -0,0 +1,7 @@
+---
+"@graphprotocol/hypergraph-react": patch
+"@graphprotocol/hypergraph": patch
+---
+
+add Type.Backlink
+  

apps/events/src/routes/podcasts.lazy.tsx

@@ -1,7 +1,5 @@
-import { Entity } from '@graphprotocol/hypergraph';
 import { useEntities } from '@graphprotocol/hypergraph-react';
 import { createLazyFileRoute } from '@tanstack/react-router';
-import { useEffect } from 'react';
 import { Podcast } from '@/schema';
 
 export const Route = createLazyFileRoute('/podcasts')({
@@ -11,25 +9,43 @@ export const Route = createLazyFileRoute('/podcasts')({
 function RouteComponent() {
   const space = 'e252f9e1-d3ad-4460-8bf1-54f93b02f220';
 
-  useEffect(() => {
-    setTimeout(async () => {
-      const result = await Entity.findOnePublic(Podcast, {
-        id: 'f5d27d3e-3a51-452d-bac2-702574381633',
-        space: space,
-        include: {
-          listenOn: {},
-        },
-      });
-      console.log('findOnePublic result:', result);
-    }, 1000);
-  }, []);
+  // useEffect(() => {
+  //   setTimeout(async () => {
+  //     const result = await Entity.searchManyPublic(Podcast, {
+  //       query: 'Joe',
+  //       space: space,
+  //       // include: {
+  //       //   listenOn: {},
+  //       // },
+  //     });
+  //     console.log('searchManyPublic result:', result);
+  //   }, 1000);
+  // }, []);
+
+  // const { data: podcast } = useEntity(Podcast, {
+  //   id: 'f5d27d3e-3a51-452d-bac2-702574381633',
+  //   mode: 'public',
+  //   space: space,
+  //   include: {
+  //     listenOn: {},
+  //     hosts: {
+  //       avatar: {},
+  //     },
+  //     episodes: {},
+  //   },
+  // });
+  // console.log({ podcast });
 
   const { data, isLoading, isError } = useEntities(Podcast, {
     mode: 'public',
-    first: 100,
+    first: 10,
     space: space,
     include: {
       listenOn: {},
+      hosts: {
+        avatar: {},
+      },
+      episodes: {},
     },
     orderBy: { property: 'dateFounded', direction: 'asc' },
     backlinksTotalCountsTypeId1: '972d201a-d780-4568-9e01-543f67b26bee',

apps/events/src/schema.ts

@@ -162,6 +162,39 @@ export const GenericEntity = Entity.Schema(
   },
 );
 
+export const Episode2 = Entity.Schema(
+  {
+    name: Type.String,
+    description: Type.optional(Type.String),
+    airDate: Type.Date,
+    avatar: Type.Relation(Image),
+    duration: Type.optional(Type.Number), // in seconds
+    audioUrl: Type.optional(Type.String),
+    listenOn: Type.Relation(GenericEntity, {
+      properties: {
+        website: Type.optional(Type.String),
+      },
+    }),
+  },
+  {
+    types: [Id('972d201a-d780-4568-9e01-543f67b26bee')],
+    properties: {
+      name: Id('a126ca53-0c8e-48d5-b888-82c734c38935'),
+      description: Id('9b1f76ff-9711-404c-861e-59dc3fa7d037'),
+      airDate: Id('77999397-f78d-44a7-bbc5-d93a617af47c'),
+      duration: Id('76996acc-d10f-4cd5-9ac9-4a705b8e03b4'),
+      audioUrl: Id('87f919d5-560b-408c-be8d-318e2c5c098b'),
+      avatar: Id('1155beff-fad5-49b7-a2e0-da4777b8792c'),
+      listenOn: {
+        propertyId: Id('1367bac7-dcea-4b80-86ad-a4a4cdd7c2cb'),
+        properties: {
+          website: Id('eed38e74-e679-46bf-8a42-ea3e4f8fb5fb'),
+        },
+      },
+    },
+  },
+);
+
 export const Podcast = Entity.Schema(
   {
     name: Type.String,
@@ -176,6 +209,7 @@ export const Podcast = Entity.Schema(
         website: Type.optional(Type.String),
       },
     }),
+    episodes: Type.Backlink(Episode2),
   },
   {
     types: [Id('4c81561d-1f95-4131-9cdd-dd20ab831ba2')],
@@ -193,6 +227,7 @@ export const Podcast = Entity.Schema(
           website: Id('eed38e74-e679-46bf-8a42-ea3e4f8fb5fb'),
         },
       },
+      episodes: Id('f1873bbc-381f-4604-abad-76fed4f6d73f'),
     },
   },
 );

packages/hypergraph-react/src/hooks/use-entities-public-infinite.ts

@@ -1,4 +1,4 @@
-import { Constants, Entity, Utils } from '@graphprotocol/hypergraph';
+import { Constants, Entity } from '@graphprotocol/hypergraph';
 import { useInfiniteQuery as useInfiniteQueryTanstack } from '@tanstack/react-query';
 import * as Option from 'effect/Option';
 import type * as Schema from 'effect/Schema';
@@ -13,24 +13,12 @@ export const useEntitiesPublicInfinite = <S extends Schema.Schema.AnyNoContext>(
   const { enabled = true, filter, include, space: spaceFromParams, first = 2, offset = 0 } = params ?? {};
   const { space: spaceFromContext } = useHypergraphSpaceInternal();
   const space = spaceFromParams ?? spaceFromContext;
-
-  // constructing the relation type ids for the query
-  const relationTypeIds = Utils.getRelationTypeIds(type, include);
-
   const typeIds = SchemaAST.getAnnotation<string[]>(Constants.TypeIdsSymbol)(type.ast as SchemaAST.TypeLiteral).pipe(
     Option.getOrElse(() => []),
   );
 
   const result = useInfiniteQueryTanstack({
-    queryKey: [
-      'hypergraph-public-entities',
-      space,
-      typeIds,
-      relationTypeIds.level1,
-      relationTypeIds.level2,
-      filter,
-      'infinite',
-    ],
+    queryKey: ['hypergraph-public-entities', space, typeIds, include, filter, 'infinite'],
     queryFn: async ({ pageParam }) => {
       return Entity.findManyPublic(type, { filter, include, space, first, offset: pageParam });
     },

packages/hypergraph-react/src/internal/use-entities-public.tsx

@@ -1,4 +1,4 @@
-import { Constants, Entity, Utils } from '@graphprotocol/hypergraph';
+import { Constants, Entity } from '@graphprotocol/hypergraph';
 import { useQuery as useQueryTanstack } from '@tanstack/react-query';
 import * as Option from 'effect/Option';
 import type * as Schema from 'effect/Schema';
@@ -19,10 +19,6 @@ export const useEntitiesPublic = <S extends Schema.Schema.AnyNoContext>(type: S,
   } = params ?? {};
   const { space: spaceFromContext } = useHypergraphSpaceInternal();
   const space = spaceFromParams ?? spaceFromContext;
-
-  // constructing the relation type ids for the query
-  const relationTypeIds = Utils.getRelationTypeIds(type, include);
-
   const typeIds = SchemaAST.getAnnotation<string[]>(Constants.TypeIdsSymbol)(type.ast as SchemaAST.TypeLiteral).pipe(
     Option.getOrElse(() => []),
   );
@@ -32,8 +28,7 @@ export const useEntitiesPublic = <S extends Schema.Schema.AnyNoContext>(type: S,
       'hypergraph-public-entities',
       space,
       typeIds,
-      relationTypeIds.level1,
-      relationTypeIds.level2,
+      include,
       filter,
       first,
       offset,