feat: deprecate workflow and llm (#213)

workflow will be available under @upstash/workflow

platforms/cloudflare.ts

@@ -55,13 +55,18 @@ const getArgs = (
  * @param routeFunction workflow function
  * @param options workflow options
  * @returns
+ *
+ * @deprecated as of version 2.7.17. Will be removed in qstash-js 3.0.0.
+ * Please use https://github.com/upstash/workflow-js
+ * Migration Guide: https://upstash.com/docs/workflow/migration
  */
 export const serve = <TInitialPayload = unknown>(
   routeFunction: RouteFunction<TInitialPayload>,
   options?: Omit<WorkflowServeOptions<Response, TInitialPayload>, "onStepFinish">
 ): ((...args: PagesHandlerArgs | WorkersHandlerArgs) => Promise<Response>) => {
   const handler = async (...args: PagesHandlerArgs | WorkersHandlerArgs) => {
     const { request, env } = getArgs(args);
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     const serveHandler = serveBase(routeFunction, {
       env,
       ...options,

platforms/h3.ts

@@ -67,6 +67,11 @@ function transformHeaders(headers: IncomingHttpHeaders): [string, string][] {
   return formattedHeaders as [string, string][];
 }
 
+/**
+ * @deprecated as of version 2.7.17. Will be removed in qstash-js 3.0.0.
+ * Please use https://github.com/upstash/workflow-js
+ * Migration Guide: https://upstash.com/docs/workflow/migration
+ */
 export const serve = <TInitialPayload = unknown>(
   routeFunction: RouteFunction<TInitialPayload>,
   options?: Omit<WorkflowServeOptions<Response, TInitialPayload>, "onStepFinish">
@@ -92,6 +97,7 @@ export const serve = <TInitialPayload = unknown>(
       method: "POST",
     });
 
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     const serveHandler = serveBase<TInitialPayload>(routeFunction, options);
     return await serveHandler(request);
   });

platforms/hono.ts

@@ -18,6 +18,10 @@ export type WorkflowBindings = {
  * @param routeFunction workflow function
  * @param options workflow options
  * @returns
+ *
+ * @deprecated as of version 2.7.17. Will be removed in qstash-js 3.0.0.
+ * Please use https://github.com/upstash/workflow-js
+ * Migration Guide: https://upstash.com/docs/workflow/migration
  */
 export const serve = <
   TInitialPayload = unknown,
@@ -31,6 +35,7 @@ export const serve = <
     const environment = context.env;
     const request = context.req.raw;
 
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     const serveHandler = serveBase(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:

platforms/nextjs.ts

@@ -201,11 +201,16 @@ export function verifySignatureAppRouter(
  * @param routeFunction workflow function
  * @param options workflow options
  * @returns
+ *
+ * @deprecated as of version 2.7.17. Will be removed in qstash-js 3.0.0.
+ * Please use https://github.com/upstash/workflow-js
+ * Migration Guide: https://upstash.com/docs/workflow/migration
  */
 export const serve = <TInitialPayload = unknown>(
   routeFunction: RouteFunction<TInitialPayload>,
   options?: Omit<WorkflowServeOptions<Response, TInitialPayload>, "onStepFinish">
 ): ((request: Request) => Promise<Response>) => {
+  // eslint-disable-next-line @typescript-eslint/no-deprecated
   const handler = serveBase<TInitialPayload>(routeFunction, {
     onStepFinish: (workflowRunId: string) =>
       new Response(JSON.stringify({ workflowRunId }), { status: 200 }),
@@ -217,10 +222,16 @@ export const serve = <TInitialPayload = unknown>(
   };
 };
 
+/**
+ * @deprecated as of version 2.7.17. Will be removed in qstash-js 3.0.0.
+ * Please use https://github.com/upstash/workflow-js
+ * Migration Guide: https://upstash.com/docs/workflow/migration
+ */
 export const servePagesRouter = <TInitialPayload = unknown>(
   routeFunction: RouteFunction<TInitialPayload>,
   options?: Omit<WorkflowServeOptions<Response, TInitialPayload>, "onStepFinish">
 ): NextApiHandler => {
+  // eslint-disable-next-line @typescript-eslint/no-deprecated
   const handler = serveBase(routeFunction, options);
 
   return async (req: NextApiRequest, res: NextApiResponse) => {

platforms/nuxt.ts

@@ -1,7 +1,9 @@
 import { verifySignatureH3 } from "./h3";
 
 /**
- * @deprecated Use import { verifySignatureH3 } from "@upstash/qstash/h3" instead
+ * @deprecated as of version 2.7.17. Will be removed in qstash-js 3.0.0.
+ * Please use https://github.com/upstash/workflow-js
+ * Migration Guide: https://upstash.com/docs/workflow/migration
  */
 // eslint-disable-next-line unicorn/prefer-export-from
 export const verifySignatureNuxt = verifySignatureH3;

platforms/solidjs.ts

@@ -57,6 +57,10 @@ export const verifySignatureSolidjs = (
  * @param routeFunction workflow function
  * @param options workflow options
  * @returns
+ *
+ * @deprecated as of version 2.7.17. Will be removed in qstash-js 3.0.0.
+ * Please use https://github.com/upstash/workflow-js
+ * Migration Guide: https://upstash.com/docs/workflow/migration
  */
 export const serve = <TInitialPayload = unknown>(
   routeFunction: RouteFunction<TInitialPayload>,
@@ -72,6 +76,7 @@ export const serve = <TInitialPayload = unknown>(
     }
 
     // create serve handler
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     const serveHandler = serveBase<TInitialPayload>(routeFunction, options);
 
     return await serveHandler(event.request);

platforms/svelte.ts

@@ -60,6 +60,10 @@ export const verifySignatureSvelte = <
  * @param routeFunction workflow function
  * @param options workflow options
  * @returns
+ *
+ * @deprecated as of version 2.7.17. Will be removed in qstash-js 3.0.0.
+ * Please use https://github.com/upstash/workflow-js
+ * Migration Guide: https://upstash.com/docs/workflow/migration
  */
 export const serve = <TInitialPayload = unknown>(
   routeFunction: RouteFunction<TInitialPayload>,
@@ -68,6 +72,7 @@ export const serve = <TInitialPayload = unknown>(
   }
 ): RequestHandler => {
   const handler: RequestHandler = async ({ request }) => {
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     const serveMethod = serveBase<TInitialPayload>(routeFunction, options);
     return await serveMethod(request);
   };

src/client/api/llm.test.ts

@@ -54,6 +54,7 @@ describe("llm", () => {
         await client.publishJSON({
           api: {
             name: "llm",
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
             provider: upstash(),
             analytics: { name: "helicone", token: analyticsToken },
           },

src/client/api/llm.ts

@@ -54,6 +54,14 @@ export class LLMProvider<TOwner extends LLMOwner> extends BaseProvider<"llm", LL
 
 // PROVIDERS
 
+/**
+ * @deprecated as of version 2.7.17. Will be removed in qstash-js 3.0.0.
+ *
+ * Please use an alternative LLM provider.
+ *
+ * openai: https://upstash.com/docs/qstash/integrations/llm
+ * anthropic: https://upstash.com/docs/qstash/integrations/anthropic
+ */
 export const upstash = (): LLMProvider<"upstash"> => {
   return new LLMProvider("https://qstash.upstash.io/llm", "", "upstash");
 };

src/client/api/utils.ts

@@ -14,6 +14,7 @@ export const getProviderInfo = (
   upstashToken: string
 ): ProviderInfo => {
   const { name, provider, ...parameters } = api;
+  // eslint-disable-next-line @typescript-eslint/no-deprecated
   const finalProvider = provider ?? upstash();
 
   // use upstash token if it's not set

src/client/client.ts

@@ -326,8 +326,13 @@ export class Client {
    * Access the workflow API.
    *
    * cancel workflows.
+   *
+   * @deprecated as of version 2.7.17. Will be removed in qstash-js 3.0.0.
+   * Please use @upstash/workflow instead https://github.com/upstash/workflow-js
+   * Migration Guide: https://upstash.com/docs/workflow/migration
    */
   public get workflow(): Workflow {
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     return new Workflow(this.http);
   }
 

src/client/llm/chat.test.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-deprecated */
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 /* eslint-disable @typescript-eslint/no-explicit-any */
@@ -14,7 +15,6 @@ async function checkStream(
   stream: AsyncIterable<ChatCompletionChunk>,
   expectInStream: string[] // array of strings to expect in stream
 ): Promise<void> {
-  // eslint-disable-next-line @typescript-eslint/no-deprecated
   const _stream = OpenAIStream(stream);
   const textResponse = new StreamingTextResponse(_stream);
   const text = await textResponse.text();

src/client/workflow.test.ts

@@ -24,9 +24,11 @@ describe("workflow tests", () => {
     );
     expect(result.isOk()).toBeTrue();
 
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     const cancelResult = await qstashClient.workflow.cancel(workflowRunId);
     expect(cancelResult).toBeTrue();
 
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     const throws = qstashClient.workflow.cancel(workflowRunId);
     expect(throws).rejects.toThrow(
       new QstashError(`{"error":"workflowRun ${workflowRunId} not found"}`)

src/client/workflow/index.ts

@@ -5,6 +5,11 @@ export * from "./context";
 export * from "./types";
 export * from "./logger";
 
+/**
+ * @deprecated as of version 2.7.17. Will be removed in qstash-js 3.0.0.
+ * Please use https://github.com/upstash/workflow-js
+ * Migration Guide: https://upstash.com/docs/workflow/migration
+ */
 export class Workflow {
   private readonly http;
 

src/client/workflow/integration.test.ts

@@ -118,6 +118,7 @@ const testEndpoint = async <TInitialPayload = unknown>({
 }) => {
   let counter = 0;
 
+  // eslint-disable-next-line @typescript-eslint/no-deprecated
   const endpoint = workflowServe<TInitialPayload>(routeFunction, {
     qstashClient,
     url: LOCAL_WORKFLOW_URL,

src/client/workflow/receiver.test.ts

@@ -84,6 +84,7 @@ const receiver = new Receiver({ currentSigningKey, nextSigningKey });
 /**
  * endpoint to call in the receiver tests
  */
+// eslint-disable-next-line @typescript-eslint/no-deprecated
 const endpoint = serve(
   async (context) => {
     await context.run("step 1", () => {

src/client/workflow/serve.test.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-deprecated */
 /* eslint-disable unicorn/consistent-function-scoping */
 /* eslint-disable unicorn/no-null */
 /* eslint-disable @typescript-eslint/require-await */
@@ -332,7 +333,6 @@ describe("serve", () => {
   });
 
   describe("failure settings", () => {
-    // eslint-disable-next-line unicorn/consistent-function-scoping
     const routeFunction: RouteFunction<unknown> = async (context) => {
       await context.sleep("sleep-step", 1);
     };
@@ -424,7 +424,6 @@ describe("serve", () => {
         _status,
         _header,
         _body
-        // eslint-disable-next-line unicorn/consistent-function-scoping
       ) => {
         return;
       };

src/client/workflow/serve.ts

@@ -95,6 +95,10 @@ export const processOptions = <TResponse extends Response = Response, TInitialPa
  * @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.
+ *
+ * @deprecated as of version 2.7.17. Will be removed in qstash-js 3.0.0.
+ * Please use https://github.com/upstash/workflow-js
+ * Migration Guide: https://upstash.com/docs/workflow/migration
  */
 export const serve = <
   TInitialPayload = unknown,