@intentius/sql-yodeler 0.0.0-stage → 0.2.0

package/dist/chant/drift.d.ts

@@ -0,0 +1,112 @@
+/**
+ * Drift: the declared objects whose live definition changed out of band, or
+ * that are gone from the server. Read from `chant lifecycle diff <env> --live
+ * --json`, the sql lexicon's section of it:
+ *
+ * - `deep.drifted[].changes[]`: a declared object whose live definition
+ *   differs, property by property, declared against live;
+ * - `resources.missing`: a declared object the server does not have;
+ * - `resources.unobserved` and `deep.unobserved`: a declared object chant
+ *   could not read (no credentials, a kind it cannot observe). Not drift, and
+ *   not clean either: that part of the environment is unknown.
+ *
+ * An object the project does not declare is never reported: chant only reads
+ * what the project declares, and only touches what carries its marker.
+ */
+import type { LiveDiffResult, UnobservedResource } from "@intentius/chant/lifecycle/live-diff";
+import type { DeepDiffResult, DeepEntityDrift } from "@intentius/chant/lifecycle/deep-diff";
+import { type Environment, type Project } from "../project.js";
+import { type ServerInfo } from "../server.js";
+import type { BuildOutput } from "./build.js";
+/** The `lexicons.sql` section of `chant lifecycle diff --live --json`. */
+export interface SqlLiveDiff {
+    resources?: LiveDiffResult;
+    deep?: DeepDiffResult;
+}
+export interface Drift {
+    environment: string;
+    /** Declared objects whose live definition differs from the declaration. */
+    changed: DeepEntityDrift[];
+    /** Declared objects the server does not have. */
+    missing: string[];
+    /** Declared objects chant could not read. */
+    unobserved: UnobservedResource[];
+    /** Postgres: a read gave up at the lock timeout, and what it waited on (#18). */
+    lockWait?: string | undefined;
+    /** Each changed table's declared column names, by position, so `columns[3]` reads as the column's name (#19). */
+    columns?: Record<string, string[]>;
+    /** What the server was compared with (#49): `src/`, or the schema the newest applied migration records. */
+    against?: DriftAgainst;
+}
+/**
+ * The declaration drift compares the server with: the project's `src/`,
+ * or the recorded schema of the newest migration the environment's history
+ * records as applied (`migration` null when none is applied yet).
+ */
+export type DriftAgainst = {
+    source: "src";
+} | {
+    source: "history";
+    migration: string | null;
+};
+/**
+ * A stable fingerprint of the drift: the environment and what drifted
+ * (each changed object's changes, declared and live, and the objects gone),
+ * order-free, so two reads of the same drift give the same one and a
+ * tracking issue updated with it changes only when the drift does. Objects
+ * that could not be read are not drift and are left out.
+ */
+export declare function driftFingerprint(drift: Drift): string;
+/**
+ * The recorded schema as declarations chant can build: one file, written
+ * by the sql lexicon's import generator from each object's DDL, each named
+ * by its export as the build named it. Written under the project directory,
+ * so the generated imports resolve from the project's node_modules, in a
+ * directory {@link RecordedSource.dispose} removes.
+ */
+export interface RecordedSource {
+    dir: string;
+    dispose: () => void;
+}
+export declare function writeRecordedSource(projectDir: string, schema: BuildOutput): Promise<RecordedSource>;
+/** Exit code: an owned object changed or is gone. */
+export declare const DRIFTED = 2;
+/** `2` on drift; `1` when there is none but part of the environment could not be read; `0` when clean. */
+export declare function driftExitCode(drift: Drift): number;
+/** The drift in a parsed `chant lifecycle diff --live --json` document. */
+export declare function driftFromLifecycle(environment: string, doc: unknown): Drift;
+/** Runs `chant lifecycle diff <env> --live --json` in the project and reads the drift from it. */
+export declare function readDrift(project: Project, env: Environment, options?: {
+    env?: NodeJS.ProcessEnv;
+    src?: string;
+}): Promise<Drift>;
+/**
+ * The declared column names of each changed object whose drift is named by
+ * column position (chant's ClickHouse tables keep columns as a list, so a
+ * change reads `columns[3].default.expr`). Read from the project's build,
+ * with the dialect's own tag, the way chant reads the declaration.
+ */
+export declare function declaredColumns(project: Project, drift: Drift, build: () => Promise<{
+    output: {
+        objects: Array<{
+            export: string;
+            ddl: string;
+        }>;
+    };
+    dispose: () => void;
+}>): Promise<Record<string, string[]>>;
+/** `columns[3].default.expr` as `column country: default.expr`, when the declaration names column 3. */
+export declare function describePath(path: string, columns: readonly string[] | undefined): string;
+/** What the server was compared with, in words. */
+export declare function describeAgainst(against: DriftAgainst | undefined): string | undefined;
+/** The drift as text. */
+export declare function renderDrift(drift: Drift, server?: ServerInfo): string;
+/**
+ * The drift as markdown, for the tracking issue: the environment and
+ * server, what it was compared with, each changed object with its changes,
+ * the objects gone, the run that found it, and the fingerprint.
+ */
+export declare function renderDriftMarkdown(drift: Drift, server: ServerInfo | undefined, extra: {
+    fingerprint: string;
+    run?: string;
+}): string;

