@crowi/api 2.0.0-alpha.0

package/dist/util/auth.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const googleAuth_1 = __importDefault(require("./googleAuth"));
+const githubAuth_1 = __importDefault(require("./githubAuth"));
+exports.default = {
+    isLoggedIn(crowi, req) {
+        const { user = {} } = req;
+        const User = crowi.model('User');
+        const isLoggedIn = user && '_id' in user && user.status === User.STATUS_ACTIVE;
+        return isLoggedIn;
+    },
+    isAccessTokenExpired(req) {
+        const { auth = {} } = req.session;
+        const { expiryDate = null } = auth;
+        if (expiryDate === null) {
+            return false;
+        }
+        const now = new Date().getTime();
+        return expiryDate < now;
+    },
+    async reauth(req, config) {
+        const { auth = {} } = req.session;
+        const { provider = '', accessToken = null, refreshToken = null } = auth;
+        const authServices = {
+            google: (0, googleAuth_1.default)(config),
+            github: (0, githubAuth_1.default)(config),
+        };
+        const providers = [authServices.google.PROVIDER, authServices.github.PROVIDER];
+        if (providers.includes(provider)) {
+            const authService = authServices[provider];
+            const serviceId = req.user[provider + 'Id'];
+            const { success, tokens } = await authService.reauth(serviceId, { accessToken, refreshToken });
+            if (success) {
+                this.saveTokenToSession(req, provider, tokens);
+            }
+            return success;
+        }
+        return false;
+    },
+    saveTokenToSession(req, provider = '', { accessToken = null, refreshToken = null, expiryDate = null }) {
+        expiryDate = expiryDate || new Date().getTime() + 60 * 60 * 1000;
+        req.session.auth = { provider, accessToken, refreshToken, expiryDate };
+    },
+};
+//# sourceMappingURL=auth.js.map

package/dist/util/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../src/util/auth.ts"],"names":[],"mappings":";;;;;AAAA,8DAAsC;AACtC,8DAAsC;AAEtC,kBAAe;IACb,UAAU,CAAC,KAAK,EAAE,GAAG;QACnB,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,GAAG,GAAG,CAAC;QAC1B,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACjC,MAAM,UAAU,GAAG,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,aAAa,CAAC;QAC/E,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,oBAAoB,CAAC,GAAG;QACtB,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC;QAClC,MAAM,EAAE,UAAU,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACnC,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QACjC,OAAO,UAAU,GAAG,GAAG,CAAC;IAC1B,CAAC;IACD,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM;QACtB,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC;QAClC,MAAM,EAAE,QAAQ,GAAG,EAAE,EAAE,WAAW,GAAG,IAAI,EAAE,YAAY,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACxE,MAAM,YAAY,GAAG;YACnB,MAAM,EAAE,IAAA,oBAAU,EAAC,MAAM,CAAC;YAC1B,MAAM,EAAE,IAAA,oBAAU,EAAC,MAAM,CAAC;SAC3B,CAAC;QACF,MAAM,SAAS,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC/E,IAAI,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjC,MAAM,WAAW,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;YAC3C,MAAM,SAAS,GAAG,GAAG,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC;YAC5C,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC,CAAC;YAC/F,IAAI,OAAO,EAAE,CAAC;gBACZ,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;YACjD,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,kBAAkB,CAChB,GAAG,EACH,QAAQ,GAAG,EAAE,EACb,EAAE,WAAW,GAAG,IAAI,EAAE,YAAY,GAAG,IAAI,EAAE,UAAU,GAAG,IAAI,EAA0F;QAEtJ,UAAU,GAAG,UAAU,IAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QACjE,GAAG,CAAC,OAAO,CAAC,IAAI,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC;IACzE,CAAC;CACF,CAAC"}

package/dist/util/auto-watch.d.ts

