@vertesia/workflow 0.78.0-dev-28b447d → 0.79.0

package/package.json

@@ -1,136 +1,136 @@
 {
-    "name": "@vertesia/workflow",
-    "version": "0.78.0-dev-28b447d",
-    "type": "module",
-    "description": "Vertesia workflow DSL",
-    "main": "./lib/esm/index.js",
-    "files": [
-        "lib",
-        "src"
-    ],
-    "bin": {
-        "bundle-workflows": "./bin/bundle-workflows.mjs"
+  "name": "@vertesia/workflow",
+  "version": "0.79.0",
+  "type": "module",
+  "description": "Vertesia workflow DSL",
+  "main": "./lib/esm/index.js",
+  "files": [
+    "lib",
+    "src"
+  ],
+  "bin": {
+    "bundle-workflows": "./bin/bundle-workflows.mjs"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vertesia/composableai.git",
+    "directory": "zeno/workflow"
+  },
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@smithy/types": "^3.7.2",
+    "@temporalio/proto": "^1.11.5",
+    "@temporalio/testing": "^1.11.5",
+    "@temporalio/worker": "^1.11.5",
+    "@types/jsonwebtoken": "^9.0.7",
+    "@types/node": "^22.5.1",
+    "@types/papaparse": "^5.3.15",
+    "@types/tmp": "^0.2.6",
+    "ts-dual-module": "^0.6.3",
+    "vitest": "^3.0.9"
+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.693.0",
+    "@aws-sdk/client-textract": "^3.693.0",
+    "@aws-sdk/credential-providers": "^3.693.0",
+    "@temporalio/activity": "^1.11.5",
+    "@temporalio/workflow": "^1.11.5",
+    "@types/json-schema": "^7.0.15",
+    "fast-deep-equal": "^3.1.3",
+    "jsonwebtoken": "^9.0.2",
+    "mime": "^4.0.0",
+    "ms": "3.0.0-canary.1",
+    "node-web-stream-adapters": "^0.2.1",
+    "p-limit": "^6.2.0",
+    "papaparse": "^5.4.1",
+    "seedrandom": "^3.0.5",
+    "sharp": "^0.33.4",
+    "tiktoken": "^1.0.15",
+    "tmp": "^0.2.3",
+    "tmp-promise": "^3.0.3",
+    "yaml": "^2.6.0",
+    "@llumiverse/common": "0.22.0",
+    "@vertesia/client": "0.79.0",
+    "@vertesia/api-fetch-client": "0.79.0",
+    "@vertesia/common": "0.79.0",
+    "@vertesia/memory": "0.50.0"
+  },
+  "ts_dual_module": {
+    "outDir": "lib",
+    "exports": {
+      "activities": "./activities/index.js",
+      "dsl-activities": "./activities/index-dsl.js",
+      "workflows": "./workflows",
+      "workflows-bundle": "./workflows-bundle.js",
+      "vars": "./vars"
+    }
+  },
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js"
     },