package/dist/chant/drift.js

@@ -0,0 +1,238 @@
+/**
+ * Drift: the declared objects whose live definition changed out of band, or
+ * that are gone from the server. Read from `chant lifecycle diff <env> --live
+ * --json`, the sql lexicon's section of it:
+ *
+ * - `deep.drifted[].changes[]`: a declared object whose live definition
+ *   differs, property by property, declared against live;
+ * - `resources.missing`: a declared object the server does not have;
+ * - `resources.unobserved` and `deep.unobserved`: a declared object chant
+ *   could not read (no credentials, a kind it cannot observe). Not drift, and
+ *   not clean either: that part of the environment is unknown.
+ *
+ * An object the project does not declare is never reported: chant only reads
+ * what the project declares, and only touches what carries its marker.
+ */
+import { createHash } from "node:crypto";
+import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { YodelError } from "../project.js";
+import { lastJsonLine, runChant } from "./process.js";
+import { describeServer } from "../server.js";
+/**
+ * A stable fingerprint of the drift: the environment and what drifted
+ * (each changed object's changes, declared and live, and the objects gone),
+ * order-free, so two reads of the same drift give the same one and a
+ * tracking issue updated with it changes only when the drift does. Objects
+ * that could not be read are not drift and are left out.
+ */
+export function driftFingerprint(drift) {
+    const changed = drift.changed
+        .map((e) => ({
+        name: e.name,
+        type: e.type,
+        changes: e.changes.map((c) => ({ path: c.path, kind: c.kind, declared: c.declared ?? null, live: c.live ?? null })).sort((a, b) => JSON.stringify(a).localeCompare(JSON.stringify(b))),
+    }))
+        .sort((a, b) => a.name.localeCompare(b.name));
+    const subject = JSON.stringify({ environment: drift.environment, changed, missing: [...drift.missing].sort() });
+    return `sha256:${createHash("sha256").update(subject, "utf8").digest("hex")}`;
+}
+export async function writeRecordedSource(projectDir, schema) {
+    const { sqlTemplateGenerator } = await import("@intentius/chant-lexicon-sql/import-generator");
+    const resources = schema.objects.map((o) => {
+        const own = o;
+        const where = typeof own.database === "string" ? { database: own.database } : typeof own.schema === "string" ? { schema: own.schema } : {};
+        return { type: o.type ?? "", logicalId: o.export, properties: { ...where, name: typeof own.name === "string" ? own.name : o.export, ddl: o.ddl } };
+    });
+    const dir = mkdtempSync(join(projectDir, ".yodel-recorded-"));
+    const dispose = () => {
+        rmSync(dir, { recursive: true, force: true });
+    };
+    try {
+        for (const f of resources.length === 0 ? [] : sqlTemplateGenerator.generate({ resources, parameters: [] })) {
+            const path = join(dir, f.path);
+            mkdirSync(dirname(path), { recursive: true });
+            writeFileSync(path, f.content);
+        }
+    }
+    catch (e) {
+        dispose();
+        throw new YodelError(`the recorded schema could not be written as declarations: ${e instanceof Error ? e.message : String(e)}`);
+    }
+    return { dir, dispose };
+}
+/** Exit code: an owned object changed or is gone. */
+export const DRIFTED = 2;
+/** `2` on drift; `1` when there is none but part of the environment could not be read; `0` when clean. */
+export function driftExitCode(drift) {
+    if (drift.changed.length > 0 || drift.missing.length > 0)
+        return DRIFTED;
+    return drift.unobserved.length > 0 ? 1 : 0;
+}
+/** The drift in a parsed `chant lifecycle diff --live --json` document. */
+export function driftFromLifecycle(environment, doc) {
+    const lexicons = doc?.lexicons;
+    if (!lexicons) {
+        const stacks = doc?.stacks;
+        throw new YodelError(stacks
+            ? "chant lifecycle diff reported per stack; a yodel project is one database and one stack"
+            : "chant lifecycle diff --json printed no lexicons");
+    }
+    const sql = lexicons.sql ?? {};
+    const unobserved = new Map();
+    for (const u of [...(sql.resources?.unobserved ?? []), ...(sql.deep?.unobserved ?? [])]) {
+        if (!unobserved.has(u.name))
+            unobserved.set(u.name, u);
+    }
+    return {
+        environment,
+        changed: (sql.deep?.drifted ?? []).filter((d) => d.changes.length > 0),
+        missing: [...(sql.resources?.missing ?? [])].sort(),
+        unobserved: [...unobserved.values()].sort((a, b) => a.name.localeCompare(b.name)),
+    };
+}
+/** Runs `chant lifecycle diff <env> --live --json` in the project and reads the drift from it. */
+export async function readDrift(project, env, options = {}) {
+    const result = await runChant(["lifecycle", "diff", env.name, "--live", "--json", ...(options.src ? ["--src", options.src] : [])], {
+        cwd: project.dir,
+        ...(options.env ? { env: options.env } : {}),
+    });
+    const doc = lastJsonLine(result.stdout);
+    if (result.code !== 0 || doc === undefined) {
+        const detail = (result.stderr || result.stdout).trim();
+        throw new YodelError(`chant lifecycle diff ${env.name} --live failed (exit ${String(result.code)})${detail ? `:\n${detail}` : ""}`);
+    }
+    return driftFromLifecycle(env.name, doc);
+}
+const COLUMN_PATH = /^columns\[(\d+)\]/;
+/**
+ * The declared column names of each changed object whose drift is named by
+ * column position (chant's ClickHouse tables keep columns as a list, so a
+ * change reads `columns[3].default.expr`). Read from the project's build,
+ * with the dialect's own tag, the way chant reads the declaration.
+ */
+export async function declaredColumns(project, drift, build) {
+    const wanted = new Set(drift.changed.filter((e) => e.changes.some((c) => COLUMN_PATH.test(c.path))).map((e) => e.name));
+    if (wanted.size === 0)
+        return {};
+    const b = await build();
+    try {
+        const tag = project.dialect === "postgres"
+            ? (await import("@intentius/chant-lexicon-sql/postgres/entities")).table
+            : (await import("@intentius/chant-lexicon-sql/clickhouse/entities")).table;
+        const out = {};
+        for (const o of b.output.objects) {
+            if (!wanted.has(o.export))
+                continue;
+            try {
+                const strings = Object.assign([o.ddl], { raw: [o.ddl] });
+                const columns = tag(strings).props.columns;
+                if (Array.isArray(columns))
+                    out[o.export] = columns.map((c) => { const n = c.name; return typeof n === "string" ? n : ""; });
+            }
+            catch {
+                // Not a table this tag reads: its paths stay as chant gives them.
+            }
+        }
+        return out;
+    }
+    finally {
+        b.dispose();
+    }
+}
+/** `columns[3].default.expr` as `column country: default.expr`, when the declaration names column 3. */
+export function describePath(path, columns) {
+    const m = COLUMN_PATH.exec(path);
+    const name = m && columns ? columns[Number(m[1])] : undefined;
+    if (!m || !name)
+        return path;
+    const rest = path.slice(m[0].length).replace(/^\./, "");
+    return `column ${name}${rest ? ` ${rest}` : ""}`;
+}
+const show = (v) => (v === undefined ? "(none)" : typeof v === "string" ? v : JSON.stringify(v));
+/** What the server was compared with, in words. */
+export function describeAgainst(against) {
+    if (!against)
+        return undefined;
+    if (against.source === "src")
+        return "Compared with the declared schema in src/.";
+    return against.migration
+        ? `Compared with the schema ${against.migration} records, the newest migration the history records as applied.`
+        : "No migration is applied yet, so the history records no schema to compare with.";
+}
+/** The drift as text. */
+export function renderDrift(drift, server) {
+    const lines = [`Drift in ${drift.environment}${server ? ` (${describeServer(server)})` : ""}`, ""];
+    const against = describeAgainst(drift.against);
+    if (against)
+        lines.push(against, "");
+    if (drift.changed.length === 0 && drift.missing.length === 0) {
+        lines.push(drift.unobserved.length > 0 ? "No drift in the declared objects that could be read." : "No drift: every declared object matches the server.");
+    }
+    if (drift.changed.length > 0) {
+        lines.push("Changed out of band:");
+        for (const e of drift.changed) {
+            lines.push(`  ${e.name} (${e.type})`);
+            for (const c of e.changes) {
+                const path = describePath(c.path, drift.columns?.[e.name]);
+                lines.push(c.kind === "absent" ? `    ${path}: declared ${show(c.declared)}, absent live` : `    ${path}: declared ${show(c.declared)}, live ${show(c.live)}`);
+            }
+        }
+    }
+    if (drift.missing.length > 0) {
+        if (drift.changed.length > 0)
+            lines.push("");
+        lines.push("Gone (declared, not on the server):");
+        for (const name of drift.missing)
+            lines.push(`  ${name}`);
+    }
+    if (drift.unobserved.length > 0) {
+        lines.push("", "Could not be read, so their state is unknown:");
+        for (const u of drift.unobserved)
+            lines.push(`  ${u.name}: ${u.reason}${u.detail ? ` (${u.detail})` : ""}`);
+        if (drift.lockWait)
+            lines.push("", `The read ${drift.lockWait}.`);
+    }
+    return `${lines.join("\n")}\n`;
+}
+const code = (v) => `\`${show(v).replace(/`/g, "'")}\``;
+/**
+ * The drift as markdown, for the tracking issue: the environment and
+ * server, what it was compared with, each changed object with its changes,
+ * the objects gone, the run that found it, and the fingerprint.
+ */
+export function renderDriftMarkdown(drift, server, extra) {
+    const lines = [`**${drift.environment}**${server ? ` (${describeServer(server)})` : ""} has drifted: declared objects were changed out of band, or are gone.`, ""];
+    const against = describeAgainst(drift.against);
+    if (against)
+        lines.push(against, "");
+    if (drift.changed.length > 0) {
+        lines.push("Changed out of band:", "");
+        for (const e of drift.changed) {
+            lines.push(`- \`${e.name}\` (${e.type})`);
+            for (const c of e.changes) {
+                const path = describePath(c.path, drift.columns?.[e.name]);
+                lines.push(c.kind === "absent" ? `  - ${path}: declared ${code(c.declared)}, absent live` : `  - ${path}: declared ${code(c.declared)}, live ${code(c.live)}`);
+            }
+        }
+        lines.push("");
+    }
+    if (drift.missing.length > 0) {
+        lines.push("Gone (declared, not on the server):", "");
+        for (const name of drift.missing)
+            lines.push(`- \`${name}\``);
+        lines.push("");
+    }
+    if (drift.unobserved.length > 0) {
+        lines.push("Could not be read, so their state is unknown:", "");
+        for (const u of drift.unobserved)
+            lines.push(`- \`${u.name}\`: ${u.reason}`);
+        lines.push("");
+    }
+    lines.push(`Run \`yodel drift ${drift.environment}\` to see it again. yodel closes this issue when the drift is gone.`);
+    if (extra.run)
+        lines.push("", `Found by ${extra.run}`);
+    lines.push("", `<sub>drift fingerprint ${extra.fingerprint}</sub>`);
+    return `${lines.join("\n")}\n`;
+}
+//# sourceMappingURL=drift.js.map

