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,113 +1,113 @@
1
- import { AlgebraicType } from '../lib/algebraic_type';
2
- import { FunctionVisibility, type Lifecycle } from '../lib/autogen/types';
3
- import type { ParamsObj, Reducer } from '../lib/reducers';
4
- import { type UntypedSchemaDef } from '../lib/schema';
5
- import { RowBuilder, type RowObj } from '../lib/type_builders';
6
- import { toPascalCase } from '../lib/util';
7
- import {
8
- exportContext,
9
- registerExport,
10
- type ModuleExport,
11
- type SchemaInner,
12
- } from './schema';
13
-
14
- export interface ReducerExport<
15
- S extends UntypedSchemaDef,
16
- Params extends ParamsObj,
17
- > extends Reducer<S, Params>,
18
- ModuleExport {}
19
-
20
- export interface ReducerOpts {
21
- name: string;
22
- }
23
-
24
- export function makeReducerExport<
25
- S extends UntypedSchemaDef,
26
- Params extends ParamsObj,
27
- >(
28
- ctx: SchemaInner,
29
- opts: ReducerOpts | undefined,
30
- params: RowObj | RowBuilder<RowObj>,
31
- fn: Reducer<any, any>,
32
- lifecycle?: Lifecycle
33
- ): ReducerExport<S, Params> {
34
- const reducerExport: ReducerExport<S, Params> = (...args) => fn(...args);
35
- reducerExport[exportContext] = ctx;
36
- reducerExport[registerExport] = (ctx, exportName) => {
37
- registerReducer(ctx, exportName, params, fn, opts, lifecycle);
38
- ctx.functionExports.set(
39
- reducerExport as ReducerExport<any, any>,
40
- exportName
41
- );
42
- };
43
-
44
- return reducerExport;
45
- }
46
-
47
- /**
48
- * internal: pushReducer() helper used by reducer() and lifecycle wrappers
49
- *
50
- * @param name - The name of the reducer.
51
- * @param params - The parameters for the reducer.
52
- * @param fn - The reducer function.
53
- * @param lifecycle - Optional lifecycle hooks for the reducer.
54
- */
55
- export function registerReducer(
56
- ctx: SchemaInner,
57
- exportName: string,
58
- params: RowObj | RowBuilder<RowObj>,
59
- fn: Reducer<any, any>,
60
- opts?: ReducerOpts,
61
- lifecycle?: Lifecycle
62
- ): void {
63
- ctx.defineFunction(exportName);
64
-
65
- if (!(params instanceof RowBuilder)) {
66
- params = new RowBuilder(params);
67
- }
68
-
69
- if (params.typeName === undefined) {
70
- params.typeName = toPascalCase(exportName);
71
- }
72
-
73
- const ref = ctx.registerTypesRecursively(params);
74
- const paramsType = ctx.resolveType(ref).value;
75
- const isLifecycle = lifecycle != null;
76
-
77
- ctx.moduleDef.reducers.push({
78
- sourceName: exportName,
79
- params: paramsType,
80
- //ModuleDef validation code is responsible to mark private reducers
81
- visibility: FunctionVisibility.ClientCallable,
82
- //Hardcoded for now - reducers do not return values yet
83
- okReturnType: AlgebraicType.Product({ elements: [] }),
84
- errReturnType: AlgebraicType.String,
85
- });
86
-
87
- if (opts?.name != null) {
88
- ctx.moduleDef.explicitNames.entries.push({
89
- tag: 'Function',
90
- value: {
91
- sourceName: exportName,
92
- canonicalName: opts.name,
93
- },
94
- });
95
- }
96
-
97
- if (isLifecycle) {
98
- ctx.moduleDef.lifeCycleReducers.push({
99
- lifecycleSpec: lifecycle,
100
- functionName: exportName,
101
- });
102
- }
103
-
104
- // If the function isn't named (e.g. `function foobar() {}`), give it the same
105
- // name as the reducer so that it's clear what it is in in backtraces.
106
- if (!fn.name) {
107
- Object.defineProperty(fn, 'name', { value: exportName, writable: false });
108
- }
109
-
110
- ctx.reducers.push(fn);
111
- }
112
-
113
- export type Reducers = Reducer<any, any>[];
1
+ import { AlgebraicType } from '../lib/algebraic_type';
2
+ import { FunctionVisibility, type Lifecycle } from '../lib/autogen/types';
3
+ import type { ParamsObj, Reducer } from '../lib/reducers';
4
+ import { type UntypedSchemaDef } from '../lib/schema';
5
+ import { RowBuilder, type RowObj } from '../lib/type_builders';
6
+ import { toPascalCase } from '../lib/util';
7
+ import {
8
+ exportContext,
9
+ registerExport,
10
+ type ModuleExport,
11
+ type SchemaInner,
12
+ } from './schema';
13
+
14
+ export interface ReducerExport<
15
+ S extends UntypedSchemaDef,
16
+ Params extends ParamsObj,
17
+ > extends Reducer<S, Params>,
18
+ ModuleExport {}
19
+
20
+ export interface ReducerOpts {
21
+ name: string;
22
+ }
23
+
24
+ export function makeReducerExport<
25
+ S extends UntypedSchemaDef,
26
+ Params extends ParamsObj,
27
+ >(
28
+ ctx: SchemaInner,
29
+ opts: ReducerOpts | undefined,
30
+ params: RowObj | RowBuilder<RowObj>,
31
+ fn: Reducer<any, any>,
32
+ lifecycle?: Lifecycle
33
+ ): ReducerExport<S, Params> {
34
+ const reducerExport: ReducerExport<S, Params> = (...args) => fn(...args);
35
+ reducerExport[exportContext] = ctx;
36
+ reducerExport[registerExport] = (ctx, exportName) => {
37
+ registerReducer(ctx, exportName, params, fn, opts, lifecycle);
38
+ ctx.functionExports.set(
39
+ reducerExport as ReducerExport<any, any>,
40
+ exportName
41
+ );
42
+ };
43
+
44
+ return reducerExport;
45
+ }
46
+
47
+ /**
48
+ * internal: pushReducer() helper used by reducer() and lifecycle wrappers
49
+ *
50
+ * @param name - The name of the reducer.
51
+ * @param params - The parameters for the reducer.
52
+ * @param fn - The reducer function.
53
+ * @param lifecycle - Optional lifecycle hooks for the reducer.
54
+ */
55
+ export function registerReducer(
56
+ ctx: SchemaInner,
57
+ exportName: string,
58
+ params: RowObj | RowBuilder<RowObj>,
59
+ fn: Reducer<any, any>,
60
+ opts?: ReducerOpts,
61
+ lifecycle?: Lifecycle
62
+ ): void {
63
+ ctx.defineFunction(exportName);
64
+
65
+ if (!(params instanceof RowBuilder)) {
66
+ params = new RowBuilder(params);
67
+ }
68
+
69
+ if (params.typeName === undefined) {
70
+ params.typeName = toPascalCase(exportName);
71
+ }
72
+
73
+ const ref = ctx.registerTypesRecursively(params);
74
+ const paramsType = ctx.resolveType(ref).value;
75
+ const isLifecycle = lifecycle != null;
76
+
77
+ ctx.moduleDef.reducers.push({
78
+ sourceName: exportName,
79
+ params: paramsType,
80
+ //ModuleDef validation code is responsible to mark private reducers
81
+ visibility: FunctionVisibility.ClientCallable,
82
+ //Hardcoded for now - reducers do not return values yet
83
+ okReturnType: AlgebraicType.Product({ elements: [] }),
84
+ errReturnType: AlgebraicType.String,
85
+ });
86
+
87
+ if (opts?.name != null) {
88
+ ctx.moduleDef.explicitNames.entries.push({
89
+ tag: 'Function',
90
+ value: {
91
+ sourceName: exportName,
92
+ canonicalName: opts.name,
93
+ },
94
+ });
95
+ }
96
+
97
+ if (isLifecycle) {
98
+ ctx.moduleDef.lifeCycleReducers.push({
99
+ lifecycleSpec: lifecycle,
100
+ functionName: exportName,
101
+ });
102
+ }
103
+
104
+ // If the function isn't named (e.g. `function foobar() {}`), give it the same
105
+ // name as the reducer so that it's clear what it is in in backtraces.
106
+ if (!fn.name) {
107
+ Object.defineProperty(fn, 'name', { value: exportName, writable: false });
108
+ }
109
+
110
+ ctx.reducers.push(fn);
111
+ }
112
+
113
+ export type Reducers = Reducer<any, any>[];
package/src/server/rng.ts CHANGED
@@ -1,113 +1,113 @@
1
- import type { RandomGenerator } from 'pure-rand';
2
- import { unsafeUniformBigIntDistribution } from 'pure-rand/distribution/UnsafeUniformBigIntDistribution';
3
- import { unsafeUniformIntDistribution } from 'pure-rand/distribution/UnsafeUniformIntDistribution';
4
- import { xoroshiro128plus } from 'pure-rand/generator/XoroShiro';
5
- import type { Timestamp } from '../lib/timestamp';
6
-
7
- type IntArray =
8
- | Int8Array
9
- | Uint8Array
10
- | Uint8ClampedArray
11
- | Int16Array
12
- | Uint16Array
13
- | Int32Array
14
- | Uint32Array
15
- | BigInt64Array
16
- | BigUint64Array;
17
-
18
- /**
19
- * A collection of random-number-generating functions, seeded based on `ctx.timestamp`.
20
- *
21
- * ## Usage
22
- *
23
- * ```
24
- * const floatOneToTen = ctx.random() * 10;
25
- * const randomBytes = ctx.random.fill(new Uint8Array(16));
26
- * const intOneToTen = ctx.random.integerInRange(0, 10);
27
- * ```
28
- */
29
- export interface Random {
30
- /**
31
- * Returns a random floating-point number in the range `[0.0, 1.0)`.
32
- *
33
- * The returned float will have 53 bits of randomness.
34
- */
35
- (): number;
36
-
37
- /**
38
- * Like `crypto.getRandomValues()`. Fills a `TypedArray` with random integers
39
- * in a uniform distribution, mutating and returning it.
40
- */
41
- fill<T extends IntArray>(array: T): T;
42
-
43
- /**
44
- * Returns a random unsigned 32-bit integer in a uniform distribution in the
45
- * range `[0, 2**32)`.
46
- */
47
- uint32(): number;
48
-
49
- /**
50
- * Returns an integer in the range `[min, max]`.
51
- */
52
- integerInRange(min: number, max: number): number;
53
-
54
- /**
55
- * Returns a bigint in the range `[min, max]`.
56
- */
57
- bigintInRange(min: bigint, max: bigint): bigint;
58
- }
59
-
60
- const { asUintN } = BigInt;
61
-
62
- /** Based on the function of the same name in `rand_core::SeedableRng::seed_from_u64` */
63
- function pcg32(state: bigint): number {
64
- const MUL = 6364136223846793005n;
65
- const INC = 11634580027462260723n;
66
-
67
- state = asUintN(64, state * MUL + INC);
68
- const xorshifted = Number(asUintN(32, ((state >> 18n) ^ state) >> 27n));
69
- const rot = Number(asUintN(32, state >> 59n));
70
- // rotate `xorshifted` right by `rot` bits
71
- return (xorshifted >> rot) | (xorshifted << (32 - rot));
72
- }
73
-
74
- /** From the `pure-rand` README */
75
- function generateFloat64(rng: RandomGenerator): number {
76
- const g1 = unsafeUniformIntDistribution(0, (1 << 26) - 1, rng);
77
- const g2 = unsafeUniformIntDistribution(0, (1 << 27) - 1, rng);
78
- const value = (g1 * Math.pow(2, 27) + g2) * Math.pow(2, -53);
79
- return value;
80
- }
81
-
82
- export function makeRandom(seed: Timestamp): Random {
83
- // Use PCG32 to turn a 64-bit seed into a 32-bit seed, as the Rust `rand` crate does.
84
- const rng = xoroshiro128plus(pcg32(seed.microsSinceUnixEpoch));
85
-
86
- const random: Random = () => generateFloat64(rng);
87
-
88
- random.fill = array => {
89
- const elem = array.at(0);
90
- if (typeof elem === 'bigint') {
91
- const upper = (1n << BigInt(array.BYTES_PER_ELEMENT * 8)) - 1n;
92
- for (let i = 0; i < array.length; i++) {
93
- array[i] = unsafeUniformBigIntDistribution(0n, upper, rng);
94
- }
95
- } else if (typeof elem === 'number') {
96
- const upper = (1 << (array.BYTES_PER_ELEMENT * 8)) - 1;
97
- for (let i = 0; i < array.length; i++) {
98
- array[i] = unsafeUniformIntDistribution(0, upper, rng);
99
- }
100
- }
101
- return array;
102
- };
103
-
104
- random.uint32 = () => rng.unsafeNext();
105
-
106
- random.integerInRange = (min, max) =>
107
- unsafeUniformIntDistribution(min, max, rng);
108
-
109
- random.bigintInRange = (min, max) =>
110
- unsafeUniformBigIntDistribution(min, max, rng);
111
-
112
- return random;
113
- }
1
+ import type { RandomGenerator } from 'pure-rand';
2
+ import { unsafeUniformBigIntDistribution } from 'pure-rand/distribution/UnsafeUniformBigIntDistribution';
3
+ import { unsafeUniformIntDistribution } from 'pure-rand/distribution/UnsafeUniformIntDistribution';
4
+ import { xoroshiro128plus } from 'pure-rand/generator/XoroShiro';
5
+ import type { Timestamp } from '../lib/timestamp';
6
+
7
+ type IntArray =
8
+ | Int8Array
9
+ | Uint8Array
10
+ | Uint8ClampedArray
11
+ | Int16Array
12
+ | Uint16Array
13
+ | Int32Array
14
+ | Uint32Array
15
+ | BigInt64Array
16
+ | BigUint64Array;
17
+
18
+ /**
19
+ * A collection of random-number-generating functions, seeded based on `ctx.timestamp`.
20
+ *
21
+ * ## Usage
22
+ *
23
+ * ```
24
+ * const floatOneToTen = ctx.random() * 10;
25
+ * const randomBytes = ctx.random.fill(new Uint8Array(16));
26
+ * const intOneToTen = ctx.random.integerInRange(0, 10);
27
+ * ```
28
+ */
29
+ export interface Random {
30
+ /**
31
+ * Returns a random floating-point number in the range `[0.0, 1.0)`.
32
+ *
33
+ * The returned float will have 53 bits of randomness.
34
+ */
35
+ (): number;
36
+
37
+ /**
38
+ * Like `crypto.getRandomValues()`. Fills a `TypedArray` with random integers
39
+ * in a uniform distribution, mutating and returning it.
40
+ */
41
+ fill<T extends IntArray>(array: T): T;
42
+
43
+ /**
44
+ * Returns a random unsigned 32-bit integer in a uniform distribution in the
45
+ * range `[0, 2**32)`.
46
+ */
47
+ uint32(): number;
48
+
49
+ /**
50
+ * Returns an integer in the range `[min, max]`.
51
+ */
52
+ integerInRange(min: number, max: number): number;
53
+
54
+ /**
55
+ * Returns a bigint in the range `[min, max]`.
56
+ */
57
+ bigintInRange(min: bigint, max: bigint): bigint;
58
+ }
59
+
60
+ const { asUintN } = BigInt;
61
+
62
+ /** Based on the function of the same name in `rand_core::SeedableRng::seed_from_u64` */
63
+ function pcg32(state: bigint): number {
64
+ const MUL = 6364136223846793005n;
65
+ const INC = 11634580027462260723n;
66
+
67
+ state = asUintN(64, state * MUL + INC);
68
+ const xorshifted = Number(asUintN(32, ((state >> 18n) ^ state) >> 27n));
69
+ const rot = Number(asUintN(32, state >> 59n));
70
+ // rotate `xorshifted` right by `rot` bits
71
+ return (xorshifted >> rot) | (xorshifted << (32 - rot));
72
+ }
73
+
74
+ /** From the `pure-rand` README */
75
+ function generateFloat64(rng: RandomGenerator): number {
76
+ const g1 = unsafeUniformIntDistribution(0, (1 << 26) - 1, rng);
77
+ const g2 = unsafeUniformIntDistribution(0, (1 << 27) - 1, rng);
78
+ const value = (g1 * Math.pow(2, 27) + g2) * Math.pow(2, -53);
79
+ return value;
80
+ }
81
+
82
+ export function makeRandom(seed: Timestamp): Random {
83
+ // Use PCG32 to turn a 64-bit seed into a 32-bit seed, as the Rust `rand` crate does.
84
+ const rng = xoroshiro128plus(pcg32(seed.microsSinceUnixEpoch));
85
+
86
+ const random: Random = () => generateFloat64(rng);
87
+
88
+ random.fill = array => {
89
+ const elem = array.at(0);
90
+ if (typeof elem === 'bigint') {
91
+ const upper = (1n << BigInt(array.BYTES_PER_ELEMENT * 8)) - 1n;
92
+ for (let i = 0; i < array.length; i++) {
93
+ array[i] = unsafeUniformBigIntDistribution(0n, upper, rng);
94
+ }
95
+ } else if (typeof elem === 'number') {
96
+ const upper = (1 << (array.BYTES_PER_ELEMENT * 8)) - 1;
97
+ for (let i = 0; i < array.length; i++) {
98
+ array[i] = unsafeUniformIntDistribution(0, upper, rng);
99
+ }
100
+ }
101
+ return array;
102
+ };
103
+
104
+ random.uint32 = () => rng.unsafeNext();
105
+
106
+ random.integerInRange = (min, max) =>
107
+ unsafeUniformIntDistribution(min, max, rng);
108
+
109
+ random.bigintInRange = (min, max) =>
110
+ unsafeUniformBigIntDistribution(min, max, rng);
111
+
112
+ return random;
113
+ }