@workflow/core 4.0.1-beta.0

package/dist/serialization.d.ts

@@ -0,0 +1,188 @@
+import * as devalue from 'devalue';
+/**
+ * Detect if a readable stream is a byte stream.
+ *
+ * @param stream
+ * @returns `"bytes"` if the stream is a byte stream, `undefined` otherwise
+ */
+export declare function getStreamType(stream: ReadableStream): 'bytes' | undefined;
+export declare function getSerializeStream(reducers: Reducers): TransformStream<any, Uint8Array>;
+export declare function getDeserializeStream(revivers: Revivers): TransformStream<Uint8Array, any>;
+export declare class WorkflowServerReadableStream extends ReadableStream<Uint8Array> {
+    #private;
+    constructor(name: string, startIndex?: number);
+}
+export declare class WorkflowServerWritableStream extends WritableStream<Uint8Array> {
+    constructor(name: string);
+}
+export interface SerializableSpecial {
+    ArrayBuffer: string;
+    BigInt64Array: string;
+    BigUint64Array: string;
+    Date: string;
+    Float32Array: string;
+    Float64Array: string;
+    Error: Record<string, any>;
+    Headers: [string, string][];
+    Int8Array: string;
+    Int16Array: string;
+    Int32Array: string;
+    Map: [any, any][];
+    ReadableStream: {
+        name: string;
+        type?: 'bytes';
+        startIndex?: number;
+    } | {
+        bodyInit: any;
+    };
+    RegExp: {
+        source: string;
+        flags: string;
+    };
+    Request: {
+        method: string;
+        url: string;
+        headers: Headers;
+        body: Request['body'];
+        duplex: Request['duplex'];
+        responseWritable?: WritableStream<Response>;
+    };
+    Response: {
+        type: Response['type'];
+        url: string;
+        status: number;
+        statusText: string;
+        headers: Headers;
+        body: Response['body'];
+        redirected: boolean;
+    };
+    Set: any[];
+    URL: string;
+    URLSearchParams: string;
+    Uint8Array: string;
+    Uint8ClampedArray: string;
+    Uint16Array: string;
+    Uint32Array: string;
+    WritableStream: {
+        name: string;
+    };
+}
+type Reducers = {
+    [K in keyof SerializableSpecial]: (value: any) => SerializableSpecial[K] | false;
+};
+type Revivers = {
+    [K in keyof SerializableSpecial]: (value: SerializableSpecial[K]) => any;
+};
+/**
+ * Reducers for serialization boundary from the client side, passing arguments
+ * to the workflow handler.
+ *
+ * @param global
+ * @param ops
+ * @returns
+ */
+export declare function getExternalReducers(global: Record<string, any> | undefined, ops: Promise<any>[]): Reducers;
+/**
+ * Reducers for serialization boundary from within the workflow execution
+ * environment, passing return value to the client side and into step arguments.
+ *
+ * @param global
+ * @returns
+ */
+export declare function getWorkflowReducers(global?: Record<string, any>): Reducers;
+/**
+ * Revivers for deserialization boundary from the client side,
+ * receiving the return value from the workflow handler.
+ *
+ * @param global
+ * @param ops
+ */
+export declare function getExternalRevivers(global: Record<string, any> | undefined, ops: Promise<any>[]): Revivers;
+/**
+ * Revivers for deserialization boundary from within the workflow execution
+ * environment, receiving arguments from the client side, and return values
+ * from the steps.
+ *
+ * @param global
+ * @returns
+ */
+export declare function getWorkflowRevivers(global?: Record<string, any>): Revivers;
+/**
+ * Called from the `start()` function to serialize the workflow arguments
+ * into a format that can be saved to the database and then hydrated from
+ * within the workflow execution environment.
+ *
+ * @param value
+ * @param global
+ * @returns The dehydrated value, ready to be inserted into the database
+ */
+export declare function dehydrateWorkflowArguments(value: unknown, ops: Promise<any>[], global?: Record<string, any>): any;
+/**
+ * Called from workflow execution environment to hydrate the workflow
+ * arguments from the database at the start of workflow execution.
+ *
+ * @param value
+ * @param ops
+ * @param global
+ * @returns The hydrated value
+ */
+export declare function hydrateWorkflowArguments(value: Parameters<typeof devalue.unflatten>[0], global?: Record<string, any>, extraRevivers?: Record<string, (value: any) => any>): any;
+/**
+ * Called at the end of a completed workflow execution to serialize the
+ * return value into a format that can be saved to the database.
+ *
+ * @param value
+ * @param global
+ * @returns The dehydrated value, ready to be inserted into the database
+ */
+export declare function dehydrateWorkflowReturnValue(value: unknown, global?: Record<string, any>): any;
+/**
+ * Called from the client side (i.e. the execution environment where
+ * the workflow run was initiated from) to hydrate the workflow
+ * return value of a completed workflow run.
+ *
+ * @param value
+ * @param global
+ * @returns The hydrated return value, ready to be consumed by the client
+ */
+export declare function hydrateWorkflowReturnValue(value: Parameters<typeof devalue.unflatten>[0], ops: Promise<any>[], global?: Record<string, any>, extraRevivers?: Record<string, (value: any) => any>): any;
+/**
+ * Called from the workflow handler when a step is being created.
+ * Dehydrates values from within the workflow execution environment
+ * into a format that can be saved to the database.
+ *
+ * @param value
+ * @param global
+ * @returns The dehydrated value, ready to be inserted into the database
+ */
+export declare function dehydrateStepArguments(value: unknown, global: Record<string, any>): any;
+/**
+ * Called from the step handler to hydrate the arguments of a step
+ * from the database at the start of the step execution.
+ *
+ * @param value
+ * @param global
+ * @returns The hydrated value, ready to be consumed by the step user-code function
+ */
+export declare function hydrateStepArguments(value: Parameters<typeof devalue.unflatten>[0], ops: Promise<any>[], global?: Record<string, any>, extraRevivers?: Record<string, (value: any) => any>): any;
+/**
+ * Called from the step handler when a step has completed.
+ * Dehydrates values from within the step execution environment
+ * into a format that can be saved to the database.
+ *
+ * @param value
+ * @param global
+ * @returns The dehydrated value, ready to be inserted into the database
+ */
+export declare function dehydrateStepReturnValue(value: unknown, ops: Promise<any>[], global?: Record<string, any>): any;
+/**
+ * Called from the workflow handler when replaying the event log of a `step_completed` event.
+ * Hydrates the return value of a step from the database.
+ *
+ * @param value
+ * @param global
+ * @returns The hydrated return value of a step, ready to be consumed by the workflow handler
+ */
+export declare function hydrateStepReturnValue(value: Parameters<typeof devalue.unflatten>[0], global?: Record<string, any>, extraRevivers?: Record<string, (value: any) => any>): any;
+export {};
+//# sourceMappingURL=serialization.d.ts.map

