@byline/cli 3.20.4 → 4.0.0

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

@@ -12,12 +12,12 @@
  * registry). `byline/i18n.ts` consumes these to assemble the
  * `defineServerConfig` / `defineClientConfig` payload.
  *
- * Kept separate from `byline/i18n.ts` so a public frontend (or a collection
- * schema file loaded outside Vite — e.g. when running seeds via tsx) can
- * import the locale arrays without dragging in the admin translation graph
- * (`@byline/i18n/admin`) that `i18n.ts` depends on. Importing `byline/i18n.ts`
- * would; importing this won't — which keeps the lazy admin/public bundle split
- * (`src/routes/_byline/route.lazy.tsx`) intact.
+ * Kept separate from `byline/i18n.ts` so `byline/public.ts` can expose the
+ * locale arrays to a public frontend (or a collection schema file loaded
+ * outside Vite — e.g. when running seeds via tsx) without dragging in the
+ * admin translation graph (`@byline/i18n/admin`) that `i18n.ts` depends on.
+ * Importing `byline/i18n.ts` would; importing this won't — which keeps the lazy
+ * admin/public bundle split (`src/routes/_byline/route.lazy.tsx`) intact.
  *
  * `interface` locales govern the CMS admin UI language; `content` locales
  * govern the languages a document can be published in.
@@ -33,10 +33,10 @@ export interface LocaleDefinition {
 // (or a third-party plugin merged in via `mergeTranslations(...)`).
 // `adminTranslations({ locales })` in `byline/i18n.ts` throws at boot if a
 // requested code is not bundled — `@byline/i18n/admin` ships English and French.
-export const interfaceLocales: LocaleDefinition[] = [
+export const interfaceLocales = [
   { code: 'en', label: 'English' },
   { code: 'fr', label: 'Français' },
-]
+] as const satisfies readonly LocaleDefinition[]
 
 /** Locales a document can be published in. */
 export const contentLocales = [
@@ -44,4 +44,4 @@ export const contentLocales = [
   { code: 'fr', label: 'Français' },
   { code: 'es', label: 'Español' },
   { code: 'de', label: 'Deutsch' },
-] as const
+] as const satisfies readonly LocaleDefinition[]

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

@@ -0,0 +1,12 @@
+/**
+ * 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
+ */
+
+/** Client-safe public configuration. Keep this barrel free of admin and server imports. */
+export { contentLocales, interfaceLocales } from './locales.js'
+export { routes } from './routes.js'
+export type { LocaleDefinition } from './locales.js'

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/generate-types.ts

@@ -0,0 +1,81 @@
+import { randomUUID } from 'node:crypto'
+import { existsSync, mkdirSync, readFileSync, renameSync, rmSync, writeFileSync } from 'node:fs'
+import { dirname, resolve } from 'node:path'
+import { fileURLToPath, pathToFileURL } from 'node:url'
+
+import { emitCollectionTypes } from '@byline/core/codegen'
+
+import { collections } from '../collections/index.js'
+
+const defaultOutputPath = fileURLToPath(
+  new URL('../generated/collection-types.ts', import.meta.url)
+)
+
+export type GenerationStatus = 'current' | 'unchanged' | 'written'
+
+export function writeCollectionTypes(
+  outputPath: string,
+  source: string,
+  check: boolean
+): GenerationStatus {
+  const existing = existsSync(outputPath) ? readFileSync(outputPath, 'utf8') : undefined
+
+  if (check) {
+    if (existing === undefined) {
+      throw new Error(
+        `generated collection types are missing: ${outputPath}. Run pnpm byline:generate`
+      )
+    }
+    if (existing !== source) {
+      throw new Error(
+        `generated collection types are stale: ${outputPath}. Run pnpm byline:generate`
+      )
+    }
+    return 'current'
+  }
+
+  if (existing === source) return 'unchanged'
+
+  mkdirSync(dirname(outputPath), { recursive: true })
+  const temporaryPath = `${outputPath}.${process.pid}.${randomUUID()}.tmp`
+  try {
+    writeFileSync(temporaryPath, source, 'utf8')
+    renameSync(temporaryPath, outputPath)
+  } finally {
+    rmSync(temporaryPath, { force: true })
+  }
+  return 'written'
+}
+
+function parseArgs(args: readonly string[]): { check: boolean } {
+  const unknown = args.filter((arg) => arg !== '--check')
+  if (unknown.length > 0) throw new Error(`unknown argument: ${unknown.join(', ')}`)
+  if (args.filter((arg) => arg === '--check').length > 1) {
+    throw new Error('duplicate argument: --check')
+  }
+  return { check: args.includes('--check') }
+}
+
+export function generateCollectionTypes(
+  outputPath = defaultOutputPath,
+  check = false
+): { hash: string; status: GenerationStatus } {
+  const { source, hash } = emitCollectionTypes(collections)
+  return { hash, status: writeCollectionTypes(outputPath, source, check) }
+}
+
+function main(): void {
+  const { check } = parseArgs(process.argv.slice(2))
+  const { hash, status } = generateCollectionTypes(defaultOutputPath, check)
+  console.log(`collection types: ${collections.length} collections ${hash.slice(0, 12)} ${status}`)
+}
+
+const entryPath = process.argv[1]
+if (entryPath !== undefined && pathToFileURL(resolve(entryPath)).href === import.meta.url) {
+  try {
+    main()
+  } catch (error) {
+    console.error(`collection type generation failed: ${(error as Error).message}`)
+    process.exitCode = 1
+  }
+}

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 { CollectionFieldsByPath, DocsFields } from '../generated/collection-types.js'
 
 const DOCS_COLLECTION = 'docs'
 const MEDIA_COLLECTION = 'media'
 const DOCS_URL_PREFIX = '/docs'
 const DEFAULT_IMPORT_STATUS = 'published'
 
+type AppBylineClient = BylineClient<CollectionFieldsByPath>
+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(
@@ -392,7 +391,7 @@ async function run(): Promise<void> {
 
   const config = getServerConfig()
   const requestContext = createSuperAdminContext({ id: 'import-docs-script' })
-  const client = createBylineClient({ config, requestContext })
+  const client = createBylineClient<CollectionFieldsByPath>({ config, requestContext })
   const handle = client.collection(DOCS_COLLECTION)
 
   // Pre-pass: map each source file to the path its imported doc will