@m6d/cortex-cli 0.1.0

package/src/swagger/openapi-schema.ts

@@ -0,0 +1,161 @@
+/**
+ * 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 type { Obj, Prop } from "./types";
+
+const MAX_DEPTH = 8;
+
+export function isObj(v: unknown): v is Obj {
+    return typeof v === "object" && v !== null && !Array.isArray(v);
+}
+
+export function obj(v: unknown) {
+    return isObj(v) ? v : {};
+}
+
+function strings(v: unknown) {
+    return Array.isArray(v) ? v.filter((x): x is string => typeof x === "string") : [];
+}
+
+export function dedupe(items: Prop[]) {
+    const seen = new Set<string>();
+    return items.filter((x) => (seen.has(x.name) ? false : (seen.add(x.name), 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 (!isObj(cur) || !(key in cur)) return null;
+        cur = cur[key];
+    }
+    return cur;
+}
+
+export function deref(doc: unknown, v: unknown) {
+    if (!isObj(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 (isObj(s.properties)) return "object";
+    if (isObj(s.items)) return "array";
+    return "";
+}
+
+function isJsonNodeRef(v: unknown) {
+    return (
+        isObj(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) };
+}
+
+export function pickContent(contentIn: unknown) {
+    const content = obj(contentIn);
+    const mimes = Object.keys(content);
+    if (!mimes.length) return null;
+    const mime =
+        mimes.find((x) => x.toLowerCase() === "application/json") ??
+        mimes.find((x) => x.toLowerCase().includes("json")) ??
+        mimes[0];
+    return { schema: obj(content[mime!]).schema, mimes };
+}

package/src/swagger/parse-response.ts

@@ -0,0 +1,88 @@
+/**
+ * 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: ResponseBody = { responseKind: "none", response: [] };
+
+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

@@ -0,0 +1,25 @@
+/**
+ * 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[];
+};

package/src/ui/prompts.ts

@@ -0,0 +1,125 @@
+/**
+ * The only file that imports `@clack/prompts`. Clack signals Ctrl-C by
+ * *returning* a cancel symbol rather than throwing, so an unwrapped call reads
+ * an abandoned prompt as an answer and scaffolds the project the user just
+ * tried to escape. Every prompt goes through `orExit`, and the rest of the CLI
+ * reaches the library through this module or not at all.
+ */
+
+import {
+    cancel,
+    intro,
+    isCancel,
+    log,
+    multiselect,
+    outro,
+    password,
+    select,
+    spinner,
+    text,
+} from "@clack/prompts";
+
+import { FEATURES, type Feature } from "@/scaffold/features";
+import type { Database } from "@/scaffold/files";
+
+export { intro, log, outro };
+
+async function orExit<T>(answer: Promise<T | symbol>) {
+    const value = await answer;
+
+    if (isCancel(value)) {
+        cancel("Cancelled — nothing was written.");
+        process.exit(1);
+    }
+
+    return value;
+}
+
+/**
+ * Prompted only when the positional is omitted; it is the directory name too.
+ * What makes a name usable is the `new` command's to say — this asks, re-asks
+ * while `check` returns a complaint, and knows nothing else about names.
+ */
+export function askName(check: (name: string) => string | undefined) {
+    return orExit(
+        text({
+            message: "Project name",
+            placeholder: "my-app",
+            validate: function (value) {
+                const candidate = (value ?? "").trim();
+                if (candidate.length === 0) return "A project name is required.";
+                return check(candidate);
+            },
+        }),
+    );
+}
+
+/**
+ * The one structural pick: it changes a `cortex.config.ts` line and decides
+ * whether the generated compose file has a database service at all.
+ */
+export function askDatabase() {
+    return orExit(
+        select<Database>({
+            message: "Database",
+            initialValue: "postgres",
+            options: [
+                { value: "postgres", hint: "docker-compose.yml runs one for you" },
+                { value: "mssql", hint: "normally an existing external instance" },
+            ],
+        }),
+    );
+}
+
+/** One multi-select for the whole catalogue — minus anything a flag settled. */
+export function askFeatures(undecided: Feature[]) {
+    return orExit(
+        multiselect<Feature>({
+            message: "Which optional features?",
+            required: false,
+            options: undecided.map((feature) => ({ value: feature, hint: FEATURES[feature].hint })),
+        }),
+    );
+}
+
+/** A required value a command was not given: asked by name, re-asked while empty. */
+export function askValue(name: string, hint?: string) {
+    return orExit(
+        text({
+            message: name,
+            placeholder: hint,
+            validate: (value) =>
+                (value ?? "").trim().length === 0 ? `${name} is required.` : undefined,
+        }),
+    );
+}
+
+/** A credential: typed masked, never echoed. */
+export function askSecret(name: string) {
+    return orExit(
+        password({
+            message: name,
+            validate: (value) => ((value ?? "").length === 0 ? `${name} is required.` : undefined),
+        }),
+    );
+}
+
+type Step = { title: string; run: () => string | undefined | Promise<string | undefined> };
+
+/**
+ * Write, install, git init. The spinner only runs on a TTY: it redraws in place
+ * with cursor escapes, which is noise in a piped log, and the non-interactive
+ * transcript is plain `◇` lines. A step that returns nothing — `git init` is
+ * silent by design — leaves none.
+ */
+export async function runSteps(steps: Step[]) {
+    for (const step of steps) {
+        // `withGuide: false` because `log.step` writes the `│` between steps; the
+        // spinner adding its own leaves a doubled bar behind every silent step.
+        const spin = process.stdout.isTTY === true ? spinner({ withGuide: false }) : undefined;
+        spin?.start(step.title);
+        const done = await step.run();
+        spin?.clear();
+        if (done !== undefined) log.step(done);
+    }
+}

