@server/next 0.35.0 → 0.36.0

package/index.d.ts

@@ -34,11 +34,13 @@ type BodyOption = BodyMode | {
     mode?: BodyMode;
     max?: number | string | false;
 };
+type CacheOption = string | number | false;
 type RouteOptions = {
     tags?: string | string[];
     title?: string;
     description?: string;
     body?: BodyOption;
+    cache?: CacheOption;
 };
 type Route = {
     path: string;
@@ -188,6 +190,7 @@ type Options = {
     favicon?: string | BucketFile;
     security?: boolean | SecurityOptions;
     body?: BodyOption;
+    cache?: CacheOption;
 };
 type Settings = {
     port: number;
@@ -207,6 +210,7 @@ type Settings = {
     favicon?: string | BucketFile;
     security: SecuritySettings;
     body: BodyOption;
+    cache?: CacheOption;
 };
 type Time = {
     (name: string): void;
@@ -230,7 +234,9 @@ type ParamsToObject<Params extends string> = {
 };
 type PathToParams<Path extends string> = ParamsToObject<ExtractPathParams<Path>>;
 type BunEnv = Record<string, string> & {
-    upgrade?: (req: Request) => boolean;
+    upgrade?: (req: Request, options?: {
+        data?: any;
+    }) => boolean;
 };
 type Context<Params extends Record<string, string | undefined> = Record<string, string>, O extends ServerConfig = object> = {
     method: Method;
@@ -343,6 +349,7 @@ declare class Reply {
     type(type?: string): this;
     download(name?: string): this;
     headers(key: string | Record<string, string>, value?: string): this;
+    cache(value: CacheOption): this;
     cookies(key: string | Record<string, CookieOptions>, value?: CookieOptions): this;
     json(body: unknown): Response;
     redirect(path: string): Response;
@@ -353,6 +360,7 @@ type Params<K extends keyof Reply> = Reply[K] extends (...args: infer A) => any
 declare const status: (...args: Params<"status">) => Reply;
 declare const headers: (...args: Params<"headers">) => Reply;
 declare const type: (...args: Params<"type">) => Reply;
+declare const cache: (...args: Params<"cache">) => Reply;
 declare const download: (...args: Params<"download">) => Reply;
 declare const cookies: (...args: Params<"cookies">) => Reply;
 declare const send: (...args: Params<"send">) => Response;
@@ -407,9 +415,9 @@ declare class Server<O extends ServerConfig = {}> extends Router<O> {
             signal?: AbortSignal | null;
             window?: null;
         }) => Promise<Response>;
-        post: (path: string, body?: string | number | boolean | ArrayBuffer | {
+        post: (path: string, body?: string | number | boolean | ArrayBuffer | ReadableStream<any> | Blob | ArrayBufferView<ArrayBuffer> | FormData | URLSearchParams | {
             [key: string]: SerializableValue;
-        } | SerializableValue[] | ReadableStream<any> | Blob | ArrayBufferView<ArrayBuffer> | FormData | URLSearchParams, options?: {
+        } | SerializableValue[], options?: {
             cache?: RequestCache;
             credentials?: RequestCredentials;
             headers?: HeadersInit;
@@ -424,9 +432,9 @@ declare class Server<O extends ServerConfig = {}> extends Router<O> {
             signal?: AbortSignal | null;
             window?: null;
         }) => Promise<Response>;
-        put: (path: string, body?: string | number | boolean | ArrayBuffer | {
+        put: (path: string, body?: string | number | boolean | ArrayBuffer | ReadableStream<any> | Blob | ArrayBufferView<ArrayBuffer> | FormData | URLSearchParams | {
             [key: string]: SerializableValue;
-        } | SerializableValue[] | ReadableStream<any> | Blob | ArrayBufferView<ArrayBuffer> | FormData | URLSearchParams, options?: {
+        } | SerializableValue[], options?: {
             cache?: RequestCache;
             credentials?: RequestCredentials;
             headers?: HeadersInit;
@@ -441,9 +449,9 @@ declare class Server<O extends ServerConfig = {}> extends Router<O> {
             signal?: AbortSignal | null;
             window?: null;
         }) => Promise<Response>;
-        patch: (path: string, body?: string | number | boolean | ArrayBuffer | {
+        patch: (path: string, body?: string | number | boolean | ArrayBuffer | ReadableStream<any> | Blob | ArrayBufferView<ArrayBuffer> | FormData | URLSearchParams | {
             [key: string]: SerializableValue;
-        } | SerializableValue[] | ReadableStream<any> | Blob | ArrayBufferView<ArrayBuffer> | FormData | URLSearchParams, options?: {
+        } | SerializableValue[], options?: {
             cache?: RequestCache;
             credentials?: RequestCredentials;
             headers?: HeadersInit;
@@ -492,4 +500,4 @@ declare class Server<O extends ServerConfig = {}> extends Router<O> {
 }
 declare function server<Session extends Record<string, any> = {}, User extends Record<string, any> = {}>(options?: Options): Server<ServerConfig<Session, User>>;
 
-export { type AuthOption, type AuthSession, type AuthSettings, type AuthUser, type BasicValue, type Body, type BodyMode, type BodyOption, type Bucket, type BucketFile, type BunEnv, type Context, type Cookie, type CorsSettings, type ExtractPathParams, type FileInfo, type InferParamType, type InlineReply, type KVStore, type LimitOptions, type LogLevel, type Logger, type Method, type Middleware, type Options, type ParamTypeMap, type ParamsToObject, type PathToParams, type Platform, type Provider, type Route, type RouteOptions, type RouterMethod, type SecurityOptions, type SecuritySettings, type SerializableValue, Server, type ServerConfig, TypedServerError as ServerError, type Settings, type Strategy, type Time, UploadPipeline, type UploadedFile, cookies, server as default, download, file, headers, json, redirect, router, send, status, type, upload };
+export { type AuthOption, type AuthSession, type AuthSettings, type AuthUser, type BasicValue, type Body, type BodyMode, type BodyOption, type Bucket, type BucketFile, type BunEnv, type CacheOption, type Context, type Cookie, type CorsSettings, type ExtractPathParams, type FileInfo, type InferParamType, type InlineReply, type KVStore, type LimitOptions, type LogLevel, type Logger, type Method, type Middleware, type Options, type ParamTypeMap, type ParamsToObject, type PathToParams, type Platform, type Provider, type Route, type RouteOptions, type RouterMethod, type SecurityOptions, type SecuritySettings, type SerializableValue, Server, type ServerConfig, TypedServerError as ServerError, type Settings, type Strategy, type Time, UploadPipeline, type UploadedFile, cache, cookies, server as default, download, file, headers, json, redirect, router, send, status, type, upload };

package/index.js

@@ -683,6 +683,97 @@ async function resolveBody(ctx, body) {
   return parsed;
 }
 
+// src/helpers/createCookies.ts
+var EXPIRED = (/* @__PURE__ */ new Date(0)).toUTCString();
+var times = /(-?(?:\d+\.?\d*|\d*\.?\d+)(?:e[-+]?\d+)?)\s*([\p{L}]*)/iu;
+parse.millisecond = parse.ms = 1e-3;
+parse.second = parse.sec = parse.s = parse[""] = 1;
+parse.minute = parse.min = parse.m = parse.s * 60;
+parse.hour = parse.hr = parse.h = parse.m * 60;
+parse.day = parse.d = parse.h * 24;
+parse.week = parse.wk = parse.w = parse.d * 7;
+parse.year = parse.yr = parse.y = parse.d * 365.25;
+parse.month = parse.b = parse.y / 12;
+function parse(str) {
+  if (str === null || str === void 0) return null;
+  if (typeof str === "number") return str;
+  if (typeof str !== "string") {
+    throw new Error(`Not a string: ${str} (${typeof str})`);
+  }
+  str = str.toLowerCase().replace(/[,_]/g, "");
+  const [_, value, units] = times.exec(str) || [];
+  if (!units) return null;
+  const unitValue = parse[units] || parse[units.replace(/s$/, "")];
+  if (!unitValue) return null;
+  const result = unitValue * parseFloat(value);
+  return Math.abs(Math.round(result * 1e3));
+}
+function normalizeExpires(expires) {
+  if (expires === null || expires === void 0) return void 0;
+  if (expires === 0) return EXPIRED;
+  if (typeof expires === "string") {
+    if (/^[\d._]+\w+$/.test(expires)) {
+      return new Date(Date.now() + parse(expires)).toUTCString();
+    } else {
+      return expires;
+    }
+  }
+  if (typeof expires === "number") {
+    return new Date(Date.now() + expires).toUTCString();
+  }
+  if (expires instanceof Date) {
+    return expires.toUTCString();
+  }
+  return void 0;
+}
+function createCookies(key, val) {
+  if (val.value === null) val.expires = EXPIRED;
+  const { value, path: path2, expires, maxAge, httpOnly, secure, sameSite } = val;
+  let str = `${key}=${value || ""};Path=${path2 || "/"}`;
+  if (typeof expires !== "undefined") str += `;Expires=${normalizeExpires(expires)}`;
+  if (typeof maxAge === "number") str += `;Max-Age=${maxAge}`;
+  if (httpOnly) str += ";HttpOnly";
+  if (secure) str += ";Secure";
+  if (sameSite) str += `;SameSite=${sameSite}`;
+  return str;
+}
+
+// src/helpers/etag.ts
+function etag(bytes) {
+  let h = 2166136261;
+  for (let i = 0; i < bytes.length; i++) {
+    h ^= bytes[i];
+    h = Math.imul(h, 16777619);
+  }
+  return `"${bytes.length.toString(16)}-${(h >>> 0).toString(16)}"`;
+}
+
+// src/helpers/cache.ts
+function resolveCache(value) {
+  if (value === false || value === 0) return "no-store";
+  if (typeof value === "number") return `public, max-age=${Math.round(value)}`;
+  if (typeof value !== "string") return null;
+  const ms = parse(value);
+  return ms === null ? null : `public, max-age=${Math.round(ms / 1e3)}`;
+}
+async function applyCache(out, ctx) {
+  if (ctx.method !== "get" || out.status !== 200) return out;
+  if (!out.headers.has("cache-control")) {
+    const value = resolveCache(ctx.options.cache);
+    if (value) out.headers.set("cache-control", value);
+  }
+  if (out.headers.has("etag") || !out.headers.has("content-length")) return out;
+  const bytes = new Uint8Array(await out.arrayBuffer());
+  const tag = etag(bytes);
+  const headers2 = new Headers(out.headers);
+  headers2.set("etag", tag);
+  if (ctx.headers["if-none-match"] === tag) {
+    headers2.delete("content-length");
+    return new Response(null, { status: 304, headers: headers2 });
+  }
+  return new Response(bytes, { status: 200, headers: headers2 });
+}
+
 // src/helpers/clientIp.ts
 var first = (v) => (Array.isArray(v) ? v[0] : v) || "";
 var normalize = (ip) => ip.replace(/^::ffff:/, "");
@@ -707,7 +798,7 @@ function isReadableStream(obj) {
 }
 
 // src/reply.ts
-var EXPIRED = (/* @__PURE__ */ new Date(0)).toUTCString();
+var EXPIRED2 = (/* @__PURE__ */ new Date(0)).toUTCString();
 var Reply = class {
   res;
   constructor() {
@@ -743,6 +834,11 @@ var Reply = class {
     this.res.headers.append(key, value);
     return this;
   }
+  cache(value) {
+    const resolved = resolveCache(value);
+    if (resolved) this.res.headers.set("cache-control", resolved);
+    return this;
+  }
   cookies(key, value) {
     if (typeof key === "object") {
       Object.entries(key).map(([key2, value2]) => this.cookies(key2, value2));
@@ -752,7 +848,7 @@ var Reply = class {
       Object.values(value).map((val) => this.cookies(key, val));
       return this;
     }
-    if (value === null) return this.cookies(key, { expires: EXPIRED });
+    if (value === null) return this.cookies(key, { expires: EXPIRED2 });
     if (typeof value !== "object") return this.cookies(key, { value });
     return this.headers("set-cookie", createCookies(key, value));
   }
@@ -822,6 +918,7 @@ var r = () => new Reply();
 var status = (...args) => r().status(...args);
 var headers = (...args) => r().headers(...args);
 var type = (...args) => r().type(...args);
+var cache = (...args) => r().cache(...args);
 var download = (...args) => r().download(...args);
 var cookies = (...args) => r().cookies(...args);
 var send = (...args) => r().send(...args);
@@ -939,61 +1036,6 @@ async function finishLogin(ctx, input) {
   throw new Error("Unknown auth type");
 }
 
-// src/helpers/createCookies.ts
-var EXPIRED2 = (/* @__PURE__ */ new Date(0)).toUTCString();
-var times = /(-?(?:\d+\.?\d*|\d*\.?\d+)(?:e[-+]?\d+)?)\s*([\p{L}]*)/iu;
-parse.millisecond = parse.ms = 1e-3;
-parse.second = parse.sec = parse.s = parse[""] = 1;
-parse.minute = parse.min = parse.m = parse.s * 60;
-parse.hour = parse.hr = parse.h = parse.m * 60;
-parse.day = parse.d = parse.h * 24;
-parse.week = parse.wk = parse.w = parse.d * 7;
-parse.year = parse.yr = parse.y = parse.d * 365.25;
-parse.month = parse.b = parse.y / 12;
-function parse(str) {
-  if (str === null || str === void 0) return null;
-  if (typeof str === "number") return str;
-  if (typeof str !== "string") {
-    throw new Error(`Not a string: ${str} (${typeof str})`);
-  }
-  str = str.toLowerCase().replace(/[,_]/g, "");
-  const [_, value, units] = times.exec(str) || [];
-  if (!units) return null;
-  const unitValue = parse[units] || parse[units.replace(/s$/, "")];
-  if (!unitValue) return null;
-  const result = unitValue * parseFloat(value);
-  return Math.abs(Math.round(result * 1e3));
-}
-function normalizeExpires(expires) {
-  if (expires === null || expires === void 0) return void 0;
-  if (expires === 0) return EXPIRED2;
-  if (typeof expires === "string") {
-    if (/^[\d._]+\w+$/.test(expires)) {
-      return new Date(Date.now() + parse(expires)).toUTCString();
-    } else {
-      return expires;
-    }
-  }
-  if (typeof expires === "number") {
-    return new Date(Date.now() + expires).toUTCString();
-  }
-  if (expires instanceof Date) {
-    return expires.toUTCString();
-  }
-  return void 0;
-}
-function createCookies(key, val) {
-  if (val.value === null) val.expires = EXPIRED2;
-  const { value, path: path2, expires, maxAge, httpOnly, secure, sameSite } = val;
-  let str = `${key}=${value || ""};Path=${path2 || "/"}`;
-  if (typeof expires !== "undefined") str += `;Expires=${normalizeExpires(expires)}`;
-  if (typeof maxAge === "number") str += `;Max-Age=${maxAge}`;
-  if (httpOnly) str += ";HttpOnly";
-  if (secure) str += ";Secure";
-  if (sameSite) str += `;SameSite=${sameSite}`;
-  return str;
-}
-
 // src/auth/state.ts
 var NAME = "oauth_state";
 function startState(ctx, crossSite = false) {
@@ -1606,6 +1648,7 @@ function config(options = {}) {
     // the added headers off; see resolveSecurity for the defaults.
     security: resolveSecurity(options.security)
   };
+  if (options.cache !== void 0) settings.cache = options.cache;
   options.cors = options.cors || env2.CORS || null;
   if (options.cors) {
     const cors2 = {
@@ -1683,6 +1726,7 @@ function config(options = {}) {
     log.message("cors", origin);
   }
   if (settings.favicon) log.message("favicon", loc(settings.favicon));
+  if (settings.cache !== void 0) log.message("cache", loc(options.cache));
   if (settings.openapi) log.message("openapi", settings.openapi.path || "/docs");
   return settings;
 }
@@ -1722,23 +1766,14 @@ function applyCors(res, ctx) {
   }
 }
 
-// src/helpers/etag.ts
-function etag(bytes) {
-  let h = 2166136261;
-  for (let i = 0; i < bytes.length; i++) {
-    h ^= bytes[i];
-    h = Math.imul(h, 16777619);
-  }
-  return `"${bytes.length.toString(16)}-${(h >>> 0).toString(16)}"`;
-}
-
 // src/helpers/createWebsocket.ts
 function createWebsocket(sockets, handlers) {
   const run = (event, socket, body) => {
     const routes = handlers.socket?.filter((r2) => r2.path === event) ?? [];
+    const user = socket.user ?? socket.data?.user;
     for (const route of routes) {
       for (const fn of route.fns) {
-        fn({ socket, sockets, body });
+        fn({ socket, sockets, body, user });
       }
     }
   };
@@ -1845,6 +1880,7 @@ async function parseResponse(out, ctx) {
   }
   applyCors(out, ctx);
   applySecurity(out, ctx);
+  out = await applyCache(out, ctx);
   if (ctx.time?.times?.length > 1) {
     out.headers.set("Server-Timing", ctx.time.headers());
   }
@@ -2632,6 +2668,13 @@ function timer(ctx) {
   ctx.time = createTime();
 }
 
+// src/auth/socketUser.ts
+async function socketUser(app, headers2, cookies2) {
+  if (!app.settings.auth) return void 0;
+  const ctx = { options: app.settings, headers: headers2, cookies: cookies2 };
+  return getUser(ctx);
+}
+
 // src/helpers/wsNode.ts
 var GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
 var CONTINUATION = 0;
@@ -2666,6 +2709,9 @@ var NodeWebSocket = class {
   fragmentOpcode;
   closed;
   readyState;
+  // The auth user resolved from the upgrade request (see attachWebsocket), or
+  // undefined for an anonymous connection. Read by socket handlers as `ctx.user`.
+  user;
   constructor(socket, handlers) {
     this.socket = socket;
     this.handlers = handlers;
@@ -2764,13 +2810,24 @@ var NodeWebSocket = class {
 };
 async function attachWebsocket(server2, app) {
   const { createHash } = await import("crypto");
-  server2.on("upgrade", (req, socket, head) => {
+  server2.on("upgrade", async (req, socket, head) => {
     const key = req.headers["sec-websocket-key"];
     const upgrade = String(req.headers.upgrade || "").toLowerCase();
     if (upgrade !== "websocket" || !key || !app.handlers.socket.length) {
       socket.destroy();
       return;
     }
+    const cookies2 = parseCookies(req.headers.cookie);
+    let user;
+    try {
+      user = await socketUser(app, req.headers, cookies2);
+    } catch {
+      socket.write(
+        "HTTP/1.1 401 Unauthorized\r\nConnection: close\r\nContent-Length: 0\r\n\r\n"
+      );
+      socket.destroy();
+      return;
+    }
     const accept = createHash("sha1").update(key + GUID).digest("base64");
     socket.write(
       `HTTP/1.1 101 Switching Protocols\r
@@ -2786,6 +2843,7 @@ Sec-WebSocket-Accept: ${accept}\r
       onMessage: (body) => app.websocket.message(ws, body),
       onClose: () => app.websocket.close(ws)
     });
+    ws.user = user;
     app.websocket.open(ws);
     if (head?.length) ws.receive(head);
     socket.on("data", (chunk) => ws.receive(chunk));
@@ -2902,7 +2960,20 @@ async function createWinter(req, app, server2) {
 
 // src/context/handlers.ts
 var Winter = async (app, request, env2) => {
-  if (env2?.upgrade(request)) return;
+  if (env2?.upgrade) {
+    const wantsWs = String(request.headers.get("upgrade") || "").toLowerCase() === "websocket";
+    if (wantsWs) {
+      const headers2 = parseHeaders_default(request.headers);
+      const cookies2 = parseCookies(headers2.cookie);
+      let user;
+      try {
+        user = await socketUser(app, headers2, cookies2);
+      } catch {
+        return new Response("Unauthorized", { status: 401 });
+      }
+      if (env2.upgrade(request, { data: { user } })) return;
+    }
+  }
   Object.assign(globalThis.env, env2);
   const ctx = await createWinter(request, app, env2);
   const res = await handleRequest(app, ctx);
@@ -3137,6 +3208,7 @@ function server(options) {
 export {
   Server,
   ServerError_default as ServerError,
+  cache,
   cookies,
   server as default,
   download,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@server/next",
-  "version": "0.35.0",
+  "version": "0.36.0",
   "description": "A fully-fledged web server with routing, file uploads, sessions, static files, schema validation, websockets, testing, etc.",
   "homepage": "https://server-js.com/",
   "repository": "github:franciscop/server-next",