@byline/cli 1.4.0 → 1.6.1

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

@@ -119,11 +119,25 @@ export const DocsAdmin: CollectionAdminConfig = defineAdmin(Docs, {
   },
 
   /**
-   * Preview URL builder for live preview links. Receives the document and an
-   * optional locale and should return a fully-qualified URL string.
+   * Preview URL builder for live preview links. Returns a URL string (relative
+   * or absolute), or `null` to hide the preview affordance.
+   *
+   * `doc.path` is the top-level slug (derived from `useAsPath`), not a field.
+   * Direct relations are auto-populated by the edit view (depth 1, picker
+   * projection) and appear under `doc.fields.<name>?.document`.
    *
    * @example
-   * preview: (doc, { locale }) => `https://example.com/${locale}/docs/${doc.fields.path}`
+   * preview: {
+   *   url: (doc, { locale }) => {
+   *     if (!doc.path) return null
+   *     // `category` is a direct relation — auto-populated to depth 1.
+   *     const category = doc.fields.category?.document?.path
+   *     const prefix = locale && locale !== 'en' ? `/${locale}` : ''
+   *     return category
+   *       ? `${prefix}/docs/${category}/${doc.path}`
+   *       : `${prefix}/docs/${doc.path}`
+   *   },
+   * }
    */
   // preview: undefined,
 
@@ -147,7 +161,7 @@ export const DocsAdmin: CollectionAdminConfig = defineAdmin(Docs, {
    */
   tabSets: [
     {
-      name: 'main',
+      name: 'tabs',
       tabs: [
         {
           name: 'details',
@@ -198,7 +212,7 @@ export const DocsAdmin: CollectionAdminConfig = defineAdmin(Docs, {
    * schema field in `main` in declaration order.
    */
   layout: {
-    main: ['main'],
+    main: ['tabs'],
     sidebar: ['publishedOn', 'availableLanguages'],
   },
 })

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

@@ -12,6 +12,7 @@ import { defineCollection, defineWorkflow } from '@byline/core'
 import { PhotoBlock } from '../../blocks/photo-block.js'
 import { RichTextBlock } from '../../blocks/richtext-block.js'
 import { availableLanguagesField } from '../../fields/available-languages-field.js'
+import { publishedOnField } from '../../fields/published-on-field.js'
 
 // ---- Schema (server-safe, no UI concerns) ----
 
@@ -146,12 +147,7 @@ export const Docs = defineCollection({
       displayField: 'title',
       optional: true,
     },
-    {
-      name: 'publishedOn',
-      label: 'Published On',
-      type: 'datetime',
-      mode: 'datetime',
-    },
+    publishedOnField,
     {
       name: 'category',
       label: 'Category',

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

@@ -127,11 +127,17 @@ export const MediaAdmin: CollectionAdminConfig = defineAdmin(Media, {
   // fields: {},
 
   /**
-   * Preview URL builder for live preview links. Receives the document and an
-   * optional locale and should return a fully-qualified URL string.
+   * Preview URL builder for live preview links. Returns a URL string (relative
+   * or absolute), or `null` to hide the preview affordance.
+   *
+   * `doc.path` is the top-level slug (derived from `useAsPath`), not a field.
+   * Direct relations are auto-populated by the edit view (depth 1, picker
+   * projection) and appear under `doc.fields.<name>?.document`.
    *
    * @example
-   * preview: (doc, { locale }) => `https://example.com/media/${doc.fields.path}`
+   * preview: {
+   *   url: (doc) => (doc.path ? `/media/${doc.path}` : null),
+   * }
    */
   // preview: undefined,
 

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

@@ -24,8 +24,16 @@ import { Link, useNavigate, 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 { Container, IconButton, LoaderRing, PlusIcon, Search, Section, Select } from '@byline/ui/react'
-import { LocalDateTime } from '@byline/ui/react'
+import {
+  Container,
+  IconButton,
+  LoaderRing,
+  LocalDateTime,
+  PlusIcon,
+  Search,
+  Section,
+  Select,
+} from '@byline/ui/react'
 
 import { FormatBadge } from './media-thumbnail'
 

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

@@ -111,11 +111,25 @@ export const NewsAdmin: CollectionAdminConfig = defineAdmin(News, {
   },
 
   /**
-   * Preview URL builder for live preview links. Receives the document and an
-   * optional locale and should return a fully-qualified URL string.
+   * Preview URL builder for live preview links. Returns a URL string (relative
+   * or absolute), or `null` to hide the preview affordance.
+   *
+   * `doc.path` is the top-level slug (derived from `useAsPath`), not a field.
+   * Direct relations are auto-populated by the edit view (depth 1, picker
+   * projection) and appear under `doc.fields.<name>?.document`.
    *
    * @example
-   * preview: (doc, { locale }) => `https://example.com/${locale}/news/${doc.fields.path}`
+   * preview: {
+   *   url: (doc, { locale }) => {
+   *     if (!doc.path) return null
+   *     // `category` is a direct relation — auto-populated to depth 1.
+   *     const category = doc.fields.category?.document?.path
+   *     const prefix = locale && locale !== 'en' ? `/${locale}` : ''
+   *     return category
+   *       ? `${prefix}/news/${category}/${doc.path}`
+   *       : `${prefix}/news/${doc.path}`
+   *   },
+   * }
    */
   // preview: undefined,
 

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

@@ -10,6 +10,7 @@ import type { CollectionFieldData } from '@byline/core'
 import { defineCollection, defineWorkflow } from '@byline/core'
 
 import { availableLanguagesField } from '~/fields/available-languages-field.js'
+import { publishedOnField } from '~/fields/published-on-field.js'
 
 // ---- Schema (server-safe, no UI concerns) ----
 
@@ -73,12 +74,7 @@ export const News = defineCollection({
       localized: true,
       embedRelationsOnSave: true, // See type definition for details.
     },
-    {
-      name: 'publishedOn',
-      label: 'Published On',
-      type: 'datetime',
-      mode: 'datetime',
-    },
+    publishedOnField,
     availableLanguagesField(),
   ],
 })

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

@@ -10,6 +10,7 @@ import { type CollectionAdminConfig, type ColumnDefinition, defineAdmin } from '
 import { DateTimeFormatter } from '@byline/ui/react'
 
 import { SummaryLength } from '~/components/summary-length.js'
+import { i18n } from '~/i18n'
 
 import { Pages } from './schema.js'
 
@@ -37,11 +38,10 @@ const listViewColumns: ColumnDefinition[] = [
     className: 'w-[30%]',
   },
   {
-    fieldName: 'featured',
-    label: 'Featured',
+    fieldName: 'area',
+    label: 'Area',
     align: 'center',
     className: 'w-[10%]',
-    formatter: (value) => (value ? '★' : ''),
   },
   {
     fieldName: 'status',
@@ -119,13 +119,30 @@ export const PagesAdmin: CollectionAdminConfig = defineAdmin(Pages, {
   },
 
   /**
-   * Preview URL builder for live preview links. Receives the document and an
-   * optional locale and should return a fully-qualified URL string.
+   * Preview URL builder for live preview links. Returns a URL string (relative
+   * or absolute), or `null` to hide the preview affordance.
+   *
+   * `doc.path` is the top-level slug (derived from `useAsPath`), not a field.
+   * Direct relations are auto-populated by the edit view (depth 1, picker
+   * projection) and appear under `doc.fields.<name>?.document`.
    *
    * @example
-   * preview: (doc, { locale }) => `https://example.com/${locale}/pages/${doc.fields.path}`
+   * preview: {
+   *   url: (doc, { locale }) => {
+   *     if (!doc.path) return null
+   *     const prefix = locale && locale !== 'en' ? `/${locale}` : ''
+   *     return `${prefix}/${doc.path}`
+   *   },
+   * }
    */
-  // preview: undefined,
+  preview: {
+    url: (doc, { locale }) => {
+      if (!doc.path) return null
+      const prefix = locale && locale !== i18n.interface.defaultLocale ? `/${locale}` : ''
+      const pathWithArea = doc.fields?.area && doc.fields.area !== 'root' ? `${doc.fields.area}/${doc.path}` : doc.path
+      return `${prefix}/${pathWithArea}`
+    },
+  },
 
   // ---------------------------------------------------------------------------
   // UI Layout
@@ -145,7 +162,23 @@ export const PagesAdmin: CollectionAdminConfig = defineAdmin(Pages, {
    * 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: [],
+  tabSets: [
+    {
+      name: 'tabs',
+      tabs: [
+        {
+          name: 'details',
+          label: 'Details',
+          fields: ['title', 'area', 'summary', 'featureImage'],
+        },
+        {
+          name: 'content',
+          label: 'Content',
+          fields: ['content'],
+        },
+      ],
+    },
+  ],
 
   /**
    * Named horizontal-row layouts. Fields listed inside a row are rendered
@@ -177,7 +210,7 @@ export const PagesAdmin: CollectionAdminConfig = defineAdmin(Pages, {
    * schema field in `main` in declaration order.
    */
   layout: {
-    main: ['title', 'summary', 'featureImage', 'category', 'content'],
-    sidebar: ['publishedOn', 'featured', 'availableLanguages'],
+    main: ['tabs'],
+    sidebar: ['publishedOn', 'availableLanguages'],
   },
 })

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

@@ -9,7 +9,10 @@
 import type { CollectionFieldData } from '@byline/core'
 import { defineCollection, defineWorkflow } from '@byline/core'
 
+import { PhotoBlock } from '~/blocks/photo-block'
+import { RichTextBlock } from '~/blocks/richtext-block'
 import { availableLanguagesField } from '~/fields/available-languages-field.js'
+import { publishedOnField } from '~/fields/published-on-field'
 
 // ---- Schema (server-safe, no UI concerns) ----
 
@@ -58,37 +61,25 @@ export const Pages = defineCollection({
       optional: true,
     },
     {
-      name: 'category',
-      label: 'Category',
+      name: 'area',
+      label: 'Area',
       type: 'select',
-      optional: true,
-      helpText: 'Select a category for this page',
+      defaultValue: 'root',
+      helpText: 'Select an area for this page',
       options: [
-        { label: 'Foo', value: 'foo' },
-        { label: 'Bar', value: 'bar' },
-        { label: 'Baz', value: 'baz' },
+        { label: 'Root', value: 'root' },
+        { label: 'About', value: 'about' },
+        { label: 'Legal', value: 'legal' },
       ],
     },
     {
       name: 'content',
       label: 'Content',
-      type: 'richText',
-      helpText: 'Enter the main content for this page.',
-      localized: true,
-    },
-    {
-      name: 'publishedOn',
-      label: 'Published On',
-      type: 'datetime',
-      mode: 'datetime',
-    },
-    {
-      name: 'featured',
-      label: 'Featured',
-      type: 'checkbox',
+      type: 'blocks',
       optional: true,
-      helpText: 'Feature this page.',
+      blocks: [RichTextBlock, PhotoBlock],
     },
+    publishedOnField,
     availableLanguagesField(),
   ],
 })

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

@@ -0,0 +1,25 @@
+/**
+ * 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 { defineField, type FieldData } from '@byline/core'
+
+/**
+ * Common "published on" datetime field. Defined once via `defineField`
+ * so the literal `name: 'publishedOn'` and `type: 'datetime'` survive
+ * inference, and dropped into any collection that needs a publish
+ * timestamp.
+ */
+export const publishedOnField = defineField({
+  name: 'publishedOn',
+  label: 'Published On',
+  type: 'datetime',
+  mode: 'datetime',
+})
+
+/** Data shape contributed by `publishedOnField` (resolves to `Date`). */
+export type PublishedOnFieldData = FieldData<typeof publishedOnField>

package/dist/templates/byline-examples/scripts/regenerate-media.ts

@@ -146,14 +146,7 @@ async function run(): Promise<void> {
       extractMeta: extractImageMeta,
       isBypassMimeType,
       generateVariants: ({ buffer, mimeType, storedFile, storage, upload, logger }) =>
-        generateImageVariants(
-          buffer,
-          mimeType,
-          storedFile,
-          storage,
-          upload.sizes ?? [],
-          logger
-        ),
+        generateImageVariants(buffer, mimeType, storedFile, storage, upload.sizes ?? [], logger),
     },
   }
 

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

@@ -128,7 +128,8 @@ async function buildBylineCore(): Promise<BylineCore<AdminStore>> {
     }),
     // S3-compatible alternative (AWS S3 / Cloudflare R2 / MinIO). Replace
     // the `localStorageProvider` block above with the call below and add
-    // the corresponding `BYLINE_STORAGE_S3_*` entries to your `.env`.
+    // the corresponding `BYLINE_STORAGE_S3_*` entries to your `.env`
+    // (see `apps/webapp/.env.example`).
     //
     // On AWS with an IAM role / instance profile, omit `accessKeyId` and
     // `secretAccessKey` so the SDK resolves credentials via its default

package/package.json

@@ -2,7 +2,7 @@
   "name": "@byline/cli",
   "private": false,
   "license": "MPL-2.0",
-  "version": "1.4.0",
+  "version": "1.6.1",
   "engines": {
     "node": ">=20.9.0"
   },