@vercel/queue 0.0.1 → 0.0.2

package/README.md

@@ -332,15 +332,26 @@ export const { send, receive, handleCallback, handleNodeCallback } = queue;
 
 The client sends requests to `https://${region}.vercel-queue.com`. When `handleCallback` receives a message, it reads the `ce-vqsregion` header and routes follow-up API calls to the correct regional endpoint.
 
-To customize the URL scheme, provide a `resolveBaseUrl`:
+To customize the URL scheme, provide a `resolveBaseUrl` that returns a `URL`:
 
 ```typescript
+// Custom domain
 const queue = new QueueClient({
   region: process.env.QUEUE_REGION!,
-  resolveBaseUrl: (region) => `https://${region}.my-proxy.example`,
+  resolveBaseUrl: (region) => new URL(`https://${region}.my-proxy.example`),
+});
+
+// Custom domain with a base path (e.g. reverse proxy prefix)
+const queue = new QueueClient({
+  region: process.env.QUEUE_REGION!,
+  resolveBaseUrl: (region) =>
+    new URL(`https://my-proxy.example/queues/${region}`),
+  // → requests go to https://my-proxy.example/queues/<region>/api/v3/…
 });
 ```
 
+The SDK always appends its own API path (`/api/v3/…`) to the returned URL.
+
 ## Transports
 
 The transport controls how message payloads are serialized and deserialized.
@@ -552,7 +563,7 @@ import { QueueClient } from "@vercel/queue";
 
 const queue = new QueueClient({
   region: process.env.QUEUE_REGION!, // Required — see Quick Start for env setup
-  resolveBaseUrl: (r) => `https://${r}.vercel-queue.com`, // Default resolver
+  resolveBaseUrl: (r) => new URL(`https://${r}.vercel-queue.com`), // Default resolver
   token: "my-token", // Auto-fetched via OIDC if omitted
   headers: { "X-Custom": "value" },
   transport: new JsonTransport(), // Default: JsonTransport

package/dist/index.d.mts

