@vercel/queue 0.0.0-alpha.36 → 0.0.0-alpha.38

package/dist/nextjs-pages.d.mts

@@ -1,48 +1,68 @@
-import { f as MessageHandler } from './types-C7IKe67P.mjs';
+import { M as MessageHandler, H as HandleCallbackOptions } from './callback-lq_sorrn.mjs';
 
-type CallbackHandlers = {
-    [topicName: string]: {
-        [consumerGroup: string]: MessageHandler;
-    };
-};
+/**
+ * Next.js Pages Router wrapper for queue callback handling.
+ *
+ * Provides a `handleCallback` that returns a standard Pages Router API
+ * handler `(req, res) => Promise<void>`, compatible with `pages/api/` routes.
+ *
+ * @example
+ * ```typescript
+ * // pages/api/queue/my-topic.ts
+ * import { handleCallback } from "@vercel/queue/nextjs/pages";
+ *
+ * export default handleCallback(async (message, metadata) => {
+ *   console.log("Processing:", message);
+ * });
+ * ```
+ */
+
+/**
+ * Minimal subset of Next.js `NextApiRequest` used by this wrapper.
+ */
 interface NextApiRequest {
     method?: string;
-    url?: string;
     headers: Record<string, string | string[] | undefined>;
-    body?: any;
-    on(event: "data", listener: (chunk: Buffer) => void): void;
-    on(event: "end", listener: () => void): void;
-    on(event: "error", listener: (err: Error) => void): void;
+    body?: unknown;
 }
+/**
+ * Minimal subset of Next.js `NextApiResponse` used by this wrapper.
+ */
 interface NextApiResponse {
     status(statusCode: number): NextApiResponse;
-    setHeader(name: string, value: string): void;
-    json(data: any): void;
-    send(data: any): void;
+    json(data: unknown): void;
     end(): void;
 }
 /**
- * Queue callback handler for Next.js Pages Router
+ * Create a Next.js Pages Router API handler for processing queue callback messages.
  *
- * Automatically extracts queue information from CloudEvent format
- * and routes to the appropriate handler based on topic and consumer group.
+ * Parses `req.body` as a CloudEvent (Next.js auto-parses JSON bodies)
+ * and invokes the message handler.
+ * Non-POST requests are responded to with 200 OK (for health checks).
  *
- * @param handlers Object with topic-specific handlers organized by consumer groups
- * @returns A Next.js Pages Router handler function
+ * Response status codes:
+ * - **200** on success or non-POST requests
+ * - **400** for invalid CloudEvent payloads
+ * - **500** for unexpected processing errors
+ *
+ * @param handler - Function to process the message payload and metadata
+ * @param options - Optional configuration
+ * @param options.client - Custom QueueClient instance
+ * @param options.visibilityTimeoutSeconds - Message lock duration (default: 300, max: 3600)
+ * @returns A `(req, res) => Promise<void>` Pages Router API handler
  *
  * @example
  * ```typescript
- * // pages/api/queue.ts
  * import { handleCallback } from "@vercel/queue/nextjs/pages";
  *
- * export default handleCallback({
- *   "image-processing": {
- *     "compress": (message, metadata) => console.log("Compressing image", message),
- *     "resize": (message, metadata) => console.log("Resizing image", message),
- *   }
- * });
+ * export default handleCallback(
+ *   async (order, metadata) => {
+ *     await processOrder(order);
+ *   },
+ *   { visibilityTimeoutSeconds: 300 },
+ * );
  * ```
  */
-declare function handleCallback(handlers: CallbackHandlers): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+declare function handleCallback<T = unknown>(handler: MessageHandler<T>, options?: HandleCallbackOptions): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
 
 export { handleCallback };

package/dist/nextjs-pages.d.ts

@@ -1,48 +1,68 @@
-import { f as MessageHandler } from './types-C7IKe67P.js';
+import { M as MessageHandler, H as HandleCallbackOptions } from './callback-lq_sorrn.js';
 
-type CallbackHandlers = {
-    [topicName: string]: {
-        [consumerGroup: string]: MessageHandler;
-    };
-};
+/**
+ * Next.js Pages Router wrapper for queue callback handling.
+ *
+ * Provides a `handleCallback` that returns a standard Pages Router API
+ * handler `(req, res) => Promise<void>`, compatible with `pages/api/` routes.
+ *
+ * @example
+ * ```typescript
+ * // pages/api/queue/my-topic.ts
+ * import { handleCallback } from "@vercel/queue/nextjs/pages";
+ *
+ * export default handleCallback(async (message, metadata) => {
+ *   console.log("Processing:", message);
+ * });
+ * ```
+ */
+
+/**
+ * Minimal subset of Next.js `NextApiRequest` used by this wrapper.
+ */
 interface NextApiRequest {
     method?: string;
-    url?: string;
     headers: Record<string, string | string[] | undefined>;
-    body?: any;
-    on(event: "data", listener: (chunk: Buffer) => void): void;
-    on(event: "end", listener: () => void): void;
-    on(event: "error", listener: (err: Error) => void): void;
+    body?: unknown;
 }
+/**
+ * Minimal subset of Next.js `NextApiResponse` used by this wrapper.
+ */
 interface NextApiResponse {
     status(statusCode: number): NextApiResponse;
-    setHeader(name: string, value: string): void;
-    json(data: any): void;
-    send(data: any): void;
+    json(data: unknown): void;
     end(): void;
 }
 /**
- * Queue callback handler for Next.js Pages Router
+ * Create a Next.js Pages Router API handler for processing queue callback messages.
  *
- * Automatically extracts queue information from CloudEvent format
- * and routes to the appropriate handler based on topic and consumer group.
+ * Parses `req.body` as a CloudEvent (Next.js auto-parses JSON bodies)
+ * and invokes the message handler.
+ * Non-POST requests are responded to with 200 OK (for health checks).
  *
- * @param handlers Object with topic-specific handlers organized by consumer groups
- * @returns A Next.js Pages Router handler function
+ * Response status codes:
+ * - **200** on success or non-POST requests
+ * - **400** for invalid CloudEvent payloads
+ * - **500** for unexpected processing errors
+ *
+ * @param handler - Function to process the message payload and metadata
+ * @param options - Optional configuration
+ * @param options.client - Custom QueueClient instance
+ * @param options.visibilityTimeoutSeconds - Message lock duration (default: 300, max: 3600)
+ * @returns A `(req, res) => Promise<void>` Pages Router API handler
  *
  * @example
  * ```typescript
- * // pages/api/queue.ts
  * import { handleCallback } from "@vercel/queue/nextjs/pages";
  *
- * export default handleCallback({
- *   "image-processing": {
- *     "compress": (message, metadata) => console.log("Compressing image", message),
- *     "resize": (message, metadata) => console.log("Resizing image", message),
- *   }
- * });
+ * export default handleCallback(
+ *   async (order, metadata) => {
+ *     await processOrder(order);
+ *   },
+ *   { visibilityTimeoutSeconds: 300 },
+ * );
  * ```
  */
-declare function handleCallback(handlers: CallbackHandlers): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+declare function handleCallback<T = unknown>(handler: MessageHandler<T>, options?: HandleCallbackOptions): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
 
 export { handleCallback };