@browserlessapi/inferlo 0.5.0 → 0.6.0

package/dist/fastify.d.ts

@@ -8,6 +8,7 @@
  *   const fastify = Fastify();
  *   await fastify.register(inferloPlugin, { ai });                         // fastify.ai and request.ai
  *   await fastify.register(inferloPlugin, { app: inferloApp, prefix: "/api" }); // or a whole Inferlo app under /api
+ *   await fastify.register(inferloPlugin, { app: inferloApp, fallthrough: true }); // or only the app's routes, at their own URLs
  *
  * Importing this entry point adds `ai` to Fastify's instance and request types. It never loads the router,
  * database or jobs code.
@@ -32,13 +33,20 @@ export interface InferloPluginOptions {
         fetch(req: Request, ...rest: unknown[]): Promise<Response>;
         ai?: AI;
     };
-    /** Path the app is served under, for example "/api". Required with app. */
+    /** Path the app is served under, for example "/api". Required with app, unless fallthrough is true. */
     prefix?: string;
+    /**
+     * Answer only the requests the app has a route for (method and path) and its own endpoints (OpenAPI, MCP,
+     * health, metrics, CORS preflights), and leave every other request to Fastify's routes and 404 handler.
+     * With it, routes move from Fastify to Inferlo one at a time at the same URLs. Default false.
+     */
+    fallthrough?: boolean;
 }
 /** A Fastify plugin, registered with fastify.register(inferloPlugin, options). */
 export type InferloPlugin = FastifyPluginAsync<InferloPluginOptions>;
 /**
  * Fastify plugin. { ai } decorates fastify.ai and request.ai everywhere in the Fastify app; { app, prefix }
- * serves a whole Inferlo app (routes, auth, validation, OpenAPI, MCP) under prefix. Both can be combined.
+ * serves a whole Inferlo app (routes, auth, validation, OpenAPI, MCP) under prefix; { app, fallthrough: true }
+ * answers only the app's routes and leaves every other request to Fastify. They can be combined.
  */
 export declare const inferloPlugin: InferloPlugin;

package/dist/fastify.js

@@ -1,6 +1,6 @@
 import { assertAIClient } from "./ai-client.js";
 import { InferloError } from "./errors.js";
