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

package/script/src/dsl/triggers/WebhookTrigger.d.ts

@@ -2,14 +2,40 @@ import { Context } from '../../context/Context.js';
 import { Taskable } from '../Task.js';
 import { Trigger, TriggerType } from '../Trigger.js';
 import { Workflow } from '../Workflow.js';
+/**
+ * WebhookData is the type of data passed to tasks triggered by a webhook. The actual request data is available
+ * through the context.
+ */
 export type WebhookData = Record<string, never>;
+/**
+ * WebhookCorsOptions configures Cross-Origin Resource Sharing (CORS) for webhook endpoints. Can be a boolean to
+ * enable/disable CORS with defaults, or an object with detailed CORS configuration.
+ */
 export type WebhookCorsOptions = boolean | {
+    /**
+     * The allowed origin(s) for CORS requests.
+     */
     origin: string;
+    /**
+     * The allowed HTTP methods.
+     */
     methods: string[];
+    /**
+     * The allowed request headers.
+     */
     allowedHeaders: string[];
+    /**
+     * The headers exposed in the response.
+     */
     exposedHeaders: string[];
+    /**
+     * Whether to allow credentials in CORS requests.
+     */
     credentials: boolean;
 };
+/**
+ * WebhookRequestOptions configures how webhook requests are processed.
+ */
 export type WebhookRequestOptions = {
     /**
      * If true, the raw body of the request will be passed to the context. Users will need to
@@ -18,6 +44,9 @@ export type WebhookRequestOptions = {
      */
     rawBody?: boolean;
 };
+/**
+ * WebhookResponseOptions configures how webhook responses are sent to clients.
+ */
 export type WebhookResponseOptions = {
     /**
      * Mode determines how the response is sent to the client. The response can be customized by
@@ -48,11 +77,29 @@ export type WebhookResponseOptions = {
      */
     onError?: <T>(ctx: Context<T>) => Response;
 };
