@serve.zone/interfaces 32.22.0 → 32.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/changelog.md +76 -0
  2. package/dist_ts/00_commitinfo_data.js +1 -1
  3. package/dist_ts/data/corestorelegacyadoption.d.ts +182 -0
  4. package/dist_ts/data/corestorelegacyadoption.js +292 -0
  5. package/dist_ts/data/index.d.ts +2 -0
  6. package/dist_ts/data/index.js +3 -1
  7. package/dist_ts/data/networkprotection.d.ts +13 -0
  8. package/dist_ts/data/networkprotection.js +8 -2
  9. package/dist_ts/data/runtimelocalstorageclaim.d.ts +73 -10
  10. package/dist_ts/data/runtimelocalstorageclaim.js +89 -2
  11. package/dist_ts/data/service.d.ts +15 -1
  12. package/dist_ts/data/service.js +1 -1
  13. package/dist_ts/data/serviceruntime.d.ts +8 -3
  14. package/dist_ts/data/serviceruntime.js +3 -2
  15. package/dist_ts/data/servicevolumeinitialization.d.ts +91 -0
  16. package/dist_ts/data/servicevolumeinitialization.js +93 -0
  17. package/dist_ts/platform/types.d.ts +45 -0
  18. package/dist_ts/platform/types.js +27 -2
  19. package/dist_ts/requests/corestore.d.ts +60 -0
  20. package/dist_ts/requests/corestore.js +1 -1
  21. package/dist_ts/requests/platform.d.ts +6 -1
  22. package/dist_ts/requests/service.d.ts +23 -0
  23. package/package.json +1 -1
  24. package/readme.md +186 -16
  25. package/ts/00_commitinfo_data.ts +1 -1
  26. package/ts/data/corestorelegacyadoption.ts +481 -0
  27. package/ts/data/index.ts +2 -0
  28. package/ts/data/networkprotection.ts +20 -1
  29. package/ts/data/runtimelocalstorageclaim.ts +169 -10
  30. package/ts/data/service.ts +16 -0
  31. package/ts/data/serviceruntime.ts +8 -2
  32. package/ts/data/servicevolumeinitialization.ts +159 -0
  33. package/ts/platform/types.ts +75 -0
  34. package/ts/requests/corestore.ts +79 -0
  35. package/ts/requests/platform.ts +6 -0
  36. package/ts/requests/service.ts +28 -0
