@intentius/sql-yodeler 0.0.0-stage → 0.1.0

package/dist/init/adopt.js

@@ -0,0 +1,138 @@
+/**
+ * `yodel init --from <env>`: adopt a live database in one go.
+ *
+ *  1. Refuse, before anything is written, when the project already declares
+ *     a schema (unless `force`), already has migrations, or the
+ *     environment's history already records any; and when the environment
+ *     names no `databases` (ClickHouse) or `schemas` (Postgres), or names
+ *     the history's own.
+ *  2. Read the live database with chant's import (`chant import --from`'s
+ *     library functions) and write the declarations into the source
+ *     directory.
+ *  3. Build them and plan the build against the same database. The plan
+ *     must be empty: the declarations are the database. If it is not, the
+ *     import does not round-trip, and everything written is taken back.
+ *  4. Write the baseline migration: the first migration (parent `null`),
+ *     whose statements create everything, from an empty schema to the build.
+ *  5. Record it applied in the history without running it (`./baseline.ts`),
+ *     on ClickHouse in `<history database>.history`, on Postgres in
+ *     `<history schema>.history` (#13), under the apply lock.
+ *
+ * Any failure in 2 to 5 takes back every file written. The live database
+ * is only read; the one write to the server is the history row, and the
+ * history database (schema) and table when they were not there.
+ */
+import { join, relative } from "node:path";
+import { loadProject, YodelError } from "../project.js";
+import { buildSchema } from "../chant/build.js";
+import { planEnvironment, renderPlan } from "../chant/plan.js";
+import { createMigration, MIGRATIONS_DIR, writeMigration } from "../migrations/index.js";
+import { environmentSettings } from "../config/settings.js";
+import { closeVersioned, hasMigrations, openVersioned, REFUSED } from "../versioned/index.js";
+import { BASELINE_NAME, checkHistoryEmpty, recordBaseline } from "./baseline.js";
+import { declarationFiles, Journal } from "./files.js";
+import { describeImported, importLive } from "./live.js";
+/** Where the declarations go: `sourceDir` when the config names one, else `src`. */
+export const schemaDir = (project) => join(project.dir, project.config.sourceDir ?? "src");
+/** The refusals that need no server: a schema already declared, migrations already there, a ClickHouse scope that would take in the history. */
+export function preflight(project, env, options = {}) {
+    if (hasMigrations(project)) {
+        throw new YodelError(`refused: ${join(project.dir, MIGRATIONS_DIR)} already holds migrations; init writes the first one (the baseline), so it adopts a database only in a project with none. Nothing was written.`, REFUSED);
+    }
+    const dir = schemaDir(project);
+    const existing = declarationFiles(dir);
+    if (existing.length > 0 && !options.force) {
+        throw new YodelError(`refused: ${relative(project.dir, dir) || "."} already declares a schema (${existing.slice(0, 3).join(", ")}${existing.length > 3 ? ", ..." : ""}); ` +
+            `init writes the declarations from the live database there. Pass --force to overwrite (files the import does not write are kept, and are built with it). Nothing was written.`, REFUSED);
+    }
+    const { historyDatabase } = environmentSettings(project, env.name, options.processEnv);
+    const [key, what] = project.dialect === "postgres" ? ["schemas", "schema"] : ["databases", "database"];
+    const scope = project.dialect === "postgres" ? env.profile.schemas : env.profile.databases;
+    if (!scope || scope.length === 0) {
+        throw new YodelError(`refused: sql.profiles.${env.name} names no ${key}, so the import would read every ${what} on the server, the history's (${historyDatabase}) included. ` +
+            `List the ${key} this project owns in sql.profiles.${env.name}.${key}. Nothing was written.`, REFUSED);
+    }
+    if (scope.includes(historyDatabase)) {
+        throw new YodelError(`refused: sql.profiles.${env.name}.${key} includes ${historyDatabase}, the history's ${what} (yodel.config.ts environments.${env.name}.history.database, else YODEL_HISTORY_DATABASE); the history is yodel's, never part of the declared schema. Nothing was written.`, REFUSED);
+    }
+}
+/** Whether a plan has nothing to do: no change to a declared object, and no undeclared object it would drop. */
+const planIsEmpty = (plan) => plan.diff.changes.length === 0 && plan.refused.length === 0;
+/** Adopts `env`'s live database into the project; see the module comment. */
+export async function adopt(project, env, options = {}) {
+    const processEnv = options.processEnv ?? process.env;
+    const log = options.log ?? (() => undefined);
+    preflight(project, env, { ...(options.force !== undefined ? { force: options.force } : {}), processEnv });
+    const venv = await openVersioned(project, env, processEnv);
+    try {
+        await checkHistoryEmpty(venv);
+        return await adoptWith(project, env, venv, options, processEnv, log);
+    }
+    finally {
+        await closeVersioned(venv);
+    }
+}
+async function adoptWith(project, env, venv, options, processEnv, log) {
+    const live = await importLive(project, env, processEnv);
+    if (live.ir.resources.length === 0) {
+        throw new YodelError(`refused: ${env.name} holds no objects in its scope (sql.profiles.${env.name}); there is nothing to adopt. Declare a schema and run yodel new instead. Nothing was written.`, REFUSED);
+    }
+    const objects = describeImported(live.ir);
+    log(`read ${String(objects.length)} object(s) from ${env.name}`);
+    const journal = new Journal();
+    try {
+        const dir = schemaDir(project);
+        journal.mkdir(dir);
+        const schemaFiles = [];
+        for (const f of live.files) {
+            const path = join(dir, f.path);
+            journal.write(path, f.content);
+            schemaFiles.push(relative(project.dir, path));
+        }
+        log(`wrote ${schemaFiles.join(", ")}`);
+        // The source directory may have been made just now; load the project again so it is built from there.
+        const adopted = await loadProject(project.dir);
+        const build = await buildSchema(adopted, { env: processEnv });
+        let made;
+        try {
+            const plan = await planEnvironment(adopted, env, build, { env: processEnv });
+            if (!planIsEmpty(plan)) {
+                throw new YodelError(`the declarations chant's import wrote do not plan clean against ${env.name}, so they are not yet the database; nothing was kept. ` +
+                    `This is an object chant cannot round-trip; please report it with the plan:\n${await renderPlan(plan, `Plan for ${env.name} after import`)}`);
+            }
+            log(`planned against ${env.name}: no change`);
+            made = createMigration({ name: options.name ?? BASELINE_NAME, build: build.output, ...(options.now ? { now: options.now } : {}) });
+        }
+        finally {
+            build.dispose();
+        }
+        if (made.id === undefined)
+            throw new YodelError("the build declares nothing, so there is no baseline to write");
+        const migrations = join(project.dir, MIGRATIONS_DIR);
+        journal.mkdir(migrations);
+        const path = writeMigration(migrations, made);
+        journal.created(path);
+        const migration = { id: made.id, dir: path, parent: null, checksum: made.document.checksum, document: made.document, files: made.files };
+        const statements = made.statements.steps.length;
+        log(`wrote ${relative(project.dir, path)} (${String(statements)} statement${statements === 1 ? "" : "s"})`);
+        const base = {
+            environment: env.name,
+            dialect: project.dialect,
+            objects,
+            schemaFiles,
+            migrationPath: relative(project.dir, path),
+            baseline: { id: made.id, checksum: made.document.checksum, statements },
+            warnings: live.warnings,
+        };
+        const { row, lock } = await recordBaseline(venv, migration, processEnv);
+        if (lock.notice)
+            log(`lock: ${lock.notice}`);
+        log(`recorded ${made.id} applied in ${venv.location.database}.history as a baseline; none of its statements was run`);
+        return { ...base, recorded: { database: venv.location.database, row, lock } };
+    }
+    catch (e) {
+        journal.undo();
+        throw e;
+    }
+}
+//# sourceMappingURL=adopt.js.map