package/dist/chant/drift.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"drift.js","sourceRoot":"","sources":["../../src/chant/drift.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAG1C,OAAO,EAAE,UAAU,EAAkC,MAAM,eAAe,CAAC;AAC3E,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,cAAc,EAAmB,MAAM,cAAc,CAAC;AAgC/D;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAY;IAC3C,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO;SAC1B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACX,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,IAAI,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;KACvL,CAAC,CAAC;SACF,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAChD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAChH,OAAO,UAAU,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;AAChF,CAAC;AAcD,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,UAAkB,EAAE,MAAmB;IAC/E,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,MAAM,CAAC,+CAA+C,CAAC,CAAC;IAC/F,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACzC,MAAM,GAAG,GAAG,CAAwE,CAAC;QACrF,MAAM,KAAK,GAAG,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3I,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,IAAI,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC;IACrJ,CAAC,CAAC,CAAC;IACH,MAAM,GAAG,GAAG,WAAW,CAAC,IAAI,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAC9D,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,MAAM,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAChD,CAAC,CAAC;IACF,IAAI,CAAC;QACH,KAAK,MAAM,CAAC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,oBAAoB,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC;YAC3G,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;YAC/B,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC9C,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,EAAE,CAAC;QACV,MAAM,IAAI,UAAU,CAAC,6DAA6D,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAClI,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC;AAC1B,CAAC;AAED,qDAAqD;AACrD,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC;AAEzB,0GAA0G;AAC1G,MAAM,UAAU,aAAa,CAAC,KAAY;IACxC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,OAAO,CAAC;IACzE,OAAO,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7C,CAAC;AAED,2EAA2E;AAC3E,MAAM,UAAU,kBAAkB,CAAC,WAAmB,EAAE,GAAY;IAClE,MAAM,QAAQ,GAAI,GAA8D,EAAE,QAAQ,CAAC;IAC3F,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,MAAM,GAAI,GAAwC,EAAE,MAAM,CAAC;QACjE,MAAM,IAAI,UAAU,CAClB,MAAM;YACJ,CAAC,CAAC,wFAAwF;YAC1F,CAAC,CAAC,iDAAiD,CACtD,CAAC;IACJ,CAAC;IACD,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,IAAI,EAAE,CAAC;IAC/B,MAAM,UAAU,GAAG,IAAI,GAAG,EAA8B,CAAC;IACzD,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,UAAU,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;QACxF,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;YAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACzD,CAAC;IACD,OAAO;QACL,WAAW;QACX,OAAO,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;QACtE,OAAO,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE;QACnD,UAAU,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;KAClF,CAAC;AACJ,CAAC;AAED,kGAAkG;AAClG,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,OAAgB,EAAE,GAAgB,EAAE,UAAqD,EAAE;IACzH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;QACjI,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC7C,CAAC,CAAC;IACH,MAAM,GAAG,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACxC,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QAC3C,MAAM,MAAM,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;QACvD,MAAM,IAAI,UAAU,CAAC,wBAAwB,GAAG,CAAC,IAAI,wBAAwB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACtI,CAAC;IACD,OAAO,kBAAkB,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAC3C,CAAC;AAED,MAAM,WAAW,GAAG,mBAAmB,CAAC;AAExC;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAAgB,EAAE,KAAY,EAAE,KAA0G;IAC9K,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACxH,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACjC,MAAM,CAAC,GAAG,MAAM,KAAK,EAAE,CAAC;IACxB,IAAI,CAAC;QACH,MAAM,GAAG,GACP,OAAO,CAAC,OAAO,KAAK,UAAU;YAC5B,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,gDAAgD,CAAC,CAAC,CAAC,KAAK;YACxE,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,kDAAkD,CAAC,CAAC,CAAC,KAAK,CAAC;QAC/E,MAAM,GAAG,GAA6B,EAAE,CAAC;QACzC,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACjC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC;gBAAE,SAAS;YACpC,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAoC,CAAC;gBAC5F,MAAM,OAAO,GAAI,GAAG,CAAC,OAAO,CAAC,CAAC,KAA+B,CAAC,OAAO,CAAC;gBACtE,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;oBAAE,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,GAAI,CAAwB,CAAC,IAAI,CAAC,CAAC,OAAO,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YACvJ,CAAC;YAAC,MAAM,CAAC;gBACP,kEAAkE;YACpE,CAAC;QACH,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;YAAS,CAAC;QACT,CAAC,CAAC,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC;AAED,wGAAwG;AACxG,MAAM,UAAU,YAAY,CAAC,IAAY,EAAE,OAAsC;IAC/E,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjC,MAAM,IAAI,GAAG,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9D,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACxD,OAAO,UAAU,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;AACnD,CAAC;AAED,MAAM,IAAI,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAE1G,mDAAmD;AACnD,MAAM,UAAU,eAAe,CAAC,OAAiC;IAC/D,IAAI,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IAC/B,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK;QAAE,OAAO,4CAA4C,CAAC;IAClF,OAAO,OAAO,CAAC,SAAS;QACtB,CAAC,CAAC,4BAA4B,OAAO,CAAC,SAAS,gEAAgE;QAC/G,CAAC,CAAC,gFAAgF,CAAC;AACvF,CAAC;AAED,yBAAyB;AACzB,MAAM,UAAU,WAAW,CAAC,KAAY,EAAE,MAAmB;IAC3D,MAAM,KAAK,GAAa,CAAC,YAAY,KAAK,CAAC,WAAW,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC7G,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC/C,IAAI,OAAO;QAAE,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACrC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7D,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,sDAAsD,CAAC,CAAC,CAAC,qDAAqD,CAAC,CAAC;IAC3J,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACnC,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAC9B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC;YACtC,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;gBAC1B,MAAM,IAAI,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC3D,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,IAAI,cAAc,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,IAAI,cAAc,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACjK,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7C,KAAK,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;QAClD,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,OAAO;YAAE,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IAC5D,CAAC;IACD,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,+CAA+C,CAAC,CAAC;QAChE,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,UAAU;YAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5G,IAAI,KAAK,CAAC,QAAQ;YAAE,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,YAAY,KAAK,CAAC,QAAQ,GAAG,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED,MAAM,IAAI,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC;AAEjE;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAY,EAAE,MAA8B,EAAE,KAA4C;IAC5H,MAAM,KAAK,GAAa,CAAC,KAAK,KAAK,CAAC,WAAW,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,uEAAuE,EAAE,EAAE,CAAC,CAAC;IAC7K,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC/C,IAAI,OAAO;QAAE,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACrC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,KAAK,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;QACvC,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAC9B,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC;YAC1C,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;gBAC1B,MAAM,IAAI,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC3D,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,IAAI,cAAc,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,IAAI,cAAc,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACjK,CAAC;QACH,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,KAAK,CAAC,IAAI,CAAC,qCAAqC,EAAE,EAAE,CAAC,CAAC;QACtD,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,OAAO;YAAE,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC;QAC9D,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,KAAK,CAAC,IAAI,CAAC,+CAA+C,EAAE,EAAE,CAAC,CAAC;QAChE,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,UAAU;YAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7E,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,qBAAqB,KAAK,CAAC,WAAW,qEAAqE,CAAC,CAAC;IACxH,IAAI,KAAK,CAAC,GAAG;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,YAAY,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC;IACvD,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,0BAA0B,KAAK,CAAC,WAAW,QAAQ,CAAC,CAAC;IACpE,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC"}

