implement Type.optional

Author: nikgraf

apps/events/src/mapping.ts

@@ -6,6 +6,7 @@ export const mapping: Mapping = {
     typeIds: [Id.Id('7f9562d4-034d-4385-bf5c-f02cdebba47a')],
     properties: {
       name: Id.Id('a126ca53-0c8e-48d5-b888-82c734c38935'),
+      description: Id.Id('9b1f76ff-9711-404c-861e-59dc3fa7d037'),
     },
     relations: {
       sponsors: Id.Id('6860bfac-f703-4289-b789-972d0aaf3abe'),

apps/events/src/schema.ts

@@ -33,6 +33,6 @@ export class Company extends Entity.Class<Company>('Company')({
 
 export class Event extends Entity.Class<Event>('Event')({
   name: Type.Text,
-  // description: Type.Text,
+  description: Type.optional(Type.Text),
   sponsors: Type.Relation(Company),
 }) {}

apps/typesync/client/src/Components/App/Schema/utils.ts

@@ -1,5 +1,6 @@
 import type { AppSchema } from '../../../schema.js';
 
+// TODO
 function fieldToEntityString({
   name,
   type_name,

apps/typesync/src/Generator.ts

@@ -1,10 +1,10 @@
-import { execSync } from 'node:child_process';
-import { readdirSync } from 'node:fs';
 import { FileSystem, Path, type Error as PlatformError } from '@effect/platform';
 import { NodeFileSystem } from '@effect/platform-node';
 import { Doc } from '@effect/printer';
 import { Mapping } from '@graphprotocol/typesync';
 import { Cause, Console, Data, Effect, Array as EffectArray, String as EffectString } from 'effect';
+import { execSync } from 'node:child_process';
+import { readdirSync } from 'node:fs';
 
 import type * as Domain from '../domain/Domain.js';
 import * as Utils from './Utils.js';
@@ -301,6 +301,7 @@ function validatePackageName(name: string): {
   };
 }
 
+// TODO
 // --------------------
 // schema builder
 // --------------------

docs/docs/schema.md

@@ -2,6 +2,8 @@
 
 The Hypergraph schema allows you to define the data model for your application. It is based on the GRC-20 specification and allows you to define Types with properties and relations to other Types.
 
+TODO update this doc
+
 ## Example
 
 Here is an example of a schema for an Event app with the properties `name` and `description`.

packages/hypergraph-react/src/internal/use-create-entity-public.ts

@@ -32,6 +32,7 @@ export function useCreateEntityPublic<const S extends Entity.AnyNoContext>(
 
       const fields = type.fields;
       const values: PropertiesParam = [];
+      // TODO
       for (const [key, value] of Object.entries(mappingEntry.properties || {})) {
         let serializedValue: string = data[key];
         if (fields[key] === Type.Checkbox) {

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

@@ -149,6 +149,7 @@ type RecursiveQueryEntity = {
   }[];
 };
 
+// TODO
 const convertPropertyValue = (
   property: { propertyId: string; value: string },
   key: string,

packages/hypergraph-react/src/prepare-publish.ts

@@ -7,7 +7,7 @@ import {
   type RelationsParam,
 } from '@graphprotocol/grc-20';
 import type { Entity } from '@graphprotocol/hypergraph';
-import { store, Type } from '@graphprotocol/hypergraph';
+import { store, TypeUtils } from '@graphprotocol/hypergraph';
 import request, { gql } from 'graphql-request';
 
 export type PreparePublishParams<S extends Entity.AnyNoContext> = {
@@ -67,15 +67,16 @@ export const preparePublish = async <S extends Entity.AnyNoContext>({
   const fields = entity.__schema.fields;
 
   if (data?.entity === null) {
+    // TODO
     for (const [key, propertyId] of Object.entries(mappingEntry.properties || {})) {
       let serializedValue: string = entity[key];
-      if (fields[key] === Type.Checkbox) {
+      if (TypeUtils.isCheckboxOrOptionalCheckboxType(fields[key])) {
         serializedValue = Graph.serializeCheckbox(entity[key]);
-      } else if (fields[key] === Type.Date) {
+      } else if (TypeUtils.isDateOrOptionalDateType(fields[key])) {
         serializedValue = Graph.serializeDate(entity[key]);
-      } else if (fields[key] === Type.Point) {
+      } else if (TypeUtils.isPointOrOptionalPointType(fields[key])) {
         serializedValue = Graph.serializePoint(entity[key]);
-      } else if (fields[key] === Type.Number) {
+      } else if (TypeUtils.isNumberOrOptionalNumberType(fields[key])) {
         serializedValue = Graph.serializeNumber(entity[key]);
       }
       values.push({ property: propertyId, value: serializedValue });
@@ -105,14 +106,15 @@ export const preparePublish = async <S extends Entity.AnyNoContext>({
 
   if (data?.entity) {
     for (const [key, propertyId] of Object.entries(mappingEntry.properties || {})) {
+      // TODO
       let serializedValue: string = entity[key];
-      if (fields[key] === Type.Checkbox) {
+      if (TypeUtils.isCheckboxOrOptionalCheckboxType(fields[key])) {
         serializedValue = Graph.serializeCheckbox(entity[key]);
-      } else if (fields[key] === Type.Date) {
+      } else if (TypeUtils.isDateOrOptionalDateType(fields[key])) {
         serializedValue = Graph.serializeDate(entity[key]);
-      } else if (fields[key] === Type.Point) {
+      } else if (TypeUtils.isPointOrOptionalPointType(fields[key])) {
         serializedValue = Graph.serializePoint(entity[key]);
-      } else if (fields[key] === Type.Number) {
+      } else if (TypeUtils.isNumberOrOptionalNumberType(fields[key])) {
         serializedValue = Graph.serializeNumber(entity[key]);
       }
 

packages/hypergraph/src/index.ts

@@ -6,8 +6,9 @@ export * as Key from './key/index.js';
 export * as Messages from './messages/index.js';
 export * as SpaceEvents from './space-events/index.js';
 export * as SpaceInfo from './space-info/index.js';
-export * from './store.js';
 export * as StoreConnect from './store-connect.js';
+export * from './store.js';
+export * as TypeUtils from './type-utils/type-utils.js';
 export * as Type from './type/type.js';
 export * from './types.js';
 export * as Utils from './utils/index.js';

packages/hypergraph/src/type-utils/type-utils.ts

@@ -0,0 +1,41 @@
+import * as Type from '../type/type.js';
+
+// biome-ignore lint/suspicious/noExplicitAny: TODO
+export const isStringOrOptionalStringType = (type: any) => {
+  if (type.ast && type.ast._tag === 'PropertySignatureDeclaration' && type.ast.isOptional) {
+    return type === Type.Text;
+  }
+  return type === Type.Text;
+};
+
+// biome-ignore lint/suspicious/noExplicitAny: TODO
+export const isNumberOrOptionalNumberType = (type: any) => {
+  if (type.ast && type.ast._tag === 'PropertySignatureDeclaration' && type.ast.isOptional) {
+    return type === Type.Number;
+  }
+  return type === Type.Number;
+};
+
+// biome-ignore lint/suspicious/noExplicitAny: TODO
+export const isDateOrOptionalDateType = (type: any) => {
+  if (type.ast && type.ast._tag === 'PropertySignatureDeclaration' && type.ast.isOptional) {
+    return type === Type.Date;
+  }
+  return type === Type.Date;
+};
+
+// biome-ignore lint/suspicious/noExplicitAny: TODO
+export const isCheckboxOrOptionalCheckboxType = (type: any) => {
+  if (type.ast && type.ast._tag === 'PropertySignatureDeclaration' && type.ast.isOptional) {
+    return type === Type.Checkbox;
+  }
+  return type === Type.Checkbox;
+};
+
+// biome-ignore lint/suspicious/noExplicitAny: TODO
+export const isPointOrOptionalPointType = (type: any) => {
+  if (type.ast && type.ast._tag === 'PropertySignatureDeclaration' && type.ast.isOptional) {
+    return type === Type.Point;
+  }
+  return type === Type.Point;
+};