@byline/cli 4.8.0 → 4.10.0

package/dist/templates/byline-examples/collections/docs/admin.tsx

@@ -96,7 +96,7 @@ export const DocsAdmin: CollectionAdminConfig = defineAdmin(Docs, {
    * rebuilds this collection's search index; it self-gates on the
    * `collections.docs.reindex` ability, so it only appears for actors who
    * hold it. Drop this (and the `search` config in schema.ts) if you don't
-   * want search on this collection. See docs/05-reading-and-delivery/07-search.md.
+   * want search on this collection. See docs/06-search/index.md.
    */
   listActions: [ReindexButton],
 

package/dist/templates/byline-examples/collections/docs/hooks.ts

@@ -46,7 +46,7 @@
  * Indexing is background maintenance that runs from out-of-band write paths
  * too (the import-docs script, seeds, migrations), where there is no HTTP
  * request to read a session cookie from. See
- * docs/05-reading-and-delivery/07-search.md.
+ * docs/06-search/index.md.
  */
 
 import { defineHooks } from '@byline/core'

package/dist/templates/byline-examples/collections/docs/schema.ts

@@ -42,19 +42,19 @@ export const Docs = defineCollection({
   // byline/scripts/import-docs.ts --tree).
   tree: true,
   // Admin list-view quick-search. The collection list route's search box
-  // matches these top-level text-store fields with substring queries (ILIKE, in
-  // the Postgres adapter) against `store_text` — a lightweight "find the row I
-  // mean" affordance that needs no indexing and no lifecycle hooks. Falls back
-  // to `useAsTitle` when omitted; declared explicitly here for guidance.
+  // matches these top-level text-store fields with adapter-native substring
+  // queries against `store_text` — a lightweight "find the row I mean"
+  // affordance that needs no indexing and no lifecycle hooks. Falls back to
+  // `useAsTitle` when omitted; declared explicitly here for guidance.
   listSearch: ['title'],
-  // Search-*provider* config (docs/05-reading-and-delivery/07-search.md) —
+  // Search-*provider* config (docs/06-search/index.md) —
   // distinct from `listSearch` above. Each key names the part a field plays in
   // the index: `body` fields feed the full-text search vector (`title` is
   // display-only unless listed here, so we include it and boost it into the
   // heaviest weight class); `facets`, `filters`, and `zones` round out the
-  // surface. This drives the pluggable SearchProvider (full-text search in
-  // @byline/search-postgres) and requires a `search` provider registered in
-  // byline/server.config.ts. Unlike `listSearch`, `search` is inert on its own
+  // surface. This drives the configured full-text SearchProvider and requires
+  // a `search` provider registered in byline/server.config.ts. Unlike
+  // `listSearch`, `search` is inert on its own
   // — opting in here is what makes the index / reindex / deindex lifecycle
   // hooks in ./hooks.ts keep this collection's provider index in sync.
   // `content` is a container (blocks) field: naming it walks every text-bearing

package/dist/templates/byline-examples/collections/media/schema.ts

@@ -51,14 +51,14 @@ export const Media = defineCollection({
   }),
   showStats: true,
   // Admin list-view quick-search. The collection list route's search box
-  // matches these top-level text-store fields with substring queries (ILIKE, in
-  // the Postgres adapter) against `store_text` — a lightweight "find the row I
-  // mean" affordance that needs no indexing and no lifecycle hooks. Falls back
-  // to `useAsTitle` when omitted; declared explicitly here for guidance.
+  // matches these top-level text-store fields with adapter-native substring
+  // queries against `store_text` — a lightweight "find the row I mean"
+  // affordance that needs no indexing and no lifecycle hooks. Falls back to
+  // `useAsTitle` when omitted; declared explicitly here for guidance.
   listSearch: ['title'],
-  // Search-*provider* config (docs/05-reading-and-delivery/07-search.md) —
-  // distinct from `listSearch` above. This drives the pluggable SearchProvider
-  // (full-text search in @byline/search-postgres) and offers richer options:
+  // Search-*provider* config (docs/06-search/index.md) —
+  // distinct from `listSearch` above. This drives the configured full-text
+  // SearchProvider and offers richer options:
   // per-field weighting/`boost`, `facets`, `filters`, and `zones`. Unlike
   // `listSearch`, `search` is inert on its own — it MUST be paired with index /
   // reindex / deindex document-lifecycle hooks that keep the provider index in

package/dist/templates/byline-examples/collections/news/schema.ts

@@ -31,14 +31,14 @@ export const News = defineCollection({
   }),
   showStats: true,
   // Admin list-view quick-search. The collection list route's search box
-  // matches these top-level text-store fields with substring queries (ILIKE, in
-  // the Postgres adapter) against `store_text` — a lightweight "find the row I
-  // mean" affordance that needs no indexing and no lifecycle hooks. Falls back
-  // to `useAsTitle` when omitted; declared explicitly here for guidance.
+  // matches these top-level text-store fields with adapter-native substring
+  // queries against `store_text` — a lightweight "find the row I mean"
+  // affordance that needs no indexing and no lifecycle hooks. Falls back to
+  // `useAsTitle` when omitted; declared explicitly here for guidance.
   listSearch: ['title'],
-  // Search-*provider* config (docs/05-reading-and-delivery/07-search.md) —
-  // distinct from `listSearch` above. This drives the pluggable SearchProvider
-  // (full-text search in @byline/search-postgres) and offers richer options:
+  // Search-*provider* config (docs/06-search/index.md) —
+  // distinct from `listSearch` above. This drives the configured full-text
+  // SearchProvider and offers richer options:
   // per-field weighting/`boost`, `facets`, `filters`, and `zones`. Unlike
   // `listSearch`, `search` is inert on its own — it MUST be paired with index /
   // reindex / deindex document-lifecycle hooks that keep the provider index in

package/dist/templates/byline-examples/collections/news-categories/schema.ts

@@ -22,14 +22,14 @@ export const NewsCategories = defineCollection({
   workflow: SINGLE_STATUS_WORKFLOW,
   showStats: true,
   // Admin list-view quick-search. The collection list route's search box
-  // matches these top-level text-store fields with substring queries (ILIKE, in
-  // the Postgres adapter) against `store_text` — a lightweight "find the row I
-  // mean" affordance that needs no indexing and no lifecycle hooks. Falls back
-  // to `useAsTitle` when omitted; declared explicitly here for guidance.
+  // matches these top-level text-store fields with adapter-native substring
+  // queries against `store_text` — a lightweight "find the row I mean"
+  // affordance that needs no indexing and no lifecycle hooks. Falls back to
+  // `useAsTitle` when omitted; declared explicitly here for guidance.
   listSearch: ['name'],
-  // Search-*provider* config (docs/05-reading-and-delivery/07-search.md) —
-  // distinct from `listSearch` above. This drives the pluggable SearchProvider
-  // (full-text search in @byline/search-postgres) and offers richer options:
+  // Search-*provider* config (docs/06-search/index.md) —
+  // distinct from `listSearch` above. This drives the configured full-text
+  // SearchProvider and offers richer options:
   // per-field weighting/`boost`, `facets`, `filters`, and `zones`. Unlike
   // `listSearch`, `search` is inert on its own — it MUST be paired with index /
   // reindex / deindex document-lifecycle hooks that keep the provider index in

package/dist/templates/byline-examples/collections/pages/schema.ts

@@ -33,14 +33,14 @@ export const Pages = defineCollection({
   }),
   showStats: true,
   // Admin list-view quick-search. The collection list route's search box
-  // matches these top-level text-store fields with substring queries (ILIKE, in
-  // the Postgres adapter) against `store_text` — a lightweight "find the row I
-  // mean" affordance that needs no indexing and no lifecycle hooks. Falls back
-  // to `useAsTitle` when omitted; declared explicitly here for guidance.
+  // matches these top-level text-store fields with adapter-native substring
+  // queries against `store_text` — a lightweight "find the row I mean"
+  // affordance that needs no indexing and no lifecycle hooks. Falls back to
+  // `useAsTitle` when omitted; declared explicitly here for guidance.
   listSearch: ['title'],
-  // Search-*provider* config (docs/05-reading-and-delivery/07-search.md) —
-  // distinct from `listSearch` above. This drives the pluggable SearchProvider
-  // (full-text search in @byline/search-postgres) and offers richer options:
+  // Search-*provider* config (docs/06-search/index.md) —
+  // distinct from `listSearch` above. This drives the configured full-text
+  // SearchProvider and offers richer options:
   // per-field weighting/`boost`, `facets`, `filters`, and `zones`. Unlike
   // `listSearch`, `search` is inert on its own — it MUST be paired with index /
   // reindex / deindex document-lifecycle hooks that keep the provider index in

package/dist/templates/byline-examples/scripts/import-docs.ts

@@ -317,7 +317,7 @@ async function processFile(
       // Advertise the imported locale (editorial available-locales set), merged
       // with whatever is already advertised so a later-locale re-import doesn't
       // clobber an earlier one. The public set is still gated by the version
-      // completeness ledger (intersection). See docs/07-internationalization/index.md.
+      // completeness ledger (intersection). See docs/08-internationalization/index.md.
       availableLocales: [...new Set([...(existing.availableLocales ?? []), locale])],
     })
     await walkToStatus(handle, result.documentId, workflowStatuses, defaultStatus, desiredStatus)

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

@@ -0,0 +1,105 @@
+/**
+ * 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 scripts that need the configured runtime.
+ *
+ * This is the minimal scaffold: no example collections or search provider.
+ */
+
+import { type AdminStore, registerAdminAbilities } from '@byline/admin'
+import { JwtSessionProvider } from '@byline/admin/auth'
+import { getAdminBylineClient } from '@byline/client/server'
+import { type BylineCore, initBylineCore } from '@byline/core'
+import { mysqlAdapter } from '@byline/db-mysql'
+import { createAdminStore } from '@byline/db-mysql/admin'
+import { registerTanstackStartHostBridge } from '@byline/host-tanstack-start/integrations/host-bridge'
+import {
+  lexicalEditorEmbedServer,
+  lexicalEditorPopulateServer,
+  lexicalEditorToMarkdownServer,
+} from '@byline/richtext-lexical/server'
+import { localStorageProvider } from '@byline/storage-local'
+
+import { collections } from './collections/index.js'
+import { serverHooks } from './collections/server-hooks.js'
+import { i18n } from './i18n.js'
+import { DEFAULT_SERVER_URL, routes } from './routes.js'
+
+const serverURL = process.env.VITE_SERVER_URL || DEFAULT_SERVER_URL
+
+// HMR-safe singleton. Reusing the resolving Promise prevents development
+// reloads from orphaning MySQL pools and exhausting server connections.
+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 = mysqlAdapter({
+    connectionString: process.env.BYLINE_DB_MYSQL_CONNECTION_STRING || '',
+    collections,
+    defaultContentLocale: i18n.content.defaultLocale,
+    // Optional pool tuning. Omit these values to use the adapter defaults:
+    // 20 connections, 2s idle timeout, and 30s connection timeout.
+    connectionLimit: process.env.BYLINE_DB_MYSQL_CONNECTION_LIMIT
+      ? Number(process.env.BYLINE_DB_MYSQL_CONNECTION_LIMIT)
+      : undefined,
+    idleTimeout: process.env.BYLINE_DB_MYSQL_IDLE_TIMEOUT_MILLIS
+      ? Number(process.env.BYLINE_DB_MYSQL_IDLE_TIMEOUT_MILLIS)
+      : undefined,
+    connectTimeout: process.env.BYLINE_DB_MYSQL_CONNECTION_TIMEOUT_MILLIS
+      ? Number(process.env.BYLINE_DB_MYSQL_CONNECTION_TIMEOUT_MILLIS)
+      : undefined,
+  })
+
+  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.local.'
+    )
+  }
+
+  const sessionProvider = new JwtSessionProvider({
+    store: adminStore,
+    signingSecret,
+  })
+
+  registerTanstackStartHostBridge()
+
+  const core = await initBylineCore<AdminStore>({
+    serverURL,
+    i18n,
+    routes,
+    collections,
+    hooks: serverHooks,
+    db,
+    adminStore,
+    storage: localStorageProvider({
+      uploadDir: './uploads',
+      baseUrl: '/uploads',
+    }),
+    sessionProvider,
+    fields: {
+      richText: {
+        embed: lexicalEditorEmbedServer({ getClient: getAdminBylineClient }),
+        populate: lexicalEditorPopulateServer({ getClient: getAdminBylineClient }),
+        toMarkdown: lexicalEditorToMarkdownServer(),
+      },
+    },
+  })
+
+  registerAdminAbilities(core.abilities)
+  return core
+}
+
+globalThis.__bylineCoreSingleton__ ??= buildBylineCore()
+await globalThis.__bylineCoreSingleton__

package/dist/templates/dialects/mysql/byline-examples/server.config.ts

@@ -0,0 +1,115 @@
+/**
+ * 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 for the MySQL example scaffold.
+ */
+
+import { type AdminStore, registerAdminAbilities } from '@byline/admin'
+import { JwtSessionProvider } from '@byline/admin/auth'
+import { getAdminBylineClient } from '@byline/client/server'
+import { type BylineCore, initBylineCore } from '@byline/core'
+import { mysqlAdapter } from '@byline/db-mysql'
+import { createAdminStore } from '@byline/db-mysql/admin'
+import { registerTanstackStartHostBridge } from '@byline/host-tanstack-start/integrations/host-bridge'
+import {
+  lexicalEditorEmbedServer,
+  lexicalEditorPopulateServer,
+  lexicalEditorToMarkdownServer,
+  lexicalEditorToTextServer,
+} from '@byline/richtext-lexical/server'
+import { migrate, mysqlSearch } from '@byline/search-mysql'
+import { localStorageProvider } from '@byline/storage-local'
+
+import { collections } from './collections/index.js'
+import { serverHooks } from './collections/server-hooks.js'
+import { i18n } from './i18n.js'
+import { DEFAULT_SERVER_URL, routes } from './routes.js'
+
+const serverURL = process.env.VITE_SERVER_URL || DEFAULT_SERVER_URL
+
+// HMR-safe singleton. Reusing the resolving Promise prevents development
+// reloads from orphaning MySQL pools and exhausting server connections.
+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 = mysqlAdapter({
+    connectionString: process.env.BYLINE_DB_MYSQL_CONNECTION_STRING || '',
+    collections,
+    defaultContentLocale: i18n.content.defaultLocale,
+    // Optional pool tuning. Omit these values to use the adapter defaults:
+    // 20 connections, 2s idle timeout, and 30s connection timeout.
+    connectionLimit: process.env.BYLINE_DB_MYSQL_CONNECTION_LIMIT
+      ? Number(process.env.BYLINE_DB_MYSQL_CONNECTION_LIMIT)
+      : undefined,
+    idleTimeout: process.env.BYLINE_DB_MYSQL_IDLE_TIMEOUT_MILLIS
+      ? Number(process.env.BYLINE_DB_MYSQL_IDLE_TIMEOUT_MILLIS)
+      : undefined,
+    connectTimeout: process.env.BYLINE_DB_MYSQL_CONNECTION_TIMEOUT_MILLIS
+      ? Number(process.env.BYLINE_DB_MYSQL_CONNECTION_TIMEOUT_MILLIS)
+      : undefined,
+  })
+
+  // Search owns its disposable projection and numbered migration stream.
+  // Apply it explicitly at startup with the adapter's existing pool. A
+  // migration failure degrades search without taking down the application.
+  try {
+    await migrate(db.pool, { log: (message) => console.log(message) })
+  } catch (error) {
+    console.error('[search-mysql] migrate failed — search may be unavailable:', error)
+  }
+
+  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.local.'
+    )
+  }
+
+  const sessionProvider = new JwtSessionProvider({
+    store: adminStore,
+    signingSecret,
+  })
+
+  registerTanstackStartHostBridge()
+
+  const core = await initBylineCore<AdminStore>({
+    serverURL,
+    i18n,
+    routes,
+    collections,
+    hooks: serverHooks,
+    db,
+    adminStore,
+    storage: localStorageProvider({
+      uploadDir: './uploads',
+      baseUrl: '/uploads',
+    }),
+    sessionProvider,
+    fields: {
+      richText: {
+        embed: lexicalEditorEmbedServer({ getClient: getAdminBylineClient }),
+        populate: lexicalEditorPopulateServer({ getClient: getAdminBylineClient }),
+        toMarkdown: lexicalEditorToMarkdownServer(),
+        toText: lexicalEditorToTextServer(),
+      },
+    },
+    search: mysqlSearch({ pool: db.pool, defaultLocale: i18n.content.defaultLocale }),
+  })
+
+  registerAdminAbilities(core.abilities)
+  return core
+}
+
+globalThis.__bylineCoreSingleton__ ??= buildBylineCore()
+await globalThis.__bylineCoreSingleton__