package/dist/init/adopt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adopt.js","sourceRoot":"","sources":["../../src/init/adopt.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,UAAU,EAAkC,MAAM,eAAe,CAAC;AACxF,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,UAAU,EAAa,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,cAAc,EAAkB,MAAM,wBAAwB,CAAC;AACzG,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,EAAE,OAAO,EAAqB,MAAM,uBAAuB,CAAC;AAEjH,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AACjF,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AA2BzD,oFAAoF;AACpF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,OAAgB,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,SAAS,IAAI,KAAK,CAAC,CAAC;AAE5G,gJAAgJ;AAChJ,MAAM,UAAU,SAAS,CAAC,OAAgB,EAAE,GAAgB,EAAE,UAA+D,EAAE;IAC7H,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,UAAU,CAClB,YAAY,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,gJAAgJ,EAC7L,OAAO,CACR,CAAC;IACJ,CAAC;IACD,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IAC/B,MAAM,QAAQ,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACvC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QAC1C,MAAM,IAAI,UAAU,CAClB,YAAY,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,GAAG,+BAA+B,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK;YACnJ,8KAA8K,EAChL,OAAO,CACR,CAAC;IACJ,CAAC;IACD,MAAM,EAAE,eAAe,EAAE,GAAG,mBAAmB,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IACvF,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,CAAE,CAAC,SAAS,EAAE,QAAQ,CAAW,CAAC,CAAC,CAAE,CAAC,WAAW,EAAE,UAAU,CAAW,CAAC;IAC7H,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC;IAC3F,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,UAAU,CAClB,yBAAyB,GAAG,CAAC,IAAI,aAAa,GAAG,oCAAoC,IAAI,kCAAkC,eAAe,cAAc;YACtJ,YAAY,GAAG,sCAAsC,GAAG,CAAC,IAAI,IAAI,GAAG,wBAAwB,EAC9F,OAAO,CACR,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,UAAU,CAClB,yBAAyB,GAAG,CAAC,IAAI,IAAI,GAAG,aAAa,eAAe,mBAAmB,IAAI,kCAAkC,GAAG,CAAC,IAAI,kIAAkI,EACvQ,OAAO,CACR,CAAC;IACJ,CAAC;AACH,CAAC;AAED,gHAAgH;AAChH,MAAM,WAAW,GAAG,CAAC,IAAU,EAAW,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC;AAEzG,6EAA6E;AAC7E,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,OAAgB,EAAE,GAAgB,EAAE,UAAwB,EAAE;IACxF,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC;IACrD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC7C,SAAS,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IAE1G,MAAM,IAAI,GAAiB,MAAM,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;IACzE,IAAI,CAAC;QACH,MAAM,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC9B,OAAO,MAAM,SAAS,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC;IACvE,CAAC;YAAS,CAAC;QACT,MAAM,cAAc,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;AACH,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,OAAgB,EAAE,GAAgB,EAAE,IAAkB,EAAE,OAAqB,EAAE,UAA6B,EAAE,GAA2B;IAChK,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;IACxD,IAAI,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,UAAU,CAAC,YAAY,GAAG,CAAC,IAAI,gDAAgD,GAAG,CAAC,IAAI,gGAAgG,EAAE,OAAO,CAAC,CAAC;IAC9M,CAAC;IACD,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1C,GAAG,CAAC,QAAQ,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,mBAAmB,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAEjE,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAC9B,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;QAC/B,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACnB,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;YAC/B,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;YAC/B,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;QAChD,CAAC;QACD,GAAG,CAAC,SAAS,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEvC,sGAAsG;QACtG,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC;QAC9D,IAAI,IAAwC,CAAC;QAC7C,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC;YAC7E,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvB,MAAM,IAAI,UAAU,CAClB,mEAAmE,GAAG,CAAC,IAAI,wDAAwD;oBACjI,+EAA+E,MAAM,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,CAAC,IAAI,eAAe,CAAC,EAAE,CAC/I,CAAC;YACJ,CAAC;YACD,GAAG,CAAC,mBAAmB,GAAG,CAAC,IAAI,aAAa,CAAC,CAAC;YAC9C,IAAI,GAAG,eAAe,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,aAAa,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QACrI,CAAC;gBAAS,CAAC;YACT,KAAK,CAAC,OAAO,EAAE,CAAC;QAClB,CAAC;QACD,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS;YAAE,MAAM,IAAI,UAAU,CAAC,8DAA8D,CAAC,CAAC;QAEhH,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QACrD,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1B,MAAM,IAAI,GAAG,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC9C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtB,MAAM,SAAS,GAAc,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;QACpJ,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC;QAChD,GAAG,CAAC,SAAS,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,MAAM,CAAC,UAAU,CAAC,aAAa,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;QAE5G,MAAM,IAAI,GAAG;YACX,WAAW,EAAE,GAAG,CAAC,IAAI;YACrB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,OAAO;YACP,WAAW;YACX,aAAa,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC;YAC1C,QAAQ,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,UAAU,EAAE;YACvE,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;QACxE,IAAI,IAAI,CAAC,MAAM;YAAE,GAAG,CAAC,SAAS,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7C,GAAG,CAAC,YAAY,IAAI,CAAC,EAAE,eAAe,IAAI,CAAC,QAAQ,CAAC,QAAQ,wDAAwD,CAAC,CAAC;QACtH,OAAO,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC;IAChF,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,IAAI,EAAE,CAAC;QACf,MAAM,CAAC,CAAC;IACV,CAAC;AACH,CAAC"}

