@phis/ui 0.1.0 → 0.2.0

package/plugins/runtime-modules/news/trees/phi-default-pub-news-page-tree.js

@@ -0,0 +1,86 @@
+import { createPhiPresetCmsInstanceIdMap } from "../../../../types/cms-instance-id";
+import { PHI_NEWS_RUNTIME_MODULE_ID } from "../ids";
+import { PHI_CMS_DEFAULT_SLOT_INDEX } from "../../../../constants/cms-layout-types";
+import { PhiCmsPageType, PhiCmsRegionType } from "../../../../constants/phi-cms";
+import { createPhiCmsPresetNodes } from "../../../../helpers/cms-preset-nodes";
+const PHI_NEWS_PAGE_PRESET_KEY = "public-news-page";
+/**
+ * The heading, carried inline for the same reason the other Public presets carry theirs: a Module cannot
+ * put a file into the Site's `public/` directory, and the Markdown Widget persists this copy the moment
+ * the Site takes the page over in the Builder.
+ */
+const PHI_DEFAULT_PUB_NEWS_MARKDOWN = "# News\n";
+const SYNTHETIC_NEWS_REGION_IDS = {
+    regionContent: -320,
+};
+const SYNTHETIC_NEWS_LAYOUT_IDS = createPhiPresetCmsInstanceIdMap({
+    domain: "page",
+    ownerModuleId: PHI_NEWS_RUNTIME_MODULE_ID,
+    presetKey: PHI_NEWS_PAGE_PRESET_KEY,
+}, [
+    "layoutContent",
+]);
+const SYNTHETIC_NEWS_WIDGET_IDS = createPhiPresetCmsInstanceIdMap({
+    domain: "page",
+    ownerModuleId: PHI_NEWS_RUNTIME_MODULE_ID,
+    presetKey: PHI_NEWS_PAGE_PRESET_KEY,
+}, [
+    "widgetHeading",
+    "widgetNewsList",
+]);
+/**
+ * The News page: a heading and the list, inside the frame every Public page wears.
+ *
+ * Two Widgets rather than one, because the heading is the Site's to change and the list is not: what the
+ * list shows is whatever Core answers. A Site that wants an introduction above its news adds it here in
+ * the Builder without touching the part that reads.
+ */
+export async function buildPhiDefaultPubNewsPageTree({ page, }) {
+    const nodes = createPhiCmsPresetNodes(page);
+    return {
+        page: nodes.page({ pageType: PhiCmsPageType.Standard }),
+        overlays: [],
+        regions: [
+            nodes.region({
+                id: SYNTHETIC_NEWS_REGION_IDS.regionContent,
+                regionType: PhiCmsRegionType.Content,
+                rootLayoutNodeId: SYNTHETIC_NEWS_LAYOUT_IDS.layoutContent,
+                sortOrder: 30,
+            }),
+        ],
+        layoutNodes: [
+            /*
+             * A vertical Flex, not the `content` Layout the one-Widget presets use: `content` has a single slot,
+             * so a second Widget placed in it is dropped without a word. `flex-vertical` carries a sequence,
+             * which is what a heading above a list is.
+             */
+            nodes.layout({
+                creationPreset: { layoutKind: "verticalflex", preset: "panel" },
+                typeKey: "flex-vertical",
+                id: SYNTHETIC_NEWS_LAYOUT_IDS.layoutContent,
+                parentLayoutNodeId: null,
+                slotIndex: PHI_CMS_DEFAULT_SLOT_INDEX,
+                label: "pub news page",
+            }),
+        ],
+        // `stack` rather than two `widget` calls: it counts the slots, so the list sits under the heading
+        // rather than in the same one.
+        contentWidgets: nodes.stack(SYNTHETIC_NEWS_LAYOUT_IDS.layoutContent, [
+            {
+                typeKey: "markdown",
+                id: SYNTHETIC_NEWS_WIDGET_IDS.widgetHeading,
+                label: "pub news heading widget",
+                config: {
+                    sourceMode: "inline",
+                    markdown: PHI_DEFAULT_PUB_NEWS_MARKDOWN,
+                },
+            },
+            {
+                typeKey: "news-list",
+                id: SYNTHETIC_NEWS_WIDGET_IDS.widgetNewsList,
+                label: "pub news list widget",
+                config: {},
+            },
+        ]),
+    };
+}

package/plugins/runtime-modules/news/widgets/news-list/authoring.d.ts

