@raybase/api 0.0.0 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Itself & Co
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/admin-routes.d.ts

@@ -0,0 +1,11 @@
+import { type RaybaseModuleRoute } from "@raybase/core";
+import { type ApiKeyOptions } from "./auth.js";
+import type { ApiOperationSummary } from "./api.js";
+export type ApiAdminRouteOptions = {
+    prefix: string;
+    operations: ApiOperationSummary[];
+    keys?: ApiKeyOptions;
+    docsTitle: string;
+};
+export declare function createApiAdminRoutes<Env>(options: ApiAdminRouteOptions): RaybaseModuleRoute<Env>[];
+//# sourceMappingURL=admin-routes.d.ts.map

package/dist/admin-routes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin-routes.d.ts","sourceRoot":"","sources":["../src/admin-routes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,KAAK,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnE,OAAO,EAML,KAAK,aAAa,EACnB,MAAM,WAAW,CAAC;AAKnB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEpD,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,mBAAmB,EAAE,CAAC;IAClC,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,OAAO,EAAE,oBAAoB,GAAG,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAmFlG"}

package/dist/admin-routes.js

@@ -0,0 +1,208 @@
+import { nowIso, q } from "@raybase/core";
+import { createApiKey, deleteApiKey, listApiKeys, revokeApiKey, rotateApiKey } from "./auth.js";
+import { ApiHttpError, apiErrorResponse } from "./errors.js";
+import { adminAssets } from "./generated/admin-assets.js";
+import { matchApiPath } from "./path.js";
+import { apiKeyEventsTableName } from "./system-tables.js";
+export function createApiAdminRoutes(options) {
+    return [
+        {
+            method: "GET",
+            path: "/admin/api",
+            auth: "admin",
+            handle: () => adminHtml(options.docsTitle)
+        },
+        {
+            method: "GET",
+            path: "/admin/api/*",
+            auth: "admin",
+            handle: (ctx) => adminAsset(new URL(ctx.request.url).pathname)
+        },
+        {
+            method: "GET",
+            path: "/api/admin/api/operations",
+            auth: "admin",
+            handle: (ctx) => ctx.json({ operations: options.operations, prefix: options.prefix })
+        },
+        {
+            method: "GET",
+            path: "/api/admin/api/keys",
+            auth: "admin",
+            handle: async (ctx) => ctx.json({ keys: await listApiKeys(ctx.control) })
+        },
+        {
+            method: "POST",
+            path: "/api/admin/api/keys",
+            auth: "admin",
+            handle: async (ctx) => adminJson(ctx, async () => createApiKey(ctx, await readJson(ctx.request), options.keys))
+        },
+        {
+            method: "POST",
+            path: "/api/admin/api/keys/:id/rotate",
+            auth: "admin",
+            handle: async (ctx) => adminJson(ctx, async () => rotateApiKey(ctx, pathId(ctx.request, "/api/admin/api/keys/:id/rotate"), options.keys))
+        },
+        {
+            method: "POST",
+            path: "/api/admin/api/keys/:id/revoke",
+            auth: "admin",
+            handle: async (ctx) => adminJson(ctx, async () => {
+                const body = await readJson(ctx.request);
+                return revokeApiKey(ctx, pathId(ctx.request, "/api/admin/api/keys/:id/revoke"), body.reason);
+            })
+        },
+        {
+            method: "DELETE",
+            path: "/api/admin/api/keys/:id",
+            auth: "admin",
+            handle: async (ctx) => adminJson(ctx, async () => deleteApiKey(ctx, pathId(ctx.request, "/api/admin/api/keys/:id")))
+        },
+        {
+            method: "GET",
+            path: "/api/admin/api/audit",
+            auth: "admin",
+            handle: async (ctx) => {
+                const rows = await ctx.control.all(`SELECT "id", "actorId", "action", "targetType", "targetId", "metadata", "createdAt"
+           FROM "_audit"
+           WHERE "action" LIKE 'api.%' OR "targetType" IN ('raybase_api_key', 'raybase_api_operation')
+           ORDER BY "createdAt" DESC LIMIT 100`).catch(() => []);
+                const keyEvents = await ctx.control.all(`SELECT * FROM ${q(apiKeyEventsTableName)} ORDER BY "createdAt" DESC LIMIT 100`).catch(() => []);
+                return ctx.json({ audit: rows, keyEvents });
+            }
+        },
+        {
+            method: "GET",
+            path: "/api/admin/api/openapi.json",
+            auth: "admin",
+            handle: (ctx) => ctx.json(openApiDocument(options))
+        },
+        {
+            method: "GET",
+            path: "/api/admin/api/spec.json",
+            auth: "admin",
+            handle: (ctx) => ctx.json(openApiDocument(options))
+        }
+    ];
+}
+function adminHtml(title) {
+    const html = `<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>${escapeHtml(title)}</title>
+  <style>${adminAssets.css}</style>
+</head>
+<body>
+  <div id="root"></div>
+  <script type="module">${adminAssets.js}</script>
+</body>
+</html>`;
+    return new Response(html, { headers: { "content-type": "text/html; charset=utf-8" } });
+}
+function adminAsset(pathname) {
+    if (pathname.endsWith("/assets/app.js")) {
+        return new Response(adminAssets.js, { headers: { "content-type": "application/javascript; charset=utf-8" } });
+    }
+    if (pathname.endsWith("/assets/app.css")) {
+        return new Response(adminAssets.css, { headers: { "content-type": "text/css; charset=utf-8" } });
+    }
+    return new Response("Not found", { status: 404 });
+}
+async function adminJson(ctx, fn) {
+    const requestId = ctx.request.headers.get("cf-ray") ?? `admin_${Date.now()}`;
+    try {
+        return ctx.json(await fn());
+    }
+    catch (error) {
+        return apiErrorResponse(error instanceof ApiHttpError ? error : new ApiHttpError(400, "invalid_request", error instanceof Error ? error.message : String(error)), requestId);
+    }
+}
+async function readJson(request) {
+    const text = await request.text();
+    if (!text.trim())
+        return {};
+    try {
+        return JSON.parse(text);
+    }
+    catch {
+        throw new ApiHttpError(400, "invalid_request", "Request body must be valid JSON.");
+    }
+}
+function pathId(request, pattern) {
+    const params = matchApiPath(pattern, new URL(request.url).pathname);
+    const id = params?.id;
+    if (!id)
+        throw new ApiHttpError(404, "not_found", "API key not found.");
+    return id;
+}
+function openApiDocument(options) {
+    const paths = {};
+    for (const operation of options.operations) {
+        const method = operation.method.toLowerCase();
+        paths[operation.path] = {
+            ...(paths[operation.path] ?? {}),
+            [method]: {
+                operationId: operation.name,
+                summary: operation.summary,
+                description: operation.description,
+                tags: operation.tags,
+                security: [{ bearerAuth: operation.scopes }],
+                requestBody: operation.method === "GET" || operation.method === "DELETE"
+                    ? undefined
+                    : {
+                        required: false,
+                        content: { "application/json": { schema: operation.inputSchema } }
+                    },
+                responses: {
+                    "200": {
+                        description: "Successful response",
+                        content: {
+                            "application/json": {
+                                schema: operation.outputSchema
+                                    ? {
+                                        type: "object",
+                                        properties: { data: operation.outputSchema },
+                                        required: ["data"]
+                                    }
+                                    : { type: "object" }
+                            }
+                        }
+                    },
+                    "400": { description: "Invalid request" },
+                    "401": { description: "Missing, invalid, expired, or revoked API key" },
+                    "403": { description: "Missing API scope or action policy denied" },
+                    "500": { description: "Internal server error" }
+                }
+            }
+        };
+    }
+    return {
+        openapi: "3.1.0",
+        info: {
+            title: options.docsTitle,
+            version: "0.1.0",
+            description: "Raybase external API operations declared through @raybase/api.",
+            "x-generated-at": nowIso()
+        },
+        components: {
+            securitySchemes: {
+                bearerAuth: {
+                    type: "http",
+                    scheme: "bearer"
+                }
+            }
+        },
+        paths
+    };
+}
+function escapeHtml(value) {
+    return value.replace(/[&<>"']/g, (char) => ({
+        "&": "&amp;",
+        "<": "&lt;",
+        ">": "&gt;",
+        "\"": "&quot;",
+        "'": "&#39;"
+    })[char] ?? char);
+}
+//# sourceMappingURL=admin-routes.js.map

