spacetimedb 2.5.0 → 2.6.0

package/src/lib/table_schema.ts

@@ -1,64 +1,64 @@
-import type { ProcedureExport, ReducerExport } from '../server';
-import type { ProductType } from './algebraic_type';
-import type { RawScheduleDefV10, RawTableDefV10 } from './autogen/types';
-import type { IndexOpts } from './indexes';
-import type { ModuleContext } from './schema';
-import type { ColumnBuilder, RowBuilder } from './type_builders';
-
-/**
- * Represents a handle to a database table, including its name, row type, and row spacetime type.
- */
-export type TableSchema<
-  Row extends Record<string, ColumnBuilder<any, any, any>>,
-  Idx extends readonly IndexOpts<keyof Row & string>[],
-> = {
-  /**
-   * The name of the table.
-   */
-  readonly tableName?: string;
-
-  /**
-   * The TypeBuilder representation of the type of the rows in the table.
-   **/
-  readonly rowType: RowBuilder<Row>;
-
-  /**
-   * The {@link ProductType} representing the structure of a row in the table.
-   */
-  readonly rowSpacetimeType: RowBuilder<Row>['algebraicType']['value'];
-
-  /**
-   * The {@link RawTableDefV10} of the configured table
-   */
-  tableDef(
-    ctx: ModuleContext,
-    accName: string
-  ): RawTableDefV10 & { schedule?: RawScheduleDefV10 };
-
-  /**
-   * The indexes defined on the table.
-   */
-  readonly idxs: Idx;
-
-  /**
-   * The constraints defined on the table.
-   */
-  readonly constraints: readonly {
-    name: string | undefined;
-    constraint: 'unique';
-    columns: [any];
-  }[];
-
-  /**
-   * The schedule defined on the table, if any.
-   */
-  readonly schedule?: {
-    scheduleAtCol: number;
-    reducer: () => ReducerExport<any, any> | ProcedureExport<any, any, any>;
-  };
-};
-
-export type UntypedTableSchema = TableSchema<
-  Record<string, ColumnBuilder<any, any, any>>,
-  readonly IndexOpts<string>[]
->;
+import type { ProcedureExport, ReducerExport } from '../server';
+import type { ProductType } from './algebraic_type';
+import type { RawScheduleDefV10, RawTableDefV10 } from './autogen/types';
+import type { IndexOpts } from './indexes';
+import type { ModuleContext } from './schema';
+import type { ColumnBuilder, RowBuilder } from './type_builders';
+
+/**
+ * Represents a handle to a database table, including its name, row type, and row spacetime type.
+ */
+export type TableSchema<
+  Row extends Record<string, ColumnBuilder<any, any, any>>,
+  Idx extends readonly IndexOpts<keyof Row & string>[],
+> = {
+  /**
+   * The name of the table.
+   */
+  readonly tableName?: string;
+
+  /**
+   * The TypeBuilder representation of the type of the rows in the table.
+   **/
+  readonly rowType: RowBuilder<Row>;
+
+  /**
+   * The {@link ProductType} representing the structure of a row in the table.
+   */
+  readonly rowSpacetimeType: RowBuilder<Row>['algebraicType']['value'];
+
+  /**
+   * The {@link RawTableDefV10} of the configured table
+   */
+  tableDef(
+    ctx: ModuleContext,
+    accName: string
+  ): RawTableDefV10 & { schedule?: RawScheduleDefV10 };
+
+  /**
+   * The indexes defined on the table.
+   */
+  readonly idxs: Idx;
+
+  /**
+   * The constraints defined on the table.
+   */
+  readonly constraints: readonly {
+    name: string | undefined;
+    constraint: 'unique';
+    columns: [any];
+  }[];
+
+  /**
+   * The schedule defined on the table, if any.
+   */
+  readonly schedule?: {
+    scheduleAtCol: number;
+    reducer: () => ReducerExport<any, any> | ProcedureExport<any, any, any>;
+  };
+};
+
+export type UntypedTableSchema = TableSchema<
+  Record<string, ColumnBuilder<any, any, any>>,
+  readonly IndexOpts<string>[]
+>;

package/src/lib/time_duration.ts