@@ -0,0 +1,2 @@
+import { type PhiNewsListWidgetConfig } from "./config";
+export declare const PHI_NEWS_LIST_WIDGET_BUILDER_PLUGIN: import("../../../../../types").PhiCmsBuilderWidgetPlugin<PhiNewsListWidgetConfig>;

package/plugins/runtime-modules/news/widgets/news-list/authoring.js

@@ -0,0 +1,21 @@
+"use client";
+import { Fragment as _Fragment, jsxs as _jsxs, jsx as _jsx } from "react/jsx-runtime";
+import { createPhiCmsBuilderWidgetPlugin } from "../../../../../plugins/factories/widget-builder-plugin";
+import { PhiWidgetEditorPlaceholder } from "../../../../../components/widgets/builder/widget-editor-placeholder";
+import { PHI_NEWS_LIST_DEFAULT_LIMIT, PHI_NEWS_LIST_WIDGET_DEFINITION, } from "./config";
+/**
+ * What the Builder says about a list whose entries it must not fetch.
+ *
+ * The canvas is not where a read should leave for Core, and the entries are not the Site's to arrange
+ * here anyway: what appears is whatever is published and unexpired at the moment a visitor arrives. So
+ * the editor states the settings it does own, and points at where the entries are written.
+ */
+function PhiNewsListWidgetEditorSummary({ config }) {
+    const limit = config?.limit ?? PHI_NEWS_LIST_DEFAULT_LIMIT;
+    const omitted = [
+        config?.showTags === false ? "tags" : null,
+        config?.showLinks === false ? "links" : null,
+    ].filter((entry) => entry !== null);
+    return (_jsxs(_Fragment, { children: ["The ", limit, " most recent published news entries, read when the page is drawn", omitted.length > 0 ? _jsxs(_Fragment, { children: [" \u2014 without ", omitted.join(" or ")] }) : null, ". Entries are written in the Editor; what a visitor sees is whatever is published and has not expired."] }));
+}
+export const PHI_NEWS_LIST_WIDGET_BUILDER_PLUGIN = createPhiCmsBuilderWidgetPlugin(PHI_NEWS_LIST_WIDGET_DEFINITION, ({ widget, config }) => (_jsx(PhiWidgetEditorPlaceholder, { widget: widget, pluginTitle: PHI_NEWS_LIST_WIDGET_DEFINITION.title, summary: _jsx(PhiNewsListWidgetEditorSummary, { config: config ?? undefined }) })));

package/plugins/runtime-modules/news/widgets/news-list/client.d.ts

@@ -0,0 +1,34 @@
+import { type PhiMarkdownBlock } from "../../../../../components/widgets/shared/markdown-body-client";
+import type { PhiNewsListLabels } from "../../../../../components/widgets/label-sets/news";
+/**
+ * One entry as the server prepared it.
+ *
+ * The date arrives formatted, not as an instant. It is formatted in the page's language, which only the
+ * server knows -- in the browser `Intl` would use the visitor's own locale, and on a Public page that is
+ * rendered once for everybody it would use the server's
+ * ([helpers/format-date-time.ts](../../../../../helpers/format-date-time.ts)). `machineDate` is the same
+ * moment for the `<time>` attribute, which is not language at all.
+ */
+export type PhiNewsListEntryView = {
+    id: string;
+    title: string;
+    subtitle: string;
+    /** The body, parsed on the server: Markdown never crosses this boundary as text. */
+    blocks: PhiMarkdownBlock[];
+    date: string;
+    machineDate: string;
+    link: string | null;
+    tags: readonly string[];
+};
+export type PhiNewsListWidgetClientProps = {
+    entries: readonly PhiNewsListEntryView[];
+    labels: PhiNewsListLabels;
+};
+/**
+ * The list itself, which holds no state and asks nothing.
+ *
+ * A Client half rather than markup from the server, because every visual Widget in this package renders
+ * through one: the Controls are where antd lives, and a server component cannot use them. Nothing here
+ * depends on the visitor, so the first paint already carries every entry.
+ */
+export declare function PhiNewsListWidgetClient({ entries, labels }: PhiNewsListWidgetClientProps): import("react").JSX.Element;

package/plugins/runtime-modules/news/widgets/news-list/client.js

