@versori/run 0.4.0-alpha.1 → 0.4.0-alpha.10

package/script/src/connection/internal/FetchBuilder.js

@@ -1,27 +1,16 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+/*
+ * 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");
@@ -33,12 +22,10 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _FetchBuilder_base, _FetchBuilder_cnx, _FetchBuilder_tracer;
+var _FetchBuilder_base, _FetchBuilder_cnx;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FetchBuilder = void 0;
-const api_1 = __importStar(require("@opentelemetry/api"));
 const helpers_js_1 = require("../../dsl/http/versori/helpers.js");
-const supervisor_js_1 = require("../../internal/supervisor.js");
 /**
  * FetchBuilder is used to build a fetch function which can be composed by multiple middlewares for
  * modifying the request/response and makes the implementation of {@link ConnectionFetchFactory}
@@ -54,105 +41,25 @@ class FetchBuilder {
         });
         _FetchBuilder_base.set(this, void 0);
         _FetchBuilder_cnx.set(this, void 0);
-        _FetchBuilder_tracer.set(this, void 0);
         __classPrivateFieldSet(this, _FetchBuilder_base, fetch, "f");
         __classPrivateFieldSet(this, _FetchBuilder_cnx, cnx, "f");
-        __classPrivateFieldSet(this, _FetchBuilder_tracer, api_1.default.trace.getTracer('fetch-builder', '1.0.0'), "f");
-        if (cnx) {
-            this.middlewares = [changeRequestbaseURLMiddleware(cnx)];
-        }
-        else {
-            this.middlewares = [];
-        }
+        this.middlewares = [changeRequestbaseURLMiddleware(cnx)];
     }
     use(fn) {
         this.middlewares.push(fn);
     }
     build() {
         let fetch = __classPrivateFieldGet(this, _FetchBuilder_base, "f");
-        if (supervisor_js_1.enabled) {
-            // create fake fetcher that calls the supervisor to generate a mock reponse
-            fetch = (async (info, options) => {
-                return await (0, supervisor_js_1.mockAPIRequest)(info, __classPrivateFieldGet(this, _FetchBuilder_cnx, "f"), options);
-            }).bind(this);
-        }
         for (let i = this.middlewares.length - 1; i >= 0; i--) {
             // apply middlewares in reverse order so that the actual middleware executes in the
             // order they were added
             fetch = this.middlewares[i](fetch);
         }
-        // Wrap the final fetch with OpenTelemetry tracing
-        return this.wrapWithTracing(fetch);
-    }
-    wrapWithTracing(fetch) {
-        const connectionId = __classPrivateFieldGet(this, _FetchBuilder_cnx, "f")?.id || '';
-        const connectionName = __classPrivateFieldGet(this, _FetchBuilder_cnx, "f")?.name || '';
-        return (input, init) => {
-            const url = getUrl(input);
-            return __classPrivateFieldGet(this, _FetchBuilder_tracer, "f").startActiveSpan(`fetch ${url}`, async (span) => {
-                // Set span attributes
-                span.setAttribute('http.url', url);
-                span.setAttribute('type', 'fetch');
-                span.setAttribute('connection.id', connectionId);
-                span.setAttribute('connection.name', connectionName);
-                if (init?.method) {
-                    span.setAttribute('http.method', init.method);
-                }
-                try {
-                    const response = await fetch(input, init);
-                    if (supervisor_js_1.enabled) {
-                        // when we are in supervisor mode, we need to store the response body in the span attribute
-                        // this will be shown the end-user in some Ui in the future
-                        const body = await response.clone().arrayBuffer();
-                        // if response is text/* pr json we store the body as a string, otherwise we store it as a base64 string
-                        const contentType = response.headers.get('Content-Type');
-                        if (contentType && (contentType.startsWith('text/') || contentType.startsWith('application/json'))) {
-                            span.setAttribute('response.body', new TextDecoder().decode(body));
-                        }
-                        else {
-                            span.setAttribute('response.body', btoa(String.fromCharCode(...new Uint8Array(body))));
-                        }
-                    }
-                    // Record response status
-                    span.setAttribute('http.status_code', response.status);
-                    if (response.status >= 400) {
-                        span.setStatus({
-                            code: api_1.SpanStatusCode.ERROR,
-                            message: `HTTP ${response.status}`,
-                        });
-                    }
-                    else {
-                        span.setStatus({ code: api_1.SpanStatusCode.OK });
-                    }
-                    return response;
-                }
-                catch (error) {
-                    // Record exception
-                    if (error instanceof Error) {
-                        span.recordException(error);
-                        span.setStatus({
-                            code: api_1.SpanStatusCode.ERROR,
-                            message: error.message,
-                        });
-                    }
-                    else {
-                        span.recordException(new Error(String(error)));
-                        span.setStatus({
-                            code: api_1.SpanStatusCode.ERROR,
-                            message: String(error),
-                        });
-                    }
-                    throw error;
-                }
-                finally {
-                    span.end();
-                }
-            });
-        };
+        return fetch;
     }
 }
 exports.FetchBuilder = FetchBuilder;
-_FetchBuilder_base = new WeakMap(), _FetchBuilder_cnx = new WeakMap(), _FetchBuilder_tracer = new WeakMap();
+_FetchBuilder_base = new WeakMap(), _FetchBuilder_cnx = new WeakMap();
 function changeBaseUrl(pathname, conn) {
     const connBaseURL = conn.baseUrl;
     // if the connection has no baseUrl set, but the pathname is a valid URL, return it as is
@@ -190,26 +97,9 @@ function changeRequestInit(info, conn) {
 }
 function changeRequestbaseURLMiddleware(conn) {
     return (fetch) => {
-        return async (input, init = {}) => {
+        return (input, init = {}) => {
             const newInput = changeRequestInit(input, conn);
             return fetch(newInput, init);
         };
     };
 }
-function getUrl(input) {
-    // Extract URL for span naming
-    let url;
-    if (typeof input === 'string') {
-        url = input;
-    }
-    else if (input instanceof URL) {
-        url = input.toString();
-    }
-    else if (input instanceof Request) {
-        url = input.url;
-    }
-    else {
-        url = 'unknown';
-    }
-    return url;
-}

package/script/src/connection/internal/HttpClientFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HttpClientFactory.d.ts","sourceRoot":"","sources":["../../../../src/src/connection/internal/HttpClientFactory.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAEvE;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC1B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAoC;;IAM1D,SAAS,CAAC,UAAU,EAAE,kBAAkB,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,GAAG,SAAS;IAcjF,OAAO,CAAC,aAAa;CAaxB"}
+{"version":3,"file":"HttpClientFactory.d.ts","sourceRoot":"","sources":["../../../../src/src/connection/internal/HttpClientFactory.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAEvE;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC1B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAoC;;IAM1D,SAAS,CAAC,UAAU,EAAE,kBAAkB,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,GAAG,SAAS;IAcjF,OAAO,CAAC,aAAa;CAaxB"}

package/script/src/connection/internal/HttpClientFactory.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.HttpClientFactory = void 0;
 const protobuf_1 = require("@bufbuild/protobuf");

package/script/src/connection/internal/InboundConnectionFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InboundConnectionFactory.d.ts","sourceRoot":"","sources":["../../../../src/src/connection/internal/InboundConnectionFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,uCAAuC,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AACjF,OAAO,KAAK,KAAK,OAAO,MAAM,SAAS,CAAC;AACxC,OAAO,EAIH,UAAU,EAGb,MAAM,gCAAgC,CAAC;AAQxC,qBAAa,+BAA+B;IAGpC,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAJ3B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAoD;gBAErD,WAAW,EAAE,MAAM,CAAC,OAAO,kBAAkB,CAAC,iBAAiB,CAAC,EAChE,MAAM,EAAE,MAAM,CAAC,OAAO,QAAQ,CAAC,YAAY,CAAC,EAC5C,MAAM,EAAE,MAAM;IAKnC,OAAO,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC;YAa3C,aAAa;IAc3B,OAAO,CAAC,YAAY;YAuDN,kBAAkB;YAiIlB,qBAAqB;YA2FrB,gBAAgB;CAsJjC"}
+{"version":3,"file":"InboundConnectionFactory.d.ts","sourceRoot":"","sources":["../../../../src/src/connection/internal/InboundConnectionFactory.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,uCAAuC,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AACjF,OAAO,KAAK,KAAK,OAAO,MAAM,SAAS,CAAC;AACxC,OAAO,EAIH,UAAU,EAGb,MAAM,gCAAgC,CAAC;AAaxC,qBAAa,+BAA+B;IAGpC,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAJ3B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAoD;gBAErD,WAAW,EAAE,MAAM,CAAC,OAAO,kBAAkB,CAAC,iBAAiB,CAAC,EAChE,MAAM,EAAE,MAAM,CAAC,OAAO,QAAQ,CAAC,YAAY,CAAC,EAC5C,MAAM,EAAE,MAAM;IAKnC,OAAO,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC;YAa3C,aAAa;IAc3B,OAAO,CAAC,YAAY;YAuDN,kBAAkB;YAiIlB,qBAAqB;YA2FrB,gBAAgB;CAsJjC"}

package/script/src/connection/internal/InboundConnectionFactory.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.ExpressInboundConnectionFactory = void 0;
 const mod_js_1 = require("../../services/credentials/mod.js");

package/script/src/connection/internal/OutboundConnectionFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OutboundConnectionFactory.d.ts","sourceRoot":"","sources":["../../../../src/src/connection/internal/OutboundConnectionFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAI7C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AAC3F,OAAO,EAGH,UAAU,EAGb,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,SAAS,EAAsB,MAAM,aAAa,CAAC;AAG5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D,qBAAa,yBAAyB;IAI9B,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAP3B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAuC;gBAGxC,iBAAiB,EAAE,iBAAiB,EACpC,WAAW,EAAE,MAAM,CAAC,OAAO,kBAAkB,CAAC,iBAAiB,CAAC,EAChE,MAAM,EAAE,MAAM,CAAC,OAAO,QAAQ,CAAC,YAAY,CAAC,EAC5C,MAAM,EAAE,MAAM,CAAC,OAAO,QAAQ,CAAC,oBAAoB,CAAC,EACpD,MAAM,EAAE,MAAM;IAKnC,OAAO,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;YAkB9B,YAAY;IAmB1B,OAAO,CAAC,eAAe;YAiDT,0BAA0B;YAwB1B,qBAAqB;IA4DnC,OAAO,CAAC,2BAA2B;IAuBnC,OAAO,CAAC,0BAA0B;IAkDlC,OAAO,CAAC,2BAA2B;YA0BrB,wBAAwB;YAkCxB,qBAAqB;IAiCnC,OAAO,CAAC,8BAA8B;IAuBtC,OAAO,CAAC,2BAA2B;YA2ErB,wBAAwB;YAkCxB,qBAAqB;IA6CnC,OAAO,CAAC,kCAAkC;CAsB7C"}
+{"version":3,"file":"OutboundConnectionFactory.d.ts","sourceRoot":"","sources":["../../../../src/src/connection/internal/OutboundConnectionFactory.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAI7C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AAC3F,OAAO,EAGH,UAAU,EAGb,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,SAAS,EAAsB,MAAM,aAAa,CAAC;AAG5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D,qBAAa,yBAAyB;IAI9B,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAP3B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAuC;gBAGxC,iBAAiB,EAAE,iBAAiB,EACpC,WAAW,EAAE,MAAM,CAAC,OAAO,kBAAkB,CAAC,iBAAiB,CAAC,EAChE,MAAM,EAAE,MAAM,CAAC,OAAO,QAAQ,CAAC,YAAY,CAAC,EAC5C,MAAM,EAAE,MAAM,CAAC,OAAO,QAAQ,CAAC,oBAAoB,CAAC,EACpD,MAAM,EAAE,MAAM;IAKnC,OAAO,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;YAkB9B,YAAY;IAmB1B,OAAO,CAAC,eAAe;YAiDT,0BAA0B;YAwB1B,qBAAqB;IA4DnC,OAAO,CAAC,2BAA2B;IAuBnC,OAAO,CAAC,0BAA0B;IAkDlC,OAAO,CAAC,2BAA2B;YA0BrB,wBAAwB;YAoCxB,qBAAqB;IAmCnC,OAAO,CAAC,8BAA8B;IAsBtC,OAAO,CAAC,2BAA2B;YA2ErB,wBAAwB;YAmCxB,qBAAqB;IAiDnC,OAAO,CAAC,kCAAkC;CAsB7C"}

package/script/src/connection/internal/OutboundConnectionFactory.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 __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -379,7 +391,8 @@ class OutboundConnectionFactory {
             });
             return refreshed.token;
         });
-        const authMiddleware = this.buildAuthorizationHeaderMiddleware(tokenHolder);
+        const authMiddleware = this
+            .buildAuthorizationHeaderMiddleware(tokenHolder);
         return Promise.resolve(refreshTokenMiddleware(authMiddleware, tokenHolder, this.logger));
     }
     async buildOAuth2Middleware(redactedCredential) {
@@ -389,10 +402,10 @@ class OutboundConnectionFactory {
         if (!response || !response.token) {
             return Promise.resolve(undefined);
         }
-        const tokenHolder = new CredentialHolder_js_1.CredentialHolder(response.token, isTokenValid_js_1.isTokenValid, async () => {
+        const tokenHolder = new CredentialHolder_js_1.CredentialHolder(response.token, isTokenValid_js_1.isTokenValid, async (force) => {
             const refreshed = await this.tokens.getToken({
                 credentialId: redactedCredential.id,
-                forceRefresh: true,
+                forceRefresh: force || false,
             });
             return refreshed.token;
         });
@@ -411,7 +424,11 @@ class OutboundConnectionFactory {
                 tokenType = 'Bearer';
                 break;
         }
-        return this.buildAuthorizationHeaderMiddleware(tokenHolder, tokenType);
+        const authMiddleware = this.buildAuthorizationHeaderMiddleware(tokenHolder, tokenType);
+        // wrap the middleware applying auth in a new middleware that handles refreshing tokens
+        // in the event of a 401 or 403 response. It's important that non of the middlewares above
+        // mutate the input or init parameters.
+        return refreshTokenMiddleware(authMiddleware, tokenHolder, this.logger);
     }
     buildAuthorizationHeaderMiddleware(tokenHolder, tokenType = 'Bearer') {
         return (fetch) => {
@@ -442,7 +459,7 @@ function refreshTokenMiddleware(authMiddleware, tokenHolder, logger) {
                 return response;
             }
             // the response is a 401 or 403, try refreshing the token and retrying the request
-            tokenHolder.refresh();
+            tokenHolder.refresh(true);
             if (init.body instanceof ReadableStream) {
                 logger.warn(`received ${response.status} but cannot refresh token requests using ReadableStream body`);
                 return response;

package/script/src/connection/types.d.ts

@@ -24,9 +24,5 @@ export interface RuntimeConnectionFactory {
     baseUrl(ctx: Context<unknown>): Promise<string>;
     handler(ctx: Context<unknown>): Promise<express.RequestHandler>;
 }
-/**
- * ExpressHandlers is the interface for returning a dynamic express handler based on the provided context.
- */
-export interface ExpressHandlers {
-}
+export type ExpressHandlers = never;
 //# sourceMappingURL=types.d.ts.map

