@byline/cli 3.20.4 → 4.0.0

package/dist/templates/byline-examples/collection-types.contract.ts

@@ -0,0 +1,67 @@
+/**
+ * Compile-time contract between this application's collection schemas and its
+ * generated collection-type projection.
+ *
+ * ```text
+ * collections/index.ts                  generated/collection-types.ts
+ *   `typeof collections`                 `CollectionFields*ByPath`
+ *            |                                      |
+ *            v                                      v
+ *    inferred registry ----------- Exact -------- generated registry
+ *                                    |
+ *                                    v
+ *                         TypeScript error on drift
+ * ```
+ *
+ * The generated file is deliberately a standalone projection for typed clients
+ * and frontend code; it does not import the runtime schemas. This module joins
+ * those two app-owned sources at compile time and requires their collection
+ * keys, ordinary field shapes, and all-locale field shapes to match exactly.
+ *
+ * This file has no runtime behavior. Keep it application-owned: `@byline/core`
+ * provides the inference and code-generation machinery, but only this
+ * application knows its concrete collection tuple and generated output.
+ */
+
+import type { CollectionFieldData, CollectionFieldDataAllLocales } from '@byline/core'
+
+import type { collections } from './collections/index.js'
+import type {
+  CollectionFieldsAllLocalesByPath,
+  CollectionFieldsByPath,
+} from './generated/collection-types.js'
+
+type InferredFieldsByPath = {
+  [Definition in (typeof collections)[number] as Definition['path']]: CollectionFieldData<Definition>
+}
+
+type InferredFieldsAllLocalesByPath = {
+  [Definition in (typeof collections)[number] as Definition['path']]: CollectionFieldDataAllLocales<Definition>
+}
+
+type IsAny<Value> = 0 extends 1 & Value ? true : false
+type Exact<Left, Right> = IsAny<Left> extends true
+  ? IsAny<Right>
+  : IsAny<Right> extends true
+    ? false
+    : (<Value>() => Value extends Left ? 1 : 2) extends <Value>() =>
+          Value extends Right ? 1 : 2
+      ? (<Value>() => Value extends Right ? 1 : 2) extends <Value>() =>
+          Value extends Left ? 1 : 2
+        ? true
+        : false
+      : false
+type Assert<Value extends true> = Value
+
+type GeneratedKeysMatchRuntimeRegistry = Assert<
+  Exact<keyof CollectionFieldsByPath, keyof InferredFieldsByPath>
+>
+type GeneratedFieldsMatchRuntimeRegistry = Assert<
+  Exact<CollectionFieldsByPath, InferredFieldsByPath>
+>
+type GeneratedAllLocalesKeysMatchRuntimeRegistry = Assert<
+  Exact<keyof CollectionFieldsAllLocalesByPath, keyof InferredFieldsAllLocalesByPath>
+>
+type GeneratedAllLocalesFieldsMatchRuntimeRegistry = Assert<
+  Exact<CollectionFieldsAllLocalesByPath, InferredFieldsAllLocalesByPath>
+>

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

@@ -17,22 +17,20 @@
  * config from it. Anything the schema *statically imports* therefore ships to
  * the client. Hook *bodies*, however, only ever run server-side.
  *
- * Search indexing is the canonical reason this matters: it imports
- * `getSystemBylineClient` from `@byline/host-tanstack-start`, a server-only
- * module. Importing that from the schema would drag server code into the
- * browser bundle (fatal in dev). The schema avoids it by referencing these
- * hooks through a **dynamic import** instead of an inline object:
+ * Search indexing is the canonical reason this matters: it imports the
+ * server-only app client boundary from `byline/clients.server.ts`. Importing
+ * that from the schema would drag server code into the browser bundle (fatal
+ * in dev). The server bootstrap avoids it by registering these hooks from a
+ * server-only module:
  *
- *     // schema.ts
- *     hooks: () => import('./hooks.js')
+ *     // collections/server-hooks.ts
+ *     collections: { docs: () => import('./docs/hooks.js') }
  *
- * Because the schema reaches this module only through `import()`, this file —
- * and its entire transitive import graph — is **structurally absent** from
- * the client bundle. `@byline/core` resolves the loader once on the server
- * (memoized) and calls these hooks exactly as it would inline ones. The
- * upshot: **inside this file we may statically import server-only modules
- * directly.** See docs/04-collections → "Hooks must not statically import
- * server-only code".
+ * No client entry reaches that registry, so this file and its transitive graph
+ * are structurally absent from the client bundle without a host-framework
+ * transform. `@byline/core` attaches and resolves the loader on the server.
+ * The upshot: **inside this file we may statically import server-only modules
+ * directly.** See docs/04-collections → "Server-only hook registry".
  *
  * ──────────────────────────────────────────────────────────────────────────
  *  Search indexing
