@byline/cli 2.7.0 → 3.0.0

package/dist/templates/routes/_byline/route.lazy.tsx

@@ -9,9 +9,19 @@
 /**
  * Lazy companion to `_byline/route.tsx`. TanStack Router loads this on
  * demand when a `_byline/*` URL matches, so the Byline UI providers,
- * stylesheets, and the admin config side-effect import (which
- * transitively pulls in the Lexical editor module graph) only run when
- * an admin route is actually visited — public routes stay clean.
+ * stylesheets, and the admin config side-effect import (which transitively
+ * pulls in the Lexical editor module graph) only run when an admin route is
+ * actually visited — public routes stay clean.
+ *
+ * The `byline/admin.config` import below registers the client config in the
+ * *client component graph* — it runs whenever this lazy module loads (component
+ * render / initial hydration), where the sibling `route.tsx` `beforeLoad` does
+ * NOT help: on initial hydration TanStack Start reuses the dehydrated SSR result
+ * and does not re-run `beforeLoad`, yet the admin layout component still calls
+ * `getClientConfig()` at render. The two registration points are complementary —
+ * `beforeLoad` (a dynamic import) covers the *loader* phase before any
+ * `_byline/*` child loader; this import covers component render / hydration.
+ * Both call `defineClientConfig` idempotently.
  *
  * If you also want to use the Byline UI components on your public site,
  * import the same stylesheets from your front-end's pathless layout
@@ -26,9 +36,9 @@ import { ToastProvider, ToastViewport } from '@byline/ui/react'
 import '@byline/ui/reset.css'
 import '@byline/ui/styles.css'
 
-// Initialize Byline admin config — sits in the lazy companion so the
-// Lexical editor module graph only loads when a _byline/* URL matches.
-// See byline/admin.config.ts for the comment on why this is side-effecty.
+// Register the Byline client config (component-render / hydration entry point —
+// see the file header). The sibling `route.tsx` `beforeLoad` covers the loader
+// phase. Lexical's module graph only loads when a `_byline/*` URL matches.
 import '../../../byline/admin.config'
 
 export const Route = createLazyFileRoute('/_byline')({

package/dist/templates/routes/_byline/route.tsx

@@ -12,17 +12,42 @@
  * to URL paths — `/_byline/admin/...` resolves to `/admin/...` and
  * `/_byline/sign-in` resolves to `/sign-in`.
  *
- * This file is intentionally bare. The router needs the route definition
- * at startup to build the tree for URL matching, so anything declared
- * here ends up in the eager module graph (and Vite will modulepreload
- * its dependencies on every page).
+ * This file is intentionally light. The router needs the route definition
+ * at startup to build the tree for URL matching, so anything *statically*
+ * imported here ends up in the eager module graph (and Vite will
+ * modulepreload its dependencies on every page).
  *
- * The component, providers, Byline UI stylesheets, and the admin config
- * side-effect import live in the sibling `route.lazy.tsx` — TanStack
- * Router loads that file on demand when a `_byline/*` URL matches, so
- * the editor + admin shell deps stay out of public-route bundles.
+ * The component, providers, and Byline UI stylesheets live in the sibling
+ * `route.lazy.tsx` — TanStack Router loads that file on demand when a
+ * `_byline/*` URL matches, so the editor + admin shell deps stay out of
+ * public-route bundles.
+ *
+ * Registering the Byline client config has two complementary entry points
+ * (both call `defineClientConfig` idempotently):
+ *  - the `beforeLoad` below — covers the *loader* phase, resolving before any
+ *    `_byline/*` child loader reads the config (e.g. the admin dashboard
+ *    loader's `getClientConfig()`);
+ *  - the side-effect import in `route.lazy.tsx` — covers component render /
+ *    initial hydration, where `beforeLoad` is not re-run.
+ * Both use `byline/admin.config` (a dynamic import here), so its module graph
+ * (incl. the Lexical editor) stays code-split out of the eager/public bundle.
  */
 
 import { createFileRoute } from '@tanstack/react-router'
 
-export const Route = createFileRoute('/_byline')({})
+export const Route = createFileRoute('/_byline')({
+  beforeLoad: async () => {
+    // Register the Byline client config (`defineClientConfig` runs as a
+    // side-effect of importing `byline/admin.config`) before any `_byline/*`
+    // child loader reads it. A parent route's `beforeLoad` resolves before its
+    // children's loaders, closing the dev race where a loader outran the lazy
+    // component module's side-effect import (on the client there is no
+    // server-config fallback, so `getClientConfig()` threw "Byline has not been
+    // configured yet"). The dynamic import keeps `admin.config` out of the
+    // eager/public bundle and evaluates once (cached). NOTE: `beforeLoad` is
+    // not re-run on initial client hydration (the SSR result is dehydrated), so
+    // the `route.lazy.tsx` side-effect import registers the config for the
+    // hydrated component render.
+    await import('../../../byline/admin.config')
+  },
+})

package/package.json

@@ -2,7 +2,7 @@
   "name": "@byline/cli",
   "private": false,
   "license": "MPL-2.0",
-  "version": "2.7.0",
+  "version": "3.0.0",
   "engines": {
     "node": ">=20.9.0"
   },