@cloudflare/workers-types 4.20230404.0 → 4.20230511.0

package/2021-11-03/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;
 };
@@ -183,11 +184,14 @@ declare interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   crypto: Crypto;
   caches: CacheStorage;
   scheduler: Scheduler;
+  performance: Performance;
+  readonly origin: string;
   Event: typeof Event;
   ExtendableEvent: typeof ExtendableEvent;
   PromiseRejectionEvent: typeof PromiseRejectionEvent;
   FetchEvent: typeof FetchEvent;
-  TraceEvent: typeof TraceEvent;
+  TailEvent: typeof TailEvent;
+  TraceEvent: typeof TailEvent;
   ScheduledEvent: typeof ScheduledEvent;
   MessageEvent: typeof MessageEvent;
   CloseEvent: typeof CloseEvent;
@@ -279,6 +283,8 @@ declare const self: ServiceWorkerGlobalScope;
 declare const crypto: Crypto;
 declare const caches: CacheStorage;
 declare const scheduler: Scheduler;
+declare const performance: Performance;
+declare const origin: string;
 declare interface TestController {}
 declare interface ExecutionContext {
   waitUntil(promise: Promise<any>): void;
@@ -292,6 +298,11 @@ declare type ExportedHandlerFetchHandler<
   env: Env,
   ctx: ExecutionContext
 ) => Response | Promise<Response>;
