@ingestron/cli 0.0.0-stage → 1.1.0

package/dist/sample-contract.js

@@ -0,0 +1,91 @@
+// ingestron contract <sample>: a draft ODCS contract from a sample file, with
+// each column's name and inferred logical type and no sample values. Keys,
+// required columns and descriptions are left to the person reviewing it.
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { basename, dirname, join, relative, resolve } from "node:path";
+import { stringify } from "yaml";
+import { readSample } from "./sample-read.js";
+/** Writes contracts/<name>.yaml from the sample. Returns the exit code. */
+export function draftContract(options, io) {
+    const sample = resolve(io.cwd, options.sample ?? "");
+    if (!options.sample || !existsSync(sample)) {
+        io.write(`contract needs a sample file: ingestron contract <file.csv|file.json>\n`);
+        return 2;
+    }
+    const name = options.init.name ?? objectName(sample);
+    const target = join(resolve(io.cwd, options.definitions), "contracts", `${name}.yaml`);
+    const shown = relative(io.cwd, target);
+    if (existsSync(target)) {
+        io.write(`${shown} already exists; nothing written.\n`);
+        return 1;
+    }
+    mkdirSync(dirname(target), { recursive: true });
+    writeFileSync(target, contractFromSample(readFileSync(sample, "utf8"), basename(sample), name));
+    io.write(`Wrote ${shown}. Review the types, then add keys, required columns and descriptions.\n`);
+    return 0;
+}
+/**
+ * The contract text for a sample's columns, with the object named after the file.
+ * @example
+ * contractFromSample("id,name\n1,a\n", "customers.csv", "shop.customers");
+ */
+export function contractFromSample(text, file, id) {
+    const { columns, rows } = readSample(text, file);
+    const properties = columns.map((column) => `      - { name: ${scalar(column)}, logicalType: ${typeOf(rows.map((row) => row[column]))} }`);
+    return [
+        `# Drafted from ${file} (${rows.length} ${rows.length === 1 ? "row" : "rows"}): names and types only. Review the`,
+        "# types, then add primaryKey, required and descriptions before use.",
+        "apiVersion: v3.1.0",
+        "kind: DataContract",
+        `id: ${scalar(id)}`,
+        "version: 0.1.0",
+        "status: draft",
+        "schema:",
+        `  - name: ${scalar(objectName(file))}`,
+        "    logicalType: object",
+        "    properties:",
+        ...properties,
+        "",
+    ].join("\n");
+}
+/** `Daily Sales.csv` → `daily_sales`. */
+function objectName(file) {
+    return basename(file)
+        .replace(/\.[^.]+$/, "")
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/g, "_")
+        .replace(/^_|_$/g, "");
+}
+function scalar(text) {
+    return stringify(text).trimEnd();
+}
+const patterns = [
+    ["integer", /^-?\d+$/],
+    ["number", /^-?\d+(\.\d+)?([eE][-+]?\d+)?$/],
+    ["boolean", /^(true|false)$/i],
+    ["date", /^\d{4}-\d{2}-\d{2}$/],
+    ["timestamp", /^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}(:\d{2}(\.\d+)?)?(Z|[+-]\d{2}:?\d{2})?$/],
+];
+/** The narrowest logical type every non-empty value fits; integers widen to number. */
+function typeOf(values) {
+    const types = new Set(values.filter((value) => value !== "" && value != null).map(typeOfValue));
+    if (types.size === 1)
+        return [...types][0];
+    return types.size === 2 && types.has("integer") && types.has("number") ? "number" : "string";
+}
+function typeOfValue(value) {
+    if (typeof value === "number")
+        return Number.isInteger(value) ? "integer" : "number";
+    if (typeof value === "boolean")
+        return "boolean";
+    if (Array.isArray(value))
+        return "array";
+    if (typeof value === "object")
+        return "object";
+    const text = String(value);
+    // A code such as 00123 is an identifier: as a number it would lose its zeros.
+    if (/^-?0\d/.test(text))
+        return "string";
+    return patterns.find(([, pattern]) => pattern.test(text))?.[0] ?? "string";
+}
+//# sourceMappingURL=sample-contract.js.map

