@cloudflare/workers-types 4.20240729.0 → 4.20240815.0

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

@@ -4717,6 +4717,128 @@ interface Hyperdrive {
    */
   readonly database: string;
 }
+// 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 =
+  | {
+      format: "image/svg+xml";
+    }
+  | {
+      format: string;
+      fileSize: number;
+      width: number;
+      height: number;
+    };
+type Transform = {
+  fit?: "scale-down" | "contain" | "pad" | "squeeze" | "cover" | "crop";
+  gravity?:
+    | "left"
+    | "right"
+    | "top"
+    | "bottom"
+    | "center"
+    | "auto"
+    | "entropy"
+    | "face"
+    | {
+        x?: number;
+        y?: number;
+        mode: "remainder" | "box-center";
+      };
+  trim?: {
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+    width?: number;
+    height?: number;
+    border?:
+      | boolean
+      | {
+          color?: string;
+          tolerance?: number;
+          keep?: number;
+        };
+  };
+  width?: number;
+  height?: number;
+  background?: string;
+  rotate?: number;
+  sharpen?: number;
+  blur?: number;
+  contrast?: number;
+  brightness?: number;
+  gamma?: number;
+  border?: {
+    color?: string;
+    width?: number;
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+  };
+  zoom?: number;
+};
+type OutputOptions = {
+  format:
+    | "image/jpeg"
+    | "image/png"
+    | "image/gif"
+    | "image/webp"
+    | "image/avif"
+    | "rgb"
+    | "rgba";
+  quality?: number;
+  background?: string;
+};
+interface ImagesBinding {
+  /**
+   * Get image metadata (type, width and height)
+   * @throws {@link ImagesError} with code 9412 if input is not an image
+   * @param stream The image bytes
+   */
+  info(stream: ReadableStream<Uint8Array>): Promise<InfoResponse>;
+  /**
+   * Begin applying a series of transformations to an image
+   * @param stream The image bytes
+   * @returns A transform handle
+   */
+  input(stream: ReadableStream<Uint8Array>): ImageTransformer;
+}
+interface ImageTransformer {
+  /**
+   * Apply transform next, returning a transform handle.
+   * You can then apply more transformations or retrieve the output.
+   * @param transform
+   */
+  transform(transform: Transform): 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>;
+}
+interface TransformationResult {
+  /**
+   * The image as a response, ready to store in cache or return to users
+   */
+  response(): Response;
+  /**
+   * The content type of the returned image
+   */
+  contentType(): string;
+  /**
+   * The bytes of the response
+   */
+  image(): ReadableStream<Uint8Array>;
+}
+interface ImagesError extends Error {
+  readonly code: number;
+  readonly message: string;
+  readonly stack?: string;
+}
 type Params<P extends string = any> = Record<P, string | string[]>;
 type EventContext<Env, P extends string, Data> = {
   request: Request<unknown, IncomingRequestCfProperties<unknown>>;
@@ -4823,6 +4945,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 interface RpcTargetBranded {
     [__RPC_TARGET_BRAND]: never;
   }
@@ -4832,9 +4955,13 @@ declare namespace Rpc {
   export interface DurableObjectBranded {
     [__DURABLE_OBJECT_BRAND]: never;
   }
+  export interface WorkflowBranded {
+    [__WORKFLOW_BRAND]: never;
+  }
   export type EntrypointBranded =
     | WorkerEntrypointBranded
-    | DurableObjectBranded;
+    | DurableObjectBranded
+    | WorkflowBranded;
   // Types that can be used through `Stub`s
   export type Stubable = RpcTargetBranded | ((...args: any[]) => any);
   // Types that can be passed over RPC
@@ -5004,6 +5131,38 @@ declare module "cloudflare:workers" {
     ): void | Promise<void>;
     webSocketError?(ws: WebSocket, error: unknown): void | Promise<void>;
   }
+  export type DurationLabel =
+    | "second"
+    | "minute"
+    | "hour"
+    | "day"
+    | "week"
+    | "month"
+    | "year";
+  export type SleepDuration = `${number} ${DurationLabel}${"s" | ""}` | number;
+  type WorkflowStep = {
+    do: <T extends Rpc.Serializable>(
+      name: string,
+      callback: () => T,
+    ) => T | Promise<T>;
+    sleep: (name: string, duration: SleepDuration) => void | Promise<void>;
+  };
+  export abstract class Workflow<
+    Env = unknown,
+    T extends Rpc.Serializable | unknown = unknown,
+  > implements Rpc.WorkflowBranded
+  {
+    [Rpc.__WORKFLOW_BRAND]: never;
+    protected ctx: ExecutionContext;
+    protected env: Env;
+    run(
+      events: Array<{
+        payload: T;
+        timestamp: Date;
+      }>,
+      step: WorkflowStep,
+    ): unknown | Promise<unknown>;
+  }
 }
 declare module "cloudflare:sockets" {
   function _connect(

package/2021-11-03/index.ts

@@ -4732,6 +4732,128 @@ export interface Hyperdrive {
    */
   readonly database: string;
 }
+// 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 =
+  | {
+      format: "image/svg+xml";
+    }
+  | {
+      format: string;
+      fileSize: number;
+      width: number;
+      height: number;
+    };
+export type Transform = {
+  fit?: "scale-down" | "contain" | "pad" | "squeeze" | "cover" | "crop";
+  gravity?:
+    | "left"
+    | "right"
+    | "top"
+    | "bottom"
+    | "center"
+    | "auto"
+    | "entropy"
+    | "face"
+    | {
+        x?: number;
+        y?: number;
+        mode: "remainder" | "box-center";
+      };
+  trim?: {
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+    width?: number;
+    height?: number;
+    border?:
+      | boolean
+      | {
+          color?: string;
+          tolerance?: number;
+          keep?: number;
+        };
+  };
+  width?: number;
+  height?: number;
+  background?: string;
+  rotate?: number;
+  sharpen?: number;
+  blur?: number;
+  contrast?: number;
+  brightness?: number;
+  gamma?: number;
+  border?: {
+    color?: string;
+    width?: number;
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+  };
+  zoom?: number;
+};
+export type OutputOptions = {
+  format:
+    | "image/jpeg"
+    | "image/png"
+    | "image/gif"
+    | "image/webp"
+    | "image/avif"
+    | "rgb"
+    | "rgba";
+  quality?: number;
+  background?: string;
+};
+export interface ImagesBinding {
+  /**
+   * Get image metadata (type, width and height)
+   * @throws {@link ImagesError} with code 9412 if input is not an image
+   * @param stream The image bytes
+   */
+  info(stream: ReadableStream<Uint8Array>): Promise<InfoResponse>;
+  /**
+   * Begin applying a series of transformations to an image
+   * @param stream The image bytes
+   * @returns A transform handle
+   */
+  input(stream: ReadableStream<Uint8Array>): ImageTransformer;
+}
+export interface ImageTransformer {
+  /**
+   * Apply transform next, returning a transform handle.
+   * You can then apply more transformations or retrieve the output.
+   * @param transform
+   */
+  transform(transform: Transform): 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>;
+}
+export interface TransformationResult {
+  /**
+   * The image as a response, ready to store in cache or return to users
+   */
+  response(): Response;
+  /**
+   * The content type of the returned image
+   */
+  contentType(): string;
+  /**
+   * The bytes of the response
+   */
+  image(): ReadableStream<Uint8Array>;
+}
+export interface ImagesError extends Error {
+  readonly code: number;
+  readonly message: string;
+  readonly stack?: string;
+}
 export type Params<P extends string = any> = Record<P, string | string[]>;
 export type EventContext<Env, P extends string, Data> = {
   request: Request<unknown, IncomingRequestCfProperties<unknown>>;
@@ -4835,6 +4957,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 interface RpcTargetBranded {
     [__RPC_TARGET_BRAND]: never;
   }
@@ -4844,9 +4967,13 @@ export declare namespace Rpc {
   export interface DurableObjectBranded {
     [__DURABLE_OBJECT_BRAND]: never;
   }
+  export interface WorkflowBranded {
+    [__WORKFLOW_BRAND]: never;
+  }
   export type EntrypointBranded =
     | WorkerEntrypointBranded
-    | DurableObjectBranded;
+    | DurableObjectBranded
+    | WorkflowBranded;
   // Types that can be used through `Stub`s
   export type Stubable = RpcTargetBranded | ((...args: any[]) => any);
   // Types that can be passed over RPC

package/2022-01-31/index.d.ts

@@ -4743,6 +4743,128 @@ interface Hyperdrive {
    */
   readonly database: string;
 }
+// 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 =
+  | {
+      format: "image/svg+xml";
+    }
+  | {
+      format: string;
+      fileSize: number;
+      width: number;
+      height: number;
+    };
+type Transform = {
+  fit?: "scale-down" | "contain" | "pad" | "squeeze" | "cover" | "crop";
+  gravity?:
+    | "left"
+    | "right"
+    | "top"
+    | "bottom"
+    | "center"
+    | "auto"
+    | "entropy"
+    | "face"
+    | {
+        x?: number;
+        y?: number;
+        mode: "remainder" | "box-center";
+      };
+  trim?: {
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+    width?: number;
+    height?: number;
+    border?:
+      | boolean
+      | {
+          color?: string;
+          tolerance?: number;
+          keep?: number;
+        };
+  };
+  width?: number;
+  height?: number;
+  background?: string;
+  rotate?: number;
+  sharpen?: number;
+  blur?: number;
+  contrast?: number;
+  brightness?: number;
+  gamma?: number;
+  border?: {
+    color?: string;
+    width?: number;
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+  };
+  zoom?: number;
+};
+type OutputOptions = {
+  format:
+    | "image/jpeg"
+    | "image/png"
+    | "image/gif"
+    | "image/webp"
+    | "image/avif"
+    | "rgb"
+    | "rgba";
+  quality?: number;
+  background?: string;
+};
+interface ImagesBinding {
+  /**
+   * Get image metadata (type, width and height)
+   * @throws {@link ImagesError} with code 9412 if input is not an image
+   * @param stream The image bytes
+   */
+  info(stream: ReadableStream<Uint8Array>): Promise<InfoResponse>;
+  /**
+   * Begin applying a series of transformations to an image
+   * @param stream The image bytes
+   * @returns A transform handle
+   */
+  input(stream: ReadableStream<Uint8Array>): ImageTransformer;
+}
+interface ImageTransformer {
+  /**
+   * Apply transform next, returning a transform handle.
+   * You can then apply more transformations or retrieve the output.
+   * @param transform
+   */
+  transform(transform: Transform): 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>;
+}
+interface TransformationResult {
+  /**
+   * The image as a response, ready to store in cache or return to users
+   */
+  response(): Response;
+  /**
+   * The content type of the returned image
+   */
+  contentType(): string;
+  /**
+   * The bytes of the response
+   */
+  image(): ReadableStream<Uint8Array>;
+}
+interface ImagesError extends Error {
+  readonly code: number;
+  readonly message: string;
+  readonly stack?: string;
+}
 type Params<P extends string = any> = Record<P, string | string[]>;
 type EventContext<Env, P extends string, Data> = {
   request: Request<unknown, IncomingRequestCfProperties<unknown>>;
@@ -4849,6 +4971,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 interface RpcTargetBranded {
     [__RPC_TARGET_BRAND]: never;
   }
@@ -4858,9 +4981,13 @@ declare namespace Rpc {
   export interface DurableObjectBranded {
     [__DURABLE_OBJECT_BRAND]: never;
   }
+  export interface WorkflowBranded {
+    [__WORKFLOW_BRAND]: never;
+  }
   export type EntrypointBranded =
     | WorkerEntrypointBranded
-    | DurableObjectBranded;
+    | DurableObjectBranded
+    | WorkflowBranded;
   // Types that can be used through `Stub`s
   export type Stubable = RpcTargetBranded | ((...args: any[]) => any);
   // Types that can be passed over RPC
@@ -5030,6 +5157,38 @@ declare module "cloudflare:workers" {
     ): void | Promise<void>;
     webSocketError?(ws: WebSocket, error: unknown): void | Promise<void>;
   }
+  export type DurationLabel =
+    | "second"
+    | "minute"
+    | "hour"
+    | "day"
+    | "week"
+    | "month"
+    | "year";
+  export type SleepDuration = `${number} ${DurationLabel}${"s" | ""}` | number;
+  type WorkflowStep = {
+    do: <T extends Rpc.Serializable>(
+      name: string,
+      callback: () => T,
+    ) => T | Promise<T>;
+    sleep: (name: string, duration: SleepDuration) => void | Promise<void>;
+  };
+  export abstract class Workflow<
+    Env = unknown,
+    T extends Rpc.Serializable | unknown = unknown,
+  > implements Rpc.WorkflowBranded
+  {
+    [Rpc.__WORKFLOW_BRAND]: never;
+    protected ctx: ExecutionContext;
+    protected env: Env;
+    run(
+      events: Array<{
+        payload: T;
+        timestamp: Date;
+      }>,
+      step: WorkflowStep,
+    ): unknown | Promise<unknown>;
+  }
 }
 declare module "cloudflare:sockets" {
   function _connect(

package/2022-01-31/index.ts

@@ -4758,6 +4758,128 @@ export interface Hyperdrive {
    */
   readonly database: string;
 }
+// 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 =
+  | {
+      format: "image/svg+xml";
+    }
+  | {
+      format: string;
+      fileSize: number;
+      width: number;
+      height: number;
+    };
+export type Transform = {
+  fit?: "scale-down" | "contain" | "pad" | "squeeze" | "cover" | "crop";
+  gravity?:
+    | "left"
+    | "right"
+    | "top"
+    | "bottom"
+    | "center"
+    | "auto"
+    | "entropy"
+    | "face"
+    | {
+        x?: number;
+        y?: number;
+        mode: "remainder" | "box-center";
+      };
+  trim?: {
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+    width?: number;
+    height?: number;
+    border?:
+      | boolean
+      | {
+          color?: string;
+          tolerance?: number;
+          keep?: number;
+        };
+  };
+  width?: number;
+  height?: number;
+  background?: string;
+  rotate?: number;
+  sharpen?: number;
+  blur?: number;
+  contrast?: number;
+  brightness?: number;
+  gamma?: number;
+  border?: {
+    color?: string;
+    width?: number;
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+  };
+  zoom?: number;
+};
+export type OutputOptions = {
+  format:
+    | "image/jpeg"
+    | "image/png"
+    | "image/gif"
+    | "image/webp"
+    | "image/avif"
+    | "rgb"
+    | "rgba";
+  quality?: number;
+  background?: string;
+};
+export interface ImagesBinding {
+  /**
+   * Get image metadata (type, width and height)
+   * @throws {@link ImagesError} with code 9412 if input is not an image
+   * @param stream The image bytes
+   */
+  info(stream: ReadableStream<Uint8Array>): Promise<InfoResponse>;
+  /**
+   * Begin applying a series of transformations to an image
+   * @param stream The image bytes
+   * @returns A transform handle
+   */
+  input(stream: ReadableStream<Uint8Array>): ImageTransformer;
+}
+export interface ImageTransformer {
+  /**
+   * Apply transform next, returning a transform handle.
+   * You can then apply more transformations or retrieve the output.
+   * @param transform
+   */
+  transform(transform: Transform): 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>;
+}
+export interface TransformationResult {
+  /**
+   * The image as a response, ready to store in cache or return to users
+   */
+  response(): Response;
+  /**
+   * The content type of the returned image
+   */
+  contentType(): string;
+  /**
+   * The bytes of the response
+   */
+  image(): ReadableStream<Uint8Array>;
+}
+export interface ImagesError extends Error {
+  readonly code: number;
+  readonly message: string;
+  readonly stack?: string;
+}
 export type Params<P extends string = any> = Record<P, string | string[]>;
 export type EventContext<Env, P extends string, Data> = {
   request: Request<unknown, IncomingRequestCfProperties<unknown>>;
@@ -4861,6 +4983,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 interface RpcTargetBranded {
     [__RPC_TARGET_BRAND]: never;
   }
@@ -4870,9 +4993,13 @@ export declare namespace Rpc {
   export interface DurableObjectBranded {
     [__DURABLE_OBJECT_BRAND]: never;
   }
+  export interface WorkflowBranded {
+    [__WORKFLOW_BRAND]: never;
+  }
   export type EntrypointBranded =
     | WorkerEntrypointBranded
-    | DurableObjectBranded;
+    | DurableObjectBranded
+    | WorkflowBranded;
   // Types that can be used through `Stub`s
   export type Stubable = RpcTargetBranded | ((...args: any[]) => any);
   // Types that can be passed over RPC