@byline/cli 1.11.2 → 1.12.1

package/dist/templates/byline-examples/admin.config.ts

@@ -29,7 +29,6 @@ import { RichTextField as LexicalRichTextField } from '@byline/richtext-lexical'
 // import { lexicalEditor } from '@byline/richtext-lexical'
 
 import { Docs, DocsAdmin } from './collections/docs/index.js'
-import { DocsCategories, DocsCategoriesAdmin } from './collections/docs-categories/index.js'
 import { Media, MediaAdmin } from './collections/media/index.js'
 import { News, NewsAdmin } from './collections/news/index.js'
 import { NewsCategories, NewsCategoriesAdmin } from './collections/news-categories/index.js'
@@ -43,8 +42,8 @@ export const config: ClientConfig = {
   serverURL,
   i18n,
   routes,
-  collections: [Docs, News, Pages, Media, DocsCategories, NewsCategories],
-  admin: [DocsAdmin, NewsAdmin, PagesAdmin, MediaAdmin, DocsCategoriesAdmin, NewsCategoriesAdmin],
+  collections: [Docs, News, Pages, Media, NewsCategories],
+  admin: [DocsAdmin, NewsAdmin, PagesAdmin, MediaAdmin, NewsCategoriesAdmin],
   fields: {
     // Default registration — every `type: 'richText'` field gets the full
     // Lexical feature set unless overridden per-field via
@@ -53,16 +52,25 @@ export const config: ClientConfig = {
     richText: { editor: LexicalRichTextField },
 
     // ---------------------------------------------------------------------
-    // Alternatively — register the editor with site-wide custom settings.
-    // The `configure` callback receives a deep clone of `defaultEditorConfig`,
-    // so mutating it is safe. Per-field `editorConfig` continues to take
-    // precedence over whatever is baked in here.
+    // Alternatively — register the editor with site-wide custom settings
+    // and an edited extensions list. The `configure` callback receives a
+    // fresh seed (default settings + the canonical extensions list), and
+    // mutations are local to this call. Per-field `editorConfig`
+    // continues to take precedence over whatever is baked in here.
+    //
+    // import {
+    //   lexicalEditor,
+    //   AdmonitionExtension,
+    //   CodeHighlightExtension,
+    //   TableExtension,
+    // } from '@byline/richtext-lexical'
     //
     // richText: {
     //   editor: lexicalEditor((c) => {
-    //     c.settings.options.tablePlugin = false
-    //     c.settings.options.codeHighlightPlugin = false
-    //     c.settings.options.admonitionPlugin = false
+    //     c.extensions
+    //       .remove(TableExtension)
+    //       .remove(CodeHighlightExtension)
+    //       .remove(AdmonitionExtension)
     //     c.settings.placeholderText = 'Start writing...'
     //     return c
     //   }),

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

@@ -11,7 +11,6 @@ import { DateTimeFormatter } from '@byline/ui/react'
 
 import { SummaryLength } from '~/components/summary-length.js'
 
-import { FeaturedFormatter } from './components/feature-formatter.js'
 import { Docs } from './schema.js'
 
 /**
@@ -34,14 +33,7 @@ const listViewColumns: ColumnDefinition[] = [
     label: 'Title',
     sortable: true,
     align: 'left',
-    className: 'w-[30%]',
-  },
-  {
-    fieldName: 'featured',
-    label: 'Featured',
-    align: 'center',
-    className: 'w-[10%]',
-    formatter: { component: FeaturedFormatter },
+    className: 'w-[50%]',
   },
   {
     fieldName: 'status',
@@ -54,7 +46,7 @@ const listViewColumns: ColumnDefinition[] = [
     label: 'Last Updated',
     sortable: true,
     align: 'right',
-    className: 'w-[20%]',
+    className: 'w-[35%]',
     formatter: { component: DateTimeFormatter },
   },
 ]
@@ -166,18 +158,13 @@ export const DocsAdmin: CollectionAdminConfig = defineAdmin(Docs, {
         {
           name: 'details',
           label: 'Details',
-          fields: ['title', 'summary', 'featureImage', 'category', 'featured'],
+          fields: ['title', 'summary', 'featureImage'],
         },
         {
           name: 'content',
           label: 'Content',
           fields: ['content'],
         },
-        {
-          name: 'reviews',
-          label: 'Reviews & Links',
-          fields: ['reviews', 'links'],
-        },
       ],
     },
   ],

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

@@ -148,20 +148,6 @@ export const Docs = defineCollection({
       optional: true,
     },
     publishedOnField,
-    {
-      name: 'category',
-      label: 'Category',
-      type: 'relation',
-      targetCollection: 'docs-categories',
-      displayField: 'name',
-    },
-    {
-      name: 'featured',
-      label: 'Featured',
-      type: 'checkbox',
-      optional: true,
-      helpText: 'Feature this document.',
-    },
     {
       name: 'content',
       label: 'Content',
@@ -169,35 +155,6 @@ export const Docs = defineCollection({
       optional: true,
       blocks: [RichTextBlock, PhotoBlock],
     },
-    {
-      name: 'reviews',
-      label: 'Reviews',
-      type: 'array',
-      optional: true,
-      fields: [
-        {
-          name: 'reviewItem',
-          label: 'Review Item',
-          type: 'group',
-          fields: [
-            { name: 'rating', label: 'Rating', type: 'integer' },
-            {
-              name: 'comment',
-              label: 'Comments',
-              type: 'richText',
-              localized: false,
-            },
-          ],
-        },
-      ],
-    },
-    {
-      name: 'links',
-      label: 'Links',
-      type: 'array',
-      optional: true,
-      fields: [{ name: 'link', label: 'Link', type: 'text' }],
-    },
     availableLanguagesField(),
   ],
 })

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

@@ -38,7 +38,7 @@ import {
 import styles from './media-list-view.module.css'
 import { FormatBadge } from './media-thumbnail'
 
-export function formatNumber(number: number, decimalPlaces: number) {
+function formatNumber(number: number, decimalPlaces: number) {
   if (typeof number !== 'number' || Number.isNaN(number)) {
     throw new TypeError('Input must be a valid number')
   }

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

@@ -56,6 +56,7 @@ export const Media = defineCollection({
       name: 'image',
       label: 'Image',
       type: 'image',
+      helpText: 'Select an image for this media item.',
       upload: {
         // Allow common image types. Extend with 'video/*', 'application/pdf'
         // etc. for a more general media field.

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

@@ -11,6 +11,7 @@ import { DateTimeFormatter } from '@byline/ui/react'
 
 import { SummaryLength } from '~/components/summary-length.js'
 
+import { FeaturedFormatter } from './components/feature-formatter.js'
 import { News } from './schema.js'
 
 /**
@@ -33,7 +34,14 @@ const listViewColumns: ColumnDefinition[] = [
     label: 'Title',
     sortable: true,
     align: 'left',
-    className: 'w-[25%]',
+    className: 'w-[30%]',
+  },
+  {
+    fieldName: 'featured',
+    label: 'Featured',
+    align: 'center',
+    className: 'w-[10%]',
+    formatter: { component: FeaturedFormatter },
   },
   {
     fieldName: 'status',
@@ -201,6 +209,6 @@ export const NewsAdmin: CollectionAdminConfig = defineAdmin(News, {
    */
   layout: {
     main: ['main'],
-    sidebar: ['availableLanguages', 'publishedOn'],
+    sidebar: ['featured', 'availableLanguages', 'publishedOn'],
   },
 })

package/dist/templates/byline-examples/collections/news/components/feature-formatter.tsx

@@ -0,0 +1,10 @@
+import type { FormatterProps } from '@byline/core'
+
+export function FeaturedFormatter({ value, record }: FormatterProps) {
+  if (value == null || value === false) return null
+  return (
+    <span title={`"${record.title}" is featured`} className="text-amber-500">
+      ★
+    </span>
+  )
+}

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

@@ -66,6 +66,13 @@ export const News = defineCollection({
       displayField: 'title',
       optional: true,
     },
+    {
+      name: 'featured',
+      label: 'Featured',
+      type: 'checkbox',
+      optional: true,
+      helpText: 'Feature this document.',
+    },
     {
       name: 'content',
       label: 'Content',

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

@@ -27,7 +27,7 @@ export const NewsCategories = defineCollection({
   // Demonstration of `orderable: true` — short, finite, naturally ordered.
   // Editors can drag rows in the list view to set a canonical order; the
   // value persists on `byline_documents.order_key` without bumping the
-  // document version. See docs/ORDERABLE.md.
+  // document version. See docs/COLLECTIONS.md (Orderable collections).
   orderable: true,
   fields: [
     { name: 'name', label: 'Name', type: 'text', localized: true },

package/dist/templates/byline-examples/fields/available-languages-field.ts

@@ -6,6 +6,15 @@
  * Copyright (c) Infonomic Company Limited
  */
 
+/**
+ * **Schema-side helper.** Returns a `GroupField` schema that emits one
+ * `checkbox` field per configured content locale. Drop the result into
+ * a collection's `fields` array in `<collection>/schema.ts`. Pure data;
+ * the only imports are `@byline/core` types and the i18n locale list.
+ *
+ * See `docs/FIELDS.md` for the schema-vs-admin model.
+ */
+
 import type { GroupField } from '@byline/core'
 
 import { contentLocales, type LocaleDefinition } from '../i18n.js'
@@ -39,7 +48,7 @@ const builtInValidate = (value: Record<string, boolean> | undefined): string | u
     !Array.isArray(value) &&
     Object.values(value).some(Boolean)
   if (!hasSelection) {
-    return 'At least one language must be selected.'
+    return 'At least one language must be selected'
   }
   return undefined
 }

package/dist/templates/byline-examples/fields/lexical-richtext-compact.ts

@@ -6,41 +6,58 @@
  * Copyright (c) Infonomic Company Limited
  */
 
+/**
+ * **Schema-side helper.** Returns a `RichTextField` schema — drop into a
+ * collection's `fields` array in `<collection>/schema.ts`. Bakes a
+ * compact Lexical `editorConfig` (settings only) into the schema. Pure
+ * data: no React, no CSS — schema files must stay tsx-loadable for
+ * seeds (see `byline/server.config.ts`).
+ *
+ * **Constraint** — `editorConfig` baked into a schema can only override
+ * **settings** (placeholder, toolbar UI flags, `embedRelationsOnSave`).
+ * Extension references (TableExtension, AdmonitionExtension, etc.) are
+ * not JSON-safe and would break tsx-loaded seeds; per-field extension
+ * removal goes through a client-side wrapper component registered via
+ * `FieldAdminConfig.editor`.
+ *
+ * See `docs/FIELDS.md` for the full schema-vs-admin model.
+ */
+
 import type { RichTextField } from '@byline/core'
-import { defaultEditorConfig, type EditorConfig } from '@byline/richtext-lexical'
+// Import from `/server` (data-only) rather than the package root so this
+// schema helper stays tsx-loadable. The root barrel evaluates `RichTextField`
+// / `EditorField` and their CSS imports, which would break seeds that load
+// any collection schema using this factory.
+import { defaultEditorConfig, type EditorConfig } from '@byline/richtext-lexical/server'
 
 type Options = Partial<Omit<RichTextField, 'type' | 'editorConfig'>> & {
   /**
    * Optional callback to further customise the compact defaults. Receives a
-   * mutable copy of the compact config; mutate and return, or return a new
+   * mutable copy of the compact settings; mutate and return, or return a new
    * object. Runs after the compact preset is applied, so callers can re-enable
    * specific options for a particular field without re-listing the full set.
+   *
+   * The compact preset only touches `settings`. Do not assign extensions
+   * here — schema-side `editorConfig` must remain JSON-safe.
    */
   configure?: (config: EditorConfig) => EditorConfig
 }
 
 /**
- * Compact preset — disables block-level features (tables, layouts,
- * admonitions, code highlight, lists, embeds, inline images, alignment) and
- * keeps a slim toolbar suitable for inline body copy like image captions,
- * byline strap-lines, or compact form fields.
+ * Compact preset — disables secondary toolbar UI (text alignment,
+ * inline-code, undo/redo, text style) for inline body copy like image
+ * captions, byline strap-lines, or compact form fields. Bold / italic /
+ * link editing remain on.
+ *
+ * To narrow the *extension* set per-field — drop tables, lists, embeds,
+ * the floating format toolbar, the table action menu — register a
+ * `LexicalRichTextCompact` wrapper component via `FieldAdminConfig.editor`.
+ * Extension references aren't safe to bake into schemas, and floating
+ * UIs are now extension-presence controlled rather than settings-controlled.
  */
 function applyCompactPreset(config: EditorConfig): EditorConfig {
   const o = config.settings.options
   o.textAlignment = false
-  o.tablePlugin = false
-  o.tableActionMenuPlugin = false
-  o.tableCellBackgroundColor = false
-  o.tableCellMerge = false
-  o.layoutPlugin = false
-  o.admonitionPlugin = false
-  o.codeHighlightPlugin = false
-  o.horizontalRulePlugin = false
-  o.listPlugin = false
-  o.checkListPlugin = false
-  o.inlineImagePlugin = false
-  o.autoEmbedPlugin = false
-  o.floatingTextFormatToolbarPlugin = false
   o.textStyle = false
   o.inlineCode = false
   o.undoRedo = false
@@ -48,24 +65,20 @@ function applyCompactPreset(config: EditorConfig): EditorConfig {
 }
 
 /**
- * Returns a `RichTextField` with a reduced Lexical feature set baked into
- * `editorConfig`. Use this for caption-style or otherwise constrained rich-text
- * fields where the full editor surface would be inappropriate.
- *
- * The compact preset disables tables, layouts, lists, code highlight, inline
- * images, embeds, and most secondary toolbar features while keeping bold /
- * italic / link editing and the floating link editor.
+ * Returns a `RichTextField` with reduced toolbar settings baked into
+ * `editorConfig`. Use this for caption-style or otherwise constrained
+ * rich-text fields where the full editor toolbar would be inappropriate.
  *
  * @example
  * ```ts
  * fields: [
  *   lexicalRichTextCompact({ name: 'caption', label: 'Caption' }),
- *   // Compact + re-enable lists for a specific field:
+ *   // Compact + custom placeholder for one field:
  *   lexicalRichTextCompact({
  *     name: 'summary',
  *     label: 'Summary',
  *     configure: (c) => {
- *       c.settings.options.listPlugin = true
+ *       c.settings.placeholderText = 'One sentence summary…'
  *       return c
  *     },
  *   }),

package/dist/templates/byline-examples/fields/published-on-field.ts

@@ -6,6 +6,15 @@
  * Copyright (c) Infonomic Company Limited
  */
 
+/**
+ * **Schema-side field.** A pre-built `datetime` field definition. Drop
+ * the exported `publishedOnField` (the value, not a call) into a
+ * collection's `fields` array in `<collection>/schema.ts`. Pure data;
+ * safe to import from any schema file.
+ *
+ * See `docs/FIELDS.md` for the schema-vs-admin model.
+ */
+
 import { defineField, type FieldData } from '@byline/core'
 
 /**

package/dist/templates/byline-examples/seed-docs.ts

@@ -10,12 +10,10 @@
 import 'dotenv/config'
 import './server.config.js'
 
-import { seedDocsCategories } from './seeds/doc-categories.js'
 import { seedDocs } from './seeds/docs.js'
 import { seedNewsCategories } from './seeds/news-categories.js'
 
 async function run() {
-  await seedDocsCategories()
   await seedNewsCategories()
   await seedDocs()
 }

package/dist/templates/byline-examples/seeds/docs.ts

@@ -24,7 +24,6 @@ const sampleDocument = {
   //   targetCollectionId: "cat-123",
   //   targetDocumentId: "electronics-audio"
   // },
-  featured: false,
   publishedOn: new Date('2024-01-15T10:00:00'),
   content: [
     {
@@ -165,81 +164,6 @@ const sampleDocument = {
       },
     },
   ],
-  reviews: [
-    {
-      reviewItem: {
-        rating: 5,
-        comment: {
-          root: {
-            children: [
-              {
-                children: [
-                  {
-                    detail: 0,
-                    format: 0,
-                    mode: 'normal',
-                    style: '',
-                    text: 'Some review text here...',
-                    type: 'text',
-                    version: 1,
-                  },
-                ],
-                direction: 'ltr',
-                format: '',
-                indent: 0,
-                type: 'paragraph',
-                version: 1,
-                textFormat: 0,
-                textStyle: '',
-              },
-            ],
-            direction: 'ltr',
-            format: '',
-            indent: 0,
-            type: 'root',
-            version: 1,
-          },
-        },
-      },
-    },
-    {
-      reviewItem: {
-        rating: 3,
-        comment: {
-          root: {
-            children: [
-              {
-                children: [
-                  {
-                    detail: 0,
-                    format: 0,
-                    mode: 'normal',
-                    style: '',
-                    text: 'Some review text here...',
-                    type: 'text',
-                    version: 1,
-                  },
-                ],
-                direction: 'ltr',
-                format: '',
-                indent: 0,
-                type: 'paragraph',
-                version: 1,
-                textFormat: 0,
-                textStyle: '',
-              },
-            ],
-            direction: 'ltr',
-            format: '',
-            indent: 0,
-            type: 'root',
-            version: 1,
-          },
-        },
-      },
-    },
-  ],
-  links: [{ link: 'https://example.com' }, { link: 'https://another-example.com' }],
 }
 
 export async function seedDocs(count = 15) {

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

@@ -28,7 +28,6 @@ import { localStorageProvider } from '@byline/storage-local'
 // admin UI configs (React components, CSS modules) that are not loadable
 // outside Vite (e.g. when running seeds via tsx).
 import { Docs } from './collections/docs/schema.js'
-import { DocsCategories } from './collections/docs-categories/schema.js'
 import { Media } from './collections/media/schema.js'
 import { News } from './collections/news/schema.js'
 import { NewsCategories } from './collections/news-categories/schema.js'
@@ -38,7 +37,7 @@ import { DEFAULT_SERVER_URL, routes } from './routes.js'
 
 const serverURL = process.env.VITE_SERVER_URL || DEFAULT_SERVER_URL
 
-const collections = [Docs, News, Pages, Media, DocsCategories, NewsCategories]
+const collections = [Docs, News, Pages, Media, NewsCategories]
 
 // HMR-safe singleton. Vite's program reload re-evaluates this module
 // without disposing the previous module's resources — every reload

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

@@ -132,6 +132,7 @@ const config = defineConfig({
     browserAsyncHooksAlias(),
     devtools(),
     nitro({
+      preset: 'node',
       // @byline/ui ships compiled JS that does `import './foo_module.css'`.
       // @byline/host-tanstack-start re-exports route factories from
       // @byline/ui at runtime in the SSR graph. Nitro externalizes

package/package.json

@@ -2,7 +2,7 @@
   "name": "@byline/cli",
   "private": false,
   "license": "MPL-2.0",
-  "version": "1.11.2",
+  "version": "1.12.1",
   "engines": {
     "node": ">=20.9.0"
   },
@@ -61,7 +61,7 @@
   "scripts": {
     "build": "tsc -p tsconfig.json && tsc-alias && node ./scripts/copy-templates.js && chmod +x dist/cli.js",
     "dev": "tsc -w -p tsconfig.json",
-    "clean": "rimraf node_modules dist .turbo",
+    "clean": "node scripts/clean.js node_modules dist .turbo",
     "lint": "biome check --write --unsafe --diagnostic-level=error",
     "test": "vitest run --passWithNoTests",
     "typecheck": "tsc --noEmit"