@crowi/api 2.0.0-alpha.0

package/dist/migration/runner.js

@@ -0,0 +1,276 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MigrationRunner = exports.MigrationRunnerCore = exports.noopProgress = void 0;
+const node_os_1 = __importDefault(require("node:os"));
+const debug_1 = __importDefault(require("debug"));
+const debug = (0, debug_1.default)('crowi:migration:runner');
+/** A no-op progress reporter — used by boot / tests that don't render progress. */
+exports.noopProgress = {
+    setTotal: () => undefined,
+    increment: () => undefined,
+    setLabel: () => undefined,
+};
+/** Default logger: structured lines via `debug`, warnings/errors to console. */
+function defaultLogger() {
+    return {
+        info: (message, ...args) => debug(message, ...args),
+        debug: (message, ...args) => debug(message, ...args),
+        warn: (message, ...args) => console.warn(`[crowi:migration] ${message}`, ...args),
+        error: (message, ...args) => console.error(`[crowi:migration] ${message}`, ...args),
+    };
+}
+/**
+ * Builds the per-run `MigrationContext` from the booted Crowi instance.
+ * `broadcastForceReload` is wired through only when the caller (api boot)
+ * supplies it; the admin CLI leaves it undefined.
+ */
+function buildContext(crowi, opts) {
+    const db = crowi.getMongo().connection.db;
+    const rewritePageBody = async (pageId, newBody, options) => {
+        if (opts.dryRun)
+            return;
+        const Page = crowi.model('Page');
+        const User = crowi.model('User');
+        const page = await Page.findById(pageId).exec();
+        if (!page) {
+            opts.logger.warn(`rewritePageBody: page ${pageId} not found, skipping`);
+            return;
+        }
+        // Route through the updatePage-equivalent path: it repoints
+        // currentRevision and nulls yjsState / yjsCheckpointAt (page.ts), so the
+        // next onLoadDocument rebuilds the Y.Doc from the new body (§4.3.1).
+        const actingUserId = options?.userId ?? page.lastUpdateUser?.toString?.() ?? page.creator?.toString?.();
+        const user = actingUserId ? await User.findById(actingUserId).exec() : null;
+        await Page.updatePage(page, newBody, user, {});
+    };
+    const invalidateYjsPersistence = async (pageIds) => {
+        if (opts.dryRun || pageIds.length === 0)
+            return;
+        const Page = crowi.model('Page');
+        // Persistence-layer only: null the snapshot so the next onLoadDocument
+        // rebuilds from the current revision. No revision is pushed here (this is
+        // the no-body-rewrite case, e.g. after an out-of-band data fix).
+        await Page.updateMany({ _id: { $in: pageIds } }, { $set: { yjsState: null, yjsCheckpointAt: null } }).exec();
+    };
+    return {
+        db,
+        crowi,
+        logger: opts.logger,
+        dryRun: opts.dryRun,
+        progress: opts.progress,
+        rewritePageBody,
+        invalidateYjsPersistence,
+        broadcastForceReload: opts.broadcastForceReload,
+    };
+}
+/**
+ * Resolve a runner's effective options, filling in defaults.
+ */
+function resolveOptions(opts) {
+    return {
+        dryRun: opts.dryRun ?? false,
+        concurrency: opts.concurrency ?? 8,
+        appliedBy: opts.appliedBy ?? `admin-cli@${node_os_1.default.hostname()}`,
+        progress: opts.progress ?? exports.noopProgress,
+        logger: opts.logger ?? defaultLogger(),
+        broadcastForceReload: opts.broadcastForceReload,
+    };
+}
+/**
+ * RFC-0008 §4.3 — the shared runner *core*.
+ *
+ * Holds the booted Crowi, the resolved options, the per-run
+ * `MigrationContext` (dry-run / progress / logger / Yjs invalidation), the
+ * SIGINT-aware abort flag, and the bounded-concurrency limiter. This is the
+ * "shared infrastructure" both namespaces ride on: `migrate` adds the
+ * `migrationApplications` reconciliation/record path on top (`MigrationRunner`
+ * below), while `rebuild` rides on the core alone with **no** audit-log
+ * coupling (`RebuildRunner` in `rebuild-runner.ts`).
+ *
+ * Keeping the record path out of the core is deliberate (§8.5: rebuilds have
+ * "no pending/applied concept"): a rebuild can never accidentally append to
+ * `migrationApplications`, and `MigrationRunner.apply` carries no `if (rebuild)`
+ * branch — the two namespaces are distinct subclasses, not flags on one path.
+ */
+class MigrationRunnerCore {
+    crowi;
+    opts;
+    ctx;
+    abortRequested = false;
+    sigintHandler = null;
+    constructor(crowi, options = {}) {
+        this.crowi = crowi;
+        this.opts = resolveOptions(options);
+        this.ctx = buildContext(crowi, this.opts);
+    }
+    /** True once a SIGINT has been received; long stages should wind down. */
+    get aborted() {
+        return this.abortRequested;
+    }
+    /** The shared per-run context handed to migration / rebuild callbacks. */
+    get context() {
+        return this.ctx;
+    }
+    get concurrency() {
+        return this.opts.concurrency;
+    }
+    /**
+     * Install a SIGINT handler so an in-progress run can stop between
+     * stages / units instead of leaving Mongo in an arbitrary state. Returns
+     * a disposer; safe to call when no handler is desired (tests pass none).
+     */
+    installSigintHandler() {
+        if (this.sigintHandler)
+            return () => this.removeSigintHandler();
+        const handler = () => {
+            if (this.abortRequested)
+                return; // a second Ctrl-C — let it through to default
+            this.abortRequested = true;
+            this.opts.logger.warn('SIGINT received — finishing the current unit then stopping safely…');
+        };
+        this.sigintHandler = handler;
+        process.on('SIGINT', handler);
+        return () => this.removeSigintHandler();
+    }
+    removeSigintHandler() {
+        if (this.sigintHandler) {
+            process.off('SIGINT', this.sigintHandler);
+            this.sigintHandler = null;
+        }
+    }
+    /**
+     * Run a bounded-concurrency map over `items`, respecting the SIGINT abort
+     * flag (stops scheduling new work once aborted). Exposed so a stage's `fn`
+     * or a rebuild task can fan out per-document work through the shared
+     * concurrency limiter.
+     */
+    async mapBounded(items, worker) {
+        const limit = Math.max(1, this.opts.concurrency);
+        let cursor = 0;
+        let processed = 0;
+        const runWorker = async () => {
+            while (cursor < items.length && !this.abortRequested) {
+                const index = cursor++;
+                await worker(items[index], index);
+                processed++;
+            }
+        };
+        await Promise.all(Array.from({ length: Math.min(limit, items.length) }, runWorker));
+        return { processed, interrupted: this.abortRequested };
+    }
+}
+exports.MigrationRunnerCore = MigrationRunnerCore;
+/**
+ * The `migrate`-namespace runner. Adds the §6.2 reconciliation rules and the
+ * `migrationApplications` audit-log append on top of the shared core. The
+ * `rebuild` namespace does NOT extend this — it rides the core directly so it
+ * stays free of any applied/pending semantics (§8.5).
+ */
+class MigrationRunner extends MigrationRunnerCore {
+    /** Cheap pending probe. Never writes; safe to call on every boot (§4.2.1). */
+    async isPending(def) {
+        return def.isPending(this.context);
+    }
+    /** Rich, optional report for `plan`. Returns null when the migration has no `detect`. */
+    async detect(def) {
+        if (!def.detect)
+            return null;
+        return def.detect(this.context);
+    }
+    /**
+     * Apply a single migration through the framework's reconciliation rules
+     * (§6.2): inspection (`isPending`) is the source of truth; the recorded
+     * state only affects which `result` label we append.
+     *
+     *  - pending + no record    → run → `applied`
+     *  - pending + applied      → re-run (warn) → `re-applied`
+     *  - not pending + no record→ `detected-clean`
+     *  - not pending + applied  → no-op (consistent), no new record
+     *
+     * Appends one `migrationApplications` row per run (except the consistent
+     * no-op case). `dryRun` runs `detect`/probe only and records nothing.
+     */
+    async apply(def) {
+        const MigrationApplication = this.crowi.model('MigrationApplication');
+        const startedAt = Date.now();
+        const pending = await this.isPending(def);
+        const latest = await MigrationApplication.latestFor(def.id);
+        const recordedApplied = latest?.result === 'applied' || latest?.result === 're-applied';
+        // not pending + applied → consistent; nothing to do, no new record.
+        if (!pending && recordedApplied) {
+            this.opts.logger.debug(`${def.id}: not pending and already applied — skipping`);
+            return { id: def.id, result: 'applied', durationMs: 0, stats: {} };
+        }
+        // not pending + no record → record detected-clean (fresh install path §9.2).
+        if (!pending) {
+            const durationMs = Date.now() - startedAt;
+            if (!this.opts.dryRun) {
+                await this.recordApplication(MigrationApplication, def, 'detected-clean', durationMs, {});
+            }
+            this.opts.logger.info(`${def.id}: detected-clean (nothing to migrate)`);
+            return { id: def.id, result: 'detected-clean', durationMs, stats: {} };
+        }
+        // pending: trust inspection. If already recorded applied, this is a
+        // re-run (§6.2) — log a warning and proceed.
+        const result = recordedApplied ? 're-applied' : 'applied';
+        if (recordedApplied) {
+            this.opts.logger.warn(`${def.id}: recorded as applied but inspection says pending — re-applying (trusting inspection, §6.2)`);
+        }
+        if (this.opts.dryRun) {
+            // Dry-run: run detect for a preview, run no stages, record nothing.
+            const report = await this.detect(def);
+            this.opts.logger.info(`${def.id}: dry-run — ${report?.summary ?? 'details unavailable (no detect)'}`);
+            return { id: def.id, result, durationMs: Date.now() - startedAt, stats: report?.counts ?? {} };
+        }
+        const stats = {};
+        let interrupted = false;
+        try {
+            for (const stage of def.stages) {
+                if (this.abortRequested) {
+                    interrupted = true;
+                    break;
+                }
+                this.opts.progress.setLabel(`${def.id}:${stage.name}`);
+                this.opts.logger.info(`${def.id}: stage ${stage.name} …`);
+                const stageResult = await stage.fn(this.context);
+                stats[stage.name] = { transformed: stageResult.transformed ?? 0, ...(stageResult.stats ?? {}) };
+            }
+        }
+        catch (err) {
+            const durationMs = Date.now() - startedAt;
+            const message = err instanceof Error ? err.message : String(err);
+            await this.recordApplication(MigrationApplication, def, 'failed', durationMs, stats, message);
+            throw err;
+        }
+        const durationMs = Date.now() - startedAt;
+        if (interrupted) {
+            // Partial completion: record what we did so the next run's
+            // reconciliation has the audit trail; isPending will still report
+            // pending so the remaining work re-runs.
+            await this.recordApplication(MigrationApplication, def, result, durationMs, { ...stats, interrupted: true });
+            this.opts.logger.warn(`${def.id}: interrupted by SIGINT after partial completion — re-run to finish`);
+            return { id: def.id, result, durationMs, stats, interrupted: true };
+        }
+        await this.recordApplication(MigrationApplication, def, result, durationMs, stats);
+        this.opts.logger.info(`${def.id}: ${result} (${durationMs}ms)`);
+        return { id: def.id, result, durationMs, stats };
+    }
+    async recordApplication(MigrationApplication, def, result, durationMs, stats, error) {
+        await MigrationApplication.record({
+            migrationId: def.id,
+            fromVersion: def.fromVersion,
+            toVersion: def.toVersion,
+            layer: def.layer,
+            result,
+            durationMs,
+            stats,
+            appliedBy: this.opts.appliedBy,
+            error,
+        });
+    }
+}
+exports.MigrationRunner = MigrationRunner;
+//# sourceMappingURL=runner.js.map