package/dist/chant/plan.d.ts

@@ -0,0 +1,45 @@
+/**
+ * The plan: the classified change from an environment's live database to the
+ * declared schema. This is `chant sql plan <env> <build>`, called as the
+ * library functions that command runs (`planAgainstServer` for ClickHouse,
+ * `planPgAgainstServer` for Postgres) rather than through the CLI.
+ */
+import type { SchemaDiff } from "@intentius/chant-lexicon-sql/clickhouse/plan/diff";
+import type { PgSchemaDiff } from "@intentius/chant-lexicon-sql/postgres/plan/diff";
+import type { ClassifiedChange } from "@intentius/chant-lexicon-sql/core/classifier";
+import { type Environment, type Project, type SqlDialect } from "../project.js";
+import type { Build } from "./build.js";
+/** A plan for one environment, in either dialect. */
+export interface Plan {
+    environment: string;
+    dialect: SqlDialect;
+    /** chant's own diff, as `chant sql plan --json` prints it. */
+    diff: SchemaDiff | PgSchemaDiff;
+    /**
+     * The changes the plan refuses to make in place, each of which needs its
+     * own Op: a ClickHouse rebuild (`rebuilds`, run as `ClickHouseRebuildOp`)
+     * or a Postgres expand-and-contract change (`refused`, run as
+     * `PostgresMigrationOp`).
+     */
+    refused: ClassifiedChange[];
+}
+/** Exit code: the plan has a change that needs a rebuild (or expand-and-contract) Op. */
+export declare const PLAN_NEEDS_OP = 2;
+/** `2` when any change needs its own Op, `0` otherwise. */
+export declare function planExitCode(plan: Plan): number;
+/**
+ * The changes to objects the build declares. A plan also lists live objects
+ * the project does not declare, as drops; an ApplyOp never touches those
+ * (it only prunes objects carrying chant's marker), so they are not work
+ * left for apply. chant labels a declared object `<export> (<name>)` and an
+ * undeclared one by its name alone.
+ */
+export declare function declaredChanges(plan: Plan, build: Build): ClassifiedChange[];
+/** The plan as `yodel plan --json` prints it: chant's diff, with the environment and dialect it is of. */
+export declare function planJson(plan: Plan): Record<string, unknown>;
+/** Plans `build` against the server `sql.profiles.<env>` binds. */
+export declare function planEnvironment(project: Project, env: Environment, build: Build, options?: {
+    env?: NodeJS.ProcessEnv;
+}): Promise<Plan>;
+/** The plan as text, chant's own report for the dialect. */
+export declare function renderPlan(plan: Plan, title: string): Promise<string>;