package/src/ui/report.ts

@@ -0,0 +1,107 @@
+/**
+ * The output grammar, shared by every command that runs against a project.
+ * The report layout is deliberately frozen; this file is the only
+ * place that knows the box characters.
+ */
+
+import { inspect } from "node:util";
+
+import pc from "picocolors";
+
+const BAR = pc.gray("│");
+
+function write(stream: NodeJS.WriteStream, lines: string[]) {
+    stream.write(`${lines.join("\n")}\n`);
+}
+
+/** Every block inside an error sits three spaces in, commands two further. */
+function indent(block: string) {
+    return block
+        .split("\n")
+        .map((line) => `   ${line}`)
+        .join("\n");
+}
+
+function describe(error: unknown) {
+    if (!(error instanceof Error)) return String(error);
+    return `${error.name}: ${error.message}`.split("\n")[0] ?? error.name;
+}
+
+// An error hugs whatever the run last printed, so it needs to know whether
+// anything opened the box above it.
+let open = false;
+
+/** `┌  cortex graph seed` — opens a run. */
+/** `1 node` / `3 nodes` — every count the box prints goes through this. */
+export function plural(count: number, noun: string) {
+    return `${count} ${noun}${count === 1 ? "" : "s"}`;
+}
+
+export function header(title: string) {
+    open = true;
+    write(process.stdout, ["", `${pc.gray("┌")}  ${title}`, BAR]);
+}
+
+/**
+ * A resolved input. These double as progress: whatever was printed last says how
+ * far the run got, which is most of the diagnosis when the next step fails.
+ */
+export function input(label: string, value: string) {
+    write(process.stdout, [`${pc.green("◇")}  ${label.padEnd(9)}  ${value}`]);
+}
+
+export function blank() {
+    write(process.stdout, [BAR]);
+}
+
+/**
+ * `│  updated   leaves/listLeaves.endpoint.ts` — a row in the body. An empty
+ * label indents to the same gutter, for the second line a finding gets. `width`
+ * is the label column: findings fit in 10, domain names need 14.
+ */
+export function row(label: string, text: string, width = 10) {
+    write(process.stdout, [`${BAR}  ${label.padEnd(width - 2)}  ${text}`]);
+}
+
+/** `└  87 nodes · 124 edges  (6.2s)` — closes a run. */
+export function footer(text: string) {
+    write(process.stdout, [`${pc.gray("└")}  ${text}`, ""]);
+}
+
+/** A paragraph below the box, for the one thing the reader has to act on. */
+export function note(text: string) {
+    write(process.stdout, [text, ""]);
+}
+
+/** A note beside machine-readable output: stderr, so `-o json | jq` stays valid. */
+export function aside(text: string) {
+    write(process.stderr, [text, ""]);
+}
+
+/**
+ * One error grammar: what happened → why → a runnable command. One line of the
+ * underlying error is kept — it is what gets pasted into a search — and the rest
+ * waits behind `--verbose`.
+ */
+export function fail(options: {
+    what: string;
+    blocks?: string[];
+    error?: unknown;
+    verbose?: boolean;
+}): never {
+    const { what, blocks = [], error, verbose = false } = options;
+    const parts = [`${pc.red("■")}  ${what}`];
+
+    if (error !== undefined) parts.push(indent(describe(error)));
+    parts.push(...blocks.map(indent));
+    if (error !== undefined) {
+        // `inspect` rather than `error.stack`: a Bun `fetch` failure carries no
+        // stack at all, and its `code` is the useful part.
+        parts.push(
+            indent(verbose ? inspect(error) : "Run with --verbose for the full stack trace."),
+        );
+    }
+
+    write(process.stderr, open ? [parts.join("\n\n"), ""] : ["", parts.join("\n\n"), ""]);
+    process.exit(1);
+}

package/tsconfig.json

@@ -0,0 +1,46 @@
+{
+    // Self-contained rather than extending @m6d/tsconfig/bun.json: this file ships
+    // in the tarball, where a private workspace package does not resolve.
+    "compilerOptions": {
+        // Environment setup & latest features
+        "lib": ["ESNext"],
+        // Named explicitly: auto-inclusion of @types/* is an editor-dependent
+        // heuristic, and `Bun`/`Response` come from here. See @cortex/contracts'
+        // tsconfig for the same fix.
+        "types": ["bun"],
+        "target": "ESNext",
+        "module": "Preserve",
+        "moduleDetection": "force",
+
+        // Bundler mode
+        "moduleResolution": "bundler",
+        "verbatimModuleSyntax": true,
+        "resolveJsonModule": true,
+        "noEmit": true,
+        "paths": {
+            // The graph contract is @cortex/contracts, a private workspace package
+            // that never publishes, so the CLI carries its own copy: `prepack`
+            // vendors it into src/contracts, where the first candidate finds it in
+            // the published tarball. Inside the repo that copy doesn't exist and
+            // resolution falls through to the workspace source.
+            "@cortex/contracts/*": ["./src/contracts/*", "../../internal/contracts/src/*"],
+            // Internal-only, and the reason this file ships in package.json `files`:
+            // the CLI runs as raw TypeScript from inside node_modules, so Bun has to
+            // read this config to resolve `@/`.
+            "@/*": ["./src/*"]
+        },
+
+        // Best practices
+        "strict": true,
+        "skipLibCheck": true,
+        "noFallthroughCasesInSwitch": true,
+        "noUncheckedIndexedAccess": true,
+        "noImplicitOverride": true,
+
+        // Some stricter flags (disabled by default)
+        "noUnusedLocals": false,
+        "noUnusedParameters": false,
+        "noPropertyAccessFromIndexSignature": false
+    },
+    "include": ["src/**/*.ts"]
+}