@byline/admin 4.18.0 → 5.0.0

package/dist/fields/field-services-types.d.ts

@@ -1,3 +1,4 @@
+import type { StructuralMutationReceipt } from '@byline/core';
 /**
  * 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
@@ -64,6 +65,7 @@ export interface TreeAncestor {
     path?: string;
 }
 export interface PlaceTreeNodeInput {
+    expectedRevision: number;
     collection: string;
     documentId: string;
     /** The new parent; `null` makes the document a root node. */
@@ -75,12 +77,13 @@ export interface PlaceTreeNodeInput {
 /** Place / move a document within its collection's tree. */
 export type PlaceTreeNodeFn = (input: PlaceTreeNodeInput) => Promise<{
     orderKey: string;
-}>;
+} & StructuralMutationReceipt>;
 /** Remove a document from the tree (back to the unplaced state). */
 export type RemoveFromTreeFn = (input: {
     collection: string;
     documentId: string;
-}) => Promise<void>;
+    expectedRevision: number;
+}) => Promise<StructuralMutationReceipt>;
 /** Resolve a document's ancestor chain, root-first, hydrated with titles. */
 export type GetTreeAncestorsFn = (input: {
     collection: string;

package/dist/forms/available-locales-widget.d.ts

@@ -5,6 +5,7 @@ export interface AvailableLocalesWidgetLocale {
     label: string;
 }
 export interface AvailableLocalesWidgetProps {
+    disabled?: boolean;
     /** All configured content locales — one checkbox each (code + display label). */
     contentLocales: ReadonlyArray<AvailableLocalesWidgetLocale>;
     /**
@@ -26,4 +27,4 @@ export interface AvailableLocalesWidgetProps {
  * Stable override handles: `.byline-form-available-locales`,
  * `.byline-form-available-locales-list`.
  */
-export declare const AvailableLocalesWidget: ({ contentLocales, availableVersionLocales, }: AvailableLocalesWidgetProps) => import("react").JSX.Element | null;
+export declare const AvailableLocalesWidget: ({ disabled: mutationsBlocked, contentLocales, availableVersionLocales, }: AvailableLocalesWidgetProps) => import("react").JSX.Element | null;

package/dist/forms/available-locales-widget.js

@@ -7,7 +7,7 @@ import clsx from "clsx";
 import { reconcileLocaleState } from "./available-locales-reconcile.js";
 import available_locales_widget_module from "./available-locales-widget.module.js";
 import { useFormContext, useSystemAvailableLocales } from "./form-context.js";
-const AvailableLocalesWidget = ({ contentLocales, availableVersionLocales })=>{
+const AvailableLocalesWidget = ({ disabled: mutationsBlocked = false, contentLocales, availableVersionLocales })=>{
     const { t } = useTranslation('byline-admin');
     const { setSystemAvailableLocales } = useFormContext();
     const advertised = useSystemAvailableLocales();
@@ -18,6 +18,7 @@ const AvailableLocalesWidget = ({ contentLocales, availableVersionLocales })=>{
         availableVersionLocales
     ]);
     const toggle = useCallback((code, checked)=>{
+        if (mutationsBlocked) return;
         const next = new Set(advertised);
         if (checked) next.add(code);
         else next.delete(code);
@@ -25,6 +26,7 @@ const AvailableLocalesWidget = ({ contentLocales, availableVersionLocales })=>{
             ...next
         ]);
     }, [
+        mutationsBlocked,
         advertised,
         setSystemAvailableLocales
     ]);
@@ -52,7 +54,7 @@ const AvailableLocalesWidget = ({ contentLocales, availableVersionLocales })=>{
                         label: label,
                         intent: intent,
                         checked: checked,
-                        disabled: disabled,
+                        disabled: mutationsBlocked || disabled,
                         onCheckedChange: (value)=>toggle(code, true === value)
                     }, code);
                 })

package/dist/forms/document-actions.d.ts

@@ -9,7 +9,8 @@ export interface DocumentActionsLocaleOption {
     code: string;
     label: string;
 }
