@upstash/workflow 0.2.8-rc-invoke → 0.2.8

package/index.js

@@ -26,6 +26,7 @@ __export(src_exports, {
   WorkflowContext: () => WorkflowContext,
   WorkflowError: () => WorkflowError,
   WorkflowLogger: () => WorkflowLogger,
+  WorkflowTool: () => WorkflowTool,
   serve: () => serve
 });
 module.exports = __toCommonJS(src_exports);
@@ -101,7 +102,7 @@ var WORKFLOW_PROTOCOL_VERSION_HEADER = "Upstash-Workflow-Sdk-Version";
 var DEFAULT_CONTENT_TYPE = "application/json";
 var NO_CONCURRENCY = 1;
 var DEFAULT_RETRIES = 3;
-var VERSION = "v0.2.7";
+var VERSION = "v0.2.3";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -148,31 +149,6 @@ var formatWorkflowError = (error) => {
   };
 };
 
-// src/utils.ts
-var NANOID_CHARS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_";
-var NANOID_LENGTH = 21;
-function getRandomInt() {
-  return Math.floor(Math.random() * NANOID_CHARS.length);
-}
-function nanoid() {
-  return Array.from({ length: NANOID_LENGTH }).map(() => NANOID_CHARS[getRandomInt()]).join("");
-}
-function getWorkflowRunId(id) {
-  return `wfr_${id ?? nanoid()}`;
-}
-function decodeBase64(base64) {
-  try {
-    const binString = atob(base64);
-    const intArray = Uint8Array.from(binString, (m) => m.codePointAt(0));
-    return new TextDecoder().decode(intArray);
-  } catch (error) {
-    console.warn(
-      `Upstash Qstash: Failed while decoding base64 "${base64}". Decoding with atob and returning it instead. ${error}`
-    );
-    return atob(base64);
-  }
-}
-
 // src/context/steps.ts
 var BaseLazyStep = class {
   stepName;
@@ -353,41 +329,6 @@ var LazyNotifyStep = class extends LazyFunctionStep {
     });
   }
 };