+declare type ExportedHandlerTailHandler<Env = unknown> = (
+  events: TraceItem[],
+  env: Env,
+  ctx: ExecutionContext
+) => void | Promise<void>;
 declare type ExportedHandlerTraceHandler<Env = unknown> = (
   traces: TraceItem[],
   env: Env,
@@ -318,10 +329,11 @@ declare interface ExportedHandler<
   CfHostMetadata = unknown
 > {
   fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata>;
+  tail?: ExportedHandlerTailHandler<Env>;
   trace?: ExportedHandlerTraceHandler<Env>;
   scheduled?: ExportedHandlerScheduledHandler<Env>;
   test?: ExportedHandlerTestHandler<Env>;
-  queue?: ExportedHandlerQueueHandler<Env, QueueMessage>;
+  queue?: ExportedHandlerQueueHandler<Env, Message>;
 }
 declare interface StructuredSerializeOptions {
   transfer?: any[];
@@ -330,6 +342,11 @@ declare abstract class PromiseRejectionEvent extends Event {
   readonly promise: Promise<any>;
   readonly reason: any;
 }
+/** Provides access to performance-related information for the current page. It's part of the High Resolution Time API, but is enhanced by the Performance Timeline API, the Navigation Timing API, the User Timing API, and the Resource Timing API. */
+declare interface Performance {
+  readonly timeOrigin: number;
+  now(): number;
+}
 declare interface DurableObject {
   fetch(request: Request): Response | Promise<Response>;
   alarm?(): void | Promise<void>;
@@ -377,6 +394,8 @@ declare interface DurableObjectState {
   readonly id: DurableObjectId;
   readonly storage: DurableObjectStorage;
   blockConcurrencyWhile<T>(callback: () => Promise<T>): Promise<T>;
+  acceptWebSocket(ws: WebSocket, tags?: string[]): void;
+  getWebSockets(tag?: string): WebSocket[];
 }
 declare interface DurableObjectTransaction {
   get<T = unknown>(
@@ -563,6 +582,7 @@ declare class AbortController {
 declare abstract class AbortSignal extends EventTarget {
   static abort(reason?: any): AbortSignal;
   static timeout(delay: number): AbortSignal;
+  static any(signals: AbortSignal[]): AbortSignal;
   /** Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise. */
   readonly aborted: boolean;
   readonly reason: any;
@@ -1058,6 +1078,7 @@ declare interface RequestInit<Cf = CfProperties> {
 }
 declare abstract class Fetcher {
   fetch(input: RequestInfo, init?: RequestInit): Promise<Response>;
+  connect(address: SocketAddress | string, options?: SocketOptions): Socket;
 }
 declare interface FetcherPutOptions {
   expiration?: number;
@@ -1170,6 +1191,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;
@@ -1603,7 +1651,8 @@ declare interface QueuingStrategyInit {
    */
   highWaterMark: number;
 }
-declare abstract class TraceEvent extends ExtendableEvent {
+declare abstract class TailEvent extends ExtendableEvent {
+  readonly events: TraceItem[];
   readonly traces: TraceItem[];
 }
 declare interface TraceItem {
@@ -1803,6 +1852,8 @@ declare class WebSocket extends EventTarget<WebSocketEventMap> {
   accept(): void;
   send(message: (ArrayBuffer | ArrayBufferView) | string): void;
   close(code?: number, reason?: string): void;
+  serializeAttachment(attachment: any): void;
+  deserializeAttachment(): any | null;
   static readonly READY_STATE_CONNECTING: number;
   static readonly READY_STATE_OPEN: number;
   static readonly READY_STATE_CLOSING: number;
@@ -1822,6 +1873,24 @@ declare const WebSocketPair: {
     1: WebSocket;
   };
 };
+declare interface Socket {
+  get readable(): ReadableStream;
+  get writable(): WritableStream;
+  get closed(): Promise<void>;
+  close(): Promise<void>;
+  startTls(options?: TlsOptions): Socket;
+}
+declare interface SocketOptions {
+  secureTransport?: string;
+  allowHalfOpen: boolean;
+}
+declare interface SocketAddress {
+  hostname: string;
+  port: number;
+}
+declare interface TlsOptions {
+  expectedServerHostname?: string;
+}
 declare interface BasicImageTransformations {
   /**
    * Maximum width in image pixels. The value must be an integer.
@@ -2211,8 +2280,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
    */
@@ -2957,75 +3025,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> {
+// https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
+declare interface DispatchNamespace {
   /**
-   * A unique, system-generated ID for the message.
+   * @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.
    */
-  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>[];
-  /**
-   * 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.
- */
-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;
 }

package/2021-11-03/index.ts

@@ -49,6 +49,7 @@ export declare class DOMException extends Error {
 export type WorkerGlobalScopeEventMap = {
   fetch: FetchEvent;
   scheduled: ScheduledEvent;
+  queue: QueueEvent;
   unhandledrejection: PromiseRejectionEvent;
   rejectionhandled: PromiseRejectionEvent;
 };
@@ -183,11 +184,14 @@ export interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   crypto: Crypto;
   caches: CacheStorage;
   scheduler: Scheduler;
+  performance: Performance;
+  readonly origin: string;
   Event: typeof Event;
   ExtendableEvent: typeof ExtendableEvent;
   PromiseRejectionEvent: typeof PromiseRejectionEvent;
   FetchEvent: typeof FetchEvent;
-  TraceEvent: typeof TraceEvent;
+  TailEvent: typeof TailEvent;
+  TraceEvent: typeof TailEvent;
   ScheduledEvent: typeof ScheduledEvent;
   MessageEvent: typeof MessageEvent;
   CloseEvent: typeof CloseEvent;
@@ -281,6 +285,8 @@ export declare const self: ServiceWorkerGlobalScope;
 export declare const crypto: Crypto;
 export declare const caches: CacheStorage;
 export declare const scheduler: Scheduler;
+export declare const performance: Performance;
+export declare const origin: string;
 export interface TestController {}
 export interface ExecutionContext {
   waitUntil(promise: Promise<any>): void;
@@ -294,6 +300,11 @@ export type ExportedHandlerFetchHandler<
   env: Env,
   ctx: ExecutionContext
 ) => Response | Promise<Response>;
+export type ExportedHandlerTailHandler<Env = unknown> = (
+  events: TraceItem[],
+  env: Env,
+  ctx: ExecutionContext
+) => void | Promise<void>;
 export type ExportedHandlerTraceHandler<Env = unknown> = (
   traces: TraceItem[],
   env: Env,
@@ -320,10 +331,11 @@ export interface ExportedHandler<
   CfHostMetadata = unknown
 > {
   fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata>;
+  tail?: ExportedHandlerTailHandler<Env>;
   trace?: ExportedHandlerTraceHandler<Env>;
   scheduled?: ExportedHandlerScheduledHandler<Env>;
   test?: ExportedHandlerTestHandler<Env>;
-  queue?: ExportedHandlerQueueHandler<Env, QueueMessage>;
+  queue?: ExportedHandlerQueueHandler<Env, Message>;
 }
 export interface StructuredSerializeOptions {
   transfer?: any[];
@@ -332,6 +344,11 @@ export declare abstract class PromiseRejectionEvent extends Event {
   readonly promise: Promise<any>;
   readonly reason: any;
 }
+/** Provides access to performance-related information for the current page. It's part of the High Resolution Time API, but is enhanced by the Performance Timeline API, the Navigation Timing API, the User Timing API, and the Resource Timing API. */
+export interface Performance {
+  readonly timeOrigin: number;
+  now(): number;
+}
 export interface DurableObject {
   fetch(request: Request): Response | Promise<Response>;
   alarm?(): void | Promise<void>;
@@ -379,6 +396,8 @@ export interface DurableObjectState {
   readonly id: DurableObjectId;
   readonly storage: DurableObjectStorage;
   blockConcurrencyWhile<T>(callback: () => Promise<T>): Promise<T>;
+  acceptWebSocket(ws: WebSocket, tags?: string[]): void;
+  getWebSockets(tag?: string): WebSocket[];
 }
 export interface DurableObjectTransaction {
   get<T = unknown>(
@@ -565,6 +584,7 @@ export declare class AbortController {
 export declare abstract class AbortSignal extends EventTarget {
   static abort(reason?: any): AbortSignal;
   static timeout(delay: number): AbortSignal;
+  static any(signals: AbortSignal[]): AbortSignal;
   /** Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise. */
   readonly aborted: boolean;
   readonly reason: any;
@@ -1060,6 +1080,7 @@ export interface RequestInit<Cf = CfProperties> {
 }
 export declare abstract class Fetcher {
   fetch(input: RequestInfo, init?: RequestInit): Promise<Response>;
+  connect(address: SocketAddress | string, options?: SocketOptions): Socket;
 }
 export interface FetcherPutOptions {
   expiration?: number;
@@ -1172,6 +1193,33 @@ export interface KVNamespaceGetWithMetadataResult<Value, Metadata> {
   value: Value | null;
   metadata: Metadata | null;
 }
+export interface Queue<Body> {
+  send(message: Body): Promise<void>;
+  sendBatch(messages: Iterable<MessageSendRequest<Body>>): Promise<void>;
+}
+export interface QueueSendOptions {}
+export interface MessageSendRequest<Body = unknown> {
+  body: Body;
+}
+export interface Message<Body = unknown> {
+  readonly id: string;
+  readonly timestamp: Date;
+  readonly body: Body;
+  retry(): void;
+  ack(): void;
+}
+export interface QueueEvent<Body = unknown> extends ExtendableEvent {
+  readonly messages: readonly Message<Body>[];
+  readonly queue: string;
+  retryAll(): void;
+  ackAll(): void;
+}
+export interface MessageBatch<Body = unknown> {
+  readonly messages: readonly Message<Body>[];
+  readonly queue: string;
+  retryAll(): void;
+  ackAll(): void;
+}
 export interface R2Error extends Error {
   readonly name: string;
   readonly code: number;
@@ -1608,7 +1656,8 @@ export interface QueuingStrategyInit {
    */
   highWaterMark: number;
 }
-export declare abstract class TraceEvent extends ExtendableEvent {
+export declare abstract class TailEvent extends ExtendableEvent {
+  readonly events: TraceItem[];
   readonly traces: TraceItem[];
 }
 export interface TraceItem {
@@ -1808,6 +1857,8 @@ export declare class WebSocket extends EventTarget<WebSocketEventMap> {
   accept(): void;
   send(message: (ArrayBuffer | ArrayBufferView) | string): void;
   close(code?: number, reason?: string): void;
+  serializeAttachment(attachment: any): void;
+  deserializeAttachment(): any | null;
   static readonly READY_STATE_CONNECTING: number;
   static readonly READY_STATE_OPEN: number;
   static readonly READY_STATE_CLOSING: number;
@@ -1827,6 +1878,24 @@ export declare const WebSocketPair: {
     1: WebSocket;
   };
 };
+export interface Socket {
+  get readable(): ReadableStream;
+  get writable(): WritableStream;
+  get closed(): Promise<void>;
+  close(): Promise<void>;
+  startTls(options?: TlsOptions): Socket;
+}
+export interface SocketOptions {
+  secureTransport?: string;
+  allowHalfOpen: boolean;
+}
+export interface SocketAddress {
+  hostname: string;
+  port: number;
+}
+export interface TlsOptions {
+  expectedServerHostname?: string;
+}
 export interface BasicImageTransformations {
   /**
    * Maximum width in image pixels. The value must be an integer.
@@ -2216,8 +2285,7 @@ export interface IncomingRequestCfPropertiesBase
 export 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
    */
@@ -2952,75 +3020,12 @@ export interface JsonWebKeyWithKid extends JsonWebKey {
   // Key Identifier of the JWK
   readonly kid: string;
 }
-/**
- * A message that is sent to a consumer Worker.
- */
-export interface Message<Body = unknown> {
+// https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
+export interface DispatchNamespace {
   /**
-   * A unique, system-generated ID for the message.
+   * @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.
    */
-  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.
- */
-export 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>[];
-  /**
-   * 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.
- */
-export type MessageSendRequest<Body = unknown> = {
-  /**
-   * The body of the message.
-   */
-  body: Body;
-};
-/**
- * A binding that allows a producer to send messages to a Queue.
- */
-export 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;
 }