Unifies server module library and client SDK for TypeScript (and fixes several bugs)

crates/bindings-typescript/examples/quickstart-chat/src/App.tsx

@@ -16,8 +16,9 @@ function App() {
   const [settingName, setSettingName] = useState(false);
   const [systemMessages, setSystemMessages] = useState([] as Message[]);
   const [newMessage, setNewMessage] = useState('');
-
   const conn = useSpacetimeDB<DbConnection>();
+
+  conn.setReducerFlags();
   const { identity, isActive: connected } = conn;
 
   // Subscribe to all messages in the chat

crates/bindings-typescript/src/index.ts

@@ -6,7 +6,7 @@ export { default as BinaryWriter } from './lib/binary_writer';
 export * from './lib/schedule_at';
 export * from './lib/time_duration';
 export * from './lib/timestamp';
-export * from './lib/utils';
+export * from './lib/util';
 export * from './lib/identity';
 export * from './lib/option';
 export * from './sdk';

crates/bindings-typescript/src/lib/algebraic_type.ts

@@ -4,21 +4,15 @@ import { ConnectionId } from './connection_id';
 import type BinaryReader from './binary_reader';
 import BinaryWriter from './binary_writer';
 import { Identity } from './identity';
-import { Option } from './option';
-import {
-  AlgebraicType as AlgebraicTypeType,
-  AlgebraicType as AlgebraicTypeValue,
-} from './autogen/algebraic_type_type';
-import {
-  type ProductType as ProductTypeType,
-  ProductType as ProductTypeValue,
-} from './autogen/product_type_type';
-import {
-  type SumType as SumTypeType,
-  SumType as SumTypeValue,
-} from './autogen/sum_type_type';
-import ScheduleAt from './schedule_at';
-import type Typespace from './autogen/typespace_type';
+import * as AlgebraicTypeVariants from './algebraic_type_variants';
+
+type TypespaceType = {
+  types: AlgebraicTypeType[];
+};
+
+export type ProductTypeType = {
+  elements: ProductTypeElement[];
+};
 
 /**
  * A factor / element of a product type.
@@ -28,101 +22,96 @@ import type Typespace from './autogen/typespace_type';
  * NOTE: Each element has an implicit element tag based on its order.
  * Uniquely identifies an element similarly to protobuf tags.
  */
-export * from './autogen/product_type_element_type';
+export type ProductTypeElement = {
+  name: string | undefined;
+  algebraicType: AlgebraicTypeType;
+};
+
+export type SumTypeType = {
+  variants: SumTypeVariant[];
+};
 
 /**
  * A variant of a sum type.
  *
  * NOTE: Each element has an implicit element tag based on its order.
  * Uniquely identifies an element similarly to protobuf tags.
  */
-export * from './autogen/sum_type_variant_type';
+export type SumTypeVariant = {
+  name: string | undefined;
+  algebraicType: AlgebraicTypeType;
+};
 
-/**
- * The variant types of the Algebraic Type tagged union.
- */
-export type * as AlgebraicTypeVariants from './autogen/algebraic_type_variants';
+export type AlgebraicTypeType =
+  | AlgebraicTypeVariants.Ref
+  | AlgebraicTypeVariants.Sum
+  | AlgebraicTypeVariants.Product
+  | AlgebraicTypeVariants.Array
+  | AlgebraicTypeVariants.String
+  | AlgebraicTypeVariants.Bool
+  | AlgebraicTypeVariants.I8
+  | AlgebraicTypeVariants.U8
+  | AlgebraicTypeVariants.I16
+  | AlgebraicTypeVariants.U16
+  | AlgebraicTypeVariants.I32
+  | AlgebraicTypeVariants.U32
+  | AlgebraicTypeVariants.I64
+  | AlgebraicTypeVariants.U64
+  | AlgebraicTypeVariants.I128
+  | AlgebraicTypeVariants.U128
+  | AlgebraicTypeVariants.I256
+  | AlgebraicTypeVariants.U256
+  | AlgebraicTypeVariants.F32
+  | AlgebraicTypeVariants.F64;
 
-/**
- * The SpacetimeDB Algebraic Type System (SATS) is a structural type system in
- * which a nominal type system can be constructed.
- *
- * The type system unifies the concepts sum types, product types, and built-in
- * primitive types into a single type system.
- */
 export type AlgebraicType = AlgebraicTypeType;
 
 /**
- * Algebraic Type utilities.
+ * The variant types of the Algebraic Type tagged union.
  */
-export const AlgebraicType: {
-  Sum<T extends SumType>(value: T): { tag: 'Sum'; value: T };
-  Product<T extends ProductType>(value: T): { tag: 'Product'; value: T };
-  Array<T extends AlgebraicType>(value: T): { tag: 'Array'; value: T };
+export { AlgebraicTypeVariants };
 
-  createOptionType(innerType: AlgebraicTypeType): AlgebraicTypeType;
-  createIdentityType(): AlgebraicTypeType;
-  createConnectionIdType(): AlgebraicTypeType;
-  createScheduleAtType(): AlgebraicTypeType;
-  createTimestampType(): AlgebraicTypeType;
-  createTimeDurationType(): AlgebraicTypeType;
-  serializeValue(
-    writer: BinaryWriter,
-    ty: AlgebraicTypeType,
-    value: any,
-    typespace?: Typespace
-  ): void;
-  deserializeValue(
-    reader: BinaryReader,
-    ty: AlgebraicTypeType,
-    typespace?: Typespace
-  ): any;
-  /**
-   * Convert a value of the algebraic type into something that can be used as a key in a map.
-   * There are no guarantees about being able to order it.
-   * This is only guaranteed to be comparable to other values of the same type.
-   * @param value A value of the algebraic type
-   * @returns Something that can be used as a key in a map.
-   */
-  intoMapKey(ty: AlgebraicTypeType, value: any): ComparablePrimitive;
-} & typeof AlgebraicTypeValue = {
-  ...AlgebraicTypeValue,
-  Sum: <T extends SumType>(value: T): { tag: 'Sum'; value: T } => ({
+// A value with helper functions to construct the type.
+export const AlgebraicType = {
+  Ref: (value: number): AlgebraicTypeVariants.Ref => ({ tag: 'Ref', value }),
+  Sum: <T extends SumTypeType>(value: T): { tag: 'Sum'; value: T } => ({
     tag: 'Sum',
     value,
   }),
-  Product: <T extends ProductType>(value: T): { tag: 'Product'; value: T } => ({
+  Product: <T extends ProductTypeType>(
+    value: T
+  ): { tag: 'Product'; value: T } => ({
     tag: 'Product',
     value,
   }),
-  Array: <T extends AlgebraicType>(value: T): { tag: 'Array'; value: T } => ({
+  Array: <T extends AlgebraicTypeType>(
+    value: T
+  ): { tag: 'Array'; value: T } => ({
     tag: 'Array',
     value,
   }),
-  createOptionType: function (innerType: AlgebraicTypeType): AlgebraicTypeType {
-    return Option.getAlgebraicType(innerType);
-  },
-  createIdentityType: function (): AlgebraicTypeType {
-    return Identity.getAlgebraicType();
-  },
-  createConnectionIdType: function (): AlgebraicTypeType {
-    return ConnectionId.getAlgebraicType();
-  },
-  createScheduleAtType: function (): AlgebraicTypeType {
-    return ScheduleAt.getAlgebraicType();
-  },
-  createTimestampType: function (): AlgebraicTypeType {
-    return Timestamp.getAlgebraicType();
-  },
-  createTimeDurationType: function (): AlgebraicTypeType {
-    return TimeDuration.getAlgebraicType();
-  },
-  serializeValue: function (
+  String: { tag: 'String' } as const,
+  Bool: { tag: 'Bool' } as const,
+  I8: { tag: 'I8' } as const,
+  U8: { tag: 'U8' } as const,
+  I16: { tag: 'I16' } as const,
+  U16: { tag: 'U16' } as const,
+  I32: { tag: 'I32' } as const,
+  U32: { tag: 'U32' } as const,
+  I64: { tag: 'I64' } as const,
+  U64: { tag: 'U64' } as const,
+  I128: { tag: 'I128' } as const,
+  U128: { tag: 'U128' } as const,
+  I256: { tag: 'I256' } as const,
+  U256: { tag: 'U256' } as const,
+  F32: { tag: 'F32' } as const,
+  F64: { tag: 'F64' } as const,
+  serializeValue(
     writer: BinaryWriter,
     ty: AlgebraicTypeType,
     value: any,
-    typespace?: Typespace
-  ): void {
+    typespace?: TypespaceType
+  ) {
     if (ty.tag === 'Ref') {
       if (!typespace)
         throw new Error('cannot serialize refs without a typespace');
@@ -199,7 +188,7 @@ export const AlgebraicType: {
   deserializeValue: function (
     reader: BinaryReader,
     ty: AlgebraicTypeType,
-    typespace?: Typespace
+    typespace?: TypespaceType
   ): any {
     if (ty.tag === 'Ref') {
       if (!typespace)
@@ -327,26 +316,12 @@ export const AlgebraicType: {
  */
 export type ProductType = ProductTypeType;
 
-export const ProductType: {
-  serializeValue(
-    writer: BinaryWriter,
-    ty: ProductTypeType,
-    value: any,
-    typespace?: Typespace
-  ): void;
-  deserializeValue(
-    reader: BinaryReader,
-    ty: ProductTypeType,
-    typespace?: Typespace
-  ): any;
-  intoMapKey(ty: ProductTypeType, value: any): ComparablePrimitive;
-} = {
-  ...ProductTypeValue,
+export const ProductType = {
   serializeValue(
     writer: BinaryWriter,
     ty: ProductTypeType,
     value: any,
-    typespace?: Typespace
+    typespace?: TypespaceType
   ): void {
     for (const element of ty.elements) {
       AlgebraicType.serializeValue(
@@ -360,7 +335,7 @@ export const ProductType: {
   deserializeValue(
     reader: BinaryReader,
     ty: ProductTypeType,
-    typespace?: Typespace
+    typespace?: TypespaceType
   ): any {
     const result: { [key: string]: any } = {};
     if (ty.elements.length === 1) {
@@ -441,25 +416,12 @@ export type SumType = SumTypeType;
  *
  * [structural]: https://en.wikipedia.org/wiki/Structural_type_system
  */
-export const SumType: {
-  serializeValue(
-    writer: BinaryWriter,
-    ty: SumTypeType,
-    value: any,
-    typespace?: Typespace
-  ): void;
-  deserializeValue(
-    reader: BinaryReader,
-    ty: SumTypeType,
-    typespace?: Typespace
-  ): any;
-} = {
-  ...SumTypeValue,
+export const SumType = {
   serializeValue: function (
     writer: BinaryWriter,
     ty: SumTypeType,
     value: any,
-    typespace?: Typespace
+    typespace?: TypespaceType
   ): void {
     if (
       ty.variants.length == 2 &&
@@ -495,7 +457,7 @@ export const SumType: {
   deserializeValue: function (
     reader: BinaryReader,
     ty: SumTypeType,
-    typespace?: Typespace
+    typespace?: TypespaceType
   ): any {
     const tag = reader.readU8();
     // In TypeScript we handle Option values as a special case

crates/bindings-typescript/src/lib/algebraic_type_variants.ts

@@ -0,0 +1,26 @@
+import type {
+  AlgebraicTypeType,
+  ProductTypeType,
+  SumTypeType,
+} from './algebraic_type';
+
+export type Ref = { tag: 'Ref'; value: number };
+export type Sum = { tag: 'Sum'; value: SumTypeType };
+export type Product = { tag: 'Product'; value: ProductTypeType };
+export type Array = { tag: 'Array'; value: AlgebraicTypeType };
+export type String = { tag: 'String' };
+export type Bool = { tag: 'Bool' };
+export type I8 = { tag: 'I8' };
+export type U8 = { tag: 'U8' };
+export type I16 = { tag: 'I16' };
+export type U16 = { tag: 'U16' };
+export type I32 = { tag: 'I32' };
+export type U32 = { tag: 'U32' };
+export type I64 = { tag: 'I64' };
+export type U64 = { tag: 'U64' };
+export type I128 = { tag: 'I128' };
+export type U128 = { tag: 'U128' };
+export type I256 = { tag: 'I256' };
+export type U256 = { tag: 'U256' };
+export type F32 = { tag: 'F32' };
+export type F64 = { tag: 'F64' };