@phis/ui 0.2.1 → 0.3.0

package/plugins/runtime-modules/dashboard/trees/area-dashboard-label-set.d.ts

@@ -7,3 +7,5 @@ export declare function getPhiAreaDashboardPageLabels(options: PhiGlobalTranslat
     pageDescription: string;
     emptyDescription: string;
 }>;
+/** What the Builder's Dashboard says where no Module offers it a card; the same sentence as everywhere. */
+export declare function getPhiDashboardCardsEmptyDescription(options: PhiGlobalTranslatorOptions): Promise<string>;

package/plugins/runtime-modules/dashboard/trees/area-dashboard-label-set.js

@@ -1,6 +1,7 @@
 import "server-only";
 import { PHI_TR_CTX_WEB_UI_LABEL } from "../../../../gateway/tr";
-import { definePhiLabelSet, definePhiMessageLabel, getPhiLabelSet } from "../../../../gateway/label-set";
+import { definePhiRuntimeModuleLabelSet, definePhiMessageLabel, getPhiLabelSet } from "../../../../gateway/label-set";
+import { PHI_DASHBOARD_RUNTIME_MODULE_IDENTITY } from "../ids";
 /**
  * What the Dashboards that were not written for one Area say.
  *
@@ -12,7 +13,7 @@ import { definePhiLabelSet, definePhiMessageLabel, getPhiLabelSet } from "../../
  * One key per Area rather than a lookup by name, because a label set's keys are what a translator sees
  * and a computed key is a message nobody can find.
  */
