@atlasauth/cli 0.11.0 → 0.12.0

package/dist/migrate/framework/custom.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customPlugin = void 0;
+exports.parseCanonicalRecords = parseCanonicalRecords;
+const node_path_1 = require("node:path");
+const migrate_1 = require("@atlasauth/migrate");
+const args_1 = require("../../args");
+const errors_1 = require("../../errors");
+/**
+ * `atlas migrate custom export --file <records>` — your own user store through
+ * the same pipeline as every vendor. The file holds canonical records (the
+ * `@atlasauth/migrate` schema v1), as NDJSON (one `{ "model": …, "data": … }`
+ * per line) or a JSON array of them; `{ "type": "record", … }` entries from a
+ * decrypted bundle are accepted too. Records are written in canonical model
+ * order whatever order the file has them in; an invalid record is left out and
+ * reported, never fatal.
+ *
+ * The file is read on this machine; only the sealed bundle goes to Atlas.
+ */
+/** Records between two export checkpoints. */
+const CHECKPOINT_EVERY = 1000;
+/** Parse NDJSON or a JSON array of `{ model, data }`. Unknown models are returned in `unknown`. */
+function parseCanonicalRecords(text) {
+    const trimmed = text.trim();
+    let raw;
+    if (!trimmed)
+        raw = [];
+    else if (trimmed.startsWith('[')) {
+        try {
+            raw = JSON.parse(trimmed);
+        }
+        catch {
+            throw new errors_1.CliError('The records file is not valid JSON.');
+        }
+        if (!Array.isArray(raw))
+            throw new errors_1.CliError('The records file must be a JSON array or NDJSON.');
+    }
+    else {
+        raw = trimmed.split('\n').filter((l) => l.trim()).map((line, i) => {
+            try {
+                return JSON.parse(line);
+            }
+            catch {
+                throw new errors_1.CliError(`Line ${i + 1} of the records file is not valid JSON.`);
+            }
+        });
+    }
+    const records = [];
+    const unknown = {};
+    for (const entry of raw) {
+        if (!entry || typeof entry !== 'object')
+            continue;
+        const e = entry;
+        if (e.type !== undefined && e.type !== 'record')
+            continue; // manifest / end lines of a decrypted bundle
+        const model = String(e.model ?? '');
+        if (!(0, migrate_1.isCanonicalModel)(model) || !e.data || typeof e.data !== 'object') {
+            unknown[model || '(none)'] = (unknown[model || '(none)'] ?? 0) + 1;
+            continue;
+        }
+        records.push({ model, data: e.data });
+    }
+    const rank = (m) => migrate_1.CANONICAL_MODEL_ORDER.indexOf(m);
+    // Stable: records of one model keep the file's order.
+    records.sort((a, b) => rank(a.model) - rank(b.model));
+    return { records, unknown };
+}
+exports.customPlugin = {
+    vendor: 'custom',
+    source: 'custom',
+    label: 'Your own user database',
+    help: 'Import a homegrown user store: write its users, identities, organizations and so on as canonical migration records (NDJSON or a JSON array of { model, data }), then run atlas migrate custom export --file <records> and atlas migrate custom import.',
+    export: {
+        reads: 'a local file of canonical migration records (--file)',
+        credentials: [],
+        async run(p, writer, resume) {
+            const file = (0, args_1.str)(p.args.values, 'file') ?? p.credential({ flag: 'file', env: 'ATLAS_MIGRATE_FILE', label: 'the records file (--file)', required: true });
+            const { records, unknown } = parseCanonicalRecords(p.ctx.readFile((0, node_path_1.resolve)(file)));
+            for (const [model, n] of Object.entries(unknown))
+                writer.omit(model, 'not a canonical model (or no data)', n);
+            const start = typeof resume.cursor === 'number' ? resume.cursor : 0;
+            if (start)
+                p.say(`  resuming at record ${start + 1} of ${records.length}`);
+            for (let i = start; i < records.length; i++) {
+                const r = records[i];
+                const issues = await writer.add(r.model, r.data);
+                if (issues.length)
+                    p.say(`  left out ${r.model} #${i + 1}: ${issues[0].message}`);
+                if ((i + 1) % CHECKPOINT_EVERY === 0)
+                    resume.checkpoint(i + 1);
+            }
+            p.say(`  read ${records.length} record(s) from ${file}`);
+        },
+    },
+};
+//# sourceMappingURL=custom.js.map

