@cloudflare/workers-types 4.20221111.1 → 4.20230214.0

package/2022-03-21/index.d.ts

@@ -229,7 +229,6 @@ declare interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   FixedLengthStream: typeof FixedLengthStream;
   IdentityTransformStream: typeof IdentityTransformStream;
   HTMLRewriter: typeof HTMLRewriter;
-  connect(address: string, options?: SocketOptions): Socket;
 }
 declare function addEventListener<Type extends keyof WorkerGlobalScopeEventMap>(
   type: Type,
@@ -283,9 +282,8 @@ declare const crypto: Crypto;
 declare const caches: CacheStorage;
 declare const scheduler: Scheduler;
 declare const navigator: Navigator;
-declare function connect(address: string, options?: SocketOptions): Socket;
 declare interface ExecutionContext {
-  waitUntil(promise: void | Promise<void>): void;
+  waitUntil(promise: Promise<any>): void;
   passThroughOnException(): void;
 }
 declare type ExportedHandlerFetchHandler<Env = unknown> = (
@@ -343,13 +341,20 @@ declare interface DurableObjectNamespace {
   ): DurableObjectId;
   idFromName(name: string): DurableObjectId;
   idFromString(id: string): DurableObjectId;
-  get(id: DurableObjectId): DurableObjectStub;
+  get(
+    id: DurableObjectId,
+    options?: DurableObjectNamespaceGetDurableObjectOptions
+  ): DurableObjectStub;
+  jurisdiction(jurisdiction: string): DurableObjectNamespace;
 }
 declare interface DurableObjectNamespaceNewUniqueIdOptions {
   jurisdiction?: string;
 }
+declare interface DurableObjectNamespaceGetDurableObjectOptions {
+  locationHint?: string;
+}
 declare interface DurableObjectState {
-  waitUntil(promise: void | Promise<void>): void;
+  waitUntil(promise: Promise<any>): void;
   readonly id: DurableObjectId;
   readonly storage: DurableObjectStorage;
   blockConcurrencyWhile<T>(callback: () => Promise<T>): Promise<T>;
@@ -539,7 +544,7 @@ declare interface SchedulerWaitOptions {
   signal?: AbortSignal;
 }
 declare abstract class ExtendableEvent extends Event {
-  waitUntil(promise: void | Promise<void>): void;
+  waitUntil(promise: Promise<any>): void;
 }
 declare class Blob {
   constructor(
@@ -987,6 +992,8 @@ declare class Request<CfHostMetadata = unknown> extends Body {
   get fetcher(): Fetcher | null;
   get signal(): AbortSignal;
   get cf(): IncomingRequestCfProperties<CfHostMetadata> | undefined;
+  get integrity(): string;
+  get keepalive(): boolean;
 }
 declare interface RequestInit<
   CfType = IncomingRequestCfProperties | RequestInitCfProperties
@@ -1001,6 +1008,8 @@ declare interface RequestInit<
   redirect?: string;
   fetcher?: Fetcher | null;
   cf?: CfType;
+  /** A cryptographic hash of the resource to be fetched by request. Sets request's integrity. */
+  integrity?: string;
   /** An AbortSignal to set request's signal. */
   signal?: AbortSignal | null;
 }
@@ -1009,7 +1018,6 @@ declare abstract class Fetcher {
     input: RequestInfo,
     init?: RequestInit<RequestInitCfProperties>
   ): Promise<Response>;
-  connect(address: string, options?: SocketOptions): Socket;
 }
 declare interface FetcherPutOptions {
   expiration?: number;
@@ -1053,11 +1061,11 @@ declare interface KVNamespace<Key extends string = string> {
   get(
     key: Key,
     options?: KVNamespaceGetOptions<"arrayBuffer">
-  ): Promise<string | null>;
+  ): Promise<ArrayBuffer | null>;
   get(
     key: Key,
     options?: KVNamespaceGetOptions<"stream">
-  ): Promise<string | null>;
+  ): Promise<ReadableStream | null>;
   list<Metadata = unknown>(
     options?: KVNamespaceListOptions
   ): Promise<KVNamespaceListResult<Metadata, Key>>;
@@ -1156,6 +1164,19 @@ declare abstract class R2Bucket {
       | Blob,
     options?: R2PutOptions
   ): Promise<R2Object>;
+  put(
+    key: string,
+    value:
+      | ReadableStream
+      | ArrayBuffer
+      | ArrayBufferView
+      | string
+      | null
+      | Blob,
+    options?: R2PutOptions & {
+      onlyIf: R2Conditional | Headers;
+    }
+  ): Promise<R2Object | null>;
   createMultipartUpload(
     key: string,
     options?: R2MultipartOptions
@@ -1539,6 +1560,8 @@ declare interface TraceItem {
         | TraceItemFetchEventInfo
         | TraceItemScheduledEventInfo
         | TraceItemAlarmEventInfo
+        | TraceItemQueueEventInfo
+        | TraceItemEmailEventInfo
         | TraceItemCustomEventInfo
       )
     | null;
@@ -1547,6 +1570,7 @@ declare interface TraceItem {
   readonly exceptions: TraceException[];
   readonly scriptName: string | null;
   readonly dispatchNamespace?: string;
+  readonly scriptTags?: string[];
   readonly outcome: string;
 }
 declare interface TraceItemAlarmEventInfo {
@@ -1557,6 +1581,15 @@ declare interface TraceItemScheduledEventInfo {
   readonly scheduledTime: number;
   readonly cron: string;
 }
+declare interface TraceItemQueueEventInfo {
+  readonly queue: string;
+  readonly batchSize: number;
+}
+declare interface TraceItemEmailEventInfo {
+  readonly mailFrom: string;
+  readonly rcptTo: string;
+  readonly rawSize: number;
+}
 declare interface TraceItemFetchEventInfo {
   readonly response?: TraceItemFetchEventInfoResponse;
   readonly request: TraceItemFetchEventInfoRequest;
@@ -1742,15 +1775,6 @@ declare const WebSocketPair: {
     1: WebSocket;
   };
 };
-declare interface Socket {
-  readonly readable: ReadableStream;
-  readonly writable: WritableStream;
-  readonly closed: Promise<void>;
-  close(): Promise<void>;
-}
-declare interface SocketOptions {
-  tsl: boolean;
-}
 declare interface BasicImageTransformations {
   /**
    * Maximum width in image pixels. The value must be an integer.
@@ -2695,6 +2719,52 @@ declare abstract class D1PreparedStatement {
   all<T = unknown>(): Promise<D1Result<T>>;
   raw<T = unknown>(): Promise<T[]>;
 }
+/**
+ * A email message that is sent to a consumer Worker.
+ */
+declare interface EmailMessage<Body = unknown> {
+  /**
+   * Envelope From attribute of the email message.
+   */
+  readonly from: string;
+  /**
+   * Envelope To attribute of the email message.
+   */
+  readonly to: string;
+  /**
+   * A [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers).
+   */
+  readonly headers: Headers;
+  /**
+   * Stream of the email message content.
+   */
+  readonly raw: ReadableStream;
+  /**
+   * Size of the email message content.
+   */
+  readonly rawSize: number;
+  /**
+   * Reject this email message by returning a permanent SMTP error back to the connecting client including the given reason.
+   * @param reason The reject reason.
+   * @returns void
+   */
+  setReject(reason: string): void;
+  /**
+   * Forward this email message to a verified destination address of the account.
+   * @param rcptTo Verified destination address.
+   * @param headers A [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers).
+   * @returns A promise that resolves when the email message is forwarded.
+   */
+  forward(rcptTo: string, headers?: Headers): Promise<void>;
+}
+declare abstract class EmailEvent extends ExtendableEvent {
+  readonly message: EmailMessage;
+}
+declare type EmailExportedHandler<Env = unknown> = (
+  message: EmailMessage,
+  env: Env,
+  ctx: ExecutionContext
+) => void | Promise<void>;
 declare type Params<P extends string = any> = Record<P, string | string[]>;
 declare type EventContext<Env, P extends string, Data> = {
   request: Request;
@@ -2741,6 +2811,40 @@ declare type PagesPluginFunction<
 declare module "assets:*" {
   export const onRequest: PagesFunction;
 }
+// https://developers.cloudflare.com/pub-sub/
+// PubSubMessage represents an incoming PubSub message.
+// The message includes metadata about the broker, the client, and the payload
+// itself.
+declare interface PubSubMessage {
+  // Message ID
+  readonly mid: number;
+  // MQTT broker FQDN in the form mqtts://BROKER.NAMESPACE.cloudflarepubsub.com:PORT
+  readonly broker: string;
+  // The MQTT topic the message was sent on.
+  readonly topic: string;
+  // The client ID of the client that published this message.
+  readonly clientId: string;
+  // The unique identifier (JWT ID) used by the client to authenticate, if token
+  // auth was used.
+  readonly jti?: string;
+  // A Unix timestamp (seconds from Jan 1, 1970), set when the Pub/Sub Broker
+  // received the message from the client.
+  readonly receivedAt: number;
+  // An (optional) string with the MIME type of the payload, if set by the
+  // client.
+  readonly contentType: string;
+  // Set to 1 when the payload is a UTF-8 string
+  // https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901063
+  readonly payloadFormatIndicator: number;
+  // Pub/Sub (MQTT) payloads can be UTF-8 strings, or byte arrays.
+  // You can use payloadFormatIndicator to inspect this before decoding.
+  payload: string | Uint8Array;
+}
+// JsonWebKey extended by kid parameter
+declare interface JsonWebKeyWithKid extends JsonWebKey {
+  // Key Identifier of the JWK
+  readonly kid: string;
+}
 /**
  * A message that is sent to a consumer Worker.
  */
@@ -2757,6 +2861,14 @@ declare interface Message<Body = unknown> {
    * The body of the message.
    */
   readonly body: Body;
+  /**
+   * Marks message to be retried.
+   */
+  retry(): void;
+  /**
+   * Marks message acknowledged.
+   */
+  ack(): void;
 }
 /**
  * A batch of messages that are sent to a consumer Worker.
@@ -2774,7 +2886,20 @@ declare interface MessageBatch<Body = unknown> {
    * Marks every message to be retried in the next batch.
    */
   retryAll(): void;
+  /**
+   * Marks every message acknowledged in the batch.
+   */
+  ackAll(): void;
 }
+/**
+ * A wrapper class used to structure message batches.
+ */
+declare type MessageSendRequest<Body = unknown> = {
+  /**
+   * The body of the message.
+   */
+  body: Body;
+};
 /**
  * A binding that allows a producer to send messages to a Queue.
  */
@@ -2785,4 +2910,10 @@ declare interface Queue<Body = any> {
    * @returns A promise that resolves when the message is confirmed to be written to disk.
    */
   send(message: Body): Promise<void>;
+  /**
+   * Sends a batch of messages to the Queue.
+   * @param messages Each item in the input must be supported by the [structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm#supported_types). A batch can contain up to 100 messages, though items are limited to 128 KB each, and the total size of the array cannot exceed 256 KB.
+   * @returns A promise that resolves when the messages are confirmed to be written to disk.
+   */
+  sendBatch(messages: Iterable<MessageSendRequest<Body>>): Promise<void>;
 }

package/2022-03-21/index.ts

@@ -229,7 +229,6 @@ export interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   FixedLengthStream: typeof FixedLengthStream;
   IdentityTransformStream: typeof IdentityTransformStream;
   HTMLRewriter: typeof HTMLRewriter;
-  connect(address: string, options?: SocketOptions): Socket;
 }
 export declare function addEventListener<
   Type extends keyof WorkerGlobalScopeEventMap
@@ -285,12 +284,8 @@ export declare const crypto: Crypto;
 export declare const caches: CacheStorage;
 export declare const scheduler: Scheduler;
 export declare const navigator: Navigator;
-export declare function connect(
-  address: string,
-  options?: SocketOptions
-): Socket;
 export interface ExecutionContext {
-  waitUntil(promise: void | Promise<void>): void;
+  waitUntil(promise: Promise<any>): void;
   passThroughOnException(): void;
 }
 export type ExportedHandlerFetchHandler<Env = unknown> = (
@@ -348,13 +343,20 @@ export interface DurableObjectNamespace {
   ): DurableObjectId;
   idFromName(name: string): DurableObjectId;
   idFromString(id: string): DurableObjectId;
-  get(id: DurableObjectId): DurableObjectStub;
+  get(
+    id: DurableObjectId,
+    options?: DurableObjectNamespaceGetDurableObjectOptions
+  ): DurableObjectStub;
+  jurisdiction(jurisdiction: string): DurableObjectNamespace;
 }
 export interface DurableObjectNamespaceNewUniqueIdOptions {
   jurisdiction?: string;
 }
+export interface DurableObjectNamespaceGetDurableObjectOptions {
+  locationHint?: string;
+}
 export interface DurableObjectState {
-  waitUntil(promise: void | Promise<void>): void;
+  waitUntil(promise: Promise<any>): void;
   readonly id: DurableObjectId;
   readonly storage: DurableObjectStorage;
   blockConcurrencyWhile<T>(callback: () => Promise<T>): Promise<T>;
@@ -544,7 +546,7 @@ export interface SchedulerWaitOptions {
   signal?: AbortSignal;
 }
 export declare abstract class ExtendableEvent extends Event {
-  waitUntil(promise: void | Promise<void>): void;
+  waitUntil(promise: Promise<any>): void;
 }
 export declare class Blob {
   constructor(
@@ -992,6 +994,8 @@ export declare class Request<CfHostMetadata = unknown> extends Body {
   get fetcher(): Fetcher | null;
   get signal(): AbortSignal;
   get cf(): IncomingRequestCfProperties<CfHostMetadata> | undefined;
+  get integrity(): string;
+  get keepalive(): boolean;
 }
 export interface RequestInit<
   CfType = IncomingRequestCfProperties | RequestInitCfProperties
@@ -1006,6 +1010,8 @@ export interface RequestInit<
   redirect?: string;
   fetcher?: Fetcher | null;
   cf?: CfType;
+  /** A cryptographic hash of the resource to be fetched by request. Sets request's integrity. */
+  integrity?: string;
   /** An AbortSignal to set request's signal. */
   signal?: AbortSignal | null;
 }
@@ -1014,7 +1020,6 @@ export declare abstract class Fetcher {
     input: RequestInfo,
     init?: RequestInit<RequestInitCfProperties>
   ): Promise<Response>;
-  connect(address: string, options?: SocketOptions): Socket;
 }
 export interface FetcherPutOptions {
   expiration?: number;
@@ -1058,11 +1063,11 @@ export interface KVNamespace<Key extends string = string> {
   get(
     key: Key,
     options?: KVNamespaceGetOptions<"arrayBuffer">
-  ): Promise<string | null>;
+  ): Promise<ArrayBuffer | null>;
   get(
     key: Key,
     options?: KVNamespaceGetOptions<"stream">
-  ): Promise<string | null>;
+  ): Promise<ReadableStream | null>;
   list<Metadata = unknown>(
     options?: KVNamespaceListOptions
   ): Promise<KVNamespaceListResult<Metadata, Key>>;
@@ -1161,6 +1166,19 @@ export declare abstract class R2Bucket {
       | Blob,
     options?: R2PutOptions
   ): Promise<R2Object>;
+  put(
+    key: string,
+    value:
+      | ReadableStream
+      | ArrayBuffer
+      | ArrayBufferView
+      | string
+      | null
+      | Blob,
+    options?: R2PutOptions & {
+      onlyIf: R2Conditional | Headers;
+    }
+  ): Promise<R2Object | null>;
   createMultipartUpload(
     key: string,
     options?: R2MultipartOptions
@@ -1547,6 +1565,8 @@ export interface TraceItem {
         | TraceItemFetchEventInfo
         | TraceItemScheduledEventInfo
         | TraceItemAlarmEventInfo
+        | TraceItemQueueEventInfo
+        | TraceItemEmailEventInfo
         | TraceItemCustomEventInfo
       )
     | null;
@@ -1555,6 +1575,7 @@ export interface TraceItem {
   readonly exceptions: TraceException[];
   readonly scriptName: string | null;
   readonly dispatchNamespace?: string;
+  readonly scriptTags?: string[];
   readonly outcome: string;
 }
 export interface TraceItemAlarmEventInfo {
@@ -1565,6 +1586,15 @@ export interface TraceItemScheduledEventInfo {
   readonly scheduledTime: number;
   readonly cron: string;
 }
+export interface TraceItemQueueEventInfo {
+  readonly queue: string;
+  readonly batchSize: number;
+}
+export interface TraceItemEmailEventInfo {
+  readonly mailFrom: string;
+  readonly rcptTo: string;
+  readonly rawSize: number;
+}
 export interface TraceItemFetchEventInfo {
   readonly response?: TraceItemFetchEventInfoResponse;
   readonly request: TraceItemFetchEventInfoRequest;
@@ -1750,15 +1780,6 @@ export declare const WebSocketPair: {
     1: WebSocket;
   };
 };
-export interface Socket {
-  readonly readable: ReadableStream;
-  readonly writable: WritableStream;
-  readonly closed: Promise<void>;
-  close(): Promise<void>;
-}
-export interface SocketOptions {
-  tsl: boolean;
-}
 export interface BasicImageTransformations {
   /**
    * Maximum width in image pixels. The value must be an integer.
@@ -2703,6 +2724,52 @@ export declare abstract class D1PreparedStatement {
   all<T = unknown>(): Promise<D1Result<T>>;
   raw<T = unknown>(): Promise<T[]>;
 }
+/**
+ * A email message that is sent to a consumer Worker.
+ */
+export interface EmailMessage<Body = unknown> {
+  /**
+   * Envelope From attribute of the email message.
+   */
+  readonly from: string;
+  /**
+   * Envelope To attribute of the email message.
+   */
+  readonly to: string;
+  /**
+   * A [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers).
+   */
+  readonly headers: Headers;
+  /**
+   * Stream of the email message content.
+   */
+  readonly raw: ReadableStream;
+  /**
+   * Size of the email message content.
+   */
+  readonly rawSize: number;
+  /**
+   * Reject this email message by returning a permanent SMTP error back to the connecting client including the given reason.
+   * @param reason The reject reason.
+   * @returns void
+   */
+  setReject(reason: string): void;
+  /**
+   * Forward this email message to a verified destination address of the account.
+   * @param rcptTo Verified destination address.
+   * @param headers A [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers).
+   * @returns A promise that resolves when the email message is forwarded.
+   */
+  forward(rcptTo: string, headers?: Headers): Promise<void>;
+}
+export declare abstract class EmailEvent extends ExtendableEvent {
+  readonly message: EmailMessage;
+}
+export type EmailExportedHandler<Env = unknown> = (
+  message: EmailMessage,
+  env: Env,
+  ctx: ExecutionContext
+) => void | Promise<void>;
 export type Params<P extends string = any> = Record<P, string | string[]>;
 export type EventContext<Env, P extends string, Data> = {
   request: Request;
@@ -2746,6 +2813,40 @@ export type PagesPluginFunction<
 > = (
   context: EventPluginContext<Env, Params, Data, PluginArgs>
 ) => Response | Promise<Response>;
+// https://developers.cloudflare.com/pub-sub/
+// PubSubMessage represents an incoming PubSub message.
+// The message includes metadata about the broker, the client, and the payload
+// itself.
+export interface PubSubMessage {
+  // Message ID
+  readonly mid: number;
+  // MQTT broker FQDN in the form mqtts://BROKER.NAMESPACE.cloudflarepubsub.com:PORT
+  readonly broker: string;
+  // The MQTT topic the message was sent on.
+  readonly topic: string;
+  // The client ID of the client that published this message.
+  readonly clientId: string;
+  // The unique identifier (JWT ID) used by the client to authenticate, if token
+  // auth was used.
+  readonly jti?: string;
+  // A Unix timestamp (seconds from Jan 1, 1970), set when the Pub/Sub Broker
+  // received the message from the client.
+  readonly receivedAt: number;
+  // An (optional) string with the MIME type of the payload, if set by the
+  // client.
+  readonly contentType: string;
+  // Set to 1 when the payload is a UTF-8 string
+  // https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901063
+  readonly payloadFormatIndicator: number;
+  // Pub/Sub (MQTT) payloads can be UTF-8 strings, or byte arrays.
+  // You can use payloadFormatIndicator to inspect this before decoding.
+  payload: string | Uint8Array;
+}
+// JsonWebKey extended by kid parameter
+export interface JsonWebKeyWithKid extends JsonWebKey {
+  // Key Identifier of the JWK
+  readonly kid: string;
+}
 /**
  * A message that is sent to a consumer Worker.
  */
@@ -2762,6 +2863,14 @@ export interface Message<Body = unknown> {
    * The body of the message.
    */
   readonly body: Body;
+  /**
+   * Marks message to be retried.
+   */
+  retry(): void;
+  /**
+   * Marks message acknowledged.
+   */
+  ack(): void;
 }
 /**
  * A batch of messages that are sent to a consumer Worker.
@@ -2779,7 +2888,20 @@ export interface MessageBatch<Body = unknown> {
    * Marks every message to be retried in the next batch.
    */
   retryAll(): void;
+  /**
+   * Marks every message acknowledged in the batch.
+   */
+  ackAll(): void;
 }
+/**
+ * A wrapper class used to structure message batches.
+ */
+export type MessageSendRequest<Body = unknown> = {
+  /**
+   * The body of the message.
+   */
+  body: Body;
+};
 /**
  * A binding that allows a producer to send messages to a Queue.
  */
@@ -2790,4 +2912,10 @@ export interface Queue<Body = any> {
    * @returns A promise that resolves when the message is confirmed to be written to disk.
    */
   send(message: Body): Promise<void>;
+  /**
+   * Sends a batch of messages to the Queue.
+   * @param messages Each item in the input must be supported by the [structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm#supported_types). A batch can contain up to 100 messages, though items are limited to 128 KB each, and the total size of the array cannot exceed 256 KB.
+   * @returns A promise that resolves when the messages are confirmed to be written to disk.
+   */
+  sendBatch(messages: Iterable<MessageSendRequest<Body>>): Promise<void>;
 }