@ahoo-wang/wow-client 10.0.0-alpha.6 → 10.0.0-alpha.7
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 +76 -23
- package/README.zh-CN.md +66 -19
- package/dist/commands.cjs +1 -1
- package/dist/commands.cjs.map +1 -1
- package/dist/commands.d.cts +131 -61
- package/dist/commands.d.ts +131 -61
- package/dist/commands.es.js +117 -59
- package/dist/commands.es.js.map +1 -1
- package/dist/developmentCaller.cjs +2 -0
- package/dist/developmentCaller.cjs.map +1 -0
- package/dist/developmentCaller.d.cts +61 -0
- package/dist/developmentCaller.d.ts +61 -0
- package/dist/developmentCaller.es.js +26 -0
- package/dist/developmentCaller.es.js.map +1 -0
- package/dist/dsl/aggregation/admit.cjs +1 -1
- package/dist/dsl/aggregation/admit.cjs.map +1 -1
- package/dist/dsl/aggregation/admit.es.js +93 -93
- package/dist/dsl/aggregation/admit.es.js.map +1 -1
- package/dist/dsl/aggregation/builders.cjs +1 -1
- package/dist/dsl/aggregation/builders.cjs.map +1 -1
- package/dist/dsl/aggregation/builders.d.cts +20 -20
- package/dist/dsl/aggregation/builders.d.ts +20 -20
- package/dist/dsl/aggregation/builders.es.js +88 -88
- package/dist/dsl/aggregation/builders.es.js.map +1 -1
- package/dist/dsl/aggregation/derived.cjs.map +1 -1
- package/dist/dsl/aggregation/derived.d.cts +8 -8
- package/dist/dsl/aggregation/derived.d.ts +8 -8
- package/dist/dsl/aggregation/derived.es.js +1 -2
- package/dist/dsl/aggregation/derived.es.js.map +1 -1
- package/dist/dsl/aggregation/expressionTrees.cjs.map +1 -1
- package/dist/dsl/aggregation/expressionTrees.es.js +1 -2
- package/dist/dsl/aggregation/having.cjs +1 -1
- package/dist/dsl/aggregation/having.cjs.map +1 -1
- package/dist/dsl/aggregation/having.d.cts +12 -12
- package/dist/dsl/aggregation/having.d.ts +12 -12
- package/dist/dsl/aggregation/having.es.js +33 -33
- package/dist/dsl/aggregation/having.es.js.map +1 -1
- package/dist/dsl/aggregation/sort.cjs.map +1 -1
- package/dist/dsl/aggregation/sort.es.js +1 -2
- package/dist/dsl/aggregation/types.cjs +1 -1
- package/dist/dsl/aggregation/types.cjs.map +1 -1
- package/dist/dsl/aggregation/types.d.cts +69 -69
- package/dist/dsl/aggregation/types.d.ts +69 -69
- package/dist/dsl/aggregation/types.es.js +15 -16
- package/dist/dsl/aggregation/types.es.js.map +1 -1
- package/dist/dsl/constantName.cjs +2 -0
- package/dist/dsl/constantName.cjs.map +1 -0
- package/dist/dsl/constantName.d.cts +9 -0
- package/dist/dsl/constantName.d.ts +9 -0
- package/dist/dsl/constantName.es.js +7 -0
- package/dist/dsl/constantName.es.js.map +1 -0
- package/dist/dsl/cursorQuery.cjs.map +1 -1
- package/dist/dsl/cursorQuery.es.js +1 -2
- package/dist/dsl/deletionState.cjs +1 -1
- package/dist/dsl/deletionState.cjs.map +1 -1
- package/dist/dsl/deletionState.d.cts +3 -3
- package/dist/dsl/deletionState.d.ts +3 -3
- package/dist/dsl/deletionState.es.js +2 -3
- package/dist/dsl/deletionState.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 +92 -42
- package/dist/dsl/descriptor.d.ts +92 -42
- package/dist/dsl/descriptor.es.js +36 -29
- package/dist/dsl/descriptor.es.js.map +1 -1
- package/dist/dsl/field.cjs.map +1 -1
- package/dist/dsl/field.es.js +1 -2
- package/dist/dsl/filter/builders.cjs +1 -1
- package/dist/dsl/filter/builders.cjs.map +1 -1
- package/dist/dsl/filter/builders.d.cts +53 -53
- package/dist/dsl/filter/builders.d.ts +53 -53
- package/dist/dsl/filter/builders.es.js +111 -111
- package/dist/dsl/filter/builders.es.js.map +1 -1
- package/dist/dsl/filter/datePattern.cjs.map +1 -1
- package/dist/dsl/filter/datePattern.es.js +1 -2
- package/dist/dsl/filter/operator.cjs +1 -1
- package/dist/dsl/filter/operator.cjs.map +1 -1
- package/dist/dsl/filter/operator.d.cts +57 -57
- package/dist/dsl/filter/operator.d.ts +57 -57
- package/dist/dsl/filter/operator.es.js +4 -5
- package/dist/dsl/filter/operator.es.js.map +1 -1
- package/dist/dsl/filter/scope.cjs +1 -1
- package/dist/dsl/filter/scope.cjs.map +1 -1
- package/dist/dsl/filter/scope.es.js +12 -12
- package/dist/dsl/filter/scope.es.js.map +1 -1
- package/dist/dsl/filter/validate.cjs +1 -1
- package/dist/dsl/filter/validate.cjs.map +1 -1
- package/dist/dsl/filter/validate.es.js +23 -23
- package/dist/dsl/filter/validate.es.js.map +1 -1
- package/dist/dsl/pagination.cjs.map +1 -1
- package/dist/dsl/pagination.es.js +1 -2
- package/dist/dsl/projection.cjs.map +1 -1
- package/dist/dsl/projection.d.cts +1 -1
- package/dist/dsl/projection.d.ts +1 -1
- package/dist/dsl/projection.es.js +1 -2
- package/dist/dsl/projection.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 +59 -48
- package/dist/dsl/queryErrorCodes.d.ts +59 -48
- package/dist/dsl/queryErrorCodes.es.js +51 -50
- package/dist/dsl/queryErrorCodes.es.js.map +1 -1
- package/dist/dsl/queryable.cjs +1 -1
- package/dist/dsl/queryable.cjs.map +1 -1
- package/dist/dsl/queryable.d.cts +25 -21
- package/dist/dsl/queryable.d.ts +25 -21
- package/dist/dsl/queryable.es.js +5 -5
- package/dist/dsl/queryable.es.js.map +1 -1
- package/dist/dsl/sort.cjs +1 -1
- package/dist/dsl/sort.cjs.map +1 -1
- package/dist/dsl/sort.d.cts +2 -2
- package/dist/dsl/sort.d.ts +2 -2
- package/dist/dsl/sort.es.js +4 -5
- package/dist/dsl/sort.es.js.map +1 -1
- package/dist/dsl.cjs +1 -1
- package/dist/dsl.es.js +3 -3
- package/dist/exactJson.cjs.map +1 -1
- package/dist/exactJson.d.cts +4 -4
- package/dist/exactJson.d.ts +4 -4
- package/dist/exactJson.es.js +1 -2
- package/dist/exactJson.es.js.map +1 -1
- package/dist/frameworkErrors.cjs +2 -0
- package/dist/frameworkErrors.cjs.map +1 -0
- package/dist/frameworkErrors.d.cts +121 -0
- package/dist/frameworkErrors.d.ts +121 -0
- package/dist/frameworkErrors.es.js +95 -0
- package/dist/frameworkErrors.es.js.map +1 -0
- package/dist/http.cjs +1 -1
- package/dist/http.cjs.map +1 -1
- package/dist/http.d.cts +4 -7
- package/dist/http.d.ts +4 -7
- package/dist/http.es.js +12 -20
- package/dist/http.es.js.map +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +9 -7
- package/dist/index.d.ts +9 -7
- package/dist/index.es.js +11 -9
- package/dist/manifest.cjs +1 -1
- package/dist/manifest.cjs.map +1 -1
- package/dist/manifest.d.cts +33 -95
- package/dist/manifest.d.ts +33 -95
- package/dist/manifest.es.js +12 -7
- package/dist/manifest.es.js.map +1 -1
- package/dist/manifestTypes.d.cts +193 -0
- package/dist/manifestTypes.d.ts +193 -0
- package/dist/problem.cjs +1 -1
- package/dist/problem.cjs.map +1 -1
- package/dist/problem.d.cts +76 -115
- package/dist/problem.d.ts +76 -115
- package/dist/problem.es.js +45 -80
- package/dist/problem.es.js.map +1 -1
- package/dist/queries.cjs +1 -1
- package/dist/queries.cjs.map +1 -1
- package/dist/queries.d.cts +28 -51
- package/dist/queries.d.ts +28 -51
- package/dist/queries.es.js +49 -40
- package/dist/queries.es.js.map +1 -1
- package/dist/routes.cjs +2 -0
- package/dist/routes.cjs.map +1 -0
- package/dist/routes.d.cts +49 -0
- package/dist/routes.d.ts +49 -0
- package/dist/routes.es.js +33 -0
- package/dist/routes.es.js.map +1 -0
- package/dist/state.cjs +1 -1
- package/dist/state.cjs.map +1 -1
- package/dist/state.d.cts +56 -11
- package/dist/state.d.ts +56 -11
- package/dist/state.es.js +56 -21
- 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 +17 -13
- package/dist/streams.d.ts +17 -13
- package/dist/streams.es.js +50 -50
- package/dist/streams.es.js.map +1 -1
- package/dist/testing/wire.cjs +2 -0
- package/dist/testing/wire.cjs.map +1 -0
- package/dist/testing/wire.d.cts +29 -0
- package/dist/testing/wire.d.ts +29 -0
- package/dist/testing/wire.es.js +88 -0
- package/dist/testing/wire.es.js.map +1 -0
- package/dist/testing.cjs +1 -0
- package/dist/testing.d.cts +12 -0
- package/dist/testing.d.ts +12 -0
- package/dist/testing.es.js +3 -0
- package/dist/wait.cjs +1 -1
- package/dist/wait.cjs.map +1 -1
- package/dist/wait.d.cts +67 -18
- package/dist/wait.d.ts +67 -18
- package/dist/wait.es.js +59 -12
- 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 +100 -50
- package/dist/wire.d.ts +100 -50
- package/dist/wire.es.js +17 -6
- package/dist/wire.es.js.map +1 -1
- package/package.json +23 -3
package/dist/wire.d.ts
CHANGED
|
@@ -30,13 +30,24 @@ export interface AggregateRef {
|
|
|
30
30
|
readonly tenantId: string;
|
|
31
31
|
readonly id: string;
|
|
32
32
|
}
|
|
33
|
+
/**
|
|
34
|
+
* The aggregate a command names: an {@link AggregateRef} whose `id` is null
|
|
35
|
+
* while admission has not chosen it, as for a creation that leaves its id to
|
|
36
|
+
* the server and was refused before one was chosen. The Kotlin client holds
|
|
37
|
+
* such an id as `AggregateRef.UNASSIGNED`.
|
|
38
|
+
*/
|
|
39
|
+
export interface CommandRef {
|
|
40
|
+
readonly type: AggregateType;
|
|
41
|
+
readonly tenantId: string;
|
|
42
|
+
readonly id: string | null;
|
|
43
|
+
}
|
|
33
44
|
/** The owner and the space an aggregate belongs to, beside its tenant. */
|
|
34
45
|
export interface Scope {
|
|
35
46
|
readonly ownerId?: string | null;
|
|
36
47
|
readonly spaceId?: string | null;
|
|
37
48
|
}
|
|
38
49
|
/**
|
|
39
|
-
* Who sent a command
|
|
50
|
+
* Who sent a command: the opaque id of the authenticated
|
|
40
51
|
* subject, its own tenant, and whether it acted in another tenant or scope.
|
|
41
52
|
* Resolve the id to a display name in the application, never from Wow.
|
|
42
53
|
*/
|
|
@@ -45,32 +56,57 @@ export interface Operator {
|
|
|
45
56
|
readonly tenantId: string;
|
|
46
57
|
readonly crossScope: boolean;
|
|
47
58
|
}
|
|
48
|
-
/** How far a command has come
|
|
59
|
+
/** How far a command has come. */
|
|
49
60
|
export declare const Stage: {
|
|
50
61
|
/** The command passed admission. */
|
|
51
|
-
readonly ACCEPTED: "
|
|
62
|
+
readonly ACCEPTED: "accepted";
|
|
52
63
|
/** The command's events are appended to the log. */
|
|
53
|
-
readonly COMMITTED: "
|
|
64
|
+
readonly COMMITTED: "committed";
|
|
54
65
|
/** A named subscription has handled the commit. */
|
|
55
|
-
readonly HANDLED: "
|
|
66
|
+
readonly HANDLED: "handled";
|
|
56
67
|
};
|
|
57
68
|
/** A {@link Stage} value. */
|
|
58
69
|
export type Stage = (typeof Stage)[keyof typeof Stage];
|
|
59
70
|
/**
|
|
60
|
-
* One hop of a wait chain
|
|
71
|
+
* One hop of a wait chain: a stage, in a context (the
|
|
61
72
|
* command's own when absent), of a subscription when the stage is
|
|
62
|
-
* `
|
|
73
|
+
* `handled`. The snapshot is the subscription named `snapshot`.
|
|
63
74
|
*/
|
|
64
75
|
export interface Hop {
|
|
65
|
-
|
|
76
|
+
/**
|
|
77
|
+
* The stage; a server newer than this client may answer one it does not
|
|
78
|
+
* list.
|
|
79
|
+
*/
|
|
80
|
+
readonly stage: Stage | (string & {});
|
|
66
81
|
readonly context?: string | null;
|
|
67
82
|
readonly subscription?: string | null;
|
|
68
83
|
}
|
|
69
84
|
/** The kind of function that produced a result. */
|
|
70
|
-
export
|
|
85
|
+
export declare const FunctionKind: {
|
|
86
|
+
/** The aggregate's command function. */
|
|
87
|
+
readonly COMMAND: "command";
|
|
88
|
+
/** A projection. */
|
|
89
|
+
readonly PROJECT: "project";
|
|
90
|
+
/** An event handler that reacts. */
|
|
91
|
+
readonly REACT: "react";
|
|
92
|
+
/** A saga. */
|
|
93
|
+
readonly SAGA: "saga";
|
|
94
|
+
/** The snapshot subscription. */
|
|
95
|
+
readonly SNAPSHOT: "snapshot";
|
|
96
|
+
/** A reservation. */
|
|
97
|
+
readonly RESERVATION: "reservation";
|
|
98
|
+
/** A timer. */
|
|
99
|
+
readonly TIMERS: "timers";
|
|
100
|
+
};
|
|
101
|
+
/** A {@link FunctionKind} value. */
|
|
102
|
+
export type FunctionKind = (typeof FunctionKind)[keyof typeof FunctionKind];
|
|
71
103
|
/** Who produced a result: a function of `kind` in `context`. */
|
|
72
104
|
export interface FunctionInfo {
|
|
73
|
-
|
|
105
|
+
/**
|
|
106
|
+
* The kind; a server newer than this client may answer one it does not
|
|
107
|
+
* list.
|
|
108
|
+
*/
|
|
109
|
+
readonly kind: FunctionKind | (string & {});
|
|
74
110
|
readonly context: string;
|
|
75
111
|
readonly processor: string;
|
|
76
112
|
readonly name: string;
|
|
@@ -97,10 +133,19 @@ export interface ErrorInfo {
|
|
|
97
133
|
readonly extensions?: Readonly<Record<string, unknown>>;
|
|
98
134
|
}
|
|
99
135
|
/** How a command ended at a hop. */
|
|
100
|
-
export
|
|
136
|
+
export declare const CommandResultStatus: {
|
|
137
|
+
/** The command reached the hop. */
|
|
138
|
+
readonly SUCCEEDED: "succeeded";
|
|
139
|
+
/** The domain or admission refused the command. */
|
|
140
|
+
readonly REJECTED: "rejected";
|
|
141
|
+
/** A technical failure stopped the command. */
|
|
142
|
+
readonly FAILED: "failed";
|
|
143
|
+
};
|
|
144
|
+
/** A {@link CommandResultStatus} value. */
|
|
145
|
+
export type CommandResultStatus = (typeof CommandResultStatus)[keyof typeof CommandResultStatus];
|
|
101
146
|
/**
|
|
102
147
|
* The command a request named before a transformer turned it into the one
|
|
103
|
-
* that ran
|
|
148
|
+
* that ran.
|
|
104
149
|
*/
|
|
105
150
|
export interface TransformedFrom {
|
|
106
151
|
/** The full type name, `context.aggregate.Command`. */
|
|
@@ -108,7 +153,7 @@ export interface TransformedFrom {
|
|
|
108
153
|
readonly aggregateId?: string | null;
|
|
109
154
|
}
|
|
110
155
|
/**
|
|
111
|
-
* The one outward result of a command
|
|
156
|
+
* The one outward result of a command: what it reached at one
|
|
112
157
|
* hop of its wait chain. A command route answers the last one; its event
|
|
113
158
|
* stream sends one per hop.
|
|
114
159
|
*
|
|
@@ -126,15 +171,20 @@ export interface CommandResult<R = Record<string, unknown>> {
|
|
|
126
171
|
readonly commandId: string;
|
|
127
172
|
readonly requestId: string;
|
|
128
173
|
readonly correlationId: string;
|
|
174
|
+
/** The aggregate: a result that succeeded always names its id. */
|
|
129
175
|
readonly ref: AggregateRef;
|
|
130
176
|
readonly hop: Hop;
|
|
131
177
|
readonly function: FunctionInfo;
|
|
132
|
-
|
|
178
|
+
/**
|
|
179
|
+
* The status; a server newer than this client may answer one it does not
|
|
180
|
+
* list, which did not succeed as far as this client knows.
|
|
181
|
+
*/
|
|
182
|
+
readonly status: CommandResultStatus | (string & {});
|
|
133
183
|
/** The aggregate's version after the commit, or the unchanged one. */
|
|
134
184
|
readonly version?: number | null;
|
|
135
185
|
/** The request was already committed: it was not decided again. */
|
|
136
186
|
readonly duplicate: boolean;
|
|
137
|
-
/** Set when `status` is `
|
|
187
|
+
/** Set when `status` is `rejected` or `failed`. */
|
|
138
188
|
readonly error?: ErrorInfo | null;
|
|
139
189
|
readonly results: R;
|
|
140
190
|
/** On a saga's hop, the ids of the commands it derived. */
|
|
@@ -150,31 +200,30 @@ export interface CommandResult<R = Record<string, unknown>> {
|
|
|
150
200
|
/** When `chainEnded`, the hops of the plan not reached, in order. */
|
|
151
201
|
readonly pending?: readonly Hop[];
|
|
152
202
|
}
|
|
153
|
-
/** The tags of an aggregate: names to values. */
|
|
154
|
-
export type Tags = Readonly<Record<string, readonly string[]>>;
|
|
155
203
|
/**
|
|
156
|
-
*
|
|
157
|
-
* `
|
|
204
|
+
* A result that may not have succeeded, as a rejection or a problem carries
|
|
205
|
+
* it (`CommandRejectedError.result`, `WowProblemError.result`): a command
|
|
206
|
+
* refused before an aggregate id was decided names none
|
|
207
|
+
* ({@link CommandRef}). The Kotlin client has no type of its own
|
|
208
|
+
* for it: its `CommandResult.ref` holds such an id as
|
|
209
|
+
* `AggregateRef.UNASSIGNED`.
|
|
158
210
|
*
|
|
159
|
-
* @typeParam
|
|
211
|
+
* @typeParam R - The results' type.
|
|
160
212
|
*/
|
|
161
|
-
export interface
|
|
162
|
-
readonly ref:
|
|
163
|
-
readonly version: number;
|
|
164
|
-
readonly scope: Scope;
|
|
165
|
-
readonly deleted: boolean;
|
|
166
|
-
readonly tags: Tags;
|
|
167
|
-
readonly state: S;
|
|
213
|
+
export interface RefusedResult<R = Record<string, unknown>> extends Omit<CommandResult<R>, 'ref'> {
|
|
214
|
+
readonly ref: CommandRef;
|
|
168
215
|
}
|
|
216
|
+
/** The tags of an aggregate: names to values. */
|
|
217
|
+
export type Tags = Readonly<Record<string, readonly string[]>>;
|
|
169
218
|
/**
|
|
170
|
-
* An event as Wow reads it now: under its current name, upgraded to its latest revision. The `events` query gives
|
|
219
|
+
* An event as Wow reads it now: under its current name, upgraded to its latest revision. Kotlin's `CommittedEvent`. The `events` query gives
|
|
171
220
|
* every stored event so, however old its record, and leaves out the events its aggregate retired, so a generated
|
|
172
221
|
* `<Aggregate>Event` union, with {@link SystemEvent}, covers each event it returns.
|
|
173
222
|
*
|
|
174
223
|
* @typeParam N - The event's name.
|
|
175
224
|
* @typeParam B - The event's body.
|
|
176
225
|
*/
|
|
177
|
-
export interface
|
|
226
|
+
export interface CommittedEvent<N extends string = string, B = unknown> {
|
|
178
227
|
readonly name: N;
|
|
179
228
|
readonly revision: number;
|
|
180
229
|
readonly body: B;
|
|
@@ -192,36 +241,36 @@ export interface TagsApplied {
|
|
|
192
241
|
readonly tags: Tags;
|
|
193
242
|
}
|
|
194
243
|
/**
|
|
195
|
-
* The body of `wow.ScheduleSet
|
|
244
|
+
* The body of `wow.ScheduleSet`: the aggregate set its
|
|
196
245
|
* schedule `key`, to send `target` the command of type `commandType`
|
|
197
246
|
* (`command` its JSON text) as `rule` says.
|
|
198
247
|
*/
|
|
199
248
|
export interface ScheduleSet {
|
|
200
249
|
readonly key: string;
|
|
201
250
|
readonly rule: ScheduleRule;
|
|
202
|
-
readonly target:
|
|
251
|
+
readonly target: CommandRef;
|
|
203
252
|
readonly commandType: string;
|
|
204
253
|
readonly command: string;
|
|
205
254
|
}
|
|
206
|
-
/** The body of `wow.ScheduleCancelled
|
|
255
|
+
/** The body of `wow.ScheduleCancelled`. */
|
|
207
256
|
export interface ScheduleCancelled {
|
|
208
257
|
readonly key: string;
|
|
209
258
|
}
|
|
210
259
|
/**
|
|
211
|
-
* The system events the kernel gives every aggregate
|
|
260
|
+
* The system events the kernel gives every aggregate:
|
|
212
261
|
* the lifecycle events and the schedule events. A state trace and an event
|
|
213
262
|
* stream carry them beside the aggregate's own events, so the event union
|
|
214
263
|
* `wow-generator` writes for an aggregate includes this one.
|
|
215
264
|
*/
|
|
216
|
-
export type SystemEvent =
|
|
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.lifecycle.TagsApplied', TagsApplied> | CommittedEvent<'wow.ScheduleSet', ScheduleSet> | CommittedEvent<'wow.ScheduleCancelled', ScheduleCancelled>;
|
|
217
266
|
/**
|
|
218
|
-
* One commit of a state trace
|
|
267
|
+
* One commit of a state trace: the events of a version and the
|
|
219
268
|
* aggregate after it.
|
|
220
269
|
*
|
|
221
270
|
* @typeParam S - The state's type.
|
|
222
271
|
* @typeParam E - The events' type.
|
|
223
272
|
*/
|
|
224
|
-
export interface CommitView<S = unknown, E extends
|
|
273
|
+
export interface CommitView<S = unknown, E extends CommittedEvent = CommittedEvent> {
|
|
225
274
|
readonly version: number;
|
|
226
275
|
/** When it was committed, in epoch milliseconds. */
|
|
227
276
|
readonly commitTime: number;
|
|
@@ -239,17 +288,18 @@ export interface CommitView<S = unknown, E extends EventView = EventView> {
|
|
|
239
288
|
* What `GET /{context}/{aggregate}/{id}/state/trace` answers: the aggregate
|
|
240
289
|
* and its commits in version order.
|
|
241
290
|
*/
|
|
242
|
-
export interface StateTrace<S = unknown, E extends
|
|
291
|
+
export interface StateTrace<S = unknown, E extends CommittedEvent = CommittedEvent> {
|
|
243
292
|
readonly ref: AggregateRef;
|
|
244
293
|
readonly commits: readonly CommitView<S, E>[];
|
|
245
294
|
}
|
|
246
295
|
/**
|
|
247
|
-
*
|
|
248
|
-
*
|
|
296
|
+
* An aggregate's latest committed state, as a record of the `snapshot` query
|
|
297
|
+
* model and as `GET /{context}/{aggregate}/{id}/state` answer it: the
|
|
298
|
+
* aggregate's system fields and its state. Kotlin's `Snapshot`.
|
|
249
299
|
*
|
|
250
300
|
* @typeParam S - The state's type.
|
|
251
301
|
*/
|
|
252
|
-
export interface
|
|
302
|
+
export interface Snapshot<S = unknown> {
|
|
253
303
|
readonly tenantId: string;
|
|
254
304
|
readonly aggregateId: string;
|
|
255
305
|
readonly version: number;
|
|
@@ -267,9 +317,9 @@ export interface SnapshotRecord<S = unknown> {
|
|
|
267
317
|
readonly firstOperator: Operator | null;
|
|
268
318
|
/**
|
|
269
319
|
* The schedules the aggregate keeps (decision D198): each rule, `{type,
|
|
270
|
-
* ...}`, by its key
|
|
320
|
+
* ...}`, by its key.
|
|
271
321
|
*/
|
|
272
|
-
readonly schedules
|
|
322
|
+
readonly schedules: Readonly<Record<string, ScheduleRule>>;
|
|
273
323
|
readonly state: S;
|
|
274
324
|
}
|
|
275
325
|
/**
|
|
@@ -277,19 +327,19 @@ export interface SnapshotRecord<S = unknown> {
|
|
|
277
327
|
* project on; a state field is `state.<path>`.
|
|
278
328
|
*/
|
|
279
329
|
export type SnapshotSystemField = 'tenantId' | 'aggregateId' | 'version' | 'ownerId' | 'spaceId' | 'deleted' | 'tags' | 'firstEventTime' | 'lastEventTime' | 'operator' | 'operator.id' | 'operator.tenantId' | 'operator.crossScope' | 'firstOperator' | 'firstOperator.id' | 'firstOperator.tenantId' | 'firstOperator.crossScope' | 'schedules';
|
|
280
|
-
/** A schedule rule of a snapshot's `schedules
|
|
330
|
+
/** A schedule rule of a snapshot's `schedules`. */
|
|
281
331
|
export interface ScheduleRule {
|
|
282
332
|
/** The rule's type: `at`, `after`, `cron`, … */
|
|
283
333
|
readonly type: string;
|
|
284
334
|
readonly [property: string]: unknown;
|
|
285
335
|
}
|
|
286
336
|
/**
|
|
287
|
-
* A record of the `events` query model
|
|
288
|
-
* aggregate and its events.
|
|
337
|
+
* A record of the `events` query model: one commit of one
|
|
338
|
+
* aggregate and its events. Kotlin's `EventStream`.
|
|
289
339
|
*
|
|
290
340
|
* @typeParam E - The events' type.
|
|
291
341
|
*/
|
|
292
|
-
export interface
|
|
342
|
+
export interface EventStream<E extends CommittedEvent = CommittedEvent> {
|
|
293
343
|
readonly aggregateId: string;
|
|
294
344
|
readonly tenantId: string;
|
|
295
345
|
readonly version: number;
|
|
@@ -306,15 +356,15 @@ export interface EventStreamRecord<E extends EventView = EventView> {
|
|
|
306
356
|
readonly events: readonly E[];
|
|
307
357
|
}
|
|
308
358
|
/**
|
|
309
|
-
* The fields of an event stream record a query names
|
|
359
|
+
* The fields of an event stream record a query names: its
|
|
310
360
|
* system fields and `events`, the array an `elementMatch` filter and an
|
|
311
361
|
* aggregation's `elements` reach an event through, by the event's own
|
|
312
362
|
* `name`, `revision` and `body.*`.
|
|
313
363
|
*/
|
|
314
364
|
export type EventStreamField = 'aggregateId' | 'tenantId' | 'version' | 'commitTime' | 'commandId' | 'requestId' | 'commandType' | 'ownerId' | 'spaceId' | 'operator' | 'operator.id' | 'operator.tenantId' | 'operator.crossScope' | 'events';
|
|
315
|
-
/** How an aggregate belongs to its callers
|
|
316
|
-
export type Ownership = '
|
|
317
|
-
/** One dataset of `GET /wow/dataset
|
|
365
|
+
/** How an aggregate belongs to its callers. */
|
|
366
|
+
export type Ownership = 'owner' | 'tenant';
|
|
367
|
+
/** One dataset of `GET /wow/dataset`. */
|
|
318
368
|
export interface DatasetEntry {
|
|
319
369
|
/** `{context}.{dataset}`. */
|
|
320
370
|
readonly name: string;
|
package/dist/wire.es.js
CHANGED
|
@@ -1,10 +1,21 @@
|
|
|
1
|
-
|
|
1
|
+
// src/wire.ts
|
|
2
2
|
var e = {
|
|
3
|
-
ACCEPTED: "
|
|
4
|
-
COMMITTED: "
|
|
5
|
-
HANDLED: "
|
|
3
|
+
ACCEPTED: "accepted",
|
|
4
|
+
COMMITTED: "committed",
|
|
5
|
+
HANDLED: "handled"
|
|
6
|
+
}, t = {
|
|
7
|
+
COMMAND: "command",
|
|
8
|
+
PROJECT: "project",
|
|
9
|
+
REACT: "react",
|
|
10
|
+
SAGA: "saga",
|
|
11
|
+
SNAPSHOT: "snapshot",
|
|
12
|
+
RESERVATION: "reservation",
|
|
13
|
+
TIMERS: "timers"
|
|
14
|
+
}, n = {
|
|
15
|
+
SUCCEEDED: "succeeded",
|
|
16
|
+
REJECTED: "rejected",
|
|
17
|
+
FAILED: "failed"
|
|
6
18
|
};
|
|
7
|
-
|
|
8
|
-
export { e as Stage };
|
|
19
|
+
export { n as CommandResultStatus, t as FunctionKind, e as Stage };
|
|
9
20
|
|
|
10
21
|
//# sourceMappingURL=wire.es.js.map
|
package/dist/wire.es.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"wire.es.js","names":["Stage"],"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/** 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 (decision D163): 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 (decision D61). */\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 (decision D62): 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 readonly stage: Stage;\n readonly context?: string | null;\n readonly subscription?: string | null;\n}\n\n/** The kind of function that produced a result. */\nexport type FunctionKind =\n | 'COMMAND'\n | 'PROJECT'\n | 'REACT'\n | 'SAGA'\n | 'SNAPSHOT'\n | 'RESERVATION'\n | 'TIMERS';\n\n/** Who produced a result: a function of `kind` in `context`. */\nexport interface FunctionInfo {\n readonly kind: FunctionKind;\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 type CommandResultStatus = 'SUCCEEDED' | 'REJECTED' | 'FAILED';\n\n/**\n * The command a request named before a transformer turned it into the one\n * that ran (decision D182).\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 (design 08 §7): 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 readonly ref: AggregateRef;\n readonly hop: Hop;\n readonly function: FunctionInfo;\n readonly status: CommandResultStatus;\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/** The tags of an aggregate: names to values. */\nexport type Tags = Readonly<Record<string, readonly string[]>>;\n\n/**\n * An aggregate's state at a version (decision D40), as\n * `GET /{context}/{aggregate}/{id}/state` answers it.\n *\n * @typeParam S - The state's type.\n */\nexport interface StateView<S = unknown> {\n readonly ref: AggregateRef;\n readonly version: number;\n readonly scope: Scope;\n readonly deleted: boolean;\n readonly tags: Tags;\n readonly state: S;\n}\n\n/**\n * An event as Wow reads it now: under its current name, upgraded to its latest revision. 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 EventView<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` (decision D198): 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: AggregateRef;\n readonly commandType: string;\n readonly command: string;\n}\n\n/** The body of `wow.ScheduleCancelled` (decision D198). */\nexport interface ScheduleCancelled {\n readonly key: string;\n}\n\n/**\n * The system events the kernel gives every aggregate (decisions D113, D198):\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 | EventView<'wow.lifecycle.AggregateDeleted', Readonly<Record<string, never>>>\n | EventView<\n 'wow.lifecycle.AggregateRestored',\n Readonly<Record<string, never>>\n >\n | EventView<'wow.lifecycle.OwnerTransferred', OwnerTransferred>\n | EventView<'wow.lifecycle.SpaceTransferred', SpaceTransferred>\n | EventView<'wow.lifecycle.TagsApplied', TagsApplied>\n | EventView<'wow.ScheduleSet', ScheduleSet>\n | EventView<'wow.ScheduleCancelled', ScheduleCancelled>;\n\n/**\n * One commit of a state trace (decision D40): 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<S = unknown, E extends EventView = EventView> {\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<S = unknown, E extends EventView = EventView> {\n readonly ref: AggregateRef;\n readonly commits: readonly CommitView<S, E>[];\n}\n\n/**\n * A record of the `snapshot` query model (decisions D128, D163): the\n * aggregate's system fields and its state.\n *\n * @typeParam S - The state's type.\n */\nexport interface SnapshotRecord<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; absent from a server before 6.8c.\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` (decision D198). */\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 (decision D131): one commit of one\n * aggregate and its events.\n *\n * @typeParam E - The events' type.\n */\nexport interface EventStreamRecord<E extends EventView = EventView> {\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 (decision D235): 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 (decision D189). */\nexport type Ownership = 'OWNER' | 'TENANT';\n\n/** One dataset of `GET /wow/dataset` (decision D145). */\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":";AAoEA,IAAaA,IAAQ;CAEnB,UAAU;CAEV,WAAW;CAEX,SAAS;AACX"}
|
|
1
|
+
{"version":3,"file":"wire.es.js","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,IAAQ;CAEnB,UAAU;CAEV,WAAW;CAEX,SAAS;AACX,GAqBaC,IAAe;CAE1B,SAAS;CAET,SAAS;CAET,OAAO;CAEP,MAAM;CAEN,UAAU;CAEV,aAAa;CAEb,QAAQ;AACV,GAyCaC,IAAsB;CAEjC,WAAW;CAEX,UAAU;CAEV,QAAQ;AACV"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ahoo-wang/wow-client",
|
|
3
|
-
"version": "10.0.0-alpha.
|
|
3
|
+
"version": "10.0.0-alpha.7",
|
|
4
4
|
"description": "TypeScript client for Wow (https://github.com/Ahoo-Wang/Wow): commands with their waits and event streams, state reads, snapshot, event and dataset queries, the Manifest and RFC 9457 problems, and the query DSL, built on Fetcher.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"wow",
|
|
@@ -53,6 +53,26 @@
|
|
|
53
53
|
"default": "./dist/dsl.cjs"
|
|
54
54
|
}
|
|
55
55
|
},
|
|
56
|
+
"./testing": {
|
|
57
|
+
"import": {
|
|
58
|
+
"types": "./dist/testing.d.ts",
|
|
59
|
+
"default": "./dist/testing.es.js"
|
|
60
|
+
},
|
|
61
|
+
"require": {
|
|
62
|
+
"types": "./dist/testing.d.cts",
|
|
63
|
+
"default": "./dist/testing.cjs"
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
"./routes": {
|
|
67
|
+
"import": {
|
|
68
|
+
"types": "./dist/routes.d.ts",
|
|
69
|
+
"default": "./dist/routes.es.js"
|
|
70
|
+
},
|
|
71
|
+
"require": {
|
|
72
|
+
"types": "./dist/routes.d.cts",
|
|
73
|
+
"default": "./dist/routes.cjs"
|
|
74
|
+
}
|
|
75
|
+
},
|
|
56
76
|
"./package.json": "./package.json"
|
|
57
77
|
},
|
|
58
78
|
"files": [
|
|
@@ -76,9 +96,9 @@
|
|
|
76
96
|
"eslint": "^10.13.0",
|
|
77
97
|
"globals": "^17.13.0",
|
|
78
98
|
"typescript": "~6.0.3",
|
|
79
|
-
"typescript-eslint": "^8.
|
|
99
|
+
"typescript-eslint": "^8.72.0",
|
|
80
100
|
"unplugin-dts": "1.1.2",
|
|
81
|
-
"vite": "8.3.
|
|
101
|
+
"vite": "8.3.5",
|
|
82
102
|
"vite-bundle-analyzer": "^1.3.9",
|
|
83
103
|
"vitest": "^4.1.12"
|
|
84
104
|
},
|