@byline/admin 4.14.1 → 4.15.0

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

@@ -1,4 +1,5 @@
 import type { PublishedVersionInfo } from './form-renderer';
+import type { ScheduledPublicationState } from './scheduled-publication-state.js';
 /**
  * Shape of a content-locale option as consumed by the Copy-to-Locale
  * modal. Matches the host adapter's `ContentLocaleOption`; declared
@@ -8,7 +9,7 @@ export interface DocumentActionsLocaleOption {
     code: string;
     label: string;
 }
-export declare function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate, sourceTitle, onCopyToLocale, sourceLocale, contentLocales, hasUnsavedChanges, onUnsavedChanges, onDeleteLocale, defaultLocale, availableLocales, }: {
+export declare function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate, sourceTitle, onCopyToLocale, sourceLocale, contentLocales, hasUnsavedChanges, onUnsavedChanges, onDeleteLocale, defaultLocale, availableLocales, scheduledPublicationState, onSchedulePublication, onConfirmScheduledPublication, onCancelScheduledPublication, }: {
     publishedVersion?: PublishedVersionInfo | null;
     onUnpublish?: () => Promise<void>;
     onDelete?: () => Promise<void>;
@@ -78,4 +79,18 @@ export declare function DocumentActions({ publishedVersion, onUnpublish, onDelet
      * minus the default locale and the `'all'` sentinel.
      */
     availableLocales?: string[];
