@upstash/workflow 0.1.4 → 0.2.0

package/hono.mjs

@@ -1,6 +1,6 @@
 import {
   serve
-} from "./chunk-HO2SB246.mjs";
+} from "./chunk-5R2BFC3N.mjs";
 
 // platforms/hono.ts
 var serve2 = (routeFunction, options) => {

package/index.d.mts

@@ -1,5 +1,5 @@
-import { R as RouteFunction, W as WorkflowServeOptions, N as NotifyResponse, a as Waiter, S as Step } from './types-CQuc-j8n.mjs';
-export { A as AsyncStepFunction, C as CallResponse, D as Duration, j as FailureFunctionPayload, F as FinishCondition, L as LogLevel, n as NotifyStepResponse, P as ParallelCallState, g as RawStep, k as RequiredExceptFields, i as StepFunction, f as StepType, e as StepTypes, h as SyncStepFunction, l as WaitRequest, m as WaitStepResponse, c as WorkflowClient, b as WorkflowContext, p as WorkflowLogger, o as WorkflowLoggerOptions, d as WorkflowReceiver } from './types-CQuc-j8n.mjs';
+import { R as RouteFunction, W as WorkflowServeOptions, N as NotifyResponse, a as Waiter, S as Step } from './types-Cki_MHrh.mjs';
+export { A as AsyncStepFunction, C as CallResponse, D as Duration, j as FailureFunctionPayload, F as FinishCondition, L as LogLevel, n as NotifyStepResponse, P as ParallelCallState, g as RawStep, k as RequiredExceptFields, i as StepFunction, f as StepType, e as StepTypes, h as SyncStepFunction, o as WaitEventOptions, l as WaitRequest, m as WaitStepResponse, c as WorkflowClient, b as WorkflowContext, q as WorkflowLogger, p as WorkflowLoggerOptions, d as WorkflowReceiver } from './types-Cki_MHrh.mjs';
 import { Client as Client$1, QstashError } from '@upstash/qstash';
 
 /**
@@ -30,20 +30,62 @@ declare class Client {
     /**
      * Cancel an ongoing workflow
      *
+     * Returns true if workflow is canceled succesfully. Otherwise, throws error.
+     *
+     * There are multiple ways you can cancel workflows:
+     * - pass one or more workflow run ids to cancel them
+     * - pass a workflow url to cancel all runs starting with this url
+     * - cancel all pending or active workflow runs
+     *
+     * ### Cancel a set of workflow runs
+     *
      * ```ts
-     * import { Client } from "@upstash/workflow";
+     * // cancel a single workflow
+     * await client.cancel({ ids: "<WORKFLOW_RUN_ID>" })
      *
-     * const client = new Client({ token: "<QSTASH_TOKEN>" })
-     * await client.cancel({ workflowRunId: "<WORKFLOW_RUN_ID>" })
+     * // cancel a set of workflow runs
+     * await client.cancel({ ids: [
+     *   "<WORKFLOW_RUN_ID_1>",
+     *   "<WORKFLOW_RUN_ID_2>",
+     * ]})
      * ```
      *
-     * @param workflowRunId run id of the workflow to delete
+     * ### Cancel workflows starting with a url
+     *
+     * If you have an endpoint called `https://your-endpoint.com` and you
+     * want to cancel all workflow runs on it, you can use `urlStartingWith`.
+     *
+     * Note that this will cancel workflows in all endpoints under
+     * `https://your-endpoint.com`.
+     *
+     * ```ts
+     * await client.cancel({ urlStartingWith: "https://your-endpoint.com" })
+     * ```
+     *
+     * ### Cancel *all* workflows
+     *
+     * To cancel all pending and currently running workflows, you can
+     * do it like this:
+     *
+     * ```ts
+     * await client.cancel({ all: true })
+     * ```
+     *
+     * @param ids run id of the workflow to delete
+     * @param urlStartingWith cancel workflows starting with this url. Will be ignored
+     *   if `ids` parameter is set.
+     * @param all set to true in order to cancel all workflows. Will be ignored
+     *   if `ids` or `urlStartingWith` parameters are set.
      * @returns true if workflow is succesfully deleted. Otherwise throws QStashError
      */
-    cancel({ workflowRunId }: {
-        workflowRunId: string;
-    }): Promise<true | {
-        error: string;
+    cancel({ ids, urlStartingWith, all, }: {
+        ids?: string | string[];
+        urlStartingWith?: string;
+        all?: true;
+    }): Promise<{
+        cancelled: number;
+    } & {
+        error?: string;
     }>;
     /**
      * Notify a workflow run waiting for an event
@@ -86,13 +128,13 @@ declare class Client {
      * Trigger new workflow run and returns the workflow run id
      *
      * ```ts
-     * const { workflowRunId } await client.trigger({
+     * const { workflowRunId } = await client.trigger({
      *   url: "https://workflow-endpoint.com",
-     *   body: "hello there!", // optional body
-     *   headers: { ... }, // optional headers
-     *   workflowRunId: "my-workflow", // optional workflow run id
-     *   retries: 3 // optional retries in the initial request
-     * })
+     *   body: "hello there!",         // Optional body
+     *   headers: { ... },             // Optional headers
+     *   workflowRunId: "my-workflow", // Optional workflow run ID
+     *   retries: 3                    // Optional retries for the initial request
+     * });
      *
      * console.log(workflowRunId)
      * // wfr_my-workflow
@@ -124,16 +166,27 @@ declare class Client {
 /**
  * Error raised during Workflow execution
  */
-declare class QStashWorkflowError extends QstashError {
+declare class WorkflowError extends QstashError {
     constructor(message: string);
 }
 /**
- * Raised when the workflow executes a function and aborts
+ * Raised when the workflow executes a function successfully
+ * and aborts to end the execution
  */
-declare class QStashWorkflowAbort extends Error {
+declare class WorkflowAbort extends Error {
     stepInfo?: Step;
     stepName: string;
-    constructor(stepName: string, stepInfo?: Step);
+    /**
+     * whether workflow is to be canceled on abort
+     */
+    cancelWorkflow: boolean;
+    /**
+     *
+     * @param stepName name of the aborting step
+     * @param stepInfo step information
+     * @param cancelWorkflow
+     */
+    constructor(stepName: string, stepInfo?: Step, cancelWorkflow?: boolean);
 }
 
-export { Client, NotifyResponse, QStashWorkflowAbort, QStashWorkflowError, RouteFunction, Step, Waiter, WorkflowServeOptions, serve };
+export { Client, NotifyResponse, RouteFunction, Step, Waiter, WorkflowAbort, WorkflowError, WorkflowServeOptions, serve };

package/index.d.ts

@@ -1,5 +1,5 @@
-import { R as RouteFunction, W as WorkflowServeOptions, N as NotifyResponse, a as Waiter, S as Step } from './types-CQuc-j8n.js';
-export { A as AsyncStepFunction, C as CallResponse, D as Duration, j as FailureFunctionPayload, F as FinishCondition, L as LogLevel, n as NotifyStepResponse, P as ParallelCallState, g as RawStep, k as RequiredExceptFields, i as StepFunction, f as StepType, e as StepTypes, h as SyncStepFunction, l as WaitRequest, m as WaitStepResponse, c as WorkflowClient, b as WorkflowContext, p as WorkflowLogger, o as WorkflowLoggerOptions, d as WorkflowReceiver } from './types-CQuc-j8n.js';
+import { R as RouteFunction, W as WorkflowServeOptions, N as NotifyResponse, a as Waiter, S as Step } from './types-Cki_MHrh.js';
+export { A as AsyncStepFunction, C as CallResponse, D as Duration, j as FailureFunctionPayload, F as FinishCondition, L as LogLevel, n as NotifyStepResponse, P as ParallelCallState, g as RawStep, k as RequiredExceptFields, i as StepFunction, f as StepType, e as StepTypes, h as SyncStepFunction, o as WaitEventOptions, l as WaitRequest, m as WaitStepResponse, c as WorkflowClient, b as WorkflowContext, q as WorkflowLogger, p as WorkflowLoggerOptions, d as WorkflowReceiver } from './types-Cki_MHrh.js';
 import { Client as Client$1, QstashError } from '@upstash/qstash';
 
 /**
@@ -30,20 +30,62 @@ declare class Client {
     /**
      * Cancel an ongoing workflow
      *
+     * Returns true if workflow is canceled succesfully. Otherwise, throws error.
+     *
+     * There are multiple ways you can cancel workflows:
+     * - pass one or more workflow run ids to cancel them
+     * - pass a workflow url to cancel all runs starting with this url
+     * - cancel all pending or active workflow runs
+     *
+     * ### Cancel a set of workflow runs
+     *
      * ```ts
-     * import { Client } from "@upstash/workflow";
+     * // cancel a single workflow
+     * await client.cancel({ ids: "<WORKFLOW_RUN_ID>" })
      *
-     * const client = new Client({ token: "<QSTASH_TOKEN>" })
-     * await client.cancel({ workflowRunId: "<WORKFLOW_RUN_ID>" })
+     * // cancel a set of workflow runs
+     * await client.cancel({ ids: [
+     *   "<WORKFLOW_RUN_ID_1>",
+     *   "<WORKFLOW_RUN_ID_2>",
+     * ]})
      * ```
      *
-     * @param workflowRunId run id of the workflow to delete
+     * ### Cancel workflows starting with a url
+     *
+     * If you have an endpoint called `https://your-endpoint.com` and you
+     * want to cancel all workflow runs on it, you can use `urlStartingWith`.
+     *
+     * Note that this will cancel workflows in all endpoints under
+     * `https://your-endpoint.com`.
+     *
+     * ```ts
+     * await client.cancel({ urlStartingWith: "https://your-endpoint.com" })
+     * ```
+     *
+     * ### Cancel *all* workflows
+     *
+     * To cancel all pending and currently running workflows, you can
+     * do it like this:
+     *
+     * ```ts
+     * await client.cancel({ all: true })
+     * ```
+     *
+     * @param ids run id of the workflow to delete
+     * @param urlStartingWith cancel workflows starting with this url. Will be ignored
+     *   if `ids` parameter is set.
+     * @param all set to true in order to cancel all workflows. Will be ignored
+     *   if `ids` or `urlStartingWith` parameters are set.
      * @returns true if workflow is succesfully deleted. Otherwise throws QStashError
      */
-    cancel({ workflowRunId }: {
-        workflowRunId: string;
-    }): Promise<true | {
-        error: string;
+    cancel({ ids, urlStartingWith, all, }: {
+        ids?: string | string[];
+        urlStartingWith?: string;
+        all?: true;
+    }): Promise<{
+        cancelled: number;
+    } & {
+        error?: string;
     }>;
     /**
      * Notify a workflow run waiting for an event
@@ -86,13 +128,13 @@ declare class Client {
      * Trigger new workflow run and returns the workflow run id
      *
      * ```ts
-     * const { workflowRunId } await client.trigger({
+     * const { workflowRunId } = await client.trigger({
      *   url: "https://workflow-endpoint.com",
-     *   body: "hello there!", // optional body
-     *   headers: { ... }, // optional headers
-     *   workflowRunId: "my-workflow", // optional workflow run id
-     *   retries: 3 // optional retries in the initial request
-     * })
+     *   body: "hello there!",         // Optional body
+     *   headers: { ... },             // Optional headers
+     *   workflowRunId: "my-workflow", // Optional workflow run ID
+     *   retries: 3                    // Optional retries for the initial request
+     * });
      *
      * console.log(workflowRunId)
      * // wfr_my-workflow
@@ -124,16 +166,27 @@ declare class Client {
 /**
  * Error raised during Workflow execution
  */
-declare class QStashWorkflowError extends QstashError {
+declare class WorkflowError extends QstashError {
     constructor(message: string);
 }
 /**
- * Raised when the workflow executes a function and aborts
+ * Raised when the workflow executes a function successfully
+ * and aborts to end the execution
  */
-declare class QStashWorkflowAbort extends Error {
+declare class WorkflowAbort extends Error {
     stepInfo?: Step;
     stepName: string;
-    constructor(stepName: string, stepInfo?: Step);
+    /**
+     * whether workflow is to be canceled on abort
+     */
+    cancelWorkflow: boolean;
+    /**
+     *
+     * @param stepName name of the aborting step
+     * @param stepInfo step information
+     * @param cancelWorkflow
+     */
+    constructor(stepName: string, stepInfo?: Step, cancelWorkflow?: boolean);
 }
 
-export { Client, NotifyResponse, QStashWorkflowAbort, QStashWorkflowError, RouteFunction, Step, Waiter, WorkflowServeOptions, serve };
+export { Client, NotifyResponse, RouteFunction, Step, Waiter, WorkflowAbort, WorkflowError, WorkflowServeOptions, serve };