@vercel/queue 0.0.2 → 0.1.0

package/dist/index.mjs

@@ -1022,7 +1022,7 @@ var ApiClient = class _ApiClient {
       return;
     }
     throw new Error(
-      'No deployment ID available. VERCEL_DEPLOYMENT_ID is not set.\n\nThis usually means the code is running outside a Vercel deployment (e.g. during build or in a non-Vercel environment).\n\nTo fix this, create a new QueueClient with an explicit deploymentId:\n  new QueueClient({ region: "iad1", deploymentId: "dpl_xxx" })\nOr explicitly opt out of deployment pinning:\n  new QueueClient({ region: "iad1", deploymentId: null })'
+      'No deployment ID available. VERCEL_DEPLOYMENT_ID is not set.\n\nThis usually means the code is running outside a Vercel deployment (e.g. during build or in a non-Vercel environment).\n\nTo fix this, create a client with an explicit deploymentId:\n  new QueueClient({ deploymentId: "dpl_xxx" })\nOr explicitly opt out of deployment pinning:\n  new QueueClient({ deploymentId: null })'
     );
   }
   getSendDeploymentId() {
@@ -1080,7 +1080,7 @@ var ApiClient = class _ApiClient {
       }
       console.debug("[VQS Debug] Request:", JSON.stringify(logData, null, 2));
     }
