@upstash/qstash 2.9.0 → 2.9.1

package/package.json

@@ -1 +1 @@
-{"version":"v2.9.0","name":"@upstash/qstash","description":"Official Typescript client for QStash","author":"Andreas Thomas <dev@chronark.com>","license":"MIT","homepage":"https://github.com/upstash/sdk-qstash-ts#readme","repository":{"type":"git","url":"git+https://github.com/upstash/sdk-qstash-ts.git"},"bugs":{"url":"https://github.com/upstash/sdk-qstash-ts/issues"},"main":"./index.js","module":"./index.mjs","types":"./index.d.ts","files":["./*"],"exports":{".":{"import":"./index.mjs","require":"./index.js"},"./dist/nextjs":{"import":"./nextjs.mjs","require":"./nextjs.js"},"./nextjs":{"import":"./nextjs.mjs","require":"./nextjs.js"},"./h3":{"import":"./h3.mjs","require":"./h3.js"},"./nuxt":{"import":"./nuxt.mjs","require":"./nuxt.js"},"./svelte":{"import":"./svelte.mjs","require":"./svelte.js"},"./solidjs":{"import":"./solidjs.mjs","require":"./solidjs.js"},"./workflow":{"import":"./workflow.mjs","require":"./workflow.js"},"./hono":{"import":"./hono.mjs","require":"./hono.js"},"./cloudflare":{"import":"./cloudflare.mjs","require":"./cloudflare.js"}},"keywords":["qstash","queue","events","serverless","upstash"],"scripts":{"build":"tsup && cp README.md ./dist/ && cp package.json ./dist/ && cp LICENSE ./dist/","test":"bun test src","fmt":"prettier --write .","lint":"tsc && eslint \"{src,platforms}/**/*.{js,ts,tsx}\" --quiet --fix","check-exports":"bun run build && cd dist && attw -P"},"devDependencies":{"@commitlint/cli":"^19.2.2","@commitlint/config-conventional":"^19.2.2","@eslint/eslintrc":"^3.1.0","@eslint/js":"^9.10.0","@solidjs/start":"^1.0.6","@sveltejs/kit":"^2.5.18","@types/bun":"^1.1.1","@types/crypto-js":"^4.2.0","@typescript-eslint/eslint-plugin":"^8.4.0","@typescript-eslint/parser":"^8.4.0","bun-types":"^1.1.7","eslint":"^9.10.0","eslint-plugin-unicorn":"^51.0.1","h3":"^1.12.0","hono":"^4.5.8","husky":"^9.0.10","next":"^14.0.2","prettier":"^3.2.5","tsup":"latest","typescript":"^5.4.5","undici-types":"^6.16.0","vitest":"latest"},"dependencies":{"crypto-js":">=4.2.0","jose":"^5.2.3","neverthrow":"^7.0.1"}}
+{"version":"v2.9.1","name":"@upstash/qstash","description":"Official Typescript client for QStash","author":"Andreas Thomas <dev@chronark.com>","license":"MIT","homepage":"https://github.com/upstash/qstash-js#readme","repository":{"type":"git","url":"git+https://github.com/upstash/qstash-js.git"},"bugs":{"url":"https://github.com/upstash/qstash-js/issues"},"main":"./index.js","module":"./index.mjs","types":"./index.d.ts","files":["./*"],"exports":{".":{"import":"./index.mjs","require":"./index.js"},"./dist/nextjs":{"import":"./nextjs.mjs","require":"./nextjs.js"},"./nextjs":{"import":"./nextjs.mjs","require":"./nextjs.js"},"./h3":{"import":"./h3.mjs","require":"./h3.js"},"./nuxt":{"import":"./nuxt.mjs","require":"./nuxt.js"},"./svelte":{"import":"./svelte.mjs","require":"./svelte.js"},"./solidjs":{"import":"./solidjs.mjs","require":"./solidjs.js"},"./workflow":{"import":"./workflow.mjs","require":"./workflow.js"},"./hono":{"import":"./hono.mjs","require":"./hono.js"},"./cloudflare":{"import":"./cloudflare.mjs","require":"./cloudflare.js"}},"keywords":["qstash","queue","events","serverless","upstash"],"scripts":{"build":"tsup && cp README.md ./dist/ && cp package.json ./dist/ && cp LICENSE ./dist/","test":"bun test src","fmt":"prettier --write .","lint":"tsc && eslint \"{src,platforms}/**/*.{js,ts,tsx}\" --quiet --fix","check-exports":"bun run build && cd dist && attw -P"},"devDependencies":{"@commitlint/cli":"^19.2.2","@commitlint/config-conventional":"^19.2.2","@eslint/eslintrc":"^3.1.0","@eslint/js":"^9.10.0","@solidjs/start":"^1.0.6","@sveltejs/kit":"^2.5.18","@types/bun":"^1.1.1","@types/crypto-js":"^4.2.0","@typescript-eslint/eslint-plugin":"^8.4.0","@typescript-eslint/parser":"^8.4.0","bun-types":"^1.1.7","eslint":"^9.10.0","eslint-plugin-unicorn":"^51.0.1","h3":"^1.12.0","hono":"^4.5.8","husky":"^9.0.10","next":"^14.0.2","prettier":"^3.2.5","tsup":"latest","typescript":"^5.4.5","undici-types":"^6.16.0","vitest":"latest"},"dependencies":{"crypto-js":">=4.2.0","jose":"^5.2.3","neverthrow":"^7.0.1"}}