package/dist/init/baseline.d.ts

@@ -0,0 +1,61 @@
+/**
+ * The baseline: the first migration of an adopted database, holding the
+ * schema the database already had, recorded applied without running it.
+ *
+ * ## How the history records it
+ *
+ * One migration row, `status = 'succeeded'`, `note` starting `baseline`
+ * ({@link BASELINE_NOTE}), the migration's checksum, `parent = ''`, and no
+ * statement rows: none of its statements was sent, since the objects they
+ * create are the ones it was read from. `plan_digest` is empty, as nothing
+ * was approved.
+ *
+ * The rest of yodel needs nothing new to read it. `deriveState` makes the
+ * migration's state its latest migration row, `succeeded`, so `isApplied`
+ * holds; `compareHistory` lists it applied, checks its checksum like any
+ * other's, and never puts it among the pending, so `yodel apply` never sends
+ * its statements; and statement rows are only read for a migration that is
+ * part way. A status other than `succeeded` (say `adopted`) would read as
+ * part way, and apply would run it, so the status stays `succeeded` and the
+ * note is what says it was adopted.
+ */
+import { YodelError } from "../project.js";
+import type { Migration } from "../migrations/index.js";
+import { type HistoryRow } from "../history/index.js";
+import { type VersionedEnv } from "../versioned/index.js";
+/** The baseline migration's name: its id is `<YYYYMMDDTHHMM>-baseline`. */
+export declare const BASELINE_NAME = "baseline";
+/** The start of a baseline row's `note`. */
+export declare const BASELINE_NOTE = "baseline";
+/** The note a baseline row carries. */
+export declare const baselineNote: (environment: string) => string;
+/** Whether a history row records a baseline. */
+export declare const isBaselineRow: (row: Pick<HistoryRow, "kind" | "note">) => boolean;
+/** The one row that records `m` applied as a baseline. */
+export declare function baselineRow(m: Pick<Migration, "id" | "parent" | "checksum">, input: {
+    seq: number;
+    runId: string;
+    appliedBy: string;
+    environment: string;
+}): HistoryRow;
+/** Why the history cannot take a baseline, or `undefined`: a baseline is the first thing a history records. */
+export declare function historyRefusal(state: {
+    migrations: readonly {
+        id: string;
+    }[];
+}, location: string): YodelError | undefined;
+/** Reads the history without the lock, for a refusal before anything is written. */
+export declare function checkHistoryEmpty(venv: VersionedEnv): Promise<void>;
+/**
+ * Records `m` applied as the baseline, under the apply lock: makes the
+ * history when it is not there, checks again that it records nothing, and
+ * appends the one row.
+ */
+export declare function recordBaseline(venv: VersionedEnv, m: Migration, processEnv?: NodeJS.ProcessEnv): Promise<{
+    row: HistoryRow;
+    lock: {
+        kind: string;
+        where: string;
+        notice?: string;
+    };
+}>;

