@byline/cli 0.1.1

package/dist/runner.js

@@ -0,0 +1,91 @@
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { dirname } from 'node:path';
+import { execa } from 'execa';
+import { renderDiff } from './ui/diff.js';
+export async function runPhase(phase, ctx) {
+    const detected = await phase.detect(ctx);
+    if (detected === 'done' && !ctx.cliFlags.force) {
+        ctx.logger.success(`${phase.id} — already complete`);
+        return;
+    }
+    if (detected === 'blocked') {
+        ctx.logger.error(`${phase.id} — blocked; cannot proceed`);
+        return;
+    }
+    ctx.logger.step(`${phase.id} — planning`);
+    const plan = await phase.plan(ctx);
+    if (plan.writes.length === 0 && plan.commands.length === 0 && plan.notes.length === 0) {
+        ctx.logger.info(`${phase.id} — nothing to do`);
+        ctx.state.markPhaseComplete(phase.id);
+        ctx.state.flush();
+        return;
+    }
+    previewPlan(phase, plan, ctx);
+    if (ctx.dryRun) {
+        ctx.logger.info(`${phase.id} — dry-run; skipping apply`);
+        return;
+    }
+    const shouldApply = await decideApply(phase, ctx);
+    if (!shouldApply) {
+        ctx.logger.warn(`${phase.id} — skipped by user`);
+        return;
+    }
+    const result = await phase.apply(plan, ctx);
+    if (result.notes)
+        for (const n of result.notes)
+            ctx.logger.info(n);
+    if (result.state === 'done') {
+        ctx.state.markPhaseComplete(phase.id);
+        ctx.logger.success(`${phase.id} — done`);
+    }
+    else if (result.state === 'partial') {
+        ctx.logger.warn(`${phase.id} — partial; re-run to finish`);
+    }
+    else if (result.state === 'blocked') {
+        ctx.logger.error(`${phase.id} — blocked`);
+    }
+    ctx.state.flush();
+}
+function previewPlan(phase, plan, ctx) {
+    ctx.logger.raw('');
+    ctx.logger.raw(`  ${phase.title}`);
+    for (const note of plan.notes)
+        ctx.logger.raw(`    • ${note}`);
+    for (const w of plan.writes) {
+        const before = w.before ?? readIfExists(w.path);
+        const label = before ? 'modify' : 'create';
+        ctx.logger.raw(`    ${label}  ${w.path}`);
+        if (before !== w.contents) {
+            ctx.logger.raw(renderDiff(w.path, before, w.contents));
+        }
+    }
+    for (const c of plan.commands) {
+        ctx.logger.raw(`    run     ${c.command} ${c.args.join(' ')}`);
+    }
+    ctx.logger.raw('');
+}
+async function decideApply(phase, ctx) {
+    if (ctx.apply && phase.defaultMode === 'confirm')
+        return true;
+    if (phase.defaultMode === 'auto' && ctx.apply !== false)
+        return true;
+    if (ctx.yes)
+        return true;
+    return ctx.prompter.confirm({
+        message: `Apply ${phase.id} changes?`,
+        defaultValue: phase.defaultMode === 'auto',
+    });
+}
+function readIfExists(path) {
+    return existsSync(path) ? readFileSync(path, 'utf8') : '';
+}
+export async function executePlan(plan, ctx) {
+    for (const w of plan.writes) {
+        mkdirSync(dirname(w.path), { recursive: true });
+        writeFileSync(w.path, w.contents, 'utf8');
+    }
+    for (const c of plan.commands) {
+        await execa(c.command, c.args, { cwd: c.cwd ?? ctx.cwd, stdio: 'inherit' });
+    }
+}
+//# sourceMappingURL=runner.js.map

