@serve.zone/interfaces 20.0.0 → 20.1.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,14 @@
1
+ export declare const strictCanonicalJsonRules: Readonly<{
2
+ version: 1;
3
+ encoding: "utf-8";
4
+ objectKeyOrdering: "utf-16-code-unit-ascending";
5
+ arrayOrdering: "preserved-dense";
6
+ unicodeNormalization: "preserved";
7
+ numberEncoding: "safe-integer-json-no-negative-zero";
8
+ digest: "sha256-lowercase-hex";
9
+ }>;
10
+ export type TCanonicalJsonFailure = (reasonArg: string) => never;
11
+ export declare const canonicalizeStrictJson: (valueArg: unknown, failArg: TCanonicalJsonFailure, fieldNameArg?: string) => string;
12
+ export declare const createSha256Hex: (contentsArg: Uint8Array, failArg: TCanonicalJsonFailure) => Promise<string>;
13
+ export declare const createCanonicalJsonSha256Hex: (canonicalJsonArg: string, failArg: TCanonicalJsonFailure) => Promise<string>;
14
+ export declare const deepFreezeValue: <T>(valueArg: T, seenArg?: WeakSet<object>) => T;
@@ -0,0 +1,154 @@
1
+ export const strictCanonicalJsonRules = Object.freeze({
2
+ version: 1,
3
+ encoding: 'utf-8',
4
+ objectKeyOrdering: 'utf-16-code-unit-ascending',
5
+ arrayOrdering: 'preserved-dense',
6
+ unicodeNormalization: 'preserved',
7
+ numberEncoding: 'safe-integer-json-no-negative-zero',
8
+ digest: 'sha256-lowercase-hex',
9
+ });
10
+ const assertUnicodeScalarString = (valueArg, fieldNameArg, failArg) => {
11
+ for (let index = 0; index < valueArg.length; index++) {
12
+ const codeUnit = valueArg.charCodeAt(index);
13
+ if (codeUnit >= 0xd800 && codeUnit <= 0xdbff) {
14
+ const followingCodeUnit = valueArg.charCodeAt(index + 1);
15
+ if (!Number.isInteger(followingCodeUnit) ||
16
+ followingCodeUnit < 0xdc00 ||
17
+ followingCodeUnit > 0xdfff) {
18
+ failArg(`${fieldNameArg} must not contain an unpaired UTF-16 surrogate`);
19
+ }
20
+ index++;
21
+ continue;
22
+ }
23
+ if (codeUnit >= 0xdc00 && codeUnit <= 0xdfff) {
24
+ failArg(`${fieldNameArg} must not contain an unpaired UTF-16 surrogate`);
25
+ }
26
+ }
27
+ };
28
+ const readStrictRecord = (valueArg, fieldNameArg, failArg) => {
29
+ const prototype = Object.getPrototypeOf(valueArg);
30
+ if (prototype !== Object.prototype && prototype !== null) {
31
+ return failArg(`${fieldNameArg} must be a plain object`);
32
+ }
33
+ const record = valueArg;
34
+ const ownKeys = Reflect.ownKeys(record);
35
+ if (ownKeys.some((keyArg) => typeof keyArg !== 'string')) {
36
+ return failArg(`${fieldNameArg} must not contain symbol keys`);
37
+ }
38
+ for (const key of ownKeys) {
39
+ const descriptor = Object.getOwnPropertyDescriptor(record, key);
40
+ if (!descriptor ||
41
+ !descriptor.enumerable ||
42
+ !Object.hasOwn(descriptor, 'value')) {
43
+ return failArg(`${fieldNameArg} must contain enumerable data properties only`);
44
+ }
45
+ }
46
+ return record;
47
+ };
48
+ const readStrictArray = (valueArg, fieldNameArg, failArg) => {
49
+ if (Object.getPrototypeOf(valueArg) !== Array.prototype) {
50
+ return failArg(`${fieldNameArg} must be a dense plain array`);
51
+ }
52
+ for (let index = 0; index < valueArg.length; index++) {
53
+ if (!Object.hasOwn(valueArg, index)) {
54
+ return failArg(`${fieldNameArg} must not contain sparse entries`);
55
+ }
56
+ const descriptor = Object.getOwnPropertyDescriptor(valueArg, String(index));
57
+ if (!descriptor ||
58
+ !descriptor.enumerable ||
59
+ !Object.hasOwn(descriptor, 'value')) {
60
+ return failArg(`${fieldNameArg} must contain enumerable data entries only`);
61
+ }
62
+ }
63
+ for (const key of Reflect.ownKeys(valueArg)) {
64
+ if (key === 'length') {
65
+ continue;
66
+ }
67
+ if (typeof key !== 'string' ||
68
+ !/^(?:0|[1-9][0-9]*)$/.test(key) ||
69
+ Number(key) >= valueArg.length) {
70
+ return failArg(`${fieldNameArg} must not contain extra properties`);
71
+ }
72
+ }
73
+ return valueArg;
74
+ };
75
+ export const canonicalizeStrictJson = (valueArg, failArg, fieldNameArg = 'canonical JSON input') => {
76
+ const ancestors = new Set();
77
+ const visit = (currentValueArg, currentFieldNameArg) => {
78
+ if (currentValueArg === null) {
79
+ return 'null';
80
+ }
81
+ if (typeof currentValueArg === 'boolean') {
82
+ return currentValueArg ? 'true' : 'false';
83
+ }
84
+ if (typeof currentValueArg === 'string') {
85
+ assertUnicodeScalarString(currentValueArg, currentFieldNameArg, failArg);
86
+ return JSON.stringify(currentValueArg);
87
+ }
88
+ if (typeof currentValueArg === 'number') {
89
+ if (!Number.isSafeInteger(currentValueArg) ||
90
+ Object.is(currentValueArg, -0)) {
91
+ return failArg(`${currentFieldNameArg} must contain safe integers only`);
92
+ }
93
+ return String(currentValueArg);
94
+ }
95
+ if (!currentValueArg || typeof currentValueArg !== 'object') {
96
+ return failArg(`${currentFieldNameArg} contains a non-JSON value`);
97
+ }
98
+ if (ancestors.has(currentValueArg)) {
99
+ return failArg(`${currentFieldNameArg} contains a cycle`);
100
+ }
101
+ ancestors.add(currentValueArg);
102
+ try {
103
+ if (Array.isArray(currentValueArg)) {
104
+ const array = readStrictArray(currentValueArg, currentFieldNameArg, failArg);
105
+ return `[${array
106
+ .map((entryArg, indexArg) => visit(entryArg, `${currentFieldNameArg}[${indexArg}]`))
107
+ .join(',')}]`;
108
+ }
109
+ const record = readStrictRecord(currentValueArg, currentFieldNameArg, failArg);
110
+ const keys = Object.keys(record).sort((leftArg, rightArg) => {
111
+ return leftArg < rightArg ? -1 : leftArg > rightArg ? 1 : 0;
112
+ });
113
+ return `{${keys
114
+ .map((keyArg) => {
115
+ assertUnicodeScalarString(keyArg, `${currentFieldNameArg} key`, failArg);
116
+ return `${JSON.stringify(keyArg)}:${visit(record[keyArg], `${currentFieldNameArg}.${keyArg}`)}`;
117
+ })
118
+ .join(',')}}`;
119
+ }
120
+ finally {
121
+ ancestors.delete(currentValueArg);
122
+ }
123
+ };
124
+ return visit(valueArg, fieldNameArg);
125
+ };
126
+ export const createSha256Hex = async (contentsArg, failArg) => {
127
+ const subtle = globalThis.crypto?.subtle;
128
+ if (!subtle) {
129
+ return failArg('Web Crypto SHA-256 is unavailable in this runtime');
130
+ }
131
+ const digest = await subtle.digest('SHA-256', new Uint8Array(contentsArg));
132
+ return Array.from(new Uint8Array(digest), (byteArg) => byteArg.toString(16).padStart(2, '0')).join('');
133
+ };
134
+ export const createCanonicalJsonSha256Hex = async (canonicalJsonArg, failArg) => {
135
+ return createSha256Hex(new TextEncoder().encode(canonicalJsonArg), failArg);
136
+ };
137
+ export const deepFreezeValue = (valueArg, seenArg = new WeakSet()) => {
138
+ if (!valueArg || typeof valueArg !== 'object') {
139
+ return valueArg;
140
+ }
141
+ const object = valueArg;
142
+ if (ArrayBuffer.isView(object) || seenArg.has(object)) {
143
+ return valueArg;
144
+ }
145
+ seenArg.add(object);
146
+ for (const key of Reflect.ownKeys(object)) {
147
+ const descriptor = Object.getOwnPropertyDescriptor(object, key);
148
+ if (descriptor && Object.hasOwn(descriptor, 'value')) {
149
+ deepFreezeValue(descriptor.value, seenArg);
150
+ }
151
+ }
152
+ return Object.freeze(valueArg);
153
+ };
154
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"canonicaljson.js","sourceRoot":"","sources":["../../ts/private/canonicaljson.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,CAAC;IACpD,OAAO,EAAE,CAAU;IACnB,QAAQ,EAAE,OAAgB;IAC1B,iBAAiB,EAAE,4BAAqC;IACxD,aAAa,EAAE,iBAA0B;IACzC,oBAAoB,EAAE,WAAoB;IAC1C,cAAc,EAAE,oCAA6C;IAC7D,MAAM,EAAE,sBAA+B;CACxC,CAAC,CAAC;AAIH,MAAM,yBAAyB,GAAG,CAChC,QAAgB,EAChB,YAAoB,EACpB,OAA8B,EACxB,EAAE;IACR,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QACrD,MAAM,QAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,QAAQ,IAAI,MAAM,IAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;YAC7C,MAAM,iBAAiB,GAAG,QAAQ,CAAC,UAAU,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;YACzD,IACE,CAAC,MAAM,CAAC,SAAS,CAAC,iBAAiB,CAAC;gBACpC,iBAAiB,GAAG,MAAM;gBAC1B,iBAAiB,GAAG,MAAM,EAC1B,CAAC;gBACD,OAAO,CAAC,GAAG,YAAY,gDAAgD,CAAC,CAAC;YAC3E,CAAC;YACD,KAAK,EAAE,CAAC;YACR,SAAS;QACX,CAAC;QACD,IAAI,QAAQ,IAAI,MAAM,IAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;YAC7C,OAAO,CAAC,GAAG,YAAY,gDAAgD,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CACvB,QAAgB,EAChB,YAAoB,EACpB,OAA8B,EACL,EAAE;IAC3B,MAAM,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAClD,IAAI,SAAS,KAAK,MAAM,CAAC,SAAS,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;QACzD,OAAO,OAAO,CAAC,GAAG,YAAY,yBAAyB,CAAC,CAAC;IAC3D,CAAC;IACD,MAAM,MAAM,GAAG,QAAmC,CAAC;IACnD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACxC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,EAAE,CAAC;QACzD,OAAO,OAAO,CAAC,GAAG,YAAY,+BAA+B,CAAC,CAAC;IACjE,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,OAAmB,EAAE,CAAC;QACtC,MAAM,UAAU,GAAG,MAAM,CAAC,wBAAwB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAChE,IACE,CAAC,UAAU;YACX,CAAC,UAAU,CAAC,UAAU;YACtB,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,EACnC,CAAC;YACD,OAAO,OAAO,CACZ,GAAG,YAAY,+CAA+C,CAC/D,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CACtB,QAAmB,EACnB,YAAoB,EACpB,OAA8B,EACnB,EAAE;IACb,IAAI,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,KAAK,KAAK,CAAC,SAAS,EAAE,CAAC;QACxD,OAAO,OAAO,CAAC,GAAG,YAAY,8BAA8B,CAAC,CAAC;IAChE,CAAC;IACD,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QACrD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC;YACpC,OAAO,OAAO,CAAC,GAAG,YAAY,kCAAkC,CAAC,CAAC;QACpE,CAAC;QACD,MAAM,UAAU,GAAG,MAAM,CAAC,wBAAwB,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5E,IACE,CAAC,UAAU;YACX,CAAC,UAAU,CAAC,UAAU;YACtB,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,EACnC,CAAC;YACD,OAAO,OAAO,CAAC,GAAG,YAAY,4CAA4C,CAAC,CAAC;QAC9E,CAAC;IACH,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5C,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;YACrB,SAAS;QACX,CAAC;QACD,IACE,OAAO,GAAG,KAAK,QAAQ;YACvB,CAAC,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC;YAChC,MAAM,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,MAAM,EAC9B,CAAC;YACD,OAAO,OAAO,CAAC,GAAG,YAAY,oCAAoC,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,QAAiB,EACjB,OAA8B,EAC9B,YAAY,GAAG,sBAAsB,EAC7B,EAAE;IACV,MAAM,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;IAEpC,MAAM,KAAK,GAAG,CAAC,eAAwB,EAAE,mBAA2B,EAAU,EAAE;QAC9E,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;YAC7B,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,IAAI,OAAO,eAAe,KAAK,SAAS,EAAE,CAAC;YACzC,OAAO,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;QAC5C,CAAC;QACD,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE,CAAC;YACxC,yBAAyB,CAAC,eAAe,EAAE,mBAAmB,EAAE,OAAO,CAAC,CAAC;YACzE,OAAO,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QACzC,CAAC;QACD,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE,CAAC;YACxC,IACE,CAAC,MAAM,CAAC,aAAa,CAAC,eAAe,CAAC;gBACtC,MAAM,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,EAC9B,CAAC;gBACD,OAAO,OAAO,CAAC,GAAG,mBAAmB,kCAAkC,CAAC,CAAC;YAC3E,CAAC;YACD,OAAO,MAAM,CAAC,eAAe,CAAC,CAAC;QACjC,CAAC;QACD,IAAI,CAAC,eAAe,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE,CAAC;YAC5D,OAAO,OAAO,CAAC,GAAG,mBAAmB,4BAA4B,CAAC,CAAC;QACrE,CAAC;QACD,IAAI,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;YACnC,OAAO,OAAO,CAAC,GAAG,mBAAmB,mBAAmB,CAAC,CAAC;QAC5D,CAAC;QAED,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC/B,IAAI,CAAC;YACH,IAAI,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC;gBACnC,MAAM,KAAK,GAAG,eAAe,CAC3B,eAAe,EACf,mBAAmB,EACnB,OAAO,CACR,CAAC;gBACF,OAAO,IAAI,KAAK;qBACb,GAAG,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAC1B,KAAK,CAAC,QAAQ,EAAE,GAAG,mBAAmB,IAAI,QAAQ,GAAG,CAAC,CACvD;qBACA,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAClB,CAAC;YAED,MAAM,MAAM,GAAG,gBAAgB,CAC7B,eAAe,EACf,mBAAmB,EACnB,OAAO,CACR,CAAC;YACF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE;gBAC1D,OAAO,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YACH,OAAO,IAAI,IAAI;iBACZ,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;gBACd,yBAAyB,CACvB,MAAM,EACN,GAAG,mBAAmB,MAAM,EAC5B,OAAO,CACR,CAAC;gBACF,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,KAAK,CACvC,MAAM,CAAC,MAAM,CAAC,EACd,GAAG,mBAAmB,IAAI,MAAM,EAAE,CACnC,EAAE,CAAC;YACN,CAAC,CAAC;iBACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;QAClB,CAAC;gBAAS,CAAC;YACT,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QACpC,CAAC;IACH,CAAC,CAAC;IAEF,OAAO,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAClC,WAAuB,EACvB,OAA8B,EACb,EAAE;IACnB,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC;IACzC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,OAAO,CAAC,mDAAmD,CAAC,CAAC;IACtE,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;IAC3E,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,CACpD,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CACtC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,4BAA4B,GAAG,KAAK,EAC/C,gBAAwB,EACxB,OAA8B,EACb,EAAE;IACnB,OAAO,eAAe,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC,CAAC;AAC9E,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,QAAW,EACX,UAAU,IAAI,OAAO,EAAU,EAC5B,EAAE;IACL,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC9C,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,MAAM,GAAG,QAAkB,CAAC;IAClC,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QACtD,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACpB,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1C,MAAM,UAAU,GAAG,MAAM,CAAC,wBAAwB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAChE,IAAI,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,CAAC;YACrD,eAAe,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AACjC,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@serve.zone/interfaces",
3
- "version": "20.0.0",
3
+ "version": "20.1.0",
4
4
  "private": false,
5
5
  "description": "Shared TypeScript interfaces and TypedRequest contracts for the serve.zone ecosystem.",
6
6
  "exports": {
package/readme.md CHANGED
@@ -120,6 +120,130 @@ must reject unknown manifest fields and unsupported required feature IDs before
120
120
  provisioning. Legacy `volumes` and `platformRequirements.s3` remain deprecated
121
121
  inputs for strict resolver normalization only.
122
122
 
123
+ `platform.storagemigration` defines the provider-neutral cutover contract for a
124
+ named object-storage binding. Corestore atomically owns and fences the source
125
+ binding after validating a distinct, unfenced active-object snapshot. Onebox
126
+ only receives a held candidate, stages that exact candidate, stops the matching
127
+ workload generation, and attests the quiesced state. The candidate cannot start
128
+ until `destinationBindingStartAuthorized` is true. Corestore continues returning
129
+ `consumerAction: 'startDestination'` until Onebox submits the mutation-fenced
130
+ consumer activation request and the acknowledgement becomes durable evidence.
131
+ Candidate-issued abort tombstones authorize only `startSource` and never retain
132
+ the staged candidate binding.
133
+
134
+ Every migration DTO and status has an exact, versioned runtime normalizer.
135
+ Unknown fields, provider or pool identifiers, unbounded strings, unsafe
136
+ integers, stale mutation revisions, identity drift, and lifecycle-inconsistent
137
+ fields are rejected. Migration-created digests use strict canonical JSON and a
138
+ bare lowercase 64-hex SHA-256 value; portable golden vectors cover the source
139
+ snapshot, target request, prepare intent, and candidate binding. Pre-cutover
140
+ failures may retry or abort; after the durable commit point, recovery can only
141
+ retry or roll forward. Physical pool IDs, mount details, provider receipts, and
142
+ publication capabilities remain private.
143
+
144
+ Primary exports include:
145
+
146
+ - `IObjectStorageMigrationPrepareRequest` and
147
+ `TObjectStorageMigrationStatus` for the immutable intent and status journal.
148
+ - `IObjectStorageMigrationConsumerQuiesceRequest` with
149
+ `IStorageMigrationConsumerQuiesceEvidence` for exact candidate staging and
150
+ source-workload shutdown.
151
+ - `IObjectStorageMigrationConsumerActivationRequest` with
152
+ `IStorageMigrationConsumerActivationEvidence` for durable destination-start
153
+ acknowledgement.
154
+ - `normalizeObjectStorageMigrationStatus`,
155
+ `bindObjectStorageMigrationConsumerQuiesceRequest`, and
156
+ `bindObjectStorageMigrationConsumerActivationRequest` for strict ingress and
157
+ current-revision mutation fencing.
158
+ - The `create*Sha256` helpers for source snapshots, prepare intent, target
159
+ requests, candidate/active bindings, and persisted staging or activation
160
+ evidence.
161
+
162
+ The phase and consumer-action progression is exact:
163
+
164
+ | Phase | `consumerAction` | Destination start authorized |
165
+ | --- | --- | --- |
166
+ | `preparing`, `transferring` | `wait` | No |
167
+ | `awaitingConsumerQuiesce` | `stageCandidateAndStop` | No |
168
+ | `finalizing`, `committing` | `wait` | No |
169
+ | `readyToStart` | `startDestination` | Yes |
170
+ | `cleanupPending`, `complete` | `none` | Yes; durable activation evidence is required |
171
+ | `aborting` | `wait` | No |
172
+ | `aborted` | `startSource` | No; only the active source binding may restart |
173
+
174
+ Normalize every status before acting, and bind consumer mutations to that exact
175
+ status revision:
176
+
177
+ ```typescript
178
+ const status =
179
+ await platform.storagemigration.normalizeObjectStorageMigrationStatus(
180
+ untrustedStatusPayload,
181
+ );
182
+
183
+ if (status.phase === 'awaitingConsumerQuiesce') {
184
+ const request =
185
+ await platform.storagemigration.bindObjectStorageMigrationConsumerQuiesceRequest(
186
+ untrustedQuiescePayload,
187
+ status,
188
+ );
189
+ await submitQuiesceAcknowledgement(request);
190
+ }
191
+
192
+ if (status.phase === 'readyToStart') {
193
+ if (
194
+ !status.destinationBindingStartAuthorized ||
195
+ status.consumerAction !== 'startDestination'
196
+ ) {
197
+ throw new Error('destination binding is not authorized to start');
198
+ }
199
+ await startWorkload(status.activeBinding);
200
+ const request =
201
+ await platform.storagemigration.bindObjectStorageMigrationConsumerActivationRequest(
202
+ untrustedActivationPayload,
203
+ status,
204
+ );
205
+ await submitActivationAcknowledgement(request);
206
+ }
207
+
208
+ if (status.phase === 'cleanupPending') {
209
+ // Cleanup is reachable only after this durable acknowledgement was accepted.
210
+ const durableActivation = status.consumerActivationEvidence;
211
+ }
212
+
213
+ if (status.phase === 'aborted') {
214
+ if (
215
+ status.destinationBindingStartAuthorized ||
216
+ status.consumerAction !== 'startSource'
217
+ ) {
218
+ throw new Error('invalid aborted migration status');
219
+ }
220
+ await startWorkload(status.activeBinding);
221
+ }
222
+ ```
223
+
224
+ Here `startWorkload`, `submitQuiesceAcknowledgement`, and
225
+ `submitActivationAcknowledgement` are consumer-owned operations, not package
226
+ exports. Canonical digests are produced from normalized payloads:
227
+
228
+ ```typescript
229
+ const snapshotSha256 =
230
+ await platform.storagemigration.createUnfencedObjectStorageBindingControlSnapshotSha256(
231
+ snapshotDigestPayload,
232
+ );
233
+ const migrationSha256 =
234
+ await platform.storagemigration.createObjectStorageMigrationSha256(
235
+ prepareRequest,
236
+ );
237
+ const candidateSha256 =
238
+ await platform.storagemigration.createObjectStorageMigrationBindingSha256(
239
+ candidateBinding,
240
+ );
241
+ const activationRecordSha256 =
242
+ await platform.storagemigration.createObjectStorageMigrationPersistedActivationSha256(
243
+ activationDigestPayload,
244
+ );
245
+ ```
246
+
123
247
  ## Data Contracts
124
248
 
125
249
  Use `data` when you need object shapes that are persisted, exchanged between services, or exposed through the Cloudly API.
@@ -438,6 +562,8 @@ Available platform modules:
438
562
  - `platform.pushnotification` is the deprecated legacy device-token push contract. New browser Web Push integrations use `requests.webpush`.
439
563
  - `platform.letter` for physical letter workflows.
440
564
  - `platform.ai`, `platform.database`, `platform.objectstorage`, `platform.logging`, `platform.backup`, and `platform.sip` for infrastructure and application capabilities.
565
+ - `platform.storage` for provider-neutral storage classes, requests, capabilities, and resolved bindings.
566
+ - `platform.storagemigration` for fenced object-storage migration intent, status, consumer acknowledgements, canonical digests, and strict normalizers.
441
567
  - `platform.types` plus root re-exports for shared capability, provider, binding, credential, and endpoint metadata.
442
568
 
443
569
  ## Legacy Platformservice Contracts
@@ -3,6 +3,6 @@
3
3
  */
4
4
  export const commitinfo = {
5
5
  name: '@serve.zone/interfaces',
6
- version: '20.0.0',
6
+ version: '20.1.0',
7
7
  description: 'Shared TypeScript interfaces and TypedRequest contracts for the serve.zone ecosystem.'
8
8
  }
@@ -3,6 +3,13 @@ import type {
3
3
  IBackupArchiveObject,
4
4
  TIsolatedRestoreResourceMapping,
5
5
  } from './backup.js';
6
+ import {
7
+ canonicalizeStrictJson,
8
+ createCanonicalJsonSha256Hex,
9
+ createSha256Hex,
10
+ deepFreezeValue,
11
+ strictCanonicalJsonRules,
12
+ } from '../private/canonicaljson.js';
6
13
 
7
14
  /** Operations carried by a short-lived, single-operation restore grant. */
8
15
  export const isolatedRestoreGrantOperations = Object.freeze([
@@ -307,15 +314,7 @@ export class IsolatedRestoreContractError extends Error {
307
314
  }
308
315
 
309
316
  /** Cross-runtime rules for restore authority digests. */
310
- export const isolatedRestoreCanonicalJsonRules = Object.freeze({
311
- version: 1 as const,
312
- encoding: 'utf-8' as const,
313
- objectKeyOrdering: 'utf-16-code-unit-ascending' as const,
314
- arrayOrdering: 'preserved-dense' as const,
315
- unicodeNormalization: 'preserved' as const,
316
- numberEncoding: 'safe-integer-json-no-negative-zero' as const,
317
- digest: 'sha256-lowercase-hex' as const,
318
- });
317
+ export const isolatedRestoreCanonicalJsonRules = strictCanonicalJsonRules;
319
318
 
320
319
  const canonicalIdentifierPattern = /^[A-Za-z0-9][A-Za-z0-9._:@-]{0,255}$/;
321
320
  const canonicalScopedIdPattern = /^[A-Za-z0-9][A-Za-z0-9_.:-]{0,191}$/;
@@ -360,23 +359,7 @@ export const assertIsolatedRestoreControlIngressByteLength = (
360
359
  return byteLengthArg;
361
360
  };
362
361
 
363
- const deepFreeze = <T>(valueArg: T, seenArg = new WeakSet<object>()): T => {
364
- if (!valueArg || typeof valueArg !== 'object') {
365
- return valueArg;
366
- }
367
- const object = valueArg as object;
368
- if (ArrayBuffer.isView(object) || seenArg.has(object)) {
369
- return valueArg;
370
- }
371
- seenArg.add(object);
372
- for (const key of Reflect.ownKeys(object)) {
373
- const descriptor = Object.getOwnPropertyDescriptor(object, key);
374
- if (descriptor && Object.hasOwn(descriptor, 'value')) {
375
- deepFreeze(descriptor.value, seenArg);
376
- }
377
- }
378
- return Object.freeze(valueArg);
379
- };
362
+ const deepFreeze = deepFreezeValue;
380
363
 
381
364
  const verifiedIsolatedRestoreGrantCompacts = new WeakMap<object, string>();
382
365
  const verifiedIsolatedRestoreWriteBindings = new WeakSet<object>();
@@ -1419,64 +1402,7 @@ export const normalizeIsolatedRestoreControlStatusRequest = (
1419
1402
  };
1420
1403
 
1421
1404
  const canonicalizeJson = (valueArg: unknown): string => {
1422
- const ancestors = new Set<object>();
1423
-
1424
- const visit = (currentValueArg: unknown, fieldNameArg: string): string => {
1425
- if (currentValueArg === null) {
1426
- return 'null';
1427
- }
1428
- if (typeof currentValueArg === 'boolean') {
1429
- return currentValueArg ? 'true' : 'false';
1430
- }
1431
- if (typeof currentValueArg === 'string') {
1432
- assertUnicodeScalarString(currentValueArg, fieldNameArg);
1433
- return JSON.stringify(currentValueArg);
1434
- }
1435
- if (typeof currentValueArg === 'number') {
1436
- if (
1437
- !Number.isSafeInteger(currentValueArg) ||
1438
- Object.is(currentValueArg, -0)
1439
- ) {
1440
- return fail(`${fieldNameArg} must contain safe integers only`);
1441
- }
1442
- return String(currentValueArg);
1443
- }
1444
- if (typeof currentValueArg !== 'object') {
1445
- return fail(`${fieldNameArg} contains a non-JSON value`);
1446
- }
1447
- if (ancestors.has(currentValueArg)) {
1448
- return fail(`${fieldNameArg} contains a cycle`);
1449
- }
1450
-
1451
- ancestors.add(currentValueArg);
1452
- try {
1453
- if (Array.isArray(currentValueArg)) {
1454
- return `[${currentValueArg
1455
- .map((entryArg, indexArg) =>
1456
- visit(entryArg, `${fieldNameArg}[${indexArg}]`),
1457
- )
1458
- .join(',')}]`;
1459
- }
1460
-
1461
- const record = readRecord(currentValueArg, fieldNameArg);
1462
- const keys = Object.keys(record).sort((leftArg, rightArg) => {
1463
- return leftArg < rightArg ? -1 : leftArg > rightArg ? 1 : 0;
1464
- });
1465
- return `{${keys
1466
- .map((keyArg) => {
1467
- assertUnicodeScalarString(keyArg, `${fieldNameArg} key`);
1468
- return `${JSON.stringify(keyArg)}:${visit(
1469
- record[keyArg],
1470
- `${fieldNameArg}.${keyArg}`,
1471
- )}`;
1472
- })
1473
- .join(',')}}`;
1474
- } finally {
1475
- ancestors.delete(currentValueArg);
1476
- }
1477
- };
1478
-
1479
- return visit(valueArg, 'canonical JSON input');
1405
+ return canonicalizeStrictJson(valueArg, fail);
1480
1406
  };
1481
1407
 
1482
1408
  export const canonicalizeIsolatedRestoreResourceMappings = (
@@ -1618,20 +1544,13 @@ export const canonicalizeIsolatedRestoreAuthorityProjection = (
1618
1544
  };
1619
1545
 
1620
1546
  const createSha256 = async (contentsArg: Uint8Array): Promise<string> => {
1621
- const subtle = globalThis.crypto?.subtle;
1622
- if (!subtle) {
1623
- return fail('Web Crypto SHA-256 is unavailable in this runtime');
1624
- }
1625
- const digest = await subtle.digest('SHA-256', new Uint8Array(contentsArg));
1626
- return Array.from(new Uint8Array(digest), (byteArg) =>
1627
- byteArg.toString(16).padStart(2, '0'),
1628
- ).join('');
1547
+ return createSha256Hex(contentsArg, fail);
1629
1548
  };
1630
1549
 
1631
1550
  const createCanonicalJsonSha256 = async (
1632
1551
  canonicalJsonArg: string,
1633
1552
  ): Promise<string> => {
1634
- return createSha256(new TextEncoder().encode(canonicalJsonArg));
1553
+ return createCanonicalJsonSha256Hex(canonicalJsonArg, fail);
1635
1554
  };
1636
1555
 
1637
1556
  export const createIsolatedRestoreBytesSha256 = async (
@@ -9,6 +9,7 @@ import * as pushnotification from './pushnotification.js';
9
9
  import * as sip from './sip.js';
10
10
  import * as sms from './sms.js';
11
11
  import * as storage from './storage.js';
12
+ import * as storagemigration from './storagemigration.js';
12
13
  import * as types from './types.js';
13
14
 
14
15
  export {
@@ -23,8 +24,10 @@ export {
23
24
  sip,
24
25
  sms,
25
26
  storage,
27
+ storagemigration,
26
28
  types,
27
29
  };
28
30
 
29
31
  export * from './storage.js';
32
+ export * from './storagemigration.js';
30
33
  export * from './types.js';