@intentius/chant 0.124.46 → 0.124.49

package/dist/workspace/import-init.d.ts

@@ -0,0 +1,26 @@
+/**
+ * `chant workspace init --from tfc|spacelift|backstage` (#3178): the command
+ * around `import-source.ts`. It reads the source, prints the proposal and what
+ * was left out, and writes only on confirmation, as `init` does (#2525 rule 1).
+ * Besides `chant.workspace.json` it writes `chant-import.<source>.json`: the
+ * environments and constraint records the declaration has no field for.
+ */
+import type { CommandContext } from "../cli/registry.js";
+import { ImportFetchError, type Fetcher } from "./import-fetch.js";
+import { type ImportProposal, type ImportSource } from "./import-source.js";
+export declare const IMPORT_USAGE: string;
+export declare const isImportSource: (v: string | undefined) => v is ImportSource;
+export interface ImportDeps {
+    /** For tests: the transport the API readers use. */
+    fetcher?: Fetcher;
+    env?: Record<string, string | undefined>;
+    /** For tests: answers the confirmation. */
+    confirm?: (question: string) => Promise<boolean>;
+    isTTY?: boolean;
+}
+/** Read the source into a proposal. Throws {@link ImportFetchError} or an Error naming what is missing. */
+export declare function loadProposal(source: ImportSource, root: string, args: CommandContext["args"], deps?: ImportDeps): Promise<ImportProposal>;
+export declare function formatImportProposal(p: ImportProposal): string[];
+export declare function runImportInit(source: ImportSource, root: string, args: CommandContext["args"], deps?: ImportDeps): Promise<number>;
+export { ImportFetchError };
+//# sourceMappingURL=import-init.d.ts.map

