@cloudflare/workers-types 0.20221111.0 → 0.20230115.0

package/2021-11-03/index.d.ts

@@ -280,7 +280,7 @@ declare const crypto: Crypto;
 declare const caches: CacheStorage;
 declare const scheduler: Scheduler;
 declare interface ExecutionContext {
-  waitUntil(promise: void | Promise<void>): void;
+  waitUntil(promise: Promise<any>): void;
   passThroughOnException(): void;
 }
 declare type ExportedHandlerFetchHandler<Env = unknown> = (
@@ -335,13 +335,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>;
@@ -543,7 +550,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(
@@ -982,9 +989,9 @@ declare interface ResponseInit {
   encodeBody?: "automatic" | "manual";
 }
 declare type RequestInfo = Request | string | URL;
-declare class Request extends Body {
+declare class Request<CfHostMetadata = unknown> extends Body {
   constructor(input: RequestInfo, init?: RequestInit);
-  clone(): Request;
+  clone(): Request<CfHostMetadata>;
   /** Returns request's HTTP method, which is "GET" by default. */
   readonly method: string;
   /** Returns the URL of request as a string. */
@@ -996,7 +1003,7 @@ declare class Request extends Body {
   readonly fetcher: Fetcher | null;
   /** Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler. */
   readonly signal: AbortSignal;
-  readonly cf?: IncomingRequestCfProperties;
+  readonly cf?: IncomingRequestCfProperties<CfHostMetadata>;
 }
 declare interface RequestInit<
   CfType = IncomingRequestCfProperties | RequestInitCfProperties
@@ -1165,9 +1172,41 @@ 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
+  ): Promise<R2MultipartUpload>;
+  resumeMultipartUpload(key: string, uploadId: string): R2MultipartUpload;
   delete(keys: string | string[]): Promise<void>;
   list(options?: R2ListOptions): Promise<R2Objects>;
 }
+declare interface R2MultipartUpload {
+  readonly key: string;
+  readonly uploadId: string;
+  uploadPart(
+    partNumber: number,
+    value: ReadableStream | (ArrayBuffer | ArrayBufferView) | string | Blob
+  ): Promise<R2UploadedPart>;
+  abort(): Promise<void>;
+  complete(uploadedParts: R2UploadedPart[]): Promise<R2Object>;
+}
+declare interface R2UploadedPart {
+  partNumber: number;
+  etag: string;
+}
 declare abstract class R2Object {
   readonly key: string;
   readonly version: string;
@@ -1222,6 +1261,10 @@ declare interface R2PutOptions {
   sha384?: ArrayBuffer | string;
   sha512?: ArrayBuffer | string;
 }
+declare interface R2MultipartOptions {
+  httpMetadata?: R2HTTPMetadata | Headers;
+  customMetadata?: Record<string, string>;
+}
 declare interface R2Checksums {
   readonly md5?: ArrayBuffer;
   readonly sha1?: ArrayBuffer;
@@ -1340,6 +1383,7 @@ declare type ReadableStreamReadResult<R = any> =
     };
 /** This Streams API interface represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object. */
 declare interface ReadableStream<R = any> {
+  readonly locked: boolean;
   cancel(reason?: any): Promise<void>;
   getReader(): ReadableStreamDefaultReader<R>;
   getReader(options: ReadableStreamGetReaderOptions): ReadableStreamBYOBReader;
@@ -1524,6 +1568,9 @@ declare interface TraceItem {
         | TraceItemFetchEventInfo
         | TraceItemScheduledEventInfo
         | TraceItemAlarmEventInfo
+        | TraceItemQueueEventInfo
+        | TraceItemEmailEventInfo
+        | TraceItemCustomEventInfo
       )
     | null;
   readonly eventTimestamp: number | null;
@@ -1531,15 +1578,26 @@ declare interface TraceItem {
   readonly exceptions: TraceException[];
   readonly scriptName: string | null;
   readonly dispatchNamespace?: string;
+  readonly scriptTags?: string[];
   readonly outcome: string;
 }
 declare interface TraceItemAlarmEventInfo {
   readonly scheduledTime: Date;
 }
+declare interface TraceItemCustomEventInfo {}
 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;
@@ -2663,6 +2721,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;
@@ -2743,6 +2847,15 @@ declare interface MessageBatch<Body = unknown> {
    */
   retryAll(): 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.
  */
@@ -2753,4 +2866,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/2021-11-03/index.ts

@@ -282,7 +282,7 @@ export declare const crypto: Crypto;
 export declare const caches: CacheStorage;
 export declare const scheduler: Scheduler;
 export interface ExecutionContext {
-  waitUntil(promise: void | Promise<void>): void;
+  waitUntil(promise: Promise<any>): void;
   passThroughOnException(): void;
 }
 export type ExportedHandlerFetchHandler<Env = unknown> = (
@@ -337,13 +337,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>;
@@ -545,7 +552,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(
@@ -984,9 +991,9 @@ export interface ResponseInit {
   encodeBody?: "automatic" | "manual";
 }
 export type RequestInfo = Request | string | URL;
-export declare class Request extends Body {
+export declare class Request<CfHostMetadata = unknown> extends Body {
   constructor(input: RequestInfo, init?: RequestInit);
-  clone(): Request;
+  clone(): Request<CfHostMetadata>;
   /** Returns request's HTTP method, which is "GET" by default. */
   readonly method: string;
   /** Returns the URL of request as a string. */
@@ -998,7 +1005,7 @@ export declare class Request extends Body {
   readonly fetcher: Fetcher | null;
   /** Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler. */
   readonly signal: AbortSignal;
-  readonly cf?: IncomingRequestCfProperties;
+  readonly cf?: IncomingRequestCfProperties<CfHostMetadata>;
 }
 export interface RequestInit<
   CfType = IncomingRequestCfProperties | RequestInitCfProperties
@@ -1167,9 +1174,41 @@ 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
+  ): Promise<R2MultipartUpload>;
+  resumeMultipartUpload(key: string, uploadId: string): R2MultipartUpload;
   delete(keys: string | string[]): Promise<void>;
   list(options?: R2ListOptions): Promise<R2Objects>;
 }
+export interface R2MultipartUpload {
+  readonly key: string;
+  readonly uploadId: string;
+  uploadPart(
+    partNumber: number,
+    value: ReadableStream | (ArrayBuffer | ArrayBufferView) | string | Blob
+  ): Promise<R2UploadedPart>;
+  abort(): Promise<void>;
+  complete(uploadedParts: R2UploadedPart[]): Promise<R2Object>;
+}
+export interface R2UploadedPart {
+  partNumber: number;
+  etag: string;
+}
 export declare abstract class R2Object {
   readonly key: string;
   readonly version: string;
@@ -1224,6 +1263,10 @@ export interface R2PutOptions {
   sha384?: ArrayBuffer | string;
   sha512?: ArrayBuffer | string;
 }
+export interface R2MultipartOptions {
+  httpMetadata?: R2HTTPMetadata | Headers;
+  customMetadata?: Record<string, string>;
+}
 export interface R2Checksums {
   readonly md5?: ArrayBuffer;
   readonly sha1?: ArrayBuffer;
@@ -1342,6 +1385,7 @@ export type ReadableStreamReadResult<R = any> =
     };
 /** This Streams API interface represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object. */
 export interface ReadableStream<R = any> {
+  readonly locked: boolean;
   cancel(reason?: any): Promise<void>;
   getReader(): ReadableStreamDefaultReader<R>;
   getReader(options: ReadableStreamGetReaderOptions): ReadableStreamBYOBReader;
@@ -1529,6 +1573,9 @@ export interface TraceItem {
         | TraceItemFetchEventInfo
         | TraceItemScheduledEventInfo
         | TraceItemAlarmEventInfo
+        | TraceItemQueueEventInfo
+        | TraceItemEmailEventInfo
+        | TraceItemCustomEventInfo
       )
     | null;
   readonly eventTimestamp: number | null;
@@ -1536,15 +1583,26 @@ export interface TraceItem {
   readonly exceptions: TraceException[];
   readonly scriptName: string | null;
   readonly dispatchNamespace?: string;
+  readonly scriptTags?: string[];
   readonly outcome: string;
 }
 export interface TraceItemAlarmEventInfo {
   readonly scheduledTime: Date;
 }
+export interface TraceItemCustomEventInfo {}
 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;
@@ -2668,6 +2726,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;
@@ -2745,6 +2849,15 @@ export interface MessageBatch<Body = unknown> {
    */
   retryAll(): 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.
  */
@@ -2755,4 +2868,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>;
 }