package/dist/admin-routes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin-routes.js","sourceRoot":"","sources":["../src/admin-routes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,CAAC,EAA2B,MAAM,eAAe,CAAC;AACnE,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,YAAY,EAEb,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAU3D,MAAM,UAAU,oBAAoB,CAAM,OAA6B;IACrE,OAAO;QACL;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC;SAC3C;QACD;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,cAAc;YACpB,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;SAC/D;QACD;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,2BAA2B;YACjC,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;SACtF;QACD;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,qBAAqB;YAC3B,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;SAC1E;QACD;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,qBAAqB;YAC3B,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,QAAQ,CAAC,GAAG,CAAC,OAAO,CAA4B,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;SAC3I;QACD;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,gCAAgC;YACtC,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,gCAAgC,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;SAC1I;QACD;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,gCAAgC;YACtC,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE;gBAC/C,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBACzC,OAAO,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,gCAAgC,CAAC,EAAG,IAAgC,CAAC,MAAM,CAAC,CAAC;YAC5H,CAAC,CAAC;SACH;QACD;YACE,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,yBAAyB;YAC/B,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,yBAAyB,CAAC,CAAC,CAAC;SACrH;QACD;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,sBAAsB;YAC5B,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;gBACpB,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,GAAG,CAChC;;;+CAGqC,CACtC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;gBAClB,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,GAAG,CACrC,iBAAiB,CAAC,CAAC,qBAAqB,CAAC,sCAAsC,CAChF,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;gBAClB,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;YAC9C,CAAC;SACF;QACD;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,6BAA6B;YACnC,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;SACpD;QACD;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,0BAA0B;YAChC,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;SACpD;KACF,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC9B,MAAM,IAAI,GAAG;;;;;WAKJ,UAAU,CAAC,KAAK,CAAC;WACjB,WAAW,CAAC,GAAG;;;;0BAIA,WAAW,CAAC,EAAE;;QAEhC,CAAC;IACP,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,0BAA0B,EAAE,EAAE,CAAC,CAAC;AACzF,CAAC;AAED,SAAS,UAAU,CAAC,QAAgB;IAClC,IAAI,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACxC,OAAO,IAAI,QAAQ,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,uCAAuC,EAAE,EAAE,CAAC,CAAC;IAChH,CAAC;IACD,IAAI,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;QACzC,OAAO,IAAI,QAAQ,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,yBAAyB,EAAE,EAAE,CAAC,CAAC;IACnG,CAAC;IACD,OAAO,IAAI,QAAQ,CAAC,WAAW,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;AACpD,CAAC;AAED,KAAK,UAAU,SAAS,CAAM,GAAqD,EAAE,EAA0B;IAC7G,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,SAAS,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;IAC7E,IAAI,CAAC;QACH,OAAO,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC9B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,gBAAgB,CAAC,KAAK,YAAY,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,GAAG,EAAE,iBAAiB,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;IAC/K,CAAC;AACH,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,OAAgB;IACtC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;IAClC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAY,CAAC;IACrC,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,YAAY,CAAC,GAAG,EAAE,iBAAiB,EAAE,kCAAkC,CAAC,CAAC;IACrF,CAAC;AACH,CAAC;AAED,SAAS,MAAM,CAAC,OAAgB,EAAE,OAAe;IAC/C,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,EAAE,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;IACpE,MAAM,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE;QAAE,MAAM,IAAI,YAAY,CAAC,GAAG,EAAE,WAAW,EAAE,oBAAoB,CAAC,CAAC;IACxE,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,eAAe,CAAC,OAA6B;IACpD,MAAM,KAAK,GAA4C,EAAE,CAAC;IAC1D,KAAK,MAAM,SAAS,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QAC3C,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAC9C,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG;YACtB,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAChC,CAAC,MAAM,CAAC,EAAE;gBACR,WAAW,EAAE,SAAS,CAAC,IAAI;gBAC3B,OAAO,EAAE,SAAS,CAAC,OAAO;gBAC1B,WAAW,EAAE,SAAS,CAAC,WAAW;gBAClC,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC;gBAC5C,WAAW,EAAE,SAAS,CAAC,MAAM,KAAK,KAAK,IAAI,SAAS,CAAC,MAAM,KAAK,QAAQ;oBACtE,CAAC,CAAC,SAAS;oBACX,CAAC,CAAC;wBACE,QAAQ,EAAE,KAAK;wBACf,OAAO,EAAE,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,WAAW,EAAE,EAAE;qBACnE;gBACL,SAAS,EAAE;oBACT,KAAK,EAAE;wBACL,WAAW,EAAE,qBAAqB;wBAClC,OAAO,EAAE;4BACP,kBAAkB,EAAE;gCAClB,MAAM,EAAE,SAAS,CAAC,YAAY;oCAC5B,CAAC,CAAC;wCACE,IAAI,EAAE,QAAQ;wCACd,UAAU,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,YAAY,EAAE;wCAC5C,QAAQ,EAAE,CAAC,MAAM,CAAC;qCACnB;oCACH,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE;6BACvB;yBACF;qBACF;oBACD,KAAK,EAAE,EAAE,WAAW,EAAE,iBAAiB,EAAE;oBACzC,KAAK,EAAE,EAAE,WAAW,EAAE,+CAA+C,EAAE;oBACvE,KAAK,EAAE,EAAE,WAAW,EAAE,2CAA2C,EAAE;oBACnE,KAAK,EAAE,EAAE,WAAW,EAAE,uBAAuB,EAAE;iBAChD;aACF;SACF,CAAC;IACJ,CAAC;IACD,OAAO;QACL,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE;YACJ,KAAK,EAAE,OAAO,CAAC,SAAS;YACxB,OAAO,EAAE,OAAO;YAChB,WAAW,EAAE,gEAAgE;YAC7E,gBAAgB,EAAE,MAAM,EAAE;SAC3B;QACD,UAAU,EAAE;YACV,eAAe,EAAE;gBACf,UAAU,EAAE;oBACV,IAAI,EAAE,MAAM;oBACZ,MAAM,EAAE,QAAQ;iBACjB;aACF;SACF;QACD,KAAK;KACN,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,KAAa;IAC/B,OAAO,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC1C,GAAG,EAAE,OAAO;QACZ,GAAG,EAAE,MAAM;QACX,GAAG,EAAE,MAAM;QACX,IAAI,EAAE,QAAQ;QACd,GAAG,EAAE,OAAO;KACb,CAAC,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC;AACpB,CAAC"}