package/dist/runner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runner.js","sourceRoot":"","sources":["../src/runner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAC5E,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAA;AAE7B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAIzC,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,KAAY,EAAE,GAAY;IACvD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACxC,IAAI,QAAQ,KAAK,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QAC/C,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,EAAE,qBAAqB,CAAC,CAAA;QACpD,OAAM;IACR,CAAC;IACD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,EAAE,4BAA4B,CAAC,CAAA;QACzD,OAAM;IACR,CAAC;IAED,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,EAAE,aAAa,CAAC,CAAA;IACzC,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAElC,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtF,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,EAAE,kBAAkB,CAAC,CAAA;QAC9C,GAAG,CAAC,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QACrC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;QACjB,OAAM;IACR,CAAC;IAED,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;IAE7B,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QACf,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,EAAE,4BAA4B,CAAC,CAAA;QACxD,OAAM;IACR,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;IACjD,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,EAAE,oBAAoB,CAAC,CAAA;QAChD,OAAM;IACR,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;IAC3C,IAAI,MAAM,CAAC,KAAK;QAAE,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,KAAK;YAAE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAElE,IAAI,MAAM,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;QAC5B,GAAG,CAAC,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QACrC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,EAAE,SAAS,CAAC,CAAA;IAC1C,CAAC;SAAM,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACtC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,EAAE,8BAA8B,CAAC,CAAA;IAC5D,CAAC;SAAM,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACtC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,EAAE,YAAY,CAAC,CAAA;IAC3C,CAAC;IACD,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;AACnB,CAAC;AAED,SAAS,WAAW,CAAC,KAAY,EAAE,IAAU,EAAE,GAAY;IACzD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IAClB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC,CAAA;IAClC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK;QAAE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC,CAAA;IAC9D,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,IAAI,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QAC/C,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAA;QAC1C,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,KAAK,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;QACzC,IAAI,MAAM,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC1B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAA;QACxD,CAAC;IACH,CAAC;IACD,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IAChE,CAAC;IACD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;AACpB,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,KAAY,EAAE,GAAY;IACnD,IAAI,GAAG,CAAC,KAAK,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS;QAAE,OAAO,IAAI,CAAA;IAC7D,IAAI,KAAK,CAAC,WAAW,KAAK,MAAM,IAAI,GAAG,CAAC,KAAK,KAAK,KAAK;QAAE,OAAO,IAAI,CAAA;IACpE,IAAI,GAAG,CAAC,GAAG;QAAE,OAAO,IAAI,CAAA;IACxB,OAAO,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC1B,OAAO,EAAE,SAAS,KAAK,CAAC,EAAE,WAAW;QACrC,YAAY,EAAE,KAAK,CAAC,WAAW,KAAK,MAAM;KAC3C,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,IAAY;IAChC,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;AAC3D,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,IAAU,EAAE,GAAY;IACxD,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAC5B,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAC/C,aAAa,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IAC3C,CAAC;IACD,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAA;IAC7E,CAAC;AACH,CAAC"}

package/dist/state.d.ts

@@ -0,0 +1,18 @@
+import type { InstallState, PhaseId } from './types.js';
+export declare class StateStore {
+    private state;
+    private readonly path;
+    private dirty;
+    constructor(cwd: string);
+    private fresh;
+    private load;
+    get(): Readonly<InstallState>;
+    patch(partial: Partial<InstallState>): void;
+    patchAnswers(partial: InstallState['answers']): void;
+    markPhaseComplete(id: PhaseId): void;
+    isComplete(id: PhaseId): boolean;
+    setWireSubEdit(key: string, status: 'pending' | 'done' | 'manual' | 'skipped'): void;
+    flush(): void;
+    filePath(): string;
+}
+//# sourceMappingURL=state.d.ts.map