@@ -1,77 +1,77 @@
-import { AlgebraicType } from './algebraic_type';
-
-export type TimeDurationAlgebraicType = {
-  tag: 'Product';
-  value: {
-    elements: [
-      { name: '__time_duration_micros__'; algebraicType: { tag: 'I64' } },
-    ];
-  };
-};
-
-/**
- * A difference between two points in time, represented as a number of microseconds.
- */
-export class TimeDuration {
-  __time_duration_micros__: bigint;
-
-  private static MICROS_PER_MILLIS: bigint = 1000n;
-
-  /**
-   * Get the algebraic type representation of the {@link TimeDuration} type.
-   * @returns The algebraic type representation of the type.
-   */
-  static getAlgebraicType(): TimeDurationAlgebraicType {
-    return AlgebraicType.Product({
-      elements: [
-        {
-          name: '__time_duration_micros__',
-          algebraicType: AlgebraicType.I64,
-        },
-      ],
-    });
-  }
-
-  static isTimeDuration(
-    algebraicType: AlgebraicType
-  ): algebraicType is TimeDurationAlgebraicType {
-    if (algebraicType.tag !== 'Product') {
-      return false;
-    }
-    const elements = algebraicType.value.elements;
-    if (elements.length !== 1) {
-      return false;
-    }
-    const microsElement = elements[0];
-    return (
-      microsElement.name === '__time_duration_micros__' &&
-      microsElement.algebraicType.tag === 'I64'
-    );
-  }
-
-  get micros(): bigint {
-    return this.__time_duration_micros__;
-  }
-
-  get millis(): number {
-    return Number(this.micros / TimeDuration.MICROS_PER_MILLIS);
-  }
-
-  constructor(micros: bigint) {
-    this.__time_duration_micros__ = micros;
-  }
-
-  static fromMillis(millis: number): TimeDuration {
-    return new TimeDuration(BigInt(millis) * TimeDuration.MICROS_PER_MILLIS);
-  }
-
-  /** This outputs the same string format that we use in the host and in Rust modules */
-  toString(): string {
-    const micros = this.micros;
-    const sign = micros < 0 ? '-' : '+';
-    const pos = micros < 0 ? -micros : micros;
-    const secs = pos / 1_000_000n;
-    const micros_remaining = pos % 1_000_000n;
-    return `${sign}${secs}.${String(micros_remaining).padStart(6, '0')}`;
-  }
-}
+import { AlgebraicType } from './algebraic_type';
+
+export type TimeDurationAlgebraicType = {
+  tag: 'Product';
+  value: {
+    elements: [
+      { name: '__time_duration_micros__'; algebraicType: { tag: 'I64' } },
+    ];
+  };
+};
+
+/**
+ * A difference between two points in time, represented as a number of microseconds.
+ */
+export class TimeDuration {
+  __time_duration_micros__: bigint;
+
+  private static MICROS_PER_MILLIS: bigint = 1000n;
+
+  /**
+   * Get the algebraic type representation of the {@link TimeDuration} type.
+   * @returns The algebraic type representation of the type.
+   */
+  static getAlgebraicType(): TimeDurationAlgebraicType {
+    return AlgebraicType.Product({
+      elements: [
+        {
+          name: '__time_duration_micros__',
+          algebraicType: AlgebraicType.I64,
+        },
+      ],
+    });
+  }
+
+  static isTimeDuration(
+    algebraicType: AlgebraicType
+  ): algebraicType is TimeDurationAlgebraicType {
+    if (algebraicType.tag !== 'Product') {
+      return false;
+    }
+    const elements = algebraicType.value.elements;
+    if (elements.length !== 1) {
+      return false;
+    }
+    const microsElement = elements[0];
+    return (
+      microsElement.name === '__time_duration_micros__' &&
+      microsElement.algebraicType.tag === 'I64'
+    );
+  }
+
+  get micros(): bigint {
+    return this.__time_duration_micros__;
+  }
+
+  get millis(): number {
+    return Number(this.micros / TimeDuration.MICROS_PER_MILLIS);
+  }
+
+  constructor(micros: bigint) {
+    this.__time_duration_micros__ = micros;
+  }
+
+  static fromMillis(millis: number): TimeDuration {
+    return new TimeDuration(BigInt(millis) * TimeDuration.MICROS_PER_MILLIS);
+  }
+
+  /** This outputs the same string format that we use in the host and in Rust modules */
+  toString(): string {
+    const micros = this.micros;
+    const sign = micros < 0 ? '-' : '+';
+    const pos = micros < 0 ? -micros : micros;
+    const secs = pos / 1_000_000n;
+    const micros_remaining = pos % 1_000_000n;
+    return `${sign}${secs}.${String(micros_remaining).padStart(6, '0')}`;
+  }
+}

package/src/lib/timestamp.ts