package/dist/sample-contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sample-contract.js","sourceRoot":"","sources":["../src/sample-contract.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAC9E,2EAA2E;AAC3E,yEAAyE;AACzE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC7E,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAGjC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,2EAA2E;AAC3E,MAAM,UAAU,aAAa,CAAC,OAAgB,EAAE,EAAM;IACpD,MAAM,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;IACrD,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3C,EAAE,CAAC,KAAK,CAAC,yEAAyE,CAAC,CAAC;QACpF,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IACrD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,GAAG,IAAI,OAAO,CAAC,CAAC;IACvF,MAAM,KAAK,GAAG,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACvC,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACvB,EAAE,CAAC,KAAK,CAAC,GAAG,KAAK,qCAAqC,CAAC,CAAC;QACxD,OAAO,CAAC,CAAC;IACX,CAAC;IACD,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAChD,aAAa,CAAC,MAAM,EAAE,kBAAkB,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;IAChG,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,yEAAyE,CAAC,CAAC;IAClG,OAAO,CAAC,CAAC;AACX,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY,EAAE,IAAY,EAAE,EAAU;IACvE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACjD,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAC5B,CAAC,MAAM,EAAE,EAAE,CACT,mBAAmB,MAAM,CAAC,MAAM,CAAC,kBAAkB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAChG,CAAC;IACF,OAAO;QACL,kBAAkB,IAAI,KAAK,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,qCAAqC;QACjH,qEAAqE;QACrE,oBAAoB;QACpB,oBAAoB;QACpB,OAAO,MAAM,CAAC,EAAE,CAAC,EAAE;QACnB,gBAAgB;QAChB,eAAe;QACf,SAAS;QACT,aAAa,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,EAAE;QACvC,yBAAyB;QACzB,iBAAiB;QACjB,GAAG,UAAU;QACb,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC;AAED,yCAAyC;AACzC,SAAS,UAAU,CAAC,IAAY;IAC9B,OAAO,QAAQ,CAAC,IAAI,CAAC;SAClB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;SACvB,WAAW,EAAE;SACb,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;SAC3B,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAC3B,CAAC;AAED,SAAS,MAAM,CAAC,IAAY;IAC1B,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;AACnC,CAAC;AAED,MAAM,QAAQ,GAAuB;IACnC,CAAC,SAAS,EAAE,SAAS,CAAC;IACtB,CAAC,QAAQ,EAAE,gCAAgC,CAAC;IAC5C,CAAC,SAAS,EAAE,iBAAiB,CAAC;IAC9B,CAAC,MAAM,EAAE,qBAAqB,CAAC;IAC/B,CAAC,WAAW,EAAE,0EAA0E,CAAC;CAC1F,CAAC;AAEF,uFAAuF;AACvF,SAAS,MAAM,CAAC,MAAiB;IAC/B,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;IAChG,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC;QAAE,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAE,CAAC;IAC5C,OAAO,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC/F,CAAC;AAED,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC;IACrF,IAAI,OAAO,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACjD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,OAAO,CAAC;IACzC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,QAAQ,CAAC;IAC/C,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC3B,8EAA8E;IAC9E,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,QAAQ,CAAC;IACzC,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC;AAC7E,CAAC"}

package/dist/sample-read.d.ts

@@ -0,0 +1,8 @@
+/** The column names in order, and each row's values by name. */
+export interface Sample {
+    columns: string[];
+    rows: Record<string, unknown>[];
+}
+/** Reads `text` as CSV, or as JSON when the file name ends in .json, .jsonl or .ndjson. */
+export declare function readSample(text: string, file: string, limit?: number): Sample;
+//# sourceMappingURL=sample-read.d.ts.map

package/dist/sample-read.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sample-read.d.ts","sourceRoot":"","sources":["../src/sample-read.ts"],"names":[],"mappings":"AAGA,gEAAgE;AAChE,MAAM,WAAW,MAAM;IACrB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;CACjC;AAED,2FAA2F;AAC3F,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,SAAO,GAAG,MAAM,CAE3E"}

package/dist/sample-read.js

@@ -0,0 +1,89 @@
+// Rows of a sample file: CSV (comma, semicolon or tab, with quotes) or JSON
+// (an array of objects, or one object per line). At most `limit` rows.
+/** Reads `text` as CSV, or as JSON when the file name ends in .json, .jsonl or .ndjson. */
+export function readSample(text, file, limit = 1000) {
+    return /\.(json|jsonl|ndjson)$/i.test(file) ? jsonSample(text, limit) : csvSample(text, limit);
+}
+function jsonSample(text, limit) {
+    const trimmed = text.trim();
+    const items = trimmed.startsWith("[")
+        ? JSON.parse(trimmed)
+        : trimmed
+            .split(/\r?\n/)
+            .filter(Boolean)
+            .slice(0, limit)
+            .map((line) => JSON.parse(line));
+    const rows = items
+        .slice(0, limit)
+        .filter((item) => typeof item === "object" && item !== null);
+    const columns = [...new Set(rows.flatMap((row) => Object.keys(row)))];
+    return { columns, rows };
+}
+function csvSample(text, limit) {
+    const firstLine = text.slice(0, text.search(/\r?\n|$/));
+    const delimiter = [",", ";", "\t"].reduce((best, candidate) => firstLine.split(candidate).length > firstLine.split(best).length ? candidate : best);
+    const [header = [], ...records] = csvRecords(text, delimiter, limit + 1);
+    const rows = records
+        .filter((record) => record.some((value) => value !== ""))
+        .map((record) => Object.fromEntries(header.map((name, index) => [name, record[index] ?? ""])));
+    return { columns: header, rows };
+}
+/** RFC 4180 records: quoted fields may hold the delimiter, line breaks and "" for a quote. */
+function csvRecords(text, delimiter, limit) {
+    const reader = new CsvReader(delimiter);
+    for (let at = 0; at < text.length && reader.records.length < limit; at += 1)
+        at += reader.read(text[at], text[at + 1]);
+    reader.end(limit);
+    return reader.records;
+}
+/** Reads one character at a time; `read` returns how many extra characters it used. */
+class CsvReader {
+    delimiter;
+    records = [];
+    record = [];
+    field = "";
+    quoted = false;
+    constructor(delimiter) {
+        this.delimiter = delimiter;
+    }
+    read(char, next) {
+        if (this.quoted)
+            return this.inQuotes(char, next);
+        if (char === '"')
+            this.quoted = true;
+        else if (char === this.delimiter)
+            this.endField();
+        else if (char === "\n" || char === "\r")
+            return this.endRecord(char, next);
+        else
+            this.field += char;
+        return 0;
+    }
+    /** The last record, when the text does not end with a line break. */
+    end(limit) {
+        if ((this.field !== "" || this.record.length > 0) && this.records.length < limit)
+            this.endRecord("\n", undefined);
+    }
+    inQuotes(char, next) {
+        if (char === '"' && next === '"') {
+            this.field += '"';
+            return 1;
+        }
+        if (char === '"')
+            this.quoted = false;
+        else
+            this.field += char;
+        return 0;
+    }
+    endField() {
+        this.record.push(this.field);
+        this.field = "";
+    }
+    endRecord(char, next) {
+        this.endField();
+        this.records.push(this.record);
+        this.record = [];
+        return char === "\r" && next === "\n" ? 1 : 0;
+    }
+}
+//# sourceMappingURL=sample-read.js.map