package/script/src/connection/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/src/connection/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,OAAO,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAEzD,MAAM,MAAM,SAAS,GAAG,OAAO,KAAK,CAAC;AAErC,MAAM,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,SAAS,KAAK,SAAS,CAAC;AAEjE;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,OAAO,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAC7C,OAAO,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;CAC7D;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB;IACrC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACnD,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAChD,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;CACnE;AAuBD;;GAEG;AACH,MAAM,WAAW,eAAe;CAC/B"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/src/connection/types.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,KAAK,OAAO,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAEzD,MAAM,MAAM,SAAS,GAAG,OAAO,KAAK,CAAC;AAErC,MAAM,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,SAAS,KAAK,SAAS,CAAC;AAEjE;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,OAAO,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAC7C,OAAO,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;CAC7D;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB;IACrC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACnD,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAChD,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;CACnE;AAwBD,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC"}

package/script/src/connection/types.js

@@ -1,2 +1,14 @@
 "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 });

package/script/src/context/ActivationImpl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ActivationImpl.d.ts","sourceRoot":"","sources":["../../../src/src/context/ActivationImpl.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,gBAAgB,EAAE,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAEjI,qBAAa,cAAe,YAAW,UAAU;IAEzC,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,GAAG;gBAJH,UAAU,EAAE,UAAU,EACtB,WAAW,EAAE,WAAW,EACxB,cAAc,EAAE,MAAM,EACtB,aAAa,EAAE,MAAM,EACrB,GAAG,EAAE,MAAM;IAGhC,IAAI,EAAE,IAAI,MAAM,CAEf;IAED,IAAI,IAAI,IAAI,OAAO,CAElB;IAED,IAAI,WAAW,IAAI,kBAAkB,GAAG,SAAS,CAEhD;IAED,IAAI,WAAW,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,SAAS,CAE/C;IAED,IAAI,gBAAgB,IAAI,gBAAgB,GAAG,SAAS,CAEnD;IAED,WAAW,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAQ/C,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CA8BjE"}
+{"version":3,"file":"ActivationImpl.d.ts","sourceRoot":"","sources":["../../../src/src/context/ActivationImpl.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACjD,OAAO,EACH,UAAU,EACV,UAAU,EACV,gBAAgB,EAChB,OAAO,EACP,WAAW,EACX,kBAAkB,EACrB,MAAM,6BAA6B,CAAC;AAErC,qBAAa,cAAe,YAAW,UAAU;IAEzC,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,GAAG;gBAJH,UAAU,EAAE,UAAU,EACtB,WAAW,EAAE,WAAW,EACxB,cAAc,EAAE,MAAM,EACtB,aAAa,EAAE,MAAM,EACrB,GAAG,EAAE,MAAM;IAGhC,IAAI,EAAE,IAAI,MAAM,CAEf;IAED,IAAI,IAAI,IAAI,OAAO,CAElB;IAED,IAAI,WAAW,IAAI,kBAAkB,GAAG,SAAS,CAEhD;IAED,IAAI,WAAW,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,SAAS,CAE/C;IAED,IAAI,gBAAgB,IAAI,gBAAgB,GAAG,SAAS,CAEnD;IAED,WAAW,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAQ/C,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CA6BjE"}

package/script/src/context/ActivationImpl.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.ActivationImpl = void 0;
 class ActivationImpl {
@@ -70,7 +82,7 @@ class ActivationImpl {
                 },
                 body: {
                     value,
-                }
+                },
             });
         }
         catch (err) {

package/script/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/script/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;IAqC3C;;;;;;OAMG;IACG,OAAO,IAAI,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAO7C;;;;;;OAMG;IACG,UAAU,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAMlD"}

package/script/src/context/AsyncWorkflow.js

@@ -1,6 +1,22 @@
 "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.AsyncWorkflow = void 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.
+ */
 class AsyncWorkflow {
     constructor(queue, workflowId) {
         Object.defineProperty(this, "workflowId", {
@@ -42,13 +58,21 @@ 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'));
@@ -63,7 +87,7 @@ class AsyncWorkflow {
                 this.isWaiting = false;
                 throw new Error('wait timed out');
             }
-            const workflow = await this.queue.poll(this.workflowId);
+            const workflow = await this.queue.getWorkflow(this.workflowId);
             if (workflow.status === 'completed') {
                 // workflow is completed, parse the output and set the data and completed to true
                 const stringData = workflow.output;
@@ -75,17 +99,29 @@ 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/script/src/context/Context.d.ts

@@ -1,30 +1,45 @@
 import type * as express from 'express';
 import { CredentialsProvider } from '../dsl/http/versori/contextcredentials.js';
-import { QueueAPI } from '../interpreter/durable/Queue.js';
+import { QueueAPI, Workflow } 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';
+import { WorkflowInterface, WorkflowOpts } from './WorkflowsClient.js';
 export type OnSuccessFn = (ctx: Context<any>) => void;
 export type OnErrorFn = (ctx: Context<any>) => void;
 export type ContextOptions = {
-    workflowId?: string;
+    workflow?: Workflow;
     request?: express.Request;
     onSuccess?: OnSuccessFn;
     onError?: OnErrorFn;
 };
-export type WorkflowOpts = {
-    maxAttempts?: number;
-    data?: unknown;
-    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,16 +48,48 @@ 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;
+    /**
+     * Returns a client for managing workflows.
+     */
+    workflowClient(): WorkflowInterface;
 }
 export declare class ContextImpl<D, Index = void> implements Context<D> {
     #private;
@@ -56,7 +103,7 @@ export declare class ContextImpl<D, Index = void> implements Context<D> {
     readonly options: ContextOptions;
     constructor(log: Logger, kvp: KeyValueProvider, creds: CredentialsProvider, executionId: string, startTime: Date, data: D, activation: ActivationImpl, issues: IssueAPI, queue?: QueueAPI, options?: ContextOptions);
     get activation(): ActivationImpl;
-    get workflowId(): string | undefined;
+    get workflow(): Workflow | undefined;
     setIndex(idx: number): ContextImpl<D, number>;
     withData<D2>(data: D2): ContextImpl<D2, Index>;
     openKv(scope?: KeyValueScope): KeyValue;
@@ -67,6 +114,7 @@ export declare class ContextImpl<D, Index = void> implements Context<D> {
     }): Promise<Issue | null>;
     credentials(): CredentialsProvider;
     destroy(scope: KeyValueScope): Promise<void>;
+    workflowClient(): WorkflowInterface;
     [Symbol.toPrimitive](): Record<string, unknown>;
 }
 //# sourceMappingURL=Context.d.ts.map