@@ -0,0 +1,35 @@
+/**
+ * feature-watch-autosubscribe — auto-watch helper.
+ *
+ * When a user participates in a page (creates it, saves a new revision, or
+ * comments), we materialise an explicit `Watcher(STATUS_WATCH)` row so the
+ * notification fan-out — now watcher-only (see
+ * `models/activity.ts:getNotificationTargetUsers`) — reaches them, and so
+ * they can plainly unwatch later.
+ *
+ * Semantics (single source of truth for all three call sites):
+ *   - An existing IGNORE row is respected: never overwrite it (the user
+ *     explicitly opted out). No-op, `newlyWatching = false`.
+ *   - An existing WATCH row: no-op, `newlyWatching = false`.
+ *   - No row at all: create a WATCH row, `newlyWatching = true`.
+ *
+ * `Watcher.upsertWatcher` is intentionally NOT used here: it does a
+ * `findOneAndUpdate({ user, target }, { status })` with `upsert`, which
+ * stomps an existing IGNORE back to WATCH. We must branch on the existing
+ * row's status first.
+ *
+ * The `target` is always a Page (`targetModel = 'Page'`) for the current
+ * call sites; this matches `Activity` / `Watcher` usage elsewhere.
+ */
+import type { Types } from 'mongoose';
+import type { WatcherModel } from '../models/watcher';
+export interface AutoWatchResult {
+    /** true only when this call created a brand-new WATCH row. */
+    newlyWatching: boolean;
+}
+/**
+ * Materialise a WATCH watcher row for `userId` on `pageId`, respecting an
+ * existing IGNORE opt-out. Returns whether a new WATCH row was created so
+ * callers (e.g. the comment handler) can surface a "now watching" hint.
+ */
+export declare function autoWatchPage(Watcher: WatcherModel, userId: Types.ObjectId, pageId: Types.ObjectId): Promise<AutoWatchResult>;

package/dist/util/auto-watch.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.autoWatchPage = autoWatchPage;
+const TARGET_MODEL_PAGE = 'Page';
+/**
+ * Materialise a WATCH watcher row for `userId` on `pageId`, respecting an
+ * existing IGNORE opt-out. Returns whether a new WATCH row was created so
+ * callers (e.g. the comment handler) can surface a "now watching" hint.
+ */
+async function autoWatchPage(Watcher, userId, pageId) {
+    const existing = await Watcher.findByUserIdAndTargetId(userId, pageId);
+    if (existing) {
+        // Either IGNORE (respect opt-out) or already WATCH — nothing to do.
+        return { newlyWatching: false };
+    }
+    await Watcher.create({
+        user: userId,
+        targetModel: TARGET_MODEL_PAGE,
+        target: pageId,
+        status: Watcher.STATUS_WATCH,
+    });
+    return { newlyWatching: true };
+}
+//# sourceMappingURL=auto-watch.js.map

package/dist/util/auto-watch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auto-watch.js","sourceRoot":"","sources":["../../src/util/auto-watch.ts"],"names":[],"mappings":";;AAsCA,sCAcC;AA1BD,MAAM,iBAAiB,GAAG,MAAM,CAAC;AAOjC;;;;GAIG;AACI,KAAK,UAAU,aAAa,CAAC,OAAqB,EAAE,MAAsB,EAAE,MAAsB;IACvG,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,uBAAuB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvE,IAAI,QAAQ,EAAE,CAAC;QACb,oEAAoE;QACpE,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;IAClC,CAAC;IAED,MAAM,OAAO,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,iBAAiB;QAC9B,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,OAAO,CAAC,YAAY;KAC7B,CAAC,CAAC;IACH,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;AACjC,CAAC"}

package/dist/util/autocomplete-match.d.ts

@@ -0,0 +1,44 @@
+/**
+ * RFC-0004 Phase 5 — pure matching / scoring for autocomplete.
+ *
+ * The autocomplete endpoints over-fetch a candidate set from Mongo
+ * (a case-insensitive substring query is the widest filter the index
+ * can serve cheaply) and then rank it here. Ranking is the RFC's
+ * three-tier order — **prefix > substring > fuzzy** — applied across
+ * the per-entity fields, each field carrying its own weight:
+ *
+ *   - users: `username` (highest) > display name > email-local-part
+ *   - pages: full `path` (highest) > path leaf ("title")
+ *
+ * Keeping this logic as a pure, field-agnostic function makes the
+ * tiering testable without a database and lets both endpoints share
+ * one implementation.
+ */
+/** Match tier, best first. `null` means the candidate does not match. */
+export type MatchTier = 'prefix' | 'substring' | 'fuzzy' | null;
+/**
+ * Classify how `query` matches `text` (both compared lower-cased).
+ *  - `prefix`    — `text` starts with `query`.
+ *  - `substring` — `query` appears somewhere inside `text`.
+ *  - `fuzzy`     — every `query` character appears in `text` in order
+ *                  (subsequence match), e.g. `apc` ⊑ `api-spec`.
+ *  - `null`      — no match.
+ */
+export declare function classifyMatch(text: string, query: string): MatchTier;
+/**
+ * A single weighted field of a candidate. `weight` is added to the
+ * tier score so, within one tier, higher-weight fields rank first.
+ */
+export interface ScoredField {
+    text: string;
+    weight: number;
+}
+/**
+ * Score a candidate against `query` over its weighted fields. The
+ * candidate's score is the best (highest) field score; a candidate
+ * with no matching field scores 0 and should be dropped.
+ *
+ * A short bonus rewards exact-length prefix matches (the typed query
+ * *is* the field) so e.g. typing `@bob` floats `bob` above `bobby`.
+ */
+export declare function scoreCandidate(fields: ScoredField[], query: string): number;