-    "scripts": {
-        "test": "vitest run",
-        "build": "pnpm exec tsmod build && node ./bin/bundle-workflows.mjs lib/esm/workflows.js lib/workflows-bundle.js",
-        "clean": "rm -rf ./lib tsconfig.tsbuildinfo"
+    "./vars": {
+      "types": "./lib/types/vars.d.ts",
+      "import": "./lib/esm/vars.js",
+      "require": "./lib/cjs/vars.js"
     },
-    "license": "Apache-2.0",
-    "devDependencies": {
-        "@smithy/types": "^3.7.2",
-        "@temporalio/proto": "^1.11.5",
-        "@temporalio/testing": "^1.11.5",
-        "@temporalio/worker": "^1.11.5",
-        "@types/jsonwebtoken": "^9.0.7",
-        "@types/node": "^22.5.1",
-        "@types/papaparse": "^5.3.15",
-        "@types/tmp": "^0.2.6",
-        "ts-dual-module": "^0.6.3",
-        "vitest": "^3.0.9"
+    "./activities": {
+      "types": "./lib/types/activities/index.d.ts",
+      "import": "./lib/esm/activities/index.js",
+      "require": "./lib/cjs/activities/index.js"
     },
-    "dependencies": {
-        "@aws-sdk/client-s3": "^3.693.0",
-        "@aws-sdk/client-textract": "^3.693.0",
-        "@aws-sdk/credential-providers": "^3.693.0",
-        "@llumiverse/common": "workspace:*",
-        "@temporalio/activity": "^1.11.5",
-        "@temporalio/workflow": "^1.11.5",
-        "@types/json-schema": "^7.0.15",
-        "@vertesia/api-fetch-client": "workspace:*",
-        "@vertesia/client": "workspace:*",
-        "@vertesia/common": "workspace:*",
-        "@vertesia/memory": "workspace:*",
-        "fast-deep-equal": "^3.1.3",
-        "jsonwebtoken": "^9.0.2",
-        "mime": "^4.0.0",
-        "ms": "3.0.0-canary.1",
-        "node-web-stream-adapters": "^0.2.1",
-        "p-limit": "^6.2.0",
-        "papaparse": "^5.4.1",
-        "seedrandom": "^3.0.5",
-        "sharp": "^0.33.4",
-        "tiktoken": "^1.0.15",
-        "tmp": "^0.2.4",
-        "tmp-promise": "^3.0.3",
-        "yaml": "^2.6.0"
+    "./dsl-activities": {
+      "types": "./lib/types/activities/index-dsl.d.ts",
+      "import": "./lib/esm/activities/index-dsl.js",
+      "require": "./lib/cjs/activities/index-dsl.js"
     },
-    "ts_dual_module": {
-        "outDir": "lib",
-        "exports": {
-            "activities": "./activities/index.js",
-            "dsl-activities": "./activities/index-dsl.js",
-            "workflows": "./workflows",
-            "workflows-bundle": "./workflows-bundle.js",
-            "vars": "./vars"
-        }
+    "./workflows": {
+      "types": "./lib/types/workflows.d.ts",
+      "import": "./lib/esm/workflows.js",
+      "require": "./lib/cjs/workflows.js"
     },
-    "exports": {
-        ".": {
-            "types": "./lib/types/index.d.ts",
-            "import": "./lib/esm/index.js",
-            "require": "./lib/cjs/index.js"
-        },
-        "./vars": {
-            "types": "./lib/types/vars.d.ts",
-            "import": "./lib/esm/vars.js",
-            "require": "./lib/cjs/vars.js"
-        },
-        "./activities": {
-            "types": "./lib/types/activities/index.d.ts",
-            "import": "./lib/esm/activities/index.js",
-            "require": "./lib/cjs/activities/index.js"
-        },
-        "./dsl-activities": {
-            "types": "./lib/types/activities/index-dsl.d.ts",
-            "import": "./lib/esm/activities/index-dsl.js",
-            "require": "./lib/cjs/activities/index-dsl.js"
-        },
-        "./workflows": {
-            "types": "./lib/types/workflows.d.ts",
-            "import": "./lib/esm/workflows.js",
-            "require": "./lib/cjs/workflows.js"
-        },
-        "./dsl": {
-            "types": "./lib/types/dsl.d.ts",
-            "import": "./lib/esm/dsl.js",
-            "require": "./lib/cjs/dsl.js"
-        },
-        "./workflows-bundle": {
-            "import": "./lib/workflows-bundle.js"
-        },
-        "./errors": {
-            "types": "./lib/types/errors.d.ts",
-            "import": "./lib/esm/errors.js",
-            "require": "./lib/cjs/errors.js"
-        }
+    "./dsl": {
+      "types": "./lib/types/dsl.d.ts",
+      "import": "./lib/esm/dsl.js",
+      "require": "./lib/cjs/dsl.js"
     },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/vertesia/composableai.git",
-        "directory": "packages/workflow"
+    "./workflows-bundle": {
+      "import": "./lib/workflows-bundle.js"
     },
-    "types": "./lib/types/index.d.ts",
-    "typesVersions": {
-        "*": {
-            "activities": [
-                "./lib/types/activities/index.d.ts"
-            ],
-            "dsl-activities": [
-                "./lib/types/activities/index-dsl.d.ts"
-            ],
-            "workflows": [
-                "./lib/types/workflows.d.ts"
-            ],
-            "dsl": [
-                "./lib/types/dsl.d.ts"
-            ],
-            "vars": [
-                "./lib/types/dsl/vars.d.ts"
-            ],
-            "errors": [
-                "./lib/types/errors.d.ts"
-            ]
-        }
+    "./errors": {
+      "types": "./lib/types/errors.d.ts",
+      "import": "./lib/esm/errors.js",
+      "require": "./lib/cjs/errors.js"
+    }
+  },
+  "types": "./lib/types/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "activities": [
+        "./lib/types/activities/index.d.ts"
+      ],
+      "dsl-activities": [
+        "./lib/types/activities/index-dsl.d.ts"
+      ],
+      "workflows": [
+        "./lib/types/workflows.d.ts"
+      ],
+      "dsl": [
+        "./lib/types/dsl.d.ts"
+      ],
+      "vars": [
+        "./lib/types/dsl/vars.d.ts"
+      ],
+      "errors": [
+        "./lib/types/errors.d.ts"
+      ]
     }
-}
+  },
+  "scripts": {
+    "test": "vitest run",
+    "build": "pnpm exec tsmod build && node ./bin/bundle-workflows.mjs lib/esm/workflows.js lib/workflows-bundle.js",
+    "clean": "rm -rf ./lib tsconfig.tsbuildinfo"
+  }
+}