package/dist/state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../src/state.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAIvD,qBAAa,UAAU;IACrB,OAAO,CAAC,KAAK,CAAc;IAC3B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAQ;IAC7B,OAAO,CAAC,KAAK,CAAQ;gBAET,GAAG,EAAE,MAAM;IAKvB,OAAO,CAAC,KAAK;IAUb,OAAO,CAAC,IAAI;IAWZ,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC;IAI7B,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI;IAK3C,YAAY,CAAC,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,GAAG,IAAI;IAKpD,iBAAiB,CAAC,EAAE,EAAE,OAAO,GAAG,IAAI;IAOpC,UAAU,CAAC,EAAE,EAAE,OAAO,GAAG,OAAO;IAIhC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,IAAI;IAKpF,KAAK,IAAI,IAAI;IAMb,QAAQ,IAAI,MAAM;CAGnB"}

package/dist/state.js

@@ -0,0 +1,68 @@
+import { existsSync, readFileSync, writeFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+const STATE_FILE = '.byline-install.json';
+export class StateStore {
+    state;
+    path;
+    dirty = false;
+    constructor(cwd) {
+        this.path = resolve(cwd, STATE_FILE);
+        this.state = this.load() ?? this.fresh();
+    }
+    fresh() {
+        return {
+            version: 1,
+            startedAt: new Date().toISOString(),
+            completedPhases: [],
+            answers: {},
+            wireSubEdits: {},
+        };
+    }
+    load() {
+        if (!existsSync(this.path))
+            return null;
+        try {
+            const raw = JSON.parse(readFileSync(this.path, 'utf8'));
+            if (raw.version !== 1)
+                return null;
+            return raw;
+        }
+        catch {
+            return null;
+        }
+    }
+    get() {
+        return this.state;
+    }
+    patch(partial) {
+        this.state = { ...this.state, ...partial };
+        this.dirty = true;
+    }
+    patchAnswers(partial) {
+        this.state.answers = { ...this.state.answers, ...partial };
+        this.dirty = true;
+    }
+    markPhaseComplete(id) {
+        if (!this.state.completedPhases.includes(id)) {
+            this.state.completedPhases.push(id);
+            this.dirty = true;
+        }
+    }
+    isComplete(id) {
+        return this.state.completedPhases.includes(id);
+    }
+    setWireSubEdit(key, status) {
+        this.state.wireSubEdits[key] = status;
+        this.dirty = true;
+    }
+    flush() {
+        if (!this.dirty)
+            return;
+        writeFileSync(this.path, `${JSON.stringify(this.state, null, 2)}\n`, 'utf8');
+        this.dirty = false;
+    }
+    filePath() {
+        return this.path;
+    }
+}
+//# sourceMappingURL=state.js.map

package/dist/state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.js","sourceRoot":"","sources":["../src/state.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAInC,MAAM,UAAU,GAAG,sBAAsB,CAAA;AAEzC,MAAM,OAAO,UAAU;IACb,KAAK,CAAc;IACV,IAAI,CAAQ;IACrB,KAAK,GAAG,KAAK,CAAA;IAErB,YAAY,GAAW;QACrB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;QACpC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,IAAI,CAAC,KAAK,EAAE,CAAA;IAC1C,CAAC;IAEO,KAAK;QACX,OAAO;YACL,OAAO,EAAE,CAAC;YACV,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,eAAe,EAAE,EAAE;YACnB,OAAO,EAAE,EAAE;YACX,YAAY,EAAE,EAAE;SACjB,CAAA;IACH,CAAC;IAEO,IAAI;QACV,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAA;QACvC,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAiB,CAAA;YACvE,IAAI,GAAG,CAAC,OAAO,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAA;YAClC,OAAO,GAAG,CAAA;QACZ,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAA;QACb,CAAC;IACH,CAAC;IAED,GAAG;QACD,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IAED,KAAK,CAAC,OAA8B;QAClC,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,OAAO,EAAE,CAAA;QAC1C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;IACnB,CAAC;IAED,YAAY,CAAC,OAAgC;QAC3C,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,OAAO,EAAE,CAAA;QAC1D,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;IACnB,CAAC;IAED,iBAAiB,CAAC,EAAW;QAC3B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;YAC7C,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACnC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACnB,CAAC;IACH,CAAC;IAED,UAAU,CAAC,EAAW;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;IAChD,CAAC;IAED,cAAc,CAAC,GAAW,EAAE,MAAiD;QAC3E,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,MAAM,CAAA;QACrC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;IACnB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAM;QACvB,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAC5E,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;CACF"}

package/dist/templates/byline/admin.config.ts

@@ -0,0 +1,41 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+
+/**
+ * Registers Byline's client-side config (collection admin UI configs,
+ * field editors, i18n, routes) in the current module graph. Imported as
+ * a side-effect from `src/routes/__root.tsx` — that module runs in both
+ * the SSR render and client module graphs, so a single import there
+ * covers both contexts.
+ *
+ * This is the minimal scaffold: no example collections registered. Add
+ * collection schemas + admin configs to the `collections` and `admin`
+ * arrays as you create them.
+ */
+
+import type { ClientConfig } from '@byline/core'
+import { defineClientConfig } from '@byline/core'
+import { RichTextField as LexicalRichTextField } from '@byline/richtext-lexical'
+
+import { i18n } from './i18n.js'
+import { DEFAULT_SERVER_URL, routes } from './routes.js'
+
+const serverURL = import.meta.env.VITE_SERVER_URL || DEFAULT_SERVER_URL
+
+export const config: ClientConfig = {
+  serverURL,
+  i18n,
+  routes,
+  collections: [],
+  admin: [],
+  fields: {
+    richText: { editor: LexicalRichTextField },
+  },
+}
+
+defineClientConfig(config)

package/dist/templates/byline/i18n.ts

@@ -0,0 +1,47 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+
+/**
+ * Shared i18n locale configuration — no upstream dependencies, safe to import
+ * from both config entry-points and collection schema files without circular
+ * references.
+ *
+ * `interface` locales govern the CMS admin UI language.
+ * `content` locales govern the languages a document can be published in.
+ */
+
+export interface LocaleDefinition {
+  code: string
+  label: string
+}
+
+/** Locales available in the CMS admin interface. */
+export const interfaceLocales: LocaleDefinition[] = [
+  { code: 'en', label: 'English' },
+  { code: 'fr', label: 'Français' },
+]
+
+/** Locales a document can be published in. */
+export const contentLocales = [
+  { code: 'en', label: 'English' },
+  { code: 'fr', label: 'Français' },
+  { code: 'es', label: 'Español' },
+  { code: 'de', label: 'Deutsch' },
+] as const
+
+/** Derived config object — passed directly to defineServerConfig / defineClientConfig. */
+export const i18n = {
+  interface: {
+    defaultLocale: 'en',
+    locales: interfaceLocales.map((l) => l.code),
+  },
+  content: {
+    defaultLocale: 'en',
+    locales: contentLocales.map((l) => l.code),
+  },
+}

package/dist/templates/byline/routes.ts

@@ -0,0 +1,28 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+
+/**
+ * URL segments for admin and (future) public API routes. Defaults of
+ * `/admin` and `/api` are applied automatically by `resolveRoutes()` —
+ * keys only need to be set here when overriding either default.
+ */
+
+import type { RoutesConfig } from '@byline/core'
+
+export const routes: Partial<RoutesConfig> = {
+  admin: '/admin',
+  api: '/api',
+}
+
+/**
+ * Fallback used by both server and admin entry points when no
+ * `VITE_SERVER_URL` env var is set. Each entry resolves the env var
+ * itself (Vite's `import.meta.env` on the client, Node's `process.env`
+ * on the server) and falls back to this literal.
+ */
+export const DEFAULT_SERVER_URL = 'http://localhost:5173/'

package/dist/templates/byline/seed.ts

@@ -0,0 +1,19 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+
+// Initialize Byline config by importing the server config
+import 'dotenv/config'
+import './server.config.js'
+
+import { seedAdmin } from './seeds/admin.js'
+
+async function run() {
+  await seedAdmin()
+}
+
+run()

package/dist/templates/byline/seeds/admin.ts

@@ -0,0 +1,62 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+
+/**
+ * Super-admin bootstrap seed.
+ *
+ * Idempotent. Reads credentials from env (`BYLINE_SUPERADMIN_EMAIL`,
+ * `BYLINE_SUPERADMIN_PASSWORD`) and calls the built-in
+ * `seedSuperAdmin` helper from `@byline/admin/admin-users` against an
+ * `AdminStore` built on the application's single connection pool.
+ *
+ * The admin account it produces:
+ *   - `is_super_admin: true`  — bypasses every ability check
+ *   - `is_enabled: true`       — ready to sign in immediately
+ *   - `is_email_verified: true` — skip the verification gate for bootstrap
+ *
+ * In any non-dev deployment: change the credentials in env, run the seed
+ * once, then immediately change the password from inside the admin UI.
+ */
+
+import type { AdminStore } from '@byline/admin'
+import { seedSuperAdmin } from '@byline/admin/admin-users'
+import { getBylineCore } from '@byline/core'
+
+export async function seedAdmin() {
+  const email = process.env.BYLINE_SUPERADMIN_EMAIL
+  const password = process.env.BYLINE_SUPERADMIN_PASSWORD
+
+  if (!email || !password) {
+    console.warn(
+      'Skipping admin seed: BYLINE_SUPERADMIN_EMAIL and BYLINE_SUPERADMIN_PASSWORD ' +
+        'must both be set (see .env.example).'
+    )
+    return
+  }
+
+  const bylineCore = getBylineCore<AdminStore>()
+
+  if (!bylineCore.adminStore) {
+    throw new Error(
+      'seedAdmin: bylineCore.adminStore is not configured. ' +
+        'Pass adminStore to initBylineCore() in byline/server.config.ts.'
+    )
+  }
+
+  const result = await seedSuperAdmin(bylineCore.adminStore, { email, password })
+
+  const parts: string[] = []
+  if (result.created.role) parts.push('role')
+  if (result.created.user) parts.push('user')
+  if (result.created.assignment) parts.push('assignment')
+  if (parts.length === 0) {
+    console.log(`Super-admin already present (${email}) — no changes.`)
+  } else {
+    console.log(`Super-admin seed: created ${parts.join(', ')} for ${email}.`)
+  }
+}

package/dist/templates/byline/server.config.ts

@@ -0,0 +1,92 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+
+/**
+ * Server-side Byline bootstrap. Imported as a side-effect from
+ * `src/server.ts` (and from any seed / migration script that needs the
+ * configured runtime). Resolves the composed `BylineCore` and registers
+ * it on the process global via `initBylineCore()` — server-side callers
+ * read it back with `getBylineCore<AdminStore>()`.
+ *
+ * This is the minimal scaffold: no example collections registered. Add
+ * collection schemas to the `collections` array as you create them under
+ * `byline/collections/<name>/schema.ts`.
+ */
+
+import { type AdminStore, registerAdminAbilities } from '@byline/admin'
+import { JwtSessionProvider } from '@byline/admin/auth'
+import { type BylineCore, initBylineCore } from '@byline/core'
+import { pgAdapter } from '@byline/db-postgres'
+import { createAdminStore } from '@byline/db-postgres/admin'
+import { getAdminBylineClient } from '@byline/host-tanstack-start/integrations/byline-client'
+import { lexicalEditorServer } from '@byline/richtext-lexical/server'
+import { localStorageProvider } from '@byline/storage-local'
+
+import { i18n } from './i18n.js'
+import { DEFAULT_SERVER_URL, routes } from './routes.js'
+
+const serverURL = process.env.VITE_SERVER_URL || DEFAULT_SERVER_URL
+
+const collections: Parameters<typeof pgAdapter>[0]['collections'] = []
+
+// HMR-safe singleton. Vite's program reload re-evaluates this module
+// without disposing the previous module's resources — every reload
+// would otherwise allocate a fresh pg `Pool` (max: 20) inside
+// `pgAdapter`, the previous pool would orphan but stay alive, and
+// after a handful of HMR cycles Postgres' `max_connections` is
+// exhausted. Stashing the resolving `Promise` lets module reloads
+// reuse the same pool. Production has no HMR so this guard is a no-op.
+declare global {
+  // biome-ignore lint: globalThis augmentation requires `var` rather than `let`
+  var __bylineCoreSingleton__: Promise<BylineCore<AdminStore>> | undefined
+}
+
+async function buildBylineCore(): Promise<BylineCore<AdminStore>> {
+  const db = pgAdapter({
+    connectionString: process.env.DB_CONNECTION_STRING || '',
+    collections,
+  })
+
+  const adminStore = createAdminStore(db.drizzle)
+
+  const signingSecret = process.env.BYLINE_JWT_SECRET
+  if (!signingSecret || signingSecret.length < 32) {
+    throw new Error(
+      'BYLINE_JWT_SECRET must be set and carry at least 32 bytes of entropy. ' +
+        'Generate one with `openssl rand -base64 48` and add it to your .env.'
+    )
+  }
+
+  const sessionProvider = new JwtSessionProvider({
+    store: adminStore,
+    signingSecret,
+  })
+
+  const core = await initBylineCore<AdminStore>({
+    serverURL,
+    i18n,
+    routes,
+    collections,
+    db,
+    adminStore,
+    storage: localStorageProvider({
+      uploadDir: './public/uploads',
+      baseUrl: '/uploads',
+    }),
+    sessionProvider,
+    fields: {
+      richText: { populate: lexicalEditorServer({ getClient: getAdminBylineClient }) },
+    },
+  })
+
+  registerAdminAbilities(core.abilities)
+  return core
+}
+
+globalThis.__bylineCoreSingleton__ ??= buildBylineCore()
+await globalThis.__bylineCoreSingleton__

package/dist/templates/byline-examples/admin.config.ts

@@ -0,0 +1,74 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+
+/**
+ * Registers Byline's client-side config (collection admin UI configs,
+ * field editors, i18n, routes) in the current module graph. Imported as
+ * a side-effect from `src/routes/__root.tsx` — that module runs in both
+ * the SSR render and client module graphs, so a single import there
+ * covers both contexts.
+ *
+ * In TanStack Start with Vite 6 the server entry (`src/server.ts`) and
+ * the SSR rendering context run in separate Vite environments, so
+ * importing this file from `src/server.ts` would NOT propagate the
+ * registration into the SSR render module graph.
+ */
+
+import type { ClientConfig } from '@byline/core'
+import { defineClientConfig } from '@byline/core'
+import { RichTextField as LexicalRichTextField } from '@byline/richtext-lexical'
+
+// Import `lexicalEditor` instead of (or alongside) `RichTextField` if you
+// want to register the editor with site-wide custom settings. See the
+// commented `richText` block below for the exact shape.
+// import { lexicalEditor } from '@byline/richtext-lexical'
+
+import { Docs, DocsAdmin } from './collections/docs/index.js'
+import { DocsCategories, DocsCategoriesAdmin } from './collections/docs-categories/index.js'
+import { Media, MediaAdmin } from './collections/media/index.js'
+import { News, NewsAdmin } from './collections/news/index.js'
+import { NewsCategories, NewsCategoriesAdmin } from './collections/news-categories/index.js'
+import { Pages, PagesAdmin } from './collections/pages/index.js'
+import { i18n } from './i18n.js'
+import { DEFAULT_SERVER_URL, routes } from './routes.js'
+
+const serverURL = import.meta.env.VITE_SERVER_URL || DEFAULT_SERVER_URL
+
+export const config: ClientConfig = {
+  serverURL,
+  i18n,
+  routes,
+  collections: [Docs, News, Pages, Media, DocsCategories, NewsCategories],
+  admin: [DocsAdmin, NewsAdmin, PagesAdmin, MediaAdmin, DocsCategoriesAdmin, NewsCategoriesAdmin],
+  fields: {
+    // Default registration — every `type: 'richText'` field gets the full
+    // Lexical feature set unless overridden per-field via
+    // `RichTextField.editorConfig` (see `byline/fields/lexical-richtext-compact.ts`
+    // for the per-field pattern).
+    richText: { editor: LexicalRichTextField },
+
+    // ---------------------------------------------------------------------
+    // Alternatively — register the editor with site-wide custom settings.
+    // The `configure` callback receives a deep clone of `defaultEditorConfig`,
+    // so mutating it is safe. Per-field `editorConfig` continues to take
+    // precedence over whatever is baked in here.
+    //
+    // richText: {
+    //   editor: lexicalEditor((c) => {
+    //     c.settings.options.tablePlugin = false
+    //     c.settings.options.codeHighlightPlugin = false
+    //     c.settings.options.admonitionPlugin = false
+    //     c.settings.placeholderText = 'Start writing...'
+    //     return c
+    //   }),
+    // },
+    // ---------------------------------------------------------------------
+  },
+}
+
+defineClientConfig(config)

package/dist/templates/byline-examples/blocks/photo-block.ts

@@ -0,0 +1,59 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+
+import { type BlockData, type BlockFieldData, defineBlock } from '@byline/core'
+
+export const PhotoBlock = defineBlock({
+  blockType: 'photoBlock',
+  label: 'Photo Block',
+  helpText: 'A block for displaying a photo with optional caption and alt text.',
+  fields: [
+    {
+      name: 'display',
+      label: 'Display',
+      type: 'select',
+      optional: true,
+      defaultValue: 'default',
+      helpText: 'Select a display option for the photo.',
+      options: [
+        { label: 'Default', value: 'default' },
+        { label: 'Wide', value: 'wide' },
+        { label: 'Full Width', value: 'full_width' },
+      ],
+    },
+    {
+      name: 'photo',
+      label: 'Photo',
+      type: 'relation',
+      targetCollection: 'media',
+      displayField: 'title',
+      optional: true,
+    },
+    { name: 'alt', label: 'Alt', type: 'text', localized: false },
+    {
+      name: 'caption',
+      label: 'Caption',
+      type: 'richText',
+      optional: true,
+      localized: true,
+    },
+  ],
+})
+
+/**
+ * Field-only data shape for the photo block — useful for forms or
+ * block-internal helpers.
+ */
+export type PhotoBlockFields = BlockFieldData<typeof PhotoBlock>
+
+/**
+ * Full block instance shape (`_id`, `_type` + fields) as it appears
+ * inside a document tree. Use this as the prop type for the photo
+ * block renderer.
+ */
+export type PhotoBlockData = BlockData<typeof PhotoBlock>

package/dist/templates/byline-examples/blocks/richtext-block.ts

@@ -0,0 +1,35 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+
+import { type BlockData, type BlockFieldData, defineBlock } from '@byline/core'
+
+export const RichTextBlock = defineBlock({
+  blockType: 'richTextBlock',
+  label: 'Richtext Block',
+  helpText: 'A block for displaying a richtext editor.',
+  fields: [
+    {
+      name: 'richText',
+      label: 'Richtext',
+      type: 'richText',
+      localized: true,
+    },
+    {
+      name: 'constrainedWidth',
+      label: 'Constrained Width',
+      type: 'checkbox',
+      optional: true,
+      defaultValue: true,
+      helpText:
+        'If enabled, the richtext content will be constrained to a maximum width for better readability.',
+    },
+  ],
+})
+
+export type RichTextBlockFields = BlockFieldData<typeof RichTextBlock>
+export type RichTextBlockData = BlockData<typeof RichTextBlock>