fix resolving optional values in a Relation Entity (#556)

Author: nikgraf

.changeset/pretty-sheep-push.md

@@ -0,0 +1,7 @@
+---
+"@graphprotocol/hypergraph-react": patch
+"@graphprotocol/hypergraph": patch
+---
+
+fix resolving optional values in a Relation Entity
+  

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

@@ -15,7 +15,7 @@ function RouteComponent() {
     offset: 0,
     space: space,
     include: {
-      projects: {},
+      listenOn: {},
     },
   });
 

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

@@ -17,7 +17,7 @@ function RouteComponent() {
         id: 'f5d27d3e-3a51-452d-bac2-702574381633',
         space: space,
         include: {
-          projects: {},
+          listenOn: {},
         },
       });
       console.log('findOnePublic result:', result);
@@ -29,7 +29,7 @@ function RouteComponent() {
     first: 100,
     space: space,
     include: {
-      projects: {},
+      listenOn: {},
     },
     orderBy: { property: 'dateFounded', direction: 'asc' },
     backlinksTotalCountsTypeId1: '972d201a-d780-4568-9e01-543f67b26bee',
@@ -45,15 +45,14 @@ function RouteComponent() {
           <h2>
             {podcast.backlinksTotalCountsTypeId1} - {podcast.dateFounded.toISOString()} {podcast.name} - {podcast.id}
           </h2>
-          {podcast.projects.map((project) => (
-            <div key={project._relation.id}>
-              <h3>- {project.name}</h3>
-              <div>--{project._relation.website}</div>
+          {podcast.listenOn.map((listenOn) => (
+            <div key={listenOn._relation.id}>
+              <h3>- {listenOn.name}</h3>
+              <div>--{listenOn._relation.website}</div>
             </div>
           ))}
         </div>
       ))}
-      <pre className="text-xs">{JSON.stringify(data, null, 2)}</pre>
     </>
   );
 }

apps/events/src/schema.ts

@@ -118,13 +118,60 @@ export const Project = Entity.Schema(
   },
 );
 
