@browserlessapi/inferlo 0.6.0 → 0.7.0

package/dist/langchain.js

@@ -0,0 +1,220 @@
+/**
+ * LangChain.js: Inferlo's AI aliases as a LangChain chat model, and Inferlo tools (function tools and routes)
+ * as LangChain tools.
+ *
+ *   import { toLangChainModel, toLangChainTools } from "@browserlessapi/inferlo/langchain";
+ *
+ *   const model = toLangChainModel(ctx.ai, { model: "fast", for: user.id });
+ *   const agent = createAgent({ model, tools: toLangChainTools([getWeather, createTicket], { ai: ctx.ai }) });
+ *
+ * The model keeps Inferlo's aliases, fallback, budgets, usage tracking and tracing; LangChain runs the agent
+ * loop and the tools. Needs @langchain/core 0.3 or later (an optional peer dependency).
+ */
+import { BaseChatModel } from "@langchain/core/language_models/chat_models";
+import { AIMessage, AIMessageChunk } from "@langchain/core/messages";
+import { ChatGenerationChunk } from "@langchain/core/outputs";
+import { DynamicStructuredTool } from "@langchain/core/tools";
+import { convertToOpenAITool } from "@langchain/core/utils/function_calling";
+import { callModel, routeToolsOf } from "./ai/index.js";
+import { functionToolSpec, isTool, runFunctionTool } from "./ai/tool.js";
+import { InferloError } from "./errors.js";
+const invalid = (message, fix) => new InferloError("IL5030", message, { fix });
+/** Inferlo's AI client as a LangChain chat model. Make one with toLangChainModel(ai, { model }). */
+export class InferloChatModel extends BaseChatModel {
+    ai;
+    options;
+    constructor(ai, options = {}) {
+        super({});
+        this.ai = ai;
+        this.options = options;
+    }
+    static lc_name() {
+        return "InferloChatModel";
+    }
+    _llmType() {
+        return "inferlo";
+    }
+    /** Offer tools to the model: LangChain tools, OpenAI-style tool definitions, or Inferlo function tools. */
+    bindTools(tools, kwargs) {
+        return this.withConfig({ ...kwargs, tools: tools });
+    }
+    async _generate(messages, options) {
+        const result = await callModel(this.ai, {
+            model: this.options.model,
+            messages: toMessages(messages),
+            tools: toolSpecs(options.tools),
+            temperature: this.options.temperature,
+            maxTokens: this.options.maxTokens,
+            for: this.options.for,
+            signal: options.signal,
+        });
+        const usage = { input_tokens: result.usage.inputTokens, output_tokens: result.usage.outputTokens, total_tokens: result.usage.inputTokens + result.usage.outputTokens };
+        const message = new AIMessage({
+            content: result.text,
+            tool_calls: result.toolCalls.map((call) => ({ id: call.id, name: call.name, args: toolArgs(call.input), type: "tool_call" })),
+            usage_metadata: usage,
+            response_metadata: { model: result.usage.model, requested: result.usage.requested, cost: result.usage.cost },
+        });
+        return { generations: [{ text: result.text, message }], llmOutput: { tokenUsage: { promptTokens: usage.input_tokens, completionTokens: usage.output_tokens, totalTokens: usage.total_tokens } } };
+    }
+    /** Streams text with ai.stream(). With tools bound, the answer (and its tool calls) comes as one chunk. */
+    async *_streamResponseChunks(messages, options, runManager) {
+        if (toolSpecs(options.tools)?.length) {
+            const { generations } = await this._generate(messages, options);
+            const message = generations[0].message;
+            yield new ChatGenerationChunk({
+                text: generations[0].text,
+                message: new AIMessageChunk({
+                    content: message.content,
+                    tool_call_chunks: (message.tool_calls ?? []).map((call, index) => ({ id: call.id, name: call.name, args: JSON.stringify(call.args), index, type: "tool_call_chunk" })),
+                    usage_metadata: message.usage_metadata,
+                    response_metadata: message.response_metadata,
+                }),
+            });
+            return;
+        }
+        const all = toMessages(messages);
+        const system = all.filter((m) => m.role === "system").map((m) => m.content).join("\n\n");
+        const stream = this.ai.stream({
+            model: this.options.model,
+            ...(system ? { system } : {}),
+            messages: all.filter((m) => m.role !== "system"),
+            temperature: this.options.temperature,
+            maxTokens: this.options.maxTokens,
+            for: this.options.for,
+            signal: options.signal,
+        });
+        for await (const text of stream) {
+            yield new ChatGenerationChunk({ text, message: new AIMessageChunk({ content: text }) });
+            await runManager?.handleLLMNewToken(text);
+        }
+        const usage = await stream.usage();
+        yield new ChatGenerationChunk({
+            text: "",
+            message: new AIMessageChunk({
+                content: "",
+                usage_metadata: { input_tokens: usage.inputTokens, output_tokens: usage.outputTokens, total_tokens: usage.inputTokens + usage.outputTokens },
+                response_metadata: { model: usage.model, requested: usage.requested, cost: usage.cost },
+            }),
+        });
+    }
+}
+/**
+ * A LangChain chat model that calls Inferlo's AI: toLangChainModel(ctx.ai, { model: "fast", for: user.id }).
+ * Use it anywhere LangChain takes a chat model (createAgent, chains, LangGraph).
+ */
+export function toLangChainModel(ai, options = {}) {
+    if (!ai || typeof ai !== "object" || typeof ai.generate !== "function") {
+        throw invalid("toLangChainModel(ai) needs Inferlo's AI client.", 'Pass ctx.ai in a route handler or job, app.ai, or the client createAI() returns: toLangChainModel(ctx.ai, { model: "fast" }).');
+    }
+    if (options === null || typeof options !== "object")
+        throw invalid("toLangChainModel() options must be an object.", 'Use toLangChainModel(ai, { model: "fast" }).');
+    for (const key of Object.keys(options)) {
+        if (!["model", "for", "temperature", "maxTokens"].includes(key))
+            throw invalid(`Unknown toLangChainModel() option "${key}".`, "Options: model, for, temperature, maxTokens.");
+    }
+    return new InferloChatModel(ai, { ...options });
+}
+/**
+ * Inferlo tools as LangChain tools. Function tools (tool(name, ...).handle(fn)) work anywhere; routes work with a
+ * request's AI client ({ ai: ctx.ai }) and run as the signed-in user, with the route's auth and validation.
+ */
+export function toLangChainTools(tools, options = {}) {
+    if (!Array.isArray(tools))
+        throw invalid("toLangChainTools() needs an array of tools.", "Pass [getWeather, createTicket]: function tools and routes.");
+    const routeTools = options.ai ? routeToolsOf(options.ai) : undefined;
+    const names = new Set();
+    return tools.map((entry) => {
+        let spec;
+        let run;
+        if (isTool(entry)) {
+            spec = functionToolSpec(entry);
+            run = async (input) => (await runFunctionTool(entry, input, undefined)).text;
+        }
+        else if (entry && typeof entry === "object" && "path" in entry && "method" in entry) {
+            if (!routeTools) {
+                throw new InferloError("IL5009", "Routes as LangChain tools need the AI client of a request.", {
+                    fix: "Call toLangChainTools([createTicket], { ai: ctx.ai }) in a route handler, so each route runs as the signed-in user with its auth and validation, or make a function tool with tool(name, { description, input }).handle(fn).",
+                });
+            }
+            const route = entry;
+            spec = routeTools.describe(route);
+            run = async (input) => (await routeTools.runner(route, input)).text;
+        }
+        else {
+            throw invalid("toLangChainTools() takes function tools made with tool(...).handle(fn) and routes.", "Pass [getWeather, createTicket].");
+        }
+        if (names.has(spec.name))
+            throw new InferloError("IL5013", `Two tools are named "${spec.name}".`, { fix: "Give each tool a unique name (a route's tool name is its export name, or tool: { name })." });
+        names.add(spec.name);
+        return new DynamicStructuredTool({ name: spec.name, description: spec.description, schema: spec.inputSchema, func: async (input) => run(input) });
+    });
+}
+/** Bound tools as Inferlo tool specs. */
+function toolSpecs(tools) {
+    if (!tools?.length)
+        return undefined;
+    return tools.map((tool) => {
+        if (isTool(tool))
+            return functionToolSpec(tool);
+        const converted = convertToOpenAITool(tool);
+        const fn = converted.function;
+        if (!fn?.name)
+            throw invalid("A tool bound to the Inferlo chat model has no name.", "Bind LangChain tools, { type: \"function\", function: { name, description, parameters } } objects, or Inferlo function tools.");
+        return { name: fn.name, description: fn.description ?? "", inputSchema: fn.parameters ?? { type: "object", properties: {} } };
+    });
+}
+function toolArgs(input) {
+    return input && typeof input === "object" && !Array.isArray(input) ? input : { input };
+}
+function typeOf(message) {
+    const m = message;
+    return typeof m.getType === "function" ? m.getType() : typeof m._getType === "function" ? m._getType() : String(m.type);
+}
+/** LangChain messages as Inferlo messages. */
+function toMessages(messages) {
+    return messages.map((message) => {
+        const type = typeOf(message);
+        const { text, images } = contentOf(message.content);
+        if (type === "system")
+            return { role: "system", content: text };
+        if (type === "human" || type === "generic")
+            return { role: "user", content: text, ...(images.length ? { images } : {}) };
+        if (type === "ai") {
+            const calls = message.tool_calls ?? [];
+            return { role: "assistant", content: text, ...(calls.length ? { toolCalls: calls.map((c) => ({ id: c.id ?? "", name: c.name, input: c.args })) } : {}) };
+        }
+        if (type === "tool") {
+            const tool = message;
+            return { role: "tool", content: text, toolCallId: tool.tool_call_id, ...(tool.status === "error" ? { isError: true } : {}) };
+        }
+        throw invalid(`The Inferlo chat model does not take "${type}" messages.`, "Use system, human, AI and tool messages.");
+    });
+}
+function contentOf(content) {
+    if (typeof content === "string")
+        return { text: content, images: [] };
+    const images = [];
+    let text = "";
+    for (const part of Array.isArray(content) ? content : []) {
+        if (!part || typeof part !== "object")
+            continue;
+        const p = part;
+        if (p.type === "text" && typeof p.text === "string")
+            text += p.text;
+        else if (p.type === "image_url") {
+            const url = typeof p.image_url === "string" ? p.image_url : p.image_url?.url;
+            if (url)
+                images.push({ url });
+        }
+        else if (p.type === "image") {
+            const mediaType = p.mimeType ?? p.mime_type;
+            if (typeof p.url === "string")
+                images.push({ url: p.url });
+            else if (typeof p.data === "string" && mediaType)
+                images.push({ base64: p.data, mediaType: mediaType });
+        }
+    }
+    return { text, images };
+}
+//# sourceMappingURL=langchain.js.map