package/dist/api.d.ts

@@ -0,0 +1,102 @@
+import { type JsonSchemaObject, type RaybaseAction, type RaybaseModule } from "@raybase/core";
+import { type ApiKeyOptions } from "./auth.js";
+export type ApiHttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+export type ApiRequestParts = {
+    request: Request;
+    params: Record<string, string>;
+    query: Record<string, string | string[]>;
+    body: unknown;
+    headers: Headers;
+    method: ApiHttpMethod;
+    path: string;
+    requestId: string;
+};
+export type ApiResponseMetadata = {
+    requestId: string;
+    operationName: string;
+    actionName: string;
+    status: "ok";
+};
+export type ApiRequestMetadata = {
+    requestId: string;
+    operationName: string;
+    actionName: string;
+    route: string;
+    servicePrincipalId: string;
+    apiKeyId: string;
+    scopes: string[];
+};
+export type ApiSerializedResponse = {
+    body?: unknown;
+    status?: number;
+    headers?: HeadersInit;
+};
+export type ApiOperationExample = {
+    name: string;
+    summary?: string;
+    request?: unknown;
+    response?: unknown;
+};
+export type ApiOperationOptions<Input, Output> = {
+    method: ApiHttpMethod;
+    path: string;
+    scopes: string[];
+    summary?: string;
+    description?: string;
+    tags?: string[];
+    idempotency?: {
+        header?: "Idempotency-Key";
+        key?: (input: Input, ctx: ApiRequestMetadata) => string;
+    };
+    parseRequest?: (request: ApiRequestParts) => Input;
+    serializeResponse?: (output: Output, ctx: ApiResponseMetadata) => unknown | ApiSerializedResponse;
+    examples?: ApiOperationExample[];
+};
+export type ApiOperation<Input = unknown, Output = unknown, Env = unknown> = {
+    kind: "raybase.api.operation";
+    action: RaybaseAction<Input, Output, Env>;
+    method: ApiHttpMethod;
+    path: string;
+    scopes: string[];
+    summary?: string;
+    description?: string;
+    tags: string[];
+    idempotency?: ApiOperationOptions<Input, Output>["idempotency"];
+    parseRequest?: (request: ApiRequestParts) => Input;
+    serializeResponse?: (output: Output, ctx: ApiResponseMetadata) => unknown | ApiSerializedResponse;
+    examples: ApiOperationExample[];
+};
+export type ApiModuleOptions<Env = unknown> = {
+    prefix?: string;
+    operations: Record<string, ApiOperation<any, any, Env>>;
+    keys?: ApiKeyOptions;
+    docs?: {
+        enabled?: boolean;
+        title?: string;
+    };
+    admin?: {
+        enabled?: boolean;
+    };
+};
+export type ApiOperationSummary = {
+    name: string;
+    actionName: string;
+    method: ApiHttpMethod;
+    path: string;
+    scopes: string[];
+    summary: string;
+    description: string;
+    tags: string[];
+    inputSchema: JsonSchemaObject;
+    outputSchema?: JsonSchemaObject;
+    examples: ApiOperationExample[];
+};
+export declare function apiOperation<Input, Output, Env = unknown>(action: RaybaseAction<Input, Output, Env>, options: ApiOperationOptions<Input, Output> & {
+    handler?: never;
+}): ApiOperation<Input, Output, Env>;
+export declare function defineApiOperations<T extends Record<string, ApiOperation<any, any, any>>>(operations: T): T;
+export declare function apiKeyScopes(...scopes: string[]): string[];
+export declare function apiModule<Env = unknown>(options: ApiModuleOptions<Env>): RaybaseModule<Env>;
+export declare function operationSummaries<Env>(prefix: string, operations: Record<string, ApiOperation<any, any, Env>>): ApiOperationSummary[];
+export declare const defaultApiPrefix = "/api/v1";
+//# sourceMappingURL=api.d.ts.map

