@cloudflare/workers-types 0.20230307.0 → 0.20230404.0

package/2022-11-30/index.d.ts

@@ -49,6 +49,7 @@ declare class DOMException extends Error {
 declare type WorkerGlobalScopeEventMap = {
   fetch: FetchEvent;
   scheduled: ScheduledEvent;
+  queue: QueueEvent;
   unhandledrejection: PromiseRejectionEvent;
   rejectionhandled: PromiseRejectionEvent;
 };
@@ -291,8 +292,11 @@ declare interface ExecutionContext {
   waitUntil(promise: Promise<any>): void;
   passThroughOnException(): void;
 }
-declare type ExportedHandlerFetchHandler<Env = unknown> = (
-  request: Request,
+declare type ExportedHandlerFetchHandler<
+  Env = unknown,
+  CfHostMetadata = unknown
+> = (
+  request: Request<CfHostMetadata, IncomingRequestCfProperties<CfHostMetadata>>,
   env: Env,
   ctx: ExecutionContext
 ) => Response | Promise<Response>;
@@ -316,12 +320,16 @@ declare type ExportedHandlerTestHandler<Env = unknown> = (
   env: Env,
   ctx: ExecutionContext
 ) => void | Promise<void>;
-declare interface ExportedHandler<Env = unknown, QueueMessage = unknown> {
-  fetch?: ExportedHandlerFetchHandler<Env>;
+declare interface ExportedHandler<
+  Env = unknown,
+  QueueMessage = unknown,
+  CfHostMetadata = unknown
+> {
+  fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata>;
   trace?: ExportedHandlerTraceHandler<Env>;
   scheduled?: ExportedHandlerScheduledHandler<Env>;
   test?: ExportedHandlerTestHandler<Env>;
-  queue?: ExportedHandlerQueueHandler<Env, QueueMessage>;
+  queue?: ExportedHandlerQueueHandler<Env, Message>;
 }
 declare interface StructuredSerializeOptions {
   transfer?: any[];
@@ -356,13 +364,24 @@ declare interface DurableObjectNamespace {
     id: DurableObjectId,
     options?: DurableObjectNamespaceGetDurableObjectOptions
   ): DurableObjectStub;
-  jurisdiction(jurisdiction: string): DurableObjectNamespace;
+  jurisdiction(jurisdiction: DurableObjectJurisdiction): DurableObjectNamespace;
 }
+declare type DurableObjectJurisdiction = "eu" | "fedramp";
 declare interface DurableObjectNamespaceNewUniqueIdOptions {
-  jurisdiction?: string;
-}
+  jurisdiction?: DurableObjectJurisdiction;
+}
+declare type DurableObjectLocationHint =
+  | "wnam"
+  | "enam"
+  | "sam"
+  | "weur"
+  | "eeur"
+  | "apac"
+  | "oc"
+  | "afr"
+  | "me";
 declare interface DurableObjectNamespaceGetDurableObjectOptions {
-  locationHint?: string;
+  locationHint?: DurableObjectLocationHint;
 }
 declare interface DurableObjectState {
   waitUntil(promise: Promise<any>): void;
@@ -992,23 +1011,27 @@ declare interface ResponseInit {
   webSocket?: WebSocket | null;
   encodeBody?: "automatic" | "manual";
 }
-declare type RequestInfo = Request | string | URL;
-declare class Request<CfHostMetadata = unknown> extends Body {
-  constructor(input: RequestInfo, init?: RequestInit);
-  clone(): Request<CfHostMetadata>;
+declare type RequestInfo<
+  CfHostMetadata = unknown,
+  Cf = CfProperties<CfHostMetadata>
+> = Request<CfHostMetadata, Cf> | string | URL;
+declare class Request<
+  CfHostMetadata = unknown,
+  Cf = CfProperties<CfHostMetadata>
+> extends Body {
+  constructor(input: RequestInfo<CfProperties>, init?: RequestInit<Cf>);
+  clone(): Request<CfHostMetadata, Cf>;
   get method(): string;
   get url(): string;
   get headers(): Headers;
   get redirect(): string;
   get fetcher(): Fetcher | null;
   get signal(): AbortSignal;
-  get cf(): IncomingRequestCfProperties<CfHostMetadata> | undefined;
+  get cf(): Cf | undefined;
   get integrity(): string;
   get keepalive(): boolean;
 }
-declare interface RequestInit<
-  CfType = IncomingRequestCfProperties | RequestInitCfProperties
-> {
+declare interface RequestInit<Cf = CfProperties> {
   /** A string to set request's method. */
   method?: string;
   /** A Headers object, an object literal, or an array of two-item arrays to set request's headers. */
@@ -1018,17 +1041,14 @@ declare interface RequestInit<
   /** A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect. */
   redirect?: string;
   fetcher?: Fetcher | null;
-  cf?: CfType;
+  cf?: Cf;
   /** 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;
 }
 declare abstract class Fetcher {
-  fetch(
-    input: RequestInfo,
-    init?: RequestInit<RequestInitCfProperties>
-  ): Promise<Response>;
+  fetch(input: RequestInfo, init?: RequestInit): Promise<Response>;
 }
 declare interface FetcherPutOptions {
   expiration?: number;
@@ -1141,6 +1161,33 @@ declare interface KVNamespaceGetWithMetadataResult<Value, Metadata> {
   value: Value | null;
   metadata: Metadata | null;
 }
+declare interface Queue<Body> {
+  send(message: Body): Promise<void>;
+  sendBatch(messages: Iterable<MessageSendRequest<Body>>): Promise<void>;
+}
+declare interface QueueSendOptions {}
+declare interface MessageSendRequest<Body = unknown> {
+  body: Body;
+}
+declare interface Message<Body = unknown> {
+  readonly id: string;
+  readonly timestamp: Date;
+  readonly body: Body;
+  retry(): void;
+  ack(): void;
+}
+declare interface QueueEvent<Body = unknown> extends ExtendableEvent {
+  readonly messages: readonly Message<Body>[];
+  readonly queue: string;
+  retryAll(): void;
+  ackAll(): void;
+}
+declare interface MessageBatch<Body = unknown> {
+  readonly messages: readonly Message<Body>[];
+  readonly queue: string;
+  retryAll(): void;
+  ackAll(): void;
+}
 declare interface R2Error extends Error {
   readonly name: string;
   readonly code: number;
@@ -1292,12 +1339,18 @@ declare interface R2HTTPMetadata {
   cacheControl?: string;
   cacheExpiry?: Date;
 }
-declare interface R2Objects {
+declare type R2Objects = {
   objects: R2Object[];
-  truncated: boolean;
-  cursor?: string;
   delimitedPrefixes: string[];
-}
+} & (
+  | {
+      truncated: true;
+      cursor: string;
+    }
+  | {
+      truncated: false;
+    }
+);
 declare abstract class ScheduledEvent extends ExtendableEvent {
   readonly scheduledTime: number;
   readonly cron: string;
@@ -1507,13 +1560,19 @@ declare class TransformStream<I = any, O = any> {
   get writable(): WritableStream<I>;
 }
 declare class FixedLengthStream extends IdentityTransformStream {
-  constructor(expectedLength: number | bigint);
+  constructor(
+    expectedLength: number | bigint,
+    queuingStrategy?: IdentityTransformStreamQueuingStrategy
+  );
 }
 declare class IdentityTransformStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   Uint8Array
 > {
-  constructor();
+  constructor(queuingStrategy?: IdentityTransformStreamQueuingStrategy);
+}
+declare interface IdentityTransformStreamQueuingStrategy {
+  highWaterMark?: number | bigint;
 }
 declare interface ReadableStreamValuesOptions {
   preventCancel?: boolean;
@@ -1658,6 +1717,7 @@ declare class URL {
   get searchParams(): URLSearchParams;
   toJSON(): string;
   toString(): string;
+  static canParse(url: string, base?: string): boolean;
 }
 declare class URLSearchParams {
   constructor(
@@ -1862,7 +1922,7 @@ declare interface BasicImageTransformationsGravityCoordinates {
  * Note: Currently, these properties cannot be tested in the
  * playground.
  */
-declare interface RequestInitCfProperties {
+declare interface RequestInitCfProperties extends Record<string, unknown> {
   cacheEverything?: boolean;
   /**
    * A request's cache key is what determines if two requests are
@@ -2032,6 +2092,49 @@ declare interface RequestInitCfPropertiesImage
    * the origin.
    */
   "origin-auth"?: "share-publicly";
+  /**
+   * Adds a border around the image. The border is added after resizing. Border
+   * width takes dpr into account, and can be specified either using a single
+   * width property, or individually for each side.
+   */
+  border?:
+    | {
+        color: string;
+        width: number;
+      }
+    | {
+        color: string;
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+      };
+  /**
+   * Increase brightness by a factor. A value of 1.0 equals no change, a value
+   * of 0.5 equals half brightness, and a value of 2.0 equals twice as bright.
+   * 0 is ignored.
+   */
+  brightness?: number;
+  /**
+   * Increase contrast by a factor. A value of 1.0 equals no change, a value of
+   * 0.5 equals low contrast, and a value of 2.0 equals high contrast. 0 is
+   * ignored.
+   */
+  contrast?: number;
+  /**
+   * Increase exposure by a factor. A value of 1.0 equals no change, a value of
+   * 0.5 darkens the image, and a value of 2.0 lightens the image. 0 is ignored.
+   */
+  gamma?: number;
+  /**
+   * Slightly reduces latency on a cache miss by selecting a
+   * quickest-to-compress file format, at a cost of increased file size and
+   * lower image quality. It will usually override the format option and choose
+   * JPEG over WebP or AVIF. We do not recommend using this option, except in
+   * unusual circumstances like resizing uncacheable dynamically-generated
+   * images.
+   */
+  compression?: "fast";
 }
 declare interface RequestInitCfPropertiesImageMinify {
   javascript?: boolean;
@@ -2047,7 +2150,8 @@ declare type IncomingRequestCfProperties<HostMetadata = unknown> =
     IncomingRequestCfPropertiesCloudflareForSaaSEnterprise<HostMetadata> &
     IncomingRequestCfPropertiesGeographicInformation &
     IncomingRequestCfPropertiesCloudflareAccessOrApiShield;
-declare interface IncomingRequestCfPropertiesBase {
+declare interface IncomingRequestCfPropertiesBase
+  extends Record<string, unknown> {
   /**
    * [ASN](https://www.iana.org/assignments/as-numbers/as-numbers.xhtml) of the incoming request.
    *
@@ -2128,8 +2232,7 @@ declare interface IncomingRequestCfPropertiesBase {
 declare interface IncomingRequestCfPropertiesBotManagementBase {
   /**
    * Cloudflare’s [level of certainty](https://developers.cloudflare.com/bots/concepts/bot-score/) that a request comes from a bot,
-   * represented as an integer percentage between `1` (almost certainly human)
-   * and `99` (almost certainly a bot).
+   * represented as an integer percentage between `1` (almost certainly a bot) and `99` (almost certainly human).
    *
    * @example 54
    */
@@ -2240,86 +2343,82 @@ declare interface IncomingRequestCfPropertiesExportedAuthenticatorMetadata {
 /**
  * Geographic data about the request's origin.
  */
-declare type IncomingRequestCfPropertiesGeographicInformation =
-  | {}
-  | {
-      /** The country code `"T1"` is used for requests originating on TOR  */
-      country: "T1";
-    }
-  | {
-      /**
-       * The [ISO 3166-1 Alpha 2](https://www.iso.org/iso-3166-country-codes.html) country code the request originated from.
-       *
-       * If your worker is [configured to accept TOR connections](https://support.cloudflare.com/hc/en-us/articles/203306930-Understanding-Cloudflare-Tor-support-and-Onion-Routing), this may also be `"T1"`, indicating a request that originated over TOR.
-       *
-       * If Cloudflare is unable to determine where the request originated this property is omitted.
-       *
-       * @example "GB"
-       */
-      country: Iso3166Alpha2Code;
-      /**
-       * If present, this property indicates that the request originated in the EU
-       *
-       * @example "1"
-       */
-      isEUCountry?: "1";
-      /**
-       * A two-letter code indicating the continent the request originated from.
-       *
-       * @example "AN"
-       */
-      continent: ContinentCode;
-      /**
-       * The city the request originated from
-       *
-       * @example "Austin"
-       */
-      city?: string;
-      /**
-       * Postal code of the incoming request
-       *
-       * @example "78701"
-       */
-      postalCode?: string;
-      /**
-       * Latitude of the incoming request
-       *
-       * @example "30.27130"
-       */
-      latitude?: string;
-      /**
-       * Longitude of the incoming request
-       *
-       * @example "-97.74260"
-       */
-      longitude?: string;
-      /**
-       * Timezone of the incoming request
-       *
-       * @example "America/Chicago"
-       */
-      timezone?: string;
-      /**
-       * If known, the ISO 3166-2 name for the first level region associated with
-       * the IP address of the incoming request
-       *
-       * @example "Texas"
-       */
-      region?: string;
-      /**
-       * If known, the ISO 3166-2 code for the first-level region associated with
-       * the IP address of the incoming request
-       *
-       * @example "TX"
-       */
-      regionCode?: string;
-      /**
-       * Metro code (DMA) of the incoming request
-       *
-       * @example "635"
-       */
-      metroCode?: string;
-    };
+declare interface IncomingRequestCfPropertiesGeographicInformation {
+  /**
+   * The [ISO 3166-1 Alpha 2](https://www.iso.org/iso-3166-country-codes.html) country code the request originated from.
+   *
+   * If your worker is [configured to accept TOR connections](https://support.cloudflare.com/hc/en-us/articles/203306930-Understanding-Cloudflare-Tor-support-and-Onion-Routing), this may also be `"T1"`, indicating a request that originated over TOR.
+   *
+   * If Cloudflare is unable to determine where the request originated this property is omitted.
+   *
+   * The country code `"T1"` is used for requests originating on TOR.
+   *
+   * @example "GB"
+   */
+  country?: Iso3166Alpha2Code | "T1";
+  /**
+   * If present, this property indicates that the request originated in the EU
+   *
+   * @example "1"
+   */
+  isEUCountry?: "1";
+  /**
+   * A two-letter code indicating the continent the request originated from.
+   *
+   * @example "AN"
+   */
+  continent?: ContinentCode;
+  /**
+   * The city the request originated from
+   *
+   * @example "Austin"
+   */
+  city?: string;
+  /**
+   * Postal code of the incoming request
+   *
+   * @example "78701"
+   */
+  postalCode?: string;
+  /**
+   * Latitude of the incoming request
+   *
+   * @example "30.27130"
+   */
+  latitude?: string;
+  /**
+   * Longitude of the incoming request
+   *
+   * @example "-97.74260"
+   */
+  longitude?: string;
+  /**
+   * Timezone of the incoming request
+   *
+   * @example "America/Chicago"
+   */
+  timezone?: string;
+  /**
+   * If known, the ISO 3166-2 name for the first level region associated with
+   * the IP address of the incoming request
+   *
+   * @example "Texas"
+   */
+  region?: string;
+  /**
+   * If known, the ISO 3166-2 code for the first-level region associated with
+   * the IP address of the incoming request
+   *
+   * @example "TX"
+   */
+  regionCode?: string;
+  /**
+   * Metro code (DMA) of the incoming request
+   *
+   * @example "635"
+   */
+  metroCode?: string;
+}
 /** Data about the incoming request's TLS certificate */
 declare interface IncomingRequestCfPropertiesTLSClientAuth {
   /** Always `"1"`, indicating that the certificate was presented */
@@ -2712,6 +2811,9 @@ declare type Iso3166Alpha2Code =
   | "ZW";
 /** The 2-letter continent codes Cloudflare uses */
 declare type ContinentCode = "AF" | "AN" | "AS" | "EU" | "NA" | "OC" | "SA";
+declare type CfProperties<HostMetadata = unknown> =
+  | IncomingRequestCfProperties<HostMetadata>
+  | RequestInitCfProperties;
 declare interface D1Result<T = unknown> {
   results?: T[];
   success: boolean;
@@ -2732,7 +2834,7 @@ declare abstract class D1PreparedStatement {
   raw<T = unknown>(): Promise<T[]>;
 }
 /**
- * A email message that is sent to a consumer Worker.
+ * An email message that can be sent from a Worker.
  */
 declare interface EmailMessage {
   /**
@@ -2743,14 +2845,19 @@ declare interface EmailMessage {
    * 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;
+}
+/**
+ * An email message that is sent to a consumer Worker and can be rejected/forwarded.
+ */
+declare interface ForwardableEmailMessage extends EmailMessage {
   /**
    * Stream of the email message content.
    */
   readonly raw: ReadableStream;
+  /**
+   * An [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers).
+   */
+  readonly headers: Headers;
   /**
    * Size of the email message content.
    */
@@ -2769,14 +2876,27 @@ declare interface EmailMessage {
    */
   forward(rcptTo: string, headers?: Headers): Promise<void>;
 }
+/**
+ * A binding that allows a Worker to send email messages.
+ */
+declare interface SendEmail {
+  send(message: EmailMessage): Promise<void>;
+}
 declare abstract class EmailEvent extends ExtendableEvent {
-  readonly message: EmailMessage;
+  readonly message: ForwardableEmailMessage;
 }
 declare type EmailExportedHandler<Env = unknown> = (
-  message: EmailMessage,
+  message: ForwardableEmailMessage,
   env: Env,
   ctx: ExecutionContext
 ) => void | Promise<void>;
+declare module "cloudflare:email" {
+  let _EmailMessage: {
+    prototype: EmailMessage;
+    new (from: string, to: string, raw: ReadableStream | string): EmailMessage;
+  };
+  export { _EmailMessage as EmailMessage };
+}
 declare type Params<P extends string = any> = Record<P, string | string[]>;
 declare type EventContext<Env, P extends string, Data> = {
   request: Request;
@@ -2857,75 +2977,12 @@ declare interface JsonWebKeyWithKid extends JsonWebKey {
   // Key Identifier of the JWK
   readonly kid: string;
 }
-/**
- * A message that is sent to a consumer Worker.
- */
-declare interface Message<Body = unknown> {
-  /**
-   * A unique, system-generated ID for the message.
-   */
-  readonly id: string;
-  /**
-   * A timestamp when the message was sent.
-   */
-  readonly timestamp: Date;
-  /**
-   * 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.
- */
-declare interface MessageBatch<Body = unknown> {
-  /**
-   * The name of the Queue that belongs to this batch.
-   */
-  readonly queue: string;
-  /**
-   * An array of messages in the batch. Ordering of messages is not guaranteed.
-   */
-  readonly messages: readonly Message<Body>[];
+// https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
+declare interface DispatchNamespace {
   /**
-   * Marks every message to be retried in the next batch.
+   * @param name Name of the Worker script.
+   * @returns A Fetcher object that allows you to send requests to the Worker script.
+   * @throws If the Worker script does not exist in this dispatch namespace, an error will be thrown.
    */
-  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.
- */
-declare interface Queue<Body = any> {
-  /**
-   * Sends a message to the Queue.
-   * @param message The message can be any type supported by the [structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm#supported_types), as long as its size is less than 128 KB.
-   * @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>;
+  get(name: string): Fetcher;
 }