package/dist/util/autocomplete-match.js

@@ -0,0 +1,80 @@
+"use strict";
+/**
+ * RFC-0004 Phase 5 — pure matching / scoring for autocomplete.
+ *
+ * The autocomplete endpoints over-fetch a candidate set from Mongo
+ * (a case-insensitive substring query is the widest filter the index
+ * can serve cheaply) and then rank it here. Ranking is the RFC's
+ * three-tier order — **prefix > substring > fuzzy** — applied across
+ * the per-entity fields, each field carrying its own weight:
+ *
+ *   - users: `username` (highest) > display name > email-local-part
+ *   - pages: full `path` (highest) > path leaf ("title")
+ *
+ * Keeping this logic as a pure, field-agnostic function makes the
+ * tiering testable without a database and lets both endpoints share
+ * one implementation.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.classifyMatch = classifyMatch;
+exports.scoreCandidate = scoreCandidate;
+/**
+ * Classify how `query` matches `text` (both compared lower-cased).
+ *  - `prefix`    — `text` starts with `query`.
+ *  - `substring` — `query` appears somewhere inside `text`.
+ *  - `fuzzy`     — every `query` character appears in `text` in order
+ *                  (subsequence match), e.g. `apc` ⊑ `api-spec`.
+ *  - `null`      — no match.
+ */
+function classifyMatch(text, query) {
+    if (query.length === 0)
+        return null;
+    const t = text.toLowerCase();
+    const q = query.toLowerCase();
+    if (t.startsWith(q))
+        return 'prefix';
+    if (t.includes(q))
+        return 'substring';
+    return isSubsequence(q, t) ? 'fuzzy' : null;
+}
+/** True when every char of `needle` appears in `haystack` in order. */
+function isSubsequence(needle, haystack) {
+    let i = 0;
+    for (let j = 0; j < haystack.length && i < needle.length; j += 1) {
+        if (haystack[j] === needle[i])
+            i += 1;
+    }
+    return i === needle.length;
+}
+/** Base score per tier. Wider gaps than the field weights so a better
+ *  tier on a lower-weight field still outranks a worse tier on a
+ *  higher-weight field. */
+const TIER_SCORE = {
+    prefix: 300,
+    substring: 200,
+    fuzzy: 100,
+};
+/**
+ * Score a candidate against `query` over its weighted fields. The
+ * candidate's score is the best (highest) field score; a candidate
+ * with no matching field scores 0 and should be dropped.
+ *
+ * A short bonus rewards exact-length prefix matches (the typed query
+ * *is* the field) so e.g. typing `@bob` floats `bob` above `bobby`.
+ */
+function scoreCandidate(fields, query) {
+    let best = 0;
+    for (const field of fields) {
+        const tier = classifyMatch(field.text, query);
+        if (tier === null)
+            continue;
+        let score = TIER_SCORE[tier] + field.weight;
+        if (tier === 'prefix' && field.text.toLowerCase() === query.toLowerCase()) {
+            score += 50; // exact full-field match
+        }
+        if (score > best)
+            best = score;
+    }
+    return best;
+}
+//# sourceMappingURL=autocomplete-match.js.map