package/dist/chant/plan.js

@@ -0,0 +1,61 @@
+/**
+ * The plan: the classified change from an environment's live database to the
+ * declared schema. This is `chant sql plan <env> <build>`, called as the
+ * library functions that command runs (`planAgainstServer` for ClickHouse,
+ * `planPgAgainstServer` for Postgres) rather than through the CLI.
+ */
+import { YodelError } from "../project.js";
+/** Exit code: the plan has a change that needs a rebuild (or expand-and-contract) Op. */
+export const PLAN_NEEDS_OP = 2;
+/** `2` when any change needs its own Op, `0` otherwise. */
+export function planExitCode(plan) {
+    return plan.refused.length > 0 ? PLAN_NEEDS_OP : 0;
+}
+/**
+ * The changes to objects the build declares. A plan also lists live objects
+ * the project does not declare, as drops; an ApplyOp never touches those
+ * (it only prunes objects carrying chant's marker), so they are not work
+ * left for apply. chant labels a declared object `<export> (<name>)` and an
+ * undeclared one by its name alone.
+ */
+export function declaredChanges(plan, build) {
+    const exports = new Set(build.output.objects.map((o) => o.export));
+    return plan.diff.changes.filter((c) => {
+        const at = c.object.indexOf(" (");
+        return at > 0 && c.object.endsWith(")") && exports.has(c.object.slice(0, at));
+    });
+}
+/** The plan as `yodel plan --json` prints it: chant's diff, with the environment and dialect it is of. */
+export function planJson(plan) {
+    return { environment: plan.environment, dialect: plan.dialect, ...plan.diff };
+}
+function bindError(e) {
+    return new YodelError(e instanceof Error ? e.message : String(e));
+}
+/** Plans `build` against the server `sql.profiles.<env>` binds. */
+export async function planEnvironment(project, env, build, options = {}) {
+    const bind = { config: project.config, cwd: project.dir, ...(options.env ? { env: options.env } : {}) };
+    try {
+        if (project.dialect === "postgres") {
+            const { planPgAgainstServer } = await import("@intentius/chant-lexicon-sql/postgres/plan/commands");
+            const diff = await planPgAgainstServer(env.name, build.path, bind);
+            return { environment: env.name, dialect: "postgres", diff, refused: diff.refused };
+        }
+        const { planAgainstServer } = await import("@intentius/chant-lexicon-sql/clickhouse/plan/commands");
+        const diff = await planAgainstServer(env.name, build.path, bind);
+        return { environment: env.name, dialect: "clickhouse", diff, refused: diff.rebuilds };
+    }
+    catch (e) {
+        throw bindError(e);
+    }
+}
+/** The plan as text, chant's own report for the dialect. */
+export async function renderPlan(plan, title) {
+    if (plan.dialect === "postgres") {
+        const { renderPgDiff } = await import("@intentius/chant-lexicon-sql/postgres/plan/report");
+        return renderPgDiff(plan.diff, { title });
+    }
+    const { renderDiff } = await import("@intentius/chant-lexicon-sql/clickhouse/plan/report");
+    return renderDiff(plan.diff, { title });
+}
+//# sourceMappingURL=plan.js.map

