@adminiumjs/manifest 0.3.0-rc.3 → 0.3.0

package/dist/plan-context.js

@@ -0,0 +1,356 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+/**
+ * Planning an APP install with what the server knows about this connection:
+ * the app's prefix, the tables it already recorded here, what other apps
+ * record here, and the operator's answers for the tables whose names are taken.
+ *
+ * ─── Why a context at all ───────────────────────────────────────────────────
+ *
+ * Without one, a table either exists (reuse) or does not (create), and that
+ * was the whole plan. It could not tell the app's own table from an earlier
+ * install apart from another app's table of the same name, could not offer
+ * to rename a stranger's table out of the way, and could not give an app its
+ * own prefix. Each table is now CLASSIFIED first, then given an ACTION:
+ *
+ *   new           the real name is free                     → create
+ *   own-leftover  this app recorded it (an earlier install) → reuse (default)
+ *   shared        another app recorded it under the SAME shape (`menu@1`)
+ *                                                            → share (default)
+ *   taken         it exists and nothing records it as this app's
+ *                                                            → the operator chooses
+ *
+ * For a taken table the operator chooses: REUSE it (offered only when it is
+ * not another app's in disguise and every change it needs is safe), RENAME the
+ * existing table out of the way (only when no other install records it), or
+ * give the whole app a DIFFERENT PREFIX (always offered, and it applies to
+ * every table at once). Until each taken table has an answer, the plan is not
+ * installable and says which table is waiting.
+ *
+ * ─── Edits ─────────────────────────────────────────────────────────────────
+ *
+ * A reused table may need changes before the app can write to it. Only changes
+ * that cannot lose data are ever offered: adding a missing column (nullable),
+ * widening a type along a fixed list (a longer varchar, varchar to text, int
+ * to bigint, a wider enum column), giving an int key the identity it lacks, and
+ * adding enum values. Anything else is refused on this screen, by name.
+ *
+ * Pure, like the planner it extends: no I/O. The server gathers the context.
+ */
+import { typeConflict } from './plan-types.js';
+/** The longest identifier each engine accepts, in bytes. SQLite has none; the portable 63 holds. */
+export const IDENTIFIER_LIMIT = {
+    postgres: 63,
+    mysql: 64,
+    sqlite: 63,
+};
+/** `adminium_roles.slug` is 40 characters. */
+export const ROLE_SLUG_LIMIT = 40;
+const IDENTIFIER = /^[a-z][a-z0-9_]*$/;
+function byteLength(text) {
+    return new TextEncoder().encode(text).length;
+}
+/** The type a declared column is created with, for an edit's `to` — the installer's own vocabulary. */
+function declaredShape(column) {
+    if (column.type === 'text' && column.maxLength !== undefined)
+        return `varchar(${String(column.maxLength)})`;
+    if (column.type === 'enum') {
+        const width = (column.enum ?? []).every((value) => value.length <= 32) ? 32 : 64;
+        return `varchar(${String(width)})`;
+    }
+    return column.type;
+}
+/**
+ * The widening that would let an existing column hold what the manifest
+ * stores, or null when there is no such safe change.
+ */
+function wideningFor(declared, have, dialect) {
+    const type = have.logicalType;
+    const width = typeof have.maxLength === 'number' ? have.maxLength : null;
+    if (declared.type === 'text' && type === 'varchar' && width !== null) {
+        return { from: `varchar(${String(width)})`, to: declaredShape(declared) };
+    }
+    if (declared.type === 'enum' && type === 'varchar' && width !== null) {
+        return { from: `varchar(${String(width)})`, to: declaredShape(declared) };
+    }
+    if (declared.type === 'bigint' && type === 'integer') {
+        // MySQL cannot change the type of a key another table's foreign key points
+        // at; a primary key is where that is all but certain.
+        if (dialect === 'mysql' && have.isPrimaryKey === true)
+            return null;
+        return { from: 'integer', to: 'bigint' };
+    }
+    return null;
+}
+/**
+ * A column an update can add to a table that exists. A link (`fk`) can, when
+ * it is nullable: every existing row starts unlinked, and the schema editor
+ * adds the foreign key beside it. A required link cannot — the rows already
+ * there would have nothing to point at.
+ */
+function isOfferable(column) {
+    if (column.type === 'fk')
+        return column.nullable === true;
+    return column.type !== 'id' && column.type !== 'blob';
+}
+/**
+ * The context half of `planInstall`. Called by it when a context is given;
+ * the returned plan keeps every field older callers read (`create`, `reuse`,
+ * `references`, `problems`) and adds `tables` and `names`.
+ */
+export function planWithContext(manifest, model, context) {
+    const noun = manifest.kind === 'app' ? 'app' : 'add-on';
+    const required = manifest.requiredSchema?.tables ?? [];
+    const live = new Map(model.tables.map((t) => [t.ref, t]));
+    const limit = IDENTIFIER_LIMIT[context.dialect];
+    const problems = [];
+    const prefix = context.prefix === null ? null : (context.altPrefix ?? context.prefix);
+    if (context.altPrefix !== undefined && !/^[a-z][a-z0-9_]*_$/.test(context.altPrefix)) {
+        problems.push({
+            code: 'IDENTIFIER_TOO_LONG',
+            table: context.altPrefix,
+            message: `"${context.altPrefix}" is not a usable prefix: lower-case letters, digits and "_", ending in "_".`,
+        });
+    }
+    // 1. Real names. A record wins (it is what this app already uses here); an
+    //    alternative prefix re-names everything that is not recorded.
+    const names = {};
+    for (const table of required) {
+        const record = context.records[table.ref];
+        const usable = record !== undefined && record.state !== 'dropped';
+        names[table.ref] = usable && context.altPrefix === undefined ? record.table : prefix === null ? table.ref : `${prefix}${table.ref}`;
+    }
+    const realNames = new Set(Object.values(names));
+    const tables = [];
+    for (const table of required) {
+        const real = names[table.ref];
+        const record = context.records[table.ref];
+        const existing = live.get(real);
+        const holders = context.others.filter((o) => o.table === real && o.state !== 'dropped');
+        const choice = context.choices?.[table.ref];
+        if (byteLength(real) > limit) {
+            problems.push({
+                code: 'IDENTIFIER_TOO_LONG',
+                table: table.ref,
+                message: `"${real}" is longer than this database allows (${String(limit)} bytes). Choose a shorter prefix.`,
+            });
+        }
+        for (const column of table.columns) {
+            if (column.type !== 'fk')
+                continue;
+            const fk = `fk_${real}_${column.ref}`;
+            if (byteLength(fk) > limit) {
+                problems.push({
+                    code: 'IDENTIFIER_TOO_LONG',
+                    table: table.ref,
+                    column: column.ref,
+                    message: `The foreign key "${fk}" would be longer than this database allows (${String(limit)} bytes). Choose a shorter prefix.`,
+                });
+            }
+        }
+        // 2. Classify.
+        const ownRecord = record !== undefined && record.state !== 'dropped' && context.altPrefix === undefined;
+        const sharer = table.shape === undefined ? undefined : holders.find((o) => o.shape === table.shape && o.state !== 'released');
+        const klass = existing === undefined ? 'new' : ownRecord ? 'own-leftover' : sharer !== undefined ? 'shared' : 'taken';
+        // Two apps whose prefixed names meet. A declared shape both share is the
+        // one way two apps may use one table.
+        if (holders.length > 0 && sharer === undefined && !ownRecord) {
+            problems.push({
+                code: 'PREFIX_COLLISION',
+                table: table.ref,
+                message: `"${real}" is already "${holders[0].appKey}"'s table, so this ${noun} cannot use that name. ` +
+                    `Give this ${noun} a different prefix.`,
+            });
+        }
+        // Why reuse is not safe for a stranger's table.
+        const declaredColumns = new Set(table.columns.map((c) => c.ref));
+        const foreign = existing === undefined
+            ? []
+            : existing.columns.filter((c) => !declaredColumns.has(c.ref) &&
+                c.nullable === false &&
+                c.hasDefault !== true &&
+                c.isPrimaryKey !== true &&
+                c.isGenerated !== true);
+        const plan = {
+            ref: table.ref,
+            table: real,
+            class: klass,
+            action: 'create',
+            offers: [],
+            edits: [],
+            blocked: [],
+        };
+        if (klass === 'new') {
+            plan.action = 'create';
+        }
+        else if (klass === 'own-leftover') {
+            plan.offers = ['reuse', 'rename-existing', 'alt-prefix'];
+            if (record?.owned === false)
+                plan.adopted = true;
+            plan.action = choice?.action === 'rename-existing' ? 'rename-existing' : 'reuse';
+        }
+        else if (klass === 'shared') {
+            plan.offers = ['share', 'alt-prefix'];
+            plan.sharedWith = sharer.appKey;
+            plan.action = 'share';
+        }
+        else {
+            plan.offers = ['alt-prefix'];
+            if (foreign.length === 0)
+                plan.offers.unshift('reuse');
+            else {
+                plan.reuseRefusal =
+                    `It requires ${foreign.map((c) => `"${c.ref}"`).join(', ')}, which this ${noun} never fills, ` +
+                        `so every row the ${noun} saves there would be refused.`;
+            }
+            if (holders.length === 0)
+                plan.offers.splice(plan.offers.length - 1, 0, 'rename-existing');
+            if (choice === undefined)
+                plan.action = 'undecided';
+            else if (choice.action === 'reuse' && plan.offers.includes('reuse'))
+                plan.action = 'reuse';
+            else if (choice.action === 'rename-existing' && plan.offers.includes('rename-existing'))
+                plan.action = 'rename-existing';
+            else
+                plan.action = 'undecided';
+        }
+        if (plan.action === 'rename-existing') {
+            const to = choice?.action === 'rename-existing' ? choice.to : `${real}_old`;
+            plan.renameExistingTo = to;
+            if (!IDENTIFIER.test(to) || byteLength(to) > limit || live.has(to) || realNames.has(to)) {
+                problems.push({
+                    code: 'TABLE_TAKEN',
+                    table: table.ref,
+                    message: `"${to}" cannot be the existing table's new name: it must be a free, lower-case name of at most ${String(limit)} bytes.`,
+                });
+            }
+        }
+        if (plan.action === 'undecided') {
+            problems.push({
+                code: 'TABLE_TAKEN',
+                table: table.ref,
+                message: `"${real}" already exists and was made by hand. Pick what to do with it before you install.`,
+            });
+        }
+        // 3. Edits, for a table the app will use as it is.
+        if ((plan.action === 'reuse' || plan.action === 'share') && existing !== undefined) {
+            for (const column of table.columns) {
+                const have = existing.columns.find((c) => c.ref === column.ref);
+                if (have === undefined) {
+                    if (isOfferable(column))
+                        plan.edits.push({ kind: 'add-column', column: column.ref });
+                    else {
+                        plan.blocked.push({
+                            column: column.ref,
+                            reason: column.type === 'id' ? 'primary-key' : column.type === 'fk' ? 'foreign-key' : 'unsupported-type',
+                        });
+                    }
+                    continue;
+                }
+                const conflict = typeConflict(column, have, context.dialect);
+                if (conflict !== null) {
+                    const widen = wideningFor(column, have, context.dialect);
+                    if (widen !== null)
+                        plan.edits.push({ kind: 'widen', column: column.ref, ...widen });
+                    else {
+                        problems.push({
+                            code: 'COLUMN_TYPE_CONFLICT',
+                            table: table.ref,
+                            column: column.ref,
+                            message: `"${real}.${column.ref}" already exists as ${conflict}, which cannot hold the ${column.type} values this ${noun} stores in it.`,
+                        });
+                    }
+                    continue;
+                }
+                if (column.role === 'pk' && (column.type === 'int' || column.type === 'bigint') && have.isIdentity === false) {
+                    plan.edits.push({ kind: 'set-identity', column: column.ref });
+                }
+                if (column.type === 'enum' && have.enumValues !== undefined) {
+                    const missing = (column.enum ?? []).filter((value) => !have.enumValues.includes(value));
+                    if (missing.length > 0)
+                        plan.edits.push({ kind: 'enum-values', column: column.ref, values: missing });
+                }
+            }
+            if (plan.blocked.length > 0) {
+                problems.push({
+                    code: 'COLUMNS_REQUIRED',
+                    table: table.ref,
+                    column: plan.blocked[0].column,
+                    message: `"${real}" is missing ${plan.blocked.map((b) => `"${b.column}"`).join(', ')}, which cannot be added ` +
+                        `to a table that already exists. Rename that table out of the way, or use a different prefix.`,
+                });
+            }
+        }
+        tables.push(plan);
+    }
+    // 4. References, against real names.
+    const references = [];
+    const declared = new Set(required.map((t) => t.ref));
+    for (const table of required) {
+        for (const column of table.columns) {
+            if (column.type !== 'fk' || column.references === undefined)
+                continue;
+            const target = column.references;
+            const resolution = declared.has(target) ? 'internal' : live.has(target) ? 'host' : 'unresolved';
+            references.push({ fromTable: table.ref, fromColumn: column.ref, to: target, resolution });
+            if (resolution === 'unresolved') {
+                problems.push({
+                    code: 'UNRESOLVED_REFERENCE',
+                    table: table.ref,
+                    column: column.ref,
+                    message: `"${table.ref}.${column.ref}" points at a table called "${target}", which this ` +
+                        `${noun} does not create and this database does not have. Connect a database that ` +
+                        `already has it, or create it first.`,
+                });
+            }
+        }
+    }
+    // 5. Role slugs fit their column.
+    if (manifest.kind === 'app') {
+        for (const role of manifest.roles ?? []) {
+            const slug = `${manifest.key}-${role.key}`;
+            if (slug.length > ROLE_SLUG_LIMIT) {
+                problems.push({
+                    code: 'IDENTIFIER_TOO_LONG',
+                    table: role.key,
+                    message: `The role "${slug}" is longer than ${String(ROLE_SLUG_LIMIT)} characters.`,
+                });
+            }
+        }
+    }
+    for (const table of required) {
+        if (table.ref.startsWith('adminium_') || names[table.ref].startsWith('adminium_')) {
+            problems.push({
+                code: 'RESERVED_TABLE',
+                table: table.ref,
+                message: `"${names[table.ref]}" is in Adminium's own namespace.`,
+            });
+        }
+    }
+    const planned = (plan) => {
+        const spec = required.find((t) => t.ref === plan.ref);
+        const have = live.get(plan.table);
+        const missing = plan.action === 'reuse' || plan.action === 'share'
+            ? spec.columns.filter((c) => have !== undefined && !have.columns.some((x) => x.ref === c.ref)).map((c) => c.ref)
+            : [];
+        return {
+            ref: plan.ref,
+            table: plan.table,
+            action: plan.action === 'reuse' || plan.action === 'share' ? 'reuse' : 'create',
+            columns: spec.columns.map((c) => ({ ref: c.ref, type: c.type, missing: missing.includes(c.ref) })),
+            missingColumns: missing,
+        };
+    };
+    return {
+        addOnKey: manifest.key,
+        version: manifest.version,
+        create: tables.filter((t) => t.action === 'create' || t.action === 'rename-existing').map(planned),
+        reuse: tables.filter((t) => t.action === 'reuse' || t.action === 'share').map(planned),
+        references,
+        problems,
+        installable: problems.length === 0,
+        touchesData: required.length > 0,
+        tables,
+        names,
+    };
+}
+//# sourceMappingURL=plan-context.js.map

