@openworkers/workers-types 0.1.5 → 0.1.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 OpenWorkers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openworkers/workers-types",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "TypeScript types for the OpenWorkers runtime",
   "license": "MIT",
   "repository": {
@@ -18,6 +18,9 @@
     "index.d.ts",
     "types/*.d.ts"
   ],
+  "scripts": {
+    "format": "prettier --write ."
+  },
   "peerDependencies": {
     "typescript": "^5"
   },
@@ -25,5 +28,8 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/",
     "provenance": true
+  },
+  "devDependencies": {
+    "prettier": "^3.8.1"
   }
 }

package/types/bindings.d.ts

@@ -18,10 +18,10 @@ declare global {
   interface BindingAssets {
     /**
      * Fetches a static asset from the bundle.
-     * @param path The asset path (e.g., "/index.html").
-     * @param options Optional request options.
+     * @param input The asset path, URL, or request.
+     * @param init Optional request options.
      */
-    fetch(path: string, options?: RequestInit): Promise<Response>;
+    fetch(input: Request | string | URL, init?: RequestInit): Promise<Response>;
   }
 
   /**
@@ -124,13 +124,7 @@ declare global {
    * Supports strings, numbers, booleans, null, arrays, and objects.
    * Note: Binary data (Uint8Array, ArrayBuffer) is not supported.
    */
-  type JsonValue =
-    | string
-    | number
-    | boolean
-    | null
-    | JsonValue[]
-    | { [key: string]: JsonValue };
+  type JsonValue = string | number | boolean | null | JsonValue[] | { [key: string]: JsonValue };
 
   /**
    * Key-Value storage binding for fast, low-latency data access.
@@ -217,9 +211,9 @@ declare global {
   interface BindingWorker {
     /**
      * Calls another worker with a request.
-     * @param request The request to send.
-     * @param init Optional request options (when using string URL).
+     * @param input The request, URL, or string URL to send.
+     * @param init Optional request options.
      */
-    fetch(request: Request | string, init?: RequestInit): Promise<Response>;
+    fetch(input: Request | string | URL, init?: RequestInit): Promise<Response>;
   }
 }

package/types/blob.d.ts

