@byline/cli 5.1.4 → 6.0.0

package/dist/templates/byline-examples/fields/lexical-richtext-ai.tsx

@@ -55,11 +55,11 @@ export const LexicalRichTextAi = lexicalEditor((c) => {
   // registration config so every richtext field keeps the AI assistant AND
   // the markdown toggle — a schema-side `editorConfig` would override this
   // baked config and strip the AI extension (it can't carry extensions).
-  c.settings.options.markdownToggle = true
+  c.settings.controls.markdownToggle = true
   // Inline as-you-type markdown shortcuts (`# ` → H1, `- ` → list, `**x**`
   // → bold, `| a | b |` → table, `:::note` → admonition, …). Uses the same
   // BYLINE_TRANSFORMERS set as the source toggle. Remove this line to disable.
-  c.settings.options.markdownShortcutPlugin = true
+  c.settings.markdownShortcuts = true
   return c
 }) satisfies (props: RichTextEditorProps) => React.JSX.Element
 

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

@@ -0,0 +1,87 @@
+/**
+ * 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
+ */
+
+/**
+ * **Admin-side half of the compact editor.** Pair with the
+ * `lexicalRichTextCompact()` schema helper, which carries the JSON-safe
+ * toolbar preferences; this file carries the extension set, which is not
+ * JSON-safe and so cannot live in a schema.
+ *
+ * Compact sits between a strictly inline field and the full editor: no
+ * block structures, but links and inline images survive, because a
+ * caption or a credit line usually wants both. Adjust the removals below
+ * to suit your own fields — this is an example, not a fixed policy.
+ *
+ * Removing an extension decides what the field ACCEPTS as well as what
+ * it offers, since each extension owns its node classes. Without this
+ * half, a compact field hid the block-format dropdown while still
+ * storing a heading that arrived by paste.
+ *
+ * Bold, italic and inline code cannot be constrained here: they are
+ * `TextNode` formats rather than node types, so they have no node to
+ * unregister and still arrive by paste.
+ */
+
+import type { FieldAdminConfig, RichTextEditorProps } from '@byline/core'
+import { builtInExtensions, lexicalEditor } from '@byline/richtext-lexical/config'
+
+/**
+ * The extension narrowing, exported separately from the component.
+ *
+ * `lexicalEditor()` closes over its callback inside a lazy component, so
+ * the resolved list is not reachable from the outside. Naming the
+ * callback lets a test assert which extensions this preset removes —
+ * which is the whole of its contract now that removal decides what a
+ * field accepts.
+ */
+export function configureCompactEditor<T extends { extensions?: any }>(c: T): T {
+  c.extensions
+    // Block structures — a caption is not a place for a heading, a
+    // quote, a list or a table.
+    .remove(builtInExtensions.Heading)
+    .remove(builtInExtensions.Quote)
+    .remove(builtInExtensions.List)
+    .remove(builtInExtensions.CheckList)
+    .remove(builtInExtensions.Table)
+    .remove(builtInExtensions.Layout)
+    .remove(builtInExtensions.Admonition)
+    .remove(builtInExtensions.HorizontalRule)
+    .remove(builtInExtensions.CodeHighlight)
+    // Embeds — a compact field is not a place to drop a video.
+    .remove(builtInExtensions.AutoEmbed)
+    .remove(builtInExtensions.YouTube)
+    .remove(builtInExtensions.Vimeo)
+  // Link, AutoLink and InlineImage stay on purpose: captions carry
+  // credits, and credits carry links.
+  return c
+}
+
+export const LexicalRichTextCompact = lexicalEditor(configureCompactEditor) satisfies (
+  props: RichTextEditorProps
+) => React.JSX.Element
+
+/**
+ * Returns a `FieldAdminConfig` that opts a single richText field into the
+ * compact editor. Drop into a `CollectionAdminConfig.fields` map, keyed
+ * by the schema field's name.
+ *
+ * @example
+ * ```ts
+ * // byline/collections/<collection>/admin.tsx
+ * import { compactRichTextAdmin } from '../../fields/lexical-richtext-compact-admin.jsx'
+ *
+ * fields: {
+ *   caption: compactRichTextAdmin(),
+ * }
+ * ```
+ */
+export function compactRichTextAdmin(): FieldAdminConfig {
+  return {
+    editor: LexicalRichTextCompact,
+  }
+}

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