package/dist/init/baseline.js

@@ -0,0 +1,88 @@
+/**
+ * The baseline: the first migration of an adopted database, holding the
+ * schema the database already had, recorded applied without running it.
+ *
+ * ## How the history records it
+ *
+ * One migration row, `status = 'succeeded'`, `note` starting `baseline`
+ * ({@link BASELINE_NOTE}), the migration's checksum, `parent = ''`, and no
+ * statement rows: none of its statements was sent, since the objects they
+ * create are the ones it was read from. `plan_digest` is empty, as nothing
+ * was approved.
+ *
+ * The rest of yodel needs nothing new to read it. `deriveState` makes the
+ * migration's state its latest migration row, `succeeded`, so `isApplied`
+ * holds; `compareHistory` lists it applied, checks its checksum like any
+ * other's, and never puts it among the pending, so `yodel apply` never sends
+ * its statements; and statement rows are only read for a migration that is
+ * part way. A status other than `succeeded` (say `adopted`) would read as
+ * part way, and apply would run it, so the status stays `succeeded` and the
+ * note is what says it was adopted.
+ */
+import { randomUUID } from "node:crypto";
+import { YodelError } from "../project.js";
+import { appliedBy, MIGRATION_ROW, withLock } from "../history/index.js";
+import { REFUSED } from "../versioned/index.js";
+/** The baseline migration's name: its id is `<YYYYMMDDTHHMM>-baseline`. */
+export const BASELINE_NAME = "baseline";
+/** The start of a baseline row's `note`. */
+export const BASELINE_NOTE = "baseline";
+/** The note a baseline row carries. */
+export const baselineNote = (environment) => `${BASELINE_NOTE}: adopted from the live database by yodel init --from ${environment}; its statements were not run`;
+/** Whether a history row records a baseline. */
+export const isBaselineRow = (row) => row.kind === "migration" && (row.note === BASELINE_NOTE || row.note.startsWith(`${BASELINE_NOTE}:`));
+/** The one row that records `m` applied as a baseline. */
+export function baselineRow(m, input) {
+    if (m.parent !== null)
+        throw new YodelError(`${m.id} follows ${m.parent}; only a first migration can be a baseline`);
+    return {
+        seq: input.seq,
+        run_id: input.runId,
+        kind: "migration",
+        migration_id: m.id,
+        parent: "",
+        checksum: m.checksum,
+        statement_index: MIGRATION_ROW,
+        statement_sha: "",
+        status: "succeeded",
+        error: "",
+        applied_by: input.appliedBy,
+        plan_digest: "",
+        silences: "[]",
+        note: baselineNote(input.environment),
+    };
+}
+/** Why the history cannot take a baseline, or `undefined`: a baseline is the first thing a history records. */
+export function historyRefusal(state, location) {
+    if (state.migrations.length === 0)
+        return undefined;
+    const ids = state.migrations.map((m) => m.id);
+    return new YodelError(`refused: the history (${location}) already records ${ids.length === 1 ? "a migration" : `${String(ids.length)} migrations`} (${ids.slice(0, 3).join(", ")}${ids.length > 3 ? ", ..." : ""}); ` +
+        `this environment is already under versioned migrations, so there is nothing to adopt. Nothing was written.`, REFUSED);
+}
+/** Reads the history without the lock, for a refusal before anything is written. */
+export async function checkHistoryEmpty(venv) {
+    const refusal = historyRefusal(await venv.store.state(), `${venv.location.database}.history`);
+    if (refusal)
+        throw refusal;
+}
+/**
+ * Records `m` applied as the baseline, under the apply lock: makes the
+ * history when it is not there, checks again that it records nothing, and
+ * appends the one row.
+ */
+export async function recordBaseline(venv, m, processEnv = process.env) {
+    const by = appliedBy(processEnv);
+    const lock = await venv.driver.acquireLock(by);
+    return withLock(lock, venv.lockTtlMs, async () => {
+        await venv.store.ensure();
+        const state = await venv.store.state();
+        const refusal = historyRefusal(state, `${venv.location.database}.history`);
+        if (refusal)
+            throw refusal;
+        const row = baselineRow(m, { seq: state.maxSeq + 1, runId: randomUUID(), appliedBy: by, environment: venv.environment });
+        await venv.store.append([row]);
+        return { row, lock: { kind: lock.kind, where: lock.where, ...(lock.notice ? { notice: lock.notice } : {}) } };
+    });
+}
+//# sourceMappingURL=baseline.js.map

