@byline/cli 3.21.0 → 4.1.0

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

@@ -1,6 +1,6 @@
 // Generated by @byline/core/codegen
-// Format version: 1
-// Hash: a32bba417302b4e2c90703e47a1f326d4db64cabd11194f8eed816e78442178e
+// Format version: 2
+// Hash: 7c42f9892f94559081c07b01952f1149e7c4cc112569bbed5861c0a32d735448
 
 import type {
   JsonValue,
@@ -8,132 +8,140 @@ import type {
   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
+declare module '@byline/generated-types' {
+  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
+}
+
+declare module '@byline/client' {
+  interface Register {
+    collections: import('@byline/generated-types').CollectionFieldsByPath
+  }
 }
-
-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/routes.ts

@@ -7,17 +7,18 @@
  */
 
 /**
- * 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.
+ * Client-safe URL paths for admin, sign-in, and the future public API.
+ * Resolve once at this client-safe configuration boundary so consumers only
+ * read canonical paths.
  */
 
-import type { RoutesConfig } from '@byline/core'
+import { resolveRoutes } from '@byline/core'
 
-export const routes: Partial<RoutesConfig> = {
+export const routes = resolveRoutes({
   admin: '/admin',
   api: '/api',
-}
+  signIn: '/sign-in',
+})
 
 /**
  * Fallback used by both server and admin entry points when no

package/dist/templates/byline-examples/scripts/backfill-version-locales.ts

@@ -16,7 +16,7 @@
  * Idempotent — safe to re-run. Uses the installation's configured default
  * content locale (resolved from byline/i18n.ts via the server config).
  *
- *   cd apps/webapp && pnpm tsx byline/scripts/backfill-version-locales.ts
+ *   pnpm tsx byline/scripts/backfill-version-locales.ts
  *
  * See docs/07-internationalization/index.md.
  */

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

@@ -12,11 +12,6 @@
 // pnpm tsx byline/scripts/import-docs.ts ../../docs/**/*.md --verbose
 // pnpm tsx byline/scripts/import-docs.ts '../../docs/*.md' --dry-run --verbose
 // pnpm tsx byline/scripts/import-docs.ts ../../docs/**/*.md
-//
-// Run tests...
-//
-// pnpm vitest run --mode=node byline/scripts/lib/
-
 /**
  * Import markdown files into the `docs` collection.
  *
@@ -59,7 +54,7 @@ import { glob } from 'node:fs/promises'
 import { basename, dirname, join, resolve } from 'node:path'
 
 import { createSuperAdminContext } from '@byline/auth'
-import { type CollectionHandle, createBylineClient } from '@byline/client'
+import { type BylineClient, type CollectionHandle, createBylineClient } from '@byline/client'
 import { getCollectionDefinition, getServerConfig, slugify } from '@byline/core'
 
 import { type DocFrontmatter, parseDocFile } from './lib/frontmatter.js'
@@ -67,12 +62,16 @@ import { type MdastToLexicalWarning, mdastToLexical } from './lib/mdast-to-lexic
 import { parseBodyToMdast } from './lib/parse-markdown.js'
 import { type DocLinkRewriteWarning, rewriteDocLinks } from './lib/rewrite-doc-links.js'
 import { stripLeadingH1IfMatches } from './lib/strip-leading-h1.js'
+import type { DocsFields } from '@byline/generated-types'
 
 const DOCS_COLLECTION = 'docs'
 const MEDIA_COLLECTION = 'media'
 const DOCS_URL_PREFIX = '/docs'
 const DEFAULT_IMPORT_STATUS = 'published'
 
+type AppBylineClient = BylineClient
+type DocsHandle = CollectionHandle<DocsFields>
+
 interface Flags {
   dryRun: boolean
   verbose: boolean
@@ -135,7 +134,7 @@ interface ResolvedFeatureImage {
 }
 
 async function resolveFeatureImage(
-  client: ReturnType<typeof createBylineClient>,
+  client: AppBylineClient,
   path: string
 ): Promise<ResolvedFeatureImage | null> {
   const mediaCollectionId = await client.resolveCollectionId(MEDIA_COLLECTION)
@@ -186,7 +185,7 @@ function derivePath(frontmatter: DocFrontmatter, locale: string): string {
  * workflow doesn't include the target or when already at/past it.
  */
 async function walkToStatus(
-  handle: CollectionHandle,
+  handle: DocsHandle,
   documentId: string,
   workflowStatuses: readonly { name: string }[],
   currentStatus: string,
@@ -230,8 +229,8 @@ function buildSourcePathMap(files: string[], defaultLocale: string): Map<string,
 
 async function processFile(
   filePath: string,
-  client: ReturnType<typeof createBylineClient>,
-  handle: CollectionHandle,
+  client: AppBylineClient,
+  handle: DocsHandle,
   flags: Flags,
   pathMap: Map<string, string>
 ): Promise<ProcessResult> {
@@ -340,7 +339,7 @@ function parentIndexFile(filePath: string): string {
  * processed in sorted order, so prefix order carries straight through.
  */
 async function placeTreeFromDirectories(
-  handle: CollectionHandle,
+  handle: DocsHandle,
   results: ProcessResult[]
 ): Promise<void> {
   const placeable = results.filter(