@byline/admin 4.15.0 → 4.17.0

package/dist/abilities.js

@@ -2,10 +2,12 @@ import { registerAdminActivityAbilities } from "./modules/admin-activity/abiliti
 import { registerAdminPermissionsAbilities } from "./modules/admin-permissions/abilities.js";
 import { registerAdminRolesAbilities } from "./modules/admin-roles/abilities.js";
 import { registerAdminUsersAbilities } from "./modules/admin-users/abilities.js";
+import { registerAnalyticsAbilities } from "./modules/analytics/abilities.js";
 function registerAdminAbilities(registry) {
     registerAdminUsersAbilities(registry);
     registerAdminRolesAbilities(registry);
     registerAdminPermissionsAbilities(registry);
     registerAdminActivityAbilities(registry);
+    registerAnalyticsAbilities(registry);
 }
 export { registerAdminAbilities };

package/dist/fields/relation/relation-field.js

@@ -1,6 +1,6 @@
 import { jsx, jsxs } from "react/jsx-runtime";
 import { useState } from "react";
-import { getCollectionAdminConfig, getCollectionDefinition } from "@byline/core";
+import { getCollectionAdminConfig, getCollectionDefinition, isSingleton } from "@byline/core";
 import { useTranslation } from "@byline/i18n/react";
 import { Button, CloseIcon, EditIcon, ErrorText, HelpText, IconButton, Label } from "@byline/ui/react";
 import clsx from "clsx";
@@ -14,7 +14,8 @@ const RelationField = ({ field, value, defaultValue, onChange, id, path })=>{
     const fieldError = useFieldError(fieldPath);
     const fieldValue = useFieldValue(fieldPath);
     const incomingValue = void 0 !== fieldValue ? fieldValue ?? null : value ?? defaultValue ?? null;
-    const targetDef = getCollectionDefinition(field.targetCollection);
+    const targetDefinition = getCollectionDefinition(field.targetCollection);
+    const targetDef = null == targetDefinition || isSingleton(targetDefinition) ? null : targetDefinition;
     const targetAdminConfig = getCollectionAdminConfig(field.targetCollection);
     const { t } = useTranslation('byline-admin');
     const [pickerOpen, setPickerOpen] = useState(false);

package/dist/fields/relation/relation-many-field.js

@@ -1,6 +1,6 @@
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
 import { useState } from "react";
-import { getCollectionAdminConfig, getCollectionDefinition } from "@byline/core";
+import { getCollectionAdminConfig, getCollectionDefinition, isSingleton } from "@byline/core";
 import { useTranslation } from "@byline/i18n/react";
 import { Button, CloseIcon, DraggableSortable, ErrorText, GripperVerticalIcon, HelpText, IconButton, Label, PlusIcon, moveItem, useSortable } from "@byline/ui/react";
 import clsx from "clsx";
@@ -61,7 +61,8 @@ const RelationManyField = ({ field, defaultValue, id, path })=>{
     const { t } = useTranslation('byline-admin');
     const fieldError = useFieldError(fieldPath);
     const { getFieldValue, setFieldValue } = useFormContext();
-    const targetDef = getCollectionDefinition(field.targetCollection);
+    const targetDefinition = getCollectionDefinition(field.targetCollection);
+    const targetDef = null == targetDefinition || isSingleton(targetDefinition) ? null : targetDefinition;
     const targetAdminConfig = getCollectionAdminConfig(field.targetCollection);
     const isUnknown = null == targetDef;
     const targetLabel = targetDef?.labels.singular ?? field.targetCollection;

package/dist/fields/relation/relation-picker.d.ts

@@ -5,7 +5,7 @@
  *
  * Copyright (c) Infonomic Company Limited
  */
-import type { CollectionDefinition } from '@byline/core';
+import type { MultiCollectionDefinition } from '@byline/core';
 /**
  * Row rendering strategy, in priority order:
  *   1. `CollectionAdminConfig.itemView` — a ColumnDefinition[] from the target
@@ -35,7 +35,7 @@ interface RelationPickerBaseProps {
     /** The target collection path (e.g. `'media'`). */
     targetCollectionPath: string;
     /** The target collection definition (used for labels + displayField fallback). */
-    targetDefinition?: CollectionDefinition | null;
+    targetDefinition?: MultiCollectionDefinition | null;
     /** Explicit display field to render as row label. */
     displayField?: string;
     /**

package/dist/fields/relation/relation-summary.d.ts

@@ -5,9 +5,9 @@
  *
  * Copyright (c) Infonomic Company Limited
  */
-import type { CollectionAdminConfig, CollectionDefinition } from '@byline/core';
+import type { CollectionAdminConfig, MultiCollectionDefinition } from '@byline/core';
 interface RelationSummaryProps {
-    targetDefinition: CollectionDefinition;
+    targetDefinition: MultiCollectionDefinition;
     targetAdminConfig: CollectionAdminConfig | null;
     displayField?: string;
     /** The raw relation value from the form. May be a plain ref or a populated envelope. */

package/dist/forms/document-actions.js

@@ -49,6 +49,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
             onSelect: ()=>void onCancelScheduledPublication()
         });
     }