package/dist/chant/plan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.js","sourceRoot":"","sources":["../../src/chant/plan.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,OAAO,EAAE,UAAU,EAAmD,MAAM,eAAe,CAAC;AAkB5F,yFAAyF;AACzF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC;AAE/B,2DAA2D;AAC3D,MAAM,UAAU,YAAY,CAAC,IAAU;IACrC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;AACrD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAC,IAAU,EAAE,KAAY;IACtD,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IACnE,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;QACpC,MAAM,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAClC,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAChF,CAAC,CAAC,CAAC;AACL,CAAC;AAED,0GAA0G;AAC1G,MAAM,UAAU,QAAQ,CAAC,IAAU;IACjC,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;AAChF,CAAC;AAED,SAAS,SAAS,CAAC,CAAU;IAC3B,OAAO,IAAI,UAAU,CAAC,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AACpE,CAAC;AAED,mEAAmE;AACnE,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAAgB,EAAE,GAAgB,EAAE,KAAY,EAAE,UAAuC,EAAE;IAC/H,MAAM,IAAI,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,MAAe,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IACjH,IAAI,CAAC;QACH,IAAI,OAAO,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;YACnC,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,MAAM,CAAC,qDAAqD,CAAC,CAAC;YACpG,MAAM,IAAI,GAAG,MAAM,mBAAmB,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACnE,OAAO,EAAE,WAAW,EAAE,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;QACrF,CAAC;QACD,MAAM,EAAE,iBAAiB,EAAE,GAAG,MAAM,MAAM,CAAC,uDAAuD,CAAC,CAAC;QACpG,MAAM,IAAI,GAAG,MAAM,iBAAiB,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACjE,OAAO,EAAE,WAAW,EAAE,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;IACxF,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC;AACH,CAAC;AAED,4DAA4D;AAC5D,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,IAAU,EAAE,KAAa;IACxD,IAAI,IAAI,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,MAAM,CAAC,mDAAmD,CAAC,CAAC;QAC3F,OAAO,YAAY,CAAC,IAAI,CAAC,IAAoB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC5D,CAAC;IACD,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,qDAAqD,CAAC,CAAC;IAC3F,OAAO,UAAU,CAAC,IAAI,CAAC,IAAkB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;AACxD,CAAC"}

