@byline/cli 0.1.1

package/dist/templates/byline-examples/collections/doc-example-tree-locale-all.ts

@@ -0,0 +1,278 @@
+const _doc_tree_locale_all = {
+  document_version_id: '01981ef7-6782-71a7-a779-3e36d9b2bc05',
+  document_id: '01981ef7-6782-71a7-a779-432fe33aaa80',
+  status: 'draft',
+  created_at: '2025-07-18T19:16:27.138Z',
+  updated_at: '2025-07-18T19:16:27.138Z',
+  path: 'my-first-bulk-document-13325',
+  publishedOn: '2024-01-15 03:00:00+00',
+  title: {
+    en: 'A bulk created document. 981',
+    es: 'Mi Primer Documento',
+  },
+  summary: {
+    en: 'This is a sample document for testing purposes.',
+    es: 'Este es un documento de muestra para fines de prueba.',
+  },
+  featured: false,
+  content: [
+    {
+      richTextBlock: [
+        {
+          richText: {
+            en: {
+              root: {
+                type: 'root',
+                format: '',
+                indent: 0,
+                version: 1,
+                children: [
+                  {
+                    type: 'paragraph',
+                    format: '',
+                    indent: 0,
+                    version: 1,
+                    children: [
+                      {
+                        mode: 'normal',
+                        text: 'Some richtext here...',
+                        type: 'text',
+                        style: '',
+                        detail: 0,
+                        format: 0,
+                        version: 1,
+                      },
+                    ],
+                    direction: 'ltr',
+                    textStyle: '',
+                    textFormat: 0,
+                  },
+                ],
+                direction: 'ltr',
+              },
+            },
+            es: {
+              root: {
+                type: 'root',
+                format: '',
+                indent: 0,
+                version: 1,
+                children: [
+                  {
+                    type: 'paragraph',
+                    format: '',
+                    indent: 0,
+                    version: 1,
+                    children: [
+                      {
+                        mode: 'normal',
+                        text: 'Aquí hay un campo de texto enriquecido...',
+                        type: 'text',
+                        style: '',
+                        detail: 0,
+                        format: 0,
+                        version: 1,
+                      },
+                    ],
+                    direction: 'ltr',
+                    textStyle: '',
+                    textFormat: 0,
+                  },
+                ],
+                direction: 'ltr',
+              },
+            },
+          },
+        },
+        {
+          constrainedWidth: true,
+        },
+      ],
+    },
+    {
+      photoBlock: [
+        {
+          display: 'wide',
+        },
+        {
+          photo: {
+            file_id: '01981ef7-2e41-7084-add9-3bf27c9b27c3',
+            filename: 'docs-photo-01.jpg',
+            original_filename: 'some-original-filename.jpg',
+            mime_type: 'image/jpeg',
+            file_size: '123456',
+            storage_provider: 'local',
+            storage_path: 'uploads/docs-photo-01.jpg',
+            storage_url: null,
+            file_hash: null,
+            image_width: null,
+            image_height: null,
+            image_format: null,
+            processing_status: 'pending',
+            thumbnail_generated: false,
+          },
+        },
+        {
+          alt: 'Some alt text here',
+        },
+        {
+          caption: {
+            en: {
+              root: {
+                type: 'root',
+                format: '',
+                indent: 0,
+                version: 1,
+                children: [
+                  {
+                    type: 'paragraph',
+                    format: '',
+                    indent: 0,
+                    version: 1,
+                    children: [
+                      {
+                        mode: 'normal',
+                        text: 'Here is a richtext field Here is a richtext field Here is a richtext field Here is a rich text field.',
+                        type: 'text',
+                        style: '',
+                        detail: 0,
+                        format: 0,
+                        version: 1,
+                      },
+                    ],
+                    direction: 'ltr',
+                    textStyle: '',
+                    textFormat: 0,
+                  },
+                ],
+                direction: 'ltr',
+              },
+            },
+            es: {
+              root: {
+                type: 'root',
+                format: '',
+                indent: 0,
+                version: 1,
+                children: [
+                  {
+                    type: 'paragraph',
+                    format: '',
+                    indent: 0,
+                    version: 1,
+                    children: [
+                      {
+                        mode: 'normal',
+                        text: 'Aquí hay un campo de texto enriquecido. Aquí hay un campo de texto enriquecido. Aquí hay un campo de texto enriquecido. Aquí hay un campo de texto enriquecido.',
+                        type: 'text',
+                        style: '',
+                        detail: 0,
+                        format: 0,
+                        version: 1,
+                      },
+                    ],
+                    direction: 'ltr',
+                    textStyle: '',
+                    textFormat: 0,
+                  },
+                ],
+                direction: 'ltr',
+              },
+            },
+          },
+        },
+      ],
+    },
+  ],
+  links: [
+    {
+      link: 'https://example.com',
+    },
+    {
+      link: 'https://another-example.com',
+    },
+  ],
+
+  reviews: [
+    {
+      reviewItem: [
+        {
+          rating: 5,
+        },
+        {
+          comment: {
+            root: {
+              type: 'root',
+              format: '',
+              indent: 0,
+              version: 1,
+              children: [
+                {
+                  type: 'paragraph',
+                  format: '',
+                  indent: 0,
+                  version: 1,
+                  children: [
+                    {
+                      mode: 'normal',
+                      text: 'Some review text here...',
+                      type: 'text',
+                      style: '',
+                      detail: 0,
+                      format: 0,
+                      version: 1,
+                    },
+                  ],
+                  direction: 'ltr',
+                  textStyle: '',
+                  textFormat: 0,
+                },
+              ],
+              direction: 'ltr',
+            },
+          },
+        },
+      ],
+    },
+    {
+      reviewItem: [
+        {
+          rating: 3,
+        },
+        {
+          comment: {
+            root: {
+              type: 'root',
+              format: '',
+              indent: 0,
+              version: 1,
+              children: [
+                {
+                  type: 'paragraph',
+                  format: '',
+                  indent: 0,
+                  version: 1,
+                  children: [
+                    {
+                      mode: 'normal',
+                      text: 'Some review text here...',
+                      type: 'text',
+                      style: '',
+                      detail: 0,
+                      format: 0,
+                      version: 1,
+                    },
+                  ],
+                  direction: 'ltr',
+                  textStyle: '',
+                  textFormat: 0,
+                },
+              ],
+              direction: 'ltr',
+            },
+          },
+        },
+      ],
+    },
+  ],
+}