+export const Person = Entity.Schema(
+  {
+    name: Type.String,
+    description: Type.optional(Type.String),
+    avatar: Type.Relation(Image),
+  },
+  {
+    types: [Id('7ed45f2b-c48b-419e-8e46-64d5ff680b0d')],
+    properties: {
+      name: Id('a126ca53-0c8e-48d5-b888-82c734c38935'),
+      description: Id('9b1f76ff-9711-404c-861e-59dc3fa7d037'),
+      avatar: Id('1155beff-fad5-49b7-a2e0-da4777b8792c'),
+    },
+  },
+);
+
+export const Topic = Entity.Schema(
+  {
+    name: Type.optional(Type.String),
+    cover: Type.Relation(Image),
+  },
+  {
+    types: [Id('5ef5a586-0f27-4d8e-8f6c-59ae5b3e89e2')],
+    properties: {
+      name: Id('a126ca53-0c8e-48d5-b888-82c734c38935'),
+      cover: Id('34f53507-2e6b-42c5-a844-43981a77cfa2'),
+    },
+  },
+);
+
+// Generic entity for platform links (Apple Podcasts, Spotify, etc.)
+// Using Project type since platforms like Apple Podcasts use this type
+export const GenericEntity = Entity.Schema(
+  {
+    name: Type.String,
+  },
+  {
+    types: [Id('484a18c5-030a-499c-b0f2-ef588ff16d50')], // Project type
+    properties: {
+      name: Id('a126ca53-0c8e-48d5-b888-82c734c38935'),
+    },
+  },
+);
+
 export const Podcast = Entity.Schema(
   {
     name: Type.String,
     description: Type.optional(Type.String),
     dateFounded: Type.Date,
     rssFeedUrl: Type.optional(Type.String),
-    projects: Type.Relation(Project, {
+    avatar: Type.Relation(Image),
+    hosts: Type.Relation(Person),
+    topics: Type.Relation(Topic),
+    listenOn: Type.Relation(GenericEntity, {
       properties: {
         website: Type.optional(Type.String),
       },
@@ -137,7 +184,83 @@ export const Podcast = Entity.Schema(
       description: Id('9b1f76ff-9711-404c-861e-59dc3fa7d037'),
       dateFounded: Id('41aa3d98-47b6-4a97-b7ec-427e575b910e'),
       rssFeedUrl: Id('a5776138-deb8-436f-8c98-3eccd100d98f'),
-      projects: {
+      hosts: Id('c72d9abb-bca8-4e86-b7e8-b71e91d2b37e'),
+      avatar: Id('1155beff-fad5-49b7-a2e0-da4777b8792c'),
+      topics: Id('458fbc07-0dbf-4c92-8f57-16f3fdde7c32'),
+      listenOn: {
+        propertyId: Id('1367bac7-dcea-4b80-86ad-a4a4cdd7c2cb'),
+        properties: {
+          website: Id('eed38e74-e679-46bf-8a42-ea3e4f8fb5fb'),
+        },
+      },
+    },
+  },
+);
+
+export const Quote = Entity.Schema(
+  {
+    name: Type.String,
+  },
+  {
+    types: [Id('043a171c-6918-4dc3-a7db-b8471ca6fcc2')],
+    properties: {
+      name: Id('a126ca53-0c8e-48d5-b888-82c734c38935'),
+    },
+  },
+);
+
+export const Claim = Entity.Schema(
+  {
+    name: Type.String,
+  },
+  {
+    types: [Id('043a171c-6918-4dc3-a7db-b8471ca6fcc2')],
+    properties: {
+      name: Id('a126ca53-0c8e-48d5-b888-82c734c38935'),
+    },
+  },
+);
+
+export const Episode = 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),
+    episodeNumber: Type.optional(Type.Number),
+    guests: Type.Relation(Person),
+    hosts: Type.Relation(Person),
+    podcast: Type.Relation(Podcast),
+    contributors: Type.Relation(Person),
+    quotes: Type.Relation(Quote),
+    claims: Type.Relation(Claim),
+    topics: Type.Relation(Topic),
+    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'),
+      episodeNumber: Id('9b5eced9-5c30-473b-8404-f474a777db3a'),
+      hosts: Id('c72d9abb-bca8-4e86-b7e8-b71e91d2b37e'),
+      guests: Id('cb60a1a6-6fb5-48c9-b936-200c5c271330'),
+      avatar: Id('1155beff-fad5-49b7-a2e0-da4777b8792c'),
+      podcast: Id('f1873bbc-381f-4604-abad-76fed4f6d73f'),
+      contributors: Id('1ff59132-2d57-4671-934a-7b662e3cf66a'),
+      quotes: Id('8d4ae49c-226d-4086-8ec3-af5d5b2a65d0'),
+      claims: Id('e1371bcd-a704-4396-adb7-ea7ecc8fe3d4'),
+      topics: Id('458fbc07-0dbf-4c92-8f57-16f3fdde7c32'),
+      listenOn: {
         propertyId: Id('1367bac7-dcea-4b80-86ad-a4a4cdd7c2cb'),
         properties: {
           website: Id('eed38e74-e679-46bf-8a42-ea3e4f8fb5fb'),

packages/hypergraph/src/utils/convert-relations.ts

@@ -84,13 +84,18 @@ export const convertRelations = <_S extends Schema.Schema.AnyNoContext>(
           };
 
           for (const nestedProp of relationTransformation.propertySignatures) {
-            const nestedResult = SchemaAST.getAnnotation<string>(Constants.PropertyIdSymbol)(nestedProp.type);
+            const propType =
+              nestedProp.isOptional && SchemaAST.isUnion(nestedProp.type)
+                ? (nestedProp.type.types.find((member) => !SchemaAST.isUndefinedKeyword(member)) ?? nestedProp.type)
+                : nestedProp.type;
+
+            const nestedResult = SchemaAST.getAnnotation<string>(Constants.PropertyIdSymbol)(propType);
             if (Option.isSome(nestedResult)) {
               const value = relationEntry.toEntity.valuesList?.find((a) => a.propertyId === nestedResult.value);
               if (!value) {
                 continue;
               }
-              const rawValue = convertPropertyValue(value, nestedProp.type);
+              const rawValue = convertPropertyValue(value, propType);
               if (rawValue) {
                 nestedRawEntity[String(nestedProp.name)] = rawValue;
               }