@versori/run 0.7.0-alpha.3 → 0.7.0-alpha.6

package/esm/src/interpreter/vanilla/Queue.d.ts

@@ -0,0 +1,72 @@
+import { Logger } from '../../observability/mod.js';
+export type WorkflowMsgMetadata = {
+    parentWorkflowId?: string;
+    executionId?: string;
+    activationId?: string;
+    userId?: string;
+};
+export type Workflows = {
+    workflows: WorkflowMsg[];
+};
+export type WorkflowMsg = {
+    id?: string;
+    projectId?: string;
+    environmentId?: string;
+    group: string;
+    payload?: string;
+    output?: string;
+    status?: 'available' | 'locked' | 'completed' | 'failed';
+    attempt?: number;
+    maxAttempts?: number;
+    timeout?: string;
+    createdAt?: string;
+    metadata?: WorkflowMsgMetadata;
+};
+export type CompleteWorkflowRequest = {
+    id: string;
+    output?: string;
+    status: 'completed' | 'failed';
+};
+export type FetchWorkflowsRequest = {
+    ttl?: number;
+    limit?: number;
+    group: string;
+    projectId?: string;
+    environmentId?: string;
+};
+export type RescheduleWorkflowRequest = {
+    id: string;
+    after: string;
+};
+export type SubmitWorkflowsRequest = {
+    workflows: WorkflowMsg[];
+};
+export interface QueueAPI {
+    complete(request: CompleteWorkflowRequest): Promise<void>;
+    submit(request: SubmitWorkflowsRequest): Promise<Workflows>;
+    fetchWorkflows(request: FetchWorkflowsRequest): Promise<Workflows | undefined>;
+    reschedule(request: RescheduleWorkflowRequest): Promise<void>;
+    poll(workflowId: string): Promise<WorkflowMsg>;
+}
+export declare class QueueImpl implements QueueAPI {
+    private baseUrl;
+    private log;
+    private projectId;
+    private environmentId;
+    constructor(baseUrl: string, projectId: string, environmentId: string, log: Logger);
+    static fromEnv(log: Logger): QueueImpl;
+    complete(request: CompleteWorkflowRequest): Promise<void>;
+    submit(request: SubmitWorkflowsRequest): Promise<Workflows>;
+    fetchWorkflows(request: FetchWorkflowsRequest): Promise<Workflows | undefined>;
+    reschedule(request: RescheduleWorkflowRequest): Promise<void>;
+    poll(workflowId: string): Promise<WorkflowMsg>;
+}
+export declare class MockQueue implements QueueAPI {
+    constructor();
+    complete(_request: CompleteWorkflowRequest): Promise<void>;
+    submit(_request: SubmitWorkflowsRequest): Promise<Workflows>;
+    fetchWorkflows(_request: FetchWorkflowsRequest): Promise<Workflows | undefined>;
+    reschedule(_request: RescheduleWorkflowRequest): Promise<void>;
+    poll(_workflowId: string): Promise<WorkflowMsg>;
+}
+//# sourceMappingURL=Queue.d.ts.map

package/esm/src/interpreter/vanilla/Queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Queue.d.ts","sourceRoot":"","sources":["../../../../src/src/interpreter/vanilla/Queue.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAEpD,MAAM,MAAM,mBAAmB,GAAG;IAC9B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACpB,SAAS,EAAE,WAAW,EAAE,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACtB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,CAAC;IACzD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,mBAAmB,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,WAAW,GAAG,QAAQ,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAChC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACjC,SAAS,EAAE,WAAW,EAAE,CAAC;CAC5B,CAAC;AAEF,MAAM,WAAW,QAAQ;IACrB,QAAQ,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1D,MAAM,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5D,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;IAC/E,UAAU,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9D,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CAClD;AAED,qBAAa,SAAU,YAAW,QAAQ;IACtC,OAAO,CAAC,OAAO,CAAS;IAExB,OAAO,CAAC,GAAG,CAAS;IAEpB,OAAO,CAAC,SAAS,CAAS;IAE1B,OAAO,CAAC,aAAa,CAAS;gBAElB,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAOlF,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS;IAehC,QAAQ,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBzD,MAAM,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,SAAS,CAAC;IA2B3D,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAoC9E,UAAU,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoB7D,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;CAevD;AAGD,qBAAa,SAAU,YAAW,QAAQ;;IAGtC,QAAQ,CAAC,QAAQ,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAG1D,MAAM,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,SAAS,CAAC;IAG5D,cAAc,CAAC,QAAQ,EAAE,qBAAqB,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAG/E,UAAU,CAAC,QAAQ,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAG9D,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;CAGlD"}

package/esm/src/interpreter/vanilla/Queue.js