+    /**
+     * Derived presentation state for the document's pending publication
+     * schedule. Decides which of the scheduling menu items appear; omit it (or
+     * pass a `none` state with no capabilities) and the group is hidden
+     * entirely — which is what an ineligible document, a single-status
+     * workflow, or an actor missing either ability all reduce to.
+     */
+    scheduledPublicationState?: ScheduledPublicationState;
+    /** Opens the schedule / reschedule modal. Save-gated by the caller. */
+    onSchedulePublication?: () => void;
+    /** Re-confirms a suspended schedule against the current version. Save-gated by the caller. */
+    onConfirmScheduledPublication?: () => void | Promise<void>;
+    /** Withdraws the pending schedule. Deliberately not save-gated. */
+    onCancelScheduledPublication?: () => void | Promise<void>;
 }): import("react").JSX.Element;

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 }) {
+function DocumentActions({ 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);
@@ -25,6 +25,30 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
     const [showDeleteLocaleConfirm, setShowDeleteLocaleConfirm] = useState(false);
     const [deleteLocaleBusy, setDeleteLocaleBusy] = useState(false);
     const [deleteTargetLocale, setDeleteTargetLocale] = useState('');
+    const scheduling = scheduledPublicationState;
+    const schedulingActions = [];
+    if (null != scheduling) {
+        if (scheduling.actions.schedule && null != onSchedulePublication) schedulingActions.push({
+            key: 'schedule',
+            label: t('scheduledPublication.actions.scheduleMenuItem'),
+            onSelect: onSchedulePublication
+        });
+        if (scheduling.actions.confirm && null != onConfirmScheduledPublication) schedulingActions.push({
+            key: 'confirm',
+            label: t('scheduledPublication.actions.confirm'),
+            onSelect: ()=>void onConfirmScheduledPublication()
+        });
+        if (scheduling.actions.reschedule && null != onSchedulePublication) schedulingActions.push({
+            key: 'reschedule',
+            label: t('scheduledPublication.actions.reschedule'),
+            onSelect: onSchedulePublication
+        });
+        if (scheduling.actions.cancel && null != onCancelScheduledPublication) schedulingActions.push({
+            key: 'cancel',
+            label: t('scheduledPublication.actions.cancel'),
+            onSelect: ()=>void onCancelScheduledPublication()
+        });
+    }
     const handleOnDelete = ()=>{
         setShowDeleteConfirm(false);
         if (onDelete) onDelete();
@@ -106,6 +130,24 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                             "data-side": "top",
                             sideOffset: 10,
                             children: [
+                                schedulingActions.length > 0 && /*#__PURE__*/ jsxs(Fragment, {
+                                    children: [
+                                        schedulingActions.map((action)=>/*#__PURE__*/ jsx(Dropdown.Item, {
+                                                onClick: action.onSelect,
+                                                children: /*#__PURE__*/ jsx("div", {
+                                                    className: clsx('byline-form-actions-item', document_actions_module.item),
+                                                    children: /*#__PURE__*/ jsx("span", {
+                                                        className: clsx('byline-form-actions-item-text', document_actions_module["item-text"]),
+                                                        children: /*#__PURE__*/ jsx("button", {
+                                                            type: "button",
+                                                            children: action.label
+                                                        })
+                                                    })
+                                                })
+                                            }, action.key)),
+                                        /*#__PURE__*/ jsx(Dropdown.Separator, {})
+                                    ]
+                                }),
                                 copyToLocaleAvailable && /*#__PURE__*/ jsx(Dropdown.Item, {
                                     onClick: handleOpenCopyToLocale,
                                     children: /*#__PURE__*/ jsx("div", {

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

@@ -9,6 +9,7 @@ import { type ReactNode } from 'react';
 import type { CollectionAdminConfig, Field, WorkflowStatus } from '@byline/core';
 import type { DocumentPatch } from '@byline/core/patches';
 import { type DocumentActionsLocaleOption } from './document-actions';
+import { type ScheduledPublicationInfo, type SchedulePublicationInput } from './scheduled-publication-control';
 import type { UseNavigationGuard } from './navigation-guard';
 /** Metadata about a previously published version that is still live. */
 export interface PublishedVersionInfo {
@@ -42,6 +43,10 @@ export interface FormRendererProps {
     onCancel: () => void;
     onStatusChange?: (nextStatus: string) => Promise<void>;
     onUnpublish?: () => Promise<void>;
+    scheduledPublication?: ScheduledPublicationInfo | null;
+    onSchedulePublication?: (input: SchedulePublicationInput) => Promise<void>;
+    onConfirmScheduledPublication?: () => Promise<void>;
+    onCancelScheduledPublication?: () => Promise<void>;
     onDelete?: () => Promise<void>;
     /**
      * Called when the editor confirms the duplicate modal in
@@ -136,4 +141,4 @@ export interface FormRendererProps {
      */
     useNavigationGuard?: UseNavigationGuard;
 }
-export declare const FormRenderer: ({ mode, fields, onSubmit, onCancel, onStatusChange, onUnpublish, onDelete, onDuplicate, onCopyToLocale, onDeleteLocale, contentLocales, nextStatus, workflowStatuses, publishedVersion, initialData, adminConfig, useAsTitle, useAsPath, advertiseLocales, tree, headingLabel, headerSlot, collectionPath, initialLocale, onLocaleChange, defaultLocale, useNavigationGuard, restoreWarnings, }: FormRendererProps) => import("react").JSX.Element;
+export declare const FormRenderer: (props: FormRendererProps) => import("react").JSX.Element;

package/dist/forms/form-renderer.js

@@ -19,11 +19,12 @@ import form_renderer_module from "./form-renderer.module.js";
 import { FormStatusDisplay } from "./form-status-display.js";
 import { useNavigationGuardAdapter } from "./navigation-guard.js";
 import { PathWidget } from "./path-widget.js";
+import { ScheduledPublicationCell, ScheduledPublicationNotice, useScheduledPublication } from "./scheduled-publication-control.js";
 import { computeStatusTransitions } from "./status-transitions.js";
 import { TreePlacementWidget } from "./tree-placement-widget.js";
 import { executeUploadsWithProgress } from "./upload-executor.js";
 import { useFormLayout } from "./use-form-layout.js";
-const FormContent = ({ mode, fields, onSubmit, onCancel, onStatusChange, onUnpublish, onDelete, onDuplicate, onCopyToLocale, onDeleteLocale, contentLocales, nextStatus, workflowStatuses, publishedVersion, initialData, adminConfig, useAsTitle, useAsPath, advertiseLocales, tree, headingLabel, headerSlot, collectionPath, initialLocale, onLocaleChange, defaultLocale = 'en', useNavigationGuard: useNavigationGuardProp, restoreWarnings, _activeTabBySet, _onTabChange })=>{
+const FormContent = ({ mode, fields, onSubmit, onCancel, onStatusChange, onUnpublish, scheduledPublication, onSchedulePublication, onConfirmScheduledPublication, onCancelScheduledPublication, onDelete, onDuplicate, onCopyToLocale, onDeleteLocale, contentLocales, nextStatus, workflowStatuses, publishedVersion, initialData, adminConfig, useAsTitle, useAsPath, advertiseLocales, tree, headingLabel, headerSlot, collectionPath, initialLocale, onLocaleChange, defaultLocale = 'en', useNavigationGuard: useNavigationGuardProp, restoreWarnings, _activeTabBySet, _onTabChange })=>{
     const { getFieldValues, runFieldHooks, validateForm, errors: initialErrors, hasChanges: hasChangesFn, resetHasChanges, getPatches, getDirtyBreakdown, getSystemPath, getSystemAvailableLocales, subscribeErrors, subscribeMeta, setFieldValue, setFieldError, getPendingUploads, clearPendingUploads, setFieldUploading } = useFormContext();
     const { t } = useTranslation('byline-admin');
     const [errors, setErrors] = useState(initialErrors);
@@ -33,6 +34,14 @@ const FormContent = ({ mode, fields, onSubmit, onCancel, onStatusChange, onUnpub
     const [showUnsavedModal, setShowUnsavedModal] = useState(false);
     const [pendingSystemFieldsSubmit, setPendingSystemFieldsSubmit] = useState(null);
     const [contentLocale, setContentLocale] = useState(initialLocale ?? defaultLocale);
+    const scheduling = useScheduledPublication({
+        schedule: scheduledPublication ?? null,
+        onSchedule: onSchedulePublication,
+        onConfirm: onConfirmScheduledPublication,
+        onCancel: onCancelScheduledPublication,
+        hasUnsavedChanges: hasChanges,
+        onUnsavedChanges: ()=>setShowUnsavedModal(true)
+    });
     const { uploadField } = useBylineFieldServices();
     const pathSlugifier = getAdminConfig().slugifier;
     const pathSourceLocked = useMemo(()=>{
@@ -248,11 +257,18 @@ const FormContent = ({ mode, fields, onSubmit, onCancel, onStatusChange, onUnpub
             /*#__PURE__*/ jsxs("div", {
                 className: clsx('byline-form-status-bar', form_renderer_module["status-bar"]),
                 children: [
-                    /*#__PURE__*/ jsx(FormStatusDisplay, {
-                        initialData: initialData,
-                        workflowStatuses: workflowStatuses,
-                        publishedVersion: publishedVersion,
-                        onUnpublish: onUnpublish
+                    /*#__PURE__*/ jsx("div", {
+                        className: clsx('byline-form-status-details', form_renderer_module["status-details"]),
+                        children: /*#__PURE__*/ jsx(FormStatusDisplay, {
+                            initialData: initialData,
+                            workflowStatuses: workflowStatuses,
+                            publishedVersion: publishedVersion,
+                            onUnpublish: onUnpublish,
+                            afterStatusCells: /*#__PURE__*/ jsx(ScheduledPublicationCell, {
+                                state: scheduling.state,
+                                timeZone: scheduling.timeZone
+                            })
+                        })
                     }),
                     /*#__PURE__*/ jsxs("div", {
                         className: clsx('byline-form-actions', form_renderer_module.actions),
@@ -322,12 +338,25 @@ const FormContent = ({ mode, fields, onSubmit, onCancel, onStatusChange, onUnpub
                                 onUnsavedChanges: ()=>setShowUnsavedModal(true),
                                 onDeleteLocale: onDeleteLocale,
                                 defaultLocale: defaultLocale,
-                                availableLocales: initialData?._availableVersionLocales
+                                availableLocales: initialData?._availableVersionLocales,
+                                scheduledPublicationState: scheduling.state,
+                                onSchedulePublication: scheduling.openSchedule,
+                                onConfirmScheduledPublication: scheduling.confirm,
+                                onCancelScheduledPublication: scheduling.cancel
                             })
                         ]
                     })
                 ]
             }),
+            /*#__PURE__*/ jsx(ScheduledPublicationNotice, {
+                state: scheduling.state,
+                timeZone: scheduling.timeZone,
+                busy: scheduling.busy,
+                onConfirm: scheduling.confirm,
+                onReschedule: scheduling.openSchedule,
+                onCancel: scheduling.cancel
+            }),
+            scheduling.modal,
             restoreWarnings && restoreWarnings.length > 0 && /*#__PURE__*/ jsxs(Alert, {
                 className: "m-0 mt-4",
                 intent: "warning",
@@ -401,41 +430,15 @@ const FormContent = ({ mode, fields, onSubmit, onCancel, onStatusChange, onUnpub
         ]
     });
 };
-const FormRenderer = ({ mode, fields, onSubmit, onCancel, onStatusChange, onUnpublish, onDelete, onDuplicate, onCopyToLocale, onDeleteLocale, contentLocales, nextStatus, workflowStatuses, publishedVersion, initialData, adminConfig, useAsTitle, useAsPath, advertiseLocales, tree, headingLabel, headerSlot, collectionPath, initialLocale, onLocaleChange, defaultLocale, useNavigationGuard, restoreWarnings })=>{
+const FormRenderer = (props)=>{
+    const { mode, initialData, initialLocale, collectionPath } = props;
     const savedTabsRef = useRef({});
     return /*#__PURE__*/ jsx(FormProvider, {
         initialData: initialData,
         documentId: 'edit' === mode && 'string' == typeof initialData?.id ? initialData.id : null,
         collectionPath: collectionPath ?? null,
         children: /*#__PURE__*/ jsx(FormContent, {
-            mode: mode,
-            fields: fields,
-            onSubmit: onSubmit,
-            onCancel: onCancel,
-            onStatusChange: onStatusChange,
-            onUnpublish: onUnpublish,
-            onDelete: onDelete,
-            onDuplicate: onDuplicate,
-            onCopyToLocale: onCopyToLocale,
-            onDeleteLocale: onDeleteLocale,
-            contentLocales: contentLocales,
-            nextStatus: nextStatus,
-            workflowStatuses: workflowStatuses,
-            publishedVersion: publishedVersion,
-            initialData: initialData,
-            adminConfig: adminConfig,
-            useAsTitle: useAsTitle,
-            useAsPath: useAsPath,
-            advertiseLocales: advertiseLocales,
-            tree: tree,
-            headingLabel: headingLabel,
-            headerSlot: headerSlot,
-            collectionPath: collectionPath,
-            initialLocale: initialLocale,
-            onLocaleChange: onLocaleChange,
-            defaultLocale: defaultLocale,
-            useNavigationGuard: useNavigationGuard,
-            restoreWarnings: restoreWarnings,
+            ...props,
             _activeTabBySet: savedTabsRef.current,
             _onTabChange: (tabSetName, tabName)=>{
                 savedTabsRef.current = {

package/dist/forms/form-renderer.module.js

@@ -7,6 +7,8 @@ const form_renderer_module = {
     "status-bar": "status-bar-kQCXLT",
     statusBar: "status-bar-kQCXLT",
     status: "status-XbhkJR",
+    "status-details": "status-details-lv5FA6",
+    statusDetails: "status-details-lv5FA6",
     "status-meta": "status-meta-gppNXX",
     statusMeta: "status-meta-gppNXX",
     "status-cell": "status-cell-Tr3QHl",

package/dist/forms/form-renderer_module.css

@@ -57,6 +57,10 @@
   display: flex;
 }
 
+:is(.status-details-lv5FA6, .byline-form-status-details) {
+  min-width: 0;
+}
+
 :is(.status-meta-gppNXX, .byline-form-status-meta) {
   flex-direction: column;
   font-size: .8rem;
@@ -73,8 +77,9 @@
 
 @media (min-width: 66rem) {
   :is(.status-meta-gppNXX, .byline-form-status-meta) {
-    flex-direction: row;
+    flex-flow: wrap;
     align-items: center;
+    row-gap: .35rem;
   }
 }
 
@@ -85,6 +90,7 @@
 }
 
 :is(.status-cell-Tr3QHl, .byline-form-status-cell) {
+  flex-wrap: wrap;
   align-items: center;
   gap: .25rem;
   min-width: 0;

package/dist/forms/form-status-display.d.ts

@@ -13,9 +13,18 @@ import type { PublishedVersionInfo } from './form-renderer';
  * created timestamps, and a "published live" indicator with an inline
  * Unpublish action when a previously-published version is still live.
  */
-export declare const FormStatusDisplay: ({ initialData, workflowStatuses, publishedVersion, onUnpublish, }: {
+export declare const FormStatusDisplay: ({ initialData, workflowStatuses, publishedVersion, onUnpublish, afterStatusCells, }: {
     initialData?: Record<string, any>;
     workflowStatuses?: WorkflowStatus[];
     publishedVersion?: PublishedVersionInfo | null;
     onUnpublish?: () => Promise<void>;
+    /**
+     * Rendered inside the status cell, directly after the status value, so it
+     * reads as a continuation of the same sentence: "Status: Draft — Scheduled
+     * for …". Scheduled publication uses this because an armed schedule is a
+     * statement about the document's lifecycle, not a timestamp to file beside
+     * Created. Falls back to standing alone when the workflow is single-status
+     * and no status cell is drawn.
+     */
+    afterStatusCells?: React.ReactNode;
 }) => import("react").JSX.Element;

package/dist/forms/form-status-display.js

@@ -4,7 +4,7 @@ import { useTranslation } from "@byline/i18n/react";
 import clsx from "clsx";
 import { LocalDateTime } from "../fields/local-date-time.js";
 import form_renderer_module from "./form-renderer.module.js";
-const FormStatusDisplay = ({ initialData, workflowStatuses, publishedVersion, onUnpublish })=>{
+const FormStatusDisplay = ({ initialData, workflowStatuses, publishedVersion, onUnpublish, afterStatusCells })=>{
     const { t } = useTranslation('byline-admin');
     const statusCode = initialData?.status;
     const statusLabel = workflowStatuses?.find((s)=>s.name === statusCode)?.label ?? statusCode;
@@ -25,9 +25,11 @@ const FormStatusDisplay = ({ initialData, workflowStatuses, publishedVersion, on
                             /*#__PURE__*/ jsx("span", {
                                 className: clsx('byline-form-status-trunc', form_renderer_module["status-trunc"]),
                                 children: statusLabel
-                            })
+                            }),
+                            afterStatusCells
                         ]
                     }),
+                    !showStatusCell && afterStatusCells,
                     initialData?.updatedAt != null && /*#__PURE__*/ jsxs("div", {
                         className: clsx('byline-form-status-cell', form_renderer_module["status-cell"]),
                         children: [

package/dist/forms/scheduled-publication-control.d.ts

@@ -0,0 +1,56 @@
+import type { ScheduledPublicationState } from './scheduled-publication-state.js';
+export type { ScheduledPublicationInfo } from './scheduled-publication-state.js';
+import type { ScheduledPublicationInfo } from './scheduled-publication-state.js';
+export interface SchedulePublicationInput {
+    publishAt: string;
+}
+export interface UseScheduledPublicationArgs {
+    schedule: ScheduledPublicationInfo | null;
+    onSchedule?: (input: SchedulePublicationInput) => Promise<void>;
+    onConfirm?: () => Promise<void>;
+    onCancel?: () => Promise<void>;
+    hasUnsavedChanges: boolean;
+    onUnsavedChanges: () => void;
+}
+export interface UseScheduledPublicationReturn {
+    state: ScheduledPublicationState;
+    timeZone: string;
+    busy: boolean;
+    /** True when any surface has something to render for this document. */
+    isActive: boolean;
+    openSchedule: () => void;
+    confirm: () => Promise<void>;
+    cancel: () => Promise<void>;
+    /** The schedule / reschedule modal. Render once, anywhere in the form. */
+    modal: React.ReactNode;
+}
+export declare function useScheduledPublication({ schedule, onSchedule, onConfirm, onCancel, hasUnsavedChanges, onUnsavedChanges, }: UseScheduledPublicationArgs): UseScheduledPublicationReturn;
+/**
+ * One metadata cell for the form's status bar, matching the Status /
+ * Last modified / Created cells in scale, sitting immediately after the status
+ * cell — an armed schedule says where the document is headed, which continues
+ * what Status says about it rather than belonging with the timestamps.
+ *
+ * Written as a single phrase in the success colour rather than the label/value
+ * pair its neighbours use: it is the one cell reporting something pending
+ * rather than something already true, and it should read that way at a glance.
+ * Only an armed schedule appears here; every other state is carried by the
+ * notice instead, so the two never say the same thing twice.
+ */
+export declare function ScheduledPublicationCell({ state, timeZone, }: {
+    state: ScheduledPublicationState;
+    timeZone: string;
+}): import("react").JSX.Element | null;
+/**
+ * The durable notice for a suspended, overdue or failing schedule. Not
+ * dismissible: `needs_reconfirm` has to stay on screen until an editor acts on
+ * it, long after the toast that announced the suspension has gone.
+ */
+export declare function ScheduledPublicationNotice({ state, timeZone, busy, onConfirm, onReschedule, onCancel, }: {
+    state: ScheduledPublicationState;
+    timeZone: string;
+    busy: boolean;
+    onConfirm: () => void;
+    onReschedule: () => void;
+    onCancel: () => void;
+}): import("react").JSX.Element | null;