@@ -52,19 +52,29 @@ type Options = Partial<Omit<RichTextField, 'type' | 'editorConfig'>> & {
  * 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`
- * (same pattern as `aiRichTextAdmin()`). Extension references aren't safe
- * to bake into schemas, and floating UIs are now extension-presence
- * controlled rather than settings-controlled.
+ * This half hides CONTROLS and nothing more. It does not decide what the
+ * field accepts: a heading can still arrive by paste, by Markdown, or
+ * from storage, and `controls.blockFormat = false` only removes the
+ * dropdown that would have offered one.
+ *
+ * To narrow what the field ACCEPTS, pair this with
+ * `compactRichTextAdmin()` (`./lexical-richtext-compact-admin.js`), which
+ * removes the extensions owning those node classes — removing an
+ * extension removes its node registration along with its controls.
+ * Extension references are not JSON-safe, so they cannot be baked into a
+ * schema and must travel through `FieldAdminConfig.editor`, the same
+ * pattern as `aiRichTextAdmin()`.
+ *
+ * Neither half can constrain bold, italic or inline code: they are
+ * `TextNode` formats rather than node types, so there is no node to
+ * unregister and they still arrive by paste.
  */
 function applyCompactPreset(config: EditorConfig): EditorConfig {
-  const o = config.settings.options
-  o.textAlignment = false
-  o.textStyle = false
-  o.inlineCode = false
-  o.undoRedo = false
+  const c = config.settings.controls
+  c.textAlignment = false
+  c.blockFormat = false
+  c.inlineCode = false
+  c.undoRedo = false
   return config
 }
 

package/dist/templates-editor-api-drift.test.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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 {};
+//# sourceMappingURL=templates-editor-api-drift.test.d.ts.map

package/dist/templates-editor-api-drift.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates-editor-api-drift.test.d.ts","sourceRoot":"","sources":["../src/templates-editor-api-drift.test.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/dist/templates-editor-api-drift.test.js

@@ -0,0 +1,87 @@
+/**
+ * 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
+ */
+/**
+ * Shipped examples must not use editor APIs that no longer exist.
+ *
+ * `tsconfig.json` excludes `src/templates` from typechecking — templates
+ * are source for a generated app, not for this package, and their
+ * imports only resolve once scaffolded. That exclusion is reasonable and
+ * it has a cost: nothing tells you when an example drifts away from the
+ * API it demonstrates. It is how `settings.options` survived in two
+ * templates through the 6.0 rename, where it would have generated a
+ * broken install.
+ *
+ * This is a blunt guard rather than a typecheck, but it catches the
+ * class of drift that matters: an example calling into a surface that
+ * was removed.
+ */
+import { readdirSync, readFileSync, statSync } from 'node:fs';
+import { dirname, join, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { describe, expect, it } from 'vitest';
+const here = dirname(fileURLToPath(import.meta.url));
+const templatesRoot = resolve(here, 'templates');
+/**
+ * Editor APIs removed in 6.0, with what replaced them.
+ *
+ * `textStyle` is deliberately absent: it is also the name of a property
+ * on serialized Lexical text nodes, which the seed and Markdown-import
+ * templates legitimately set. Matching it here would fail on those.
+ */
+const REMOVED = [
+    {
+        pattern: /settings\.options\b/,
+        was: 'EditorSettings.options',
+        now: 'settings.mode / settings.markdownShortcuts / settings.controls / settings.debug',
+    },
+    {
+        pattern: /\bmarkdownShortcutPlugin\b/,
+        was: 'options.markdownShortcutPlugin',
+        now: 'settings.markdownShortcuts',
+    },
+    {
+        pattern: /\bshowTreeView\b/,
+        was: 'options.showTreeView',
+        now: 'settings.controls.treeView',
+    },
+    {
+        pattern: /\bfrom '@byline\/richtext-lexical'[\s\S]{0,80}\bNodes\b/,
+        was: 'the Nodes export',
+        now: 'READABLE_NODES, which is a read vocabulary rather than a registration list',
+    },
+];
+function sourceFiles(dir) {
+    const found = [];
+    for (const entry of readdirSync(dir)) {
+        const full = join(dir, entry);
+        if (statSync(full).isDirectory()) {
+            found.push(...sourceFiles(full));
+        }
+        else if (/\.tsx?$/.test(entry)) {
+            found.push(full);
+        }
+    }
+    return found;
+}
+describe('shipped templates track the editor API', () => {
+    const files = sourceFiles(templatesRoot);
+    it('finds templates to check', () => {
+        // Guards the guard: a walk that silently returns nothing would make
+        // every assertion below vacuous.
+        expect(files.length).toBeGreaterThan(20);
+    });
+    for (const { pattern, was, now } of REMOVED) {
+        it(`uses no ${was}`, () => {
+            const offenders = files
+                .filter((file) => pattern.test(readFileSync(file, 'utf8')))
+                .map((file) => file.slice(templatesRoot.length + 1));
+            expect(offenders, `${was} was removed in 6.0 — use ${now}`).toEqual([]);
+        });
+    }
+});
+//# sourceMappingURL=templates-editor-api-drift.test.js.map

package/dist/templates-editor-api-drift.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates-editor-api-drift.test.js","sourceRoot":"","sources":["../src/templates-editor-api-drift.test.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAC7D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAE7C,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;AACpD,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;AAEhD;;;;;;GAMG;AACH,MAAM,OAAO,GAAyD;IACpE;QACE,OAAO,EAAE,qBAAqB;QAC9B,GAAG,EAAE,wBAAwB;QAC7B,GAAG,EAAE,iFAAiF;KACvF;IACD;QACE,OAAO,EAAE,4BAA4B;QACrC,GAAG,EAAE,gCAAgC;QACrC,GAAG,EAAE,4BAA4B;KAClC;IACD;QACE,OAAO,EAAE,kBAAkB;QAC3B,GAAG,EAAE,sBAAsB;QAC3B,GAAG,EAAE,4BAA4B;KAClC;IACD;QACE,OAAO,EAAE,yDAAyD;QAClE,GAAG,EAAE,kBAAkB;QACvB,GAAG,EAAE,4EAA4E;KAClF;CACF,CAAA;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,MAAM,KAAK,GAAa,EAAE,CAAA;IAC1B,KAAK,MAAM,KAAK,IAAI,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QAC7B,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;YACjC,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAA;QAClC,CAAC;aAAM,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACjC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClB,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED,QAAQ,CAAC,wCAAwC,EAAE,GAAG,EAAE;IACtD,MAAM,KAAK,GAAG,WAAW,CAAC,aAAa,CAAC,CAAA;IAExC,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAClC,oEAAoE;QACpE,iCAAiC;QACjC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,EAAE,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;IAEF,KAAK,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,OAAO,EAAE,CAAC;QAC5C,EAAE,CAAC,WAAW,GAAG,EAAE,EAAE,GAAG,EAAE;YACxB,MAAM,SAAS,GAAG,KAAK;iBACpB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;iBAC1D,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAA;YAEtD,MAAM,CAAC,SAAS,EAAE,GAAG,GAAG,6BAA6B,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QACzE,CAAC,CAAC,CAAA;IACJ,CAAC;AACH,CAAC,CAAC,CAAA"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@byline/cli",
   "private": false,
   "license": "MPL-2.0",
-  "version": "5.1.4",
+  "version": "6.0.0",
   "engines": {
     "node": ">=20.9.0"
   },
@@ -48,9 +48,9 @@
     "yaml": "^2.9.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.5.12",
+    "@biomejs/biome": "2.5.13",
     "@types/mdast": "^4.0.4",
-    "@types/node": "^26.5.0",
+    "@types/node": "^26.5.1",
     "@types/pg": "^8.23.1",
     "@types/semver": "^7.8.0",
     "dotenv": "^17.4.2",
@@ -61,7 +61,7 @@
     "typescript": "^7.0.2",
     "unified": "^11.0.5",
     "vitest": "^5.0.0",
-    "@byline/core": "5.1.4"
+    "@byline/core": "6.0.0"
   },
   "publishConfig": {
     "access": "public",