@cloudflare/workers-types 4.20240925.0 → 4.20241011.0

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

@@ -14,6 +14,7 @@ and limitations under the License.
 ***************************************************************************** */
 /* eslint-disable */
 // noinspection JSUnusedGlobalSymbols
+declare var onmessage: never;
 /**
  * An abnormal event (called an exception) which occurs as a result of calling a method or accessing a property of a web API.
  *
@@ -1517,12 +1518,18 @@ declare abstract class Body {
  *
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response)
  */
-declare class Response extends Body {
-  constructor(body?: BodyInit | null, init?: ResponseInit);
-  /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/redirect_static) */
-  static redirect(url: string, status?: number): Response;
-  /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/json_static) */
-  static json(any: any, maybeInit?: ResponseInit | Response): Response;
+declare var Response: {
+  prototype: Response;
+  new (body?: BodyInit | null, init?: ResponseInit): Response;
+  redirect(url: string, status?: number): Response;
+  json(any: any, maybeInit?: ResponseInit | Response): Response;
+};
+/**
+ * This Fetch API interface represents the response to a request.
+ *
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response)
+ */
+interface Response extends Body {
   /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/clone) */
   clone(): Response;
   /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/status) */
@@ -1557,11 +1564,20 @@ type RequestInfo<CfHostMetadata = unknown, Cf = CfProperties<CfHostMetadata>> =
  *
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request)
  */