@@ -0,0 +1,26 @@
+"use client";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { PhiDividerControl } from "../../../../../components/controls/phi-divider-control";
+import { PhiEmptyControl } from "../../../../../components/controls/phi-empty-control";
+import { PhiFlexControl } from "../../../../../components/controls/phi-flex-control";
+import { PhiTagControl } from "../../../../../components/controls/phi-tag-control";
+import { PhiTypographyControl } from "../../../../../components/controls/phi-typography-control";
+import { PhiLink } from "../../../../../components/navigation/phi-link";
+import { PhiMarkdownWidgetClient, } from "../../../../../components/widgets/shared/markdown-body-client";
+import { PHI_SPACE } from "../../../../../theme/antd-css-var-contract";
+function PhiNewsListEntry({ entry, labels }) {
+    return (_jsx("article", { children: _jsxs(PhiFlexControl, { vertical: true, gap: PHI_SPACE.xs, children: [_jsx(PhiTypographyControl, { presentation: "text", type: "secondary", children: _jsx("time", { dateTime: entry.machineDate, children: entry.date }) }), _jsx(PhiTypographyControl, { presentation: "title", level: 3, style: { margin: 0 }, children: entry.title }), entry.subtitle ? (_jsx(PhiTypographyControl, { presentation: "text", strong: true, children: entry.subtitle })) : null, entry.blocks.length > 0 ? _jsx(PhiMarkdownWidgetClient, { config: { blocks: entry.blocks } }) : null, entry.tags.length > 0 ? (_jsx(PhiFlexControl, { wrap: true, gap: PHI_SPACE.xxs, children: entry.tags.map((tag) => (_jsx(PhiTagControl, { variant: "outlined", children: tag }, tag))) })) : null, entry.link ? _jsx(PhiLink, { href: entry.link, children: labels.readMore }) : null] }) }));
+}
+/**
+ * The list itself, which holds no state and asks nothing.
+ *
+ * A Client half rather than markup from the server, because every visual Widget in this package renders
+ * through one: the Controls are where antd lives, and a server component cannot use them. Nothing here
+ * depends on the visitor, so the first paint already carries every entry.
+ */
+export function PhiNewsListWidgetClient({ entries, labels }) {
+    if (entries.length === 0) {
+        return (_jsx(PhiEmptyControl, { description: (_jsxs(PhiFlexControl, { vertical: true, gap: PHI_SPACE.xxs, children: [_jsx(PhiTypographyControl, { presentation: "text", strong: true, children: labels.emptyTitle }), _jsx(PhiTypographyControl, { presentation: "text", type: "secondary", children: labels.emptyText })] })) }));
+    }
+    return (_jsx(PhiFlexControl, { vertical: true, gap: PHI_SPACE.lg, children: entries.map((entry, index) => (_jsxs(PhiFlexControl, { vertical: true, gap: PHI_SPACE.lg, children: [index > 0 ? _jsx(PhiDividerControl, { style: { margin: 0 } }) : null, _jsx(PhiNewsListEntry, { entry: entry, labels: labels })] }, entry.id))) }));
+}

package/plugins/runtime-modules/news/widgets/news-list/config.d.ts

@@ -0,0 +1,43 @@
+import { type PhiCmsWidgetConfigBase } from "../../../../../components/widgets/config/parser-primitives";
+/** As many as a page can carry without becoming an archive, which is a later address. */
+export declare const PHI_NEWS_LIST_DEFAULT_LIMIT = 10;
+export type PhiNewsListWidgetConfig = PhiCmsWidgetConfigBase & {
+    /**
+     * How many entries at most.
+     *
+     * A ceiling in the Widget rather than a page parameter: what a Site shows on its News page is a
+     * decision it makes once in the Builder, and a visitor who could ask for five hundred entries would be
+     * asking the server to render them.
+     */
+    limit: number;
+    /** Whether each entry shows the tags it was published with. */
+    showTags: boolean;
+    /** Whether an entry that carries a link shows it as an action. */
+    showLinks: boolean;
+};
+export declare function normalizePhiNewsListWidgetConfig(config: unknown): PhiNewsListWidgetConfig;
+export declare function parsePhiNewsListWidgetConfig(config: Record<string, unknown>): PhiNewsListWidgetConfig;
+export declare const PHI_NEWS_LIST_WIDGET_DEFINITION: {
+    kind: "widget";
+    pluginKey: string;
+    typeKey: string;
+    title: string;
+    description: string;
+    category: "content";
+    tags: string[];
+    icon: string;
+    slotSizePolicy: "fill-inline";
+    fields: ({
+        key: string;
+        type: "number";
+        label: string;
+        description: string;
+    } | {
+        key: string;
+        type: "boolean";
+        label: string;
+        description?: undefined;
+    })[];
+    defaultConfig: PhiNewsListWidgetConfig;
+    parseConfig: typeof parsePhiNewsListWidgetConfig;
+};

