@serve.zone/interfaces 32.68.0 → 32.69.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,434 @@
1
+ import { canonicalizeStrictJson, compareWireTokens, createCanonicalJsonSha256Hex } from '../private/canonicaljson.js';
2
+ import { readDataElements, readDataProperties, readExactDataRecord } from '../private/dataproperties.js';
3
+ import { isClusterNodeId } from '../private/nodeidentifier.js';
4
+ import { isCanonicalTokenList } from '../private/tokenlist.js';
5
+ import { protocolRefusalHttpStatus, readProtocolOffer } from '../protocol.js';
6
+ import { isReleaseVersion } from './releaseversion.js';
7
+ /**
8
+ * Every node action, in canonical token order, so a list of them (a Spark's `actionExecutors`)
9
+ * is compared byte for byte.
10
+ */
11
+ export const nodeActionNames = Object.freeze([
12
+ 'reboot',
13
+ 'serveZoneServiceUpdate',
14
+ 'systemUpgrade',
15
+ ]);
16
+ const nodeActionNamesComplete = true;
17
+ void nodeActionNamesComplete;
18
+ export const isNodeActionName = (valueArg) => (nodeActionNames.some((nameArg) => nameArg === valueArg));
19
+ /**
20
+ * Whether each action state is still open or ended.
21
+ *
22
+ * The four values the Swarm-era carrier shipped keep their meaning: `pending` is the requested
23
+ * state of every action, `running` is a Swarm-era action its daemon started, and `succeeded` and
24
+ * `failed` end one. The node runtime's lifecycle (`INodeActionLifecycle`) adds the rest:
25
+ *
26
+ * - `claimed`: the node's Spark took the action (`claim`), stating the boot it took it in.
27
+ * - `executing`, `draining`, `rebooting`: the phase Spark reports, only ever forward
28
+ * (`sparkNodeActionPhaseOrder`).
29
+ * - `verifying`: Cloudly saw the evidence the action changed the node (`nodeActionVerification`)
30
+ * and waits for the node's runtime to come back.
31
+ * - `expired`: never claimed in its claim window, or a Swarm-era record no carrier can deliver
32
+ * (`TNodeActionExpiryReason`).
33
+ * - `cancelled`: an operator withdrew it while it was still `pending`.
34
+ * - `unverified`: its deadline passed before Cloudly could verify it. An operator judges the node;
35
+ * Cloudly never retries it.
36
+ */
37
+ export const nodeActionStatusKinds = Object.freeze({
38
+ pending: 'open',
39
+ running: 'open',
40
+ claimed: 'open',
41
+ executing: 'open',
42
+ draining: 'open',
43
+ rebooting: 'open',
44
+ verifying: 'open',
45
+ succeeded: 'terminal',
46
+ failed: 'terminal',
47
+ expired: 'terminal',
48
+ cancelled: 'terminal',
49
+ unverified: 'terminal',
50
+ });
51
+ /** Every open state, the ones the one-open-action-per-node rule counts. */
52
+ export const nodeActionOpenStatuses = Object.freeze(Object.keys(nodeActionStatusKinds)
53
+ .filter((statusArg) => nodeActionStatusKinds[statusArg] === 'open'));
54
+ export const isNodeActionOpen = (statusArg) => (nodeActionStatusKinds[statusArg] === 'open');
55
+ /**
56
+ * The phases Spark reports while it executes a claimed action, in the only order it may report
57
+ * them. A phase may be skipped, never repeated or reported after a later one.
58
+ */
59
+ export const sparkNodeActionPhaseOrder = Object.freeze(['claimed', 'executing', 'draining', 'rebooting']);
60
+ /**
61
+ * Time budgets of the node runtime's action lifecycle, in milliseconds.
62
+ *
63
+ * A requested action waits `claimWindowMs` for its node's Spark to claim it, then expires. A claimed
64
+ * action must be verified within its completion budget (`nodeActionCompletionBudgetMs`), measured
65
+ * from the claim, or it ends `unverified`. Each budget is the sum of the steps the action takes. One
66
+ * budget is read from Spark's code; every other one is chosen here, and each member says which.
67
+ */
68
+ export const nodeActionContract = Object.freeze({
69
+ /** Chosen: how long a requested action waits for its node's Spark to claim it (10 min). */
70
+ claimWindowMs: 600_000,
71
+ /**
72
+ * Spark code: `sparkNodeStopTimeoutSeconds`, the node unit's `TimeoutStopSec=` (522 s), in which
73
+ * Pallet stops every workload it runs.
74
+ */
75
+ drainMs: 522_000,
76
+ /** Chosen: a host's reboot until Spark reports from the new boot (10 min). */
77
+ bootMs: 600_000,
78
+ /**
79
+ * Chosen: how long Pallet takes to start and register again after the node runtime starts
80
+ * (712 s, from the 2026-11-05 survey; Spark states no start budget of its own).
81
+ */
82
+ startMs: 712_000,
83
+ /** Chosen: downloading and checking the target's node bundle before anything stops (10 min). */
84
+ downloadMs: 600_000,
85
+ /** Chosen: the host's package upgrade (30 min). */
86
+ hostUpgradeMs: 1_800_000,
87
+ /** Entries an action's timeline keeps; each state is entered at most once. */
88
+ maximumTimelineEntries: 16,
89
+ /** Characters of operator text one timeline entry or failure carries. */
90
+ maximumDetailLength: 512,
91
+ /** Services one impact names; a node holding more is answered `impact-unreadable`. */
92
+ maximumImpactServices: 1024,
93
+ /** Characters of one service name an impact carries. */
94
+ maximumServiceNameLength: 256,
95
+ });
96
+ /**
97
+ * How long a claimed action has until Cloudly must have verified it, from the claim.
98
+ *
99
+ * A reboot drains, boots and starts the node. An update downloads the target, then restarts the
100
+ * node runtime on it: a drain and a start, no boot. A host upgrade runs the package upgrade and,
101
+ * with `reboot`, the reboot after it.
102
+ */
103
+ export const nodeActionCompletionBudgetMs = (actionNameArg, rebootArg) => {
104
+ const c = nodeActionContract;
105
+ switch (actionNameArg) {
106
+ case 'reboot':
107
+ return c.drainMs + c.bootMs + c.startMs;
108
+ case 'serveZoneServiceUpdate':
109
+ return c.downloadMs + c.drainMs + c.startMs;
110
+ case 'systemUpgrade':
111
+ return c.hostUpgradeMs + (rebootArg ? c.drainMs + c.bootMs + c.startMs : 0);
112
+ }
113
+ };
114
+ /** Whether an action reboots the host, which is how Cloudly verifies it (`nodeActionVerification`). */
115
+ export const nodeActionReboots = (actionNameArg, rebootArg) => (actionNameArg === 'reboot' || (actionNameArg === 'systemUpgrade' && rebootArg));
116
+ export const nodeActionVerification = (actionNameArg, rebootArg) => nodeActionReboots(actionNameArg, rebootArg) ? 'new-boot'
117
+ : actionNameArg === 'serveZoneServiceUpdate' ? 'target-version' : 'upgrade-complete';
118
+ /** Whether the action restarts the node runtime and is verified by its return (see `nodeActionVerification`). */
119
+ export const nodeActionRestartsRuntime = (actionNameArg, rebootArg) => (nodeActionVerification(actionNameArg, rebootArg) !== 'upgrade-complete');
120
+ /**
121
+ * Why an action ended `failed`, each with the remedy an operator is told.
122
+ *
123
+ * The first group is stated by Spark (`TSparkNodeActionFailureCode`), the second by Cloudly.
124
+ */
125
+ export const nodeActionFailureRemedies = Object.freeze({
126
+ 'download-failed': 'Spark could not download the target release. Check that the node reaches '
127
+ + 'code.foss.global, then request the update again.',
128
+ 'installer-mismatch': 'The downloaded install.sh does not have the SHA-256 the target states. '
129
+ + 'Nothing was installed; set the fleet Spark target again, then request the update again.',
130
+ 'install-failed': 'The node bundle installer failed and left the installed release in place. '
131
+ + 'Read the node\'s Spark journal, then request the update again.',
132
+ 'drain-failed': 'Pallet did not stop its workloads within the stop budget. Read the node\'s '
133
+ + 'Pallet journal before requesting the action again.',
134
+ 'reboot-failed': 'The host did not accept the reboot. Read the node\'s Spark journal.',
135
+ 'host-upgrade-failed': 'The host package upgrade failed. Read the node\'s Spark journal, repair '
136
+ + 'the package state on the host, then request the upgrade again.',
137
+ 'executor-failed': 'Spark could not run the action. Read the node\'s Spark journal.',
138
+ 'reboot-required': 'The host upgrade finished and applying it needs a reboot. Request a system '
139
+ + 'upgrade with reboot, or a reboot, when the node may go down.',
140
+ 'target-below-node': 'The node runs a newer Spark than the action\'s target, so the update '
141
+ + 'would downgrade it. Set the fleet Spark target to the release the node should run.',
142
+ });
143
+ /** The failure codes Spark may state with a `fail` transition. */
144
+ export const sparkNodeActionFailureCodes = Object.freeze([
145
+ 'download-failed',
146
+ 'drain-failed',
147
+ 'executor-failed',
148
+ 'host-upgrade-failed',
149
+ 'install-failed',
150
+ 'installer-mismatch',
151
+ 'reboot-failed',
152
+ ]);
153
+ /** The SHA-256 (lowercase hex) of one impact's canonical JSON, which a confirmation names. */
154
+ export const computeNodeActionImpactDigest = async (impactArg) => {
155
+ const fail = (reasonArg) => { throw new Error(`Node action impact rejected: ${reasonArg}`); };
156
+ return createCanonicalJsonSha256Hex(canonicalizeStrictJson(impactArg, fail, 'node action impact'), fail);
157
+ };
158
+ /**
159
+ * Every reason Cloudly answers instead of admitting, previewing or cancelling a node action. Each
160
+ * travels by name as a `TypedResponseError`, and a refused request changes nothing.
161
+ */
162
+ export const nodeActionRefusals = Object.freeze([
163
+ /** No node of that id exists. */
164
+ 'node-missing',
165
+ /** The node reported through no Spark that carries actions: it never reported at all. */
166
+ 'node-action-undeliverable',
167
+ /** The node's Spark does not state that it executes this action (`ISparkNodeReport.actionExecutors`). */
168
+ 'node-action-unsupported',
169
+ /**
170
+ * System upgrade on a node runtime node: its Spark does not state the `systemUpgrade` executor,
171
+ * which Spark states only once its host-upgrade executor passed the lab qualification.
172
+ */
173
+ 'system-upgrade-unqualified',
174
+ /** The node already has an open action. */
175
+ 'node-action-open',
176
+ /** Another node of the cluster has an open action; a cluster runs one disruptive action at a time. */
177
+ 'cluster-action-open',
178
+ /** An update without a fleet Spark target. */
179
+ 'spark-target-unset',
180
+ /** An update whose target is below the Spark bundle version the node reports. */
181
+ 'spark-target-below-node',
182
+ /** An update of a node that is held at its release (`ISparkNodeTargetHold`). */
183
+ 'spark-target-held',
184
+ /** The request states no confirmation, or one that is not well-formed for this action. */
185
+ 'confirmation-invalid',
186
+ /** The typed hostname is not the hostname the node reports. */
187
+ 'confirmation-hostname-mismatch',
188
+ /** What the action interrupts changed since the preview the confirmation names. */
189
+ 'impact-changed',
190
+ /** An update whose confirmation names another fleet Spark target revision than the one Cloudly would freeze. */
191
+ 'target-changed',
192
+ /** The impact names a Corestore on the node and the confirmation does not consent to restarting it. */
193
+ 'corestore-consent-required',
194
+ /** Cloudly could not read what the action interrupts. */
195
+ 'impact-unreadable',
196
+ /** No action of that id on that node. */
197
+ 'node-action-missing',
198
+ /** Only a `pending` action is cancelled. */
199
+ 'node-action-not-cancellable',
200
+ /** The action moved since the revision the request names. */
201
+ 'node-action-revision-stale',
202
+ ]);
203
+ const maximumHostnameLength = 253;
204
+ const hostnamePattern = /^[a-z0-9](?:[a-z0-9.-]{0,251}[a-z0-9])?$/;
205
+ const sha256HexPattern = /^[a-f0-9]{64}$/;
206
+ /**
207
+ * Validates one confirmation for one action and names every reason it is refused.
208
+ *
209
+ * Shape only: an update must state `targetRevision`, every other action must not. Whether it
210
+ * matches the node, the impact and the fleet target Cloudly reads now is Cloudly's decision
211
+ * (`confirmation-hostname-mismatch`, `impact-changed`, `target-changed`, `corestore-consent-required`).
212
+ */
213
+ export const validateNodeActionConfirmation = (valueArg, actionNameArg, pathArg = 'node action confirmation') => {
214
+ // An update names the target revision it confirmed; no other action does.
215
+ const update = actionNameArg === 'serveZoneServiceUpdate';
216
+ const value = readExactDataRecord(valueArg, ['confirmedHostname', 'impactDigest', 'corestoreRestart', 'reboot',
217
+ ...(update ? ['targetRevision'] : [])]);
218
+ if (value === null) {
219
+ return [update
220
+ ? `${pathArg} must use its exact schema, with the targetRevision the preview showed`
221
+ : `${pathArg} must use its exact schema, without a targetRevision`];
222
+ }
223
+ const errors = [];
224
+ if (update && (!Number.isSafeInteger(value.targetRevision) || value.targetRevision < 1)) {
225
+ errors.push(`${pathArg} targetRevision must be a positive integer`);
226
+ }
227
+ if (typeof value.confirmedHostname !== 'string' || value.confirmedHostname.length > maximumHostnameLength
228
+ || !hostnamePattern.test(value.confirmedHostname)) {
229
+ errors.push(`${pathArg} confirmedHostname must be a lowercase hostname`);
230
+ }
231
+ if (typeof value.impactDigest !== 'string' || !sha256HexPattern.test(value.impactDigest)) {
232
+ errors.push(`${pathArg} impactDigest must be a lowercase SHA-256 hex digest`);
233
+ }
234
+ if (typeof value.corestoreRestart !== 'boolean')
235
+ errors.push(`${pathArg} corestoreRestart must be a boolean`);
236
+ if (typeof value.reboot !== 'boolean') {
237
+ errors.push(`${pathArg} reboot must be a boolean`);
238
+ }
239
+ else if (value.reboot && actionNameArg !== 'systemUpgrade') {
240
+ errors.push(`${pathArg} reboot is stated for systemUpgrade only`);
241
+ }
242
+ return errors;
243
+ };
244
+ /**
245
+ * The node runtime's action routes.
246
+ *
247
+ * Spark asks the offer route after each accepted heartbeat and states every step on the transition
248
+ * route. Both are authenticated with the node's Spark credential exactly like
249
+ * `sparkNodeHeartbeatContract` and judged in the same server order: the offer first, within
250
+ * `maxRequestBytes`, answered with `protocolRefusalStatus` and an `IProtocolRefusal` body on
251
+ * refusal, before the node is authenticated. The server's offer on these routes names, as its
252
+ * minimum, the release that introduced them, so a Spark below it is refused by name and is never
253
+ * handed an action.
254
+ */
255
+ export const sparkNodeActionContracts = Object.freeze({
256
+ offer: Object.freeze({
257
+ endpoint: '/spark/nodes/action',
258
+ maxRequestBytes: 1024,
259
+ maxResponseBytes: 4096,
260
+ }),
261
+ transition: Object.freeze({
262
+ endpoint: '/spark/nodes/action/transition',
263
+ maxRequestBytes: 2048,
264
+ maxResponseBytes: 4096,
265
+ }),
266
+ protocolRefusalStatus: protocolRefusalHttpStatus,
267
+ });
268
+ const fail = () => { throw new Error('Spark node action contract rejected.'); };
269
+ function requireValue(valueArg) {
270
+ if (!valueArg)
271
+ fail();
272
+ }
273
+ const record = (valueArg, keysArg) => {
274
+ const result = readExactDataRecord(valueArg, keysArg);
275
+ requireValue(result !== null);
276
+ return result;
277
+ };
278
+ const nodeId = (valueArg) => (isClusterNodeId(valueArg) ? valueArg : fail());
279
+ const nodeToken = (valueArg) => {
280
+ requireValue(typeof valueArg === 'string' && /^secureToken[a-f0-9]{64}$/.test(valueArg));
281
+ return valueArg;
282
+ };
283
+ const integer = (valueArg, minimumArg) => {
284
+ requireValue(Number.isSafeInteger(valueArg) && !Object.is(valueArg, -0) && valueArg >= minimumArg);
285
+ return valueArg;
286
+ };
287
+ /** An action id as Cloudly mints them: a short URL-safe token. */
288
+ const actionId = (valueArg) => {
289
+ requireValue(typeof valueArg === 'string' && /^[A-Za-z0-9_-]{1,64}$/.test(valueArg));
290
+ return valueArg;
291
+ };
292
+ /** The kernel's `boot_id`: one lowercase UUID. */
293
+ export const isHostBootId = (valueArg) => (typeof valueArg === 'string'
294
+ && /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.test(valueArg));
295
+ const bootId = (valueArg) => (isHostBootId(valueArg) ? valueArg : fail());
296
+ const operatorText = (valueArg) => {
297
+ requireValue(typeof valueArg === 'string' && valueArg.length <= nodeActionContract.maximumDetailLength
298
+ && /^[\x20-\x7e]*$/.test(valueArg));
299
+ return valueArg;
300
+ };
301
+ const snapshotTarget = (valueArg) => {
302
+ const value = record(valueArg, ['version', 'installerSha256', 'targetRevision']);
303
+ requireValue(isReleaseVersion(value.version));
304
+ requireValue(typeof value.installerSha256 === 'string' && sha256HexPattern.test(value.installerSha256));
305
+ return Object.freeze({
306
+ version: value.version, installerSha256: value.installerSha256,
307
+ targetRevision: integer(value.targetRevision, 1),
308
+ });
309
+ };
310
+ const assignmentStatuses = ['pending', 'claimed', 'executing', 'draining', 'rebooting', 'verifying'];
311
+ /** One assignment, exactly its keys; detached and frozen. */
312
+ export const snapshotSparkNodeActionAssignment = (valueArg) => {
313
+ const value = record(valueArg, ['id', 'actionName', 'status', 'revision', 'deadlineAt', 'reboot', 'target', 'claim']);
314
+ requireValue(isNodeActionName(value.actionName));
315
+ const status = assignmentStatuses.find((statusArg) => statusArg === value.status) ?? fail();
316
+ requireValue(typeof value.reboot === 'boolean' && (!value.reboot || value.actionName === 'systemUpgrade'));
317
+ const target = value.target === null ? null : snapshotTarget(value.target);
318
+ requireValue((target !== null) === (value.actionName === 'serveZoneServiceUpdate'));
319
+ const claim = value.claim === null ? null : Object.freeze({ bootId: bootId(record(value.claim, ['bootId']).bootId) });
320
+ requireValue((claim === null) === (status === 'pending'));
321
+ return Object.freeze({
322
+ id: actionId(value.id), actionName: value.actionName, status,
323
+ revision: integer(value.revision, 1), deadlineAt: integer(value.deadlineAt, 1),
324
+ reboot: value.reboot, target, claim,
325
+ });
326
+ };
327
+ export const snapshotSparkNodeActionOfferRequest = (valueArg) => {
328
+ const value = record(valueArg, ['nodeId', 'nodeToken', 'protocol']);
329
+ return Object.freeze({
330
+ nodeId: nodeId(value.nodeId), nodeToken: nodeToken(value.nodeToken), protocol: readProtocolOffer(value),
331
+ });
332
+ };
333
+ export const snapshotSparkNodeActionOffer = (valueArg) => {
334
+ const value = record(valueArg, ['nodeId', 'action', 'protocol']);
335
+ return Object.freeze({
336
+ nodeId: nodeId(value.nodeId),
337
+ action: value.action === null ? null : snapshotSparkNodeActionAssignment(value.action),
338
+ protocol: readProtocolOffer(value),
339
+ });
340
+ };
341
+ const snapshotTransition = (valueArg) => {
342
+ const properties = readDataProperties(valueArg);
343
+ requireValue(properties !== null);
344
+ switch (properties.kind) {
345
+ case 'claim':
346
+ return Object.freeze({ kind: 'claim', bootId: bootId(record(valueArg, ['kind', 'bootId']).bootId) });
347
+ case 'phase': {
348
+ const phase = record(valueArg, ['kind', 'phase']).phase;
349
+ const known = sparkNodeActionPhaseOrder.find((phaseArg) => phaseArg !== 'claimed' && phaseArg === phase);
350
+ return Object.freeze({ kind: 'phase', phase: (known ?? fail()) });
351
+ }
352
+ case 'complete':
353
+ record(valueArg, ['kind']);
354
+ return Object.freeze({ kind: 'complete' });
355
+ case 'fail': {
356
+ const value = record(valueArg, ['kind', 'code', 'detail']);
357
+ const code = sparkNodeActionFailureCodes.find((codeArg) => codeArg === value.code) ?? fail();
358
+ return Object.freeze({ kind: 'fail', code, detail: operatorText(value.detail) });
359
+ }
360
+ default:
361
+ return fail();
362
+ }
363
+ };
364
+ export const snapshotSparkNodeActionTransitionRequest = (valueArg) => {
365
+ const value = record(valueArg, ['nodeId', 'nodeToken', 'protocol', 'actionId', 'expectedRevision', 'transition']);
366
+ return Object.freeze({
367
+ nodeId: nodeId(value.nodeId), nodeToken: nodeToken(value.nodeToken), protocol: readProtocolOffer(value),
368
+ actionId: actionId(value.actionId), expectedRevision: integer(value.expectedRevision, 1),
369
+ transition: snapshotTransition(value.transition),
370
+ });
371
+ };
372
+ const transitionRefusals = [
373
+ 'action-unknown', 'action-closed', 'revision-stale', 'transition-invalid',
374
+ ];
375
+ export const snapshotSparkNodeActionTransitionAnswer = (valueArg) => {
376
+ const properties = readDataProperties(valueArg);
377
+ requireValue(properties !== null);
378
+ if (properties.outcome === 'refused') {
379
+ const value = record(valueArg, ['outcome', 'reason', 'action', 'protocol']);
380
+ const reason = transitionRefusals.find((reasonArg) => reasonArg === value.reason) ?? fail();
381
+ return Object.freeze({
382
+ outcome: 'refused', reason,
383
+ action: value.action === null ? null : snapshotSparkNodeActionAssignment(value.action),
384
+ protocol: readProtocolOffer(value),
385
+ });
386
+ }
387
+ const value = record(valueArg, ['outcome', 'action', 'protocol']);
388
+ requireValue(value.outcome === 'applied' || value.outcome === 'replayed');
389
+ return Object.freeze({
390
+ outcome: value.outcome,
391
+ action: value.action === null ? null : snapshotSparkNodeActionAssignment(value.action),
392
+ protocol: readProtocolOffer(value),
393
+ });
394
+ };
395
+ /**
396
+ * Whether an open action admits one transition from Spark, judged from its state alone.
397
+ *
398
+ * `claim` takes a `pending` action. A `phase` moves strictly forward in `sparkNodeActionPhaseOrder`
399
+ * from `claimed` or an earlier phase, and only into a phase the action has: `rebooting` only for
400
+ * an action that reboots, `draining` for every action but a host upgrade without a reboot.
401
+ * `complete` ends the execution of a host upgrade without a reboot. `fail` ends any claimed action
402
+ * that Cloudly is not yet verifying.
403
+ */
404
+ export const admitsSparkNodeActionTransition = (actionArg, transitionArg) => {
405
+ const executing = sparkNodeActionPhaseOrder.indexOf(actionArg.status);
406
+ switch (transitionArg.kind) {
407
+ case 'claim':
408
+ return actionArg.status === 'pending';
409
+ case 'phase': {
410
+ if (executing < 0)
411
+ return false;
412
+ const next = sparkNodeActionPhaseOrder.indexOf(transitionArg.phase);
413
+ if (next <= executing)
414
+ return false;
415
+ if (transitionArg.phase === 'rebooting')
416
+ return nodeActionReboots(actionArg.actionName, actionArg.reboot);
417
+ if (transitionArg.phase === 'draining')
418
+ return nodeActionRestartsRuntime(actionArg.actionName, actionArg.reboot);
419
+ return actionArg.actionName !== 'reboot';
420
+ }
421
+ case 'complete':
422
+ return executing >= 1 && nodeActionVerification(actionArg.actionName, actionArg.reboot) === 'upgrade-complete';
423
+ case 'fail':
424
+ return executing >= 0;
425
+ }
426
+ };
427
+ /** True when a value is a canonical list of action names: known names, strictly increasing, at least one. */
428
+ export const isNodeActionNameList = (valueArg) => {
429
+ const elements = readDataElements(valueArg, nodeActionNames.length);
430
+ return elements !== null && elements.length > 0 && isCanonicalTokenList(elements, nodeActionNames);
431
+ };
432
+ /** Sorts action names into canonical order, so a list built from a set compares byte for byte. */
433
+ export const sortNodeActionNames = (namesArg) => ([...new Set(namesArg)].sort(compareWireTokens));
434
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"nodeaction.js","sourceRoot":"","sources":["../../ts/data/nodeaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAC;AACtH,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACzG,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,yBAAyB,EAAE,iBAAiB,EAAuB,MAAM,gBAAgB,CAAC;AAEnG,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC;IAC3C,QAAQ;IACR,wBAAwB;IACxB,eAAe;CAC8B,CAAC,CAAC;AAIjD,MAAM,uBAAuB,GAA6B,IAAI,CAAC;AAC/D,KAAK,uBAAuB,CAAC;AAE7B,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,QAAiB,EAA+B,EAAE,CAAC,CAClF,eAAe,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,QAAQ,CAAC,CACxD,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAAC;IACjD,OAAO,EAAE,MAAM;IACf,OAAO,EAAE,MAAM;IACf,OAAO,EAAE,MAAM;IACf,SAAS,EAAE,MAAM;IACjB,QAAQ,EAAE,MAAM;IAChB,SAAS,EAAE,MAAM;IACjB,SAAS,EAAE,MAAM;IACjB,SAAS,EAAE,UAAU;IACrB,MAAM,EAAE,UAAU;IAClB,OAAO,EAAE,UAAU;IACnB,SAAS,EAAE,UAAU;IACrB,UAAU,EAAE,UAAU;CAC2C,CAAC,CAAC;AAErE,2EAA2E;AAC3E,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAE,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAyB;KAC5G,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,qBAAqB,CAAC,SAAS,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC;AAEvE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,SAA4B,EAAW,EAAE,CAAC,CACzE,qBAAqB,CAAC,SAAS,CAAC,KAAK,MAAM,CAC5C,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,CAAU,CAAC,CAAC;AAKnH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9C,2FAA2F;IAC3F,aAAa,EAAE,OAAO;IACtB;;;OAGG;IACH,OAAO,EAAE,OAAO;IAChB,8EAA8E;IAC9E,MAAM,EAAE,OAAO;IACf;;;OAGG;IACH,OAAO,EAAE,OAAO;IAChB,gGAAgG;IAChG,UAAU,EAAE,OAAO;IACnB,mDAAmD;IACnD,aAAa,EAAE,SAAS;IACxB,8EAA8E;IAC9E,sBAAsB,EAAE,EAAE;IAC1B,yEAAyE;IACzE,mBAAmB,EAAE,GAAG;IACxB,sFAAsF;IACtF,qBAAqB,EAAE,IAAI;IAC3B,wDAAwD;IACxD,wBAAwB,EAAE,GAAG;CACrB,CAAC,CAAC;AAEZ;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,aAA8B,EAAE,SAAkB,EAAU,EAAE;IACzG,MAAM,CAAC,GAAG,kBAAkB,CAAC;IAC7B,QAAQ,aAAa,EAAE,CAAC;QACtB,KAAK,QAAQ;YACX,OAAO,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,OAAO,CAAC;QAC1C,KAAK,wBAAwB;YAC3B,OAAO,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC;QAC9C,KAAK,eAAe;YAClB,OAAO,CAAC,CAAC,aAAa,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChF,CAAC;AACH,CAAC,CAAC;AAEF,uGAAuG;AACvG,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,aAA8B,EAAE,SAAkB,EAAW,EAAE,CAAC,CAChG,aAAa,KAAK,QAAQ,IAAI,CAAC,aAAa,KAAK,eAAe,IAAI,SAAS,CAAC,CAC/E,CAAC;AAoBF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,aAA8B,EAC9B,SAAkB,EACO,EAAE,CAAC,iBAAiB,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU;IACpF,CAAC,CAAC,aAAa,KAAK,wBAAwB,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,kBAAkB,CAAC;AAEvF,iHAAiH;AACjH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,aAA8B,EAAE,SAAkB,EAAW,EAAE,CAAC,CACxG,sBAAsB,CAAC,aAAa,EAAE,SAAS,CAAC,KAAK,kBAAkB,CACxE,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC,MAAM,CAAC;IACrD,iBAAiB,EAAE,2EAA2E;UAC1F,kDAAkD;IACtD,oBAAoB,EAAE,yEAAyE;UAC3F,yFAAyF;IAC7F,gBAAgB,EAAE,4EAA4E;UAC1F,gEAAgE;IACpE,cAAc,EAAE,6EAA6E;UACzF,oDAAoD;IACxD,eAAe,EAAE,qEAAqE;IACtF,qBAAqB,EAAE,0EAA0E;UAC7F,gEAAgE;IACpE,iBAAiB,EAAE,iEAAiE;IACpF,iBAAiB,EAAE,6EAA6E;UAC5F,8DAA8D;IAClE,mBAAmB,EAAE,uEAAuE;UACxF,oFAAoF;CAChF,CAAC,CAAC;AAIZ,kEAAkE;AAClE,MAAM,CAAC,MAAM,2BAA2B,GAAG,MAAM,CAAC,MAAM,CAAC;IACvD,iBAAiB;IACjB,cAAc;IACd,iBAAiB;IACjB,qBAAqB;IACrB,gBAAgB;IAChB,oBAAoB;IACpB,eAAe;CACqC,CAAC,CAAC;AA4FxD,8FAA8F;AAC9F,MAAM,CAAC,MAAM,6BAA6B,GAAG,KAAK,EAAE,SAA4B,EAAmB,EAAE;IACnG,MAAM,IAAI,GAAG,CAAC,SAAiB,EAAS,EAAE,GAAG,MAAM,IAAI,KAAK,CAAC,gCAAgC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7G,OAAO,4BAA4B,CAAC,sBAAsB,CAAC,SAAS,EAAE,IAAI,EAAE,oBAAoB,CAAC,EAAE,IAAI,CAAC,CAAC;AAC3G,CAAC,CAAC;AAoDF;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9C,iCAAiC;IACjC,cAAc;IACd,yFAAyF;IACzF,2BAA2B;IAC3B,yGAAyG;IACzG,yBAAyB;IACzB;;;OAGG;IACH,4BAA4B;IAC5B,2CAA2C;IAC3C,kBAAkB;IAClB,sGAAsG;IACtG,qBAAqB;IACrB,8CAA8C;IAC9C,oBAAoB;IACpB,iFAAiF;IACjF,yBAAyB;IACzB,gFAAgF;IAChF,mBAAmB;IACnB,0FAA0F;IAC1F,sBAAsB;IACtB,+DAA+D;IAC/D,gCAAgC;IAChC,mFAAmF;IACnF,gBAAgB;IAChB,gHAAgH;IAChH,gBAAgB;IAChB,uGAAuG;IACvG,4BAA4B;IAC5B,yDAAyD;IACzD,mBAAmB;IACnB,yCAAyC;IACzC,qBAAqB;IACrB,4CAA4C;IAC5C,6BAA6B;IAC7B,6DAA6D;IAC7D,4BAA4B;CACpB,CAAC,CAAC;AAqBZ,MAAM,qBAAqB,GAAG,GAAG,CAAC;AAClC,MAAM,eAAe,GAAG,0CAA0C,CAAC;AACnE,MAAM,gBAAgB,GAAG,gBAAgB,CAAC;AAE1C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAC5C,QAAiB,EACjB,aAA8B,EAC9B,OAAO,GAAG,0BAA0B,EAC1B,EAAE;IACZ,0EAA0E;IAC1E,MAAM,MAAM,GAAG,aAAa,KAAK,wBAAwB,CAAC;IAC1D,MAAM,KAAK,GAAG,mBAAmB,CAAC,QAAQ,EAAE,CAAC,mBAAmB,EAAE,cAAc,EAAE,kBAAkB,EAAE,QAAQ;QAC5G,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC1C,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,CAAC,MAAM;gBACZ,CAAC,CAAC,GAAG,OAAO,wEAAwE;gBACpF,CAAC,CAAC,GAAG,OAAO,sDAAsD,CAAC,CAAC;IACxE,CAAC;IACD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,MAAM,IAAI,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,cAAc,CAAC,IAAK,KAAK,CAAC,cAAyB,GAAG,CAAC,CAAC,EAAE,CAAC;QACpG,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,4CAA4C,CAAC,CAAC;IACtE,CAAC;IACD,IAAI,OAAO,KAAK,CAAC,iBAAiB,KAAK,QAAQ,IAAI,KAAK,CAAC,iBAAiB,CAAC,MAAM,GAAG,qBAAqB;WACpG,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC;QACpD,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,iDAAiD,CAAC,CAAC;IAC3E,CAAC;IACD,IAAI,OAAO,KAAK,CAAC,YAAY,KAAK,QAAQ,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;QACzF,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,sDAAsD,CAAC,CAAC;IAChF,CAAC;IACD,IAAI,OAAO,KAAK,CAAC,gBAAgB,KAAK,SAAS;QAAE,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,qCAAqC,CAAC,CAAC;IAC9G,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACtC,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,2BAA2B,CAAC,CAAC;IACrD,CAAC;SAAM,IAAI,KAAK,CAAC,MAAM,IAAI,aAAa,KAAK,eAAe,EAAE,CAAC;QAC7D,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,0CAA0C,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AA4FF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,CAAC;IACpD,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;QACnB,QAAQ,EAAE,qBAAqB;QAC/B,eAAe,EAAE,IAAI;QACrB,gBAAgB,EAAE,IAAI;KACd,CAAC;IACX,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC;QACxB,QAAQ,EAAE,gCAAgC;QAC1C,eAAe,EAAE,IAAI;QACrB,gBAAgB,EAAE,IAAI;KACd,CAAC;IACX,qBAAqB,EAAE,yBAAyB;CACxC,CAAC,CAAC;AAEZ,MAAM,IAAI,GAAG,GAAU,EAAE,GAAG,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC,CAAC,CAAC,CAAC;AACvF,SAAS,YAAY,CAAC,QAAiB;IACrC,IAAI,CAAC,QAAQ;QAAE,IAAI,EAAE,CAAC;AACxB,CAAC;AACD,MAAM,MAAM,GAAG,CAAC,QAAiB,EAAE,OAA0B,EAA2B,EAAE;IACxF,MAAM,MAAM,GAAG,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACtD,YAAY,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC;IAC9B,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AACF,MAAM,MAAM,GAAG,CAAC,QAAiB,EAAU,EAAE,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;AAC9F,MAAM,SAAS,GAAG,CAAC,QAAiB,EAAU,EAAE;IAC9C,YAAY,CAAC,OAAO,QAAQ,KAAK,QAAQ,IAAI,2BAA2B,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACzF,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AACF,MAAM,OAAO,GAAG,CAAC,QAAiB,EAAE,UAAkB,EAAU,EAAE;IAChE,YAAY,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAK,QAAmB,IAAI,UAAU,CAAC,CAAC;IAC/G,OAAO,QAAkB,CAAC;AAC5B,CAAC,CAAC;AACF,kEAAkE;AAClE,MAAM,QAAQ,GAAG,CAAC,QAAiB,EAAU,EAAE;IAC7C,YAAY,CAAC,OAAO,QAAQ,KAAK,QAAQ,IAAI,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACrF,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AACF,kDAAkD;AAClD,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,QAAiB,EAAsB,EAAE,CAAC,CACrE,OAAO,QAAQ,KAAK,QAAQ;OACzB,gEAAgE,CAAC,IAAI,CAAC,QAAQ,CAAC,CACnF,CAAC;AACF,MAAM,MAAM,GAAG,CAAC,QAAiB,EAAU,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;AAC3F,MAAM,YAAY,GAAG,CAAC,QAAiB,EAAU,EAAE;IACjD,YAAY,CAAC,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,MAAM,IAAI,kBAAkB,CAAC,mBAAmB;WACjG,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACtC,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,QAAiB,EAAqB,EAAE;IAC9D,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,iBAAiB,EAAE,gBAAgB,CAAC,CAAC,CAAC;IACjF,YAAY,CAAC,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9C,YAAY,CAAC,OAAO,KAAK,CAAC,eAAe,KAAK,QAAQ,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;IACxG,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,eAAe,EAAE,KAAK,CAAC,eAAe;QAC9D,cAAc,EAAE,OAAO,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC;KACjD,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,CAAU,CAAC;AAE9G,6DAA6D;AAC7D,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,QAAiB,EAA8B,EAAE;IACjG,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IACtH,YAAY,CAAC,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,KAAK,KAAK,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;IAC5F,YAAY,CAAC,OAAO,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,UAAU,KAAK,eAAe,CAAC,CAAC,CAAC;IAC3G,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC3E,YAAY,CAAC,CAAC,MAAM,KAAK,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,KAAK,wBAAwB,CAAC,CAAC,CAAC;IACpF,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACtH,YAAY,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC;IAC1D,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,EAAE,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,MAAM;QAC5D,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC;QAC9E,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK;KACpC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,QAAiB,EAAgC,EAAE;IACrG,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;IACpE,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC;KACxG,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,QAAiB,EAAyB,EAAE;IACvF,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;IACjE,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;QAC5B,MAAM,EAAE,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,iCAAiC,CAAC,KAAK,CAAC,MAAM,CAAC;QACtF,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC;KACnC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,QAAiB,EAA8B,EAAE;IAC3E,MAAM,UAAU,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAChD,YAAY,CAAC,UAAU,KAAK,IAAI,CAAC,CAAC;IAClC,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;QACxB,KAAK,OAAO;YACV,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACvG,KAAK,OAAO,EAAE,CAAC;YACb,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;YACxD,MAAM,KAAK,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,KAAK,CAAC,CAAC;YACzG,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,KAAK,IAAI,IAAI,EAAE,CAA0B,EAAE,CAAC,CAAC;QAC7F,CAAC;QACD,KAAK,UAAU;YACb,MAAM,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;YAC3B,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;QAC7C,KAAK,MAAM,EAAE,CAAC;YACZ,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC3D,MAAM,IAAI,GAAG,2BAA2B,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YAC7F,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACnF,CAAC;QACD;YACE,OAAO,IAAI,EAAE,CAAC;IAClB,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,wCAAwC,GAAG,CAAC,QAAiB,EAAqC,EAAE;IAC/G,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,kBAAkB,EAAE,YAAY,CAAC,CAAC,CAAC;IAClH,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC;QACvG,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACxF,UAAU,EAAE,kBAAkB,CAAC,KAAK,CAAC,UAAU,CAAC;KACjD,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAiD;IACvE,gBAAgB,EAAE,eAAe,EAAE,gBAAgB,EAAE,oBAAoB;CAC1E,CAAC;AAEF,MAAM,CAAC,MAAM,uCAAuC,GAAG,CAAC,QAAiB,EAAoC,EAAE;IAC7G,MAAM,UAAU,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAChD,YAAY,CAAC,UAAU,KAAK,IAAI,CAAC,CAAC;IAClC,IAAI,UAAU,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;QAC5E,MAAM,MAAM,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,KAAK,KAAK,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;QAC5F,OAAO,MAAM,CAAC,MAAM,CAAC;YACnB,OAAO,EAAE,SAAS,EAAE,MAAM;YAC1B,MAAM,EAAE,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,iCAAiC,CAAC,KAAK,CAAC,MAAM,CAAC;YACtF,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC;SACnC,CAAC,CAAC;IACL,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;IAClE,YAAY,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC;IAC1E,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,OAAO,EAAE,KAAK,CAAC,OAAiC;QAChD,MAAM,EAAE,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,iCAAiC,CAAC,KAAK,CAAC,MAAM,CAAC;QACtF,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC;KACnC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAC7C,SAA+E,EAC/E,aAAyC,EAChC,EAAE;IACX,MAAM,SAAS,GAAI,yBAA+C,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC7F,QAAQ,aAAa,CAAC,IAAI,EAAE,CAAC;QAC3B,KAAK,OAAO;YACV,OAAO,SAAS,CAAC,MAAM,KAAK,SAAS,CAAC;QACxC,KAAK,OAAO,EAAE,CAAC;YACb,IAAI,SAAS,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC;YAChC,MAAM,IAAI,GAAG,yBAAyB,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACpE,IAAI,IAAI,IAAI,SAAS;gBAAE,OAAO,KAAK,CAAC;YACpC,IAAI,aAAa,CAAC,KAAK,KAAK,WAAW;gBAAE,OAAO,iBAAiB,CAAC,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;YAC1G,IAAI,aAAa,CAAC,KAAK,KAAK,UAAU;gBAAE,OAAO,yBAAyB,CAAC,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;YACjH,OAAO,SAAS,CAAC,UAAU,KAAK,QAAQ,CAAC;QAC3C,CAAC;QACD,KAAK,UAAU;YACb,OAAO,SAAS,IAAI,CAAC,IAAI,sBAAsB,CAAC,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC,MAAM,CAAC,KAAK,kBAAkB,CAAC;QACjH,KAAK,MAAM;YACT,OAAO,SAAS,IAAI,CAAC,CAAC;IAC1B,CAAC;AACH,CAAC,CAAC;AAEF,6GAA6G;AAC7G,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,QAAiB,EAAiC,EAAE;IACvF,MAAM,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;IACpE,OAAO,QAAQ,KAAK,IAAI,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,oBAAoB,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;AACrG,CAAC,CAAC;AAEF,kGAAkG;AAClG,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAmC,EAAqB,EAAE,CAAC,CAC7F,CAAC,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAC/C,CAAC"}
@@ -0,0 +1,80 @@
1
+ /**
2
+ * The Spark release every node of the fleet should run: one row in Cloudly's database, the only
3
+ * source of the release a fresh node's bootstrap installs and an update moves a node to.
4
+ *
5
+ * An administrator names the version and the revision they read; Cloudly reads the SHA-256 of the
6
+ * release's `install.sh` from the release's published `SHA256SUMS.txt`, checks it against the
7
+ * `install.sh` it downloads, and stores the pair. Nobody types a hash. A database without the row
8
+ * holds no target, and every reader refuses by name (`spark-target-unset`) rather than falling
9
+ * back to a release of its own.
10
+ *
11
+ * A target below the release a node runs is admitted: that node reads `ahead` of it, and an update
12
+ * that would move it down is refused (`spark-target-below-node`).
13
+ */
14
+ export interface ISparkFleetTarget {
15
+ /** `MAJOR.MINOR.PATCH`, without `v`. */
16
+ version: string;
17
+ /** The SHA-256 the release's `SHA256SUMS.txt` states for `install.sh`, lowercase hex. */
18
+ installerSha256: string;
19
+ /** Advances by one with every change; the first target is revision 1. */
20
+ revision: number;
21
+ /** Who set it: `admin:<userId>`, or `migration:<step>` for the target a data step seeded. */
22
+ setBy: string;
23
+ setAt: number;
24
+ }
25
+ /**
26
+ * One change of the fleet target, kept in an append-only history: the target as it was set, and
27
+ * the version it replaced (`null` for the first). The history is the audit; nothing else records
28
+ * why a target moved.
29
+ */
30
+ export interface ISparkFleetTargetChange extends ISparkFleetTarget {
31
+ previousVersion: string | null;
32
+ }
33
+ /**
34
+ * One node held at the release it runs: it reads `held` rather than behind or ahead, and an update
35
+ * of it is refused (`spark-target-held`) until the hold is released. There is no per-node or
36
+ * per-cluster target; a hold is the only exception to the one fleet target.
37
+ */
38
+ export interface ISparkNodeTargetHold {
39
+ nodeId: string;
40
+ /** Operator text naming why the node is held. */
41
+ reason: string;
42
+ heldBy: string;
43
+ heldAt: number;
44
+ }
45
+ export declare const sparkFleetTargetContract: Readonly<{
46
+ /** Changes one `getSparkFleetTarget` answers, newest first. */
47
+ readonly historyLimit: 50;
48
+ /** Characters of one hold's reason. */
49
+ readonly maximumHoldReasonLength: 256;
50
+ }>;
51
+ /**
52
+ * Every reason Cloudly answers instead of reading or changing the fleet target or a hold. Each
53
+ * travels by name as a `TypedResponseError`, and a refused request changes nothing.
54
+ */
55
+ export declare const sparkFleetTargetRefusals: readonly ["spark-target-request-invalid", "spark-target-revision-stale", "spark-release-unavailable", "spark-release-checksum-missing", "spark-release-checksum-mismatch", "node-missing"];
56
+ export type TSparkFleetTargetRefusalCode = typeof sparkFleetTargetRefusals[number];
57
+ /**
58
+ * Where one node stands against the fleet target.
59
+ *
60
+ * - `at-target`, `behind`, `ahead`: the Spark bundle version it reports, compared to the target.
61
+ * - `held`: the node is held (`ISparkNodeTargetHold`), whatever it runs.
62
+ * - `unreported`: the node reports no Spark bundle version (it never reported through the node
63
+ * runtime).
64
+ * - `untargeted`: there is no fleet target.
65
+ */
66
+ export type TSparkNodeTargetStanding = 'at-target' | 'behind' | 'ahead' | 'held' | 'unreported' | 'untargeted';
67
+ export declare const readSparkNodeTargetStanding: (argsArg: {
68
+ bundleVersion: string | null;
69
+ target: Pick<ISparkFleetTarget, 'version'> | null;
70
+ held: boolean;
71
+ }) => TSparkNodeTargetStanding;
72
+ /**
73
+ * Validates one `setSparkFleetTarget` input and names every reason it is refused: a release version
74
+ * and the revision of the target the administrator read, `0` while there is none.
75
+ */
76
+ export declare const validateSetSparkFleetTargetInput: (valueArg: unknown, pathArg?: string) => string[];
77
+ /**
78
+ * Validates one hold a request states: `{ reason }` to hold the node, `null` to release it.
79
+ */
80
+ export declare const validateSparkNodeTargetHoldInput: (valueArg: unknown, pathArg?: string) => string[];
@@ -0,0 +1,71 @@
1
+ import { readExactDataRecord } from '../private/dataproperties.js';
2
+ import { compareReleaseVersions, isReleaseVersion, parseReleaseVersion } from './releaseversion.js';
3
+ export const sparkFleetTargetContract = Object.freeze({
4
+ /** Changes one `getSparkFleetTarget` answers, newest first. */
5
+ historyLimit: 50,
6
+ /** Characters of one hold's reason. */
7
+ maximumHoldReasonLength: 256,
8
+ });
9
+ /**
10
+ * Every reason Cloudly answers instead of reading or changing the fleet target or a hold. Each
11
+ * travels by name as a `TypedResponseError`, and a refused request changes nothing.
12
+ */
13
+ export const sparkFleetTargetRefusals = Object.freeze([
14
+ /** The request is not well-formed (`validateSetSparkFleetTargetInput`, `validateSparkNodeTargetHoldInput`). */
15
+ 'spark-target-request-invalid',
16
+ /** The target moved since the revision the request names (`0` while there is none). */
17
+ 'spark-target-revision-stale',
18
+ /** The release, its `SHA256SUMS.txt` or its `install.sh` could not be downloaded. */
19
+ 'spark-release-unavailable',
20
+ /** The release's `SHA256SUMS.txt` states no SHA-256 for `install.sh`. */
21
+ 'spark-release-checksum-missing',
22
+ /** The downloaded `install.sh` does not have the SHA-256 its `SHA256SUMS.txt` states. */
23
+ 'spark-release-checksum-mismatch',
24
+ /** No node of that id exists. */
25
+ 'node-missing',
26
+ ]);
27
+ export const readSparkNodeTargetStanding = (argsArg) => {
28
+ if (argsArg.held)
29
+ return 'held';
30
+ if (argsArg.target === null)
31
+ return 'untargeted';
32
+ const running = parseReleaseVersion(argsArg.bundleVersion);
33
+ const target = parseReleaseVersion(argsArg.target.version);
34
+ if (running === null || target === null)
35
+ return 'unreported';
36
+ const order = compareReleaseVersions(running, target);
37
+ return order === 0 ? 'at-target' : order < 0 ? 'behind' : 'ahead';
38
+ };
39
+ /**
40
+ * Validates one `setSparkFleetTarget` input and names every reason it is refused: a release version
41
+ * and the revision of the target the administrator read, `0` while there is none.
42
+ */
43
+ export const validateSetSparkFleetTargetInput = (valueArg, pathArg = 'spark fleet target input') => {
44
+ const value = readExactDataRecord(valueArg, ['version', 'expectedRevision']);
45
+ if (value === null)
46
+ return [`${pathArg} must use its exact schema`];
47
+ const errors = [];
48
+ if (!isReleaseVersion(value.version))
49
+ errors.push(`${pathArg} version must be a MAJOR.MINOR.PATCH release version`);
50
+ if (!Number.isSafeInteger(value.expectedRevision) || Object.is(value.expectedRevision, -0)
51
+ || value.expectedRevision < 0) {
52
+ errors.push(`${pathArg} expectedRevision must be a non-negative integer`);
53
+ }
54
+ return errors;
55
+ };
56
+ /**
57
+ * Validates one hold a request states: `{ reason }` to hold the node, `null` to release it.
58
+ */
59
+ export const validateSparkNodeTargetHoldInput = (valueArg, pathArg = 'spark node target hold') => {
60
+ if (valueArg === null)
61
+ return [];
62
+ const value = readExactDataRecord(valueArg, ['reason']);
63
+ if (value === null)
64
+ return [`${pathArg} must be null or use its exact schema`];
65
+ return typeof value.reason === 'string' && value.reason.length > 0
66
+ && value.reason.length <= sparkFleetTargetContract.maximumHoldReasonLength
67
+ && /^[\x20-\x7e]+$/.test(value.reason)
68
+ ? []
69
+ : [`${pathArg} reason must be printable text of 1 to ${sparkFleetTargetContract.maximumHoldReasonLength} characters`];
70
+ };
71
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3BhcmtmbGVldHRhcmdldC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzL2RhdGEvc3BhcmtmbGVldHRhcmdldC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsbUJBQW1CLEVBQUUsTUFBTSw4QkFBOEIsQ0FBQztBQUNuRSxPQUFPLEVBQUUsc0JBQXNCLEVBQUUsZ0JBQWdCLEVBQUUsbUJBQW1CLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQWlEcEcsTUFBTSxDQUFDLE1BQU0sd0JBQXdCLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQztJQUNwRCwrREFBK0Q7SUFDL0QsWUFBWSxFQUFFLEVBQUU7SUFDaEIsdUNBQXVDO0lBQ3ZDLHVCQUF1QixFQUFFLEdBQUc7Q0FDcEIsQ0FBQyxDQUFDO0FBRVo7OztHQUdHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sd0JBQXdCLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQztJQUNwRCwrR0FBK0c7SUFDL0csOEJBQThCO0lBQzlCLHVGQUF1RjtJQUN2Riw2QkFBNkI7SUFDN0IscUZBQXFGO0lBQ3JGLDJCQUEyQjtJQUMzQix5RUFBeUU7SUFDekUsZ0NBQWdDO0lBQ2hDLHlGQUF5RjtJQUN6RixpQ0FBaUM7SUFDakMsaUNBQWlDO0lBQ2pDLGNBQWM7Q0FDTixDQUFDLENBQUM7QUFlWixNQUFNLENBQUMsTUFBTSwyQkFBMkIsR0FBRyxDQUFDLE9BSTNDLEVBQTRCLEVBQUU7SUFDN0IsSUFBSSxPQUFPLENBQUMsSUFBSTtRQUFFLE9BQU8sTUFBTSxDQUFDO0lBQ2hDLElBQUksT0FBTyxDQUFDLE1BQU0sS0FBSyxJQUFJO1FBQUUsT0FBTyxZQUFZLENBQUM7SUFDakQsTUFBTSxPQUFPLEdBQUcsbUJBQW1CLENBQUMsT0FBTyxDQUFDLGFBQWEsQ0FBQyxDQUFDO0lBQzNELE1BQU0sTUFBTSxHQUFHLG1CQUFtQixDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDM0QsSUFBSSxPQUFPLEtBQUssSUFBSSxJQUFJLE1BQU0sS0FBSyxJQUFJO1FBQUUsT0FBTyxZQUFZLENBQUM7SUFDN0QsTUFBTSxLQUFLLEdBQUcsc0JBQXNCLENBQUMsT0FBTyxFQUFFLE1BQU0sQ0FBQyxDQUFDO0lBQ3RELE9BQU8sS0FBSyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxLQUFLLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDLE9BQU8sQ0FBQztBQUNwRSxDQUFDLENBQUM7QUFFRjs7O0dBR0c7QUFDSCxNQUFNLENBQUMsTUFBTSxnQ0FBZ0MsR0FBRyxDQUM5QyxRQUFpQixFQUNqQixPQUFPLEdBQUcsMEJBQTBCLEVBQzFCLEVBQUU7SUFDWixNQUFNLEtBQUssR0FBRyxtQkFBbUIsQ0FBQyxRQUFRLEVBQUUsQ0FBQyxTQUFTLEVBQUUsa0JBQWtCLENBQUMsQ0FBQyxDQUFDO0lBQzdFLElBQUksS0FBSyxLQUFLLElBQUk7UUFBRSxPQUFPLENBQUMsR0FBRyxPQUFPLDRCQUE0QixDQUFDLENBQUM7SUFDcEUsTUFBTSxNQUFNLEdBQWEsRUFBRSxDQUFDO0lBQzVCLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDO1FBQUUsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLE9BQU8sc0RBQXNELENBQUMsQ0FBQztJQUNwSCxJQUFJLENBQUMsTUFBTSxDQUFDLGFBQWEsQ0FBQyxLQUFLLENBQUMsZ0JBQWdCLENBQUMsSUFBSSxNQUFNLENBQUMsRUFBRSxDQUFDLEtBQUssQ0FBQyxnQkFBZ0IsRUFBRSxDQUFDLENBQUMsQ0FBQztXQUNwRixLQUFLLENBQUMsZ0JBQTJCLEdBQUcsQ0FBQyxFQUFFLENBQUM7UUFDNUMsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLE9BQU8sa0RBQWtELENBQUMsQ0FBQztJQUM1RSxDQUFDO0lBQ0QsT0FBTyxNQUFNLENBQUM7QUFDaEIsQ0FBQyxDQUFDO0FBRUY7O0dBRUc7QUFDSCxNQUFNLENBQUMsTUFBTSxnQ0FBZ0MsR0FBRyxDQUM5QyxRQUFpQixFQUNqQixPQUFPLEdBQUcsd0JBQXdCLEVBQ3hCLEVBQUU7SUFDWixJQUFJLFFBQVEsS0FBSyxJQUFJO1FBQUUsT0FBTyxFQUFFLENBQUM7SUFDakMsTUFBTSxLQUFLLEdBQUcsbUJBQW1CLENBQUMsUUFBUSxFQUFFLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQztJQUN4RCxJQUFJLEtBQUssS0FBSyxJQUFJO1FBQUUsT0FBTyxDQUFDLEdBQUcsT0FBTyx1Q0FBdUMsQ0FBQyxDQUFDO0lBQy9FLE9BQU8sT0FBTyxLQUFLLENBQUMsTUFBTSxLQUFLLFFBQVEsSUFBSSxLQUFLLENBQUMsTUFBTSxDQUFDLE1BQU0sR0FBRyxDQUFDO1dBQzdELEtBQUssQ0FBQyxNQUFNLENBQUMsTUFBTSxJQUFJLHdCQUF3QixDQUFDLHVCQUF1QjtXQUN2RSxnQkFBZ0IsQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQztRQUN0QyxDQUFDLENBQUMsRUFBRTtRQUNKLENBQUMsQ0FBQyxDQUFDLEdBQUcsT0FBTywwQ0FBMEMsd0JBQXdCLENBQUMsdUJBQXVCLGFBQWEsQ0FBQyxDQUFDO0FBQzFILENBQUMsQ0FBQyJ9