package/dist/plan-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan-context.js","sourceRoot":"","sources":["../src/plan-context.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAWH,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAc/C,oGAAoG;AACpG,MAAM,CAAC,MAAM,gBAAgB,GAAqD;IAChF,QAAQ,EAAE,EAAE;IACZ,KAAK,EAAE,EAAE;IACT,MAAM,EAAE,EAAE;CACX,CAAC;AAEF,8CAA8C;AAC9C,MAAM,CAAC,MAAM,eAAe,GAAG,EAAE,CAAC;AAElC,MAAM,UAAU,GAAG,mBAAmB,CAAC;AAEvC,SAAS,UAAU,CAAC,IAAY;IAC9B,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;AAC/C,CAAC;AAED,uGAAuG;AACvG,SAAS,aAAa,CAAC,MAAsB;IAC3C,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS;QAAE,OAAO,WAAW,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;IAC5G,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAC3B,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjF,OAAO,WAAW,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;IACrC,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC;AACrB,CAAC;AAED;;;GAGG;AACH,SAAS,WAAW,CAClB,QAAwB,EACxB,IAAwB,EACxB,OAA+B;IAE/B,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC;IAC9B,MAAM,KAAK,GAAG,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;IACzE,IAAI,QAAQ,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACrE,OAAO,EAAE,IAAI,EAAE,WAAW,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,EAAE,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC5E,CAAC;IACD,IAAI,QAAQ,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACrE,OAAO,EAAE,IAAI,EAAE,WAAW,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,EAAE,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC5E,CAAC;IACD,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrD,2EAA2E;QAC3E,sDAAsD;QACtD,IAAI,OAAO,KAAK,OAAO,IAAI,IAAI,CAAC,YAAY,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC;QACnE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC;IAC3C,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,MAAsB;IACzC,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI;QAAE,OAAO,MAAM,CAAC,QAAQ,KAAK,IAAI,CAAC;IAC1D,OAAO,MAAM,CAAC,IAAI,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC;AACxD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAC7B,QAAkB,EAClB,KAAsB,EACtB,OAAoB;IAEpB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;IACxD,MAAM,QAAQ,GAA6B,QAAQ,CAAC,cAAc,EAAE,MAAM,IAAI,EAAE,CAAC;IACjF,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,MAAM,KAAK,GAAG,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAChD,MAAM,QAAQ,GAAkB,EAAE,CAAC;IACnC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEtF,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;QACrF,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,qBAAqB;YAC3B,KAAK,EAAE,OAAO,CAAC,SAAS;YACxB,OAAO,EAAE,IAAI,OAAO,CAAC,SAAS,8EAA8E;SAC7G,CAAC,CAAC;IACL,CAAC;IAED,2EAA2E;IAC3E,kEAAkE;IAClE,MAAM,KAAK,GAA2B,EAAE,CAAC;IACzC,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC7B,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC;QAClE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;IACtI,CAAC;IACD,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAEhD,MAAM,MAAM,GAAuB,EAAE,CAAC;IACtC,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC7B,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAE,CAAC;QAC/B,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChC,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;QACxF,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE5C,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC;YAC7B,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,qBAAqB;gBAC3B,KAAK,EAAE,KAAK,CAAC,GAAG;gBAChB,OAAO,EAAE,IAAI,IAAI,0CAA0C,MAAM,CAAC,KAAK,CAAC,mCAAmC;aAC5G,CAAC,CAAC;QACL,CAAC;QACD,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACnC,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI;gBAAE,SAAS;YACnC,MAAM,EAAE,GAAG,MAAM,IAAI,IAAI,MAAM,CAAC,GAAG,EAAE,CAAC;YACtC,IAAI,UAAU,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC;gBAC3B,QAAQ,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,qBAAqB;oBAC3B,KAAK,EAAE,KAAK,CAAC,GAAG;oBAChB,MAAM,EAAE,MAAM,CAAC,GAAG;oBAClB,OAAO,EAAE,oBAAoB,EAAE,gDAAgD,MAAM,CAAC,KAAK,CAAC,mCAAmC;iBAChI,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,eAAe;QACf,MAAM,SAAS,GAAG,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC;QACxG,MAAM,MAAM,GACV,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC;QACjH,MAAM,KAAK,GACT,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC;QAE1G,yEAAyE;QACzE,sCAAsC;QACtC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,SAAS,EAAE,CAAC;YAC7D,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,kBAAkB;gBACxB,KAAK,EAAE,KAAK,CAAC,GAAG;gBAChB,OAAO,EACL,IAAI,IAAI,iBAAiB,OAAO,CAAC,CAAC,CAAE,CAAC,MAAM,sBAAsB,IAAI,yBAAyB;oBAC9F,aAAa,IAAI,sBAAsB;aAC1C,CAAC,CAAC;QACL,CAAC;QAED,gDAAgD;QAChD,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACjE,MAAM,OAAO,GACX,QAAQ,KAAK,SAAS;YACpB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CACrB,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;gBAC3B,CAAC,CAAC,QAAQ,KAAK,KAAK;gBACpB,CAAC,CAAC,UAAU,KAAK,IAAI;gBACrB,CAAC,CAAC,YAAY,KAAK,IAAI;gBACvB,CAAC,CAAC,WAAW,KAAK,IAAI,CACzB,CAAC;QAER,MAAM,IAAI,GAAqB;YAC7B,GAAG,EAAE,KAAK,CAAC,GAAG;YACd,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,EAAE;YACV,KAAK,EAAE,EAAE;YACT,OAAO,EAAE,EAAE;SACZ,CAAC;QAEF,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;YACpB,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC;QACzB,CAAC;aAAM,IAAI,KAAK,KAAK,cAAc,EAAE,CAAC;YACpC,IAAI,CAAC,MAAM,GAAG,CAAC,OAAO,EAAE,iBAAiB,EAAE,YAAY,CAAC,CAAC;YACzD,IAAI,MAAM,EAAE,KAAK,KAAK,KAAK;gBAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACjD,IAAI,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,KAAK,iBAAiB,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,OAAO,CAAC;QACnF,CAAC;aAAM,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC,MAAM,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;YACtC,IAAI,CAAC,UAAU,GAAG,MAAO,CAAC,MAAM,CAAC;YACjC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,GAAG,CAAC,YAAY,CAAC,CAAC;YAC7B,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;gBAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;iBAClD,CAAC;gBACJ,IAAI,CAAC,YAAY;oBACf,eAAe,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,IAAI,gBAAgB;wBAC9F,oBAAoB,IAAI,gCAAgC,CAAC;YAC7D,CAAC;YACD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;gBAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,iBAAiB,CAAC,CAAC;YAC3F,IAAI,MAAM,KAAK,SAAS;gBAAE,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;iBAC/C,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAAE,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;iBACtF,IAAI,MAAM,CAAC,MAAM,KAAK,iBAAiB,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC;gBAAE,IAAI,CAAC,MAAM,GAAG,iBAAiB,CAAC;;gBACpH,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;QACjC,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,KAAK,iBAAiB,EAAE,CAAC;YACtC,MAAM,EAAE,GAAG,MAAM,EAAE,MAAM,KAAK,iBAAiB,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,MAAM,CAAC;YAC5E,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;gBACxF,QAAQ,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,aAAa;oBACnB,KAAK,EAAE,KAAK,CAAC,GAAG;oBAChB,OAAO,EAAE,IAAI,EAAE,4FAA4F,MAAM,CAAC,KAAK,CAAC,SAAS;iBAClI,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;YAChC,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,aAAa;gBACnB,KAAK,EAAE,KAAK,CAAC,GAAG;gBAChB,OAAO,EAAE,IAAI,IAAI,oFAAoF;aACtG,CAAC,CAAC;QACL,CAAC;QAED,mDAAmD;QACnD,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,OAAO,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO,CAAC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACnF,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;gBACnC,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC;gBAChE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;oBACvB,IAAI,WAAW,CAAC,MAAM,CAAC;wBAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC;yBAChF,CAAC;wBACJ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;4BAChB,MAAM,EAAE,MAAM,CAAC,GAAG;4BAClB,MAAM,EAAE,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,kBAAkB;yBACzG,CAAC,CAAC;oBACL,CAAC;oBACD,SAAS;gBACX,CAAC;gBACD,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;gBAC7D,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;oBACtB,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;oBACzD,IAAI,KAAK,KAAK,IAAI;wBAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;yBAChF,CAAC;wBACJ,QAAQ,CAAC,IAAI,CAAC;4BACZ,IAAI,EAAE,sBAAsB;4BAC5B,KAAK,EAAE,KAAK,CAAC,GAAG;4BAChB,MAAM,EAAE,MAAM,CAAC,GAAG;4BAClB,OAAO,EAAE,IAAI,IAAI,IAAI,MAAM,CAAC,GAAG,uBAAuB,QAAQ,2BAA2B,MAAM,CAAC,IAAI,gBAAgB,IAAI,gBAAgB;yBACzI,CAAC,CAAC;oBACL,CAAC;oBACD,SAAS;gBACX,CAAC;gBACD,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,KAAK,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;oBAC7G,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC;gBAChE,CAAC;gBACD,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;oBAC5D,MAAM,OAAO,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,UAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;oBACzF,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;wBAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;gBACxG,CAAC;YACH,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC5B,QAAQ,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,kBAAkB;oBACxB,KAAK,EAAE,KAAK,CAAC,GAAG;oBAChB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAE,CAAC,MAAM;oBAC/B,OAAO,EACL,IAAI,IAAI,gBAAgB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B;wBACrG,8FAA8F;iBACjG,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;IAED,qCAAqC;IACrC,MAAM,UAAU,GAA8B,EAAE,CAAC;IACjD,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACrD,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC7B,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACnC,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS;gBAAE,SAAS;YACtE,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC;YACjC,MAAM,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC;YAChG,UAAU,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,GAAG,EAAE,UAAU,EAAE,MAAM,CAAC,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;YAC1F,IAAI,UAAU,KAAK,YAAY,EAAE,CAAC;gBAChC,QAAQ,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,sBAAsB;oBAC5B,KAAK,EAAE,KAAK,CAAC,GAAG;oBAChB,MAAM,EAAE,MAAM,CAAC,GAAG;oBAClB,OAAO,EACL,IAAI,KAAK,CAAC,GAAG,IAAI,MAAM,CAAC,GAAG,+BAA+B,MAAM,gBAAgB;wBAChF,GAAG,IAAI,4EAA4E;wBACnF,qCAAqC;iBACxC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IAED,kCAAkC;IAClC,IAAI,QAAQ,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QAC5B,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC;YACxC,MAAM,IAAI,GAAG,GAAG,QAAQ,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YAC3C,IAAI,IAAI,CAAC,MAAM,GAAG,eAAe,EAAE,CAAC;gBAClC,QAAQ,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,qBAAqB;oBAC3B,KAAK,EAAE,IAAI,CAAC,GAAG;oBACf,OAAO,EAAE,aAAa,IAAI,oBAAoB,MAAM,CAAC,eAAe,CAAC,cAAc;iBACpF,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC7B,IAAI,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,CAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YACnF,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,gBAAgB;gBACtB,KAAK,EAAE,KAAK,CAAC,GAAG;gBAChB,OAAO,EAAE,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,CAAE,mCAAmC;aAClE,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,CAAC,IAAsB,EAAE,EAAE;QACzC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,CAAE,CAAC;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,KAAK,OAAO,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO;YAChE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;YAChH,CAAC,CAAC,EAAE,CAAC;QACP,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,MAAM,KAAK,OAAO,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO,CAAC,CAAC,CAAE,OAAiB,CAAC,CAAC,CAAE,QAAkB;YACrG,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAClG,cAAc,EAAE,OAAO;SACxB,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO;QACL,QAAQ,EAAE,QAAQ,CAAC,GAAG;QACtB,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,KAAK,iBAAiB,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC;QAClG,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,OAAO,IAAI,CAAC,CAAC,MAAM,KAAK,OAAO,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC;QACtF,UAAU;QACV,QAAQ;QACR,WAAW,EAAE,QAAQ,CAAC,MAAM,KAAK,CAAC;QAClC,WAAW,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC;QAChC,MAAM;QACN,KAAK;KACN,CAAC;AACJ,CAAC"}