+    const hasAnyAction = schedulingActions.length > 0 || copyToLocaleAvailable || deleteLocaleAvailable || null != onDuplicate || null != onDelete;
     const handleOnDelete = ()=>{
         setShowDeleteConfirm(false);
         if (onDelete) onDelete();
@@ -109,7 +110,7 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
     const sourceLocaleLabel = contentLocales?.find((loc)=>loc.code === sourceLocale)?.label ?? sourceLocale ?? '';
     return /*#__PURE__*/ jsxs(Fragment, {
         children: [
-            /*#__PURE__*/ jsxs(Dropdown.Root, {
+            hasAnyAction && /*#__PURE__*/ jsxs(Dropdown.Root, {
                 children: [
                     /*#__PURE__*/ jsx(Dropdown.Trigger, {
                         render: /*#__PURE__*/ jsx(IconButton, {
@@ -187,31 +188,35 @@ function DocumentActions({ publishedVersion, onUnpublish, onDelete, onDuplicate,
                                         })
                                     })
                                 }),
-                                /*#__PURE__*/ jsx(Dropdown.Separator, {}),
-                                /*#__PURE__*/ jsx(Dropdown.Item, {
-                                    onClick: ()=>{
-                                        setShowDeleteConfirm(true);
-                                    },
-                                    children: /*#__PURE__*/ jsxs("div", {
-                                        className: clsx('byline-form-actions-item', document_actions_module.item),
-                                        children: [
-                                            /*#__PURE__*/ jsx("span", {
-                                                className: clsx('byline-form-actions-item-icon', document_actions_module["item-icon"]),
-                                                children: /*#__PURE__*/ jsx(DeleteIcon, {
-                                                    width: "16px",
-                                                    height: "16px"
-                                                })
-                                            }),
-                                            /*#__PURE__*/ jsx("span", {
-                                                className: clsx('byline-form-actions-item-text', document_actions_module["item-text"]),
-                                                children: /*#__PURE__*/ jsx("button", {
-                                                    type: "button",
-                                                    className: clsx('byline-form-actions-delete', document_actions_module["delete"]),
-                                                    children: t('common.actions.delete')
-                                                })
+                                onDelete && /*#__PURE__*/ jsxs(Fragment, {
+                                    children: [
+                                        /*#__PURE__*/ jsx(Dropdown.Separator, {}),
+                                        /*#__PURE__*/ jsx(Dropdown.Item, {
+                                            onClick: ()=>{
+                                                setShowDeleteConfirm(true);
+                                            },
+                                            children: /*#__PURE__*/ jsxs("div", {
+                                                className: clsx('byline-form-actions-item', document_actions_module.item),
+                                                children: [
+                                                    /*#__PURE__*/ jsx("span", {
+                                                        className: clsx('byline-form-actions-item-icon', document_actions_module["item-icon"]),
+                                                        children: /*#__PURE__*/ jsx(DeleteIcon, {
+                                                            width: "16px",
+                                                            height: "16px"
+                                                        })
+                                                    }),
+                                                    /*#__PURE__*/ jsx("span", {
+                                                        className: clsx('byline-form-actions-item-text', document_actions_module["item-text"]),
+                                                        children: /*#__PURE__*/ jsx("button", {
+                                                            type: "button",
+                                                            className: clsx('byline-form-actions-delete', document_actions_module["delete"]),
+                                                            children: t('common.actions.delete')
+                                                        })
+                                                    })
+                                                ]
                                             })
-                                        ]
-                                    })
+                                        })
+                                    ]
                                 })
                             ]
                         })

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

@@ -6,7 +6,7 @@
  * Copyright (c) Infonomic Company Limited
  */
 import { type ReactNode } from 'react';
-import type { CollectionAdminConfig, Field, WorkflowStatus } from '@byline/core';
+import type { Field, FormAdminConfig, 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';
@@ -39,7 +39,7 @@ export interface SystemFieldsSubmitPayload {
 export interface FormRendererProps {
     mode: 'create' | 'edit';
     fields: Field[];
-    onSubmit: (data: any) => void;
+    onSubmit: (data: any) => void | Promise<void>;
     onCancel: () => void;
     onStatusChange?: (nextStatus: string) => Promise<void>;
     onUnpublish?: () => Promise<void>;
@@ -86,7 +86,7 @@ export interface FormRendererProps {
     workflowStatuses?: WorkflowStatus[];
     publishedVersion?: PublishedVersionInfo | null;
     initialData?: Record<string, any>;
-    adminConfig?: CollectionAdminConfig;
+    adminConfig?: FormAdminConfig;
     /**
      * Name of the schema field to render as the live form heading.
      * Sourced from `CollectionDefinition.useAsTitle` by the caller.
@@ -98,6 +98,20 @@ export interface FormRendererProps {
      * present the path widget renders in the sidebar.
      */
     useAsPath?: string;
+    /**
+     * Whether the system path widget may render in the sidebar. Defaults to
+     * `true`, which preserves the historical behaviour of showing the widget
+     * whenever `useAsPath` is declared or the document envelope carries a
+     * `path`. Set `false` for a resource whose path is internal metadata and
+     * must never be presented or edited.
+     */
+    showPath?: boolean;
+    /**
+     * Explicit form heading, used verbatim. Overrides both `useAsTitle`'s live
+     * value and the create/edit wording derived from `mode` — for a resource
+     * whose identity does not change when it is first materialised.
+     */
+    heading?: string;
     /**
      * Opts the available-locales widget into the sidebar (below the path
      * widget). Sourced from `CollectionDefinition.advertiseLocales` by the

package/dist/forms/form-renderer.js

@@ -24,13 +24,15 @@ 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, 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 FormContent = ({ mode, fields, onSubmit, onCancel, onStatusChange, onUnpublish, scheduledPublication, onSchedulePublication, onConfirmScheduledPublication, onCancelScheduledPublication, onDelete, onDuplicate, onCopyToLocale, onDeleteLocale, contentLocales, nextStatus, workflowStatuses, publishedVersion, initialData, adminConfig, useAsTitle, useAsPath, showPath = true, heading, 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);
     const [hasChanges, setHasChanges] = useState(hasChangesFn());
     const [statusBusy, setStatusBusy] = useState(false);
     const [isUploading, setIsUploading] = useState(false);
+    const submittingRef = useRef(false);
+    const [isSubmitting, setIsSubmitting] = useState(false);
     const [showUnsavedModal, setShowUnsavedModal] = useState(false);
     const [pendingSystemFieldsSubmit, setPendingSystemFieldsSubmit] = useState(null);
     const [contentLocale, setContentLocale] = useState(initialLocale ?? defaultLocale);
@@ -83,7 +85,7 @@ const FormContent = ({ mode, fields, onSubmit, onCancel, onStatusChange, onUnpub
     ]);
     const [formData, setFormData] = useState(()=>getFieldValues());
     const liveTitle = useFieldValue(useAsTitle ?? '');
-    const heading = liveTitle || (headingLabel ? 'create' === mode ? t('forms.heading.createLabel', {
+    const computedHeading = heading || liveTitle || (headingLabel ? 'create' === mode ? t('forms.heading.createLabel', {
         label: headingLabel
     }) : t('forms.heading.editLabel', {
         label: headingLabel
@@ -107,10 +109,17 @@ const FormContent = ({ mode, fields, onSubmit, onCancel, onStatusChange, onUnpub
     const handleCancel = ()=>{
         if (onCancel && 'function' == typeof onCancel) onCancel();
     };
-    const submitPayload = useCallback((payload)=>{
-        if (onSubmit && 'function' == typeof onSubmit) {
-            onSubmit(payload);
+    const submitPayload = useCallback(async (payload)=>{
+        if ('function' != typeof onSubmit) return;
+        if (submittingRef.current) return;
+        submittingRef.current = true;
+        setIsSubmitting(true);
+        try {
+            await onSubmit(payload);
             resetHasChanges();
+        } catch  {} finally{
+            submittingRef.current = false;
+            setIsSubmitting(false);
         }
     }, [
         onSubmit,
@@ -169,7 +178,7 @@ const FormContent = ({ mode, fields, onSubmit, onCancel, onStatusChange, onUnpub
                 systemAvailableLocales
             };
             if ('edit' === mode && ('direct-write' === reason || 'both' === reason)) return void setPendingSystemFieldsSubmit(payload);
-            submitPayload(payload);
+            await submitPayload(payload);
         })();
     };
     const tabErrorCountsBySet = useMemo(()=>{
@@ -249,7 +258,7 @@ const FormContent = ({ mode, fields, onSubmit, onCancel, onStatusChange, onUnpub
                 children: [
                     /*#__PURE__*/ jsx("h1", {
                         className: clsx('byline-form-heading', form_renderer_module.heading),
-                        children: heading
+                        children: computedHeading
                     }),
                     headerSlot
                 ]
@@ -285,7 +294,7 @@ const FormContent = ({ mode, fields, onSubmit, onCancel, onStatusChange, onUnpub
                                 className: clsx('byline-form-actions-button', form_renderer_module["actions-button"]),
                                 size: "sm",
                                 type: "submit",
-                                disabled: false === hasChanges || isUploading,
+                                disabled: false === hasChanges || isUploading || isSubmitting,
                                 children: isUploading ? t('forms.actions.uploading') : t('common.actions.save')
                             }),
                             primaryStatus && onStatusChange && /*#__PURE__*/ jsx("div", {
@@ -386,7 +395,7 @@ const FormContent = ({ mode, fields, onSubmit, onCancel, onStatusChange, onUnpub
                     /*#__PURE__*/ jsxs("div", {
                         className: clsx('byline-form-sidebar', form_renderer_module.sidebar),
                         children: [
-                            (useAsPath || 'string' == typeof initialData?.path && initialData.path.length > 0) && /*#__PURE__*/ jsx(PathWidget, {
+                            showPath && (useAsPath || 'string' == typeof initialData?.path && initialData.path.length > 0) && /*#__PURE__*/ jsx(PathWidget, {
                                 useAsPath: useAsPath,
                                 collectionPath: collectionPath ?? '',
                                 defaultLocale: defaultLocale,

package/dist/forms/tree-placement-widget.js

@@ -1,7 +1,7 @@
 "use client";
 import { jsx, jsxs } from "react/jsx-runtime";
 import { useCallback, useEffect, useState } from "react";
-import { getCollectionDefinition } from "@byline/core";
+import { getCollectionDefinition, isSingleton } from "@byline/core";
 import { useTranslation } from "@byline/i18n/react";
 import { Button } from "@byline/ui/react";
 import clsx from "clsx";
@@ -11,7 +11,8 @@ import tree_placement_widget_module from "./tree-placement-widget.module.js";
 const TreePlacementWidget = ({ collectionPath, documentId, useAsTitle })=>{
     const { t } = useTranslation('byline-admin');
     const { getTreeAncestors, getTreeParent, placeTreeNode } = useBylineFieldServices();
-    const targetDefinition = getCollectionDefinition(collectionPath);
+    const definition = getCollectionDefinition(collectionPath);
+    const targetDefinition = null == definition || isSingleton(definition) ? null : definition;
     const [parent, setParent] = useState(null);
     const [placed, setPlaced] = useState(true);
     const [loading, setLoading] = useState(true);

package/dist/forms/use-form-layout.d.ts

@@ -1,4 +1,4 @@
-import type { CollectionAdminConfig, Field, GroupDefinition, LayoutDefinition, RowDefinition, TabSetDefinition } from '@byline/core';
+import type { Field, FormAdminConfig, GroupDefinition, LayoutDefinition, RowDefinition, TabSetDefinition } from '@byline/core';
 /** Which tab set + tab a schema field is placed under. */
 export interface TabPath {
     tabSetName: string;
@@ -27,9 +27,9 @@ export interface FormLayout {
  * `layout.main`) are absent from the map. Rows and groups are recursed into;
  * the `seen` set guards against a config that references a row/group cycle.
  */
-export declare function buildFieldToTabPath(adminConfig: CollectionAdminConfig | undefined, fieldByName: Map<string, Field>, rowByName: Map<string, RowDefinition>, groupByName: Map<string, GroupDefinition>): Map<string, TabPath>;
+export declare function buildFieldToTabPath(adminConfig: FormAdminConfig | undefined, fieldByName: Map<string, Field>, rowByName: Map<string, RowDefinition>, groupByName: Map<string, GroupDefinition>): Map<string, TabPath>;
 /**
  * Memoise the layout primitives + lookup tables the form renderer walks.
  * Rebuilt only when `adminConfig` / `fields` change.
  */
-export declare function useFormLayout(adminConfig: CollectionAdminConfig | undefined, fields: Field[]): FormLayout;
+export declare function useFormLayout(adminConfig: FormAdminConfig | undefined, fields: Field[]): FormLayout;

package/dist/index.d.ts

@@ -28,5 +28,6 @@ export * from './modules/admin-activity/index.js';
 export * from './modules/admin-permissions/index.js';
 export * from './modules/admin-roles/index.js';
 export * from './modules/admin-users/index.js';
+export * from './modules/analytics/index.js';
 export * from './modules/auth/index.js';
 export type { AdminStore } from './store.js';

package/dist/index.js

@@ -3,6 +3,7 @@ export * from "./modules/admin-activity/index.js";
 export * from "./modules/admin-permissions/index.js";
 export * from "./modules/admin-roles/index.js";
 export * from "./modules/admin-users/index.js";
+export * from "./modules/analytics/index.js";
 export * from "./modules/auth/index.js";
 export { registerAdminAbilities } from "./abilities.js";
 export { assertAdminActor, requireAdminActor } from "./lib/assert-admin-actor.js";

package/dist/modules/analytics/abilities.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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 { AbilityRegistry } from '@byline/auth';
+export declare const ANALYTICS_ABILITIES: {
+    readonly read: 'analytics.read';
+    readonly maintain: 'analytics.maintain';
+};
+export type AnalyticsAbilityKey = (typeof ANALYTICS_ABILITIES)[keyof typeof ANALYTICS_ABILITIES];
+export declare function registerAnalyticsAbilities(registry: AbilityRegistry): void;

package/dist/modules/analytics/abilities.js

@@ -0,0 +1,21 @@
+const ANALYTICS_ABILITIES = {
+    read: 'analytics.read',
+    maintain: 'analytics.maintain'
+};
+function registerAnalyticsAbilities(registry) {
+    registry.register({
+        key: ANALYTICS_ABILITIES.read,
+        label: 'Read analytics',
+        description: 'View installation-level page, visitor, download, referrer, and country totals.',
+        group: 'analytics',
+        source: 'admin'
+    });
+    registry.register({
+        key: ANALYTICS_ABILITIES.maintain,
+        label: 'Maintain analytics',
+        description: 'Delete retained analytics events and rebuild affected daily aggregates.',
+        group: 'analytics',
+        source: 'admin'
+    });
+}
+export { ANALYTICS_ABILITIES, registerAnalyticsAbilities };

package/dist/modules/analytics/components/dashboard.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 React from 'react';
+import type { AnalyticsDashboardData, AnalyticsDashboardPeriod } from '../types.js';
+export interface AnalyticsDashboardProps {
+    data: AnalyticsDashboardData;
+    period: AnalyticsDashboardPeriod;
+    onPeriodChange(period: AnalyticsDashboardPeriod): void;
+}
+export declare function AnalyticsDashboard({ data, period, onPeriodChange, }: AnalyticsDashboardProps): React.JSX.Element;
+/** Never collapse the bar entirely: a visible sliver still encodes "smallest". */
+export declare function shareWidth(value: number, ceiling: number): number;
+export declare function formatShare(part: number, whole: number, locale: string): string;
+/** Return the retained boundary only when it truncates the selected range. */
+export declare function partialCoverageFrom(rangeFrom: string, coverageFrom: string | null): string | undefined;