package/dist/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,EAmBL,KAAK,gBAAgB,EACrB,KAAK,aAAa,EAClB,KAAK,aAAa,EAGnB,MAAM,eAAe,CAAC;AACvB,OAAO,EAA6C,KAAK,aAAa,EAAE,MAAM,WAAW,CAAC;AAM1F,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAExE,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC;IACzC,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,aAAa,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,IAAI,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,mBAAmB,CAAC,KAAK,EAAE,MAAM,IAAI;IAC/C,MAAM,EAAE,aAAa,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,CAAC,EAAE;QACZ,MAAM,CAAC,EAAE,iBAAiB,CAAC;QAC3B,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,kBAAkB,KAAK,MAAM,CAAC;KACzD,CAAC;IACF,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,KAAK,CAAC;IACnD,iBAAiB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,mBAAmB,KAAK,OAAO,GAAG,qBAAqB,CAAC;IAClG,QAAQ,CAAC,EAAE,mBAAmB,EAAE,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,KAAK,GAAG,OAAO,EAAE,MAAM,GAAG,OAAO,EAAE,GAAG,GAAG,OAAO,IAAI;IAC3E,IAAI,EAAE,uBAAuB,CAAC;IAC9B,MAAM,EAAE,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1C,MAAM,EAAE,aAAa,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,WAAW,CAAC,EAAE,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC;IAChE,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,KAAK,CAAC;IACnD,iBAAiB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,mBAAmB,KAAK,OAAO,GAAG,qBAAqB,CAAC;IAClG,QAAQ,EAAE,mBAAmB,EAAE,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,gBAAgB,CAAC,GAAG,GAAG,OAAO,IAAI;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IACxD,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,IAAI,CAAC,EAAE;QACL,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,KAAK,CAAC,EAAE;QACN,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,aAAa,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,WAAW,EAAE,gBAAgB,CAAC;IAC9B,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,QAAQ,EAAE,mBAAmB,EAAE,CAAC;CACjC,CAAC;AAEF,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,GAAG,OAAO,EACvD,MAAM,EAAE,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EACzC,OAAO,EAAE,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,KAAK,CAAA;CAAE,GAChE,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAkBlC;AAED,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,GAAG,CAAC,CAG3G;AAED,wBAAgB,YAAY,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAE1D;AAED,wBAAgB,SAAS,CAAC,GAAG,GAAG,OAAO,EAAE,OAAO,EAAE,gBAAgB,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,CA+B3F;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EACpC,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,GACtD,mBAAmB,EAAE,CAcvB;AAED,eAAO,MAAM,gBAAgB,YAAY,CAAC"}