package/dist/init/baseline.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseline.js","sourceRoot":"","sources":["../../src/init/baseline.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,QAAQ,EAAmB,MAAM,qBAAqB,CAAC;AAC1F,OAAO,EAAE,OAAO,EAAqB,MAAM,uBAAuB,CAAC;AAEnE,2EAA2E;AAC3E,MAAM,CAAC,MAAM,aAAa,GAAG,UAAU,CAAC;AAExC,4CAA4C;AAC5C,MAAM,CAAC,MAAM,aAAa,GAAG,UAAU,CAAC;AAExC,uCAAuC;AACvC,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,WAAmB,EAAU,EAAE,CAC1D,GAAG,aAAa,yDAAyD,WAAW,+BAA+B,CAAC;AAEtH,gDAAgD;AAChD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,GAAsC,EAAW,EAAE,CAC/E,GAAG,CAAC,IAAI,KAAK,WAAW,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,aAAa,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,aAAa,GAAG,CAAC,CAAC,CAAC;AAEvG,0DAA0D;AAC1D,MAAM,UAAU,WAAW,CAAC,CAAgD,EAAE,KAA6E;IACzJ,IAAI,CAAC,CAAC,MAAM,KAAK,IAAI;QAAE,MAAM,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,MAAM,4CAA4C,CAAC,CAAC;IACrH,OAAO;QACL,GAAG,EAAE,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,CAAC,KAAK;QACnB,IAAI,EAAE,WAAW;QACjB,YAAY,EAAE,CAAC,CAAC,EAAE;QAClB,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,eAAe,EAAE,aAAa;QAC9B,aAAa,EAAE,EAAE;QACjB,MAAM,EAAE,WAAW;QACnB,KAAK,EAAE,EAAE;QACT,UAAU,EAAE,KAAK,CAAC,SAAS;QAC3B,WAAW,EAAE,EAAE;QACf,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC;KACtC,CAAC;AACJ,CAAC;AAED,+GAA+G;AAC/G,MAAM,UAAU,cAAc,CAAC,KAAgD,EAAE,QAAgB;IAC/F,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACpD,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC9C,OAAO,IAAI,UAAU,CACnB,yBAAyB,QAAQ,qBAAqB,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK;QAC7L,4GAA4G,EAC9G,OAAO,CACR,CAAC;AACJ,CAAC;AAED,oFAAoF;AACpF,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,IAAkB;IACxD,MAAM,OAAO,GAAG,cAAc,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,UAAU,CAAC,CAAC;IAC9F,IAAI,OAAO;QAAE,MAAM,OAAO,CAAC;AAC7B,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,IAAkB,EAAE,CAAY,EAAE,aAAgC,OAAO,CAAC,GAAG;IAChH,MAAM,EAAE,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;IACjC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAC/C,OAAO,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAC1B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACvC,MAAM,OAAO,GAAG,cAAc,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,UAAU,CAAC,CAAC;QAC3E,IAAI,OAAO;YAAE,MAAM,OAAO,CAAC;QAC3B,MAAM,GAAG,GAAG,WAAW,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QACzH,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/B,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;IAChH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/init/files.d.ts

@@ -0,0 +1,23 @@
+/**
+ * The files `yodel init` writes, and taking them back when a later step
+ * fails, so an init that does not finish leaves the project as it found it.
+ */
+/** Whether a file is a declaration chant builds: TypeScript (not a test or a `.d.ts`) or SQL. */
+export declare const isDeclarationFile: (name: string) => boolean;
+/** The declaration files under `dir`, relative to it, sorted. None when `dir` does not exist. */
+export declare function declarationFiles(dir: string): string[];
+/**
+ * Records every file and directory written, with what a file held before,
+ * so {@link Journal.undo} puts things back.
+ */
+export declare class Journal {
+    private readonly steps;
+    /** Makes `dir` and any parents missing, remembering the ones it made. */
+    mkdir(dir: string): void;
+    /** Writes a file, remembering what was there. */
+    write(path: string, content: string): void;
+    /** Remembers a directory something else made (a migration's), to remove on undo. */
+    created(path: string): void;
+    /** Puts back everything, newest first. */
+    undo(): void;
+}

package/dist/init/files.js

