@cloudflare/workers-types 0.20230115.0 → 0.20230307.0

package/index.ts

@@ -281,6 +281,7 @@ export declare const self: ServiceWorkerGlobalScope;
 export declare const crypto: Crypto;
 export declare const caches: CacheStorage;
 export declare const scheduler: Scheduler;
+export interface TestController {}
 export interface ExecutionContext {
   waitUntil(promise: Promise<any>): void;
   passThroughOnException(): void;
@@ -305,10 +306,16 @@ export type ExportedHandlerQueueHandler<Env = unknown, Message = unknown> = (
   env: Env,
   ctx: ExecutionContext
 ) => void | Promise<void>;
+export type ExportedHandlerTestHandler<Env = unknown> = (
+  controller: TestController,
+  env: Env,
+  ctx: ExecutionContext
+) => void | Promise<void>;
 export interface ExportedHandler<Env = unknown, QueueMessage = unknown> {
   fetch?: ExportedHandlerFetchHandler<Env>;
   trace?: ExportedHandlerTraceHandler<Env>;
   scheduled?: ExportedHandlerScheduledHandler<Env>;
+  test?: ExportedHandlerTestHandler<Env>;
   queue?: ExportedHandlerQueueHandler<Env, QueueMessage>;
 }
 export interface StructuredSerializeOptions {
@@ -1006,6 +1013,10 @@ export declare class Request<CfHostMetadata = unknown> extends Body {
   /** 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<CfHostMetadata>;
+  /** Returns request's subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. [SRI] */
+  readonly integrity: string;
+  /** Returns a boolean indicating whether or not request can outlive the global in which it was created. */
+  readonly keepalive: boolean;
 }
 export interface RequestInit<
   CfType = IncomingRequestCfProperties | RequestInitCfProperties
@@ -1020,6 +1031,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;
 }
@@ -1071,11 +1084,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>>;
@@ -1521,13 +1534,13 @@ export declare class CompressionStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   Uint8Array
 > {
-  constructor(format: "gzip" | "deflate");
+  constructor(format: "gzip" | "deflate" | "deflate-raw");
 }
 export declare class DecompressionStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   Uint8Array
 > {
-  constructor(format: "gzip" | "deflate");
+  constructor(format: "gzip" | "deflate" | "deflate-raw");
 }
 export declare class TextEncoderStream extends TransformStream<
   string,
@@ -1659,6 +1672,7 @@ export declare class URLSearchParams {
       | Record<string, string>
       | [key: string, value: string][]
   );
+  get size(): number;
   append(name: string, value: string): void;
   delete(name: string): void;
   get(name: string): string | null;
@@ -2147,6 +2161,10 @@ export interface IncomingRequestCfPropertiesBotManagementBase {
    * A boolean value that's true if the request matches [file extensions](https://developers.cloudflare.com/bots/reference/static-resources/) for many types of static resources.
    */
   staticResource: boolean;
+  /**
+   * List of IDs that correlate to the Bot Management heuristic detections made on a request (you can have multiple heuristic detections on the same request).
+   */
+  detectionIds: number[];
 }
 export interface IncomingRequestCfPropertiesBotManagement {
   /**
@@ -2729,7 +2747,7 @@ export declare abstract class D1PreparedStatement {
 /**
  * A email message that is sent to a consumer Worker.
  */
-export interface EmailMessage<Body = unknown> {
+export interface EmailMessage {
   /**
    * Envelope From attribute of the email message.
    */
@@ -2815,6 +2833,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.
  */
@@ -2831,6 +2883,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.
@@ -2848,6 +2908,10 @@ 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.

package/oldest/index.d.ts

@@ -279,6 +279,7 @@ declare const self: ServiceWorkerGlobalScope;
 declare const crypto: Crypto;
 declare const caches: CacheStorage;
 declare const scheduler: Scheduler;
+declare interface TestController {}
 declare interface ExecutionContext {
   waitUntil(promise: Promise<any>): void;
   passThroughOnException(): void;
@@ -303,10 +304,16 @@ declare type ExportedHandlerQueueHandler<Env = unknown, Message = unknown> = (
   env: Env,
   ctx: ExecutionContext
 ) => void | Promise<void>;
+declare type ExportedHandlerTestHandler<Env = unknown> = (
+  controller: TestController,
+  env: Env,
+  ctx: ExecutionContext
+) => void | Promise<void>;
 declare interface ExportedHandler<Env = unknown, QueueMessage = unknown> {
   fetch?: ExportedHandlerFetchHandler<Env>;
   trace?: ExportedHandlerTraceHandler<Env>;
   scheduled?: ExportedHandlerScheduledHandler<Env>;
+  test?: ExportedHandlerTestHandler<Env>;
   queue?: ExportedHandlerQueueHandler<Env, QueueMessage>;
 }
 declare interface StructuredSerializeOptions {
@@ -1004,6 +1011,10 @@ declare class Request<CfHostMetadata = unknown> extends Body {
   /** 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<CfHostMetadata>;
+  /** Returns request's subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. [SRI] */
+  readonly integrity: string;
+  /** Returns a boolean indicating whether or not request can outlive the global in which it was created. */
+  readonly keepalive: boolean;
 }
 declare interface RequestInit<
   CfType = IncomingRequestCfProperties | RequestInitCfProperties
@@ -1018,6 +1029,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;
 }
@@ -1069,11 +1082,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>>;
@@ -1519,13 +1532,13 @@ declare class CompressionStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   Uint8Array
 > {
-  constructor(format: "gzip" | "deflate");
+  constructor(format: "gzip" | "deflate" | "deflate-raw");
 }
 declare class DecompressionStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   Uint8Array
 > {
-  constructor(format: "gzip" | "deflate");
+  constructor(format: "gzip" | "deflate" | "deflate-raw");
 }
 declare class TextEncoderStream extends TransformStream<string, Uint8Array> {
   constructor();
@@ -1654,6 +1667,7 @@ declare class URLSearchParams {
       | Record<string, string>
       | [key: string, value: string][]
   );
+  get size(): number;
   append(name: string, value: string): void;
   delete(name: string): void;
   get(name: string): string | null;
@@ -2142,6 +2156,10 @@ declare interface IncomingRequestCfPropertiesBotManagementBase {
    * A boolean value that's true if the request matches [file extensions](https://developers.cloudflare.com/bots/reference/static-resources/) for many types of static resources.
    */
   staticResource: boolean;
+  /**
+   * List of IDs that correlate to the Bot Management heuristic detections made on a request (you can have multiple heuristic detections on the same request).
+   */
+  detectionIds: number[];
 }
 declare interface IncomingRequestCfPropertiesBotManagement {
   /**
@@ -2724,7 +2742,7 @@ declare abstract class D1PreparedStatement {
 /**
  * A email message that is sent to a consumer Worker.
  */
-declare interface EmailMessage<Body = unknown> {
+declare interface EmailMessage {
   /**
    * Envelope From attribute of the email message.
    */
@@ -2813,6 +2831,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.
  */
@@ -2829,6 +2881,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.
@@ -2846,6 +2906,10 @@ 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.

package/oldest/index.ts

@@ -281,6 +281,7 @@ export declare const self: ServiceWorkerGlobalScope;
 export declare const crypto: Crypto;
 export declare const caches: CacheStorage;
 export declare const scheduler: Scheduler;
+export interface TestController {}
 export interface ExecutionContext {
   waitUntil(promise: Promise<any>): void;
   passThroughOnException(): void;
@@ -305,10 +306,16 @@ export type ExportedHandlerQueueHandler<Env = unknown, Message = unknown> = (
   env: Env,
   ctx: ExecutionContext
 ) => void | Promise<void>;
+export type ExportedHandlerTestHandler<Env = unknown> = (
+  controller: TestController,
+  env: Env,
+  ctx: ExecutionContext
+) => void | Promise<void>;
 export interface ExportedHandler<Env = unknown, QueueMessage = unknown> {
   fetch?: ExportedHandlerFetchHandler<Env>;
   trace?: ExportedHandlerTraceHandler<Env>;
   scheduled?: ExportedHandlerScheduledHandler<Env>;
+  test?: ExportedHandlerTestHandler<Env>;
   queue?: ExportedHandlerQueueHandler<Env, QueueMessage>;
 }
 export interface StructuredSerializeOptions {
@@ -1006,6 +1013,10 @@ export declare class Request<CfHostMetadata = unknown> extends Body {
   /** 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<CfHostMetadata>;
+  /** Returns request's subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. [SRI] */
+  readonly integrity: string;
+  /** Returns a boolean indicating whether or not request can outlive the global in which it was created. */
+  readonly keepalive: boolean;
 }
 export interface RequestInit<
   CfType = IncomingRequestCfProperties | RequestInitCfProperties
@@ -1020,6 +1031,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;
 }
@@ -1071,11 +1084,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>>;
@@ -1521,13 +1534,13 @@ export declare class CompressionStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   Uint8Array
 > {
-  constructor(format: "gzip" | "deflate");
+  constructor(format: "gzip" | "deflate" | "deflate-raw");
 }
 export declare class DecompressionStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   Uint8Array
 > {
-  constructor(format: "gzip" | "deflate");
+  constructor(format: "gzip" | "deflate" | "deflate-raw");
 }
 export declare class TextEncoderStream extends TransformStream<
   string,
@@ -1659,6 +1672,7 @@ export declare class URLSearchParams {
       | Record<string, string>
       | [key: string, value: string][]
   );
+  get size(): number;
   append(name: string, value: string): void;
   delete(name: string): void;
   get(name: string): string | null;
@@ -2147,6 +2161,10 @@ export interface IncomingRequestCfPropertiesBotManagementBase {
    * A boolean value that's true if the request matches [file extensions](https://developers.cloudflare.com/bots/reference/static-resources/) for many types of static resources.
    */
   staticResource: boolean;
+  /**
+   * List of IDs that correlate to the Bot Management heuristic detections made on a request (you can have multiple heuristic detections on the same request).
+   */
+  detectionIds: number[];
 }
 export interface IncomingRequestCfPropertiesBotManagement {
   /**
@@ -2729,7 +2747,7 @@ export declare abstract class D1PreparedStatement {
 /**
  * A email message that is sent to a consumer Worker.
  */
-export interface EmailMessage<Body = unknown> {
+export interface EmailMessage {
   /**
    * Envelope From attribute of the email message.
    */
@@ -2815,6 +2833,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.
  */
@@ -2831,6 +2883,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.
@@ -2848,6 +2908,10 @@ 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.

package/package.json

@@ -7,5 +7,5 @@
   },
   "author": "Cloudflare Workers DevProd Team <workers-devprod@cloudflare.com> (https://workers.cloudflare.com)",
   "license": "MIT OR Apache-2.0",
-  "version": "0.20230115.0"
+  "version": "0.20230307.0"
 }