package/dist/workspace/import-init.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"import-init.d.ts","sourceRoot":"","sources":["../../src/workspace/import-init.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAKH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAA4B,gBAAgB,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC1F,OAAO,EAML,KAAK,cAAc,EACnB,KAAK,YAAY,EAGlB,MAAM,iBAAiB,CAAC;AAGzB,eAAO,MAAM,YAAY,QAGqD,CAAC;AAE/E,eAAO,MAAM,cAAc,MAAO,MAAM,GAAG,SAAS,KAAG,CAAC,IAAI,YAAuE,CAAC;AAEpI,MAAM,WAAW,UAAU;IACzB,oDAAoD;IACpD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IACzC,2CAA2C;IAC3C,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACjD,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,2GAA2G;AAC3G,wBAAsB,YAAY,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,EAAE,IAAI,GAAE,UAAe,GAAG,OAAO,CAAC,cAAc,CAAC,CAuBnJ;AAED,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,cAAc,GAAG,MAAM,EAAE,CAiBhE;AAcD,wBAAsB,aAAa,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,EAAE,IAAI,GAAE,UAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CA6C5I;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/workspace/import-init.js

@@ -0,0 +1,130 @@
+/**
+ * `chant workspace init --from tfc|spacelift|backstage` (#3178): the command
+ * around `import-source.ts`. It reads the source, prints the proposal and what
+ * was left out, and writes only on confirmation, as `init` does (#2525 rule 1).
+ * Besides `chant.workspace.json` it writes `chant-import.<source>.json`: the
+ * environments and constraint records the declaration has no field for.
+ */
+import { existsSync, writeFileSync } from "node:fs";
+import { join, resolve } from "node:path";
+import { formatError, formatSuccess } from "../cli/format.js";
+import { fetchSpacelift, fetchTfc, ImportFetchError } from "./import-fetch.js";
+import { IMPORT_SOURCES, proposeFromBackstage, proposeFromSpacelift, proposeFromTfc, readInputFile, } from "./import-source.js";
+import { WorkspaceReadError } from "./declaration.js";
+export const IMPORT_USAGE = "chant workspace init --from tfc --org <organization> [--input <export.json>] [--token <token>] [dir] [--name <name>] [--yes]\n" +
+    "       chant workspace init --from spacelift --endpoint <https://acme.app.spacelift.io/graphql> [--input <export.json>] [--token <token>] [dir] [--yes]\n" +
+    "       chant workspace init --from backstage [dir] [--name <name>] [--yes]";
+export const isImportSource = (v) => IMPORT_SOURCES.includes(v ?? "");
+/** Read the source into a proposal. Throws {@link ImportFetchError} or an Error naming what is missing. */
+export async function loadProposal(source, root, args, deps = {}) {
+    const env = deps.env ?? process.env;
+    if (source === "backstage")
+        return proposeFromBackstage(root, { name: args.selectName });
+    if (source === "tfc") {
+        let input;
+        if (args.input)
+            input = readInputFile("tfc", resolve(args.input));
+        else {
+            const token = args.token ?? env.TFE_TOKEN ?? env.TF_TOKEN_app_terraform_io;
+            if (!token)
+                throw new Error("--from tfc needs --input <export.json>, or a token in --token, TFE_TOKEN or TF_TOKEN_app_terraform_io");
+            if (!args.org)
+                throw new Error("--from tfc needs --org <organization>");
+            input = await fetchTfc({ organization: args.org, token, fetcher: deps.fetcher });
+        }
+        return proposeFromTfc(input, { name: args.selectName });
+    }
+    let input;
+    if (args.input)
+        input = readInputFile("spacelift", resolve(args.input));
+    else {
+        const token = args.token ?? env.SPACELIFT_API_TOKEN;
+        if (!token)
+            throw new Error("--from spacelift needs --input <export.json>, or a token in --token or SPACELIFT_API_TOKEN");
+        if (!args.endpoint)
+            throw new Error("--from spacelift needs --endpoint <https://<account>.app.spacelift.io/graphql>");
+        input = await fetchSpacelift({ endpoint: args.endpoint, token, fetcher: deps.fetcher });
+    }
+    return proposeFromSpacelift(input, { name: args.selectName });
+}
+export function formatImportProposal(p) {
+    const lines = [];
+    const links = p.declaration.members.reduce((n, m) => n + (m.links?.length ?? 0), 0);
+    lines.push(`${p.declaration.members.length} member(s), ${links} link(s), ${p.environments.length} environment(s), ${p.records.length} constraint record(s).`);
+    if (p.environments.length > 0) {
+        lines.push("", "Environments:");
+        for (const e of p.environments)
+            lines.push(`  ${e.name}: ${e.members.join(", ")}`);
+    }
+    if (p.records.length > 0) {
+        lines.push("", "Constraint records:");
+        for (const r of p.records)
+            lines.push(`  ${r.id}${r.policyKind ? ` (${r.policyKind})` : ""} applies to ${r.appliesTo.length === 0 ? "every member" : r.appliesTo.join(", ")}`);
+    }
+    lines.push("", "Left out:");
+    if (p.leftOut.length === 0)
+        lines.push("  nothing");
+    for (const l of p.leftOut)
+        lines.push(`  ${l.count} ${l.what}: ${l.why}`);
+    for (const n of p.notes)
+        lines.push("", n);
+    return lines;
+}
+async function defaultConfirm(question) {
+    const { createInterface } = await import("node:readline");
+    const rl = createInterface({ input: process.stdin, output: process.stdout });
+    return new Promise((done) => {
+        rl.question(question, (a) => {
+            done(/^y(es)?$/i.test(a.trim()));
+            rl.close();
+        });
+        rl.on("close", () => done(false));
+    });
+}
+export async function runImportInit(source, root, args, deps = {}) {
+    let proposal;
+    try {
+        proposal = await loadProposal(source, root, args, deps);
+    }
+    catch (err) {
+        if (err instanceof WorkspaceReadError) {
+            console.error(formatError({ message: `the proposed declaration is not valid: ${err.describe()}`, hint: "Write chant.workspace.json by hand for now." }));
+            return 1;
+        }
+        console.error(formatError({ message: err instanceof Error ? err.message : String(err), hint: IMPORT_USAGE }));
+        return 1;
+    }
+    const target = join(root, "chant.workspace.json");
+    const sidecar = join(root, `chant-import.${source}.json`);
+    const text = `${JSON.stringify(proposal.declaration, null, 2)}\n`;
+    const sideText = `${JSON.stringify({ source, environments: proposal.environments, records: proposal.records, leftOut: proposal.leftOut }, null, 2)}\n`;
+    console.log(`Proposed ${target}:`);
+    console.log("");
+    console.log(text);
+    for (const line of formatImportProposal(proposal))
+        console.log(line);
+    console.log("");
+    console.log(`Confirming also writes ${sidecar}, holding the environments, constraint records and the left-out list.`);
+    console.log("");
+    let write = !!args.yes;
+    if (!write) {
+        if (!(deps.isTTY ?? process.stdin.isTTY)) {
+            console.log("Nothing written. Re-run with --yes to write it, or save the proposal above and edit it first.");
+            return 0;
+        }
+        write = await (deps.confirm ?? defaultConfirm)("Write chant.workspace.json? [y/N] ");
+    }
+    if (!write) {
+        console.log("Nothing written.");
+        return 0;
+    }
+    if (existsSync(sidecar)) {
+        console.error(formatError({ message: `${sidecar} already exists`, hint: "Move it aside and run again." }));
+        return 1;
+    }
+    writeFileSync(target, text, { flag: "wx" });
+    writeFileSync(sidecar, sideText, { flag: "wx" });
+    console.log(formatSuccess(`Wrote ${target} and ${sidecar}. chant workspace ls lists what it declares.`));
+    return 0;
+}
+export { ImportFetchError };

package/dist/workspace/import-source.d.ts

@@ -0,0 +1,147 @@
+/**
+ * `chant workspace init --from tfc|spacelift|backstage` (#3178): propose a
+ * declaration from structure that lives outside the repository.
+ *
+ * Each source is read into a small input document (see the `*Input` types),
+ * and the mapping from that document to a proposal is a pure function. The
+ * Terraform Cloud and Spacelift documents come from their APIs
+ * (`import-fetch.ts`) or from an exported file given with `--input`; tests
+ * feed fixture JSON and never open a connection. Backstage is read from
+ * `catalog-info.yaml` files on disk.
+ *
+ * What maps:
+ *
+ * - a TFC workspace or a Spacelift stack becomes a member (`terraform` for a
+ *   Terraform stack, `other` with a `because` for anything else);
+ * - a TFC run trigger, or a Spacelift stack dependency, becomes a link on the
+ *   consumer to an output of the producer;
+ * - an environment is read from the `env:` or `environment:` tag or label, or
+ *   the Backstage `spec.lifecycle`;
+ * - policy sets and policies become constraint records;
+ * - a Backstage component or resource becomes an `other` member, and its
+ *   `dependsOn` becomes links.
+ *
+ * Everything else is listed in `leftOut`, with the reason, so the user sees
+ * what the import did not carry.
+ */
+export declare const IMPORT_SOURCES: readonly ["tfc", "spacelift", "backstage"];
+export type ImportSource = (typeof IMPORT_SOURCES)[number];
+/** The output every imported producer exposes when its source names none: "this member was applied". */
+export declare const APPLIED_OUTPUT = "applied";
+/** The output a Backstage entity exposes to the entities that depend on it. */
+export declare const CATALOG_OUTPUT = "catalog";
+export interface TfcInput {
+    organization: string;
+    projects?: {
+        id: string;
+        name: string;
+    }[];
+    workspaces: {
+        id: string;
+        name: string;
+        project?: string;
+        workingDirectory?: string;
+        terraformVersion?: string;
+        vcsRepo?: string;
+        tags?: string[];
+        variables?: {
+            key: string;
+            category?: string;
+            sensitive?: boolean;
+        }[];
+        /** Workspace ids (or names) whose runs trigger this one. */
+        runTriggers?: string[];
+        notifications?: number;
+    }[];
+    policySets?: {
+        id?: string;
+        name: string;
+        kind?: string;
+        enforcement?: string;
+        workspaces?: string[];
+        global?: boolean;
+    }[];
+}
+export interface SpaceliftInput {
+    account: string;
+    stacks: {
+        id: string;
+        name: string;
+        space?: string;
+        repository?: string;
+        branch?: string;
+        projectRoot?: string;
+        vendor?: string;
+        labels?: string[];
+        dependsOn?: {
+            stack: string;
+            references?: {
+                outputName: string;
+                inputName?: string;
+            }[];
+        }[];
+        policies?: string[];
+        contexts?: string[];
+    }[];
+    policies?: {
+        id: string;
+        name: string;
+        type?: string;
+    }[];
+}
+export interface ImportedMember {
+    name: string;
+    dir: string;
+    kind: string;
+    because?: string;
+    outputs?: string[];
+    links?: {
+        member: string;
+        output: string;
+    }[];
+}
+export interface ConstraintRecord {
+    id: string;
+    kind: "constraint";
+    source: ImportSource;
+    title: string;
+    policyKind?: string;
+    enforcement?: string;
+    /** The members the constraint applies to; empty means all of them. */
+    appliesTo: string[];
+}
+export interface EnvironmentRecord {
+    name: string;
+    members: string[];
+}
+export interface LeftOut {
+    what: string;
+    count: number;
+    why: string;
+}
+export interface ImportProposal {
+    source: ImportSource;
+    declaration: {
+        name: string;
+        schema: 1;
+        members: ImportedMember[];
+    };
+    environments: EnvironmentRecord[];
+    records: ConstraintRecord[];
+    leftOut: LeftOut[];
+    /** Plain-language notes the user should read before writing, such as the kind pin the proposal needs. */
+    notes: string[];
+}
+export declare function proposeFromTfc(input: TfcInput, options?: {
+    name?: string;
+}): ImportProposal;
+export declare function proposeFromSpacelift(input: SpaceliftInput, options?: {
+    name?: string;
+}): ImportProposal;
+/** Every `catalog-info.yaml` under `root`, relative and `/`-separated. */
+export declare function findCatalogFiles(root: string): string[];
+export declare function proposeFromBackstage(root: string, options?: {
+    name?: string;
+}): ImportProposal;
+export declare function readInputFile(source: "tfc" | "spacelift", path: string): TfcInput | SpaceliftInput;
+//# sourceMappingURL=import-source.d.ts.map

package/dist/workspace/import-source.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"import-source.d.ts","sourceRoot":"","sources":["../../src/workspace/import-source.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAQH,eAAO,MAAM,cAAc,YAAI,KAAK,EAAE,WAAW,EAAE,WAAW,CAAU,CAAC;AACzE,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3D,wGAAwG;AACxG,eAAO,MAAM,cAAc,YAAY,CAAC;AACxC,+EAA+E;AAC/E,eAAO,MAAM,cAAc,YAAY,CAAC;AAIxC,MAAM,WAAW,QAAQ;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC1C,UAAU,EAAE;QACV,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAChB,SAAS,CAAC,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;YAAC,SAAS,CAAC,EAAE,OAAO,CAAA;SAAE,EAAE,CAAC;QACtE,4DAA4D;QAC5D,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QACvB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,EAAE,CAAC;IACJ,UAAU,CAAC,EAAE;QAAE,EAAE,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,EAAE,CAAC;CAC5H;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE;QACN,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,SAAS,CAAC,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,UAAU,CAAC,EAAE;gBAAE,UAAU,EAAE,MAAM,CAAC;gBAAC,SAAS,CAAC,EAAE,MAAM,CAAA;aAAE,EAAE,CAAA;SAAE,EAAE,CAAC;QAC3F,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACrB,EAAE,CAAC;IACJ,QAAQ,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC1D;AAID,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC9C;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,YAAY,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sEAAsE;IACtE,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,YAAY,CAAC;IACrB,WAAW,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,CAAC,CAAC;QAAC,OAAO,EAAE,cAAc,EAAE,CAAA;KAAE,CAAC;IACpE,YAAY,EAAE,iBAAiB,EAAE,CAAC;IAClC,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB,yGAAyG;IACzG,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAoDD,wBAAgB,cAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,GAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAO,GAAG,cAAc,CA+E/F;AAID,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,cAAc,EAAE,OAAO,GAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAO,GAAG,cAAc,CAuE3G;AAaD,0EAA0E;AAC1E,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAavD;AAeD,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAO,GAAG,cAAc,CAmFlG;AAID,wBAAgB,aAAa,CAAC,MAAM,EAAE,KAAK,GAAG,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,cAAc,CAKlG"}