@browserlessapi/inferlo 0.7.0 → 0.8.0

package/dist/sockets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sockets.js","sourceRoot":"","sources":["../src/sockets.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE9C,4CAA4C;AAC5C,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAG,CAAC;AAyD5B,MAAM,UAAU,SAAS,CAAC,IAAa;IACrC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,QAAQ,EAAE,CAAC;QAC5E,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,qDAAqD,QAAQ,oBAAoB,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,eAAe,IAAI,CAAC,MAAM,aAAa,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,IAAI,GAAG,EAAE;YAC9N,GAAG,EAAE,+IAA+I;SACrJ,CAAC,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,KAAK,CAAC,IAAY,EAAE,MAAqB;IAChD,4FAA4F;IAC5F,OAAO,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;AAC7E,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,KAAmB;IACjD,MAAM,OAAO,GAAG,IAAI,GAAG,EAAc,CAAC;IACtC,MAAM,KAAK,GAAG,IAAI,GAAG,EAA2B,CAAC;IACjD,MAAM,MAAM,GAAG,IAAI,GAAG,EAA2B,CAAC;IAElD,MAAM,UAAU,GAAG,CAAC,OAAqC,EAAE,QAAuB,EAAiB,EAAE;QACnG,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS;YAAE,OAAO,QAAQ,CAAC;QAChE,OAAO,OAAO,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC5E,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAC,GAAW,EAAE,IAAY,EAAQ,EAAE;QAClD,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,CAAC,GAAG;YAAE,OAAO;QACjB,KAAK,MAAM,MAAM,IAAI,CAAC,GAAG,GAAG,CAAC;YAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC,CAAC;IAEF,MAAM,IAAI,GAAG,KAAK,EAAE,IAAY,EAAE,IAAa,EAAE,MAAqB,EAAiB,EAAE;QACvF,MAAM,IAAI,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACnE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,0DAA0D,EAAE,EAAE,GAAG,EAAE,mGAAmG,EAAE,CAAC,CAAC;QAC7M,CAAC;QACD,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAChC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACnB,IAAI,KAAK;YAAE,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC,CAAC;IAEF,MAAM,SAAS,GAAG,CAAC,MAAqB,EAAW,EAAE,CAAC,CAAC;QACrD,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;KACnG,CAAC,CAAC;IAEH,IAAI,OAAkC,CAAC;IAEvC,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAC7B,OAAO;QACL,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,KAAK,CAAC,IAAI,EAAE,OAAO;YACjB,IAAI,IAAI,KAAK,SAAS;gBAAE,OAAO,OAAO,CAAC,IAAI,CAAC;YAC5C,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC;QACjF,CAAC;QACD,IAAI,CAAC,MAAM;YACT,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACtB,CAAC;QACD,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM;YACvB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC;gBAAE,OAAO;YACjC,MAAM,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;YAC3C,IAAI,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACzB,IAAI,CAAC,GAAG;gBAAE,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC;YAC5C,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAChB,IAAI,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC9B,IAAI,CAAC,IAAI;gBAAE,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC;YAClD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChB,CAAC;QACD,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM;YACxB,MAAM,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;YAC3C,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC3B,IAAI,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC;gBAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC7D,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;QAClC,CAAC;QACD,IAAI,CAAC,MAAM;YACT,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACvB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;gBAC3C,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAC3B,IAAI,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC;oBAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC/D,CAAC;YACD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC;QACD,SAAS;QACT,KAAK;YACH,IAAI,CAAC,KAAK;gBAAE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;YACrC,OAAO,KAAK,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;gBACxD,OAAO,GAAG,SAAS,CAAC;gBACpB,MAAM,KAAK,CAAC;YACd,CAAC,CAAC,CAAC;YACH,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,CAAC,IAAI;YACR,IAAI,CAAC,OAAO;gBAAE,OAAO;YACrB,MAAM,GAAG,GAAG,OAAO,CAAC;YACpB,OAAO,GAAG,SAAS,CAAC;YACpB,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,KAAM,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAChD,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/storage.d.ts

@@ -0,0 +1,47 @@
+/** What storage.put() stored. */
+export interface StoredFile {
+    key: string;
+    /** Size in bytes. */
+    size: number;
+    /** Media type, for example "image/png". */
+    type: string;
+}
+/** Where files are kept. Implement it to use another store; Inferlo checks keys and types before calling it. */
+export interface StorageStore {
+    /** Shown in describe() and as app.storage.store, for example "memory" or "disk". */
+    readonly name: string;
+    /** Store the bytes and their media type under the key, replacing what was there. */
+    put(key: string, bytes: Uint8Array, type: string): Promise<void>;
+    /** The bytes and media type stored under the key, or null. */
+    get(key: string): Promise<{
+        bytes: Uint8Array;
+        type: string;
+    } | null>;
+    /** Remove the key. Resolves to true when it existed. */
+    delete(key: string): Promise<boolean>;
+}
+export interface StoragePutOptions {
+    /** Media type to store. Default: the File's or Blob's type, or "application/octet-stream". */
+    type?: string;
+}
+export interface Storage {
+    /** The store's name ("memory", "disk", ...), or null when createApp has no storage option. */
+    readonly store: string | null;
+    /**
+     * Store a file under a key such as "avatars/42.png" (segments of letters, digits, ".", "_" and "-", separated by "/"),
+     * replacing what was there. Keys are the same for every user and tenant: put the tenant or user id in the key.
+     */
+    put(key: string, data: Blob | Uint8Array | ArrayBuffer | string, options?: StoragePutOptions): Promise<StoredFile>;
+    /** The file stored under the key as a web File (name: the key's last segment), or null when there is none. */
+    get(key: string): Promise<File | null>;
+    /** Remove the file. Resolves to true when it existed. */
+    delete(key: string): Promise<boolean>;
+}
+/** Throws IL6039 unless the key is safe for every store (no "..", no leading "/", no hidden files). */
+export declare function checkStorageKey(key: unknown): string;
+/** Throws IL6038 unless the value implements StorageStore. */
+export declare function checkStorageStore(value: unknown): StorageStore | undefined;
+/** The ctx.storage and app.storage API on top of a store (or one that throws IL6037 when there is none). */
+export declare function createStorage(store: StorageStore | undefined): Storage;
+/** Files kept in this process's memory: for tests and single-process development. Lost on restart. */
+export declare function memoryStorage(): StorageStore;