package/dist/langchain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"langchain.js","sourceRoot":"","sources":["../src/langchain.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,OAAO,EAAE,aAAa,EAAsD,MAAM,6CAA6C,CAAC;AAChI,OAAO,EAAE,SAAS,EAAE,cAAc,EAAoB,MAAM,0BAA0B,CAAC;AACvF,OAAO,EAAE,mBAAmB,EAAmB,MAAM,yBAAyB,CAAC;AAC/E,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAC7E,OAAO,EAAE,SAAS,EAAE,YAAY,EAAW,MAAM,eAAe,CAAC;AAEjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,eAAe,EAAgB,MAAM,cAAc,CAAC;AACvF,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAiB3C,MAAM,OAAO,GAAG,CAAC,OAAe,EAAE,GAAW,EAAE,EAAE,CAAC,IAAI,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;AAE/F,oGAAoG;AACpG,MAAM,OAAO,gBAAiB,SAAQ,aAA0D;IACrF,EAAE,CAAK;IACP,OAAO,CAAwB;IAExC,YAAY,EAAM,EAAE,UAAiC,EAAE;QACrD,KAAK,CAAC,EAAE,CAAC,CAAC;QACV,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,MAAM,CAAC,OAAO;QACZ,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED,QAAQ;QACN,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,2GAA2G;IAClG,SAAS,CAAC,KAAmC,EAAE,MAA6C;QACnG,OAAO,IAAI,CAAC,UAAU,CAAC,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,KAAyB,EAA0C,CAAC,CAAC;IAClH,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,QAAuB,EAAE,OAAkC;QACzE,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE;YACtC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK;YACzB,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;YAC9B,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC;YAC/B,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW;YACrC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;YACjC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG;YACrB,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,EAAE,YAAY,EAAE,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,KAAK,CAAC,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;QACvK,MAAM,OAAO,GAAG,IAAI,SAAS,CAAC;YAC5B,OAAO,EAAE,MAAM,CAAC,IAAI;YACpB,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,WAAoB,EAAE,CAAC,CAAC;YACtI,cAAc,EAAE,KAAK;YACrB,iBAAiB,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE;SAC7G,CAAC,CAAC;QACH,OAAO,EAAE,WAAW,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,UAAU,EAAE,EAAE,YAAY,EAAE,KAAK,CAAC,YAAY,EAAE,gBAAgB,EAAE,KAAK,CAAC,aAAa,EAAE,WAAW,EAAE,KAAK,CAAC,YAAY,EAAE,EAAE,EAAE,CAAC;IACpM,CAAC;IAED,2GAA2G;IAClG,KAAK,CAAC,CAAC,qBAAqB,CAAC,QAAuB,EAAE,OAAkC,EAAE,UAAmE;QACpK,IAAI,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;YACrC,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAChE,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAE,CAAC,OAAoB,CAAC;YACrD,MAAM,IAAI,mBAAmB,CAAC;gBAC5B,IAAI,EAAE,WAAW,CAAC,CAAC,CAAE,CAAC,IAAI;gBAC1B,OAAO,EAAE,IAAI,cAAc,CAAC;oBAC1B,OAAO,EAAE,OAAO,CAAC,OAAO;oBACxB,gBAAgB,EAAE,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,iBAA0B,EAAE,CAAC,CAAC;oBAC/K,cAAc,EAAE,OAAO,CAAC,cAAc;oBACtC,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;iBAC7C,CAAC;aACH,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QACD,MAAM,GAAG,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzF,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC;YAC5B,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK;YACzB,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7B,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC;YAChD,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW;YACrC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;YACjC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG;YACrB,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;QACH,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAChC,MAAM,IAAI,mBAAmB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,cAAc,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;YACxF,MAAM,UAAU,EAAE,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QACnC,MAAM,IAAI,mBAAmB,CAAC;YAC5B,IAAI,EAAE,EAAE;YACR,OAAO,EAAE,IAAI,cAAc,CAAC;gBAC1B,OAAO,EAAE,EAAE;gBACX,cAAc,EAAE,EAAE,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE,aAAa,EAAE,KAAK,CAAC,YAAY,EAAE,YAAY,EAAE,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC,YAAY,EAAE;gBAC5I,iBAAiB,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE;aACxF,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,EAAM,EAAE,UAAiC,EAAE;IAC1E,IAAI,CAAC,EAAE,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,OAAQ,EAAS,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;QAC/E,MAAM,OAAO,CAAC,iDAAiD,EAAE,+HAA+H,CAAC,CAAC;IACpM,CAAC;IACD,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ;QAAE,MAAM,OAAO,CAAC,+CAA+C,EAAE,8CAA8C,CAAC,CAAC;IACpK,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,MAAM,OAAO,CAAC,sCAAsC,GAAG,IAAI,EAAE,8CAA8C,CAAC,CAAC;IAChL,CAAC;IACD,OAAO,IAAI,gBAAgB,CAAC,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAsC,EAAE,UAAuB,EAAE;IAChG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,MAAM,OAAO,CAAC,6CAA6C,EAAE,6DAA6D,CAAC,CAAC;IACvJ,MAAM,UAAU,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACrE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACzB,IAAI,IAAc,CAAC;QACnB,IAAI,GAAwC,CAAC;QAC7C,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YAClB,IAAI,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;YAC/B,GAAG,GAAG,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,eAAe,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;QAC/E,CAAC;aAAM,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,IAAI,KAAK,IAAI,QAAQ,IAAI,KAAK,EAAE,CAAC;YACtF,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,4DAA4D,EAAE;oBAC7F,GAAG,EAAE,8NAA8N;iBACpO,CAAC,CAAC;YACL,CAAC;YACD,MAAM,KAAK,GAAG,KAAiB,CAAC;YAChC,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAClC,GAAG,GAAG,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QACtE,CAAC;aAAM,CAAC;YACN,MAAM,OAAO,CAAC,oFAAoF,EAAE,kCAAkC,CAAC,CAAC;QAC1I,CAAC;QACD,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,wBAAwB,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,GAAG,EAAE,2FAA2F,EAAE,CAAC,CAAC;QACxM,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrB,OAAO,IAAI,qBAAqB,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC,WAAoB,EAAE,IAAI,EAAE,KAAK,EAAE,KAAc,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACtK,CAAC,CAAC,CAAC;AACL,CAAC;AAED,yCAAyC;AACzC,SAAS,SAAS,CAAC,KAAqC;IACtD,IAAI,CAAC,KAAK,EAAE,MAAM;QAAE,OAAO,SAAS,CAAC;IACrC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACxB,IAAI,MAAM,CAAC,IAAI,CAAC;YAAE,OAAO,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,SAAS,GAAG,mBAAmB,CAAC,IAAa,CAAiG,CAAC;QACrJ,MAAM,EAAE,GAAG,SAAS,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,EAAE,EAAE,IAAI;YAAE,MAAM,OAAO,CAAC,qDAAqD,EAAE,+HAA+H,CAAC,CAAC;QACrN,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE,EAAE,CAAC,WAAW,IAAI,EAAE,EAAE,WAAW,EAAE,EAAE,CAAC,UAAU,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,EAAE,EAAE,CAAC;IAChI,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,KAA6B,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;AAClH,CAAC;AAED,SAAS,MAAM,CAAC,OAAoB;IAClC,MAAM,CAAC,GAAG,OAAwF,CAAC;IACnG,OAAO,OAAO,CAAC,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAC1H,CAAC;AAED,8CAA8C;AAC9C,SAAS,UAAU,CAAC,QAAuB;IACzC,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QAC9B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAC7B,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACpD,IAAI,IAAI,KAAK,QAAQ;YAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QAChE,IAAI,IAAI,KAAK,OAAO,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;QACzH,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAClB,MAAM,KAAK,GAAI,OAAqB,CAAC,UAAU,IAAI,EAAE,CAAC;YACtD,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;QAC3J,CAAC;QACD,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;YACpB,MAAM,IAAI,GAAG,OAA+D,CAAC;YAC7E,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,YAAY,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;QAC/H,CAAC;QACD,MAAM,OAAO,CAAC,yCAAyC,IAAI,aAAa,EAAE,0CAA0C,CAAC,CAAC;IACxH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,SAAS,CAAC,OAAgB;IACjC,IAAI,OAAO,OAAO,KAAK,QAAQ;QAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IACtE,MAAM,MAAM,GAAY,EAAE,CAAC;IAC3B,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACzD,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,SAAS;QAChD,MAAM,CAAC,GAAG,IAAyK,CAAC;QACpL,IAAI,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ;YAAE,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC;aAC/D,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YAChC,MAAM,GAAG,GAAG,OAAO,CAAC,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC;YAC7E,IAAI,GAAG;gBAAE,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;QAChC,CAAC;aAAM,IAAI,CAAC,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC9B,MAAM,SAAS,GAAG,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,SAAS,CAAC;YAC5C,IAAI,OAAO,CAAC,CAAC,GAAG,KAAK,QAAQ;gBAAE,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;iBACtD,IAAI,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ,IAAI,SAAS;gBAAE,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,SAAkB,EAAE,CAAC,CAAC;QACnH,CAAC;IACH,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAC1B,CAAC"}

