@workflow/core 5.0.0-beta.3 → 5.0.0-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/capture-stack.d.ts +16 -0
- package/dist/capture-stack.d.ts.map +1 -0
- package/dist/capture-stack.js +21 -0
- package/dist/classify-error.d.ts +7 -0
- package/dist/classify-error.d.ts.map +1 -1
- package/dist/classify-error.js +25 -4
- package/dist/context-errors.d.ts +27 -0
- package/dist/context-errors.d.ts.map +1 -0
- package/dist/context-errors.js +101 -0
- package/dist/context-violation-error.d.ts +97 -0
- package/dist/context-violation-error.d.ts.map +1 -0
- package/dist/context-violation-error.js +147 -0
- package/dist/create-hook.d.ts.map +1 -1
- package/dist/create-hook.js +4 -3
- package/dist/define-hook.d.ts.map +1 -1
- package/dist/define-hook.js +20 -5
- package/dist/describe-error.d.ts +70 -0
- package/dist/describe-error.d.ts.map +1 -0
- package/dist/describe-error.js +119 -0
- package/dist/encryption.d.ts.map +1 -1
- package/dist/encryption.js +4 -20
- package/dist/events-consumer.d.ts +7 -0
- package/dist/events-consumer.d.ts.map +1 -1
- package/dist/events-consumer.js +9 -2
- package/dist/flushable-stream.d.ts +10 -10
- package/dist/flushable-stream.d.ts.map +1 -1
- package/dist/flushable-stream.js +13 -12
- package/dist/global.d.ts +4 -0
- package/dist/global.d.ts.map +1 -1
- package/dist/global.js +8 -2
- package/dist/log-format.d.ts +25 -0
- package/dist/log-format.d.ts.map +1 -0
- package/dist/log-format.js +250 -0
- package/dist/logger.d.ts +28 -30
- package/dist/logger.d.ts.map +1 -1
- package/dist/logger.js +77 -31
- package/dist/private.js +3 -3
- package/dist/runtime/get-port-lazy.d.ts +10 -0
- package/dist/runtime/get-port-lazy.d.ts.map +1 -0
- package/dist/runtime/get-port-lazy.js +30 -0
- package/dist/runtime/get-world-lazy.d.ts +32 -0
- package/dist/runtime/get-world-lazy.d.ts.map +1 -0
- package/dist/runtime/get-world-lazy.js +56 -0
- package/dist/runtime/helpers.d.ts +38 -5
- package/dist/runtime/helpers.d.ts.map +1 -1
- package/dist/runtime/helpers.js +67 -18
- package/dist/runtime/resume-hook.js +4 -4
- package/dist/runtime/run.d.ts.map +1 -1
- package/dist/runtime/run.js +31 -6
- package/dist/runtime/start.js +3 -3
- package/dist/runtime/step-executor.d.ts +40 -0
- package/dist/runtime/step-executor.d.ts.map +1 -0
- package/dist/runtime/step-executor.js +480 -0
- package/dist/runtime/step-handler.d.ts.map +1 -1
- package/dist/runtime/step-handler.js +209 -111
- package/dist/runtime/suspension-handler.d.ts +22 -4
- package/dist/runtime/suspension-handler.d.ts.map +1 -1
- package/dist/runtime/suspension-handler.js +86 -73
- package/dist/runtime/world-init.d.ts +75 -0
- package/dist/runtime/world-init.d.ts.map +1 -0
- package/dist/runtime/world-init.js +75 -0
- package/dist/runtime/world.d.ts.map +1 -1
- package/dist/runtime/world.js +47 -18
- package/dist/runtime.d.ts +8 -7
- package/dist/runtime.d.ts.map +1 -1
- package/dist/runtime.js +649 -292
- package/dist/schemas.d.ts +1 -1
- package/dist/schemas.d.ts.map +1 -1
- package/dist/schemas.js +1 -1
- package/dist/serialization/client.d.ts +17 -0
- package/dist/serialization/client.d.ts.map +1 -0
- package/dist/serialization/client.js +44 -0
- package/dist/serialization/codec-devalue.d.ts +14 -0
- package/dist/serialization/codec-devalue.d.ts.map +1 -0
- package/dist/serialization/codec-devalue.js +98 -0
- package/dist/serialization/codec.d.ts +90 -0
- package/dist/serialization/codec.d.ts.map +1 -0
- package/dist/serialization/codec.js +17 -0
- package/dist/serialization/encryption.d.ts +32 -0
- package/dist/serialization/encryption.d.ts.map +1 -0
- package/dist/serialization/encryption.js +51 -0
- package/dist/serialization/errors.d.ts +21 -0
- package/dist/serialization/errors.d.ts.map +1 -0
- package/dist/serialization/errors.js +41 -0
- package/dist/serialization/format.d.ts +60 -0
- package/dist/serialization/format.d.ts.map +1 -0
- package/dist/serialization/format.js +97 -0
- package/dist/serialization/index.d.ts +18 -0
- package/dist/serialization/index.d.ts.map +1 -0
- package/dist/serialization/index.js +20 -0
- package/dist/serialization/reducers/class.d.ts +11 -0
- package/dist/serialization/reducers/class.d.ts.map +1 -0
- package/dist/serialization/reducers/class.js +68 -0
- package/dist/serialization/reducers/common.d.ts +16 -0
- package/dist/serialization/reducers/common.d.ts.map +1 -0
- package/dist/serialization/reducers/common.js +362 -0
- package/dist/serialization/reducers/step-function.d.ts +35 -0
- package/dist/serialization/reducers/step-function.d.ts.map +1 -0
- package/dist/serialization/reducers/step-function.js +88 -0
- package/dist/serialization/step.d.ts +17 -0
- package/dist/serialization/step.d.ts.map +1 -0
- package/dist/serialization/step.js +44 -0
- package/dist/serialization/types.d.ts +201 -0
- package/dist/serialization/types.d.ts.map +1 -0
- package/dist/serialization/types.js +21 -0
- package/dist/serialization/workflow.d.ts +29 -0
- package/dist/serialization/workflow.d.ts.map +1 -0
- package/dist/serialization/workflow.js +54 -0
- package/dist/serialization-format.d.ts.map +1 -1
- package/dist/serialization-format.js +77 -3
- package/dist/serialization.d.ts +202 -226
- package/dist/serialization.d.ts.map +1 -1
- package/dist/serialization.js +773 -633
- package/dist/sleep.d.ts.map +1 -1
- package/dist/sleep.js +3 -2
- package/dist/step/get-closure-vars.d.ts.map +1 -1
- package/dist/step/get-closure-vars.js +3 -2
- package/dist/step/get-step-metadata.d.ts.map +1 -1
- package/dist/step/get-step-metadata.js +3 -2
- package/dist/step/get-workflow-metadata.d.ts.map +1 -1
- package/dist/step/get-workflow-metadata.js +3 -2
- package/dist/step/writable-stream.d.ts.map +1 -1
- package/dist/step/writable-stream.js +3 -2
- package/dist/step.d.ts.map +1 -1
- package/dist/step.js +83 -16
- package/dist/symbols.d.ts +4 -0
- package/dist/symbols.d.ts.map +1 -1
- package/dist/symbols.js +5 -1
- package/dist/telemetry/semantic-conventions.d.ts +2 -2
- package/dist/telemetry/semantic-conventions.js +1 -1
- package/dist/util.d.ts +18 -3
- package/dist/util.d.ts.map +1 -1
- package/dist/util.js +28 -5
- package/dist/version.d.ts +1 -1
- package/dist/version.js +2 -2
- package/dist/vm/index.d.ts.map +1 -1
- package/dist/vm/index.js +3 -2
- package/dist/workflow/abort-controller.d.ts +65 -0
- package/dist/workflow/abort-controller.d.ts.map +1 -0
- package/dist/workflow/abort-controller.js +245 -0
- package/dist/workflow/create-hook.d.ts.map +1 -1
- package/dist/workflow/create-hook.js +3 -2
- package/dist/workflow/define-hook.d.ts +1 -1
- package/dist/workflow/define-hook.d.ts.map +1 -1
- package/dist/workflow/define-hook.js +8 -4
- package/dist/workflow/get-workflow-metadata.d.ts.map +1 -1
- package/dist/workflow/get-workflow-metadata.js +14 -3
- package/dist/workflow/index.d.ts.map +1 -1
- package/dist/workflow/index.js +4 -3
- package/dist/workflow/world-init-stub.d.ts +15 -0
- package/dist/workflow/world-init-stub.d.ts.map +1 -0
- package/dist/workflow/world-init-stub.js +15 -0
- package/dist/workflow.d.ts.map +1 -1
- package/dist/workflow.js +71 -28
- package/docs/foundations/cancellation.mdx +460 -0
- package/docs/foundations/errors-and-retries.mdx +7 -3
- package/docs/foundations/meta.json +1 -0
- package/docs/foundations/serialization.mdx +77 -41
- package/docs/how-it-works/cancellation.mdx +287 -0
- package/docs/how-it-works/meta.json +2 -1
- package/package.json +15 -6
package/dist/schemas.d.ts
CHANGED
|
@@ -11,5 +11,5 @@
|
|
|
11
11
|
*/
|
|
12
12
|
export type Serializable = string | number | boolean | null | undefined | Serializable[] | {
|
|
13
13
|
[key: string]: Serializable;
|
|
14
|
-
} | ArrayBuffer | bigint | BigInt64Array | BigUint64Array | Date | DOMException | Float32Array | Float64Array | Headers | Int8Array | Int16Array | Int32Array | Map<Serializable, Serializable> | ReadableStream<Uint8Array> | RegExp | Response | Set<Serializable> | URL | URLSearchParams | Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array | WritableStream<Uint8Array> | ((...args: Serializable[]) => Promise<Serializable>);
|
|
14
|
+
} | ArrayBuffer | bigint | BigInt64Array | BigUint64Array | Date | DOMException | Error | Float32Array | Float64Array | Headers | Int8Array | Int16Array | Int32Array | Map<Serializable, Serializable> | ReadableStream<Uint8Array> | RegExp | Response | Set<Serializable> | URL | URLSearchParams | Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array | WritableStream<Uint8Array> | AbortController | AbortSignal | ((...args: Serializable[]) => Promise<Serializable>);
|
|
15
15
|
//# sourceMappingURL=schemas.d.ts.map
|
package/dist/schemas.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,MAAM,MAAM,YAAY,GAEpB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,GACT,YAAY,EAAE,GACd;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;CAAE,GAG/B,WAAW,GACX,MAAM,GACN,aAAa,GACb,cAAc,GACd,IAAI,GACJ,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,OAAO,GACP,SAAS,GACT,UAAU,GACV,UAAU,GACV,GAAG,CAAC,YAAY,EAAE,YAAY,CAAC,GAC/B,cAAc,CAAC,UAAU,CAAC,GAC1B,MAAM,GACN,QAAQ,GACR,GAAG,CAAC,YAAY,CAAC,GACjB,GAAG,GACH,eAAe,GACf,UAAU,GACV,iBAAiB,GACjB,WAAW,GACX,WAAW,GACX,cAAc,CAAC,UAAU,CAAC,GAC1B,CAAC,CAAC,GAAG,IAAI,EAAE,YAAY,EAAE,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,MAAM,MAAM,YAAY,GAEpB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,GACT,YAAY,EAAE,GACd;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;CAAE,GAG/B,WAAW,GACX,MAAM,GACN,aAAa,GACb,cAAc,GACd,IAAI,GACJ,YAAY,GACZ,KAAK,GACL,YAAY,GACZ,YAAY,GACZ,OAAO,GACP,SAAS,GACT,UAAU,GACV,UAAU,GACV,GAAG,CAAC,YAAY,EAAE,YAAY,CAAC,GAC/B,cAAc,CAAC,UAAU,CAAC,GAC1B,MAAM,GACN,QAAQ,GACR,GAAG,CAAC,YAAY,CAAC,GACjB,GAAG,GACH,eAAe,GACf,UAAU,GACV,iBAAiB,GACjB,WAAW,GACX,WAAW,GACX,cAAc,CAAC,UAAU,CAAC,GAC1B,eAAe,GACf,WAAW,GACX,CAAC,CAAC,GAAG,IAAI,EAAE,YAAY,EAAE,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC"}
|
package/dist/schemas.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export {};
|
|
2
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
2
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2NoZW1hcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9zY2hlbWFzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEEgc2VyaWFsaXphYmxlIHZhbHVlOlxuICogQW55IHZhbGlkIEpTT04gb2JqZWN0IGlzIHNlcmlhbGl6YWJsZVxuICpcbiAqIEBleGFtcGxlXG4gKlxuICogYGBgdHNcbiAqIC8vIGFueSB2YWxpZCBKU09OIG9iamVjdCBpcyBzZXJpYWxpemFibGVcbiAqIGNvbnN0IGFueUpzb246IFNlcmlhbGl6YWJsZSA9IHsgZm9vOiBcImJhclwiIH07XG4gKiBgYGBcbiAqL1xuZXhwb3J0IHR5cGUgU2VyaWFsaXphYmxlID1cbiAgLy8gU3RhbmRhcmQgSlNPTiB0eXBlc1xuICB8IHN0cmluZ1xuICB8IG51bWJlclxuICB8IGJvb2xlYW5cbiAgfCBudWxsXG4gIHwgdW5kZWZpbmVkXG4gIHwgU2VyaWFsaXphYmxlW11cbiAgfCB7IFtrZXk6IHN0cmluZ106IFNlcmlhbGl6YWJsZSB9XG4gIC8vIFNwZWNpYWwgdHlwZXMgdGhhdCBuZWVkIHNwZWNpYWwgaGFuZGxpbmcgd2hlblxuICAvLyBzZXJpYWxpemVkL2Rlc2VyaWFsaXplZCAoc2VlIGBzZXJpYWxpemF0aW9uLnRzYClcbiAgfCBBcnJheUJ1ZmZlclxuICB8IGJpZ2ludFxuICB8IEJpZ0ludDY0QXJyYXlcbiAgfCBCaWdVaW50NjRBcnJheVxuICB8IERhdGVcbiAgfCBET01FeGNlcHRpb25cbiAgfCBFcnJvclxuICB8IEZsb2F0MzJBcnJheVxuICB8IEZsb2F0NjRBcnJheVxuICB8IEhlYWRlcnNcbiAgfCBJbnQ4QXJyYXlcbiAgfCBJbnQxNkFycmF5XG4gIHwgSW50MzJBcnJheVxuICB8IE1hcDxTZXJpYWxpemFibGUsIFNlcmlhbGl6YWJsZT5cbiAgfCBSZWFkYWJsZVN0cmVhbTxVaW50OEFycmF5PlxuICB8IFJlZ0V4cFxuICB8IFJlc3BvbnNlXG4gIHwgU2V0PFNlcmlhbGl6YWJsZT5cbiAgfCBVUkxcbiAgfCBVUkxTZWFyY2hQYXJhbXNcbiAgfCBVaW50OEFycmF5XG4gIHwgVWludDhDbGFtcGVkQXJyYXlcbiAgfCBVaW50MTZBcnJheVxuICB8IFVpbnQzMkFycmF5XG4gIHwgV3JpdGFibGVTdHJlYW08VWludDhBcnJheT5cbiAgfCBBYm9ydENvbnRyb2xsZXJcbiAgfCBBYm9ydFNpZ25hbFxuICB8ICgoLi4uYXJnczogU2VyaWFsaXphYmxlW10pID0+IFByb21pc2U8U2VyaWFsaXphYmxlPik7IC8vIFN0ZXAgZnVuY3Rpb25cbiJdfQ==
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Client (external) mode serialization.
|
|
3
|
+
*
|
|
4
|
+
* Used when starting workflows from the client side (serializing workflow
|
|
5
|
+
* arguments) and when receiving workflow return values. Supports encryption.
|
|
6
|
+
*/
|
|
7
|
+
import type { CodecOptions } from './codec.js';
|
|
8
|
+
import { type CryptoKey } from './encryption.js';
|
|
9
|
+
/**
|
|
10
|
+
* Serialize a value from the client environment (e.g. workflow arguments).
|
|
11
|
+
*/
|
|
12
|
+
export declare function serialize(value: unknown, encryptionKey?: CryptoKey, options?: CodecOptions): Promise<Uint8Array | unknown>;
|
|
13
|
+
/**
|
|
14
|
+
* Deserialize a value for the client environment (e.g. workflow return value).
|
|
15
|
+
*/
|
|
16
|
+
export declare function deserialize(data: Uint8Array | unknown, encryptionKey?: CryptoKey, options?: CodecOptions): Promise<unknown>;
|
|
17
|
+
//# sourceMappingURL=client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/serialization/client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,OAAO,EACL,KAAK,SAAS,EAGf,MAAM,iBAAiB,CAAC;AAKzB;;GAEG;AACH,wBAAsB,SAAS,CAC7B,KAAK,EAAE,OAAO,EACd,aAAa,CAAC,EAAE,SAAS,EACzB,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,CAY/B;AAED;;GAEG;AACH,wBAAsB,WAAW,CAC/B,IAAI,EAAE,UAAU,GAAG,OAAO,EAC1B,aAAa,CAAC,EAAE,SAAS,EACzB,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,OAAO,CAAC,CAmBlB"}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Client (external) mode serialization.
|
|
3
|
+
*
|
|
4
|
+
* Used when starting workflows from the client side (serializing workflow
|
|
5
|
+
* arguments) and when receiving workflow return values. Supports encryption.
|
|
6
|
+
*/
|
|
7
|
+
import { SerializationError } from '@workflow/errors';
|
|
8
|
+
import { devalueCodec } from './codec-devalue.js';
|
|
9
|
+
import { decrypt as decryptData, encrypt as encryptData, } from './encryption.js';
|
|
10
|
+
import { formatSerializationError } from './errors.js';
|
|
11
|
+
import { decodeFormatPrefix, encodeWithFormatPrefix } from './format.js';
|
|
12
|
+
import { SerializationFormat } from './types.js';
|
|
13
|
+
/**
|
|
14
|
+
* Serialize a value from the client environment (e.g. workflow arguments).
|
|
15
|
+
*/
|
|
16
|
+
export async function serialize(value, encryptionKey, options) {
|
|
17
|
+
try {
|
|
18
|
+
const payload = devalueCodec.serialize(value, 'client', options);
|
|
19
|
+
const prefixed = encodeWithFormatPrefix(SerializationFormat.DEVALUE_V1, payload);
|
|
20
|
+
return encryptData(prefixed, encryptionKey);
|
|
21
|
+
}
|
|
22
|
+
catch (error) {
|
|
23
|
+
const { message, hint } = formatSerializationError('client value', error);
|
|
24
|
+
throw new SerializationError(message, { hint, cause: error });
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Deserialize a value for the client environment (e.g. workflow return value).
|
|
29
|
+
*/
|
|
30
|
+
export async function deserialize(data, encryptionKey, options) {
|
|
31
|
+
const decrypted = await decryptData(data, encryptionKey);
|
|
32
|
+
if (!(decrypted instanceof Uint8Array)) {
|
|
33
|
+
if (devalueCodec.deserializeLegacy) {
|
|
34
|
+
return devalueCodec.deserializeLegacy(decrypted, 'client', options);
|
|
35
|
+
}
|
|
36
|
+
throw new Error('Cannot deserialize non-binary data without legacy support');
|
|
37
|
+
}
|
|
38
|
+
const { format, payload } = decodeFormatPrefix(decrypted);
|
|
39
|
+
if (format === SerializationFormat.DEVALUE_V1) {
|
|
40
|
+
return devalueCodec.deserialize(payload, 'client', options);
|
|
41
|
+
}
|
|
42
|
+
throw new Error(`Unsupported serialization format: ${format}`);
|
|
43
|
+
}
|
|
44
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpZW50LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3NlcmlhbGl6YXRpb24vY2xpZW50LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOzs7OztHQUtHO0FBRUgsT0FBTyxFQUFFLGtCQUFrQixFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFFdEQsT0FBTyxFQUFFLFlBQVksRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBQ2xELE9BQU8sRUFFTCxPQUFPLElBQUksV0FBVyxFQUN0QixPQUFPLElBQUksV0FBVyxHQUN2QixNQUFNLGlCQUFpQixDQUFDO0FBQ3pCLE9BQU8sRUFBRSx3QkFBd0IsRUFBRSxNQUFNLGFBQWEsQ0FBQztBQUN2RCxPQUFPLEVBQUUsa0JBQWtCLEVBQUUsc0JBQXNCLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFDekUsT0FBTyxFQUFFLG1CQUFtQixFQUFFLE1BQU0sWUFBWSxDQUFDO0FBRWpEOztHQUVHO0FBQ0gsTUFBTSxDQUFDLEtBQUssVUFBVSxTQUFTLENBQzdCLEtBQWMsRUFDZCxhQUF5QixFQUN6QixPQUFzQjtJQUV0QixJQUFJLENBQUM7UUFDSCxNQUFNLE9BQU8sR0FBRyxZQUFZLENBQUMsU0FBUyxDQUFDLEtBQUssRUFBRSxRQUFRLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDakUsTUFBTSxRQUFRLEdBQUcsc0JBQXNCLENBQ3JDLG1CQUFtQixDQUFDLFVBQVUsRUFDOUIsT0FBTyxDQUNNLENBQUM7UUFDaEIsT0FBTyxXQUFXLENBQUMsUUFBUSxFQUFFLGFBQWEsQ0FBQyxDQUFDO0lBQzlDLENBQUM7SUFBQyxPQUFPLEtBQUssRUFBRSxDQUFDO1FBQ2YsTUFBTSxFQUFFLE9BQU8sRUFBRSxJQUFJLEVBQUUsR0FBRyx3QkFBd0IsQ0FBQyxjQUFjLEVBQUUsS0FBSyxDQUFDLENBQUM7UUFDMUUsTUFBTSxJQUFJLGtCQUFrQixDQUFDLE9BQU8sRUFBRSxFQUFFLElBQUksRUFBRSxLQUFLLEVBQUUsS0FBSyxFQUFFLENBQUMsQ0FBQztJQUNoRSxDQUFDO0FBQ0gsQ0FBQztBQUVEOztHQUVHO0FBQ0gsTUFBTSxDQUFDLEtBQUssVUFBVSxXQUFXLENBQy9CLElBQTBCLEVBQzFCLGFBQXlCLEVBQ3pCLE9BQXNCO0lBRXRCLE1BQU0sU0FBUyxHQUFHLE1BQU0sV0FBVyxDQUFDLElBQUksRUFBRSxhQUFhLENBQUMsQ0FBQztJQUV6RCxJQUFJLENBQUMsQ0FBQyxTQUFTLFlBQVksVUFBVSxDQUFDLEVBQUUsQ0FBQztRQUN2QyxJQUFJLFlBQVksQ0FBQyxpQkFBaUIsRUFBRSxDQUFDO1lBQ25DLE9BQU8sWUFBWSxDQUFDLGlCQUFpQixDQUFDLFNBQVMsRUFBRSxRQUFRLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDdEUsQ0FBQztRQUNELE1BQU0sSUFBSSxLQUFLLENBQ2IsMkRBQTJELENBQzVELENBQUM7SUFDSixDQUFDO0lBRUQsTUFBTSxFQUFFLE1BQU0sRUFBRSxPQUFPLEVBQUUsR0FBRyxrQkFBa0IsQ0FBQyxTQUFTLENBQUMsQ0FBQztJQUUxRCxJQUFJLE1BQU0sS0FBSyxtQkFBbUIsQ0FBQyxVQUFVLEVBQUUsQ0FBQztRQUM5QyxPQUFPLFlBQVksQ0FBQyxXQUFXLENBQUMsT0FBTyxFQUFFLFFBQVEsRUFBRSxPQUFPLENBQUMsQ0FBQztJQUM5RCxDQUFDO0lBRUQsTUFBTSxJQUFJLEtBQUssQ0FBQyxxQ0FBcUMsTUFBTSxFQUFFLENBQUMsQ0FBQztBQUNqRSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBDbGllbnQgKGV4dGVybmFsKSBtb2RlIHNlcmlhbGl6YXRpb24uXG4gKlxuICogVXNlZCB3aGVuIHN0YXJ0aW5nIHdvcmtmbG93cyBmcm9tIHRoZSBjbGllbnQgc2lkZSAoc2VyaWFsaXppbmcgd29ya2Zsb3dcbiAqIGFyZ3VtZW50cykgYW5kIHdoZW4gcmVjZWl2aW5nIHdvcmtmbG93IHJldHVybiB2YWx1ZXMuIFN1cHBvcnRzIGVuY3J5cHRpb24uXG4gKi9cblxuaW1wb3J0IHsgU2VyaWFsaXphdGlvbkVycm9yIH0gZnJvbSAnQHdvcmtmbG93L2Vycm9ycyc7XG5pbXBvcnQgdHlwZSB7IENvZGVjT3B0aW9ucyB9IGZyb20gJy4vY29kZWMuanMnO1xuaW1wb3J0IHsgZGV2YWx1ZUNvZGVjIH0gZnJvbSAnLi9jb2RlYy1kZXZhbHVlLmpzJztcbmltcG9ydCB7XG4gIHR5cGUgQ3J5cHRvS2V5LFxuICBkZWNyeXB0IGFzIGRlY3J5cHREYXRhLFxuICBlbmNyeXB0IGFzIGVuY3J5cHREYXRhLFxufSBmcm9tICcuL2VuY3J5cHRpb24uanMnO1xuaW1wb3J0IHsgZm9ybWF0U2VyaWFsaXphdGlvbkVycm9yIH0gZnJvbSAnLi9lcnJvcnMuanMnO1xuaW1wb3J0IHsgZGVjb2RlRm9ybWF0UHJlZml4LCBlbmNvZGVXaXRoRm9ybWF0UHJlZml4IH0gZnJvbSAnLi9mb3JtYXQuanMnO1xuaW1wb3J0IHsgU2VyaWFsaXphdGlvbkZvcm1hdCB9IGZyb20gJy4vdHlwZXMuanMnO1xuXG4vKipcbiAqIFNlcmlhbGl6ZSBhIHZhbHVlIGZyb20gdGhlIGNsaWVudCBlbnZpcm9ubWVudCAoZS5nLiB3b3JrZmxvdyBhcmd1bWVudHMpLlxuICovXG5leHBvcnQgYXN5bmMgZnVuY3Rpb24gc2VyaWFsaXplKFxuICB2YWx1ZTogdW5rbm93bixcbiAgZW5jcnlwdGlvbktleT86IENyeXB0b0tleSxcbiAgb3B0aW9ucz86IENvZGVjT3B0aW9uc1xuKTogUHJvbWlzZTxVaW50OEFycmF5IHwgdW5rbm93bj4ge1xuICB0cnkge1xuICAgIGNvbnN0IHBheWxvYWQgPSBkZXZhbHVlQ29kZWMuc2VyaWFsaXplKHZhbHVlLCAnY2xpZW50Jywgb3B0aW9ucyk7XG4gICAgY29uc3QgcHJlZml4ZWQgPSBlbmNvZGVXaXRoRm9ybWF0UHJlZml4KFxuICAgICAgU2VyaWFsaXphdGlvbkZvcm1hdC5ERVZBTFVFX1YxLFxuICAgICAgcGF5bG9hZFxuICAgICkgYXMgVWludDhBcnJheTtcbiAgICByZXR1cm4gZW5jcnlwdERhdGEocHJlZml4ZWQsIGVuY3J5cHRpb25LZXkpO1xuICB9IGNhdGNoIChlcnJvcikge1xuICAgIGNvbnN0IHsgbWVzc2FnZSwgaGludCB9ID0gZm9ybWF0U2VyaWFsaXphdGlvbkVycm9yKCdjbGllbnQgdmFsdWUnLCBlcnJvcik7XG4gICAgdGhyb3cgbmV3IFNlcmlhbGl6YXRpb25FcnJvcihtZXNzYWdlLCB7IGhpbnQsIGNhdXNlOiBlcnJvciB9KTtcbiAgfVxufVxuXG4vKipcbiAqIERlc2VyaWFsaXplIGEgdmFsdWUgZm9yIHRoZSBjbGllbnQgZW52aXJvbm1lbnQgKGUuZy4gd29ya2Zsb3cgcmV0dXJuIHZhbHVlKS5cbiAqL1xuZXhwb3J0IGFzeW5jIGZ1bmN0aW9uIGRlc2VyaWFsaXplKFxuICBkYXRhOiBVaW50OEFycmF5IHwgdW5rbm93bixcbiAgZW5jcnlwdGlvbktleT86IENyeXB0b0tleSxcbiAgb3B0aW9ucz86IENvZGVjT3B0aW9uc1xuKTogUHJvbWlzZTx1bmtub3duPiB7XG4gIGNvbnN0IGRlY3J5cHRlZCA9IGF3YWl0IGRlY3J5cHREYXRhKGRhdGEsIGVuY3J5cHRpb25LZXkpO1xuXG4gIGlmICghKGRlY3J5cHRlZCBpbnN0YW5jZW9mIFVpbnQ4QXJyYXkpKSB7XG4gICAgaWYgKGRldmFsdWVDb2RlYy5kZXNlcmlhbGl6ZUxlZ2FjeSkge1xuICAgICAgcmV0dXJuIGRldmFsdWVDb2RlYy5kZXNlcmlhbGl6ZUxlZ2FjeShkZWNyeXB0ZWQsICdjbGllbnQnLCBvcHRpb25zKTtcbiAgICB9XG4gICAgdGhyb3cgbmV3IEVycm9yKFxuICAgICAgJ0Nhbm5vdCBkZXNlcmlhbGl6ZSBub24tYmluYXJ5IGRhdGEgd2l0aG91dCBsZWdhY3kgc3VwcG9ydCdcbiAgICApO1xuICB9XG5cbiAgY29uc3QgeyBmb3JtYXQsIHBheWxvYWQgfSA9IGRlY29kZUZvcm1hdFByZWZpeChkZWNyeXB0ZWQpO1xuXG4gIGlmIChmb3JtYXQgPT09IFNlcmlhbGl6YXRpb25Gb3JtYXQuREVWQUxVRV9WMSkge1xuICAgIHJldHVybiBkZXZhbHVlQ29kZWMuZGVzZXJpYWxpemUocGF5bG9hZCwgJ2NsaWVudCcsIG9wdGlvbnMpO1xuICB9XG5cbiAgdGhyb3cgbmV3IEVycm9yKGBVbnN1cHBvcnRlZCBzZXJpYWxpemF0aW9uIGZvcm1hdDogJHtmb3JtYXR9YCk7XG59XG4iXX0=
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Devalue codec implementation.
|
|
3
|
+
*
|
|
4
|
+
* Uses the `devalue` library for serialization. Handles custom types via
|
|
5
|
+
* reducers (serialize) and revivers (deserialize) which are composed
|
|
6
|
+
* internally based on the serialization mode.
|
|
7
|
+
*
|
|
8
|
+
* The reducer/reviver pattern is specific to devalue — other codecs
|
|
9
|
+
* (CBOR, JSON) would handle types differently (e.g. CBOR supports Date,
|
|
10
|
+
* typed arrays, Map, Set natively).
|
|
11
|
+
*/
|
|
12
|
+
import type { Codec } from './codec.js';
|
|
13
|
+
export declare const devalueCodec: Codec;
|
|
14
|
+
//# sourceMappingURL=codec-devalue.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"codec-devalue.d.ts","sourceRoot":"","sources":["../../src/serialization/codec-devalue.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,EAAE,KAAK,EAAmC,MAAM,YAAY,CAAC;AAwFzE,eAAO,MAAM,YAAY,EAAE,KA2C1B,CAAC"}
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Devalue codec implementation.
|
|
3
|
+
*
|
|
4
|
+
* Uses the `devalue` library for serialization. Handles custom types via
|
|
5
|
+
* reducers (serialize) and revivers (deserialize) which are composed
|
|
6
|
+
* internally based on the serialization mode.
|
|
7
|
+
*
|
|
8
|
+
* The reducer/reviver pattern is specific to devalue — other codecs
|
|
9
|
+
* (CBOR, JSON) would handle types differently (e.g. CBOR supports Date,
|
|
10
|
+
* typed arrays, Map, Set natively).
|
|
11
|
+
*/
|
|
12
|
+
import { parse, stringify, unflatten } from 'devalue';
|
|
13
|
+
import { getClassReducers, getClassRevivers } from './reducers/class.js';
|
|
14
|
+
import { getCommonReducers, getCommonRevivers } from './reducers/common.js';
|
|
15
|
+
import { getStepFunctionReducer, getStepFunctionReviver, } from './reducers/step-function.js';
|
|
16
|
+
import { SerializationFormat } from './types.js';
|
|
17
|
+
const encoder = new TextEncoder();
|
|
18
|
+
const decoder = new TextDecoder();
|
|
19
|
+
// ---- Reducer/Reviver composition per mode ----
|
|
20
|
+
function getReducersForMode(mode, global = globalThis, extraReducers) {
|
|
21
|
+
let base;
|
|
22
|
+
switch (mode) {
|
|
23
|
+
case 'workflow':
|
|
24
|
+
// Class/Instance MUST come before common (first-match-wins for Error subclasses)
|
|
25
|
+
base = {
|
|
26
|
+
...getClassReducers(),
|
|
27
|
+
...getStepFunctionReducer(),
|
|
28
|
+
...getCommonReducers(global),
|
|
29
|
+
};
|
|
30
|
+
break;
|
|
31
|
+
case 'step':
|
|
32
|
+
base = {
|
|
33
|
+
...getClassReducers(),
|
|
34
|
+
...getCommonReducers(global),
|
|
35
|
+
};
|
|
36
|
+
break;
|
|
37
|
+
case 'client':
|
|
38
|
+
base = {
|
|
39
|
+
...getClassReducers(),
|
|
40
|
+
...getCommonReducers(global),
|
|
41
|
+
};
|
|
42
|
+
break;
|
|
43
|
+
}
|
|
44
|
+
if (extraReducers) {
|
|
45
|
+
return { ...base, ...extraReducers };
|
|
46
|
+
}
|
|
47
|
+
return base;
|
|
48
|
+
}
|
|
49
|
+
function getReviversForMode(mode, global = globalThis, extraRevivers) {
|
|
50
|
+
let base;
|
|
51
|
+
switch (mode) {
|
|
52
|
+
case 'workflow':
|
|
53
|
+
base = {
|
|
54
|
+
...getClassRevivers(global),
|
|
55
|
+
...getStepFunctionReviver(global),
|
|
56
|
+
...getCommonRevivers(global),
|
|
57
|
+
};
|
|
58
|
+
break;
|
|
59
|
+
case 'step':
|
|
60
|
+
base = {
|
|
61
|
+
...getClassRevivers(global),
|
|
62
|
+
...getCommonRevivers(global),
|
|
63
|
+
};
|
|
64
|
+
break;
|
|
65
|
+
case 'client':
|
|
66
|
+
base = {
|
|
67
|
+
...getClassRevivers(global),
|
|
68
|
+
...getCommonRevivers(global),
|
|
69
|
+
StepFunction: () => {
|
|
70
|
+
throw new Error('Step functions cannot be deserialized in client context.');
|
|
71
|
+
},
|
|
72
|
+
};
|
|
73
|
+
break;
|
|
74
|
+
}
|
|
75
|
+
if (extraRevivers) {
|
|
76
|
+
return { ...base, ...extraRevivers };
|
|
77
|
+
}
|
|
78
|
+
return base;
|
|
79
|
+
}
|
|
80
|
+
// ---- Codec implementation ----
|
|
81
|
+
export const devalueCodec = {
|
|
82
|
+
formatPrefix: SerializationFormat.DEVALUE_V1,
|
|
83
|
+
serialize(value, mode, options) {
|
|
84
|
+
const reducers = getReducersForMode(mode, options?.global, options?.extraReducers);
|
|
85
|
+
const str = stringify(value, reducers);
|
|
86
|
+
return encoder.encode(str);
|
|
87
|
+
},
|
|
88
|
+
deserialize(data, mode, options) {
|
|
89
|
+
const revivers = getReviversForMode(mode, options?.global, options?.extraRevivers);
|
|
90
|
+
const str = decoder.decode(data);
|
|
91
|
+
return parse(str, revivers);
|
|
92
|
+
},
|
|
93
|
+
deserializeLegacy(data, mode, options) {
|
|
94
|
+
const revivers = getReviversForMode(mode, options?.global, options?.extraRevivers);
|
|
95
|
+
return unflatten(data, revivers);
|
|
96
|
+
},
|
|
97
|
+
};
|
|
98
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"codec-devalue.js","sourceRoot":"","sources":["../../src/serialization/codec-devalue.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEtD,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACzE,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EACL,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAgC,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAE/E,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;AAClC,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;AAElC,iDAAiD;AAEjD,SAAS,kBAAkB,CACzB,IAAuB,EACvB,SAA8B,UAAU,EACxC,aAAmD;IAEnD,IAAI,IAAuB,CAAC;IAC5B,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,UAAU;YACb,iFAAiF;YACjF,IAAI,GAAG;gBACL,GAAG,gBAAgB,EAAE;gBACrB,GAAG,sBAAsB,EAAE;gBAC3B,GAAG,iBAAiB,CAAC,MAAM,CAAC;aAC7B,CAAC;YACF,MAAM;QACR,KAAK,MAAM;YACT,IAAI,GAAG;gBACL,GAAG,gBAAgB,EAAE;gBACrB,GAAG,iBAAiB,CAAC,MAAM,CAAC;aAC7B,CAAC;YACF,MAAM;QACR,KAAK,QAAQ;YACX,IAAI,GAAG;gBACL,GAAG,gBAAgB,EAAE;gBACrB,GAAG,iBAAiB,CAAC,MAAM,CAAC;aAC7B,CAAC;YACF,MAAM;IACV,CAAC;IACD,IAAI,aAAa,EAAE,CAAC;QAClB,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,aAAa,EAAyC,CAAC;IAC9E,CAAC;IACD,OAAO,IAA2C,CAAC;AACrD,CAAC;AAED,SAAS,kBAAkB,CACzB,IAAuB,EACvB,SAA8B,UAAU,EACxC,aAAmD;IAEnD,IAAI,IAAuB,CAAC;IAC5B,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,UAAU;YACb,IAAI,GAAG;gBACL,GAAG,gBAAgB,CAAC,MAAM,CAAC;gBAC3B,GAAG,sBAAsB,CAAC,MAAM,CAAC;gBACjC,GAAG,iBAAiB,CAAC,MAAM,CAAC;aAC7B,CAAC;YACF,MAAM;QACR,KAAK,MAAM;YACT,IAAI,GAAG;gBACL,GAAG,gBAAgB,CAAC,MAAM,CAAC;gBAC3B,GAAG,iBAAiB,CAAC,MAAM,CAAC;aAC7B,CAAC;YACF,MAAM;QACR,KAAK,QAAQ;YACX,IAAI,GAAG;gBACL,GAAG,gBAAgB,CAAC,MAAM,CAAC;gBAC3B,GAAG,iBAAiB,CAAC,MAAM,CAAC;gBAC5B,YAAY,EAAE,GAAG,EAAE;oBACjB,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAC;gBACJ,CAAC;aACF,CAAC;YACF,MAAM;IACV,CAAC;IACD,IAAI,aAAa,EAAE,CAAC;QAClB,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,aAAa,EAAyC,CAAC;IAC9E,CAAC;IACD,OAAO,IAA2C,CAAC;AACrD,CAAC;AAED,iCAAiC;AAEjC,MAAM,CAAC,MAAM,YAAY,GAAU;IACjC,YAAY,EAAE,mBAAmB,CAAC,UAAU;IAE5C,SAAS,CACP,KAAc,EACd,IAAuB,EACvB,OAAsB;QAEtB,MAAM,QAAQ,GAAG,kBAAkB,CACjC,IAAI,EACJ,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,aAAa,CACvB,CAAC;QACF,MAAM,GAAG,GAAG,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACvC,OAAO,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED,WAAW,CACT,IAAgB,EAChB,IAAuB,EACvB,OAAsB;QAEtB,MAAM,QAAQ,GAAG,kBAAkB,CACjC,IAAI,EACJ,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,aAAa,CACvB,CAAC;QACF,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACjC,OAAO,KAAK,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED,iBAAiB,CACf,IAAa,EACb,IAAuB,EACvB,OAAsB;QAEtB,MAAM,QAAQ,GAAG,kBAAkB,CACjC,IAAI,EACJ,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,aAAa,CACvB,CAAC;QACF,OAAO,SAAS,CAAC,IAAa,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;CACF,CAAC","sourcesContent":["/**\n * Devalue codec implementation.\n *\n * Uses the `devalue` library for serialization. Handles custom types via\n * reducers (serialize) and revivers (deserialize) which are composed\n * internally based on the serialization mode.\n *\n * The reducer/reviver pattern is specific to devalue — other codecs\n * (CBOR, JSON) would handle types differently (e.g. CBOR supports Date,\n * typed arrays, Map, Set natively).\n */\n\nimport { parse, stringify, unflatten } from 'devalue';\nimport type { Codec, CodecOptions, SerializationMode } from './codec.js';\nimport { getClassReducers, getClassRevivers } from './reducers/class.js';\nimport { getCommonReducers, getCommonRevivers } from './reducers/common.js';\nimport {\n  getStepFunctionReducer,\n  getStepFunctionReviver,\n} from './reducers/step-function.js';\nimport { type Reducers, type Revivers, SerializationFormat } from './types.js';\n\nconst encoder = new TextEncoder();\nconst decoder = new TextDecoder();\n\n// ---- Reducer/Reviver composition per mode ----\n\nfunction getReducersForMode(\n  mode: SerializationMode,\n  global: Record<string, any> = globalThis,\n  extraReducers?: Record<string, (value: any) => any>\n): Record<string, (value: any) => any> {\n  let base: Partial<Reducers>;\n  switch (mode) {\n    case 'workflow':\n      // Class/Instance MUST come before common (first-match-wins for Error subclasses)\n      base = {\n        ...getClassReducers(),\n        ...getStepFunctionReducer(),\n        ...getCommonReducers(global),\n      };\n      break;\n    case 'step':\n      base = {\n        ...getClassReducers(),\n        ...getCommonReducers(global),\n      };\n      break;\n    case 'client':\n      base = {\n        ...getClassReducers(),\n        ...getCommonReducers(global),\n      };\n      break;\n  }\n  if (extraReducers) {\n    return { ...base, ...extraReducers } as Record<string, (value: any) => any>;\n  }\n  return base as Record<string, (value: any) => any>;\n}\n\nfunction getReviversForMode(\n  mode: SerializationMode,\n  global: Record<string, any> = globalThis,\n  extraRevivers?: Record<string, (value: any) => any>\n): Record<string, (value: any) => any> {\n  let base: Partial<Revivers>;\n  switch (mode) {\n    case 'workflow':\n      base = {\n        ...getClassRevivers(global),\n        ...getStepFunctionReviver(global),\n        ...getCommonRevivers(global),\n      };\n      break;\n    case 'step':\n      base = {\n        ...getClassRevivers(global),\n        ...getCommonRevivers(global),\n      };\n      break;\n    case 'client':\n      base = {\n        ...getClassRevivers(global),\n        ...getCommonRevivers(global),\n        StepFunction: () => {\n          throw new Error(\n            'Step functions cannot be deserialized in client context.'\n          );\n        },\n      };\n      break;\n  }\n  if (extraRevivers) {\n    return { ...base, ...extraRevivers } as Record<string, (value: any) => any>;\n  }\n  return base as Record<string, (value: any) => any>;\n}\n\n// ---- Codec implementation ----\n\nexport const devalueCodec: Codec = {\n  formatPrefix: SerializationFormat.DEVALUE_V1,\n\n  serialize(\n    value: unknown,\n    mode: SerializationMode,\n    options?: CodecOptions\n  ): Uint8Array {\n    const reducers = getReducersForMode(\n      mode,\n      options?.global,\n      options?.extraReducers\n    );\n    const str = stringify(value, reducers);\n    return encoder.encode(str);\n  },\n\n  deserialize(\n    data: Uint8Array,\n    mode: SerializationMode,\n    options?: CodecOptions\n  ): unknown {\n    const revivers = getReviversForMode(\n      mode,\n      options?.global,\n      options?.extraRevivers\n    );\n    const str = decoder.decode(data);\n    return parse(str, revivers);\n  },\n\n  deserializeLegacy(\n    data: unknown,\n    mode: SerializationMode,\n    options?: CodecOptions\n  ): unknown {\n    const revivers = getReviversForMode(\n      mode,\n      options?.global,\n      options?.extraRevivers\n    );\n    return unflatten(data as any[], revivers);\n  },\n};\n"]}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Codec interface for serialization formats.
|
|
3
|
+
*
|
|
4
|
+
* A codec handles the core serialize/deserialize logic for a specific
|
|
5
|
+
* wire format (devalue, CBOR, JSON, etc.). Each codec is responsible
|
|
6
|
+
* for handling all supported data types internally — the caller only
|
|
7
|
+
* specifies which serialization mode to use.
|
|
8
|
+
*
|
|
9
|
+
* - **devalue**: Uses custom reducers/revivers for Date, Error, Map, Set,
|
|
10
|
+
* typed arrays, class instances, etc.
|
|
11
|
+
* - **cbor**: Would handle Date, typed arrays, Map, Set natively via the
|
|
12
|
+
* CBOR type system. Class instances would still need custom handling.
|
|
13
|
+
* - **json**: Would only support standard JSON types (primitives, arrays,
|
|
14
|
+
* plain objects). No Date, Map, Set, typed arrays, etc.
|
|
15
|
+
*/
|
|
16
|
+
import type { FormatPrefix } from './types.js';
|
|
17
|
+
/**
|
|
18
|
+
* The serialization mode determines which types are supported and how
|
|
19
|
+
* they're handled. Different modes compose different sets of type handlers.
|
|
20
|
+
*
|
|
21
|
+
* - `workflow`: Runs inside the workflow VM. Includes class serialization,
|
|
22
|
+
* step function serialization. No stream handling.
|
|
23
|
+
* - `step`: Runs in the step handler (Node.js). Includes class serialization.
|
|
24
|
+
* No step function serialization. Stream handling at call sites.
|
|
25
|
+
* - `client`: Runs on the client side. Includes class serialization.
|
|
26
|
+
* No step function serialization. Stream handling at call sites.
|
|
27
|
+
*/
|
|
28
|
+
export type SerializationMode = 'workflow' | 'step' | 'client';
|
|
29
|
+
/**
|
|
30
|
+
* Options passed to codec serialize/deserialize to support VM-context
|
|
31
|
+
* serialization and mode-specific type handling.
|
|
32
|
+
*/
|
|
33
|
+
export interface CodecOptions {
|
|
34
|
+
/**
|
|
35
|
+
* The global object to use for `instanceof` checks and constructors.
|
|
36
|
+
* Defaults to `globalThis`. Must be set to the VM's global when
|
|
37
|
+
* serializing/deserializing data that crosses VM boundaries.
|
|
38
|
+
*/
|
|
39
|
+
global?: Record<string, any>;
|
|
40
|
+
/**
|
|
41
|
+
* Additional reducers to merge into the mode's default reducers.
|
|
42
|
+
* Used by dehydrate/hydrate functions that need stream handling
|
|
43
|
+
* or other mode-specific type reducers.
|
|
44
|
+
*/
|
|
45
|
+
extraReducers?: Record<string, (value: any) => any>;
|
|
46
|
+
/**
|
|
47
|
+
* Additional revivers to merge into the mode's default revivers.
|
|
48
|
+
* Used by dehydrate/hydrate functions that need stream handling
|
|
49
|
+
* or other mode-specific type revivers.
|
|
50
|
+
*/
|
|
51
|
+
extraRevivers?: Record<string, (value: any) => any>;
|
|
52
|
+
}
|
|
53
|
+
export interface Codec {
|
|
54
|
+
/** The 4-character format prefix identifier (e.g. "devl", "cbor", "json") */
|
|
55
|
+
readonly formatPrefix: FormatPrefix;
|
|
56
|
+
/**
|
|
57
|
+
* Serialize a value to bytes.
|
|
58
|
+
*
|
|
59
|
+
* The codec handles all supported types internally based on the mode.
|
|
60
|
+
*
|
|
61
|
+
* @param value - The value to serialize
|
|
62
|
+
* @param mode - The serialization mode
|
|
63
|
+
* @param options - Optional global, extra reducers/revivers
|
|
64
|
+
* @returns The serialized payload (without format prefix)
|
|
65
|
+
*/
|
|
66
|
+
serialize(value: unknown, mode: SerializationMode, options?: CodecOptions): Uint8Array;
|
|
67
|
+
/**
|
|
68
|
+
* Deserialize bytes back to a value.
|
|
69
|
+
*
|
|
70
|
+
* The codec handles all supported types internally based on the mode.
|
|
71
|
+
*
|
|
72
|
+
* @param data - The serialized payload (without format prefix)
|
|
73
|
+
* @param mode - The serialization mode
|
|
74
|
+
* @param options - Optional global, extra revivers
|
|
75
|
+
* @returns The deserialized value
|
|
76
|
+
*/
|
|
77
|
+
deserialize(data: Uint8Array, mode: SerializationMode, options?: CodecOptions): unknown;
|
|
78
|
+
/**
|
|
79
|
+
* Deserialize legacy (pre-format-prefix) data.
|
|
80
|
+
* Used for backwards compatibility with specVersion 1 runs that stored
|
|
81
|
+
* data as plain JSON arrays instead of binary.
|
|
82
|
+
*
|
|
83
|
+
* @param data - The legacy data
|
|
84
|
+
* @param mode - The serialization mode
|
|
85
|
+
* @param options - Optional global, extra revivers
|
|
86
|
+
* @returns The deserialized value
|
|
87
|
+
*/
|
|
88
|
+
deserializeLegacy?(data: unknown, mode: SerializationMode, options?: CodecOptions): unknown;
|
|
89
|
+
}
|
|
90
|
+
//# sourceMappingURL=codec.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"codec.d.ts","sourceRoot":"","sources":["../../src/serialization/codec.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C;;;;;;;;;;GAUG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE/D;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE7B;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC,CAAC;IAEpD;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,KAAK;IACpB,6EAA6E;IAC7E,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAEpC;;;;;;;;;OASG;IACH,SAAS,CACP,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,YAAY,GACrB,UAAU,CAAC;IAEd;;;;;;;;;OASG;IACH,WAAW,CACT,IAAI,EAAE,UAAU,EAChB,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC;IAEX;;;;;;;;;OASG;IACH,iBAAiB,CAAC,CAChB,IAAI,EAAE,OAAO,EACb,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC;CACZ"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Codec interface for serialization formats.
|
|
3
|
+
*
|
|
4
|
+
* A codec handles the core serialize/deserialize logic for a specific
|
|
5
|
+
* wire format (devalue, CBOR, JSON, etc.). Each codec is responsible
|
|
6
|
+
* for handling all supported data types internally — the caller only
|
|
7
|
+
* specifies which serialization mode to use.
|
|
8
|
+
*
|
|
9
|
+
* - **devalue**: Uses custom reducers/revivers for Date, Error, Map, Set,
|
|
10
|
+
* typed arrays, class instances, etc.
|
|
11
|
+
* - **cbor**: Would handle Date, typed arrays, Map, Set natively via the
|
|
12
|
+
* CBOR type system. Class instances would still need custom handling.
|
|
13
|
+
* - **json**: Would only support standard JSON types (primitives, arrays,
|
|
14
|
+
* plain objects). No Date, Map, Set, typed arrays, etc.
|
|
15
|
+
*/
|
|
16
|
+
export {};
|
|
17
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29kZWMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvc2VyaWFsaXphdGlvbi9jb2RlYy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7Ozs7Ozs7Ozs7R0FjRyIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogQ29kZWMgaW50ZXJmYWNlIGZvciBzZXJpYWxpemF0aW9uIGZvcm1hdHMuXG4gKlxuICogQSBjb2RlYyBoYW5kbGVzIHRoZSBjb3JlIHNlcmlhbGl6ZS9kZXNlcmlhbGl6ZSBsb2dpYyBmb3IgYSBzcGVjaWZpY1xuICogd2lyZSBmb3JtYXQgKGRldmFsdWUsIENCT1IsIEpTT04sIGV0Yy4pLiBFYWNoIGNvZGVjIGlzIHJlc3BvbnNpYmxlXG4gKiBmb3IgaGFuZGxpbmcgYWxsIHN1cHBvcnRlZCBkYXRhIHR5cGVzIGludGVybmFsbHkg4oCUIHRoZSBjYWxsZXIgb25seVxuICogc3BlY2lmaWVzIHdoaWNoIHNlcmlhbGl6YXRpb24gbW9kZSB0byB1c2UuXG4gKlxuICogLSAqKmRldmFsdWUqKjogVXNlcyBjdXN0b20gcmVkdWNlcnMvcmV2aXZlcnMgZm9yIERhdGUsIEVycm9yLCBNYXAsIFNldCxcbiAqICAgdHlwZWQgYXJyYXlzLCBjbGFzcyBpbnN0YW5jZXMsIGV0Yy5cbiAqIC0gKipjYm9yKio6IFdvdWxkIGhhbmRsZSBEYXRlLCB0eXBlZCBhcnJheXMsIE1hcCwgU2V0IG5hdGl2ZWx5IHZpYSB0aGVcbiAqICAgQ0JPUiB0eXBlIHN5c3RlbS4gQ2xhc3MgaW5zdGFuY2VzIHdvdWxkIHN0aWxsIG5lZWQgY3VzdG9tIGhhbmRsaW5nLlxuICogLSAqKmpzb24qKjogV291bGQgb25seSBzdXBwb3J0IHN0YW5kYXJkIEpTT04gdHlwZXMgKHByaW1pdGl2ZXMsIGFycmF5cyxcbiAqICAgcGxhaW4gb2JqZWN0cykuIE5vIERhdGUsIE1hcCwgU2V0LCB0eXBlZCBhcnJheXMsIGV0Yy5cbiAqL1xuXG5pbXBvcnQgdHlwZSB7IEZvcm1hdFByZWZpeCB9IGZyb20gJy4vdHlwZXMuanMnO1xuXG4vKipcbiAqIFRoZSBzZXJpYWxpemF0aW9uIG1vZGUgZGV0ZXJtaW5lcyB3aGljaCB0eXBlcyBhcmUgc3VwcG9ydGVkIGFuZCBob3dcbiAqIHRoZXkncmUgaGFuZGxlZC4gRGlmZmVyZW50IG1vZGVzIGNvbXBvc2UgZGlmZmVyZW50IHNldHMgb2YgdHlwZSBoYW5kbGVycy5cbiAqXG4gKiAtIGB3b3JrZmxvd2A6IFJ1bnMgaW5zaWRlIHRoZSB3b3JrZmxvdyBWTS4gSW5jbHVkZXMgY2xhc3Mgc2VyaWFsaXphdGlvbixcbiAqICAgc3RlcCBmdW5jdGlvbiBzZXJpYWxpemF0aW9uLiBObyBzdHJlYW0gaGFuZGxpbmcuXG4gKiAtIGBzdGVwYDogUnVucyBpbiB0aGUgc3RlcCBoYW5kbGVyIChOb2RlLmpzKS4gSW5jbHVkZXMgY2xhc3Mgc2VyaWFsaXphdGlvbi5cbiAqICAgTm8gc3RlcCBmdW5jdGlvbiBzZXJpYWxpemF0aW9uLiBTdHJlYW0gaGFuZGxpbmcgYXQgY2FsbCBzaXRlcy5cbiAqIC0gYGNsaWVudGA6IFJ1bnMgb24gdGhlIGNsaWVudCBzaWRlLiBJbmNsdWRlcyBjbGFzcyBzZXJpYWxpemF0aW9uLlxuICogICBObyBzdGVwIGZ1bmN0aW9uIHNlcmlhbGl6YXRpb24uIFN0cmVhbSBoYW5kbGluZyBhdCBjYWxsIHNpdGVzLlxuICovXG5leHBvcnQgdHlwZSBTZXJpYWxpemF0aW9uTW9kZSA9ICd3b3JrZmxvdycgfCAnc3RlcCcgfCAnY2xpZW50JztcblxuLyoqXG4gKiBPcHRpb25zIHBhc3NlZCB0byBjb2RlYyBzZXJpYWxpemUvZGVzZXJpYWxpemUgdG8gc3VwcG9ydCBWTS1jb250ZXh0XG4gKiBzZXJpYWxpemF0aW9uIGFuZCBtb2RlLXNwZWNpZmljIHR5cGUgaGFuZGxpbmcuXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgQ29kZWNPcHRpb25zIHtcbiAgLyoqXG4gICAqIFRoZSBnbG9iYWwgb2JqZWN0IHRvIHVzZSBmb3IgYGluc3RhbmNlb2ZgIGNoZWNrcyBhbmQgY29uc3RydWN0b3JzLlxuICAgKiBEZWZhdWx0cyB0byBgZ2xvYmFsVGhpc2AuIE11c3QgYmUgc2V0IHRvIHRoZSBWTSdzIGdsb2JhbCB3aGVuXG4gICAqIHNlcmlhbGl6aW5nL2Rlc2VyaWFsaXppbmcgZGF0YSB0aGF0IGNyb3NzZXMgVk0gYm91bmRhcmllcy5cbiAgICovXG4gIGdsb2JhbD86IFJlY29yZDxzdHJpbmcsIGFueT47XG5cbiAgLyoqXG4gICAqIEFkZGl0aW9uYWwgcmVkdWNlcnMgdG8gbWVyZ2UgaW50byB0aGUgbW9kZSdzIGRlZmF1bHQgcmVkdWNlcnMuXG4gICAqIFVzZWQgYnkgZGVoeWRyYXRlL2h5ZHJhdGUgZnVuY3Rpb25zIHRoYXQgbmVlZCBzdHJlYW0gaGFuZGxpbmdcbiAgICogb3Igb3RoZXIgbW9kZS1zcGVjaWZpYyB0eXBlIHJlZHVjZXJzLlxuICAgKi9cbiAgZXh0cmFSZWR1Y2Vycz86IFJlY29yZDxzdHJpbmcsICh2YWx1ZTogYW55KSA9PiBhbnk+O1xuXG4gIC8qKlxuICAgKiBBZGRpdGlvbmFsIHJldml2ZXJzIHRvIG1lcmdlIGludG8gdGhlIG1vZGUncyBkZWZhdWx0IHJldml2ZXJzLlxuICAgKiBVc2VkIGJ5IGRlaHlkcmF0ZS9oeWRyYXRlIGZ1bmN0aW9ucyB0aGF0IG5lZWQgc3RyZWFtIGhhbmRsaW5nXG4gICAqIG9yIG90aGVyIG1vZGUtc3BlY2lmaWMgdHlwZSByZXZpdmVycy5cbiAgICovXG4gIGV4dHJhUmV2aXZlcnM/OiBSZWNvcmQ8c3RyaW5nLCAodmFsdWU6IGFueSkgPT4gYW55Pjtcbn1cblxuZXhwb3J0IGludGVyZmFjZSBDb2RlYyB7XG4gIC8qKiBUaGUgNC1jaGFyYWN0ZXIgZm9ybWF0IHByZWZpeCBpZGVudGlmaWVyIChlLmcuIFwiZGV2bFwiLCBcImNib3JcIiwgXCJqc29uXCIpICovXG4gIHJlYWRvbmx5IGZvcm1hdFByZWZpeDogRm9ybWF0UHJlZml4O1xuXG4gIC8qKlxuICAgKiBTZXJpYWxpemUgYSB2YWx1ZSB0byBieXRlcy5cbiAgICpcbiAgICogVGhlIGNvZGVjIGhhbmRsZXMgYWxsIHN1cHBvcnRlZCB0eXBlcyBpbnRlcm5hbGx5IGJhc2VkIG9uIHRoZSBtb2RlLlxuICAgKlxuICAgKiBAcGFyYW0gdmFsdWUgLSBUaGUgdmFsdWUgdG8gc2VyaWFsaXplXG4gICAqIEBwYXJhbSBtb2RlIC0gVGhlIHNlcmlhbGl6YXRpb24gbW9kZVxuICAgKiBAcGFyYW0gb3B0aW9ucyAtIE9wdGlvbmFsIGdsb2JhbCwgZXh0cmEgcmVkdWNlcnMvcmV2aXZlcnNcbiAgICogQHJldHVybnMgVGhlIHNlcmlhbGl6ZWQgcGF5bG9hZCAod2l0aG91dCBmb3JtYXQgcHJlZml4KVxuICAgKi9cbiAgc2VyaWFsaXplKFxuICAgIHZhbHVlOiB1bmtub3duLFxuICAgIG1vZGU6IFNlcmlhbGl6YXRpb25Nb2RlLFxuICAgIG9wdGlvbnM/OiBDb2RlY09wdGlvbnNcbiAgKTogVWludDhBcnJheTtcblxuICAvKipcbiAgICogRGVzZXJpYWxpemUgYnl0ZXMgYmFjayB0byBhIHZhbHVlLlxuICAgKlxuICAgKiBUaGUgY29kZWMgaGFuZGxlcyBhbGwgc3VwcG9ydGVkIHR5cGVzIGludGVybmFsbHkgYmFzZWQgb24gdGhlIG1vZGUuXG4gICAqXG4gICAqIEBwYXJhbSBkYXRhIC0gVGhlIHNlcmlhbGl6ZWQgcGF5bG9hZCAod2l0aG91dCBmb3JtYXQgcHJlZml4KVxuICAgKiBAcGFyYW0gbW9kZSAtIFRoZSBzZXJpYWxpemF0aW9uIG1vZGVcbiAgICogQHBhcmFtIG9wdGlvbnMgLSBPcHRpb25hbCBnbG9iYWwsIGV4dHJhIHJldml2ZXJzXG4gICAqIEByZXR1cm5zIFRoZSBkZXNlcmlhbGl6ZWQgdmFsdWVcbiAgICovXG4gIGRlc2VyaWFsaXplKFxuICAgIGRhdGE6IFVpbnQ4QXJyYXksXG4gICAgbW9kZTogU2VyaWFsaXphdGlvbk1vZGUsXG4gICAgb3B0aW9ucz86IENvZGVjT3B0aW9uc1xuICApOiB1bmtub3duO1xuXG4gIC8qKlxuICAgKiBEZXNlcmlhbGl6ZSBsZWdhY3kgKHByZS1mb3JtYXQtcHJlZml4KSBkYXRhLlxuICAgKiBVc2VkIGZvciBiYWNrd2FyZHMgY29tcGF0aWJpbGl0eSB3aXRoIHNwZWNWZXJzaW9uIDEgcnVucyB0aGF0IHN0b3JlZFxuICAgKiBkYXRhIGFzIHBsYWluIEpTT04gYXJyYXlzIGluc3RlYWQgb2YgYmluYXJ5LlxuICAgKlxuICAgKiBAcGFyYW0gZGF0YSAtIFRoZSBsZWdhY3kgZGF0YVxuICAgKiBAcGFyYW0gbW9kZSAtIFRoZSBzZXJpYWxpemF0aW9uIG1vZGVcbiAgICogQHBhcmFtIG9wdGlvbnMgLSBPcHRpb25hbCBnbG9iYWwsIGV4dHJhIHJldml2ZXJzXG4gICAqIEByZXR1cm5zIFRoZSBkZXNlcmlhbGl6ZWQgdmFsdWVcbiAgICovXG4gIGRlc2VyaWFsaXplTGVnYWN5PyhcbiAgICBkYXRhOiB1bmtub3duLFxuICAgIG1vZGU6IFNlcmlhbGl6YXRpb25Nb2RlLFxuICAgIG9wdGlvbnM/OiBDb2RlY09wdGlvbnNcbiAgKTogdW5rbm93bjtcbn1cbiJdfQ==
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Composable encryption layer for serialized data.
|
|
3
|
+
*
|
|
4
|
+
* Wraps/unwraps serialized payloads with AES-256-GCM encryption,
|
|
5
|
+
* using the format prefix system to mark encrypted data.
|
|
6
|
+
*/
|
|
7
|
+
import { type CryptoKey } from '../encryption.js';
|
|
8
|
+
export type { CryptoKey };
|
|
9
|
+
/**
|
|
10
|
+
* Encryption key parameter type. Accepts a resolved key, undefined (no encryption),
|
|
11
|
+
* or a promise that resolves to either.
|
|
12
|
+
*/
|
|
13
|
+
export type EncryptionKeyParam = CryptoKey | undefined | Promise<CryptoKey | undefined>;
|
|
14
|
+
/**
|
|
15
|
+
* Encrypt a format-prefixed payload if a key is provided.
|
|
16
|
+
* Wraps the data with the 'encr' format prefix.
|
|
17
|
+
*
|
|
18
|
+
* @param data - The format-prefixed serialized data
|
|
19
|
+
* @param key - Encryption key (undefined to skip encryption)
|
|
20
|
+
* @returns The encrypted data with 'encr' prefix, or the original data if no key
|
|
21
|
+
*/
|
|
22
|
+
export declare function encrypt(data: Uint8Array | unknown, key: CryptoKey | undefined): Promise<Uint8Array | unknown>;
|
|
23
|
+
/**
|
|
24
|
+
* Decrypt a format-prefixed payload if it's encrypted.
|
|
25
|
+
* Strips the 'encr' format prefix and decrypts the inner payload.
|
|
26
|
+
*
|
|
27
|
+
* @param data - The potentially encrypted data
|
|
28
|
+
* @param key - Encryption key (undefined to skip decryption)
|
|
29
|
+
* @returns The decrypted inner payload, or the original data if not encrypted
|
|
30
|
+
*/
|
|
31
|
+
export declare function decrypt(data: Uint8Array | unknown, key: CryptoKey | undefined): Promise<Uint8Array | unknown>;
|
|
32
|
+
//# sourceMappingURL=encryption.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"encryption.d.ts","sourceRoot":"","sources":["../../src/serialization/encryption.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAGL,KAAK,SAAS,EACf,MAAM,kBAAkB,CAAC;AAQ1B,YAAY,EAAE,SAAS,EAAE,CAAC;AAE1B;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAC1B,SAAS,GACT,SAAS,GACT,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;AAEnC;;;;;;;GAOG;AACH,wBAAsB,OAAO,CAC3B,IAAI,EAAE,UAAU,GAAG,OAAO,EAC1B,GAAG,EAAE,SAAS,GAAG,SAAS,GACzB,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,CAI/B;AAED;;;;;;;GAOG;AACH,wBAAsB,OAAO,CAC3B,IAAI,EAAE,UAAU,GAAG,OAAO,EAC1B,GAAG,EAAE,SAAS,GAAG,SAAS,GACzB,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,CAqB/B"}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Composable encryption layer for serialized data.
|
|
3
|
+
*
|
|
4
|
+
* Wraps/unwraps serialized payloads with AES-256-GCM encryption,
|
|
5
|
+
* using the format prefix system to mark encrypted data.
|
|
6
|
+
*/
|
|
7
|
+
import { WorkflowRuntimeError } from '@workflow/errors';
|
|
8
|
+
import { decrypt as aesGcmDecrypt, encrypt as aesGcmEncrypt, } from '../encryption.js';
|
|
9
|
+
import { decodeFormatPrefix, encodeWithFormatPrefix, peekFormatPrefix, } from './format.js';
|
|
10
|
+
import { SerializationFormat } from './types.js';
|
|
11
|
+
/**
|
|
12
|
+
* Encrypt a format-prefixed payload if a key is provided.
|
|
13
|
+
* Wraps the data with the 'encr' format prefix.
|
|
14
|
+
*
|
|
15
|
+
* @param data - The format-prefixed serialized data
|
|
16
|
+
* @param key - Encryption key (undefined to skip encryption)
|
|
17
|
+
* @returns The encrypted data with 'encr' prefix, or the original data if no key
|
|
18
|
+
*/
|
|
19
|
+
export async function encrypt(data, key) {
|
|
20
|
+
if (!key || !(data instanceof Uint8Array))
|
|
21
|
+
return data;
|
|
22
|
+
const encrypted = await aesGcmEncrypt(key, data);
|
|
23
|
+
return encodeWithFormatPrefix(SerializationFormat.ENCRYPTED, encrypted);
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Decrypt a format-prefixed payload if it's encrypted.
|
|
27
|
+
* Strips the 'encr' format prefix and decrypts the inner payload.
|
|
28
|
+
*
|
|
29
|
+
* @param data - The potentially encrypted data
|
|
30
|
+
* @param key - Encryption key (undefined to skip decryption)
|
|
31
|
+
* @returns The decrypted inner payload, or the original data if not encrypted
|
|
32
|
+
*/
|
|
33
|
+
export async function decrypt(data, key) {
|
|
34
|
+
// Non-binary data is returned as-is.
|
|
35
|
+
if (!(data instanceof Uint8Array))
|
|
36
|
+
return data;
|
|
37
|
+
const format = peekFormatPrefix(data);
|
|
38
|
+
// If the data is encrypted but no key was provided, fail fast.
|
|
39
|
+
// Uses WorkflowRuntimeError to preserve the error contract from the
|
|
40
|
+
// legacy maybeDecrypt() implementation that callers may rely on.
|
|
41
|
+
if (format === SerializationFormat.ENCRYPTED && !key) {
|
|
42
|
+
throw new WorkflowRuntimeError('Encrypted data encountered but no encryption key is available. ' +
|
|
43
|
+
'Encryption is not configured or no key was provided for this run.');
|
|
44
|
+
}
|
|
45
|
+
// If the data is not encrypted, return it unchanged.
|
|
46
|
+
if (format !== SerializationFormat.ENCRYPTED)
|
|
47
|
+
return data;
|
|
48
|
+
const { payload } = decodeFormatPrefix(data);
|
|
49
|
+
return aesGcmDecrypt(key, payload);
|
|
50
|
+
}
|
|
51
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZW5jcnlwdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9zZXJpYWxpemF0aW9uL2VuY3J5cHRpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUE7Ozs7O0dBS0c7QUFFSCxPQUFPLEVBQUUsb0JBQW9CLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUN4RCxPQUFPLEVBQ0wsT0FBTyxJQUFJLGFBQWEsRUFDeEIsT0FBTyxJQUFJLGFBQWEsR0FFekIsTUFBTSxrQkFBa0IsQ0FBQztBQUMxQixPQUFPLEVBQ0wsa0JBQWtCLEVBQ2xCLHNCQUFzQixFQUN0QixnQkFBZ0IsR0FDakIsTUFBTSxhQUFhLENBQUM7QUFDckIsT0FBTyxFQUFFLG1CQUFtQixFQUFFLE1BQU0sWUFBWSxDQUFDO0FBYWpEOzs7Ozs7O0dBT0c7QUFDSCxNQUFNLENBQUMsS0FBSyxVQUFVLE9BQU8sQ0FDM0IsSUFBMEIsRUFDMUIsR0FBMEI7SUFFMUIsSUFBSSxDQUFDLEdBQUcsSUFBSSxDQUFDLENBQUMsSUFBSSxZQUFZLFVBQVUsQ0FBQztRQUFFLE9BQU8sSUFBSSxDQUFDO0lBQ3ZELE1BQU0sU0FBUyxHQUFHLE1BQU0sYUFBYSxDQUFDLEdBQUcsRUFBRSxJQUFJLENBQUMsQ0FBQztJQUNqRCxPQUFPLHNCQUFzQixDQUFDLG1CQUFtQixDQUFDLFNBQVMsRUFBRSxTQUFTLENBQUMsQ0FBQztBQUMxRSxDQUFDO0FBRUQ7Ozs7Ozs7R0FPRztBQUNILE1BQU0sQ0FBQyxLQUFLLFVBQVUsT0FBTyxDQUMzQixJQUEwQixFQUMxQixHQUEwQjtJQUUxQixxQ0FBcUM7SUFDckMsSUFBSSxDQUFDLENBQUMsSUFBSSxZQUFZLFVBQVUsQ0FBQztRQUFFLE9BQU8sSUFBSSxDQUFDO0lBRS9DLE1BQU0sTUFBTSxHQUFHLGdCQUFnQixDQUFDLElBQUksQ0FBQyxDQUFDO0lBRXRDLCtEQUErRDtJQUMvRCxvRUFBb0U7SUFDcEUsaUVBQWlFO0lBQ2pFLElBQUksTUFBTSxLQUFLLG1CQUFtQixDQUFDLFNBQVMsSUFBSSxDQUFDLEdBQUcsRUFBRSxDQUFDO1FBQ3JELE1BQU0sSUFBSSxvQkFBb0IsQ0FDNUIsaUVBQWlFO1lBQy9ELG1FQUFtRSxDQUN0RSxDQUFDO0lBQ0osQ0FBQztJQUVELHFEQUFxRDtJQUNyRCxJQUFJLE1BQU0sS0FBSyxtQkFBbUIsQ0FBQyxTQUFTO1FBQUUsT0FBTyxJQUFJLENBQUM7SUFFMUQsTUFBTSxFQUFFLE9BQU8sRUFBRSxHQUFHLGtCQUFrQixDQUFDLElBQUksQ0FBQyxDQUFDO0lBQzdDLE9BQU8sYUFBYSxDQUFDLEdBQUksRUFBRSxPQUFPLENBQUMsQ0FBQztBQUN0QyxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBDb21wb3NhYmxlIGVuY3J5cHRpb24gbGF5ZXIgZm9yIHNlcmlhbGl6ZWQgZGF0YS5cbiAqXG4gKiBXcmFwcy91bndyYXBzIHNlcmlhbGl6ZWQgcGF5bG9hZHMgd2l0aCBBRVMtMjU2LUdDTSBlbmNyeXB0aW9uLFxuICogdXNpbmcgdGhlIGZvcm1hdCBwcmVmaXggc3lzdGVtIHRvIG1hcmsgZW5jcnlwdGVkIGRhdGEuXG4gKi9cblxuaW1wb3J0IHsgV29ya2Zsb3dSdW50aW1lRXJyb3IgfSBmcm9tICdAd29ya2Zsb3cvZXJyb3JzJztcbmltcG9ydCB7XG4gIGRlY3J5cHQgYXMgYWVzR2NtRGVjcnlwdCxcbiAgZW5jcnlwdCBhcyBhZXNHY21FbmNyeXB0LFxuICB0eXBlIENyeXB0b0tleSxcbn0gZnJvbSAnLi4vZW5jcnlwdGlvbi5qcyc7XG5pbXBvcnQge1xuICBkZWNvZGVGb3JtYXRQcmVmaXgsXG4gIGVuY29kZVdpdGhGb3JtYXRQcmVmaXgsXG4gIHBlZWtGb3JtYXRQcmVmaXgsXG59IGZyb20gJy4vZm9ybWF0LmpzJztcbmltcG9ydCB7IFNlcmlhbGl6YXRpb25Gb3JtYXQgfSBmcm9tICcuL3R5cGVzLmpzJztcblxuZXhwb3J0IHR5cGUgeyBDcnlwdG9LZXkgfTtcblxuLyoqXG4gKiBFbmNyeXB0aW9uIGtleSBwYXJhbWV0ZXIgdHlwZS4gQWNjZXB0cyBhIHJlc29sdmVkIGtleSwgdW5kZWZpbmVkIChubyBlbmNyeXB0aW9uKSxcbiAqIG9yIGEgcHJvbWlzZSB0aGF0IHJlc29sdmVzIHRvIGVpdGhlci5cbiAqL1xuZXhwb3J0IHR5cGUgRW5jcnlwdGlvbktleVBhcmFtID1cbiAgfCBDcnlwdG9LZXlcbiAgfCB1bmRlZmluZWRcbiAgfCBQcm9taXNlPENyeXB0b0tleSB8IHVuZGVmaW5lZD47XG5cbi8qKlxuICogRW5jcnlwdCBhIGZvcm1hdC1wcmVmaXhlZCBwYXlsb2FkIGlmIGEga2V5IGlzIHByb3ZpZGVkLlxuICogV3JhcHMgdGhlIGRhdGEgd2l0aCB0aGUgJ2VuY3InIGZvcm1hdCBwcmVmaXguXG4gKlxuICogQHBhcmFtIGRhdGEgLSBUaGUgZm9ybWF0LXByZWZpeGVkIHNlcmlhbGl6ZWQgZGF0YVxuICogQHBhcmFtIGtleSAtIEVuY3J5cHRpb24ga2V5ICh1bmRlZmluZWQgdG8gc2tpcCBlbmNyeXB0aW9uKVxuICogQHJldHVybnMgVGhlIGVuY3J5cHRlZCBkYXRhIHdpdGggJ2VuY3InIHByZWZpeCwgb3IgdGhlIG9yaWdpbmFsIGRhdGEgaWYgbm8ga2V5XG4gKi9cbmV4cG9ydCBhc3luYyBmdW5jdGlvbiBlbmNyeXB0KFxuICBkYXRhOiBVaW50OEFycmF5IHwgdW5rbm93bixcbiAga2V5OiBDcnlwdG9LZXkgfCB1bmRlZmluZWRcbik6IFByb21pc2U8VWludDhBcnJheSB8IHVua25vd24+IHtcbiAgaWYgKCFrZXkgfHwgIShkYXRhIGluc3RhbmNlb2YgVWludDhBcnJheSkpIHJldHVybiBkYXRhO1xuICBjb25zdCBlbmNyeXB0ZWQgPSBhd2FpdCBhZXNHY21FbmNyeXB0KGtleSwgZGF0YSk7XG4gIHJldHVybiBlbmNvZGVXaXRoRm9ybWF0UHJlZml4KFNlcmlhbGl6YXRpb25Gb3JtYXQuRU5DUllQVEVELCBlbmNyeXB0ZWQpO1xufVxuXG4vKipcbiAqIERlY3J5cHQgYSBmb3JtYXQtcHJlZml4ZWQgcGF5bG9hZCBpZiBpdCdzIGVuY3J5cHRlZC5cbiAqIFN0cmlwcyB0aGUgJ2VuY3InIGZvcm1hdCBwcmVmaXggYW5kIGRlY3J5cHRzIHRoZSBpbm5lciBwYXlsb2FkLlxuICpcbiAqIEBwYXJhbSBkYXRhIC0gVGhlIHBvdGVudGlhbGx5IGVuY3J5cHRlZCBkYXRhXG4gKiBAcGFyYW0ga2V5IC0gRW5jcnlwdGlvbiBrZXkgKHVuZGVmaW5lZCB0byBza2lwIGRlY3J5cHRpb24pXG4gKiBAcmV0dXJucyBUaGUgZGVjcnlwdGVkIGlubmVyIHBheWxvYWQsIG9yIHRoZSBvcmlnaW5hbCBkYXRhIGlmIG5vdCBlbmNyeXB0ZWRcbiAqL1xuZXhwb3J0IGFzeW5jIGZ1bmN0aW9uIGRlY3J5cHQoXG4gIGRhdGE6IFVpbnQ4QXJyYXkgfCB1bmtub3duLFxuICBrZXk6IENyeXB0b0tleSB8IHVuZGVmaW5lZFxuKTogUHJvbWlzZTxVaW50OEFycmF5IHwgdW5rbm93bj4ge1xuICAvLyBOb24tYmluYXJ5IGRhdGEgaXMgcmV0dXJuZWQgYXMtaXMuXG4gIGlmICghKGRhdGEgaW5zdGFuY2VvZiBVaW50OEFycmF5KSkgcmV0dXJuIGRhdGE7XG5cbiAgY29uc3QgZm9ybWF0ID0gcGVla0Zvcm1hdFByZWZpeChkYXRhKTtcblxuICAvLyBJZiB0aGUgZGF0YSBpcyBlbmNyeXB0ZWQgYnV0IG5vIGtleSB3YXMgcHJvdmlkZWQsIGZhaWwgZmFzdC5cbiAgLy8gVXNlcyBXb3JrZmxvd1J1bnRpbWVFcnJvciB0byBwcmVzZXJ2ZSB0aGUgZXJyb3IgY29udHJhY3QgZnJvbSB0aGVcbiAgLy8gbGVnYWN5IG1heWJlRGVjcnlwdCgpIGltcGxlbWVudGF0aW9uIHRoYXQgY2FsbGVycyBtYXkgcmVseSBvbi5cbiAgaWYgKGZvcm1hdCA9PT0gU2VyaWFsaXphdGlvbkZvcm1hdC5FTkNSWVBURUQgJiYgIWtleSkge1xuICAgIHRocm93IG5ldyBXb3JrZmxvd1J1bnRpbWVFcnJvcihcbiAgICAgICdFbmNyeXB0ZWQgZGF0YSBlbmNvdW50ZXJlZCBidXQgbm8gZW5jcnlwdGlvbiBrZXkgaXMgYXZhaWxhYmxlLiAnICtcbiAgICAgICAgJ0VuY3J5cHRpb24gaXMgbm90IGNvbmZpZ3VyZWQgb3Igbm8ga2V5IHdhcyBwcm92aWRlZCBmb3IgdGhpcyBydW4uJ1xuICAgICk7XG4gIH1cblxuICAvLyBJZiB0aGUgZGF0YSBpcyBub3QgZW5jcnlwdGVkLCByZXR1cm4gaXQgdW5jaGFuZ2VkLlxuICBpZiAoZm9ybWF0ICE9PSBTZXJpYWxpemF0aW9uRm9ybWF0LkVOQ1JZUFRFRCkgcmV0dXJuIGRhdGE7XG5cbiAgY29uc3QgeyBwYXlsb2FkIH0gPSBkZWNvZGVGb3JtYXRQcmVmaXgoZGF0YSk7XG4gIHJldHVybiBhZXNHY21EZWNyeXB0KGtleSEsIHBheWxvYWQpO1xufVxuIl19
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Shared error formatting utility for serialization failures.
|
|
3
|
+
*
|
|
4
|
+
* Used by the mode-specific serializers (workflow, step, client) to
|
|
5
|
+
* produce consistent error messages with devalue path information.
|
|
6
|
+
*
|
|
7
|
+
* Returns a `{ message, hint }` pair so callers can throw a
|
|
8
|
+
* `SerializationError(message, { hint, cause })` and have the hint flow
|
|
9
|
+
* through the standard friendly-errors framing instead of being baked
|
|
10
|
+
* into the message string.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Format a serialization error with context about what failed.
|
|
14
|
+
* Extracts path, value, and reason from devalue's DevalueError when available.
|
|
15
|
+
* Logs the problematic value to the console for better debugging.
|
|
16
|
+
*/
|
|
17
|
+
export declare function formatSerializationError(context: string, error: unknown): {
|
|
18
|
+
message: string;
|
|
19
|
+
hint: string;
|
|
20
|
+
};
|
|
21
|
+
//# sourceMappingURL=errors.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/serialization/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAKH;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,OAAO,GACb;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAqBnC"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Shared error formatting utility for serialization failures.
|
|
3
|
+
*
|
|
4
|
+
* Used by the mode-specific serializers (workflow, step, client) to
|
|
5
|
+
* produce consistent error messages with devalue path information.
|
|
6
|
+
*
|
|
7
|
+
* Returns a `{ message, hint }` pair so callers can throw a
|
|
8
|
+
* `SerializationError(message, { hint, cause })` and have the hint flow
|
|
9
|
+
* through the standard friendly-errors framing instead of being baked
|
|
10
|
+
* into the message string.
|
|
11
|
+
*/
|
|
12
|
+
import { DevalueError } from 'devalue';
|
|
13
|
+
import { runtimeLogger } from '../logger.js';
|
|
14
|
+
/**
|
|
15
|
+
* Format a serialization error with context about what failed.
|
|
16
|
+
* Extracts path, value, and reason from devalue's DevalueError when available.
|
|
17
|
+
* Logs the problematic value to the console for better debugging.
|
|
18
|
+
*/
|
|
19
|
+
export function formatSerializationError(context, error) {
|
|
20
|
+
// `returning` for outputs, `passing` for everything that crosses the
|
|
21
|
+
// boundary the other way (arguments, stream messages, etc.).
|
|
22
|
+
const verb = context.includes('return value') ? 'returning' : 'passing';
|
|
23
|
+
let message = `Failed to serialize ${context}`;
|
|
24
|
+
if (error instanceof DevalueError && error.path) {
|
|
25
|
+
message += ` at path "${error.path}"`;
|
|
26
|
+
}
|
|
27
|
+
// Workflow can serialize a much richer set than the devalue defaults —
|
|
28
|
+
// classes registered via `WORKFLOW_SERIALIZE`, FatalError / RetryableError
|
|
29
|
+
// subclasses, AbortSignal, etc. Pointing at the foundations doc keeps
|
|
30
|
+
// this hint accurate as the supported set grows, instead of repeating
|
|
31
|
+
// a hardcoded list that drifts out of sync.
|
|
32
|
+
const hint = `Ensure you're ${verb} workflow serializable types. Check the serialization docs to see what's serializable: https://workflow-sdk.dev/docs/foundations/serialization`;
|
|
33
|
+
if (error instanceof DevalueError && error.value !== undefined) {
|
|
34
|
+
runtimeLogger.error('Serialization failed', {
|
|
35
|
+
context,
|
|
36
|
+
problematicValue: error.value,
|
|
37
|
+
});
|
|
38
|
+
}
|
|
39
|
+
return { message, hint };
|
|
40
|
+
}
|
|
41
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXJyb3JzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3NlcmlhbGl6YXRpb24vZXJyb3JzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOzs7Ozs7Ozs7O0dBVUc7QUFFSCxPQUFPLEVBQUUsWUFBWSxFQUFFLE1BQU0sU0FBUyxDQUFDO0FBQ3ZDLE9BQU8sRUFBRSxhQUFhLEVBQUUsTUFBTSxjQUFjLENBQUM7QUFFN0M7Ozs7R0FJRztBQUNILE1BQU0sVUFBVSx3QkFBd0IsQ0FDdEMsT0FBZSxFQUNmLEtBQWM7SUFFZCxxRUFBcUU7SUFDckUsNkRBQTZEO0lBQzdELE1BQU0sSUFBSSxHQUFHLE9BQU8sQ0FBQyxRQUFRLENBQUMsY0FBYyxDQUFDLENBQUMsQ0FBQyxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUMsU0FBUyxDQUFDO0lBQ3hFLElBQUksT0FBTyxHQUFHLHVCQUF1QixPQUFPLEVBQUUsQ0FBQztJQUMvQyxJQUFJLEtBQUssWUFBWSxZQUFZLElBQUksS0FBSyxDQUFDLElBQUksRUFBRSxDQUFDO1FBQ2hELE9BQU8sSUFBSSxhQUFhLEtBQUssQ0FBQyxJQUFJLEdBQUcsQ0FBQztJQUN4QyxDQUFDO0lBQ0QsdUVBQXVFO0lBQ3ZFLDJFQUEyRTtJQUMzRSxzRUFBc0U7SUFDdEUsc0VBQXNFO0lBQ3RFLDRDQUE0QztJQUM1QyxNQUFNLElBQUksR0FBRyxpQkFBaUIsSUFBSSxnSkFBZ0osQ0FBQztJQUNuTCxJQUFJLEtBQUssWUFBWSxZQUFZLElBQUksS0FBSyxDQUFDLEtBQUssS0FBSyxTQUFTLEVBQUUsQ0FBQztRQUMvRCxhQUFhLENBQUMsS0FBSyxDQUFDLHNCQUFzQixFQUFFO1lBQzFDLE9BQU87WUFDUCxnQkFBZ0IsRUFBRSxLQUFLLENBQUMsS0FBSztTQUM5QixDQUFDLENBQUM7SUFDTCxDQUFDO0lBQ0QsT0FBTyxFQUFFLE9BQU8sRUFBRSxJQUFJLEVBQUUsQ0FBQztBQUMzQixDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBTaGFyZWQgZXJyb3IgZm9ybWF0dGluZyB1dGlsaXR5IGZvciBzZXJpYWxpemF0aW9uIGZhaWx1cmVzLlxuICpcbiAqIFVzZWQgYnkgdGhlIG1vZGUtc3BlY2lmaWMgc2VyaWFsaXplcnMgKHdvcmtmbG93LCBzdGVwLCBjbGllbnQpIHRvXG4gKiBwcm9kdWNlIGNvbnNpc3RlbnQgZXJyb3IgbWVzc2FnZXMgd2l0aCBkZXZhbHVlIHBhdGggaW5mb3JtYXRpb24uXG4gKlxuICogUmV0dXJucyBhIGB7IG1lc3NhZ2UsIGhpbnQgfWAgcGFpciBzbyBjYWxsZXJzIGNhbiB0aHJvdyBhXG4gKiBgU2VyaWFsaXphdGlvbkVycm9yKG1lc3NhZ2UsIHsgaGludCwgY2F1c2UgfSlgIGFuZCBoYXZlIHRoZSBoaW50IGZsb3dcbiAqIHRocm91Z2ggdGhlIHN0YW5kYXJkIGZyaWVuZGx5LWVycm9ycyBmcmFtaW5nIGluc3RlYWQgb2YgYmVpbmcgYmFrZWRcbiAqIGludG8gdGhlIG1lc3NhZ2Ugc3RyaW5nLlxuICovXG5cbmltcG9ydCB7IERldmFsdWVFcnJvciB9IGZyb20gJ2RldmFsdWUnO1xuaW1wb3J0IHsgcnVudGltZUxvZ2dlciB9IGZyb20gJy4uL2xvZ2dlci5qcyc7XG5cbi8qKlxuICogRm9ybWF0IGEgc2VyaWFsaXphdGlvbiBlcnJvciB3aXRoIGNvbnRleHQgYWJvdXQgd2hhdCBmYWlsZWQuXG4gKiBFeHRyYWN0cyBwYXRoLCB2YWx1ZSwgYW5kIHJlYXNvbiBmcm9tIGRldmFsdWUncyBEZXZhbHVlRXJyb3Igd2hlbiBhdmFpbGFibGUuXG4gKiBMb2dzIHRoZSBwcm9ibGVtYXRpYyB2YWx1ZSB0byB0aGUgY29uc29sZSBmb3IgYmV0dGVyIGRlYnVnZ2luZy5cbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIGZvcm1hdFNlcmlhbGl6YXRpb25FcnJvcihcbiAgY29udGV4dDogc3RyaW5nLFxuICBlcnJvcjogdW5rbm93blxuKTogeyBtZXNzYWdlOiBzdHJpbmc7IGhpbnQ6IHN0cmluZyB9IHtcbiAgLy8gYHJldHVybmluZ2AgZm9yIG91dHB1dHMsIGBwYXNzaW5nYCBmb3IgZXZlcnl0aGluZyB0aGF0IGNyb3NzZXMgdGhlXG4gIC8vIGJvdW5kYXJ5IHRoZSBvdGhlciB3YXkgKGFyZ3VtZW50cywgc3RyZWFtIG1lc3NhZ2VzLCBldGMuKS5cbiAgY29uc3QgdmVyYiA9IGNvbnRleHQuaW5jbHVkZXMoJ3JldHVybiB2YWx1ZScpID8gJ3JldHVybmluZycgOiAncGFzc2luZyc7XG4gIGxldCBtZXNzYWdlID0gYEZhaWxlZCB0byBzZXJpYWxpemUgJHtjb250ZXh0fWA7XG4gIGlmIChlcnJvciBpbnN0YW5jZW9mIERldmFsdWVFcnJvciAmJiBlcnJvci5wYXRoKSB7XG4gICAgbWVzc2FnZSArPSBgIGF0IHBhdGggXCIke2Vycm9yLnBhdGh9XCJgO1xuICB9XG4gIC8vIFdvcmtmbG93IGNhbiBzZXJpYWxpemUgYSBtdWNoIHJpY2hlciBzZXQgdGhhbiB0aGUgZGV2YWx1ZSBkZWZhdWx0cyDigJRcbiAgLy8gY2xhc3NlcyByZWdpc3RlcmVkIHZpYSBgV09SS0ZMT1dfU0VSSUFMSVpFYCwgRmF0YWxFcnJvciAvIFJldHJ5YWJsZUVycm9yXG4gIC8vIHN1YmNsYXNzZXMsIEFib3J0U2lnbmFsLCBldGMuIFBvaW50aW5nIGF0IHRoZSBmb3VuZGF0aW9ucyBkb2Mga2VlcHNcbiAgLy8gdGhpcyBoaW50IGFjY3VyYXRlIGFzIHRoZSBzdXBwb3J0ZWQgc2V0IGdyb3dzLCBpbnN0ZWFkIG9mIHJlcGVhdGluZ1xuICAvLyBhIGhhcmRjb2RlZCBsaXN0IHRoYXQgZHJpZnRzIG91dCBvZiBzeW5jLlxuICBjb25zdCBoaW50ID0gYEVuc3VyZSB5b3UncmUgJHt2ZXJifSB3b3JrZmxvdyBzZXJpYWxpemFibGUgdHlwZXMuIENoZWNrIHRoZSBzZXJpYWxpemF0aW9uIGRvY3MgdG8gc2VlIHdoYXQncyBzZXJpYWxpemFibGU6IGh0dHBzOi8vd29ya2Zsb3ctc2RrLmRldi9kb2NzL2ZvdW5kYXRpb25zL3NlcmlhbGl6YXRpb25gO1xuICBpZiAoZXJyb3IgaW5zdGFuY2VvZiBEZXZhbHVlRXJyb3IgJiYgZXJyb3IudmFsdWUgIT09IHVuZGVmaW5lZCkge1xuICAgIHJ1bnRpbWVMb2dnZXIuZXJyb3IoJ1NlcmlhbGl6YXRpb24gZmFpbGVkJywge1xuICAgICAgY29udGV4dCxcbiAgICAgIHByb2JsZW1hdGljVmFsdWU6IGVycm9yLnZhbHVlLFxuICAgIH0pO1xuICB9XG4gIHJldHVybiB7IG1lc3NhZ2UsIGhpbnQgfTtcbn1cbiJdfQ==
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Format prefix system for serialized payloads.
|
|
3
|
+
*
|
|
4
|
+
* All serialized payloads are prefixed with a 4-byte format identifier that
|
|
5
|
+
* allows the deserializer to determine how to decode the payload. This enables:
|
|
6
|
+
*
|
|
7
|
+
* 1. Self-describing payloads — the World layer is agnostic to serialization format
|
|
8
|
+
* 2. Gradual migration — old runs keep working, new runs can use new formats
|
|
9
|
+
* 3. Composability — encryption can wrap any format ("encr" wrapping "devl")
|
|
10
|
+
* 4. Debugging — raw data inspection immediately reveals the format
|
|
11
|
+
*
|
|
12
|
+
* Format: [4 bytes: format identifier][payload]
|
|
13
|
+
*
|
|
14
|
+
* The format prefix is open-ended — any 4-character [a-z0-9] string is valid.
|
|
15
|
+
* This allows new codecs to be added without modifying this module.
|
|
16
|
+
*/
|
|
17
|
+
import { type FormatPrefix } from './types.js';
|
|
18
|
+
/**
|
|
19
|
+
* Encode a payload with a format prefix.
|
|
20
|
+
*
|
|
21
|
+
* @param format - The format identifier (4 chars, [a-z0-9])
|
|
22
|
+
* @param payload - The serialized payload bytes
|
|
23
|
+
* @returns A new Uint8Array with format prefix prepended
|
|
24
|
+
*/
|
|
25
|
+
export declare function encodeWithFormatPrefix(format: FormatPrefix, payload: Uint8Array | unknown): Uint8Array | unknown;
|
|
26
|
+
/**
|
|
27
|
+
* Peek at the format prefix without consuming it.
|
|
28
|
+
*
|
|
29
|
+
* Returns the prefix if it's a valid format prefix ([a-z0-9]{4}),
|
|
30
|
+
* or null if the data is legacy/non-binary or doesn't start with a
|
|
31
|
+
* valid prefix.
|
|
32
|
+
*
|
|
33
|
+
* @param data - The format-prefixed data
|
|
34
|
+
* @returns The format prefix, or null
|
|
35
|
+
*/
|
|
36
|
+
export declare function peekFormatPrefix(data: Uint8Array | unknown): FormatPrefix | null;
|
|
37
|
+
/**
|
|
38
|
+
* Check if data is encrypted (has 'encr' format prefix).
|
|
39
|
+
*/
|
|
40
|
+
export declare function isEncrypted(data: Uint8Array | unknown): boolean;
|
|
41
|
+
/**
|
|
42
|
+
* Decode a format-prefixed payload.
|
|
43
|
+
*
|
|
44
|
+
* Unlike the legacy implementation which only accepted known formats
|
|
45
|
+
* (`devl`, `encr`), this function accepts any valid format prefix
|
|
46
|
+
* (`[a-z0-9]{4}`). This is intentional for forward compatibility —
|
|
47
|
+
* new codecs (e.g. `cbor`) can be added without modifying this module.
|
|
48
|
+
* Callers are responsible for checking whether they support the returned
|
|
49
|
+
* format and throwing an appropriate error if not (e.g. "Unsupported
|
|
50
|
+
* serialization format").
|
|
51
|
+
*
|
|
52
|
+
* @param data - The format-prefixed data
|
|
53
|
+
* @returns An object with the format prefix and payload
|
|
54
|
+
* @throws Error if the data is too short or has an invalid prefix
|
|
55
|
+
*/
|
|
56
|
+
export declare function decodeFormatPrefix(data: Uint8Array | unknown): {
|
|
57
|
+
format: FormatPrefix;
|
|
58
|
+
payload: Uint8Array;
|
|
59
|
+
};
|
|
60
|
+
//# sourceMappingURL=format.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../../src/serialization/format.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EACL,KAAK,YAAY,EAGlB,MAAM,YAAY,CAAC;AAQpB;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,UAAU,GAAG,OAAO,GAC5B,UAAU,GAAG,OAAO,CAUtB;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,UAAU,GAAG,OAAO,GACzB,YAAY,GAAG,IAAI,CAOrB;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,GAAG,OAAO,CAE/D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,GAAG;IAC9D,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,EAAE,UAAU,CAAC;CACrB,CA0BA"}
|