-export declare function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate, sourceTitle, onCopyToLocale, sourceLocale, contentLocales, hasUnsavedChanges, onUnsavedChanges, onDeleteLocale, defaultLocale, availableLocales, scheduledPublicationState, onSchedulePublication, onConfirmScheduledPublication, onCancelScheduledPublication, }: {
+export declare function DocumentActions({ disabled, publishedVersion, onUnpublish, onDelete, onDuplicate, sourceTitle, onCopyToLocale, sourceLocale, contentLocales, hasUnsavedChanges, onUnsavedChanges, onDeleteLocale, defaultLocale, availableLocales, scheduledPublicationState, onSchedulePublication, onConfirmScheduledPublication, onCancelScheduledPublication, }: {
+    disabled?: boolean;
     publishedVersion?: PublishedVersionInfo | null;
     onUnpublish?: () => Promise<void>;
     onDelete?: () => Promise<void>;

package/dist/forms/document-actions.js

@@ -6,7 +6,7 @@ import { Button, Checkbox, CloseIcon, DeleteIcon, Dropdown, EllipsisIcon, IconBu
 import clsx from "clsx";
 import document_actions_module from "./document-actions.module.js";
 const DUPLICATE_TITLE_SUFFIX = ' (copy)';
-function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate, sourceTitle, onCopyToLocale, sourceLocale, contentLocales, hasUnsavedChanges, onUnsavedChanges, onDeleteLocale, defaultLocale, availableLocales, scheduledPublicationState, onSchedulePublication, onConfirmScheduledPublication, onCancelScheduledPublication }) {
+function DocumentActions({ disabled = false, publishedVersion, onUnpublish, onDelete, onDuplicate, sourceTitle, onCopyToLocale, sourceLocale, contentLocales, hasUnsavedChanges, onUnsavedChanges, onDeleteLocale, defaultLocale, availableLocales, scheduledPublicationState, onSchedulePublication, onConfirmScheduledPublication, onCancelScheduledPublication }) {
     const { t } = useTranslation('byline-admin');
     const [showDeleteConfirm, setShowDeleteConfirm] = useState(false);
     const [showDuplicateConfirm, setShowDuplicateConfirm] = useState(false);
@@ -51,30 +51,35 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
     }
     const hasAnyAction = schedulingActions.length > 0 || copyToLocaleAvailable || deleteLocaleAvailable || null != onDuplicate || null != onDelete;
     const handleOnDelete = ()=>{
+        if (disabled) return;
         setShowDeleteConfirm(false);
-        if (onDelete) onDelete();
+        if (onDelete) onDelete().catch(()=>{});
     };
     const handleOnDuplicate = async ()=>{
+        if (disabled) return;
         if (!onDuplicate) return;
         setDuplicateBusy(true);
         try {
             await onDuplicate();
             setShowDuplicateConfirm(false);
-        } finally{
+        } catch  {} finally{
             setDuplicateBusy(false);
         }
     };
     const handleOpenDuplicate = ()=>{
+        if (disabled) return;
         if (hasUnsavedChanges) return void onUnsavedChanges?.();
         setShowDuplicateConfirm(true);
     };
     const handleOpenCopyToLocale = ()=>{
+        if (disabled) return;
         if (hasUnsavedChanges) return void onUnsavedChanges?.();
         setCopyTargetLocale(availableTargetLocales[0]?.code ?? '');
         setCopyOverwrite(false);
         setShowCopyToLocaleConfirm(true);
     };
     const handleOnCopyToLocale = async ()=>{
+        if (disabled) return;
         if (!onCopyToLocale || !copyTargetLocale) return;
         setCopyToLocaleBusy(true);
         try {
@@ -83,17 +88,19 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                 overwrite: copyOverwrite
             });
             setShowCopyToLocaleConfirm(false);
-        } finally{
+        } catch  {} finally{
             setCopyToLocaleBusy(false);
         }
     };
     const handleOpenDeleteLocale = ()=>{
+        if (disabled) return;
         if (hasUnsavedChanges) return void onUnsavedChanges?.();
         const preferred = deletableLocales.find((loc)=>loc.code === sourceLocale)?.code;
         setDeleteTargetLocale(preferred ?? deletableLocales[0]?.code ?? '');
         setShowDeleteLocaleConfirm(true);
     };
     const handleOnDeleteLocale = async ()=>{
+        if (disabled) return;
         if (!onDeleteLocale || !deleteTargetLocale) return;
         setDeleteLocaleBusy(true);
         try {
@@ -101,7 +108,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                 targetLocale: deleteTargetLocale
             });
             setShowDeleteLocaleConfirm(false);
-        } finally{
+        } catch  {} finally{
             setDeleteLocaleBusy(false);
         }
     };