package/dist/migrate/framework/custom.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom.js","sourceRoot":"","sources":["../../../src/migrate/framework/custom.ts"],"names":[],"mappings":";;;AA2BA,sDAqCC;AAhED,yCAAoC;AACpC,gDAA4H;AAC5H,qCAAiC;AACjC,yCAAwC;AAGxC;;;;;;;;;;GAUG;AAEH,8CAA8C;AAC9C,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAO9B,mGAAmG;AACnG,SAAgB,qBAAqB,CAAC,IAAY;IAChD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC5B,IAAI,GAAc,CAAC;IACnB,IAAI,CAAC,OAAO;QAAE,GAAG,GAAG,EAAE,CAAC;SAClB,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACjC,IAAI,CAAC;YACH,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAc,CAAC;QACzC,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,iBAAQ,CAAC,qCAAqC,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;YAAE,MAAM,IAAI,iBAAQ,CAAC,kDAAkD,CAAC,CAAC;IAClG,CAAC;SAAM,CAAC;QACN,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;YAChE,IAAI,CAAC;gBACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAY,CAAC;YACrC,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,IAAI,iBAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;YAC7E,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IACD,MAAM,OAAO,GAA0B,EAAE,CAAC;IAC1C,MAAM,OAAO,GAA2B,EAAE,CAAC;IAC3C,KAAK,MAAM,KAAK,IAAI,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,SAAS;QAClD,MAAM,CAAC,GAAG,KAA4D,CAAC;QACvE,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ;YAAE,SAAS,CAAC,6CAA6C;QACxG,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;QACpC,IAAI,CAAC,IAAA,0BAAgB,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtE,OAAO,CAAC,KAAK,IAAI,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;YACnE,SAAS;QACX,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,IAA+B,EAAE,CAAC,CAAC;IACnE,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,CAAS,EAAE,EAAE,CAAE,+BAA2C,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACpF,sDAAsD;IACtD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACtD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;AAC9B,CAAC;AAEY,QAAA,YAAY,GAAoB;IAC3C,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,wBAAwB;IAC/B,IAAI,EAAE,wPAAwP;IAC9P,MAAM,EAAE;QACN,KAAK,EAAE,sDAAsD;QAC7D,WAAW,EAAE,EAAE;QACf,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM;YACzB,MAAM,IAAI,GAAG,IAAA,UAAG,EAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,oBAAoB,EAAE,KAAK,EAAE,2BAA2B,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;YACzJ,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,qBAAqB,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAA,mBAAO,EAAC,IAAK,CAAC,CAAC,CAAC,CAAC;YACnF,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;gBAAE,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,oCAAoC,EAAE,CAAC,CAAC,CAAC;YAC9G,MAAM,KAAK,GAAG,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YACpE,IAAI,KAAK;gBAAE,CAAC,CAAC,GAAG,CAAC,wBAAwB,KAAK,GAAG,CAAC,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YAC3E,KAAK,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC5C,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAE,CAAC;gBACtB,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,IAAsD,CAAC,CAAC;gBACnG,IAAI,MAAM,CAAC,MAAM;oBAAE,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,KAAK,KAAK,CAAC,GAAG,CAAC,KAAK,MAAM,CAAC,CAAC,CAAE,CAAC,OAAO,EAAE,CAAC,CAAC;gBACnF,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,gBAAgB,KAAK,CAAC;oBAAE,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACjE,CAAC;YACD,CAAC,CAAC,GAAG,CAAC,UAAU,OAAO,CAAC,MAAM,mBAAmB,IAAI,EAAE,CAAC,CAAC;QAC3D,CAAC;KACF;CACF,CAAC"}

package/dist/migrate/framework/orchestrator.d.ts