@@ -130,11 +130,24 @@ declare class StreamTransport implements Transport<ReadableStream<Uint8Array>> {
  */
 type VercelRegion = "arn1" | "bom1" | "cdg1" | "cle1" | "cpt1" | "dub1" | "dxb1" | "fra1" | "gru1" | "hkg1" | "hnd1" | "iad1" | "icn1" | "kix1" | "lhr1" | "pdx1" | "sfo1" | "sin1" | "syd1" | "yul1" | (string & {});
 /**
- * Resolves a region code to a base URL for the Vercel Queue Service API.
+ * Resolves a region code to a base {@link URL} for the Vercel Queue Service API.
  *
- * Default: `` (region) => `https://${region}.vercel-queue.com` ``
+ * The SDK appends its own API path (`/api/v3/…`) to the returned URL.
+ * To add a prefix (e.g. when routing through a reverse proxy), include it
+ * in the pathname of the returned URL:
+ *
+ * ```ts
+ * // Default — domain only, no prefix:
+ * (region) => new URL(`https://${region}.vercel-queue.com`)
+ *
+ * // Custom domain with a base path:
+ * (region) => new URL(`https://my-proxy.example/custom-prefix`)
+ * // → requests go to https://my-proxy.example/custom-prefix/api/v3/…
+ * ```
+ *
+ * Default: `` (region) => new URL(`https://${region}.vercel-queue.com`) ``
  */
-type BaseUrlResolver = (region: string) => string;
+type BaseUrlResolver = (region: string) => URL;
 interface QueueClientOptions {
     /**
      * Vercel region code for API routing.
@@ -152,8 +165,16 @@ interface QueueClientOptions {
      */
     region: VercelRegion;
     /**
-     * Custom resolver that maps a region code to a base URL.
-     * @default (region) => `https://${region}.vercel-queue.com`
+     * Custom resolver that maps a region code to a base {@link URL}.
+     *
+     * The SDK always appends its own API path (`/api/v3/…`) to the returned URL.
+     * Include a pathname to add a prefix (e.g. for reverse-proxy routing):
+     *
+     * ```ts
+     * resolveBaseUrl: (region) => new URL(`https://my-proxy.example/prefix`)
+     * ```
+     *
+     * @default (region) => new URL(`https://${region}.vercel-queue.com`)
      */
     resolveBaseUrl?: BaseUrlResolver;
     /**

package/dist/index.d.ts

@@ -130,11 +130,24 @@ declare class StreamTransport implements Transport<ReadableStream<Uint8Array>> {
  */
 type VercelRegion = "arn1" | "bom1" | "cdg1" | "cle1" | "cpt1" | "dub1" | "dxb1" | "fra1" | "gru1" | "hkg1" | "hnd1" | "iad1" | "icn1" | "kix1" | "lhr1" | "pdx1" | "sfo1" | "sin1" | "syd1" | "yul1" | (string & {});
 /**
- * Resolves a region code to a base URL for the Vercel Queue Service API.
+ * Resolves a region code to a base {@link URL} for the Vercel Queue Service API.
  *
- * Default: `` (region) => `https://${region}.vercel-queue.com` ``
+ * The SDK appends its own API path (`/api/v3/…`) to the returned URL.
+ * To add a prefix (e.g. when routing through a reverse proxy), include it
+ * in the pathname of the returned URL:
+ *
+ * ```ts
+ * // Default — domain only, no prefix:
+ * (region) => new URL(`https://${region}.vercel-queue.com`)
+ *
+ * // Custom domain with a base path:
+ * (region) => new URL(`https://my-proxy.example/custom-prefix`)
+ * // → requests go to https://my-proxy.example/custom-prefix/api/v3/…
+ * ```
+ *
+ * Default: `` (region) => new URL(`https://${region}.vercel-queue.com`) ``
  */
-type BaseUrlResolver = (region: string) => string;
+type BaseUrlResolver = (region: string) => URL;
 interface QueueClientOptions {
     /**
      * Vercel region code for API routing.
@@ -152,8 +165,16 @@ interface QueueClientOptions {
      */
     region: VercelRegion;
     /**
-     * Custom resolver that maps a region code to a base URL.
-     * @default (region) => `https://${region}.vercel-queue.com`
+     * Custom resolver that maps a region code to a base {@link URL}.
+     *
+     * The SDK always appends its own API path (`/api/v3/…`) to the returned URL.
+     * Include a pathname to add a prefix (e.g. for reverse-proxy routing):
+     *
+     * ```ts
+     * resolveBaseUrl: (region) => new URL(`https://my-proxy.example/prefix`)
+     * ```
+     *
+     * @default (region) => new URL(`https://${region}.vercel-queue.com`)
      */
     resolveBaseUrl?: BaseUrlResolver;
     /**

package/dist/index.js

@@ -1021,7 +1021,7 @@ function parseQueueHeaders(headers) {
     receiptHandle
   };
 }
-var DEFAULT_BASE_URL_RESOLVER = (region) => `https://${region}.vercel-queue.com`;
+var DEFAULT_BASE_URL_RESOLVER = (region) => new URL(`https://${region}.vercel-queue.com`);
 function resolveBaseUrl(region, resolver) {
   return (resolver ?? DEFAULT_BASE_URL_RESOLVER)(region);
 }
@@ -1112,7 +1112,8 @@ var ApiClient = class _ApiClient {
     const encodedQueue = encodeURIComponent(queueName);
     const segments = pathSegments.map((s) => encodeURIComponent(s));
     const path2 = segments.length > 0 ? "/" + segments.join("/") : "";
-    return `${this.baseUrl}${BASE_PATH}/${encodedQueue}${path2}`;
+    const basePath = this.baseUrl.pathname.replace(/\/+$/, "");
+    return `${this.baseUrl.origin}${basePath}${BASE_PATH}/${encodedQueue}${path2}`;
   }
   async fetch(url, init) {
     const method = init.method || "GET";
@@ -1136,7 +1137,7 @@ var ApiClient = class _ApiClient {
       }
       console.debug("[VQS Debug] Request:", JSON.stringify(logData, null, 2));
     }
-    init.headers.set("User-Agent", `@vercel/queue/${"0.0.1"}`);
+    init.headers.set("User-Agent", `@vercel/queue/${"0.0.2"}`);
     init.headers.set("Vqs-Client-Ts", (/* @__PURE__ */ new Date()).toISOString());
     const response = await fetch(url, init);
     if (isDebugEnabled()) {