@toapi/server 1.3.4 → 1.4.0

package/dist/create-request-handler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-request-handler.d.ts","sourceRoot":"","sources":["../src/create-request-handler.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EAAE,IAAI,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE/C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAK9C,UAAU,OAAO;IACf,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kEAAkE;IAClE,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAWD,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,aAAa,CAAC,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAC7D,OAAO,GAAE,OAAY,SAmBF,OAAO,uBAqL3B;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAOrD;AAuGD,wBAAsB,cAAc,CAAC,IAAI,EACvC,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,EACrC,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,mDAOnC"}
+{"version":3,"file":"create-request-handler.d.ts","sourceRoot":"","sources":["../src/create-request-handler.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EAAE,IAAI,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE/C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAK9C,UAAU,OAAO;IACf,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kEAAkE;IAClE,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAWD,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,aAAa,CAAC,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAC7D,OAAO,GAAE,OAAY,SAmBF,OAAO,uBAuL3B;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAOrD;AAuGD,wBAAsB,cAAc,CAAC,IAAI,EACvC,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,EACrC,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,mDAOnC"}

package/dist/create-request-handler.js

@@ -28,6 +28,8 @@ export function createRequestHandler(api, options = {}) {
         if (url.pathname === `${basePath}${INVALIDATIONS_ROUTE}`) {
             return streamRevalidatedTags({
                 cache: api.cache,
+                config: api.revalidationStreamConfig,
+                req,
             });
         }
         if (api.oas && url.pathname === `${basePath}${OPENAPI_ROUTE}`) {

package/dist/define-api.d.ts

@@ -3,6 +3,7 @@ import type { Logger } from "@toapi/common";
 import type { Path as BasePath, StrictParams } from "@toapi/common";
 import type { Route } from "@toapi/common";
 import { type Cache } from "./cache.js";
+import type { RevalidationStreamConfig } from "./revalidation-stream.js";
 export interface OasInfo {
     title: string;
     version: string;
@@ -11,6 +12,7 @@ interface Options {
     cache?: Cache;
     oas?: OasInfo;
     logger?: Logger;
+    revalidationStream?: RevalidationStreamConfig;
 }
 export declare function defineApi(options?: Options): ApiDefinition<{}>;
 export declare class ApiDefinition<Routes extends Record<BasePath, unknown>> {
@@ -18,7 +20,8 @@ export declare class ApiDefinition<Routes extends Record<BasePath, unknown>> {
     cache: Cache;
     oas?: OasInfo | undefined;
     logger?: Logger | undefined;
-    constructor(routes: Routes, cache: Cache, oas?: OasInfo | undefined, logger?: Logger | undefined);
+    revalidationStreamConfig?: RevalidationStreamConfig | undefined;
+    constructor(routes: Routes, cache: Cache, oas?: OasInfo | undefined, logger?: Logger | undefined, revalidationStreamConfig?: RevalidationStreamConfig | undefined);
     invalidate(tags: string[]): Promise<void>;
     route<Path extends BasePath, GetResponse = never, GetQuery extends Record<string, unknown> = never, PostResponse = never, PostQuery extends Record<string, unknown> = never, PostBody = never, DeleteResponse = never, DeleteQuery extends Record<string, unknown> = never, PutResponse = never, PutQuery extends Record<string, unknown> = never, PutBody = never, PatchResponse = never, PatchQuery extends Record<string, unknown> = never, PatchBody = never>(path: Path, route: MaybePromise<Route<StrictParams<Path>, GetResponse, GetQuery, PostResponse, PostQuery, PostBody, DeleteResponse, DeleteQuery, PutResponse, PutQuery, PutBody, PatchResponse, PatchQuery, PatchBody>>): ApiDefinition<Routes & { [path in Path]: MaybePromise<Route<StrictParams<Path>, GetResponse, GetQuery, PostResponse, PostQuery, PostBody, DeleteResponse, DeleteQuery, PutResponse, PutQuery, PutBody, PatchResponse, PatchQuery, PatchBody>>; }>;
 }

package/dist/define-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"define-api.d.ts","sourceRoot":"","sources":["../src/define-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,EAAE,IAAI,IAAI,QAAQ,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACpE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,KAAK,KAAK,EAAU,MAAM,YAAY,CAAC;AAEhD,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,OAAO;IACf,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,SAAS,CAAC,OAAO,GAAE,OAAY,qBAE9C;AAED,qBAAa,aAAa,CAAC,MAAM,SAAS,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC;IAExD,MAAM,EAAE,MAAM;IACd,KAAK,EAAE,KAAK;IACZ,GAAG,CAAC,EAAE,OAAO;IACb,MAAM,CAAC,EAAE,MAAM;IAJxB,YACS,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,KAAK,EACZ,GAAG,CAAC,EAAE,OAAO,YAAA,EACb,MAAM,CAAC,EAAE,MAAM,YAAA,EACpB;IAEE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,iBAE9B;IAED,KAAK,CACH,IAAI,SAAS,QAAQ,EACrB,WAAW,GAAG,KAAK,EACnB,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,EAChD,YAAY,GAAG,KAAK,EACpB,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,EACjD,QAAQ,GAAG,KAAK,EAChB,cAAc,GAAG,KAAK,EACtB,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,EACnD,WAAW,GAAG,KAAK,EACnB,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,EAChD,OAAO,GAAG,KAAK,EACf,aAAa,GAAG,KAAK,EACrB,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,EAClD,SAAS,GAAG,KAAK,EAEjB,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,YAAY,CACjB,KAAK,CACH,YAAY,CAAC,IAAI,CAAC,EAClB,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,SAAS,EACT,QAAQ,EACR,cAAc,EACd,WAAW,EACX,WAAW,EACX,QAAQ,EACR,OAAO,EACP,aAAa,EACb,UAAU,EACV,SAAS,CACV,CACF,GAGyB,aAAa,CACrC,MAAM,GAAG,GACN,IAAI,IAAI,IAAI,GAAG,YAAY,CAC1B,KAAK,CACH,YAAY,CAAC,IAAI,CAAC,EAClB,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,SAAS,EACT,QAAQ,EACR,cAAc,EACd,WAAW,EACX,WAAW,EACX,QAAQ,EACR,OAAO,EACP,aAAa,EACb,UAAU,EACV,SAAS,CACV,CACF,GACF,CACF,CACF;CACF"}
+{"version":3,"file":"define-api.d.ts","sourceRoot":"","sources":["../src/define-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,EAAE,IAAI,IAAI,QAAQ,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACpE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,KAAK,KAAK,EAAU,MAAM,YAAY,CAAC;AAChD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AAEzE,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,OAAO;IACf,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kBAAkB,CAAC,EAAE,wBAAwB,CAAC;CAC/C;AAED,wBAAgB,SAAS,CAAC,OAAO,GAAE,OAAY,qBAQ9C;AAED,qBAAa,aAAa,CAAC,MAAM,SAAS,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC;IAExD,MAAM,EAAE,MAAM;IACd,KAAK,EAAE,KAAK;IACZ,GAAG,CAAC,EAAE,OAAO;IACb,MAAM,CAAC,EAAE,MAAM;IACf,wBAAwB,CAAC,EAAE,wBAAwB;IAL5D,YACS,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,KAAK,EACZ,GAAG,CAAC,EAAE,OAAO,YAAA,EACb,MAAM,CAAC,EAAE,MAAM,YAAA,EACf,wBAAwB,CAAC,EAAE,wBAAwB,YAAA,EACxD;IAEE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,iBAE9B;IAED,KAAK,CACH,IAAI,SAAS,QAAQ,EACrB,WAAW,GAAG,KAAK,EACnB,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,EAChD,YAAY,GAAG,KAAK,EACpB,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,EACjD,QAAQ,GAAG,KAAK,EAChB,cAAc,GAAG,KAAK,EACtB,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,EACnD,WAAW,GAAG,KAAK,EACnB,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,EAChD,OAAO,GAAG,KAAK,EACf,aAAa,GAAG,KAAK,EACrB,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,EAClD,SAAS,GAAG,KAAK,EAEjB,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,YAAY,CACjB,KAAK,CACH,YAAY,CAAC,IAAI,CAAC,EAClB,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,SAAS,EACT,QAAQ,EACR,cAAc,EACd,WAAW,EACX,WAAW,EACX,QAAQ,EACR,OAAO,EACP,aAAa,EACb,UAAU,EACV,SAAS,CACV,CACF,GAGyB,aAAa,CACrC,MAAM,GAAG,GACN,IAAI,IAAI,IAAI,GAAG,YAAY,CAC1B,KAAK,CACH,YAAY,CAAC,IAAI,CAAC,EAClB,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,SAAS,EACT,QAAQ,EACR,cAAc,EACd,WAAW,EACX,WAAW,EACX,QAAQ,EACR,OAAO,EACP,aAAa,EACb,UAAU,EACV,SAAS,CACV,CACF,GACF,CACF,CACF;CACF"}

package/dist/define-api.js

@@ -1,17 +1,19 @@
 import { PubSub } from "./cache.js";
 export function defineApi(options = {}) {
-    return new ApiDefinition({}, options?.cache ?? new PubSub(), options?.oas, options?.logger);
+    return new ApiDefinition({}, options?.cache ?? new PubSub(), options?.oas, options?.logger, options?.revalidationStream);
 }
 export class ApiDefinition {
     routes;
     cache;
     oas;
     logger;
-    constructor(routes, cache, oas, logger) {
+    revalidationStreamConfig;
+    constructor(routes, cache, oas, logger, revalidationStreamConfig) {
         this.routes = routes;
         this.cache = cache;
         this.oas = oas;
         this.logger = logger;
+        this.revalidationStreamConfig = revalidationStreamConfig;
     }
     async invalidate(tags) {
         await this.cache.delete(tags);

package/dist/revalidation-stream.d.ts

@@ -1,7 +1,14 @@
 import type { Cache } from "./cache.js";
+export interface RevalidationStreamConfig {
+    throttleTimeout?: number;
+    keepaliveInterval?: number;
+    filter?: (req: Request) => (tag: string) => boolean;
+}
 interface Options {
     cache: Cache;
+    config?: RevalidationStreamConfig;
+    req: Request;
 }
-export declare function streamRevalidatedTags({ cache }: Options): Response;
+export declare function streamRevalidatedTags({ cache, config, req }: Options): Response;
 export {};
 //# sourceMappingURL=revalidation-stream.d.ts.map

package/dist/revalidation-stream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"revalidation-stream.d.ts","sourceRoot":"","sources":["../src/revalidation-stream.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAIxC,UAAU,OAAO;IACf,KAAK,EAAE,KAAK,CAAC;CACd;AAED,wBAAgB,qBAAqB,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,YA0CvD"}
+{"version":3,"file":"revalidation-stream.d.ts","sourceRoot":"","sources":["../src/revalidation-stream.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAKxC,MAAM,WAAW,wBAAwB;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;CACrD;AAED,UAAU,OAAO;IACf,KAAK,EAAE,KAAK,CAAC;IACb,MAAM,CAAC,EAAE,wBAAwB,CAAC;IAClC,GAAG,EAAE,OAAO,CAAC;CACd;AAED,wBAAgB,qBAAqB,CAAC,EAAE,KAAK,EAAE,MAAW,EAAE,GAAG,EAAE,EAAE,OAAO,YAwEzE"}

package/dist/revalidation-stream.js

@@ -1,11 +1,16 @@
-import { SESSION_COOKIE_NAME, TAGS_CONTENT_TYPE, } from "@toapi/common";
-const KEEPALIVE_INTERVAL = 10 * 1000;
-export function streamRevalidatedTags({ cache }) {
+import { SESSION_COOKIE_NAME, TAGS_CONTENT_TYPE } from "@toapi/common";
+const DEFAULT_KEEPALIVE_INTERVAL = 10 * 1000;
+const DEFAULT_THROTTLE_TIMEOUT = 500;
+export function streamRevalidatedTags({ cache, config = {}, req }) {
+    const { throttleTimeout = DEFAULT_THROTTLE_TIMEOUT, keepaliveInterval = DEFAULT_KEEPALIVE_INTERVAL, filter = () => () => true, } = config;
+    const filterTag = filter(req);
     const id = crypto.randomUUID();
     let interval = null;
+    let timeout = null;
     let unsubscribe = () => { };
     const stream = new ReadableStream({
         async start(controller) {
+            let queue = new Set();
             const textEncoder = new TextEncoder();
             // subscribe to tag invalidations
             unsubscribe = cache.subscribe((tags, meta) => {
@@ -15,19 +20,34 @@ export function streamRevalidatedTags({ cache }) {
                     "clientId" in meta &&
                     meta.clientId === id)
                     return;
+                for (const tag of tags) {
+                    if (filterTag(tag)) {
+                        queue.add(tag);
+                    }
+                }
                 // send tags to client
-                controller.enqueue(textEncoder.encode(`${tags.join(" ")}\n`));
+                if (queue.size > 0 && !timeout) {
+                    controller.enqueue(textEncoder.encode(`${Array.from(queue).join(" ")}\n`));
+                    queue = new Set();
+                    timeout = setTimeout(() => {
+                        controller.enqueue(textEncoder.encode(`${Array.from(queue).join(" ")}\n`));
+                        queue = new Set();
+                        timeout = null;
+                    }, throttleTimeout);
+                }
             });
             // keepalive. The first one is sent right away so the response headers
             // are flushed immediately instead of only once the interval first
             // fires — consumers skip empty lines, so this is a no-op for them.
             const keepalive = () => controller.enqueue(textEncoder.encode("\n"));
             keepalive();
-            interval = setInterval(keepalive, KEEPALIVE_INTERVAL);
+            interval = setInterval(keepalive, keepaliveInterval);
         },
         cancel() {
             if (interval)
                 clearInterval(interval);
+            if (timeout)
+                clearTimeout(timeout);
             unsubscribe();
         },
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toapi/server",
-  "version": "1.3.4",
+  "version": "1.4.0",
   "author": {
     "name": "Michel Smola",
     "email": "michel.smola@farbenmeer.de"
@@ -20,7 +20,7 @@
     }
   },
   "dependencies": {
-    "@toapi/common": "^1.3.4",
+    "@toapi/common": "^1.4.0",
     "zod-openapi": "^6.0.0"
   },
   "devDependencies": {