package/plugins/runtime-modules/news/widgets/news-list/config.js

@@ -0,0 +1,52 @@
+import { resolvePhiCmsWidgetPluginKey } from "../../../../../constants/cms-widget-types";
+import { readBoolean, readInteger, readRenderableBlockConfig, } from "../../../../../components/widgets/config/parser-primitives";
+/** As many as a page can carry without becoming an archive, which is a later address. */
+export const PHI_NEWS_LIST_DEFAULT_LIMIT = 10;
+const PHI_NEWS_LIST_MAX_LIMIT = 50;
+function readLimit(value) {
+    const limit = readInteger(value);
+    if (!limit || limit <= 0) {
+        return PHI_NEWS_LIST_DEFAULT_LIMIT;
+    }
+    return Math.min(limit, PHI_NEWS_LIST_MAX_LIMIT);
+}
+export function normalizePhiNewsListWidgetConfig(config) {
+    const raw = config && typeof config === "object" && !Array.isArray(config)
+        ? config
+        : {};
+    return {
+        ...readRenderableBlockConfig(raw),
+        limit: readLimit(raw.limit),
+        // Absent means shown: a Site that never opened the Inspector gets the entry as it was published,
+        // tags and link included, rather than a list quietly missing half of what was written. `readBoolean`
+        // answers `undefined` for anything that is not a boolean, which is the same case as absent.
+        showTags: readBoolean(raw.showTags) ?? true,
+        showLinks: readBoolean(raw.showLinks) ?? true,
+    };
+}
+export function parsePhiNewsListWidgetConfig(config) {
+    return normalizePhiNewsListWidgetConfig(config);
+}
+export const PHI_NEWS_LIST_WIDGET_DEFINITION = {
+    kind: "widget",
+    pluginKey: resolvePhiCmsWidgetPluginKey("news-list"),
+    typeKey: "news-list",
+    title: "News",
+    description: "The Site's published news entries, read while the page is drawn.",
+    category: "content",
+    tags: ["news", "content", "list"],
+    icon: "antd:notification",
+    slotSizePolicy: "fill-inline",
+    fields: [
+        {
+            key: "limit",
+            type: "number",
+            label: "Entries",
+            description: `How many at most. ${PHI_NEWS_LIST_DEFAULT_LIMIT} by default, ${PHI_NEWS_LIST_MAX_LIMIT} at the very most.`,
+        },
+        { key: "showTags", type: "boolean", label: "Show tags" },
+        { key: "showLinks", type: "boolean", label: "Show links" },
+    ],
+    defaultConfig: normalizePhiNewsListWidgetConfig(null),
+    parseConfig: parsePhiNewsListWidgetConfig,
+};

package/plugins/runtime-modules/news/widgets/news-list/plugin.d.ts

@@ -0,0 +1,3 @@
+import type { PhiCmsServerWidgetPlugin } from "../../../../../types";
+import { type PhiNewsListWidgetConfig } from "./config";
+export declare const PHI_NEWS_LIST_WIDGET_PLUGIN: PhiCmsServerWidgetPlugin<PhiNewsListWidgetConfig>;

package/plugins/runtime-modules/news/widgets/news-list/plugin.js

@@ -0,0 +1,8 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { definePhiPassiveWidgetRenderers } from "../../../../../plugins/factories/widget-renderers";
+import { PHI_NEWS_LIST_WIDGET_DEFINITION } from "./config";
+import { PhiNewsListWidget } from "./server";
+export const PHI_NEWS_LIST_WIDGET_PLUGIN = {
+    ...PHI_NEWS_LIST_WIDGET_DEFINITION,
+    ...definePhiPassiveWidgetRenderers(({ widget, config, runtime }) => (_jsx(PhiNewsListWidget, { config: config, runtime: runtime }, `widget-${widget.id}`))),
+};

package/plugins/runtime-modules/news/widgets/news-list/server.d.ts

