add type optional

[nikgraf]

No description provided.

[Copilot]

Pull Request Overview

This PR adds support for optional fields in the hypergraph schema system by introducing a Type.optional function and utilities to handle optional type checking throughout the codebase.

• Adds Type.optional export and comprehensive type utilities for detecting optional fields
• Updates serialization logic to handle optional fields by skipping undefined values or throwing errors for required fields
• Demonstrates the feature with optional fields in schema examples and practical usage in the events app

Reviewed Changes

Copilot reviewed 17 out of 18 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
packages/hypergraph/src/type/type.ts	Exports Schema.optional as Type.optional
packages/hypergraph/src/type-utils/type-utils.ts	Adds utility functions to detect optional and specific optional field types
packages/hypergraph/src/index.ts	Exports the new TypeUtils module
packages/hypergraph-react/test/prepare-publish.test.ts	Comprehensive tests for the preparePublish function with optional field handling
packages/hypergraph-react/src/use-query.tsx	Removes commented-out legacy code for merging entities
packages/hypergraph-react/src/prepare-publish.ts	Updates to use TypeUtils for field type checking and optional field handling
packages/hypergraph-react/src/internal/use-query-public.tsx	Updates property value conversion to use TypeUtils
packages/hypergraph-react/src/internal/use-generate-update-ops.tsx	Removes entire file (was commented out)
packages/hypergraph-react/src/internal/use-create-entity-public.ts	Updates to use TypeUtils and handle optional fields
docs/docs/schema.md	Adds documentation for optional fields
apps/typesync/src/Generator.ts	Minor import ordering change
apps/events/src/schema.ts	Adds optional description field to Event schema
apps/events/src/mapping.ts	Adds mapping for the new description property
apps/events/src/components/ui/label.tsx	Adds new Label UI component
apps/events/src/components/playground.tsx	Increases query limit from 2 to 10
apps/events/src/components/events/events.tsx	Updates UI to handle optional description field
apps/events/package.json	Adds @radix-ui/react-label dependency

Files not reviewed (1)

• pnpm-lock.yaml: Language not supported

[Copilot]

The function isStringOrOptionalStringType returns type === Type.Text in both branches of the conditional, making the conditional logic redundant. Consider simplifying this to just return type === Type.Text; or implementing proper optional type checking.

Suggested change

	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.Text;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isNumberOrOptionalNumberType = (type: any) => {
	return type === Type.Number;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isDateOrOptionalDateType = (type: any) => {
	return type === Type.Date;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isCheckboxOrOptionalCheckboxType = (type: any) => {
	return type === Type.Checkbox;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isPointOrOptionalPointType = (type: any) => {

[cmwhited]

I guess I don't disagree with the copilot response here that both branches are the same. Is there a reason for if the if check if it only returns the same as the else case?

[Copilot]

The function isNumberOrOptionalNumberType has the same logic issue as isStringOrOptionalStringType - both branches return the same value, making the conditional redundant.

Suggested change

	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.Text;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isNumberOrOptionalNumberType = (type: any) => {
	return type === Type.Number;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isDateOrOptionalDateType = (type: any) => {
	return type === Type.Date;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isCheckboxOrOptionalCheckboxType = (type: any) => {
	return type === Type.Checkbox;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isPointOrOptionalPointType = (type: any) => {

[Copilot]

The function isDateOrOptionalDateType has the same logic issue - both branches return the same value, making the conditional redundant.

Suggested change

	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.Text;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isNumberOrOptionalNumberType = (type: any) => {
	return type === Type.Number;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isDateOrOptionalDateType = (type: any) => {
	return type === Type.Date;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isCheckboxOrOptionalCheckboxType = (type: any) => {
	return type === Type.Checkbox;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isPointOrOptionalPointType = (type: any) => {

[Copilot]

The function isCheckboxOrOptionalCheckboxType has the same logic issue - both branches return the same value, making the conditional redundant.

Suggested change

	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.Text;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isNumberOrOptionalNumberType = (type: any) => {
	return type === Type.Number;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isDateOrOptionalDateType = (type: any) => {
	return type === Type.Date;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isCheckboxOrOptionalCheckboxType = (type: any) => {
	return type === Type.Checkbox;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isPointOrOptionalPointType = (type: any) => {

[Copilot]

The function isPointOrOptionalPointType has the same logic issue - both branches return the same value, making the conditional redundant.

Suggested change

	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.Text;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isNumberOrOptionalNumberType = (type: any) => {
	return type === Type.Number;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isDateOrOptionalDateType = (type: any) => {
	return type === Type.Date;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isCheckboxOrOptionalCheckboxType = (type: any) => {
	return type === Type.Checkbox;
	};
	// biome-ignore lint/suspicious/noExplicitAny: TODO
	export const isPointOrOptionalPointType = (type: any) => {

[cmwhited]

Check comment on is{Type}OrOptional{Type}Type fn

[cmwhited]

I guess I don't disagree with the copilot response here that both branches are the same. Is there a reason for if the if check if it only returns the same as the else case?

[nikgraf]

@cmwhited excellent catch! fixed it and added tests for more optional cases