@@ -19,10 +19,7 @@ declare global {
      * @param blobParts Array of data to include in the blob.
      * @param options Optional settings like MIME type.
      */
-    constructor(
-      blobParts?: (ArrayBuffer | Uint8Array | Blob | string)[],
-      options?: { type?: string }
-    );
+    constructor(blobParts?: (ArrayBuffer | Uint8Array | Blob | string)[], options?: { type?: string });
 
     /** The size of the blob in bytes. */
     readonly size: number;
@@ -104,9 +101,7 @@ declare global {
     set(name: string, value: string | Blob, filename?: string): void;
 
     /** Executes a callback for each key/value pair. */
-    forEach(
-      callback: (value: string | File, key: string, parent: FormData) => void
-    ): void;
+    forEach(callback: (value: string | File, key: string, parent: FormData) => void): void;
 
     /** Returns an iterator of all key/value pairs. */
     entries(): IterableIterator<[string, string | File]>;

package/types/crypto.d.ts

@@ -18,10 +18,7 @@ declare global {
      * const hash = await crypto.subtle.digest('SHA-256', new TextEncoder().encode('hello'));
      * ```
      */
-    digest(
-      algorithm: string | { name: string },
-      data: BufferSource
-    ): Promise<ArrayBuffer>;
+    digest(algorithm: string | { name: string }, data: BufferSource): Promise<ArrayBuffer>;
 
     /**
      * Encrypts data using a key.
@@ -29,11 +26,7 @@ declare global {
      * @param key The encryption key.
      * @param data The data to encrypt.
      */
-    encrypt(
-      algorithm: unknown,
-      key: CryptoKey,
-      data: BufferSource
-    ): Promise<ArrayBuffer>;
+    encrypt(algorithm: unknown, key: CryptoKey, data: BufferSource): Promise<ArrayBuffer>;
 
     /**
      * Decrypts data using a key.
@@ -41,11 +34,7 @@ declare global {
      * @param key The decryption key.
      * @param data The data to decrypt.
      */
-    decrypt(
-      algorithm: unknown,
-      key: CryptoKey,
-      data: BufferSource
-    ): Promise<ArrayBuffer>;
+    decrypt(algorithm: unknown, key: CryptoKey, data: BufferSource): Promise<ArrayBuffer>;
 
     /**
      * Signs data using a private key.
@@ -53,11 +42,7 @@ declare global {
      * @param key The private key.
      * @param data The data to sign.
      */
-    sign(
-      algorithm: unknown,
-      key: CryptoKey,
-      data: BufferSource
-    ): Promise<ArrayBuffer>;
+    sign(algorithm: unknown, key: CryptoKey, data: BufferSource): Promise<ArrayBuffer>;
 
     /**
      * Verifies a signature using a public key.
@@ -67,12 +52,7 @@ declare global {
      * @param data The original data.
      * @returns True if the signature is valid.
      */
-    verify(
-      algorithm: unknown,
-      key: CryptoKey,
-      signature: BufferSource,
-      data: BufferSource
-    ): Promise<boolean>;
+    verify(algorithm: unknown, key: CryptoKey, signature: BufferSource, data: BufferSource): Promise<boolean>;
 
     /**
      * Generates a new cryptographic key or key pair.
@@ -80,11 +60,7 @@ declare global {
      * @param extractable Whether the key can be exported.
      * @param keyUsages The allowed operations for this key.
      */
-    generateKey(
-      algorithm: unknown,
-      extractable: boolean,
-      keyUsages: string[]
-    ): Promise<CryptoKey | CryptoKeyPair>;
+    generateKey(algorithm: unknown, extractable: boolean, keyUsages: string[]): Promise<CryptoKey | CryptoKeyPair>;
 
     /**
      * Imports a key from external format.
@@ -107,10 +83,7 @@ declare global {
      * @param format The key format ("raw", "pkcs8", "spki", "jwk").
      * @param key The key to export.
      */
-    exportKey(
-      format: string,
-      key: CryptoKey
-    ): Promise<ArrayBuffer | JsonWebKey>;
+    exportKey(format: string, key: CryptoKey): Promise<ArrayBuffer | JsonWebKey>;
 
     /**
      * Derives bits from a base key.
@@ -118,11 +91,7 @@ declare global {
      * @param baseKey The base key.
      * @param length The number of bits to derive.
      */
-    deriveBits(
-      algorithm: unknown,
-      baseKey: CryptoKey,
-      length: number
-    ): Promise<ArrayBuffer>;
+    deriveBits(algorithm: unknown, baseKey: CryptoKey, length: number): Promise<ArrayBuffer>;
 
     /**
      * Derives a new key from a base key.

package/types/encoding.d.ts

@@ -36,10 +36,7 @@ declare global {
      * @param destination The buffer to write into.
      * @returns An object with `read` (chars read) and `written` (bytes written).
      */
-    encodeInto(
-      source: string,
-      destination: Uint8Array
-    ): { read: number; written: number };
+    encodeInto(source: string, destination: Uint8Array): { read: number; written: number };
   }
 
   /**

package/types/fetch.d.ts

@@ -5,14 +5,7 @@ export {};
 /**
  * Valid types for a request or response body.
  */
-type BodyInit =
-  | ReadableStream
-  | Blob
-  | ArrayBuffer
-  | Uint8Array
-  | FormData
-  | URLSearchParams
-  | string;
+type BodyInit = ReadableStream | Blob | ArrayBuffer | Uint8Array | FormData | URLSearchParams | string;
 
 /**
  * Valid types for initializing Headers.
@@ -82,7 +75,7 @@ declare global {
     body?: BodyInit | null;
 
     /** How to handle redirects: "follow", "error", or "manual". */
-    redirect?: "follow" | "error" | "manual";
+    redirect?: 'follow' | 'error' | 'manual';
 
     /** An AbortSignal to cancel the request. */
     signal?: AbortSignal;
@@ -136,7 +129,7 @@ declare global {
     formData(): Promise<FormData>;
 
     /** Reads the body as JSON. */
-    json(): Promise<unknown>;
+    json<T = unknown>(): Promise<T>;
 
     /** Reads the body as text. */
     text(): Promise<string>;
@@ -227,7 +220,7 @@ declare global {
     formData(): Promise<FormData>;
 
     /** Reads the body as JSON. */
-    json(): Promise<unknown>;
+    json<T = unknown>(): Promise<T>;
 
     /** Reads the body as text. */
     text(): Promise<string>;
@@ -246,8 +239,5 @@ declare global {
    * const data = await response.json();
    * ```
    */
-  function fetch(
-    input: Request | string | URL,
-    init?: RequestInit
-  ): Promise<Response>;
+  function fetch(input: Request | string | URL, init?: RequestInit): Promise<Response>;
 }

package/types/streams.d.ts

@@ -53,10 +53,7 @@ declare global {
      * Pipes this stream through a transform stream, returning the readable side.
      * @param transform An object with `writable` and `readable` properties.
      */
-    pipeThrough<T>(transform: {
-      writable: WritableStream<R>;
-      readable: ReadableStream<T>;
-    }): ReadableStream<T>;
+    pipeThrough<T>(transform: { writable: WritableStream<R>; readable: ReadableStream<T> }): ReadableStream<T>;
 
     /** Pipes this stream to a writable stream. */
     pipeTo(dest: WritableStream<R>): Promise<void>;
@@ -73,6 +70,12 @@ declare global {
     /** The amount of data the consumer wants, or null if the stream is closed. */
     readonly desiredSize: number | null;
 
+    /**
+     * An AbortSignal that is aborted when the stream consumer cancels/disconnects.
+     * Use this to detect client disconnection and stop producing data.
+     */
+    readonly signal?: AbortSignal;
+
     /** Closes the stream. No more chunks can be enqueued after this. */
     close(): void;
 

package/types/timers.d.ts

@@ -17,11 +17,7 @@ declare global {
    * clearTimeout(id); // Cancel before it runs
    * ```
    */
-  function setTimeout(
-    callback: (...args: unknown[]) => void,
-    ms?: number,
-    ...args: unknown[]
-  ): number;
+  function setTimeout(callback: (...args: unknown[]) => void, ms?: number, ...args: unknown[]): number;
 
   /**
    * Cancels a timeout previously scheduled with setTimeout().
@@ -46,11 +42,7 @@ declare global {
    * }, 1000);
    * ```
    */
-  function setInterval(
-    callback: (...args: unknown[]) => void,
-    ms?: number,
-    ...args: unknown[]
-  ): number;
+  function setInterval(callback: (...args: unknown[]) => void, ms?: number, ...args: unknown[]): number;
 
   /**
    * Cancels an interval previously scheduled with setInterval().

package/types/url.d.ts

@@ -85,9 +85,7 @@ declare global {
      * Creates a new URLSearchParams.
      * @param init Initial parameters as string, object, or array of pairs.
      */
-    constructor(
-      init?: string | URLSearchParams | Record<string, string> | [string, string][]
-    );
+    constructor(init?: string | URLSearchParams | Record<string, string> | [string, string][]);
 
     /** Appends a new key/value pair. */
     append(name: string, value: string): void;
@@ -114,9 +112,7 @@ declare global {
     toString(): string;
 
     /** Executes a callback for each key/value pair. */
-    forEach(
-      callback: (value: string, key: string, parent: URLSearchParams) => void
-    ): void;
+    forEach(callback: (value: string, key: string, parent: URLSearchParams) => void): void;
 
     /** Returns an iterator of all key/value pairs. */
     entries(): IterableIterator<[string, string]>;

package/types/workers.d.ts

@@ -42,6 +42,13 @@ declare global {
      * Must be called before any response is sent.
      */
     passThroughOnException(): void;
+
+    /**
+     * Properties passed to the worker.
+     * For Hono/Cloudflare Workers compatibility.
+     * @deprecated Not implemented in OpenWorkers
+     */
+    props: never;
   }
 
   /**
@@ -64,11 +71,7 @@ declare global {
      * @param env Environment bindings.
      * @param ctx Execution context.
      */
-    fetch?(
-      request: Request,
-      env: Env,
-      ctx: ExecutionContext
-    ): Response | Promise<Response>;
+    fetch?(request: Request, env: Env, ctx: ExecutionContext): Response | Promise<Response>;
 
     /**
      * Handles scheduled (cron) invocations.
@@ -76,11 +79,7 @@ declare global {
      * @param env Environment bindings.
      * @param ctx Execution context.
      */
-    scheduled?(
-      event: ScheduledEvent,
-      env: Env,
-      ctx: ExecutionContext
-    ): void | Promise<void>;
+    scheduled?(event: ScheduledEvent, env: Env, ctx: ExecutionContext): void | Promise<void>;
   }
 
   // addEventListener pattern
@@ -126,16 +125,10 @@ declare global {
   /**
    * Registers a fetch event listener (Service Worker pattern).
    */
-  function addEventListener(
-    type: "fetch",
-    listener: (event: FetchEvent) => void
-  ): void;
+  function addEventListener(type: 'fetch', listener: (event: FetchEvent) => void): void;
 
   /**
    * Registers a scheduled event listener (Service Worker pattern).
    */
-  function addEventListener(
-    type: "scheduled",
-    listener: ScheduledEventListener
-  ): void;
+  function addEventListener(type: 'scheduled', listener: ScheduledEventListener): void;
 }