spacetimedb 2.4.1 → 2.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (194) hide show
  1. package/LICENSE.txt +759 -759
  2. package/README.md +211 -120
  3. package/dist/angular/index.cjs.map +1 -1
  4. package/dist/angular/index.mjs.map +1 -1
  5. package/dist/browser/angular/index.mjs.map +1 -1
  6. package/dist/browser/react/index.mjs +129 -57
  7. package/dist/browser/react/index.mjs.map +1 -1
  8. package/dist/browser/solid/index.mjs +1933 -0
  9. package/dist/browser/solid/index.mjs.map +1 -0
  10. package/dist/browser/svelte/index.mjs.map +1 -1
  11. package/dist/browser/vue/index.mjs.map +1 -1
  12. package/dist/index.browser.mjs +10 -2
  13. package/dist/index.browser.mjs.map +1 -1
  14. package/dist/index.cjs +10 -2
  15. package/dist/index.cjs.map +1 -1
  16. package/dist/index.mjs +10 -2
  17. package/dist/index.mjs.map +1 -1
  18. package/dist/min/index.browser.mjs +1 -1
  19. package/dist/min/index.browser.mjs.map +1 -1
  20. package/dist/min/react/index.mjs +1 -1
  21. package/dist/min/react/index.mjs.map +1 -1
  22. package/dist/min/sdk/index.browser.mjs +1 -1
  23. package/dist/min/sdk/index.browser.mjs.map +1 -1
  24. package/dist/react/index.cjs +129 -57
  25. package/dist/react/index.cjs.map +1 -1
  26. package/dist/react/index.mjs +129 -57
  27. package/dist/react/index.mjs.map +1 -1
  28. package/dist/react/useTable.d.ts.map +1 -1
  29. package/dist/sdk/connection_manager.d.ts +8 -0
  30. package/dist/sdk/connection_manager.d.ts.map +1 -1
  31. package/dist/sdk/db_connection_impl.d.ts +7 -0
  32. package/dist/sdk/db_connection_impl.d.ts.map +1 -1
  33. package/dist/sdk/index.browser.mjs +10 -2
  34. package/dist/sdk/index.browser.mjs.map +1 -1
  35. package/dist/sdk/index.cjs +10 -2
  36. package/dist/sdk/index.cjs.map +1 -1
  37. package/dist/sdk/index.mjs +10 -2
  38. package/dist/sdk/index.mjs.map +1 -1
  39. package/dist/sdk/websocket_test_adapter.d.ts +2 -1
  40. package/dist/sdk/websocket_test_adapter.d.ts.map +1 -1
  41. package/dist/server/index.mjs.map +1 -1
  42. package/dist/server/runtime.d.ts.map +1 -1
  43. package/dist/solid/SpacetimeDBProvider.d.ts +7 -0
  44. package/dist/solid/SpacetimeDBProvider.d.ts.map +1 -0
  45. package/dist/solid/connection_state.d.ts +6 -0
  46. package/dist/solid/connection_state.d.ts.map +1 -0
  47. package/dist/solid/index.cjs +1939 -0
  48. package/dist/solid/index.cjs.map +1 -0
  49. package/dist/solid/index.d.ts +6 -0
  50. package/dist/solid/index.d.ts.map +1 -0
  51. package/dist/solid/index.mjs +1933 -0
  52. package/dist/solid/index.mjs.map +1 -0
  53. package/dist/solid/useProcedure.d.ts +4 -0
  54. package/dist/solid/useProcedure.d.ts.map +1 -0
  55. package/dist/solid/useReducer.d.ts +4 -0
  56. package/dist/solid/useReducer.d.ts.map +1 -0
  57. package/dist/solid/useSpacetimeDB.d.ts +4 -0
  58. package/dist/solid/useSpacetimeDB.d.ts.map +1 -0
  59. package/dist/solid/useTable.d.ts +32 -0
  60. package/dist/solid/useTable.d.ts.map +1 -0
  61. package/dist/svelte/index.cjs.map +1 -1
  62. package/dist/svelte/index.mjs.map +1 -1
  63. package/dist/tanstack/index.cjs +120 -50
  64. package/dist/tanstack/index.cjs.map +1 -1
  65. package/dist/tanstack/index.mjs +120 -50
  66. package/dist/tanstack/index.mjs.map +1 -1
  67. package/dist/vue/index.cjs.map +1 -1
  68. package/dist/vue/index.mjs.map +1 -1
  69. package/package.json +13 -3
  70. package/src/angular/connection_state.ts +19 -19
  71. package/src/angular/index.ts +3 -3
  72. package/src/angular/injectors/index.ts +4 -4
  73. package/src/angular/injectors/inject-reducer.ts +62 -62
  74. package/src/angular/injectors/inject-spacetimedb-connected.ts +13 -13
  75. package/src/angular/injectors/inject-spacetimedb.ts +10 -10
  76. package/src/angular/injectors/inject-table.ts +234 -234
  77. package/src/angular/providers/index.ts +1 -1
  78. package/src/angular/providers/provide-spacetimedb.ts +96 -96
  79. package/src/index.ts +16 -16
  80. package/src/lib/algebraic_type.ts +819 -819
  81. package/src/lib/algebraic_type_variants.ts +26 -26
  82. package/src/lib/algebraic_value.ts +10 -10
  83. package/src/lib/autogen/types.ts +746 -746
  84. package/src/lib/binary_reader.ts +188 -188
  85. package/src/lib/binary_writer.ts +213 -213
  86. package/src/lib/connection_id.ts +102 -102
  87. package/src/lib/constraints.ts +48 -48
  88. package/src/lib/errors.ts +26 -26
  89. package/src/lib/filter.ts +195 -195
  90. package/src/lib/identity.ts +83 -83
  91. package/src/lib/indexes.ts +251 -251
  92. package/src/lib/option.ts +34 -34
  93. package/src/lib/query.ts +1019 -1019
  94. package/src/lib/reducer_schema.ts +38 -38
  95. package/src/lib/reducers.ts +116 -116
  96. package/src/lib/result.ts +36 -36
  97. package/src/lib/schedule_at.ts +86 -86
  98. package/src/lib/schema.ts +420 -420
  99. package/src/lib/table.ts +548 -548
  100. package/src/lib/table_schema.ts +64 -64
  101. package/src/lib/time_duration.ts +77 -77
  102. package/src/lib/timestamp.ts +148 -148
  103. package/src/lib/type_builders.test-d.ts +128 -128
  104. package/src/lib/type_builders.ts +4014 -4014
  105. package/src/lib/type_util.ts +124 -124
  106. package/src/lib/util.ts +196 -196
  107. package/src/lib/uuid.ts +337 -337
  108. package/src/react/SpacetimeDBProvider.ts +84 -84
  109. package/src/react/connection_state.ts +6 -6
  110. package/src/react/index.ts +5 -5
  111. package/src/react/useProcedure.ts +60 -60
  112. package/src/react/useReducer.ts +53 -53
  113. package/src/react/useSpacetimeDB.ts +18 -18
  114. package/src/react/useTable.ts +256 -251
  115. package/src/sdk/client_api/index.ts +114 -114
  116. package/src/sdk/client_api/types/procedures.ts +8 -8
  117. package/src/sdk/client_api/types/reducers.ts +8 -8
  118. package/src/sdk/client_api/types.ts +288 -288
  119. package/src/sdk/client_cache.ts +129 -129
  120. package/src/sdk/client_table.ts +179 -179
  121. package/src/sdk/connection_manager.ts +352 -237
  122. package/src/sdk/db_connection_builder.ts +290 -290
  123. package/src/sdk/db_connection_impl.ts +1356 -1347
  124. package/src/sdk/db_context.ts +28 -28
  125. package/src/sdk/db_view.ts +12 -12
  126. package/src/sdk/decompress.ts +51 -51
  127. package/src/sdk/event.ts +18 -18
  128. package/src/sdk/event_context.ts +51 -51
  129. package/src/sdk/event_emitter.ts +32 -32
  130. package/src/sdk/index.ts +14 -14
  131. package/src/sdk/internal.ts +2 -2
  132. package/src/sdk/json_api.ts +46 -46
  133. package/src/sdk/logger.ts +134 -134
  134. package/src/sdk/message_types.ts +46 -46
  135. package/src/sdk/procedures.ts +83 -83
  136. package/src/sdk/reducer_event.ts +20 -20
  137. package/src/sdk/reducer_handle.ts +12 -12
  138. package/src/sdk/reducers.ts +159 -159
  139. package/src/sdk/schema.ts +45 -45
  140. package/src/sdk/spacetime_module.ts +28 -28
  141. package/src/sdk/subscription_builder_impl.ts +275 -275
  142. package/src/sdk/table_cache.ts +581 -581
  143. package/src/sdk/type_utils.ts +19 -19
  144. package/src/sdk/version.ts +133 -133
  145. package/src/sdk/websocket_decompress_adapter.ts +63 -63
  146. package/src/sdk/websocket_protocols.ts +25 -25
  147. package/src/sdk/websocket_test_adapter.ts +107 -100
  148. package/src/sdk/websocket_v3_frames.ts +126 -126
  149. package/src/sdk/ws.ts +105 -105
  150. package/src/server/console.ts +81 -81
  151. package/src/server/db_view.ts +21 -21
  152. package/src/server/errors.ts +138 -138
  153. package/src/server/http.test-d.ts +80 -80
  154. package/src/server/http.ts +14 -14
  155. package/src/server/http_handlers.ts +413 -413
  156. package/src/server/http_internal.ts +79 -79
  157. package/src/server/http_shared.ts +186 -186
  158. package/src/server/index.ts +37 -37
  159. package/src/server/polyfills.ts +4 -4
  160. package/src/server/procedures.ts +239 -239
  161. package/src/server/query.ts +1 -1
  162. package/src/server/range.ts +53 -53
  163. package/src/server/reducers.ts +113 -113
  164. package/src/server/rng.ts +113 -113
  165. package/src/server/runtime.ts +1102 -1102
  166. package/src/server/schema.test-d.ts +99 -99
  167. package/src/server/schema.ts +663 -663
  168. package/src/server/sys.d.ts +125 -125
  169. package/src/server/view.test-d.ts +194 -194
  170. package/src/server/views.ts +340 -340
  171. package/src/solid/SpacetimeDBProvider.ts +97 -0
  172. package/src/solid/connection_state.ts +6 -0
  173. package/src/solid/index.ts +5 -0
  174. package/src/solid/useProcedure.ts +57 -0
  175. package/src/solid/useReducer.ts +50 -0
  176. package/src/solid/useSpacetimeDB.ts +18 -0
  177. package/src/solid/useTable.ts +203 -0
  178. package/src/svelte/SpacetimeDBProvider.ts +101 -101
  179. package/src/svelte/connection_state.ts +16 -16
  180. package/src/svelte/index.ts +4 -4
  181. package/src/svelte/useReducer.ts +61 -61
  182. package/src/svelte/useSpacetimeDB.ts +22 -22
  183. package/src/svelte/useTable.ts +218 -218
  184. package/src/tanstack/SpacetimeDBQueryClient.ts +330 -330
  185. package/src/tanstack/hooks.ts +83 -83
  186. package/src/tanstack/index.ts +16 -16
  187. package/src/util-stub.ts +1 -1
  188. package/src/vue/SpacetimeDBProvider.ts +157 -157
  189. package/src/vue/connection_state.ts +19 -19
  190. package/src/vue/index.ts +5 -5
  191. package/src/vue/useProcedure.ts +62 -62
  192. package/src/vue/useReducer.ts +55 -55
  193. package/src/vue/useSpacetimeDB.ts +18 -18
  194. package/src/vue/useTable.ts +229 -229