-    init.headers.set("User-Agent", `@vercel/queue/${"0.0.2"}`);
+    init.headers.set("User-Agent", `@vercel/queue/${"0.1.0"}`);
     init.headers.set("Vqs-Client-Ts", (/* @__PURE__ */ new Date()).toISOString());
     const response = await fetch(url, init);
     if (isDebugEnabled()) {
@@ -1416,23 +1416,37 @@ var ApiClient = class _ApiClient {
 
 // src/client.ts
 var apiClients = /* @__PURE__ */ new WeakMap();
-function getApiClient(client) {
+function getApi(client) {
   const api = apiClients.get(client);
   if (!api) {
-    throw new Error("QueueClient not initialized");
+    throw new Error("Client not initialized");
   }
   return api;
 }
+function getApiClient(client) {
+  return getApi(client);
+}
+var DEFAULT_REGION = "iad1";
+function resolveRegion(region) {
+  if (region) return region;
+  const fromEnv = process.env.VERCEL_REGION;
+  if (fromEnv) return fromEnv;
+  console.warn(
+    `[QueueClient] Region not detected \u2014 defaulting to "${DEFAULT_REGION}". On Vercel this is set automatically via VERCEL_REGION. To silence this warning, pass region explicitly: new QueueClient({ region: "iad1" })`
+  );
+  return DEFAULT_REGION;
+}
 var QueueClient = class {
-  constructor(options) {
-    apiClients.set(this, new ApiClient(options));
+  constructor(options = {}) {
+    const region = resolveRegion(options.region);
+    apiClients.set(this, new ApiClient({ ...options, region }));
   }
   /**
    * Send a message to a topic.
    *
    * This is an arrow function property so it can be destructured:
    * ```typescript
-   * const { send } = new QueueClient({ region: process.env.QUEUE_REGION! });
+   * const { send } = new QueueClient();
    * await send("my-topic", payload);
    * ```
    *
@@ -1443,7 +1457,7 @@ var QueueClient = class {
    *   the message for deferred processing (no ID available yet)
    */
   send = async (topicName, payload, options) => {
-    const api = getApiClient(this);
+    const api = getApi(this);
     const result = await api.sendMessage({
       queueName: topicName,
       payload,
@@ -1462,75 +1476,6 @@ var QueueClient = class {
     }
     return { messageId: result.messageId };
   };
-  /**
-   * Receive and process messages from a topic.
-   *
-   * Each message is automatically locked, kept alive via periodic visibility
-   * extensions during processing, and acknowledged upon successful handler completion.
-   * The handler is not called when the queue is empty — check `result.ok` instead.
-   *
-   * This is an arrow function property so it can be destructured:
-   * ```typescript
-   * const { receive } = new QueueClient({ region: process.env.QUEUE_REGION! });
-   * const result = await receive("my-topic", "my-group", handler);
-   * if (!result.ok) console.log(result.reason);
-   * ```
-   *
-   * @param topicName - Name of the topic (pattern: `[A-Za-z0-9_-]+`)
-   * @param consumerGroup - Name of the consumer group (pattern: `[A-Za-z0-9_-]+`)
-   * @param handler - Function to process each message payload and metadata.
-   *                  Not called when the queue is empty.
-   * @param options - Optional receive options (visibilityTimeoutSeconds, limit, or messageId)
-   * @returns Discriminated result: `{ ok: true }` on success, `{ ok: false, reason }` otherwise
-   */
-  receive = async (topicName, consumerGroup, handler, options) => {
-    const api = getApiClient(this);
-    const topic = new Topic(api, topicName);
-    const visibilityTimeoutSeconds = options && "visibilityTimeoutSeconds" in options ? options.visibilityTimeoutSeconds : void 0;
-    const consumer = topic.consumerGroup(
-      consumerGroup,
-      visibilityTimeoutSeconds !== void 0 ? { visibilityTimeoutSeconds } : {}
-    );
-    try {
-      let count;
-      const retry = options?.retry;
-      if (options && "messageId" in options) {
-        count = await consumer.consume(handler, {
-          messageId: options.messageId,
-          retry
-        });
-      } else {
-        const limit = options && "limit" in options ? options.limit : void 0;
-        count = await consumer.consume(handler, {
-          ...limit !== void 0 ? { limit } : {},
-          retry
-        });
-      }
-      if (count === 0) {
-        return { ok: false, reason: "empty" };
-      }
-      return { ok: true };
-    } catch (error) {
-      if (options && "messageId" in options && error instanceof MessageNotFoundError) {
-        return { ok: false, reason: "not_found", messageId: options.messageId };
-      }
-      if (options && "messageId" in options && error instanceof MessageNotAvailableError) {
-        return {
-          ok: false,
-          reason: "not_available",
-          messageId: options.messageId
-        };
-      }
-      if (options && "messageId" in options && error instanceof MessageAlreadyProcessedError) {
-        return {
-          ok: false,
-          reason: "already_processed",
-          messageId: options.messageId
-        };
-      }
-      throw error;
-    }
-  };
   /**
    * Create a Web API route handler for processing queue callback messages.
    *
@@ -1539,7 +1484,7 @@ var QueueClient = class {
    *
    * This is an arrow function property so it can be destructured:
    * ```typescript
-   * const { handleCallback } = new QueueClient({ region: process.env.QUEUE_REGION! });
+   * const { handleCallback } = new QueueClient();
    * export const POST = handleCallback(handler);
    * ```
    *
@@ -1581,7 +1526,7 @@ var QueueClient = class {
    *
    * This is an arrow function property so it can be destructured:
    * ```typescript
-   * const { handleNodeCallback } = new QueueClient({ region: process.env.QUEUE_REGION! });
+   * const { handleNodeCallback } = new QueueClient();
    * app.post("/api/queue", handleNodeCallback(handler));
    * ```
    *
@@ -1617,6 +1562,107 @@ var QueueClient = class {
     };
   };
 };
+var PollingQueueClient = class {
+  constructor(options) {
+    apiClients.set(this, new ApiClient(options));
+  }
+  /**
+   * Send a message to a topic.
+   *
+   * This is an arrow function property so it can be destructured:
+   * ```typescript
+   * const { send } = new PollingQueueClient({ region: "iad1" });
+   * await send("my-topic", payload);
+   * ```
+   *
+   * @param topicName - Name of the topic (pattern: `[A-Za-z0-9_-]+`)
+   * @param payload - The data to send (serialized via the configured transport)
+   * @param options - Optional send options (idempotencyKey, retentionSeconds, delaySeconds, headers)
+   * @returns `{ messageId }` — `messageId` is `null` when the server accepted
+   *   the message for deferred processing (no ID available yet)
+   */
+  send = async (topicName, payload, options) => {
+    const api = getApi(this);
+    const result = await api.sendMessage({
+      queueName: topicName,
+      payload,
+      idempotencyKey: options?.idempotencyKey,
+      retentionSeconds: options?.retentionSeconds,
+      delaySeconds: options?.delaySeconds,
+      headers: options?.headers
+    });
+    return { messageId: result.messageId };
+  };
+  /**
+   * Receive and process messages from a topic.
+   *
+   * Each message is automatically locked, kept alive via periodic visibility
+   * extensions during processing, and acknowledged upon successful handler completion.
+   * The handler is not called when the queue is empty — check `result.ok` instead.
+   *
+   * This is an arrow function property so it can be destructured:
+   * ```typescript
+   * const { receive } = new PollingQueueClient({ region: "iad1" });
+   * const result = await receive("my-topic", "my-group", handler);
+   * if (!result.ok) console.log(result.reason);
+   * ```
+   *
+   * @param topicName - Name of the topic (pattern: `[A-Za-z0-9_-]+`)
+   * @param consumerGroup - Name of the consumer group (pattern: `[A-Za-z0-9_-]+`)
+   * @param handler - Function to process each message payload and metadata.
+   *                  Not called when the queue is empty.
+   * @param options - Optional receive options (visibilityTimeoutSeconds, limit, or messageId)
+   * @returns Discriminated result: `{ ok: true }` on success, `{ ok: false, reason }` otherwise
+   */
+  receive = async (topicName, consumerGroup, handler, options) => {
+    const api = getApi(this);
+    const topic = new Topic(api, topicName);
+    const visibilityTimeoutSeconds = options && "visibilityTimeoutSeconds" in options ? options.visibilityTimeoutSeconds : void 0;
+    const consumer = topic.consumerGroup(
+      consumerGroup,
+      visibilityTimeoutSeconds !== void 0 ? { visibilityTimeoutSeconds } : {}
+    );
+    try {
+      let count;
+      const retry = options?.retry;
+      if (options && "messageId" in options) {
+        count = await consumer.consume(handler, {
+          messageId: options.messageId,
+          retry
+        });
+      } else {
+        const limit = options && "limit" in options ? options.limit : void 0;
+        count = await consumer.consume(handler, {
+          ...limit !== void 0 ? { limit } : {},
+          retry
+        });
+      }
+      if (count === 0) {
+        return { ok: false, reason: "empty" };
+      }
+      return { ok: true };
+    } catch (error) {
+      if (options && "messageId" in options && error instanceof MessageNotFoundError) {
+        return { ok: false, reason: "not_found", messageId: options.messageId };
+      }
+      if (options && "messageId" in options && error instanceof MessageNotAvailableError) {
+        return {
+          ok: false,
+          reason: "not_available",
+          messageId: options.messageId
+        };
+      }
+      if (options && "messageId" in options && error instanceof MessageAlreadyProcessedError) {
+        return {
+          ok: false,
+          reason: "already_processed",
+          messageId: options.messageId
+        };
+      }
+      throw error;
+    }
+  };
+};
 export {
   BadRequestError,
   BufferTransport,
@@ -1634,6 +1680,7 @@ export {
   MessageLockedError,
   MessageNotAvailableError,
   MessageNotFoundError,
+  PollingQueueClient,
   QueueClient,
   QueueEmptyError,
   StreamTransport,