@@ -113,6 +120,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
             hasAnyAction && /*#__PURE__*/ jsxs(Dropdown.Root, {
                 children: [
                     /*#__PURE__*/ jsx(Dropdown.Trigger, {
+                        disabled: disabled,
                         render: /*#__PURE__*/ jsx(IconButton, {
                             variant: "text",
                             intent: "noeffect",
@@ -134,6 +142,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                 schedulingActions.length > 0 && /*#__PURE__*/ jsxs(Fragment, {
                                     children: [
                                         schedulingActions.map((action)=>/*#__PURE__*/ jsx(Dropdown.Item, {
+                                                disabled: disabled,
                                                 onClick: action.onSelect,
                                                 children: /*#__PURE__*/ jsx("div", {
                                                     className: clsx('byline-form-actions-item', document_actions_module.item),
@@ -141,6 +150,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                                         className: clsx('byline-form-actions-item-text', document_actions_module["item-text"]),
                                                         children: /*#__PURE__*/ jsx("button", {
                                                             type: "button",
+                                                            disabled: disabled,
                                                             children: action.label
                                                         })
                                                     })
@@ -150,6 +160,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                     ]
                                 }),
                                 copyToLocaleAvailable && /*#__PURE__*/ jsx(Dropdown.Item, {
+                                    disabled: disabled,
                                     onClick: handleOpenCopyToLocale,
                                     children: /*#__PURE__*/ jsx("div", {
                                         className: clsx('byline-form-actions-item', document_actions_module.item),
@@ -157,12 +168,14 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                             className: clsx('byline-form-actions-item-text', document_actions_module["item-text"]),
                                             children: /*#__PURE__*/ jsx("button", {
                                                 type: "button",
+                                                disabled: disabled,
                                                 children: t('documentActions.copyToLocaleMenuItem')
                                             })
                                         })
                                     })
                                 }),
                                 deleteLocaleAvailable && /*#__PURE__*/ jsx(Dropdown.Item, {
+                                    disabled: disabled,
                                     onClick: handleOpenDeleteLocale,
                                     children: /*#__PURE__*/ jsx("div", {
                                         className: clsx('byline-form-actions-item', document_actions_module.item),
@@ -170,12 +183,14 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                             className: clsx('byline-form-actions-item-text', document_actions_module["item-text"]),
                                             children: /*#__PURE__*/ jsx("button", {
                                                 type: "button",
+                                                disabled: disabled,
                                                 children: t('documentActions.deleteLocale.menuItem')
                                             })
                                         })
                                     })
                                 }),
                                 onDuplicate && /*#__PURE__*/ jsx(Dropdown.Item, {
+                                    disabled: disabled,
                                     onClick: handleOpenDuplicate,
                                     children: /*#__PURE__*/ jsx("div", {
                                         className: clsx('byline-form-actions-item', document_actions_module.item),
@@ -183,6 +198,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                             className: clsx('byline-form-actions-item-text', document_actions_module["item-text"]),
                                             children: /*#__PURE__*/ jsx("button", {
                                                 type: "button",
+                                                disabled: disabled,
                                                 children: t('common.actions.duplicate')
                                             })
                                         })
@@ -192,6 +208,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                     children: [
                                         /*#__PURE__*/ jsx(Dropdown.Separator, {}),
                                         /*#__PURE__*/ jsx(Dropdown.Item, {
+                                            disabled: disabled,
                                             onClick: ()=>{
                                                 setShowDeleteConfirm(true);
                                             },
@@ -286,6 +303,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                         minWidth: '80px'
                                     },
                                     intent: "danger",
+                                    disabled: disabled,
                                     onClick: handleOnDelete,
                                     children: t('common.actions.delete')
                                 })
@@ -397,7 +415,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                     onClick: ()=>{
                                         if (!duplicateBusy) setShowDuplicateConfirm(false);
                                     },
-                                    disabled: duplicateBusy,
+                                    disabled: disabled || duplicateBusy,
                                     children: t('common.actions.cancel')
                                 }),
                                 /*#__PURE__*/ jsx(Button, {
@@ -407,7 +425,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                     },
                                     intent: "primary",
                                     onClick: handleOnDuplicate,
-                                    disabled: duplicateBusy,
+                                    disabled: disabled || duplicateBusy,
                                     children: duplicateBusy ? t('documentActions.duplicate.busyButton') : t('common.actions.duplicate')
                                 })
                             ]
@@ -499,7 +517,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                             onValueChange: (value)=>{
                                                 if (null != value) setCopyTargetLocale(value);
                                             },
-                                            disabled: copyToLocaleBusy
+                                            disabled: disabled || copyToLocaleBusy
                                         })
                                     ]
                                 }),
