@cloudflare/workers-types 4.20230518.0 → 4.20230710.0

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

@@ -213,6 +213,7 @@ declare interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   Response: typeof Response;
   WebSocket: typeof WebSocket;
   WebSocketPair: typeof WebSocketPair;
+  WebSocketRequestResponsePair: typeof WebSocketRequestResponsePair;
   AbortController: typeof AbortController;
   AbortSignal: typeof AbortSignal;
   TextDecoder: typeof TextDecoder;
@@ -328,7 +329,7 @@ declare type ExportedHandlerTestHandler<Env = unknown> = (
 ) => void | Promise<void>;
 declare interface ExportedHandler<
   Env = unknown,
-  QueueMessage = unknown,
+  QueueHandlerMessage = unknown,
   CfHostMetadata = unknown
 > {
   fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata>;
@@ -336,7 +337,8 @@ declare interface ExportedHandler<
   trace?: ExportedHandlerTraceHandler<Env>;
   scheduled?: ExportedHandlerScheduledHandler<Env>;
   test?: ExportedHandlerTestHandler<Env>;
-  queue?: ExportedHandlerQueueHandler<Env, Message>;
+  email?: EmailExportedHandler<Env>;
+  queue?: ExportedHandlerQueueHandler<Env, QueueHandlerMessage>;
 }
 declare interface StructuredSerializeOptions {
   transfer?: any[];
@@ -356,6 +358,17 @@ declare interface Performance {
 declare interface DurableObject {
   fetch(request: Request): Response | Promise<Response>;
   alarm?(): void | Promise<void>;
+  webSocketMessage(
+    ws: WebSocket,
+    message: string | ArrayBuffer
+  ): void | Promise<void>;
+  webSocketClose(
+    ws: WebSocket,
+    code: number,
+    reason: string,
+    wasClean: boolean
+  ): void | Promise<void>;
+  webSocketError(ws: WebSocket, error: unknown): void | Promise<void>;
 }
 declare interface DurableObjectStub extends Fetcher {
   readonly id: DurableObjectId;
@@ -402,6 +415,9 @@ declare interface DurableObjectState {
   blockConcurrencyWhile<T>(callback: () => Promise<T>): Promise<T>;
   acceptWebSocket(ws: WebSocket, tags?: string[]): void;
   getWebSockets(tag?: string): WebSocket[];
+  setWebSocketAutoResponse(maybeReqResp?: WebSocketRequestResponsePair): void;
+  getWebSocketAutoResponse(): WebSocketRequestResponsePair | null;
+  getWebSocketAutoResponseTimestamp(ws: WebSocket): Date | null;
 }
 declare interface DurableObjectTransaction {
   get<T = unknown>(
@@ -496,6 +512,11 @@ declare interface DurableObjectSetAlarmOptions {
   allowConcurrency?: boolean;
   allowUnconfirmed?: boolean;
 }
+declare class WebSocketRequestResponsePair {
+  constructor(request: string, response: string);
+  get request(): string;
+  get response(): string;
+}
 declare interface AnalyticsEngineDataset {
   writeDataPoint(event?: AnalyticsEngineDataPoint): void;
 }
@@ -1657,6 +1678,7 @@ declare interface TraceItem {
   readonly eventTimestamp: number | null;
   readonly logs: TraceLog[];
   readonly exceptions: TraceException[];
+  readonly diagnosticsChannelEvents: TraceDiagnosticChannelEvent[];
   readonly scriptName: string | null;
   readonly dispatchNamespace?: string;
   readonly scriptTags?: string[];
@@ -1703,6 +1725,11 @@ declare interface TraceException {
   readonly message: string;
   readonly name: string;
 }
+declare interface TraceDiagnosticChannelEvent {
+  readonly timestamp: number;
+  readonly channel: string;
+  readonly message: any;
+}
 declare interface TraceMetrics {
   readonly cpuTime: number;
   readonly wallTime: number;
@@ -1744,10 +1771,10 @@ declare class URLSearchParams {
   );
   get size(): number;
   append(name: string, value: string): void;
-  delete(name: string, value?: any): void;
+  delete(name: string, value?: string): void;
   get(name: string): string | null;
   getAll(name: string): string[];
-  has(name: string, value?: any): boolean;
+  has(name: string, value?: string): boolean;
   set(name: string, value: string): void;
   sort(): void;
   entries(): IterableIterator<[key: string, value: string]>;
@@ -2853,25 +2880,36 @@ declare type ContinentCode = "AF" | "AN" | "AS" | "EU" | "NA" | "OC" | "SA";
 declare type CfProperties<HostMetadata = unknown> =
   | IncomingRequestCfProperties<HostMetadata>
   | RequestInitCfProperties;
+// Copyright (c) 2022-2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
 declare interface D1Result<T = unknown> {
-  results?: T[];
-  success: boolean;
-  error?: string;
+  results: T[];
+  success: true;
   meta: any;
+  error?: never;
+}
+declare interface D1ExecResult {
+  count: number;
+  duration: number;
 }
 declare abstract class D1Database {
   prepare(query: string): D1PreparedStatement;
   dump(): Promise<ArrayBuffer>;
   batch<T = unknown>(statements: D1PreparedStatement[]): Promise<D1Result<T>[]>;
-  exec<T = unknown>(query: string): Promise<D1Result<T>>;
+  exec<T = unknown>(query: string): Promise<D1ExecResult>;
 }
 declare abstract class D1PreparedStatement {
   bind(...values: any[]): D1PreparedStatement;
-  first<T = unknown>(colName?: string): Promise<T>;
+  first<T = unknown>(colName: string): Promise<T | null>;
+  first<T = unknown>(): Promise<Record<string, T> | null>;
   run<T = unknown>(): Promise<D1Result<T>>;
-  all<T = unknown>(): Promise<D1Result<T>>;
+  all<T = unknown>(): Promise<D1Result<T[]>>;
   raw<T = unknown>(): Promise<T[]>;
 }
+// Copyright (c) 2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
 /**
  * An email message that can be sent from a Worker.
  */
@@ -2936,6 +2974,9 @@ declare module "cloudflare:email" {
   };
   export { _EmailMessage as EmailMessage };
 }
+// Copyright (c) 2022-2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
 declare type Params<P extends string = any> = Record<P, string | string[]>;
 declare type EventContext<Env, P extends string, Data> = {
   request: Request;
@@ -2982,6 +3023,9 @@ declare type PagesPluginFunction<
 declare module "assets:*" {
   export const onRequest: PagesFunction;
 }
+// Copyright (c) 2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
 // https://developers.cloudflare.com/pub-sub/
 // PubSubMessage represents an incoming PubSub message.
 // The message includes metadata about the broker, the client, and the payload
@@ -3016,6 +3060,9 @@ declare interface JsonWebKeyWithKid extends JsonWebKey {
   // Key Identifier of the JWK
   readonly kid: string;
 }
+// Copyright (c) 2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
 declare module "cloudflare:sockets" {
   function _connect(
     address: string | SocketAddress,
@@ -3023,6 +3070,9 @@ declare module "cloudflare:sockets" {
   ): Socket;
   export { _connect as connect };
 }
+// Copyright (c) 2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
 // https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
 declare interface DynamicDispatchLimits {
   /**

package/2022-10-31/index.ts

@@ -213,6 +213,7 @@ export interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   Response: typeof Response;
   WebSocket: typeof WebSocket;
   WebSocketPair: typeof WebSocketPair;
+  WebSocketRequestResponsePair: typeof WebSocketRequestResponsePair;
   AbortController: typeof AbortController;
   AbortSignal: typeof AbortSignal;
   TextDecoder: typeof TextDecoder;
@@ -330,7 +331,7 @@ export type ExportedHandlerTestHandler<Env = unknown> = (
 ) => void | Promise<void>;
 export interface ExportedHandler<
   Env = unknown,
-  QueueMessage = unknown,
+  QueueHandlerMessage = unknown,
   CfHostMetadata = unknown
 > {
   fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata>;
@@ -338,7 +339,8 @@ export interface ExportedHandler<
   trace?: ExportedHandlerTraceHandler<Env>;
   scheduled?: ExportedHandlerScheduledHandler<Env>;
   test?: ExportedHandlerTestHandler<Env>;
-  queue?: ExportedHandlerQueueHandler<Env, Message>;
+  email?: EmailExportedHandler<Env>;
+  queue?: ExportedHandlerQueueHandler<Env, QueueHandlerMessage>;
 }
 export interface StructuredSerializeOptions {
   transfer?: any[];
@@ -358,6 +360,17 @@ export interface Performance {
 export interface DurableObject {
   fetch(request: Request): Response | Promise<Response>;
   alarm?(): void | Promise<void>;
+  webSocketMessage(
+    ws: WebSocket,
+    message: string | ArrayBuffer
+  ): void | Promise<void>;
+  webSocketClose(
+    ws: WebSocket,
+    code: number,
+    reason: string,
+    wasClean: boolean
+  ): void | Promise<void>;
+  webSocketError(ws: WebSocket, error: unknown): void | Promise<void>;
 }
 export interface DurableObjectStub extends Fetcher {
   readonly id: DurableObjectId;
@@ -404,6 +417,9 @@ export interface DurableObjectState {
   blockConcurrencyWhile<T>(callback: () => Promise<T>): Promise<T>;
   acceptWebSocket(ws: WebSocket, tags?: string[]): void;
   getWebSockets(tag?: string): WebSocket[];
+  setWebSocketAutoResponse(maybeReqResp?: WebSocketRequestResponsePair): void;
+  getWebSocketAutoResponse(): WebSocketRequestResponsePair | null;
+  getWebSocketAutoResponseTimestamp(ws: WebSocket): Date | null;
 }
 export interface DurableObjectTransaction {
   get<T = unknown>(
@@ -498,6 +514,11 @@ export interface DurableObjectSetAlarmOptions {
   allowConcurrency?: boolean;
   allowUnconfirmed?: boolean;
 }
+export declare class WebSocketRequestResponsePair {
+  constructor(request: string, response: string);
+  get request(): string;
+  get response(): string;
+}
 export interface AnalyticsEngineDataset {
   writeDataPoint(event?: AnalyticsEngineDataPoint): void;
 }
@@ -1662,6 +1683,7 @@ export interface TraceItem {
   readonly eventTimestamp: number | null;
   readonly logs: TraceLog[];
   readonly exceptions: TraceException[];
+  readonly diagnosticsChannelEvents: TraceDiagnosticChannelEvent[];
   readonly scriptName: string | null;
   readonly dispatchNamespace?: string;
   readonly scriptTags?: string[];
@@ -1708,6 +1730,11 @@ export interface TraceException {
   readonly message: string;
   readonly name: string;
 }
+export interface TraceDiagnosticChannelEvent {
+  readonly timestamp: number;
+  readonly channel: string;
+  readonly message: any;
+}
 export interface TraceMetrics {
   readonly cpuTime: number;
   readonly wallTime: number;
@@ -1749,10 +1776,10 @@ export declare class URLSearchParams {
   );
   get size(): number;
   append(name: string, value: string): void;
-  delete(name: string, value?: any): void;
+  delete(name: string, value?: string): void;
   get(name: string): string | null;
   getAll(name: string): string[];
-  has(name: string, value?: any): boolean;
+  has(name: string, value?: string): boolean;
   set(name: string, value: string): void;
   sort(): void;
   entries(): IterableIterator<[key: string, value: string]>;
@@ -2858,25 +2885,36 @@ export type ContinentCode = "AF" | "AN" | "AS" | "EU" | "NA" | "OC" | "SA";
 export type CfProperties<HostMetadata = unknown> =
   | IncomingRequestCfProperties<HostMetadata>
   | RequestInitCfProperties;
+// Copyright (c) 2022-2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
 export interface D1Result<T = unknown> {
-  results?: T[];
-  success: boolean;
-  error?: string;
+  results: T[];
+  success: true;
   meta: any;
+  error?: never;
+}
+export interface D1ExecResult {
+  count: number;
+  duration: number;
 }
 export declare abstract class D1Database {
   prepare(query: string): D1PreparedStatement;
   dump(): Promise<ArrayBuffer>;
   batch<T = unknown>(statements: D1PreparedStatement[]): Promise<D1Result<T>[]>;
-  exec<T = unknown>(query: string): Promise<D1Result<T>>;
+  exec<T = unknown>(query: string): Promise<D1ExecResult>;
 }
 export declare abstract class D1PreparedStatement {
   bind(...values: any[]): D1PreparedStatement;
-  first<T = unknown>(colName?: string): Promise<T>;
+  first<T = unknown>(colName: string): Promise<T | null>;
+  first<T = unknown>(): Promise<Record<string, T> | null>;
   run<T = unknown>(): Promise<D1Result<T>>;
-  all<T = unknown>(): Promise<D1Result<T>>;
+  all<T = unknown>(): Promise<D1Result<T[]>>;
   raw<T = unknown>(): Promise<T[]>;
 }
+// Copyright (c) 2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
 /**
  * An email message that can be sent from a Worker.
  */
@@ -2934,6 +2972,9 @@ export type EmailExportedHandler<Env = unknown> = (
   env: Env,
   ctx: ExecutionContext
 ) => void | Promise<void>;
+// Copyright (c) 2022-2023 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 Params<P extends string = any> = Record<P, string | string[]>;
 export type EventContext<Env, P extends string, Data> = {
   request: Request;
@@ -2977,6 +3018,9 @@ export type PagesPluginFunction<
 > = (
   context: EventPluginContext<Env, Params, Data, PluginArgs>
 ) => Response | Promise<Response>;
+// Copyright (c) 2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
 // https://developers.cloudflare.com/pub-sub/
 // PubSubMessage represents an incoming PubSub message.
 // The message includes metadata about the broker, the client, and the payload
@@ -3011,6 +3055,9 @@ export interface JsonWebKeyWithKid extends JsonWebKey {
   // Key Identifier of the JWK
   readonly kid: string;
 }
+// Copyright (c) 2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
 // https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
 export interface DynamicDispatchLimits {
   /**

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

@@ -217,6 +217,7 @@ declare interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   Response: typeof Response;
   WebSocket: typeof WebSocket;
   WebSocketPair: typeof WebSocketPair;
+  WebSocketRequestResponsePair: typeof WebSocketRequestResponsePair;
   AbortController: typeof AbortController;
   AbortSignal: typeof AbortSignal;
   TextDecoder: typeof TextDecoder;
@@ -332,7 +333,7 @@ declare type ExportedHandlerTestHandler<Env = unknown> = (
 ) => void | Promise<void>;
 declare interface ExportedHandler<
   Env = unknown,
-  QueueMessage = unknown,
+  QueueHandlerMessage = unknown,
   CfHostMetadata = unknown
 > {
   fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata>;
@@ -340,7 +341,8 @@ declare interface ExportedHandler<
   trace?: ExportedHandlerTraceHandler<Env>;
   scheduled?: ExportedHandlerScheduledHandler<Env>;
   test?: ExportedHandlerTestHandler<Env>;
-  queue?: ExportedHandlerQueueHandler<Env, Message>;
+  email?: EmailExportedHandler<Env>;
+  queue?: ExportedHandlerQueueHandler<Env, QueueHandlerMessage>;
 }
 declare interface StructuredSerializeOptions {
   transfer?: any[];
@@ -360,6 +362,17 @@ declare interface Performance {
 declare interface DurableObject {
   fetch(request: Request): Response | Promise<Response>;
   alarm?(): void | Promise<void>;
+  webSocketMessage(
+    ws: WebSocket,
+    message: string | ArrayBuffer
+  ): void | Promise<void>;
+  webSocketClose(
+    ws: WebSocket,
+    code: number,
+    reason: string,
+    wasClean: boolean
+  ): void | Promise<void>;
+  webSocketError(ws: WebSocket, error: unknown): void | Promise<void>;
 }
 declare interface DurableObjectStub extends Fetcher {
   readonly id: DurableObjectId;
@@ -406,6 +419,9 @@ declare interface DurableObjectState {
   blockConcurrencyWhile<T>(callback: () => Promise<T>): Promise<T>;
   acceptWebSocket(ws: WebSocket, tags?: string[]): void;
   getWebSockets(tag?: string): WebSocket[];
+  setWebSocketAutoResponse(maybeReqResp?: WebSocketRequestResponsePair): void;
+  getWebSocketAutoResponse(): WebSocketRequestResponsePair | null;
+  getWebSocketAutoResponseTimestamp(ws: WebSocket): Date | null;
 }
 declare interface DurableObjectTransaction {
   get<T = unknown>(
@@ -500,6 +516,11 @@ declare interface DurableObjectSetAlarmOptions {
   allowConcurrency?: boolean;
   allowUnconfirmed?: boolean;
 }
+declare class WebSocketRequestResponsePair {
+  constructor(request: string, response: string);
+  get request(): string;
+  get response(): string;
+}
 declare interface AnalyticsEngineDataset {
   writeDataPoint(event?: AnalyticsEngineDataPoint): void;
 }
@@ -1660,6 +1681,7 @@ declare interface TraceItem {
   readonly eventTimestamp: number | null;
   readonly logs: TraceLog[];
   readonly exceptions: TraceException[];
+  readonly diagnosticsChannelEvents: TraceDiagnosticChannelEvent[];
   readonly scriptName: string | null;
   readonly dispatchNamespace?: string;
   readonly scriptTags?: string[];
@@ -1706,6 +1728,11 @@ declare interface TraceException {
   readonly message: string;
   readonly name: string;
 }
+declare interface TraceDiagnosticChannelEvent {
+  readonly timestamp: number;
+  readonly channel: string;
+  readonly message: any;
+}
 declare interface TraceMetrics {
   readonly cpuTime: number;
   readonly wallTime: number;
@@ -1747,10 +1774,10 @@ declare class URLSearchParams {
   );
   get size(): number;
   append(name: string, value: string): void;
-  delete(name: string, value?: any): void;
+  delete(name: string, value?: string): void;
   get(name: string): string | null;
   getAll(name: string): string[];
-  has(name: string, value?: any): boolean;
+  has(name: string, value?: string): boolean;
   set(name: string, value: string): void;
   sort(): void;
   entries(): IterableIterator<[key: string, value: string]>;
@@ -2856,25 +2883,36 @@ declare type ContinentCode = "AF" | "AN" | "AS" | "EU" | "NA" | "OC" | "SA";
 declare type CfProperties<HostMetadata = unknown> =
   | IncomingRequestCfProperties<HostMetadata>
   | RequestInitCfProperties;
+// Copyright (c) 2022-2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
 declare interface D1Result<T = unknown> {
-  results?: T[];
-  success: boolean;
-  error?: string;
+  results: T[];
+  success: true;
   meta: any;
+  error?: never;
+}
+declare interface D1ExecResult {
+  count: number;
+  duration: number;
 }
 declare abstract class D1Database {
   prepare(query: string): D1PreparedStatement;
   dump(): Promise<ArrayBuffer>;
   batch<T = unknown>(statements: D1PreparedStatement[]): Promise<D1Result<T>[]>;
-  exec<T = unknown>(query: string): Promise<D1Result<T>>;
+  exec<T = unknown>(query: string): Promise<D1ExecResult>;
 }
 declare abstract class D1PreparedStatement {
   bind(...values: any[]): D1PreparedStatement;
-  first<T = unknown>(colName?: string): Promise<T>;
+  first<T = unknown>(colName: string): Promise<T | null>;
+  first<T = unknown>(): Promise<Record<string, T> | null>;
   run<T = unknown>(): Promise<D1Result<T>>;
-  all<T = unknown>(): Promise<D1Result<T>>;
+  all<T = unknown>(): Promise<D1Result<T[]>>;
   raw<T = unknown>(): Promise<T[]>;
 }
+// Copyright (c) 2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
 /**
  * An email message that can be sent from a Worker.
  */
@@ -2939,6 +2977,9 @@ declare module "cloudflare:email" {
   };
   export { _EmailMessage as EmailMessage };
 }
+// Copyright (c) 2022-2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
 declare type Params<P extends string = any> = Record<P, string | string[]>;
 declare type EventContext<Env, P extends string, Data> = {
   request: Request;
@@ -2985,6 +3026,9 @@ declare type PagesPluginFunction<
 declare module "assets:*" {
   export const onRequest: PagesFunction;
 }
+// Copyright (c) 2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
 // https://developers.cloudflare.com/pub-sub/
 // PubSubMessage represents an incoming PubSub message.
 // The message includes metadata about the broker, the client, and the payload
@@ -3019,6 +3063,9 @@ declare interface JsonWebKeyWithKid extends JsonWebKey {
   // Key Identifier of the JWK
   readonly kid: string;
 }
+// Copyright (c) 2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
 declare module "cloudflare:sockets" {
   function _connect(
     address: string | SocketAddress,
@@ -3026,6 +3073,9 @@ declare module "cloudflare:sockets" {
   ): Socket;
   export { _connect as connect };
 }
+// Copyright (c) 2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
 // https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
 declare interface DynamicDispatchLimits {
   /**