package/dist/migration/runner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runner.js","sourceRoot":"","sources":["../../src/migration/runner.ts"],"names":[],"mappings":";;;;;;AAAA,sDAAyB;AACzB,kDAA0B;AAgB1B,MAAM,KAAK,GAAG,IAAA,eAAK,EAAC,wBAAwB,CAAC,CAAC;AA2C9C,mFAAmF;AACtE,QAAA,YAAY,GAAqB;IAC5C,QAAQ,EAAE,GAAG,EAAE,CAAC,SAAS;IACzB,SAAS,EAAE,GAAG,EAAE,CAAC,SAAS;IAC1B,QAAQ,EAAE,GAAG,EAAE,CAAC,SAAS;CAC1B,CAAC;AAEF,gFAAgF;AAChF,SAAS,aAAa;IACpB,OAAO;QACL,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;QACnD,KAAK,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;QACpD,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC;QACjF,KAAK,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,qBAAqB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC;KACpF,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAS,YAAY,CACnB,KAAY,EACZ,IAAmH;IAEnH,MAAM,EAAE,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC,UAAU,CAAC,EAAiB,CAAC;IAEzD,MAAM,eAAe,GAAG,KAAK,EAAE,MAAc,EAAE,OAAe,EAAE,OAAgC,EAAiB,EAAE;QACjH,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO;QACxB,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACjC,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACjC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;QAChD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,yBAAyB,MAAM,sBAAsB,CAAC,CAAC;YACxE,OAAO;QACT,CAAC;QACD,4DAA4D;QAC5D,yEAAyE;QACzE,qEAAqE;QACrE,MAAM,YAAY,GAAG,OAAO,EAAE,MAAM,IAAI,IAAI,CAAC,cAAc,EAAE,QAAQ,EAAE,EAAE,IAAI,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC;QACxG,MAAM,IAAI,GAAG,YAAY,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5E,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IACjD,CAAC,CAAC;IAEF,MAAM,wBAAwB,GAAG,KAAK,EAAE,OAAiB,EAAiB,EAAE;QAC1E,IAAI,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAChD,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACjC,uEAAuE;QACvE,0EAA0E;QAC1E,iEAAiE;QACjE,MAAM,IAAI,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC/G,CAAC,CAAC;IAEF,OAAO;QACL,EAAE;QACF,KAAK;QACL,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,eAAe;QACf,wBAAwB;QACxB,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;KAChD,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,cAAc,CACrB,IAAmB;IAEnB,OAAO;QACL,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,KAAK;QAC5B,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,CAAC;QAClC,SAAS,EAAE,IAAI,CAAC,SAAS,IAAI,aAAa,iBAAE,CAAC,QAAQ,EAAE,EAAE;QACzD,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,oBAAY;QACvC,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,aAAa,EAAE;QACtC,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;KAChD,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAa,mBAAmB;IACX,KAAK,CAAQ;IACb,IAAI,CAAoC;IAC1C,GAAG,CAAmB;IAC7B,cAAc,GAAG,KAAK,CAAC;IACzB,aAAa,GAAwB,IAAI,CAAC;IAElD,YAAY,KAAY,EAAE,UAAyB,EAAE;QACnD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;QACpC,IAAI,CAAC,GAAG,GAAG,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED,0EAA0E;IAC1E,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,0EAA0E;IAC1E,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,oBAAoB;QAClB,IAAI,IAAI,CAAC,aAAa;YAAE,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAChE,MAAM,OAAO,GAAG,GAAG,EAAE;YACnB,IAAI,IAAI,CAAC,cAAc;gBAAE,OAAO,CAAC,8CAA8C;YAC/E,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oEAAoE,CAAC,CAAC;QAC9F,CAAC,CAAC;QACF,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC;QAC7B,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC9B,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC1C,CAAC;IAEO,mBAAmB;QACzB,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;YAC1C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC5B,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAI,KAAmB,EAAE,MAAiD;QACxF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACjD,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,MAAM,SAAS,GAAG,KAAK,IAAmB,EAAE;YAC1C,OAAO,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;gBACrD,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC;gBACvB,MAAM,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;gBAClC,SAAS,EAAE,CAAC;YACd,CAAC;QACH,CAAC,CAAC;QACF,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;QACpF,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC;IACzD,CAAC;CACF;AAvED,kDAuEC;AAED;;;;;GAKG;AACH,MAAa,eAAgB,SAAQ,mBAAmB;IACtD,8EAA8E;IAC9E,KAAK,CAAC,SAAS,CAAC,GAAwB;QACtC,OAAO,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAED,yFAAyF;IACzF,KAAK,CAAC,MAAM,CAAC,GAAwB;QACnC,IAAI,CAAC,GAAG,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QAC7B,OAAO,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,KAAK,CAAC,GAAwB;QAClC,MAAM,oBAAoB,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,sBAAsB,CAA8B,CAAC;QACnG,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE7B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC5D,MAAM,eAAe,GAAG,MAAM,EAAE,MAAM,KAAK,SAAS,IAAI,MAAM,EAAE,MAAM,KAAK,YAAY,CAAC;QAExF,oEAAoE;QACpE,IAAI,CAAC,OAAO,IAAI,eAAe,EAAE,CAAC;YAChC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,EAAE,8CAA8C,CAAC,CAAC;YAChF,OAAO,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;QACrE,CAAC;QAED,6EAA6E;QAC7E,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;YAC1C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACtB,MAAM,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,EAAE,GAAG,EAAE,gBAAgB,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;YAC5F,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,EAAE,uCAAuC,CAAC,CAAC;YACxE,OAAO,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,gBAAgB,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;QACzE,CAAC;QAED,oEAAoE;QACpE,6CAA6C;QAC7C,MAAM,MAAM,GAAoB,eAAe,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3E,IAAI,eAAe,EAAE,CAAC;YACpB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,EAAE,6FAA6F,CAAC,CAAC;QAChI,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACrB,oEAAoE;YACpE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACtC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,EAAE,eAAe,MAAM,EAAE,OAAO,IAAI,iCAAiC,EAAE,CAAC,CAAC;YACtG,OAAO,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,IAAI,EAAE,EAAE,CAAC;QACjG,CAAC;QAED,MAAM,KAAK,GAA4B,EAAE,CAAC;QAC1C,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,IAAI,CAAC;YACH,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;gBAC/B,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;oBACxB,WAAW,GAAG,IAAI,CAAC;oBACnB,MAAM;gBACR,CAAC;gBACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,EAAE,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;gBACvD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,EAAE,WAAW,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC;gBAC1D,MAAM,WAAW,GAAgB,MAAM,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC9D,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,EAAE,WAAW,CAAC,WAAW,IAAI,CAAC,EAAE,GAAG,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;YAClG,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;YAC1C,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACjE,MAAM,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,EAAE,GAAG,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;YAC9F,MAAM,GAAG,CAAC;QACZ,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;QAC1C,IAAI,WAAW,EAAE,CAAC;YAChB,2DAA2D;YAC3D,kEAAkE;YAClE,yCAAyC;YACzC,MAAM,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,GAAG,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;YAC7G,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,EAAE,qEAAqE,CAAC,CAAC;YACtG,OAAO,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;QACtE,CAAC;QAED,MAAM,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QACnF,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,EAAE,KAAK,MAAM,KAAK,UAAU,KAAK,CAAC,CAAC;QAChE,OAAO,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;IACnD,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAC7B,oBAA+C,EAC/C,GAAwB,EACxB,MAAuB,EACvB,UAAkB,EAClB,KAA8B,EAC9B,KAAc;QAEd,MAAM,oBAAoB,CAAC,MAAM,CAAC;YAChC,WAAW,EAAE,GAAG,CAAC,EAAE;YACnB,WAAW,EAAE,GAAG,CAAC,WAAW;YAC5B,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,MAAM;YACN,UAAU;YACV,KAAK;YACL,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS;YAC9B,KAAK;SACN,CAAC,CAAC;IACL,CAAC;CACF;AAtHD,0CAsHC"}