@@ -0,0 +1,176 @@
+/*
+ * 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 { envVarEnvId, envVarProjectId, envVarSDKApiBaseURL, } from '../../dsl/http/versori/constants.js';
+import { ConsoleLogger } from '../../mod.js';
+export class QueueImpl {
+    constructor(baseUrl, projectId, environmentId, log) {
+        Object.defineProperty(this, "baseUrl", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "log", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "projectId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "environmentId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.baseUrl = baseUrl;
+        this.log = log;
+        this.projectId = projectId;
+        this.environmentId = environmentId;
+    }
+    static fromEnv(log) {
+        // TODO make these environment variables configurable in constants/ts
+        const baseUrl = Deno.env.get(envVarSDKApiBaseURL);
+        const _log = log || new ConsoleLogger('debug');
+        const projectId = Deno.env.get(envVarProjectId) || 'default-project';
+        const environmentId = Deno.env.get(envVarEnvId) || 'default-environment';
+        if (!baseUrl) {
+            throw new Error('Missing required environment variables');
+        }
+        return new QueueImpl(baseUrl, projectId, environmentId, _log);
+    }
+    async complete(request) {
+        const resp = await fetch(`${this.baseUrl}/v1/workflows/complete`, {
+            method: 'POST',
+            body: JSON.stringify({
+                id: request.id,
+                output: request.output,
+                status: request.status,
+            }),
+        });
+        if (!resp.ok) {
+            this.log.error('Failed to complete workflow', {
+                id: request.id,
+                output: request.output,
+                status: request.status,
+            });
+            throw new Error('Failed to complete workflow');
+        }
+        return;
+    }
+    async submit(request) {
+        // Ensure all workflows have the projectId & environmentId set
+        const workflows = request.workflows.map((w) => ({
+            ...w,
+            projectId: this.projectId || w.projectId,
+            environmentId: this.environmentId || w.environmentId,
+        }));
+        const resp = await fetch(`${this.baseUrl}/v1/workflows/submit`, {
+            method: 'POST',
+            body: JSON.stringify({
+                workflows: workflows,
+            }),
+        });
+        if (!resp.ok) {
+            this.log.error('Failed to submit workflows', {
+                workflows: workflows,
+            });
+            throw new Error('Failed to submit workflows');
+        }
+        const result = (await resp.json());
+        return result;
+    }
+    async fetchWorkflows(request) {
+        const resp = await fetch(`${this.baseUrl}/v1/workflows/fetch`, {
+            method: 'POST',
+            body: JSON.stringify({
+                ttl: request.ttl,
+                limit: request.limit,
+                group: request.group,
+                projectId: this.projectId || request.projectId,
+                environmentId: this.environmentId || request.environmentId,
+            }),
+        });
+        if (!resp.ok) {
+            const errorText = (await resp.json());
+            this.log.error('Failed to fetch workflows', {
+                error: errorText.message,
+                ttl: request.ttl,
+                limit: request.limit,
+                group: request.group,
+                projectId: this.projectId || request.projectId,
+            });
+            throw new Error('failed to fetch workflows', {
+                cause: new Error(errorText.message),
+            });
+        }
+        if (resp.status === 204) {
+            return undefined;
+        }
+        const result = (await resp.json());
+        return result;
+    }
+    async reschedule(request) {
+        const resp = await fetch(`${this.baseUrl}/v1/workflows/reschedule`, {
+            method: 'POST',
+            body: JSON.stringify({
+                id: request.id,
+                after: request.after,
+            }),
+        });
+        if (!resp.ok) {
+            this.log.error('Failed to reschedule workflow', {
+                id: request.id,
+                after: request.after,
+            });
+            throw new Error('Failed to reschedule workflow');
+        }
+        return;
+    }
+    async poll(workflowId) {
+        // this endpoint returns a 404 if the workflow is not completed
+        const resp = await fetch(`${this.baseUrl}/v1/workflows/fetch/${workflowId}`, {
+            method: 'GET',
+        });
+        if (!resp.ok) {
+            this.log.error('Failed to poll workflow', { workflowId });
+            throw new Error('Failed to poll workflow');
+        }
+        const result = (await resp.json());
+        return result;
+    }
+}
+// MockQueue can be used for testing. Right now it throws errors for all methods because it isn't used in tests yet.
+export class MockQueue {
+    constructor() { }
+    complete(_request) {
+        throw new Error('Method not implemented.');
+    }
+    submit(_request) {
+        throw new Error('Method not implemented.');
+    }
+    fetchWorkflows(_request) {
+        throw new Error('Method not implemented.');
+    }
+    reschedule(_request) {
+        throw new Error('Method not implemented.');
+    }
+    poll(_workflowId) {
+        throw new Error('Method not implemented.');
+    }
+}

package/esm/src/interpreter/vanilla/VanillaInterpreter.d.ts

@@ -0,0 +1,95 @@
+import { Tracer } from '@opentelemetry/api';
+import { NodeSDK } from '@opentelemetry/sdk-node';
+import { Router } from 'express';
+import { Observable, Subscription } from 'rxjs';
+import { ConfigReader, CronProvider } from '../../dsl/http/types.js';
+import { Workflow } from '../../dsl/Workflow.js';
+import { Logger } from '../../observability/logging/Logger.js';
+import { ContextOperatorFunction } from './compilers/types.js';
+import { ObservableCompiler } from './ObservableCompiler.js';
+import { QueueAPI } from './Queue.js';
+import { DefaultConnectionFactory } from '../../connection/VanillaConnectionFactory.js';
+import { VanillaContext, VanillaContextProvider } from '../../context/VanillaContext.js';
+import { ContextProvider } from '../../context/ContextProvider.js';
+/**
+ * VanillaInterpreterOptions
+ *  configures the behavior of the {@link VanillaInterpreter}.
+ */
+export type VanillaInterpreterOptions = {
+    /**
+     * 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?: VanillaContextProvider;
+    /**
+     * Abort signal to cancel workflow execution.
+     */
+    signal?: AbortSignal;
+    /**
+     * Skip loading Versori credentials. Useful for local development.
+     */
+    skipVersoriCredentials?: boolean;
+};
+type Registration = {
+    trigger$: Observable<VanillaContext<any, void>>;
+    task$: ContextOperatorFunction<any, any, any>;
+    localAbortController: AbortController;
+    sigintListener: () => void;
+    subscription?: Subscription;
+};
+/**
+ * VanillaInterpreter 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 DurableInterpreter}, this interpreter is incapable of using connections. Therefore, all fetch requests will need
+ * to use fully qualified URLs and authentication must be handled manually within the workflow.
+ *
+ * @example
+ * ```typescript
+ * import { VanillaInterpreter, 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 VanillaInterpreter();
+ * interpreter.register(processJob);
+ * await interpreter.start();
+ * ```
+ */
+export declare class VanillaInterpreter {
+    private readonly log;
+    private readonly compiler;
+    private readonly contextProvider;
+    private readonly webhookRouter;
+    private readonly cronRouter;
+    private readonly cronRegistry;
+    private readonly cnxFetchFactory;
+    private readonly cronProvider;
+    private readonly tracer;
+    private readonly cfgReader;
+    private readonly queueProvider;
+    private readonly otelSDK?;
+    private registeredWorkflows;
+    private webhookServer?;
+    private cronServer?;
+    private shutdownServer?;
+    private isShuttingDown;
+    constructor(log: Logger, compiler: ObservableCompiler, contextProvider: ContextProvider, webhookRouter: Router, cronRouter: Router, cronRegistry: Map<string, string>, cnxFetchFactory: DefaultConnectionFactory, cronProvider: CronProvider, tracer: Tracer, cfgReader: ConfigReader, queueProvider: QueueAPI, otelSDK?: NodeSDK | undefined);
+    static newInstance(options?: VanillaInterpreterOptions): Promise<VanillaInterpreter>;
+    register<O>(workflow: Workflow<O>, options?: VanillaInterpreterOptions): Registration;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=VanillaInterpreter.d.ts.map

package/esm/src/interpreter/vanilla/VanillaInterpreter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VanillaInterpreter.d.ts","sourceRoot":"","sources":["../../../../src/src/interpreter/vanilla/VanillaInterpreter.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,YAAY,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAarE,OAAO,EAAE,QAAQ,EAAgB,MAAM,uBAAuB,CAAC;AAM/D,OAAO,EAAE,MAAM,EAAE,MAAM,uCAAuC,CAAC;AAC/D,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAA0B,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AACrF,OAAO,EAAE,QAAQ,EAAa,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,wBAAwB,EAAE,MAAM,8CAA8C,CAAC;AACxF,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzF,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AAEnE;;;GAGG;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,sBAAsB,CAAC;IAEzC;;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,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IAChD,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;;;;;;;;;;;;;;;;;;;;;;GAsBG;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,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IAlB7B,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,eAAe,EAAE,wBAAwB,EACzC,YAAY,EAAE,YAAY,EAC1B,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,YAAY,EACvB,aAAa,EAAE,QAAQ,EACvB,OAAO,CAAC,EAAE,OAAO,YAAA;WASzB,WAAW,CAAC,OAAO,GAAE,yBAA8B,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA4F9F,QAAQ,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,yBAAyB;IAgDtE,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAmMtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CASxB"}