@ahoo-wang/wow-client 10.0.0-alpha.7 → 10.0.0-beta.2
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/README.md +8 -5
- package/README.zh-CN.md +4 -3
- package/dist/commands.cjs +1 -1
- package/dist/commands.cjs.map +1 -1
- package/dist/commands.d.cts +9 -13
- package/dist/commands.d.ts +9 -13
- package/dist/commands.es.js +60 -54
- package/dist/commands.es.js.map +1 -1
- package/dist/dsl/aggregation/admit.cjs +1 -1
- package/dist/dsl/aggregation/admit.cjs.map +1 -1
- package/dist/dsl/aggregation/admit.es.js +73 -69
- package/dist/dsl/aggregation/admit.es.js.map +1 -1
- package/dist/dsl/aggregation/aliases.cjs +2 -0
- package/dist/dsl/aggregation/aliases.cjs.map +1 -0
- package/dist/dsl/aggregation/aliases.d.cts +2 -0
- package/dist/dsl/aggregation/aliases.d.ts +2 -0
- package/dist/dsl/aggregation/aliases.es.js +13 -0
- package/dist/dsl/aggregation/aliases.es.js.map +1 -0
- package/dist/dsl/aggregation/builders.cjs +1 -1
- package/dist/dsl/aggregation/builders.cjs.map +1 -1
- package/dist/dsl/aggregation/builders.d.cts +17 -243
- package/dist/dsl/aggregation/builders.d.ts +17 -243
- package/dist/dsl/aggregation/builders.es.js +36 -171
- package/dist/dsl/aggregation/builders.es.js.map +1 -1
- package/dist/dsl/aggregation/derived.cjs +1 -1
- package/dist/dsl/aggregation/derived.cjs.map +1 -1
- package/dist/dsl/aggregation/derived.d.cts +123 -1
- package/dist/dsl/aggregation/derived.d.ts +123 -1
- package/dist/dsl/aggregation/derived.es.js +43 -28
- package/dist/dsl/aggregation/derived.es.js.map +1 -1
- package/dist/dsl/aggregation/groups.cjs +2 -0
- package/dist/dsl/aggregation/groups.cjs.map +1 -0
- package/dist/dsl/aggregation/groups.d.cts +325 -0
- package/dist/dsl/aggregation/groups.d.ts +325 -0
- package/dist/dsl/aggregation/groups.es.js +80 -0
- package/dist/dsl/aggregation/groups.es.js.map +1 -0
- package/dist/dsl/aggregation/having.cjs +1 -1
- package/dist/dsl/aggregation/having.cjs.map +1 -1
- package/dist/dsl/aggregation/having.d.cts +63 -1
- package/dist/dsl/aggregation/having.d.ts +63 -1
- package/dist/dsl/aggregation/having.es.js +33 -30
- package/dist/dsl/aggregation/having.es.js.map +1 -1
- package/dist/dsl/aggregation/index.d.cts +4 -2
- package/dist/dsl/aggregation/index.d.ts +4 -2
- package/dist/dsl/aggregation/metrics.cjs +2 -0
- package/dist/dsl/aggregation/metrics.cjs.map +1 -0
- package/dist/dsl/aggregation/metrics.d.cts +279 -0
- package/dist/dsl/aggregation/metrics.d.ts +279 -0
- package/dist/dsl/aggregation/metrics.es.js +75 -0
- package/dist/dsl/aggregation/metrics.es.js.map +1 -0
- package/dist/dsl/aggregation/types.cjs +1 -1
- package/dist/dsl/aggregation/types.cjs.map +1 -1
- package/dist/dsl/aggregation/types.d.cts +4 -524
- package/dist/dsl/aggregation/types.d.ts +4 -524
- package/dist/dsl/aggregation/types.es.js +5 -25
- package/dist/dsl/aggregation/types.es.js.map +1 -1
- package/dist/dsl/cursorQuery.cjs +1 -1
- package/dist/dsl/cursorQuery.cjs.map +1 -1
- package/dist/dsl/cursorQuery.d.cts +18 -7
- package/dist/dsl/cursorQuery.d.ts +18 -7
- package/dist/dsl/cursorQuery.es.js +13 -12
- package/dist/dsl/cursorQuery.es.js.map +1 -1
- package/dist/dsl/descriptor.cjs +1 -1
- package/dist/dsl/descriptor.cjs.map +1 -1
- package/dist/dsl/descriptor.d.cts +24 -379
- package/dist/dsl/descriptor.d.ts +24 -379
- package/dist/dsl/descriptor.es.js +6 -32
- package/dist/dsl/descriptor.es.js.map +1 -1
- package/dist/dsl/fieldDescriptor.cjs +2 -0
- package/dist/dsl/fieldDescriptor.cjs.map +1 -0
- package/dist/dsl/fieldDescriptor.d.cts +246 -0
- package/dist/dsl/fieldDescriptor.d.ts +246 -0
- package/dist/dsl/fieldDescriptor.es.js +24 -0
- package/dist/dsl/fieldDescriptor.es.js.map +1 -0
- package/dist/dsl/filter/builders.cjs +1 -1
- package/dist/dsl/filter/builders.cjs.map +1 -1
- package/dist/dsl/filter/builders.d.cts +7 -949
- package/dist/dsl/filter/builders.d.ts +7 -949
- package/dist/dsl/filter/builders.es.js +14 -285
- package/dist/dsl/filter/builders.es.js.map +1 -1
- package/dist/dsl/filter/expressionFilter.cjs +2 -0
- package/dist/dsl/filter/expressionFilter.cjs.map +1 -0
- package/dist/dsl/filter/expressionFilter.d.cts +35 -0
- package/dist/dsl/filter/expressionFilter.d.ts +35 -0
- package/dist/dsl/filter/expressionFilter.es.js +18 -0
- package/dist/dsl/filter/expressionFilter.es.js.map +1 -0
- package/dist/dsl/filter/fieldFilters.cjs +2 -0
- package/dist/dsl/filter/fieldFilters.cjs.map +1 -0
- package/dist/dsl/filter/fieldFilters.d.cts +297 -0
- package/dist/dsl/filter/fieldFilters.d.ts +297 -0
- package/dist/dsl/filter/fieldFilters.es.js +110 -0
- package/dist/dsl/filter/fieldFilters.es.js.map +1 -0
- package/dist/dsl/filter/index.d.cts +2 -1
- package/dist/dsl/filter/index.d.ts +2 -1
- package/dist/dsl/filter/logicalFilters.cjs +2 -0
- package/dist/dsl/filter/logicalFilters.cjs.map +1 -0
- package/dist/dsl/filter/logicalFilters.d.cts +109 -0
- package/dist/dsl/filter/logicalFilters.d.ts +109 -0
- package/dist/dsl/filter/logicalFilters.es.js +36 -0
- package/dist/dsl/filter/logicalFilters.es.js.map +1 -0
- package/dist/dsl/filter/metadataFilters.cjs +2 -0
- package/dist/dsl/filter/metadataFilters.cjs.map +1 -0
- package/dist/dsl/filter/metadataFilters.d.cts +132 -0
- package/dist/dsl/filter/metadataFilters.d.ts +132 -0
- package/dist/dsl/filter/metadataFilters.es.js +56 -0
- package/dist/dsl/filter/metadataFilters.es.js.map +1 -0
- package/dist/dsl/filter/operator.cjs +1 -1
- package/dist/dsl/filter/operator.cjs.map +1 -1
- package/dist/dsl/filter/operator.d.cts +11 -9
- package/dist/dsl/filter/operator.d.ts +11 -9
- package/dist/dsl/filter/operator.es.js +1 -1
- package/dist/dsl/filter/operator.es.js.map +1 -1
- package/dist/dsl/filter/searchFilter.cjs +2 -0
- package/dist/dsl/filter/searchFilter.cjs.map +1 -0
- package/dist/dsl/filter/searchFilter.d.cts +39 -0
- package/dist/dsl/filter/searchFilter.d.ts +39 -0
- package/dist/dsl/filter/searchFilter.es.js +19 -0
- package/dist/dsl/filter/searchFilter.es.js.map +1 -0
- package/dist/dsl/filter/timeFilters.cjs +2 -0
- package/dist/dsl/filter/timeFilters.cjs.map +1 -0
- package/dist/dsl/filter/timeFilters.d.cts +290 -0
- package/dist/dsl/filter/timeFilters.d.ts +290 -0
- package/dist/dsl/filter/timeFilters.es.js +89 -0
- package/dist/dsl/filter/timeFilters.es.js.map +1 -0
- package/dist/dsl/filter/types.d.cts +4 -14
- package/dist/dsl/filter/types.d.ts +4 -14
- package/dist/dsl/filter/validate.cjs +1 -1
- package/dist/dsl/filter/validate.cjs.map +1 -1
- package/dist/dsl/filter/validate.d.cts +2 -4
- package/dist/dsl/filter/validate.d.ts +2 -4
- package/dist/dsl/filter/validate.es.js +25 -31
- package/dist/dsl/filter/validate.es.js.map +1 -1
- package/dist/dsl/queryErrorCodes.cjs +1 -1
- package/dist/dsl/queryErrorCodes.cjs.map +1 -1
- package/dist/dsl/queryErrorCodes.d.cts +0 -2
- package/dist/dsl/queryErrorCodes.d.ts +0 -2
- package/dist/dsl/queryErrorCodes.es.js +0 -1
- package/dist/dsl/queryErrorCodes.es.js.map +1 -1
- package/dist/dsl/queryFilter.cjs +2 -0
- package/dist/dsl/queryFilter.cjs.map +1 -0
- package/dist/dsl/queryFilter.d.cts +3 -0
- package/dist/dsl/queryFilter.d.ts +3 -0
- package/dist/dsl/queryFilter.es.js +9 -0
- package/dist/dsl/queryFilter.es.js.map +1 -0
- package/dist/dsl/queryable.cjs +1 -1
- package/dist/dsl/queryable.cjs.map +1 -1
- package/dist/dsl/queryable.es.js +12 -16
- package/dist/dsl/queryable.es.js.map +1 -1
- package/dist/dsl/semanticTypes.cjs +2 -0
- package/dist/dsl/semanticTypes.cjs.map +1 -0
- package/dist/dsl/semanticTypes.d.cts +128 -0
- package/dist/dsl/semanticTypes.d.ts +128 -0
- package/dist/dsl/semanticTypes.es.js +13 -0
- package/dist/dsl/semanticTypes.es.js.map +1 -0
- package/dist/dsl.cjs +1 -1
- package/dist/dsl.d.cts +2 -0
- package/dist/dsl.d.ts +2 -0
- package/dist/dsl.es.js +14 -8
- package/dist/exactJson.cjs +2 -2
- package/dist/exactJson.cjs.map +1 -1
- package/dist/exactJson.d.cts +41 -16
- package/dist/exactJson.d.ts +41 -16
- package/dist/exactJson.es.js +104 -102
- package/dist/exactJson.es.js.map +1 -1
- package/dist/frameworkErrors.cjs.map +1 -1
- package/dist/frameworkErrors.d.cts +5 -5
- package/dist/frameworkErrors.d.ts +5 -5
- package/dist/frameworkErrors.es.js.map +1 -1
- package/dist/http.cjs +1 -1
- package/dist/http.cjs.map +1 -1
- package/dist/http.d.cts +29 -9
- package/dist/http.d.ts +29 -9
- package/dist/http.es.js +24 -19
- package/dist/http.es.js.map +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.es.js +12 -12
- package/dist/manifest.cjs +1 -1
- package/dist/manifest.cjs.map +1 -1
- package/dist/manifest.d.cts +30 -2
- package/dist/manifest.d.ts +30 -2
- package/dist/manifest.es.js +34 -6
- package/dist/manifest.es.js.map +1 -1
- package/dist/manifestTypes.d.cts +21 -4
- package/dist/manifestTypes.d.ts +21 -4
- package/dist/queries.cjs +1 -1
- package/dist/queries.cjs.map +1 -1
- package/dist/queries.d.cts +18 -8
- package/dist/queries.d.ts +18 -8
- package/dist/queries.es.js +46 -35
- package/dist/queries.es.js.map +1 -1
- package/dist/routes.cjs +1 -1
- package/dist/routes.cjs.map +1 -1
- package/dist/routes.d.cts +16 -3
- package/dist/routes.d.ts +16 -3
- package/dist/routes.es.js +24 -25
- package/dist/routes.es.js.map +1 -1
- package/dist/state.cjs +1 -1
- package/dist/state.cjs.map +1 -1
- package/dist/state.d.cts +21 -19
- package/dist/state.d.ts +21 -19
- package/dist/state.es.js +27 -22
- package/dist/state.es.js.map +1 -1
- package/dist/streams.cjs +1 -1
- package/dist/streams.cjs.map +1 -1
- package/dist/streams.d.cts +14 -7
- package/dist/streams.d.ts +14 -7
- package/dist/streams.es.js +65 -50
- package/dist/streams.es.js.map +1 -1
- package/dist/testing/wire.cjs +1 -1
- package/dist/testing/wire.cjs.map +1 -1
- package/dist/testing/wire.es.js +1 -1
- package/dist/testing/wire.es.js.map +1 -1
- package/dist/wait.cjs +1 -1
- package/dist/wait.cjs.map +1 -1
- package/dist/wait.d.cts +18 -5
- package/dist/wait.d.ts +18 -5
- package/dist/wait.es.js +36 -34
- package/dist/wait.es.js.map +1 -1
- package/dist/wire.cjs +1 -1
- package/dist/wire.cjs.map +1 -1
- package/dist/wire.d.cts +76 -31
- package/dist/wire.d.ts +76 -31
- package/dist/wire.es.js +1 -3
- package/dist/wire.es.js.map +1 -1
- package/package.json +5 -5
- package/dist/dsl/filter/datePattern.cjs +0 -2
- package/dist/dsl/filter/datePattern.cjs.map +0 -1
- package/dist/dsl/filter/datePattern.d.cts +0 -8
- package/dist/dsl/filter/datePattern.d.ts +0 -8
- package/dist/dsl/filter/datePattern.es.js +0 -96
- package/dist/dsl/filter/datePattern.es.js.map +0 -1
package/dist/wait.d.cts
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
import { Hop } from './wire.cjs';
|
|
2
2
|
/** The name of the built-in subscription that writes snapshots. */
|
|
3
|
-
export declare const SNAPSHOT_SUBSCRIPTION = "snapshot";
|
|
3
|
+
export declare const SNAPSHOT_SUBSCRIPTION = "wow.snapshot";
|
|
4
|
+
/**
|
|
5
|
+
* The name a `queryable` hop gives the snapshot subscription of the store an
|
|
6
|
+
* aggregate type's snapshot queries read: its copy's where it has one, else
|
|
7
|
+
* its own store's, as `snapshot` is.
|
|
8
|
+
*/
|
|
9
|
+
export declare const QUERYABLE_SUBSCRIPTION = "wow.queryable";
|
|
4
10
|
/**
|
|
5
11
|
* Builds the hops of a wait chain. A context left out is
|
|
6
12
|
* the command's own. A saga's `handled` hop may be followed by hops of the
|
|
@@ -22,13 +28,20 @@ export declare const wait: {
|
|
|
22
28
|
readonly committed: (context?: string) => Hop;
|
|
23
29
|
/** Until the snapshot holds the commit: the caller reads its own write. */
|
|
24
30
|
readonly snapshot: (context?: string) => Hop;
|
|
31
|
+
/**
|
|
32
|
+
* Until the store the aggregate type's snapshot queries read holds the
|
|
33
|
+
* commit: a list or a count the caller runs next sees it. The same as
|
|
34
|
+
* `snapshot` for a type whose queries read its own store.
|
|
35
|
+
*/
|
|
36
|
+
readonly queryable: (context?: string) => Hop;
|
|
25
37
|
/** Until the subscription named `processor.function` handled the commit. */
|
|
26
38
|
readonly handled: (subscription: string, context?: string) => Hop;
|
|
27
39
|
};
|
|
28
40
|
/**
|
|
29
|
-
* A hop as `Wow-Wait` spells it: `accepted`, `committed`, `snapshot
|
|
30
|
-
* `handled(subscription)`, each with its context when it has
|
|
31
|
-
* `committed(ctx)`, `snapshot(ctx)`, `
|
|
41
|
+
* A hop as `Wow-Wait` spells it: `accepted`, `committed`, `snapshot`,
|
|
42
|
+
* `queryable` and `handled(subscription)`, each with its context when it has
|
|
43
|
+
* one: `committed(ctx)`, `snapshot(ctx)`, `queryable(ctx)`,
|
|
44
|
+
* `handled(ctx/subscription)`.
|
|
32
45
|
*
|
|
33
46
|
* @param value - The hop
|
|
34
47
|
*/
|
|
@@ -87,7 +100,7 @@ export declare class WaitPlan {
|
|
|
87
100
|
export declare function formatWaitPlan(plan: WaitPlan): string;
|
|
88
101
|
/**
|
|
89
102
|
* The plan a `Wow-Wait` value spells, as the service reads it: hops
|
|
90
|
-
* separated by `>`, each `accepted`, `committed`, `snapshot` or
|
|
103
|
+
* separated by `>`, each `accepted`, `committed`, `snapshot`, `queryable` or
|
|
91
104
|
* `handled(subscription)`, with its context in parentheses
|
|
92
105
|
* (`committed(ctx)`, `handled(ctx/subscription)`); the inverse of
|
|
93
106
|
* {@link formatWaitPlan}. Throws a `TypeError` for anything else.
|
package/dist/wait.d.ts
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
import { Hop } from './wire.js';
|
|
2
2
|
/** The name of the built-in subscription that writes snapshots. */
|
|
3
|
-
export declare const SNAPSHOT_SUBSCRIPTION = "snapshot";
|
|
3
|
+
export declare const SNAPSHOT_SUBSCRIPTION = "wow.snapshot";
|
|
4
|
+
/**
|
|
5
|
+
* The name a `queryable` hop gives the snapshot subscription of the store an
|
|
6
|
+
* aggregate type's snapshot queries read: its copy's where it has one, else
|
|
7
|
+
* its own store's, as `snapshot` is.
|
|
8
|
+
*/
|
|
9
|
+
export declare const QUERYABLE_SUBSCRIPTION = "wow.queryable";
|
|
4
10
|
/**
|
|
5
11
|
* Builds the hops of a wait chain. A context left out is
|
|
6
12
|
* the command's own. A saga's `handled` hop may be followed by hops of the
|
|
@@ -22,13 +28,20 @@ export declare const wait: {
|
|
|
22
28
|
readonly committed: (context?: string) => Hop;
|
|
23
29
|
/** Until the snapshot holds the commit: the caller reads its own write. */
|
|
24
30
|
readonly snapshot: (context?: string) => Hop;
|
|
31
|
+
/**
|
|
32
|
+
* Until the store the aggregate type's snapshot queries read holds the
|
|
33
|
+
* commit: a list or a count the caller runs next sees it. The same as
|
|
34
|
+
* `snapshot` for a type whose queries read its own store.
|
|
35
|
+
*/
|
|
36
|
+
readonly queryable: (context?: string) => Hop;
|
|
25
37
|
/** Until the subscription named `processor.function` handled the commit. */
|
|
26
38
|
readonly handled: (subscription: string, context?: string) => Hop;
|
|
27
39
|
};
|
|
28
40
|
/**
|
|
29
|
-
* A hop as `Wow-Wait` spells it: `accepted`, `committed`, `snapshot
|
|
30
|
-
* `handled(subscription)`, each with its context when it has
|
|
31
|
-
* `committed(ctx)`, `snapshot(ctx)`, `
|
|
41
|
+
* A hop as `Wow-Wait` spells it: `accepted`, `committed`, `snapshot`,
|
|
42
|
+
* `queryable` and `handled(subscription)`, each with its context when it has
|
|
43
|
+
* one: `committed(ctx)`, `snapshot(ctx)`, `queryable(ctx)`,
|
|
44
|
+
* `handled(ctx/subscription)`.
|
|
32
45
|
*
|
|
33
46
|
* @param value - The hop
|
|
34
47
|
*/
|
|
@@ -87,7 +100,7 @@ export declare class WaitPlan {
|
|
|
87
100
|
export declare function formatWaitPlan(plan: WaitPlan): string;
|
|
88
101
|
/**
|
|
89
102
|
* The plan a `Wow-Wait` value spells, as the service reads it: hops
|
|
90
|
-
* separated by `>`, each `accepted`, `committed`, `snapshot` or
|
|
103
|
+
* separated by `>`, each `accepted`, `committed`, `snapshot`, `queryable` or
|
|
91
104
|
* `handled(subscription)`, with its context in parentheses
|
|
92
105
|
* (`committed(ctx)`, `handled(ctx/subscription)`); the inverse of
|
|
93
106
|
* {@link formatWaitPlan}. Throws a `TypeError` for anything else.
|
package/dist/wait.es.js
CHANGED
|
@@ -1,91 +1,93 @@
|
|
|
1
1
|
import { Stage as e } from "./wire.es.js";
|
|
2
2
|
// src/wait.ts
|
|
3
|
-
var t = "snapshot", n = /^[A-Za-z0-9_.-]+$/;
|
|
4
|
-
function
|
|
5
|
-
if (!
|
|
3
|
+
var t = "wow.snapshot", n = "wow.queryable", r = /^[A-Za-z0-9_.-]+$/;
|
|
4
|
+
function i(e, t) {
|
|
5
|
+
if (!r.test(t)) throw TypeError(`Not a ${e} name: '${t}'.`);
|
|
6
6
|
return t;
|
|
7
7
|
}
|
|
8
|
-
function
|
|
8
|
+
function a(e, t, n) {
|
|
9
9
|
return {
|
|
10
10
|
stage: e,
|
|
11
|
-
...t === void 0 ? {} : { context:
|
|
12
|
-
...n === void 0 ? {} : { subscription:
|
|
11
|
+
...t === void 0 ? {} : { context: i("context", t) },
|
|
12
|
+
...n === void 0 ? {} : { subscription: i("subscription", n) }
|
|
13
13
|
};
|
|
14
14
|
}
|
|
15
|
-
var
|
|
16
|
-
accepted: (t) =>
|
|
17
|
-
committed: (t) =>
|
|
18
|
-
snapshot: (n) =>
|
|
19
|
-
|
|
15
|
+
var o = {
|
|
16
|
+
accepted: (t) => a(e.ACCEPTED, t),
|
|
17
|
+
committed: (t) => a(e.COMMITTED, t),
|
|
18
|
+
snapshot: (n) => a(e.HANDLED, n, t),
|
|
19
|
+
queryable: (t) => a(e.HANDLED, t, n),
|
|
20
|
+
handled: (t, n) => a(e.HANDLED, n, t)
|
|
20
21
|
};
|
|
21
|
-
function
|
|
22
|
+
function s(t) {
|
|
22
23
|
let n = t.context ?? void 0, r = t.subscription ?? void 0;
|
|
23
24
|
if (t.stage === e.HANDLED) {
|
|
24
25
|
if (r === void 0) throw TypeError("A handled hop names its subscription.");
|
|
25
|
-
return r === "snapshot" ? n === void 0 ? "snapshot" : `snapshot(${n})` : n === void 0 ? `handled(${r})` : `handled(${n}/${r})`;
|
|
26
|
+
return r === "wow.snapshot" ? n === void 0 ? "snapshot" : `snapshot(${n})` : r === "wow.queryable" ? n === void 0 ? "queryable" : `queryable(${n})` : n === void 0 ? `handled(${r})` : `handled(${n}/${r})`;
|
|
26
27
|
}
|
|
27
28
|
if (r !== void 0) throw TypeError("Only a handled hop names a subscription.");
|
|
28
29
|
let i = t.stage.toLowerCase();
|
|
29
30
|
return n === void 0 ? i : `${i}(${n})`;
|
|
30
31
|
}
|
|
31
|
-
var
|
|
32
|
+
var c = class e {
|
|
32
33
|
static {
|
|
33
34
|
this.DEFAULT_TIMEOUT = 1e4;
|
|
34
35
|
}
|
|
35
36
|
static {
|
|
36
|
-
this.DEFAULT = new e([
|
|
37
|
+
this.DEFAULT = new e([o.snapshot()], void 0, !0);
|
|
37
38
|
}
|
|
38
39
|
static {
|
|
39
|
-
this.SNAPSHOT = new e([
|
|
40
|
+
this.SNAPSHOT = new e([o.snapshot()]);
|
|
40
41
|
}
|
|
41
42
|
static {
|
|
42
|
-
this.COMMITTED = new e([
|
|
43
|
+
this.COMMITTED = new e([o.committed()]);
|
|
43
44
|
}
|
|
44
45
|
static {
|
|
45
|
-
this.ACCEPTED = new e([
|
|
46
|
+
this.ACCEPTED = new e([o.accepted()]);
|
|
46
47
|
}
|
|
47
48
|
static of(...t) {
|
|
48
49
|
return new e(t);
|
|
49
50
|
}
|
|
50
51
|
constructor(t, n = e.DEFAULT_TIMEOUT, r = !1) {
|
|
51
52
|
if (t.length === 0) throw TypeError("A wait plan has at least one hop.");
|
|
52
|
-
|
|
53
|
+
m(n), this.hops = Object.freeze([...t]), this.timeout = n, this.isDefault = r, Object.freeze(this);
|
|
53
54
|
}
|
|
54
55
|
within(t) {
|
|
55
56
|
return new e(this.hops, t, this.isDefault);
|
|
56
57
|
}
|
|
57
58
|
};
|
|
58
|
-
function
|
|
59
|
-
return e.hops.map(
|
|
59
|
+
function l(e) {
|
|
60
|
+
return e.hops.map(s).join(" > ");
|
|
60
61
|
}
|
|
61
|
-
var
|
|
62
|
-
function
|
|
62
|
+
var u = /^([A-Za-z]+)\s*(?:\(\s*([^()]*?)\s*\))?$/;
|
|
63
|
+
function d(e) {
|
|
63
64
|
if (e.trim() === "") throw TypeError("A wait plan has at least one hop.");
|
|
64
|
-
return
|
|
65
|
+
return c.of(...e.split(">").map((e) => f(e.trim())));
|
|
65
66
|
}
|
|
66
|
-
function
|
|
67
|
-
let t =
|
|
67
|
+
function f(e) {
|
|
68
|
+
let t = u.exec(e);
|
|
68
69
|
if (t === null) throw TypeError(`Not a hop: '${e}'.`);
|
|
69
70
|
let n = t[1].toLowerCase(), r = t[2];
|
|
70
71
|
switch (n) {
|
|
71
|
-
case "accepted": return
|
|
72
|
-
case "committed": return
|
|
73
|
-
case "snapshot": return
|
|
72
|
+
case "accepted": return o.accepted(r);
|
|
73
|
+
case "committed": return o.committed(r);
|
|
74
|
+
case "snapshot": return o.snapshot(r);
|
|
75
|
+
case "queryable": return o.queryable(r);
|
|
74
76
|
case "handled": {
|
|
75
77
|
if (r === void 0) throw TypeError(`A handled hop names its subscription: '${e}'.`);
|
|
76
78
|
let t = r.split("/");
|
|
77
79
|
if (t.length > 2) throw TypeError(`A handled hop is (subscription) or (context/subscription): '${r}'.`);
|
|
78
|
-
return t.length === 1 ?
|
|
80
|
+
return t.length === 1 ? o.handled(t[0]) : o.handled(t[1].trim(), t[0].trim());
|
|
79
81
|
}
|
|
80
82
|
default: throw TypeError(`Not a stage: '${n}'.`);
|
|
81
83
|
}
|
|
82
84
|
}
|
|
83
|
-
function f(e) {
|
|
84
|
-
return p(e), e % 1e3 == 0 ? `${e / 1e3}s` : `${e}ms`;
|
|
85
|
-
}
|
|
86
85
|
function p(e) {
|
|
86
|
+
return m(e), e % 1e3 == 0 ? `${e / 1e3}s` : `${e}ms`;
|
|
87
|
+
}
|
|
88
|
+
function m(e) {
|
|
87
89
|
if (!Number.isInteger(e) || e <= 0) throw TypeError(`A wait timeout is a positive whole number of milliseconds: ${e}.`);
|
|
88
90
|
}
|
|
89
|
-
export { t as SNAPSHOT_SUBSCRIPTION,
|
|
91
|
+
export { n as QUERYABLE_SUBSCRIPTION, t as SNAPSHOT_SUBSCRIPTION, c as WaitPlan, s as formatHop, l as formatWaitPlan, p as formatWaitTimeout, f as parseHop, d as parseWaitPlan, o as wait };
|
|
90
92
|
|
|
91
93
|
//# sourceMappingURL=wait.es.js.map
|
package/dist/wait.es.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"wait.es.js","names":["SNAPSHOT_SUBSCRIPTION","NAME","checkName","value","kind","hop","context","subscription","wait","Stage","formatHop","keyword","WaitPlan","hops","checkTimeout","timeout","isDefault","formatWaitPlan","plan","HOP","parseWaitPlan","parseHop","part","match","argument","parts","formatWaitTimeout"],"sources":["../src/wait.ts"],"sourcesContent":["/*\n * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n * http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { type Hop, Stage } from './wire.js';\n\n/** The name of the built-in subscription that writes snapshots. */\nexport const SNAPSHOT_SUBSCRIPTION = 'snapshot';\n\nconst NAME = /^[A-Za-z0-9_.-]+$/;\n\nfunction checkName(kind: string, value: string): string {\n if (!NAME.test(value)) {\n throw new TypeError(`Not a ${kind} name: '${value}'.`);\n }\n return value;\n}\n\nfunction hop(stage: Stage, context?: string, subscription?: string): Hop {\n return {\n stage,\n ...(context === undefined\n ? {}\n : { context: checkName('context', context) }),\n ...(subscription === undefined\n ? {}\n : { subscription: checkName('subscription', subscription) }),\n };\n}\n\n/**\n * Builds the hops of a wait chain. A context left out is\n * the command's own. A saga's `handled` hop may be followed by hops of the\n * commands it derived, in their contexts:\n *\n * @example\n * ```typescript\n * const plan = [\n * wait.committed(),\n * wait.handled('BasketCheckoutSaga.onBasketCheckedOut', 'eshop-basket'),\n * wait.committed('eshop-ordering'),\n * ];\n * ```\n */\nexport const wait = {\n /** Until the command passed admission; the route answers 202. */\n accepted: (context?: string): Hop => hop(Stage.ACCEPTED, context),\n /** Until the command's events are appended to the log. */\n committed: (context?: string): Hop => hop(Stage.COMMITTED, context),\n /** Until the snapshot holds the commit: the caller reads its own write. */\n snapshot: (context?: string): Hop =>\n hop(Stage.HANDLED, context, SNAPSHOT_SUBSCRIPTION),\n /** Until the subscription named `processor.function` handled the commit. */\n handled: (subscription: string, context?: string): Hop =>\n hop(Stage.HANDLED, context, subscription),\n} as const;\n\n/**\n * A hop as `Wow-Wait` spells it: `accepted`, `committed`, `snapshot` and\n * `handled(subscription)`, each with its context when it has one:\n * `committed(ctx)`, `snapshot(ctx)`, `handled(ctx/subscription)`.\n *\n * @param value - The hop\n */\nexport function formatHop(value: Hop): string {\n const context = value.context ?? undefined;\n const subscription = value.subscription ?? undefined;\n if (value.stage === Stage.HANDLED) {\n if (subscription === undefined) {\n throw new TypeError('A handled hop names its subscription.');\n }\n if (subscription === SNAPSHOT_SUBSCRIPTION) {\n return context === undefined ? 'snapshot' : `snapshot(${context})`;\n }\n return context === undefined\n ? `handled(${subscription})`\n : `handled(${context}/${subscription})`;\n }\n if (subscription !== undefined) {\n throw new TypeError(`Only a handled hop names a subscription.`);\n }\n const keyword = value.stage.toLowerCase();\n return context === undefined ? keyword : `${keyword}(${context})`;\n}\n\n/**\n * How far a command is waited for, and for how long: the hops, in order, and\n * a timeout in milliseconds. Kotlin's `me.ahoo.wow.api.result.WaitPlan`,\n * with its constants and constructors: {@link WaitPlan.of} the hops a\n * {@link wait} builder makes, {@link WaitPlan.within} another timeout.\n *\n * @example\n * ```typescript\n * const plan = WaitPlan.of(\n * wait.committed(),\n * wait.handled('BasketCheckoutSaga.onBasketCheckedOut', 'eshop-basket'),\n * ).within(30_000);\n * ```\n */\nexport class WaitPlan {\n /** The timeout of a wait whose caller gives none: 10 seconds. */\n static readonly DEFAULT_TIMEOUT = 10_000;\n\n /**\n * The plan of a caller that asked for none: until the snapshot holds the\n * commit, so the caller reads its own write; until `committed` for an\n * aggregate without a snapshot subscription. A request with it sends no\n * `Wow-Wait`, so the service picks.\n */\n static readonly DEFAULT = new WaitPlan([wait.snapshot()], undefined, true);\n\n /**\n * Until the snapshot holds the commit, asked for explicitly: rejected at\n * admission for an aggregate without a snapshot subscription.\n */\n static readonly SNAPSHOT = new WaitPlan([wait.snapshot()]);\n\n /** Until the events are appended. */\n static readonly COMMITTED = new WaitPlan([wait.committed()]);\n\n /** Until the command passed admission. */\n static readonly ACCEPTED = new WaitPlan([wait.accepted()]);\n\n /** Until `hops` are reached, in order. */\n static of(...hops: Hop[]): WaitPlan {\n return new WaitPlan(hops);\n }\n\n /** The hops to reach, in order; at least one. */\n readonly hops: readonly Hop[];\n /** How long to wait, in milliseconds. */\n readonly timeout: number;\n /** Whether this is {@link WaitPlan.DEFAULT}, the service's choice. */\n readonly isDefault: boolean;\n\n private constructor(\n hops: readonly Hop[],\n timeout: number = WaitPlan.DEFAULT_TIMEOUT,\n isDefault = false,\n ) {\n if (hops.length === 0) {\n throw new TypeError('A wait plan has at least one hop.');\n }\n checkTimeout(timeout);\n this.hops = Object.freeze([...hops]);\n this.timeout = timeout;\n this.isDefault = isDefault;\n Object.freeze(this);\n }\n\n /** This plan, waiting `timeout` milliseconds. */\n within(timeout: number): WaitPlan {\n return new WaitPlan(this.hops, timeout, this.isDefault);\n }\n}\n\n/**\n * A wait plan as the `Wow-Wait` header spells it: its hops, in order,\n * separated by `>`; the inverse of {@link parseWaitPlan}.\n *\n * @param plan - The plan\n */\nexport function formatWaitPlan(plan: WaitPlan): string {\n return plan.hops.map(formatHop).join(' > ');\n}\n\nconst HOP = /^([A-Za-z]+)\\s*(?:\\(\\s*([^()]*?)\\s*\\))?$/;\n\n/**\n * The plan a `Wow-Wait` value spells, as the service reads it: hops\n * separated by `>`, each `accepted`, `committed`, `snapshot` or\n * `handled(subscription)`, with its context in parentheses\n * (`committed(ctx)`, `handled(ctx/subscription)`); the inverse of\n * {@link formatWaitPlan}. Throws a `TypeError` for anything else.\n *\n * @param value - The header's value\n */\nexport function parseWaitPlan(value: string): WaitPlan {\n if (value.trim() === '') {\n throw new TypeError('A wait plan has at least one hop.');\n }\n return WaitPlan.of(...value.split('>').map(part => parseHop(part.trim())));\n}\n\n/**\n * The hop one part of a `Wow-Wait` value spells; see {@link parseWaitPlan}.\n *\n * @param value - The part, such as `committed(ctx)`\n */\nexport function parseHop(value: string): Hop {\n const match = HOP.exec(value);\n if (match === null) throw new TypeError(`Not a hop: '${value}'.`);\n const keyword = match[1].toLowerCase();\n const argument = match[2];\n switch (keyword) {\n case 'accepted':\n return wait.accepted(argument);\n case 'committed':\n return wait.committed(argument);\n case 'snapshot':\n return wait.snapshot(argument);\n case 'handled': {\n if (argument === undefined) {\n throw new TypeError(\n `A handled hop names its subscription: '${value}'.`,\n );\n }\n const parts = argument.split('/');\n if (parts.length > 2) {\n throw new TypeError(\n `A handled hop is (subscription) or (context/subscription): '${argument}'.`,\n );\n }\n return parts.length === 1\n ? wait.handled(parts[0])\n : wait.handled(parts[1].trim(), parts[0].trim());\n }\n default:\n throw new TypeError(`Not a stage: '${keyword}'.`);\n }\n}\n\n/**\n * A wait timeout as the `Wow-Wait-Timeout` header spells it: milliseconds\n * as `<n>s` when whole seconds, else `<n>ms`.\n *\n * @param timeout - Milliseconds\n */\nexport function formatWaitTimeout(timeout: number): string {\n checkTimeout(timeout);\n return timeout % 1000 === 0 ? `${timeout / 1000}s` : `${timeout}ms`;\n}\n\nfunction checkTimeout(timeout: number): void {\n if (!Number.isInteger(timeout) || timeout <= 0) {\n throw new TypeError(\n `A wait timeout is a positive whole number of milliseconds: ${timeout}.`,\n );\n }\n}\n"],"mappings":";;AAgBA,IAAaA,IAAwB,YAE/BC,IAAO;AAEb,SAASC,EAAU,GAAc,GAAuB;CACtD,IAAI,CAACD,EAAK,KAAKE,CAAK,GAClB,MAAU,UAAU,SAASC,EAAK,UAAUD,EAAM,GAAG;CAEvD,OAAOA;AACT;AAEA,SAASE,EAAI,GAAc,GAAkB,GAA4B;CACvE,OAAO;EACL;EACA,GAAIC,MAAY,KAAA,IACZ,CAAC,IACD,EAAE,SAASJ,EAAU,WAAWI,CAAO,EAAE;EAC7C,GAAIC,MAAiB,KAAA,IACjB,CAAC,IACD,EAAE,cAAcL,EAAU,gBAAgBK,CAAY,EAAE;CAC9D;AACF;AAgBA,IAAaC,IAAO;CAElB,WAAW,MAA0BH,EAAII,EAAM,UAAUH,CAAO;CAEhE,YAAY,MAA0BD,EAAII,EAAM,WAAWH,CAAO;CAElE,WAAW,MACTD,EAAII,EAAM,SAASH,GAASN,CAAqB;CAEnD,UAAU,GAAsB,MAC9BK,EAAII,EAAM,SAASH,GAASC,CAAY;AAC5C;AASA,SAAgBG,EAAU,GAAoB;CAC5C,IAAMJ,IAAUH,EAAM,WAAW,KAAA,GAC3BI,IAAeJ,EAAM,gBAAgB,KAAA;CAC3C,IAAIA,EAAM,UAAUM,EAAM,SAAS;EACjC,IAAIF,MAAiB,KAAA,GACnB,MAAU,UAAU,uCAAuC;EAK7D,OAHIA,MAAA,aACKD,MAAY,KAAA,IAAY,aAAa,YAAYA,EAAQ,KAE3DA,MAAY,KAAA,IACf,WAAWC,EAAa,KACxB,WAAWD,EAAQ,GAAGC,EAAa;CACzC;CACA,IAAIA,MAAiB,KAAA,GACnB,MAAU,UAAU,0CAA0C;CAEhE,IAAMI,IAAUR,EAAM,MAAM,YAAY;CACxC,OAAOG,MAAY,KAAA,IAAYK,IAAU,GAAGA,EAAQ,GAAGL,EAAQ;AACjE;AAgBA,IAAaM,IAAb,MAAaA,EAAS;;EAEc,KAAA,kBAAA;;;EAQR,KAAA,UAAA,IAAIA,EAAS,CAACJ,EAAK,SAAS,CAAC,GAAG,KAAA,GAAW,EAAI;;;EAM9C,KAAA,WAAA,IAAII,EAAS,CAACJ,EAAK,SAAS,CAAC,CAAC;;;EAG7B,KAAA,YAAA,IAAII,EAAS,CAACJ,EAAK,UAAU,CAAC,CAAC;;;EAGhC,KAAA,WAAA,IAAII,EAAS,CAACJ,EAAK,SAAS,CAAC,CAAC;;CAGzD,OAAO,GAAG,GAAGK,GAAuB;EAClC,OAAO,IAAID,EAASC,CAAI;CAC1B;CASA,YACE,GACA,IAAkBD,EAAS,iBAC3B,IAAY,IACZ;EACA,IAAIC,EAAK,WAAW,GAClB,MAAU,UAAU,mCAAmC;EAMzD,AAJAC,EAAaC,CAAO,GACpB,KAAK,OAAO,OAAO,OAAO,CAAC,GAAGF,CAAI,CAAC,GACnC,KAAK,UAAUE,GACf,KAAK,YAAYC,GACjB,OAAO,OAAO,IAAI;CACpB;CAGA,OAAO,GAA2B;EAChC,OAAO,IAAIJ,EAAS,KAAK,MAAMG,GAAS,KAAK,SAAS;CACxD;AACF;AAQA,SAAgBE,EAAe,GAAwB;CACrD,OAAOC,EAAK,KAAK,IAAIR,CAAS,CAAC,CAAC,KAAK,KAAK;AAC5C;AAEA,IAAMS,IAAM;AAWZ,SAAgBC,EAAc,GAAyB;CACrD,IAAIjB,EAAM,KAAK,MAAM,IACnB,MAAU,UAAU,mCAAmC;CAEzD,OAAOS,EAAS,GAAG,GAAGT,EAAM,MAAM,GAAG,CAAC,CAAC,KAAI,MAAQkB,EAASC,EAAK,KAAK,CAAC,CAAC,CAAC;AAC3E;AAOA,SAAgBD,EAAS,GAAoB;CAC3C,IAAME,IAAQJ,EAAI,KAAKhB,CAAK;CAC5B,IAAIoB,MAAU,MAAM,MAAU,UAAU,eAAepB,EAAM,GAAG;CAChE,IAAMQ,IAAUY,EAAM,EAAE,CAAC,YAAY,GAC/BC,IAAWD,EAAM;CACvB,QAAQZ,GAAR;EACE,KAAK,YACH,OAAOH,EAAK,SAASgB,CAAQ;EAC/B,KAAK,aACH,OAAOhB,EAAK,UAAUgB,CAAQ;EAChC,KAAK,YACH,OAAOhB,EAAK,SAASgB,CAAQ;EAC/B,KAAK,WAAW;GACd,IAAIA,MAAa,KAAA,GACf,MAAU,UACR,0CAA0CrB,EAAM,GAClD;GAEF,IAAMsB,IAAQD,EAAS,MAAM,GAAG;GAChC,IAAIC,EAAM,SAAS,GACjB,MAAU,UACR,+DAA+DD,EAAS,GAC1E;GAEF,OAAOC,EAAM,WAAW,IACpBjB,EAAK,QAAQiB,EAAM,EAAE,IACrBjB,EAAK,QAAQiB,EAAM,EAAE,CAAC,KAAK,GAAGA,EAAM,EAAE,CAAC,KAAK,CAAC;EACnD;EACA,SACE,MAAU,UAAU,iBAAiBd,EAAQ,GAAG;CACpD;AACF;AAQA,SAAgBe,EAAkB,GAAyB;CAEzD,OADAZ,EAAaC,CAAO,GACbA,IAAU,OAAS,IAAI,GAAGA,IAAU,IAAK,KAAK,GAAGA,EAAQ;AAClE;AAEA,SAASD,EAAa,GAAuB;CAC3C,IAAI,CAAC,OAAO,UAAUC,CAAO,KAAKA,KAAW,GAC3C,MAAU,UACR,8DAA8DA,EAAQ,EACxE;AAEJ"}
|
|
1
|
+
{"version":3,"file":"wait.es.js","names":["SNAPSHOT_SUBSCRIPTION","QUERYABLE_SUBSCRIPTION","NAME","checkName","value","kind","hop","context","subscription","wait","Stage","formatHop","keyword","WaitPlan","hops","checkTimeout","timeout","isDefault","formatWaitPlan","plan","HOP","parseWaitPlan","parseHop","part","match","argument","parts","formatWaitTimeout"],"sources":["../src/wait.ts"],"sourcesContent":["/*\n * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n * http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { type Hop, Stage } from './wire.js';\n\n/** The name of the built-in subscription that writes snapshots. */\nexport const SNAPSHOT_SUBSCRIPTION = 'wow.snapshot';\n\n/**\n * The name a `queryable` hop gives the snapshot subscription of the store an\n * aggregate type's snapshot queries read: its copy's where it has one, else\n * its own store's, as `snapshot` is.\n */\nexport const QUERYABLE_SUBSCRIPTION = 'wow.queryable';\n\nconst NAME = /^[A-Za-z0-9_.-]+$/;\n\nfunction checkName(kind: string, value: string): string {\n if (!NAME.test(value)) {\n throw new TypeError(`Not a ${kind} name: '${value}'.`);\n }\n return value;\n}\n\nfunction hop(stage: Stage, context?: string, subscription?: string): Hop {\n return {\n stage,\n ...(context === undefined\n ? {}\n : { context: checkName('context', context) }),\n ...(subscription === undefined\n ? {}\n : { subscription: checkName('subscription', subscription) }),\n };\n}\n\n/**\n * Builds the hops of a wait chain. A context left out is\n * the command's own. A saga's `handled` hop may be followed by hops of the\n * commands it derived, in their contexts:\n *\n * @example\n * ```typescript\n * const plan = [\n * wait.committed(),\n * wait.handled('BasketCheckoutSaga.onBasketCheckedOut', 'eshop-basket'),\n * wait.committed('eshop-ordering'),\n * ];\n * ```\n */\nexport const wait = {\n /** Until the command passed admission; the route answers 202. */\n accepted: (context?: string): Hop => hop(Stage.ACCEPTED, context),\n /** Until the command's events are appended to the log. */\n committed: (context?: string): Hop => hop(Stage.COMMITTED, context),\n /** Until the snapshot holds the commit: the caller reads its own write. */\n snapshot: (context?: string): Hop =>\n hop(Stage.HANDLED, context, SNAPSHOT_SUBSCRIPTION),\n /**\n * Until the store the aggregate type's snapshot queries read holds the\n * commit: a list or a count the caller runs next sees it. The same as\n * `snapshot` for a type whose queries read its own store.\n */\n queryable: (context?: string): Hop =>\n hop(Stage.HANDLED, context, QUERYABLE_SUBSCRIPTION),\n /** Until the subscription named `processor.function` handled the commit. */\n handled: (subscription: string, context?: string): Hop =>\n hop(Stage.HANDLED, context, subscription),\n} as const;\n\n/**\n * A hop as `Wow-Wait` spells it: `accepted`, `committed`, `snapshot`,\n * `queryable` and `handled(subscription)`, each with its context when it has\n * one: `committed(ctx)`, `snapshot(ctx)`, `queryable(ctx)`,\n * `handled(ctx/subscription)`.\n *\n * @param value - The hop\n */\nexport function formatHop(value: Hop): string {\n const context = value.context ?? undefined;\n const subscription = value.subscription ?? undefined;\n if (value.stage === Stage.HANDLED) {\n if (subscription === undefined) {\n throw new TypeError('A handled hop names its subscription.');\n }\n if (subscription === SNAPSHOT_SUBSCRIPTION) {\n return context === undefined ? 'snapshot' : `snapshot(${context})`;\n }\n if (subscription === QUERYABLE_SUBSCRIPTION) {\n return context === undefined ? 'queryable' : `queryable(${context})`;\n }\n return context === undefined\n ? `handled(${subscription})`\n : `handled(${context}/${subscription})`;\n }\n if (subscription !== undefined) {\n throw new TypeError(`Only a handled hop names a subscription.`);\n }\n const keyword = value.stage.toLowerCase();\n return context === undefined ? keyword : `${keyword}(${context})`;\n}\n\n/**\n * How far a command is waited for, and for how long: the hops, in order, and\n * a timeout in milliseconds. Kotlin's `me.ahoo.wow.api.result.WaitPlan`,\n * with its constants and constructors: {@link WaitPlan.of} the hops a\n * {@link wait} builder makes, {@link WaitPlan.within} another timeout.\n *\n * @example\n * ```typescript\n * const plan = WaitPlan.of(\n * wait.committed(),\n * wait.handled('BasketCheckoutSaga.onBasketCheckedOut', 'eshop-basket'),\n * ).within(30_000);\n * ```\n */\nexport class WaitPlan {\n /** The timeout of a wait whose caller gives none: 10 seconds. */\n static readonly DEFAULT_TIMEOUT = 10_000;\n\n /**\n * The plan of a caller that asked for none: until the snapshot holds the\n * commit, so the caller reads its own write; until `committed` for an\n * aggregate without a snapshot subscription. A request with it sends no\n * `Wow-Wait`, so the service picks.\n */\n static readonly DEFAULT = new WaitPlan([wait.snapshot()], undefined, true);\n\n /**\n * Until the snapshot holds the commit, asked for explicitly: rejected at\n * admission for an aggregate without a snapshot subscription.\n */\n static readonly SNAPSHOT = new WaitPlan([wait.snapshot()]);\n\n /** Until the events are appended. */\n static readonly COMMITTED = new WaitPlan([wait.committed()]);\n\n /** Until the command passed admission. */\n static readonly ACCEPTED = new WaitPlan([wait.accepted()]);\n\n /** Until `hops` are reached, in order. */\n static of(...hops: Hop[]): WaitPlan {\n return new WaitPlan(hops);\n }\n\n /** The hops to reach, in order; at least one. */\n readonly hops: readonly Hop[];\n /** How long to wait, in milliseconds. */\n readonly timeout: number;\n /** Whether this is {@link WaitPlan.DEFAULT}, the service's choice. */\n readonly isDefault: boolean;\n\n private constructor(\n hops: readonly Hop[],\n timeout: number = WaitPlan.DEFAULT_TIMEOUT,\n isDefault = false,\n ) {\n if (hops.length === 0) {\n throw new TypeError('A wait plan has at least one hop.');\n }\n checkTimeout(timeout);\n this.hops = Object.freeze([...hops]);\n this.timeout = timeout;\n this.isDefault = isDefault;\n Object.freeze(this);\n }\n\n /** This plan, waiting `timeout` milliseconds. */\n within(timeout: number): WaitPlan {\n return new WaitPlan(this.hops, timeout, this.isDefault);\n }\n}\n\n/**\n * A wait plan as the `Wow-Wait` header spells it: its hops, in order,\n * separated by `>`; the inverse of {@link parseWaitPlan}.\n *\n * @param plan - The plan\n */\nexport function formatWaitPlan(plan: WaitPlan): string {\n return plan.hops.map(formatHop).join(' > ');\n}\n\nconst HOP = /^([A-Za-z]+)\\s*(?:\\(\\s*([^()]*?)\\s*\\))?$/;\n\n/**\n * The plan a `Wow-Wait` value spells, as the service reads it: hops\n * separated by `>`, each `accepted`, `committed`, `snapshot`, `queryable` or\n * `handled(subscription)`, with its context in parentheses\n * (`committed(ctx)`, `handled(ctx/subscription)`); the inverse of\n * {@link formatWaitPlan}. Throws a `TypeError` for anything else.\n *\n * @param value - The header's value\n */\nexport function parseWaitPlan(value: string): WaitPlan {\n if (value.trim() === '') {\n throw new TypeError('A wait plan has at least one hop.');\n }\n return WaitPlan.of(...value.split('>').map(part => parseHop(part.trim())));\n}\n\n/**\n * The hop one part of a `Wow-Wait` value spells; see {@link parseWaitPlan}.\n *\n * @param value - The part, such as `committed(ctx)`\n */\nexport function parseHop(value: string): Hop {\n const match = HOP.exec(value);\n if (match === null) throw new TypeError(`Not a hop: '${value}'.`);\n const keyword = match[1].toLowerCase();\n const argument = match[2];\n switch (keyword) {\n case 'accepted':\n return wait.accepted(argument);\n case 'committed':\n return wait.committed(argument);\n case 'snapshot':\n return wait.snapshot(argument);\n case 'queryable':\n return wait.queryable(argument);\n case 'handled': {\n if (argument === undefined) {\n throw new TypeError(\n `A handled hop names its subscription: '${value}'.`,\n );\n }\n const parts = argument.split('/');\n if (parts.length > 2) {\n throw new TypeError(\n `A handled hop is (subscription) or (context/subscription): '${argument}'.`,\n );\n }\n return parts.length === 1\n ? wait.handled(parts[0])\n : wait.handled(parts[1].trim(), parts[0].trim());\n }\n default:\n throw new TypeError(`Not a stage: '${keyword}'.`);\n }\n}\n\n/**\n * A wait timeout as the `Wow-Wait-Timeout` header spells it: milliseconds\n * as `<n>s` when whole seconds, else `<n>ms`.\n *\n * @param timeout - Milliseconds\n */\nexport function formatWaitTimeout(timeout: number): string {\n checkTimeout(timeout);\n return timeout % 1000 === 0 ? `${timeout / 1000}s` : `${timeout}ms`;\n}\n\nfunction checkTimeout(timeout: number): void {\n if (!Number.isInteger(timeout) || timeout <= 0) {\n throw new TypeError(\n `A wait timeout is a positive whole number of milliseconds: ${timeout}.`,\n );\n }\n}\n"],"mappings":";;AAgBA,IAAaA,IAAwB,gBAOxBC,IAAyB,iBAEhCC,IAAO;AAEb,SAASC,EAAU,GAAc,GAAuB;CACtD,IAAI,CAACD,EAAK,KAAKE,CAAK,GAClB,MAAU,UAAU,SAASC,EAAK,UAAUD,EAAM,GAAG;CAEvD,OAAOA;AACT;AAEA,SAASE,EAAI,GAAc,GAAkB,GAA4B;CACvE,OAAO;EACL;EACA,GAAIC,MAAY,KAAA,IACZ,CAAC,IACD,EAAE,SAASJ,EAAU,WAAWI,CAAO,EAAE;EAC7C,GAAIC,MAAiB,KAAA,IACjB,CAAC,IACD,EAAE,cAAcL,EAAU,gBAAgBK,CAAY,EAAE;CAC9D;AACF;AAgBA,IAAaC,IAAO;CAElB,WAAW,MAA0BH,EAAII,EAAM,UAAUH,CAAO;CAEhE,YAAY,MAA0BD,EAAII,EAAM,WAAWH,CAAO;CAElE,WAAW,MACTD,EAAII,EAAM,SAASH,GAASP,CAAqB;CAMnD,YAAY,MACVM,EAAII,EAAM,SAASH,GAASN,CAAsB;CAEpD,UAAU,GAAsB,MAC9BK,EAAII,EAAM,SAASH,GAASC,CAAY;AAC5C;AAUA,SAAgBG,EAAU,GAAoB;CAC5C,IAAMJ,IAAUH,EAAM,WAAW,KAAA,GAC3BI,IAAeJ,EAAM,gBAAgB,KAAA;CAC3C,IAAIA,EAAM,UAAUM,EAAM,SAAS;EACjC,IAAIF,MAAiB,KAAA,GACnB,MAAU,UAAU,uCAAuC;EAQ7D,OANIA,MAAA,iBACKD,MAAY,KAAA,IAAY,aAAa,YAAYA,EAAQ,KAE9DC,MAAA,kBACKD,MAAY,KAAA,IAAY,cAAc,aAAaA,EAAQ,KAE7DA,MAAY,KAAA,IACf,WAAWC,EAAa,KACxB,WAAWD,EAAQ,GAAGC,EAAa;CACzC;CACA,IAAIA,MAAiB,KAAA,GACnB,MAAU,UAAU,0CAA0C;CAEhE,IAAMI,IAAUR,EAAM,MAAM,YAAY;CACxC,OAAOG,MAAY,KAAA,IAAYK,IAAU,GAAGA,EAAQ,GAAGL,EAAQ;AACjE;AAgBA,IAAaM,IAAb,MAAaA,EAAS;;EAEc,KAAA,kBAAA;;;EAQR,KAAA,UAAA,IAAIA,EAAS,CAACJ,EAAK,SAAS,CAAC,GAAG,KAAA,GAAW,EAAI;;;EAM9C,KAAA,WAAA,IAAII,EAAS,CAACJ,EAAK,SAAS,CAAC,CAAC;;;EAG7B,KAAA,YAAA,IAAII,EAAS,CAACJ,EAAK,UAAU,CAAC,CAAC;;;EAGhC,KAAA,WAAA,IAAII,EAAS,CAACJ,EAAK,SAAS,CAAC,CAAC;;CAGzD,OAAO,GAAG,GAAGK,GAAuB;EAClC,OAAO,IAAID,EAASC,CAAI;CAC1B;CASA,YACE,GACA,IAAkBD,EAAS,iBAC3B,IAAY,IACZ;EACA,IAAIC,EAAK,WAAW,GAClB,MAAU,UAAU,mCAAmC;EAMzD,AAJAC,EAAaC,CAAO,GACpB,KAAK,OAAO,OAAO,OAAO,CAAC,GAAGF,CAAI,CAAC,GACnC,KAAK,UAAUE,GACf,KAAK,YAAYC,GACjB,OAAO,OAAO,IAAI;CACpB;CAGA,OAAO,GAA2B;EAChC,OAAO,IAAIJ,EAAS,KAAK,MAAMG,GAAS,KAAK,SAAS;CACxD;AACF;AAQA,SAAgBE,EAAe,GAAwB;CACrD,OAAOC,EAAK,KAAK,IAAIR,CAAS,CAAC,CAAC,KAAK,KAAK;AAC5C;AAEA,IAAMS,IAAM;AAWZ,SAAgBC,EAAc,GAAyB;CACrD,IAAIjB,EAAM,KAAK,MAAM,IACnB,MAAU,UAAU,mCAAmC;CAEzD,OAAOS,EAAS,GAAG,GAAGT,EAAM,MAAM,GAAG,CAAC,CAAC,KAAI,MAAQkB,EAASC,EAAK,KAAK,CAAC,CAAC,CAAC;AAC3E;AAOA,SAAgBD,EAAS,GAAoB;CAC3C,IAAME,IAAQJ,EAAI,KAAKhB,CAAK;CAC5B,IAAIoB,MAAU,MAAM,MAAU,UAAU,eAAepB,EAAM,GAAG;CAChE,IAAMQ,IAAUY,EAAM,EAAE,CAAC,YAAY,GAC/BC,IAAWD,EAAM;CACvB,QAAQZ,GAAR;EACE,KAAK,YACH,OAAOH,EAAK,SAASgB,CAAQ;EAC/B,KAAK,aACH,OAAOhB,EAAK,UAAUgB,CAAQ;EAChC,KAAK,YACH,OAAOhB,EAAK,SAASgB,CAAQ;EAC/B,KAAK,aACH,OAAOhB,EAAK,UAAUgB,CAAQ;EAChC,KAAK,WAAW;GACd,IAAIA,MAAa,KAAA,GACf,MAAU,UACR,0CAA0CrB,EAAM,GAClD;GAEF,IAAMsB,IAAQD,EAAS,MAAM,GAAG;GAChC,IAAIC,EAAM,SAAS,GACjB,MAAU,UACR,+DAA+DD,EAAS,GAC1E;GAEF,OAAOC,EAAM,WAAW,IACpBjB,EAAK,QAAQiB,EAAM,EAAE,IACrBjB,EAAK,QAAQiB,EAAM,EAAE,CAAC,KAAK,GAAGA,EAAM,EAAE,CAAC,KAAK,CAAC;EACnD;EACA,SACE,MAAU,UAAU,iBAAiBd,EAAQ,GAAG;CACpD;AACF;AAQA,SAAgBe,EAAkB,GAAyB;CAEzD,OADAZ,EAAaC,CAAO,GACbA,IAAU,OAAS,IAAI,GAAGA,IAAU,IAAK,KAAK,GAAGA,EAAQ;AAClE;AAEA,SAASD,EAAa,GAAuB;CAC3C,IAAI,CAAC,OAAO,UAAUC,CAAO,KAAKA,KAAW,GAC3C,MAAU,UACR,8DAA8DA,EAAQ,EACxE;AAEJ"}
|
package/dist/wire.cjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var e={ACCEPTED:`accepted`,COMMITTED:`committed`,HANDLED:`handled`},t={COMMAND:`command`,PROJECT:`project`,REACT:`react`,SAGA:`saga`,
|
|
1
|
+
var e={ACCEPTED:`accepted`,COMMITTED:`committed`,HANDLED:`handled`},t={COMMAND:`command`,PROJECT:`project`,REACT:`react`,SAGA:`saga`,SYSTEM:`system`},n={SUCCEEDED:`succeeded`,REJECTED:`rejected`,FAILED:`failed`};exports.CommandResultStatus=n,exports.FunctionKind=t,exports.Stage=e;
|
|
2
2
|
//# sourceMappingURL=wire.cjs.map
|
package/dist/wire.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"wire.cjs","names":["Stage","FunctionKind","CommandResultStatus"],"sources":["../src/wire.ts"],"sourcesContent":["/*\n * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n * http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { TextNumbers } from './exactJson.js';\n\n/**\n * The wire model of a Wow service: what its routes answer, as the server\n * writes it (`wow-api`'s `CommandResult`, the edge's state views, the query\n * records). Types and wire values only.\n */\n\n/** An aggregate type: its bounded context and its name. */\nexport interface AggregateType {\n readonly context: string;\n readonly name: string;\n /**\n * Which numbers of its states, events and commands are read and written\n * as their exact text (review R4-Q, Q-9): the `int64`, `bigint` and\n * `decimal` fields of its Manifest, as wow-generator writes them.\n */\n readonly textNumbers?: AggregateTextNumbers;\n}\n\n/** The numbers of an aggregate type kept as their exact text ({@link TextNumbers}). */\nexport interface AggregateTextNumbers {\n /** Those of its state. */\n readonly state?: TextNumbers;\n /** Those of each event's body, by the event's name as the server sends it. */\n readonly events?: Readonly<Record<string, TextNumbers>>;\n /** Those of each command's body, by the command's name. */\n readonly commands?: Readonly<Record<string, TextNumbers>>;\n}\n\n/** One aggregate: its type, its tenant and its id. */\nexport interface AggregateRef {\n readonly type: AggregateType;\n readonly tenantId: string;\n readonly id: string;\n}\n\n/**\n * The aggregate a command names: an {@link AggregateRef} whose `id` is null\n * while admission has not chosen it, as for a creation that leaves its id to\n * the server and was refused before one was chosen. The Kotlin client holds\n * such an id as `AggregateRef.UNASSIGNED`.\n */\nexport interface CommandRef {\n readonly type: AggregateType;\n readonly tenantId: string;\n readonly id: string | null;\n}\n\n/** The owner and the space an aggregate belongs to, beside its tenant. */\nexport interface Scope {\n readonly ownerId?: string | null;\n readonly spaceId?: string | null;\n}\n\n/**\n * Who sent a command: the opaque id of the authenticated\n * subject, its own tenant, and whether it acted in another tenant or scope.\n * Resolve the id to a display name in the application, never from Wow.\n */\nexport interface Operator {\n readonly id: string;\n readonly tenantId: string;\n readonly crossScope: boolean;\n}\n\n/** How far a command has come. */\nexport const Stage = {\n /** The command passed admission. */\n ACCEPTED: 'accepted',\n /** The command's events are appended to the log. */\n COMMITTED: 'committed',\n /** A named subscription has handled the commit. */\n HANDLED: 'handled',\n} as const;\n\n/** A {@link Stage} value. */\nexport type Stage = (typeof Stage)[keyof typeof Stage];\n\n/**\n * One hop of a wait chain: a stage, in a context (the\n * command's own when absent), of a subscription when the stage is\n * `handled`. The snapshot is the subscription named `snapshot`.\n */\nexport interface Hop {\n /**\n * The stage; a server newer than this client may answer one it does not\n * list.\n */\n readonly stage: Stage | (string & {});\n readonly context?: string | null;\n readonly subscription?: string | null;\n}\n\n/** The kind of function that produced a result. */\nexport const FunctionKind = {\n /** The aggregate's command function. */\n COMMAND: 'command',\n /** A projection. */\n PROJECT: 'project',\n /** An event handler that reacts. */\n REACT: 'react',\n /** A saga. */\n SAGA: 'saga',\n /** The snapshot subscription. */\n SNAPSHOT: 'snapshot',\n /** A reservation. */\n RESERVATION: 'reservation',\n /** A timer. */\n TIMERS: 'timers',\n} as const;\n\n/** A {@link FunctionKind} value. */\nexport type FunctionKind = (typeof FunctionKind)[keyof typeof FunctionKind];\n\n/** Who produced a result: a function of `kind` in `context`. */\nexport interface FunctionInfo {\n /**\n * The kind; a server newer than this client may answer one it does not\n * list.\n */\n readonly kind: FunctionKind | (string & {});\n readonly context: string;\n readonly processor: string;\n readonly name: string;\n}\n\n/** A field-level validation error. */\nexport interface Violation {\n /** The path of the field, or the query part, that broke the rule. */\n readonly path: string;\n /** The rule's code, such as `NotBlank` or `UNKNOWN_FIELD`. */\n readonly code: string;\n /** A human-readable message. */\n readonly message: string;\n}\n\n/** Why a command was rejected or failed. */\nexport interface ErrorInfo {\n /** A framework code (`wow.*`) or the domain's own. */\n readonly code: string;\n readonly message: string;\n readonly violations?: readonly Violation[];\n /**\n * The rejection's structured data (decision D211), which a problem\n * writes as its extension members.\n */\n readonly extensions?: Readonly<Record<string, unknown>>;\n}\n\n/** How a command ended at a hop. */\nexport const CommandResultStatus = {\n /** The command reached the hop. */\n SUCCEEDED: 'succeeded',\n /** The domain or admission refused the command. */\n REJECTED: 'rejected',\n /** A technical failure stopped the command. */\n FAILED: 'failed',\n} as const;\n\n/** A {@link CommandResultStatus} value. */\nexport type CommandResultStatus =\n (typeof CommandResultStatus)[keyof typeof CommandResultStatus];\n\n/**\n * The command a request named before a transformer turned it into the one\n * that ran.\n */\nexport interface TransformedFrom {\n /** The full type name, `context.aggregate.Command`. */\n readonly command: string;\n readonly aggregateId?: string | null;\n}\n\n/**\n * The one outward result of a command: what it reached at one\n * hop of its wait chain. A command route answers the last one; its event\n * stream sends one per hop.\n *\n * A chain can end before its plan does (decision D212): a hop, such as a\n * saga's that sent no command (a declined payment, say), leaves nothing to\n * reach the later hops. Its result is then the last one, at that hop with its\n * own status, `chainEnded` and the hops not reached in `pending`; a server\n * before D212 sends neither, so read them as `false` and empty when absent.\n *\n * @typeParam R - The shape of `results`, what the command's decide function\n * answered with.\n */\nexport interface CommandResult<R = Record<string, unknown>> {\n readonly format: number;\n readonly commandId: string;\n readonly requestId: string;\n readonly correlationId: string;\n /** The aggregate: a result that succeeded always names its id. */\n readonly ref: AggregateRef;\n readonly hop: Hop;\n readonly function: FunctionInfo;\n /**\n * The status; a server newer than this client may answer one it does not\n * list, which did not succeed as far as this client knows.\n */\n readonly status: CommandResultStatus | (string & {});\n /** The aggregate's version after the commit, or the unchanged one. */\n readonly version?: number | null;\n /** The request was already committed: it was not decided again. */\n readonly duplicate: boolean;\n /** Set when `status` is `rejected` or `failed`. */\n readonly error?: ErrorInfo | null;\n readonly results: R;\n /** On a saga's hop, the ids of the commands it derived. */\n readonly derived: readonly string[];\n /** When it was produced, in epoch milliseconds. */\n readonly signalTime: number;\n readonly transformedFrom?: TransformedFrom | null;\n /**\n * The chain ended at this hop before its plan did (decision D212): the\n * hops in `pending` will not come.\n */\n readonly chainEnded?: boolean;\n /** When `chainEnded`, the hops of the plan not reached, in order. */\n readonly pending?: readonly Hop[];\n}\n\n/**\n * A result that may not have succeeded, as a rejection or a problem carries\n * it (`CommandRejectedError.result`, `WowProblemError.result`): a command\n * refused before an aggregate id was decided names none\n * ({@link CommandRef}). The Kotlin client has no type of its own\n * for it: its `CommandResult.ref` holds such an id as\n * `AggregateRef.UNASSIGNED`.\n *\n * @typeParam R - The results' type.\n */\nexport interface RefusedResult<R = Record<string, unknown>> extends Omit<\n CommandResult<R>,\n 'ref'\n> {\n readonly ref: CommandRef;\n}\n\n/** The tags of an aggregate: names to values. */\nexport type Tags = Readonly<Record<string, readonly string[]>>;\n\n/**\n * An event as Wow reads it now: under its current name, upgraded to its latest revision. Kotlin's `CommittedEvent`. The `events` query gives\n * every stored event so, however old its record, and leaves out the events its aggregate retired, so a generated\n * `<Aggregate>Event` union, with {@link SystemEvent}, covers each event it returns.\n *\n * @typeParam N - The event's name.\n * @typeParam B - The event's body.\n */\nexport interface CommittedEvent<N extends string = string, B = unknown> {\n readonly name: N;\n readonly revision: number;\n readonly body: B;\n}\n\n/** The body of `wow.lifecycle.OwnerTransferred`: the aggregate's new owner. */\nexport interface OwnerTransferred {\n readonly ownerId: string;\n}\n\n/** The body of `wow.lifecycle.SpaceTransferred`: the aggregate's new space. */\nexport interface SpaceTransferred {\n readonly spaceId: string;\n}\n\n/** The body of `wow.lifecycle.TagsApplied`: the aggregate's tags now. */\nexport interface TagsApplied {\n readonly tags: Tags;\n}\n\n/**\n * The body of `wow.ScheduleSet`: the aggregate set its\n * schedule `key`, to send `target` the command of type `commandType`\n * (`command` its JSON text) as `rule` says.\n */\nexport interface ScheduleSet {\n readonly key: string;\n readonly rule: ScheduleRule;\n readonly target: CommandRef;\n readonly commandType: string;\n readonly command: string;\n}\n\n/** The body of `wow.ScheduleCancelled`. */\nexport interface ScheduleCancelled {\n readonly key: string;\n}\n\n/**\n * The system events the kernel gives every aggregate:\n * the lifecycle events and the schedule events. A state trace and an event\n * stream carry them beside the aggregate's own events, so the event union\n * `wow-generator` writes for an aggregate includes this one.\n */\nexport type SystemEvent =\n | CommittedEvent<\n 'wow.lifecycle.AggregateDeleted',\n Readonly<Record<string, never>>\n >\n | CommittedEvent<\n 'wow.lifecycle.AggregateRestored',\n Readonly<Record<string, never>>\n >\n | CommittedEvent<'wow.lifecycle.OwnerTransferred', OwnerTransferred>\n | CommittedEvent<'wow.lifecycle.SpaceTransferred', SpaceTransferred>\n | CommittedEvent<'wow.lifecycle.TagsApplied', TagsApplied>\n | CommittedEvent<'wow.ScheduleSet', ScheduleSet>\n | CommittedEvent<'wow.ScheduleCancelled', ScheduleCancelled>;\n\n/**\n * One commit of a state trace: the events of a version and the\n * aggregate after it.\n *\n * @typeParam S - The state's type.\n * @typeParam E - The events' type.\n */\nexport interface CommitView<\n S = unknown,\n E extends CommittedEvent = CommittedEvent,\n> {\n readonly version: number;\n /** When it was committed, in epoch milliseconds. */\n readonly commitTime: number;\n readonly commandId: string;\n readonly requestId: string;\n readonly commandType: string;\n readonly events: readonly E[];\n readonly scope: Scope;\n readonly deleted: boolean;\n readonly tags: Tags;\n readonly state: S;\n readonly operator?: Operator | null;\n}\n\n/**\n * What `GET /{context}/{aggregate}/{id}/state/trace` answers: the aggregate\n * and its commits in version order.\n */\nexport interface StateTrace<\n S = unknown,\n E extends CommittedEvent = CommittedEvent,\n> {\n readonly ref: AggregateRef;\n readonly commits: readonly CommitView<S, E>[];\n}\n\n/**\n * An aggregate's latest committed state, as a record of the `snapshot` query\n * model and as `GET /{context}/{aggregate}/{id}/state` answer it: the\n * aggregate's system fields and its state. Kotlin's `Snapshot`.\n *\n * @typeParam S - The state's type.\n */\nexport interface Snapshot<S = unknown> {\n readonly tenantId: string;\n readonly aggregateId: string;\n readonly version: number;\n readonly ownerId: string | null;\n readonly spaceId: string | null;\n readonly deleted: boolean;\n readonly tags: Tags;\n /** The first commit's time, in epoch milliseconds. */\n readonly firstEventTime: number;\n /** The last commit's time, in epoch milliseconds. */\n readonly lastEventTime: number;\n /** Who sent the last command; null for an anonymous caller. */\n readonly operator: Operator | null;\n /** Who created the aggregate; null for an anonymous caller. */\n readonly firstOperator: Operator | null;\n /**\n * The schedules the aggregate keeps (decision D198): each rule, `{type,\n * ...}`, by its key.\n */\n readonly schedules: Readonly<Record<string, ScheduleRule>>;\n readonly state: S;\n}\n\n/**\n * The system fields of a snapshot record a query can filter, sort and\n * project on; a state field is `state.<path>`.\n */\nexport type SnapshotSystemField =\n | 'tenantId'\n | 'aggregateId'\n | 'version'\n | 'ownerId'\n | 'spaceId'\n | 'deleted'\n | 'tags'\n | 'firstEventTime'\n | 'lastEventTime'\n | 'operator'\n | 'operator.id'\n | 'operator.tenantId'\n | 'operator.crossScope'\n | 'firstOperator'\n | 'firstOperator.id'\n | 'firstOperator.tenantId'\n | 'firstOperator.crossScope'\n | 'schedules';\n\n/** A schedule rule of a snapshot's `schedules`. */\nexport interface ScheduleRule {\n /** The rule's type: `at`, `after`, `cron`, … */\n readonly type: string;\n readonly [property: string]: unknown;\n}\n\n/**\n * A record of the `events` query model: one commit of one\n * aggregate and its events. Kotlin's `EventStream`.\n *\n * @typeParam E - The events' type.\n */\nexport interface EventStream<E extends CommittedEvent = CommittedEvent> {\n readonly aggregateId: string;\n readonly tenantId: string;\n readonly version: number;\n /** When it was committed, in epoch milliseconds. */\n readonly commitTime: number;\n readonly commandId: string;\n readonly requestId: string;\n readonly commandType: string;\n /** Null when the stream has none (`Scope.NONE`). */\n readonly ownerId?: string | null;\n readonly spaceId?: string | null;\n /** Null for an anonymous caller (decision D163). */\n readonly operator?: Operator | null;\n readonly events: readonly E[];\n}\n\n/**\n * The fields of an event stream record a query names: its\n * system fields and `events`, the array an `elementMatch` filter and an\n * aggregation's `elements` reach an event through, by the event's own\n * `name`, `revision` and `body.*`.\n */\nexport type EventStreamField =\n | 'aggregateId'\n | 'tenantId'\n | 'version'\n | 'commitTime'\n | 'commandId'\n | 'requestId'\n | 'commandType'\n | 'ownerId'\n | 'spaceId'\n | 'operator'\n | 'operator.id'\n | 'operator.tenantId'\n | 'operator.crossScope'\n | 'events';\n\n/** How an aggregate belongs to its callers. */\nexport type Ownership = 'owner' | 'tenant';\n\n/** One dataset of `GET /wow/dataset`. */\nexport interface DatasetEntry {\n /** `{context}.{dataset}`. */\n readonly name: string;\n readonly context: string;\n readonly dataset: string;\n readonly title?: string | null;\n /** The path of its query route. */\n readonly path: string;\n}\n"],"mappings":"AAgFA,IAAaA,EAAQ,CAEnB,SAAU,WAEV,UAAW,YAEX,QAAS,SACX,EAqBaC,EAAe,CAE1B,QAAS,UAET,QAAS,UAET,MAAO,QAEP,KAAM,OAEN,SAAU,WAEV,YAAa,cAEb,OAAQ,QACV,EAyCaC,EAAsB,CAEjC,UAAW,YAEX,SAAU,WAEV,OAAQ,QACV,E"}
|
|
1
|
+
{"version":3,"file":"wire.cjs","names":["Stage","FunctionKind","CommandResultStatus"],"sources":["../src/wire.ts"],"sourcesContent":["/*\n * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n * http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { TextNumbers } from './exactJson.js';\n\n/**\n * The wire model of a Wow service: what its routes answer, as the server\n * writes it (`wow-api`'s `CommandResult`, the edge's state views, the query\n * records). Types and wire values only.\n */\n\n/** An aggregate type: its bounded context and its name. */\nexport interface AggregateType {\n readonly context: string;\n readonly name: string;\n /**\n * Which numbers of its states, events and commands are read and written\n * as their exact text (review R4-Q, Q-9): the `int64`, `bigint` and\n * `decimal` fields of its Manifest, as wow-generator writes them.\n */\n readonly textNumbers?: AggregateTextNumbers;\n}\n\n/** The numbers of an aggregate type kept as their exact text ({@link TextNumbers}). */\nexport interface AggregateTextNumbers {\n /** Those of its state. */\n readonly state?: TextNumbers;\n /** Those of each event's body, by the event's name as the server sends it. */\n readonly events?: Readonly<Record<string, TextNumbers>>;\n /** Those of each command's body, by the command's name. */\n readonly commands?: Readonly<Record<string, TextNumbers>>;\n /**\n * Those of its access attributes, by name: the integer ones, which a record\n * keeps as a `Long` (`int64`).\n */\n readonly access?: TextNumbers;\n}\n\n/** One aggregate: its type, its tenant and its id. */\nexport interface AggregateRef {\n readonly type: AggregateType;\n readonly tenantId: string;\n readonly id: string;\n}\n\n/**\n * The aggregate a command names: an {@link AggregateRef} whose `id` is null\n * while admission has not chosen it, as for a creation that leaves its id to\n * the server and was refused before one was chosen. The Kotlin client holds\n * such an id as `AggregateRef.UNASSIGNED`.\n */\nexport interface CommandRef {\n readonly type: AggregateType;\n readonly tenantId: string;\n readonly id: string | null;\n}\n\n/** The owner and the space an aggregate belongs to, beside its tenant. */\nexport interface Scope {\n readonly ownerId?: string | null;\n readonly spaceId?: string | null;\n}\n\n/**\n * Who sent a command: the opaque id of the authenticated\n * subject, its own tenant, and whether it acted in another tenant or scope.\n * Resolve the id to a display name in the application, never from Wow.\n */\nexport interface Operator {\n readonly id: string;\n readonly tenantId: string;\n readonly actedElsewhere: boolean;\n}\n\n/** How far a command has come. */\nexport const Stage = {\n /** The command passed admission. */\n ACCEPTED: 'accepted',\n /** The command's events are appended to the log. */\n COMMITTED: 'committed',\n /** A named subscription has handled the commit. */\n HANDLED: 'handled',\n} as const;\n\n/** A {@link Stage} value. */\nexport type Stage = (typeof Stage)[keyof typeof Stage];\n\n/**\n * One hop of a wait chain: a stage, in a context (the\n * command's own when absent), of a subscription when the stage is\n * `handled`. The snapshot is the subscription named `wow.snapshot`\n * (`SNAPSHOT_SUBSCRIPTION`), which a `Wow-Wait` header writes `snapshot`;\n * the store the snapshot queries read is `wow.queryable`\n * (`QUERYABLE_SUBSCRIPTION`), written `queryable`.\n */\nexport interface Hop {\n /**\n * The stage; a server newer than this client may answer one it does not\n * list.\n */\n readonly stage: Stage | (string & {});\n readonly context?: string | null;\n readonly subscription?: string | null;\n}\n\n/** The kind of function that produced a result. */\nexport const FunctionKind = {\n /** The aggregate's command function. */\n COMMAND: 'command',\n /** A projection. */\n PROJECT: 'project',\n /** An event handler that reacts. */\n REACT: 'react',\n /** A saga. */\n SAGA: 'saga',\n /**\n * A built-in subscription of Wow's, such as the one that writes snapshots:\n * its `processor` and `name` say which.\n */\n SYSTEM: 'system',\n} as const;\n\n/** A {@link FunctionKind} value. */\nexport type FunctionKind = (typeof FunctionKind)[keyof typeof FunctionKind];\n\n/** Who produced a result: a function of `kind` in `context`. */\nexport interface FunctionInfo {\n /**\n * The kind; a server newer than this client may answer one it does not\n * list.\n */\n readonly kind: FunctionKind | (string & {});\n readonly context: string;\n readonly processor: string;\n readonly name: string;\n}\n\n/** A field-level validation error. */\nexport interface Violation {\n /** The path of the field, or the query part, that broke the rule. */\n readonly path: string;\n /** The rule's code, such as `NotBlank` or `UNKNOWN_FIELD`. */\n readonly code: string;\n /** A human-readable message. */\n readonly message: string;\n}\n\n/** Why a command was rejected or failed. */\nexport interface ErrorInfo {\n /** A framework code (`wow.*`) or the domain's own. */\n readonly code: string;\n readonly message: string;\n readonly violations?: readonly Violation[];\n /**\n * The rejection's structured data (decision D211), which a problem\n * writes as its extension members.\n */\n readonly extensions?: Readonly<Record<string, unknown>>;\n}\n\n/** How a command ended at a hop. */\nexport const CommandResultStatus = {\n /** The command reached the hop. */\n SUCCEEDED: 'succeeded',\n /** The domain or admission refused the command. */\n REJECTED: 'rejected',\n /** A technical failure stopped the command. */\n FAILED: 'failed',\n} as const;\n\n/** A {@link CommandResultStatus} value. */\nexport type CommandResultStatus =\n (typeof CommandResultStatus)[keyof typeof CommandResultStatus];\n\n/**\n * The command a request named before a transformer turned it into the one\n * that ran.\n */\nexport interface TransformedFrom {\n /** The full type name, `context.aggregate.Command`. */\n readonly command: string;\n readonly aggregateId?: string | null;\n}\n\n/**\n * The one outward result of a command: what it reached at one\n * hop of its wait chain. A command route answers the last one; its event\n * stream sends one per hop.\n *\n * A chain can end before its plan does (decision D212): a hop, such as a\n * saga's that sent no command (a declined payment, say), leaves nothing to\n * reach the later hops. Its result is then the last one, at that hop with its\n * own status, `chainEnded` and the hops not reached in `pending`; a server\n * before D212 sends neither, so read them as `false` and empty when absent.\n *\n * @typeParam R - The shape of `results`, what the command's decide function\n * answered with.\n */\nexport interface CommandResult<R = Record<string, unknown>> {\n readonly format: number;\n readonly commandId: string;\n readonly requestId: string;\n readonly correlationId: string;\n /** The aggregate: a result that succeeded always names its id. */\n readonly ref: AggregateRef;\n readonly hop: Hop;\n readonly function: FunctionInfo;\n /**\n * The status; a server newer than this client may answer one it does not\n * list, which did not succeed as far as this client knows.\n */\n readonly status: CommandResultStatus | (string & {});\n /** The aggregate's version after the commit, or the unchanged one. */\n readonly version?: number | null;\n /** The request was already committed: it was not decided again. */\n readonly duplicate: boolean;\n /** Set when `status` is `rejected` or `failed`. */\n readonly error?: ErrorInfo | null;\n readonly results: R;\n /** On a saga's hop, the ids of the commands it derived. */\n readonly derived: readonly string[];\n /** When it was produced, in epoch milliseconds. */\n readonly signalTime: number;\n readonly transformedFrom?: TransformedFrom | null;\n /**\n * The chain ended at this hop before its plan did (decision D212): the\n * hops in `pending` will not come.\n */\n readonly chainEnded?: boolean;\n /** When `chainEnded`, the hops of the plan not reached, in order. */\n readonly pending?: readonly Hop[];\n}\n\n/**\n * A result that may not have succeeded, as a rejection or a problem carries\n * it (`CommandRejectedError.result`, `WowProblemError.result`): a command\n * refused before an aggregate id was decided names none\n * ({@link CommandRef}). The Kotlin client has no type of its own\n * for it: its `CommandResult.ref` holds such an id as\n * `AggregateRef.UNASSIGNED`.\n *\n * @typeParam R - The results' type.\n */\nexport interface RefusedResult<R = Record<string, unknown>> extends Omit<\n CommandResult<R>,\n 'ref'\n> {\n readonly ref: CommandRef;\n}\n\n/**\n * An access attribute's value as a record carries it: a single attribute's\n * value or null, a multiple one's values, distinct and sorted. An integer is\n * a `Long` on the server: wow-generator types it `string` and marks it to be\n * read as its exact text ({@link AggregateTextNumbers.access}).\n */\nexport type AccessValue =\n string | number | boolean | null | readonly (string | number | boolean)[];\n\n/**\n * A record's access attributes by name, as the aggregate declares them\n * (`@Access` on its state, the Manifest's `access`): a generated client types\n * them as an `<Aggregate>Access` interface instead.\n */\nexport type AccessValues = Readonly<Record<string, AccessValue>>;\n\n/**\n * The access attributes of an aggregate that declares none: a record's\n * `access` is then empty, and a query names no `access.<name>`.\n */\nexport type NoAccess = Readonly<Record<never, never>>;\n\n/**\n * The `access` of an event stream: the aggregate's current owner and space\n * beside its declared access attributes `A`.\n */\nexport type StreamAccess<A = AccessValues> = A & {\n readonly owner?: string | null;\n readonly space?: string | null;\n};\n\n/** The `access.<name>` field paths of the access attributes `A`. */\nexport type AccessField<A> = `access.${keyof A & string}`;\n\n/**\n * An event as Wow reads it now: under its current name, upgraded to its latest revision. Kotlin's `CommittedEvent`. The `events` query gives\n * every stored event so, however old its record, and leaves out the events its aggregate retired, so a generated\n * `<Aggregate>Event` union, with {@link SystemEvent}, covers each event it returns.\n *\n * @typeParam N - The event's name.\n * @typeParam B - The event's body.\n */\nexport interface CommittedEvent<N extends string = string, B = unknown> {\n readonly name: N;\n readonly revision: number;\n readonly body: B;\n}\n\n/** The body of `wow.lifecycle.OwnerTransferred`: the aggregate's new owner. */\nexport interface OwnerTransferred {\n readonly ownerId: string;\n}\n\n/** The body of `wow.lifecycle.SpaceTransferred`: the aggregate's new space. */\nexport interface SpaceTransferred {\n readonly spaceId: string;\n}\n\n/**\n * The body of `wow.schedule.ScheduleSet`: the aggregate set its\n * schedule `key`, to send `target` the command of type `commandType`\n * (`command` its body, a JSON object) as `rule` says.\n */\nexport interface ScheduleSet {\n readonly key: string;\n readonly rule: ScheduleRule;\n readonly target: CommandRef;\n readonly commandType: string;\n readonly command: Readonly<Record<string, unknown>>;\n}\n\n/** The body of `wow.schedule.ScheduleCancelled`. */\nexport interface ScheduleCancelled {\n readonly key: string;\n}\n\n/**\n * The system events the kernel gives every aggregate:\n * the lifecycle events and the schedule events. A state trace and an event\n * stream carry them beside the aggregate's own events, so the event union\n * `wow-generator` writes for an aggregate includes this one.\n */\nexport type SystemEvent =\n | CommittedEvent<\n 'wow.lifecycle.AggregateDeleted',\n Readonly<Record<string, never>>\n >\n | CommittedEvent<\n 'wow.lifecycle.AggregateRestored',\n Readonly<Record<string, never>>\n >\n | CommittedEvent<'wow.lifecycle.OwnerTransferred', OwnerTransferred>\n | CommittedEvent<'wow.lifecycle.SpaceTransferred', SpaceTransferred>\n | CommittedEvent<'wow.schedule.ScheduleSet', ScheduleSet>\n | CommittedEvent<'wow.schedule.ScheduleCancelled', ScheduleCancelled>;\n\n/**\n * One commit of a state trace: the events of a version and the\n * aggregate after it.\n *\n * @typeParam S - The state's type.\n * @typeParam E - The events' type.\n * @typeParam A - The aggregate's access attributes.\n */\nexport interface CommitView<\n S = unknown,\n E extends CommittedEvent = CommittedEvent,\n A = AccessValues,\n> {\n readonly version: number;\n /** When it was committed, in epoch milliseconds. */\n readonly commitTime: number;\n readonly commandId: string;\n readonly requestId: string;\n readonly commandType: string;\n readonly events: readonly E[];\n readonly scope: Scope;\n readonly deleted: boolean;\n /** Its declared access attributes after the commit. */\n readonly access: A;\n readonly state: S;\n readonly operator?: Operator | null;\n}\n\n/**\n * What `GET /{context}/{aggregate}/{id}/state/trace` answers: the aggregate\n * and its commits in version order.\n */\nexport interface StateTrace<\n S = unknown,\n E extends CommittedEvent = CommittedEvent,\n A = AccessValues,\n> {\n readonly ref: AggregateRef;\n readonly commits: readonly CommitView<S, E, A>[];\n}\n\n/**\n * An aggregate's latest committed state, as a record of the `snapshot` query\n * model and as `GET /{context}/{aggregate}/{id}/state` answer it: the\n * aggregate's system fields and its state. Kotlin's `Snapshot`.\n *\n * @typeParam S - The state's type.\n * @typeParam A - The aggregate's access attributes.\n */\nexport interface Snapshot<S = unknown, A = AccessValues> {\n readonly tenantId: string;\n readonly aggregateId: string;\n readonly version: number;\n readonly ownerId: string | null;\n readonly spaceId: string | null;\n readonly deleted: boolean;\n /**\n * Its declared access attributes. A snapshot written before an attribute\n * was declared lacks it.\n */\n readonly access: A;\n /** The first commit's time, in epoch milliseconds. */\n readonly firstEventTime: number;\n /** The last commit's time, in epoch milliseconds. */\n readonly lastEventTime: number;\n /** Who sent the last command; null for an anonymous caller. */\n readonly operator: Operator | null;\n /** Who created the aggregate; null for an anonymous caller. */\n readonly firstOperator: Operator | null;\n /**\n * The schedules the aggregate keeps (decision D198): each rule, `{type,\n * ...}`, by its key.\n */\n readonly schedules: Readonly<Record<string, ScheduleRule>>;\n readonly state: S;\n}\n\n/**\n * The system fields of a snapshot record a query can filter, sort and\n * project on; a state field is `state.<path>`.\n */\nexport type SnapshotSystemField =\n | 'tenantId'\n | 'aggregateId'\n | 'version'\n | 'ownerId'\n | 'spaceId'\n | 'deleted'\n | 'access'\n | 'firstEventTime'\n | 'lastEventTime'\n | 'operator'\n | 'operator.id'\n | 'operator.tenantId'\n | 'operator.actedElsewhere'\n | 'firstOperator'\n | 'firstOperator.id'\n | 'firstOperator.tenantId'\n | 'firstOperator.actedElsewhere'\n | 'schedules';\n\n/** A schedule rule of a snapshot's `schedules`. */\nexport interface ScheduleRule {\n /** The rule's type: `at`, `after`, `cron`, … */\n readonly type: string;\n readonly [property: string]: unknown;\n}\n\n/**\n * A record of the `events` query model: one commit of one\n * aggregate and its events. Kotlin's `EventStream`.\n *\n * @typeParam E - The events' type.\n * @typeParam A - The aggregate's declared access attributes.\n */\nexport interface EventStream<\n E extends CommittedEvent = CommittedEvent,\n A = AccessValues,\n> {\n readonly aggregateId: string;\n readonly tenantId: string;\n readonly version: number;\n /** When it was committed, in epoch milliseconds. */\n readonly commitTime: number;\n readonly commandId: string;\n readonly requestId: string;\n readonly commandType: string;\n /** Null when the stream has none (`Scope.NONE`). */\n readonly ownerId?: string | null;\n readonly spaceId?: string | null;\n /** Null for an anonymous caller (decision D163). */\n readonly operator?: Operator | null;\n /**\n * The aggregate's current access attributes, its owner and space among\n * them, kept current as they change (decision D390); null while the stream\n * is not stamped (appended before the log recorded them, or imported\n * without them).\n */\n readonly access?: StreamAccess<A> | null;\n readonly events: readonly E[];\n}\n\n/**\n * The fields of an event stream record a query names: its\n * system fields, `access` and its built-in `owner` and `space` (a declared\n * attribute is an {@link AccessField}), and `events`, the array an\n * `elementMatch` filter and an aggregation's `elements` reach an event\n * through, by the event's own `name`, `revision` and `body.*`.\n */\nexport type EventStreamField =\n | 'aggregateId'\n | 'tenantId'\n | 'version'\n | 'commitTime'\n | 'commandId'\n | 'requestId'\n | 'commandType'\n | 'ownerId'\n | 'spaceId'\n | 'operator'\n | 'operator.id'\n | 'operator.tenantId'\n | 'operator.actedElsewhere'\n | 'access'\n | 'access.owner'\n | 'access.space'\n | 'events';\n\n/** How an aggregate belongs to its callers. */\nexport type Ownership = 'owner' | 'tenant';\n\n/** One dataset of `GET /wow/dataset`. */\nexport interface DatasetEntry {\n /** `{context}.{dataset}`. */\n readonly name: string;\n readonly context: string;\n readonly dataset: string;\n readonly title?: string | null;\n /** The path of its query route. */\n readonly path: string;\n}\n"],"mappings":"AAqFA,IAAaA,EAAQ,CAEnB,SAAU,WAEV,UAAW,YAEX,QAAS,SACX,EAwBaC,EAAe,CAE1B,QAAS,UAET,QAAS,UAET,MAAO,QAEP,KAAM,OAKN,OAAQ,QACV,EAyCaC,EAAsB,CAEjC,UAAW,YAEX,SAAU,WAEV,OAAQ,QACV,E"}
|
package/dist/wire.d.cts
CHANGED
|
@@ -23,6 +23,11 @@ export interface AggregateTextNumbers {
|
|
|
23
23
|
readonly events?: Readonly<Record<string, TextNumbers>>;
|
|
24
24
|
/** Those of each command's body, by the command's name. */
|
|
25
25
|
readonly commands?: Readonly<Record<string, TextNumbers>>;
|
|
26
|
+
/**
|
|
27
|
+
* Those of its access attributes, by name: the integer ones, which a record
|
|
28
|
+
* keeps as a `Long` (`int64`).
|
|
29
|
+
*/
|
|
30
|
+
readonly access?: TextNumbers;
|
|
26
31
|
}
|
|
27
32
|
/** One aggregate: its type, its tenant and its id. */
|
|
28
33
|
export interface AggregateRef {
|
|
@@ -54,7 +59,7 @@ export interface Scope {
|
|
|
54
59
|
export interface Operator {
|
|
55
60
|
readonly id: string;
|
|
56
61
|
readonly tenantId: string;
|
|
57
|
-
readonly
|
|
62
|
+
readonly actedElsewhere: boolean;
|
|
58
63
|
}
|
|
59
64
|
/** How far a command has come. */
|
|
60
65
|
export declare const Stage: {
|
|
@@ -70,7 +75,10 @@ export type Stage = (typeof Stage)[keyof typeof Stage];
|
|
|
70
75
|
/**
|
|
71
76
|
* One hop of a wait chain: a stage, in a context (the
|
|
72
77
|
* command's own when absent), of a subscription when the stage is
|
|
73
|
-
* `handled`. The snapshot is the subscription named `snapshot
|
|
78
|
+
* `handled`. The snapshot is the subscription named `wow.snapshot`
|
|
79
|
+
* (`SNAPSHOT_SUBSCRIPTION`), which a `Wow-Wait` header writes `snapshot`;
|
|
80
|
+
* the store the snapshot queries read is `wow.queryable`
|
|
81
|
+
* (`QUERYABLE_SUBSCRIPTION`), written `queryable`.
|
|
74
82
|
*/
|
|
75
83
|
export interface Hop {
|
|
76
84
|
/**
|
|
@@ -91,12 +99,11 @@ export declare const FunctionKind: {
|
|
|
91
99
|
readonly REACT: "react";
|
|
92
100
|
/** A saga. */
|
|
93
101
|
readonly SAGA: "saga";
|
|
94
|
-
/**
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
readonly TIMERS: "timers";
|
|
102
|
+
/**
|
|
103
|
+
* A built-in subscription of Wow's, such as the one that writes snapshots:
|
|
104
|
+
* its `processor` and `name` say which.
|
|
105
|
+
*/
|
|
106
|
+
readonly SYSTEM: "system";
|
|
100
107
|
};
|
|
101
108
|
/** A {@link FunctionKind} value. */
|
|
102
109
|
export type FunctionKind = (typeof FunctionKind)[keyof typeof FunctionKind];
|
|
@@ -213,8 +220,34 @@ export interface CommandResult<R = Record<string, unknown>> {
|
|
|
213
220
|
export interface RefusedResult<R = Record<string, unknown>> extends Omit<CommandResult<R>, 'ref'> {
|
|
214
221
|
readonly ref: CommandRef;
|
|
215
222
|
}
|
|
216
|
-
/**
|
|
217
|
-
|
|
223
|
+
/**
|
|
224
|
+
* An access attribute's value as a record carries it: a single attribute's
|
|
225
|
+
* value or null, a multiple one's values, distinct and sorted. An integer is
|
|
226
|
+
* a `Long` on the server: wow-generator types it `string` and marks it to be
|
|
227
|
+
* read as its exact text ({@link AggregateTextNumbers.access}).
|
|
228
|
+
*/
|
|
229
|
+
export type AccessValue = string | number | boolean | null | readonly (string | number | boolean)[];
|
|
230
|
+
/**
|
|
231
|
+
* A record's access attributes by name, as the aggregate declares them
|
|
232
|
+
* (`@Access` on its state, the Manifest's `access`): a generated client types
|
|
233
|
+
* them as an `<Aggregate>Access` interface instead.
|
|
234
|
+
*/
|
|
235
|
+
export type AccessValues = Readonly<Record<string, AccessValue>>;
|
|
236
|
+
/**
|
|
237
|
+
* The access attributes of an aggregate that declares none: a record's
|
|
238
|
+
* `access` is then empty, and a query names no `access.<name>`.
|
|
239
|
+
*/
|
|
240
|
+
export type NoAccess = Readonly<Record<never, never>>;
|
|
241
|
+
/**
|
|
242
|
+
* The `access` of an event stream: the aggregate's current owner and space
|
|
243
|
+
* beside its declared access attributes `A`.
|
|
244
|
+
*/
|
|
245
|
+
export type StreamAccess<A = AccessValues> = A & {
|
|
246
|
+
readonly owner?: string | null;
|
|
247
|
+
readonly space?: string | null;
|
|
248
|
+
};
|
|
249
|
+
/** The `access.<name>` field paths of the access attributes `A`. */
|
|
250
|
+
export type AccessField<A> = `access.${keyof A & string}`;
|
|
218
251
|
/**
|
|
219
252
|
* An event as Wow reads it now: under its current name, upgraded to its latest revision. Kotlin's `CommittedEvent`. The `events` query gives
|
|
220
253
|
* every stored event so, however old its record, and leaves out the events its aggregate retired, so a generated
|
|
@@ -236,23 +269,19 @@ export interface OwnerTransferred {
|
|
|
236
269
|
export interface SpaceTransferred {
|
|
237
270
|
readonly spaceId: string;
|
|
238
271
|
}
|
|
239
|
-
/** The body of `wow.lifecycle.TagsApplied`: the aggregate's tags now. */
|
|
240
|
-
export interface TagsApplied {
|
|
241
|
-
readonly tags: Tags;
|
|
242
|
-
}
|
|
243
272
|
/**
|
|
244
|
-
* The body of `wow.ScheduleSet`: the aggregate set its
|
|
273
|
+
* The body of `wow.schedule.ScheduleSet`: the aggregate set its
|
|
245
274
|
* schedule `key`, to send `target` the command of type `commandType`
|
|
246
|
-
* (`command` its JSON
|
|
275
|
+
* (`command` its body, a JSON object) as `rule` says.
|
|
247
276
|
*/
|
|
248
277
|
export interface ScheduleSet {
|
|
249
278
|
readonly key: string;
|
|
250
279
|
readonly rule: ScheduleRule;
|
|
251
280
|
readonly target: CommandRef;
|
|
252
281
|
readonly commandType: string;
|
|
253
|
-
readonly command: string
|
|
282
|
+
readonly command: Readonly<Record<string, unknown>>;
|
|
254
283
|
}
|
|
255
|
-
/** The body of `wow.ScheduleCancelled`. */
|
|
284
|
+
/** The body of `wow.schedule.ScheduleCancelled`. */
|
|
256
285
|
export interface ScheduleCancelled {
|
|
257
286
|
readonly key: string;
|
|
258
287
|
}
|
|
@@ -262,15 +291,16 @@ export interface ScheduleCancelled {
|
|
|
262
291
|
* stream carry them beside the aggregate's own events, so the event union
|
|
263
292
|
* `wow-generator` writes for an aggregate includes this one.
|
|
264
293
|
*/
|
|
265
|
-
export type SystemEvent = CommittedEvent<'wow.lifecycle.AggregateDeleted', Readonly<Record<string, never>>> | CommittedEvent<'wow.lifecycle.AggregateRestored', Readonly<Record<string, never>>> | CommittedEvent<'wow.lifecycle.OwnerTransferred', OwnerTransferred> | CommittedEvent<'wow.lifecycle.SpaceTransferred', SpaceTransferred> | CommittedEvent<'wow.
|
|
294
|
+
export type SystemEvent = CommittedEvent<'wow.lifecycle.AggregateDeleted', Readonly<Record<string, never>>> | CommittedEvent<'wow.lifecycle.AggregateRestored', Readonly<Record<string, never>>> | CommittedEvent<'wow.lifecycle.OwnerTransferred', OwnerTransferred> | CommittedEvent<'wow.lifecycle.SpaceTransferred', SpaceTransferred> | CommittedEvent<'wow.schedule.ScheduleSet', ScheduleSet> | CommittedEvent<'wow.schedule.ScheduleCancelled', ScheduleCancelled>;
|
|
266
295
|
/**
|
|
267
296
|
* One commit of a state trace: the events of a version and the
|
|
268
297
|
* aggregate after it.
|
|
269
298
|
*
|
|
270
299
|
* @typeParam S - The state's type.
|
|
271
300
|
* @typeParam E - The events' type.
|
|
301
|
+
* @typeParam A - The aggregate's access attributes.
|
|
272
302
|
*/
|
|
273
|
-
export interface CommitView<S = unknown, E extends CommittedEvent = CommittedEvent> {
|
|
303
|
+
export interface CommitView<S = unknown, E extends CommittedEvent = CommittedEvent, A = AccessValues> {
|
|
274
304
|
readonly version: number;
|
|
275
305
|
/** When it was committed, in epoch milliseconds. */
|
|
276
306
|
readonly commitTime: number;
|
|
@@ -280,7 +310,8 @@ export interface CommitView<S = unknown, E extends CommittedEvent = CommittedEve
|
|
|
280
310
|
readonly events: readonly E[];
|
|
281
311
|
readonly scope: Scope;
|
|
282
312
|
readonly deleted: boolean;
|
|
283
|
-
|
|
313
|
+
/** Its declared access attributes after the commit. */
|
|
314
|
+
readonly access: A;
|
|
284
315
|
readonly state: S;
|
|
285
316
|
readonly operator?: Operator | null;
|
|
286
317
|
}
|
|
@@ -288,9 +319,9 @@ export interface CommitView<S = unknown, E extends CommittedEvent = CommittedEve
|
|
|
288
319
|
* What `GET /{context}/{aggregate}/{id}/state/trace` answers: the aggregate
|
|
289
320
|
* and its commits in version order.
|
|
290
321
|
*/
|
|
291
|
-
export interface StateTrace<S = unknown, E extends CommittedEvent = CommittedEvent> {
|
|
322
|
+
export interface StateTrace<S = unknown, E extends CommittedEvent = CommittedEvent, A = AccessValues> {
|
|
292
323
|
readonly ref: AggregateRef;
|
|
293
|
-
readonly commits: readonly CommitView<S, E>[];
|
|
324
|
+
readonly commits: readonly CommitView<S, E, A>[];
|
|
294
325
|
}
|
|
295
326
|
/**
|
|
296
327
|
* An aggregate's latest committed state, as a record of the `snapshot` query
|
|
@@ -298,15 +329,20 @@ export interface StateTrace<S = unknown, E extends CommittedEvent = CommittedEve
|
|
|
298
329
|
* aggregate's system fields and its state. Kotlin's `Snapshot`.
|
|
299
330
|
*
|
|
300
331
|
* @typeParam S - The state's type.
|
|
332
|
+
* @typeParam A - The aggregate's access attributes.
|
|
301
333
|
*/
|
|
302
|
-
export interface Snapshot<S = unknown> {
|
|
334
|
+
export interface Snapshot<S = unknown, A = AccessValues> {
|
|
303
335
|
readonly tenantId: string;
|
|
304
336
|
readonly aggregateId: string;
|
|
305
337
|
readonly version: number;
|
|
306
338
|
readonly ownerId: string | null;
|
|
307
339
|
readonly spaceId: string | null;
|
|
308
340
|
readonly deleted: boolean;
|
|
309
|
-
|
|
341
|
+
/**
|
|
342
|
+
* Its declared access attributes. A snapshot written before an attribute
|
|
343
|
+
* was declared lacks it.
|
|
344
|
+
*/
|
|
345
|
+
readonly access: A;
|
|
310
346
|
/** The first commit's time, in epoch milliseconds. */
|
|
311
347
|
readonly firstEventTime: number;
|
|
312
348
|
/** The last commit's time, in epoch milliseconds. */
|
|
@@ -326,7 +362,7 @@ export interface Snapshot<S = unknown> {
|
|
|
326
362
|
* The system fields of a snapshot record a query can filter, sort and
|
|
327
363
|
* project on; a state field is `state.<path>`.
|
|
328
364
|
*/
|
|
329
|
-
export type SnapshotSystemField = 'tenantId' | 'aggregateId' | 'version' | 'ownerId' | 'spaceId' | 'deleted' | '
|
|
365
|
+
export type SnapshotSystemField = 'tenantId' | 'aggregateId' | 'version' | 'ownerId' | 'spaceId' | 'deleted' | 'access' | 'firstEventTime' | 'lastEventTime' | 'operator' | 'operator.id' | 'operator.tenantId' | 'operator.actedElsewhere' | 'firstOperator' | 'firstOperator.id' | 'firstOperator.tenantId' | 'firstOperator.actedElsewhere' | 'schedules';
|
|
330
366
|
/** A schedule rule of a snapshot's `schedules`. */
|
|
331
367
|
export interface ScheduleRule {
|
|
332
368
|
/** The rule's type: `at`, `after`, `cron`, … */
|
|
@@ -338,8 +374,9 @@ export interface ScheduleRule {
|
|
|
338
374
|
* aggregate and its events. Kotlin's `EventStream`.
|
|
339
375
|
*
|
|
340
376
|
* @typeParam E - The events' type.
|
|
377
|
+
* @typeParam A - The aggregate's declared access attributes.
|
|
341
378
|
*/
|
|
342
|
-
export interface EventStream<E extends CommittedEvent = CommittedEvent> {
|
|
379
|
+
export interface EventStream<E extends CommittedEvent = CommittedEvent, A = AccessValues> {
|
|
343
380
|
readonly aggregateId: string;
|
|
344
381
|
readonly tenantId: string;
|
|
345
382
|
readonly version: number;
|
|
@@ -353,15 +390,23 @@ export interface EventStream<E extends CommittedEvent = CommittedEvent> {
|
|
|
353
390
|
readonly spaceId?: string | null;
|
|
354
391
|
/** Null for an anonymous caller (decision D163). */
|
|
355
392
|
readonly operator?: Operator | null;
|
|
393
|
+
/**
|
|
394
|
+
* The aggregate's current access attributes, its owner and space among
|
|
395
|
+
* them, kept current as they change (decision D390); null while the stream
|
|
396
|
+
* is not stamped (appended before the log recorded them, or imported
|
|
397
|
+
* without them).
|
|
398
|
+
*/
|
|
399
|
+
readonly access?: StreamAccess<A> | null;
|
|
356
400
|
readonly events: readonly E[];
|
|
357
401
|
}
|
|
358
402
|
/**
|
|
359
403
|
* The fields of an event stream record a query names: its
|
|
360
|
-
* system fields and
|
|
361
|
-
*
|
|
362
|
-
* `
|
|
404
|
+
* system fields, `access` and its built-in `owner` and `space` (a declared
|
|
405
|
+
* attribute is an {@link AccessField}), and `events`, the array an
|
|
406
|
+
* `elementMatch` filter and an aggregation's `elements` reach an event
|
|
407
|
+
* through, by the event's own `name`, `revision` and `body.*`.
|
|
363
408
|
*/
|
|
364
|
-
export type EventStreamField = 'aggregateId' | 'tenantId' | 'version' | 'commitTime' | 'commandId' | 'requestId' | 'commandType' | 'ownerId' | 'spaceId' | 'operator' | 'operator.id' | 'operator.tenantId' | 'operator.
|
|
409
|
+
export type EventStreamField = 'aggregateId' | 'tenantId' | 'version' | 'commitTime' | 'commandId' | 'requestId' | 'commandType' | 'ownerId' | 'spaceId' | 'operator' | 'operator.id' | 'operator.tenantId' | 'operator.actedElsewhere' | 'access' | 'access.owner' | 'access.space' | 'events';
|
|
365
410
|
/** How an aggregate belongs to its callers. */
|
|
366
411
|
export type Ownership = 'owner' | 'tenant';
|
|
367
412
|
/** One dataset of `GET /wow/dataset`. */
|