@@ -0,0 +1,91 @@
1
+ import type { IRuntimeLocalStorageOwnership } from './runtimelocalstorageclaim.js';
2
+ import type { IServiceRuntimeProfile } from './serviceruntime.js';
3
+ /**
4
+ * Where an `import` volume's bytes come from.
5
+ *
6
+ * `docker-volume` is a Docker volume on the host the claim's node runs on, named exactly as Docker
7
+ * lists it; a Corestore-driver volume is named the same way. The operator copies its tree into the
8
+ * node's import directory; the node never reads this reference, and the local storage claim does
9
+ * not carry it.
10
+ */
11
+ export type TServiceVolumeImportSource = {
12
+ kind: 'docker-volume';
13
+ volumeName: string;
14
+ };
15
+ /**
16
+ * The owner and permission bits an `empty` volume's root directory gets.
17
+ *
18
+ * `explicit` states the numeric owner. `run-as` takes the owner from the runtime spec's
19
+ * `profile.runAs` (user and group) when the claim is first issued; the mode is always stated,
20
+ * because no mode is right for every image.
21
+ */
22
+ export type TServiceVolumeOwnership = {
23
+ kind: 'explicit';
24
+ uid: number;
25
+ gid: number;
26
+ mode: number;
27
+ } | {
28
+ kind: 'run-as';
29
+ mode: number;
30
+ };
31
+ /**
32
+ * How a service volume's node-local claim starts: `empty` creates a fresh root with the stated
33
+ * ownership, `import` waits for the bytes of an existing volume.
34
+ */
35
+ export type TServiceVolumeInitialization = {
36
+ kind: 'empty';
37
+ ownership: TServiceVolumeOwnership;
38
+ } | {
39
+ kind: 'import';
40
+ source: TServiceVolumeImportSource;
41
+ };
42
+ /**
43
+ * What a volume's initialization derives for a local storage claim, or why it derives nothing.
44
+ *
45
+ * `volume-initialization-unknown` is a volume with no initialization: Cloudly never assumes
46
+ * `empty`, because an empty volume in front of a service whose data sits in a legacy volume would
47
+ * start that service without its data. `volume-ownership-unknown` is a `run-as` ownership while
48
+ * the runtime spec runs the image's own user (`runAs: null`), whose numeric identity Cloudly does
49
+ * not know.
50
+ */
51
+ export type TServiceVolumeClaimInitialization = {
52
+ status: 'derived';
53
+ initialization: 'empty';
54
+ initialOwnership: IRuntimeLocalStorageOwnership;
55
+ } | {
56
+ status: 'derived';
57
+ initialization: 'import';
58
+ initialOwnership: null;
59
+ } | {
60
+ status: 'refused';
61
+ reason: 'volume-initialization-unknown' | 'volume-ownership-unknown';
62
+ };
63
+ /**
64
+ * Why `setServiceVolumeInitialization` wrote nothing. `volume-not-found` names no declared volume
65
+ * at that mount path, `conflict` a stored initialization other than `expected`,
66
+ * `volume-initialization-invalid` a value this contract refuses, and
67
+ * `volume-initialization-bound` a change while a bound local storage claim of the volume exists:
68
+ * a claim keeps the initialization and ownership it was issued with for its whole life.
69
+ */
70
+ export type TServiceVolumeInitializationRefusal = 'volume-not-found' | 'conflict' | 'volume-initialization-invalid' | 'volume-initialization-bound';
71
+ /** The named refusal of `setServiceVolumeInitialization`, sent as `TypedResponseError.errorData`. */
72
+ export interface IServiceVolumeInitializationErrorData {
73
+ code: TServiceVolumeInitializationRefusal;
74
+ retryable: false;
75
+ }
76
+ export declare const serviceVolumeInitializationContract: Readonly<{
77
+ /** Every permission bit an ownership may state, the local storage claim's own bound. */
78
+ readonly directoryModeBits: 2047;
79
+ readonly maximumDockerVolumeNameLength: 255;
80
+ }>;
81
+ /** Validates one volume initialization and names every reason it is refused. */
82
+ export declare const validateServiceVolumeInitialization: (valueArg: unknown, pathArg?: string) => string[];
83
+ /**
84
+ * The claim fields a volume's initialization derives under a runtime spec's `runAs`.
85
+ *
86
+ * Absent initialization refuses as `volume-initialization-unknown`; a `run-as` ownership under
87
+ * `runAs: null` refuses as `volume-ownership-unknown`. Nothing is defaulted. The answer is for the
88
+ * first generation of a claim only: later generations carry that claim's own initialization and
89
+ * ownership, whatever `runAs` says by then. A malformed initialization or `runAs` throws.
90
+ */
91
+ export declare const deriveServiceVolumeClaimInitialization: (initializationArg: TServiceVolumeInitialization | undefined, runAsArg: IServiceRuntimeProfile["runAs"]) => TServiceVolumeClaimInitialization;
@@ -0,0 +1,93 @@
1
+ import { runtimeLocalStorageClaimContract } from './runtimelocalstorageclaim.js';
2
+ import { hasExactKeys, isPlainRecord } from '../private/dataproperties.js';
3
+ import { isRuntimeIdentityNumber } from '../private/runtimepolicy.js';
4
+ export const serviceVolumeInitializationContract = Object.freeze({
5
+ /** Every permission bit an ownership may state, the local storage claim's own bound. */
6
+ directoryModeBits: runtimeLocalStorageClaimContract.directoryModeBits,
7
+ maximumDockerVolumeNameLength: 255,
8
+ });
9
+ /** Docker's own volume name grammar, `[a-zA-Z0-9][a-zA-Z0-9_.-]`, which needs two characters. */
10
+ const dockerVolumeNamePattern = /^[A-Za-z0-9][A-Za-z0-9_.-]+$/;
11
+ const isDirectoryMode = (valueArg) => Number.isSafeInteger(valueArg)
12
+ && valueArg >= 0
13
+ && (valueArg & ~serviceVolumeInitializationContract.directoryModeBits) === 0;
14
+ const validateOwnership = (valueArg, pathArg) => {
15
+ if (!isPlainRecord(valueArg))
16
+ return [`${pathArg} must use its exact schema`];
17
+ if (valueArg.kind === 'explicit') {
18
+ if (!hasExactKeys(valueArg, ['kind', 'uid', 'gid', 'mode']))
19
+ return [`${pathArg} must use its exact schema`];
20
+ const errors = [];
21
+ if (!isRuntimeIdentityNumber(valueArg.uid) || !isRuntimeIdentityNumber(valueArg.gid)) {
22
+ errors.push(`${pathArg} uid and gid must be runtime identity numbers`);
23
+ }
24
+ if (!isDirectoryMode(valueArg.mode))
25
+ errors.push(`${pathArg} mode must hold directory permission bits only`);
26
+ return errors;
27
+ }
28
+ if (valueArg.kind === 'run-as') {
29
+ if (!hasExactKeys(valueArg, ['kind', 'mode']))
30
+ return [`${pathArg} must use its exact schema`];
31
+ return isDirectoryMode(valueArg.mode) ? [] : [`${pathArg} mode must hold directory permission bits only`];
32
+ }
33
+ return [`${pathArg} kind must be explicit or run-as`];
34
+ };
35
+ const validateImportSource = (valueArg, pathArg) => {
36
+ if (!isPlainRecord(valueArg) || valueArg.kind !== 'docker-volume'
37
+ || !hasExactKeys(valueArg, ['kind', 'volumeName'])) {
38
+ return [`${pathArg} must be an exact docker-volume source`];
39
+ }
40
+ return typeof valueArg.volumeName === 'string'
41
+ && valueArg.volumeName.length <= serviceVolumeInitializationContract.maximumDockerVolumeNameLength
42
+ && dockerVolumeNamePattern.test(valueArg.volumeName)
43
+ ? []
44
+ : [`${pathArg} volumeName must be a Docker volume name`];
45
+ };
46
+ /** Validates one volume initialization and names every reason it is refused. */
47
+ export const validateServiceVolumeInitialization = (valueArg, pathArg = 'service volume initialization') => {
48
+ if (!isPlainRecord(valueArg))
49
+ return [`${pathArg} must use its exact schema`];
50
+ if (valueArg.kind === 'empty') {
51
+ if (!hasExactKeys(valueArg, ['kind', 'ownership']))
52
+ return [`${pathArg} must use its exact schema`];
53
+ return validateOwnership(valueArg.ownership, `${pathArg} ownership`);
54
+ }
55
+ if (valueArg.kind === 'import') {
56
+ if (!hasExactKeys(valueArg, ['kind', 'source']))
57
+ return [`${pathArg} must use its exact schema`];
58
+ return validateImportSource(valueArg.source, `${pathArg} source`);
59
+ }
60
+ return [`${pathArg} kind must be empty or import`];
61
+ };
62
+ /**
63
+ * The claim fields a volume's initialization derives under a runtime spec's `runAs`.
64
+ *
65
+ * Absent initialization refuses as `volume-initialization-unknown`; a `run-as` ownership under
66
+ * `runAs: null` refuses as `volume-ownership-unknown`. Nothing is defaulted. The answer is for the
67
+ * first generation of a claim only: later generations carry that claim's own initialization and
68
+ * ownership, whatever `runAs` says by then. A malformed initialization or `runAs` throws.
69
+ */
70
+ export const deriveServiceVolumeClaimInitialization = (initializationArg, runAsArg) => {
71
+ if (initializationArg === undefined)
72
+ return { status: 'refused', reason: 'volume-initialization-unknown' };
73
+ const errors = validateServiceVolumeInitialization(initializationArg);
74
+ if (errors.length > 0)
75
+ throw new Error(errors[0]);
76
+ if (runAsArg !== null && !(isPlainRecord(runAsArg) && hasExactKeys(runAsArg, ['user', 'group'])
77
+ && isRuntimeIdentityNumber(runAsArg.user) && isRuntimeIdentityNumber(runAsArg.group))) {
78
+ throw new Error('runAs must be null or an exact user and group');
79
+ }
80
+ if (initializationArg.kind === 'import') {
81
+ return { status: 'derived', initialization: 'import', initialOwnership: null };
82
+ }
83
+ const ownership = initializationArg.ownership;
84
+ if (ownership.kind === 'explicit') {
85
+ return { status: 'derived', initialization: 'empty',
86
+ initialOwnership: { uid: ownership.uid, gid: ownership.gid, mode: ownership.mode } };
87
+ }
88
+ if (runAsArg === null)
89
+ return { status: 'refused', reason: 'volume-ownership-unknown' };
90
+ return { status: 'derived', initialization: 'empty',
91
+ initialOwnership: { uid: runAsArg.user, gid: runAsArg.group, mode: ownership.mode } };
92
+ };
93
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VydmljZXZvbHVtZWluaXRpYWxpemF0aW9uLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvZGF0YS9zZXJ2aWNldm9sdW1laW5pdGlhbGl6YXRpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFFLGdDQUFnQyxFQUFFLE1BQU0sK0JBQStCLENBQUM7QUFFakYsT0FBTyxFQUFFLFlBQVksRUFBRSxhQUFhLEVBQUUsTUFBTSw4QkFBOEIsQ0FBQztBQUMzRSxPQUFPLEVBQUUsdUJBQXVCLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQWdFdEUsTUFBTSxDQUFDLE1BQU0sbUNBQW1DLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQztJQUMvRCx3RkFBd0Y7SUFDeEYsaUJBQWlCLEVBQUUsZ0NBQWdDLENBQUMsaUJBQWlCO0lBQ3JFLDZCQUE2QixFQUFFLEdBQUc7Q0FDMUIsQ0FBQyxDQUFDO0FBRVosaUdBQWlHO0FBQ2pHLE1BQU0sdUJBQXVCLEdBQUcsOEJBQThCLENBQUM7QUFFL0QsTUFBTSxlQUFlLEdBQUcsQ0FBQyxRQUFpQixFQUFzQixFQUFFLENBQUMsTUFBTSxDQUFDLGFBQWEsQ0FBQyxRQUFRLENBQUM7T0FDM0YsUUFBbUIsSUFBSSxDQUFDO09BQ3pCLENBQUUsUUFBbUIsR0FBRyxDQUFDLG1DQUFtQyxDQUFDLGlCQUFpQixDQUFDLEtBQUssQ0FBQyxDQUFDO0FBRTNGLE1BQU0saUJBQWlCLEdBQUcsQ0FBQyxRQUFpQixFQUFFLE9BQWUsRUFBWSxFQUFFO0lBQ3pFLElBQUksQ0FBQyxhQUFhLENBQUMsUUFBUSxDQUFDO1FBQUUsT0FBTyxDQUFDLEdBQUcsT0FBTyw0QkFBNEIsQ0FBQyxDQUFDO0lBQzlFLElBQUksUUFBUSxDQUFDLElBQUksS0FBSyxVQUFVLEVBQUUsQ0FBQztRQUNqQyxJQUFJLENBQUMsWUFBWSxDQUFDLFFBQVEsRUFBRSxDQUFDLE1BQU0sRUFBRSxLQUFLLEVBQUUsS0FBSyxFQUFFLE1BQU0sQ0FBQyxDQUFDO1lBQUUsT0FBTyxDQUFDLEdBQUcsT0FBTyw0QkFBNEIsQ0FBQyxDQUFDO1FBQzdHLE1BQU0sTUFBTSxHQUFhLEVBQUUsQ0FBQztRQUM1QixJQUFJLENBQUMsdUJBQXVCLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsdUJBQXVCLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUM7WUFDckYsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLE9BQU8sK0NBQStDLENBQUMsQ0FBQztRQUN6RSxDQUFDO1FBQ0QsSUFBSSxDQUFDLGVBQWUsQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDO1lBQUUsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLE9BQU8sZ0RBQWdELENBQUMsQ0FBQztRQUM3RyxPQUFPLE1BQU0sQ0FBQztJQUNoQixDQUFDO0lBQ0QsSUFBSSxRQUFRLENBQUMsSUFBSSxLQUFLLFFBQVEsRUFBRSxDQUFDO1FBQy9CLElBQUksQ0FBQyxZQUFZLENBQUMsUUFBUSxFQUFFLENBQUMsTUFBTSxFQUFFLE1BQU0sQ0FBQyxDQUFDO1lBQUUsT0FBTyxDQUFDLEdBQUcsT0FBTyw0QkFBNEIsQ0FBQyxDQUFDO1FBQy9GLE9BQU8sZUFBZSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDLEdBQUcsT0FBTyxnREFBZ0QsQ0FBQyxDQUFDO0lBQzVHLENBQUM7SUFDRCxPQUFPLENBQUMsR0FBRyxPQUFPLGtDQUFrQyxDQUFDLENBQUM7QUFDeEQsQ0FBQyxDQUFDO0FBRUYsTUFBTSxvQkFBb0IsR0FBRyxDQUFDLFFBQWlCLEVBQUUsT0FBZSxFQUFZLEVBQUU7SUFDNUUsSUFBSSxDQUFDLGFBQWEsQ0FBQyxRQUFRLENBQUMsSUFBSSxRQUFRLENBQUMsSUFBSSxLQUFLLGVBQWU7V0FDNUQsQ0FBQyxZQUFZLENBQUMsUUFBUSxFQUFFLENBQUMsTUFBTSxFQUFFLFlBQVksQ0FBQyxDQUFDLEVBQUUsQ0FBQztRQUNyRCxPQUFPLENBQUMsR0FBRyxPQUFPLHdDQUF3QyxDQUFDLENBQUM7SUFDOUQsQ0FBQztJQUNELE9BQU8sT0FBTyxRQUFRLENBQUMsVUFBVSxLQUFLLFFBQVE7V0FDekMsUUFBUSxDQUFDLFVBQVUsQ0FBQyxNQUFNLElBQUksbUNBQW1DLENBQUMsNkJBQTZCO1dBQy9GLHVCQUF1QixDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsVUFBVSxDQUFDO1FBQ3BELENBQUMsQ0FBQyxFQUFFO1FBQ0osQ0FBQyxDQUFDLENBQUMsR0FBRyxPQUFPLDBDQUEwQyxDQUFDLENBQUM7QUFDN0QsQ0FBQyxDQUFDO0FBRUYsZ0ZBQWdGO0FBQ2hGLE1BQU0sQ0FBQyxNQUFNLG1DQUFtQyxHQUFHLENBQ2pELFFBQWlCLEVBQ2pCLE9BQU8sR0FBRywrQkFBK0IsRUFDL0IsRUFBRTtJQUNaLElBQUksQ0FBQyxhQUFhLENBQUMsUUFBUSxDQUFDO1FBQUUsT0FBTyxDQUFDLEdBQUcsT0FBTyw0QkFBNEIsQ0FBQyxDQUFDO0lBQzlFLElBQUksUUFBUSxDQUFDLElBQUksS0FBSyxPQUFPLEVBQUUsQ0FBQztRQUM5QixJQUFJLENBQUMsWUFBWSxDQUFDLFFBQVEsRUFBRSxDQUFDLE1BQU0sRUFBRSxXQUFXLENBQUMsQ0FBQztZQUFFLE9BQU8sQ0FBQyxHQUFHLE9BQU8sNEJBQTRCLENBQUMsQ0FBQztRQUNwRyxPQUFPLGlCQUFpQixDQUFDLFFBQVEsQ0FBQyxTQUFTLEVBQUUsR0FBRyxPQUFPLFlBQVksQ0FBQyxDQUFDO0lBQ3ZFLENBQUM7SUFDRCxJQUFJLFFBQVEsQ0FBQyxJQUFJLEtBQUssUUFBUSxFQUFFLENBQUM7UUFDL0IsSUFBSSxDQUFDLFlBQVksQ0FBQyxRQUFRLEVBQUUsQ0FBQyxNQUFNLEVBQUUsUUFBUSxDQUFDLENBQUM7WUFBRSxPQUFPLENBQUMsR0FBRyxPQUFPLDRCQUE0QixDQUFDLENBQUM7UUFDakcsT0FBTyxvQkFBb0IsQ0FBQyxRQUFRLENBQUMsTUFBTSxFQUFFLEdBQUcsT0FBTyxTQUFTLENBQUMsQ0FBQztJQUNwRSxDQUFDO0lBQ0QsT0FBTyxDQUFDLEdBQUcsT0FBTywrQkFBK0IsQ0FBQyxDQUFDO0FBQ3JELENBQUMsQ0FBQztBQUVGOzs7Ozs7O0dBT0c7QUFDSCxNQUFNLENBQUMsTUFBTSxzQ0FBc0MsR0FBRyxDQUNwRCxpQkFBMkQsRUFDM0QsUUFBeUMsRUFDTixFQUFFO0lBQ3JDLElBQUksaUJBQWlCLEtBQUssU0FBUztRQUFFLE9BQU8sRUFBRSxNQUFNLEVBQUUsU0FBUyxFQUFFLE1BQU0sRUFBRSwrQkFBK0IsRUFBRSxDQUFDO0lBQzNHLE1BQU0sTUFBTSxHQUFHLG1DQUFtQyxDQUFDLGlCQUFpQixDQUFDLENBQUM7SUFDdEUsSUFBSSxNQUFNLENBQUMsTUFBTSxHQUFHLENBQUM7UUFBRSxNQUFNLElBQUksS0FBSyxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ2xELElBQUksUUFBUSxLQUFLLElBQUksSUFBSSxDQUFDLENBQUMsYUFBYSxDQUFDLFFBQVEsQ0FBQyxJQUFJLFlBQVksQ0FBQyxRQUFRLEVBQUUsQ0FBQyxNQUFNLEVBQUUsT0FBTyxDQUFDLENBQUM7V0FDMUYsdUJBQXVCLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxJQUFJLHVCQUF1QixDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUMsQ0FBQyxFQUFFLENBQUM7UUFDeEYsTUFBTSxJQUFJLEtBQUssQ0FBQywrQ0FBK0MsQ0FBQyxDQUFDO0lBQ25FLENBQUM7SUFDRCxJQUFJLGlCQUFpQixDQUFDLElBQUksS0FBSyxRQUFRLEVBQUUsQ0FBQztRQUN4QyxPQUFPLEVBQUUsTUFBTSxFQUFFLFNBQVMsRUFBRSxjQUFjLEVBQUUsUUFBUSxFQUFFLGdCQUFnQixFQUFFLElBQUksRUFBRSxDQUFDO0lBQ2pGLENBQUM7SUFDRCxNQUFNLFNBQVMsR0FBRyxpQkFBaUIsQ0FBQyxTQUFTLENBQUM7SUFDOUMsSUFBSSxTQUFTLENBQUMsSUFBSSxLQUFLLFVBQVUsRUFBRSxDQUFDO1FBQ2xDLE9BQU8sRUFBRSxNQUFNLEVBQUUsU0FBUyxFQUFFLGNBQWMsRUFBRSxPQUFPO1lBQ2pELGdCQUFnQixFQUFFLEVBQUUsR0FBRyxFQUFFLFNBQVMsQ0FBQyxHQUFHLEVBQUUsR0FBRyxFQUFFLFNBQVMsQ0FBQyxHQUFHLEVBQUUsSUFBSSxFQUFFLFNBQVMsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUFDO0lBQ3pGLENBQUM7SUFDRCxJQUFJLFFBQVEsS0FBSyxJQUFJO1FBQUUsT0FBTyxFQUFFLE1BQU0sRUFBRSxTQUFTLEVBQUUsTUFBTSxFQUFFLDBCQUEwQixFQUFFLENBQUM7SUFDeEYsT0FBTyxFQUFFLE1BQU0sRUFBRSxTQUFTLEVBQUUsY0FBYyxFQUFFLE9BQU87UUFDakQsZ0JBQWdCLEVBQUUsRUFBRSxHQUFHLEVBQUUsUUFBUSxDQUFDLElBQUksRUFBRSxHQUFHLEVBQUUsUUFBUSxDQUFDLEtBQUssRUFBRSxJQUFJLEVBQUUsU0FBUyxDQUFDLElBQUksRUFBRSxFQUFFLENBQUM7QUFDMUYsQ0FBQyxDQUFDIn0=
@@ -4,6 +4,31 @@ export type TPlatformCapability = 'email' | 'sms' | 'pushnotification' | 'letter
4
4
  export type TPlatformAccessMode = 'rpc' | 'binding' | 'sidecar' | 'internal';