package/src/activities/notifyWebhook.test.ts

@@ -1,9 +1,9 @@
 import {
   MockActivityEnvironment,
 } from "@temporalio/testing";
-import { beforeAll, beforeEach, describe, expect, it, test, vi } from "vitest";
-import { notifyWebhook, NotifyWebhook, NotifyWebhookParams } from "./notifyWebhook.js";
 import { ContentEventName, DSLActivityExecutionPayload } from "@vertesia/common";
+import { beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
+import { notifyWebhook, NotifyWebhookParams } from "./notifyWebhook.js";
 
 // Mock fetch globally
 vi.stubGlobal('fetch', vi.fn());
@@ -20,16 +20,20 @@ beforeEach(() => {
 });
 
 const defaultParams = {
-  target_url: "https://vertesia.test",
+  webhook: "https://vertesia.test",
   method: "POST" as const,
-  payload: { message: "Hello World" }
-};
+  detail: { message: "Hello World" },
+  workflow_id: "wf_id",
+  workflow_type: "wfFuncName",
+  workflow_run_id: "wf_run_id",
+  event_name: "completed",
+} satisfies NotifyWebhookParams;
 
 // Helper function to create test payload
 const createTestPayload = (params: Partial<NotifyWebhookParams> = {}): DSLActivityExecutionPayload<NotifyWebhookParams> => {
   const mergedParams = { ...defaultParams, ...params };
   return {
-    auth_token: process.env.VERTESIA_KEY || "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwOi8vbW9jay10b2tlbi1zZXJ2ZXIiLCJzdWIiOiJ0ZXN0In0.signature",
+    auth_token: "unset",
     account_id: "unset",
     project_id: "unset",
     params: mergedParams,
@@ -52,15 +56,15 @@ describe("Webhook should be notified", () => {
       ok: true,
       status: 200,
       statusText: 'OK',
-      url: defaultParams.target_url
+      url: defaultParams.webhook
     };
     mockFetch.mockResolvedValueOnce(mockResponse as Response);
 
     const payload = createTestPayload();
     const res = await testEnv.run(notifyWebhook, payload);
-    
+
     // Verify fetch was called with correct parameters
-    expect(mockFetch).toHaveBeenCalledWith(defaultParams.target_url, {
+    expect(mockFetch).toHaveBeenCalledWith(defaultParams.webhook, {
       method: 'POST',
       body: JSON.stringify({ message: 'Hello World' }),
       headers: {
@@ -72,7 +76,7 @@ describe("Webhook should be notified", () => {
     expect(res).toEqual({
       status: 200,
       message: 'OK',
-      url: defaultParams.target_url
+      url: defaultParams.webhook
     });
   });
 
@@ -82,7 +86,7 @@ describe("Webhook should be notified", () => {
       ok: false,
       status: 500,
       statusText: 'Internal Server Error',
-      url: defaultParams.target_url,
+      url: defaultParams.webhook,
       text: vi.fn().mockResolvedValue('{"error": "Database connection failed", "code": "DB_ERROR"}')
     } as unknown as Response;
     mockFetch.mockResolvedValueOnce(mockResponse);
@@ -91,11 +95,11 @@ describe("Webhook should be notified", () => {
 
     // Expect the function to throw an error with response payload
     await expect(testEnv.run(notifyWebhook, payload)).rejects.toThrow(
-      `Webhook Notification to ${defaultParams.target_url} failed with status: 500 Internal Server Error - Response: {"error": "Database connection failed", "code": "DB_ERROR"}`
+      `Webhook Notification to ${defaultParams.webhook} failed with status: 500 Internal Server Error - Response: {"error": "Database connection failed", "code": "DB_ERROR"}`
     );
 
     // Verify fetch was called with correct parameters
-    expect(mockFetch).toHaveBeenCalledWith(defaultParams.target_url, {
+    expect(mockFetch).toHaveBeenCalledWith(defaultParams.webhook, {
       method: 'POST',
       body: JSON.stringify({ message: 'Hello World' }),
       headers: {
@@ -118,7 +122,7 @@ describe("Webhook should be notified", () => {
     await expect(testEnv.run(notifyWebhook, payload)).rejects.toThrow('Network request failed');
 
     // Verify fetch was called with correct parameters
-    expect(mockFetch).toHaveBeenCalledWith(defaultParams.target_url, {
+    expect(mockFetch).toHaveBeenCalledWith(defaultParams.webhook, {
       method: 'POST',
       body: JSON.stringify({ message: 'Hello World' }),
       headers: {

package/src/activities/notifyWebhook.ts

@@ -1,15 +1,29 @@
 import { log } from "@temporalio/activity";
-import { DSLActivityExecutionPayload, DSLActivitySpec } from "@vertesia/common";
+import { VertesiaClient } from "@vertesia/client";
+import { ApiVersions, DSLActivityExecutionPayload, DSLActivitySpec, WebHookSpec, WorkflowExecutionBaseParams } from "@vertesia/common";
 import { setupActivity } from "../dsl/setup/ActivityContext.js";
 import { WorkflowParamNotFoundError } from "../errors.js";
+import { getVertesiaClientOptions } from "../utils/client.js";
 
 export interface NotifyWebhookParams {
-    target_url: string; //URL to send the notification to
+    webhook: string | WebHookSpec; //URL to send the notification to
+    workflow_id: string; //The ID of the workflow sending the notification
+    workflow_type: string; //The type of workflow sending the notification (the wf function name)
+    workflow_run_id: string; //The ID of the specific workflow run sending the notification
+    event_name: string; //The event that triggered the notification (e.g. "completed", "failed", etc.)
+    detail?: Record<string, any>; // additional data about the event if any. It will be send to the webhook when using POST 
+    //target_url: string; //URL to send the notification to
     method: 'GET' | 'POST'; //HTTP method to use
-    payload: Record<string, any>; //payload to send (if POST then as JSON body, if GET then as query string)
-    headers?: Record<string, string>; //additional headers to send
+    headers?: Record<string, string>; // additional headers to send
 }
 
+export interface WebhookNotificationPayload {
+    workflow_id: string,
+    workflow_name: string,
+    workflow_run_id: string,
+    event_name: string,
+    detail?: Record<string, any>,
+}
 
 export interface NotifyWebhook extends DSLActivitySpec<NotifyWebhookParams> {
     name: 'notifyWebhook';
@@ -19,22 +33,33 @@ export interface NotifyWebhook extends DSLActivitySpec<NotifyWebhookParams> {
 export async function notifyWebhook(payload: DSLActivityExecutionPayload<NotifyWebhookParams>) {
 
     const { params } = await setupActivity<NotifyWebhookParams>(payload);
-    const { target_url, method, payload: requestPayload, headers } = params
+    const { webhook, method, headers: defaultHeaders } = params
+    // resolve the url and the api version of the webhook
+    let target_url: string, version: number | undefined;
+    if (typeof webhook === 'string') {
+        target_url = webhook;
+    } else {
+        target_url = webhook.url;
+        version = webhook.version;
+    }
 
     if (!target_url) throw new WorkflowParamNotFoundError('target_url');
 
-    const body = method === 'POST' ? JSON.stringify({
-        ...requestPayload,
-    }) : undefined
+    const hasBody = params.detail && method === 'POST'; //body is sent only for POST
+
+    const headers = {
+        ...defaultHeaders,
+    };
+    if (hasBody) {
+        headers['Content-Type'] = 'application/json';
+    }
+    const body = hasBody ? await createRequestBody(payload, params, version) : undefined
 
     log.info(`Notifying webhook at ${target_url}`);
     const res = await fetch(target_url, {
         method,
         body,
-        headers: {
-            'Content-Type': 'application/json',
-            ...headers
-        },
+        headers,
     }).catch(err => {
         log.error(`An error occurred while notifying webhook at ${target_url}`, { err });
         throw err;
@@ -42,7 +67,7 @@ export async function notifyWebhook(payload: DSLActivityExecutionPayload<NotifyW
 
     if (!res.ok) {
         log.warn(`Webhook endpoint ${target_url} returned an error - ${res.status} ${res.statusText}`, { fetchResponse: res });
-        
+
         // Try to get response payload for error message
         let errorMessage = `Webhook Notification to ${target_url} failed with status: ${res.status} ${res.statusText}`;
         try {
@@ -54,10 +79,120 @@ export async function notifyWebhook(payload: DSLActivityExecutionPayload<NotifyW
             // If we can't read the response, just use the basic error message
             log.debug('Could not read response body for error', { readError });
         }
-        
+
         throw new Error(errorMessage);
     }
 
     return { status: res.status, message: res.statusText, url: res.url }
 
 }
+
+
+
+// --------------------------------------
+// Data provider for webhooks
+// this allows to customize the payload sent to the webhook depending on the 
+// type of workflow and the api version of the webhook
+// --------------------------------------
+
+
+function getWorkflowName(workflowType: string): string {
+    // remove trailing Workflow or _Workflow case insensitive from the workflow type
+    return workflowType.replace(/_?workflow$/i, '');
+}
+
+async function createRequestBody(payload: WorkflowExecutionBaseParams, params: NotifyWebhookParams, api_version: number | undefined): Promise<string> {
+    if (api_version === undefined || Number(api_version) < ApiVersions.COMPLETION_RESULT_V1) {
+        return createOldRequestBody(payload, params);
+    } else {
+        return createLatestRequestBody(payload, params, api_version);
+    }
+}
+
+async function createLatestRequestBody(payload: WorkflowExecutionBaseParams, params: NotifyWebhookParams, api_version: number | undefined): Promise<string> {
+    const data = await createEventData(payload, params, api_version);
+    return JSON.stringify({
+        workflow_id: params.workflow_id,
+        workflow_name: getWorkflowName(params.workflow_type),
+        workflow_run_id: params.workflow_run_id,
+        event_name: params.event_name,
+        detail: data,
+    } satisfies WebhookNotificationPayload);
+}
+
+async function createEventData(payload: WorkflowExecutionBaseParams, params: NotifyWebhookParams, api_version: number | undefined): Promise<any> {
+    const data = params.detail;
+    if (data && data.run_id && params.event_name === "workflow_completed" && params.workflow_type === 'ExecuteInteractionWorkflow') {
+        const client = getVersionedVertesiaClient(payload, api_version); //ensure client is initialized
+        // we replace the result property with the full execution run object
+        return await client.runs.retrieve(data.run_id);
+    }
+    return data;
+}
+
+
+function getVersionedVertesiaClient(payload: WorkflowExecutionBaseParams, version: string | number | undefined | null) {
+    // set the api version header
+    return new VertesiaClient(getVertesiaClientOptions(payload)).withApiVersion(version ? String(version) : null);
+}
+
+
+// ----------------- Compatibility code -----------------
+/* Before 2025-10-08 the notifyWebhook POST body was in the format:
+
+{
+    "workflowId": "generation:ExecuteInteractionWorkflow:WhatColor:ox8wu6t4",
+    "runId": "0199c2c6-818f-77eb-b931-c1ba8b9e5184",
+    "status": "completed",
+    "result": {
+        "run_id": "68e616274b0e9bb510462378",
+        "status": "completed",
+        "result": {"Color": "white"}
+    }
+}
+
+After Versions.COMPLETION_RESULT_V1  (20250925) when the completion result interface changed we improved the
+payload to the current format:
+
+{
+    "workflow_id": "generation:ExecuteInteractionWorkflow:WhatColor:bdedqjqj6",
+    "workflow_name": "ExecuteInteraction",
+    "workflow_run_id": "0199c2d4-6b1d-7cf2-a1e5-4cac6778091e",
+    "event_name": "workflow_completed",
+    "detail": ExecutionRun
+}
+
+where ExecutionRun contains a result property with the new completion result format.
+
+"result": [
+    {
+        "type": "json",
+        "value": {
+            "Color": "white"
+        }
+    }
+],
+
+*/
+
+//@ts-ignore
+async function createOldRequestBody(payload: WorkflowExecutionBaseParams, params: NotifyWebhookParams): Promise<string> {
+    let data = params.detail;
+    if (data && data.run_id && params.event_name === "workflow_completed" && params.workflow_type === 'ExecuteInteractionWorkflow') {
+        const client = getVersionedVertesiaClient(payload, null); //ensure client is using no specific version
+        const run = await client.runs.retrieve(data.run_id);
+        // since we use an unversioned client the run will be in old format so we don't need to tranform the result
+        const result = run.result;
+        data = {
+            workflowId: params.workflow_id,
+            runId: params.workflow_run_id,
+            status: params.event_name === 'workflow_completed' ? 'completed' : params.event_name,
+            result: {
+                run_id: run.id,
+                status: run.status,
+                result: result || null
+            }
+        };
+    }
+    return JSON.stringify(data || {});
+}