@@ -52,7 +50,7 @@
  */
 
 import { defineHooks } from '@byline/core'
-import { getSystemBylineClient } from '@byline/host-tanstack-start/integrations/byline-client'
+import { getSystemBylineClient } from '../../clients.server.js'
 
 export default defineHooks({
   beforeCreate: async ({ data, collectionPath }) => {
@@ -62,7 +60,7 @@ export default defineHooks({
     console.log(
       `afterCreate: document ${documentId} (version ${documentVersionId}) created in '${collectionPath}'`
     )
-    await getSystemBylineClient().collection(collectionPath).indexDocument(documentId)
+    await getSystemBylineClient().collection('docs').indexDocument(documentId)
   },
   beforeUpdate: async ({ data, collectionPath }) => {
     console.log(`beforeUpdate: updating a document in '${collectionPath}'`, data)
@@ -71,7 +69,19 @@ export default defineHooks({
     console.log(
       `afterUpdate: document ${documentId} (version ${documentVersionId}) in '${collectionPath}' updated`
     )
-    await getSystemBylineClient().collection(collectionPath).indexDocument(documentId)
+    await getSystemBylineClient().collection('docs').indexDocument(documentId)
+  },
+  // Path and advertised-locale edits are immediate document-grain writes, not
+  // content updates. Re-index their published view through this dedicated event.
+  afterSystemFieldsChange: async ({ documentId, collectionPath, requested, changed }) => {
+    console.log(
+      `afterSystemFieldsChange: ${documentId} in '${collectionPath}' changed`,
+      changed
+    )
+    // Advertised locales affect alternates/sitemaps, not indexed content.
+    if (requested.path) {
+      await getSystemBylineClient().collection('docs').indexDocument(documentId)
+    }
   },
   beforeStatusChange: async ({ documentId, collectionPath, previousStatus, nextStatus }) => {
     console.log(
@@ -85,21 +95,21 @@ export default defineHooks({
     console.log(
       `afterStatusChange: ${documentId} in '${collectionPath}' ${previousStatus} → ${nextStatus}`
     )
-    await getSystemBylineClient().collection(collectionPath).indexDocument(documentId)
+    await getSystemBylineClient().collection('docs').indexDocument(documentId)
   },
   beforeUnpublish: async ({ documentId, collectionPath }) => {
     console.log(`beforeUnpublish: unpublishing ${documentId} in '${collectionPath}'`)
   },
   afterUnpublish: async ({ documentId, collectionPath }) => {
     console.log(`afterUnpublish: ${documentId} in '${collectionPath}' unpublished`)
-    await getSystemBylineClient().collection(collectionPath).indexDocument(documentId)
+    await getSystemBylineClient().collection('docs').indexDocument(documentId)
   },
   beforeDelete: async ({ documentId, collectionPath }) => {
     console.log(`beforeDelete: deleting ${documentId} in '${collectionPath}'`)
   },
   afterDelete: async ({ documentId, collectionPath }) => {
     console.log(`afterDelete: ${documentId} in '${collectionPath}' deleted`)
-    await getSystemBylineClient().collection(collectionPath).removeFromIndex(documentId)
+    await getSystemBylineClient().collection('docs').removeFromIndex(documentId)
   },
   // Fires on any structural tree change (place / reorder / re-parent /
   // promote-on-delete) for a `tree: true` collection. The payload carries the

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

@@ -41,13 +41,22 @@ export const Docs = defineCollection({
   // placement from the source directory layout (see
   // byline/scripts/import-docs.ts --tree).
   tree: true,
-  // Collection search config (docs/05-reading-and-delivery/07-search.md).
-  // 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. Opting in here is what
-  // makes the lifecycle hooks in ./hooks.ts index this collection — and it
-  // requires a `search` provider registered in byline/server.config.ts.
+  // 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.
+  listSearch: ['title'],
+  // Search-*provider* config (docs/05-reading-and-delivery/07-search.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
+  // — 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
   // child (richtext body, image alt + caption) into the searchable body —
   // omit it and document bodies are silently absent from the index.
@@ -56,17 +65,8 @@ export const Docs = defineCollection({
   useAsPath: 'title',
   advertiseLocales: true, // Renders the available-locales sidebar widget.
   linksInEditor: true, // See type definition for details.
-  // Collection lifecycle hooks. Hook *bodies* only ever run server-side, but
-  // a collection *schema* is isomorphic — Byline bundles it into the browser
-  // admin too (the admin reads field config from it), so anything the schema
-  // *statically imports* ships to the client. Search indexing needs a
-  // server-only import (`getSystemBylineClient` from
-  // `@byline/host-tanstack-start`), which would crash the browser bundle if
-  // imported here. The **loader form** — a thunk that dynamically imports a
-  // sibling module — keeps `./hooks.ts` and its entire import graph out of
-  // the client bundle while running exactly like inline hooks on the server.
-  // See ./hooks.ts for the worked example and the full explanation.
-  hooks: () => import('./hooks.js'),
+  // Server-only lifecycle hooks are registered in ../server-hooks.ts so this
+  // schema remains portable across host frameworks and safe in client graphs.
   fields: [
     {
       name: 'title',

package/dist/templates/byline-examples/collections/index.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 { InferCollectionRegistry } from '@byline/core'
+
+import type { CollectionFieldsByPath } from '../generated/collection-types.js'
+
+import { Docs } from './docs/schema.js'
+import { Media } from './media/schema.js'
+import { News } from './news/schema.js'
+import { NewsCategories } from './news-categories/schema.js'
+import { Pages } from './pages/schema.js'
+
+export const collections = [Docs, News, Pages, Media, NewsCategories] as const
+
+export type InferredBylineCollections = InferCollectionRegistry<typeof collections>
+export type BylineCollections = CollectionFieldsByPath

package/dist/templates/byline-examples/collections/media/components/media-list-view.tsx

@@ -19,11 +19,16 @@
  *  - Top + bottom pagination (RouterPager)
  */
 
-import { Link, useNavigate, useRouterState } from '@tanstack/react-router'
+import { useRouterState } from '@tanstack/react-router'
 
 import type { ListViewComponentProps, StoredFileValue, WorkflowStatus } from '@byline/core'
 import type { AnyCollectionSchemaTypes } from '@byline/core/zod-schemas'
 import { RouterPager } from '@byline/host-tanstack-start/admin-shell/chrome/router-pager'
+import {
+  Link,
+  useNavigate,
+} from '@byline/host-tanstack-start/admin-shell/chrome/loose-router'
+import { getAdminRoutePath } from '@byline/host-tanstack-start/routes/admin-path'
 import { Container, IconButton, LoaderRing, PlusIcon, Search, Section, Select } from '@byline/ui/react'
 import { LocalDateTime } from '@byline/admin/react'
 
@@ -128,7 +133,7 @@ export function MediaListView({
       delete params.page
       params.query = query
       navigate({
-        to: '/admin/collections/$collection',
+        to: getAdminRoutePath('collections', '$collection'),
         params: { collection: collectionPath },
         search: params,
       })
@@ -140,7 +145,7 @@ export function MediaListView({
     delete params.page
     delete params.query
     navigate({
-      to: '/admin/collections/$collection',
+      to: getAdminRoutePath('collections', '$collection'),
       params: { collection: collectionPath },
       search: params,
     })
@@ -158,7 +163,7 @@ export function MediaListView({
     params.order = order
     params.desc = desc
     navigate({
-      to: '/admin/collections/$collection',
+      to: getAdminRoutePath('collections', '$collection'),
       params: { collection: collectionPath },
       search: params,
     })
@@ -178,7 +183,7 @@ export function MediaListView({
             render={
               <Link
                 className={styles['create-link']}
-                to="/admin/collections/$collection/create"
+                to={getAdminRoutePath('collections', '$collection', 'create')}
                 params={{ collection: collectionPath }}
               />
             }
@@ -239,7 +244,7 @@ export function MediaListView({
               return (
                 <Link
                   key={doc.id}
-                  to="/admin/collections/$collection/$id"
+                  to={getAdminRoutePath('collections', '$collection', '$id')}
                   params={{ collection: collectionPath, id: doc.id }}
                   className={styles.card}
                 >

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

@@ -50,6 +50,19 @@ export const Media = defineCollection({
     archived: { label: 'Archived', verb: 'Archive' },
   }),
   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.
+  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:
+  // 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
+  // sync on create / update / publish / delete (see this collection's hooks).
   search: { body: ['title', 'caption'] },
   fields: [
     {
@@ -115,6 +128,9 @@ export const Media = defineCollection({
             quality: 55,
           },
         ],
+        // Worked example: definition-attached inline hooks are appropriate
+        // when their entire implementation is isomorphic-safe. Hooks that
+        // import server-only code belong in collections/server-hooks.ts.
         hooks: {
           beforeStore: (ctx: BeforeStoreContext) => {
             console.log('beforeStore hook called', ctx)

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

@@ -30,6 +30,19 @@ export const News = defineCollection({
     archived: { label: 'Archived', verb: 'Archive' },
   }),
   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.
+  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:
+  // 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
+  // sync on create / update / publish / delete (see this collection's hooks).
   search: { body: ['title'] },
   useAsTitle: 'title',
   useAsPath: 'title',
@@ -86,8 +99,9 @@ export const News = defineCollection({
 })
 
 /**
- * Field data shape inferred directly from the schema. Use this as the
- * generic to typed read calls — `client.collection('news').find<NewsFields>()`
- * — so dot-notation on `doc.fields` is fully checked.
+ * Schema-local field shape for hooks and other collection implementation details.
+ * Frontend/client code should import `NewsFields` from
+ * `byline/generated/collection-types.ts`; ordinary reads infer it from the
+ * client registry, while populate/select projections may supply an overlay.
  */
 export type NewsFields = CollectionFieldData<typeof News>

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

@@ -21,6 +21,19 @@ export const NewsCategories = defineCollection({
   // `published` and the form shows only Save / Close.
   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.
+  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:
+  // 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
+  // sync on create / update / publish / delete (see this collection's hooks).
   search: { body: ['name'] },
   useAsTitle: 'name',
   useAsPath: 'name',

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

@@ -32,6 +32,19 @@ export const Pages = defineCollection({
     archived: { label: 'Archived', verb: 'Archive' },
   }),
   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.
+  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:
+  // 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
+  // sync on create / update / publish / delete (see this collection's hooks).
   search: { body: ['title'] },
   useAsTitle: 'title',
   useAsPath: 'title',

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

@@ -0,0 +1,8 @@
+/** Server-only lifecycle hook registry. Imported only by server.config.ts. */
+import type { ServerHooksConfig } from '@byline/core'
+
+export const serverHooks = {
+  collections: {
+    docs: () => import('./docs/hooks.js'),
+  },
+} satisfies ServerHooksConfig

package/dist/templates/byline-examples/fields/ai-text.ts

@@ -27,7 +27,7 @@ import { AiFieldPanel } from './ai-widgets/ai-field-panel.js'
  *
  * @example
  * ```ts
- * // apps/webapp/byline/collections/news/admin.tsx
+ * // byline/collections/news/admin.tsx
  * fields: {
  *   title: aiTextFieldAdmin(),
  * }

package/dist/templates/byline-examples/fields/ai-textarea.ts

@@ -28,7 +28,7 @@ import { AiFieldPanel } from './ai-widgets/ai-field-panel.js'
  *
  * @example
  * ```ts
- * // apps/webapp/byline/collections/news/admin.tsx
+ * // byline/collections/news/admin.tsx
  * fields: {
  *   summary: aiTextAreaFieldAdmin({
  *     components: { HelpText: SummaryLength },

package/dist/templates/byline-examples/fields/lexical-richtext-ai.tsx

@@ -13,7 +13,7 @@
  *   - `LexicalRichTextAi` — a `RichTextEditorComponent` that registers
  *     the AI assistant by adding `AiLexicalExtension` to the editor's
  *     extension graph. Register globally in
- *     `apps/webapp/byline/admin.config.ts` under
+ *     `byline/admin.config.ts` under
  *     `fields.richText.editor` to AI-enable every richtext field.
  *   - `aiRichTextAdmin()` — a `FieldAdminConfig` factory. Drop into a
  *     collection's `fields` map in `<collection>/admin.tsx` to opt one
@@ -38,7 +38,7 @@ import { builtInExtensions, lexicalEditor } from '@byline/richtext-lexical/confi
  * drawer via `ReactExtension.decorators` — no `featureAfterEditor`, no
  * React-context registry hop.
  *
- * **Global** opt-in — register in `apps/webapp/byline/admin.config.ts`:
+ * **Global** opt-in — register in `byline/admin.config.ts`:
  *
  * ```ts
  * fields: {
@@ -77,7 +77,7 @@ export const LexicalRichTextAi = lexicalEditor((c) => {
  *
  * @example
  * ```ts
- * // apps/webapp/byline/collections/news/admin.tsx
+ * // byline/collections/news/admin.tsx
  * import { aiRichTextAdmin } from '../../fields/lexical-richtext-ai.js'
  *
  * fields: {

package/dist/templates/byline-examples/generated/collection-types.ts

@@ -0,0 +1,139 @@
+// Generated by @byline/core/codegen
+// Format version: 1
+// Hash: a32bba417302b4e2c90703e47a1f326d4db64cabd11194f8eed816e78442178e
+
+import type {
+  JsonValue,
+  RelatedDocumentValue,
+  StoredFileValue,
+} from '@byline/core'
+
+export type PhotoBlockData = {
+  _id: string
+  _type: 'photoBlock'
+  display?: 'default' | 'wide' | 'full_width' | undefined
+  photo?: RelatedDocumentValue | undefined
+  alt: string
+  caption?: JsonValue | undefined
+}
+
+export type PhotoBlockDataAllLocales = {
+  _id: string
+  _type: 'photoBlock'
+  display?: 'default' | 'wide' | 'full_width' | undefined
+  photo?: RelatedDocumentValue | undefined
+  alt: string
+  caption?: { [locale: string]: JsonValue } | undefined
+}
+
+export type RichTextBlockData = {
+  _id: string
+  _type: 'richTextBlock'
+  richText: JsonValue
+  constrainedWidth?: boolean | undefined
+}
+
+export type RichTextBlockDataAllLocales = {
+  _id: string
+  _type: 'richTextBlock'
+  richText: { [locale: string]: JsonValue }
+  constrainedWidth?: boolean | undefined
+}
+
+export type DocsFields = {
+  title: string
+  summary: string
+  featureImage?: RelatedDocumentValue | undefined
+  publishedOn: Date
+  content?: Array<RichTextBlockData | PhotoBlockData> | undefined
+}
+
+export type DocsFieldsAllLocales = {
+  title: { [locale: string]: string }
+  summary: { [locale: string]: string }
+  featureImage?: RelatedDocumentValue | undefined
+  publishedOn: Date
+  content?: Array<RichTextBlockDataAllLocales | PhotoBlockDataAllLocales> | undefined
+}
+
+export type MediaFields = {
+  image: StoredFileValue
+  title: string
+  altText: string
+  caption?: string | undefined
+  credit?: string | undefined
+}
+
+export type MediaFieldsAllLocales = {
+  image: StoredFileValue
+  title: string
+  altText: string
+  caption?: string | undefined
+  credit?: string | undefined
+}
+
+export type NewsCategoriesFields = {
+  name: string
+  description: string
+}
+
+export type NewsCategoriesFieldsAllLocales = {
+  name: { [locale: string]: string }
+  description: { [locale: string]: string }
+}
+
+export type NewsFields = {
+  title: string
+  summary: string
+  category: RelatedDocumentValue
+  featureImage?: RelatedDocumentValue | undefined
+  featured?: boolean | undefined
+  content: JsonValue
+  publishedOn: Date
+}
+
+export type NewsFieldsAllLocales = {
+  title: { [locale: string]: string }
+  summary: { [locale: string]: string }
+  category: RelatedDocumentValue
+  featureImage?: RelatedDocumentValue | undefined
+  featured?: boolean | undefined
+  content: { [locale: string]: JsonValue }
+  publishedOn: Date
+}
+
+export type PagesFields = {
+  title: string
+  summary: string
+  featureImage?: RelatedDocumentValue | undefined
+  area: 'root' | 'about' | 'legal'
+  content?: Array<RichTextBlockData | PhotoBlockData> | undefined
+  publishedOn: Date
+}
+
+export type PagesFieldsAllLocales = {
+  title: { [locale: string]: string }
+  summary: { [locale: string]: string }
+  featureImage?: RelatedDocumentValue | undefined
+  area: 'root' | 'about' | 'legal'
+  content?: Array<RichTextBlockDataAllLocales | PhotoBlockDataAllLocales> | undefined
+  publishedOn: Date
+}
+
+export type CollectionFieldsByPath = {
+  docs: DocsFields
+  media: MediaFields
+  news: NewsFields
+  'news-categories': NewsCategoriesFields
+  pages: PagesFields
+}
+
+export type CollectionFieldsAllLocalesByPath = {
+  docs: DocsFieldsAllLocales
+  media: MediaFieldsAllLocales
+  news: NewsFieldsAllLocales
+  'news-categories': NewsCategoriesFieldsAllLocales
+  pages: PagesFieldsAllLocales
+}
+
+export type CollectionPath = keyof CollectionFieldsByPath

package/dist/templates/byline-examples/i18n.ts

@@ -12,9 +12,9 @@
  * translation bundle.
  *
  * The locale arrays themselves live in `./locales.ts`, a dependency-free leaf
- * module, so the public frontend can import them without pulling in the admin
- * translation graph this file depends on. Re-exported here for back-compat
- * with existing `~/i18n` importers.
+ * module exposed to public frontend code by `./public.ts`, without pulling in
+ * the admin translation graph this file depends on. Re-exported here for
+ * back-compat with existing `~/i18n` importers.
  *
  * `interface` locales govern the CMS admin UI language.
  * `content` locales govern the languages a document can be published in.