package/dist/model.d.ts

@@ -4,27 +4,43 @@ export type SystemShape = {
     createdAt: Schema<Date, Date | string>;
     updatedAt: Schema<Date, Date | string>;
 };
-export declare class Model<N extends string = string, S extends Shape = Shape> {
+/** Options of model(). */
+export interface ModelOptions {
+    /**
+     * true: the table belongs to tenants (organisations, workspaces, customers). Every row gets a
+     * tenantId column, and ctx.db filters every query by and stamps every insert with the current
+     * tenant (auth.tenant(user), default user.tenantId). Unique fields are unique per tenant.
+     */
+    tenant?: boolean;
+}
+/** Longest tenant id Inferlo accepts. */
+export declare const MAX_TENANT_ID = 200;
+export type TenantShape = {
+    tenantId: Schema<string>;
+};
+export declare class Model<N extends string = string, S extends Shape = Shape, T extends boolean = false> {
     /** Table name, also the property name on `db` (db.tickets). */
     readonly name: N;
     /** Fields you defined. */
     readonly fields: S;
-    /** Full row schema including id, createdAt and updatedAt. */
-    readonly row: ObjectSchema<SystemShape & S>;
+    /** Full row schema including id, createdAt and updatedAt (and tenantId on tenant-scoped models). */
+    readonly row: ObjectSchema<SystemShape & S & (T extends true ? TenantShape : {})>;
+    /** True when the model is tenant-scoped (model(name, fields, { tenant: true })). */
+    readonly tenant: T;
     /** Input schema for inserts. Fields with defaults or .optional() may be left out. */
     readonly create: ObjectSchema<S>;
     /** Input schema for updates. Every field optional. */
     readonly update: ObjectSchema<PartialShape<S>>;
     /** Type-only: the row type. Prefer Row<typeof Model>. */
-    readonly $row: ShapeOutput<SystemShape & S>;
+    readonly $row: ShapeOutput<SystemShape & S & (T extends true ? TenantShape : {})>;
     readonly $create: ShapeInput<S>;
-    constructor(name: N, fields: S);
+    constructor(name: N, fields: S, options?: ModelOptions);
     /** Input schema with only some fields, e.g. for a route body: Ticket.pick("title", "body"). */
     pick<K extends keyof S & string>(...keys: K[]): ObjectSchema<Pick<S, K>>;
     /** Input schema without some fields, e.g. Ticket.omit("ownerId"). */
     omit<K extends keyof S & string>(...keys: K[]): ObjectSchema<Omit<S, K>>;
 }
-export type AnyModel = Model<string, any>;
+export type AnyModel = Model<string, any, boolean>;
 /** Row type of a model: Row<typeof Ticket>. */
 export type Row<M extends AnyModel> = M["$row"];
 /** Insert input type of a model. */
@@ -32,5 +48,6 @@ export type CreateInput<M extends AnyModel> = M["$create"];
 /** Update input type of a model. */
 export type UpdateInput<M extends AnyModel> = Partial<M["$create"]>;
 export declare function model<const N extends string, S extends Shape>(name: N, fields: S): Model<N, S>;
+export declare function model<const N extends string, S extends Shape, const O extends ModelOptions>(name: N, fields: S, options: O): Model<N, S, O["tenant"] extends true ? true : false>;
 /** camelCase field name to snake_case column name. */
 export declare function columnName(field: string): string;

package/dist/model.js

@@ -8,6 +8,10 @@
  *   })
  *
  * Every model gets id (uuid), createdAt and updatedAt automatically.