@@ -0,0 +1,77 @@
+/**
+ * The files `yodel init` writes, and taking them back when a later step
+ * fails, so an init that does not finish leaves the project as it found it.
+ */
+import { existsSync, mkdirSync, readdirSync, readFileSync, rmSync, statSync, writeFileSync } from "node:fs";
+import { dirname, join, relative } from "node:path";
+/** Directories never searched for declarations. */
+const SKIP = new Set(["node_modules", "dist", "coverage"]);
+/** Whether a file is a declaration chant builds: TypeScript (not a test or a `.d.ts`) or SQL. */
+export const isDeclarationFile = (name) => (/\.(ts|mts|sql)$/.test(name) && !/\.d\.ts$/.test(name) && !/\.(test|spec)\.ts$/.test(name));
+/** The declaration files under `dir`, relative to it, sorted. None when `dir` does not exist. */
+export function declarationFiles(dir) {
+    if (!existsSync(dir))
+        return [];
+    const out = [];
+    const walk = (at) => {
+        for (const e of readdirSync(at, { withFileTypes: true })) {
+            if (e.name.startsWith(".") || SKIP.has(e.name))
+                continue;
+            const path = join(at, e.name);
+            if (e.isDirectory())
+                walk(path);
+            else if (e.isFile() && isDeclarationFile(e.name))
+                out.push(relative(dir, path));
+        }
+    };
+    walk(dir);
+    return out.sort();
+}
+/**
+ * Records every file and directory written, with what a file held before,
+ * so {@link Journal.undo} puts things back.
+ */
+export class Journal {
+    steps = [];
+    /** Makes `dir` and any parents missing, remembering the ones it made. */
+    mkdir(dir) {
+        const missing = [];
+        for (let d = dir; !existsSync(d); d = dirname(d))
+            missing.push(d);
+        if (missing.length === 0)
+            return;
+        mkdirSync(dir, { recursive: true });
+        const top = missing[missing.length - 1];
+        if (top !== undefined)
+            this.steps.push(() => { rmSync(top, { recursive: true, force: true }); });
+    }
+    /** Writes a file, remembering what was there. */
+    write(path, content) {
+        this.mkdir(dirname(path));
+        const before = existsSync(path) && statSync(path).isFile() ? readFileSync(path, "utf8") : undefined;
+        writeFileSync(path, content);
+        this.steps.push(() => {
+            if (before === undefined)
+                rmSync(path, { force: true });
+            else
+                writeFileSync(path, before);
+        });
+    }
+    /** Remembers a directory something else made (a migration's), to remove on undo. */
+    created(path) {
+        this.steps.push(() => { rmSync(path, { recursive: true, force: true }); });
+    }
+    /** Puts back everything, newest first. */
+    undo() {
+        for (const step of this.steps.reverse()) {
+            try {
+                step();
+            }
+            catch {
+                // Best effort: the rest still runs.
+            }
+        }
+        this.steps.length = 0;
+    }
+}
+//# sourceMappingURL=files.js.map

package/dist/init/files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.js","sourceRoot":"","sources":["../../src/init/files.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC5G,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAEpD,mDAAmD;AACnD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,cAAc,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;AAE3D,iGAAiG;AACjG,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAW,EAAE,CACzD,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AAE/F,iGAAiG;AACjG,MAAM,UAAU,gBAAgB,CAAC,GAAW;IAC1C,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,EAAE,CAAC;IAChC,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,MAAM,IAAI,GAAG,CAAC,EAAU,EAAE,EAAE;QAC1B,KAAK,MAAM,CAAC,IAAI,WAAW,CAAC,EAAE,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;YACzD,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;gBAAE,SAAS;YACzD,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,CAAC,CAAC,WAAW,EAAE;gBAAE,IAAI,CAAC,IAAI,CAAC,CAAC;iBAC3B,IAAI,CAAC,CAAC,MAAM,EAAE,IAAI,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC;gBAAE,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;QAClF,CAAC;IACH,CAAC,CAAC;IACF,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,OAAO,GAAG,CAAC,IAAI,EAAE,CAAC;AACpB,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,OAAO;IACD,KAAK,GAAsB,EAAE,CAAC;IAE/C,yEAAyE;IACzE,KAAK,CAAC,GAAW;QACf,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,KAAK,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QACjC,SAAS,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACpC,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACxC,IAAI,GAAG,KAAK,SAAS;YAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACnG,CAAC;IAED,iDAAiD;IACjD,KAAK,CAAC,IAAY,EAAE,OAAe;QACjC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1B,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACpG,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE;YACnB,IAAI,MAAM,KAAK,SAAS;gBAAE,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;;gBACnD,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,oFAAoF;IACpF,OAAO,CAAC,IAAY;QAClB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,0CAA0C;IAC1C,IAAI;QACF,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;YACxC,IAAI,CAAC;gBACH,IAAI,EAAE,CAAC;YACT,CAAC;YAAC,MAAM,CAAC;gBACP,oCAAoC;YACtC,CAAC;QACH,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IACxB,CAAC;CACF"}