@@ -513,7 +531,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                         name: "overwrite",
                                         label: t('documentActions.copyToLocale.overwriteLabel'),
                                         checked: copyOverwrite,
-                                        disabled: copyToLocaleBusy,
+                                        disabled: disabled || copyToLocaleBusy,
                                         helpText: t('documentActions.copyToLocale.overwriteHelp'),
                                         onCheckedChange: (value)=>{
                                             setCopyOverwrite(true === value);
@@ -540,7 +558,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                     onClick: ()=>{
                                         if (!copyToLocaleBusy) setShowCopyToLocaleConfirm(false);
                                     },
-                                    disabled: copyToLocaleBusy,
+                                    disabled: disabled || copyToLocaleBusy,
                                     children: t('common.actions.cancel')
                                 }),
                                 /*#__PURE__*/ jsx(Button, {
@@ -550,7 +568,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                     },
                                     intent: "primary",
                                     onClick: handleOnCopyToLocale,
-                                    disabled: copyToLocaleBusy || !copyTargetLocale,
+                                    disabled: disabled || copyToLocaleBusy || !copyTargetLocale,
                                     children: copyToLocaleBusy ? t('documentActions.copyToLocale.busyButton') : t('documentActions.copyToLocale.confirmButton')
                                 })
                             ]
@@ -620,7 +638,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                             onValueChange: (value)=>{
                                                 if (null != value) setDeleteTargetLocale(value);
                                             },
-                                            disabled: deleteLocaleBusy
+                                            disabled: disabled || deleteLocaleBusy
                                         })
                                     ]
                                 }),
@@ -650,7 +668,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                     onClick: ()=>{
                                         if (!deleteLocaleBusy) setShowDeleteLocaleConfirm(false);
                                     },
-                                    disabled: deleteLocaleBusy,
+                                    disabled: disabled || deleteLocaleBusy,
                                     children: t('common.actions.cancel')
                                 }),
                                 /*#__PURE__*/ jsx(Button, {
@@ -660,7 +678,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                     },
                                     intent: "danger",
                                     onClick: handleOnDeleteLocale,
-                                    disabled: deleteLocaleBusy || !deleteTargetLocale,
+                                    disabled: disabled || deleteLocaleBusy || !deleteTargetLocale,
                                     children: deleteLocaleBusy ? t('documentActions.deleteLocale.busyButton') : t('documentActions.deleteLocale.confirmButton')
                                 })
                             ]

package/dist/forms/form-renderer.d.ts

@@ -37,6 +37,15 @@ export interface SystemFieldsSubmitPayload {
 }
 /** Props shared by both the public FormRenderer and its internal FormContent component. */
 export interface FormRendererProps {
+    mutationIssue?: 'stale' | 'reload' | 'lock' | 'unavailable' | 'committed' | null;
+    mutationsBlocked?: boolean;
+    observedRevision?: number;
+    onMutationError?: (error: unknown) => 'blocked' | 'committed' | null | void;
+    onTreeMutationCommitted?: (receipt: import('@byline/core').StructuralMutationReceipt) => void;
+    scheduledPublicationsNeedReconfirmation?: boolean;
+    scheduledPublicationsHref?: string;
+    /** Explicit discard action; defaults to a complete server reload. */
+    onReloadDocument?: () => void | Promise<void>;
     mode: 'create' | 'edit';
     fields: Field[];
     onSubmit: (data: any) => void | Promise<void>;