package/dist/util/autocomplete-match.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"autocomplete-match.js","sourceRoot":"","sources":["../../src/util/autocomplete-match.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;AAaH,sCAOC;AAqCD,wCAYC;AAhED;;;;;;;GAOG;AACH,SAAgB,aAAa,CAAC,IAAY,EAAE,KAAa;IACvD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACpC,MAAM,CAAC,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAC7B,MAAM,CAAC,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;IAC9B,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;QAAE,OAAO,QAAQ,CAAC;IACrC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;QAAE,OAAO,WAAW,CAAC;IACtC,OAAO,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;AAC9C,CAAC;AAED,uEAAuE;AACvE,SAAS,aAAa,CAAC,MAAc,EAAE,QAAgB;IACrD,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACjE,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC;YAAE,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC;AAC7B,CAAC;AAED;;2BAE2B;AAC3B,MAAM,UAAU,GAA6C;IAC3D,MAAM,EAAE,GAAG;IACX,SAAS,EAAE,GAAG;IACd,KAAK,EAAE,GAAG;CACX,CAAC;AAWF;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,MAAqB,EAAE,KAAa;IACjE,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC9C,IAAI,IAAI,KAAK,IAAI;YAAE,SAAS;QAC5B,IAAI,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;QAC5C,IAAI,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YAC1E,KAAK,IAAI,EAAE,CAAC,CAAC,yBAAyB;QACxC,CAAC;QACD,IAAI,KAAK,GAAG,IAAI;YAAE,IAAI,GAAG,KAAK,CAAC;IACjC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/util/aws-config-migration.d.ts

@@ -0,0 +1,11 @@
+import type Crowi from '../crowi';
+/**
+ * Copy legacy `upload:aws:*` config into the new plugin namespace
+ * (`plugin:@crowi/plugin-aws:*` and `plugin:@crowi/plugin-storage-aws-s3:bucket`).
+ * Idempotent: target keys are written only when empty / missing. Returns
+ * the number of keys actually migrated.
+ *
+ * The legacy keys are kept in place so a downgrade still finds its config;
+ * cleanup is a follow-up once the new namespace is verified in production.
+ */
+export declare function runAwsConfigMigration(crowi: Crowi): Promise<number>;

package/dist/util/aws-config-migration.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runAwsConfigMigration = runAwsConfigMigration;
+const debug_1 = __importDefault(require("debug"));
+const debug = (0, debug_1.default)('crowi:util:aws-config-migration');
+/**
+ * Copy legacy `upload:aws:*` config into the new plugin namespace
+ * (`plugin:@crowi/plugin-aws:*` and `plugin:@crowi/plugin-storage-aws-s3:bucket`).
+ * Idempotent: target keys are written only when empty / missing. Returns
+ * the number of keys actually migrated.
+ *
+ * The legacy keys are kept in place so a downgrade still finds its config;
+ * cleanup is a follow-up once the new namespace is verified in production.
+ */
+async function runAwsConfigMigration(crowi) {
+    const cfg = crowi.getConfig();
+    if (!cfg || typeof cfg !== 'object') {
+        debug('config not loaded yet, skipping aws migration');
+        return 0;
+    }
+    const ns = cfg.crowi;
+    if (!ns) {
+        debug('crowi namespace missing, skipping aws migration');
+        return 0;
+    }
+    const pairs = [
+        { legacy: 'upload:aws:region', next: 'plugin:@crowi/plugin-aws:region' },
+        { legacy: 'upload:aws:accessKeyId', next: 'plugin:@crowi/plugin-aws:accessKeyId' },
+        { legacy: 'upload:aws:secretAccessKey', next: 'plugin:@crowi/plugin-aws:secretAccessKey' },
+        // The S3 bucket lives in the storage-aws-s3 plugin's own namespace
+        // because it's S3-specific config rather than shared AWS credentials.
+        { legacy: 'upload:aws:bucket', next: 'plugin:@crowi/plugin-storage-aws-s3:bucket' },
+    ];
+    const updates = {};
+    for (const { legacy, next } of pairs) {
+        const legacyValue = ns[legacy];
+        if (!hasMeaningfulValue(legacyValue))
+            continue;
+        if (hasMeaningfulValue(ns[next]))
+            continue;
+        updates[next] = legacyValue;
+    }
+    if (Object.keys(updates).length === 0) {
+        debug('no aws keys to migrate');
+        return 0;
+    }
+    // Write through the model directly to avoid `notifyUpdated()` which
+    // would fire `setupSlack` / `setupMailer` — both run again a few lines
+    // later in `Crowi.init()` anyway, and the redis pubsub may not be wired
+    // yet at this point in boot.
+    const Config = crowi.model('Config');
+    await Config.updateConfigByNamespace('crowi', updates);
+    Object.assign(ns, updates);
+    console.log(`[crowi] Migrated ${Object.keys(updates).length} legacy upload:aws:* config key(s) into the plugin namespace.`);
+    debug('migrated keys: %o', Object.keys(updates));
+    return Object.keys(updates).length;
+}
+function hasMeaningfulValue(value) {
+    if (value === null || value === undefined)
+        return false;
+    if (typeof value === 'string' && value === '')
+        return false;
+    return true;
+}
+//# sourceMappingURL=aws-config-migration.js.map

package/dist/util/aws-config-migration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aws-config-migration.js","sourceRoot":"","sources":["../../src/util/aws-config-migration.ts"],"names":[],"mappings":";;;;;AAcA,sDA6CC;AA3DD,kDAA0B;AAG1B,MAAM,KAAK,GAAG,IAAA,eAAK,EAAC,iCAAiC,CAAC,CAAC;AAEvD;;;;;;;;GAQG;AACI,KAAK,UAAU,qBAAqB,CAAC,KAAY;IACtD,MAAM,GAAG,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;IAC9B,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QACpC,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACvD,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,EAAE,GAAI,GAA2C,CAAC,KAAK,CAAC;IAC9D,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACzD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,KAAK,GAAuC;QAChD,EAAE,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,iCAAiC,EAAE;QACxE,EAAE,MAAM,EAAE,wBAAwB,EAAE,IAAI,EAAE,sCAAsC,EAAE;QAClF,EAAE,MAAM,EAAE,4BAA4B,EAAE,IAAI,EAAE,0CAA0C,EAAE;QAC1F,mEAAmE;QACnE,sEAAsE;QACtE,EAAE,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,4CAA4C,EAAE;KACpF,CAAC;IAEF,MAAM,OAAO,GAA4B,EAAE,CAAC;IAC5C,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,EAAE,CAAC;QACrC,MAAM,WAAW,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;QAC/B,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC;YAAE,SAAS;QAC/C,IAAI,kBAAkB,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;YAAE,SAAS;QAC3C,OAAO,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC;IAC9B,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAChC,OAAO,CAAC,CAAC;IACX,CAAC;IAED,oEAAoE;IACpE,uEAAuE;IACvE,wEAAwE;IACxE,6BAA6B;IAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACrC,MAAM,MAAM,CAAC,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvD,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAE3B,OAAO,CAAC,GAAG,CAAC,oBAAoB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,+DAA+D,CAAC,CAAC;IAC5H,KAAK,CAAC,mBAAmB,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACjD,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;AACrC,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAc;IACxC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACxD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE;QAAE,OAAO,KAAK,CAAC;IAC5D,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/util/boot-reporter.d.ts

@@ -0,0 +1,130 @@
+/**
+ * TTY-aware boot reporter (feature-boot-progress-ui, Part 1).
+ *
+ * Wraps the existing `step()` boot sequence in `crowi/index.ts` and groups
+ * the 13 init steps + the server start steps into four layers
+ * (core / config / services / server). Each layer is shown as:
+ *
+ *   - TTY:     a live spinner that resolves to `✓ <layer>  (Nms)` and a final
+ *              `🚀 API ready <url>` banner.
+ *   - non-TTY: a structured, grep-able one-line log per layer
+ *              (`[boot] core ok (412ms)`), no cursor control / re-draw.
+ *
+ * In both modes a machine-readable marker is emitted on exactly one line at
+ * the end of boot: `@@crowi:ready api <url>` on success, or
+ * `@@crowi:fail api <reason>` when boot aborts (e.g. the database is
+ * unreachable). These two markers are the only contract `scripts/dev.mjs`
+ * depends on — kept separate from the human-facing banner so wording can
+ * change freely. On the fail marker the dev launcher tears the whole tree
+ * (api · web · deps) down instead of leaving web up against a dead api.
+ *
+ * The reporter is intentionally `debug`-independent: it writes to stdout
+ * directly so operators see boot progress without `DEBUG=crowi:*`. When
+ * `DEBUG` is set we degrade to plain mode (see {@link createBootReporter}) so
+ * spinner re-draws never interleave with debug output.
+ *
+ * Pure helpers (marker formatting/parsing, plain-line formatting, duration
+ * formatting, spinner frame, ANSI escapes) are exported so they can be
+ * unit-tested without a real TTY.
+ */
+/** Boot layers, in execution order. */
+export type BootLayer = 'core' | 'config' | 'services' | 'server';
+/** Stable, machine-readable readiness marker prefix. Shared contract with `scripts/dev.mjs`. */
+export declare const READY_MARKER_PREFIX = "@@crowi:ready";
+/** ANSI escape fragments — bundled so tests can assert on exact bytes. */
+export declare const ANSI: {
+    readonly hideCursor: "\u001B[?25l";
+    readonly showCursor: "\u001B[?25h";
+    readonly clearLine: "\u001B[2K";
+    readonly cursorStart: "\r";
+    readonly dim: "\u001B[2m";
+    readonly green: "\u001B[32m";
+    readonly cyan: "\u001B[36m";
+    readonly bold: "\u001B[1m";
+    readonly reset: "\u001B[0m";
+};
+/** Format a duration as a compact `(Nms)` / `(N.Ns)` token. */
+export declare function formatDuration(ms: number): string;
+/** Spinner frame for a given tick (wraps around the frame list). */
+export declare function spinnerFrame(tick: number): string;
+/** Build the `@@crowi:ready <service> <url>` marker line (no trailing newline). */
+export declare function formatReadyMarker(service: string, url: string): string;
+/**
+ * Parse a `@@crowi:ready <service> <url>` marker out of an arbitrary output
+ * line (it may be prefixed by turbo's `api:dev: ` etc.). Returns null when the
+ * line carries no marker. Shared logic mirrored in `scripts/dev.mjs`.
+ */
+export declare function parseReadyMarker(line: string): {
+    service: string;
+    url: string;
+} | null;
+/** Stable, machine-readable boot-failure marker prefix. Shared contract with `scripts/dev.mjs`. */
+export declare const FAIL_MARKER_PREFIX = "@@crowi:fail";
+/**
+ * Build the `@@crowi:fail <service> <reason>` marker line (no trailing newline).
+ * The reason is collapsed to a single line so the marker is always parseable
+ * off one output line.
+ */
+export declare function formatFailMarker(service: string, reason: string): string;
+/**
+ * Parse a `@@crowi:fail <service> <reason…>` marker out of an arbitrary output
+ * line (it may be prefixed by turbo's `api:dev: `). `service` is the first
+ * token; `reason` is the remainder (may be empty). Returns null when the line
+ * carries no marker. Mirrored in `scripts/dev.mjs` so the dev launcher can tear
+ * the whole tree down instead of leaving web up against a dead api.
+ */
+export declare function parseFailMarker(line: string): {
+    service: string;
+    reason: string;
+} | null;
+/** Non-TTY structured layer line: `[boot] core ok (412ms)`. */
+export declare function formatPlainLayerLine(layer: BootLayer, ms: number): string;
+/** Non-TTY final line: `[boot] ready in 1.2s` (total boot time). */
+export declare function formatPlainReadyLine(totalMs: number): string;
+export interface BootReporter {
+    /** Start a layer (begins the spinner in TTY mode). */
+    beginLayer(layer: BootLayer): void;
+    /** Mark the active layer done and print its elapsed time. */
+    endLayer(): void;
+    /**
+     * Emit a warning/error line without corrupting the live spinner: clears the
+     * current spinner line, writes the message, then re-arms the spinner.
+     */
+    note(write: () => void): void;
+    /**
+     * Finish boot: stops any spinner, prints the human banner + the machine
+     * readiness marker. `service`/`url` feed the marker; `url` also the banner.
+     */
+    finish(service: string, url: string): void;
+    /**
+     * Idempotent teardown for the failure path: stops any running spinner,
+     * clears the current spinner line and restores the cursor. Safe to call
+     * multiple times (e.g. from a try/finally *and* from `exitOnError`). Must run
+     * before a fatal `console.error` so the spinner doesn't overwrite the stack
+     * trace and the hidden cursor is restored before the process exits.
+     */
+    dispose(): void;
+}
+export interface CreateBootReporterOptions {
+    /** Output sink. Defaults to `process.stdout`. */
+    stream?: NodeJS.WriteStream;
+    /** Force TTY/plain mode (tests). Defaults to `stream.isTTY`. */
+    isTTY?: boolean;
+    /**
+     * When DEBUG is active, plain mode is forced so spinner re-draws don't
+     * interleave with debug output. Defaults to reading `process.env.DEBUG`.
+     */
+    debugEnabled?: boolean;
+    /**
+     * Suppress ALL output (progress lines, banner, readiness marker). Used by
+     * the test harness, where each of the 100+ test files boots Crowi and the
+     * per-layer `[boot] … ok` lines would otherwise flood the jest output.
+     * Defaults to `false`.
+     */
+    quiet?: boolean;
+}
+/**
+ * Construct the boot reporter. In TTY mode it animates a spinner per layer; in
+ * plain mode (non-TTY, or `DEBUG` set) it emits one structured line per layer.
+ */
+export declare function createBootReporter(options?: CreateBootReporterOptions): BootReporter;