-declare class Request<
-  CfHostMetadata = unknown,
-  Cf = CfProperties<CfHostMetadata>,
-> extends Body {
-  constructor(input: RequestInfo<CfProperties>, init?: RequestInit<Cf>);
+declare var Request: {
+  prototype: Request;
+  new <CfHostMetadata = unknown, Cf = CfProperties<CfHostMetadata>>(
+    input: RequestInfo<CfProperties>,
+    init?: RequestInit<Cf>,
+  ): Request<CfHostMetadata, Cf>;
+};
+/**
+ * This Fetch API interface represents a resource request.
+ *
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request)
+ */
+interface Request<CfHostMetadata = unknown, Cf = CfProperties<CfHostMetadata>>
+  extends Body {
   /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/clone) */
   clone(): Request<CfHostMetadata, Cf>;
   /**
@@ -2292,7 +2308,7 @@ declare class TextDecoderStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   string
 > {
-  constructor(param1?: string, param2?: TextDecoderStreamTextDecoderStreamInit);
+  constructor(label?: string, options?: TextDecoderStreamTextDecoderStreamInit);
   get encoding(): string;
   get fatal(): boolean;
   get ignoreBOM(): boolean;
@@ -2662,8 +2678,24 @@ type WebSocketEventMap = {
  *
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket)
  */
-declare class WebSocket extends EventTarget<WebSocketEventMap> {
-  constructor(url: string, protocols?: string[] | string);
+declare var WebSocket: {
+  prototype: WebSocket;
+  new (url: string, protocols?: string[] | string): WebSocket;
+  readonly READY_STATE_CONNECTING: number;
+  readonly CONNECTING: number;
+  readonly READY_STATE_OPEN: number;
+  readonly OPEN: number;
+  readonly READY_STATE_CLOSING: number;
+  readonly CLOSING: number;
+  readonly READY_STATE_CLOSED: number;
+  readonly CLOSED: number;
+};
+/**
+ * Provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection.
+ *
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket)
+ */
+interface WebSocket extends EventTarget<WebSocketEventMap> {
   accept(): void;
   /**
    * Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView.
@@ -2679,14 +2711,6 @@ declare class WebSocket extends EventTarget<WebSocketEventMap> {
   close(code?: number, reason?: string): void;
   serializeAttachment(attachment: any): void;
   deserializeAttachment(): any | null;
-  static readonly READY_STATE_CONNECTING: number;
-  static readonly CONNECTING: number;
-  static readonly READY_STATE_OPEN: number;
-  static readonly OPEN: number;
-  static readonly READY_STATE_CLOSING: number;
-  static readonly CLOSING: number;
-  static readonly READY_STATE_CLOSED: number;
-  static readonly CLOSED: number;
   /**
    * Returns the state of the WebSocket object's connection. It can have the values described below.
    *
@@ -3484,7 +3508,7 @@ type AiTextToImageInput = {
   strength?: number;
   guidance?: number;
 };
-type AiTextToImageOutput = Uint8Array;
+type AiTextToImageOutput = ReadableStream<Uint8Array>;
 declare abstract class BaseAiTextToImage {
   inputs: AiTextToImageInput;
   postProcessedOutputs: AiTextToImageOutput;
@@ -3503,9 +3527,11 @@ declare abstract class BaseAiTranslation {
 }
 type GatewayOptions = {
   id: string;
+  cacheKey?: string;
   cacheTtl?: number;
   skipCache?: boolean;
   metadata?: Record<string, number | string | boolean | null | bigint>;
+  collectLog?: boolean;
 };
 type AiOptions = {
   gateway?: GatewayOptions;
@@ -4761,7 +4787,7 @@ interface Hyperdrive {
 // Copyright (c) 2024 Cloudflare, Inc.
 // Licensed under the Apache 2.0 license found in the LICENSE file or at:
 //     https://opensource.org/licenses/Apache-2.0
-type InfoResponse =
+type ImageInfoResponse =
   | {
       format: "image/svg+xml";
     }
@@ -4771,7 +4797,7 @@ type InfoResponse =
       width: number;
       height: number;
     };
-type Transform = {
+type ImageTransform = {
   fit?: "scale-down" | "contain" | "pad" | "squeeze" | "cover" | "crop";
   gravity?:
     | "left"
@@ -4821,7 +4847,7 @@ type Transform = {
   };
   zoom?: number;
 };
-type OutputOptions = {
+type ImageOutputOptions = {
   format:
     | "image/jpeg"
     | "image/png"
@@ -4839,7 +4865,7 @@ interface ImagesBinding {
    * @throws {@link ImagesError} with code 9412 if input is not an image
    * @param stream The image bytes
    */
-  info(stream: ReadableStream<Uint8Array>): Promise<InfoResponse>;
+  info(stream: ReadableStream<Uint8Array>): Promise<ImageInfoResponse>;
   /**
    * Begin applying a series of transformations to an image
    * @param stream The image bytes
@@ -4853,15 +4879,15 @@ interface ImageTransformer {
    * You can then apply more transformations or retrieve the output.
    * @param transform
    */
-  transform(transform: Transform): ImageTransformer;
+  transform(transform: ImageTransform): ImageTransformer;
   /**
    * Retrieve the image that results from applying the transforms to the
    * provided input
    * @param options Options that apply to the output e.g. output format
    */
-  output(options: OutputOptions): Promise<TransformationResult>;
+  output(options: ImageOutputOptions): Promise<ImageTransformationResult>;
 }
-interface TransformationResult {
+interface ImageTransformationResult {
   /**
    * The image as a response, ready to store in cache or return to users
    */
@@ -5010,7 +5036,7 @@ declare namespace Rpc {
   export const __RPC_TARGET_BRAND: "__RPC_TARGET_BRAND";
   export const __WORKER_ENTRYPOINT_BRAND: "__WORKER_ENTRYPOINT_BRAND";
   export const __DURABLE_OBJECT_BRAND: "__DURABLE_OBJECT_BRAND";
-  export const __WORKFLOW_BRAND: "__WORKFLOW_BRAND";
+  export const __WORKFLOW_ENTRYPOINT_BRAND: "__WORKFLOW_ENTRYPOINT_BRAND";
   export interface RpcTargetBranded {
     [__RPC_TARGET_BRAND]: never;
   }
@@ -5020,13 +5046,13 @@ declare namespace Rpc {
   export interface DurableObjectBranded {
     [__DURABLE_OBJECT_BRAND]: never;
   }
-  export interface WorkflowBranded {
-    [__WORKFLOW_BRAND]: never;
+  export interface WorkflowEntrypointBranded {
+    [__WORKFLOW_ENTRYPOINT_BRAND]: never;
   }
   export type EntrypointBranded =
     | WorkerEntrypointBranded
     | DurableObjectBranded
-    | WorkflowBranded;
+    | WorkflowEntrypointBranded;
   // Types that can be used through `Stub`s
   export type Stubable = RpcTargetBranded | ((...args: any[]) => any);
   // Types that can be passed over RPC
@@ -5221,25 +5247,33 @@ declare module "cloudflare:workers" {
     timestamp: Date;
   };
   export type WorkflowStep = {
-    do: <T extends Rpc.Serializable>(
-      name: string,
-      callback: () => Promise<T>,
-      config?: WorkflowStepConfig,
-    ) => Promise<T>;
-    sleep: (
-      name: string,
-      duration: WorkflowSleepDuration,
-    ) => void | Promise<void>;
+    do:
+      | (<T extends Rpc.Serializable>(
+          name: string,
+          callback: () => Promise<T>,
+        ) => Promise<T>)
+      | (<T extends Rpc.Serializable>(
+          name: string,
+          config: WorkflowStepConfig,
+          callback: () => Promise<T>,
+        ) => Promise<T>)
+      | (<T extends Rpc.Serializable>(
+          name: string,
+          config: WorkflowStepConfig | (() => Promise<T>),
+          callback?: () => Promise<T>,
+        ) => Promise<T>);
+    sleep: (name: string, duration: WorkflowSleepDuration) => Promise<void>;
+    sleepUntil: (name: string, timestamp: Date | number) => Promise<void>;
   };
-  export abstract class Workflow<
+  export abstract class WorkflowEntrypoint<
     Env = unknown,
     T extends Rpc.Serializable | unknown = unknown,
-  > implements Rpc.WorkflowBranded
+  > implements Rpc.WorkflowEntrypointBranded
   {
-    [Rpc.__WORKFLOW_BRAND]: never;
+    [Rpc.__WORKFLOW_ENTRYPOINT_BRAND]: never;
     protected ctx: ExecutionContext;
     protected env: Env;
-    run(events: Array<WorkflowEvent<T>>, step: WorkflowStep): Promise<unknown>;
+    run(event: WorkflowEvent<T>, step: WorkflowStep): Promise<unknown>;
   }
 }
 declare module "cloudflare:sockets" {

package/2021-11-03/index.ts

@@ -14,6 +14,7 @@ and limitations under the License.
 ***************************************************************************** */
 /* eslint-disable */
 // noinspection JSUnusedGlobalSymbols
+export declare var onmessage: never;
 /**
  * An abnormal event (called an exception) which occurs as a result of calling a method or accessing a property of a web API.
  *
@@ -1522,12 +1523,18 @@ export declare abstract class Body {
  *
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response)
  */
-export declare class Response extends Body {
-  constructor(body?: BodyInit | null, init?: ResponseInit);
-  /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/redirect_static) */
-  static redirect(url: string, status?: number): Response;
-  /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/json_static) */
-  static json(any: any, maybeInit?: ResponseInit | Response): Response;
+export declare var Response: {
+  prototype: Response;
+  new (body?: BodyInit | null, init?: ResponseInit): Response;
+  redirect(url: string, status?: number): Response;
+  json(any: any, maybeInit?: ResponseInit | Response): Response;
+};
+/**
+ * This Fetch API interface represents the response to a request.
+ *
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response)
+ */
+export interface Response extends Body {
   /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/clone) */
   clone(): Response;
   /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/status) */
@@ -1562,11 +1569,22 @@ export type RequestInfo<
  *
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request)
  */
-export declare class Request<
+export declare var Request: {
+  prototype: Request;
+  new <CfHostMetadata = unknown, Cf = CfProperties<CfHostMetadata>>(
+    input: RequestInfo<CfProperties>,
+    init?: RequestInit<Cf>,
+  ): Request<CfHostMetadata, Cf>;
+};
+/**
+ * This Fetch API interface represents a resource request.
+ *
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request)
+ */
+export interface Request<
   CfHostMetadata = unknown,
   Cf = CfProperties<CfHostMetadata>,
 > extends Body {
-  constructor(input: RequestInfo<CfProperties>, init?: RequestInit<Cf>);
   /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/clone) */
   clone(): Request<CfHostMetadata, Cf>;
   /**
@@ -2301,7 +2319,7 @@ export declare class TextDecoderStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   string
 > {
-  constructor(param1?: string, param2?: TextDecoderStreamTextDecoderStreamInit);
+  constructor(label?: string, options?: TextDecoderStreamTextDecoderStreamInit);
   get encoding(): string;
   get fatal(): boolean;
   get ignoreBOM(): boolean;
@@ -2671,8 +2689,24 @@ export type WebSocketEventMap = {
  *
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket)
  */
-export declare class WebSocket extends EventTarget<WebSocketEventMap> {
-  constructor(url: string, protocols?: string[] | string);
+export declare var WebSocket: {
+  prototype: WebSocket;
+  new (url: string, protocols?: string[] | string): WebSocket;
+  readonly READY_STATE_CONNECTING: number;
+  readonly CONNECTING: number;
+  readonly READY_STATE_OPEN: number;
+  readonly OPEN: number;
+  readonly READY_STATE_CLOSING: number;
+  readonly CLOSING: number;
+  readonly READY_STATE_CLOSED: number;
+  readonly CLOSED: number;
+};
+/**
+ * Provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection.
+ *
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket)
+ */
+export interface WebSocket extends EventTarget<WebSocketEventMap> {
   accept(): void;
   /**
    * Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView.
@@ -2688,14 +2722,6 @@ export declare class WebSocket extends EventTarget<WebSocketEventMap> {
   close(code?: number, reason?: string): void;
   serializeAttachment(attachment: any): void;
   deserializeAttachment(): any | null;
-  static readonly READY_STATE_CONNECTING: number;
-  static readonly CONNECTING: number;
-  static readonly READY_STATE_OPEN: number;
-  static readonly OPEN: number;
-  static readonly READY_STATE_CLOSING: number;
-  static readonly CLOSING: number;
-  static readonly READY_STATE_CLOSED: number;
-  static readonly CLOSED: number;
   /**
    * Returns the state of the WebSocket object's connection. It can have the values described below.
    *
@@ -3493,7 +3519,7 @@ export type AiTextToImageInput = {
   strength?: number;
   guidance?: number;
 };
-export type AiTextToImageOutput = Uint8Array;
+export type AiTextToImageOutput = ReadableStream<Uint8Array>;
 export declare abstract class BaseAiTextToImage {
   inputs: AiTextToImageInput;
   postProcessedOutputs: AiTextToImageOutput;
@@ -3512,9 +3538,11 @@ export declare abstract class BaseAiTranslation {
 }
 export type GatewayOptions = {
   id: string;
+  cacheKey?: string;
   cacheTtl?: number;
   skipCache?: boolean;
   metadata?: Record<string, number | string | boolean | null | bigint>;
+  collectLog?: boolean;
 };
 export type AiOptions = {
   gateway?: GatewayOptions;
@@ -4776,7 +4804,7 @@ export interface Hyperdrive {
 // Copyright (c) 2024 Cloudflare, Inc.
 // Licensed under the Apache 2.0 license found in the LICENSE file or at:
 //     https://opensource.org/licenses/Apache-2.0
-export type InfoResponse =
+export type ImageInfoResponse =
   | {
       format: "image/svg+xml";
     }
@@ -4786,7 +4814,7 @@ export type InfoResponse =
       width: number;
       height: number;
     };
-export type Transform = {
+export type ImageTransform = {
   fit?: "scale-down" | "contain" | "pad" | "squeeze" | "cover" | "crop";
   gravity?:
     | "left"
@@ -4836,7 +4864,7 @@ export type Transform = {
   };
   zoom?: number;
 };
-export type OutputOptions = {
+export type ImageOutputOptions = {
   format:
     | "image/jpeg"
     | "image/png"
@@ -4854,7 +4882,7 @@ export interface ImagesBinding {
    * @throws {@link ImagesError} with code 9412 if input is not an image
    * @param stream The image bytes
    */
-  info(stream: ReadableStream<Uint8Array>): Promise<InfoResponse>;
+  info(stream: ReadableStream<Uint8Array>): Promise<ImageInfoResponse>;
   /**
    * Begin applying a series of transformations to an image
    * @param stream The image bytes
@@ -4868,15 +4896,15 @@ export interface ImageTransformer {
    * You can then apply more transformations or retrieve the output.
    * @param transform
    */
-  transform(transform: Transform): ImageTransformer;
+  transform(transform: ImageTransform): ImageTransformer;
   /**
    * Retrieve the image that results from applying the transforms to the
    * provided input
    * @param options Options that apply to the output e.g. output format
    */
-  output(options: OutputOptions): Promise<TransformationResult>;
+  output(options: ImageOutputOptions): Promise<ImageTransformationResult>;
 }
-export interface TransformationResult {
+export interface ImageTransformationResult {
   /**
    * The image as a response, ready to store in cache or return to users
    */
@@ -5022,7 +5050,7 @@ export declare namespace Rpc {
   export const __RPC_TARGET_BRAND: "__RPC_TARGET_BRAND";
   export const __WORKER_ENTRYPOINT_BRAND: "__WORKER_ENTRYPOINT_BRAND";
   export const __DURABLE_OBJECT_BRAND: "__DURABLE_OBJECT_BRAND";
-  export const __WORKFLOW_BRAND: "__WORKFLOW_BRAND";
+  export const __WORKFLOW_ENTRYPOINT_BRAND: "__WORKFLOW_ENTRYPOINT_BRAND";
   export interface RpcTargetBranded {
     [__RPC_TARGET_BRAND]: never;
   }
@@ -5032,13 +5060,13 @@ export declare namespace Rpc {
   export interface DurableObjectBranded {
     [__DURABLE_OBJECT_BRAND]: never;
   }
-  export interface WorkflowBranded {
-    [__WORKFLOW_BRAND]: never;
+  export interface WorkflowEntrypointBranded {
+    [__WORKFLOW_ENTRYPOINT_BRAND]: never;
   }
   export type EntrypointBranded =
     | WorkerEntrypointBranded
     | DurableObjectBranded
-    | WorkflowBranded;
+    | WorkflowEntrypointBranded;
   // Types that can be used through `Stub`s
   export type Stubable = RpcTargetBranded | ((...args: any[]) => any);
   // Types that can be passed over RPC