+/**
+ * WebhookOptions configures a webhook trigger with CORS, response handling, and HTTP method settings.
+ */
 export type WebhookOptions = {
+    /**
+     * CORS configuration for the webhook endpoint.
+     */
     cors?: WebhookCorsOptions;
+    /**
+     * Response handling configuration.
+     */
     response?: WebhookResponseOptions;
+    /**
+     * Optional connection to use for verifying webhook signatures or authentication.
+     */
     connection?: string;
-    method?: "all" | "get" | "post" | "put" | "delete" | "patch" | "options" | "head";
+    /**
+     * The HTTP method(s) to accept. Defaults to 'all'.
+     */
+    method?: 'all' | 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head';
+    /**
+     * Request processing configuration.
+     */
     request?: WebhookRequestOptions;
 };
 export declare class WebhookTrigger implements Trigger<WebhookData> {
@@ -62,5 +109,28 @@ export declare class WebhookTrigger implements Trigger<WebhookData> {
     constructor(id: string, options?: WebhookOptions);
     then<OO>(task: Taskable<WebhookData, OO>): Workflow<OO>;
 }
+/**
+ * Create a workflow that is triggered by incoming HTTP webhook requests.
+ *
+ * Webhook workflows create an HTTP endpoint that can receive requests from external systems. The request data is
+ * available through the context object. You can configure CORS, response handling, HTTP methods, and request
+ * processing options.
+ *
+ * @param id A unique identifier for this workflow, which will be used in the webhook URL path.
+ * @param options Optional configuration for CORS, response handling, and request processing.
+ * @returns A trigger that can be used to create a workflow.
+ *
+ * @example
+ * ```typescript
+ * import { webhook, fn } from '@versori/run';
+ *
+ * const handleWebhook = webhook('github-push', { method: 'post' })
+ *   .then(fn('process-push', async (ctx) => {
+ *     const payload = ctx.data;
+ *     ctx.log.info('Received push event', { payload });
+ *     // ... process webhook
+ *   }));
+ * ```
+ */
 export declare function webhook(id: string, options?: WebhookOptions): Trigger<WebhookData>;
 //# sourceMappingURL=WebhookTrigger.d.ts.map

package/script/src/dsl/triggers/WebhookTrigger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WebhookTrigger.d.ts","sourceRoot":"","sources":["../../../../src/src/dsl/triggers/WebhookTrigger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AAEnD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAgB,MAAM,gBAAgB,CAAC;AAExD,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAEhD,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,WAAW,EAAE,OAAO,CAAC;CACxB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAChC;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACjC;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAExB;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC;IAE7C;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC;CAC9C,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IACzB,IAAI,CAAC,EAAE,kBAAkB,CAAC;IAC1B,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;IAClF,OAAO,CAAC,EAAE,qBAAqB,CAAC;CACnC,CAAA;AAED,qBAAa,cAAe,YAAW,OAAO,CAAC,WAAW,CAAC;IACvD,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,cAAc,CAAC;IAExB,CAAC,WAAW,CAAC,EAAE,MAAM,CAAa;gBAEtB,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB;IAOpD,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC;CAK1D;AAED,wBAAgB,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,CAElF"}
+{"version":3,"file":"WebhookTrigger.d.ts","sourceRoot":"","sources":["../../../../src/src/dsl/triggers/WebhookTrigger.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AAEnD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAgB,MAAM,gBAAgB,CAAC;AAExD;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAEhD;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG;IACvC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,cAAc,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAChC;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACjC;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAExB;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC;IAE7C;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC;CAC9C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,kBAAkB,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;IAElF;;OAEG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAC;CACnC,CAAC;AAEF,qBAAa,cAAe,YAAW,OAAO,CAAC,WAAW,CAAC;IACvD,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,cAAc,CAAC;IAExB,CAAC,WAAW,CAAC,EAAE,MAAM,CAAa;gBAEtB,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB;IAKpD,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC;CAG1D;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,CAElF"}

package/script/src/dsl/triggers/WebhookTrigger.js

@@ -1,4 +1,16 @@
 "use strict";
+/*
+ * 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 _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebhookTrigger = void 0;
@@ -28,15 +40,36 @@ class WebhookTrigger {
         });
         this.id = id;
         this.options = options;
-        this.then = this.then.bind(this);
     }
     then(task) {
-        const actualTask = (0, ensureTask_js_1.ensureTask)(task);
-        return new Workflow_js_1.WorkflowImpl(this, actualTask);
+        return new Workflow_js_1.WorkflowImpl(this, (0, ensureTask_js_1.ensureTask)(task));
     }
 }
 exports.WebhookTrigger = WebhookTrigger;
 _a = Trigger_js_1.TriggerType;
+/**
+ * Create a workflow that is triggered by incoming HTTP webhook requests.
+ *
+ * Webhook workflows create an HTTP endpoint that can receive requests from external systems. The request data is
+ * available through the context object. You can configure CORS, response handling, HTTP methods, and request
+ * processing options.
+ *
+ * @param id A unique identifier for this workflow, which will be used in the webhook URL path.
+ * @param options Optional configuration for CORS, response handling, and request processing.
+ * @returns A trigger that can be used to create a workflow.
+ *
+ * @example
+ * ```typescript
+ * import { webhook, fn } from '@versori/run';
+ *
+ * const handleWebhook = webhook('github-push', { method: 'post' })
+ *   .then(fn('process-push', async (ctx) => {
+ *     const payload = ctx.data;
+ *     ctx.log.info('Received push event', { payload });
+ *     // ... process webhook
+ *   }));
+ * ```
+ */
 function webhook(id, options) {
     return new WebhookTrigger(id, options);
 }

package/script/src/dsl/triggers/mod.d.ts

@@ -1,6 +1,4 @@
-export type * from './ScheduleTrigger.js';
-export type * from './WebhookTrigger.js';
-export { schedule } from './ScheduleTrigger.js';
-export { webhook } from './WebhookTrigger.js';
-export { workflow } from './DurableTrigger.js';
+export { schedule, type ActivationPredicate, type PrebuiltPredicate, type ScheduleData, } from './ScheduleTrigger.js';
+export { webhook, type WebhookCorsOptions, type WebhookData, type WebhookOptions, type WebhookRequestOptions, type WebhookResponseOptions, } from './WebhookTrigger.js';
+export { workflow, type DurableWorkflowData, type DurableWorkflowOptions, } from './DurableTrigger.js';
 //# sourceMappingURL=mod.d.ts.map

package/script/src/dsl/triggers/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../../src/src/dsl/triggers/mod.ts"],"names":[],"mappings":"AAAA,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,qBAAqB,CAAC;AAEzC,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../../src/src/dsl/triggers/mod.ts"],"names":[],"mappings":"AAaA,OAAO,EACH,QAAQ,EACR,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,YAAY,GACpB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACH,OAAO,EACP,KAAK,kBAAkB,EACvB,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,GAC9B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACH,QAAQ,EACR,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,GAC9B,MAAM,qBAAqB,CAAC"}

package/script/src/dsl/triggers/mod.js

@@ -1,4 +1,16 @@
 "use strict";
+/*
+ * 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.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.workflow = exports.webhook = exports.schedule = void 0;
 var ScheduleTrigger_js_1 = require("./ScheduleTrigger.js");

package/script/src/internal/InternalAuth.d.ts

@@ -5,6 +5,7 @@ export declare class InternalAuth {
     private clientId;
     private clientSecret;
     private tokenEndpoint;
+    private runLocal;
     private accessToken;
     private expiresAt;
     constructor();

package/script/src/internal/InternalAuth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InternalAuth.d.ts","sourceRoot":"","sources":["../../../src/src/internal/InternalAuth.ts"],"names":[],"mappings":"AAOA,KAAK,kBAAkB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAEpD,qBAAa,YAAY;IACrB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,aAAa,CAAS;IAE9B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,SAAS,CAAS;;IA2BpB,aAAa,IAAI,OAAO,CAAC,kBAAkB,CAAC;CAsBrD"}
+{"version":3,"file":"InternalAuth.d.ts","sourceRoot":"","sources":["../../../src/src/internal/InternalAuth.ts"],"names":[],"mappings":"AAsBA,KAAK,kBAAkB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAEpD,qBAAa,YAAY;IACrB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAU;IAE1B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,SAAS,CAAS;;IAkCpB,aAAa,IAAI,OAAO,CAAC,kBAAkB,CAAC;CAsBrD"}

package/script/src/internal/InternalAuth.js

@@ -1,6 +1,19 @@
 "use strict";
+/*
+ * 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.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InternalAuth = void 0;
+const cli_js_1 = require("./cli.js");
 const constants_js_1 = require("./constants.js");
 class InternalAuth {
     constructor() {
@@ -22,6 +35,12 @@ class InternalAuth {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "runLocal", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "accessToken", {
             enumerable: true,
             configurable: true,
@@ -39,12 +58,18 @@ class InternalAuth {
         this.tokenEndpoint = Deno.env.get(constants_js_1.envVarTokenEndpoint) || '';
         this.accessToken = '';
         this.expiresAt = 0;
+        this.runLocal = Deno.env.get(constants_js_1.envVarLocalRun) === 'true';
         if (Deno.env.get(constants_js_1.envVarInternalToken)) {
             this.accessToken = Deno.env.get(constants_js_1.envVarInternalToken) || '';
             this.expiresAt = Date.now() + 365 * 24 * 60 * 60 * 1000; // expires in 1 year
             console.log(`Using static token provided by ${constants_js_1.envVarInternalToken}`);
             return;
         }
+        if (this.runLocal) {
+            console.info('Running in local mode using cookie for authentication');
+            this.accessToken = (0, cli_js_1.getVersoriCookie)();
+            return;
+        }
         if (!this.clientId || !this.clientSecret || !this.tokenEndpoint) {
             const missingVars = [];
             if (!this.clientId)

package/script/src/internal/cli.d.ts

@@ -0,0 +1,2 @@
+export declare function getVersoriCookie(): string;
+//# sourceMappingURL=cli.d.ts.map

package/script/src/internal/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../../src/src/internal/cli.ts"],"names":[],"mappings":"AA8BA,wBAAgB,gBAAgB,IAAI,MAAM,CAmBzC"}

package/script/src/internal/cli.js

@@ -0,0 +1,35 @@
+"use strict";
+/*
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVersoriCookie = getVersoriCookie;
+// This file contains functions that can read stuff generated by the Versori CLI. This is used when running locally.
+const node_os_1 = require("node:os");
+const cookiesFileName = 'cookies.json';
+const versoriCookieName = 'versori_sess';
+function getVersoriCookie() {
+    const cookiesFilePath = `${(0, node_os_1.homedir)()}/.config/versori/${cookiesFileName}`;
+    let cookiesFile;
+    try {
+        cookiesFile = JSON.parse(Deno.readTextFileSync(cookiesFilePath));
+    }
+    catch (e) {
+        console.error('Error reading file, have you run the Versori CLI to log in?');
+        throw new Error(`Failed to read or parse cookies file at ${cookiesFilePath}: ${e}`);
+    }
+    const versoriCookie = cookiesFile.cookies.find((cookie) => cookie.Name === versoriCookieName);
+    if (!versoriCookie) {
+        throw new Error(`Cookie 'versori_sess' not found in ${cookiesFilePath}`);
+    }
+    return `${versoriCookieName}=${versoriCookie.Value}`;
+}

package/script/src/internal/constants.d.ts

@@ -10,13 +10,11 @@ export declare const envVarSelfRefURL = "RUN_SELF_REF_URL";
 export declare const envVarCredsBaseURL = "RUN_CREDENTIALS_SERVICE_INTERNAL_URL";
 export declare const envVarOtelTracesURL = "RUN_OTEL_TRACES_URL";
 export declare const envVarVersion = "RUN_SERVICE_VERSION";
-export declare const envReadyCheckURL = "READY_CHECK_URL";
-export declare const envPort = "PORT";
-export declare const envCronPort = "CRON_PORT";
 export declare const envVarConfigFile = "RUN_CONFIG_FILE";
 export declare const envVarClientId = "RUN_CLIENT_ID";
 export declare const envVarClientSecret = "RUN_CLIENT_SECRET";
 export declare const envVarTokenEndpoint = "RUN_TOKEN_ENDPOINT";
 export declare const envVarInternalToken = "RUN_INTERNAL_TOKEN";
+export declare const envVarLocalRun = "RUN_LOCAL";
 export declare const cronPort = 3001;
 //# sourceMappingURL=constants.d.ts.map

package/script/src/internal/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/src/internal/constants.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,WAAW,wBAAwB,CAAC;AACjD,eAAO,MAAM,WAAW,uBAAuB,CAAC;AAChD,eAAO,MAAM,qBAAqB,oBAAoB,CAAC;AACvD,eAAO,MAAM,eAAe,mBAAmB,CAAC;AAChD,eAAO,MAAM,aAAa,0BAA0B,CAAC;AACrD,eAAO,MAAM,wBAAwB,kCAAkC,CAAC;AACxE,eAAO,MAAM,oBAAoB,8BAA8B,CAAC;AAChE,eAAO,MAAM,mBAAmB,oBAAoB,CAAC;AACrD,eAAO,MAAM,gBAAgB,qBAAqB,CAAC;AACnD,eAAO,MAAM,kBAAkB,yCAAyC,CAAC;AACzE,eAAO,MAAM,mBAAmB,wBAAwB,CAAC;AACzD,eAAO,MAAM,aAAa,wBAAwB,CAAC;AACnD,eAAO,MAAM,gBAAgB,oBAAoB,CAAA;AACjD,eAAO,MAAM,OAAO,SAAS,CAAC;AAC9B,eAAO,MAAM,WAAW,cAAc,CAAC;AAGvC,eAAO,MAAM,gBAAgB,oBAAoB,CAAC;AAGlD,eAAO,MAAM,cAAc,kBAAkB,CAAC;AAC9C,eAAO,MAAM,kBAAkB,sBAAsB,CAAC;AACtD,eAAO,MAAM,mBAAmB,uBAAuB,CAAC;AACxD,eAAO,MAAM,mBAAmB,uBAAuB,CAAC;AAMxD,eAAO,MAAM,QAAQ,OAAO,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/src/internal/constants.ts"],"names":[],"mappings":"AAcA,eAAO,MAAM,WAAW,wBAAwB,CAAC;AACjD,eAAO,MAAM,WAAW,uBAAuB,CAAC;AAChD,eAAO,MAAM,qBAAqB,oBAAoB,CAAC;AACvD,eAAO,MAAM,eAAe,mBAAmB,CAAC;AAChD,eAAO,MAAM,aAAa,0BAA0B,CAAC;AACrD,eAAO,MAAM,wBAAwB,kCAAkC,CAAC;AACxE,eAAO,MAAM,oBAAoB,8BAA8B,CAAC;AAChE,eAAO,MAAM,mBAAmB,oBAAoB,CAAC;AACrD,eAAO,MAAM,gBAAgB,qBAAqB,CAAC;AACnD,eAAO,MAAM,kBAAkB,yCAAyC,CAAC;AACzE,eAAO,MAAM,mBAAmB,wBAAwB,CAAC;AACzD,eAAO,MAAM,aAAa,wBAAwB,CAAC;AAEnD,eAAO,MAAM,gBAAgB,oBAAoB,CAAC;AAGlD,eAAO,MAAM,cAAc,kBAAkB,CAAC;AAC9C,eAAO,MAAM,kBAAkB,sBAAsB,CAAC;AACtD,eAAO,MAAM,mBAAmB,uBAAuB,CAAC;AACxD,eAAO,MAAM,mBAAmB,uBAAuB,CAAC;AAGxD,eAAO,MAAM,cAAc,cAAc,CAAC;AAG1C,eAAO,MAAM,QAAQ,OAAO,CAAC"}

package/script/src/internal/constants.js

@@ -1,6 +1,18 @@
 "use strict";
+/*
+ * 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.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cronPort = exports.envVarInternalToken = exports.envVarTokenEndpoint = exports.envVarClientSecret = exports.envVarClientId = exports.envVarConfigFile = exports.envCronPort = exports.envPort = exports.envReadyCheckURL = exports.envVarVersion = exports.envVarOtelTracesURL = exports.envVarCredsBaseURL = exports.envVarSelfRefURL = exports.envVarSDKApiBaseURL = exports.envVarCronApiBaseURL = exports.envVarPlatformApiBaseURL = exports.envVarOrgSlug = exports.envVarProjectId = exports.envVarEnvironmentName = exports.envVarEnvId = exports.envVarOrgId = void 0;
+exports.cronPort = exports.envVarLocalRun = exports.envVarInternalToken = exports.envVarTokenEndpoint = exports.envVarClientSecret = exports.envVarClientId = exports.envVarConfigFile = exports.envVarVersion = exports.envVarOtelTracesURL = exports.envVarCredsBaseURL = exports.envVarSelfRefURL = exports.envVarSDKApiBaseURL = exports.envVarCronApiBaseURL = exports.envVarPlatformApiBaseURL = exports.envVarOrgSlug = exports.envVarProjectId = exports.envVarEnvironmentName = exports.envVarEnvId = exports.envVarOrgId = void 0;
 // This file contains constants used in the Versori DSL HTTP client.
 exports.envVarOrgId = 'RUN_ORGANISATION_ID';
 exports.envVarEnvId = 'RUN_ENVIRONMENT_ID';
@@ -14,9 +26,6 @@ exports.envVarSelfRefURL = 'RUN_SELF_REF_URL';
 exports.envVarCredsBaseURL = 'RUN_CREDENTIALS_SERVICE_INTERNAL_URL';
 exports.envVarOtelTracesURL = 'RUN_OTEL_TRACES_URL';
 exports.envVarVersion = 'RUN_SERVICE_VERSION';
-exports.envReadyCheckURL = 'READY_CHECK_URL';
-exports.envPort = 'PORT';
-exports.envCronPort = 'CRON_PORT';
 // The following environment variables are used for the config file
 exports.envVarConfigFile = 'RUN_CONFIG_FILE';
 // The following environment variables are used for internal authentication
@@ -25,6 +34,6 @@ exports.envVarClientSecret = 'RUN_CLIENT_SECRET';
 exports.envVarTokenEndpoint = 'RUN_TOKEN_ENDPOINT';
 exports.envVarInternalToken = 'RUN_INTERNAL_TOKEN';
 // The following are for running locally
-// export const envVarLocalRun = 'RUN_LOCAL';
+exports.envVarLocalRun = 'RUN_LOCAL';
 // please no changerino
 exports.cronPort = 3001; // The port on which the cron API communicates with the service

package/script/src/interpreter/durable/DurableInterpreter.d.ts

@@ -3,27 +3,39 @@ import { NodeSDK } from '@opentelemetry/sdk-node';
 import { Router } from 'express';
 import { Observable, Subscription } from 'rxjs';
 import { DirectConnectionFactory } from '../../connection/DirectConnectionFactory.js';
+import { ContextImpl } from '../../context/Context.js';
 import { ContextProvider } from '../../context/ContextProvider.js';
 import { ConfigReader, CronProvider } from '../../dsl/http/types.js';
 import { Workflow } from '../../dsl/Workflow.js';
 import { IssueAPI } from '../../issues/Issues.js';
-import { ContextImpl, ContextOperatorFunction } from '../../mod.js';
 import { Logger } from '../../observability/logging/Logger.js';
 import { PlatformApi } from '../../services/platform/PlatformApi.js';
+import { ContextOperatorFunction } from './compilers/types.js';
 import { ObservableCompiler } from './ObservableCompiler.js';
 import { QueueAPI } from './Queue.js';
-declare global {
-    namespace Express {
-        interface Request {
-            rawBody: Uint8Array;
-        }
-    }
-}
+/**
+ * DurableInterpreterOptions configures the behavior of the {@link DurableInterpreter}.
+ */
 export type DurableInterpreterOptions = {
+    /**
+     * Custom logger instance. Defaults to ConsoleLogger.
+     */
     logger?: Logger;
+    /**
+     * Custom compiler for workflow execution. Advanced use only.
+     */
     compiler?: ObservableCompiler;
+    /**
+     * Custom context provider. Advanced use only.
+     */
     contextProvider?: ContextProvider;
+    /**
+     * Abort signal to cancel workflow execution.
+     */
     signal?: AbortSignal;
+    /**
+     * Skip loading Versori credentials. Useful for local development.
+     */
     skipVersoriCredentials?: boolean;
 };
 type Registration = {
@@ -33,19 +45,37 @@ type Registration = {
     sigintListener: () => void;
     subscription?: Subscription;
 };
-type WebhookRegistry = Map<string, {
-    method: string;
-    path: string;
-    options: any;
-}>;
+/**
+ * DurableInterpreter is an interpreter for executing Versori workflows with support for durable, queue-based workflow
+ * execution. It supports all trigger types including the {@link workflow} trigger which allows workflows to be started
+ * programmatically.
+ *
+ * Unlike {@link MemoryInterpreter}, this interpreter provides durability and retry capabilities through a queue-based
+ * architecture. Workflows started with `ctx.start()` are queued and executed asynchronously with configurable retry
+ * policies.
+ *
+ * @example
+ * ```typescript
+ * import { DurableInterpreter, workflow, fn } from '@versori/run';
+ *
+ * const processJob = workflow('process-job', { maxAttempts: 3 })
+ *   .then(fn('task', async (ctx) => {
+ *     ctx.log.info('Processing job', { data: ctx.data });
+ *     // ... long-running process
+ *   }));
+ *
+ * const interpreter = new DurableInterpreter();
+ * interpreter.register(processJob);
+ * await interpreter.start();
+ * ```
+ */
 export declare class DurableInterpreter {
     private readonly log;
     private readonly compiler;
     private readonly contextProvider;
     private readonly webhookRouter;
     private readonly cronRouter;
-    private cronRegistry;
-    private webhookRegistry;
+    private readonly cronRegistry;
     private readonly platformApi;
     private readonly cnxFetchFactory;
     private readonly cronProvider;
@@ -59,7 +89,7 @@ export declare class DurableInterpreter {
     private cronServer?;
     private shutdownServer?;
     private isShuttingDown;
-    constructor(log: Logger, compiler: ObservableCompiler, contextProvider: ContextProvider, webhookRouter: Router, cronRouter: Router, cronRegistry: Map<string, string>, webhookRegistry: WebhookRegistry, platformApi: PlatformApi, cnxFetchFactory: DirectConnectionFactory, cronProvider: CronProvider, tracer: Tracer, issue: IssueAPI, cfgReader: ConfigReader, queueProvider: QueueAPI, otelSDK?: NodeSDK | undefined);
+    constructor(log: Logger, compiler: ObservableCompiler, contextProvider: ContextProvider, webhookRouter: Router, cronRouter: Router, cronRegistry: Map<string, string>, platformApi: PlatformApi, cnxFetchFactory: DirectConnectionFactory, cronProvider: CronProvider, tracer: Tracer, issue: IssueAPI, cfgReader: ConfigReader, queueProvider: QueueAPI, otelSDK?: NodeSDK | undefined);
     static newInstance(options?: DurableInterpreterOptions): Promise<DurableInterpreter>;
     register<O>(workflow: Workflow<O>, options?: DurableInterpreterOptions): Registration;
     start(): Promise<void>;

package/script/src/interpreter/durable/DurableInterpreter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DurableInterpreter.d.ts","sourceRoot":"","sources":["../../../../src/src/interpreter/durable/DurableInterpreter.ts"],"names":[],"mappings":"AAAA,OAAsB,EAAQ,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAGjE,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAgB,EAAqB,MAAM,EAAE,MAAM,SAAS,CAAC;AAE7D,OAAO,EAA+B,UAAU,EAAM,YAAY,EAAO,MAAM,MAAM,CAAC;AACtF,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,eAAe,EAAuB,MAAM,kCAAkC,CAAC;AAExF,OAAO,EAAE,YAAY,EAAE,YAAY,EAAuB,MAAM,yBAAyB,CAAC;AAG1F,OAAO,EAAE,QAAQ,EAAgB,MAAM,uBAAuB,CAAC;AAe/D,OAAO,EAAE,QAAQ,EAAa,MAAM,wBAAwB,CAAC;AAG7D,OAAO,EAAE,WAAW,EAAE,uBAAuB,EAAoB,MAAM,cAAc,CAAC;AAEtF,OAAO,EAAE,MAAM,EAAE,MAAM,uCAAuC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAmB,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAA0B,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AACrF,OAAO,EAAE,QAAQ,EAAa,MAAM,YAAY,CAAC;AAEjD,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,OAAO,CAAC;QACd,UAAU,OAAO;YACb,OAAO,EAAE,UAAU,CAAC;SACvB;KACJ;CACJ;AAGD,MAAM,MAAM,yBAAyB,GAAG;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,sBAAsB,CAAC,EAAE,OAAO,CAAC;CACpC,CAAC;AAEF,KAAK,YAAY,GAAG;IAChB,QAAQ,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IAC7C,KAAK,EAAE,uBAAuB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IAC9C,oBAAoB,EAAE,eAAe,CAAC;IACtC,cAAc,EAAE,MAAM,IAAI,CAAC;IAC3B,YAAY,CAAC,EAAE,YAAY,CAAC;CAC/B,CAAC;AAUF,KAAK,eAAe,GAAG,GAAG,CAAC,MAAM,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,GAAG,CAAA;CAAE,CAAC,CAAC;AASnF,qBAAa,kBAAkB;IAQvB,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,eAAe;IACvB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IArB7B,OAAO,CAAC,mBAAmB,CAA2B;IACtD,OAAO,CAAC,aAAa,CAAC,CAAS;IAC/B,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,OAAO,CAAC,cAAc,CAAC,CAAa;IACpC,OAAO,CAAC,cAAc,CAAS;gBAGV,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,kBAAkB,EAC5B,eAAe,EAAE,eAAe,EAChC,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAC3B,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EACjC,eAAe,EAAE,eAAe,EACvB,WAAW,EAAE,WAAW,EACxB,eAAe,EAAE,uBAAuB,EACxC,YAAY,EAAE,YAAY,EAC1B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,QAAQ,EACf,SAAS,EAAE,YAAY,EACvB,aAAa,EAAE,QAAQ,EACvB,OAAO,CAAC,EAAE,OAAO,YAAA;WAWzB,WAAW,CAAC,OAAO,GAAE,yBAA8B,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAmH9F,QAAQ,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,yBAAyB;IAqDhE,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IA+NtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAO9B"}
+{"version":3,"file":"DurableInterpreter.d.ts","sourceRoot":"","sources":["../../../../src/src/interpreter/durable/DurableInterpreter.ts"],"names":[],"mappings":"AAaA,OAAsB,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAG3D,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAgB,EAAqB,MAAM,EAAE,MAAM,SAAS,CAAC;AAE7D,OAAO,EAA+B,UAAU,EAAM,YAAY,EAAO,MAAM,MAAM,CAAC;AACtF,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,eAAe,EAAuB,MAAM,kCAAkC,CAAC;AAExF,OAAO,EAAE,YAAY,EAAE,YAAY,EAAuB,MAAM,yBAAyB,CAAC;AAe1F,OAAO,EAAE,QAAQ,EAAgB,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAa,MAAM,wBAAwB,CAAC;AAK7D,OAAO,EAAE,MAAM,EAAE,MAAM,uCAAuC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAmB,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAA0B,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AACrF,OAAO,EAAE,QAAQ,EAAa,MAAM,YAAY,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACpC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CACpC,CAAC;AAEF,KAAK,YAAY,GAAG;IAChB,QAAQ,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IAC7C,KAAK,EAAE,uBAAuB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IAC9C,oBAAoB,EAAE,eAAe,CAAC;IACtC,cAAc,EAAE,MAAM,IAAI,CAAC;IAC3B,YAAY,CAAC,EAAE,YAAY,CAAC;CAC/B,CAAC;AAoCF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,kBAAkB;IAQvB,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IApB7B,OAAO,CAAC,mBAAmB,CAA2B;IACtD,OAAO,CAAC,aAAa,CAAC,CAAS;IAC/B,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,OAAO,CAAC,cAAc,CAAC,CAAa;IACpC,OAAO,CAAC,cAAc,CAAS;gBAGV,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,kBAAkB,EAC5B,eAAe,EAAE,eAAe,EAChC,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EACjC,WAAW,EAAE,WAAW,EACxB,eAAe,EAAE,uBAAuB,EACxC,YAAY,EAAE,YAAY,EAC1B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,QAAQ,EACf,SAAS,EAAE,YAAY,EACvB,aAAa,EAAE,QAAQ,EACvB,OAAO,CAAC,EAAE,OAAO,YAAA;WAWzB,WAAW,CAAC,OAAO,GAAE,yBAA8B,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA6G9F,QAAQ,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,yBAAyB;IAoDhE,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IA4MtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAO9B"}