package/dist/templates/{byline-examples → dialects/postgres/byline-examples}/scripts/backfill-version-locales.ts

@@ -18,7 +18,7 @@
  *
  *   pnpm tsx byline/scripts/backfill-version-locales.ts
  *
- * See docs/07-internationalization/index.md.
+ * See docs/08-internationalization/index.md.
  */
 
 import '../load-env.js'

package/dist/templates/{byline-examples → dialects/postgres/byline-examples}/scripts/re-anchor.ts

@@ -20,7 +20,7 @@
  *   pnpm tsx byline/scripts/re-anchor.ts --to fr --collection pages
  *   pnpm tsx byline/scripts/re-anchor.ts --to fr --dry-run
  *
- * See docs/07-internationalization/index.md.
+ * See docs/08-internationalization/index.md.
  */
 
 import '../load-env.js'

package/dist/templates/{byline-examples → dialects/postgres/byline-examples}/server.config.ts

@@ -103,7 +103,7 @@ async function buildBylineCore(): Promise<BylineCore<AdminStore>> {
   // host's Drizzle migration stream. We run it deliberately here, rather
   // than relying on the driver's `autoMigrate` option, so startup DDL is an
   // explicit, awaited step. Reuses the adapter's pool — no second
-  // connection. See docs/05-reading-and-delivery/07-search.md.
+  // connection. See docs/06-search/index.md.
   //
   // Wrapped defensively: a migration failure degrades search but must not
   // take down the whole app at boot. We log loudly and continue. (For
@@ -233,7 +233,7 @@ async function buildBylineCore(): Promise<BylineCore<AdminStore>> {
         // `body` fields to indexable text for `buildSearchDocument`. Pure
         // JSON walk, no client. Required by any collection that lists a
         // richText field in its `search.body`. See
-        // docs/05-reading-and-delivery/07-search.md.
+        // docs/06-search/index.md.
         toText: lexicalEditorToTextServer(),
       },
     },