package/dist/init/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Adoption (#10): `yodel init --from <env>` reads a live database with
+ * chant's import, writes its declarations, writes the baseline migration
+ * holding them, and records the baseline applied without running it.
+ *
+ *   adopt(project, env, options)     the whole of it; takes back what it wrote on a failure
+ *   preflight(project, env)          the refusals that need no server
+ *   importLive(project, env)         chant import --from, in process: the IR and the files
+ *   baselineRow(migration, input)    the history row that records a baseline
+ *   isBaselineRow(row)               whether a row is one
+ *   recordBaseline(venv, migration)  appends it under the apply lock
+ */
+export * from "./adopt.js";
+export * from "./baseline.js";
+export * from "./files.js";
+export * from "./live.js";

package/dist/init/index.js

@@ -0,0 +1,17 @@
+/**
+ * Adoption (#10): `yodel init --from <env>` reads a live database with
+ * chant's import, writes its declarations, writes the baseline migration
+ * holding them, and records the baseline applied without running it.
+ *
+ *   adopt(project, env, options)     the whole of it; takes back what it wrote on a failure
+ *   preflight(project, env)          the refusals that need no server
+ *   importLive(project, env)         chant import --from, in process: the IR and the files
+ *   baselineRow(migration, input)    the history row that records a baseline
+ *   isBaselineRow(row)               whether a row is one
+ *   recordBaseline(venv, migration)  appends it under the apply lock
+ */
+export * from "./adopt.js";
+export * from "./baseline.js";
+export * from "./files.js";
+export * from "./live.js";
+//# sourceMappingURL=index.js.map

package/dist/init/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/init/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}

package/dist/init/live.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Reading a live database as declarations: the library functions behind
+ * `chant import --from <env>`, called in process with the project's own
+ * config, so the server read is the one `sql.profiles.<env>` binds and the
+ * files written are the ones `chant import --from` writes.
+ *
+ * chant's import already strips its ownership marker from every comment it
+ * reads, so the declarations say what an author would, and an object that
+ * carries no marker (one made by hand) reads the same as one chant made.
+ */
+import type { GeneratedFile } from "@intentius/chant/import/generator";
+import type { TemplateIR } from "@intentius/chant/import/parser";
+import { type Environment, type Project } from "../project.js";
+export interface LiveImport {
+    /** What the server holds, as chant's import IR: one resource per object. */
+    ir: TemplateIR;
+    /** The declaration files, paths relative to the source directory (chant's sql generator writes one, `schema.ts`). */
+    files: GeneratedFile[];
+    /** What the import left out or could not carry, as chant reports it. */
+    warnings: string[];
+}
+/** The objects an import read, as `<type> <name>` lines for people. */
+export declare function describeImported(ir: TemplateIR): string[];
+/**
+ * Reads the environment's live database and generates its declarations,
+ * exactly as `chant import --from <env>` does. Nothing is written.
+ */
+export declare function importLive(project: Project, env: Environment, processEnv?: NodeJS.ProcessEnv): Promise<LiveImport>;

package/dist/init/live.js