package/dist/sample-read.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sample-read.js","sourceRoot":"","sources":["../src/sample-read.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,uEAAuE;AAQvE,2FAA2F;AAC3F,MAAM,UAAU,UAAU,CAAC,IAAY,EAAE,IAAY,EAAE,KAAK,GAAG,IAAI;IACjE,OAAO,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACjG,CAAC;AAED,SAAS,UAAU,CAAC,IAAY,EAAE,KAAa;IAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC5B,MAAM,KAAK,GAAc,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC;QAC9C,CAAC,CAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAe;QACpC,CAAC,CAAC,OAAO;aACJ,KAAK,CAAC,OAAO,CAAC;aACd,MAAM,CAAC,OAAO,CAAC;aACf,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC;aACf,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAY,CAAC,CAAC;IAClD,MAAM,IAAI,GAAG,KAAK;SACf,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC;SACf,MAAM,CAAC,CAAC,IAAI,EAAmC,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,CAAC,CAAC;IAChG,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACtE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC;AAED,SAAS,SAAS,CAAC,IAAY,EAAE,KAAa;IAC5C,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;IACxD,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE,CAC5D,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CACpF,CAAC;IACF,MAAM,CAAC,MAAM,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,UAAU,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;IACzE,MAAM,IAAI,GAAG,OAAO;SACjB,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC;SACxD,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACjG,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AACnC,CAAC;AAED,8FAA8F;AAC9F,SAAS,UAAU,CAAC,IAAY,EAAE,SAAiB,EAAE,KAAa;IAChE,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,SAAS,CAAC,CAAC;IACxC,KAAK,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,KAAK,EAAE,EAAE,IAAI,CAAC;QACzE,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAE,EAAE,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7C,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAClB,OAAO,MAAM,CAAC,OAAO,CAAC;AACxB,CAAC;AAED,uFAAuF;AACvF,MAAM,SAAS;IAMgB;IAL7B,OAAO,GAAe,EAAE,CAAC;IACjB,MAAM,GAAa,EAAE,CAAC;IACtB,KAAK,GAAG,EAAE,CAAC;IACX,MAAM,GAAG,KAAK,CAAC;IAEvB,YAA6B,SAAiB;QAAjB,cAAS,GAAT,SAAS,CAAQ;IAAG,CAAC;IAElD,IAAI,CAAC,IAAY,EAAE,IAAwB;QACzC,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAClD,IAAI,IAAI,KAAK,GAAG;YAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;aAChC,IAAI,IAAI,KAAK,IAAI,CAAC,SAAS;YAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;aAC7C,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;;YACtE,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC;QACxB,OAAO,CAAC,CAAC;IACX,CAAC;IAED,qEAAqE;IACrE,GAAG,CAAC,KAAa;QACf,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,KAAK;YAC9E,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACpC,CAAC;IAEO,QAAQ,CAAC,IAAY,EAAE,IAAwB;QACrD,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjC,IAAI,CAAC,KAAK,IAAI,GAAG,CAAC;YAClB,OAAO,CAAC,CAAC;QACX,CAAC;QACD,IAAI,IAAI,KAAK,GAAG;YAAE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;;YACjC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC;QACxB,OAAO,CAAC,CAAC;IACX,CAAC;IAEO,QAAQ;QACd,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;IAClB,CAAC;IAEO,SAAS,CAAC,IAAY,EAAE,IAAwB;QACtD,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,OAAO,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC;CACF"}

package/dist/samples.d.ts