@@ -0,0 +1,14 @@
+import type { PhiNoLabels, PhiServerBlockBaseProps } from "../../../../../types";
+import { type PhiNewsListWidgetConfig } from "./config";
+export type PhiNewsListWidgetProps = PhiServerBlockBaseProps<PhiNoLabels, PhiNewsListWidgetConfig>;
+/**
+ * The Site's news, read while the page is drawn.
+ *
+ * Nothing here depends on the visitor -- published news is the same for everybody -- so it belongs in the
+ * render rather than in a request the browser makes afterwards. On a Public page that is also the only
+ * way an expired entry can be absent instead of appearing and then disappearing.
+ *
+ * A failed read says so. The alternative is a page with a heading and nothing under it, which a visitor
+ * reads as "this Site has no news" and an operator cannot tell from the real thing.
+ */
+export declare function PhiNewsListWidget({ config, runtime }: PhiNewsListWidgetProps): Promise<import("react").JSX.Element>;

package/plugins/runtime-modules/news/widgets/news-list/server.js

@@ -0,0 +1,82 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { PhiAlertControl } from "../../../../../components/controls/phi-alert-control";
+import { PhiRuntimeModuleRenderClientHost } from "../../../../../components/runtime/runtime-module-render-client-manifest";
+import { getPhiNewsListLabels } from "../../../../../components/widgets/label-sets/news";
+import { PhiCmsWidgetType } from "../../../../../constants/cms-widget-types";
+import { fetchPhiSiteNews } from "../../../../../gateway/news";
+import { formatPhiDate } from "../../../../../helpers/format-date-time";
+import { phiRuntime } from "../../../../../server-helpers/phi-runtime";
+import { normalizePhiNewsListWidgetConfig } from "./config";
+/**
+ * The Site's news, read while the page is drawn.
+ *
+ * Nothing here depends on the visitor -- published news is the same for everybody -- so it belongs in the
+ * render rather than in a request the browser makes afterwards. On a Public page that is also the only
+ * way an expired entry can be absent instead of appearing and then disappearing.
+ *
+ * A failed read says so. The alternative is a page with a heading and nothing under it, which a visitor
+ * reads as "this Site has no news" and an operator cannot tell from the real thing.
+ */
+export async function PhiNewsListWidget({ config, runtime }) {
+    const settings = normalizePhiNewsListWidgetConfig(config);
+    const rt = phiRuntime(runtime);
+    const locale = runtime.locale.current;
+    const labels = await getPhiNewsListLabels({
+        apiBaseUrl: rt.apiBaseUrl,
+        internalToken: rt.internalToken,
+        locale,
+    });
+    let entries;
+    try {
+        entries = await fetchPhiSiteNews({
+            apiBaseUrl: rt.apiBaseUrl,
+            internalToken: rt.internalToken,
+            siteKey: rt.siteKey,
+            locale,
+        });
+    }
+    catch {
+        return _jsx(PhiAlertControl, { level: "warning", showIcon: true, title: labels.unavailable });
+    }
+    /*
+     * The body is Markdown, and it is parsed and translated here rather than answered translated by Core.
+     *
+     * Only the inline content of headings, paragraphs and table cells is handed to a provider, as HTML --
+     * the structure, code fences and raw HTML never are (`collectMarkdownTranslationUnits`). That is what
+     * makes Markdown the right standard for an entry: the control characters are not spared, they are never
+     * sent. It also means each paragraph is its own cache entry, so correcting one costs one.
+     *
+     * The entry's own language and switch decide, not the Widget's: they belong to the words.
+     */
+    /*
+     * Imported here rather than at the top: the Widget catalogue loads every Module's server file at
+     * start-up, and reaching into the core Module's graph from there closes a cycle through its data
+     * provider keys -- eleven unrelated suites failed on an undefined constant before this moved inside.
+     */
+    const { resolveMarkdownRenderData } = await import("../../../../../components/widgets/shared/markdown-render");
+    const views = await Promise.all(entries.slice(0, settings.limit).map(async (entry, index) => {
+        // Core answers the slug where an entry has one; the index is the fallback for an entry that has
+        // none, so two entries can never share a React key -- or a heading anchor.
+        const id = entry.id || entry.slug || `news-${index}`;
+        const body = entry.content.trim()
+            ? await resolveMarkdownRenderData({
+                sourceMode: "inline",
+                markdown: entry.content,
+                translate: entry.translate,
+                sourceLocale: entry.sourceLocale ?? undefined,
+                widgetId: `news-${id}`,
+            }, runtime)
+            : { blocks: [] };
+        return {
+            id,
+            title: entry.title,
+            subtitle: entry.subtitle,
+            blocks: "error" in body ? [] : body.blocks,
+            date: formatPhiDate(entry.created, locale),
+            machineDate: entry.created,
+            link: settings.showLinks ? entry.link : null,
+            tags: settings.showTags ? entry.tags : [],
+        };
+    }));
+    return (_jsx(PhiRuntimeModuleRenderClientHost, { type: PhiCmsWidgetType.NewsList, componentProps: { entries: views, labels } }));
+}