package/dist/chant/process.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Running the `chant` CLI that yodel depends on, for the commands that have
+ * no library surface (`build`, `run`, `lifecycle diff`).
+ *
+ * Published chant ships TypeScript source, and its own bin runs
+ * `node --import <tsx loader> src/cli/main.ts`. yodel does the same with its
+ * own copy of tsx, so the chant it runs is the one in its own dependencies,
+ * not whatever `chant` is first on PATH. That chant's `bin/` goes first on the
+ * child's PATH, because chant's Op activities shell out to `chant` themselves
+ * (`lifecycleDiff` runs `chant lifecycle diff`).
+ */
+export interface ChantInstall {
+    /** The `@intentius/chant` package directory. */
+    root: string;
+    /** Its CLI entry, `src/cli/main.ts`. */
+    main: string;
+    /** Its `bin/`, which holds the `chant` script. */
+    bin: string;
+    /** The tsx loader to run it under, as a file URL. */
+    loader: string;
+}
+/** Where yodel's chant and tsx are installed. */
+export declare function chantInstall(): ChantInstall;
+export interface ChantResult {
+    code: number;
+    stdout: string;
+    stderr: string;
+}
+export interface RunChantOptions {
+    cwd: string;
+    env?: NodeJS.ProcessEnv;
+    /** Called with each chunk as it arrives, for output a person watches (an Op run). */
+    onStdout?: (text: string) => void;
+    onStderr?: (text: string) => void;
+}
+/** The environment a chant child runs with: the caller's, with chant's bin first on PATH. */
+export declare function chantEnv(base?: NodeJS.ProcessEnv): NodeJS.ProcessEnv;
+/** Runs `chant <args>` in `cwd` and resolves with its exit code and output. Never rejects on a non-zero exit. */
+export declare function runChant(args: readonly string[], options: RunChantOptions): Promise<ChantResult>;
+/** The last line of `stdout` that parses as a JSON object: chant prints its `--json` document as one line, after any log lines. */
+export declare function lastJsonLine(stdout: string): unknown;

package/dist/chant/process.js