@@ -0,0 +1,45 @@
+/**
+ * Reading a live database as declarations: the library functions behind
+ * `chant import --from <env>`, called in process with the project's own
+ * config, so the server read is the one `sql.profiles.<env>` binds and the
+ * files written are the ones `chant import --from` writes.
+ *
+ * chant's import already strips its ownership marker from every comment it
+ * reads, so the declarations say what an author would, and an object that
+ * carries no marker (one made by hand) reads the same as one chant made.
+ */
+import { YodelError } from "../project.js";
+/** The objects an import read, as `<type> <name>` lines for people. */
+export function describeImported(ir) {
+    return ir.resources.map((r) => {
+        const p = r.properties;
+        const where = p.database ?? p.schema;
+        return `${r.type.replace(/^(ClickHouse|Postgres)::/, "")} ${where ? `${where}.` : ""}${p.name ?? r.logicalId}`;
+    });
+}
+/**
+ * Reads the environment's live database and generates its declarations,
+ * exactly as `chant import --from <env>` does. Nothing is written.
+ */
+export async function importLive(project, env, processEnv = process.env) {
+    const options = { environment: env.name, config: project.config, cwd: project.dir, env: processEnv };
+    let exported;
+    try {
+        if (project.dialect === "postgres") {
+            const { exportResources } = await import("@intentius/chant-lexicon-sql/postgres/import/live-export");
+            exported = await exportResources(options);
+        }
+        else {
+            const { exportResources } = await import("@intentius/chant-lexicon-sql/clickhouse/import/live-export");
+            exported = await exportResources(options);
+        }
+    }
+    catch (e) {
+        throw new YodelError(`reading ${env.name}'s live schema failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+    const ir = { resources: exported.resources, parameters: exported.parameters ?? [] };
+    const { sqlTemplateGenerator } = await import("@intentius/chant-lexicon-sql/import-generator");
+    const files = ir.resources.length === 0 ? [] : sqlTemplateGenerator.generate(ir);
+    return { ir, files, warnings: exported.warnings ?? [] };
+}
+//# sourceMappingURL=live.js.map

package/dist/init/live.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"live.js","sourceRoot":"","sources":["../../src/init/live.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,OAAO,EAAE,UAAU,EAAkC,MAAM,eAAe,CAAC;AAW3E,uEAAuE;AACvE,MAAM,UAAU,gBAAgB,CAAC,EAAc;IAC7C,OAAO,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QAC5B,MAAM,CAAC,GAAG,CAAC,CAAC,UAAmE,CAAC;QAChF,MAAM,KAAK,GAAG,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,MAAM,CAAC;QACrC,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,0BAA0B,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC;IACjH,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,OAAgB,EAAE,GAAgB,EAAE,aAAgC,OAAO,CAAC,GAAG;IAC9G,MAAM,OAAO,GAAG,EAAE,WAAW,EAAE,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,MAAe,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC;IAC9G,IAAI,QAA4G,CAAC;IACjH,IAAI,CAAC;QACH,IAAI,OAAO,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;YACnC,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,MAAM,CAAC,0DAA0D,CAAC,CAAC;YACrG,QAAQ,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,MAAM,CAAC,4DAA4D,CAAC,CAAC;YACvG,QAAQ,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,UAAU,CAAC,WAAW,GAAG,CAAC,IAAI,0BAA0B,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAClH,CAAC;IACD,MAAM,EAAE,GAAe,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,IAAI,EAAE,EAAE,CAAC;IAChG,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,MAAM,CAAC,+CAA+C,CAAC,CAAC;IAC/F,MAAM,KAAK,GAAG,EAAE,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,oBAAoB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACjF,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;AAC1D,CAAC"}

package/dist/lint/check.d.ts

@@ -0,0 +1,81 @@
+/**
+ * `yodel lint` over a migrations directory: every rule in `./rules.ts`,
+ * offline, with no server. Optionally against one environment's history
+ * (`--env`), which turns the checksum rule from "the files changed since
+ * yodel wrote them" into "an applied migration changed since it ran".
+ *
+ * Rules that need more than the directory, such as the replay check (#11),
+ * plug in as {@link ProjectRule}s through {@link LintOptions.rules}.
+ */
+import type { Project } from "../project.js";
+import { type MigrationScan } from "../migrations/index.js";
+import type { VersionedStatus } from "../versioned/state.js";
+import { type LintSettings } from "./config.js";
+import { type LintLevel, type LintRule } from "./rules.js";
+import { type Silence } from "./silences.js";
+import { type Dialect } from "./statements.js";
+/** One thing a rule found. */
+export interface Finding {
+    rule: string;
+    level: LintLevel;
+    message: string;
+    /** The migration it is in, when it is in one. */
+    migration?: string;
+    /** The step, an index into the migration's `steps`. */
+    step?: number;
+    /** The step's object on the server (`database.table`, `schema.table`). */
+    object?: string;
+    /** A line in migration.sql. */
+    line?: number;
+    /** Set when a `-- yodel:allow` line silenced it: the reason given. A silenced finding fails nothing. */
+    silenced?: string;
+}
+/** What a rule reports, before its level and any silence are applied. */
+export type RawFinding = Omit<Finding, "level" | "silenced"> & {
+    /** Overrides the rule's level for this one finding (a pending migration edited, with --env, is a warning). */
+    level?: LintLevel;
+};
+export interface LintContext {
+    /** The migrations directory, absolute. */
+    dir: string;
+    scan: MigrationScan;
+    dialect: Dialect | undefined;
+    project: Project | undefined;
+}
+/**
+ * A rule that checks the project as a whole and may reach a server or the
+ * emulator: the hook for the replay check (#11). Its findings get levels
+ * from `yodel.config.ts` like any rule's; `yodel lint --rules` lists it.
+ */
+export interface ProjectRule {
+    rule: LintRule;
+    check: (ctx: LintContext) => Promise<RawFinding[]>;
+}
+export interface LintOptions {
+    /** The project's dialect. Every migration must be this dialect. */
+    dialect?: Dialect;
+    project?: Project;
+    settings?: LintSettings;
+    /** An environment's history compared with the directory (`compareHistory`), for --env. */
+    history?: {
+        environment: string;
+        status: VersionedStatus;
+    };
+    /** More rules: the replay check (#11) plugs in here. */
+    rules?: readonly ProjectRule[];
+}
+export interface LintReport {
+    dir: string;
+    dialect: Dialect | undefined;
+    environment: string | undefined;
+    /** Every migration read, sorted by id. */
+    migrations: string[];
+    findings: Finding[];
+    /** The silences each migration's migration.sql holds, by migration id. */
+    silences: Record<string, Silence[]>;
+    errors: number;
+    warnings: number;
+    silenced: number;
+}
+/** Lints the migrations in `dir`. Never throws on what it finds; a finding is a result. */
+export declare function lintMigrations(dir: string, options?: LintOptions): Promise<LintReport>;