-const PHI_AREA_DASHBOARD_PAGE_LABEL_SET = definePhiLabelSet({
+const PHI_AREA_DASHBOARD_PAGE_LABEL_SET = definePhiRuntimeModuleLabelSet(PHI_DASHBOARD_RUNTIME_MODULE_IDENTITY, {
     key: "preset:area-dashboard-page",
     ctx: PHI_TR_CTX_WEB_UI_LABEL,
     labels: {
@@ -36,3 +37,7 @@ export async function getPhiAreaDashboardPageLabels(options, area) {
         emptyDescription: labels.empty_description,
     };
 }
+/** What the Builder's Dashboard says where no Module offers it a card; the same sentence as everywhere. */
+export async function getPhiDashboardCardsEmptyDescription(options) {
+    return (await getPhiLabelSet(options, PHI_AREA_DASHBOARD_PAGE_LABEL_SET)).empty_description;
+}

package/plugins/runtime-modules/dashboard/trees/dashboard-cards-page-tree.d.ts

@@ -0,0 +1,37 @@
+import { createPhiCmsPresetNodes } from "../../../../helpers/cms-preset-nodes";
+import type { PhiCmsPageNode, PhiResolvedCmsPageTree } from "../../../../types/cms";
+import type { PhiCmsInstanceId } from "../../../../types/cms-instance-id";
+/**
+ * The Collection over an Area's card contributions, as a node of the base page layout.
+ *
+ * Its own function because the Builder's Dashboard places it beside its authoring controls rather than
+ * standing on this page alone.
+ */
+export declare function buildPhiDashboardCardsWidget({ nodes, widgetId, area, slotIndex, emptyDescription, }: {
+    nodes: ReturnType<typeof createPhiCmsPresetNodes>;
+    widgetId: PhiCmsInstanceId;
+    area: string;
+    slotIndex: number;
+    emptyDescription: string;
+}): import("../../../../types").PhiCmsContentWidgetNode;
+/**
+ * A Dashboard page: one Collection over the card contributions of an Area's Modules.
+ *
+ * Admin's and the generic Area's Dashboard are this page with their own ids, labels and Area; a Module
+ * puts a card here by contributing one. No toolbar of its own: what a card shows and when it is asked
+ * again is the contribution's business and, later, the Controller's. A reload button that refreshed the
+ * list but not the payloads would be a button that lies.
+ */
+export declare function buildPhiDashboardCardsPageTree({ page, area, regionId, widgetId, labels, descriptionSource, }: {
+    page: PhiCmsPageNode;
+    area: string;
+    regionId: number;
+    widgetId: PhiCmsInstanceId;
+    labels: {
+        pageTitle: string;
+        pageDescription: string;
+        emptyDescription: string;
+    };
+    /** The untranslated description, where the page has one of its own to say. */
+    descriptionSource: string;
+}): PhiResolvedCmsPageTree;

package/plugins/runtime-modules/dashboard/trees/dashboard-cards-page-tree.js

@@ -0,0 +1,69 @@
+import { PHI_CMS_SEQUENTIAL_LAYOUT_SLOTS } from "../../../../constants/cms-layout-types";
+import { PHI_DASHBOARD_CARD_DATA_PROVIDER_KEY, PHI_DASHBOARD_CARD_RESOURCE_KEY, } from "../../../../constants/dashboard-card-provider-keys";
+import { PhiCmsPageType } from "../../../../constants/phi-cms";
+import { createPhiCmsPresetNodes } from "../../../../helpers/cms-preset-nodes";
+import { buildPhiBasePageContentScaffold, PHI_BASE_PAGE_LAYOUT_NODE_ID } from "../../../../components/regions/presets/phi-base-page-layout";
+/**
+ * The Collection over an Area's card contributions, as a node of the base page layout.
+ *
+ * Its own function because the Builder's Dashboard places it beside its authoring controls rather than
+ * standing on this page alone.
+ */
+export function buildPhiDashboardCardsWidget({ nodes, widgetId, area, slotIndex, emptyDescription, }) {
+    return nodes.widget({
+        id: widgetId,
+        parentLayoutNodeId: PHI_BASE_PAGE_LAYOUT_NODE_ID,
+        typeKey: "collection-view",
+        slotIndex,
+        sortOrder: 0,
+        label: `${area} dashboard cards`,
+        config: {
+            presentation: {
+                mode: "grid",
+                emptyDescription,
+            },
+            features: {
+                tools: { mode: "external" },
+                pagination: { enabled: false },
+            },
+            source: {
+                providerKey: PHI_DASHBOARD_CARD_DATA_PROVIDER_KEY,
+                resourceKey: PHI_DASHBOARD_CARD_RESOURCE_KEY,
+                // Which Dashboard this is. A page belongs to one Area, so the preset that places the Widget
+                // is what knows it; the path it stands on is read live, because that is what a Site changes.
+                params: { area },
+            },
+        },
+    });
+}
+/**
+ * A Dashboard page: one Collection over the card contributions of an Area's Modules.
+ *
+ * Admin's and the generic Area's Dashboard are this page with their own ids, labels and Area; a Module
+ * puts a card here by contributing one. No toolbar of its own: what a card shows and when it is asked
+ * again is the contribution's business and, later, the Controller's. A reload button that refreshed the
+ * list but not the payloads would be a button that lies.
+ */
+export function buildPhiDashboardCardsPageTree({ page, area, regionId, widgetId, labels, descriptionSource, }) {
+    const scaffold = buildPhiBasePageContentScaffold({ page, regionId });
+    const nodes = createPhiCmsPresetNodes(page);
+    return {
+        page: nodes.page({ pageType: PhiCmsPageType.Standard }),
+        pageMeta: {
+            title: { msgId: 0, source: "Dashboard", value: labels.pageTitle },
+            description: { msgId: 0, source: descriptionSource, value: labels.pageDescription },
+        },
+        overlays: [],
+        regions: [scaffold.region],
+        layoutNodes: [scaffold.layoutNode],
+        contentWidgets: [
+            buildPhiDashboardCardsWidget({
+                nodes,
+                widgetId,
+                area,
+                slotIndex: PHI_CMS_SEQUENTIAL_LAYOUT_SLOTS[0].slotIndex,
+                emptyDescription: labels.emptyDescription,
+            }),
+        ],
+    };
+}

package/plugins/runtime-modules/dashboard/trees/phi-default-admin-dashboard-page-tree.js

@@ -1,11 +1,7 @@
 import { createPhiPresetCmsInstanceIdMap } from "../../../../types/cms-instance-id";
 import { PHI_DASHBOARD_RUNTIME_MODULE_ID } from "../ids";
-import { PHI_DASHBOARD_CARD_DATA_PROVIDER_KEY, PHI_DASHBOARD_CARD_RESOURCE_KEY, } from "../../../../constants/dashboard-card-provider-keys";
-import { PHI_CMS_SEQUENTIAL_LAYOUT_SLOTS } from "../../../../constants/cms-layout-types";
-import { PhiCmsPageType } from "../../../../constants/phi-cms";
-import { createPhiCmsPresetNodes } from "../../../../helpers/cms-preset-nodes";
-import { buildPhiBasePageContentScaffold, PHI_BASE_PAGE_LAYOUT_NODE_ID } from "../../../../components/regions/presets/phi-base-page-layout";
 import { getPhiAdminDashboardPageLabels } from "./admin-dashboard-label-set";
+import { buildPhiDashboardCardsPageTree } from "./dashboard-cards-page-tree";
 import { readPhiServerApiCredentials } from "../../../../helpers/phis-server-credentials";
 /**
  * The Admin Dashboard: one Widget, and whatever the Area's Modules offer it.
@@ -34,54 +30,12 @@ export async function buildPhiDefaultAdminDashboardPageTree({ page, runtime, })
         internalToken: readPhiServerApiCredentials().internalToken,
         locale: runtime.locale.current,
     });
-    const scaffold = buildPhiBasePageContentScaffold({
+    return buildPhiDashboardCardsPageTree({
         page,
+        area: "admin",
         regionId: SYNTHETIC_ADMIN_DASHBOARD_REGION_IDS.regionContent,
-        regionConfig: { border: false },
+        widgetId: SYNTHETIC_ADMIN_DASHBOARD_WIDGET_IDS.widgetCards,
+        labels,
+        descriptionSource: "Review the current site status and core runtime counters at a glance.",
     });
-    const nodes = createPhiCmsPresetNodes(page);
-    return {
-        page: nodes.page({ pageType: PhiCmsPageType.Standard }),
-        pageMeta: {
-            title: { msgId: 0, source: "Dashboard", value: labels.pageTitle },
-            description: {
-                msgId: 0,
-                source: "Review the current site status and core runtime counters at a glance.",
-                value: labels.pageDescription,
-            },
-        },
-        overlays: [],
-        regions: [scaffold.region],
-        layoutNodes: [scaffold.layoutNode],
-        contentWidgets: [
-            nodes.widget({
-                id: SYNTHETIC_ADMIN_DASHBOARD_WIDGET_IDS.widgetCards,
-                parentLayoutNodeId: PHI_BASE_PAGE_LAYOUT_NODE_ID,
-                typeKey: "collection-view",
-                slotIndex: PHI_CMS_SEQUENTIAL_LAYOUT_SLOTS[0].slotIndex,
-                sortOrder: 0,
-                label: "admin dashboard cards",
-                config: {
-                    presentation: {
-                        mode: "grid",
-                        emptyDescription: labels.emptyDescription,
-                    },
-                    features: {
-                        // No toolbar of its own: what a card shows and when it is asked again is the contribution's
-                        // business and, later, the Controller's. A reload button that refreshed the list but not the
-                        // payloads would be a button that lies.
-                        tools: { mode: "external" },
-                        pagination: { enabled: false },
-                    },
-                    source: {
-                        providerKey: PHI_DASHBOARD_CARD_DATA_PROVIDER_KEY,
-                        resourceKey: PHI_DASHBOARD_CARD_RESOURCE_KEY,
-                        // Which Dashboard this is. A page belongs to one Area, so the preset that places the Widget
-                        // is what knows it; the path it stands on is read live, because that is what a Site changes.
-                        params: { area: "admin" },
-                    },
-                },
-            }),
-        ],
-    };
 }

package/plugins/runtime-modules/dashboard/trees/phi-default-area-dashboard-page-tree.js

@@ -1,17 +1,13 @@
 import { createPhiPresetCmsInstanceIdMap } from "../../../../types/cms-instance-id";
 import { PHI_DASHBOARD_RUNTIME_MODULE_ID } from "../ids";
-import { PHI_DASHBOARD_CARD_DATA_PROVIDER_KEY, PHI_DASHBOARD_CARD_RESOURCE_KEY, } from "../../../../constants/dashboard-card-provider-keys";
-import { PHI_CMS_SEQUENTIAL_LAYOUT_SLOTS } from "../../../../constants/cms-layout-types";
-import { PhiCmsPageType } from "../../../../constants/phi-cms";
-import { createPhiCmsPresetNodes } from "../../../../helpers/cms-preset-nodes";
-import { buildPhiBasePageContentScaffold, PHI_BASE_PAGE_LAYOUT_NODE_ID } from "../../../../components/regions/presets/phi-base-page-layout";
 import { getPhiAreaDashboardPageLabels, } from "./area-dashboard-label-set";
 import { readPhiServerApiCredentials } from "../../../../helpers/phis-server-credentials";
+import { buildPhiDashboardCardsPageTree } from "./dashboard-cards-page-tree";
 /**
  * The Dashboard an Area gets when it has nothing more specific to show.
  *
  * Admin and Builder each carry one written for them -- the first reports on the installation, the
- * second opens the authoring controls -- and neither generalises. What the remaining Areas need is a
+ * second puts the same cards under the authoring controls -- and neither generalises. What the remaining Areas need is a
  * page that exists: the Area root forwards to the Dashboard, so an Area without one has no front door
  * at all.
  *
@@ -41,47 +37,12 @@ export async function buildPhiDefaultAreaDashboardPageTree({ page, runtime, area
         internalToken: readPhiServerApiCredentials().internalToken,
         locale: runtime.locale.current,
     }, area);
-    const scaffold = buildPhiBasePageContentScaffold({
+    return buildPhiDashboardCardsPageTree({
         page,
+        area,
         regionId,
-        regionConfig: { border: false },
+        widgetId: widgetIds.widgetCards,
+        labels,
+        descriptionSource: "",
     });
-    const nodes = createPhiCmsPresetNodes(page);
-    return {
-        page: nodes.page({ pageType: PhiCmsPageType.Standard }),
-        pageMeta: {
-            title: { msgId: 0, source: "Dashboard", value: labels.pageTitle },
-            description: { msgId: 0, source: "", value: labels.pageDescription },
-        },
-        overlays: [],
-        regions: [scaffold.region],
-        layoutNodes: [scaffold.layoutNode],
-        contentWidgets: [
-            nodes.widget({
-                id: widgetIds.widgetCards,
-                parentLayoutNodeId: PHI_BASE_PAGE_LAYOUT_NODE_ID,
-                typeKey: "collection-view",
-                slotIndex: PHI_CMS_SEQUENTIAL_LAYOUT_SLOTS[0].slotIndex,
-                sortOrder: 0,
-                label: `${area} dashboard cards`,
-                config: {
-                    presentation: {
-                        mode: "grid",
-                        emptyDescription: labels.emptyDescription,
-                    },
-                    features: {
-                        // No toolbar of its own, for the reason the Admin Dashboard states: a reload that refreshed
-                        // the list but not the payloads would be a button that lies.
-                        tools: { mode: "external" },
-                        pagination: { enabled: false },
-                    },
-                    source: {
-                        providerKey: PHI_DASHBOARD_CARD_DATA_PROVIDER_KEY,
-                        resourceKey: PHI_DASHBOARD_CARD_RESOURCE_KEY,
-                        params: { area },
-                    },
-                },
-            }),
-        ],
-    };
 }

package/plugins/runtime-modules/dashboard/trees/phi-default-builder-dashboard-page-tree.js

@@ -1,12 +1,14 @@
 import { createPhiPresetCmsInstanceIdMap } from "../../../../types/cms-instance-id";
 import { PHI_DASHBOARD_RUNTIME_MODULE_ID } from "../ids";
 import { PHI_CMS_DEFAULT_SLOT_INDEX } from "../../../../constants/cms-layout-types";
-import { PhiCmsPageType, PhiCmsRegionType } from "../../../../constants/phi-cms";
+import { PhiCmsFlags, PhiCmsPageType, PhiCmsRegionType } from "../../../../constants/phi-cms";
 import { createPhiCmsPresetNodes } from "../../../../helpers/cms-preset-nodes";
 import { resolvePhiShellHeaderHeight } from "../../../../helpers/shell-region-style";
-import { buildPhiBasePageContentScaffold, PHI_BASE_PAGE_LAYOUT_NODE_ID } from "../../../../components/regions/presets/phi-base-page-layout";
+import { buildPhiBasePageContentScaffold } from "../../../../components/regions/presets/phi-base-page-layout";
 import { getPhiBuilderChromeWidgetLabels } from "../../../../components/widgets/label-sets/builder-chrome";
 import { readPhiServerApiCredentials } from "../../../../helpers/phis-server-credentials";
+import { buildPhiDashboardCardsWidget } from "./dashboard-cards-page-tree";
+import { getPhiDashboardCardsEmptyDescription } from "./area-dashboard-label-set";
 const SYNTHETIC_BUILDER_DASHBOARD_REGION_IDS = {
     regionHeaderBottom: -580,
     regionContent: -581,
@@ -23,14 +25,18 @@ const SYNTHETIC_BUILDER_DASHBOARD_WIDGET_IDS = createPhiPresetCmsInstanceIdMap({
     ownerModuleId: PHI_DASHBOARD_RUNTIME_MODULE_ID,
     presetKey: "builder-dashboard-page",
 }, [
-    "widgetBuilderChromeControls",
+    "widgetCards",
 ]);
 export async function buildPhiDefaultBuilderDashboardPageTree({ page, runtime, }) {
-    const labels = await getPhiBuilderChromeWidgetLabels({
+    const translatorOptions = {
         apiBaseUrl: readPhiServerApiCredentials().apiBaseUrl,
         internalToken: readPhiServerApiCredentials().internalToken,
         locale: runtime.locale.current,
-    });
+    };
+    const [labels, emptyDescription] = await Promise.all([
+        getPhiBuilderChromeWidgetLabels(translatorOptions),
+        getPhiDashboardCardsEmptyDescription(translatorOptions),
+    ]);
     const pageTitleSource = "Dashboard";
     const pageTitle = labels.pageTitles.dashboard;
     const scaffold = buildPhiBasePageContentScaffold({
@@ -56,7 +62,7 @@ export async function buildPhiDefaultBuilderDashboardPageTree({ page, runtime, }
                 rootLayoutNodeId: SYNTHETIC_BUILDER_DASHBOARD_LAYOUT_IDS.layoutHeaderBottom,
                 sortOrder: 25,
                 config: {
-                    sticky: true,
+                    flags: PhiCmsFlags.Sticky,
                     /*
                      * No Effect or Shadow of its own, like every other Builder Header. A `glass` authored here
                      * frosts this one Region against the Site's Shell Chrome Overlay, so the Dashboard's Header
@@ -80,23 +86,21 @@ export async function buildPhiDefaultBuilderDashboardPageTree({ page, runtime, }
                 config: {
                     balancedSides: true,
                     contentAlign: "center",
-                    style: { height: "100%" },
                 },
             }),
             scaffold.layoutNode,
         ],
         contentWidgets: [
-            nodes.widget({
-                typeKey: "builder-chrome-controls",
-                id: SYNTHETIC_BUILDER_DASHBOARD_WIDGET_IDS.widgetBuilderChromeControls,
-                parentLayoutNodeId: PHI_BASE_PAGE_LAYOUT_NODE_ID,
+            /*
+             * The cards the Builder's Modules contribute: the same Collection the other Dashboards are made
+             * of, so a Module puts a card here the way it does anywhere else.
+             */
+            buildPhiDashboardCardsWidget({
+                nodes,
+                widgetId: SYNTHETIC_BUILDER_DASHBOARD_WIDGET_IDS.widgetCards,
+                area: "builder",
                 slotIndex: 0,
-                label: "builder dashboard header main controls",
-                config: {
-                    editorPreviewDisabled: true,
-                    actionsDisabled: true,
-                    debugDisabled: true,
-                },
+                emptyDescription,
             }),
         ],
     };

package/plugins/runtime-modules/descriptor-compiler.d.ts

@@ -49,10 +49,12 @@ export declare function compilePhiCmsActiveRouteTable({ catalog, area, activeMod
      */
     landingSelection?: PhiAreaLandingSelection | null;
 }): PhiCmsActiveRouteTable;
-export declare function resolvePhiCmsActiveNavigationSurfaces({ catalog, area, activeModuleIds, viewer, }: {
+export declare function resolvePhiCmsActiveNavigationSurfaces({ catalog, area, activeModuleIds, routeTable, viewer, }: {
     catalog: PhiCmsCompiledDescriptorCatalog;
     area: PhiCmsAreaKey;
     activeModuleIds: ReadonlySet<PhiRuntimeModuleId>;
+    /** The Area's active route table (`compilePhiCmsActiveRouteTable`): what answers, and where. */
+    routeTable: PhiCmsActiveRouteTable;
     viewer?: PhiAccessViewer;
 }): readonly PhiCmsResolvedNavigationSurface[];
 export declare function resolvePhiCmsNavigationOverlay(surface: PhiCmsResolvedNavigationSurface, overlay: PhiCmsNavigationOverlay | null): PhiCmsNavigationOverlayResolution;
@@ -60,18 +62,6 @@ export declare function resolvePhiCmsRoutePreset(table: PhiCmsActiveRouteTable,
 export declare function resolvePhiCmsRoutePresetByPageId(table: PhiCmsActiveRouteTable, pageId: PhiCmsInstanceId): PhiCmsRoutePresetBinding | null;
 export declare function resolvePhiCmsAreaShellPresetBinding(catalog: PhiCmsCompiledDescriptorCatalog, area: PhiCmsAreaKey): PhiCmsAreaShellPresetBinding | null;
 export declare function resolvePhiCmsRoutePresetByIdentity(catalog: PhiCmsCompiledDescriptorCatalog, ownerModuleId: PhiRuntimeModuleId, presetKey: string): PhiCmsRoutePresetDescriptor | null;
-/**
- * The route a Module Page reference names, read off the whole catalogue.
- *
- * A reference carries the derived Page id and not the pair it was derived from, so this is the only way
- * in from a stored link: the hash cannot be undone, and the catalogue is the other side of it.
- *
- * The Area's active route table answers the same question for what that Area actually serves, and where
- * a caller has one it is the better question -- it has already dropped the Modules that are switched off
- * and the root applicants that lost. This one is for a caller holding only the catalogue, and it leaves
- * those checks to them.
- */
-export declare function resolvePhiCmsRouteDescriptorByPageId(catalog: PhiCmsCompiledDescriptorCatalog, pageId: PhiCmsInstanceId): PhiCmsRoutePresetDescriptor | null;
 export declare function resolvePhiCmsThemePresetBinding(catalog: PhiCmsCompiledDescriptorCatalog, themeKey: string, activeModuleIds: ReadonlySet<PhiRuntimeModuleId>): PhiCmsThemePresetBinding | null;
 export declare function instantiatePhiCmsThemePreset(binding: PhiCmsThemePresetBinding): Promise<import("../../theme").PhiThemePresetPlugin>;
 export declare function instantiatePhiCmsThemePresets(catalog: PhiCmsCompiledThemeDescriptors, activeModuleIds: ReadonlySet<PhiRuntimeModuleId>): Promise<import("../../theme").PhiThemePresetPlugin[]>;