@vercel/queue 0.0.0-alpha.31 → 0.0.0-alpha.33

package/dist/{types-JvOenjfT.d.mts → types-Dw29Fr9y.d.mts}

@@ -50,7 +50,7 @@ declare class BufferTransport implements Transport<Buffer> {
  *
  * IMPORTANT: When using StreamTransport, you must call finalize(payload) when done
  * processing the message to prevent resource leaks, especially in error cases.
- * ConsumerGroup handles this automatically, but direct QueueClient usage requires manual cleanup.
+ * ConsumerGroup handles this automatically, but direct Client usage requires manual cleanup.
  *
  * Example usage:
  * ```typescript
@@ -77,6 +77,29 @@ declare class StreamTransport implements Transport<ReadableStream<Uint8Array>> {
  * Vercel Queue Service client types
  */
 
+interface QueueClientOptions {
+    /**
+     * Base URL for the Vercel Queue Service API
+     * Can also be set via VERCEL_QUEUE_BASE_URL environment variable
+     * @default "https://vercel-queue.com"
+     */
+    baseUrl?: string;
+    /**
+     * Base path for API endpoints
+     * Can also be set via VERCEL_QUEUE_BASE_PATH environment variable
+     * @default "/api/v2/messages"
+     */
+    basePath?: string;
+    /**
+     * Authentication token for the Vercel Queue Service API
+     * If not provided, the client will attempt to get a token via OIDC
+     */
+    token?: string;
+    /**
+     * Custom headers to include in all requests
+     */
+    headers?: Record<string, string>;
+}
 /**
  * Shared options for publishing messages
  */
@@ -143,6 +166,79 @@ interface Message<T = unknown> {
      */
     ticket: string;
 }
+interface ReceiveMessagesOptions<T = unknown> {
+    /**
+     * The queue name to receive messages from
+     */
+    queueName: string;
+    /**
+     * Consumer group name
+     */
+    consumerGroup: string;
+    /**
+     * Time in seconds that messages will be invisible to other consumers
+     * @default 900 (15 minutes)
+     */
+    visibilityTimeoutSeconds?: number;
+    /**
+     * Maximum number of messages to retrieve
+     * @default 10
+     * @max 10
+     */
+    limit?: number;
+}
+interface DeleteMessageOptions {
+    /**
+     * The queue name the message belongs to
+     */
+    queueName: string;
+    /**
+     * Consumer group name
+     */
+    consumerGroup: string;
+    /**
+     * The message ID to delete
+     */
+    messageId: string;
+    /**
+     * Ticket received from the message
+     */
+    ticket: string;
+}
+interface DeleteMessageResponse {
+    /**
+     * Whether the message was successfully deleted
+     */
+    deleted: boolean;
+}
+interface ChangeVisibilityOptions {
+    /**
+     * The queue name the message belongs to
+     */
+    queueName: string;
+    /**
+     * Consumer group name
+     */
+    consumerGroup: string;
+    /**
+     * The message ID to update
+     */
+    messageId: string;
+    /**
+     * Ticket received from the message
+     */
+    ticket: string;
+    /**
+     * New visibility timeout in seconds
+     */
+    visibilityTimeoutSeconds: number;
+}
+interface ChangeVisibilityResponse {
+    /**
+     * Whether the visibility was successfully updated
+     */
+    updated: boolean;
+}
 /**
  * Result indicating the message should be timed out for retry later
  */
@@ -190,6 +286,34 @@ interface ConsumerGroupOptions<T = unknown> {
      */
     refreshInterval?: number;
 }
+interface ReceiveMessageByIdOptions<T = unknown> {
+    /**
+     * The queue name to receive the message from
+     */
+    queueName: string;
+    /**
+     * Consumer group name
+     */
+    consumerGroup: string;
+    /**
+     * The message ID to retrieve
+     */
+    messageId: string;
+    /**
+     * Time in seconds that the message will be invisible to other consumers
+     * @default 900 (15 minutes)
+     */
+    visibilityTimeoutSeconds?: number;
+    /**
+     * Skip payload content and only return message metadata
+     * When true, the server returns a 204 status with headers containing message metadata
+     * @default false
+     */
+    skipPayload?: boolean;
+}
+interface ReceiveMessageByIdResponse<T = unknown, TSkipPayload extends boolean = false> {
+    message: TSkipPayload extends true ? Message<void> : Message<T>;
+}
 /**
  * Error thrown when a message is not found (404)
  */
@@ -253,4 +377,4 @@ declare class InvalidLimitError extends Error {
     constructor(limit: number, min?: number, max?: number);
 }
 
-export { BufferTransport as B, type ConsumerGroupOptions as C, ForbiddenError as F, InternalServerError as I, JsonTransport as J, type MessageHandler as M, type PublishOptions as P, QueueEmptyError as Q, StreamTransport as S, type Transport as T, UnauthorizedError as U, BadRequestError as a, InvalidLimitError as b, MessageCorruptedError as c, MessageLockedError as d, MessageNotAvailableError as e, MessageNotFoundError as f, type Message as g, type MessageHandlerResult as h, type MessageMetadata as i, type MessageTimeoutResult as j, type SendMessageOptions as k, type SendMessageResponse as l };
+export { BufferTransport as B, type ChangeVisibilityOptions as C, type DeleteMessageOptions as D, ForbiddenError as F, InternalServerError as I, JsonTransport as J, type Message as M, type PublishOptions as P, type QueueClientOptions as Q, type ReceiveMessagesOptions as R, type SendMessageOptions as S, type Transport as T, UnauthorizedError as U, type SendMessageResponse as a, type ReceiveMessageByIdOptions as b, type ReceiveMessageByIdResponse as c, type DeleteMessageResponse as d, type ChangeVisibilityResponse as e, type MessageHandler as f, type ConsumerGroupOptions as g, StreamTransport as h, BadRequestError as i, InvalidLimitError as j, MessageCorruptedError as k, MessageLockedError as l, MessageNotAvailableError as m, MessageNotFoundError as n, QueueEmptyError as o, type MessageHandlerResult as p, type MessageMetadata as q, type MessageTimeoutResult as r };

package/dist/{types-JvOenjfT.d.ts → types-Dw29Fr9y.d.ts}

@@ -50,7 +50,7 @@ declare class BufferTransport implements Transport<Buffer> {
  *
  * IMPORTANT: When using StreamTransport, you must call finalize(payload) when done
  * processing the message to prevent resource leaks, especially in error cases.
- * ConsumerGroup handles this automatically, but direct QueueClient usage requires manual cleanup.
+ * ConsumerGroup handles this automatically, but direct Client usage requires manual cleanup.
  *
  * Example usage:
  * ```typescript
@@ -77,6 +77,29 @@ declare class StreamTransport implements Transport<ReadableStream<Uint8Array>> {
  * Vercel Queue Service client types
  */
 
+interface QueueClientOptions {
+    /**
+     * Base URL for the Vercel Queue Service API
+     * Can also be set via VERCEL_QUEUE_BASE_URL environment variable
+     * @default "https://vercel-queue.com"
+     */
+    baseUrl?: string;
+    /**
+     * Base path for API endpoints
+     * Can also be set via VERCEL_QUEUE_BASE_PATH environment variable
+     * @default "/api/v2/messages"
+     */
+    basePath?: string;
+    /**
+     * Authentication token for the Vercel Queue Service API
+     * If not provided, the client will attempt to get a token via OIDC
+     */
+    token?: string;
+    /**
+     * Custom headers to include in all requests
+     */
+    headers?: Record<string, string>;
+}
 /**
  * Shared options for publishing messages
  */
@@ -143,6 +166,79 @@ interface Message<T = unknown> {
      */
     ticket: string;
 }
+interface ReceiveMessagesOptions<T = unknown> {
+    /**
+     * The queue name to receive messages from
+     */
+    queueName: string;
+    /**
+     * Consumer group name
+     */
+    consumerGroup: string;
+    /**
+     * Time in seconds that messages will be invisible to other consumers
+     * @default 900 (15 minutes)
+     */
+    visibilityTimeoutSeconds?: number;
+    /**
+     * Maximum number of messages to retrieve
+     * @default 10
+     * @max 10
+     */
+    limit?: number;
+}
+interface DeleteMessageOptions {
+    /**
+     * The queue name the message belongs to
+     */
+    queueName: string;
+    /**
+     * Consumer group name
+     */
+    consumerGroup: string;
+    /**
+     * The message ID to delete
+     */
+    messageId: string;
+    /**
+     * Ticket received from the message
+     */
+    ticket: string;
+}
+interface DeleteMessageResponse {
+    /**
+     * Whether the message was successfully deleted
+     */
+    deleted: boolean;
+}
+interface ChangeVisibilityOptions {
+    /**
+     * The queue name the message belongs to
+     */
+    queueName: string;
+    /**
+     * Consumer group name
+     */
+    consumerGroup: string;
+    /**
+     * The message ID to update
+     */
+    messageId: string;
+    /**
+     * Ticket received from the message
+     */
+    ticket: string;
+    /**
+     * New visibility timeout in seconds
+     */
+    visibilityTimeoutSeconds: number;
+}
+interface ChangeVisibilityResponse {
+    /**
+     * Whether the visibility was successfully updated
+     */
+    updated: boolean;
+}
 /**
  * Result indicating the message should be timed out for retry later
  */
@@ -190,6 +286,34 @@ interface ConsumerGroupOptions<T = unknown> {
      */
     refreshInterval?: number;
 }
+interface ReceiveMessageByIdOptions<T = unknown> {
+    /**
+     * The queue name to receive the message from
+     */
+    queueName: string;
+    /**
+     * Consumer group name
+     */
+    consumerGroup: string;
+    /**
+     * The message ID to retrieve
+     */
+    messageId: string;
+    /**
+     * Time in seconds that the message will be invisible to other consumers
+     * @default 900 (15 minutes)
+     */
+    visibilityTimeoutSeconds?: number;
+    /**
+     * Skip payload content and only return message metadata
+     * When true, the server returns a 204 status with headers containing message metadata
+     * @default false
+     */
+    skipPayload?: boolean;
+}
+interface ReceiveMessageByIdResponse<T = unknown, TSkipPayload extends boolean = false> {
+    message: TSkipPayload extends true ? Message<void> : Message<T>;
+}
 /**
  * Error thrown when a message is not found (404)
  */
@@ -253,4 +377,4 @@ declare class InvalidLimitError extends Error {
     constructor(limit: number, min?: number, max?: number);
 }
 
-export { BufferTransport as B, type ConsumerGroupOptions as C, ForbiddenError as F, InternalServerError as I, JsonTransport as J, type MessageHandler as M, type PublishOptions as P, QueueEmptyError as Q, StreamTransport as S, type Transport as T, UnauthorizedError as U, BadRequestError as a, InvalidLimitError as b, MessageCorruptedError as c, MessageLockedError as d, MessageNotAvailableError as e, MessageNotFoundError as f, type Message as g, type MessageHandlerResult as h, type MessageMetadata as i, type MessageTimeoutResult as j, type SendMessageOptions as k, type SendMessageResponse as l };
+export { BufferTransport as B, type ChangeVisibilityOptions as C, type DeleteMessageOptions as D, ForbiddenError as F, InternalServerError as I, JsonTransport as J, type Message as M, type PublishOptions as P, type QueueClientOptions as Q, type ReceiveMessagesOptions as R, type SendMessageOptions as S, type Transport as T, UnauthorizedError as U, type SendMessageResponse as a, type ReceiveMessageByIdOptions as b, type ReceiveMessageByIdResponse as c, type DeleteMessageResponse as d, type ChangeVisibilityResponse as e, type MessageHandler as f, type ConsumerGroupOptions as g, StreamTransport as h, BadRequestError as i, InvalidLimitError as j, MessageCorruptedError as k, MessageLockedError as l, MessageNotAvailableError as m, MessageNotFoundError as n, QueueEmptyError as o, type MessageHandlerResult as p, type MessageMetadata as q, type MessageTimeoutResult as r };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/queue",
-  "version": "0.0.0-alpha.31",
+  "version": "0.0.0-alpha.33",
   "publishConfig": {
     "access": "public"
   },