spacetimedb 2.4.1 → 2.6.0

package/src/lib/reducer_schema.ts

@@ -1,38 +1,38 @@
-import type { ProductType } from './algebraic_type';
-import type { RawReducerDefV9 } from './autogen/types';
-import type { ParamsObj } from './reducers';
-import type { RowBuilder, RowObj } from './type_builders';
-import type { CamelCase } from './type_util';
-
-/**
- * Represents a handle to a database reducer, including its name and argument type.
- */
-export type ReducerSchema<
-  ReducerName extends string,
-  Params extends ParamsObj | RowObj,
-> = {
-  /**
-   * The name of the reducer.
-   */
-  readonly reducerName: ReducerName;
-
-  /**
-   * The accessor name for the reducer.
-   */
-  readonly accessorName: CamelCase<ReducerName>;
-
-  /**
-   * The TypeBuilder representation of the reducer's parameter type.
-   */
-  readonly params: RowBuilder<Params>;
-
-  /**
-   * The {@link ProductType} representing the structure of the reducer's parameters.
-   */
-  readonly paramsSpacetimeType: ProductType;
-
-  /**
-   * The {@link RawReducerDefV9} of the configured reducer.
-   */
-  readonly reducerDef: RawReducerDefV9;
-};
+import type { ProductType } from './algebraic_type';
+import type { RawReducerDefV9 } from './autogen/types';
+import type { ParamsObj } from './reducers';
+import type { RowBuilder, RowObj } from './type_builders';
+import type { CamelCase } from './type_util';
+
+/**
+ * Represents a handle to a database reducer, including its name and argument type.
+ */
+export type ReducerSchema<
+  ReducerName extends string,
+  Params extends ParamsObj | RowObj,
+> = {
+  /**
+   * The name of the reducer.
+   */
+  readonly reducerName: ReducerName;
+
+  /**
+   * The accessor name for the reducer.
+   */
+  readonly accessorName: CamelCase<ReducerName>;
+
+  /**
+   * The TypeBuilder representation of the reducer's parameter type.
+   */
+  readonly params: RowBuilder<Params>;
+
+  /**
+   * The {@link ProductType} representing the structure of the reducer's parameters.
+   */
+  readonly paramsSpacetimeType: ProductType;
+
+  /**
+   * The {@link RawReducerDefV9} of the configured reducer.
+   */
+  readonly reducerDef: RawReducerDefV9;
+};

package/src/lib/reducers.ts

