@pramen/cms-editor 0.0.50 → 0.0.51

package/README.md

@@ -26,8 +26,8 @@ allow-lists, and the review/publish gates are all enforced server-side.
 ## Run it
 
 ```bash
-bun --cwd packages/cms-editor run build    # → dist/ (index.html + hashed JS)
-bun --cwd packages/cms-editor run dev      # watch + preview on http://localhost:5175
+bun run --cwd packages/cms-editor build    # → dist/ (index.html + hashed JS)
+bun run --cwd packages/cms-editor dev      # watch + preview on http://localhost:5175
 ```
 
 It's a **standalone static SPA** (no server-package dependency — local types + `fetch`).
@@ -43,6 +43,49 @@ rewrite to `/index.html` (Cloudflare Pages/`assets` handle this by default). The
 referenced by an **absolute** path (`/main.<hash>.js`), so it loads correctly from any route
 depth — don't rewrite it to a relative path.
 
+## Configure it (`/config.js`)
+
+`dist/config.js` is loaded before the app boots and sets `window.PRAMEN_CMS_EDITOR`. Override
+that one file on your host — no rebuild, no fork. Every field is optional, and the shipped
+file has them all commented out; **add them one at a time**:
+
+```js
+window.PRAMEN_CMS_EDITOR = {
+  brand: { name: "Acme", suffix: "cms" },            // the wordmark — see below
+  // signInUrl: "/signin/",                          // ONLY once that page exists — see the warning
+  // hidePages: true,                                // collections-only deployments
+  // extraNav: [{ label: "Curation", href: "/curate" }],
+};
+```
+
+> **`signInUrl` must be a page that exists, and same-origin needs care.** An unauthenticated
+> load calls it after clearing the stored session, so if the path 404s into this SPA's own
+> catch-all (which a same-origin extensionless path does — see the SPA-fallback note above),
+> the editor bounces between the redirect and itself with no session to recover from. Point
+> it at a page you have already deployed, and prefer a separate origin.
+
+**Set `brand` when you deploy this for a client.** The editor ships as a package an agency
+installs on someone else's behalf, so the default wordmark — `pramen · cms editor`, in the
+topbar, on the Setup screen and in the browser tab — puts the framework's name where the
+client's belongs. `name` replaces it; `suffix: null` drops the `· cms` half entirely. A
+configured brand replaces the whole string, including the word "editor", so nothing English
+is appended to a client's name. Configure nothing and every surface renders exactly as it
+did before this option existed.
+
+A malformed `brand` can never take the editor down: a non-string value is ignored rather
+than thrown on, and a `brand` that yields no usable name logs a console warning instead of
+silently shipping "pramen" to your client.
+
+The `<title>` in `index.html` is baked at build time, before any config exists, so the app
+re-applies the configured brand on boot; the static tag is the pre-hydration fallback, which
+means the default shows for the moment before the bundle runs.
+
+A clean build regenerates `config.js` when it is missing, but never overwrites one that is
+already there — including on every `dev` rebuild — so an edit you are previewing survives.
+
+Settings → About still reports `pramen · cms-editor`. That row names the *software* you are
+running, not the deployment, which is what an About panel is for.
+
 Routes are file-based: `src/routes/*` is scanned by the Bun plugin at build time, which
 (re)generates the checked-in `src/buzola.gen.ts`. After adding or renaming a route, run
 `bun run codegen` (the build does it automatically) so tsc sees the new route.

package/dist/config.js

@@ -1,5 +1,15 @@
-// Runtime configuration for the pramen CMS editor. Override this file in your host app to
-// point unauthenticated / expired sessions at an external sign-in page instead of the
-// built-in Setup screen:
-//   window.PRAMEN_CMS_EDITOR = { signInUrl: "/signin/" };
+// Runtime configuration for the pramen CMS editor. Override this file in your host app —
+// no rebuild needed. Every field is optional:
+//
+//   window.PRAMEN_CMS_EDITOR = {
+//     // Send unauthenticated / expired sessions to your own sign-in page instead of the
+//     // built-in Setup screen (?setup=1 still forces Setup, to paste a first-admin JWT):
+//     signInUrl: "/signin/",
+//     // The wordmark in the topbar, on the Setup screen and in the browser tab. Set this
+//     // when you deploy the editor for a client — the default says "pramen", which is the
+//     // framework's name, not theirs. `suffix: null` drops the "· cms" half.
+//     brand: { name: "Acme", suffix: "cms" },
+//     hidePages: true,                                  // collections-only deployments
+//     extraNav: [{ label: "Curation", href: "/curate" }],
+//   };
 window.PRAMEN_CMS_EDITOR = window.PRAMEN_CMS_EDITOR || {};

package/dist/index.html

@@ -7,11 +7,13 @@
     <link rel="stylesheet" href="/fonts.css" />
     <link rel="stylesheet" href="/app.css" />
     <!-- Runtime config, loaded before the app so window.PRAMEN_CMS_EDITOR is set at boot.
-         A default config.js ships in dist; a host overrides it to set e.g. signInUrl. -->
+         A default config.js ships in dist; a host overrides it to set e.g. signInUrl or
+         the wordmark. The <title> below is the pre-hydration fallback — the app re-applies
+         the configured brand on boot, since this file is baked before any config exists. -->
     <script src="/config.js"></script>
   </head>
   <body>
     <div id="app"></div>
-    <script type="module" src="/main.bx4zkbes.js"></script>
+    <script type="module" src="/main.a0tgw8hg.js"></script>
   </body>
 </html>