@@ -1,148 +1,148 @@
-import { AlgebraicType } from './algebraic_type';
-import { TimeDuration } from './time_duration';
-
-export type TimestampAlgebraicType = {
-  tag: 'Product';
-  value: {
-    elements: [
-      {
-        name: '__timestamp_micros_since_unix_epoch__';
-        algebraicType: { tag: 'I64' };
-      },
-    ];
-  };
-};
-
-/**
- * A point in time, represented as a number of microseconds since the Unix epoch.
- */
-export class Timestamp {
-  __timestamp_micros_since_unix_epoch__: bigint;
-
-  private static MICROS_PER_MILLIS: bigint = 1000n;
-
-  get microsSinceUnixEpoch(): bigint {
-    return this.__timestamp_micros_since_unix_epoch__;
-  }
-
-  constructor(micros: bigint) {
-    this.__timestamp_micros_since_unix_epoch__ = micros;
-  }
-
-  /**
-   * Get the algebraic type representation of the {@link Timestamp} type.
-   * @returns The algebraic type representation of the type.
-   */
-  static getAlgebraicType(): TimestampAlgebraicType {
-    return AlgebraicType.Product({
-      elements: [
-        {
-          name: '__timestamp_micros_since_unix_epoch__',
-          algebraicType: AlgebraicType.I64,
-        },
-      ],
-    });
-  }
-
-  static isTimestamp(
-    algebraicType: AlgebraicType
-  ): algebraicType is TimestampAlgebraicType {
-    if (algebraicType.tag !== 'Product') {
-      return false;
-    }
-    const elements = algebraicType.value.elements;
-    if (elements.length !== 1) {
-      return false;
-    }
-    const microsElement = elements[0];
-    return (
-      microsElement.name === '__timestamp_micros_since_unix_epoch__' &&
-      microsElement.algebraicType.tag === 'I64'
-    );
-  }
-
-  /**
-   * The Unix epoch, the midnight at the beginning of January 1, 1970, UTC.
-   */
-  static UNIX_EPOCH: Timestamp = new Timestamp(0n);
-
-  /**
-   * Get a `Timestamp` representing the execution environment's belief of the current moment in time.
-   */
-  static now(): Timestamp {
-    return Timestamp.fromDate(new Date());
-  }
-
-  /** Convert to milliseconds since Unix epoch. */
-  toMillis(): bigint {
-    return this.microsSinceUnixEpoch / 1000n;
-  }
-
-  /**
-   * Get a `Timestamp` representing the same point in time as `date`.
-   */
-  static fromDate(date: Date): Timestamp {
-    const millis = date.getTime();
-    const micros = BigInt(millis) * Timestamp.MICROS_PER_MILLIS;
-    return new Timestamp(micros);
-  }
-
-  /**
-   * Get a `Date` representing approximately the same point in time as `this`.
-   *
-   * This method truncates to millisecond precision,
-   * and throws `RangeError` if the `Timestamp` is outside the range representable as a `Date`.
-   */
-  toDate(): Date {
-    const micros = this.__timestamp_micros_since_unix_epoch__;
-    const millis = micros / Timestamp.MICROS_PER_MILLIS;
-    if (
-      millis > BigInt(Number.MAX_SAFE_INTEGER) ||
-      millis < BigInt(Number.MIN_SAFE_INTEGER)
-    ) {
-      throw new RangeError(
-        "Timestamp is outside of the representable range of JS's Date"
-      );
-    }
-    return new Date(Number(millis));
-  }
-
-  /**
-   * Get an ISO 8601 / RFC 3339 formatted string representation of this timestamp with microsecond precision.
-   *
-   * This method preserves the full microsecond precision of the timestamp,
-   * and throws `RangeError` if the `Timestamp` is outside the range representable in ISO format.
-   *
-   * @returns ISO 8601 formatted string with microsecond precision (e.g., '2025-02-17T10:30:45.123456Z')
-   */
-  toISOString(): string {
-    const micros = this.__timestamp_micros_since_unix_epoch__;
-    const millis = micros / Timestamp.MICROS_PER_MILLIS;
-
-    if (
-      millis > BigInt(Number.MAX_SAFE_INTEGER) ||
-      millis < BigInt(Number.MIN_SAFE_INTEGER)
-    ) {
-      throw new RangeError(
-        'Timestamp is outside of the representable range for ISO string formatting'
-      );
-    }
-
-    const date = new Date(Number(millis));
-    const isoBase = date.toISOString(); // Format: '2025-02-17T10:30:45.123Z'
-
-    // Extract the full 6 decimal places of microseconds
-    const microsRemainder = Math.abs(Number(micros % 1000000n));
-    const fractionalPart = String(microsRemainder).padStart(6, '0');
-
-    // Replace the 3-digit millisecond part with the full 6-digit microsecond part
-    return isoBase.replace(/\.\d{3}Z$/, `.${fractionalPart}Z`);
-  }
-
-  since(other: Timestamp): TimeDuration {
-    return new TimeDuration(
-      this.__timestamp_micros_since_unix_epoch__ -
-        other.__timestamp_micros_since_unix_epoch__
-    );
-  }
-}
+import { AlgebraicType } from './algebraic_type';
+import { TimeDuration } from './time_duration';
+
+export type TimestampAlgebraicType = {
+  tag: 'Product';
+  value: {
+    elements: [
+      {
+        name: '__timestamp_micros_since_unix_epoch__';
+        algebraicType: { tag: 'I64' };
+      },
+    ];
+  };
+};
+
+/**
+ * A point in time, represented as a number of microseconds since the Unix epoch.
+ */
+export class Timestamp {
+  __timestamp_micros_since_unix_epoch__: bigint;
+
+  private static MICROS_PER_MILLIS: bigint = 1000n;
+
+  get microsSinceUnixEpoch(): bigint {
+    return this.__timestamp_micros_since_unix_epoch__;
+  }
+
+  constructor(micros: bigint) {
+    this.__timestamp_micros_since_unix_epoch__ = micros;
+  }
+
+  /**
+   * Get the algebraic type representation of the {@link Timestamp} type.
+   * @returns The algebraic type representation of the type.
+   */
+  static getAlgebraicType(): TimestampAlgebraicType {
+    return AlgebraicType.Product({
+      elements: [
+        {
+          name: '__timestamp_micros_since_unix_epoch__',
+          algebraicType: AlgebraicType.I64,
+        },
+      ],
+    });
+  }
+
+  static isTimestamp(
+    algebraicType: AlgebraicType
+  ): algebraicType is TimestampAlgebraicType {
+    if (algebraicType.tag !== 'Product') {
+      return false;
+    }
+    const elements = algebraicType.value.elements;
+    if (elements.length !== 1) {
+      return false;
+    }
+    const microsElement = elements[0];
+    return (
+      microsElement.name === '__timestamp_micros_since_unix_epoch__' &&
+      microsElement.algebraicType.tag === 'I64'
+    );
+  }
+
+  /**
+   * The Unix epoch, the midnight at the beginning of January 1, 1970, UTC.
+   */
+  static UNIX_EPOCH: Timestamp = new Timestamp(0n);
+
+  /**
+   * Get a `Timestamp` representing the execution environment's belief of the current moment in time.
+   */
+  static now(): Timestamp {
+    return Timestamp.fromDate(new Date());
+  }
+
+  /** Convert to milliseconds since Unix epoch. */
+  toMillis(): bigint {
+    return this.microsSinceUnixEpoch / 1000n;
+  }
+
+  /**
+   * Get a `Timestamp` representing the same point in time as `date`.
+   */
+  static fromDate(date: Date): Timestamp {
+    const millis = date.getTime();
+    const micros = BigInt(millis) * Timestamp.MICROS_PER_MILLIS;
+    return new Timestamp(micros);
+  }
+
+  /**
+   * Get a `Date` representing approximately the same point in time as `this`.
+   *
+   * This method truncates to millisecond precision,
+   * and throws `RangeError` if the `Timestamp` is outside the range representable as a `Date`.
+   */
+  toDate(): Date {
+    const micros = this.__timestamp_micros_since_unix_epoch__;
+    const millis = micros / Timestamp.MICROS_PER_MILLIS;
+    if (
+      millis > BigInt(Number.MAX_SAFE_INTEGER) ||
+      millis < BigInt(Number.MIN_SAFE_INTEGER)
+    ) {
+      throw new RangeError(
+        "Timestamp is outside of the representable range of JS's Date"
+      );
+    }
+    return new Date(Number(millis));
+  }
+
+  /**
+   * Get an ISO 8601 / RFC 3339 formatted string representation of this timestamp with microsecond precision.
+   *
+   * This method preserves the full microsecond precision of the timestamp,
+   * and throws `RangeError` if the `Timestamp` is outside the range representable in ISO format.
+   *
+   * @returns ISO 8601 formatted string with microsecond precision (e.g., '2025-02-17T10:30:45.123456Z')
+   */
+  toISOString(): string {
+    const micros = this.__timestamp_micros_since_unix_epoch__;
+    const millis = micros / Timestamp.MICROS_PER_MILLIS;
+
+    if (
+      millis > BigInt(Number.MAX_SAFE_INTEGER) ||
+      millis < BigInt(Number.MIN_SAFE_INTEGER)
+    ) {
+      throw new RangeError(
+        'Timestamp is outside of the representable range for ISO string formatting'
+      );
+    }
+
+    const date = new Date(Number(millis));
+    const isoBase = date.toISOString(); // Format: '2025-02-17T10:30:45.123Z'
+
+    // Extract the full 6 decimal places of microseconds
+    const microsRemainder = Math.abs(Number(micros % 1000000n));
+    const fractionalPart = String(microsRemainder).padStart(6, '0');
+
+    // Replace the 3-digit millisecond part with the full 6-digit microsecond part
+    return isoBase.replace(/\.\d{3}Z$/, `.${fractionalPart}Z`);
+  }
+
+  since(other: Timestamp): TimeDuration {
+    return new TimeDuration(
+      this.__timestamp_micros_since_unix_epoch__ -
+        other.__timestamp_micros_since_unix_epoch__
+    );
+  }
+}