@upstash/workflow 0.2.8-rc-invoke → 0.2.9

package/index.mjs

@@ -4,12 +4,13 @@ import {
   WorkflowContext,
   WorkflowError,
   WorkflowLogger,
+  WorkflowTool,
   getWorkflowRunId,
   makeGetWaitersRequest,
   makeNotifyRequest,
   serve,
   triggerFirstInvocation
-} from "./chunk-IWAW7GIG.mjs";
+} from "./chunk-IPXJZU3K.mjs";
 
 // src/client/index.ts
 import { Client as QStashClient } from "@upstash/qstash";
@@ -172,7 +173,8 @@ var Client = class {
     body,
     headers,
     workflowRunId,
-    retries
+    retries,
+    flowControl
   }) {
     const finalWorkflowRunId = getWorkflowRunId(workflowRunId);
     const context = new WorkflowContext({
@@ -184,8 +186,9 @@ var Client = class {
       url,
       workflowRunId: finalWorkflowRunId,
       retries,
-      telemetry: void 0
+      telemetry: void 0,
       // can't know workflow telemetry here
+      flowControl
     });
     const result = await triggerFirstInvocation({
       workflowContext: context,
@@ -198,6 +201,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 +262,6 @@ export {
   WorkflowContext,
   WorkflowError,
   WorkflowLogger,
+  WorkflowTool,
   serve
 };

package/nextjs.d.mts

@@ -1,6 +1,6 @@
 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 { R as RouteFunction, k as PublicServeOptions, t as InvokableWorkflow } from './types-CYhDXnf8.mjs';
+import { s as serveManyBase } from './serve-many-BVDpPsF-.mjs';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';
@@ -18,15 +18,15 @@ import '@ai-sdk/openai';
 declare const serve: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, 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"]) => {
+declare const createWorkflow: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult>;
+declare const serveMany: (workflows: Parameters<typeof serveManyBase>[0]["workflows"], options?: Parameters<typeof serveManyBase>[0]["options"]) => {
     POST: (request: Request) => Promise<any>;
 };
 declare const servePagesRouter: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, 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"]) => {
+declare const createWorkflowPagesRouter: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult>;
+declare const serveManyPagesRouter: (workflows: Parameters<typeof serveManyBase>[0]["workflows"], options?: Parameters<typeof serveManyBase>[0]["options"]) => {
     handler: (req: NextApiRequest, res: NextApiResponse<any>) => Promise<any>;
 };
 

package/nextjs.d.ts

@@ -1,6 +1,6 @@
 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 { R as RouteFunction, k as PublicServeOptions, t as InvokableWorkflow } from './types-CYhDXnf8.js';
+import { s as serveManyBase } from './serve-many-e4zufyXN.js';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';
@@ -18,15 +18,15 @@ import '@ai-sdk/openai';
 declare const serve: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, 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"]) => {
+declare const createWorkflow: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult>;
+declare const serveMany: (workflows: Parameters<typeof serveManyBase>[0]["workflows"], options?: Parameters<typeof serveManyBase>[0]["options"]) => {
     POST: (request: Request) => Promise<any>;
 };
 declare const servePagesRouter: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, 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"]) => {
+declare const createWorkflowPagesRouter: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult>;
+declare const serveManyPagesRouter: (workflows: Parameters<typeof serveManyBase>[0]["workflows"], options?: Parameters<typeof serveManyBase>[0]["options"]) => {
     handler: (req: NextApiRequest, res: NextApiResponse<any>) => Promise<any>;
 };