package/dist/storage.js

@@ -0,0 +1,123 @@
+/**
+ * File storage: ctx.storage in routes, sockets and jobs, app.storage everywhere else.
+ *
+ *   const app = createApp({ routes, storage: diskStorage({ dir: "./uploads" }) });
+ *
+ *   const saved = await storage.put(`avatars/${user.id}.png`, body.avatar); // a File from t.file(), a Blob, bytes or text
+ *   const file = await storage.get(`avatars/${user.id}.png`);               // a web File, or null
+ *   await storage.delete(`avatars/${user.id}.png`);                         // true when it existed
+ *
+ * The store is chosen once in createApp({ storage }): memoryStorage() (one process, tests), diskStorage({ dir })
+ * (a local or mounted directory), or any object that implements StorageStore.
+ */
+import { InferloError } from "./errors.js";
+const MAX_KEY_LENGTH = 1024;
+const SEGMENT = /^[A-Za-z0-9_-][A-Za-z0-9._-]{0,254}$/;
+const MEDIA_TYPE = /^[a-z0-9][a-z0-9!#$&^_.+-]{0,126}\/[a-z0-9][a-z0-9!#$&^_.+-]{0,126}$/;
+const DEFAULT_TYPE = "application/octet-stream";
+function invalidKey(key, why) {
+    return new InferloError("IL6039", `Invalid storage key ${JSON.stringify(key)}: ${why}.`, {
+        fix: 'Use keys made of segments of letters, digits, ".", "_" and "-" (not starting with "."), separated by "/", for example `avatars/${user.id}.png`. Never use a file name sent by the client as the key.',
+    });
+}
+/** Throws IL6039 unless the key is safe for every store (no "..", no leading "/", no hidden files). */
+export function checkStorageKey(key) {
+    if (typeof key !== "string" || key.length === 0)
+        throw invalidKey(key, "keys are non-empty strings");
+    if (key.length > MAX_KEY_LENGTH)
+        throw invalidKey(key.slice(0, 40) + "...", `keys are at most ${MAX_KEY_LENGTH} characters`);
+    for (const segment of key.split("/")) {
+        if (!SEGMENT.test(segment))
+            throw invalidKey(key, segment === "" ? 'empty segment (a leading, trailing or double "/")' : `segment "${segment}" is not allowed`);
+    }
+    return key;
+}
+function checkType(type) {
+    const lower = type.toLowerCase();
+    if (!MEDIA_TYPE.test(lower)) {
+        throw new InferloError("IL6039", `Invalid media type ${JSON.stringify(type)} for storage.put().`, {
+            fix: 'Pass a plain media type without parameters, for example { type: "image/png" } or "application/pdf".',
+        });
+    }
+    return lower;
+}
+async function toBytes(data) {
+    if (typeof data === "string")
+        return new TextEncoder().encode(data);
+    if (data instanceof Uint8Array)
+        return data;
+    if (data instanceof ArrayBuffer)
+        return new Uint8Array(data);
+    if (typeof Blob !== "undefined" && data instanceof Blob)
+        return new Uint8Array(await data.arrayBuffer());
+    throw new InferloError("IL6039", "storage.put() takes a File, Blob, Uint8Array, ArrayBuffer or string.", {
+        fix: "Pass the File from a t.file() field directly: await storage.put(key, body.avatar).",
+    });
+}
+function blobType(data) {
+    return typeof Blob !== "undefined" && data instanceof Blob && data.type ? data.type.split(";")[0].trim() : "";
+}
+/** Throws IL6038 unless the value implements StorageStore. */
+export function checkStorageStore(value) {
+    if (value === undefined)
+        return undefined;
+    const store = value;
+    if (!store || typeof store !== "object" || typeof store.name !== "string" || !store.name || typeof store.put !== "function" || typeof store.get !== "function" || typeof store.delete !== "function") {
+        throw new InferloError("IL6038", "Invalid storage option in createApp.", {
+            fix: 'Pass a store: createApp({ storage: diskStorage({ dir: "./uploads" }) }), memoryStorage() in tests, or an object with name, put(key, bytes, type), get(key) and delete(key).',
+        });
+    }
+    return store;
+}
+/** The ctx.storage and app.storage API on top of a store (or one that throws IL6037 when there is none). */
+export function createStorage(store) {
+    const need = () => {
+        if (store)
+            return store;
+        throw new InferloError("IL6037", "ctx.storage was used, but createApp has no storage option.", {
+            fix: 'Choose where files are kept: createApp({ storage: diskStorage({ dir: "./uploads" }) }), or memoryStorage() in tests.',
+        });
+    };
+    return {
+        store: store?.name ?? null,
+        async put(key, data, options = {}) {
+            const s = need();
+            checkStorageKey(key);
+            const type = checkType(options.type ?? (blobType(data) || DEFAULT_TYPE));
+            const bytes = await toBytes(data);
+            await s.put(key, bytes, type);
+            return { key, size: bytes.byteLength, type };
+        },
+        async get(key) {
+            const s = need();
+            checkStorageKey(key);
+            const found = await s.get(key);
+            if (!found)
+                return null;
+            return new File([found.bytes], key.slice(key.lastIndexOf("/") + 1), { type: found.type || DEFAULT_TYPE });
+        },
+        async delete(key) {
+            const s = need();
+            checkStorageKey(key);
+            return s.delete(key);
+        },
+    };
+}
+/** Files kept in this process's memory: for tests and single-process development. Lost on restart. */
+export function memoryStorage() {
+    const files = new Map();
+    return {
+        name: "memory",
+        async put(key, bytes, type) {
+            files.set(key, { bytes: bytes.slice(), type });
+        },
+        async get(key) {
+            const found = files.get(key);
+            return found ? { bytes: found.bytes.slice(), type: found.type } : null;
+        },
+        async delete(key) {
+            return files.delete(key);
+        },
+    };
+}
+//# sourceMappingURL=storage.js.map

package/dist/storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AA0C3C,MAAM,cAAc,GAAG,IAAI,CAAC;AAC5B,MAAM,OAAO,GAAG,sCAAsC,CAAC;AACvD,MAAM,UAAU,GAAG,sEAAsE,CAAC;AAC1F,MAAM,YAAY,GAAG,0BAA0B,CAAC;AAEhD,SAAS,UAAU,CAAC,GAAY,EAAE,GAAW;IAC3C,OAAO,IAAI,YAAY,CAAC,QAAQ,EAAE,uBAAuB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,GAAG,GAAG,EAAE;QACvF,GAAG,EAAE,sMAAsM;KAC5M,CAAC,CAAC;AACL,CAAC;AAED,uGAAuG;AACvG,MAAM,UAAU,eAAe,CAAC,GAAY;IAC1C,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,UAAU,CAAC,GAAG,EAAE,4BAA4B,CAAC,CAAC;IACrG,IAAI,GAAG,CAAC,MAAM,GAAG,cAAc;QAAE,MAAM,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,EAAE,oBAAoB,cAAc,aAAa,CAAC,CAAC;IAC7H,KAAK,MAAM,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACrC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;YAAE,MAAM,UAAU,CAAC,GAAG,EAAE,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,mDAAmD,CAAC,CAAC,CAAC,YAAY,OAAO,kBAAkB,CAAC,CAAC;IAClK,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,SAAS,CAAC,IAAY;IAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACjC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,sBAAsB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,qBAAqB,EAAE;YAChG,GAAG,EAAE,qGAAqG;SAC3G,CAAC,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,KAAK,UAAU,OAAO,CAAC,IAA8C;IACnE,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACpE,IAAI,IAAI,YAAY,UAAU;QAAE,OAAO,IAAI,CAAC;IAC5C,IAAI,IAAI,YAAY,WAAW;QAAE,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;IAC7D,IAAI,OAAO,IAAI,KAAK,WAAW,IAAI,IAAI,YAAY,IAAI;QAAE,OAAO,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IACzG,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,sEAAsE,EAAE;QACvG,GAAG,EAAE,oFAAoF;KAC1F,CAAC,CAAC;AACL,CAAC;AAED,SAAS,QAAQ,CAAC,IAAa;IAC7B,OAAO,OAAO,IAAI,KAAK,WAAW,IAAI,IAAI,YAAY,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AACjH,CAAC;AAED,8DAA8D;AAC9D,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,MAAM,KAAK,GAAG,KAAqC,CAAC;IACpD,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,OAAO,KAAK,CAAC,GAAG,KAAK,UAAU,IAAI,OAAO,KAAK,CAAC,GAAG,KAAK,UAAU,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;QACrM,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,sCAAsC,EAAE;YACvE,GAAG,EAAE,6KAA6K;SACnL,CAAC,CAAC;IACL,CAAC;IACD,OAAO,KAAqB,CAAC;AAC/B,CAAC;AAED,4GAA4G;AAC5G,MAAM,UAAU,aAAa,CAAC,KAA+B;IAC3D,MAAM,IAAI,GAAG,GAAiB,EAAE;QAC9B,IAAI,KAAK;YAAE,OAAO,KAAK,CAAC;QACxB,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,4DAA4D,EAAE;YAC7F,GAAG,EAAE,sHAAsH;SAC5H,CAAC,CAAC;IACL,CAAC,CAAC;IACF,OAAO;QACL,KAAK,EAAE,KAAK,EAAE,IAAI,IAAI,IAAI;QAC1B,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,GAAG,EAAE;YAC/B,MAAM,CAAC,GAAG,IAAI,EAAE,CAAC;YACjB,eAAe,CAAC,GAAG,CAAC,CAAC;YACrB,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC;YACzE,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;YAClC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YAC9B,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC;QAC/C,CAAC;QACD,KAAK,CAAC,GAAG,CAAC,GAAG;YACX,MAAM,CAAC,GAAG,IAAI,EAAE,CAAC;YACjB,eAAe,CAAC,GAAG,CAAC,CAAC;YACrB,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC/B,IAAI,CAAC,KAAK;gBAAE,OAAO,IAAI,CAAC;YACxB,OAAO,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,KAAgC,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,YAAY,EAAE,CAAC,CAAC;QACvI,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,GAAG;YACd,MAAM,CAAC,GAAG,IAAI,EAAE,CAAC;YACjB,eAAe,CAAC,GAAG,CAAC,CAAC;YACrB,OAAO,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC;KACF,CAAC;AACJ,CAAC;AAED,sGAAsG;AACtG,MAAM,UAAU,aAAa;IAC3B,MAAM,KAAK,GAAG,IAAI,GAAG,EAA+C,CAAC;IACrE,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI;YACxB,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QACjD,CAAC;QACD,KAAK,CAAC,GAAG,CAAC,GAAG;YACX,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC7B,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QACzE,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,GAAG;YACd,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/websocket.d.ts

@@ -0,0 +1,81 @@
+/**
+ * WebSocket plumbing shared by the app (src/app.ts) and the servers (src/serve.ts): the per-request upgrader a server
+ * registers, the record of upgraded requests, Deno's built-in upgrade, and the RFC 6455 frame reader and writer used
+ * on Node.js, where the runtime has no WebSocket server of its own. Web APIs only.
+ */
+/** One open connection, as the app sees it: send a text message, or close with a code and reason. */
+export interface SocketTransport {
+    send(text: string): void;
+    close(code: number, reason: string): void;
+}
+/** What the app does with a connection's events. */
+export interface SocketListener {
+    message(data: string | Uint8Array): void;
+    close(code: number, reason: string): void;
+}
+/**
+ * Accepts the WebSocket upgrade of one request: connects the app's listener to the new connection and returns the
+ * response to answer with (Deno), or undefined when the server answers the handshake itself (Node.js, Bun).
+ */
+export type Upgrader = (connect: (transport: SocketTransport) => SocketListener) => Promise<Response | undefined>;
+/** Set by serve() for each request it can upgrade (Node.js upgrade requests, every Bun request). */
+export declare const upgraders: WeakMap<Request, Upgrader>;
+/** Requests the app upgraded, with Deno's upgrade response (null on Node.js and Bun, which answer it themselves). */
+export declare const upgrades: WeakMap<Request, Response | null>;
+/**
+ * On Deno, a request from Deno.serve (or deno serve), which passes its handler info with a remoteAddr to app.fetch,
+ * can be upgraded with Deno.upgradeWebSocket. Requests made any other way (app.request) cannot.
+ */
+export declare function denoUpgrader(req: Request, info: unknown): Upgrader | undefined;
+type BunSocket = {
+    data: {
+        connect: (transport: SocketTransport) => SocketListener;
+        listener?: SocketListener;
+    };
+    send(text: string): void;
+    close(code?: number, reason?: string): void;
+};
+/**
+ * The websocket handlers for Bun.serve, so a Bun server that runs app.fetch serves the app's WebSocket routes:
+ * Bun.serve({ fetch: app.fetch, websocket: bunWebSocket }). serve() and app.listen() on Bun use them already.
+ */
+export declare const bunWebSocket: {
+    open(ws: BunSocket): void;
+    message(ws: BunSocket, data: string | Uint8Array): void;
+    close(ws: BunSocket, code: number, reason: string): void;
+};
+/** On Bun, app.fetch(req, server) gets the Bun server, whose upgrade() hands the connection to bunWebSocket. */
+export declare function bunUpgrader(req: Request, server: unknown): Upgrader | undefined;
+/** The Sec-WebSocket-Accept value for a client's Sec-WebSocket-Key (RFC 6455 section 4.2.2). */
+export declare function acceptKey(key: string): Promise<string>;
+/** True for a well-formed Sec-WebSocket-Key: 16 random bytes in base64. */
+export declare function validKey(key: string | null): key is string;
+export declare const OP_CONTINUATION = 0;
+export declare const OP_TEXT = 1;
+export declare const OP_BINARY = 2;
+export declare const OP_CLOSE = 8;
+export declare const OP_PING = 9;
+export declare const OP_PONG = 10;
+/** A complete, unmasked server frame. */
+export declare function encodeFrame(opcode: number, payload: Uint8Array): Uint8Array;
+/** A close frame with a status code and a reason (cut to the 123 bytes a close frame has room for). */
+export declare function encodeClose(code: number, reason: string): Uint8Array;
+export interface FrameEvents {
+    /** A complete text (string) or binary (bytes) message. */
+    message(data: string | Uint8Array): void;
+    ping(payload: Uint8Array): void;
+    /** The client's close frame: its code (1005 when it sent none) and reason. */
+    close(code: number, reason: string): void;
+    /** The client broke the protocol: close the connection with this code. */
+    error(code: number, reason: string): void;
+}
+/**
+ * Reads client frames (RFC 6455): masked, possibly fragmented, with ping, pong and close control frames in between.
+ * A message larger than maxMessageBytes is an error (1009), so a client cannot make the server buffer without end.
+ */
+export declare class FrameReader {
+    #private;
+    constructor(maxMessageBytes: number, events: FrameEvents);
+    push(chunk: Uint8Array): void;
+}
+export {};

package/dist/websocket.js

@@ -0,0 +1,251 @@
+/**
+ * WebSocket plumbing shared by the app (src/app.ts) and the servers (src/serve.ts): the per-request upgrader a server
+ * registers, the record of upgraded requests, Deno's built-in upgrade, and the RFC 6455 frame reader and writer used
+ * on Node.js, where the runtime has no WebSocket server of its own. Web APIs only.
+ */
+import { InferloError } from "./errors.js";
+/** Set by serve() for each request it can upgrade (Node.js upgrade requests, every Bun request). */
+export const upgraders = new WeakMap();
+/** Requests the app upgraded, with Deno's upgrade response (null on Node.js and Bun, which answer it themselves). */
+export const upgrades = new WeakMap();
+/**
+ * On Deno, a request from Deno.serve (or deno serve), which passes its handler info with a remoteAddr to app.fetch,
+ * can be upgraded with Deno.upgradeWebSocket. Requests made any other way (app.request) cannot.
+ */
+export function denoUpgrader(req, info) {
+    const deno = globalThis.Deno;
+    if (!deno?.upgradeWebSocket || typeof info !== "object" || info === null || !("remoteAddr" in info))
+        return undefined;
+    return async (connect) => {
+        const { socket, response } = deno.upgradeWebSocket(req);
+        const listener = connect({
+            send: (text) => {
+                if (socket.readyState === 1)
+                    socket.send(text);
+            },
+            close: (code, reason) => socket.close(code, reason),
+        });
+        socket.onmessage = (event) => listener.message(typeof event.data === "string" ? event.data : new Uint8Array(event.data));
+        socket.onclose = (event) => listener.close(event.code, event.reason);
+        socket.onerror = () => { };
+        return response;
+    };
+}
+/**
+ * The websocket handlers for Bun.serve, so a Bun server that runs app.fetch serves the app's WebSocket routes:
+ * Bun.serve({ fetch: app.fetch, websocket: bunWebSocket }). serve() and app.listen() on Bun use them already.
+ */
+export const bunWebSocket = {
+    open(ws) {
+        ws.data.listener = ws.data.connect({ send: (text) => ws.send(text), close: (code, reason) => ws.close(code, reason) });
+    },
+    message(ws, data) {
+        ws.data.listener?.message(typeof data === "string" ? data : new Uint8Array(data));
+    },
+    close(ws, code, reason) {
+        ws.data.listener?.close(code, reason);
+    },
+};
+/** On Bun, app.fetch(req, server) gets the Bun server, whose upgrade() hands the connection to bunWebSocket. */
+export function bunUpgrader(req, server) {
+    if (!globalThis.Bun || typeof server?.upgrade !== "function")
+        return undefined;
+    return async (connect) => {
+        let upgraded;
+        try {
+            upgraded = server.upgrade(req, { data: { connect } });
+        }
+        catch {
+            upgraded = false;
+        }
+        if (!upgraded) {
+            throw new InferloError("IL2011", "This Bun server cannot accept WebSocket connections.", { status: 501, fix: 'Pass the websocket handlers to Bun.serve: Bun.serve({ fetch: app.fetch, websocket: bunWebSocket }), with bunWebSocket from "@browserlessapi/inferlo".' });
+        }
+        return undefined;
+    };
+}
+/** The Sec-WebSocket-Accept value for a client's Sec-WebSocket-Key (RFC 6455 section 4.2.2). */
+export async function acceptKey(key) {
+    const digest = await crypto.subtle.digest("SHA-1", new TextEncoder().encode(key + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"));
+    let binary = "";
+    for (const byte of new Uint8Array(digest))
+        binary += String.fromCharCode(byte);
+    return btoa(binary);
+}
+/** True for a well-formed Sec-WebSocket-Key: 16 random bytes in base64. */
+export function validKey(key) {
+    return typeof key === "string" && /^[A-Za-z0-9+/]{22}==$/.test(key);
+}
+export const OP_CONTINUATION = 0x0;
+export const OP_TEXT = 0x1;
+export const OP_BINARY = 0x2;
+export const OP_CLOSE = 0x8;
+export const OP_PING = 0x9;
+export const OP_PONG = 0xa;
+/** A complete, unmasked server frame. */
+export function encodeFrame(opcode, payload) {
+    const length = payload.byteLength;
+    const headerLength = length < 126 ? 2 : length < 65536 ? 4 : 10;
+    const out = new Uint8Array(headerLength + length);
+    out[0] = 0x80 | opcode;
+    if (length < 126)
+        out[1] = length;
+    else if (length < 65536) {
+        out[1] = 126;
+        out[2] = length >> 8;
+        out[3] = length & 0xff;
+    }
+    else {
+        out[1] = 127;
+        new DataView(out.buffer).setBigUint64(2, BigInt(length));
+    }
+    out.set(payload, headerLength);
+    return out;
+}
+/** A close frame with a status code and a reason (cut to the 123 bytes a close frame has room for). */
+export function encodeClose(code, reason) {
+    const text = new TextEncoder().encode(reason).subarray(0, 123);
+    const payload = new Uint8Array(2 + text.byteLength);
+    payload[0] = code >> 8;
+    payload[1] = code & 0xff;
+    payload.set(text, 2);
+    return encodeFrame(OP_CLOSE, payload);
+}
+/**
+ * Reads client frames (RFC 6455): masked, possibly fragmented, with ping, pong and close control frames in between.
+ * A message larger than maxMessageBytes is an error (1009), so a client cannot make the server buffer without end.
+ */
+export class FrameReader {
+    #buffer = new Uint8Array(0);
+    #parts = [];
+    #size = 0;
+    #opcode = -1;
+    #done = false;
+    #max;
+    #events;
+    #decoder = new TextDecoder("utf-8", { fatal: true });
+    constructor(maxMessageBytes, events) {
+        this.#max = maxMessageBytes;
+        this.#events = events;
+    }
+    push(chunk) {
+        if (this.#done)
+            return;
+        if (this.#buffer.byteLength === 0)
+            this.#buffer = chunk;
+        else {
+            const joined = new Uint8Array(this.#buffer.byteLength + chunk.byteLength);
+            joined.set(this.#buffer);
+            joined.set(chunk, this.#buffer.byteLength);
+            this.#buffer = joined;
+        }
+        while (!this.#done && this.#next())
+            ;
+    }
+    #fail(code, reason) {
+        this.#done = true;
+        this.#events.error(code, reason);
+        return false;
+    }
+    /** Reads one frame from the buffer; false when more bytes are needed or reading stopped. */
+    #next() {
+        const b = this.#buffer;
+        if (b.byteLength < 2)
+            return false;
+        const fin = (b[0] & 0x80) !== 0;
+        const opcode = b[0] & 0x0f;
+        if ((b[0] & 0x70) !== 0)
+            return this.#fail(1002, "Extensions are not supported");
+        if ((b[1] & 0x80) === 0)
+            return this.#fail(1002, "Client frames must be masked");
+        let length = b[1] & 0x7f;
+        let offset = 2;
+        if (length === 126) {
+            if (b.byteLength < 4)
+                return false;
+            length = (b[2] << 8) | b[3];
+            offset = 4;
+        }
+        else if (length === 127) {
+            if (b.byteLength < 10)
+                return false;
+            const big = new DataView(b.buffer, b.byteOffset + 2, 8).getBigUint64(0);
+            if (big > BigInt(this.#max))
+                return this.#fail(1009, "Message too big");
+            length = Number(big);
+            offset = 10;
+        }
+        const control = opcode >= 0x8;
+        if (control && (!fin || length > 125))
+            return this.#fail(1002, "Invalid control frame");
+        if (![OP_CONTINUATION, OP_TEXT, OP_BINARY, OP_CLOSE, OP_PING, OP_PONG].includes(opcode))
+            return this.#fail(1002, "Unknown opcode");
+        if (!control && this.#size + length > this.#max)
+            return this.#fail(1009, "Message too big");
+        if (b.byteLength < offset + 4 + length)
+            return false;
+        const mask = b.subarray(offset, offset + 4);
+        const payload = b.slice(offset + 4, offset + 4 + length);
+        for (let i = 0; i < payload.byteLength; i++)
+            payload[i] ^= mask[i & 3];
+        this.#buffer = b.subarray(offset + 4 + length);
+        if (opcode === OP_PING)
+            this.#events.ping(payload);
+        else if (opcode === OP_PONG) {
+            // Answers to pings; nothing to do.
+        }
+        else if (opcode === OP_CLOSE) {
+            if (payload.byteLength === 1)
+                return this.#fail(1002, "Invalid close frame");
+            const code = payload.byteLength >= 2 ? (payload[0] << 8) | payload[1] : 1005;
+            let reason = "";
+            try {
+                reason = this.#decoder.decode(payload.subarray(2));
+            }
+            catch {
+                return this.#fail(1007, "Close reason is not UTF-8");
+            }
+            this.#done = true;
+            this.#events.close(code, reason);
+            return false;
+        }
+        else {
+            if (opcode === OP_CONTINUATION ? this.#opcode === -1 : this.#opcode !== -1)
+                return this.#fail(1002, "Unexpected frame order");
+            if (opcode !== OP_CONTINUATION)
+                this.#opcode = opcode;
+            this.#parts.push(payload);
+            this.#size += length;
+            if (fin) {
+                const data = this.#parts.length === 1 ? this.#parts[0] : concat(this.#parts, this.#size);
+                const kind = this.#opcode;
+                this.#parts = [];
+                this.#size = 0;
+                this.#opcode = -1;
+                if (kind === OP_TEXT) {
+                    let text;
+                    try {
+                        text = this.#decoder.decode(data);
+                    }
+                    catch {
+                        return this.#fail(1007, "Text message is not UTF-8");
+                    }
+                    this.#events.message(text);
+                }
+                else
+                    this.#events.message(data);
+            }
+        }
+        return true;
+    }
+}
+function concat(parts, size) {
+    const out = new Uint8Array(size);
+    let at = 0;
+    for (const part of parts) {
+        out.set(part, at);
+        at += part.byteLength;
+    }
+    return out;
+}
+//# sourceMappingURL=websocket.js.map

package/dist/websocket.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket.js","sourceRoot":"","sources":["../src/websocket.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAoB3C,oGAAoG;AACpG,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,OAAO,EAAqB,CAAC;AAE1D,qHAAqH;AACrH,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,OAAO,EAA4B,CAAC;AAWhE;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,GAAY,EAAE,IAAa;IACtD,MAAM,IAAI,GAAI,UAAyG,CAAC,IAAI,CAAC;IAC7H,IAAI,CAAC,IAAI,EAAE,gBAAgB,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,YAAY,IAAI,IAAI,CAAC;QAAE,OAAO,SAAS,CAAC;IACtH,OAAO,KAAK,EAAE,OAAO,EAAE,EAAE;QACvB,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,gBAAiB,CAAC,GAAG,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,OAAO,CAAC;YACvB,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;gBACb,IAAI,MAAM,CAAC,UAAU,KAAK,CAAC;oBAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjD,CAAC;YACD,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC;SACpD,CAAC,CAAC;QACH,MAAM,CAAC,SAAS,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,IAAmB,CAAC,CAAC,CAAC;QACxI,MAAM,CAAC,OAAO,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACrE,MAAM,CAAC,OAAO,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;AACJ,CAAC;AAID;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,IAAI,CAAC,EAAa;QAChB,EAAE,CAAC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;IACzH,CAAC;IACD,OAAO,CAAC,EAAa,EAAE,IAAyB;QAC9C,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;IACpF,CAAC;IACD,KAAK,CAAC,EAAa,EAAE,IAAY,EAAE,MAAc;QAC/C,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACxC,CAAC;CACF,CAAC;AAEF,gHAAgH;AAChH,MAAM,UAAU,WAAW,CAAC,GAAY,EAAE,MAAe;IACvD,IAAI,CAAE,UAAgC,CAAC,GAAG,IAAI,OAAQ,MAAuC,EAAE,OAAO,KAAK,UAAU;QAAE,OAAO,SAAS,CAAC;IACxI,OAAO,KAAK,EAAE,OAAO,EAAE,EAAE;QACvB,IAAI,QAAiB,CAAC;QACtB,IAAI,CAAC;YACH,QAAQ,GAAI,MAA8D,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;QACjH,CAAC;QAAC,MAAM,CAAC;YACP,QAAQ,GAAG,KAAK,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,sDAAsD,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,uJAAuJ,EAAE,CAAC,CAAC;QAC1Q,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;AACJ,CAAC;AAED,gGAAgG;AAChG,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,GAAW;IACzC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,GAAG,sCAAsC,CAAC,CAAC,CAAC;IAC3H,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,MAAM,IAAI,IAAI,IAAI,UAAU,CAAC,MAAM,CAAC;QAAE,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC/E,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;AACtB,CAAC;AAED,2EAA2E;AAC3E,MAAM,UAAU,QAAQ,CAAC,GAAkB;IACzC,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,uBAAuB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACtE,CAAC;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,CAAC;AACnC,MAAM,CAAC,MAAM,OAAO,GAAG,GAAG,CAAC;AAC3B,MAAM,CAAC,MAAM,SAAS,GAAG,GAAG,CAAC;AAC7B,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAG,CAAC;AAC5B,MAAM,CAAC,MAAM,OAAO,GAAG,GAAG,CAAC;AAC3B,MAAM,CAAC,MAAM,OAAO,GAAG,GAAG,CAAC;AAE3B,yCAAyC;AACzC,MAAM,UAAU,WAAW,CAAC,MAAc,EAAE,OAAmB;IAC7D,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAClC,MAAM,YAAY,GAAG,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAChE,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,YAAY,GAAG,MAAM,CAAC,CAAC;IAClD,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,MAAM,CAAC;IACvB,IAAI,MAAM,GAAG,GAAG;QAAE,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;SAC7B,IAAI,MAAM,GAAG,KAAK,EAAE,CAAC;QACxB,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;QACb,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,CAAC,CAAC;QACrB,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC;IACzB,CAAC;SAAM,CAAC;QACN,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;QACb,IAAI,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAC3D,CAAC;IACD,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC/B,OAAO,GAAG,CAAC;AACb,CAAC;AAED,uGAAuG;AACvG,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,MAAc;IACtD,MAAM,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC/D,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;IACpD,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC;IACvB,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;IACzB,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACrB,OAAO,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AACxC,CAAC;AAYD;;;GAGG;AACH,MAAM,OAAO,WAAW;IACtB,OAAO,GAAe,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IACxC,MAAM,GAAiB,EAAE,CAAC;IAC1B,KAAK,GAAG,CAAC,CAAC;IACV,OAAO,GAAG,CAAC,CAAC,CAAC;IACb,KAAK,GAAG,KAAK,CAAC;IACL,IAAI,CAAS;IACb,OAAO,CAAc;IACrB,QAAQ,GAAG,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAE9D,YAAY,eAAuB,EAAE,MAAmB;QACtD,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,IAAI,CAAC,KAAiB;QACpB,IAAI,IAAI,CAAC,KAAK;YAAE,OAAO;QACvB,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,KAAK,CAAC;YAAE,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;aACnD,CAAC;YACJ,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;YAC1E,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACzB,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAC3C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACxB,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE;YAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,IAAY,EAAE,MAAc;QAChC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,4FAA4F;IAC5F,KAAK;QACH,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;QACvB,IAAI,CAAC,CAAC,UAAU,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QACnC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,CAAC,CAAC,CAAC,CAAE,GAAG,IAAI,CAAC;QAC5B,IAAI,CAAC,CAAC,CAAC,CAAC,CAAE,GAAG,IAAI,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,8BAA8B,CAAC,CAAC;QAClF,IAAI,CAAC,CAAC,CAAC,CAAC,CAAE,GAAG,IAAI,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,8BAA8B,CAAC,CAAC;QAClF,IAAI,MAAM,GAAG,CAAC,CAAC,CAAC,CAAE,GAAG,IAAI,CAAC;QAC1B,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,IAAI,CAAC,CAAC,UAAU,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC;YACnC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC;YAC9B,MAAM,GAAG,CAAC,CAAC;QACb,CAAC;aAAM,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YAC1B,IAAI,CAAC,CAAC,UAAU,GAAG,EAAE;gBAAE,OAAO,KAAK,CAAC;YACpC,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACxE,IAAI,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;gBAAE,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;YACxE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YACrB,MAAM,GAAG,EAAE,CAAC;QACd,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,IAAI,GAAG,CAAC;QAC9B,IAAI,OAAO,IAAI,CAAC,CAAC,GAAG,IAAI,MAAM,GAAG,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,uBAAuB,CAAC,CAAC;QACxF,IAAI,CAAC,CAAC,eAAe,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;YAAE,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;QACnI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;QAC5F,IAAI,CAAC,CAAC,UAAU,GAAG,MAAM,GAAG,CAAC,GAAG,MAAM;YAAE,OAAO,KAAK,CAAC;QACrD,MAAM,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC;QACzD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,EAAE;YAAE,OAAO,CAAC,CAAC,CAAE,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC;QACzE,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC;QAE/C,IAAI,MAAM,KAAK,OAAO;YAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aAC9C,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;YAC5B,mCAAmC;QACrC,CAAC;aAAM,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,IAAI,OAAO,CAAC,UAAU,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;YAC7E,MAAM,IAAI,GAAG,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YAC/E,IAAI,MAAM,GAAG,EAAE,CAAC;YAChB,IAAI,CAAC;gBACH,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;YACrD,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,2BAA2B,CAAC,CAAC;YACvD,CAAC;YACD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACjC,OAAO,KAAK,CAAC;QACf,CAAC;aAAM,CAAC;YACN,IAAI,MAAM,KAAK,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,CAAC;gBAAE,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC;YAC9H,IAAI,MAAM,KAAK,eAAe;gBAAE,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;YACtD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC1B,IAAI,CAAC,KAAK,IAAI,MAAM,CAAC;YACrB,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC1F,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC;gBAC1B,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;gBACjB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;gBACf,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;gBAClB,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;oBACrB,IAAI,IAAY,CAAC;oBACjB,IAAI,CAAC;wBACH,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;oBACpC,CAAC;oBAAC,MAAM,CAAC;wBACP,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,2BAA2B,CAAC,CAAC;oBACvD,CAAC;oBACD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAC7B,CAAC;;oBAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,SAAS,MAAM,CAAC,KAAmB,EAAE,IAAY;IAC/C,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;IACjC,IAAI,EAAE,GAAG,CAAC,CAAC;IACX,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAClB,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC;IACxB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/llms.txt

@@ -11,6 +11,7 @@ Key rules: routes are private unless `auth: "public"`; validate input with `t.*`
 - [Schemas](https://github.com/BrowserlessAPI/Inferlo/blob/main/docs/schema.md): t.* types, modifiers, validation, JSON Schema
 - [Models and database](https://github.com/BrowserlessAPI/Inferlo/blob/main/docs/database.md): model(), queries, adapters, db push, transactions
 - [Routes](https://github.com/BrowserlessAPI/Inferlo/blob/main/docs/routes.md): options, handler context, return values, errors, middleware, deprecated routes (Deprecation and Sunset headers), API versions with apiVersion("v1", routes) and an OpenAPI document per version
+- [WebSockets](https://github.com/BrowserlessAPI/Inferlo/blob/main/docs/websockets.md): route.ws(path, { message, auth, rateLimit }).handle(fn) with the same auth, permissions and rate limits as HTTP routes, JSON messages validated and handled in order, ctx.socket, origin checks, on Node.js, Bun and Deno
 - [Auth](https://github.com/BrowserlessAPI/Inferlo/blob/main/docs/auth.md): auth.resolve, roles, permissions() with can() and authorize() and the route permission option, bearer API keys, passwords
 - [AI](https://github.com/BrowserlessAPI/Inferlo/blob/main/docs/ai.md): providers, aliases and fallback, structured output, streaming, embeddings, usage and budgets
 - [Modules](https://github.com/BrowserlessAPI/Inferlo/blob/main/docs/modules.md): module("billing", { imports, models, routes, jobs, provides }) splits a large app into feature modules with explicit dependencies, createApp({ modules }), checked at startup and shown in describe