package/dist/migration/types.d.ts

@@ -0,0 +1,153 @@
+import type { mongo } from 'mongoose';
+import type Crowi from '../crowi';
+/** Raw mongo driver database handle, re-exported by mongoose (no direct `mongodb` dep). */
+export type MigrationDb = mongo.Db;
+/**
+ * RFC-0008 Migration Framework — core type definitions.
+ *
+ * A *migration* is a one-shot, forward-only transformation from one
+ * version's data shape to another's, applied at most once per dataset.
+ * Two layers are distinguished by `MigrationLayer`:
+ *
+ *   - `boot`      — lightweight / safe; applied automatically during the
+ *                   api boot sequence (`runBootMigrations`).
+ *   - `preflight` — heavy / potentially destructive; invoked explicitly
+ *                   from `crowi-admin migrate apply` in a maintenance
+ *                   window. Boot only *probes* these (via `isPending`) and
+ *                   refuses to start when any is unapplied (§4.2.1/§4.2.7).
+ *
+ * Index building is deliberately NOT modelled here: per §9, unique indexes
+ * are declared on schemas and built by Mongoose's autoIndex. A migration's
+ * job is to *prepare data* (e.g. dedup) so autoIndex won't hit E11000 —
+ * hence there is no `build-index` stage and no `ownedIndexes`.
+ */
+export type MigrationLayer = 'boot' | 'preflight';
+/**
+ * Minimal logger surface the runner hands to a migration. Backed by the
+ * runner's structured logger (console / `debug`); kept narrow so a
+ * migration can't reach into transport details.
+ */
+export interface MigrationLogger {
+    info(message: string, ...args: unknown[]): void;
+    warn(message: string, ...args: unknown[]): void;
+    error(message: string, ...args: unknown[]): void;
+    debug(message: string, ...args: unknown[]): void;
+}
+/**
+ * Progress sink for long-running stages. The CLI binds this to a live
+ * progress line; boot / tests bind it to a no-op or a counter.
+ */
+export interface ProgressReporter {
+    /** Declare the total unit count for the current stage (enables ETA). */
+    setTotal(total: number): void;
+    /** Advance the processed count by `delta` (default 1). */
+    increment(delta?: number): void;
+    /** Set a short human-readable label for the current item / sub-step. */
+    setLabel(label: string): void;
+}
+/** Result of a single stage's `fn`. Folded into the migration's `stats`. */
+export interface StageResult {
+    /** Stage name (echoed for the application record / logs). */
+    name: string;
+    /** Rows / documents transformed by this stage (0 in dry-run). */
+    transformed?: number;
+    /** Free-form per-stage stats merged into `migrationApplications.stats`. */
+    stats?: Record<string, unknown>;
+}
+/** Rich, optional report returned by `detect` and shown by `migrate plan`. */
+export interface DetectReport {
+    /** One-line summary (e.g. "42 duplicate username groups"). */
+    summary: string;
+    /** Optional structured counts for `--json` consumers. */
+    counts?: Record<string, number>;
+}
+/**
+ * Per-run context handed to `isPending` / `detect` / every stage `fn`.
+ *
+ * The Yjs-invalidation surface is split per §4.3.1:
+ *   - `rewritePageBody` / `invalidateYjsPersistence` are *persistence-layer*
+ *     operations available in **all layers** (they route through the
+ *     `updatePage`-equivalent path: repoint `currentRevision` + null
+ *     `yjsState` / `yjsCheckpointAt`, so the next `onLoadDocument` rebuilds
+ *     the `Y.Doc` from the body).
+ *   - `broadcastForceReload` is a *live* force-reload broadcast available
+ *     **only in `layer='boot'`** migrations (api process with a live
+ *     Hocuspocus handle). It is `undefined` in preflight (admin CLI is a
+ *     separate, mongo-only process — see §4.3.1).
+ */
+export interface MigrationContext {
+    /** Raw mongo driver handle (for index-backed probes / aggregations). */
+    db: MigrationDb;
+    /** The booted Crowi instance — gives access to `crowi.model(...)`. */
+    crowi: Crowi;
+    logger: MigrationLogger;
+    /** Stages MUST no-op (no writes) when this is true. */
+    dryRun: boolean;
+    progress: ProgressReporter;
+    /**
+     * Persistence-layer Yjs invalidation (all layers): rewrite a page's body
+     * via the `updatePage`-equivalent path, repointing `currentRevision` and
+     * nulling `page.yjsState` / `yjsCheckpointAt`.
+     */
+    rewritePageBody: (pageId: string, newBody: string, options?: RewritePageBodyOptions) => Promise<void>;
+    /**
+     * Persistence-layer Yjs invalidation without a body rewrite: null
+     * `yjsState` / `yjsCheckpointAt` for the given pages so the next
+     * `onLoadDocument` rebuilds from the current revision.
+     */
+    invalidateYjsPersistence: (pageIds: string[]) => Promise<void>;
+    /**
+     * Live force-reload broadcast. Present ONLY in `layer='boot'` migrations
+     * (api process with a live Hocuspocus handle); `undefined` in preflight.
+     */
+    broadcastForceReload?: (pageIds: string[]) => Promise<void>;
+}
+/** Options for `ctx.rewritePageBody`. */
+export interface RewritePageBodyOptions {
+    /** Acting user id for the new revision (defaults to the page's lastUpdateUser). */
+    userId?: string;
+}
+/** A named, side-effecting transform. Index building is NOT a stage (§9). */
+export interface MigrationStage {
+    /** Label for logging / progress (e.g. 'dedup-username'). */
+    name: string;
+    /** Must no-op when `ctx.dryRun` is true. */
+    fn: (ctx: MigrationContext) => Promise<StageResult>;
+}
+export interface MigrationDefinition {
+    /** Stable identifier. Convention: dateless kebab-case slug (§5.4). */
+    id: string;
+    /** Version range this migration covers (e.g. '1.x' → '2.0'). */
+    fromVersion: string;
+    toVersion: string;
+    layer: MigrationLayer;
+    /** Short, human-readable description (shown by `plan` / `list`). */
+    description: string;
+    /**
+     * Execution order within the same version range. Defaults to registry
+     * insertion order when omitted (§5.3).
+     */
+    order?: number;
+    /** Side-effecting transforms, executed in declaration order. */
+    stages: MigrationStage[];
+    /**
+     * REQUIRED. A cheap pending probe — O(1) or index-backed. Called on every
+     * boot for every instance (§4.2.1), so it MUST NOT be a full-collection
+     * scan. For `preflight` + `block`, a false positive blocks boot for the
+     * whole cluster (§4.2.7), so authors must write this conservatively (§6.2).
+     */
+    isPending: (ctx: MigrationContext) => Promise<boolean>;
+    /**
+     * OPTIONAL. A detailed report for `plan` — may be a full scan. Not called
+     * at boot. When omitted, `plan` shows "details unavailable" and relies on
+     * the `isPending` verdict.
+     */
+    detect?: (ctx: MigrationContext) => Promise<DetectReport>;
+}
+/**
+ * Identity helper that attaches the `MigrationDefinition` type to a literal
+ * so migration modules get inference + a single import to depend on. Returns
+ * its argument unchanged (no runtime behaviour, mirrors `defineConfig`-style
+ * helpers).
+ */
+export declare function defineMigration(def: MigrationDefinition): MigrationDefinition;