package/dist/plan-model.d.ts

@@ -0,0 +1,197 @@
+/**
+ * The install planner's shapes, on their own.
+ *
+ * Types only, so the planner (`plan.ts`), its context extension
+ * (`plan-context.ts`) and the type rules (`plan-types.ts`) can all name them
+ * without importing one another in a circle. `plan.ts` and `plan-context.ts`
+ * re-export them, so every importer outside keeps its path.
+ */
+/** The existing database, as much of it as planning needs. */
+export interface SchemaModelView {
+    /** Every table name that already exists, however it got there. */
+    tables: readonly {
+        ref: string;
+        columns: readonly ExistingColumnView[];
+    }[];
+    /**
+     * The engine the tables live on. Only the type check reads it: SQLite
+     * reports the installer's own `bool` as `integer` and its `money` as
+     * `float`, which would be a conflict anywhere else. Absent, a type is judged
+     * by the rules every engine shares.
+     */
+    dialect?: 'postgres' | 'mysql' | 'sqlite' | undefined;
+}
+/**
+ * One existing column. Only `ref` is required; the rest is what the database
+ * reports, and a caller that does not know it leaves it out. A column that
+ * says nothing is never treated as required.
+ */
+export interface ExistingColumnView {
+    ref: string;
+    nullable?: boolean;
+    /** The database fills it when an insert leaves it out (a default, a sequence). */
+    hasDefault?: boolean;
+    isPrimaryKey?: boolean;
+    isGenerated?: boolean;
+    /** The engine's logical type (`integer`, `varchar`, …). Absent = not judged. */
+    logicalType?: string;
+    /** A `varchar`'s width, when it has one. */
+    maxLength?: number | null;
+    /** A key the database numbers itself. Absent = unknown, never offered a repair. */
+    isIdentity?: boolean;
+    /** The values an enum column's CHECK (or native enum) admits, when it has one. */
+    enumValues?: readonly string[];
+}
+/** What will happen to one table. */
+export type TableAction = 'create' | 'reuse';
+export interface PlannedColumn {
+    ref: string;
+    type: string;
+    /** Absent from an existing table, so the install would have to add it. */
+    missing: boolean;
+}
+export interface PlannedTable {
+    ref: string;
+    /** The real table name, when a plan context gave the table one (prefixed or recorded). */
+    table?: string;
+    action: TableAction;
+    columns: PlannedColumn[];
+    /**
+     * Only on `reuse`: columns the manifest requires that the existing table does
+     * not have. A non-empty list is a PARTIAL MATCH — the table is there but does
+     * not carry what the add-on needs, which is a different situation from either
+     * "create it" or "it fits", and the operator should be told which.
+     */
+    missingColumns: string[];
+}
+/** Where one declared foreign key ends up pointing. */
+export interface PlannedReference {
+    fromTable: string;
+    fromColumn: string;
+    to: string;
+    /**
+     * `internal` — the target is another table in this manifest.
+     * `host` — the target already exists in the database (the add-on attaching to
+     *   the host's data, which is the intended shape).
+     * `unresolved` — the target exists nowhere, and the plan is not installable.
+     */
+    resolution: 'internal' | 'host' | 'unresolved';
+}
+/** A reason the plan cannot be applied, phrased for a person. */
+export interface PlanProblem {
+    code: 'UNRESOLVED_REFERENCE' | 'COLUMN_TYPE_CONFLICT' | 'COLUMNS_REQUIRED' | 'RESERVED_TABLE' | 'FOREIGN_TABLE' | 'TABLE_TAKEN' | 'IDENTIFIER_TOO_LONG' | 'PREFIX_COLLISION' | 'PAGE_SLUG_TAKEN' | 'PAGE_FORM_INVALID' | 'ROLE_INVALID' | 'EMAIL_TEMPLATE_INVALID';
+    message: string;
+    table: string;
+    column?: string;
+}
+export interface InstallPlan {
+    /**
+     * The manifest key this plan is for.
+     *
+     * Named `addOnKey` because add-ons were the only caller when it was written,
+     * and left named that because the wire DTOs each route builds are where a
+     * reader meets it — `routes/apps` spells it `key` on its own reply. Renaming
+     * it here would churn three call sites and a shipped dialog for a field only
+     * the server reads.
+     */
+    addOnKey: string;
+    version: string;
+    /** Tables to create, in declaration order (targets before dependents). */
+    create: PlannedTable[];
+    /** Tables that already exist and will be reused rather than created. */
+    reuse: PlannedTable[];
+    references: PlannedReference[];
+    problems: PlanProblem[];
+    /**
+     * `true` when there is nothing standing in the way. A plan with problems is
+     * still RETURNED — the consent dialog has to be able to show WHY an add-on
+     * cannot be installed here, and an exception would leave it with nothing to
+     * render.
+     */
+    installable: boolean;
+    /** No `requiredSchema` at all: install touches no data source. */
+    touchesData: boolean;
+    /** With a plan context: each table's class, action, offers and edits. */
+    tables?: InstallTablePlan[];
+    /** With a plan context: short name → real table. */
+    names?: Record<string, string>;
+}
+/** What the operator answered for one taken table. */
+export type TableChoice = {
+    action: 'reuse';
+} | {
+    action: 'share';
+} | {
+    action: 'rename-existing';
+    to: string;
+};
+export interface PlanContext {
+    /** The app's own prefix (`pos_`), or null for an app whose tables are not prefixed. */
+    prefix: string | null;
+    /** A different prefix for every table of this app, chosen on the check step. */
+    altPrefix?: string | undefined;
+    /** This app's own records on this connection, by short name. */
+    records: Readonly<Record<string, {
+        table: string;
+        owned: boolean;
+        state: string;
+    }>>;
+    /** What OTHER apps record on this connection. */
+    others: readonly {
+        appKey: string;
+        table: string;
+        shape: string | null;
+        state: string;
+    }[];
+    /** The operator's answers, by short name. */
+    choices?: Readonly<Record<string, TableChoice>> | undefined;
+    dialect: 'postgres' | 'mysql' | 'sqlite';
+}
+export type TableClass = 'new' | 'own-leftover' | 'shared' | 'taken';
+export type ContextTableAction = 'create' | 'reuse' | 'share' | 'rename-existing' | 'undecided';
+export type TableOffer = 'reuse' | 'share' | 'rename-existing' | 'alt-prefix';
+/** One change a reused table needs, every one of them unable to lose data. */
+export type PlanEdit = {
+    kind: 'add-column';
+    column: string;
+} | {
+    kind: 'widen';
+    column: string;
+    from: string;
+    to: string;
+} | {
+    kind: 'set-identity';
+    column: string;
+} | {
+    kind: 'enum-values';
+    column: string;
+    values: string[];
+};
+export interface InstallTablePlan {
+    /** The manifest's short name. */
+    ref: string;
+    /** The real table: prefixed, recorded, or the ref itself. */
+    table: string;
+    class: TableClass;
+    action: ContextTableAction;
+    /** What the check step offers for this table. */
+    offers: TableOffer[];
+    /** Why reuse is NOT offered on a taken table, for a person. */
+    reuseRefusal?: string | undefined;
+    /** For `rename-existing`: what the existing table is renamed to. */
+    renameExistingTo?: string | undefined;
+    /** For `share`: the app whose table this is. */
+    sharedWith?: string | undefined;
+    /**
+     * For `own-leftover`: the earlier install used a table that was already
+     * there rather than making it. The check step words the two apart.
+     */
+    adopted?: true | undefined;
+    edits: PlanEdit[];
+    /** Columns that cannot be added this way, and why. */
+    blocked: {
+        column: string;
+        reason: 'foreign-key' | 'primary-key' | 'unsupported-type';
+    }[];
+}
+//# sourceMappingURL=plan-model.d.ts.map