package/dist/serialization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serialization.d.ts","sourceRoot":"","sources":["../src/serialization.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AASnC;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,GAAG,SAAS,CAMzE;AAED,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,QAAQ,GACjB,eAAe,CAAC,GAAG,EAAE,UAAU,CAAC,CAkBlC;AAED,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,QAAQ,GACjB,eAAe,CAAC,UAAU,EAAE,GAAG,CAAC,CA6BlC;AAED,qBAAa,4BAA6B,SAAQ,cAAc,CAAC,UAAU,CAAC;;gBAG9D,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM;CA8B9C;AAED,qBAAa,4BAA6B,SAAQ,cAAc,CAAC,UAAU,CAAC;gBAC9D,IAAI,EAAE,MAAM;CAczB;AAID,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;IAClB,cAAc,EACV;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GACrD;QAAE,QAAQ,EAAE,GAAG,CAAA;KAAE,CAAC;IACtB,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1C,OAAO,EAAE;QACP,MAAM,EAAE,MAAM,CAAC;QACf,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QACtB,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QAG1B,gBAAgB,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;KAC7C,CAAC;IACF,QAAQ,EAAE;QACR,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvB,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvB,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;IACF,GAAG,EAAE,GAAG,EAAE,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAClC;AAED,KAAK,QAAQ,GAAG;KACb,CAAC,IAAI,MAAM,mBAAmB,GAAG,CAChC,KAAK,EAAE,GAAG,KACP,mBAAmB,CAAC,CAAC,CAAC,GAAG,KAAK;CACpC,CAAC;AAEF,KAAK,QAAQ,GAAG;KACb,CAAC,IAAI,MAAM,mBAAmB,GAAG,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC,CAAC,KAAK,GAAG;CACzE,CAAC;AA4GF;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,YAAa,EACxC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,GAClB,QAAQ,CA0CV;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAc,GACvC,QAAQ,CAmCV;AA+ID;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,YAAa,EACxC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,GAClB,QAAQ,CAqDV;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAc,GACvC,QAAQ,CAsDV;AAwED;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,EACnB,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAc,OAWzC;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CACtC,KAAK,EAAE,UAAU,CAAC,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAC9C,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAc,EACxC,aAAa,GAAE,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAM,OAOxD;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,KAAK,EAAE,OAAO,EACd,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAc,OAWzC;AAED;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,UAAU,CAAC,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAC9C,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,EACnB,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAc,EACxC,aAAa,GAAE,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAM,OAOxD;AAED;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,OAW5B;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,UAAU,CAAC,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAC9C,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,EACnB,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAc,EACxC,aAAa,GAAE,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAM,OAOxD;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CACtC,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,EACnB,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAc,OAWzC;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,UAAU,CAAC,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAC9C,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAc,EACxC,aAAa,GAAE,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAM,OAOxD"}