package/dist/migration/types.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineMigration = defineMigration;
+/**
+ * Identity helper that attaches the `MigrationDefinition` type to a literal
+ * so migration modules get inference + a single import to depend on. Returns
+ * its argument unchanged (no runtime behaviour, mirrors `defineConfig`-style
+ * helpers).
+ */
+function defineMigration(def) {
+    return def;
+}
+//# sourceMappingURL=types.js.map

package/dist/migration/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/migration/types.ts"],"names":[],"mappings":";;AA8KA,0CAEC;AARD;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,GAAwB;IACtD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/models/activity.d.ts

@@ -0,0 +1,34 @@
+import Crowi from '../crowi';
+import { Types, Document, Model } from 'mongoose';
+export interface ActivityDocument extends Document {
+    _id: Types.ObjectId;
+    user: Types.ObjectId | any;
+    targetModel: string;
+    target: string;
+    action: string;
+    event: Types.ObjectId;
+    eventModel: string;
+    createdAt: Date;
+    getNotificationTargetUsers(): Promise<any[]>;
+}
+export interface ActivityModel extends Model<ActivityDocument> {
+    createByParameters(parameters: any): Promise<ActivityDocument>;
+    removeByParameters(parameters: any): any;
+    createByPageComment(comment: any): Promise<ActivityDocument>;
+    removeByPageCommentDelete(comment: any): Promise<{
+        deletedCount: number;
+    }>;
+    createByPageLike(page: any, user: any): Promise<ActivityDocument>;
+    removeByPageUnlike(page: any, user: any): Promise<{
+        deletedCount: number;
+    }>;
+    createByPageUpdate(page: any, user: any): Promise<ActivityDocument>;
+    createByPageMention(page: any, mentionedUser: any, author: any): Promise<ActivityDocument>;
+    removeByPage(page: any): Promise<{
+        deletedCount: number;
+    }>;
+    findByUser(user: any): Promise<ActivityDocument[]>;
+    getActionUsersFromActivities(activities: ActivityDocument[]): any[];
+}
+declare const _default: (crowi: Crowi) => ActivityModel;
+export default _default;