@@ -1,116 +1,116 @@
-import type { DbView } from '../server/db_view';
-import type { Random } from '../server/rng';
-import type { ConnectionId } from './connection_id';
-import type { Identity } from './identity';
-import { type UntypedSchemaDef } from './schema';
-import { type Timestamp } from './timestamp';
-import {
-  ColumnBuilder,
-  type InferTypeOfRow,
-  type TypeBuilder,
-} from './type_builders';
-import { Uuid } from './uuid.ts';
-
-/**
- * Helper to extract the parameter types from an object type
- */
-export type ParamsObj = Record<
-  string,
-  TypeBuilder<any, any> | ColumnBuilder<any, any, any>
->;
-
-/**
- * Helper to convert a ParamsObj or RowObj into an object type
- */
-export type ParamsAsObject<ParamDef extends ParamsObj> =
-  InferTypeOfRow<ParamDef>;
-
-/**
- * Defines a SpacetimeDB reducer function.
- * Reducers are the primary way to modify the state of your SpacetimeDB application.
- * They are atomic, meaning that either all operations within a reducer succeed,
- * or none of them do.
- * @template S - The inferred schema type of the SpacetimeDB module.
- * @template Params - The type of the parameters object expected by the reducer.
- * @param ctx - The reducer context, providing access to `sender`, `timestamp`, `connection_id`, and `db`.
- * @param payload - An object containing the arguments passed to the reducer, typed according to `params`.
- * @example
- * ```typescript
- * // Define a reducer named 'create_user' that takes 'username' (string) and 'email' (string)
- * reducer(
- *   'create_user',
- *   {
- *    username: t.string(),
- *    email: t.string(),
- *   },
- *   (ctx, { username, email }) => {
- *     // Access the 'user' table from the database view in the context
- *     ctx.db.user.insert({ username, email, created_at: ctx.timestamp });
- *     console.log(`User ${username} created by ${ctx.sender.identityId}`);
- *   }
- * );
- * ```
- */
-export type Reducer<S extends UntypedSchemaDef, Params extends ParamsObj> = (
-  ctx: ReducerCtx<S>,
-  payload: ParamsAsObject<Params>
-) => void;
-
-/**
- * Authentication information for the caller of a reducer.
- */
-export type AuthCtx = Readonly<{
-  /** Whether the caller is an internal system process. */
-  isInternal: boolean;
-  /** Whether the caller has authenticated with a JWT token. */
-  hasJWT: boolean;
-  /** The JWT claims associated with the caller, or null if hasJWT == false. */
-  jwt: JwtClaims | null;
-}>;
-
-export type JsonValue =
-  | string
-  | number
-  | boolean
-  | null
-  | Array<JsonValue>
-  | JsonObject;
-
-export interface JsonObject {
-  [key: string]: JsonValue;
-}
-
-/**
- * Auth Claims extracted from the payload of a JWT token
- */
-export interface JwtClaims {
-  /** The full payload as a JSON string */
-  readonly rawPayload: string;
-  /** The subject of the JWT token ('sub') */
-  readonly subject: string;
-  /** The issuer of the JWT token ('iss') */
-  readonly issuer: string;
-  /** The audience of the JWT token ('aud') */
-  readonly audience: readonly string[];
-  /** The identity associated with the JWT token, which is based on the sub and iss */
-  readonly identity: Identity;
-  /** The full payload as a JsonObject */
-  readonly fullPayload: JsonObject;
-}
-
-/**
- * Reducer context parametrized by the inferred Schema
- */
-export type ReducerCtx<SchemaDef extends UntypedSchemaDef> = Readonly<{
-  sender: Identity;
-  databaseIdentity: Identity;
-  /** @deprecated Use `databaseIdentity` instead. */
-  identity: Identity;
-  timestamp: Timestamp;
-  connectionId: ConnectionId | null;
-  db: DbView<SchemaDef>;
-  senderAuth: AuthCtx;
-  newUuidV4(): Uuid;
-  newUuidV7(): Uuid;
-  random: Random;
-}>;
+import type { DbView } from '../server/db_view';
+import type { Random } from '../server/rng';
+import type { ConnectionId } from './connection_id';
+import type { Identity } from './identity';
+import { type UntypedSchemaDef } from './schema';
+import { type Timestamp } from './timestamp';
+import {
+  ColumnBuilder,
+  type InferTypeOfRow,
+  type TypeBuilder,
+} from './type_builders';
+import { Uuid } from './uuid.ts';
+
+/**
+ * Helper to extract the parameter types from an object type
+ */
+export type ParamsObj = Record<
+  string,
+  TypeBuilder<any, any> | ColumnBuilder<any, any, any>
+>;
+
+/**
+ * Helper to convert a ParamsObj or RowObj into an object type
+ */
+export type ParamsAsObject<ParamDef extends ParamsObj> =
+  InferTypeOfRow<ParamDef>;
+
+/**
+ * Defines a SpacetimeDB reducer function.
+ * Reducers are the primary way to modify the state of your SpacetimeDB application.
+ * They are atomic, meaning that either all operations within a reducer succeed,
+ * or none of them do.
+ * @template S - The inferred schema type of the SpacetimeDB module.
+ * @template Params - The type of the parameters object expected by the reducer.
+ * @param ctx - The reducer context, providing access to `sender`, `timestamp`, `connection_id`, and `db`.
+ * @param payload - An object containing the arguments passed to the reducer, typed according to `params`.
+ * @example
+ * ```typescript
+ * // Define a reducer named 'create_user' that takes 'username' (string) and 'email' (string)
+ * reducer(
+ *   'create_user',
+ *   {
+ *    username: t.string(),
+ *    email: t.string(),
+ *   },
+ *   (ctx, { username, email }) => {
+ *     // Access the 'user' table from the database view in the context
+ *     ctx.db.user.insert({ username, email, created_at: ctx.timestamp });
+ *     console.log(`User ${username} created by ${ctx.sender.identityId}`);
+ *   }
+ * );
+ * ```
+ */
+export type Reducer<S extends UntypedSchemaDef, Params extends ParamsObj> = (
+  ctx: ReducerCtx<S>,
+  payload: ParamsAsObject<Params>
+) => void;
+
+/**
+ * Authentication information for the caller of a reducer.
+ */
+export type AuthCtx = Readonly<{
+  /** Whether the caller is an internal system process. */
+  isInternal: boolean;
+  /** Whether the caller has authenticated with a JWT token. */
+  hasJWT: boolean;
+  /** The JWT claims associated with the caller, or null if hasJWT == false. */
+  jwt: JwtClaims | null;
+}>;
+
+export type JsonValue =
+  | string
+  | number
+  | boolean
+  | null
+  | Array<JsonValue>
+  | JsonObject;
+
+export interface JsonObject {
+  [key: string]: JsonValue;
+}
+
+/**
+ * Auth Claims extracted from the payload of a JWT token
+ */
+export interface JwtClaims {
+  /** The full payload as a JSON string */
+  readonly rawPayload: string;
+  /** The subject of the JWT token ('sub') */
+  readonly subject: string;
+  /** The issuer of the JWT token ('iss') */
+  readonly issuer: string;
+  /** The audience of the JWT token ('aud') */
+  readonly audience: readonly string[];
+  /** The identity associated with the JWT token, which is based on the sub and iss */
+  readonly identity: Identity;
+  /** The full payload as a JsonObject */
+  readonly fullPayload: JsonObject;
+}
+
+/**
+ * Reducer context parametrized by the inferred Schema
+ */
+export type ReducerCtx<SchemaDef extends UntypedSchemaDef> = Readonly<{
+  sender: Identity;
+  databaseIdentity: Identity;
+  /** @deprecated Use `databaseIdentity` instead. */
+  identity: Identity;
+  timestamp: Timestamp;
+  connectionId: ConnectionId | null;
+  db: DbView<SchemaDef>;
+  senderAuth: AuthCtx;
+  newUuidV4(): Uuid;
+  newUuidV7(): Uuid;
+  random: Random;
+}>;