@@ -0,0 +1,87 @@
+/**
+ * Running the `chant` CLI that yodel depends on, for the commands that have
+ * no library surface (`build`, `run`, `lifecycle diff`).
+ *
+ * Published chant ships TypeScript source, and its own bin runs
+ * `node --import <tsx loader> src/cli/main.ts`. yodel does the same with its
+ * own copy of tsx, so the chant it runs is the one in its own dependencies,
+ * not whatever `chant` is first on PATH. That chant's `bin/` goes first on the
+ * child's PATH, because chant's Op activities shell out to `chant` themselves
+ * (`lifecycleDiff` runs `chant lifecycle diff`).
+ */
+import { spawn } from "node:child_process";
+import { createRequire } from "node:module";
+import { dirname, delimiter, join } from "node:path";
+import { pathToFileURL } from "node:url";
+let install;
+/** Where yodel's chant and tsx are installed. */
+export function chantInstall() {
+    if (install)
+        return install;
+    const require = createRequire(import.meta.url);
+    // "." resolves to <root>/src/index.ts; package.json is not an export.
+    const root = dirname(dirname(require.resolve("@intentius/chant")));
+    install = {
+        root,
+        main: join(root, "src", "cli", "main.ts"),
+        bin: join(root, "bin"),
+        loader: pathToFileURL(require.resolve("tsx")).href,
+    };
+    return install;
+}
+/** The environment a chant child runs with: the caller's, with chant's bin first on PATH. */
+export function chantEnv(base = process.env) {
+    const { bin } = chantInstall();
+    return { ...base, PATH: [bin, base.PATH ?? ""].filter(Boolean).join(delimiter), FORCE_COLOR: "0", NO_COLOR: "1" };
+}
+/** Runs `chant <args>` in `cwd` and resolves with its exit code and output. Never rejects on a non-zero exit. */
+export function runChant(args, options) {
+    const { main, loader } = chantInstall();
+    return new Promise((resolvePromise, reject) => {
+        const child = spawn(process.execPath, ["--import", loader, main, ...args], {
+            cwd: options.cwd,
+            env: chantEnv(options.env),
+            stdio: ["ignore", "pipe", "pipe"],
+        });
+        let stdout = "";
+        let stderr = "";
+        child.stdout.setEncoding("utf8");
+        child.stderr.setEncoding("utf8");
+        child.stdout.on("data", (chunk) => {
+            stdout += chunk;
+            options.onStdout?.(chunk);
+        });
+        child.stderr.on("data", (chunk) => {
+            stderr += chunk;
+            options.onStderr?.(chunk);
+        });
+        child.on("error", reject);
+        child.on("close", (code, signal) => {
+            resolvePromise({ code: code ?? (signal ? 128 : 1), stdout, stderr });
+        });
+    });
+}
+/** The last line of `stdout` that parses as a JSON object: chant prints its `--json` document as one line, after any log lines. */
+export function lastJsonLine(stdout) {
+    const lines = stdout.split("\n").map((l) => l.trim()).filter((l) => l.startsWith("{"));
+    for (const line of lines.reverse()) {
+        try {
+            return JSON.parse(line);
+        }
+        catch {
+            // A log line that happens to start with "{"; keep looking.
+        }
+    }
+    // A pretty-printed document spans lines; try the whole of stdout from its first "{".
+    const at = stdout.indexOf("{");
+    if (at >= 0) {
+        try {
+            return JSON.parse(stdout.slice(at));
+        }
+        catch {
+            // Not JSON.
+        }
+    }
+    return undefined;
+}
+//# sourceMappingURL=process.js.map

package/dist/chant/process.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"process.js","sourceRoot":"","sources":["../../src/chant/process.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAazC,IAAI,OAAiC,CAAC;AAEtC,iDAAiD;AACjD,MAAM,UAAU,YAAY;IAC1B,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC;IAC5B,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,sEAAsE;IACtE,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IACnE,OAAO,GAAG;QACR,IAAI;QACJ,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC;QACzC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC;QACtB,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;KACnD,CAAC;IACF,OAAO,OAAO,CAAC;AACjB,CAAC;AAgBD,6FAA6F;AAC7F,MAAM,UAAU,QAAQ,CAAC,OAA0B,OAAO,CAAC,GAAG;IAC5D,MAAM,EAAE,GAAG,EAAE,GAAG,YAAY,EAAE,CAAC;IAC/B,OAAO,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC;AACpH,CAAC;AAED,iHAAiH;AACjH,MAAM,UAAU,QAAQ,CAAC,IAAuB,EAAE,OAAwB;IACxE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,YAAY,EAAE,CAAC;IACxC,OAAO,IAAI,OAAO,CAAC,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE;QAC5C,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,EAAE;YACzE,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC;YAC1B,KAAK,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC;SAClC,CAAC,CAAC;QACH,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACjC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACjC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;YACxC,MAAM,IAAI,KAAK,CAAC;YAChB,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;YACxC,MAAM,IAAI,KAAK,CAAC;YAChB,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC1B,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;YACjC,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,mIAAmI;AACnI,MAAM,UAAU,YAAY,CAAC,MAAc;IACzC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IACvF,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QACnC,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAY,CAAC;QACrC,CAAC;QAAC,MAAM,CAAC;YACP,2DAA2D;QAC7D,CAAC;IACH,CAAC;IACD,qFAAqF;IACrF,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/B,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;QACZ,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAY,CAAC;QACjD,CAAC;QAAC,MAAM,CAAC;YACP,YAAY;QACd,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/chant/runnable.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Commands yodel prints for a person to run (#14): `chant approve ...`,
+ * `yodel apply ...`. In a project that installs chant and yodel locally,
+ * neither is on PATH, only in node_modules/.bin, so a printed `chant approve`
+ * fails with "command not found". Such a command is printed as `npx chant
+ * ...` instead, which runs the project's own copy. When the tool is on PATH,
+ * or the project does not install it (where `npx` would fetch an unrelated
+ * package of that name), the command is printed as it is.
+ */
+/**
+ * Whether `name` is an executable on `PATH`, not counting `node_modules/.bin`
+ * directories: `npx yodel` puts the project's on yodel's PATH, but the
+ * person's shell does not have it.
+ */
+export declare function onPath(name: string, env?: NodeJS.ProcessEnv): boolean;
+/** Whether `dir` or a directory above it has `node_modules/.bin/<name>`. */
+export declare function installedLocally(name: string, dir: string): boolean;
+/** `command` as a person can run it in `projectDir`: prefixed with `npx ` when its tool is installed there but not on PATH. */
+export declare function runnable(command: string, projectDir: string, env?: NodeJS.ProcessEnv): string;