5
5
  export type TPlatformBindingStatus = 'requested' | 'provisioning' | 'ready' | 'degraded' | 'failed' | 'disabled';
6
6
  export type TPlatformDesiredState = 'enabled' | 'disabled';
7
+ export declare const platformBindingStatusReasons: readonly ["legacy-adoption-pending", "legacy-adoption-conflict", "legacy-adoption-mismatch"];
8
+ /**
9
+ * Why a binding holds the status it reports, where the status alone does not say.
10
+ *
11
+ * All three come from Corestore's refusal of a credential binding beside a legacy
12
+ * `/resources/provision` resource (`code` in its 409 body, read with
13
+ * `readCorestoreLegacyAdoptionRefusal`):
14
+ *
15
+ * - `legacy-adoption-pending` (status `provisioning`): the service owns a legacy resource of this
16
+ * capability that no offline adoption authorizes yet. It clears when the operator runs
17
+ * Corestore's adoption with the plan Cloudly produced.
18
+ * - `legacy-adoption-conflict` (status `failed`): the adoption authorizes another binding id, or
19
+ * it was already consumed.
20
+ * - `legacy-adoption-mismatch` (status `failed`): the legacy resource is no longer the one the
21
+ * adoption authorized, its database tenant is absent, or the binding's bucket or retention
22
+ * intent differs from the legacy bucket's.
23
+ */
24
+ export type TPlatformBindingStatusReason = typeof platformBindingStatusReasons[number];
25
+ /** The one status each reason is reported with. */
26
+ export declare const getPlatformBindingStatusOfReason: (reasonArg: TPlatformBindingStatusReason) => TPlatformBindingStatus;
27
+ /**
28
+ * Validates a reported status and its optional reason: a reason must be a member of the
29
+ * vocabulary and come with its one status. An absent reason is valid with every status.
30
+ */
31
+ export declare const validatePlatformBindingStatusReason: (statusArg: unknown, reasonArg: unknown, pathArg?: string) => string[];
7
32
  export type TPlatformEndpointProtocol = 'typedrequest' | 'http' | 'tcp' | 'udp' | 'smtp' | 's3' | 'postgres' | 'mongodb' | 'sip';