package/src/lib/result.ts

@@ -1,36 +1,36 @@
-import { AlgebraicType } from './algebraic_type';
-
-export type ResultAlgebraicType<
-  T extends AlgebraicType = AlgebraicType,
-  E extends AlgebraicType = AlgebraicType,
-> = {
-  tag: 'Sum';
-  value: {
-    variants: [
-      { name: 'ok'; algebraicType: T },
-      { name: 'err'; algebraicType: E },
-    ];
-  };
-};
-
-export const Result: {
-  getAlgebraicType<
-    T extends AlgebraicType = AlgebraicType,
-    E extends AlgebraicType = AlgebraicType,
-  >(
-    okType: T,
-    errType: E
-  ): ResultAlgebraicType<T, E>;
-} = {
-  getAlgebraicType<
-    T extends AlgebraicType = AlgebraicType,
-    E extends AlgebraicType = AlgebraicType,
-  >(okType: T, errType: E): ResultAlgebraicType<T, E> {
-    return AlgebraicType.Sum({
-      variants: [
-        { name: 'ok', algebraicType: okType },
-        { name: 'err', algebraicType: errType },
-      ],
-    });
-  },
-};
+import { AlgebraicType } from './algebraic_type';
+
+export type ResultAlgebraicType<
+  T extends AlgebraicType = AlgebraicType,
+  E extends AlgebraicType = AlgebraicType,
+> = {
+  tag: 'Sum';
+  value: {
+    variants: [
+      { name: 'ok'; algebraicType: T },
+      { name: 'err'; algebraicType: E },
+    ];
+  };
+};
+
+export const Result: {
+  getAlgebraicType<
+    T extends AlgebraicType = AlgebraicType,
+    E extends AlgebraicType = AlgebraicType,
+  >(
+    okType: T,
+    errType: E
+  ): ResultAlgebraicType<T, E>;
+} = {
+  getAlgebraicType<
+    T extends AlgebraicType = AlgebraicType,
+    E extends AlgebraicType = AlgebraicType,
+  >(okType: T, errType: E): ResultAlgebraicType<T, E> {
+    return AlgebraicType.Sum({
+      variants: [
+        { name: 'ok', algebraicType: okType },
+        { name: 'err', algebraicType: errType },
+      ],
+    });
+  },
+};

package/src/lib/schedule_at.ts

