@workflow/core 4.0.1-beta.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Vercel, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @workflow/core
+
+Core runtime package for [Workflow DevKit](https://useworkflow.dev).

package/dist/builtins.d.ts

@@ -0,0 +1,4 @@
+export declare function __builtin_response_array_buffer(res: Response): Promise<ArrayBuffer>;
+export declare function __builtin_response_json(res: Response): Promise<unknown>;
+export declare function __builtin_response_text(res: Response): Promise<string>;
+//# sourceMappingURL=builtins.d.ts.map

package/dist/builtins.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builtins.d.ts","sourceRoot":"","sources":["../src/builtins.ts"],"names":[],"mappings":"AAAA,wBAAsB,+BAA+B,CAAC,GAAG,EAAE,QAAQ,wBAGlE;AAED,wBAAsB,uBAAuB,CAAC,GAAG,EAAE,QAAQ,oBAG1D;AAED,wBAAsB,uBAAuB,CAAC,GAAG,EAAE,QAAQ,mBAG1D"}

package/dist/builtins.js

@@ -0,0 +1,13 @@
+export async function __builtin_response_array_buffer(res) {
+    'use step';
+    return res.arrayBuffer();
+}
+export async function __builtin_response_json(res) {
+    'use step';
+    return res.json();
+}
+export async function __builtin_response_text(res) {
+    'use step';
+    return res.text();
+}
+//# sourceMappingURL=builtins.js.map

package/dist/builtins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"builtins.js","sourceRoot":"","sources":["../src/builtins.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,KAAK,UAAU,+BAA+B,CAAC,GAAa;IACjE,UAAU,CAAC;IACX,OAAO,GAAG,CAAC,WAAW,EAAE,CAAC;AAC3B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,GAAa;IACzD,UAAU,CAAC;IACX,OAAO,GAAG,CAAC,IAAI,EAAE,CAAC;AACpB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,GAAa;IACzD,UAAU,CAAC;IACX,OAAO,GAAG,CAAC,IAAI,EAAE,CAAC;AACpB,CAAC"}

package/dist/create-hook.d.ts

@@ -0,0 +1,123 @@
+import type { Serializable } from './schemas.js';
+/**
+ * An object that can be awaited to receive a value.
+ */
+interface Thenable<T> {
+    then: Promise<T>['then'];
+}
+/**
+ * A `Request` that can be responded to within a workflow
+ * step function by calling the `respondWith()` method.
+ */
+export interface RequestWithResponse extends Request {
+    respondWith: (response: Response) => Promise<void>;
+}
+/**
+ * A hook that can be awaited and/or iterated over to receive
+ * a value within a workflow from an external system.
+ */
+export interface Hook<T = any> extends AsyncIterable<T>, Thenable<T> {
+    /**
+     * The token used to identify this hook.
+     */
+    token: string;
+}
+/**
+ * A webhook that can be used to suspend and resume the workflow run
+ * upon receiving an HTTP request to the specified URL.
+ *
+ * @see {@link createWebhook}
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Request
+ */
+export interface Webhook<T extends Request> extends Hook<T> {
+    /**
+     * The URL that external systems can call to send data to the workflow.
+     */
+    url: string;
+}
+export interface HookOptions {
+    /**
+     * Unique token that is used to associate with the hook.
+     *
+     * When specifying an explicit token, the token should be constructed
+     * with information that the dispatching side can reliably reconstruct
+     * the token with the information it has available.
+     *
+     * If not provided, a randomly generated token will be assigned.
+     *
+     * @example
+     *
+     * ```ts
+     * // Explicit token for a Slack bot (one workflow run per channel)
+     * const hook = createHook<SlackMessage>({
+     *   token: `slack_webhook:${channelId}`,
+     * });
+     * ```
+     */
+    token?: string;
+    /**
+     * Additional user-defined data to include with the hook payload.
+     *
+     * @example
+     *
+     * ```ts
+     * const hook = createHook<{ name: string }>({
+     *   metadata: {
+     *     type: "cat",
+     *     color: "orange",
+     *   },
+     * });
+     * ```
+     */
+    metadata?: Serializable;
+}
+export interface WebhookOptions extends HookOptions {
+    /**
+     * If set to a `Response` object, the webhook will automatically
+     * respond with the specified response.
+     *
+     * If set to `"manual"`, each individual request will need to
+     * be responded to manually from within the workflow by calling the
+     * `respondWith()` method.
+     *
+     * If not set then the webhook will automatically respond with
+     * a `202 Accepted` response.
+     */
+    respondWith?: Response | 'manual';
+}
+/**
+ * Creates a {@link Hook} that can be used to suspend and resume the workflow run with a payload.
+ *
+ * Hooks allow external systems to send arbitrary serializable data into a workflow.
+ *
+ * @param options - Configuration options for the hook.
+ * @returns A `Hook` that can be awaited to receive one or more payloads.
+ *
+ * @example
+ *
+ * ```ts
+ * export async function workflowWithHook() {
+ *   "use workflow";
+ *
+ *   const hook = createHook<{ message: string }>();
+ *   console.log('Hook token:', hook.token);
+ *
+ *   const payload = await hook;
+ *   console.log('Received:', payload.message);
+ * }
+ * ```
+ */
+export declare function createHook<T = any>(options?: HookOptions): Hook<T>;
+/**
+ * Creates a {@link Webhook} that can be used to suspend and resume the workflow
+ * run upon receiving an HTTP request to the specified URL.
+ *
+ * Webhooks will result in a {@link https://developer.mozilla.org/en-US/docs/Web/API/Request | Request} object
+ * that can be interacted with in workflow functions.
+ */
+export declare function createWebhook(options: WebhookOptions & {
+    respondWith: 'manual';
+}): Webhook<RequestWithResponse>;
+export declare function createWebhook(options?: WebhookOptions): Webhook<Request>;
+export {};
+//# sourceMappingURL=create-hook.d.ts.map

package/dist/create-hook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-hook.d.ts","sourceRoot":"","sources":["../src/create-hook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEjD;;GAEG;AACH,UAAU,QAAQ,CAAC,CAAC;IAClB,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,OAAO;IAClD,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACpD;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,aAAa,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;IAClE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,OAAO,CAAC,CAAC,SAAS,OAAO,CAAE,SAAQ,IAAI,CAAC,CAAC,CAAC;IACzD;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,WAAW;IAC1B;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC;CACzB;AAED,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD;;;;;;;;;;OAUG;IACH,WAAW,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;CACnC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,wBAAgB,UAAU,CAAC,CAAC,GAAG,GAAG,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC,CAIlE;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,OAAO,EAAE,cAAc,GAAG;IAAE,WAAW,EAAE,QAAQ,CAAA;CAAE,GAClD,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAChC,wBAAgB,aAAa,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC"}

package/dist/create-hook.js

@@ -0,0 +1,32 @@
+/**
+ * Creates a {@link Hook} that can be used to suspend and resume the workflow run with a payload.
+ *
+ * Hooks allow external systems to send arbitrary serializable data into a workflow.
+ *
+ * @param options - Configuration options for the hook.
+ * @returns A `Hook` that can be awaited to receive one or more payloads.
+ *
+ * @example
+ *
+ * ```ts
+ * export async function workflowWithHook() {
+ *   "use workflow";
+ *
+ *   const hook = createHook<{ message: string }>();
+ *   console.log('Hook token:', hook.token);
+ *
+ *   const payload = await hook;
+ *   console.log('Received:', payload.message);
+ * }
+ * ```
+ */
+// @ts-expect-error `options` is here for types/docs
+export function createHook(options) {
+    throw new Error('`createHook()` can only be called inside a workflow function');
+}
+export function createWebhook(
+// @ts-expect-error `options` is here for types/docs
+options) {
+    throw new Error('`createWebhook()` can only be called inside a workflow function');
+}
+//# sourceMappingURL=create-hook.js.map

package/dist/create-hook.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-hook.js","sourceRoot":"","sources":["../src/create-hook.ts"],"names":[],"mappings":"AA+FA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,oDAAoD;AACpD,MAAM,UAAU,UAAU,CAAU,OAAqB;IACvD,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;AACJ,CAAC;AAaD,MAAM,UAAU,aAAa;AAC3B,oDAAoD;AACpD,OAAwB;IAExB,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;AACJ,CAAC"}

package/dist/define-hook.d.ts

@@ -0,0 +1,53 @@
+import type { Hook as HookEntity } from '@workflow/world';
+import type { Hook, HookOptions } from './create-hook.js';
+/**
+ * Defines a typed hook for type-safe hook creation and resumption.
+ *
+ * This helper provides type safety by allowing you to define the payload type once
+ * and reuse it when creating hooks and resuming them.
+ *
+ * @returns An object with `create` and `resume` functions pre-typed with the payload type
+ *
+ * @example
+ *
+ * ```ts
+ * // Define a hook with a specific payload type
+ * const approvalHook = defineHook<{ approved: boolean; comment: string }>();
+ *
+ * // In a workflow
+ * export async function workflowWithApproval() {
+ *   "use workflow";
+ *
+ *   const hook = approvalHook.create();
+ *   const result = await hook; // Fully typed as { approved: boolean; comment: string }
+ * }
+ *
+ * // In an API route
+ * export async function POST(request: Request) {
+ *   const { token, approved, comment } = await request.json();
+ *   await approvalHook.resume(token, { approved, comment });
+ *   return Response.json({ success: true });
+ * }
+ * ```
+ */
+export declare function defineHook<T>(): {
+    /**
+     * Creates a new hook with the defined payload type.
+     *
+     * Note: This method is not available in runtime bundles. Use it from workflow contexts only.
+     *
+     * @param _options - Optional hook configuration
+     * @returns A Hook that resolves to the defined payload type
+     */
+    create(options?: HookOptions): Hook<T>;
+    /**
+     * Resumes a hook by sending a payload with the defined type.
+     * This is a type-safe wrapper around the `resumeHook` runtime function.
+     *
+     * @param token - The unique token identifying the hook
+     * @param payload - The payload to send (must match the defined type)
+     * @returns Promise resolving to the hook entity, or null if the hook doesn't exist
+     */
+    resume(token: string, payload: T): Promise<HookEntity | null>;
+};
+//# sourceMappingURL=define-hook.d.ts.map

package/dist/define-hook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-hook.d.ts","sourceRoot":"","sources":["../src/define-hook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,IAAI,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,UAAU,CAAC,CAAC;IAExB;;;;;;;OAOG;qBAEc,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC;IAMtC;;;;;;;OAOG;kBACW,MAAM,WAAW,CAAC,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;EAIhE"}

package/dist/define-hook.js

@@ -0,0 +1,59 @@
+import { resumeHook } from './runtime/resume-hook.js';
+/**
+ * Defines a typed hook for type-safe hook creation and resumption.
+ *
+ * This helper provides type safety by allowing you to define the payload type once
+ * and reuse it when creating hooks and resuming them.
+ *
+ * @returns An object with `create` and `resume` functions pre-typed with the payload type
+ *
+ * @example
+ *
+ * ```ts
+ * // Define a hook with a specific payload type
+ * const approvalHook = defineHook<{ approved: boolean; comment: string }>();
+ *
+ * // In a workflow
+ * export async function workflowWithApproval() {
+ *   "use workflow";
+ *
+ *   const hook = approvalHook.create();
+ *   const result = await hook; // Fully typed as { approved: boolean; comment: string }
+ * }
+ *
+ * // In an API route
+ * export async function POST(request: Request) {
+ *   const { token, approved, comment } = await request.json();
+ *   await approvalHook.resume(token, { approved, comment });
+ *   return Response.json({ success: true });
+ * }
+ * ```
+ */
+export function defineHook() {
+    return {
+        /**
+         * Creates a new hook with the defined payload type.
+         *
+         * Note: This method is not available in runtime bundles. Use it from workflow contexts only.
+         *
+         * @param _options - Optional hook configuration
+         * @returns A Hook that resolves to the defined payload type
+         */
+        // @ts-expect-error `options` is here for types/docs
+        create(options) {
+            throw new Error('`defineHook().create()` can only be called inside a workflow function.');
+        },
+        /**
+         * Resumes a hook by sending a payload with the defined type.
+         * This is a type-safe wrapper around the `resumeHook` runtime function.
+         *
+         * @param token - The unique token identifying the hook
+         * @param payload - The payload to send (must match the defined type)
+         * @returns Promise resolving to the hook entity, or null if the hook doesn't exist
+         */
+        resume(token, payload) {
+            return resumeHook(token, payload);
+        },
+    };
+}
+//# sourceMappingURL=define-hook.js.map

package/dist/define-hook.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-hook.js","sourceRoot":"","sources":["../src/define-hook.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,UAAU,UAAU;IACxB,OAAO;QACL;;;;;;;WAOG;QACH,oDAAoD;QACpD,MAAM,CAAC,OAAqB;YAC1B,MAAM,IAAI,KAAK,CACb,wEAAwE,CACzE,CAAC;QACJ,CAAC;QAED;;;;;;;WAOG;QACH,MAAM,CAAC,KAAa,EAAE,OAAU;YAC9B,OAAO,UAAU,CAAI,KAAK,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/events-consumer.d.ts

@@ -0,0 +1,35 @@
+import type { Event } from '@workflow/world';
+export declare enum EventConsumerResult {
+    /**
+     * Callback consumed the event, but should not be removed from the callbacks list
+     */
+    Consumed = 0,
+    /**
+     * Callback did not consume the event, so it should be passed to the next callback
+     */
+    NotConsumed = 1,
+    /**
+     * Callback consumed the event, and should be removed from the callbacks list
+     */
+    Finished = 2
+}
+type EventConsumerCallback = (event: Event | null) => EventConsumerResult;
+export declare class EventsConsumer {
+    eventIndex: number;
+    readonly events: Event[];
+    readonly callbacks: EventConsumerCallback[];
+    constructor(events: Event[]);
+    /**
+     * Registers a callback function to be called after an event has been consumed
+     * by a different callback. The callback can return:
+     *  - `EventConsumerResult.Consumed` the event is considered consumed and will not be passed to any other callback, but the callback will remain in the callbacks list
+     *  - `EventConsumerResult.NotConsumed` the event is passed to the next callback
+     *  - `EventConsumerResult.Finished` the event is considered consumed and the callback is removed from the callbacks list
+     *
+     * @param fn - The callback function to register.
+     */
+    subscribe(fn: EventConsumerCallback): void;
+    private consume;
+}
+export {};
+//# sourceMappingURL=events-consumer.d.ts.map

package/dist/events-consumer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events-consumer.d.ts","sourceRoot":"","sources":["../src/events-consumer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAG7C,oBAAY,mBAAmB;IAC7B;;OAEG;IACH,QAAQ,IAAA;IACR;;OAEG;IACH,WAAW,IAAA;IACX;;OAEG;IACH,QAAQ,IAAA;CACT;AAED,KAAK,qBAAqB,GAAG,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,KAAK,mBAAmB,CAAC;AAE1E,qBAAa,cAAc;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,CAAM;IAC9B,QAAQ,CAAC,SAAS,EAAE,qBAAqB,EAAE,CAAM;gBAErC,MAAM,EAAE,KAAK,EAAE;IAO3B;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,EAAE,qBAAqB;IAKnC,OAAO,CAAC,OAAO,CAkCb;CACH"}

package/dist/events-consumer.js

@@ -0,0 +1,72 @@
+import { eventsLogger } from './logger.js';
+export var EventConsumerResult;
+(function (EventConsumerResult) {
+    /**
+     * Callback consumed the event, but should not be removed from the callbacks list
+     */
+    EventConsumerResult[EventConsumerResult["Consumed"] = 0] = "Consumed";
+    /**
+     * Callback did not consume the event, so it should be passed to the next callback
+     */
+    EventConsumerResult[EventConsumerResult["NotConsumed"] = 1] = "NotConsumed";
+    /**
+     * Callback consumed the event, and should be removed from the callbacks list
+     */
+    EventConsumerResult[EventConsumerResult["Finished"] = 2] = "Finished";
+})(EventConsumerResult || (EventConsumerResult = {}));
+export class EventsConsumer {
+    eventIndex;
+    events = [];
+    callbacks = [];
+    constructor(events) {
+        this.events = events;
+        this.eventIndex = 0;
+        eventsLogger.debug('EventsConsumer initialized', { events });
+    }
+    /**
+     * Registers a callback function to be called after an event has been consumed
+     * by a different callback. The callback can return:
+     *  - `EventConsumerResult.Consumed` the event is considered consumed and will not be passed to any other callback, but the callback will remain in the callbacks list
+     *  - `EventConsumerResult.NotConsumed` the event is passed to the next callback
+     *  - `EventConsumerResult.Finished` the event is considered consumed and the callback is removed from the callbacks list
+     *
+     * @param fn - The callback function to register.
+     */
+    subscribe(fn) {
+        this.callbacks.push(fn);
+        process.nextTick(this.consume);
+    }
+    consume = () => {
+        const currentEvent = this.events[this.eventIndex] ?? null;
+        for (let i = 0; i < this.callbacks.length; i++) {
+            const callback = this.callbacks[i];
+            let handled = EventConsumerResult.NotConsumed;
+            try {
+                handled = callback(currentEvent);
+            }
+            catch (error) {
+                eventsLogger.error('EventConsumer callback threw an error', { error });
+                // Hopefully shouldn't happen, but we don't want to block the workflow
+                console.error('EventConsumer callback threw an error', error);
+            }
+            eventsLogger.debug('EventConsumer callback result', {
+                handled: EventConsumerResult[handled],
+                eventIndex: this.eventIndex,
+                eventId: currentEvent?.eventId,
+            });
+            if (handled === EventConsumerResult.Consumed ||
+                handled === EventConsumerResult.Finished) {
+                // consumer handled this event, so increase the event index
+                this.eventIndex++;
+                // remove the callback if it has finished
+                if (handled === EventConsumerResult.Finished) {
+                    this.callbacks.splice(i, 1);
+                }
+                // continue to the next event
+                process.nextTick(this.consume);
+                return;
+            }
+        }
+    };
+}
+//# sourceMappingURL=events-consumer.js.map

package/dist/events-consumer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events-consumer.js","sourceRoot":"","sources":["../src/events-consumer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,MAAM,CAAN,IAAY,mBAaX;AAbD,WAAY,mBAAmB;IAC7B;;OAEG;IACH,qEAAQ,CAAA;IACR;;OAEG;IACH,2EAAW,CAAA;IACX;;OAEG;IACH,qEAAQ,CAAA;AACV,CAAC,EAbW,mBAAmB,KAAnB,mBAAmB,QAa9B;AAID,MAAM,OAAO,cAAc;IACzB,UAAU,CAAS;IACV,MAAM,GAAY,EAAE,CAAC;IACrB,SAAS,GAA4B,EAAE,CAAC;IAEjD,YAAY,MAAe;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;QAEpB,YAAY,CAAC,KAAK,CAAC,4BAA4B,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAyB;QACjC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACxB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAEO,OAAO,GAAG,GAAG,EAAE;QACrB,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC;QAC1D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACnC,IAAI,OAAO,GAAG,mBAAmB,CAAC,WAAW,CAAC;YAC9C,IAAI,CAAC;gBACH,OAAO,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC;YACnC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,YAAY,CAAC,KAAK,CAAC,uCAAuC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;gBACvE,sEAAsE;gBACtE,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAAC;YAChE,CAAC;YACD,YAAY,CAAC,KAAK,CAAC,+BAA+B,EAAE;gBAClD,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC;gBACrC,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,OAAO,EAAE,YAAY,EAAE,OAAO;aAC/B,CAAC,CAAC;YACH,IACE,OAAO,KAAK,mBAAmB,CAAC,QAAQ;gBACxC,OAAO,KAAK,mBAAmB,CAAC,QAAQ,EACxC,CAAC;gBACD,2DAA2D;gBAC3D,IAAI,CAAC,UAAU,EAAE,CAAC;gBAElB,yCAAyC;gBACzC,IAAI,OAAO,KAAK,mBAAmB,CAAC,QAAQ,EAAE,CAAC;oBAC7C,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC9B,CAAC;gBAED,6BAA6B;gBAC7B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC/B,OAAO;YACT,CAAC;QACH,CAAC;IACH,CAAC,CAAC;CACH"}

package/dist/global.d.ts

@@ -0,0 +1,29 @@
+import type { Serializable } from './schemas.js';
+export interface StepInvocationQueueItem {
+    type: 'step';
+    correlationId: string;
+    stepName: string;
+    args: Serializable[];
+}
+export interface HookInvocationQueueItem {
+    type: 'hook';
+    correlationId: string;
+    token: string;
+    metadata?: Serializable;
+}
+export type QueueItem = StepInvocationQueueItem | HookInvocationQueueItem;
+/**
+ * An error that is thrown when one or more operations (steps/hooks/etc.) are called but do
+ * not yet have corresponding entries in the event log. The workflow
+ * dispatcher will catch this error and push the operations
+ * onto the queue.
+ */
+export declare class WorkflowSuspension extends Error {
+    steps: QueueItem[];
+    globalThis: typeof globalThis;
+    stepCount: number;
+    hookCount: number;
+    constructor(steps: QueueItem[], global: typeof globalThis);
+}
+export declare function ENOTSUP(): never;
+//# sourceMappingURL=global.d.ts.map

package/dist/global.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"global.d.ts","sourceRoot":"","sources":["../src/global.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEjD,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,YAAY,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,YAAY,CAAC;CACzB;AAED,MAAM,MAAM,SAAS,GAAG,uBAAuB,GAAG,uBAAuB,CAAC;AAE1E;;;;;GAKG;AACH,qBAAa,kBAAmB,SAAQ,KAAK;IAC3C,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB,UAAU,EAAE,OAAO,UAAU,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;gBAEN,KAAK,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,OAAO,UAAU;CAoC1D;AAED,wBAAgB,OAAO,IAAI,KAAK,CAE/B"}

package/dist/global.js

@@ -0,0 +1,50 @@
+/**
+ * An error that is thrown when one or more operations (steps/hooks/etc.) are called but do
+ * not yet have corresponding entries in the event log. The workflow
+ * dispatcher will catch this error and push the operations
+ * onto the queue.
+ */
+export class WorkflowSuspension extends Error {
+    steps;
+    globalThis;
+    stepCount;
+    hookCount;
+    constructor(steps, global) {
+        const stepCount = steps.filter((s) => s.type === 'step').length;
+        const hookCount = steps.filter((s) => s.type === 'hook').length;
+        // Build description parts
+        const parts = [];
+        if (stepCount > 0) {
+            parts.push(`${stepCount} ${stepCount === 1 ? 'step' : 'steps'}`);
+        }
+        if (hookCount > 0) {
+            parts.push(`${hookCount} ${hookCount === 1 ? 'hook' : 'hooks'}`);
+        }
+        // Determine verb (has/have) and action (run/created/received)
+        const totalCount = stepCount + hookCount;
+        const hasOrHave = totalCount === 1 ? 'has' : 'have';
+        let action;
+        if (stepCount > 0) {
+            action = 'run';
+        }
+        else if (hookCount > 0) {
+            action = 'created';
+        }
+        else {
+            action = 'received';
+        }
+        const description = parts.length > 0
+            ? `${parts.join(' and ')} ${hasOrHave} not been ${action} yet`
+            : '0 steps have not been run yet'; // Default case for empty array
+        super(description);
+        this.name = 'WorkflowSuspension';
+        this.steps = steps;
+        this.globalThis = global;
+        this.stepCount = stepCount;
+        this.hookCount = hookCount;
+    }
+}
+export function ENOTSUP() {
+    throw new Error('Not supported in workflow functions');
+}
+//# sourceMappingURL=global.js.map

package/dist/global.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"global.js","sourceRoot":"","sources":["../src/global.ts"],"names":[],"mappings":"AAkBA;;;;;GAKG;AACH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C,KAAK,CAAc;IACnB,UAAU,CAAoB;IAC9B,SAAS,CAAS;IAClB,SAAS,CAAS;IAElB,YAAY,KAAkB,EAAE,MAAyB;QACvD,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,MAAM,CAAC;QAChE,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,MAAM,CAAC;QAEhE,0BAA0B;QAC1B,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,GAAG,SAAS,IAAI,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACnE,CAAC;QACD,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,GAAG,SAAS,IAAI,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACnE,CAAC;QAED,8DAA8D;QAC9D,MAAM,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;QACzC,MAAM,SAAS,GAAG,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;QACpD,IAAI,MAAc,CAAC;QACnB,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;YAClB,MAAM,GAAG,KAAK,CAAC;QACjB,CAAC;aAAM,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;YACzB,MAAM,GAAG,SAAS,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,UAAU,CAAC;QACtB,CAAC;QAED,MAAM,WAAW,GACf,KAAK,CAAC,MAAM,GAAG,CAAC;YACd,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,SAAS,aAAa,MAAM,MAAM;YAC9D,CAAC,CAAC,+BAA+B,CAAC,CAAC,+BAA+B;QACtE,KAAK,CAAC,WAAW,CAAC,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CACF;AAED,MAAM,UAAU,OAAO;IACrB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;AACzD,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Just the core utilities that are meant to be imported by user
+ * steps/workflows. This allows the bundler to tree-shake and limit what goes
+ * into the final user bundles. Logic for running/handling steps/workflows
+ * should live in runtime. Eventually these might be separate packages
+ * `workflow` and `workflow/runtime`?
+ *
+ * Everything here will get re-exported under the 'workflow' top level package.
+ * This should be a minimal set of APIs so **do not anything here** unless it's
+ * needed for userland workflow code.
+ */
+export { FatalError, RetryableError, type RetryableErrorOptions, } from '@workflow/errors';
+export { createHook, createWebhook, type Hook, type HookOptions, type RequestWithResponse, type Webhook, type WebhookOptions, } from './create-hook.js';
+export { defineHook } from './define-hook.js';
+export { getStepMetadata, type StepMetadata, } from './step/get-step-metadata.js';
+export { getWorkflowMetadata, type WorkflowMetadata, } from './step/get-workflow-metadata.js';
+export { getWritable } from './writable-stream.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EACL,UAAU,EACV,cAAc,EACd,KAAK,qBAAqB,GAC3B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,UAAU,EACV,aAAa,EACb,KAAK,IAAI,EACT,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,KAAK,OAAO,EACZ,KAAK,cAAc,GACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EACL,eAAe,EACf,KAAK,YAAY,GAClB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,mBAAmB,EACnB,KAAK,gBAAgB,GACtB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/index.js

@@ -0,0 +1,18 @@
+/**
+ * Just the core utilities that are meant to be imported by user
+ * steps/workflows. This allows the bundler to tree-shake and limit what goes
+ * into the final user bundles. Logic for running/handling steps/workflows
+ * should live in runtime. Eventually these might be separate packages
+ * `workflow` and `workflow/runtime`?
+ *
+ * Everything here will get re-exported under the 'workflow' top level package.
+ * This should be a minimal set of APIs so **do not anything here** unless it's
+ * needed for userland workflow code.
+ */
+export { FatalError, RetryableError, } from '@workflow/errors';
+export { createHook, createWebhook, } from './create-hook.js';
+export { defineHook } from './define-hook.js';
+export { getStepMetadata, } from './step/get-step-metadata.js';
+export { getWorkflowMetadata, } from './step/get-workflow-metadata.js';
+export { getWritable } from './writable-stream.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EACL,UAAU,EACV,cAAc,GAEf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,UAAU,EACV,aAAa,GAMd,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EACL,eAAe,GAEhB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,mBAAmB,GAEpB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/logger.d.ts

@@ -0,0 +1,31 @@
+export declare const stepLogger: {
+    debug: (message: string, metadata?: Record<string, any>) => void;
+    info: (message: string, metadata?: Record<string, any>) => void;
+    warn: (message: string, metadata?: Record<string, any>) => void;
+    error: (message: string, metadata?: Record<string, any>) => void;
+};
+export declare const runtimeLogger: {
+    debug: (message: string, metadata?: Record<string, any>) => void;
+    info: (message: string, metadata?: Record<string, any>) => void;
+    warn: (message: string, metadata?: Record<string, any>) => void;
+    error: (message: string, metadata?: Record<string, any>) => void;
+};
+export declare const webhookLogger: {
+    debug: (message: string, metadata?: Record<string, any>) => void;
+    info: (message: string, metadata?: Record<string, any>) => void;
+    warn: (message: string, metadata?: Record<string, any>) => void;
+    error: (message: string, metadata?: Record<string, any>) => void;
+};
+export declare const eventsLogger: {
+    debug: (message: string, metadata?: Record<string, any>) => void;
+    info: (message: string, metadata?: Record<string, any>) => void;
+    warn: (message: string, metadata?: Record<string, any>) => void;
+    error: (message: string, metadata?: Record<string, any>) => void;
+};
+export declare const adapterLogger: {
+    debug: (message: string, metadata?: Record<string, any>) => void;
+    info: (message: string, metadata?: Record<string, any>) => void;
+    warn: (message: string, metadata?: Record<string, any>) => void;
+    error: (message: string, metadata?: Record<string, any>) => void;
+};
+//# sourceMappingURL=logger.d.ts.map

package/dist/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAgCA,eAAO,MAAM,UAAU;qBAvBF,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;oBAAtC,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;oBAAtC,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;qBAAtC,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAuBb,CAAC;AAC/C,eAAO,MAAM,aAAa;qBAxBL,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;oBAAtC,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;oBAAtC,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;qBAAtC,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAwBP,CAAC;AACrD,eAAO,MAAM,aAAa;qBAzBL,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;oBAAtC,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;oBAAtC,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;qBAAtC,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAyBP,CAAC;AACrD,eAAO,MAAM,YAAY;qBA1BJ,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;oBAAtC,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;oBAAtC,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;qBAAtC,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CA0BT,CAAC;AACnD,eAAO,MAAM,aAAa;qBA3BL,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;oBAAtC,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;oBAAtC,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;qBAAtC,MAAM,aAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CA2BP,CAAC"}