package/dist/templates/byline-examples/collections/doc-example-tree-locale-en.ts

@@ -0,0 +1,205 @@
+const _doc_tree_locale_en = {
+  document_version_id: '01981ef7-6782-71a7-a779-3e36d9b2bc05',
+  document_id: '01981ef7-6782-71a7-a779-432fe33aaa80',
+  status: 'draft',
+  created_at: '2025-07-18T19:16:27.138Z',
+  updated_at: '2025-07-18T19:16:27.138Z',
+  path: 'my-first-bulk-document-13325',
+  publishedOn: '2024-01-15 03:00:00+00',
+  title: 'A bulk created document. 981',
+  summary: 'This is a sample document for testing purposes.',
+  featured: false,
+  content: [
+    {
+      richTextBlock: [
+        {
+          richText: {
+            root: {
+              type: 'root',
+              format: '',
+              indent: 0,
+              version: 1,
+              children: [
+                {
+                  type: 'paragraph',
+                  format: '',
+                  indent: 0,
+                  version: 1,
+                  children: [
+                    {
+                      mode: 'normal',
+                      text: 'Some richtext here...',
+                      type: 'text',
+                      style: '',
+                      detail: 0,
+                      format: 0,
+                      version: 1,
+                    },
+                  ],
+                  direction: 'ltr',
+                  textStyle: '',
+                  textFormat: 0,
+                },
+              ],
+              direction: 'ltr',
+            },
+          },
+        },
+        {
+          constrainedWidth: true,
+        },
+      ],
+    },
+    {
+      photoBlock: [
+        {
+          display: 'wide',
+        },
+        {
+          photo: {
+            file_id: '01981ef7-2e41-7084-add9-3bf27c9b27c3',
+            filename: 'docs-photo-01.jpg',
+            original_filename: 'some-original-filename.jpg',
+            mime_type: 'image/jpeg',
+            file_size: '123456',
+            storage_provider: 'local',
+            storage_path: 'uploads/docs-photo-01.jpg',
+            storage_url: null,
+            file_hash: null,
+            image_width: null,
+            image_height: null,
+            image_format: null,
+            processing_status: 'pending',
+            thumbnail_generated: false,
+          },
+        },
+        {
+          alt: 'Some alt text here',
+        },
+        {
+          caption: {
+            root: {
+              type: 'root',
+              format: '',
+              indent: 0,
+              version: 1,
+              children: [
+                {
+                  type: 'paragraph',
+                  format: '',
+                  indent: 0,
+                  version: 1,
+                  children: [
+                    {
+                      mode: 'normal',
+                      text: 'Here is a richtext field Here is a richtext field Here is a richtext field Here is a rich text field.',
+                      type: 'text',
+                      style: '',
+                      detail: 0,
+                      format: 0,
+                      version: 1,
+                    },
+                  ],
+                  direction: 'ltr',
+                  textStyle: '',
+                  textFormat: 0,
+                },
+              ],
+              direction: 'ltr',
+            },
+          },
+        },
+      ],
+    },
+  ],
+  links: [
+    {
+      link: 'https://example.com',
+    },
+    {
+      link: 'https://another-example.com',
+    },
+  ],
+  reviews: [
+    {
+      reviewItem: [
+        {
+          rating: 5,
+        },
+        {
+          comment: {
+            root: {
+              type: 'root',
+              format: '',
+              indent: 0,
+              version: 1,
+              children: [
+                {
+                  type: 'paragraph',
+                  format: '',
+                  indent: 0,
+                  version: 1,
+                  children: [
+                    {
+                      mode: 'normal',
+                      text: 'Some review text here...',
+                      type: 'text',
+                      style: '',
+                      detail: 0,
+                      format: 0,
+                      version: 1,
+                    },
+                  ],
+                  direction: 'ltr',
+                  textStyle: '',
+                  textFormat: 0,
+                },
+              ],
+              direction: 'ltr',
+            },
+          },
+        },
+      ],
+    },
+    {
+      reviewItem: [
+        {
+          rating: 3,
+        },
+        {
+          comment: {
+            root: {
+              type: 'root',
+              format: '',
+              indent: 0,
+              version: 1,
+              children: [
+                {
+                  type: 'paragraph',
+                  format: '',
+                  indent: 0,
+                  version: 1,
+                  children: [
+                    {
+                      mode: 'normal',
+                      text: 'Some review text here...',
+                      type: 'text',
+                      style: '',
+                      detail: 0,
+                      format: 0,
+                      version: 1,
+                    },
+                  ],
+                  direction: 'ltr',
+                  textStyle: '',
+                  textFormat: 0,
+                },
+              ],
+              direction: 'ltr',
+            },
+          },
+        },
+      ],
+    },
+  ],
+}

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