package/dist/plan-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan-model.d.ts","sourceRoot":"","sources":["../src/plan-model.ts"],"names":[],"mappings":"AACA;;;;;;;GAOG;AAEH,8DAA8D;AAC9D,MAAM,WAAW,eAAe;IAC9B,kEAAkE;IAClE,MAAM,EAAE,SAAS;QACf,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,SAAS,kBAAkB,EAAE,CAAC;KACxC,EAAE,CAAC;IACJ;;;;;OAKG;IACH,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;CACvD;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kFAAkF;IAClF,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,gFAAgF;IAChF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4CAA4C;IAC5C,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,mFAAmF;IACnF,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,kFAAkF;IAClF,UAAU,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAChC;AAED,qCAAqC;AACrC,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE7C,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,0EAA0E;IAC1E,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,0FAA0F;IAC1F,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,WAAW,CAAC;IACpB,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB;;;;;OAKG;IACH,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED,uDAAuD;AACvD,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX;;;;;OAKG;IACH,UAAU,EAAE,UAAU,GAAG,MAAM,GAAG,YAAY,CAAC;CAChD;AAED,iEAAiE;AACjE,MAAM,WAAW,WAAW;IAC1B,IAAI,EACA,sBAAsB,GACtB,sBAAsB,GACtB,kBAAkB,GAClB,gBAAgB,GAChB,eAAe,GAGf,aAAa,GACb,qBAAqB,GACrB,kBAAkB,GAElB,iBAAiB,GACjB,mBAAmB,GACnB,cAAc,GAEd,wBAAwB,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,WAAW;IAC1B;;;;;;;;OAQG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,0EAA0E;IAC1E,MAAM,EAAE,YAAY,EAAE,CAAC;IACvB,wEAAwE;IACxE,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,UAAU,EAAE,gBAAgB,EAAE,CAAC;IAC/B,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB;;;;;OAKG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB,kEAAkE;IAClE,WAAW,EAAE,OAAO,CAAC;IACrB,yEAAyE;IACzE,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC5B,oDAAoD;IACpD,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC;AAED,sDAAsD;AACtD,MAAM,MAAM,WAAW,GACnB;IAAE,MAAM,EAAE,OAAO,CAAA;CAAE,GACnB;IAAE,MAAM,EAAE,OAAO,CAAA;CAAE,GACnB;IAAE,MAAM,EAAE,iBAAiB,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9C,MAAM,WAAW,WAAW;IAC1B,uFAAuF;IACvF,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,gFAAgF;IAChF,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,gEAAgE;IAChE,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC,CAAC;IACpF,iDAAiD;IACjD,MAAM,EAAE,SAAS;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC1F,6CAA6C;IAC7C,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,GAAG,SAAS,CAAC;IAC5D,OAAO,EAAE,UAAU,GAAG,OAAO,GAAG,QAAQ,CAAC;CAC1C;AAED,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,cAAc,GAAG,QAAQ,GAAG,OAAO,CAAC;AACrE,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,iBAAiB,GAAG,WAAW,CAAC;AAChG,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,OAAO,GAAG,iBAAiB,GAAG,YAAY,CAAC;AAE9E,8EAA8E;AAC9E,MAAM,MAAM,QAAQ,GAChB;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACtC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,GAC3D;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACxC;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAE9D,MAAM,WAAW,gBAAgB;IAC/B,iCAAiC;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,UAAU,CAAC;IAClB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,iDAAiD;IACjD,MAAM,EAAE,UAAU,EAAE,CAAC;IACrB,+DAA+D;IAC/D,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,oEAAoE;IACpE,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,gDAAgD;IAChD,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IAC3B,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,sDAAsD;IACtD,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,aAAa,GAAG,aAAa,GAAG,kBAAkB,CAAA;KAAE,EAAE,CAAC;CAC3F"}