package/plugins/runtime-modules/news/widgets.d.ts

@@ -0,0 +1,2 @@
+import type { PhiRuntimeModuleWidgetDefinition } from "../contracts";
+export declare const PHI_NEWS_RUNTIME_MODULE_WIDGETS: readonly [PhiRuntimeModuleWidgetDefinition];

package/plugins/runtime-modules/news/widgets.js

@@ -0,0 +1,16 @@
+import { PHI_NEWS_RUNTIME_MODULE_ID } from "./ids";
+import { PHI_NEWS_LIST_WIDGET_DEFINITION } from "./widgets/news-list/config";
+function defineFirstPartyWidget(options) {
+    return options;
+}
+export const PHI_NEWS_RUNTIME_MODULE_WIDGETS = [
+    defineFirstPartyWidget({
+        definition: PHI_NEWS_LIST_WIDGET_DEFINITION,
+        ownerModuleId: PHI_NEWS_RUNTIME_MODULE_ID,
+        renderPolicies: { runtime: "custom", preview: "custom", authoring: "custom" },
+        loadRuntime: () => import("./widgets/news-list/plugin")
+            .then((module) => module.PHI_NEWS_LIST_WIDGET_PLUGIN),
+        loadPreview: () => import("./widgets/news-list/plugin")
+            .then((module) => module.PHI_NEWS_LIST_WIDGET_PLUGIN),
+    }),
+];

package/plugins/runtime-modules/observability/authoring-widgets.d.ts

@@ -1,2 +1,11 @@
+/**
+ * Observability contributes no Widgets of its own.
+ *
+ * Its log detail was a Widget for exactly as long as nothing general could do the job; the core record
+ * Widget reads one row of a Table Provider, and the logs Page declares its eleven fields against that.
+ * What is left here is the Module's Builder entry, which every Module has whether or not it brings
+ * Widgets -- `validate-runtime-module-manifests.mjs` checks that union, and a Module missing from it is
+ * a Module the Builder cannot reach.
+ */
 declare const _default: import("react").ComponentType<import("../client-authoring-widget-module").PhiAuthoringWidgetModuleProps>;
 export default _default;

package/plugins/runtime-modules/observability/authoring-widgets.js

@@ -1,7 +1,12 @@
 "use client";
-import { PHI_OBSERVABILITY_LOG_DETAIL_WIDGET_DEFINITION } from "./widgets/log-detail/config";
-import { createPhiAuthoringWidgetModule, definePhiAuthoringWidgetModuleLoader, } from "../client-authoring-widget-module";
-export default createPhiAuthoringWidgetModule([
-    definePhiAuthoringWidgetModuleLoader(PHI_OBSERVABILITY_LOG_DETAIL_WIDGET_DEFINITION, () => import("./widgets/log-detail/authoring")
-        .then((module) => module.PHI_OBSERVABILITY_LOG_DETAIL_WIDGET_BUILDER_PLUGIN)),
-]);
+import { createPhiAuthoringWidgetModule } from "../client-authoring-widget-module";
+/**
+ * Observability contributes no Widgets of its own.
+ *
+ * Its log detail was a Widget for exactly as long as nothing general could do the job; the core record
+ * Widget reads one row of a Table Provider, and the logs Page declares its eleven fields against that.
+ * What is left here is the Module's Builder entry, which every Module has whether or not it brings
+ * Widgets -- `validate-runtime-module-manifests.mjs` checks that union, and a Module missing from it is
+ * a Module the Builder cannot reach.
+ */
+export default createPhiAuthoringWidgetModule([]);

package/plugins/runtime-modules/observability/definition.d.ts