+ *
+ * Tenant-scoped models (multi-tenant apps) also get tenantId, set from the signed-in user:
+ *
+ *   export const Ticket = model("tickets", { title: t.string() }, { tenant: true })
  */
 import { InferloError } from "./errors.js";
 import { ObjectSchema, Schema, t } from "./schema.js";
@@ -17,24 +21,45 @@ const RESERVED = new Set(["id", "createdAt", "updatedAt"]);
 function system(schema, kind) {
     return new Schema({ ...schema.def, system: kind });
 }
+/** Longest tenant id Inferlo accepts. */
+export const MAX_TENANT_ID = 200;
 export class Model {
     /** Table name, also the property name on `db` (db.tickets). */
     name;
     /** Fields you defined. */
     fields;
-    /** Full row schema including id, createdAt and updatedAt. */
+    /** Full row schema including id, createdAt and updatedAt (and tenantId on tenant-scoped models). */
     row;
+    /** True when the model is tenant-scoped (model(name, fields, { tenant: true })). */
+    tenant;
     /** Input schema for inserts. Fields with defaults or .optional() may be left out. */
     create;
     /** Input schema for updates. Every field optional. */
     update;
-    constructor(name, fields) {
+    constructor(name, fields, options = {}) {
         if (!TABLE_NAME.test(name)) {
             throw new InferloError("IL4005", `Model name "${name}" is not a valid table name.`, {
                 fix: 'Use lowercase letters, digits and underscores, starting with a letter, e.g. model("support_tickets", {...}).',
             });
         }
+        if (options === null || typeof options !== "object" || Array.isArray(options)) {
+            throw new InferloError("IL4026", `The options of model "${name}" must be an object.`, { fix: `Pass model("${name}", { ...fields }, { tenant: true }), or leave the options out.` });
+        }
+        for (const key of Object.keys(options)) {
+            if (key !== "tenant") {
+                throw new InferloError("IL4026", `Unknown option "${key}" in model "${name}".`, { fix: "model() takes one option: { tenant: true }." });
+            }
+        }
+        if (options.tenant !== undefined && typeof options.tenant !== "boolean") {
+            throw new InferloError("IL4026", `The tenant option of model "${name}" must be true or false.`, { fix: `Use model("${name}", { ...fields }, { tenant: true }).` });
+        }
+        const tenant = options.tenant === true;
         for (const key of Object.keys(fields)) {
+            if (tenant && key === "tenantId") {
+                throw new InferloError("IL4006", `Model "${name}" defines "tenantId", which Inferlo adds to tenant-scoped models.`, {
+                    fix: 'Remove "tenantId" from the model. With { tenant: true } every row already has tenantId, set from the current tenant.',
+                });
+            }
             if (RESERVED.has(key)) {
                 throw new InferloError("IL4006", `Model "${name}" defines "${key}", which Inferlo adds automatically.`, {
                     fix: `Remove "${key}" from the model. Every model already has id, createdAt and updatedAt.`,
@@ -47,15 +72,19 @@ export class Model {
             }
         }
         this.name = name;
-        this.fields = fields;
+        this.tenant = tenant;
         this.create = t.object(fields);
         this.update = this.create.partial();
+        // tenantId is a column like the others for the adapters, migrations and describe(), but never input.
+        this.fields = (tenant
+            ? { ...fields, tenantId: system(t.string().min(1).max(MAX_TENANT_ID).index().describe("Set automatically from the current tenant"), "tenantId") }
+            : fields);
         const systemShape = {
             id: system(t.uuid(), "id"),
             createdAt: system(t.date(), "createdAt"),
             updatedAt: system(t.date(), "updatedAt"),
         };
-        this.row = t.object({ ...systemShape, ...fields });
+        this.row = t.object({ ...systemShape, ...this.fields });
     }
     /** Input schema with only some fields, e.g. for a route body: Ticket.pick("title", "body"). */
     pick(...keys) {
@@ -66,8 +95,8 @@ export class Model {
         return this.create.omit(...keys);
     }
 }
-export function model(name, fields) {
-    return new Model(name, fields);
+export function model(name, fields, options) {
+    return new Model(name, fields, options);
 }
 /** camelCase field name to snake_case column name. */
 export function columnName(field) {

package/dist/model.js.map

@@ -1 +1 @@
-{"version":3,"file":"model.js","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,EAA8E,MAAM,aAAa,CAAC;AAElI,MAAM,UAAU,GAAG,wBAAwB,CAAC;AAC5C,MAAM,UAAU,GAAG,6BAA6B,CAAC;AACjD,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;AAE3D,SAAS,MAAM,CAAC,MAAwB,EAAE,IAAmB;IAC3D,OAAO,IAAI,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;AACrD,CAAC;AAQD,MAAM,OAAO,KAAK;IAChB,+DAA+D;IACtD,IAAI,CAAI;IACjB,0BAA0B;IACjB,MAAM,CAAI;IACnB,6DAA6D;IACpD,GAAG,CAAgC;IAC5C,qFAAqF;IAC5E,MAAM,CAAkB;IACjC,sDAAsD;IAC7C,MAAM,CAAgC;IAM/C,YAAY,IAAO,EAAE,MAAS;QAC5B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,eAAe,IAAI,8BAA8B,EAAE;gBAClF,GAAG,EAAE,8GAA8G;aACpH,CAAC,CAAC;QACL,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACtC,IAAI,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACtB,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,UAAU,IAAI,cAAc,GAAG,sCAAsC,EAAE;oBACtG,GAAG,EAAE,WAAW,GAAG,wEAAwE;iBAC5F,CAAC,CAAC;YACL,CAAC;YACD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,UAAU,IAAI,IAAI,GAAG,8BAA8B,EAAE;oBACpF,GAAG,EAAE,gFAAgF;iBACtF,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpC,MAAM,WAAW,GAAgB;YAC/B,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC;YAC1B,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,WAAW,CAAC;YACxC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,WAAW,CAAC;SACzC,CAAC;QACF,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,EAAqB,CAAC,CAAC;IACxE,CAAC;IAED,+FAA+F;IAC/F,IAAI,CAA6B,GAAG,IAAS;QAC3C,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;IACnC,CAAC;IAED,qEAAqE;IACrE,IAAI,CAA6B,GAAG,IAAS;QAC3C,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;IACnC,CAAC;CACF;AAWD,MAAM,UAAU,KAAK,CAA0C,IAAO,EAAE,MAAS;IAC/E,OAAO,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACjC,CAAC;AAED,sDAAsD;AACtD,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,OAAO,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AAC/D,CAAC"}
+{"version":3,"file":"model.js","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,EAA8E,MAAM,aAAa,CAAC;AAElI,MAAM,UAAU,GAAG,wBAAwB,CAAC;AAC5C,MAAM,UAAU,GAAG,6BAA6B,CAAC;AACjD,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;AAE3D,SAAS,MAAM,CAAC,MAAwB,EAAE,IAAmB;IAC3D,OAAO,IAAI,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;AACrD,CAAC;AAkBD,yCAAyC;AACzC,MAAM,CAAC,MAAM,aAAa,GAAG,GAAG,CAAC;AAIjC,MAAM,OAAO,KAAK;IAChB,+DAA+D;IACtD,IAAI,CAAI;IACjB,0BAA0B;IACjB,MAAM,CAAI;IACnB,oGAAoG;IAC3F,GAAG,CAAsE;IAClF,oFAAoF;IAC3E,MAAM,CAAI;IACnB,qFAAqF;IAC5E,MAAM,CAAkB;IACjC,sDAAsD;IAC7C,MAAM,CAAgC;IAM/C,YAAY,IAAO,EAAE,MAAS,EAAE,UAAwB,EAAE;QACxD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,eAAe,IAAI,8BAA8B,EAAE;gBAClF,GAAG,EAAE,8GAA8G;aACpH,CAAC,CAAC;QACL,CAAC;QACD,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC9E,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,yBAAyB,IAAI,sBAAsB,EAAE,EAAE,GAAG,EAAE,eAAe,IAAI,gEAAgE,EAAE,CAAC,CAAC;QACtL,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACvC,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;gBACrB,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,mBAAmB,GAAG,eAAe,IAAI,IAAI,EAAE,EAAE,GAAG,EAAE,6CAA6C,EAAE,CAAC,CAAC;YAC1I,CAAC;QACH,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACxE,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,+BAA+B,IAAI,0BAA0B,EAAE,EAAE,GAAG,EAAE,cAAc,IAAI,sCAAsC,EAAE,CAAC,CAAC;QACrK,CAAC;QACD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC;QACvC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACtC,IAAI,MAAM,IAAI,GAAG,KAAK,UAAU,EAAE,CAAC;gBACjC,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,UAAU,IAAI,mEAAmE,EAAE;oBAClH,GAAG,EAAE,sHAAsH;iBAC5H,CAAC,CAAC;YACL,CAAC;YACD,IAAI,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACtB,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,UAAU,IAAI,cAAc,GAAG,sCAAsC,EAAE;oBACtG,GAAG,EAAE,WAAW,GAAG,wEAAwE;iBAC5F,CAAC,CAAC;YACL,CAAC;YACD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,UAAU,IAAI,IAAI,GAAG,8BAA8B,EAAE;oBACpF,GAAG,EAAE,gFAAgF;iBACtF,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAW,CAAC;QAC1B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpC,qGAAqG;QACrG,IAAI,CAAC,MAAM,GAAG,CAAC,MAAM;YACnB,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,2CAA2C,CAAC,EAAE,UAAU,CAAC,EAAE;YACjJ,CAAC,CAAC,MAAM,CAAM,CAAC;QACjB,MAAM,WAAW,GAAgB;YAC/B,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC;YAC1B,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,WAAW,CAAC;YACxC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,WAAW,CAAC;SACzC,CAAC;QACF,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,WAAW,EAAE,GAAG,IAAI,CAAC,MAAM,EAAqB,CAAU,CAAC;IACtF,CAAC;IAED,+FAA+F;IAC/F,IAAI,CAA6B,GAAG,IAAS;QAC3C,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;IACnC,CAAC;IAED,qEAAqE;IACrE,IAAI,CAA6B,GAAG,IAAS;QAC3C,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;IACnC,CAAC;CACF;AAaD,MAAM,UAAU,KAAK,CAAC,IAAY,EAAE,MAAa,EAAE,OAAsB;IACvE,OAAO,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAa,CAAC;AACtD,CAAC;AAED,sDAAsD;AACtD,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,OAAO,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AAC/D,CAAC"}

package/dist/rate-limit.d.ts

@@ -11,16 +11,18 @@ export interface RateLimit {
     per: "second" | "minute" | "hour" | "day";
     /**
      * Who is counted. "user": each signed-in user (requests without a user count by IP).
-     * "ip": each client IP address. Default "user".
+     * "tenant": each tenant (organisation) in multi-tenant apps, shared by all its users (users without a tenant
+     * count one by one, requests without a user by IP). "ip": each client IP address. Default "user".
      */
-    by?: "user" | "ip";
+    by?: "user" | "tenant" | "ip";
 }
 export interface RateLimitConfig {
     /**
      * Where counts are kept. "memory" (default): in this process, for one instance and tests.
      * "database": in the inferlo_rate_limits table of the app's Postgres database, shared by every instance.
+     * "redis": in the Redis of createApp({ redis }), shared by every instance.
      */
-    store?: "memory" | "database";
+    store?: "memory" | "database" | "redis";
 }
 /** Counts hits per key in fixed windows. */
 export interface RateLimitStore {

package/dist/rate-limit.js

@@ -14,12 +14,12 @@ export function checkRateLimit(limit, where) {
             problems.push("max must be a whole number of at least 1");
         if (!Object.hasOwn(WINDOWS, l.per))
             problems.push(`per must be one of ${Object.keys(WINDOWS).map((k) => `"${k}"`).join(", ")}`);
-        if (l.by !== undefined && l.by !== "user" && l.by !== "ip")
-            problems.push('by must be "user" or "ip"');
+        if (l.by !== undefined && l.by !== "user" && l.by !== "tenant" && l.by !== "ip")
+            problems.push('by must be "user", "tenant" or "ip"');
     }
     if (problems.length) {
         throw new InferloError("IL6007", `Invalid rateLimit on ${where}: ${problems.join(", ")}.`, {
-            fix: 'Use rateLimit: { max: 10, per: "minute", by: "user" } (per: "second" | "minute" | "hour" | "day", by: "user" | "ip").',
+            fix: 'Use rateLimit: { max: 10, per: "minute", by: "user" } (per: "second" | "minute" | "hour" | "day", by: "user" | "tenant" | "ip").',
         });
     }
 }

package/dist/rate-limit.js.map

@@ -1 +1 @@
-{"version":3,"file":"rate-limit.js","sourceRoot":"","sources":["../src/rate-limit.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AA2B3C,MAAM,OAAO,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,UAAU,EAAW,CAAC;AAE5F,MAAM,UAAU,QAAQ,CAAC,KAAgB;IACvC,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC5B,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,cAAc,CAAC,KAAc,EAAE,KAAa;IAC1D,MAAM,CAAC,GAAG,KAAkB,CAAC;IAC7B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI;QAAE,QAAQ,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;SAC1E,CAAC;QACJ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;YAAE,QAAQ,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;QACrG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,GAAa,CAAC;YAAE,QAAQ,CAAC,IAAI,CAAC,sBAAsB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1I,IAAI,CAAC,CAAC,EAAE,KAAK,SAAS,IAAI,CAAC,CAAC,EAAE,KAAK,MAAM,IAAI,CAAC,CAAC,EAAE,KAAK,IAAI;YAAE,QAAQ,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;IACzG,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpB,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,wBAAwB,KAAK,KAAK,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACzF,GAAG,EAAE,uHAAuH;SAC7H,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,MAAoB,IAAI,CAAC,GAAG;IAC/D,MAAM,MAAM,GAAG,IAAI,GAAG,EAA8C,CAAC;IACrE,OAAO;QACL,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE;YACf,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC;YACnB,IAAI,MAAM,CAAC,IAAI,GAAG,MAAM;gBAAE,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM;oBAAE,IAAI,CAAC,CAAC,OAAO,IAAI,IAAI;wBAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC/F,IAAI,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC5B,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC;gBACpC,KAAK,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;gBACzC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACzB,CAAC;YACD,KAAK,CAAC,KAAK,EAAE,CAAC;YACd,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC;QAC/D,CAAC;KACF,CAAC;AACJ,CAAC;AAED,2GAA2G;AAC3G,MAAM,UAAU,sBAAsB,CAAC,OAAgB;IACrD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACvC,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,8EAA8E,OAAO,CAAC,OAAO,WAAW,EAAE;YACzI,GAAG,EAAE,kHAAkH;SACxH,CAAC,CAAC;IACL,CAAC;IACD,IAAI,KAAmC,CAAC;IACxC,MAAM,MAAM,GAAG,GAAG,EAAE,CAClB,GAAG,CAAC,sIAAsI,CAAC,CAAC,KAAK;IAC/I,0EAA0E;IAC1E,GAAG,EAAE,CAAC,GAAG,CAAC,6CAA6C,CAAC,CACzD,CAAC;IACJ,OAAO;QACL,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE;YACf,KAAK,KAAK,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACjC,KAAK,GAAG,SAAS,CAAC;gBAClB,MAAM,KAAK,CAAC;YACd,CAAC,CAAC,CAAC;YACH,MAAM,KAAK,CAAC;YACZ,MAAM,IAAI,GAAG,MAAM,GAAG,CACpB;;;;wGAIgG,EAChG,CAAC,GAAG,EAAE,EAAE,CAAC,CACV,CAAC;YACF,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAsF,CAAC;YACzG,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACtG,CAAC;KACF,CAAC;AACJ,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,eAAe,CAAC,KAAgB,EAAE,GAAuC;IACvF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC;IACzD,MAAM,OAAO,GAA2B;QACtC,iBAAiB,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;QACpC,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;QACjE,iBAAiB,EAAE,MAAM,CAAC,KAAK,CAAC;KACjC,CAAC;IACF,IAAI,GAAG,CAAC,KAAK,IAAI,KAAK,CAAC,GAAG;QAAE,OAAO,EAAE,OAAO,EAAE,CAAC;IAC/C,OAAO,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IACvC,OAAO;QACL,OAAO;QACP,KAAK,EAAE,IAAI,YAAY,CAAC,QAAQ,EAAE,mCAAmC,KAAK,UAAU,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE;YAC7G,MAAM,EAAE,GAAG;YACX,GAAG,EAAE,qBAAqB,KAAK,CAAC,GAAG,WAAW,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,QAAQ,KAAK,CAAC,GAAG,8DAA8D;SACxJ,CAAC;KACH,CAAC;AACJ,CAAC"}
+{"version":3,"file":"rate-limit.js","sourceRoot":"","sources":["../src/rate-limit.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AA6B3C,MAAM,OAAO,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,UAAU,EAAW,CAAC;AAE5F,MAAM,UAAU,QAAQ,CAAC,KAAgB;IACvC,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC5B,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,cAAc,CAAC,KAAc,EAAE,KAAa;IAC1D,MAAM,CAAC,GAAG,KAAkB,CAAC;IAC7B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI;QAAE,QAAQ,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;SAC1E,CAAC;QACJ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;YAAE,QAAQ,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;QACrG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,GAAa,CAAC;YAAE,QAAQ,CAAC,IAAI,CAAC,sBAAsB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1I,IAAI,CAAC,CAAC,EAAE,KAAK,SAAS,IAAI,CAAC,CAAC,EAAE,KAAK,MAAM,IAAI,CAAC,CAAC,EAAE,KAAK,QAAQ,IAAI,CAAC,CAAC,EAAE,KAAK,IAAI;YAAE,QAAQ,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;IACxI,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpB,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,wBAAwB,KAAK,KAAK,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACzF,GAAG,EAAE,kIAAkI;SACxI,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,MAAoB,IAAI,CAAC,GAAG;IAC/D,MAAM,MAAM,GAAG,IAAI,GAAG,EAA8C,CAAC;IACrE,OAAO;QACL,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE;YACf,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC;YACnB,IAAI,MAAM,CAAC,IAAI,GAAG,MAAM;gBAAE,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM;oBAAE,IAAI,CAAC,CAAC,OAAO,IAAI,IAAI;wBAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC/F,IAAI,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC5B,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC;gBACpC,KAAK,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;gBACzC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACzB,CAAC;YACD,KAAK,CAAC,KAAK,EAAE,CAAC;YACd,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC;QAC/D,CAAC;KACF,CAAC;AACJ,CAAC;AAED,2GAA2G;AAC3G,MAAM,UAAU,sBAAsB,CAAC,OAAgB;IACrD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACvC,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,8EAA8E,OAAO,CAAC,OAAO,WAAW,EAAE;YACzI,GAAG,EAAE,kHAAkH;SACxH,CAAC,CAAC;IACL,CAAC;IACD,IAAI,KAAmC,CAAC;IACxC,MAAM,MAAM,GAAG,GAAG,EAAE,CAClB,GAAG,CAAC,sIAAsI,CAAC,CAAC,KAAK;IAC/I,0EAA0E;IAC1E,GAAG,EAAE,CAAC,GAAG,CAAC,6CAA6C,CAAC,CACzD,CAAC;IACJ,OAAO;QACL,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE;YACf,KAAK,KAAK,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACjC,KAAK,GAAG,SAAS,CAAC;gBAClB,MAAM,KAAK,CAAC;YACd,CAAC,CAAC,CAAC;YACH,MAAM,KAAK,CAAC;YACZ,MAAM,IAAI,GAAG,MAAM,GAAG,CACpB;;;;wGAIgG,EAChG,CAAC,GAAG,EAAE,EAAE,CAAC,CACV,CAAC;YACF,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAsF,CAAC;YACzG,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACtG,CAAC;KACF,CAAC;AACJ,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,eAAe,CAAC,KAAgB,EAAE,GAAuC;IACvF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC;IACzD,MAAM,OAAO,GAA2B;QACtC,iBAAiB,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;QACpC,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;QACjE,iBAAiB,EAAE,MAAM,CAAC,KAAK,CAAC;KACjC,CAAC;IACF,IAAI,GAAG,CAAC,KAAK,IAAI,KAAK,CAAC,GAAG;QAAE,OAAO,EAAE,OAAO,EAAE,CAAC;IAC/C,OAAO,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IACvC,OAAO;QACL,OAAO;QACP,KAAK,EAAE,IAAI,YAAY,CAAC,QAAQ,EAAE,mCAAmC,KAAK,UAAU,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE;YAC7G,MAAM,EAAE,GAAG;YACX,GAAG,EAAE,qBAAqB,KAAK,CAAC,GAAG,WAAW,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,QAAQ,KAAK,CAAC,GAAG,8DAA8D;SACxJ,CAAC;KACH,CAAC;AACJ,CAAC"}

package/dist/redis-events.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Events between services over Redis Streams: createApp({ name: "billing", redis, events: { transport: "redis" } }).
+ *
+ * Keys (shared by every app on the Redis, so services find each other's events):
+ *   inferlo:events:<event name>   a stream with one entry per published event (fields id, payload, publishedAt,
+ *                                 and traceparent and tracestate with tracing), trimmed to about maxLength entries
+ *
+ * Each app reads with a consumer group named after the app (createApp({ name })), so every service subscribed to
+ * an event gets each event once, and its instances share the work. An entry is acknowledged (XACK) after its jobs
+ * are queued; an entry a crashed instance read but did not acknowledge is claimed again (XAUTOCLAIM) after
+ * staleAfterMs. Delivery is at least once; the jobs it queues have ids derived from the event id, so a repeated
+ * delivery queues nothing new.
+ */
+import type { EventTransport } from "./events.ts";
+import type { RedisClient } from "./redis.ts";
+export declare const EVENT_STREAM_PREFIX = "inferlo:events:";
+export interface RedisEventTransportOptions {
+    /** The consumer group: the app name. */
+    group: string;
+    /** Entries kept per event stream (approximately, trimmed by Redis as events are added). Default 100,000. */
+    maxLength?: number;
+    /** An entry read but not acknowledged for this long (its instance stopped) is delivered again. Default 30 seconds. */
+    staleAfterMs?: number;
+    /** Entries read per stream and call. Default 100. */
+    batch?: number;
+}
+export declare function redisEventTransport(client: RedisClient, options: RedisEventTransportOptions): EventTransport;