@@ -1,86 +1,86 @@
-import { AlgebraicType } from './algebraic_type';
-import { TimeDuration, type TimeDurationAlgebraicType } from './time_duration';
-import { Timestamp, type TimestampAlgebraicType } from './timestamp';
-
-export type ScheduleAtAlgebraicType = {
-  tag: 'Sum';
-  value: {
-    variants: [
-      { name: 'Interval'; algebraicType: TimeDurationAlgebraicType },
-      { name: 'Time'; algebraicType: TimestampAlgebraicType },
-    ];
-  };
-};
-
-type ScheduleAtType = Interval | Time;
-
-export const ScheduleAt: {
-  interval: (micros: bigint) => ScheduleAtType;
-  time: (microsSinceUnixEpoch: bigint) => ScheduleAtType;
-  /**
-   * Get the algebraic type representation of the {@link ScheduleAt} type.
-   * @returns The algebraic type representation of the type.
-   */
-  getAlgebraicType(): ScheduleAtAlgebraicType;
-  isScheduleAt(
-    algebraicType: AlgebraicType
-  ): algebraicType is ScheduleAtAlgebraicType;
-} = {
-  interval(value: bigint): ScheduleAtType {
-    return Interval(value);
-  },
-  time(value: bigint): ScheduleAtType {
-    return Time(value);
-  },
-  getAlgebraicType(): ScheduleAtAlgebraicType {
-    return AlgebraicType.Sum({
-      variants: [
-        {
-          name: 'Interval',
-          algebraicType: TimeDuration.getAlgebraicType(),
-        },
-        { name: 'Time', algebraicType: Timestamp.getAlgebraicType() },
-      ],
-    });
-  },
-  isScheduleAt(
-    algebraicType: AlgebraicType
-  ): algebraicType is ScheduleAtAlgebraicType {
-    if (algebraicType.tag !== 'Sum') {
-      return false;
-    }
-    const variants = algebraicType.value.variants;
-    if (variants.length !== 2) {
-      return false;
-    }
-    const intervalVariant = variants.find(v => v.name === 'Interval');
-    const timeVariant = variants.find(v => v.name === 'Time');
-    if (!intervalVariant || !timeVariant) {
-      return false;
-    }
-    return (
-      TimeDuration.isTimeDuration(intervalVariant.algebraicType) &&
-      Timestamp.isTimestamp(timeVariant.algebraicType)
-    );
-  },
-};
-
-export type Interval = {
-  tag: 'Interval';
-  value: TimeDuration;
-};
-export const Interval = (micros: bigint): Interval => ({
-  tag: 'Interval',
-  value: new TimeDuration(micros),
-});
-export type Time = {
-  tag: 'Time';
-  value: Timestamp;
-};
-export const Time = (microsSinceUnixEpoch: bigint): Time => ({
-  tag: 'Time',
-  value: new Timestamp(microsSinceUnixEpoch),
-});
-
-export default ScheduleAt;
-export type ScheduleAt = ScheduleAtType;
+import { AlgebraicType } from './algebraic_type';
+import { TimeDuration, type TimeDurationAlgebraicType } from './time_duration';
+import { Timestamp, type TimestampAlgebraicType } from './timestamp';
+
+export type ScheduleAtAlgebraicType = {
+  tag: 'Sum';
+  value: {
+    variants: [
+      { name: 'Interval'; algebraicType: TimeDurationAlgebraicType },
+      { name: 'Time'; algebraicType: TimestampAlgebraicType },
+    ];
+  };
+};
+
+type ScheduleAtType = Interval | Time;
+
+export const ScheduleAt: {
+  interval: (micros: bigint) => ScheduleAtType;
+  time: (microsSinceUnixEpoch: bigint) => ScheduleAtType;
+  /**
+   * Get the algebraic type representation of the {@link ScheduleAt} type.
+   * @returns The algebraic type representation of the type.
+   */
+  getAlgebraicType(): ScheduleAtAlgebraicType;
+  isScheduleAt(
+    algebraicType: AlgebraicType
+  ): algebraicType is ScheduleAtAlgebraicType;
+} = {
+  interval(value: bigint): ScheduleAtType {
+    return Interval(value);
+  },
+  time(value: bigint): ScheduleAtType {
+    return Time(value);
+  },
+  getAlgebraicType(): ScheduleAtAlgebraicType {
+    return AlgebraicType.Sum({
+      variants: [
+        {
+          name: 'Interval',
+          algebraicType: TimeDuration.getAlgebraicType(),
+        },
+        { name: 'Time', algebraicType: Timestamp.getAlgebraicType() },
+      ],
+    });
+  },
+  isScheduleAt(
+    algebraicType: AlgebraicType
+  ): algebraicType is ScheduleAtAlgebraicType {
+    if (algebraicType.tag !== 'Sum') {
+      return false;
+    }
+    const variants = algebraicType.value.variants;
+    if (variants.length !== 2) {
+      return false;
+    }
+    const intervalVariant = variants.find(v => v.name === 'Interval');
+    const timeVariant = variants.find(v => v.name === 'Time');
+    if (!intervalVariant || !timeVariant) {
+      return false;
+    }
+    return (
+      TimeDuration.isTimeDuration(intervalVariant.algebraicType) &&
+      Timestamp.isTimestamp(timeVariant.algebraicType)
+    );
+  },
+};
+
+export type Interval = {
+  tag: 'Interval';
+  value: TimeDuration;
+};
+export const Interval = (micros: bigint): Interval => ({
+  tag: 'Interval',
+  value: new TimeDuration(micros),
+});
+export type Time = {
+  tag: 'Time';
+  value: Timestamp;
+};
+export const Time = (microsSinceUnixEpoch: bigint): Time => ({
+  tag: 'Time',
+  value: new Timestamp(microsSinceUnixEpoch),
+});
+
+export default ScheduleAt;
+export type ScheduleAt = ScheduleAtType;