@@ -3,11 +3,6 @@ export declare const PHI_OBSERVABILITY_RUNTIME_MODULE_DEFINITION: {
     kind: "module";
     eligibleAreas: readonly ["admin"];
     serverBinding: import("../../../types").PhiRuntimeModuleServerBinding;
-    accessPolicy: {
-        readonly access: "roles";
-        readonly providerId: "@phis/server/core";
-        readonly allowedRoleFlags: number;
-    };
     title: string;
     description: string;
     category: "foundation";

package/plugins/runtime-modules/observability/definition.js

@@ -1,13 +1,11 @@
 import { PHI_OBSERVABILITY_RUNTIME_MODULE_ID } from "./ids";
 import { PHI_CORE_SERVER_BINDING } from "../../../types/server-capabilities";
-import { PHI_VIEWER_ACCESS_DEVELOPER_TOOLS } from "../../../types/access";
 import { PHI_OBSERVABILITY_RUNTIME_DATA_PROVIDER_DESCRIPTORS } from "./data-providers";
 export const PHI_OBSERVABILITY_RUNTIME_MODULE_DEFINITION = {
     moduleId: PHI_OBSERVABILITY_RUNTIME_MODULE_ID,
     kind: "module",
     eligibleAreas: ["admin"],
     serverBinding: PHI_CORE_SERVER_BINDING,
-    accessPolicy: PHI_VIEWER_ACCESS_DEVELOPER_TOOLS,
     title: "Observability",
     description: "Site-runtime log administration.",
     category: "foundation",

package/plugins/runtime-modules/observability/module.d.ts

@@ -3,11 +3,6 @@ export declare const PHI_OBSERVABILITY_RUNTIME_MODULE: {
     kind: "module";
     eligibleAreas: readonly ["admin"];
     serverBinding: import("../../../types").PhiRuntimeModuleServerBinding;
-    accessPolicy: {
-        readonly access: "roles";
-        readonly providerId: "@phis/server/core";
-        readonly allowedRoleFlags: number;
-    };
     title: string;
     description: string;
     category: "foundation";

package/plugins/runtime-modules/observability/presets.d.ts

@@ -1,30 +1,2 @@
-export declare const PHI_OBSERVABILITY_RUNTIME_MODULE_ROUTES: {
-    ownerModuleId: "@phis/ui/modules/observability";
-    presetKey: string;
-    presetVersion: number;
-    area: "admin";
-    title: string;
-    accessPolicy: {
-        readonly access: "roles";
-        readonly providerId: "@phis/server/core";
-        readonly allowedRoleFlags: number;
-    };
-    path: string;
-    navigation: {
-        navKey: "admin:sidebar";
-        parentItemKey: null;
-        before: string;
-        item: {
-            itemKey: string;
-            label: {
-                defaultMessage: string;
-            };
-            icon: string;
-            routePresetKey: string;
-        };
-    }[];
-    loadTree: ({ page, runtime }: import("../../../types").PhiCmsDescriptorBuildContext & {
-        activeModuleIds: ReadonlySet<import("../contracts").PhiRuntimeModuleId>;
-        params: Readonly<Record<string, string>>;
-    }) => Promise<import("../../../types").PhiResolvedCmsPageTree>;
-}[];
+import type { PhiCmsRoutePresetDescriptor } from "../../../types/cms-module-descriptors";
+export declare const PHI_OBSERVABILITY_RUNTIME_MODULE_ROUTES: PhiCmsRoutePresetDescriptor[];

package/plugins/runtime-modules/observability/presets.js

@@ -1,25 +1,16 @@
-import { PHI_BASE_PAGE_LAYOUT_VERSION } from "../../../components/regions/presets/phi-base-page-layout";
+import { buildPhiSidebarRoutePresetDescriptor } from "../sidebar-route";
 import { PHI_OBSERVABILITY_RUNTIME_MODULE_ID } from "./ids";
-import { PHI_VIEWER_ACCESS_DEVELOPER_TOOLS } from "../../../types/access";
-export const PHI_OBSERVABILITY_RUNTIME_MODULE_ROUTES = [{
+export const PHI_OBSERVABILITY_RUNTIME_MODULE_ROUTES = [
+    buildPhiSidebarRoutePresetDescriptor({
+        area: "admin",
+        anchor: "main",
         ownerModuleId: PHI_OBSERVABILITY_RUNTIME_MODULE_ID,
         presetKey: "admin-logs-page",
-        presetVersion: 1 + PHI_BASE_PAGE_LAYOUT_VERSION,
-        area: "admin",
         title: "Logs",
-        accessPolicy: PHI_VIEWER_ACCESS_DEVELOPER_TOOLS,
         path: "/logs",
-        navigation: [{
-                navKey: "admin:sidebar",
-                parentItemKey: null,
-                before: "@phis/ui/modules/admin/nav/settings",
-                item: {
-                    itemKey: "@phis/ui/modules/observability/nav/admin/logs",
-                    label: { defaultMessage: "Logs" },
-                    icon: "antd:file-search",
-                    routePresetKey: "admin-logs-page",
-                },
-            }],
-        loadTree: ({ page, runtime }) => import("../../../components/regions/presets/phi-default-admin-logs-page-tree")
+        itemKey: "@phis/ui/modules/observability/nav/admin/logs",
+        icon: "antd:file-search",
+        loadTree: ({ page, runtime }) => import("./trees/phi-default-admin-logs-page-tree")
             .then((module) => module.buildPhiDefaultAdminLogsPageTree({ page, runtime })),
-    }];
+    }),
+];

package/plugins/runtime-modules/observability/server.js

@@ -1,12 +1,11 @@
 import { definePhiRuntimeModuleServerAreaContribution } from "../area-contributions";
 import { PHI_OBSERVABILITY_RUNTIME_MODULE_DEFINITION } from "./definition";
 import { PHI_OBSERVABILITY_RUNTIME_MODULE_ROUTES } from "./presets";
-import { PHI_OBSERVABILITY_RUNTIME_MODULE_WIDGETS } from "./widgets";
 export const PHI_OBSERVABILITY_RUNTIME_MODULE_SERVER_AREA_CONTRIBUTION = definePhiRuntimeModuleServerAreaContribution({
     moduleId: PHI_OBSERVABILITY_RUNTIME_MODULE_DEFINITION.moduleId,
     catalogEntry: {
         definition: PHI_OBSERVABILITY_RUNTIME_MODULE_DEFINITION,
-        widgets: PHI_OBSERVABILITY_RUNTIME_MODULE_WIDGETS,
+        widgets: [],
         layouts: [],
         routes: PHI_OBSERVABILITY_RUNTIME_MODULE_ROUTES,
         load: () => import("./module").then((module) => module.PHI_OBSERVABILITY_RUNTIME_MODULE),

package/plugins/runtime-modules/observability/trees/admin-logs-label-set.d.ts

@@ -0,0 +1,8 @@
+import "server-only";
+import { type PhiGlobalTranslatorOptions } from "../../../../gateway/tr";
+export declare function getPhiAdminLogsPageLabels(options: PhiGlobalTranslatorOptions): Promise<{
+    pageTitle: string;
+    pageDescription: string;
+    contentLabel: string;
+    tableLabel: string;
+}>;

package/plugins/runtime-modules/observability/trees/admin-logs-label-set.js

@@ -0,0 +1,22 @@
+import "server-only";
+import { PHI_TR_CTX_WEB_UI_LABEL } from "../../../../gateway/tr";
+import { definePhiLabelSet, definePhiMessageLabel, getPhiLabelSet } from "../../../../gateway/label-set";
+const PHI_ADMIN_LOGS_PAGE_LABEL_SET = definePhiLabelSet({
+    key: "preset:admin-logs-page",
+    ctx: PHI_TR_CTX_WEB_UI_LABEL,
+    labels: {
+        page_title: "Logs",
+        page_description: definePhiMessageLabel("Inspect site-scoped runtime logs from the current site process."),
+        content_label: "Logs content",
+        table_label: "Runtime logs",
+    },
+});
+export async function getPhiAdminLogsPageLabels(options) {
+    const labels = await getPhiLabelSet(options, PHI_ADMIN_LOGS_PAGE_LABEL_SET);
+    return {
+        pageTitle: labels.page_title,
+        pageDescription: labels.page_description,
+        contentLabel: labels.content_label,
+        tableLabel: labels.table_label,
+    };
+}

package/plugins/runtime-modules/observability/trees/phi-default-admin-logs-page-tree.d.ts

@@ -0,0 +1,6 @@
+import type { PhiCmsPageNode, PhiResolvedCmsPageTree } from "../../../../types/cms";
+import type { PhiBlockRuntime } from "../../../../types";
+export declare function buildPhiDefaultAdminLogsPageTree({ page, runtime, }: {
+    page: PhiCmsPageNode;
+    runtime: PhiBlockRuntime;
+}): Promise<PhiResolvedCmsPageTree>;