@@ -0,0 +1,113 @@
+import { type MigrationSource } from '@atlasauth/migrate';
+import { type ParsedArgs } from '../../args';
+import type { ConfigHttp } from '../../config-http';
+import type { RunContext } from '../../context';
+import type { Format, Json } from '../../serialize';
+import type { MigrationPlugin, PluginContext, TranslationResult } from './plugin';
+/**
+ * `atlas migrate <vendor> [path]` — the program for any vendor with a
+ * {@link MigrationPlugin}, as one resumable run:
+ *
+ *   preflight → config → export → import → bridge → lazy → code → verify
+ *
+ * Each finished step is checkpointed in atlas-migrate/<vendor>/state.json, so
+ * `--resume` carries on where a run stopped (a confirmation declined, a vendor
+ * credential missing, an export interrupted). `--dry-run` walks every step
+ * without touching the instance, the vendor or the code; `--yes` answers every
+ * confirmation. A single step runs on its own with `atlas migrate <vendor> <step>`.
+ *
+ * EXPORT RESUME. A sealed bundle cannot be appended to, so an export is written
+ * as one or more SEGMENTS (bundle.1.atlas, bundle.2.atlas, …), each a complete
+ * bundle. The exporter calls `checkpoint(cursor)` as it goes; when it stops on
+ * an error the current segment is sealed with what it holds and the last
+ * checkpoint is kept, so the next run starts a new segment from there. Records
+ * written after the checkpoint appear in both segments, which is harmless:
+ * every import is an idempotent upsert. A hard crash leaves an unsealed
+ * segment that is simply rewritten. The import step imports the segments in
+ * order (each one's references resolve through the ones applied before it).
+ */
+export declare const VENDOR_STEPS: readonly ["preflight", "config", "export", "import", "bridge", "lazy", "code", "verify"];
+export type VendorStepId = (typeof VENDOR_STEPS)[number];
+type StepStatus = 'done' | 'skipped' | 'planned' | 'action_needed' | 'awaiting_confirmation' | 'blocked';
+interface StepRecord {
+    status: StepStatus;
+    at?: number;
+    detail?: Record<string, unknown>;
+    message?: string;
+}
+export interface VendorMigrationState {
+    version: 1;
+    vendor: string;
+    source: MigrationSource;
+    project: string;
+    instance_id: string | null;
+    environment: string | null;
+    started_at: number;
+    steps: Partial<Record<VendorStepId, StepRecord>>;
+    export: {
+        /** Sealed segment files, in order (relative to the state directory). */
+        segments: string[];
+        /** The exporter's last checkpoint, handed back on resume. */
+        cursor: Json | null;
+        /** The exporter ran to the end. */
+        complete: boolean;
+        counts: Record<string, number>;
+    };
+    import: {
+        /** Segments fully imported. */
+        done: string[];
+        /** The segment being imported and its import id. */
+        current: {
+            segment: string;
+            id: string;
+        } | null;
+        ids: string[];
+    };
+}
+interface StepResult {
+    status: StepStatus;
+    detail?: Record<string, unknown>;
+    message?: string;
+    stop?: boolean;
+    exitCode?: number;
+}
+export declare class VendorMigration {
+    readonly ctx: RunContext;
+    readonly args: ParsedArgs;
+    readonly plugin: MigrationPlugin;
+    readonly project: string;
+    readonly dir: string;
+    readonly statePath: string;
+    readonly configDir: string;
+    readonly format: Format;
+    readonly yes: boolean;
+    readonly dryRun: boolean;
+    readonly json: boolean;
+    readonly skip: Set<string>;
+    readonly sets: Record<string, string>;
+    state: VendorMigrationState;
+    private http?;
+    private translation?;
+    constructor(ctx: RunContext, args: ParsedArgs, plugin: MigrationPlugin, projectArg: string | undefined);
+    say(line: string): void;
+    api(): ConfigHttp;
+    confirm(question: string): Promise<boolean>;
+    sleep(ms: number): Promise<void>;
+    /** What a plugin step gets. */
+    pluginContext(): PluginContext;
+    /** The translation from this run, or the one a previous run wrote. */
+    getTranslation(): TranslationResult | undefined;
+    setTranslation(t: TranslationResult): void;
+    loadState(opts: {
+        single: boolean;
+    }): void;
+    saveState(): void;
+    record(step: VendorStepId, result: StepResult): void;
+    /** Run every step (or just `only`). Returns the exit code. */
+    run(only?: VendorStepId): Promise<number>;
+}
+/** `--set a=b --set c=d,e=f` → { a: 'b', c: 'd', e: 'f' }. A value may contain `=`. */
+export declare function parseSets(raw: string[]): Record<string, string>;
+export declare const VENDOR_HANDLERS: Record<VendorStepId, (m: VendorMigration) => Promise<StepResult>>;
+export declare function migrateVendor(ctx: RunContext, args: ParsedArgs, plugin: MigrationPlugin, projectArg: string | undefined, only?: VendorStepId): Promise<number>;
+export {};