-var LazyInvokeStep = class extends BaseLazyStep {
-  stepType = "Invoke";
-  params;
-  constructor(stepName, { workflow, body, headers = {}, workflowRunId, retries }) {
-    super(stepName);
-    this.params = {
-      workflow,
-      body,
-      headers,
-      workflowRunId: getWorkflowRunId(workflowRunId),
-      retries
-    };
-  }
-  getPlanStep(concurrent, targetStep) {
-    return {
-      stepId: 0,
-      stepName: this.stepName,
-      stepType: this.stepType,
-      concurrent,
-      targetStep
-    };
-  }
-  /**
-   * won't be used as it's the server who will add the result step
-   * in Invoke step.
-   */
-  getResultStep(concurrent, stepId) {
-    return Promise.resolve({
-      stepId,
-      stepName: this.stepName,
-      stepType: this.stepType,
-      concurrent
-    });
-  }
-};
 
 // node_modules/neverthrow/dist/index.es.js
 var defaultErrorConfig = {
@@ -812,8 +753,7 @@ var StepTypes = [
   "SleepUntil",
   "Call",
   "Wait",
-  "Notify",
-  "Invoke"
+  "Notify"
 ];
 
 // src/workflow-requests.ts
@@ -877,8 +817,8 @@ var triggerRouteFunction = async ({
   debug
 }) => {
   try {
-    const result = await onStep();
-    await onCleanup(result);
+    await onStep();
+    await onCleanup();
     return ok("workflow-finished");
   } catch (error) {
     const error_ = error;
@@ -899,15 +839,14 @@ var triggerRouteFunction = async ({
     }
   }
 };
-var triggerWorkflowDelete = async (workflowContext, result, debug, cancel = false) => {
+var triggerWorkflowDelete = async (workflowContext, debug, cancel = false) => {
   await debug?.log("SUBMIT", "SUBMIT_CLEANUP", {
     deletedWorkflowRunId: workflowContext.workflowRunId
   });
   await workflowContext.qstashClient.http.request({
     path: ["v2", "workflows", "runs", `${workflowContext.workflowRunId}?cancel=${cancel}`],
     method: "DELETE",
-    parseResponseAsJson: false,
-    body: JSON.stringify(result)
+    parseResponseAsJson: false
   });
   await debug?.log(
     "SUBMIT",
@@ -1062,14 +1001,11 @@ var getHeaders = ({
   callTimeout,
   telemetry
 }) => {
-  const contentType = (userHeaders ? userHeaders.get("Content-Type") : void 0) ?? DEFAULT_CONTENT_TYPE;
   const baseHeaders = {
     [WORKFLOW_INIT_HEADER]: initHeaderValue,
     [WORKFLOW_ID_HEADER]: workflowRunId,
     [WORKFLOW_URL_HEADER]: workflowUrl,
     [WORKFLOW_FEATURE_HEADER]: "LazyFetch,InitialBody",
-    [WORKFLOW_PROTOCOL_VERSION_HEADER]: WORKFLOW_PROTOCOL_VERSION,
-    "content-type": contentType,
     ...telemetry ? getTelemetryHeaders(telemetry) : {}
   };
   if (!step?.callUrl) {
@@ -1080,13 +1016,18 @@ var getHeaders = ({
   }
   if (failureUrl) {
     baseHeaders[`Upstash-Failure-Callback-Forward-${WORKFLOW_FAILURE_HEADER}`] = "true";
+    baseHeaders[`Upstash-Failure-Callback-Forward-Upstash-Workflow-Failure-Callback`] = "true";
+    baseHeaders["Upstash-Failure-Callback-Workflow-Runid"] = workflowRunId;
+    baseHeaders["Upstash-Failure-Callback-Workflow-Init"] = "false";
+    baseHeaders["Upstash-Failure-Callback-Workflow-Url"] = workflowUrl;
+    baseHeaders["Upstash-Failure-Callback-Workflow-Calltype"] = "failureCall";
+    if (retries !== void 0) {
+      baseHeaders["Upstash-Failure-Callback-Retries"] = retries.toString();
+    }
     if (!step?.callUrl) {
       baseHeaders["Upstash-Failure-Callback"] = failureUrl;
     }
   }
-  if (step?.stepType === "Invoke") {
-    baseHeaders["upstash-workflow-invoke"] = "true";
-  }
   if (step?.callUrl) {
     baseHeaders["Upstash-Retries"] = callRetries?.toString() ?? "0";
     baseHeaders[WORKFLOW_FEATURE_HEADER] = "WF_NoDelete,InitialBody";
@@ -1108,6 +1049,7 @@ var getHeaders = ({
       baseHeaders[`Upstash-Failure-Callback-Forward-${header}`] = userHeaders.get(header);
     }
   }
+  const contentType = (userHeaders ? userHeaders.get("Content-Type") : void 0) ?? DEFAULT_CONTENT_TYPE;
   if (step?.callHeaders) {
     const forwardedHeaders = Object.fromEntries(
       Object.entries(step.callHeaders).map(([header, value]) => [
@@ -1157,7 +1099,8 @@ var getHeaders = ({
         "Upstash-Workflow-Runid": [workflowRunId],
         [WORKFLOW_INIT_HEADER]: ["false"],
         [WORKFLOW_URL_HEADER]: [workflowUrl],
-        "Upstash-Workflow-CallType": ["step"]
+        "Upstash-Workflow-CallType": ["step"],
+        "Content-Type": [contentType]
       }
     };
   }
@@ -1452,23 +1395,7 @@ var AutoExecutor = class _AutoExecutor {
         method: "POST",
         parseResponseAsJson: false
       });
-      throw new WorkflowAbort(waitStep.stepName, waitStep);
-    }
-    if (steps.length === 1 && lazySteps[0] instanceof LazyInvokeStep) {
-      const invokeStep = steps[0];
-      const lazyInvokeStep = lazySteps[0];
-      await lazyInvokeStep.params.workflow.callback(
-        {
-          body: lazyInvokeStep.params.body,
-          headers: lazyInvokeStep.params.headers,
-          workflowRunId: lazyInvokeStep.params.workflowRunId,
-          workflow: lazyInvokeStep.params.workflow,
-          retries: lazyInvokeStep.params.retries
-        },
-        invokeStep,
-        this.context
-      );
-      throw new WorkflowAbort(invokeStep.stepName, invokeStep);
+      throw new WorkflowAbort(steps[0].stepName, steps[0]);
     }
     const result = await this.context.qstashClient.batchJSON(
       steps.map((singleStep, index) => {
@@ -1787,9 +1714,10 @@ var wrapTools = ({
   return Object.fromEntries(
     Object.entries(tools).map((toolInfo) => {
       const [toolName, tool3] = toolInfo;
+      const executeAsStep = "executeAsStep" in tool3 ? tool3.executeAsStep : true;
       const aiSDKTool = convertToAISDKTool(tool3);
       const execute = aiSDKTool.execute;
-      if (execute) {
+      if (execute && executeAsStep) {
         const wrappedExecute = (...params) => {
           return context.run(`Run tool ${toolName}`, () => execute(...params));
         };
@@ -1810,6 +1738,37 @@ var convertLangchainTool = (langchainTool) => {
     execute: async (...param) => langchainTool.invoke(...param)
   });
 };
+var WorkflowTool = class {
+  /**
+   * description of the tool
+   */
+  description;
+  /**
+   * schema of the tool
+   */
+  schema;
+  /**
+   * function to invoke the tool
+   */
+  invoke;
+  /**
+   * whether the invoke method of the tool is to be wrapped with `context.run`
+   */
+  executeAsStep;
+  /**
+   * 
+   * @param description description of the tool
+   * @param schema schema of the tool
+   * @param invoke function to invoke the tool
+   * @param executeAsStep whether the invoke method of the tool is to be wrapped with `context.run`
+   */
+  constructor(params) {
+    this.description = params.description;
+    this.schema = params.schema;
+    this.invoke = params.invoke;
+    this.executeAsStep = params.executeAsStep ?? true;
+  }
+};
 
 // src/agents/agent.ts
 var import_zod = require("zod");
@@ -2385,13 +2344,6 @@ var WorkflowContext = class {
       return result;
     }
   }
-  async invoke(stepName, settings) {
-    const result = await this.addStep(new LazyInvokeStep(stepName, settings));
-    return {
-      ...result,
-      body: result.body ? JSON.parse(result.body) : void 0
-    };
-  }
   /**
    * Cancel the current workflow run
    *
@@ -2469,6 +2421,31 @@ var WorkflowLogger = class _WorkflowLogger {
   }
 };
 
+// src/utils.ts
+var NANOID_CHARS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_";
+var NANOID_LENGTH = 21;
+function getRandomInt() {
+  return Math.floor(Math.random() * NANOID_CHARS.length);
+}
+function nanoid() {
+  return Array.from({ length: NANOID_LENGTH }).map(() => NANOID_CHARS[getRandomInt()]).join("");
+}
+function getWorkflowRunId(id) {
+  return `wfr_${id ?? nanoid()}`;
+}
+function decodeBase64(base64) {
+  try {
+    const binString = atob(base64);
+    const intArray = Uint8Array.from(binString, (m) => m.codePointAt(0));
+    return new TextDecoder().decode(intArray);
+  } catch (error) {
+    console.warn(
+      `Upstash Qstash: Failed while decoding base64 "${base64}". Decoding with atob and returning it instead. ${error}`
+    );
+    return atob(base64);
+  }
+}
+
 // src/serve/authorization.ts
 var import_qstash8 = require("@upstash/qstash");
 var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowContext {
@@ -2914,8 +2891,8 @@ var serveBase = (routeFunction, telemetry, options) => {
     } else if (callReturnCheck.value === "continue-workflow") {
       const result = isFirstInvocation ? await triggerFirstInvocation({ workflowContext, useJSONContent, telemetry, debug }) : await triggerRouteFunction({
         onStep: async () => routeFunction(workflowContext),
-        onCleanup: async (result2) => {
-          await triggerWorkflowDelete(workflowContext, result2, debug);
+        onCleanup: async () => {
+          await triggerWorkflowDelete(workflowContext, debug);
         },
         onCancel: async () => {
           await makeCancelRequest(workflowContext.qstashClient.http, workflowRunId);
@@ -3144,6 +3121,59 @@ var Client4 = class {
       throw result.error;
     }
   }
+  /**
+    * Fetches logs for workflow runs.
+    *
+    * @param workflowRunId - The ID of the workflow run to fetch logs for.
+    * @param cursor - The cursor for pagination.
+    * @param count - Number of runs to fetch. Default value is 10.
+    * @param state - The state of the workflow run.
+    * @param workflowUrl - The URL of the workflow. Should be an exact match.
+    * @param workflowCreatedAt - The creation time of the workflow. If you have two workflow runs with the same URL, you can use this to filter them.
+    * @returns A promise that resolves to either a `WorkflowRunLog` or a `WorkflowRunResponse`.
+    *
+    * @example
+    * Fetch logs for a specific workflow run:
+    * ```typescript
+    * const { runs } = await client.logs({ workflowRunId: '12345' });
+    * const steps = runs[0].steps; // access steps
+    * ```
+    *
+    * @example
+    * Fetch logs with pagination:
+    * ```typescript
+    * const { runs, cursor } = await client.logs();
+    * const steps = runs[0].steps // access steps
+    * 
+    * const { runs: nextRuns, cursor: nextCursor } = await client.logs({ cursor, count: 2 });
+    * ```
+    */
+  async logs(params) {
+    const { workflowRunId, cursor, count, state, workflowUrl, workflowCreatedAt } = params ?? {};
+    const urlParams = new URLSearchParams({ "groupBy": "workflowRunId" });
+    if (workflowRunId) {
+      urlParams.append("workflowRunId", workflowRunId);
+    }
+    if (cursor) {
+      urlParams.append("cursor", cursor);
+    }
+    if (count) {
+      urlParams.append("count", count.toString());
+    }
+    if (state) {
+      urlParams.append("state", state);
+    }
+    if (workflowUrl) {
+      urlParams.append("workflowUrl", workflowUrl);
+    }
+    if (workflowCreatedAt) {
+      urlParams.append("workflowCreatedAt", workflowCreatedAt.toString());
+    }
+    const result = await this.client.http.request({
+      path: ["v2", "workflows", `events?${urlParams.toString()}`]
+    });
+    return result;
+  }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -3153,5 +3183,6 @@ var Client4 = class {
   WorkflowContext,
   WorkflowError,
   WorkflowLogger,
+  WorkflowTool,
   serve
 });

package/index.mjs

@@ -4,12 +4,13 @@ import {
   WorkflowContext,
   WorkflowError,
   WorkflowLogger,
+  WorkflowTool,
   getWorkflowRunId,
   makeGetWaitersRequest,
   makeNotifyRequest,
   serve,
   triggerFirstInvocation
-} from "./chunk-IWAW7GIG.mjs";
+} from "./chunk-BPUSHNSD.mjs";
 
 // src/client/index.ts
 import { Client as QStashClient } from "@upstash/qstash";
@@ -198,6 +199,59 @@ var Client = class {
       throw result.error;
     }
   }
+  /**
+    * Fetches logs for workflow runs.
+    *
+    * @param workflowRunId - The ID of the workflow run to fetch logs for.
+    * @param cursor - The cursor for pagination.
+    * @param count - Number of runs to fetch. Default value is 10.
+    * @param state - The state of the workflow run.
+    * @param workflowUrl - The URL of the workflow. Should be an exact match.
+    * @param workflowCreatedAt - The creation time of the workflow. If you have two workflow runs with the same URL, you can use this to filter them.
+    * @returns A promise that resolves to either a `WorkflowRunLog` or a `WorkflowRunResponse`.
+    *
+    * @example
+    * Fetch logs for a specific workflow run:
+    * ```typescript
+    * const { runs } = await client.logs({ workflowRunId: '12345' });
+    * const steps = runs[0].steps; // access steps
+    * ```
+    *
+    * @example
+    * Fetch logs with pagination:
+    * ```typescript
+    * const { runs, cursor } = await client.logs();
+    * const steps = runs[0].steps // access steps
+    * 
+    * const { runs: nextRuns, cursor: nextCursor } = await client.logs({ cursor, count: 2 });
+    * ```
+    */
+  async logs(params) {
+    const { workflowRunId, cursor, count, state, workflowUrl, workflowCreatedAt } = params ?? {};
+    const urlParams = new URLSearchParams({ "groupBy": "workflowRunId" });
+    if (workflowRunId) {
+      urlParams.append("workflowRunId", workflowRunId);
+    }
+    if (cursor) {
+      urlParams.append("cursor", cursor);
+    }
+    if (count) {
+      urlParams.append("count", count.toString());
+    }
+    if (state) {
+      urlParams.append("state", state);
+    }
+    if (workflowUrl) {
+      urlParams.append("workflowUrl", workflowUrl);
+    }
+    if (workflowCreatedAt) {
+      urlParams.append("workflowCreatedAt", workflowCreatedAt.toString());
+    }
+    const result = await this.client.http.request({
+      path: ["v2", "workflows", `events?${urlParams.toString()}`]
+    });
+    return result;
+  }
 };
 export {
   Client,
@@ -206,5 +260,6 @@ export {
   WorkflowContext,
   WorkflowError,
   WorkflowLogger,
+  WorkflowTool,
   serve
 };

package/nextjs.d.mts

@@ -1,6 +1,5 @@
-import { NextApiHandler, NextApiRequest, NextApiResponse } from 'next';
-import { R as RouteFunction, j as PublicServeOptions, t as InvokableWorkflow } from './types-C7Y7WUQd.mjs';
-import { s as serveManyBase } from './serve-many-BlBvXfBS.mjs';
+import { NextApiHandler } from 'next';
+import { R as RouteFunction, k as PublicServeOptions } from './types-B62AnIU3.mjs';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';
@@ -15,19 +14,11 @@ import '@ai-sdk/openai';
  * @param options workflow options
  * @returns
  */
-declare const serve: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload>) => {
+declare const serve: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options?: PublicServeOptions<TInitialPayload>) => {
     POST: (request: Request) => Promise<Response>;
 };
-declare const createWorkflow: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult, Parameters<ReturnType<typeof serve<TInitialPayload, TResult>>["POST"]>>;
-declare const serveMany: (workflows: Parameters<typeof serveManyBase>[0]["workflows"]) => {
-    POST: (request: Request) => Promise<any>;
-};
-declare const servePagesRouter: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload>) => {
+declare const servePagesRouter: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options?: PublicServeOptions<TInitialPayload>) => {
     handler: NextApiHandler;
 };
-declare const createWorkflowPagesRouter: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult, Parameters<ReturnType<typeof servePagesRouter<TInitialPayload, TResult>>["handler"]>>;
-declare const serveManyPagesRouter: (workflows: Parameters<typeof serveManyBase>[0]["workflows"]) => {
-    handler: (req: NextApiRequest, res: NextApiResponse<any>) => Promise<any>;
-};
 
-export { createWorkflow, createWorkflowPagesRouter, serve, serveMany, serveManyPagesRouter, servePagesRouter };
+export { serve, servePagesRouter };

package/nextjs.d.ts

@@ -1,6 +1,5 @@
-import { NextApiHandler, NextApiRequest, NextApiResponse } from 'next';
-import { R as RouteFunction, j as PublicServeOptions, t as InvokableWorkflow } from './types-C7Y7WUQd.js';
-import { s as serveManyBase } from './serve-many-Dw-UUnH6.js';
+import { NextApiHandler } from 'next';
+import { R as RouteFunction, k as PublicServeOptions } from './types-B62AnIU3.js';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';
@@ -15,19 +14,11 @@ import '@ai-sdk/openai';
  * @param options workflow options
  * @returns
  */
-declare const serve: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload>) => {
+declare const serve: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options?: PublicServeOptions<TInitialPayload>) => {
     POST: (request: Request) => Promise<Response>;
 };
-declare const createWorkflow: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult, Parameters<ReturnType<typeof serve<TInitialPayload, TResult>>["POST"]>>;
-declare const serveMany: (workflows: Parameters<typeof serveManyBase>[0]["workflows"]) => {
-    POST: (request: Request) => Promise<any>;
-};
-declare const servePagesRouter: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload>) => {
+declare const servePagesRouter: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options?: PublicServeOptions<TInitialPayload>) => {
     handler: NextApiHandler;
 };
-declare const createWorkflowPagesRouter: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult, Parameters<ReturnType<typeof servePagesRouter<TInitialPayload, TResult>>["handler"]>>;
-declare const serveManyPagesRouter: (workflows: Parameters<typeof serveManyBase>[0]["workflows"]) => {
-    handler: (req: NextApiRequest, res: NextApiResponse<any>) => Promise<any>;
-};
 
-export { createWorkflow, createWorkflowPagesRouter, serve, serveMany, serveManyPagesRouter, servePagesRouter };
+export { serve, servePagesRouter };