@@ -0,0 +1,33 @@
+/** One sample: where it is, what kind, and how it is listed. */
+export interface Sample {
+    name: string;
+    kind: "starter" | "guide";
+    folder: string;
+    title: string;
+    summary: string;
+}
+/** What a sample's project uses, across its environments. */
+export interface SampleFacts {
+    packs: string[];
+    connectors: string[];
+    connectivity: string[];
+    methods: string[];
+    environments: string[];
+    /** Such as "quality checks", "transforms", "change data" or "several packs". */
+    features: string[];
+}
+/** The starters' folder: `project-templates/` beside `dist/`, in the repository and installed. */
+export declare const templatesFolder: string;
+/**
+ * The samples in `folder`: starters, smallest first, or guides in their order.
+ * @example listSamples().map((sample) => sample.name) // ["minimal", …]
+ */
+export declare function listSamples(folder?: string, kind?: Sample["kind"]): Sample[];
+/** The packs, connectors, connectivity, methods, environments and features a sample uses. */
+export declare function sampleFacts(folder: string): SampleFacts;
+/**
+ * One sample folder, listed from its `template.yaml` (starter) or `sample.yaml` (guide).
+ * @example readSample(folder, "guide").title
+ */
+export declare function readSample(folder: string, kind: Sample["kind"]): Sample;
+//# sourceMappingURL=samples.d.ts.map

package/dist/samples.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"samples.d.ts","sourceRoot":"","sources":["../src/samples.ts"],"names":[],"mappings":"AAYA,gEAAgE;AAChE,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,6DAA6D;AAC7D,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,gFAAgF;IAChF,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAID,kGAAkG;AAClG,eAAO,MAAM,eAAe,QAAyC,CAAC;AAEtE;;;GAGG;AACH,wBAAgB,WAAW,CAAC,MAAM,SAAkB,EAAE,IAAI,GAAE,MAAM,CAAC,MAAM,CAAa,GAAG,MAAM,EAAE,CAOhG;AAED,6FAA6F;AAC7F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW,CA+BvD;AAkCD;;;GAGG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAWvE"}

package/dist/samples.js