-import { toNodeHandler } from "./serve.js";
+import { answersNodeRequest, toNodeHandler } from "./serve.js";
 const bad = (message, fix) => new InferloError("IL5015", message, { fix });
 async function plugin(fastify, options) {
     const { app, prefix } = options ?? {};
@@ -18,8 +18,25 @@ async function plugin(fastify, options) {
     }
     if (!app)
         return;
-    if (typeof prefix !== "string" || !/^\/[^*?#]*[^/*?#]$/.test(prefix)) {
-        throw bad(`inferloPlugin needs a prefix such as "/api" to serve an app, got ${JSON.stringify(prefix)}.`, 'Use fastify.register(inferloPlugin, { app, prefix: "/api" }).');
+    const { fallthrough } = options;
+    if (fallthrough !== undefined && typeof fallthrough !== "boolean") {
+        throw bad("inferloPlugin's fallthrough must be true or false.", "Use fastify.register(inferloPlugin, { app, fallthrough: true }).");
+    }
+    const validPrefix = typeof prefix === "string" && /^\/[^*?#]*[^/*?#]$/.test(prefix);
+    if (fallthrough ? prefix !== undefined && !validPrefix : !validPrefix) {
+        throw bad(`inferloPlugin needs a prefix such as "/api" to serve an app, got ${JSON.stringify(prefix)}.`, 'Use fastify.register(inferloPlugin, { app, prefix: "/api" }), or { app, fallthrough: true } to serve the app\'s routes at their own URLs.');
+    }
+    if (fallthrough) {
+        const handler = toNodeHandler(app, { prefix, fallthrough: true }); // also checks that app comes from createApp
+        // onRequest runs before Fastify reads the body, for Fastify's routes and its 404 handler alike, so the app
+        // can take over the requests it answers and Fastify keeps everything else, also other methods on a path.
+        fastify.addHook("onRequest", async (request, reply) => {
+            if (!answersNodeRequest(app, request.raw, prefix))
+                return;
+            reply.hijack();
+            await handler(request.raw, reply.raw);
+        });
+        return;
     }
     const handler = toNodeHandler(app, { prefix });
     // In a child context, so the catch-all body parser applies to the app's routes only: Inferlo reads the
@@ -37,7 +54,8 @@ async function plugin(fastify, options) {
 }
 /**
  * Fastify plugin. { ai } decorates fastify.ai and request.ai everywhere in the Fastify app; { app, prefix }
- * serves a whole Inferlo app (routes, auth, validation, OpenAPI, MCP) under prefix. Both can be combined.
+ * serves a whole Inferlo app (routes, auth, validation, OpenAPI, MCP) under prefix; { app, fallthrough: true }
+ * answers only the app's routes and leaves every other request to Fastify. They can be combined.
  */
 export const inferloPlugin = Object.assign(plugin, {
     // Like fastify-plugin: the decorators are visible to the whole Fastify app, not only inside this plugin.

package/dist/fastify.js.map

@@ -1 +1 @@
-{"version":3,"file":"fastify.js","sourceRoot":"","sources":["../src/fastify.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAuC,MAAM,YAAY,CAAC;AAyBhF,MAAM,GAAG,GAAG,CAAC,OAAe,EAAE,GAAW,EAAE,EAAE,CAAC,IAAI,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;AAE3F,KAAK,UAAU,MAAM,CAAC,OAAwB,EAAE,OAA6B;IAC3E,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IACtC,IAAI,GAAG,KAAK,SAAS,IAAI,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,UAAU,CAAC,EAAE,CAAC;QACtG,MAAM,GAAG,CAAC,8DAA8D,EAAE,2EAA2E,CAAC,CAAC;IACzJ,CAAC;IACD,mGAAmG;IACnG,MAAM,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC7E,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,EAAE;QAAE,MAAM,GAAG,CAAC,sCAAsC,EAAE,gIAAgI,CAAC,CAAC;IAC9M,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;QACrB,cAAc,CAAC,EAAE,EAAE,+IAA+I,CAAC,CAAC;QACpK,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC3B,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACtD,CAAC;IACD,IAAI,CAAC,GAAG;QAAE,OAAO;IACjB,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACrE,MAAM,GAAG,CAAC,oEAAoE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,+DAA+D,CAAC,CAAC;IAC5K,CAAC;IACD,MAAM,OAAO,GAAG,aAAa,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC/C,uGAAuG;IACvG,iGAAiG;IACjG,MAAM,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACrC,KAAK,CAAC,2BAA2B,EAAE,CAAC;QACpC,KAAK,CAAC,oBAAoB,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,MAAM,KAAK,GAAG,KAAK,EAAE,OAAuB,EAAE,KAAmB,EAAE,EAAE;YACnE,KAAK,CAAC,MAAM,EAAE,CAAC;YACf,MAAM,OAAO,CAAC,OAAO,CAAC,GAAkB,EAAE,KAAK,CAAC,GAAmB,CAAC,CAAC;QACvE,CAAC,CAAC;QACF,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACzB,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,IAAI,EAAE,KAAK,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAkB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;IAChE,yGAAyG;IACzG,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,EAAE,IAAI;IACnC,CAAC,MAAM,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC,EAAE,SAAS;CAChD,CAAC,CAAC"}
+{"version":3,"file":"fastify.js","sourceRoot":"","sources":["../src/fastify.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAuC,MAAM,YAAY,CAAC;AA+BpG,MAAM,GAAG,GAAG,CAAC,OAAe,EAAE,GAAW,EAAE,EAAE,CAAC,IAAI,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;AAE3F,KAAK,UAAU,MAAM,CAAC,OAAwB,EAAE,OAA6B;IAC3E,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IACtC,IAAI,GAAG,KAAK,SAAS,IAAI,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,UAAU,CAAC,EAAE,CAAC;QACtG,MAAM,GAAG,CAAC,8DAA8D,EAAE,2EAA2E,CAAC,CAAC;IACzJ,CAAC;IACD,mGAAmG;IACnG,MAAM,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC7E,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,EAAE;QAAE,MAAM,GAAG,CAAC,sCAAsC,EAAE,gIAAgI,CAAC,CAAC;IAC9M,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;QACrB,cAAc,CAAC,EAAE,EAAE,+IAA+I,CAAC,CAAC;QACpK,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC3B,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACtD,CAAC;IACD,IAAI,CAAC,GAAG;QAAE,OAAO;IACjB,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAChC,IAAI,WAAW,KAAK,SAAS,IAAI,OAAO,WAAW,KAAK,SAAS,EAAE,CAAC;QAClE,MAAM,GAAG,CAAC,oDAAoD,EAAE,kEAAkE,CAAC,CAAC;IACtI,CAAC;IACD,MAAM,WAAW,GAAG,OAAO,MAAM,KAAK,QAAQ,IAAI,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpF,IAAI,WAAW,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QACtE,MAAM,GAAG,CACP,oEAAoE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAC7F,2IAA2I,CAC5I,CAAC;IACJ,CAAC;IACD,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,OAAO,GAAG,aAAa,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,4CAA4C;QAC/G,2GAA2G;QAC3G,yGAAyG;QACzG,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,EAAE,OAAuB,EAAE,KAAmB,EAAE,EAAE;YAClF,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC;gBAAE,OAAO;YAC1D,KAAK,CAAC,MAAM,EAAE,CAAC;YACf,MAAM,OAAO,CAAC,OAAO,CAAC,GAAkB,EAAE,KAAK,CAAC,GAAmB,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,MAAM,OAAO,GAAG,aAAa,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC/C,uGAAuG;IACvG,iGAAiG;IACjG,MAAM,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACrC,KAAK,CAAC,2BAA2B,EAAE,CAAC;QACpC,KAAK,CAAC,oBAAoB,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,MAAM,KAAK,GAAG,KAAK,EAAE,OAAuB,EAAE,KAAmB,EAAE,EAAE;YACnE,KAAK,CAAC,MAAM,EAAE,CAAC;YACf,MAAM,OAAO,CAAC,OAAO,CAAC,GAAkB,EAAE,KAAK,CAAC,GAAmB,CAAC,CAAC;QACvE,CAAC,CAAC;QACF,KAAK,CAAC,GAAG,CAAC,MAAO,EAAE,KAAK,CAAC,CAAC;QAC1B,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,IAAI,EAAE,KAAK,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAkB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;IAChE,yGAAyG;IACzG,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,EAAE,IAAI;IACnC,CAAC,MAAM,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC,EAAE,SAAS;CAChD,CAAC,CAAC"}

package/dist/h3.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Inferlo inside h3 (1 and 2), Nitro and Nuxt server routes, without a runtime dependency on h3:
+ *
+ *   // server/routes/api/[...path].ts (Nitro or Nuxt)
+ *   import { toH3Handler } from "@browserlessapi/inferlo/h3";
+ *   import { app } from "../../inferlo/app";
+ *
+ *   export default toH3Handler(app, { prefix: "/api" });
+ *
+ *   // server/plugins/ai.ts: event.context.ai in every server route
+ *   import { inferloAI } from "@browserlessapi/inferlo/h3";
+ *   export default defineNitroPlugin(inferloAI(ai));
+ *
+ * It never loads the router, database or jobs code.
+ */
+import type { H3EventContext } from "h3";
+import type { AI } from "./ai/index.ts";
+import type { App } from "./app.ts";
+declare module "h3" {
+    interface H3EventContext {
+        /** The AI client from the inferloAI() Nitro plugin of @browserlessapi/inferlo/h3. */
+        ai: AI;
+    }
+}
+/** The parts of an h3 1 or h3 2 event Inferlo uses. */
+export interface H3EventLike {
+    /** h3 2: the Web request (and event.url, the parsed URL). */
+    req?: {
+        url: string;
+        method: string;
+        headers: HeadersInit;
+        body?: ReadableStream<Uint8Array> | null;
+        signal?: AbortSignal;
+        ip?: string;
+    };
+    url?: URL;
+    /** h3 1: the Node request and response, and event.path (after an app.use() prefix). h3 2 has node on Node.js too. */
+    node?: {
+        req: unknown;
+        res: {
+            on(event: "close", listener: () => void): unknown;
+            writableFinished?: boolean;
+        };
+    };
+    path?: string;
+    /** event.context, where the inferloAI() plugin puts ai. */
+    context: H3EventContext | Record<string, unknown>;
+}
+/** An h3 event handler: export it from a Nitro server route, or pass it to app.use() or router.add(). */
+export type H3Handler = ((event: H3EventLike) => Promise<Response>) & {
+    readonly __is_handler__: true;
+};
+export interface H3HandlerOptions {
+    /**
+     * The path the handler is served under, removed before the app routes the request: "/api" for
+     * server/routes/api/[...path].ts. Requests outside it keep their path. Leave it out when h3 already removed the
+     * path (h3 1 app.use("/api", handler)).
+     */
+    prefix?: string;
+}
+/** A Nitro plugin: export default defineNitroPlugin(inferloAI(ai)). */
+export type NitroPlugin = (nitroApp: {
+    hooks: {
+        hook(name: "request", fn: (event: H3EventLike) => void): unknown;
+    };
+}) => void;
+/**
+ * An h3 event handler that runs a whole Inferlo app (routes, auth, validation, rate limits, OpenAPI and MCP), for
+ * Nitro and Nuxt server routes and h3 apps, on h3 1 (Nuxt 3 and 4, Nitro 2) and h3 2 (Nitro 3).
+ */
+export declare function toH3Handler(app: Pick<App<any>, "fetch">, options?: H3HandlerOptions): H3Handler;
+/**
+ * A Nitro plugin that puts an AI client (createAI(...) or an Inferlo app's app.ai) on every request as
+ * event.context.ai: export default defineNitroPlugin(inferloAI(ai)) in server/plugins/ai.ts.
+ */
+export declare function inferloAI(ai: AI): NitroPlugin;

package/dist/h3.js

@@ -0,0 +1,61 @@
+import { assertAIClient } from "./ai-client.js";
+import { clientIps } from "./client-ip.js";
+import { InferloError } from "./errors.js";
+import { buildRequest, normalizePrefix, stripPrefix } from "./serve.js";
+const fix = 'Pass the app from createApp and the route\'s path: export default toH3Handler(app, { prefix: "/api" }).';
+/**
+ * An h3 event handler that runs a whole Inferlo app (routes, auth, validation, rate limits, OpenAPI and MCP), for
+ * Nitro and Nuxt server routes and h3 apps, on h3 1 (Nuxt 3 and 4, Nitro 2) and h3 2 (Nitro 3).
+ */
+export function toH3Handler(app, options = {}) {
+    if (!app || typeof app.fetch !== "function") {
+        throw new InferloError("IL5021", "toH3Handler() needs an Inferlo app (the value returned by createApp).", { fix });
+    }
+    if (options === null || typeof options !== "object" || (options.prefix !== undefined && (typeof options.prefix !== "string" || !options.prefix.startsWith("/")))) {
+        throw new InferloError("IL5021", 'toH3Handler() prefix must be a path that starts with /, such as "/api".', { fix });
+    }
+    const prefix = normalizePrefix(options.prefix);
+    const handler = async (event) => {
+        const e = event;
+        // h3 2: the event carries a Web request.
+        if (e?.req && e.url instanceof URL) {
+            const url = new URL(e.url.href);
+            url.pathname = stripPrefix(url.pathname, prefix) ?? url.pathname;
+            const method = e.req.method.toUpperCase();
+            const hasBody = e.req.body != null && method !== "GET" && method !== "HEAD";
+            const init = { method, headers: e.req.headers, body: hasBody ? e.req.body : undefined, signal: e.req.signal };
+            if (hasBody)
+                init.duplex = "half";
+            const request = new Request(url, init);
+            if (typeof e.req.ip === "string" && e.req.ip)
+                clientIps.set(request, e.req.ip);
+            return app.fetch(request);
+        }
+        // h3 1: the event carries Node's request and response.
+        if (e?.node?.req) {
+            const raw = typeof e.path === "string" ? e.path : (e.node.req.url ?? "/");
+            const controller = new AbortController();
+            e.node.res.on("close", () => {
+                if (!e.node.res.writableFinished)
+                    controller.abort();
+            });
+            return app.fetch(buildRequest(e.node.req, stripPrefix(raw, prefix) ?? raw, controller.signal));
+        }
+        throw new InferloError("IL5021", "toH3Handler()'s handler was called with something that is not an h3 event.", { fix: "Export it from a Nitro server route or pass it to an h3 app: app.use(\"/api/**\", toH3Handler(inferlo, { prefix: \"/api\" }))." });
+    };
+    // Marks it as an event handler for h3 1 (what defineEventHandler does); h3 2 takes plain functions.
+    return Object.assign(handler, { __is_handler__: true });
+}
+/**
+ * A Nitro plugin that puts an AI client (createAI(...) or an Inferlo app's app.ai) on every request as
+ * event.context.ai: export default defineNitroPlugin(inferloAI(ai)) in server/plugins/ai.ts.
+ */
+export function inferloAI(ai) {
+    assertAIClient(ai, 'Pass createAI({ providers, models }) from "@browserlessapi/inferlo/ai", or an Inferlo app\'s app.ai: export default defineNitroPlugin(inferloAI(ai)).');
+    return (nitroApp) => {
+        nitroApp.hooks.hook("request", (event) => {
+            event.context.ai = ai;
+        });
+    };
+}
+//# sourceMappingURL=h3.js.map

package/dist/h3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"h3.js","sourceRoot":"","sources":["../src/h3.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,WAAW,EAAoB,MAAM,YAAY,CAAC;AAoC1F,MAAM,GAAG,GAAG,yGAAyG,CAAC;AAEtH;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,GAA4B,EAAE,UAA4B,EAAE;IACtF,IAAI,CAAC,GAAG,IAAI,OAAQ,GAA2B,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;QACrE,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,uEAAuE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IACrH,CAAC;IACD,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACjK,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,yEAAyE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IACvH,CAAC;IACD,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAE/C,MAAM,OAAO,GAAG,KAAK,EAAE,KAAkB,EAAqB,EAAE;QAC9D,MAAM,CAAC,GAAG,KAAgC,CAAC;QAC3C,yCAAyC;QACzC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,GAAG,YAAY,GAAG,EAAE,CAAC;YACnC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAChC,GAAG,CAAC,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC;YACjE,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,IAAI,IAAI,MAAM,KAAK,KAAK,IAAI,MAAM,KAAK,MAAM,CAAC;YAC5E,MAAM,IAAI,GAAsC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;YACjJ,IAAI,OAAO;gBAAE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YAClC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YACvC,IAAI,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,KAAK,QAAQ,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE;gBAAE,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC/E,OAAO,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC;QACD,uDAAuD;QACvD,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;YACjB,MAAM,GAAG,GAAG,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,IAAI,CAAC,GAAmB,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC;YAC3F,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;YACzC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;gBAC1B,IAAI,CAAC,CAAC,CAAC,IAAK,CAAC,GAAG,CAAC,gBAAgB;oBAAE,UAAU,CAAC,KAAK,EAAE,CAAC;YACxD,CAAC,CAAC,CAAC;YACH,OAAO,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,GAAkB,EAAE,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,GAAG,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QAChH,CAAC;QACD,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,4EAA4E,EAAE,EAAE,GAAG,EAAE,gIAAgI,EAAE,CAAC,CAAC;IAC5P,CAAC,CAAC;IACF,oGAAoG;IACpG,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,cAAc,EAAE,IAAa,EAAE,CAAC,CAAC;AACnE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,EAAM;IAC9B,cAAc,CAAC,EAAE,EAAE,uJAAuJ,CAAC,CAAC;IAC5K,OAAO,CAAC,QAAQ,EAAE,EAAE;QAClB,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;YACvC,KAAK,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC"}

package/dist/hapi.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Inferlo inside hapi (21 and later), without a runtime dependency on hapi:
+ *
+ *   import Hapi from "@hapi/hapi";
+ *   import { createAI, anthropic } from "@browserlessapi/inferlo/ai";
+ *   import { inferloPlugin } from "@browserlessapi/inferlo/hapi";
+ *
+ *   const server = Hapi.server({ port: 3000 });
+ *   await server.register({ plugin: inferloPlugin, options: { ai } });                                // server.ai and request.ai
+ *   await server.register({ plugin: inferloPlugin, options: { app: inferloApp }, routes: { prefix: "/api" } }); // a whole Inferlo app under /api
+ *
+ * Importing this entry point adds `ai` to hapi's server and request types. It never loads the router,
+ * database or jobs code.
+ */
+import type { Plugin } from "@hapi/hapi";
+import type { AI } from "./ai/index.ts";
+declare module "@hapi/hapi" {
+    interface Server {
+        /** The AI client registered with inferloPlugin from @browserlessapi/inferlo/hapi. */
+        ai: AI;
+    }
+    interface Request {
+        /** The AI client registered with inferloPlugin from @browserlessapi/inferlo/hapi. */
+        ai: AI;
+    }
+}
+export interface InferloPluginOptions {
+    /** AI client for server.ai and request.ai: createAI(...) or an Inferlo app's app.ai. Default: app.ai, unless server.ai is already set. */
+    ai?: AI;
+    /**
+     * A whole Inferlo app (routes, auth, validation, OpenAPI, MCP) to serve. It is served under the prefix you
+     * register the plugin with (routes: { prefix: "/api" }), or, without one, for every path hapi has no route for.
+     */
+    app?: {
+        fetch(req: Request, ...rest: unknown[]): Promise<Response>;
+        ai?: AI;
+    };
+}
+/** A hapi plugin, registered with server.register({ plugin: inferloPlugin, options }). */
+export type InferloPlugin = Plugin<InferloPluginOptions>;
+/**
+ * hapi plugin. options: { ai } decorates server.ai and request.ai; options: { app } serves a whole Inferlo app
+ * (routes, auth, validation, OpenAPI, MCP) under the prefix the plugin is registered with (routes: { prefix }).
+ */
+export declare const inferloPlugin: InferloPlugin;

package/dist/hapi.js

@@ -0,0 +1,57 @@
+import { assertAIClient } from "./ai-client.js";
+import { InferloError } from "./errors.js";
+import { toNodeHandler } from "./serve.js";
+const bad = (message, fix) => new InferloError("IL5025", message, { fix });
+async function register(server, options) {
+    if (options === null || typeof options !== "object") {
+        throw bad("inferloPlugin options must be an object with ai, app or both.", "Use server.register({ plugin: inferloPlugin, options: { ai } }).");
+    }
+    if ("prefix" in options) {
+        throw bad("inferloPlugin takes the path prefix from hapi, not from its options.", 'Use server.register({ plugin: inferloPlugin, options: { app }, routes: { prefix: "/api" } }).');
+    }
+    const { app } = options;
+    if (app !== undefined && (typeof app !== "object" || app === null || typeof app.fetch !== "function")) {
+        throw bad("inferloPlugin's app must be an Inferlo app (createApp(...)).", 'Use server.register({ plugin: inferloPlugin, options: { app: inferloApp }, routes: { prefix: "/api" } }).');
+    }
+    if (!app && !options.ai) {
+        throw bad("inferloPlugin needs ai, app or both.", 'Use options: { ai } for server.ai and request.ai, or options: { app } with routes: { prefix: "/api" } to serve an Inferlo app.');
+    }
+    const decorated = server.decorations.server.includes("ai");
+    // app.ai is the default, unless an earlier registration with { ai } already set server.ai.
+    const ai = options.ai ?? (decorated ? undefined : app?.ai);
+    if (ai !== undefined) {
+        assertAIClient(ai, 'Pass createAI({ providers, models }) from "@browserlessapi/inferlo/ai", or an Inferlo app\'s app.ai: server.register({ plugin: inferloPlugin, options: { ai } }).');
+        if (decorated) {
+            throw bad("server.ai is already set by an earlier inferloPlugin registration.", "Register inferloPlugin with { ai } once, and with { app } (without ai) for each app you serve.");
+        }
+        // A value, not a method (older hapi types only describe method decorations).
+        server.decorate("server", "ai", ai);
+        // A getter, so every request reads the one client.
+        server.decorate("request", "ai", () => ai, { apply: true });
+    }
+    if (!app)
+        return;
+    const prefix = server.realm.modifiers.route.prefix;
+    const handler = toNodeHandler(app, { prefix });
+    // Inferlo reads the body stream itself (JSON, forms, its own size limits) and writes the answer, streams
+    // included, to the Node response; hapi's own routes stay more specific than this catch-all.
+    server.route({
+        method: "*",
+        path: "/{path*}",
+        options: { payload: { output: "stream", parse: false }, description: "Inferlo app" },
+        handler: async (request, h) => {
+            await handler(request.raw.req, request.raw.res);
+            return h.abandon;
+        },
+    });
+}
+/**
+ * hapi plugin. options: { ai } decorates server.ai and request.ai; options: { app } serves a whole Inferlo app
+ * (routes, auth, validation, OpenAPI, MCP) under the prefix the plugin is registered with (routes: { prefix }).
+ */
+export const inferloPlugin = {
+    name: "@browserlessapi/inferlo",
+    multiple: true,
+    register,
+};
+//# sourceMappingURL=hapi.js.map

package/dist/hapi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hapi.js","sourceRoot":"","sources":["../src/hapi.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAuC,MAAM,YAAY,CAAC;AA0BhF,MAAM,GAAG,GAAG,CAAC,OAAe,EAAE,GAAW,EAAE,EAAE,CAAC,IAAI,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;AAE3F,KAAK,UAAU,QAAQ,CAAC,MAAc,EAAE,OAA6B;IACnE,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QACpD,MAAM,GAAG,CAAC,+DAA+D,EAAE,kEAAkE,CAAC,CAAC;IACjJ,CAAC;IACD,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;QACxB,MAAM,GAAG,CAAC,sEAAsE,EAAE,+FAA+F,CAAC,CAAC;IACrL,CAAC;IACD,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IACxB,IAAI,GAAG,KAAK,SAAS,IAAI,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,UAAU,CAAC,EAAE,CAAC;QACtG,MAAM,GAAG,CAAC,8DAA8D,EAAE,2GAA2G,CAAC,CAAC;IACzL,CAAC;IACD,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QACxB,MAAM,GAAG,CAAC,sCAAsC,EAAE,gIAAgI,CAAC,CAAC;IACtL,CAAC;IACD,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC3D,2FAA2F;IAC3F,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC3D,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;QACrB,cAAc,CAAC,EAAE,EAAE,mKAAmK,CAAC,CAAC;QACxL,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,GAAG,CAAC,oEAAoE,EAAE,gGAAgG,CAAC,CAAC;QACpL,CAAC;QACD,6EAA6E;QAC7E,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAW,CAAC,CAAC;QAC7C,mDAAmD;QACnD,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9D,CAAC;IACD,IAAI,CAAC,GAAG;QAAE,OAAO;IACjB,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC;IACnD,MAAM,OAAO,GAAG,aAAa,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC/C,yGAAyG;IACzG,4FAA4F;IAC5F,MAAM,CAAC,KAAK,CAAC;QACX,MAAM,EAAE,GAAG;QACX,IAAI,EAAE,UAAU;QAChB,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,aAAa,EAAE;QACpF,OAAO,EAAE,KAAK,EAAE,OAAoB,EAAE,CAAkB,EAAE,EAAE;YAC1D,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAkB,EAAE,OAAO,CAAC,GAAG,CAAC,GAA8B,CAAC,CAAC;YAC1F,OAAO,CAAC,CAAC,OAAO,CAAC;QACnB,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAkB;IAC1C,IAAI,EAAE,yBAAyB;IAC/B,QAAQ,EAAE,IAAI;IACd,QAAQ;CACT,CAAC"}

package/dist/index.d.ts

@@ -8,8 +8,12 @@ export type { MetricsConfig } from "./metrics.ts";
 export type { Deprecation } from "./deprecation.ts";
 export type { App, AppConfig, AuthConfig, CorsConfig, Middleware, MiddlewareContext, RequestOptions, RouteSource, Logger, HealthConfig, HealthCheck, CheckResult, ReadinessReport, CloseOptions } from "./app.ts";
 export type { SecureHeadersConfig } from "./secure-headers.ts";
+export { module, isModule } from "./module.ts";
+export type { Module, ModuleOptions, AnyModule, ModuleModels } from "./module.ts";
+export { apiVersion } from "./api-version.ts";
+export type { ApiVersionOptions } from "./api-version.ts";
 export { route, isRoute } from "./route.ts";
-export type { Register, Context, RouteDef, RouteOptions, Auth, Method, ToolOptions, AppUser, AppDb } from "./route.ts";
+export type { Register, Context, RouteDef, RouteOptions, Auth, Method, ToolOptions, AppUser, AppDb, AppPermission } from "./route.ts";
 export { t, Schema, ObjectSchema, ArraySchema, RefSchema, ValidationError, toJSONSchema } from "./schema.ts";
 export type { Infer, InferInput, Issue, JSONSchema, ParseResult, Shape, AnySchema } from "./schema.ts";
 export { model, Model, columnName } from "./model.ts";
@@ -28,8 +32,17 @@ export type { RateLimit, RateLimitConfig } from "./rate-limit.ts";
 export { job, isJob, retryDelayMs } from "./jobs.ts";
 export { cron, isCron } from "./cron.ts";
 export type { CronDef } from "./cron.ts";
+export type { JobTraceContext } from "./tracing.ts";
 export type { JobDef, JobOptions, JobContext, JobInput, JobRecord, JobStatus, JobSource, JobQueueConfig, Jobs, AppJobs, EnqueueOptions, RunResult, Worker } from "./jobs.ts";
+export { AuditLog, auditChanges } from "./audit.ts";
+export type { Audit, AuditEntry, AuditChange } from "./audit.ts";
+export type { Cache, CacheConfig, CacheSetOptions, RouteCache } from "./cache.ts";
+export { permissions, isPermissions } from "./permissions.ts";
+export type { Permissions, PermissionRule, PermissionInput } from "./permissions.ts";
 export { bearer, hashToken, createToken, hashPassword, verifyPassword, safeEqual } from "./auth.ts";
+export { sessions } from "./sessions.ts";
+export type { TracingConfig, OtelApi, OtelSpan } from "./tracing.ts";
+export type { Sessions, SessionsOptions, SessionData, SessionCookieOptions, SessionResponseContext } from "./sessions.ts";
 export { env, setEnv } from "./env.ts";
 export { config } from "./config.ts";
 export type { Config, ConfigOptions } from "./config.ts";

package/dist/index.js

@@ -3,6 +3,8 @@
  * https://github.com/BrowserlessAPI/Inferlo
  */
 export { createApp } from "./app.js";
+export { module, isModule } from "./module.js";
+export { apiVersion } from "./api-version.js";
 export { route, isRoute } from "./route.js";
 export { t, Schema, ObjectSchema, ArraySchema, RefSchema, ValidationError, toJSONSchema } from "./schema.js";
 export { model, Model, columnName } from "./model.js";
@@ -13,7 +15,10 @@ export { createAI, cosineSimilarity, extractJson, openai, openaiCompatible, anth
 export { tool, isTool, ToolBuilder } from "./ai/tool.js";
 export { job, isJob, retryDelayMs } from "./jobs.js";
 export { cron, isCron } from "./cron.js";
+export { AuditLog, auditChanges } from "./audit.js";
+export { permissions, isPermissions } from "./permissions.js";
 export { bearer, hashToken, createToken, hashPassword, verifyPassword, safeEqual } from "./auth.js";
+export { sessions } from "./sessions.js";
 export { env, setEnv } from "./env.js";
 export { config } from "./config.js";
 export { InferloError, httpError, notFound, forbidden, badRequest, docsUrl } from "./errors.js";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAOrC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAG5C,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG7G,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAGtD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAGhD,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAWjE,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC1J,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAwBzD,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAGzC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACpG,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAChG,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAEnE,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAOrC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAG/C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG9C,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAG5C,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG7G,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAGtD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAGhD,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAWjE,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC1J,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAwBzD,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAIzC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAGpD,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAE9D,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACpG,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAGzC,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAChG,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAEnE,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC"}

package/dist/jobs.d.ts

@@ -11,10 +11,13 @@
  * jobs in this process, app.jobs.runDue() runs them once (tests).
  */
 import type { AI } from "./ai/index.ts";
+import type { Audit } from "./audit.ts";
+import type { Cache } from "./cache.ts";
 import { type CronDef } from "./cron.ts";
 import type { Adapter } from "./db/types.ts";
 import type { AppDb } from "./route.ts";
 import { type AnySchema, type Infer, type InferInput } from "./schema.ts";
+import type { JobTraceContext, JobTracing } from "./tracing.ts";
 export interface JobOptions<I extends AnySchema> {
     /** Schema of the job's input. Checked when the job is enqueued and again when it runs. */
     input: I;
@@ -30,10 +33,17 @@ export interface JobContext<Input> {
     ai: AI;
     /** Enqueue follow-up jobs. */
     jobs: Jobs;
+    /** The app cache, the same as ctx.cache in routes and app.cache. */
+    cache: Cache;
     /** Job id. */
     id: string;
     /** 1 on the first run, 2 on the first retry, and so on. */
     attempt: number;
+    /**
+     * Write an audit log entry (needs AuditLog in createApp({ models })). Jobs have no signed-in user: pass the
+     * userId of the user who asked for the work, or leave it out for work the system does on its own.
+     */
+    audit: Audit;
 }
 export interface JobDef<Input = any, Output = any> {
     readonly kind: "inferlo.job";
@@ -64,6 +74,8 @@ export interface JobRecord {
     runAt: Date;
     /** Message of the last failure. */
     lastError?: string;
+    /** With createApp({ tracing }): the trace (W3C traceparent and tracestate) of the request or job that enqueued it, which its runs continue. */
+    trace?: JobTraceContext;
     createdAt: Date;
     updatedAt: Date;
 }
@@ -161,6 +173,12 @@ export declare function jobStoreFor(config: JobQueueConfig | undefined, adapter:
 export interface JobRuntime {
     db: AppDb;
     ai: AI;
+    cache: Cache;
+    /** Builds ctx.audit for one run. */
+    audit(job: {
+        name: string;
+        id: string;
+    }): Audit;
     store: JobStore;
     /** Name of the store, shown as app.jobs.queue. Default "memory". */
     queue?: "memory" | "database";
@@ -172,6 +190,8 @@ export interface JobRuntime {
     };
     /** Called after each attempt with its outcome and duration (metrics). */
     onRun?(name: string, outcome: keyof RunResult, durationMs: number): void;
+    /** With createApp({ tracing }): a span per attempt that continues the trace the job was enqueued in. */
+    tracing?: JobTracing;
 }
 /** app.jobs plus what the framework tests reach directly. */
 export interface InternalJobs extends AppJobs {

package/dist/jobs.js

@@ -125,7 +125,7 @@ export const STALE_AFTER_MS = 5 * 60_000;
 /** How often a worker reports that a running job is still alive. */
 export const HEARTBEAT_MS = 30_000;
 export const STOPPED_MESSAGE = "The worker stopped while running this job (the process exited or lost its database connection).";
-const JOB_COLUMNS = `"id", "name", "input", "status", "attempts", "max_attempts", "run_at", "last_error", "created_at", "updated_at"`;
+const JOB_COLUMNS = `"id", "name", "input", "status", "attempts", "max_attempts", "run_at", "last_error", "created_at", "updated_at", "traceparent", "tracestate"`;
 function fromRow(row) {
     const record = {
         id: String(row.id),
@@ -140,6 +140,11 @@ function fromRow(row) {
     };
     if (row.last_error !== null && row.last_error !== undefined)
         record.lastError = String(row.last_error);
+    if (typeof row.traceparent === "string") {
+        record.trace = { traceparent: row.traceparent };
+        if (typeof row.tracestate === "string")
+            record.trace.tracestate = row.tracestate;
+    }
     return record;
 }
 /**
@@ -161,7 +166,10 @@ export function databaseJobStore(adapter, options = {}) {
             await sql(`CREATE TABLE IF NOT EXISTS "inferlo_jobs" (
           "id" uuid PRIMARY KEY, "name" text NOT NULL, "input" jsonb NOT NULL, "status" text NOT NULL,
           "attempts" integer NOT NULL, "max_attempts" integer NOT NULL, "run_at" timestamptz NOT NULL,
-          "last_error" text, "created_at" timestamptz NOT NULL, "updated_at" timestamptz NOT NULL)`);
+          "last_error" text, "created_at" timestamptz NOT NULL, "updated_at" timestamptz NOT NULL,
+          "traceparent" text, "tracestate" text)`);
+            // Tables created by Inferlo 0.5 and earlier get the trace columns.
+            await sql('ALTER TABLE "inferlo_jobs" ADD COLUMN IF NOT EXISTS "traceparent" text, ADD COLUMN IF NOT EXISTS "tracestate" text');
             await sql('CREATE INDEX IF NOT EXISTS "inferlo_jobs_due_idx" ON "inferlo_jobs" ("status", "run_at")');
         }
         catch {
@@ -179,8 +187,8 @@ export function databaseJobStore(adapter, options = {}) {
     return {
         async add(r) {
             await table();
-            await sql(`INSERT INTO "inferlo_jobs" (${JOB_COLUMNS}) VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10) ON CONFLICT ("id") DO NOTHING`, [
-                r.id, r.name, JSON.stringify(r.input), r.status, r.attempts, r.maxAttempts, r.runAt, r.lastError ?? null, r.createdAt, r.updatedAt,
+            await sql(`INSERT INTO "inferlo_jobs" (${JOB_COLUMNS}) VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12) ON CONFLICT ("id") DO NOTHING`, [
+                r.id, r.name, JSON.stringify(r.input), r.status, r.attempts, r.maxAttempts, r.runAt, r.lastError ?? null, r.createdAt, r.updatedAt, r.trace?.traceparent ?? null, r.trace?.tracestate ?? null,
             ]);
         },
         async claim(now, limit, names) {
@@ -296,6 +304,9 @@ export function createJobs(list, runtime, crons = []) {
                 throw new InferloError("IL6009", `runAt for job "${def.name}" must be a valid Date.`, { fix: "Pass runAt: new Date(Date.now() + 60_000) or leave it out to run now." });
             }
             const queued = record(def, input, options.runAt, crypto.randomUUID());
+            const trace = runtime.tracing?.capture();
+            if (trace?.traceparent)
+                queued.trace = trace;
             await runtime.store.add(queued);
             return queued;
         },
@@ -355,22 +366,23 @@ export function createJobs(list, runtime, crons = []) {
     workers.set(jobs, running);
     async function run(record, now) {
         const started = performance.now();
-        const outcome = await attempt(record, now);
+        const outcome = runtime.tracing ? await runtime.tracing.run(record, (fail) => attempt(record, now, fail)) : await attempt(record, now);
         runtime.onRun?.(record.name, outcome, performance.now() - started);
         return outcome;
     }
-    async function attempt(record, now) {
+    async function attempt(record, now, fail) {
         const def = byName.get(record.name);
         const touch = runtime.store.touch?.bind(runtime.store);
         const heartbeat = touch ? setInterval(() => void touch(record.id).catch(() => { }), runtime.heartbeatMs ?? HEARTBEAT_MS) : undefined;
         try {
             if (!def)
                 throw new InferloError("IL6010", `"${record.name}" is not a registered job.`, { fix: "Add the job to createApp({ jobs: [...] }) in the process that runs jobs." });
-            await def.handler({ input: parse(def, record.input), db: runtime.db, ai: runtime.ai, jobs, id: record.id, attempt: record.attempts });
+            await def.handler({ input: parse(def, record.input), db: runtime.db, ai: runtime.ai, jobs, cache: runtime.cache, id: record.id, attempt: record.attempts, audit: runtime.audit({ name: record.name, id: record.id }) });
             await runtime.store.update(record.id, { status: "done" });
             return "done";
         }
         catch (error) {
+            fail?.(error);
             const message = error instanceof Error ? error.message : String(error);
             if (record.attempts < record.maxAttempts) {
                 await runtime.store.update(record.id, { status: "pending", lastError: message, runAt: new Date(now.getTime() + retryDelayMs(record.attempts)) });