@@ -1,64 +1,64 @@
1
- import type { ProcedureExport, ReducerExport } from '../server';
2
- import type { ProductType } from './algebraic_type';
3
- import type { RawScheduleDefV10, RawTableDefV10 } from './autogen/types';
4
- import type { IndexOpts } from './indexes';
5
- import type { ModuleContext } from './schema';
6
- import type { ColumnBuilder, RowBuilder } from './type_builders';
7
-
8
- /**
9
- * Represents a handle to a database table, including its name, row type, and row spacetime type.
10
- */
11
- export type TableSchema<
12
- Row extends Record<string, ColumnBuilder<any, any, any>>,
13
- Idx extends readonly IndexOpts<keyof Row & string>[],
14
- > = {
15
- /**
16
- * The name of the table.
17
- */
18
- readonly tableName?: string;
19
-
20
- /**
21
- * The TypeBuilder representation of the type of the rows in the table.
22
- **/
23
- readonly rowType: RowBuilder<Row>;
24
-
25
- /**
26
- * The {@link ProductType} representing the structure of a row in the table.
27
- */
28
- readonly rowSpacetimeType: RowBuilder<Row>['algebraicType']['value'];
29
-
30
- /**
31
- * The {@link RawTableDefV10} of the configured table
32
- */
33
- tableDef(
34
- ctx: ModuleContext,
35
- accName: string
36
- ): RawTableDefV10 & { schedule?: RawScheduleDefV10 };
37
-
38
- /**
39
- * The indexes defined on the table.
40
- */
41
- readonly idxs: Idx;
42
-
43
- /**
44
- * The constraints defined on the table.
45
- */
46
- readonly constraints: readonly {
47
- name: string | undefined;
48
- constraint: 'unique';
49
- columns: [any];
50
- }[];
51
-
52
- /**
53
- * The schedule defined on the table, if any.
54
- */
55
- readonly schedule?: {
56
- scheduleAtCol: number;
57
- reducer: () => ReducerExport<any, any> | ProcedureExport<any, any, any>;
58
- };
59
- };
60
-
61
- export type UntypedTableSchema = TableSchema<
62
- Record<string, ColumnBuilder<any, any, any>>,
63
- readonly IndexOpts<string>[]
64
- >;
1
+ import type { ProcedureExport, ReducerExport } from '../server';
2
+ import type { ProductType } from './algebraic_type';
3
+ import type { RawScheduleDefV10, RawTableDefV10 } from './autogen/types';
4
+ import type { IndexOpts } from './indexes';
5
+ import type { ModuleContext } from './schema';
6
+ import type { ColumnBuilder, RowBuilder } from './type_builders';
7
+
8
+ /**
9
+ * Represents a handle to a database table, including its name, row type, and row spacetime type.
10
+ */
11
+ export type TableSchema<
12
+ Row extends Record<string, ColumnBuilder<any, any, any>>,
13
+ Idx extends readonly IndexOpts<keyof Row & string>[],
14
+ > = {
15
+ /**
16
+ * The name of the table.
17
+ */
18
+ readonly tableName?: string;
19
+
20
+ /**
21
+ * The TypeBuilder representation of the type of the rows in the table.
22
+ **/
23
+ readonly rowType: RowBuilder<Row>;
24
+
25
+ /**
26
+ * The {@link ProductType} representing the structure of a row in the table.
27
+ */
28
+ readonly rowSpacetimeType: RowBuilder<Row>['algebraicType']['value'];
29
+
30
+ /**
31
+ * The {@link RawTableDefV10} of the configured table
32
+ */
33
+ tableDef(
34
+ ctx: ModuleContext,
35
+ accName: string
36
+ ): RawTableDefV10 & { schedule?: RawScheduleDefV10 };
37
+
38
+ /**
39
+ * The indexes defined on the table.
40
+ */
41
+ readonly idxs: Idx;
42
+
43
+ /**
44
+ * The constraints defined on the table.
45
+ */
46
+ readonly constraints: readonly {
47
+ name: string | undefined;
48
+ constraint: 'unique';
49
+ columns: [any];
50
+ }[];
51
+
52
+ /**
53
+ * The schedule defined on the table, if any.
54
+ */
55
+ readonly schedule?: {
56
+ scheduleAtCol: number;
57
+ reducer: () => ReducerExport<any, any> | ProcedureExport<any, any, any>;
58
+ };
59
+ };
60
+
61
+ export type UntypedTableSchema = TableSchema<
62
+ Record<string, ColumnBuilder<any, any, any>>,
63
+ readonly IndexOpts<string>[]
64
+ >;
@@ -1,77 +1,77 @@
1
- import { AlgebraicType } from './algebraic_type';
2
-
3
- export type TimeDurationAlgebraicType = {
4
- tag: 'Product';
5
- value: {
6
- elements: [
7
- { name: '__time_duration_micros__'; algebraicType: { tag: 'I64' } },
8
- ];
9
- };
10
- };
11
-
12
- /**
13
- * A difference between two points in time, represented as a number of microseconds.
14
- */
15
- export class TimeDuration {
16
- __time_duration_micros__: bigint;
17
-
18
- private static MICROS_PER_MILLIS: bigint = 1000n;
19
-
20
- /**
21
- * Get the algebraic type representation of the {@link TimeDuration} type.
22
- * @returns The algebraic type representation of the type.
23
- */
24
- static getAlgebraicType(): TimeDurationAlgebraicType {
25
- return AlgebraicType.Product({
26
- elements: [
27
- {
28
- name: '__time_duration_micros__',
29
- algebraicType: AlgebraicType.I64,
30
- },
31
- ],
32
- });
33
- }
34
-
35
- static isTimeDuration(
36
- algebraicType: AlgebraicType
37
- ): algebraicType is TimeDurationAlgebraicType {
38
- if (algebraicType.tag !== 'Product') {
39
- return false;
40
- }
41
- const elements = algebraicType.value.elements;
42
- if (elements.length !== 1) {
43
- return false;
44
- }
45
- const microsElement = elements[0];
46
- return (
47
- microsElement.name === '__time_duration_micros__' &&
48
- microsElement.algebraicType.tag === 'I64'
49
- );
50
- }
51
-
52
- get micros(): bigint {
53
- return this.__time_duration_micros__;
54
- }
55
-
56
- get millis(): number {
57
- return Number(this.micros / TimeDuration.MICROS_PER_MILLIS);
58
- }
59
-
60
- constructor(micros: bigint) {
61
- this.__time_duration_micros__ = micros;
62
- }
63
-
64
- static fromMillis(millis: number): TimeDuration {
65
- return new TimeDuration(BigInt(millis) * TimeDuration.MICROS_PER_MILLIS);
66
- }
67
-
68
- /** This outputs the same string format that we use in the host and in Rust modules */
69
- toString(): string {
70
- const micros = this.micros;
71
- const sign = micros < 0 ? '-' : '+';
72
- const pos = micros < 0 ? -micros : micros;
73
- const secs = pos / 1_000_000n;
74
- const micros_remaining = pos % 1_000_000n;
75
- return `${sign}${secs}.${String(micros_remaining).padStart(6, '0')}`;
76
- }
77
- }
1
+ import { AlgebraicType } from './algebraic_type';
2
+
3
+ export type TimeDurationAlgebraicType = {
4
+ tag: 'Product';
5
+ value: {
6
+ elements: [
7
+ { name: '__time_duration_micros__'; algebraicType: { tag: 'I64' } },
8
+ ];
9
+ };
10
+ };
11
+
12
+ /**
13
+ * A difference between two points in time, represented as a number of microseconds.
14
+ */
15
+ export class TimeDuration {
16
+ __time_duration_micros__: bigint;
17
+
18
+ private static MICROS_PER_MILLIS: bigint = 1000n;
19
+
20
+ /**
21
+ * Get the algebraic type representation of the {@link TimeDuration} type.
22
+ * @returns The algebraic type representation of the type.
23
+ */
24
+ static getAlgebraicType(): TimeDurationAlgebraicType {
25
+ return AlgebraicType.Product({
26
+ elements: [
27
+ {
28
+ name: '__time_duration_micros__',
29
+ algebraicType: AlgebraicType.I64,
30
+ },
31
+ ],
32
+ });
33
+ }
34
+
35
+ static isTimeDuration(
36
+ algebraicType: AlgebraicType
37
+ ): algebraicType is TimeDurationAlgebraicType {
38
+ if (algebraicType.tag !== 'Product') {
39
+ return false;
40
+ }
41
+ const elements = algebraicType.value.elements;
42
+ if (elements.length !== 1) {
43
+ return false;
44
+ }
45
+ const microsElement = elements[0];
46
+ return (
47
+ microsElement.name === '__time_duration_micros__' &&
48
+ microsElement.algebraicType.tag === 'I64'
49
+ );
50
+ }
51
+
52
+ get micros(): bigint {
53
+ return this.__time_duration_micros__;
54
+ }
55
+
56
+ get millis(): number {
57
+ return Number(this.micros / TimeDuration.MICROS_PER_MILLIS);
58
+ }
59
+
60
+ constructor(micros: bigint) {
61
+ this.__time_duration_micros__ = micros;
62
+ }
63
+
64
+ static fromMillis(millis: number): TimeDuration {
65
+ return new TimeDuration(BigInt(millis) * TimeDuration.MICROS_PER_MILLIS);
66
+ }
67
+
68
+ /** This outputs the same string format that we use in the host and in Rust modules */
69
+ toString(): string {
70
+ const micros = this.micros;
71
+ const sign = micros < 0 ? '-' : '+';
72
+ const pos = micros < 0 ? -micros : micros;
73
+ const secs = pos / 1_000_000n;
74
+ const micros_remaining = pos % 1_000_000n;
75
+ return `${sign}${secs}.${String(micros_remaining).padStart(6, '0')}`;
76
+ }
77
+ }
@@ -1,148 +1,148 @@
1
- import { AlgebraicType } from './algebraic_type';
2
- import { TimeDuration } from './time_duration';
3
-
4
- export type TimestampAlgebraicType = {
5
- tag: 'Product';
6
- value: {
7
- elements: [
8
- {
9
- name: '__timestamp_micros_since_unix_epoch__';
10
- algebraicType: { tag: 'I64' };
11
- },
12
- ];
13
- };
14
- };
15
-
16
- /**
17
- * A point in time, represented as a number of microseconds since the Unix epoch.
18
- */
19
- export class Timestamp {
20
- __timestamp_micros_since_unix_epoch__: bigint;
21
-
22
- private static MICROS_PER_MILLIS: bigint = 1000n;
23
-
24
- get microsSinceUnixEpoch(): bigint {
25
- return this.__timestamp_micros_since_unix_epoch__;
26
- }
27
-
28
- constructor(micros: bigint) {
29
- this.__timestamp_micros_since_unix_epoch__ = micros;
30
- }
31
-
32
- /**
33
- * Get the algebraic type representation of the {@link Timestamp} type.
34
- * @returns The algebraic type representation of the type.
35
- */
36
- static getAlgebraicType(): TimestampAlgebraicType {
37
- return AlgebraicType.Product({
38
- elements: [
39
- {
40
- name: '__timestamp_micros_since_unix_epoch__',
41
- algebraicType: AlgebraicType.I64,
42
- },
43
- ],
44
- });
45
- }
46
-
47
- static isTimestamp(
48
- algebraicType: AlgebraicType
49
- ): algebraicType is TimestampAlgebraicType {
50
- if (algebraicType.tag !== 'Product') {
51
- return false;
52
- }
53
- const elements = algebraicType.value.elements;
54
- if (elements.length !== 1) {
55
- return false;
56
- }
57
- const microsElement = elements[0];
58
- return (
59
- microsElement.name === '__timestamp_micros_since_unix_epoch__' &&
60
- microsElement.algebraicType.tag === 'I64'
61
- );
62
- }
63
-
64
- /**
65
- * The Unix epoch, the midnight at the beginning of January 1, 1970, UTC.
66
- */
67
- static UNIX_EPOCH: Timestamp = new Timestamp(0n);
68
-
69
- /**
70
- * Get a `Timestamp` representing the execution environment's belief of the current moment in time.
71
- */
72
- static now(): Timestamp {
73
- return Timestamp.fromDate(new Date());
74
- }
75
-
76
- /** Convert to milliseconds since Unix epoch. */
77
- toMillis(): bigint {
78
- return this.microsSinceUnixEpoch / 1000n;
79
- }
80
-
81
- /**
82
- * Get a `Timestamp` representing the same point in time as `date`.
83
- */
84
- static fromDate(date: Date): Timestamp {
85
- const millis = date.getTime();
86
- const micros = BigInt(millis) * Timestamp.MICROS_PER_MILLIS;
87
- return new Timestamp(micros);
88
- }
89
-
90
- /**
91
- * Get a `Date` representing approximately the same point in time as `this`.
92
- *
93
- * This method truncates to millisecond precision,
94
- * and throws `RangeError` if the `Timestamp` is outside the range representable as a `Date`.
95
- */
96
- toDate(): Date {
97
- const micros = this.__timestamp_micros_since_unix_epoch__;
98
- const millis = micros / Timestamp.MICROS_PER_MILLIS;
99
- if (
100
- millis > BigInt(Number.MAX_SAFE_INTEGER) ||
101
- millis < BigInt(Number.MIN_SAFE_INTEGER)
102
- ) {
103
- throw new RangeError(
104
- "Timestamp is outside of the representable range of JS's Date"
105
- );
106
- }
107
- return new Date(Number(millis));
108
- }
109
-
110
- /**
111
- * Get an ISO 8601 / RFC 3339 formatted string representation of this timestamp with microsecond precision.
112
- *
113
- * This method preserves the full microsecond precision of the timestamp,
114
- * and throws `RangeError` if the `Timestamp` is outside the range representable in ISO format.
115
- *
116
- * @returns ISO 8601 formatted string with microsecond precision (e.g., '2025-02-17T10:30:45.123456Z')
117
- */
118
- toISOString(): string {
119
- const micros = this.__timestamp_micros_since_unix_epoch__;
120
- const millis = micros / Timestamp.MICROS_PER_MILLIS;
121
-
122
- if (
123
- millis > BigInt(Number.MAX_SAFE_INTEGER) ||
124
- millis < BigInt(Number.MIN_SAFE_INTEGER)
125
- ) {
126
- throw new RangeError(
127
- 'Timestamp is outside of the representable range for ISO string formatting'
128
- );
129
- }
130
-
131
- const date = new Date(Number(millis));
132
- const isoBase = date.toISOString(); // Format: '2025-02-17T10:30:45.123Z'
133
-
134
- // Extract the full 6 decimal places of microseconds
135
- const microsRemainder = Math.abs(Number(micros % 1000000n));
136
- const fractionalPart = String(microsRemainder).padStart(6, '0');
137
-
138
- // Replace the 3-digit millisecond part with the full 6-digit microsecond part
139
- return isoBase.replace(/\.\d{3}Z$/, `.${fractionalPart}Z`);
140
- }
141
-
142
- since(other: Timestamp): TimeDuration {
143
- return new TimeDuration(
144
- this.__timestamp_micros_since_unix_epoch__ -
145
- other.__timestamp_micros_since_unix_epoch__
146
- );
147
- }
148
- }
1
+ import { AlgebraicType } from './algebraic_type';
2
+ import { TimeDuration } from './time_duration';
3
+
4
+ export type TimestampAlgebraicType = {
5
+ tag: 'Product';
6
+ value: {
7
+ elements: [
8
+ {
9
+ name: '__timestamp_micros_since_unix_epoch__';
10
+ algebraicType: { tag: 'I64' };
11
+ },
12
+ ];
13
+ };
14
+ };
15
+
16
+ /**
17
+ * A point in time, represented as a number of microseconds since the Unix epoch.
18
+ */
19
+ export class Timestamp {
20
+ __timestamp_micros_since_unix_epoch__: bigint;
21
+
22
+ private static MICROS_PER_MILLIS: bigint = 1000n;
23
+
24
+ get microsSinceUnixEpoch(): bigint {
25
+ return this.__timestamp_micros_since_unix_epoch__;
26
+ }
27
+
28
+ constructor(micros: bigint) {
29
+ this.__timestamp_micros_since_unix_epoch__ = micros;
30
+ }
31
+
32
+ /**
33
+ * Get the algebraic type representation of the {@link Timestamp} type.
34
+ * @returns The algebraic type representation of the type.
35
+ */
36
+ static getAlgebraicType(): TimestampAlgebraicType {
37
+ return AlgebraicType.Product({
38
+ elements: [
39
+ {
40
+ name: '__timestamp_micros_since_unix_epoch__',
41
+ algebraicType: AlgebraicType.I64,
42
+ },
43
+ ],
44
+ });
45
+ }
46
+
47
+ static isTimestamp(
48
+ algebraicType: AlgebraicType
49
+ ): algebraicType is TimestampAlgebraicType {
50
+ if (algebraicType.tag !== 'Product') {
51
+ return false;
52
+ }
53
+ const elements = algebraicType.value.elements;
54
+ if (elements.length !== 1) {
55
+ return false;
56
+ }
57
+ const microsElement = elements[0];
58
+ return (
59
+ microsElement.name === '__timestamp_micros_since_unix_epoch__' &&
60
+ microsElement.algebraicType.tag === 'I64'
61
+ );
62
+ }
63
+
64
+ /**
65
+ * The Unix epoch, the midnight at the beginning of January 1, 1970, UTC.
66
+ */
67
+ static UNIX_EPOCH: Timestamp = new Timestamp(0n);
68
+
69
+ /**
70
+ * Get a `Timestamp` representing the execution environment's belief of the current moment in time.
71
+ */
72
+ static now(): Timestamp {
73
+ return Timestamp.fromDate(new Date());
74
+ }
75
+
76
+ /** Convert to milliseconds since Unix epoch. */
77
+ toMillis(): bigint {
78
+ return this.microsSinceUnixEpoch / 1000n;
79
+ }
80
+
81
+ /**
82
+ * Get a `Timestamp` representing the same point in time as `date`.
83
+ */
84
+ static fromDate(date: Date): Timestamp {
85
+ const millis = date.getTime();
86
+ const micros = BigInt(millis) * Timestamp.MICROS_PER_MILLIS;
87
+ return new Timestamp(micros);
88
+ }
89
+
90
+ /**
91
+ * Get a `Date` representing approximately the same point in time as `this`.
92
+ *
93
+ * This method truncates to millisecond precision,
94
+ * and throws `RangeError` if the `Timestamp` is outside the range representable as a `Date`.
95
+ */
96
+ toDate(): Date {
97
+ const micros = this.__timestamp_micros_since_unix_epoch__;
98
+ const millis = micros / Timestamp.MICROS_PER_MILLIS;
99
+ if (
100
+ millis > BigInt(Number.MAX_SAFE_INTEGER) ||
101
+ millis < BigInt(Number.MIN_SAFE_INTEGER)
102
+ ) {
103
+ throw new RangeError(
104
+ "Timestamp is outside of the representable range of JS's Date"
105
+ );
106
+ }
107
+ return new Date(Number(millis));
108
+ }
109
+
110
+ /**
111
+ * Get an ISO 8601 / RFC 3339 formatted string representation of this timestamp with microsecond precision.
112
+ *
113
+ * This method preserves the full microsecond precision of the timestamp,
114
+ * and throws `RangeError` if the `Timestamp` is outside the range representable in ISO format.
115
+ *
116
+ * @returns ISO 8601 formatted string with microsecond precision (e.g., '2025-02-17T10:30:45.123456Z')
117
+ */
118
+ toISOString(): string {
119
+ const micros = this.__timestamp_micros_since_unix_epoch__;
120
+ const millis = micros / Timestamp.MICROS_PER_MILLIS;
121
+
122
+ if (
123
+ millis > BigInt(Number.MAX_SAFE_INTEGER) ||
124
+ millis < BigInt(Number.MIN_SAFE_INTEGER)
125
+ ) {
126
+ throw new RangeError(
127
+ 'Timestamp is outside of the representable range for ISO string formatting'
128
+ );
129
+ }
130
+
131
+ const date = new Date(Number(millis));
132
+ const isoBase = date.toISOString(); // Format: '2025-02-17T10:30:45.123Z'
133
+
134
+ // Extract the full 6 decimal places of microseconds
135
+ const microsRemainder = Math.abs(Number(micros % 1000000n));
136
+ const fractionalPart = String(microsRemainder).padStart(6, '0');
137
+
138
+ // Replace the 3-digit millisecond part with the full 6-digit microsecond part
139
+ return isoBase.replace(/\.\d{3}Z$/, `.${fractionalPart}Z`);
140
+ }
141
+
142
+ since(other: Timestamp): TimeDuration {
143
+ return new TimeDuration(
144
+ this.__timestamp_micros_since_unix_epoch__ -
145
+ other.__timestamp_micros_since_unix_epoch__
146
+ );
147
+ }
148
+ }