package/dist/templates/host/vite.config.ts

@@ -44,7 +44,7 @@ const bylineSsrNoExternal = [/^@byline\//]
 // kept external so Node resolves them at runtime instead.
 //   - sharp + @byline/storage-local — image processing (libvips)
 //   - @byline/storage-s3 — bundles the AWS SDK; keep external for Node resolution
-//   - @byline/db-postgres — depends on `pg` native bindings
+//   - @byline/db-postgres + @byline/db-mysql — database drivers
 //   - pino — CJS entrypoints don't execute under Vite's module runner
 //
 // `@byline/admin` is intentionally NOT externalised: it now hosts
@@ -53,7 +53,7 @@ const bylineSsrNoExternal = [/^@byline\//]
 // `import './foo_module.css'`. Node's ESM loader can't handle `.css`,
 // so admin must flow through Vite's SSR pipeline where the CSS plugin
 // resolves the side-effect imports. Server-only admin subpaths reach
-// db-postgres / storage adapters through composition at runtime, not
+// database / storage adapters through composition at runtime, not
 // through `@byline/admin`'s own import graph, so this is safe.
 const ssrExternal = [
   'sharp',
@@ -61,6 +61,7 @@ const ssrExternal = [
   '@byline/storage-local',
   '@byline/storage-s3',
   '@byline/db-postgres',
+  '@byline/db-mysql',
 ]
 
 const config = defineConfig({
@@ -198,7 +199,7 @@ const config = defineConfig({
           'react-dom',
           'pino',
           'sharp',
-          /^@byline\/(db-postgres|storage-local|storage-s3)/,
+          /^@byline\/(db-postgres|db-mysql|storage-local|storage-s3)/,
         ],
       },
     }),