@m6d/cortex-cli 0.12.0 → 0.13.0

package/src/scaffold/templates/index.ts.txt

@@ -1,18 +0,0 @@
-import { createCortex } from "@m6d/cortex-server";
-import config from "./cortex.config";
-
-const cortex = createCortex(config);
-
-const server = await cortex.serve();
-
-// Your own routes hang off the same Hono app the agent runtime serves from:
-// server.app.get("/hello", function (c) {
-//     return c.text("hello");
-// });
-
-export default {
-    port: server.port,
-    fetch: server.fetch,
-    websocket: server.websocket,
-    idleTimeout: 0,
-};

package/src/swagger/extract-endpoints.ts

@@ -1,269 +0,0 @@
-import * as fs from "node:fs";
-import * as path from "node:path";
-import { isRecord } from "@cortex/contracts/json";
-import type { Endpoint, HttpMethod, Obj } from "./types";
-import { dedupe, deref, obj, pickContent, schemaType, toProp, toProps } from "./openapi-schema";
-import { parseResponse } from "./parse-response";
-import { withGeneratedBlock } from "./generated-block";
-
-type ExtractEndpointsOptions = {
-    swaggerUrls: string[];
-    domainsDir: string;
-    write: boolean;
-};
-
-const METHODS = ["GET", "POST", "PUT", "DELETE"] as const satisfies readonly HttpMethod[];
-
-/**
- * ASP.NET conventions the extractor normalizes away so an `.endpoint.ts` path
- * matches the spec whichever way the API was mounted: routes are keyed without
- * the `/api` prefix (either side may carry it), and `JsonNode`-typed query
- * parameters, which Swagger expands into `Root.Options`, `Root.Parent` and
- * `Root.Root` dot-paths, collapse back to one object parameter.
- */
-const API_PREFIX = /^\/api(?=\/|$)/i;
-const JSON_NODE_MEMBER = /^(Options|Parent|Root)\b/;
-
-function toCamelCase(s: string) {
-    return s
-        .split(".")
-        .map((seg) => seg.replace(/^[A-Z]/, (c) => c.toLowerCase()))
-        .join(".");
-}
-
-/** `Root` for a dotted parameter like `Root.Options`; undefined for a plain one. */
-function dottedRoot(name: string) {
-    const dot = name.indexOf(".");
-    return dot < 0 ? undefined : name.slice(0, dot);
-}
-
-function normalizePath(raw: string) {
-    let p = raw.startsWith("/") ? raw : `/${raw}`;
-    p = p.replace(/\{([^}:?]+)(?::[^}]+)?\??\}/g, "{$1}").replace(API_PREFIX, "") || "/";
-    return p.length > 1 ? p.replace(/\/+$/, "") : p;
-}
-
-function walkFiles(dir: string) {
-    if (!fs.existsSync(dir)) return [];
-    const out: string[] = [];
-    function walk(d: string) {
-        for (const e of fs.readdirSync(d, { withFileTypes: true })) {
-            const p = path.join(d, e.name);
-            if (e.isDirectory()) walk(p);
-            else out.push(p);
-        }
-    }
-    walk(dir);
-    return out;
-}
-
-/**
- * The `method` and `path` an endpoint file declares, read the way the server's
- * own file walk reads them.
- */
-export function declaredRoute(source: string) {
-    return {
-        method: source.match(/^\s*method:\s*(['"])([^'"]+)\1/m)?.[2],
-        path: source.match(/^\s*path:\s*(['"])([^'"]+)\1/m)?.[2],
-    };
-}
-
-function endpointFiles(root: string) {
-    const out = new Map<string, string>();
-    for (const filePath of walkFiles(root).filter((p) => p.endsWith(".endpoint.ts"))) {
-        const { method, path: route } = declaredRoute(fs.readFileSync(filePath, "utf8"));
-        if (method && route) out.set(`${method}:${normalizePath(route)}`, filePath);
-    }
-    return out;
-}
-
-/**
- * Path and query parameters, path-level first, with each `JsonNode` parameter
- * collapsed back to one object.
- */
-function extractParams(doc: unknown, pathItem: Obj, operation: Obj) {
-    const rawParams = [
-        ...(Array.isArray(pathItem.parameters) ? (pathItem.parameters as unknown[]) : []),
-        ...(Array.isArray(operation.parameters) ? (operation.parameters as unknown[]) : []),
-    ]
-        .map((param) => deref(doc, param))
-        .filter(
-            (param): param is Obj & { name: string; in: string } =>
-                typeof param.name === "string" &&
-                typeof param.in === "string" &&
-                ["path", "query"].includes(param.in),
-        );
-
-    const jsonNodeRoots = new Set<string>();
-    for (const { name } of rawParams) {
-        const root = dottedRoot(name);
-        if (root !== undefined && JSON_NODE_MEMBER.test(name.slice(root.length + 1))) {
-            jsonNodeRoots.add(root);
-        }
-    }
-
-    return dedupe(
-        rawParams
-            .filter((param) => {
-                const root = dottedRoot(param.name);
-                return root === undefined || !jsonNodeRoots.has(root);
-            })
-            .map((param) =>
-                toProp(
-                    doc,
-                    toCamelCase(param.name),
-                    param.schema,
-                    param.in === "path" || param.required === true,
-                ),
-            )
-            .concat(
-                [...jsonNodeRoots].map((root) => ({
-                    name: toCamelCase(root),
-                    required: false,
-                    type: "object",
-                })),
-            ),
-    );
-}
-
-/** An object body contributes its own fields; anything else is one `items` or `body` field. */
-function extractBody(doc: unknown, operation: Obj) {
-    const requestBody = deref(doc, operation.requestBody);
-    const content = pickContent(requestBody.content);
-    if (!content) return [];
-    const schema = deref(doc, content.schema);
-    const type = schemaType(schema);
-    if (type === "object") return toProps(doc, schema);
-    const name = type === "array" ? "items" : "body";
-    return [toProp(doc, name, schema, requestBody.required === true)];
-}
-
-function extractEndpoint(
-    doc: unknown,
-    route: string,
-    method: HttpMethod,
-    pathItem: Obj,
-    operation: Obj,
-) {
-    const normalizedPath = normalizePath(route);
-    return {
-        key: `${method}:${normalizedPath}`,
-        method,
-        path: normalizedPath,
-        params: extractParams(doc, pathItem, operation),
-        body: extractBody(doc, operation),
-        ...parseResponse(doc, operation.responses),
-    } satisfies Endpoint;
-}
-
-function parseSwaggerEndpoints(swagger: unknown) {
-    const out = new Map<string, Endpoint>();
-    const doc = obj(swagger);
-    for (const [route, pathItemIn] of Object.entries(obj(doc.paths))) {
-        const pathItem = obj(pathItemIn);
-        for (const method of METHODS) {
-            const operation = pathItem[method.toLowerCase()];
-            if (!isRecord(operation)) continue;
-            const endpoint = extractEndpoint(doc, route, method, pathItem, operation);
-            out.set(endpoint.key, endpoint);
-        }
-    }
-    return out;
-}
-
-function formatGeneratedFiles(filePaths: string[]) {
-    if (!filePaths.length) return;
-    try {
-        // Absolute paths: a relative domainsDir yields paths relative to the
-        // process cwd, which a prettier run elsewhere would resolve wrongly.
-        Bun.spawnSync(["bunx", "prettier", "--write", ...filePaths.map((p) => path.resolve(p))], {
-            stdio: ["ignore", "ignore", "ignore"],
-        });
-    } catch {
-        // Formatting is cosmetic; a missing prettier must not fail the run.
-    }
-}
-
-async function fetchJson(url: string) {
-    const response = await fetch(url, {
-        headers: { Accept: "application/json" },
-    });
-    if (!response.ok) {
-        throw new Error(`Swagger request failed (${response.status})`);
-    }
-    return response.json();
-}
-
-function resolveEndpoint(key: string, extracted: Map<string, Endpoint>) {
-    const [method, route] = key.split(":");
-    if (!method || !route) return undefined;
-    return (
-        extracted.get(key) ??
-        extracted.get(`${method}:${normalizePath(`/api${route}`)}`) ??
-        (route.startsWith("/api/")
-            ? extracted.get(`${method}:${normalizePath(route.slice(4))}`)
-            : undefined)
-    );
-}
-
-// The post-write prettier pass reformats generated blocks, so an exact string
-// compare would report freshly synced files as drift forever. Compare modulo
-// the axes prettier varies: quote style, whitespace, and trailing commas.
-function sameModuloFormatting(a: string, b: string) {
-    function norm(s: string) {
-        return s
-            .replace(/['"]/g, '"')
-            .replace(/\s+/g, "")
-            .replace(/,(?=[}\])])/g, "");
-    }
-    return norm(a) === norm(b);
-}
-
-export async function extractEndpoints(options: ExtractEndpointsOptions) {
-    const { swaggerUrls, domainsDir, write } = options;
-
-    // Merge every document first: a file missing from one swagger doc may be
-    // matched by another. Last write wins on duplicate keys, so per-agent docs
-    // deliberately override the server-level one (`swaggerUrls` lists it first).
-    const extracted = new Map<string, Endpoint>();
-    for (const swaggerUrl of swaggerUrls) {
-        for (const [key, endpoint] of parseSwaggerEndpoints(await fetchJson(swaggerUrl))) {
-            extracted.set(key, endpoint);
-        }
-    }
-
-    let matched = 0;
-    const missing: string[] = [];
-    const drift: string[] = [];
-    const updated: string[] = [];
-    const updatedFiles: string[] = [];
-
-    for (const [key, filePath] of endpointFiles(domainsDir).entries()) {
-        const relativePath = path.relative(domainsDir, filePath);
-        const endpoint = resolveEndpoint(key, extracted);
-        if (!endpoint) {
-            missing.push(relativePath);
-            continue;
-        }
-
-        const current = fs.readFileSync(filePath, "utf8");
-        const next = withGeneratedBlock(current, endpoint);
-        if (next === null || next === current || sameModuloFormatting(next, current)) {
-            matched++;
-            continue;
-        }
-
-        if (!write) {
-            drift.push(relativePath);
-            continue;
-        }
-
-        fs.writeFileSync(filePath, next);
-        updatedFiles.push(filePath);
-        updated.push(relativePath);
-    }
-
-    if (write) formatGeneratedFiles(updatedFiles);
-
-    return { matched, missing, drift, updated };
-}

package/src/swagger/generated-block.ts

@@ -1,74 +0,0 @@
-/**
- * Splicing the generated block into an endpoint definition the developer also edits
- * by hand. The markers are the contract: everything between them belongs to the
- * generator, everything outside is the developer's.
- */
-import type { Endpoint, Prop } from "./types";
-
-const AUTO_START = "// @auto-generated-start";
-const AUTO_END = "// @auto-generated-end";
-
-function serializeProps(props: Prop[], depth: number) {
-    return props
-        .map((p) => {
-            const indent = "    ".repeat(depth);
-            const childIndent = "    ".repeat(depth + 1);
-            const typeLiteral = p.type.includes("'")
-                ? `"${p.type.replace(/"/g, '\\"')}"`
-                : `'${p.type}'`;
-
-            const parts = [`name: '${p.name}'`, `required: ${p.required}`, `type: ${typeLiteral}`];
-            if (p.isArray) parts.push("isArray: true");
-            if (p.properties?.length)
-                parts.push(
-                    `properties: [\n${serializeProps(p.properties, depth + 1)}\n${childIndent}]`,
-                );
-
-            return `${indent}    { ${parts.join(", ")} },`;
-        })
-        .join("\n");
-}
-
-function blockFor(endpoint: Endpoint) {
-    return `    autoGenerated: {
-        params: [
-${serializeProps(endpoint.params, 2)}
-        ] as const,
-        body: [
-${serializeProps(endpoint.body, 2)}
-        ] as const,
-        response: [
-${serializeProps(endpoint.response, 2)}
-        ] as const,
-        successStatus: ${endpoint.successStatus},
-        errorStatuses: [${endpoint.errorStatuses.join(", ")}],
-        responseKind: '${endpoint.responseKind}',
-    } as const,`;
-}
-
-/**
- * Replaces the marked region when it exists, otherwise inserts one just inside the
- * closing `});`. Returns null when there is nowhere to put it, which means the file
- * is not shaped like an endpoint definition.
- */
-export function withGeneratedBlock(current: string, endpoint: Endpoint) {
-    const start = current.indexOf(AUTO_START);
-    const end = current.indexOf(AUTO_END);
-
-    if (start >= 0 && end > start) {
-        return (
-            current.slice(0, start + AUTO_START.length) +
-            `\n${blockFor(endpoint)}\n    ` +
-            current.slice(end)
-        );
-    }
-
-    const closingIndex = current.lastIndexOf("});");
-    if (closingIndex < 0) return null;
-
-    return (
-        current.slice(0, closingIndex) +
-        `\n  ${AUTO_START}\n${blockFor(endpoint)}\n    ${AUTO_END}\n});` +
-        current.slice(closingIndex + 3)
-    );
-}

package/src/swagger/openapi-schema.ts

@@ -1,168 +0,0 @@
-/**
- * Reading an OpenAPI document: following $ref, deciding a schema's type, and turning
- * a schema into the flat property list the generator emits. Nothing here knows what
- * the properties are for.
- */
-import { isRecord } from "@cortex/contracts/json";
-import type { Obj, Prop } from "./types";
-
-const MAX_DEPTH = 8;
-
-export function obj(v: unknown) {
-    return isRecord(v) ? v : {};
-}
-
-function strings(v: unknown) {
-    return Array.isArray(v) ? v.filter((x): x is string => typeof x === "string") : [];
-}
-
-/** The first prop of each name. */
-export function dedupe(items: Prop[]) {
-    const seen = new Set<string>();
-    return items.filter((prop) => {
-        if (seen.has(prop.name)) return false;
-        seen.add(prop.name);
-        return true;
-    });
-}
-
-function resolvePointer(doc: unknown, ref: string) {
-    if (!ref.startsWith("#/")) return null;
-    let cur: unknown = doc;
-    for (const part of ref.slice(2).split("/")) {
-        const key = part.replace(/~1/g, "/").replace(/~0/g, "~");
-        if (!isRecord(cur) || !(key in cur)) return null;
-        cur = cur[key];
-    }
-    return cur;
-}
-
-export function deref(doc: unknown, v: unknown) {
-    if (!isRecord(v)) return {};
-    let x = v;
-    const seen = new Set<string>();
-    while (typeof x.$ref === "string") {
-        if (seen.has(x.$ref)) return {};
-        seen.add(x.$ref);
-        x = obj(resolvePointer(doc, x.$ref));
-    }
-    return x;
-}
-
-export function schemaType(s: Obj) {
-    const t = Array.isArray(s.type)
-        ? (s.type as unknown[]).find((x) => typeof x === "string" && x !== "null")
-        : s.type;
-    if (typeof t === "string") return t;
-    if (isRecord(s.properties)) return "object";
-    if (isRecord(s.items)) return "array";
-    return "";
-}
-
-function isJsonNodeRef(v: unknown) {
-    return (
-        isRecord(v) &&
-        typeof v.$ref === "string" &&
-        /\/System\.Text\.Json\.Nodes\.JsonNode$/.test(v.$ref)
-    );
-}
-
-function isJsonNodeSchema(s: Obj) {
-    const p = obj(s.properties);
-    return (
-        schemaType(s) === "object" &&
-        "options" in p &&
-        "parent" in p &&
-        "root" in p &&
-        isJsonNodeRef(p.parent) &&
-        isJsonNodeRef(p.root)
-    );
-}
-
-function scalarType(s: Obj) {
-    if (Array.isArray(s.enum) && s.enum.every((v) => typeof v === "string")) {
-        return s.enum.map((v) => `'${String(v).replace(/'/g, "\\'")}'`).join(" | ");
-    }
-    const t = schemaType(s);
-    const f = typeof s.format === "string" ? s.format : "";
-    if (f === "uuid") return "uuid";
-    if (f === "date") return "date";
-    if (f === "date-time") return "datetime";
-    if (t === "integer" || t === "number") return "number";
-    if (t === "boolean") return "boolean";
-    if (t === "string") return "string";
-    if (t === "object") return "object";
-    return "unknown";
-}
-
-export function toProps(doc: unknown, schemaIn: unknown, depth = 0) {
-    if (depth > MAX_DEPTH) return [];
-    const s = deref(doc, schemaIn);
-    if (isJsonNodeRef(schemaIn) || isJsonNodeSchema(s)) return [];
-    const req = new Set(strings(s.required));
-    return dedupe(
-        Object.entries(obj(s.properties)).map(([name, child]) =>
-            toProp(doc, name, child, req.has(name), depth + 1),
-        ),
-    );
-}
-
-export function toProp(
-    doc: unknown,
-    name: string,
-    schemaIn: unknown,
-    required: boolean,
-    depth = 0,
-    // eslint-disable-next-line m6d/no-explicit-return-type -- mutually recursive with toProps, so the return type cannot be inferred
-): Prop {
-    if (isJsonNodeRef(schemaIn)) return { name, required, type: "object" };
-
-    const s = deref(doc, schemaIn);
-    const req = required && s.nullable !== true;
-
-    if (isJsonNodeSchema(s)) return { name, required: req, type: "object" };
-
-    const t = schemaType(s);
-    if (t === "array") {
-        const item = deref(doc, s.items);
-        if (schemaType(item) === "object") {
-            const properties = toProps(doc, item, depth + 1);
-            return {
-                name,
-                required: req,
-                type: "object",
-                isArray: true,
-                ...(properties.length ? { properties } : {}),
-            };
-        }
-        return { name, required: req, type: scalarType(item), isArray: true };
-    }
-
-    if (t === "object") {
-        const properties = toProps(doc, s, depth + 1);
-        return {
-            name,
-            required: req,
-            type: "object",
-            ...(properties.length ? { properties } : {}),
-        };
-    }
-
-    return { name, required: req, type: scalarType(s) };
-}
-
-/**
- * The schema under `application/json`, else any JSON type, else the first
- * type, along with every type offered.
- */
-export function pickContent(contentIn: unknown) {
-    const content = obj(contentIn);
-    const mimes = Object.keys(content);
-    const [first] = mimes;
-    if (first === undefined) return null;
-    const mime =
-        mimes.find((x) => x.toLowerCase() === "application/json") ??
-        mimes.find((x) => x.toLowerCase().includes("json")) ??
-        first;
-    return { schema: obj(content[mime]).schema, mimes };
-}

package/src/swagger/parse-response.ts

@@ -1,88 +0,0 @@
-/**
- * Deciding what an endpoint answers with: which statuses it uses, and what shape the
- * success body takes. The shape is what drives code generation, so a paged envelope
- * is reported as the rows it wraps rather than as its own page fields.
- */
-import type { Obj, Prop, ResponseKind } from "./types";
-import { deref, obj, pickContent, schemaType, toProp, toProps } from "./openapi-schema";
-
-type ResponseBody = { responseKind: ResponseKind; response: Prop[] };
-
-const NO_BODY = { responseKind: "none", response: [] } satisfies ResponseBody;
-
-const FILE_MIME = /(application\/octet-stream|application\/pdf|application\/vnd\.|text\/csv)/i;
-
-/** An object contributes its own fields; anything else stands as a single `item`. */
-function itemProps(doc: unknown, item: Obj) {
-    return schemaType(item) === "object" ? toProps(doc, item) : [toProp(doc, "item", item, true)];
-}
-
-function isFileResponse(mimes: string[], schema: Obj) {
-    if (mimes.some((mime) => FILE_MIME.test(mime))) return true;
-
-    return (
-        schemaType(schema) === "string" &&
-        typeof schema.format === "string" &&
-        ["binary", "base64"].includes(schema.format)
-    );
-}
-
-/** A paged envelope is described by the items it wraps, not by its own page fields. */
-function parseObjectBody(doc: unknown, schema: Obj) {
-    const props = obj(schema.properties);
-    const hasPaging = ["totalCount", "pageNumber", "pageSize", "totalPages"].some(
-        (k) => k in props,
-    );
-    const list = deref(doc, props.items ?? props.data ?? props.results);
-
-    if (hasPaging && schemaType(list) === "array") {
-        return {
-            responseKind: "paginated",
-            response: itemProps(doc, deref(doc, list.items)),
-        } satisfies ResponseBody;
-    }
-
-    return { responseKind: "object", response: toProps(doc, schema) } satisfies ResponseBody;
-}
-
-function parseResponseBody(doc: unknown, schema: Obj, mimes: string[]) {
-    if (isFileResponse(mimes, schema))
-        return { responseKind: "file", response: [] } satisfies ResponseBody;
-
-    const type = schemaType(schema);
-    if (type === "array") {
-        return {
-            responseKind: "array",
-            response: itemProps(doc, deref(doc, schema.items)),
-        } satisfies ResponseBody;
-    }
-    if (type === "object") return parseObjectBody(doc, schema);
-    if (Object.keys(schema).length) {
-        return {
-            responseKind: "object",
-            response: [toProp(doc, "value", schema, true)],
-        } satisfies ResponseBody;
-    }
-
-    return NO_BODY;
-}
-
-export function parseResponse(doc: unknown, responsesIn: unknown) {
-    const responses = obj(responsesIn);
-    const statuses = Object.keys(responses)
-        .map(Number)
-        .filter(Number.isInteger)
-        .sort((a, b) => a - b);
-    const successStatus = statuses.find((s) => s >= 200 && s < 300) ?? 200;
-    const errorStatuses = [...new Set(statuses.filter((s) => s >= 400))];
-
-    // 204 says there is no body at all, so there is nothing further to read.
-    if (successStatus === 204) return { successStatus, errorStatuses, ...NO_BODY };
-
-    const success = deref(doc, responses[String(successStatus)]);
-    const content = pickContent(success.content);
-    if (!content) return { successStatus, errorStatuses, ...NO_BODY };
-
-    const body = parseResponseBody(doc, deref(doc, content.schema), content.mimes);
-    return { successStatus, errorStatuses, ...body };
-}

package/src/swagger/types.ts

@@ -1,25 +0,0 @@
-/**
- * The shapes shared across endpoint extraction: what an OpenAPI document looks like
- * on the way in, and what one generated endpoint looks like on the way out.
- */
-export type HttpMethod = "GET" | "POST" | "PUT" | "DELETE";
-export type ResponseKind = "object" | "array" | "paginated" | "file" | "none";
-export type Obj = Record<string, unknown>;
-export type Prop = {
-    name: string;
-    required: boolean;
-    type: string;
-    isArray?: boolean;
-    properties?: Prop[];
-};
-export type Endpoint = {
-    key: string;
-    method: HttpMethod;
-    path: string;
-    params: Prop[];
-    body: Prop[];
-    response: Prop[];
-    responseKind: ResponseKind;
-    successStatus: number;
-    errorStatuses: number[];
-};