package/solidjs.d.mts

@@ -1,5 +1,5 @@
 import { APIHandler, APIEvent } from '@solidjs/start/server';
-import { a9 as RouteFunction, aa as WorkflowServeOptions } from './client-BVG9vt90.mjs';
+import { ae as RouteFunction, af as WorkflowServeOptions } from './client-jh_SomWB.mjs';
 import 'neverthrow';
 
 type VerifySignatureConfig = {

package/solidjs.d.ts

@@ -1,5 +1,5 @@
 import { APIHandler, APIEvent } from '@solidjs/start/server';
-import { a9 as RouteFunction, aa as WorkflowServeOptions } from './client-BVG9vt90.js';
+import { ae as RouteFunction, af as WorkflowServeOptions } from './client-jh_SomWB.js';
 import 'neverthrow';
 
 type VerifySignatureConfig = {

package/solidjs.js

@@ -671,6 +671,107 @@ var DLQ = class {
   }
 };
 
+// src/client/flow-control.ts
+var FlowControlApi = class {
+  http;
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * Get a single flow control by key.
+   */
+  async get(flowControlKey) {
+    return await this.http.request({
+      method: "GET",
+      path: ["v2", "flowControl", flowControlKey]
+    });
+  }
+  /**
+   * Get the global parallelism info.
+   */
+  async getGlobalParallelism() {
+    const response = await this.http.request({
+      method: "GET",
+      path: ["v2", "globalParallelism"]
+    });
+    return {
+      parallelismMax: response.parallelismMax ?? 0,
+      parallelismCount: response.parallelismCount ?? 0
+    };
+  }
+  /**
+   * Pause message delivery for a flow-control key.
+   *
+   * Messages already in the waitlist will remain there.
+   * New incoming messages will be added directly to the waitlist.
+   */
+  async pause(flowControlKey) {
+    await this.http.request({
+      method: "POST",
+      path: ["v2", "flowControl", flowControlKey, "pause"],
+      parseResponseAsJson: false
+    });
+  }
+  /**
+   * Resume message delivery for a flow-control key.
+   */
+  async resume(flowControlKey) {
+    await this.http.request({
+      method: "POST",
+      path: ["v2", "flowControl", flowControlKey, "resume"],
+      parseResponseAsJson: false
+    });
+  }
+  /**
+   * Pin a processing configuration for a flow-control key.
+   *
+   * While pinned, the system ignores configurations provided by incoming
+   * messages and uses the pinned configuration instead.
+   */
+  async pin(flowControlKey, options) {
+    await this.http.request({
+      method: "POST",
+      path: ["v2", "flowControl", flowControlKey, "pin"],
+      query: {
+        parallelism: options.parallelism,
+        rate: options.rate,
+        period: options.period
+      },
+      parseResponseAsJson: false
+    });
+  }
+  /**
+   * Remove the pinned configuration for a flow-control key.
+   *
+   * After unpinning, the system resumes updating the configuration
+   * based on incoming messages.
+   */
+  async unpin(flowControlKey, options) {
+    await this.http.request({
+      method: "POST",
+      path: ["v2", "flowControl", flowControlKey, "unpin"],
+      query: {
+        parallelism: options.parallelism,
+        rate: options.rate
+      },
+      parseResponseAsJson: false
+    });
+  }
+  /**
+   * Reset the rate configuration state for a flow-control key.
+   *
+   * Clears the current rate count and immediately ends the current period.
+   * The current timestamp becomes the start of the new rate period.
+   */
+  async resetRate(flowControlKey) {
+    await this.http.request({
+      method: "POST",
+      path: ["v2", "flowControl", flowControlKey, "resetRate"],
+      parseResponseAsJson: false
+    });
+  }
+};
+
 // src/client/http.ts
 var HttpClient = class {
   baseUrl;
@@ -2741,7 +2842,7 @@ var Workflow = class {
 };
 
 // version.ts
-var VERSION = "v2.9.0";
+var VERSION = "v2.9.1";
 
 // src/client/client.ts
 var Client = class {
@@ -2812,6 +2913,14 @@ var Client = class {
   get schedules() {
     return new Schedules(this.http);
   }
+  /**
+   * Access the flow control API.
+   *
+   * List, get, or reset flow controls.
+   */
+  get flowControl() {
+    return new FlowControlApi(this.http);
+  }
   /**
    * Access the workflow API.
    *

package/solidjs.mjs

@@ -1,8 +1,8 @@
-import "./chunk-M7SEEFAC.mjs";
+import "./chunk-KDHOB7B5.mjs";
 import {
   Receiver,
   serve
-} from "./chunk-QYBCXZKB.mjs";
+} from "./chunk-DT2X63FB.mjs";
 
 // platforms/solidjs.ts
 var verifySignatureSolidjs = (handler, config) => {

package/svelte.d.mts

@@ -1,5 +1,5 @@
 import { RequestHandler } from '@sveltejs/kit';
-import { a9 as RouteFunction, aa as WorkflowServeOptions } from './client-BVG9vt90.mjs';
+import { ae as RouteFunction, af as WorkflowServeOptions } from './client-jh_SomWB.mjs';
 import 'neverthrow';
 
 type VerifySignatureConfig = {

package/svelte.d.ts

@@ -1,5 +1,5 @@
 import { RequestHandler } from '@sveltejs/kit';
-import { a9 as RouteFunction, aa as WorkflowServeOptions } from './client-BVG9vt90.js';
+import { ae as RouteFunction, af as WorkflowServeOptions } from './client-jh_SomWB.js';
 import 'neverthrow';
 
 type VerifySignatureConfig = {

package/svelte.js

@@ -671,6 +671,107 @@ var DLQ = class {
   }
 };
 
+// src/client/flow-control.ts
+var FlowControlApi = class {
+  http;
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * Get a single flow control by key.
+   */
+  async get(flowControlKey) {
+    return await this.http.request({
+      method: "GET",
+      path: ["v2", "flowControl", flowControlKey]
+    });
+  }
+  /**
+   * Get the global parallelism info.
+   */
+  async getGlobalParallelism() {
+    const response = await this.http.request({
+      method: "GET",
+      path: ["v2", "globalParallelism"]
+    });
+    return {
+      parallelismMax: response.parallelismMax ?? 0,
+      parallelismCount: response.parallelismCount ?? 0
+    };
+  }
+  /**
+   * Pause message delivery for a flow-control key.
+   *
+   * Messages already in the waitlist will remain there.
+   * New incoming messages will be added directly to the waitlist.
+   */
+  async pause(flowControlKey) {
+    await this.http.request({
+      method: "POST",
+      path: ["v2", "flowControl", flowControlKey, "pause"],
+      parseResponseAsJson: false
+    });
+  }
+  /**
+   * Resume message delivery for a flow-control key.
+   */
+  async resume(flowControlKey) {
+    await this.http.request({
+      method: "POST",
+      path: ["v2", "flowControl", flowControlKey, "resume"],
+      parseResponseAsJson: false
+    });
+  }
+  /**
+   * Pin a processing configuration for a flow-control key.
+   *
+   * While pinned, the system ignores configurations provided by incoming
+   * messages and uses the pinned configuration instead.
+   */
+  async pin(flowControlKey, options) {
+    await this.http.request({
+      method: "POST",
+      path: ["v2", "flowControl", flowControlKey, "pin"],
+      query: {
+        parallelism: options.parallelism,
+        rate: options.rate,
+        period: options.period
+      },
+      parseResponseAsJson: false
+    });
+  }
+  /**
+   * Remove the pinned configuration for a flow-control key.
+   *
+   * After unpinning, the system resumes updating the configuration
+   * based on incoming messages.
+   */
+  async unpin(flowControlKey, options) {
+    await this.http.request({
+      method: "POST",
+      path: ["v2", "flowControl", flowControlKey, "unpin"],
+      query: {
+        parallelism: options.parallelism,
+        rate: options.rate
+      },
+      parseResponseAsJson: false
+    });
+  }
+  /**
+   * Reset the rate configuration state for a flow-control key.
+   *
+   * Clears the current rate count and immediately ends the current period.
+   * The current timestamp becomes the start of the new rate period.
+   */
+  async resetRate(flowControlKey) {
+    await this.http.request({
+      method: "POST",
+      path: ["v2", "flowControl", flowControlKey, "resetRate"],
+      parseResponseAsJson: false
+    });
+  }
+};
+
 // src/client/http.ts
 var HttpClient = class {
   baseUrl;
@@ -2741,7 +2842,7 @@ var Workflow = class {
 };
 
 // version.ts
-var VERSION = "v2.9.0";
+var VERSION = "v2.9.1";
 
 // src/client/client.ts
 var Client = class {
@@ -2812,6 +2913,14 @@ var Client = class {
   get schedules() {
     return new Schedules(this.http);
   }
+  /**
+   * Access the flow control API.
+   *
+   * List, get, or reset flow controls.
+   */
+  get flowControl() {
+    return new FlowControlApi(this.http);
+  }
   /**
    * Access the workflow API.
    *

package/svelte.mjs

@@ -1,8 +1,8 @@
-import "./chunk-M7SEEFAC.mjs";
+import "./chunk-KDHOB7B5.mjs";
 import {
   Receiver,
   serve
-} from "./chunk-QYBCXZKB.mjs";
+} from "./chunk-DT2X63FB.mjs";
 
 // platforms/svelte.ts
 var verifySignatureSvelte = (handler, config) => {

package/workflow.d.mts

@@ -1,2 +1,2 @@
-export { am as AsyncStepFunction, af as DisabledWorkflowContext, F as FailureFunctionPayload, ap as FinishCondition, ar as LogLevel, ao as ParallelCallState, ak as RawStep, aq as RequiredExceptFields, a9 as RouteFunction, S as Step, an as StepFunction, aj as StepType, ai as StepTypes, al as SyncStepFunction, ab as Workflow, ag as WorkflowClient, ae as WorkflowContext, at as WorkflowLogger, as as WorkflowLoggerOptions, ah as WorkflowReceiver, aa as WorkflowServeOptions, ac as processOptions, ad as serve } from './client-BVG9vt90.mjs';
+export { ar as AsyncStepFunction, ak as DisabledWorkflowContext, F as FailureFunctionPayload, au as FinishCondition, aw as LogLevel, at as ParallelCallState, ap as RawStep, av as RequiredExceptFields, ae as RouteFunction, S as Step, as as StepFunction, ao as StepType, an as StepTypes, aq as SyncStepFunction, ag as Workflow, al as WorkflowClient, aj as WorkflowContext, ay as WorkflowLogger, ax as WorkflowLoggerOptions, am as WorkflowReceiver, af as WorkflowServeOptions, ah as processOptions, ai as serve } from './client-jh_SomWB.mjs';
 import 'neverthrow';

package/workflow.d.ts

@@ -1,2 +1,2 @@
-export { am as AsyncStepFunction, af as DisabledWorkflowContext, F as FailureFunctionPayload, ap as FinishCondition, ar as LogLevel, ao as ParallelCallState, ak as RawStep, aq as RequiredExceptFields, a9 as RouteFunction, S as Step, an as StepFunction, aj as StepType, ai as StepTypes, al as SyncStepFunction, ab as Workflow, ag as WorkflowClient, ae as WorkflowContext, at as WorkflowLogger, as as WorkflowLoggerOptions, ah as WorkflowReceiver, aa as WorkflowServeOptions, ac as processOptions, ad as serve } from './client-BVG9vt90.js';
+export { ar as AsyncStepFunction, ak as DisabledWorkflowContext, F as FailureFunctionPayload, au as FinishCondition, aw as LogLevel, at as ParallelCallState, ap as RawStep, av as RequiredExceptFields, ae as RouteFunction, S as Step, as as StepFunction, ao as StepType, an as StepTypes, aq as SyncStepFunction, ag as Workflow, al as WorkflowClient, aj as WorkflowContext, ay as WorkflowLogger, ax as WorkflowLoggerOptions, am as WorkflowReceiver, af as WorkflowServeOptions, ah as processOptions, ai as serve } from './client-jh_SomWB.js';
 import 'neverthrow';

package/workflow.js

@@ -676,6 +676,107 @@ var DLQ = class {
   }
 };
 
+// src/client/flow-control.ts
+var FlowControlApi = class {
+  http;
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * Get a single flow control by key.
+   */
+  async get(flowControlKey) {
+    return await this.http.request({
+      method: "GET",
+      path: ["v2", "flowControl", flowControlKey]
+    });
+  }
+  /**
+   * Get the global parallelism info.
+   */
+  async getGlobalParallelism() {
+    const response = await this.http.request({
+      method: "GET",
+      path: ["v2", "globalParallelism"]
+    });
+    return {
+      parallelismMax: response.parallelismMax ?? 0,
+      parallelismCount: response.parallelismCount ?? 0
+    };
+  }
+  /**
+   * Pause message delivery for a flow-control key.
+   *
+   * Messages already in the waitlist will remain there.
+   * New incoming messages will be added directly to the waitlist.
+   */
+  async pause(flowControlKey) {
+    await this.http.request({
+      method: "POST",
+      path: ["v2", "flowControl", flowControlKey, "pause"],
+      parseResponseAsJson: false
+    });
+  }
+  /**
+   * Resume message delivery for a flow-control key.
+   */
+  async resume(flowControlKey) {
+    await this.http.request({
+      method: "POST",
+      path: ["v2", "flowControl", flowControlKey, "resume"],
+      parseResponseAsJson: false
+    });
+  }
+  /**
+   * Pin a processing configuration for a flow-control key.
+   *
+   * While pinned, the system ignores configurations provided by incoming
+   * messages and uses the pinned configuration instead.
+   */
+  async pin(flowControlKey, options) {
+    await this.http.request({
+      method: "POST",
+      path: ["v2", "flowControl", flowControlKey, "pin"],
+      query: {
+        parallelism: options.parallelism,
+        rate: options.rate,
+        period: options.period
+      },
+      parseResponseAsJson: false
+    });
+  }
+  /**
+   * Remove the pinned configuration for a flow-control key.
+   *
+   * After unpinning, the system resumes updating the configuration
+   * based on incoming messages.
+   */
+  async unpin(flowControlKey, options) {
+    await this.http.request({
+      method: "POST",
+      path: ["v2", "flowControl", flowControlKey, "unpin"],
+      query: {
+        parallelism: options.parallelism,
+        rate: options.rate
+      },
+      parseResponseAsJson: false
+    });
+  }
+  /**
+   * Reset the rate configuration state for a flow-control key.
+   *
+   * Clears the current rate count and immediately ends the current period.
+   * The current timestamp becomes the start of the new rate period.
+   */
+  async resetRate(flowControlKey) {
+    await this.http.request({
+      method: "POST",
+      path: ["v2", "flowControl", flowControlKey, "resetRate"],
+      parseResponseAsJson: false
+    });
+  }
+};
+
 // src/client/http.ts
 var HttpClient = class {
   baseUrl;
@@ -1360,7 +1461,7 @@ var UrlGroups = class {
 };
 
 // version.ts
-var VERSION = "v2.9.0";
+var VERSION = "v2.9.1";
 
 // src/client/client.ts
 var Client = class {
@@ -1431,6 +1532,14 @@ var Client = class {
   get schedules() {
     return new Schedules(this.http);
   }
+  /**
+   * Access the flow control API.
+   *
+   * List, get, or reset flow controls.
+   */
+  get flowControl() {
+    return new FlowControlApi(this.http);
+  }
   /**
    * Access the workflow API.
    *

package/workflow.mjs

@@ -6,7 +6,7 @@ import {
   WorkflowLogger,
   processOptions,
   serve
-} from "./chunk-QYBCXZKB.mjs";
+} from "./chunk-DT2X63FB.mjs";
 export {
   DisabledWorkflowContext,
   StepTypes,