@versori/run 0.4.0-alpha.1 → 0.4.0-docs.14

package/esm/src/context/ActivationImpl.js

@@ -1,3 +1,15 @@
+/*
+ * Copyright (c) 2025 Versori Group Inc
+ *
+ * Use of this software is governed by the Business Source License 1.1
+ * included in the LICENSE file at the root of this repository.
+ *
+ * Change Date: 2029-01-01
+ * Change License: Apache License, Version 2.0
+ *
+ * As of the Change Date, in accordance with the Business Source License,
+ * use of this software will be governed by the Apache License, Version 2.0.
+ */
 export class ActivationImpl {
     constructor(activation, platformApi, organisationId, environmentId, log) {
         Object.defineProperty(this, "activation", {
@@ -67,7 +79,7 @@ export class ActivationImpl {
                 },
                 body: {
                     value,
-                }
+                },
             });
         }
         catch (err) {

package/esm/src/context/AsyncWorkflow.d.ts

@@ -1,4 +1,8 @@
 import { QueueAPI } from '../interpreter/durable/Queue.js';
+/**
+ * AsyncWorkflow represents a durable workflow that has been started asynchronously using `ctx.start()`.
+ * It provides methods to wait for completion and retrieve the workflow's output data.
+ */
 export declare class AsyncWorkflow {
     private workflowId;
     private queue;
@@ -7,9 +11,35 @@ export declare class AsyncWorkflow {
     private isWaiting;
     private isCompleted;
     constructor(queue: QueueAPI, workflowId: string);
+    /**
+     * The unique identifier for this workflow instance.
+     */
     get id(): string;
+    /**
+     * Wait for the workflow to complete by polling the queue.
+     *
+     * If the workflow is already completed, returns immediately. Throws an error if already waiting or if the wait
+     * times out.
+     *
+     * @param maxWait Optional maximum wait time in milliseconds. If exceeded, throws an error.
+     * @throws Error if already waiting for this workflow or if maxWait is exceeded.
+     */
     wait(maxWait?: number): Promise<void>;
+    /**
+     * Get the parsed output data from the completed workflow.
+     *
+     * If the workflow hasn't completed yet, this will wait for it to complete first.
+     *
+     * @returns The workflow's output data, JSON parsed.
+     */
     getData(): Promise<unknown | undefined>;
+    /**
+     * Get the raw output data from the completed workflow as a base64 encoded string.
+     *
+     * If the workflow hasn't completed yet, this will wait for it to complete first.
+     *
+     * @returns The workflow's output data, base64 encoded.
+     */
     getDataRaw(): Promise<string | undefined>;
 }
 //# sourceMappingURL=AsyncWorkflow.d.ts.map

package/esm/src/context/AsyncWorkflow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AsyncWorkflow.d.ts","sourceRoot":"","sources":["../../../src/src/context/AsyncWorkflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAE3D,qBAAa,aAAa;IACtB,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,KAAK,CAAW;IACxB,OAAO,CAAC,IAAI,CAAsB;IAClC,OAAO,CAAC,OAAO,CAAqB;IACpC,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,WAAW,CAAkB;gBAEzB,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM;IAK/C,IAAI,EAAE,IAAI,MAAM,CAEf;IAMK,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAsCrC,OAAO,IAAI,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAQvC,UAAU,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAMlD"}
+{"version":3,"file":"AsyncWorkflow.d.ts","sourceRoot":"","sources":["../../../src/src/context/AsyncWorkflow.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAE3D;;;GAGG;AACH,qBAAa,aAAa;IACtB,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,KAAK,CAAW;IACxB,OAAO,CAAC,IAAI,CAAsB;IAClC,OAAO,CAAC,OAAO,CAAqB;IACpC,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,WAAW,CAAkB;gBAEzB,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM;IAK/C;;OAEG;IACH,IAAI,EAAE,IAAI,MAAM,CAEf;IAED;;;;;;;;OAQG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAoC3C;;;;;;OAMG;IACG,OAAO,IAAI,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAO7C;;;;;;OAMG;IACG,UAAU,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAMlD"}

package/esm/src/context/AsyncWorkflow.js

@@ -1,3 +1,19 @@
+/*
+ * Copyright (c) 2025 Versori Group Inc
+ *
+ * Use of this software is governed by the Business Source License 1.1
+ * included in the LICENSE file at the root of this repository.
+ *
+ * Change Date: 2029-01-01
+ * Change License: Apache License, Version 2.0
+ *
+ * As of the Change Date, in accordance with the Business Source License,
+ * use of this software will be governed by the Apache License, Version 2.0.
+ */
+/**
+ * AsyncWorkflow represents a durable workflow that has been started asynchronously using `ctx.start()`.
+ * It provides methods to wait for completion and retrieve the workflow's output data.
+ */
 export class AsyncWorkflow {
     constructor(queue, workflowId) {
         Object.defineProperty(this, "workflowId", {
@@ -39,13 +55,21 @@ export class AsyncWorkflow {
         this.queue = queue;
         this.workflowId = workflowId;
     }
+    /**
+     * The unique identifier for this workflow instance.
+     */
     get id() {
         return this.workflowId;
     }
-    // wait will wait for the workflow to complete by polling the queue
-    // If maxWait is provided (in milliseconds), it will wait for that long before giving up
-    // If the workflow is already completed, it will return immediately.
-    // Throws an error if already waiting or if the wait times out.
+    /**
+     * Wait for the workflow to complete by polling the queue.
+     *
+     * If the workflow is already completed, returns immediately. Throws an error if already waiting or if the wait
+     * times out.
+     *
+     * @param maxWait Optional maximum wait time in milliseconds. If exceeded, throws an error.
+     * @throws Error if already waiting for this workflow or if maxWait is exceeded.
+     */
     async wait(maxWait) {
         if (this.isWaiting) {
             return Promise.reject(new Error('already waiting for workflow to complete'));
@@ -72,17 +96,29 @@ export class AsyncWorkflow {
                 this.isCompleted = true;
                 return;
             }
-            await new Promise(resolve => setTimeout(resolve, 1000));
+            await new Promise((resolve) => setTimeout(resolve, 1000));
         }
     }
-    // getData returns the data as D type, which is JSON parsed
+    /**
+     * Get the parsed output data from the completed workflow.
+     *
+     * If the workflow hasn't completed yet, this will wait for it to complete first.
+     *
+     * @returns The workflow's output data, JSON parsed.
+     */
     async getData() {
         if (!this.isWaiting) {
             await this.wait();
         }
         return this.data;
     }
-    // getDataRaw returns the raw data as base64 encoded string
+    /**
+     * Get the raw output data from the completed workflow as a base64 encoded string.
+     *
+     * If the workflow hasn't completed yet, this will wait for it to complete first.
+     *
+     * @returns The workflow's output data, base64 encoded.
+     */
     async getDataRaw() {
         if (!this.isWaiting) {
             await this.wait();

package/esm/src/context/Context.d.ts

@@ -4,8 +4,8 @@ import { QueueAPI } from '../interpreter/durable/Queue.js';
 import { Issue, IssueAPI } from '../issues/Issues.js';
 import { KeyValue, KeyValueProvider, KeyValueScope } from '../kv/KeyValue.js';
 import { Logger } from '../observability/logging/Logger.js';
-import { AsyncWorkflow } from './AsyncWorkflow.js';
 import { ActivationImpl } from './ActivationImpl.js';
+import { AsyncWorkflow } from './AsyncWorkflow.js';
 export type OnSuccessFn = (ctx: Context<any>) => void;
 export type OnErrorFn = (ctx: Context<any>) => void;
 export type ContextOptions = {
@@ -14,17 +14,52 @@ export type ContextOptions = {
     onSuccess?: OnSuccessFn;
     onError?: OnErrorFn;
 };
+/**
+ * WorkflowOpts is used to pass data to the workflow when starting it. Use either `data` or `dataRaw`, but not both.
+ *
+ * MaxAttempts is used to limit the number of attempts for the workflow execution.
+ */
 export type WorkflowOpts = {
+    /**
+     * MaxAttempts is used to limit the number of attempts for the workflow execution.
+     *
+     * @default 5
+     */
     maxAttempts?: number;
+    /**
+     * The data passed to the workflow instance when it was created.
+     */
     data?: unknown;
+    /**
+     * The data passed to the workflow instance when it was created, base64 encoded.
+     */
     dataRaw?: string;
 };
+/**
+ * CreateIssue is the payload for creating a new issue.
+ */
 export type CreateIssue = {
+    /**
+     * The severity of the issue.
+     */
     severity: 'low' | 'medium' | 'high';
+    /**
+     * The title of the issue.
+     */
     title: string;
+    /**
+     * The message of the issue.
+     */
     message: string;
+    /**
+     * Any additional annotations to attach to the issue.
+     */
     annotations: Record<string, string>;
 };
+/**
+ * Context is the object passed to workflow functions, it provides access to the data being processed by the workflow,
+ * as well as a number of other properties and methods for implementing the workflow logic.
+ */
 export interface Context<D> {
     readonly log: Logger;
     readonly executionId: string;
@@ -33,15 +68,43 @@ export interface Context<D> {
     activation: ActivationImpl;
     /**
      * Opens a key value store for the given scope, defaulting to ':project:' if not provided.
-     * @param scope
+     * @param scope The scope of the key value store to open, defaulting to ':project:' if not provided.
      */
     openKv(scope?: KeyValueScope): KeyValue;
+    /**
+     * Starts a workflow with the given ID and options.
+     * @param workflowId The ID of the workflow to start, this should refer to a workflow registered with the
+     *  {@link DurableInterpreter}.
+     * @param workflowOpts The options for the workflow.
+     *
+     * The integration must be ran using the {@link DurableInterpreter} and not {@link MemoryInterpreter} (the
+     * default interpreter). Reach out to support if you need help with this.
+     */
     start(workflowId: string, workflowOpts: WorkflowOpts): Promise<AsyncWorkflow>;
+    /**
+     * Returns a {@link CredentialsProvider} which can be used to read credential data directly and construct requests
+     * for systems using custom authentication methods which are not supported natively by Versori.
+     */
     credentials(): CredentialsProvider;
+    /**
+     * Destroys the key value store for the given scope, ":execution:", ":project:" or ":organization:".
+     *
+     * @param scope The scope of the key value store to destroy, ":execution:", ":project:" or ":organization:".
+     */
     destroy(scope: KeyValueScope): Promise<void>;
+    /**
+     * Creates a new issue for the current context. Issues can be managed through the Versori platform or via the API.
+     * Users can configure notification channels within their account settings to be notified of new issues.
+     *
+     * @param issue The issue to create.
+     * @param options Optional options for the issue creation.
+     */
     createIssue(issue: CreateIssue, options?: {
         deduplicate?: boolean;
     }): Promise<Issue | null>;
+    /**
+     * Returns the underlying express {@link express.Request} object for the current execution.
+     */
     request(): express.Request | undefined;
 }
 export declare class ContextImpl<D, Index = void> implements Context<D> {

package/esm/src/context/Context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Context.d.ts","sourceRoot":"","sources":["../../../src/src/context/Context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,OAAO,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,mBAAmB,EAAE,MAAM,2CAA2C,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAC9E,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,MAAM,MAAM,WAAW,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC;AACtD,MAAM,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC;AAEpD,MAAM,MAAM,cAAc,GAAG;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,WAAW,CAAC;IACxB,OAAO,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAKF,MAAM,MAAM,YAAY,GAAG;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACtB,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,WAAW,OAAO,CAAC,CAAC;IACtB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAEjB,UAAU,EAAE,cAAc,CAAC;IAE3B;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;IAExC,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAE9E,WAAW,IAAI,mBAAmB,CAAC;IAEnC,OAAO,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IAE5F,OAAO,IAAI,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;CAC1C;AAED,qBAAa,WAAW,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI,CAAE,YAAW,OAAO,CAAC,CAAC,CAAC;;IAC3D,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAGjB,GAAG,EAAE,KAAK,CAAC;IAEX,QAAQ,CAAC,GAAG,EAAE,gBAAgB,CAAC;IAC/B,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC;IAE1B,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;gBAI7B,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,gBAAgB,EACrB,KAAK,EAAE,mBAAmB,EAC1B,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,IAAI,EACf,IAAI,EAAE,CAAC,EACP,UAAU,EAAE,cAAc,EAC1B,MAAM,EAAE,QAAQ,EAChB,KAAK,CAAC,EAAE,QAAQ,EAChB,OAAO,GAAE,cAAmB;IA0BhC,IAAI,UAAU,IAAI,cAAc,CAE/B;IAED,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAEnC;IAED,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC;IAkB7C,QAAQ,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,GAAG,WAAW,CAAC,EAAE,EAAE,KAAK,CAAC;IAe9C,MAAM,CAAC,KAAK,GAAE,aAA2B,GAAG,QAAQ;IAepD,OAAO,IAAI,OAAO,CAAC,OAAO,GAAG,SAAS;IAIhC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC;IAgCtE,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAO3F,WAAW,IAAI,mBAAmB;IAUlC,OAAO,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAe5C,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAQlD"}
+{"version":3,"file":"Context.d.ts","sourceRoot":"","sources":["../../../src/src/context/Context.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,KAAK,OAAO,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,mBAAmB,EAAE,MAAM,2CAA2C,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAC9E,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,MAAM,MAAM,WAAW,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC;AACtD,MAAM,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC;AAEpD,MAAM,MAAM,cAAc,GAAG;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,WAAW,CAAC;IACxB,OAAO,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG;IACvB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACtB;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;IAEpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACvC,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,OAAO,CAAC,CAAC;IACtB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAEjB,UAAU,EAAE,cAAc,CAAC;IAE3B;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;IAExC;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAE9E;;;OAGG;IACH,WAAW,IAAI,mBAAmB,CAAC;IAEnC;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;;;OAMG;IACH,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IAE5F;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;CAC1C;AAED,qBAAa,WAAW,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI,CAAE,YAAW,OAAO,CAAC,CAAC,CAAC;;IAC3D,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAGjB,GAAG,EAAE,KAAK,CAAC;IAEX,QAAQ,CAAC,GAAG,EAAE,gBAAgB,CAAC;IAC/B,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC;IAE1B,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;gBAI7B,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,gBAAgB,EACrB,KAAK,EAAE,mBAAmB,EAC1B,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,IAAI,EACf,IAAI,EAAE,CAAC,EACP,UAAU,EAAE,cAAc,EAC1B,MAAM,EAAE,QAAQ,EAChB,KAAK,CAAC,EAAE,QAAQ,EAChB,OAAO,GAAE,cAAmB;IA0BhC,IAAI,UAAU,IAAI,cAAc,CAE/B;IAED,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAEnC;IAED,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC;IAkB7C,QAAQ,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,GAAG,WAAW,CAAC,EAAE,EAAE,KAAK,CAAC;IAe9C,MAAM,CAAC,KAAK,GAAE,aAA2B,GAAG,QAAQ;IAepD,OAAO,IAAI,OAAO,CAAC,OAAO,GAAG,SAAS;IAIhC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC;IAgCtE,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAO3F,WAAW,IAAI,mBAAmB;IAUlC,OAAO,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAe5C,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAQlD"}

package/esm/src/context/Context.js

@@ -1,3 +1,15 @@
+/*
+ * Copyright (c) 2025 Versori Group Inc
+ *
+ * Use of this software is governed by the Business Source License 1.1
+ * included in the LICENSE file at the root of this repository.
+ *
+ * Change Date: 2029-01-01
+ * Change License: Apache License, Version 2.0
+ *
+ * As of the Change Date, in accordance with the Business Source License,
+ * use of this software will be governed by the Apache License, Version 2.0.
+ */
 var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
     if (kind === "m") throw new TypeError("Private method is not writable");
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");

package/esm/src/context/ContextFunc.d.ts

@@ -1,5 +1,27 @@
 import { Context } from './Context.js';
+/**
+ * ContextFunc represents a function that can be used as a task in a workflow. It can be either synchronous or
+ * asynchronous, and receives a {@link Context} object and an optional index parameter.
+ *
+ * @template Input The type of data expected in the context.
+ * @template Output The type of data returned by the function.
+ * @template Index Optional index parameter, typically used when processing arrays.
+ */
 export type ContextFunc<Input, Output, Index = void> = AsyncContextFunc<Input, Output, Index> | SyncContextFunc<Input, Output, Index>;
+/**
+ * AsyncContextFunc is an asynchronous function that can be used as a task in a workflow.
+ *
+ * @template Input The type of data expected in the context.
+ * @template Output The type of data returned by the function.
+ * @template Index Optional index parameter, typically used when processing arrays.
+ */
 export type AsyncContextFunc<Input, Output, Index> = (ctx: Context<Input>, idx: Index) => Promise<Output>;
+/**
+ * SyncContextFunc is a synchronous function that can be used as a task in a workflow.
+ *
+ * @template Input The type of data expected in the context.
+ * @template Output The type of data returned by the function.
+ * @template Index Optional index parameter, typically used when processing arrays.
+ */
 export type SyncContextFunc<Input, Output, Index> = (ctx: Context<Input>, idx: Index) => Output;
 //# sourceMappingURL=ContextFunc.d.ts.map

package/esm/src/context/ContextFunc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ContextFunc.d.ts","sourceRoot":"","sources":["../../../src/src/context/ContextFunc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,IAAI,IAC7C,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,GACtC,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAE5C,MAAM,MAAM,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,KAAK,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAE1G,MAAM,MAAM,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,KAAK,KAAK,MAAM,CAAC"}
+{"version":3,"file":"ContextFunc.d.ts","sourceRoot":"","sources":["../../../src/src/context/ContextFunc.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,IAAI,IAC7C,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,GACtC,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAE5C;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,IAAI,CACjD,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,EACnB,GAAG,EAAE,KAAK,KACT,OAAO,CAAC,MAAM,CAAC,CAAC;AAErB;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,KAAK,KAAK,MAAM,CAAC"}

package/esm/src/context/ContextFunc.js

@@ -1 +1,13 @@
+/*
+ * Copyright (c) 2025 Versori Group Inc
+ *
+ * Use of this software is governed by the Business Source License 1.1
+ * included in the LICENSE file at the root of this repository.
+ *
+ * Change Date: 2029-01-01
+ * Change License: Apache License, Version 2.0
+ *
+ * As of the Change Date, in accordance with the Business Source License,
+ * use of this software will be governed by the Apache License, Version 2.0.
+ */
 export {};

package/esm/src/context/ContextProvider.d.ts

@@ -3,8 +3,8 @@ import { QueueAPI } from '../interpreter/durable/Queue.js';
 import { IssueAPI } from '../issues/Issues.js';
 import { KeyValueProvider } from '../kv/KeyValue.js';
 import { Logger } from '../observability/logging/Logger.js';
-import { Activation, PlatformApi } from '../services/platform/mod.js';
 import { Context, ContextImpl, ContextOptions } from './Context.js';
+import { Activation, PlatformApi } from '../services/platform/mod.js';
 export interface ContextProvider {
     create<D>(activation: Activation, data: D, options?: ContextOptions): ContextImpl<D, void>;
     destroy(ctx: Context<any>): Promise<void>;

package/esm/src/context/ContextProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ContextProvider.d.ts","sourceRoot":"","sources":["../../../src/src/context/ContextProvider.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2CAA2C,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAEtE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAEpE,MAAM,WAAW,eAAe;IAC5B,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAC3F,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7C;AAED,qBAAa,mBAAoB,YAAW,eAAe;IAWnD,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAZlC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,gBAAgB,CAAC;IACtB,KAAK,EAAE,mBAAmB,CAAC;IAC3B,MAAM,EAAE,QAAQ,CAAC;IACjB,KAAK,CAAC,EAAE,QAAQ,CAAC;gBAGb,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,gBAAgB,EACrB,KAAK,EAAE,mBAAmB,EACT,WAAW,EAAE,WAAW,EACxB,cAAc,EAAE,MAAM,EACtB,aAAa,EAAE,MAAM,EACtC,MAAM,EAAE,QAAQ,EAChB,KAAK,GAAE,QAAQ,GAAG,SAAqB;IAS3C,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,GAAE,cAAmB,GAAG,WAAW,CAAC,CAAC,CAAC;IAyBxF,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAG1C"}
+{"version":3,"file":"ContextProvider.d.ts","sourceRoot":"","sources":["../../../src/src/context/ContextProvider.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2CAA2C,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAGtE,MAAM,WAAW,eAAe;IAC5B,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAC3F,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7C;AAED,qBAAa,mBAAoB,YAAW,eAAe;IAWnD,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAZlC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,gBAAgB,CAAC;IACtB,KAAK,EAAE,mBAAmB,CAAC;IAC3B,MAAM,EAAE,QAAQ,CAAC;IACjB,KAAK,CAAC,EAAE,QAAQ,CAAC;gBAGb,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,gBAAgB,EACrB,KAAK,EAAE,mBAAmB,EACT,WAAW,EAAE,WAAW,EACxB,cAAc,EAAE,MAAM,EACtB,aAAa,EAAE,MAAM,EACtC,MAAM,EAAE,QAAQ,EAChB,KAAK,GAAE,QAAQ,GAAG,SAAqB;IAS3C,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,GAAE,cAAmB,GAAG,WAAW,CAAC,CAAC,CAAC;IA+BxF,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAG1C"}

package/esm/src/context/ContextProvider.js

@@ -1,6 +1,18 @@
+/*
+ * Copyright (c) 2025 Versori Group Inc
+ *
+ * Use of this software is governed by the Business Source License 1.1
+ * included in the LICENSE file at the root of this repository.
+ *
+ * Change Date: 2029-01-01
+ * Change License: Apache License, Version 2.0
+ *
+ * As of the Change Date, in accordance with the Business Source License,
+ * use of this software will be governed by the Apache License, Version 2.0.
+ */
 import { ulid } from '../../deps/jsr.io/@std/ulid/1.0.0/mod.js';
-import { ActivationImpl } from './ActivationImpl.js';
 import { ContextImpl } from './Context.js';
+import { ActivationImpl } from './ActivationImpl.js';
 export class ContextProviderImpl {
     constructor(log, kvp, creds, platformApi, organisationId, environmentId, issues, queue = undefined) {
         Object.defineProperty(this, "platformApi", {

package/esm/src/context/mod.d.ts

@@ -1,4 +1,10 @@
-export * from './Context.js';
+/**
+ * The context module provides the functionality for accessing the data, metadata, and interacting with the Versori
+ * managed services within a workflow.
+ *
+ * @module
+ */
+export type { Context, CreateIssue, WorkflowOpts } from './Context.js';
+export type { AsyncWorkflow } from './AsyncWorkflow.js';
 export * from './ContextFunc.js';
-export * from './ContextProvider.js';
 //# sourceMappingURL=mod.d.ts.map

package/esm/src/context/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../src/src/context/mod.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../src/src/context/mod.ts"],"names":[],"mappings":"AAaA;;;;;GAKG;AACH,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACvE,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,cAAc,kBAAkB,CAAC"}

package/esm/src/context/mod.js

@@ -1,3 +1,13 @@
-export * from './Context.js';
+/*
+ * Copyright (c) 2025 Versori Group Inc
+ *
+ * Use of this software is governed by the Business Source License 1.1
+ * included in the LICENSE file at the root of this repository.
+ *
+ * Change Date: 2029-01-01
+ * Change License: Apache License, Version 2.0
+ *
+ * As of the Change Date, in accordance with the Business Source License,
+ * use of this software will be governed by the Apache License, Version 2.0.
+ */
 export * from './ContextFunc.js';
-export * from './ContextProvider.js';

package/esm/src/dsl/Task.d.ts

@@ -1,5 +1,15 @@
 import { ContextFunc } from '../context/ContextFunc.js';
+/**
+ * Symbol used to identify objects as tasks.
+ */
 export declare const TaskType: unique symbol;
+/**
+ * Task represents a single unit of work in a workflow. Tasks can be chained together using the `.then()` method,
+ * handle errors with `.catch()`, run in the background with `.background()`, and process arrays with `.unpack()`.
+ *
+ * @template In The input type expected by this task.
+ * @template Out The output type produced by this task.
+ */
 export interface Task<In = any, Out = any> extends Object {
     [TaskType]: string;
     /**
@@ -18,16 +28,51 @@ export interface Task<In = any, Out = any> extends Object {
      */
     catch<NextOut>(task: Taskable<Error, NextOut>): Task<In, NextOut>;
     /**
-     * Run the current task in the background and continue execution of the workflow.
+     * Run the current task in the background and continue execution of the workflow. The next step's input data will be
+     * of type `void`.
      */
     background(): Task<In, void>;
     unpack<NextOut = Out extends Array<infer Elem> ? Elem : Out>(): ArrayTask<In, NextOut>;
     unpack<NextOut>(mapper: (data: Out) => NextOut[]): ArrayTask<In, NextOut>;
+    /**
+     * Create a copy of this task.
+     *
+     * @returns A cloned instance of this task.
+     */
     clone(): Task<In, Out>;
 }
+/**
+ * ArrayTask extends {@link Task} with methods for processing array elements either in parallel or serial.
+ * It is created by calling `.unpack()` on a task that produces an array.
+ *
+ * @template In The input type expected by this task.
+ * @template OutElem The type of individual elements in the output array.
+ */
 export type ArrayTask<In, OutElem> = Task<In, OutElem[]> & {
+    /**
+     * Process each element of the array in parallel.
+     *
+     * @template NextOut The output type produced by the task for each element.
+     * @param task The task to apply to each element.
+     * @returns A task that outputs an array of results.
+     */
     parallel<NextOut>(task: Taskable<OutElem, NextOut, number>): Task<In, NextOut[]>;
+    /**
+     * Process each element of the array in series (one after another).
+     *
+     * @template NextOut The output type produced by the task for each element.
+     * @param task The task to apply to each element.
+     * @returns A task that outputs an array of results.
+     */
     serial<NextOut>(task: Taskable<OutElem, NextOut, number>): Task<In, NextOut[]>;
 };
+/**
+ * Taskable represents anything that can be used as a task in a workflow: either a {@link Task} object or a
+ * {@link ContextFunc} function.
+ *
+ * @template In The input type expected by this task.
+ * @template O The output type produced by this task.
+ * @template Index Optional index parameter used when processing arrays.
+ */
 export type Taskable<In, O, Index = unknown> = Task<In, O> | ContextFunc<In, O, Index>;
 //# sourceMappingURL=Task.d.ts.map

package/esm/src/dsl/Task.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Task.d.ts","sourceRoot":"","sources":["../../../src/src/dsl/Task.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAExD,eAAO,MAAM,QAAQ,eAAiB,CAAC;AAEvC,MAAM,WAAW,IAAI,CAAC,EAAE,GAAG,GAAG,EAAE,GAAG,GAAG,GAAG,CAAE,SAAQ,MAAM;IACrD,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAE/D;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAElE;;OAEG;IACH,UAAU,IAAI,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAQ7B,MAAM,CAAC,OAAO,GAAG,GAAG,SAAS,KAAK,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,GAAG,KAAK,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IACvF,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,OAAO,EAAE,GAAG,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAO1E,KAAK,IAAI,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;CAC1B;AAID,MAAM,MAAM,SAAS,CAAC,EAAE,EAAE,OAAO,IAAI,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,GAAG;IACvD,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IACjF,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;CAClF,CAAC;AAEF,MAAM,MAAM,QAAQ,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,GAAG,OAAO,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC"}
+{"version":3,"file":"Task.d.ts","sourceRoot":"","sources":["../../../src/src/dsl/Task.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAExD;;GAEG;AACH,eAAO,MAAM,QAAQ,eAAiB,CAAC;AAEvC;;;;;;GAMG;AACH,MAAM,WAAW,IAAI,CAAC,EAAE,GAAG,GAAG,EAAE,GAAG,GAAG,GAAG,CAAE,SAAQ,MAAM;IACrD,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAE/D;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAElE;;;OAGG;IACH,UAAU,IAAI,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAQ7B,MAAM,CAAC,OAAO,GAAG,GAAG,SAAS,KAAK,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,GAAG,KAAK,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IACvF,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,OAAO,EAAE,GAAG,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAO1E;;;;OAIG;IACH,KAAK,IAAI,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;CAC1B;AAID;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,CAAC,EAAE,EAAE,OAAO,IAAI,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,GAAG;IACvD;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAEjF;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;CAClF,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,QAAQ,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,GAAG,OAAO,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC"}

package/esm/src/dsl/Task.js

@@ -1 +1,16 @@
+/*
+ * Copyright (c) 2025 Versori Group Inc
+ *
+ * Use of this software is governed by the Business Source License 1.1
+ * included in the LICENSE file at the root of this repository.
+ *
+ * Change Date: 2029-01-01
+ * Change License: Apache License, Version 2.0
+ *
+ * As of the Change Date, in accordance with the Business Source License,
+ * use of this software will be governed by the Apache License, Version 2.0.
+ */
+/**
+ * Symbol used to identify objects as tasks.
+ */
 export const TaskType = Symbol('Task');

package/esm/src/dsl/Trigger.d.ts

@@ -1,8 +1,24 @@
 import { Taskable } from './Task.js';
 import { Workflow } from './Workflow.js';
+/**
+ * Symbol used to identify the type of trigger.
+ */
 export declare const TriggerType: unique symbol;
+/**
+ * Trigger represents the starting point of a workflow. Triggers define when and how a workflow should be executed.
+ * Common trigger types include {@link schedule}, {@link webhook}, and {@link workflow}.
+ *
+ * @template O The type of data produced by this trigger.
+ */
 export interface Trigger<O> {
     [TriggerType]: string;
+    /**
+     * Attach a task to this trigger, creating a workflow.
+     *
+     * @template OO The output type of the task.
+     * @param task The task to execute when the trigger fires.
+     * @returns A workflow combining this trigger with the provided task.
+     */
     then<OO>(task: Taskable<O, OO>): Workflow<OO>;
 }
 //# sourceMappingURL=Trigger.d.ts.map

package/esm/src/dsl/Trigger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Trigger.d.ts","sourceRoot":"","sources":["../../../src/src/dsl/Trigger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,eAAO,MAAM,WAAW,eAAwB,CAAC;AAEjD,MAAM,WAAW,OAAO,CAAC,CAAC;IACtB,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAEtB,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;CACjD"}
+{"version":3,"file":"Trigger.d.ts","sourceRoot":"","sources":["../../../src/src/dsl/Trigger.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC;;GAEG;AACH,eAAO,MAAM,WAAW,eAAwB,CAAC;AAEjD;;;;;GAKG;AACH,MAAM,WAAW,OAAO,CAAC,CAAC;IACtB,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;CACjD"}

package/esm/src/dsl/Trigger.js

@@ -1 +1,16 @@
+/*
+ * Copyright (c) 2025 Versori Group Inc
+ *
+ * Use of this software is governed by the Business Source License 1.1
+ * included in the LICENSE file at the root of this repository.
+ *
+ * Change Date: 2029-01-01
+ * Change License: Apache License, Version 2.0
+ *
+ * As of the Change Date, in accordance with the Business Source License,
+ * use of this software will be governed by the Apache License, Version 2.0.
+ */
+/**
+ * Symbol used to identify the type of trigger.
+ */
 export const TriggerType = Symbol('TriggerType');

package/esm/src/dsl/Workflow.d.ts

@@ -1,7 +1,31 @@
 import { Task, Taskable } from './Task.js';
 import { Trigger } from './Trigger.js';
+/**
+ * Workflow represents a complete integration composed of a {@link Trigger} and one or more {@link Task}s.
+ * Workflows are registered with an interpreter (like {@link MemoryInterpreter} or {@link DurableInterpreter}) to be
+ * executed.
+ *
+ * @template O The output type of the final task in the workflow.
+ */
 export interface Workflow<O> {
+    /**
+     * Append a task to the end of this workflow.
+     *
+     * @template OO The output type of the new task.
+     * @param task The task to append.
+     * @returns A new workflow with the task appended.
+     */
     then<OO>(task: Taskable<O, OO>): Workflow<OO>;
+    /**
+     * Add error handling to the workflow.
+     *
+     * Typically the error will be a {@link Context<ExecutionError>}, but in some cases it may another {@link Error}
+     * type.
+     *
+     * @template OO The output type after error handling.
+     * @param error The error handler.
+     * @returns A new workflow with error handling.
+     */
     catch<OO>(error: any): Workflow<OO>;
 }
 export declare class WorkflowImpl<T, O> implements Workflow<O> {

package/esm/src/dsl/Workflow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Workflow.d.ts","sourceRoot":"","sources":["../../../src/src/dsl/Workflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAY,MAAM,WAAW,CAAC;AACrD,OAAO,EAAE,OAAO,EAAe,MAAM,cAAc,CAAC;AAIpD,MAAM,WAAW,QAAQ,CAAC,CAAC;IACvB,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC9C,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;CACvC;AAGD,qBAAa,YAAY,CAAC,CAAC,EAAE,CAAC,CAAE,YAAW,QAAQ,CAAC,CAAC,CAAC;IAClD,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAEL,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;IAQjD,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC;IAI7C,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,GAAG,QAAQ,CAAC,EAAE,CAAC;CAGtC"}
+{"version":3,"file":"Workflow.d.ts","sourceRoot":"","sources":["../../../src/src/dsl/Workflow.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC;IACvB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;IAE9C;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;CACvC;AAED,qBAAa,YAAY,CAAC,CAAC,EAAE,CAAC,CAAE,YAAW,QAAQ,CAAC,CAAC,CAAC;IAClD,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAEL,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;IAKjD,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC;IAI7C,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,GAAG,QAAQ,CAAC,EAAE,CAAC;CAGtC"}

package/esm/src/dsl/Workflow.js

@@ -1,3 +1,15 @@
+/*
+ * Copyright (c) 2025 Versori Group Inc
+ *
+ * Use of this software is governed by the Business Source License 1.1
+ * included in the LICENSE file at the root of this repository.
+ *
+ * Change Date: 2029-01-01
+ * Change License: Apache License, Version 2.0
+ *
+ * As of the Change Date, in accordance with the Business Source License,
+ * use of this software will be governed by the Apache License, Version 2.0.
+ */
 export class WorkflowImpl {
     constructor(trigger, task) {
         Object.defineProperty(this, "trigger", {
@@ -14,8 +26,6 @@ export class WorkflowImpl {
         });
         this.trigger = trigger;
         this.task = task;
-        this.then = this.then.bind(this);
-        this.catch = this.catch.bind(this);
     }
     then(task) {
         return new WorkflowImpl(this.trigger, this.task.then(task));

package/esm/src/dsl/ensureTask.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ensureTask.d.ts","sourceRoot":"","sources":["../../../src/src/dsl/ensureTask.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAG3C,wBAAgB,UAAU,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAMtF"}
+{"version":3,"file":"ensureTask.d.ts","sourceRoot":"","sources":["../../../src/src/dsl/ensureTask.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAG3C,wBAAgB,UAAU,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAMtF"}