@@ -0,0 +1,204 @@
+/**
+ * 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 CollectionAdminConfig, type ColumnDefinition, defineAdmin } from '@byline/core'
+import { DateTimeFormatter } from '@byline/ui/react/fields'
+
+import { SummaryLength } from '~/components/summary-length.js'
+
+import { FeaturedFormatter } from './components/feature-formatter.js'
+import { Docs } from './schema.js'
+
+/**
+ * Column definitions for the default table-based list view.
+ *
+ * These are passed to the built-in `ListView` component and control which
+ * fields appear as columns, their labels, sort behaviour, and formatters.
+ *
+ * Note: when a custom `listView` component is registered on the
+ * `CollectionAdminConfig`, it receives the raw paginated data directly and
+ * is responsible for its own layout. These column definitions can still
+ * be used in a custom list view, but they are not automatically applied
+ * as they are with the default table-based `ListView`. You can import
+ * them if needed - for example if you wanted to create a toggled grid/table
+ * custom view.
+ */
+const listViewColumns: ColumnDefinition[] = [
+  {
+    fieldName: 'title',
+    label: 'Title',
+    sortable: true,
+    align: 'left',
+    className: 'w-[30%]',
+  },
+  {
+    fieldName: 'featured',
+    label: 'Featured',
+    align: 'center',
+    className: 'w-[10%]',
+    formatter: { component: FeaturedFormatter },
+  },
+  {
+    fieldName: 'status',
+    label: 'Status',
+    align: 'center',
+    className: 'w-[15%]',
+  },
+  {
+    fieldName: 'updatedAt',
+    label: 'Last Updated',
+    sortable: true,
+    align: 'right',
+    className: 'w-[20%]',
+    formatter: { component: DateTimeFormatter },
+  },
+]
+
+/**
+ * Columns rendered per row when a collection item appears as the
+ * target of a relation picker. Usually narrower than the list
+ * view — just enough to identify the right item at a glance.
+ */
+// const pickerViewColumns: ColumnDefinition[] = []
+
+export const DocsAdmin: CollectionAdminConfig = defineAdmin(Docs, {
+  /**
+   * Column definitions for the default table-based list view.
+   * Controls which fields appear as columns, their labels, sort behaviour, and formatters.
+   */
+  columns: listViewColumns,
+
+  /**
+   * Column definitions used when this collection appears as the target of a relation
+   * picker modal (opened from a `relation` field widget). Omit to fall back to a
+   * single-line render of `useAsTitle` + `path`.
+   *
+   * Shape matches `ColumnDefinition` so formatters can be reused across list and picker.
+   *
+   * @example
+   * picker: [{ fieldName: 'title', label: 'Title' }] // or defined above as `pickerViewColumns`
+   */
+  // picker: [],
+
+  /**
+   * Custom list-view component that completely replaces the default table-based `ListView`
+   * on the collection index route. Receives a `ListViewComponentProps` object and is
+   * responsible for rendering search, ordering, results, and pagination itself.
+   *
+   * When omitted, the default table-based `ListView` is used with the `columns` defined above.
+   *
+   * @example
+   * listView: DocsListView,
+   */
+  // listView: undefined,
+
+  /**
+   * Group name for organising this collection in the admin sidebar navigation.
+   *
+   * @example
+   * group: 'Documentation',
+   */
+  // group: undefined,
+
+  /**
+   * Per-field rendering overrides, keyed by field name. Use to supply custom
+   * UI component slots for a specific field without affecting placement.
+   * Placement is controlled exclusively through the layout primitives below.
+   */
+  fields: {
+    summary: {
+      components: {
+        HelpText: SummaryLength,
+      },
+    },
+  },
+
+  /**
+   * Preview URL builder for live preview links. Receives the document and an
+   * optional locale and should return a fully-qualified URL string.
+   *
+   * @example
+   * preview: (doc, { locale }) => `https://example.com/${locale}/docs/${doc.fields.path}`
+   */
+  // preview: undefined,
+
+  // ---------------------------------------------------------------------------
+  // UI Layout
+  //
+  // Tab, row, and group containers control how fields are grouped and positioned
+  // in the document edit view. Field names must match those defined in the
+  // collection schema. Names for tabSets, rows, and groups must be unique and
+  // must not collide with any schema field name (a startup error is thrown if
+  // they do).
+  // ---------------------------------------------------------------------------
+
+  /**
+   * Named tab sets. Each entry creates a separate tabbed interface in the edit
+   * view. You can define more than one tab set, though a single set is sufficient
+   * for most collections. Tab sets may only appear in `layout.main`.
+   *
+   * Each tab's `fields` array accepts schema field names, row names, and group names.
+   * An optional `condition` function can show/hide a tab based on live form data.
+   */
+  tabSets: [
+    {
+      name: 'main',
+      tabs: [
+        {
+          name: 'details',
+          label: 'Details',
+          fields: ['title', 'summary', 'featureImage', 'category', 'featured'],
+        },
+        {
+          name: 'content',
+          label: 'Content',
+          fields: ['content'],
+        },
+        {
+          name: 'reviews',
+          label: 'Reviews & Links',
+          fields: ['reviews', 'links'],
+        },
+      ],
+    },
+  ],
+
+  /**
+   * Named horizontal-row layouts. Fields listed inside a row are rendered
+   * side-by-side (flex row) on desktop and stack vertically below the `sm`
+   * breakpoint. Rows are leaf containers — they accept only schema field names.
+   *
+   * Reference a row by its `name` inside a tab's `fields`, a group's `fields`,
+   * or directly in `layout.main` / `layout.sidebar`.
+   */
+  // rows: [],
+
+  /**
+   * Named labelled-fieldset clusters. Groups accept schema field names and row
+   * names (not tabSets or nested groups). An optional `label` renders a heading
+   * above the cluster.
+   *
+   * Reference a group by its `name` inside a tab's `fields` or directly in
+   * `layout.main` / `layout.sidebar`.
+   */
+  // groups: [],
+
+  /**
+   * Composition of all layout primitives into the form's two render regions.
+   *
+   * - `main` — accepts tabSet names, group names, row names, and schema field names.
+   * - `sidebar` — accepts group names, row names, and schema field names (no tabSets).
+   *
+   * When omitted entirely, the renderer synthesises a default that places every
+   * schema field in `main` in declaration order.
+   */
+  layout: {
+    main: ['main'],
+    sidebar: ['publishedOn', 'availableLanguages'],
+  },
+})

package/dist/templates/byline-examples/collections/docs/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/docs/index.ts

@@ -0,0 +1,10 @@
+/**
+ * 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
+ */
+
+export { DocsAdmin } from './admin.js'
+export { Docs } from './schema.js'