8
33
  export interface IPlatformCapability {
9
34
  id: TPlatformCapability;
@@ -30,6 +55,22 @@ export interface IPlatformServiceEndpoint {
30
55
  networkAlias?: string;
31
56
  port?: number;
32
57
  }
58
+ /**
59
+ * The legacy Corestore resource an object-storage or database binding adopts.
60
+ *
61
+ * Server-managed: only `adoptCorestoreLegacyResources` writes it, in the same write that creates
62
+ * the binding, and Cloudly refuses it (and `objectstorageBucketName`) on `upsertPlatformBinding`.
63
+ * `nodeId` is the node whose Corestore holds the resource, so the binding is placed there and
64
+ * nowhere else; `resourceName` is the legacy database or bucket name; `inventorySha256` is the
65
+ * legacy inventory the adoption was checked against. An adopted bucket's
66
+ * `objectstorageBucketName` is the legacy bucket and its `objectstorageRetention.intent` the legacy
67
+ * intent exactly, or absent when the legacy bucket has none.
68
+ */
69
+ export interface IPlatformBindingCorestoreLegacyAdoption {
70
+ nodeId: string;
71
+ resourceName: string;
72
+ inventorySha256: string;
73
+ }
33
74
  export interface IPlatformBinding {
34
75
  id: string;
35
76
  serviceId: string;
@@ -44,6 +85,10 @@ export interface IPlatformBinding {
44
85
  objectstorageBucketName?: string;
45
86
  /** Capability-specific value-free immutable-retention intent and evidence. */
46
87
  objectstorageRetention?: IObjectStorageRetentionBinding;
88
+ /** Server-managed: the legacy Corestore resource this binding adopts. */
89
+ corestoreLegacyAdoption?: IPlatformBindingCorestoreLegacyAdoption;
90
+ /** Why the binding holds its status, as the responsible cluster reported it. */
91
+ statusReason?: TPlatformBindingStatusReason;
47
92
  createdAt?: number;
48
93
  updatedAt?: number;
49
94
  }
@@ -1,2 +1,27 @@
1
- export {};
2
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9wbGF0Zm9ybS90eXBlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=
1
+ export const platformBindingStatusReasons = [
2
+ 'legacy-adoption-pending',
3
+ 'legacy-adoption-conflict',
4
+ 'legacy-adoption-mismatch',
5
+ ];
6
+ const platformBindingStatusOfReason = Object.freeze({
7
+ 'legacy-adoption-pending': 'provisioning',
8
+ 'legacy-adoption-conflict': 'failed',
9
+ 'legacy-adoption-mismatch': 'failed',
10
+ });
11
+ /** The one status each reason is reported with. */
12
+ export const getPlatformBindingStatusOfReason = (reasonArg) => platformBindingStatusOfReason[reasonArg];
13
+ /**
14
+ * Validates a reported status and its optional reason: a reason must be a member of the
15
+ * vocabulary and come with its one status. An absent reason is valid with every status.
16
+ */
17
+ export const validatePlatformBindingStatusReason = (statusArg, reasonArg, pathArg = 'platform binding statusReason') => {
18
+ if (reasonArg === undefined)
19
+ return [];
20
+ if (!platformBindingStatusReasons.includes(reasonArg)) {
21
+ return [`${pathArg} must be a platform binding status reason`];
22
+ }
23
+ return platformBindingStatusOfReason[reasonArg] === statusArg
24
+ ? []
25
+ : [`${pathArg} ${reasonArg} requires status ${platformBindingStatusOfReason[reasonArg]}`];
26
+ };
27
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9wbGF0Zm9ybS90eXBlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFtQkEsTUFBTSxDQUFDLE1BQU0sNEJBQTRCLEdBQUc7SUFDMUMseUJBQXlCO0lBQ3pCLDBCQUEwQjtJQUMxQiwwQkFBMEI7Q0FDbEIsQ0FBQztBQW9CWCxNQUFNLDZCQUE2QixHQUNqQyxNQUFNLENBQUMsTUFBTSxDQUFDO0lBQ1oseUJBQXlCLEVBQUUsY0FBYztJQUN6QywwQkFBMEIsRUFBRSxRQUFRO0lBQ3BDLDBCQUEwQixFQUFFLFFBQVE7Q0FDckMsQ0FBQyxDQUFDO0FBRUwsbURBQW1EO0FBQ25ELE1BQU0sQ0FBQyxNQUFNLGdDQUFnQyxHQUFHLENBQzlDLFNBQXVDLEVBQ2YsRUFBRSxDQUFDLDZCQUE2QixDQUFDLFNBQVMsQ0FBQyxDQUFDO0FBRXRFOzs7R0FHRztBQUNILE1BQU0sQ0FBQyxNQUFNLG1DQUFtQyxHQUFHLENBQ2pELFNBQWtCLEVBQ2xCLFNBQWtCLEVBQ2xCLE9BQU8sR0FBRywrQkFBK0IsRUFDL0IsRUFBRTtJQUNaLElBQUksU0FBUyxLQUFLLFNBQVM7UUFBRSxPQUFPLEVBQUUsQ0FBQztJQUN2QyxJQUFJLENBQUUsNEJBQW1ELENBQUMsUUFBUSxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUM7UUFDOUUsT0FBTyxDQUFDLEdBQUcsT0FBTywyQ0FBMkMsQ0FBQyxDQUFDO0lBQ2pFLENBQUM7SUFDRCxPQUFPLDZCQUE2QixDQUFDLFNBQXlDLENBQUMsS0FBSyxTQUFTO1FBQzNGLENBQUMsQ0FBQyxFQUFFO1FBQ0osQ0FBQyxDQUFDLENBQUMsR0FBRyxPQUFPLElBQUksU0FBbUIsb0JBQW9CLDZCQUE2QixDQUFDLFNBQXlDLENBQUMsRUFBRSxDQUFDLENBQUM7QUFDeEksQ0FBQyxDQUFDIn0=
@@ -1,5 +1,7 @@
1
1
  import * as plugins from '../plugins.js';
2
2
  import type { IIdentity } from '../data/user.js';
3
+ import type { ICorestoreLegacyResourceAdoptionPlanEntry, ICorestoreLegacyResourceSelection, TClusterCorestoreLegacyResourceInventory } from '../data/corestorelegacyadoption.js';
4
+ import type { IPlatformBinding } from '../platform/types.js';
3
5
  /**
4
6
  * A provisioned corestore resource (NoSQLDB database or ObjectStorage bucket)
5
7
  * as reported by a node's corestore control API.
@@ -131,3 +133,61 @@ export interface IReq_Cloudly_Coreflow_GetCorestoreInventory extends plugins.typ
131
133
  inventory: ICorestoreNodeInventory;
132
134
  };
133
135
  }
136
+ /**
137
+ * Cloudly asks the relay for one exact node's legacy Corestore resources.
138
+ *
139
+ * The relay reads Corestore's `corestoreLegacyAdoptionContract.inventoryPath` with the control
140
+ * token and answers `reachable: true` with its services, or `reachable: false` with the reason, never
141
+ * an empty list for a node it could not read.
142
+ */
143
+ export interface IReq_Cloudly_Relay_GetClusterCorestoreLegacyResources extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_Relay_GetClusterCorestoreLegacyResources> {
144
+ method: 'getClusterCorestoreLegacyResources';
145
+ request: {
146
+ nodeId: string;
147
+ };
148
+ response: {
149
+ inventory: TClusterCorestoreLegacyResourceInventory;
150
+ };
151
+ }
152
+ /**
153
+ * An administrator reads one node's legacy Corestore resources through its cluster's relay, with
154
+ * the digest an adoption is checked against (`null` for an unreachable node).
155
+ */
156
+ export interface IReq_Any_Cloudly_GetCorestoreLegacyResources extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_Cloudly_GetCorestoreLegacyResources> {
157
+ method: 'getCorestoreLegacyResources';
158
+ request: {
159
+ identity: IIdentity;
160
+ clusterId: string;
161
+ nodeId: string;
162
+ };
163
+ response: {
164
+ inventory: TClusterCorestoreLegacyResourceInventory;
165
+ inventorySha256: string | null;
166
+ };
167
+ }
168
+ /**
169
+ * The only path that creates a binding carrying a legacy bucket name.
170
+ *
171
+ * Cloudly reads the node's legacy inventory again, requires `expectedInventorySha256`, and for
172
+ * each selected resource creates the adopting binding in one transaction: enabled, placed on
173
+ * `nodeId`, with `corestoreLegacyAdoption`, and for a bucket the legacy bucket name and retention
174
+ * intent (`validatePlatformBindingCorestoreLegacyAdoption`). A resource whose adopting binding
175
+ * already exists is answered unchanged. The response lists the adopting bindings and the plan
176
+ * (`createCorestoreLegacyResourceAdoptionPlan`) the operator hands to Corestore's offline
177
+ * `legacy-resource-adoption` migration. Refusals travel as `ICorestoreLegacyAdoptionErrorData`.
178
+ */
179
+ export interface IReq_Any_Cloudly_AdoptCorestoreLegacyResources extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_Cloudly_AdoptCorestoreLegacyResources> {
180
+ method: 'adoptCorestoreLegacyResources';
181
+ request: {
182
+ identity: IIdentity;
183
+ clusterId: string;
184
+ nodeId: string;
185
+ expectedInventorySha256: string;
186
+ /** Sorted by service then capability (`validateCorestoreLegacyResourceSelections`). */
187
+ resources: ICorestoreLegacyResourceSelection[];
188
+ };
189
+ response: {
190
+ bindings: IPlatformBinding[];
191
+ plan: ICorestoreLegacyResourceAdoptionPlanEntry[];
192
+ };
193
+ }
@@ -96,4 +96,4 @@ export const validateClusterCorestoreInventory = (valueArg, pathArg = 'cluster c
96
96
  }
97
97
  return errors;
98
98
  };
99
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29yZXN0b3JlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvcmVxdWVzdHMvY29yZXN0b3JlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDO0FBRXpDLE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSw4QkFBOEIsQ0FBQztBQUM1RCxPQUFPLEVBQUUsZUFBZSxFQUFFLE1BQU0sOEJBQThCLENBQUM7QUF3Ry9ELE1BQU0sMENBQTBDLEdBQUcscUNBQXFDLENBQUM7QUFFekYsTUFBTSx3QkFBd0IsR0FBRyxDQUMvQixRQUFpQixFQUNvQixFQUFFLENBQUMsQ0FDeEMsT0FBTyxDQUFDLFFBQVEsQ0FBQztPQUNkLE9BQU8sUUFBUSxLQUFLLFFBQVE7T0FDNUIsQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQztPQUN4QixDQUFDLE1BQU0sQ0FBQyxjQUFjLENBQUMsUUFBUSxDQUFDLEtBQUssTUFBTSxDQUFDLFNBQVM7V0FDbkQsTUFBTSxDQUFDLGNBQWMsQ0FBQyxRQUFRLENBQUMsS0FBSyxJQUFJLENBQUMsQ0FDL0MsQ0FBQztBQUVGLE1BQU0sd0NBQXdDLEdBQUcsQ0FDL0MsUUFBaUIsRUFDakIsT0FBZSxFQUNMLEVBQUU7SUFDWixJQUFJLENBQUMsd0JBQXdCLENBQUMsUUFBUSxDQUFDO1dBQ2xDLENBQUMsWUFBWSxDQUNkLFFBQVEsRUFDUixDQUFDLFdBQVcsRUFBRSxXQUFXLEVBQUUsV0FBVyxDQUFDLEVBQ3ZDLENBQUMsYUFBYSxDQUFDLENBQ2hCLEVBQUUsQ0FBQztRQUNKLE9BQU8sQ0FBQyxHQUFHLE9BQU8sNEJBQTRCLENBQUMsQ0FBQztJQUNsRCxDQUFDO0lBQ0QsTUFBTSxNQUFNLEdBQWEsRUFBRSxDQUFDO0lBQzVCLElBQUksT0FBTyxRQUFRLENBQUMsU0FBUyxLQUFLLFFBQVE7V0FDckMsQ0FBQywwQ0FBMEMsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUM7UUFDMUUsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLE9BQU8seUNBQXlDLENBQUMsQ0FBQztJQUNuRSxDQUFDO0lBQ0QsSUFBSSxDQUFDLE1BQU0sQ0FBQyxhQUFhLENBQUMsUUFBUSxDQUFDLFNBQVMsQ0FBQyxJQUFLLFFBQVEsQ0FBQyxTQUFvQixHQUFHLENBQUMsRUFBRSxDQUFDO1FBQ3BGLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxPQUFPLGdEQUFnRCxDQUFDLENBQUM7SUFDMUUsQ0FBQztJQUNELElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDO1FBQ3ZDLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxPQUFPLDZCQUE2QixDQUFDLENBQUM7UUFDckQsT0FBTyxNQUFNLENBQUM7SUFDaEIsQ0FBQztJQUNELEtBQUssTUFBTSxDQUFDLEtBQUssRUFBRSxRQUFRLENBQUMsSUFBSSxRQUFRLENBQUMsU0FBUyxDQUFDLE9BQU8sRUFBRSxFQUFFLENBQUM7UUFDN0QsTUFBTSxZQUFZLEdBQUcsR0FBRyxPQUFPLGNBQWMsS0FBSyxHQUFHLENBQUM7UUFDdEQsSUFBSSxDQUFDLHdCQUF3QixDQUFDLFFBQVEsQ0FBQztlQUNsQyxDQUFDLFlBQVksQ0FDZCxRQUFRLEVBQ1IsQ0FBQyxZQUFZLEVBQUUsVUFBVSxFQUFFLGNBQWMsRUFBRSxXQUFXLENBQUMsQ0FDeEQsRUFBRSxDQUFDO1lBQ0osTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLFlBQVksNEJBQTRCLENBQUMsQ0FBQztZQUN6RCxTQUFTO1FBQ1gsQ0FBQztRQUNELElBQUksUUFBUSxDQUFDLFVBQVUsS0FBSyxVQUFVLElBQUksUUFBUSxDQUFDLFVBQVUsS0FBSyxlQUFlLEVBQUUsQ0FBQztZQUNsRixNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsWUFBWSwrQ0FBK0MsQ0FBQyxDQUFDO1FBQzlFLENBQUM7UUFDRCxJQUFJLE9BQU8sUUFBUSxDQUFDLFFBQVEsS0FBSyxRQUFRLElBQUksUUFBUSxDQUFDLFFBQVEsQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFLENBQUM7WUFDNUUsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLFlBQVksc0NBQXNDLENBQUMsQ0FBQztRQUNyRSxDQUFDO1FBQ0QsSUFBSSxPQUFPLFFBQVEsQ0FBQyxZQUFZLEtBQUssUUFBUSxJQUFJLFFBQVEsQ0FBQyxZQUFZLENBQUMsTUFBTSxLQUFLLENBQUMsRUFBRSxDQUFDO1lBQ3BGLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxZQUFZLDBDQUEwQyxDQUFDLENBQUM7UUFDekUsQ0FBQztRQUNELElBQUksQ0FBQyxNQUFNLENBQUMsYUFBYSxDQUFDLFFBQVEsQ0FBQyxTQUFTLENBQUMsSUFBSyxRQUFRLENBQUMsU0FBb0IsR0FBRyxDQUFDLEVBQUUsQ0FBQztZQUNwRixNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsWUFBWSxnREFBZ0QsQ0FBQyxDQUFDO1FBQy9FLENBQUM7SUFDSCxDQUFDO0lBQ0QsT0FBTyxNQUFNLENBQUM7QUFDaEIsQ0FBQyxDQUFDO0FBRUY7Ozs7Ozs7OztHQVNHO0FBQ0gsTUFBTSxDQUFDLE1BQU0saUNBQWlDLEdBQUcsQ0FDL0MsUUFBaUIsRUFDakIsT0FBTyxHQUFHLDZCQUE2QixFQUM3QixFQUFFO0lBQ1osSUFBSSxDQUFDLHdCQUF3QixDQUFDLFFBQVEsQ0FBQztXQUNsQyxDQUFDLFlBQVksQ0FDZCxRQUFRLEVBQ1IsQ0FBQyxRQUFRLEVBQUUsV0FBVyxFQUFFLFdBQVcsRUFBRSxVQUFVLENBQUMsRUFDaEQsQ0FBQyxXQUFXLENBQUMsQ0FDZCxFQUFFLENBQUM7UUFDSixPQUFPLENBQUMsR0FBRyxPQUFPLDRCQUE0QixDQUFDLENBQUM7SUFDbEQsQ0FBQztJQUNELE1BQU0sTUFBTSxHQUFhLEVBQUUsQ0FBQztJQUM1QixJQUFJLENBQUMsZUFBZSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDO1FBQ3RDLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxPQUFPLDJCQUEyQixDQUFDLENBQUM7SUFDckQsQ0FBQztJQUNELElBQUksQ0FBQyxNQUFNLENBQUMsYUFBYSxDQUFDLFFBQVEsQ0FBQyxTQUFTLENBQUMsSUFBSyxRQUFRLENBQUMsU0FBb0IsR0FBRyxDQUFDLEVBQUUsQ0FBQztRQUNwRixNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsT0FBTyxnREFBZ0QsQ0FBQyxDQUFDO0lBQzFFLENBQUM7SUFDRCxJQUFJLE9BQU8sUUFBUSxDQUFDLFNBQVMsS0FBSyxTQUFTLEVBQUUsQ0FBQztRQUM1QyxNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsT0FBTyw4QkFBOEIsQ0FBQyxDQUFDO0lBQ3hELENBQUM7SUFDRCxJQUFJLFFBQVEsQ0FBQyxTQUFTLEtBQUssU0FBUztXQUMvQixRQUFRLENBQUMsU0FBUyxLQUFLLDRCQUE0QjtXQUNuRCxRQUFRLENBQUMsU0FBUyxLQUFLLHVCQUF1QixFQUFFLENBQUM7UUFDcEQsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLE9BQU8scURBQXFELENBQUMsQ0FBQztJQUMvRSxDQUFDO0lBQ0QsSUFBSSxRQUFRLENBQUMsU0FBUyxLQUFLLElBQUksSUFBSSxRQUFRLENBQUMsU0FBUyxLQUFLLFNBQVMsRUFBRSxDQUFDO1FBQ3BFLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxPQUFPLGtFQUFrRSxDQUFDLENBQUM7SUFDNUYsQ0FBQztJQUNELElBQUksUUFBUSxDQUFDLFNBQVMsS0FBSyxLQUFLLElBQUksUUFBUSxDQUFDLFNBQVMsS0FBSyxTQUFTLEVBQUUsQ0FBQztRQUNyRSx3RUFBd0U7UUFDeEUsMkRBQTJEO1FBQzNELE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxPQUFPLDJFQUEyRSxDQUFDLENBQUM7SUFDckcsQ0FBQztJQUNELElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxRQUFRLENBQUMsRUFBRSxDQUFDO1FBQ3RDLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxPQUFPLDRCQUE0QixDQUFDLENBQUM7UUFDcEQsT0FBTyxNQUFNLENBQUM7SUFDaEIsQ0FBQztJQUNELElBQUksUUFBUSxDQUFDLFNBQVMsS0FBSyxLQUFLLElBQUksUUFBUSxDQUFDLFFBQVEsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFLENBQUM7UUFDakUsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLE9BQU8sOERBQThELENBQUMsQ0FBQztJQUN4RixDQUFDO0lBQ0QsS0FBSyxNQUFNLENBQUMsS0FBSyxFQUFFLE9BQU8sQ0FBQyxJQUFJLFFBQVEsQ0FBQyxRQUFRLENBQUMsT0FBTyxFQUFFLEVBQUUsQ0FBQztRQUMzRCxNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsd0NBQXdDLENBQUMsT0FBTyxFQUFFLEdBQUcsT0FBTyxhQUFhLEtBQUssR0FBRyxDQUFDLENBQUMsQ0FBQztJQUNyRyxDQUFDO0lBQ0QsT0FBTyxNQUFNLENBQUM7QUFDaEIsQ0FBQyxDQUFDIn0=
99
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29yZXN0b3JlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvcmVxdWVzdHMvY29yZXN0b3JlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDO0FBUXpDLE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSw4QkFBOEIsQ0FBQztBQUM1RCxPQUFPLEVBQUUsZUFBZSxFQUFFLE1BQU0sOEJBQThCLENBQUM7QUF3Ry9ELE1BQU0sMENBQTBDLEdBQUcscUNBQXFDLENBQUM7QUFFekYsTUFBTSx3QkFBd0IsR0FBRyxDQUMvQixRQUFpQixFQUNvQixFQUFFLENBQUMsQ0FDeEMsT0FBTyxDQUFDLFFBQVEsQ0FBQztPQUNkLE9BQU8sUUFBUSxLQUFLLFFBQVE7T0FDNUIsQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQztPQUN4QixDQUFDLE1BQU0sQ0FBQyxjQUFjLENBQUMsUUFBUSxDQUFDLEtBQUssTUFBTSxDQUFDLFNBQVM7V0FDbkQsTUFBTSxDQUFDLGNBQWMsQ0FBQyxRQUFRLENBQUMsS0FBSyxJQUFJLENBQUMsQ0FDL0MsQ0FBQztBQUVGLE1BQU0sd0NBQXdDLEdBQUcsQ0FDL0MsUUFBaUIsRUFDakIsT0FBZSxFQUNMLEVBQUU7SUFDWixJQUFJLENBQUMsd0JBQXdCLENBQUMsUUFBUSxDQUFDO1dBQ2xDLENBQUMsWUFBWSxDQUNkLFFBQVEsRUFDUixDQUFDLFdBQVcsRUFBRSxXQUFXLEVBQUUsV0FBVyxDQUFDLEVBQ3ZDLENBQUMsYUFBYSxDQUFDLENBQ2hCLEVBQUUsQ0FBQztRQUNKLE9BQU8sQ0FBQyxHQUFHLE9BQU8sNEJBQTRCLENBQUMsQ0FBQztJQUNsRCxDQUFDO0lBQ0QsTUFBTSxNQUFNLEdBQWEsRUFBRSxDQUFDO0lBQzVCLElBQUksT0FBTyxRQUFRLENBQUMsU0FBUyxLQUFLLFFBQVE7V0FDckMsQ0FBQywwQ0FBMEMsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUM7UUFDMUUsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLE9BQU8seUNBQXlDLENBQUMsQ0FBQztJQUNuRSxDQUFDO0lBQ0QsSUFBSSxDQUFDLE1BQU0sQ0FBQyxhQUFhLENBQUMsUUFBUSxDQUFDLFNBQVMsQ0FBQyxJQUFLLFFBQVEsQ0FBQyxTQUFvQixHQUFHLENBQUMsRUFBRSxDQUFDO1FBQ3BGLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxPQUFPLGdEQUFnRCxDQUFDLENBQUM7SUFDMUUsQ0FBQztJQUNELElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDO1FBQ3ZDLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxPQUFPLDZCQUE2QixDQUFDLENBQUM7UUFDckQsT0FBTyxNQUFNLENBQUM7SUFDaEIsQ0FBQztJQUNELEtBQUssTUFBTSxDQUFDLEtBQUssRUFBRSxRQUFRLENBQUMsSUFBSSxRQUFRLENBQUMsU0FBUyxDQUFDLE9BQU8sRUFBRSxFQUFFLENBQUM7UUFDN0QsTUFBTSxZQUFZLEdBQUcsR0FBRyxPQUFPLGNBQWMsS0FBSyxHQUFHLENBQUM7UUFDdEQsSUFBSSxDQUFDLHdCQUF3QixDQUFDLFFBQVEsQ0FBQztlQUNsQyxDQUFDLFlBQVksQ0FDZCxRQUFRLEVBQ1IsQ0FBQyxZQUFZLEVBQUUsVUFBVSxFQUFFLGNBQWMsRUFBRSxXQUFXLENBQUMsQ0FDeEQsRUFBRSxDQUFDO1lBQ0osTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLFlBQVksNEJBQTRCLENBQUMsQ0FBQztZQUN6RCxTQUFTO1FBQ1gsQ0FBQztRQUNELElBQUksUUFBUSxDQUFDLFVBQVUsS0FBSyxVQUFVLElBQUksUUFBUSxDQUFDLFVBQVUsS0FBSyxlQUFlLEVBQUUsQ0FBQztZQUNsRixNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsWUFBWSwrQ0FBK0MsQ0FBQyxDQUFDO1FBQzlFLENBQUM7UUFDRCxJQUFJLE9BQU8sUUFBUSxDQUFDLFFBQVEsS0FBSyxRQUFRLElBQUksUUFBUSxDQUFDLFFBQVEsQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFLENBQUM7WUFDNUUsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLFlBQVksc0NBQXNDLENBQUMsQ0FBQztRQUNyRSxDQUFDO1FBQ0QsSUFBSSxPQUFPLFFBQVEsQ0FBQyxZQUFZLEtBQUssUUFBUSxJQUFJLFFBQVEsQ0FBQyxZQUFZLENBQUMsTUFBTSxLQUFLLENBQUMsRUFBRSxDQUFDO1lBQ3BGLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxZQUFZLDBDQUEwQyxDQUFDLENBQUM7UUFDekUsQ0FBQztRQUNELElBQUksQ0FBQyxNQUFNLENBQUMsYUFBYSxDQUFDLFFBQVEsQ0FBQyxTQUFTLENBQUMsSUFBSyxRQUFRLENBQUMsU0FBb0IsR0FBRyxDQUFDLEVBQUUsQ0FBQztZQUNwRixNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsWUFBWSxnREFBZ0QsQ0FBQyxDQUFDO1FBQy9FLENBQUM7SUFDSCxDQUFDO0lBQ0QsT0FBTyxNQUFNLENBQUM7QUFDaEIsQ0FBQyxDQUFDO0FBRUY7Ozs7Ozs7OztHQVNHO0FBQ0gsTUFBTSxDQUFDLE1BQU0saUNBQWlDLEdBQUcsQ0FDL0MsUUFBaUIsRUFDakIsT0FBTyxHQUFHLDZCQUE2QixFQUM3QixFQUFFO0lBQ1osSUFBSSxDQUFDLHdCQUF3QixDQUFDLFFBQVEsQ0FBQztXQUNsQyxDQUFDLFlBQVksQ0FDZCxRQUFRLEVBQ1IsQ0FBQyxRQUFRLEVBQUUsV0FBVyxFQUFFLFdBQVcsRUFBRSxVQUFVLENBQUMsRUFDaEQsQ0FBQyxXQUFXLENBQUMsQ0FDZCxFQUFFLENBQUM7UUFDSixPQUFPLENBQUMsR0FBRyxPQUFPLDRCQUE0QixDQUFDLENBQUM7SUFDbEQsQ0FBQztJQUNELE1BQU0sTUFBTSxHQUFhLEVBQUUsQ0FBQztJQUM1QixJQUFJLENBQUMsZUFBZSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDO1FBQ3RDLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxPQUFPLDJCQUEyQixDQUFDLENBQUM7SUFDckQsQ0FBQztJQUNELElBQUksQ0FBQyxNQUFNLENBQUMsYUFBYSxDQUFDLFFBQVEsQ0FBQyxTQUFTLENBQUMsSUFBSyxRQUFRLENBQUMsU0FBb0IsR0FBRyxDQUFDLEVBQUUsQ0FBQztRQUNwRixNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsT0FBTyxnREFBZ0QsQ0FBQyxDQUFDO0lBQzFFLENBQUM7SUFDRCxJQUFJLE9BQU8sUUFBUSxDQUFDLFNBQVMsS0FBSyxTQUFTLEVBQUUsQ0FBQztRQUM1QyxNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsT0FBTyw4QkFBOEIsQ0FBQyxDQUFDO0lBQ3hELENBQUM7SUFDRCxJQUFJLFFBQVEsQ0FBQyxTQUFTLEtBQUssU0FBUztXQUMvQixRQUFRLENBQUMsU0FBUyxLQUFLLDRCQUE0QjtXQUNuRCxRQUFRLENBQUMsU0FBUyxLQUFLLHVCQUF1QixFQUFFLENBQUM7UUFDcEQsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLE9BQU8scURBQXFELENBQUMsQ0FBQztJQUMvRSxDQUFDO0lBQ0QsSUFBSSxRQUFRLENBQUMsU0FBUyxLQUFLLElBQUksSUFBSSxRQUFRLENBQUMsU0FBUyxLQUFLLFNBQVMsRUFBRSxDQUFDO1FBQ3BFLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxPQUFPLGtFQUFrRSxDQUFDLENBQUM7SUFDNUYsQ0FBQztJQUNELElBQUksUUFBUSxDQUFDLFNBQVMsS0FBSyxLQUFLLElBQUksUUFBUSxDQUFDLFNBQVMsS0FBSyxTQUFTLEVBQUUsQ0FBQztRQUNyRSx3RUFBd0U7UUFDeEUsMkRBQTJEO1FBQzNELE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxPQUFPLDJFQUEyRSxDQUFDLENBQUM7SUFDckcsQ0FBQztJQUNELElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxRQUFRLENBQUMsRUFBRSxDQUFDO1FBQ3RDLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxPQUFPLDRCQUE0QixDQUFDLENBQUM7UUFDcEQsT0FBTyxNQUFNLENBQUM7SUFDaEIsQ0FBQztJQUNELElBQUksUUFBUSxDQUFDLFNBQVMsS0FBSyxLQUFLLElBQUksUUFBUSxDQUFDLFFBQVEsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFLENBQUM7UUFDakUsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLE9BQU8sOERBQThELENBQUMsQ0FBQztJQUN4RixDQUFDO0lBQ0QsS0FBSyxNQUFNLENBQUMsS0FBSyxFQUFFLE9BQU8sQ0FBQyxJQUFJLFFBQVEsQ0FBQyxRQUFRLENBQUMsT0FBTyxFQUFFLEVBQUUsQ0FBQztRQUMzRCxNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsd0NBQXdDLENBQUMsT0FBTyxFQUFFLEdBQUcsT0FBTyxhQUFhLEtBQUssR0FBRyxDQUFDLENBQUMsQ0FBQztJQUNyRyxDQUFDO0lBQ0QsT0FBTyxNQUFNLENBQUM7QUFDaEIsQ0FBQyxDQUFDIn0=
@@ -1,6 +1,6 @@
1
1
  import * as plugins from '../plugins.js';
2
2
  import type { IIdentity } from '../data/user.js';
3
- import type { IPlatformBinding, IPlatformCapability, IPlatformProviderConfig, TPlatformBindingStatus } from '../platform/types.js';
3
+ import type { IPlatformBinding, IPlatformCapability, IPlatformProviderConfig, TPlatformBindingStatus, TPlatformBindingStatusReason } from '../platform/types.js';
4
4
  export interface IReq_Any_Cloudly_GetPlatformDesiredState extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_Cloudly_GetPlatformDesiredState> {
5
5
  method: 'getPlatformDesiredState';
6
6
  request: {
@@ -111,6 +111,11 @@ export interface IReq_Any_Cloudly_UpdatePlatformBindingStatus extends plugins.ty
111
111
  endpoints?: IPlatformBinding['endpoints'];
112
112
  /** Reports the exact provider-returned bucket for an objectstorage binding. */
113
113
  objectstorageBucketName?: IPlatformBinding['objectstorageBucketName'];
114
+ /**
115
+ * Why the binding holds `status`; `validatePlatformBindingStatusReason` pairs each reason with
116
+ * its one status. Absent clears a stored reason.
117
+ */
118
+ statusReason?: TPlatformBindingStatusReason;
114
119
  errorText?: string;
115
120
  };
116
121
  response: {
@@ -2,6 +2,7 @@ import * as plugins from '../plugins.js';
2
2
  import type { IService } from '../data/service.js';
3
3
  import type { TServiceUpdateWritableData, TServiceWritableData } from '../data/service.js';
4
4
  import type { IServicePlacement } from '../data/service.js';
5
+ import type { TServiceVolumeInitialization } from '../data/servicevolumeinitialization.js';
5
6
  import type { IRegistryTarget } from '../data/registry.js';
6
7
  import type { IIdentity, IIdentityCredential } from '../data/user.js';
7
8
  import type { IImageRelease } from '../data/immutableimage.js';
@@ -267,6 +268,28 @@ export interface IRequest_Any_Cloudly_DeleteServiceById extends plugins.typedreq
267
268
  success: boolean;
268
269
  };
269
270
  }
271
+ /**
272
+ * Sets how one declared volume's node-local storage claim starts, the only write of
273
+ * `IServiceVolume.initialization`.
274
+ *
275
+ * The volume is named by its exact declared `mountPath`. `expected` is the initialization the
276
+ * caller read, or `null` when the volume has none; any other stored value refuses as `conflict`.
277
+ * While a bound local storage claim of the volume exists, a different initialization refuses as
278
+ * `volume-initialization-bound`. Refusals travel as `IServiceVolumeInitializationErrorData`.
279
+ */
280
+ export interface IRequest_Any_Cloudly_SetServiceVolumeInitialization extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_Any_Cloudly_SetServiceVolumeInitialization> {
281
+ method: 'setServiceVolumeInitialization';
282
+ request: {
283
+ identity: IIdentity;
284
+ serviceId: string;
285
+ mountPath: string;
286
+ expected: TServiceVolumeInitialization | null;
287
+ initialization: TServiceVolumeInitialization;
288
+ };
289
+ response: {
290
+ service: IService;
291
+ };
292
+ }
270
293
  /**
271
294
  * Writes the complete runtime spec of one service.
272
295
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@serve.zone/interfaces",
3
- "version": "32.22.0",
3
+ "version": "32.24.0",
4
4
  "private": false,
5
5
  "description": "Shared TypeScript interfaces and TypedRequest contracts for the serve.zone ecosystem.",
6
6
  "exports": {