@upstash/workflow 0.2.22-rc → 0.3.0-rc

package/README.md

@@ -83,6 +83,15 @@ waiting for an event or get the workflows waiting for an event:
 import { Client } from "@upstash/workflow";
 const client = new Client({ token: "<QSTASH_TOKEN>" });
 
+// trigger a workflow
+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 for the initial request
+});
+
 // cancel workflow:
 await client.cancel({ workflowRunId: "<WORKFLOW_RUN_ID>" });
 
@@ -98,6 +107,36 @@ const result = await client.getWaiters({
 });
 ```
 
+## Telemetry
+
+This sdk sends anonymous telemetry headers to help us improve your experience.
+We collect the following:
+
+- SDK version
+- Platform (Cloudflare, AWS or Vercel)
+- Runtime version (node@18.x)
+
+You can opt out by setting `disableTelemetry: true` when triggering the workflow and in the serve options:
+
+```ts
+// client
+const client = new Client(/***/);
+await client.trigger({
+  // ...
+  disableTelemetry: true,
+});
+
+// workflow endpoint
+export const { POST } = serve(
+  async (context) => {
+    // ...
+  },
+  {
+    disableTelemetry: true,
+  }
+);
+```
+
 ## Contributing
 
 ### Setup

package/astro.d.mts

@@ -1,15 +1,13 @@
 import { APIContext, APIRoute } from 'astro';
-import { g as WorkflowContext, n as PublicServeOptions, y as InvokableWorkflow } from './types-Q3dM0UlR.mjs';
-import { s as serveManyBase } from './serve-many-BNusWYgt.mjs';
+import { g as WorkflowContext, n as PublicServeOptions, y as InvokableWorkflow } from './types-DESkn7K9.mjs';
+import { s as serveManyBase } from './serve-many-DEwKPF6H.mjs';
 import '@upstash/qstash';
 import 'zod';
-import 'ai';
-import '@ai-sdk/openai';
 
 declare function serve<TInitialPayload = unknown, TResult = unknown>(routeFunction: (workflowContext: WorkflowContext<TInitialPayload>, apiContext: APIContext) => Promise<TResult>, options?: PublicServeOptions<TInitialPayload>): {
     POST: APIRoute;
 };
-declare const createWorkflow: <TInitialPayload, TResult>(routeFunction: (workflowContext: WorkflowContext<TInitialPayload>, apiContext: APIContext) => Promise<TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult>;
+declare const createWorkflow: <TInitialPayload, TResult>(...params: Parameters<typeof serve<TInitialPayload, TResult>>) => InvokableWorkflow<TInitialPayload, TResult>;
 declare const serveMany: (workflows: Parameters<typeof serveManyBase>[0]["workflows"], options?: Parameters<typeof serveManyBase>[0]["options"]) => {
     POST: (context: APIContext<Record<string, any>, Record<string, string | undefined>>) => Promise<any>;
 };

package/astro.d.ts

@@ -1,15 +1,13 @@
 import { APIContext, APIRoute } from 'astro';
-import { g as WorkflowContext, n as PublicServeOptions, y as InvokableWorkflow } from './types-Q3dM0UlR.js';
-import { s as serveManyBase } from './serve-many-CXqQP3RI.js';
+import { g as WorkflowContext, n as PublicServeOptions, y as InvokableWorkflow } from './types-DESkn7K9.js';
+import { s as serveManyBase } from './serve-many-DVtHRxeg.js';
 import '@upstash/qstash';
 import 'zod';
-import 'ai';
-import '@ai-sdk/openai';
 
 declare function serve<TInitialPayload = unknown, TResult = unknown>(routeFunction: (workflowContext: WorkflowContext<TInitialPayload>, apiContext: APIContext) => Promise<TResult>, options?: PublicServeOptions<TInitialPayload>): {
     POST: APIRoute;
 };
-declare const createWorkflow: <TInitialPayload, TResult>(routeFunction: (workflowContext: WorkflowContext<TInitialPayload>, apiContext: APIContext) => Promise<TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult>;
+declare const createWorkflow: <TInitialPayload, TResult>(...params: Parameters<typeof serve<TInitialPayload, TResult>>) => InvokableWorkflow<TInitialPayload, TResult>;
 declare const serveMany: (workflows: Parameters<typeof serveManyBase>[0]["workflows"], options?: Parameters<typeof serveManyBase>[0]["options"]) => {
     POST: (context: APIContext<Record<string, any>, Record<string, string | undefined>>) => Promise<any>;
 };