@cloudflare/workers-types 3.7.0 → 3.9.0

package/index.d.ts

@@ -131,7 +131,7 @@ declare type BodyInitializer = BodyInit;
 declare class ByteLengthQueuingStrategy {
   constructor(init: QueuingStrategyInit);
   readonly highWaterMark: number;
-  size(arg1?: any): number | undefined;
+  size(chunk?: any): number;
 }
 
 declare abstract class Cache {
@@ -194,7 +194,7 @@ interface Comment {
 }
 
 declare class CompressionStream extends TransformStream {
-  constructor(format: string);
+  constructor(format: "gzip" | "deflate");
 }
 
 interface Console {
@@ -214,7 +214,7 @@ interface ContentOptions {
 declare class CountQueuingStrategy {
   constructor(init: QueuingStrategyInit);
   readonly highWaterMark: number;
-  size(arg1?: any): number | undefined;
+  size(chunk?: any): number;
 }
 
 declare abstract class Crypto {
@@ -323,7 +323,7 @@ declare class DOMException extends Error {
 }
 
 declare class DecompressionStream extends TransformStream {
-  constructor(format: string);
+  constructor(format: "gzip" | "deflate");
 }
 
 declare class DigestStream extends WritableStream {
@@ -345,6 +345,10 @@ interface DurableObject {
   fetch(request: Request): Promise<Response>;
 }
 
+interface DurableObjectGetAlarmOptions {
+  allowConcurrency?: boolean;
+}
+
 interface DurableObjectGetOptions {
   allowConcurrency?: boolean;
   noCache?: boolean;
@@ -385,6 +389,11 @@ interface DurableObjectPutOptions {
   noCache?: boolean;
 }
 
+interface DurableObjectSetAlarmOptions {
+  allowConcurrency?: boolean;
+  allowUnconfirmed?: boolean;
+}
+
 interface DurableObjectState {
   waitUntil(promise: Promise<any>): void;
   readonly id: DurableObjectId | string;
@@ -419,17 +428,12 @@ interface DurableObjectStorage {
   transaction<T>(
     closure: (txn: DurableObjectTransaction) => Promise<T>
   ): Promise<T>;
-  getAlarm(
-    options?: DurableObjectStorageOperationsGetAlarmOptions
-  ): Promise<Date | null>;
+  getAlarm(options?: DurableObjectGetAlarmOptions): Promise<number | null>;
   setAlarm(
-    arg2: Date,
-    options?: DurableObjectStorageOperationsSetAlarmOptions
+    scheduledTime: number | Date,
+    options?: DurableObjectSetAlarmOptions
   ): Promise<void>;
-}
-
-interface DurableObjectStorageOperationsGetAlarmOptions {
-  allowConcurrency?: boolean;
+  deleteAlarm(options?: DurableObjectSetAlarmOptions): Promise<void>;
 }
 
 /**
@@ -451,11 +455,6 @@ declare type DurableObjectStorageOperationsListOptions =
  */
 declare type DurableObjectStorageOperationsPutOptions = DurableObjectPutOptions;
 
-interface DurableObjectStorageOperationsSetAlarmOptions {
-  allowConcurrency?: boolean;
-  allowUnconfirmed?: boolean;
-}
-
 interface DurableObjectStub extends Fetcher {
   readonly id: DurableObjectId;
   readonly name?: string;
@@ -482,13 +481,12 @@ interface DurableObjectTransaction {
   delete(key: string, options?: DurableObjectPutOptions): Promise<boolean>;
   delete(keys: string[], options?: DurableObjectPutOptions): Promise<number>;
   rollback(): void;
-  getAlarm(
-    options?: DurableObjectStorageOperationsGetAlarmOptions
-  ): Promise<Date | null>;
+  getAlarm(options?: DurableObjectGetAlarmOptions): Promise<number | null>;
   setAlarm(
-    arg2: Date,
-    options?: DurableObjectStorageOperationsSetAlarmOptions
+    scheduledTime: number | Date,
+    options?: DurableObjectSetAlarmOptions
   ): Promise<void>;
+  deleteAlarm(options?: DurableObjectSetAlarmOptions): Promise<void>;
 }
 
 interface Element {
@@ -618,11 +616,15 @@ declare type ExportedHandlerScheduledHandler<Env = unknown> = (
   ctx: ExecutionContext
 ) => void | Promise<void>;
 
+declare class ExtendableEvent extends Event {
+  constructor(type: string, init?: EventInit);
+  waitUntil(promise: Promise<any>): void;
+}
+
 declare abstract class FetchEvent extends Event {
   readonly request: Request;
   respondWith(promise: Response | Promise<Response>): void;
   passThroughOnException(): void;
-  waitUntil(promise: Promise<any>): void;
 }
 
 declare abstract class Fetcher {
@@ -1003,7 +1005,13 @@ interface R2Bucket {
   get(key: string, options?: R2GetOptions): Promise<R2ObjectBody | null>;
   put(
     key: string,
-    value: ReadableStream | ArrayBuffer | ArrayBufferView | string | null,
+    value:
+      | ReadableStream
+      | ArrayBuffer
+      | ArrayBufferView
+      | string
+      | null
+      | Blob,
     options?: R2PutOptions
   ): Promise<R2Object>;
   delete(key: string): Promise<void>;
@@ -1077,7 +1085,7 @@ interface R2ListOptions {
    * }
    * ```
    */
-  include: ("httpMetadata" | "customMetadata")[];
+  include?: ("httpMetadata" | "customMetadata")[];
 }
 
 /**
@@ -1135,12 +1143,15 @@ declare abstract class ReadableByteStreamController {
   readonly byobRequest: ReadableStreamBYOBRequest | null;
   readonly desiredSize: number | null;
   close(): void;
-  enqueue(chunk: ArrayBufferView): void;
+  enqueue(chunk: ArrayBuffer | ArrayBufferView): void;
   error(reason: any): void;
 }
 
 declare class ReadableStream {
-  constructor(underlyingSource?: Object, queuingStrategy?: Object);
+  constructor(
+    underlyingSource?: UnderlyingSource,
+    queuingStrategy?: StreamQueuingStrategy
+  );
   readonly locked: boolean;
   cancel(reason?: any): Promise<void>;
   getReader(options: ReadableStreamGetReaderOptions): ReadableStreamBYOBReader;
@@ -1174,7 +1185,7 @@ declare class ReadableStreamBYOBReader {
 declare abstract class ReadableStreamBYOBRequest {
   readonly view: Uint8Array | null;
   respond(bytesWritten: number): void;
-  respondWithNewView(view: ArrayBufferView): void;
+  respondWithNewView(view: ArrayBuffer | ArrayBufferView): void;
   readonly atLeast: number | null;
 }
 
@@ -1474,11 +1485,10 @@ interface ScheduledController {
   noRetry(): void;
 }
 
-declare abstract class ScheduledEvent extends Event {
+declare abstract class ScheduledEvent extends ExtendableEvent {
   readonly scheduledTime: number;
   readonly cron: string;
   noRetry(): void;
-  waitUntil(promise: Promise<any>): void;
 }
 
 interface Scheduler {
@@ -1814,6 +1824,26 @@ declare type URLSearchParamsInit =
  */
 declare type URLSearchParamsInitializer = URLSearchParamsInit;
 
+interface UnderlyingSink {
+  type?: string;
+  start?(controller: WritableStreamDefaultController): any;
+  write?(chunk: any, controller: WritableStreamDefaultController): any;
+  abort?(reason: any): any;
+  close?(): any;
+}
+
+interface UnderlyingSource {
+  type?: string;
+  autoAllocateChunkSize?: number;
+  start?(
+    controller: ReadableStreamDefaultController | ReadableByteStreamController
+  ): any;
+  pull?(
+    controller: ReadableStreamDefaultController | ReadableByteStreamController
+  ): any;
+  cancel?(reason?: any): any;
+}
+
 declare class WebSocket extends EventTarget<WebSocketEventMap> {
   constructor(url: string, protocols?: string[] | string);
   accept(): void;
@@ -1848,7 +1878,10 @@ declare type WorkerGlobalScopeEventMap = {
 };
 
 declare class WritableStream {
-  constructor(underlyingSink?: Object, queuingStrategy?: Object);
+  constructor(
+    underlyingSink?: UnderlyingSink,
+    queuingStrategy?: StreamQueuingStrategy
+  );
   readonly locked: boolean;
   abort(reason: any): Promise<void>;
   close(): Promise<void>;
@@ -1947,6 +1980,7 @@ type Params<P extends string = any> = Record<P, string | string[]>;
 
 type EventContext<Env, P extends string, Data> = {
   request: Request;
+  functionPath: string;
   waitUntil: (promise: Promise<any>) => void;
   next: (input?: Request | string, init?: RequestInit) => Promise<Response>;
   env: Env & { ASSETS: { fetch: typeof fetch } };
@@ -1959,3 +1993,23 @@ declare type PagesFunction<
   Params extends string = any,
   Data extends Record<string, unknown> = Record<string, unknown>
 > = (context: EventContext<Env, Params, Data>) => Response | Promise<Response>;
+
+type EventPluginContext<Env, P extends string, Data, PluginArgs> = {
+  request: Request;
+  functionPath: string;
+  waitUntil: (promise: Promise<any>) => void;
+  next: (input?: Request | string, init?: RequestInit) => Promise<Response>;
+  env: Env & { ASSETS: { fetch: typeof fetch } };
+  params: Params<P>;
+  data: Data;
+  pluginArgs: PluginArgs;
+};
+
+declare type PagesPluginFunction<
+  Env = unknown,
+  Params extends string = any,
+  Data extends Record<string, unknown> = Record<string, unknown>,
+  PluginArgs = unknown
+> = (
+  context: EventPluginContext<Env, Params, Data, PluginArgs>
+) => Response | Promise<Response>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudflare/workers-types",
-  "version": "3.7.0",
+  "version": "3.9.0",
   "description": "TypeScript typings for Cloudflare Workers",
   "repository": {
     "type": "git",