@@ -0,0 +1,108 @@
+// The samples users read and start from. Starters are complete projects that
+// `ingestron init` and VS Code create a project from (each has template.yaml),
+// in this package's project-templates/. Guides are small projects that each
+// show one idea (each has sample.yaml); the documentation keeps its own and
+// lists them with the same functions. What a sample uses is found by resolving it.
+import { existsSync, readdirSync, readFileSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+import { loadDefinitions } from "@ingestron/definitions";
+import { parse } from "yaml";
+import { packs } from "./packs.js";
+const packageRoot = join(dirname(fileURLToPath(import.meta.url)), "..");
+/** The starters' folder: `project-templates/` beside `dist/`, in the repository and installed. */
+export const templatesFolder = join(packageRoot, "project-templates");
+/**
+ * The samples in `folder`: starters, smallest first, or guides in their order.
+ * @example listSamples().map((sample) => sample.name) // ["minimal", …]
+ */
+export function listSamples(folder = templatesFolder, kind = "starter") {
+    const folders = foldersIn(folder);
+    return kind === "starter"
+        ? folders
+            .map((path) => readSample(path, kind))
+            .sort((a, b) => size(a.folder) - size(b.folder) || a.name.localeCompare(b.name))
+        : folders.sort((a, b) => orderOf(a) - orderOf(b)).map((path) => readSample(path, kind));
+}
+/** The packs, connectors, connectivity, methods, environments and features a sample uses. */
+export function sampleFacts(folder) {
+    const manifest = parse(readFileSync(join(folder, "project.yaml"), "utf8"));
+    const environments = Object.keys(manifest.environments ?? {});
+    const models = (environments.length > 0 ? environments : [undefined]).flatMap((environment) => {
+        const { model } = loadDefinitions(folder, {
+            packs,
+            environment,
+            envvars: {},
+        });
+        return model ? [model] : [];
+    });
+    const all = (pick) => [...new Set(models.flatMap(pick))];
+    const tables = models.flatMap((model) => model.tables);
+    return {
+        packs: all((model) => model.standard.packs.map((pack) => pack.split("@")[0])),
+        connectors: all((model) => model.tables.flatMap((table) => table.ingest?.connection.connector ?? [])),
+        connectivity: all((model) => model.tables.flatMap((table) => table.ingest?.connection.connectivity ?? [])),
+        methods: all((model) => model.tables.flatMap((table) => [table.ingest, table.transform, table.store].flatMap((step) => step?.method ?? []))),
+        environments,
+        features: features(models, tables),
+    };
+}
+function features(models, tables) {
+    const manage = models.flatMap((model) => Object.entries(model.platform.manage).flatMap(([id, on]) => (on ? [`manages ${id}`] : [])));
+    return [
+        ...new Set([
+            // Its own rules, not the not-null checks every required column gets.
+            ...(tables.some((table) => table.expectations.some((item) => item.from === "definition") ||
+                table.contract.checks.length + table.contract.tableChecks.length > 0)
+                ? ["quality checks"]
+                : []),
+            ...(tables.some((table) => table.transform) ? ["transforms"] : []),
+            ...(tables.some((table) => ["upsert", "history"].includes(String(table.store?.settings.mode)))
+                ? ["change data"]
+                : []),
+            ...(models.some((model) => model.standard.packs.length > 1) ? ["several packs"] : []),
+            ...(models.some((model) => model.platform.schedule) ? ["schedule"] : []),
+            ...manage,
+        ]),
+    ];
+}
+function foldersIn(folder) {
+    if (!existsSync(folder))
+        return [];
+    return readdirSync(folder, { withFileTypes: true })
+        .filter((entry) => entry.isDirectory())
+        .map((entry) => join(folder, entry.name));
+}
+/**
+ * One sample folder, listed from its `template.yaml` (starter) or `sample.yaml` (guide).
+ * @example readSample(folder, "guide").title
+ */
+export function readSample(folder, kind) {
+    const file = kind === "starter" ? "template.yaml" : "sample.yaml";
+    const data = (parse(readFileSync(join(folder, file), "utf8")) ?? {});
+    const name = folder.split(/[\\/]/).pop();
+    return {
+        name,
+        kind,
+        folder,
+        title: String(data.title ?? name),
+        summary: String(data.summary ?? ""),
+    };
+}
+function orderOf(folder) {
+    const data = parse(readFileSync(join(folder, "sample.yaml"), "utf8"));
+    return data.order ?? Number.MAX_SAFE_INTEGER;
+}
+/** Definition files, so the smallest starter comes first. */
+function size(folder) {
+    const files = (path) => readdirSync(path, { withFileTypes: true })
+        .filter((entry) => entry.name !== "build")
+        .reduce((sum, entry) => sum +
+        (entry.isDirectory()
+            ? files(join(path, entry.name))
+            : /\.ya?ml$/.test(entry.name)
+                ? 1
+                : 0), 0);
+    return files(folder);
+}
+//# sourceMappingURL=samples.js.map

package/dist/samples.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"samples.js","sourceRoot":"","sources":["../src/samples.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,+EAA+E;AAC/E,4EAA4E;AAC5E,4EAA4E;AAC5E,mFAAmF;AACnF,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,eAAe,EAAsB,MAAM,wBAAwB,CAAC;AAC7E,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAsBnC,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;AAExE,kGAAkG;AAClG,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;AAEtE;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,MAAM,GAAG,eAAe,EAAE,OAAuB,SAAS;IACpF,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IAClC,OAAO,IAAI,KAAK,SAAS;QACvB,CAAC,CAAC,OAAO;aACJ,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;aACrC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACpF,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AAC5F,CAAC;AAED,6FAA6F;AAC7F,MAAM,UAAU,WAAW,CAAC,MAAc;IACxC,MAAM,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAExE,CAAC;IACF,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;IAC9D,MAAM,MAAM,GAAG,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;QAC5F,MAAM,EAAE,KAAK,EAAE,GAAG,eAAe,CAAC,MAAM,EAAE;YACxC,KAAK;YACL,WAAW;YACX,OAAO,EAAE,EAAE;SACZ,CAAC,CAAC;QACH,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9B,CAAC,CAAC,CAAC;IACH,MAAM,GAAG,GAAG,CAAI,IAAmC,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3F,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACvD,OAAO;QACL,KAAK,EAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC;QAC9E,UAAU,EAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACxB,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,SAAS,IAAI,EAAE,CAAC,CAC1E;QACD,YAAY,EAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAC1B,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,YAAY,IAAI,EAAE,CAAC,CAC7E;QACD,OAAO,EAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACrB,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAC7B,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,CAAC,CACnF,CACF;QACD,YAAY;QACZ,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;KACnC,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,MAAuB,EAAE,MAA+B;IACxE,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CACtC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAC3F,CAAC;IACF,OAAO;QACL,GAAG,IAAI,GAAG,CAAC;YACT,qEAAqE;YACrE,GAAG,CAAC,MAAM,CAAC,IAAI,CACb,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,YAAY,CAAC;gBAC7D,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CACvE;gBACC,CAAC,CAAC,CAAC,gBAAgB,CAAC;gBACpB,CAAC,CAAC,EAAE,CAAC;YACP,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAClE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC5F,CAAC,CAAC,CAAC,aAAa,CAAC;gBACjB,CAAC,CAAC,EAAE,CAAC;YACP,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACrF,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACxE,GAAG,MAAM;SACV,CAAC;KACH,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,MAAc;IAC/B,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAAE,OAAO,EAAE,CAAC;IACnC,OAAO,WAAW,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;SAChD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;SACtC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,MAAc,EAAE,IAAoB;IAC7D,MAAM,IAAI,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC;IAClE,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,CAA4B,CAAC;IAChG,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,EAAG,CAAC;IAC1C,OAAO;QACL,IAAI;QACJ,IAAI;QACJ,MAAM;QACN,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC;QACjC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;KACpC,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,MAAc;IAC7B,MAAM,IAAI,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,CAAC,CAAuB,CAAC;IAC5F,OAAO,IAAI,CAAC,KAAK,IAAI,MAAM,CAAC,gBAAgB,CAAC;AAC/C,CAAC;AAED,6DAA6D;AAC7D,SAAS,IAAI,CAAC,MAAc;IAC1B,MAAM,KAAK,GAAG,CAAC,IAAY,EAAU,EAAE,CACrC,WAAW,CAAC,IAAI,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;SACvC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC;SACzC,MAAM,CACL,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CACb,GAAG;QACH,CAAC,KAAK,CAAC,WAAW,EAAE;YAClB,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC3B,CAAC,CAAC,CAAC;gBACH,CAAC,CAAC,CAAC,CAAC,EACV,CAAC,CACF,CAAC;IACN,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC;AACvB,CAAC"}

package/dist/scaffold.d.ts

@@ -0,0 +1,34 @@
+import type { Template } from "./templates.js";
+/** What the user chose. */
+export interface Answers {
+    name: string;
+    environments: string[];
+    values: Record<string, string>;
+    /** Another standard to use instead of the template's: its file and where it came from. */
+    standard?: {
+        file: string;
+        source: string;
+    };
+}
+/** A file's content: text for the files init edits, bytes for everything else. */
+export type Content = string | Buffer;
+/** Files to write, path → content; throws on a symbolic link in the template. */
+export declare function scaffoldFiles(template: Template, answers: Answers, prepared?: Record<string, Content>): Record<string, Content>;
+/**
+ * Writes the files under `target`, or returns what is in the way and writes
+ * nothing: an existing entry at a path (a link too, never followed), or one
+ * that is not a folder where the template needs a folder.
+ */
+export declare function writeScaffold(target: string, files: Record<string, Content>): {
+    written: string[];
+} | {
+    clashes: string[];
+};
+/**
+ * Why a project or environment name is not valid, with a valid suggestion, or
+ * undefined when it is. One rule for the command, its questions and editors.
+ */
+export declare function nameProblem(text: string, what: "project" | "environment"): string | undefined;
+/** A valid project id from a folder name: lowercase, other characters to `_`, a letter first. */
+export declare function projectId(text: string): string;
+//# sourceMappingURL=scaffold.d.ts.map

package/dist/scaffold.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffold.d.ts","sourceRoot":"","sources":["../src/scaffold.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE/C,2BAA2B;AAC3B,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,0FAA0F;IAC1F,QAAQ,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAC7C;AAYD,kFAAkF;AAClF,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AAEtC,iFAAiF;AACjF,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,OAAO,EAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACjC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAWzB;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B;IAAE,OAAO,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,MAAM,EAAE,CAAA;CAAE,CAU/C;AAcD;;;GAGG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,aAAa,GAAG,MAAM,GAAG,SAAS,CAG7F;AAED,iGAAiG;AACjG,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAM9C"}

package/dist/scaffold.js

@@ -0,0 +1,106 @@
+// A new project from a template: the files to write, then writing them
+// without ever replacing a file that is already there.
+import { lstatSync, mkdirSync, readdirSync, readFileSync, writeFileSync } from "node:fs";
+import { dirname, join, relative } from "node:path";
+import { isMap, isScalar, parseDocument, YAMLMap } from "yaml";
+/** Never copied: the template's own description and README, and anything generated. */
+const skipped = new Set([
+    "template.yaml",
+    "README.md",
+    "build",
+    ".generated.json",
+    ".git",
+    ".ingestron",
+]);
+/** Files to write, path → content; throws on a symbolic link in the template. */
+export function scaffoldFiles(template, answers, prepared) {
+    const files = { ...prepared };
+    if (!prepared)
+        for (const path of templateFiles(template, template.folder))
+            files[path] = readFileSync(join(template.folder, path));
+    files["project.yaml"] = projectText(files["project.yaml"]?.toString() ?? "", answers);
+    if (answers.standard) {
+        const text = readFileSync(answers.standard.file, "utf8");
+        files["standard.yaml"] = `# From ${answers.standard.source}\n${text}`;
+    }
+    return files;
+}
+/**
+ * Writes the files under `target`, or returns what is in the way and writes
+ * nothing: an existing entry at a path (a link too, never followed), or one
+ * that is not a folder where the template needs a folder.
+ */
+export function writeScaffold(target, files) {
+    const paths = Object.keys(files).sort();
+    const clashes = [...new Set(paths.flatMap((path) => inTheWay(target, path)))].sort();
+    if (clashes.length > 0)
+        return { clashes };
+    for (const path of paths) {
+        mkdirSync(dirname(join(target, path)), { recursive: true });
+        // "wx": never replace a file that appeared after the check.
+        writeFileSync(join(target, path), files[path], { flag: "wx" });
+    }
+    return { written: paths };
+}
+/** The path itself if anything is there, or a parent that exists but is not a folder. */
+function inTheWay(target, path) {
+    const parts = path.split("/");
+    for (let index = 1; index <= parts.length; index += 1) {
+        const prefix = parts.slice(0, index).join("/");
+        const stat = lstatSync(join(target, prefix), { throwIfNoEntry: false });
+        if (!stat)
+            return [];
+        if (index === parts.length || !stat.isDirectory())
+            return [prefix];
+    }
+    return [];
+}
+/**
+ * Why a project or environment name is not valid, with a valid suggestion, or
+ * undefined when it is. One rule for the command, its questions and editors.
+ */
+export function nameProblem(text, what) {
+    if (projectId(text) === text)
+        return undefined;
+    return `"${text}" is not a valid ${what} name: use lowercase letters, digits and underscores, starting with a letter. Try "${projectId(text)}".`;
+}
+/** A valid project id from a folder name: lowercase, other characters to `_`, a letter first. */
+export function projectId(text) {
+    const id = text
+        .toLowerCase()
+        .replace(/[^a-z0-9_]+/g, "_")
+        .replace(/^_+|_+$/g, "");
+    return /^[a-z]/.test(id) ? id : `p_${id}`;
+}
+function templateFiles(template, folder) {
+    return readdirSync(folder).flatMap((entry) => {
+        if (skipped.has(entry))
+            return [];
+        const path = join(folder, entry);
+        const stat = lstatSync(path);
+        if (stat.isSymbolicLink())
+            throw new Error(`Template "${template.name}" has a symbolic link: ${relative(template.folder, path)}. Templates may only hold regular files.`);
+        if (stat.isDirectory())
+            return templateFiles(template, path);
+        return stat.isFile() ? [relative(template.folder, path)] : [];
+    });
+}
+/** project.yaml with the name, environments and answers; comments are kept. */
+function projectText(text, answers) {
+    const document = parseDocument(text);
+    document.set("id", answers.name);
+    const existing = document.get("environments");
+    const environments = isMap(existing) ? existing : new YAMLMap();
+    // Edit the template's map in place, so comments on its environments stay.
+    for (const pair of [...environments.items])
+        if (!answers.environments.includes(String(isScalar(pair.key) ? pair.key.value : pair.key)))
+            environments.delete(pair.key);
+    for (const name of answers.environments)
+        if (!environments.has(name))
+            environments.set(name, new YAMLMap());
+    document.set("environments", environments);
+    for (const [key, value] of Object.entries(answers.values))
+        document.setIn(["values", key], value);
+    return document.toString();
+}
+//# sourceMappingURL=scaffold.js.map

package/dist/scaffold.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffold.js","sourceRoot":"","sources":["../src/scaffold.ts"],"names":[],"mappings":"AAAA,uEAAuE;AACvE,uDAAuD;AACvD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACzF,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAY/D,uFAAuF;AACvF,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC;IACtB,eAAe;IACf,WAAW;IACX,OAAO;IACP,iBAAiB;IACjB,MAAM;IACN,YAAY;CACb,CAAC,CAAC;AAKH,iFAAiF;AACjF,MAAM,UAAU,aAAa,CAC3B,QAAkB,EAClB,OAAgB,EAChB,QAAkC;IAElC,MAAM,KAAK,GAA4B,EAAE,GAAG,QAAQ,EAAE,CAAC;IACvD,IAAI,CAAC,QAAQ;QACX,KAAK,MAAM,IAAI,IAAI,aAAa,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC;YACzD,KAAK,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IAC5D,KAAK,CAAC,cAAc,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACtF,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACzD,KAAK,CAAC,eAAe,CAAC,GAAG,UAAU,OAAO,CAAC,QAAQ,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;IACxE,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAc,EACd,KAA8B;IAE9B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;IACxC,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACrF,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,EAAE,OAAO,EAAE,CAAC;IAC3C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5D,4DAA4D;QAC5D,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,IAAI,CAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AAC5B,CAAC;AAED,yFAAyF;AACzF,SAAS,QAAQ,CAAC,MAAc,EAAE,IAAY;IAC5C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACtD,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,IAAI;YAAE,OAAO,EAAE,CAAC;QACrB,IAAI,KAAK,KAAK,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,IAA+B;IACvE,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,IAAI;QAAE,OAAO,SAAS,CAAC;IAC/C,OAAO,IAAI,IAAI,oBAAoB,IAAI,sFAAsF,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;AACnJ,CAAC;AAED,iGAAiG;AACjG,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,MAAM,EAAE,GAAG,IAAI;SACZ,WAAW,EAAE;SACb,OAAO,CAAC,cAAc,EAAE,GAAG,CAAC;SAC5B,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAC3B,OAAO,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;AAC5C,CAAC;AAED,SAAS,aAAa,CAAC,QAAkB,EAAE,MAAc;IACvD,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC3C,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACjC,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,MAAM,IAAI,KAAK,CACb,aAAa,QAAQ,CAAC,IAAI,0BAA0B,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,0CAA0C,CAC9H,CAAC;QACJ,IAAI,IAAI,CAAC,WAAW,EAAE;YAAE,OAAO,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAChE,CAAC,CAAC,CAAC;AACL,CAAC;AAED,+EAA+E;AAC/E,SAAS,WAAW,CAAC,IAAY,EAAE,OAAgB;IACjD,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IACrC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC9C,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,OAAO,EAAoB,CAAC;IAClF,0EAA0E;IAC1E,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC;QACxC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACxF,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClC,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,YAAY;QACrC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,OAAO,EAAE,CAAC,CAAC;IACrE,QAAQ,CAAC,GAAG,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;IAC3C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;QAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;IAClG,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;AAC7B,CAAC"}

package/dist/schemas.d.ts

@@ -0,0 +1,5 @@
+import type { Options } from "./args.js";
+import type { Io } from "./io.js";
+/** Writes the schemas to `.ingestron/schemas` and prints the VS Code setting. */
+export declare function writeSchemas(options: Options, io: Io): number;
+//# sourceMappingURL=schemas.d.ts.map

package/dist/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAGlC,iFAAiF;AACjF,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,GAAG,MAAM,CAsC7D"}

package/dist/schemas.js

@@ -0,0 +1,39 @@
+// Editor schemas for VS Code's YAML extension. One combined schema chooses
+// each document's schema by its `kind`, so a single setting covers every file.
+import { mkdirSync, writeFileSync } from "node:fs";
+import { join, relative, resolve } from "node:path";
+import { manifestSchema, toEditorSchema } from "@ingestron/config";
+import { kinds } from "@ingestron/definitions";
+import { templateSchema } from "./templates.js";
+/** Writes the schemas to `.ingestron/schemas` and prints the VS Code setting. */
+export function writeSchemas(options, io) {
+    const folder = join(io.cwd, ".ingestron", "schemas");
+    mkdirSync(folder, { recursive: true });
+    const write = (name, schema) => writeFileSync(join(folder, name), `${JSON.stringify(schema, null, 2)}\n`);
+    write("project.json", manifestSchema);
+    const branches = Object.values(kinds).map((kind) => {
+        const file = `${kind.kind.toLowerCase()}.json`;
+        write(file, toEditorSchema(kind.schema));
+        return {
+            if: { required: ["kind"], properties: { kind: { const: kind.kind } } },
+            then: { $ref: file },
+        };
+    });
+    write("template.json", templateSchema);
+    // Without a kind: project.yaml has an id, a template's template.yaml does not.
+    branches.push({
+        if: { not: { required: ["kind"] }, required: ["id"] },
+        then: { $ref: "project.json" },
+    }, {
+        if: { not: { anyOf: [{ required: ["kind"] }, { required: ["id"] }] } },
+        then: { $ref: "template.json" },
+    });
+    write("definitions.json", { title: "Ingestron definitions", allOf: branches });
+    const files = join(relative(io.cwd, resolve(io.cwd, options.definitions)) || ".", "**/*.yaml").replace(/^\.\//, "");
+    const setting = {
+        "yaml.schemas": { [relative(io.cwd, join(folder, "definitions.json"))]: files },
+    };
+    io.write(`Wrote editor schemas to ${relative(io.cwd, folder)}.\nAdd this to .vscode/settings.json:\n${JSON.stringify(setting, null, 2)}\n`);
+    return 0;
+}
+//# sourceMappingURL=schemas.js.map

package/dist/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,+EAA+E;AAC/E,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,cAAc,EAAmB,MAAM,mBAAmB,CAAC;AACpF,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAG/C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,iFAAiF;AACjF,MAAM,UAAU,YAAY,CAAC,OAAgB,EAAE,EAAM;IACnD,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;IACrD,SAAS,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACvC,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,MAAkB,EAAE,EAAE,CACjD,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;IAC5E,KAAK,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IACtC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACjD,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC;QAC/C,KAAK,CAAC,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QACzC,OAAO;YACL,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE;YACtE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;SACrB,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,KAAK,CAAC,eAAe,EAAE,cAA4B,CAAC,CAAC;IACrD,+EAA+E;IAC/E,QAAQ,CAAC,IAAI,CACX;QACE,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,IAAI,CAAC,EAAE;QACrD,IAAI,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE;KACtB,EACV;QACE,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;QACtE,IAAI,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE;KACvB,CACX,CAAC;IACF,KAAK,CAAC,kBAAkB,EAAE,EAAE,KAAK,EAAE,uBAAuB,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC/E,MAAM,KAAK,GAAG,IAAI,CAChB,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,GAAG,EAC7D,WAAW,CACZ,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACvB,MAAM,OAAO,GAAG;QACd,cAAc,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE;KAChF,CAAC;IACF,EAAE,CAAC,KAAK,CACN,2BAA2B,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,0CAA0C,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAClI,CAAC;IACF,OAAO,CAAC,CAAC;AACX,CAAC"}

package/dist/sources.d.ts

@@ -0,0 +1,17 @@
+import { type Template } from "./templates.js";
+/** The URL without `user:password@`, for messages and the standard's "From" line. */
+export declare function withoutCredentials(text: string): string;
+/** A Git URL rather than a path or a name. */
+export declare function isGitUrl(spec: string): boolean;
+/** A template from a built-in name, a folder or a Git URL (`#` names a sub-folder). Call `done()` when finished. */
+export declare function templateSource(spec: string, cwd: string): {
+    template: Template;
+    done(): void;
+};
+/** A standard file from a path or a Git URL with `#path/to/standard.yaml`. */
+export declare function standardSource(spec: string, cwd: string): {
+    file: string;
+    source: string;
+    done(): void;
+};
+//# sourceMappingURL=sources.d.ts.map

package/dist/sources.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sources.d.ts","sourceRoot":"","sources":["../src/sources.ts"],"names":[],"mappings":"AAMA,OAAO,EAAkC,KAAK,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE/E,qFAAqF;AACrF,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEvD;AAQD,8CAA8C;AAC9C,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAM9C;AAED,oHAAoH;AACpH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG;IAAE,QAAQ,EAAE,QAAQ,CAAC;IAAC,IAAI,IAAI,IAAI,CAAA;CAAE,CAuB9F;AAED,8EAA8E;AAC9E,wBAAgB,cAAc,CAC5B,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,MAAM,GACV;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,IAAI,IAAI,CAAA;CAAE,CAQhD"}