@evolu/common 6.0.1-preview.3 → 6.0.1-preview.31
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.
- package/dist/src/Array.d.ts +69 -5
- package/dist/src/Array.d.ts.map +1 -1
- package/dist/src/Array.js +64 -5
- package/dist/src/Assert.d.ts +6 -16
- package/dist/src/Assert.d.ts.map +1 -1
- package/dist/src/Assert.js +6 -18
- package/dist/src/Brand.d.ts +75 -0
- package/dist/src/Brand.d.ts.map +1 -0
- package/dist/src/Brand.js +1 -0
- package/dist/src/Buffer.d.ts +1 -1
- package/dist/src/Buffer.d.ts.map +1 -1
- package/dist/src/Buffer.js +8 -7
- package/dist/src/Cache.d.ts +44 -0
- package/dist/src/Cache.d.ts.map +1 -0
- package/dist/src/Cache.js +52 -0
- package/dist/src/Callbacks.d.ts +45 -12
- package/dist/src/Callbacks.d.ts.map +1 -1
- package/dist/src/Callbacks.js +14 -7
- package/dist/src/Console.d.ts +31 -6
- package/dist/src/Console.d.ts.map +1 -1
- package/dist/src/Console.js +72 -9
- package/dist/src/Crypto.d.ts +61 -34
- package/dist/src/Crypto.d.ts.map +1 -1
- package/dist/src/Crypto.js +32 -45
- package/dist/src/Evolu/Db.d.ts +161 -65
- package/dist/src/Evolu/Db.d.ts.map +1 -1
- package/dist/src/Evolu/Db.js +286 -694
- package/dist/src/Evolu/Diff.d.ts +3 -3
- package/dist/src/Evolu/Diff.d.ts.map +1 -1
- package/dist/src/Evolu/Diff.js +7 -5
- package/dist/src/Evolu/Evolu.d.ts +208 -133
- package/dist/src/Evolu/Evolu.d.ts.map +1 -1
- package/dist/src/Evolu/Evolu.js +188 -183
- package/dist/src/Evolu/Internal.d.ts +0 -2
- package/dist/src/Evolu/Internal.d.ts.map +1 -1
- package/dist/src/Evolu/Internal.js +0 -2
- package/dist/src/Evolu/LocalAuth.d.ts +150 -0
- package/dist/src/Evolu/LocalAuth.d.ts.map +1 -0
- package/dist/src/Evolu/LocalAuth.js +174 -0
- package/dist/src/Evolu/Owner.d.ts +273 -120
- package/dist/src/Evolu/Owner.d.ts.map +1 -1
- package/dist/src/Evolu/Owner.js +130 -104
- package/dist/src/Evolu/Platform.d.ts +9 -7
- package/dist/src/Evolu/Platform.d.ts.map +1 -1
- package/dist/src/Evolu/Protocol.d.ts +277 -232
- package/dist/src/Evolu/Protocol.d.ts.map +1 -1
- package/dist/src/Evolu/Protocol.js +603 -378
- package/dist/src/Evolu/Public.d.ts +6 -8
- package/dist/src/Evolu/Public.d.ts.map +1 -1
- package/dist/src/Evolu/Public.js +2 -3
- package/dist/src/Evolu/PublicKysely.js +3 -3
- package/dist/src/Evolu/Query.d.ts +2 -1
- package/dist/src/Evolu/Query.d.ts.map +1 -1
- package/dist/src/Evolu/Relay.d.ts +92 -7
- package/dist/src/Evolu/Relay.d.ts.map +1 -1
- package/dist/src/Evolu/Relay.js +238 -76
- package/dist/src/Evolu/Schema.d.ts +129 -73
- package/dist/src/Evolu/Schema.d.ts.map +1 -1
- package/dist/src/Evolu/Schema.js +169 -89
- package/dist/src/Evolu/Storage.d.ts +240 -26
- package/dist/src/Evolu/Storage.d.ts.map +1 -1
- package/dist/src/Evolu/Storage.js +189 -91
- package/dist/src/Evolu/Sync.d.ts +67 -13
- package/dist/src/Evolu/Sync.d.ts.map +1 -1
- package/dist/src/Evolu/Sync.js +441 -20
- package/dist/src/Evolu/Timestamp.d.ts +85 -27
- package/dist/src/Evolu/Timestamp.d.ts.map +1 -1
- package/dist/src/Evolu/Timestamp.js +77 -18
- package/dist/src/Identicon.d.ts +35 -0
- package/dist/src/Identicon.d.ts.map +1 -0
- package/dist/src/Identicon.js +143 -0
- package/dist/src/Instances.d.ts +34 -0
- package/dist/src/Instances.d.ts.map +1 -0
- package/dist/src/Instances.js +44 -0
- package/dist/src/ManyToManyMap.d.ts +71 -10
- package/dist/src/ManyToManyMap.d.ts.map +1 -1
- package/dist/src/ManyToManyMap.js +41 -6
- package/dist/src/Number.d.ts +4 -3
- package/dist/src/Number.d.ts.map +1 -1
- package/dist/src/Number.js +5 -4
- package/dist/src/Platform.d.ts +20 -0
- package/dist/src/Platform.d.ts.map +1 -0
- package/dist/src/Platform.js +22 -0
- package/dist/src/Random.d.ts +3 -2
- package/dist/src/Random.d.ts.map +1 -1
- package/dist/src/Resources.d.ts +118 -0
- package/dist/src/Resources.d.ts.map +1 -0
- package/dist/src/Resources.js +197 -0
- package/dist/src/Result.d.ts +184 -52
- package/dist/src/Result.d.ts.map +1 -1
- package/dist/src/Result.js +30 -241
- package/dist/src/Skiplist.js +2 -1
- package/dist/src/Sqlite.d.ts +63 -5
- package/dist/src/Sqlite.d.ts.map +1 -1
- package/dist/src/Sqlite.js +110 -9
- package/dist/src/Task.d.ts +586 -0
- package/dist/src/Task.d.ts.map +1 -0
- package/dist/src/Task.js +469 -0
- package/dist/src/Time.d.ts +66 -1
- package/dist/src/Time.d.ts.map +1 -1
- package/dist/src/Time.js +99 -5
- package/dist/src/Type.d.ts +622 -340
- package/dist/src/Type.d.ts.map +1 -1
- package/dist/src/Type.js +666 -464
- package/dist/src/Types.d.ts +1 -75
- package/dist/src/Types.d.ts.map +1 -1
- package/dist/src/WebSocket.d.ts +5 -2
- package/dist/src/WebSocket.d.ts.map +1 -1
- package/dist/src/WebSocket.js +12 -18
- package/dist/src/Worker.d.ts +39 -11
- package/dist/src/Worker.d.ts.map +1 -1
- package/dist/src/Worker.js +22 -4
- package/dist/src/index.d.ts +7 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +7 -2
- package/package.json +14 -13
- package/src/Array.ts +90 -11
- package/src/Assert.ts +6 -24
- package/src/Brand.ts +75 -0
- package/src/Buffer.ts +7 -7
- package/src/Cache.ts +85 -0
- package/src/Callbacks.ts +62 -22
- package/src/Console.ts +91 -11
- package/src/Crypto.ts +97 -82
- package/src/Evolu/Db.ts +517 -1020
- package/src/Evolu/Diff.ts +7 -5
- package/src/Evolu/Evolu.ts +464 -355
- package/src/Evolu/Internal.ts +0 -2
- package/src/Evolu/LocalAuth.ts +463 -0
- package/src/Evolu/Owner.ts +355 -228
- package/src/Evolu/Platform.ts +9 -9
- package/src/Evolu/Protocol.ts +859 -676
- package/src/Evolu/Public.ts +7 -14
- package/src/Evolu/PublicKysely.ts +3 -3
- package/src/Evolu/Query.ts +2 -1
- package/src/Evolu/Relay.ts +437 -93
- package/src/Evolu/Schema.ts +391 -191
- package/src/Evolu/Storage.ts +532 -135
- package/src/Evolu/Sync.ts +766 -37
- package/src/Evolu/Timestamp.ts +88 -35
- package/src/Identicon.ts +197 -0
- package/src/Instances.ts +90 -0
- package/src/ManyToManyMap.ts +124 -24
- package/src/Number.ts +6 -10
- package/src/Platform.ts +26 -0
- package/src/Random.ts +3 -2
- package/src/Resources.ts +367 -0
- package/src/Result.ts +191 -54
- package/src/Skiplist.ts +1 -1
- package/src/Sqlite.ts +122 -17
- package/src/Task.ts +901 -0
- package/src/Time.ts +180 -5
- package/src/Type.ts +1084 -727
- package/src/Types.ts +1 -77
- package/src/WebSocket.ts +27 -25
- package/src/Worker.ts +72 -23
- package/src/index.ts +7 -2
- package/dist/src/Evolu/Config.d.ts +0 -69
- package/dist/src/Evolu/Config.d.ts.map +0 -1
- package/dist/src/Evolu/Config.js +0 -9
- package/dist/src/Evolu/Kysely.d.ts +0 -6
- package/dist/src/Evolu/Kysely.d.ts.map +0 -1
- package/dist/src/Evolu/Kysely.js +0 -21
- package/dist/src/NanoId.d.ts +0 -27
- package/dist/src/NanoId.d.ts.map +0 -1
- package/dist/src/NanoId.js +0 -6
- package/dist/src/Promise.d.ts +0 -180
- package/dist/src/Promise.d.ts.map +0 -1
- package/dist/src/Promise.js +0 -176
- package/src/Evolu/Config.ts +0 -83
- package/src/Evolu/Kysely.ts +0 -38
- package/src/NanoId.ts +0 -39
- package/src/Promise.ts +0 -295
package/dist/src/Number.d.ts
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { NonEmptyReadonlyArray } from "./Array.js";
|
|
2
2
|
import { Result } from "./Result.js";
|
|
3
3
|
import { NonNegativeInt, PositiveInt } from "./Type.js";
|
|
4
|
-
import {
|
|
4
|
+
import { Predicate, WidenLiteral } from "./Types.js";
|
|
5
|
+
import { IsBranded } from "./Brand.js";
|
|
5
6
|
export declare const increment: (n: number) => number;
|
|
6
7
|
export declare const decrement: (n: number) => number;
|
|
7
8
|
/** Clamps a number within a given range. */
|
|
@@ -36,7 +37,7 @@ export declare const max: <T extends number>(...values: [T, ...ReadonlyArray<T>]
|
|
|
36
37
|
*/
|
|
37
38
|
export declare const computeBalancedBuckets: (numberOfItems: NonNegativeInt,
|
|
38
39
|
/** Default: 16 */
|
|
39
|
-
numberOfBuckets?:
|
|
40
|
+
numberOfBuckets?: number & import("./Brand.js").Brand<"Int"> & import("./Brand.js").Brand<"NonNegative"> & import("./Brand.js").Brand<"Positive">,
|
|
40
41
|
/** Default: 2 */
|
|
41
|
-
minNumberOfItemsPerBucket?:
|
|
42
|
+
minNumberOfItemsPerBucket?: number & import("./Brand.js").Brand<"Int"> & import("./Brand.js").Brand<"NonNegative"> & import("./Brand.js").Brand<"Positive">) => Result<NonEmptyReadonlyArray<PositiveInt>, PositiveInt>;
|
|
42
43
|
//# sourceMappingURL=Number.d.ts.map
|
package/dist/src/Number.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Number.d.ts","sourceRoot":"","sources":["../../src/Number.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAEnD,OAAO,EAAW,MAAM,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxD,OAAO,
|
|
1
|
+
{"version":3,"file":"Number.d.ts","sourceRoot":"","sources":["../../src/Number.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAEnD,OAAO,EAAW,MAAM,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxD,OAAO,EAAoB,SAAS,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,eAAO,MAAM,SAAS,GAAI,GAAG,MAAM,KAAG,MAAe,CAAC;AAEtD,eAAO,MAAM,SAAS,GAAI,GAAG,MAAM,KAAG,MAAe,CAAC;AAEtD,4CAA4C;AAC5C,eAAO,MAAM,KAAK,GACf,KAAK,MAAM,EAAE,KAAK,MAAM,MACxB,GAAG,MAAM,KAAG,MACoB,CAAC;AAEpC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,GACnB,KAAK,MAAM,EAAE,KAAK,MAAM,KAAG,SAAS,CAAC,MAAM,CAEd,CAAC;AAEjC,wEAAwE;AACxE,eAAO,MAAM,GAAG,GAAI,CAAC,SAAS,MAAM,EAClC,GAAG,QAAQ,CAAC,CAAC,EAAE,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,KAClC,SAAS,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,YAAY,CAAC,CAAC,CACa,CAAC;AAE/D,wEAAwE;AACxE,eAAO,MAAM,GAAG,GAAI,CAAC,SAAS,MAAM,EAClC,GAAG,QAAQ,CAAC,CAAC,EAAE,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,KAClC,SAAS,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,YAAY,CAAC,CAAC,CACa,CAAC;AAE/D;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB,GACjC,eAAe,cAAc;AAE7B,kBAAkB;AAClB,iJAAyC;AAEzC,iBAAiB;AACjB,2JAAkD,KACjD,MAAM,CAAC,qBAAqB,CAAC,WAAW,CAAC,EAAE,WAAW,CAoBxD,CAAC"}
|
package/dist/src/Number.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { assertNonEmptyReadonlyArray } from "./Assert.js";
|
|
2
2
|
import { err, ok } from "./Result.js";
|
|
3
|
+
import { PositiveInt } from "./Type.js";
|
|
3
4
|
export const increment = (n) => n + 1;
|
|
4
5
|
export const decrement = (n) => n - 1;
|
|
5
6
|
/** Clamps a number within a given range. */
|
|
@@ -34,12 +35,12 @@ export const max = (...values) => values.reduce((a, b) => (a > b ? a : b));
|
|
|
34
35
|
*/
|
|
35
36
|
export const computeBalancedBuckets = (numberOfItems,
|
|
36
37
|
/** Default: 16 */
|
|
37
|
-
numberOfBuckets = 16,
|
|
38
|
+
numberOfBuckets = PositiveInt.orThrow(16),
|
|
38
39
|
/** Default: 2 */
|
|
39
|
-
minNumberOfItemsPerBucket = 2) => {
|
|
40
|
+
minNumberOfItemsPerBucket = PositiveInt.orThrow(2)) => {
|
|
40
41
|
const minRequiredItems = numberOfBuckets * minNumberOfItemsPerBucket;
|
|
41
42
|
if (numberOfItems < minRequiredItems)
|
|
42
|
-
return err(minRequiredItems);
|
|
43
|
+
return err(PositiveInt.orThrow(minRequiredItems));
|
|
43
44
|
const indexes = [];
|
|
44
45
|
const itemsPerBucket = Math.floor(numberOfItems / numberOfBuckets);
|
|
45
46
|
const extraItems = numberOfItems % numberOfBuckets;
|
|
@@ -48,7 +49,7 @@ minNumberOfItemsPerBucket = 2) => {
|
|
|
48
49
|
const hasExtraItem = i < extraItems;
|
|
49
50
|
const itemsInThisBucket = itemsPerBucket + (hasExtraItem ? 1 : 0);
|
|
50
51
|
bucketBoundary += itemsInThisBucket;
|
|
51
|
-
indexes.push(bucketBoundary);
|
|
52
|
+
indexes.push(PositiveInt.orThrow(bucketBoundary));
|
|
52
53
|
}
|
|
53
54
|
assertNonEmptyReadonlyArray(indexes);
|
|
54
55
|
return ok(indexes);
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Platform detection utilities for Evolu.
|
|
3
|
+
*
|
|
4
|
+
* @module
|
|
5
|
+
*/
|
|
6
|
+
/** Detects if the code is running in React Native environment. */
|
|
7
|
+
export declare const isReactNative: boolean;
|
|
8
|
+
/**
|
|
9
|
+
* Detects if Node.js Buffer is available and should be used.
|
|
10
|
+
*
|
|
11
|
+
* React Native apps often polyfill Node.js APIs like Buffer, but we want to use
|
|
12
|
+
* native methods when available for better performance.
|
|
13
|
+
*
|
|
14
|
+
* Returns false in React Native even if Buffer is polyfilled, as we prefer
|
|
15
|
+
* native methods in that environment.
|
|
16
|
+
*
|
|
17
|
+
* @see https://github.com/craftzdog/react-native-quick-base64#installation
|
|
18
|
+
*/
|
|
19
|
+
export declare const hasNodeBuffer: boolean;
|
|
20
|
+
//# sourceMappingURL=Platform.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Platform.d.ts","sourceRoot":"","sources":["../../src/Platform.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,kEAAkE;AAClE,eAAO,MAAM,aAAa,SAIoB,CAAC;AAE/C;;;;;;;;;;GAUG;AACH,eAAO,MAAM,aAAa,SACkC,CAAC"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Platform detection utilities for Evolu.
|
|
3
|
+
*
|
|
4
|
+
* @module
|
|
5
|
+
*/
|
|
6
|
+
/** Detects if the code is running in React Native environment. */
|
|
7
|
+
export const isReactNative = typeof navigator !== "undefined" &&
|
|
8
|
+
"product" in navigator &&
|
|
9
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
|
|
10
|
+
navigator.product === "ReactNative";
|
|
11
|
+
/**
|
|
12
|
+
* Detects if Node.js Buffer is available and should be used.
|
|
13
|
+
*
|
|
14
|
+
* React Native apps often polyfill Node.js APIs like Buffer, but we want to use
|
|
15
|
+
* native methods when available for better performance.
|
|
16
|
+
*
|
|
17
|
+
* Returns false in React Native even if Buffer is polyfilled, as we prefer
|
|
18
|
+
* native methods in that environment.
|
|
19
|
+
*
|
|
20
|
+
* @see https://github.com/craftzdog/react-native-quick-base64#installation
|
|
21
|
+
*/
|
|
22
|
+
export const hasNodeBuffer = !isReactNative && typeof globalThis.Buffer !== "undefined";
|
package/dist/src/Random.d.ts
CHANGED
|
@@ -5,8 +5,9 @@
|
|
|
5
5
|
*/
|
|
6
6
|
import { Random as RandomLib } from "random";
|
|
7
7
|
/**
|
|
8
|
-
* A simple wrapper around Math.random().
|
|
9
|
-
*
|
|
8
|
+
* A simple wrapper around Math.random().
|
|
9
|
+
*
|
|
10
|
+
* For more complex needs check {@link RandomLibDep}.
|
|
10
11
|
*
|
|
11
12
|
* ### Example
|
|
12
13
|
*
|
package/dist/src/Random.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Random.d.ts","sourceRoot":"","sources":["../../src/Random.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,MAAM,IAAI,SAAS,EAAE,MAAM,QAAQ,CAAC;AAE7C
|
|
1
|
+
{"version":3,"file":"Random.d.ts","sourceRoot":"","sources":["../../src/Random.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,MAAM,IAAI,SAAS,EAAE,MAAM,QAAQ,CAAC;AAE7C;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,MAAM;IACrB,0EAA0E;IAC1E,IAAI,EAAE,MAAM,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,oDAAoD;AACpD,eAAO,MAAM,YAAY,QAAO,MAE9B,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,oBAAoB,GAAI,MAAM,MAAM,KAAG,MAKnD,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,4DAA4D;AAC5D,eAAO,MAAM,eAAe,QAAO,SAA4B,CAAC;AAEhE;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GAAI,MAAM,MAAM,KAAG,YAErD,CAAC"}
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
import { Result } from "./Result.js";
|
|
2
|
+
/**
|
|
3
|
+
* A generic resource manager that handles reference counting and delayed
|
|
4
|
+
* disposal of shared resources. Useful for managing expensive resources like
|
|
5
|
+
* WebSocket connections that need to be shared among multiple consumers.
|
|
6
|
+
*/
|
|
7
|
+
export interface Resources<TResource extends Disposable, TResourceKey extends string, TResourceConfig, TConsumer, TConsumerId extends string> extends Disposable {
|
|
8
|
+
/**
|
|
9
|
+
* Adds a consumer to resources, creating them if necessary. Increments
|
|
10
|
+
* reference counts for existing consumer-resource pairs.
|
|
11
|
+
*/
|
|
12
|
+
readonly addConsumer: (consumer: TConsumer, resourceConfigs: ReadonlyArray<TResourceConfig>) => void;
|
|
13
|
+
/**
|
|
14
|
+
* Removes a consumer from resources. Decrements reference counts and
|
|
15
|
+
* schedules disposal when no consumers remain.
|
|
16
|
+
*
|
|
17
|
+
* Returns an error if the resource doesn't exist or if the consumer wasn't
|
|
18
|
+
* added to the resource.
|
|
19
|
+
*/
|
|
20
|
+
readonly removeConsumer: (consumer: TConsumer, resourceConfigs: ReadonlyArray<TResourceConfig>) => Result<void, ResourceNotFoundError<TResourceKey> | ConsumerNotFoundError<TConsumerId, TResourceKey>>;
|
|
21
|
+
/** Gets the resource for the specified key, or null if it doesn't exist. */
|
|
22
|
+
readonly getResource: (key: TResourceKey) => TResource | null;
|
|
23
|
+
/** Gets all consumer IDs currently using the specified resource key. */
|
|
24
|
+
readonly getConsumersForResource: (key: TResourceKey) => ReadonlyArray<TConsumerId>;
|
|
25
|
+
/** Checks if a consumer is currently using any resources. */
|
|
26
|
+
readonly hasConsumerAnyResource: (consumer: TConsumer) => boolean;
|
|
27
|
+
/**
|
|
28
|
+
* Gets the consumer for the specified consumer ID, or null if not found or
|
|
29
|
+
* not using any resources.
|
|
30
|
+
*/
|
|
31
|
+
readonly getConsumer: (consumerId: TConsumerId) => TConsumer | null;
|
|
32
|
+
}
|
|
33
|
+
/** Error when trying to remove a consumer from a resource that doesn't exist. */
|
|
34
|
+
export interface ResourceNotFoundError<TResourceKey extends string = string> {
|
|
35
|
+
readonly type: "ResourceNotFoundError";
|
|
36
|
+
readonly resourceKey: TResourceKey;
|
|
37
|
+
}
|
|
38
|
+
/** Error when trying to remove a consumer that wasn't added to a resource. */
|
|
39
|
+
export interface ConsumerNotFoundError<TConsumerId extends string = string, TResourceKey extends string = string> {
|
|
40
|
+
readonly type: "ConsumerNotFoundError";
|
|
41
|
+
readonly consumerId: TConsumerId;
|
|
42
|
+
readonly resourceKey: TResourceKey;
|
|
43
|
+
}
|
|
44
|
+
export interface ResourcesConfig<TResource extends Disposable, TResourceKey extends string, TResourceConfig, TConsumer, TConsumerId extends string> {
|
|
45
|
+
/** Creates a new resource for the given config. */
|
|
46
|
+
readonly createResource: (config: TResourceConfig) => TResource;
|
|
47
|
+
/** Extracts a unique key from a resource config for deduplication. */
|
|
48
|
+
readonly getResourceKey: (config: TResourceConfig) => TResourceKey;
|
|
49
|
+
/** Extracts a unique identifier from a consumer for reference counting. */
|
|
50
|
+
readonly getConsumerId: (consumer: TConsumer) => TConsumerId;
|
|
51
|
+
/**
|
|
52
|
+
* Delay in milliseconds before disposing unused resources. Helps avoid
|
|
53
|
+
* resource churn during rapid add/remove cycles. Defaults to 100ms.
|
|
54
|
+
*/
|
|
55
|
+
readonly disposalDelay?: number;
|
|
56
|
+
/**
|
|
57
|
+
* Called when a consumer is added to a resource for the first time. This
|
|
58
|
+
* happens when the consumer's reference count goes from 0 to 1 for this
|
|
59
|
+
* resource.
|
|
60
|
+
*/
|
|
61
|
+
readonly onConsumerAdded?: (consumer: TConsumer, resource: TResource, resourceKey: TResourceKey) => void;
|
|
62
|
+
/**
|
|
63
|
+
* Called when a consumer is completely removed from a resource. This happens
|
|
64
|
+
* when the consumer's reference count goes from 1 to 0 for this resource.
|
|
65
|
+
*/
|
|
66
|
+
readonly onConsumerRemoved?: (consumer: TConsumer, resource: TResource, resourceKey: TResourceKey) => void;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Creates {@link Resources}.
|
|
70
|
+
*
|
|
71
|
+
* This tracks which consumers are using which resources and maintains reference
|
|
72
|
+
* counts to know when it's safe to dispose resources. Resources are created
|
|
73
|
+
* on-demand and disposed with a configurable delay to avoid churn.
|
|
74
|
+
*
|
|
75
|
+
* ### Example Usage
|
|
76
|
+
*
|
|
77
|
+
* ```ts
|
|
78
|
+
* // WebSocket connections
|
|
79
|
+
* interface WebSocketConfig {
|
|
80
|
+
* readonly url: WebSocketUrl;
|
|
81
|
+
* }
|
|
82
|
+
*
|
|
83
|
+
* type WebSocketUrl = string & Brand<"WebSocketUrl">;
|
|
84
|
+
* type UserId = string & Brand<"UserId">;
|
|
85
|
+
*
|
|
86
|
+
* const webSockets = createResources<
|
|
87
|
+
* WebSocket,
|
|
88
|
+
* WebSocketUrl,
|
|
89
|
+
* WebSocketConfig,
|
|
90
|
+
* User,
|
|
91
|
+
* UserId
|
|
92
|
+
* >({
|
|
93
|
+
* createResource: (config) => new WebSocket(config.url),
|
|
94
|
+
* getResourceKey: (config) => config.url,
|
|
95
|
+
* getConsumerId: (user) => user.id,
|
|
96
|
+
* disposalDelay: 1000,
|
|
97
|
+
* });
|
|
98
|
+
*
|
|
99
|
+
* // Add users to WebSocket connections
|
|
100
|
+
* webSockets.addConsumer(user1, [
|
|
101
|
+
* { url: "ws://server1.com" as WebSocketUrl },
|
|
102
|
+
* { url: "ws://server2.com" as WebSocketUrl },
|
|
103
|
+
* ]);
|
|
104
|
+
* webSockets.addConsumer(user2, [
|
|
105
|
+
* { url: "ws://server1.com" as WebSocketUrl },
|
|
106
|
+
* ]);
|
|
107
|
+
*
|
|
108
|
+
* // Remove users - server1 stays alive (user2 still using it)
|
|
109
|
+
* webSockets.removeConsumer(user1, [
|
|
110
|
+
* { url: "ws://server1.com" as WebSocketUrl },
|
|
111
|
+
* { url: "ws://server2.com" as WebSocketUrl },
|
|
112
|
+
* ]);
|
|
113
|
+
*
|
|
114
|
+
* // server2 gets disposed after delay, server1 stays alive
|
|
115
|
+
* ```
|
|
116
|
+
*/
|
|
117
|
+
export declare const createResources: <TResource extends Disposable, TResourceKey extends string, TResourceConfig, TConsumer, TConsumerId extends string>(config: ResourcesConfig<TResource, TResourceKey, TResourceConfig, TConsumer, TConsumerId>) => Resources<TResource, TResourceKey, TResourceConfig, TConsumer, TConsumerId>;
|
|
118
|
+
//# sourceMappingURL=Resources.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Resources.d.ts","sourceRoot":"","sources":["../../src/Resources.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,MAAM,EAAE,MAAM,aAAa,CAAC;AAG9C;;;;GAIG;AACH,MAAM,WAAW,SAAS,CACxB,SAAS,SAAS,UAAU,EAC5B,YAAY,SAAS,MAAM,EAC3B,eAAe,EACf,SAAS,EACT,WAAW,SAAS,MAAM,CAC1B,SAAQ,UAAU;IAClB;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,CACpB,QAAQ,EAAE,SAAS,EACnB,eAAe,EAAE,aAAa,CAAC,eAAe,CAAC,KAC5C,IAAI,CAAC;IAEV;;;;;;OAMG;IACH,QAAQ,CAAC,cAAc,EAAE,CACvB,QAAQ,EAAE,SAAS,EACnB,eAAe,EAAE,aAAa,CAAC,eAAe,CAAC,KAC5C,MAAM,CACT,IAAI,EACF,qBAAqB,CAAC,YAAY,CAAC,GACnC,qBAAqB,CAAC,WAAW,EAAE,YAAY,CAAC,CACnD,CAAC;IAEF,4EAA4E;IAC5E,QAAQ,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,SAAS,GAAG,IAAI,CAAC;IAE9D,wEAAwE;IACxE,QAAQ,CAAC,uBAAuB,EAAE,CAChC,GAAG,EAAE,YAAY,KACd,aAAa,CAAC,WAAW,CAAC,CAAC;IAEhC,6DAA6D;IAC7D,QAAQ,CAAC,sBAAsB,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,OAAO,CAAC;IAElE;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,WAAW,KAAK,SAAS,GAAG,IAAI,CAAC;CACrE;AAED,iFAAiF;AACjF,MAAM,WAAW,qBAAqB,CAAC,YAAY,SAAS,MAAM,GAAG,MAAM;IACzE,QAAQ,CAAC,IAAI,EAAE,uBAAuB,CAAC;IACvC,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;CACpC;AAED,8EAA8E;AAC9E,MAAM,WAAW,qBAAqB,CACpC,WAAW,SAAS,MAAM,GAAG,MAAM,EACnC,YAAY,SAAS,MAAM,GAAG,MAAM;IAEpC,QAAQ,CAAC,IAAI,EAAE,uBAAuB,CAAC;IACvC,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC;IACjC,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;CACpC;AAED,MAAM,WAAW,eAAe,CAC9B,SAAS,SAAS,UAAU,EAC5B,YAAY,SAAS,MAAM,EAC3B,eAAe,EACf,SAAS,EACT,WAAW,SAAS,MAAM;IAE1B,mDAAmD;IACnD,QAAQ,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,SAAS,CAAC;IAEhE,sEAAsE;IACtE,QAAQ,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,YAAY,CAAC;IAEnE,2EAA2E;IAC3E,QAAQ,CAAC,aAAa,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,WAAW,CAAC;IAE7D;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEhC;;;;OAIG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,CACzB,QAAQ,EAAE,SAAS,EACnB,QAAQ,EAAE,SAAS,EACnB,WAAW,EAAE,YAAY,KACtB,IAAI,CAAC;IAEV;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAC3B,QAAQ,EAAE,SAAS,EACnB,QAAQ,EAAE,SAAS,EACnB,WAAW,EAAE,YAAY,KACtB,IAAI,CAAC;CACX;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,eAAO,MAAM,eAAe,GAC1B,SAAS,SAAS,UAAU,EAC5B,YAAY,SAAS,MAAM,EAC3B,eAAe,EACf,SAAS,EACT,WAAW,SAAS,MAAM,EAE1B,QAAQ,eAAe,CACrB,SAAS,EACT,YAAY,EACZ,eAAe,EACf,SAAS,EACT,WAAW,CACZ,KACA,SAAS,CACV,SAAS,EACT,YAAY,EACZ,eAAe,EACf,SAAS,EACT,WAAW,CAoLZ,CAAC"}
|
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
import { err, ok } from "./Result.js";
|
|
2
|
+
import { PositiveInt } from "./Type.js";
|
|
3
|
+
/**
|
|
4
|
+
* Creates {@link Resources}.
|
|
5
|
+
*
|
|
6
|
+
* This tracks which consumers are using which resources and maintains reference
|
|
7
|
+
* counts to know when it's safe to dispose resources. Resources are created
|
|
8
|
+
* on-demand and disposed with a configurable delay to avoid churn.
|
|
9
|
+
*
|
|
10
|
+
* ### Example Usage
|
|
11
|
+
*
|
|
12
|
+
* ```ts
|
|
13
|
+
* // WebSocket connections
|
|
14
|
+
* interface WebSocketConfig {
|
|
15
|
+
* readonly url: WebSocketUrl;
|
|
16
|
+
* }
|
|
17
|
+
*
|
|
18
|
+
* type WebSocketUrl = string & Brand<"WebSocketUrl">;
|
|
19
|
+
* type UserId = string & Brand<"UserId">;
|
|
20
|
+
*
|
|
21
|
+
* const webSockets = createResources<
|
|
22
|
+
* WebSocket,
|
|
23
|
+
* WebSocketUrl,
|
|
24
|
+
* WebSocketConfig,
|
|
25
|
+
* User,
|
|
26
|
+
* UserId
|
|
27
|
+
* >({
|
|
28
|
+
* createResource: (config) => new WebSocket(config.url),
|
|
29
|
+
* getResourceKey: (config) => config.url,
|
|
30
|
+
* getConsumerId: (user) => user.id,
|
|
31
|
+
* disposalDelay: 1000,
|
|
32
|
+
* });
|
|
33
|
+
*
|
|
34
|
+
* // Add users to WebSocket connections
|
|
35
|
+
* webSockets.addConsumer(user1, [
|
|
36
|
+
* { url: "ws://server1.com" as WebSocketUrl },
|
|
37
|
+
* { url: "ws://server2.com" as WebSocketUrl },
|
|
38
|
+
* ]);
|
|
39
|
+
* webSockets.addConsumer(user2, [
|
|
40
|
+
* { url: "ws://server1.com" as WebSocketUrl },
|
|
41
|
+
* ]);
|
|
42
|
+
*
|
|
43
|
+
* // Remove users - server1 stays alive (user2 still using it)
|
|
44
|
+
* webSockets.removeConsumer(user1, [
|
|
45
|
+
* { url: "ws://server1.com" as WebSocketUrl },
|
|
46
|
+
* { url: "ws://server2.com" as WebSocketUrl },
|
|
47
|
+
* ]);
|
|
48
|
+
*
|
|
49
|
+
* // server2 gets disposed after delay, server1 stays alive
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
52
|
+
export const createResources = (config) => {
|
|
53
|
+
let isDisposed = false;
|
|
54
|
+
const resourcesMap = new Map();
|
|
55
|
+
const consumerCounts = new Map();
|
|
56
|
+
const consumers = new Map();
|
|
57
|
+
const disposalTimeouts = new Map();
|
|
58
|
+
const disposalDelay = config.disposalDelay ?? 100;
|
|
59
|
+
const ensureResource = (resourceConfig) => {
|
|
60
|
+
const key = config.getResourceKey(resourceConfig);
|
|
61
|
+
const timeout = disposalTimeouts.get(key);
|
|
62
|
+
if (timeout) {
|
|
63
|
+
clearTimeout(timeout);
|
|
64
|
+
disposalTimeouts.delete(key);
|
|
65
|
+
}
|
|
66
|
+
if (!resourcesMap.has(key)) {
|
|
67
|
+
const resource = config.createResource(resourceConfig);
|
|
68
|
+
resourcesMap.set(key, resource);
|
|
69
|
+
}
|
|
70
|
+
};
|
|
71
|
+
const scheduleDisposal = (key) => {
|
|
72
|
+
const timeout = setTimeout(() => {
|
|
73
|
+
const resource = resourcesMap.get(key);
|
|
74
|
+
if (resource) {
|
|
75
|
+
resource[Symbol.dispose]();
|
|
76
|
+
resourcesMap.delete(key);
|
|
77
|
+
}
|
|
78
|
+
disposalTimeouts.delete(key);
|
|
79
|
+
}, disposalDelay);
|
|
80
|
+
disposalTimeouts.set(key, timeout);
|
|
81
|
+
};
|
|
82
|
+
const resources = {
|
|
83
|
+
addConsumer: (consumer, resourceConfigs) => {
|
|
84
|
+
if (isDisposed)
|
|
85
|
+
return;
|
|
86
|
+
const consumerId = config.getConsumerId(consumer);
|
|
87
|
+
// Store consumer (last added consumer for this ID)
|
|
88
|
+
consumers.set(consumerId, consumer);
|
|
89
|
+
for (const resourceConfig of resourceConfigs) {
|
|
90
|
+
ensureResource(resourceConfig);
|
|
91
|
+
const resourceKey = config.getResourceKey(resourceConfig);
|
|
92
|
+
let counts = consumerCounts.get(resourceKey);
|
|
93
|
+
if (!counts) {
|
|
94
|
+
counts = new Map();
|
|
95
|
+
consumerCounts.set(resourceKey, counts);
|
|
96
|
+
}
|
|
97
|
+
const currentCount = counts.get(consumerId) ?? 0;
|
|
98
|
+
const newCount = currentCount + 1;
|
|
99
|
+
counts.set(consumerId, PositiveInt.orThrow(newCount));
|
|
100
|
+
// Call onConsumerAdded callback only when consumer is added for the first time (0 -> 1)
|
|
101
|
+
if (currentCount === 0 && config.onConsumerAdded) {
|
|
102
|
+
const resource = resourcesMap.get(resourceKey);
|
|
103
|
+
if (resource) {
|
|
104
|
+
config.onConsumerAdded(consumer, resource, resourceKey);
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
},
|
|
109
|
+
removeConsumer: (consumer, resourceConfigs) => {
|
|
110
|
+
if (isDisposed)
|
|
111
|
+
return ok();
|
|
112
|
+
const consumerId = config.getConsumerId(consumer);
|
|
113
|
+
for (const resourceConfig of resourceConfigs) {
|
|
114
|
+
const key = config.getResourceKey(resourceConfig);
|
|
115
|
+
const counts = consumerCounts.get(key);
|
|
116
|
+
if (!counts) {
|
|
117
|
+
return err({ type: "ResourceNotFoundError", resourceKey: key });
|
|
118
|
+
}
|
|
119
|
+
const currentCount = counts.get(consumerId);
|
|
120
|
+
if (currentCount == null) {
|
|
121
|
+
return err({
|
|
122
|
+
type: "ConsumerNotFoundError",
|
|
123
|
+
consumerId: consumerId,
|
|
124
|
+
resourceKey: key,
|
|
125
|
+
});
|
|
126
|
+
}
|
|
127
|
+
if (currentCount === 1) {
|
|
128
|
+
counts.delete(consumerId);
|
|
129
|
+
// Call onConsumerRemoved callback only when consumer is completely removed (1 -> 0)
|
|
130
|
+
if (config.onConsumerRemoved) {
|
|
131
|
+
const resource = resourcesMap.get(key);
|
|
132
|
+
if (resource) {
|
|
133
|
+
config.onConsumerRemoved(consumer, resource, key);
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
if (counts.size === 0) {
|
|
137
|
+
consumerCounts.delete(key);
|
|
138
|
+
scheduleDisposal(key);
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
else {
|
|
142
|
+
counts.set(consumerId, PositiveInt.orThrow(currentCount - 1));
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
if (!resources.hasConsumerAnyResource(consumer)) {
|
|
146
|
+
consumers.delete(consumerId);
|
|
147
|
+
}
|
|
148
|
+
return ok();
|
|
149
|
+
},
|
|
150
|
+
getResource: (key) => {
|
|
151
|
+
if (isDisposed)
|
|
152
|
+
return null;
|
|
153
|
+
return resourcesMap.get(key) ?? null;
|
|
154
|
+
},
|
|
155
|
+
getConsumersForResource: (key) => {
|
|
156
|
+
if (isDisposed)
|
|
157
|
+
return [];
|
|
158
|
+
const counts = consumerCounts.get(key);
|
|
159
|
+
return counts ? Array.from(counts.keys()) : [];
|
|
160
|
+
},
|
|
161
|
+
hasConsumerAnyResource: (consumer) => {
|
|
162
|
+
if (isDisposed)
|
|
163
|
+
return false;
|
|
164
|
+
const consumerId = config.getConsumerId(consumer);
|
|
165
|
+
// If slow, can be optimized with reverse index
|
|
166
|
+
return Array.from(consumerCounts.values()).some((counts) => counts.has(consumerId));
|
|
167
|
+
},
|
|
168
|
+
getConsumer: (consumerId) => {
|
|
169
|
+
if (isDisposed)
|
|
170
|
+
return null;
|
|
171
|
+
const consumer = consumers.get(consumerId);
|
|
172
|
+
if (!consumer)
|
|
173
|
+
return null;
|
|
174
|
+
// Only return consumer if it's currently using any resources
|
|
175
|
+
if (!resources.hasConsumerAnyResource(consumer)) {
|
|
176
|
+
return null;
|
|
177
|
+
}
|
|
178
|
+
return consumer;
|
|
179
|
+
},
|
|
180
|
+
[Symbol.dispose]: () => {
|
|
181
|
+
if (isDisposed)
|
|
182
|
+
return;
|
|
183
|
+
isDisposed = true;
|
|
184
|
+
for (const timeout of disposalTimeouts.values()) {
|
|
185
|
+
clearTimeout(timeout);
|
|
186
|
+
}
|
|
187
|
+
disposalTimeouts.clear();
|
|
188
|
+
for (const resource of resourcesMap.values()) {
|
|
189
|
+
resource[Symbol.dispose]();
|
|
190
|
+
}
|
|
191
|
+
resourcesMap.clear();
|
|
192
|
+
consumerCounts.clear();
|
|
193
|
+
consumers.clear();
|
|
194
|
+
},
|
|
195
|
+
};
|
|
196
|
+
return resources;
|
|
197
|
+
};
|