package/dist/plan-model.js

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+/**
+ * The install planner's shapes, on their own.
+ *
+ * Types only, so the planner (`plan.ts`), its context extension
+ * (`plan-context.ts`) and the type rules (`plan-types.ts`) can all name them
+ * without importing one another in a circle. `plan.ts` and `plan-context.ts`
+ * re-export them, so every importer outside keeps its path.
+ */
+export {};
+//# sourceMappingURL=plan-model.js.map

package/dist/plan-model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan-model.js","sourceRoot":"","sources":["../src/plan-model.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC;;;;;;;GAOG"}

package/dist/plan-types.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Whether an existing column can hold what a manifest stores in it — shared by
+ * both halves of the planner.
+ */
+import type { ExistingColumnView, SchemaModelView } from './plan-model.js';
+import type { RequiredColumn } from './schema.js';
+/**
+ * Why an existing column cannot hold what the manifest stores in it — its type,
+ * named for a person — or `null` when it can (or cannot be judged).
+ */
+export declare function typeConflict(declared: RequiredColumn, existing: ExistingColumnView, dialect: SchemaModelView['dialect']): string | null;
+//# sourceMappingURL=plan-types.d.ts.map

package/dist/plan-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan-types.d.ts","sourceRoot":"","sources":["../src/plan-types.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAC3E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAwClD;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,cAAc,EACxB,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,eAAe,CAAC,SAAS,CAAC,GAClC,MAAM,GAAG,IAAI,CAuBf"}