@upstash/workflow 0.1.0

package/hono.mjs

@@ -0,0 +1,22 @@
+import {
+  serve
+} from "./chunk-JDMP6KKR.mjs";
+
+// platforms/hono.ts
+var serve2 = (routeFunction, options) => {
+  const handler = async (context) => {
+    const environment = context.env;
+    const request = context.req.raw;
+    const serveHandler = serve(routeFunction, {
+      // when hono is used without cf workers, it sends a DebugHTTPServer
+      // object in `context.env`. don't pass env if this is the case:
+      env: "QSTASH_TOKEN" in environment ? environment : void 0,
+      ...options
+    });
+    return await serveHandler(request);
+  };
+  return handler;
+};
+export {
+  serve2 as serve
+};

package/index.d.mts

@@ -0,0 +1,57 @@
+import { R as RouteFunction, W as WorkflowServeOptions, N as NotifyResponse, S as Step } from './types-CfN1Epuj.mjs';
+export { A as AsyncStepFunction, i as FailureFunctionPayload, F as FinishCondition, L as LogLevel, P as ParallelCallState, f as RawStep, j as RequiredExceptFields, h as StepFunction, e as StepType, d as StepTypes, g as SyncStepFunction, m as WaitRequest, k as WaitResult, n as WaitStepResponse, l as Waiter, b as WorkflowClient, a as WorkflowContext, p as WorkflowLogger, o as WorkflowLoggerOptions, c as WorkflowReceiver } from './types-CfN1Epuj.mjs';
+import { Client as Client$1, QstashError } from '@upstash/qstash';
+
+/**
+ * Creates an async method that handles incoming requests and runs the provided
+ * route function as a workflow.
+ *
+ * @param routeFunction - A function that uses WorkflowContext as a parameter and runs a workflow.
+ * @param options - Options including the client, onFinish callback, and initialPayloadParser.
+ * @returns An async method that consumes incoming requests and runs the workflow.
+ */
+declare const serve: <TInitialPayload = unknown, TRequest extends Request = Request, TResponse extends Response = Response>(routeFunction: RouteFunction<TInitialPayload>, options?: WorkflowServeOptions<TResponse, TInitialPayload>) => ((request: TRequest) => Promise<TResponse>);
+
+type ClientConfig = ConstructorParameters<typeof Client$1>[0];
+declare class Client {
+    private client;
+    constructor(clientConfig: ClientConfig);
+    /**
+     * Cancel an ongoing workflow
+     *
+     * @param workflowRunId run id of the workflow to delete
+     * @returns true if workflow is succesfully deleted. Otherwise throws QStashError
+     */
+    cancel({ workflowRunId }: {
+        workflowRunId: string;
+    }): Promise<true | {
+        error: string;
+    }>;
+    /**
+     * Notify a workflow run waiting for an event
+     *
+     * @param eventId event id to notify
+     * @param notifyData data to provide to the workflow
+     */
+    notify({ eventId, notifyBody, }: {
+        eventId: string;
+        notifyBody?: string;
+    }): Promise<NotifyResponse[]>;
+}
+
+/**
+ * Error raised during Workflow execution
+ */
+declare class QStashWorkflowError extends QstashError {
+    constructor(message: string);
+}
+/**
+ * Raised when the workflow executes a function and aborts
+ */
+declare class QStashWorkflowAbort extends Error {
+    stepInfo?: Step;
+    stepName: string;
+    constructor(stepName: string, stepInfo?: Step);
+}
+
+export { Client, NotifyResponse, QStashWorkflowAbort, QStashWorkflowError, RouteFunction, Step, WorkflowServeOptions, serve };

package/index.d.ts

@@ -0,0 +1,57 @@
+import { R as RouteFunction, W as WorkflowServeOptions, N as NotifyResponse, S as Step } from './types-CfN1Epuj.js';
+export { A as AsyncStepFunction, i as FailureFunctionPayload, F as FinishCondition, L as LogLevel, P as ParallelCallState, f as RawStep, j as RequiredExceptFields, h as StepFunction, e as StepType, d as StepTypes, g as SyncStepFunction, m as WaitRequest, k as WaitResult, n as WaitStepResponse, l as Waiter, b as WorkflowClient, a as WorkflowContext, p as WorkflowLogger, o as WorkflowLoggerOptions, c as WorkflowReceiver } from './types-CfN1Epuj.js';
+import { Client as Client$1, QstashError } from '@upstash/qstash';
+
+/**
+ * Creates an async method that handles incoming requests and runs the provided
+ * route function as a workflow.
+ *
+ * @param routeFunction - A function that uses WorkflowContext as a parameter and runs a workflow.
+ * @param options - Options including the client, onFinish callback, and initialPayloadParser.
+ * @returns An async method that consumes incoming requests and runs the workflow.
+ */
+declare const serve: <TInitialPayload = unknown, TRequest extends Request = Request, TResponse extends Response = Response>(routeFunction: RouteFunction<TInitialPayload>, options?: WorkflowServeOptions<TResponse, TInitialPayload>) => ((request: TRequest) => Promise<TResponse>);
+
+type ClientConfig = ConstructorParameters<typeof Client$1>[0];
+declare class Client {
+    private client;
+    constructor(clientConfig: ClientConfig);
+    /**
+     * Cancel an ongoing workflow
+     *
+     * @param workflowRunId run id of the workflow to delete
+     * @returns true if workflow is succesfully deleted. Otherwise throws QStashError
+     */
+    cancel({ workflowRunId }: {
+        workflowRunId: string;
+    }): Promise<true | {
+        error: string;
+    }>;
+    /**
+     * Notify a workflow run waiting for an event
+     *
+     * @param eventId event id to notify
+     * @param notifyData data to provide to the workflow
+     */
+    notify({ eventId, notifyBody, }: {
+        eventId: string;
+        notifyBody?: string;
+    }): Promise<NotifyResponse[]>;
+}
+
+/**
+ * Error raised during Workflow execution
+ */
+declare class QStashWorkflowError extends QstashError {
+    constructor(message: string);
+}
+/**
+ * Raised when the workflow executes a function and aborts
+ */
+declare class QStashWorkflowAbort extends Error {
+    stepInfo?: Step;
+    stepName: string;
+    constructor(stepName: string, stepInfo?: Step);
+}
+
+export { Client, NotifyResponse, QStashWorkflowAbort, QStashWorkflowError, RouteFunction, Step, WorkflowServeOptions, serve };