Merge branch 'main' into feat/websocket-idletimeout-support

Author: kitsonk

README.md

@@ -47,18 +47,19 @@ oak is available on both [deno.land/x](https://deno.land/x/oak/) and
 import { Application } from "https://deno.land/x/oak/mod.ts";
 ```
 
-To use from JSR, import into a module:
+To use from JSR, add it to your project:
 
-```ts
-import { Application } from "jsr:@oak/oak";
+```
+deno add jsr:@oak/oak
 ```
 
-Or use the Deno CLI to add it to your project:
+Then import into a module:
 
-```
-deno add jsr:@oak/oak
+```ts
+import { Application } from "@oak/oak";
 ```
 
+
 ### Node.js
 
 oak is available for Node.js on both
@@ -157,7 +158,7 @@ processing requests with the registered middleware.
 A basic usage, responding to every request with _Hello World!_:
 
 ```ts
-import { Application } from "jsr:@oak/oak/application";
+import { Application } from "@oak/oak/application";
 
 const app = new Application();
 
@@ -184,7 +185,7 @@ context and reference to the "next" method in the stack.
 A more complex example:
 
 ```ts
-import { Application } from "jsr:@oak/oak/application";
+import { Application } from "@oak/oak/application";
 
 const app = new Application();
 
@@ -232,7 +233,7 @@ or `undefined` if the `ctx.respond === true`.
 An example:
 
 ```ts
-import { Application } from "jsr:@oak/oak/application";
+import { Application } from "@oak/oak/application";
 
 const app = new Application();
 
@@ -649,7 +650,7 @@ will fire a `"listen"` event, which can be listened for via the
 `.addEventListener()` method. For example:
 
 ```ts
-import { Application } from "jsr:@oak/oak/application";
+import { Application } from "@oak/oak/application";
 
 const app = new Application();
 
@@ -673,7 +674,7 @@ If you want to close the application, the application supports the option of an
 Here is an example of using the signal:
 
 ```ts
-import { Application } from "jsr:@oak/oak/application";
+import { Application } from "@oak/oak/application";
 
 const app = new Application();
 
@@ -700,9 +701,9 @@ handling middleware that provides a well managed response to errors would work
 like this:
 
 ```ts
-import { Application } from "jsr:@oak/oak/application";
-import { isHttpError } from "jsr:@oak/commons/http_errors";
-import { Status } from "jsr:@oak/commons/status";
+import { Application } from "@oak/oak/application";
+import { isHttpError } from "@oak/commons/http_errors";
+import { Status } from "@oak/commons/status";
 
 const app = new Application();
 
@@ -733,7 +734,7 @@ application. To listen for these errors, you would add an event handler to the
 application instance:
 
 ```ts
-import { Application } from "jsr:@oak/oak/application";
+import { Application } from "@oak/oak/application";
 
 const app = new Application();
 
@@ -762,8 +763,8 @@ The following example serves up a _RESTful_ service of a map of books, where
 `http://localhost:8000/book/1` would return the book with ID `"1"`:
 
 ```ts
-import { Application } from "jsr:@oak/oak/application";
-import { Router } from "jsr:@oak/oak/router";
+import { Application } from "@oak/oak/application";
+import { Router } from "@oak/oak/router";
 
 const books = new Map<string, any>();
 books.set("1", {
@@ -814,8 +815,8 @@ Nesting routers is supported. The following example responds to
 `http://localhost:8000/forums/oak/posts/nested-routers`.
 
 ```typescript
-import { Application } from "jsr:@oak/oak/application";
-import { Router } from "jsr:@oak/oak/router";
+import { Application } from "@oak/oak/application";
+import { Router } from "@oak/oak/router";
 
 const posts = new Router()
   .get("/", (ctx) => {
@@ -845,7 +846,7 @@ system relative to the root from the requested path.
 A basic usage would look something like this:
 
 ```ts
-import { Application } from "jsr:@oak/oak/application";
+import { Application } from "@oak/oak/application";
 
 const app = new Application();
 
@@ -881,8 +882,8 @@ determines if it can create an `ETag` header for that body type, and if so sets
 the `ETag` header on the response. Basic usage would look something like this:
 
 ```ts
-import { Application } from "jsr:@oak/oak/application";
-import { factory } from "jsr:@oak/oak/etag";
+import { Application } from "@oak/oak/application";
+import { factory } from "@oak/oak/etag";
 
 const app = new Application();
 
@@ -893,12 +894,12 @@ app.use(factory());
 
 There is also a function which retrieves an entity for a given context based on
 what it logical to read into memory which can be passed to the etag calculate
-that is part of the Deno std library:
+that is part of the Deno std library (`deno add jsr:@std/http`):
 
 ```ts
-import { Application } from "jsr:@oak/oak/application";
-import { getEntity } from "jsr:@oak/oak/etag";
-import { calculate } from "jsr:@std/http/etag";
+import { Application } from "@oak/oak/application";
+import { getEntity } from "@oak/oak/etag";
+import { calculate } from "@std/http/etag";
 
 const app = new Application();
 
@@ -938,8 +939,8 @@ the handler to resolve with a Fetch API `Response`.
 An example of using `serve()` with `Application.prototype.use()`:
 
 ```ts
-import { Application } from "jsr:@oak/oak/application";
-import { serve } from "jsr:@oak/oak/serve";
+import { Application } from "@oak/oak/application";
+import { serve } from "@oak/oak/serve";
 
 const app = new Application();
 
@@ -955,9 +956,9 @@ And a similar solution works with `route()` where the context contains the
 information about the router, like the params:
 
 ```ts
-import { Application } from "jsr:@oak/oak/application";
-import { Router } from "jsr:@oak/oak/router";
-import { route } from "jsr:@oak/oak/serve";
+import { Application } from "@oak/oak/application";
+import { Router } from "@oak/oak/router";
+import { route } from "@oak/oak/serve";
 
 const app = new Application;
 

body.ts

@@ -9,7 +9,7 @@
  */
 
 import { createHttpError, matches, parseFormData, Status } from "./deps.ts";
-import type { ServerRequest } from "./types.ts";
+import type { ServerRequest, Uint8ArrayArrayBuffer } from "./types.ts";
 
 type JsonReviver = (key: string, value: unknown) => unknown;
 
@@ -30,13 +30,13 @@ const KNOWN_BODY_TYPES: [bodyType: BodyType, knownMediaTypes: string[]][] = [
 ];
 
 async function readBlob(
-  body?: ReadableStream<Uint8Array> | null,
+  body?: ReadableStream<Uint8ArrayArrayBuffer> | null,
   type?: string | null,
 ): Promise<Blob> {
   if (!body) {
     return new Blob(undefined, type ? { type } : undefined);
   }
-  const chunks: Uint8Array[] = [];
+  const chunks: Uint8ArrayArrayBuffer[] = [];
   for await (const chunk of body) {
     chunks.push(chunk);
   }
@@ -45,7 +45,7 @@ async function readBlob(
 
 /** An object which encapsulates information around a request body. */
 export class Body {
-  #body?: ReadableStream<Uint8Array> | null;
+  #body?: ReadableStream<Uint8ArrayArrayBuffer> | null;
   #memo: Promise<ArrayBuffer | Blob | FormData | string> | null = null;
   #memoType: "arrayBuffer" | "blob" | "formData" | "text" | null = null;
   #headers?: Headers;
@@ -80,7 +80,7 @@ export class Body {
   }
 
   /** Exposes the "raw" `ReadableStream` of the body. */
-  get stream(): ReadableStream<Uint8Array> | null {
+  get stream(): ReadableStream<Uint8ArrayArrayBuffer> | null {
     return this.#request ? this.#request.body : this.#body!;
   }
 

deno.json

@@ -40,5 +40,10 @@
   "fmt": {
     "exclude": ["README.md"]
   },
+  "lint": {
+    "rules": {
+      "exclude": ["no-import-prefix"]
+    }
+  },
   "lock": false
 }

http_server_bun.ts

@@ -13,6 +13,7 @@ import type {
   ServeOptions,
   ServerRequest,
   ServeTlsOptions,
+  Uint8ArrayArrayBuffer,
 } from "./types.ts";
 import { createPromiseWithResolvers } from "./utils/create_promise_with_resolvers.ts";
 
@@ -94,7 +95,7 @@ class BunRequest implements ServerRequest {
   #resolved = false;
   #promise: Promise<Response>;
 
-  get body(): ReadableStream<Uint8Array> | null {
+  get body(): ReadableStream<Uint8ArrayArrayBuffer> | null {
     return this.#request.body;
   }
 
@@ -150,7 +151,7 @@ class BunRequest implements ServerRequest {
     this.#reject(reason);
   }
 
-  getBody(): ReadableStream<Uint8Array> | null {
+  getBody(): ReadableStream<Uint8ArrayArrayBuffer> | null {
     return this.#request.body;
   }
 

http_server_native_request.ts

@@ -3,6 +3,7 @@
 import type {
   NetAddr,
   ServerRequest,
+  Uint8ArrayArrayBuffer,
   UpgradeWebSocketFn,
   UpgradeWebSocketOptions,
 } from "./types.ts";
@@ -55,7 +56,7 @@ export class NativeRequest implements ServerRequest {
     this.#response = promise;
   }
 
-  get body(): ReadableStream<Uint8Array> | null {
+  get body(): ReadableStream<Uint8ArrayArrayBuffer> | null {
     return this.#request.body;
   }
 
@@ -102,7 +103,7 @@ export class NativeRequest implements ServerRequest {
     this.#resolved = true;
   }
 
-  getBody(): ReadableStream<Uint8Array> | null {
+  getBody(): ReadableStream<Uint8ArrayArrayBuffer> | null {
     return this.#request.body;
   }
 

http_server_node.ts

@@ -12,6 +12,7 @@ import type {
   ServeOptions,
   ServerRequest,
   ServeTlsOptions,
+  Uint8ArrayArrayBuffer,
 } from "./types.ts";
 import { createPromiseWithResolvers } from "./utils/create_promise_with_resolvers.ts";
 
@@ -90,15 +91,15 @@ export class NodeRequest implements ServerRequest {
     this.#responded = true;
   }
 
-  getBody(): ReadableStream<Uint8Array> | null {
-    let body: ReadableStream<Uint8Array> | null;
+  getBody(): ReadableStream<Uint8ArrayArrayBuffer> | null {
+    let body: ReadableStream<Uint8ArrayArrayBuffer> | null;
     if (this.method === "GET" || this.method === "HEAD") {
       body = null;
     } else {
-      body = new ReadableStream<Uint8Array>({
+      body = new ReadableStream<Uint8ArrayArrayBuffer>({
         start: (controller) => {
-          this.#request.on("data", (chunk: Uint8Array) => {
-            controller.enqueue(chunk);
+          this.#request.on("data", (chunk) => {
+            controller.enqueue(chunk as Uint8ArrayArrayBuffer);
           });
           this.#request.on("error", (err: Error) => {
             controller.error(err);

send.ts

@@ -31,6 +31,7 @@ import type { Response } from "./response.ts";
 import { isNode } from "./utils/type_guards.ts";
 import { decode } from "./utils/decode.ts";
 import { resolvePath } from "./utils/resolve_path.ts";
+import type { Uint8ArrayArrayBuffer } from "./types.ts";
 
 if (isNode()) {
   console.warn("oak send() does not work under Node.js.");
@@ -137,9 +138,15 @@ async function getEntity(
   stats: Deno.FileInfo,
   maxbuffer: number,
   response: Response,
-): Promise<[Uint8Array | Deno.FsFile, Uint8Array | FileInfo, FileInfo]> {
-  let body: Uint8Array | Deno.FsFile;
-  let entity: Uint8Array | FileInfo;
+): Promise<
+  [
+    Uint8ArrayArrayBuffer | Deno.FsFile,
+    Uint8ArrayArrayBuffer | FileInfo,
+    FileInfo,
+  ]
+> {
+  let body: Uint8ArrayArrayBuffer | Deno.FsFile;
+  let entity: Uint8ArrayArrayBuffer | FileInfo;
   const fileInfo = { mtime: new Date(mtime), size: stats.size };
   if (stats.size < maxbuffer) {
     const buffer = await Deno.readFile(path);
@@ -270,8 +277,8 @@ export async function send(
       : contentTypes[extname(path)] ?? extname(path);
   }
 
-  let entity: Uint8Array | FileInfo | null = null;
-  let body: Uint8Array | Deno.FsFile | null = null;
+  let entity: Uint8ArrayArrayBuffer | FileInfo | null = null;
+  let body: Uint8ArrayArrayBuffer | Deno.FsFile | null = null;
   let fileInfo: FileInfo | null = null;
 
   if (request.headers.has("If-None-Match") && mtime) {

types.ts

@@ -21,7 +21,7 @@ export interface ServerRequest {
   readonly url: string;
   // deno-lint-ignore no-explicit-any
   error(reason?: any): void;
-  getBody(): ReadableStream<Uint8Array> | null;
+  getBody(): ReadableStream<Uint8ArrayArrayBuffer> | null;
   respond(response: Response): void | Promise<void>;
   upgrade?(options?: UpgradeWebSocketOptions): WebSocket;
 }
@@ -38,8 +38,11 @@ export interface ServerConstructor<T extends ServerRequest> {
   type?: "native" | "node" | "bun";
 }
 
-export type Data = string | number[] | ArrayBuffer | Uint8Array;
-export type Key = string | number[] | ArrayBuffer | Uint8Array;
+/** Type for backwards compatibility. Resolves to `Uint8Array<ArrayBuffer>` in
+ * TypeScript 5.7+ and `Uint8Array` in older versions. */
+export type Uint8ArrayArrayBuffer = ReturnType<Uint8Array["slice"]>;
+export type Data = string | number[] | ArrayBuffer | Uint8ArrayArrayBuffer;
+export type Key = string | number[] | ArrayBuffer | Uint8ArrayArrayBuffer;
 
 export interface UpgradeWebSocketOptions {
   protocol?: string;