@phis/ui 0.2.1 → 0.4.0

package/plugins/runtime-modules/user-management/controller/client.js

@@ -3,28 +3,27 @@ import { jsx as _jsx } from "react/jsx-runtime";
 import { useCallback, useEffect, useMemo, useRef, useState } from "react";
 import { PHI_USER_MANAGEMENT_RUNTIME_DATA_PROVIDER_KEYS } from "../ids";
 import { PHI_VIEWER_ACCESS_SITE_ADMIN, canPhiViewerAccess } from "../../../../types/access";
-import { PHI_SIGNAL_VALUE_SCHEMAS, createPhiSignalAddress, createPhiSignalSubcontrolAddress } from "../../../../types/signals";
 import { readPhiTableActionSignalValue } from "../../../../types/table-signal-values";
 import { readPhiOverlayCloseRequest } from "../../../../types/cms-overlay";
 import { createPhiRuntimeControllerClient } from "../../../../components/runtime/runtime-controller-client-factory";
 import { usePhiRuntimeConditionStateResponder } from "../../../../components/runtime/runtime-condition-state-responder";
 import { usePhiSignalDispatcher, usePhiSignalListener } from "../../../../components/runtime/runtime-signal-bus";
+import { dispatchPhiSignalCapability } from "../../../../components/runtime/runtime-signal-identity";
 import { usePhiTableProvider } from "../../../../components/widgets/client/shared/phi-table-provider";
 import { PHI_USER_MANAGEMENT_RUNTIME_CONTROLLER_DEFINITION, } from "../controller/definition";
-import { PHI_USER_MANAGEMENT_PAGE_OVERLAY_IDS, PHI_USER_MANAGEMENT_PAGE_WIDGET_IDS, } from "../addresses";
-function cmsAddress(id) {
-    return createPhiSignalAddress("cms", id);
+/*
+ * The workflow a signal belongs to, read off its channel: the Page routes the create and the edit half
+ * of the dialogs on channels of their own (`createSubmit`, `editCommand`, ...), so nothing here has to
+ * know which Widget sent it.
+ */
+function readFormWorkflow(channel, suffix) {
+    if (channel === `create${suffix}`)
+        return "create";
+    if (channel === `edit${suffix}`)
+        return "edit";
+    return null;
 }
-const EDIT_FORM_ADDRESS = cmsAddress(PHI_USER_MANAGEMENT_PAGE_WIDGET_IDS.widgetEditForm);
-const CREATE_FORM_ADDRESS = cmsAddress(PHI_USER_MANAGEMENT_PAGE_WIDGET_IDS.widgetCreateForm);
-const HISTORY_TABLE_ADDRESS = cmsAddress(PHI_USER_MANAGEMENT_PAGE_WIDGET_IDS.widgetHistoryTable);
-const CREATE_OVERLAY_ADDRESS = cmsAddress(PHI_USER_MANAGEMENT_PAGE_OVERLAY_IDS.overlayCreate);
-const EDIT_OVERLAY_ADDRESS = cmsAddress(PHI_USER_MANAGEMENT_PAGE_OVERLAY_IDS.overlayEdit);
-const CREATE_CANCEL_ADDRESS = createPhiSignalSubcontrolAddress("cms", PHI_USER_MANAGEMENT_PAGE_WIDGET_IDS.widgetCreateCommands, "cancel");
-const CREATE_SAVE_ADDRESS = createPhiSignalSubcontrolAddress("cms", PHI_USER_MANAGEMENT_PAGE_WIDGET_IDS.widgetCreateCommands, "save");
-const EDIT_CANCEL_ADDRESS = createPhiSignalSubcontrolAddress("cms", PHI_USER_MANAGEMENT_PAGE_WIDGET_IDS.widgetEditCommands, "cancel");
-const EDIT_SAVE_ADDRESS = createPhiSignalSubcontrolAddress("cms", PHI_USER_MANAGEMENT_PAGE_WIDGET_IDS.widgetEditCommands, "save");
-function PhiUserManagementControllerView({ address, runtime, }) {
+function PhiUserManagementControllerView({ address, runtime, config, }) {
     const dispatchSignal = usePhiSignalDispatcher();
     const source = useMemo(() => ({
         providerKey: PHI_USER_MANAGEMENT_RUNTIME_DATA_PROVIDER_KEYS.table,
@@ -43,80 +42,24 @@ function PhiUserManagementControllerView({ address, runtime, }) {
      * the same row, because the identity is equal in both and says nothing about which one asked.
      */
     const workflowRef = useRef({ workflow: null, action: null, selectedSelf: true, correlationId: null });
-    const send = useCallback((input) => dispatchSignal({
-        scope: "page",
-        sender: address,
-        receiver: input.receiver,
-        channel: input.channel,
-        action: input.action,
-        value: input.value,
-        valueType: input.valueType,
-        valueSchema: input.valueSchema ?? null,
-        correlationId: input.correlationId,
-        timestamp: Date.now(),
-    }), [address, dispatchSignal]);
+    /*
+     * One declared output, delivered through every route the Page wrote for it. The dialogs, Forms and
+     * Tables were Widget ids of the users Page held in this file; the Page names them now.
+     */
+    const emitRoutes = useMemo(() => config.signalRoutes?.emits ?? [], [config.signalRoutes?.emits]);
+    const emitCapability = useCallback((capabilityId, value, correlationId) => dispatchPhiSignalCapability(dispatchSignal, address, emitRoutes, capabilityId, value, correlationId), [address, dispatchSignal, emitRoutes]);
     const conditionState = useCallback((pending = submitting) => ({
         ready: true,
         permissions: { readOnly },
         selection: { self: workflowRef.current.selectedSelf },
         submission: { pending },
     }), [readOnly, submitting]);
-    const sendConditionState = useCallback((receiver, correlationId) => {
-        send({
-            receiver,
-            channel: "condition",
-            action: "change",
-            value: { state: conditionState() },
-            valueType: "json",
-            valueSchema: PHI_SIGNAL_VALUE_SCHEMAS.runtimeConditionState,
-            correlationId,
-        });
-    }, [conditionState, send]);
     const openOverlay = useCallback((workflow, correlationId) => {
-        const overlayId = workflow === "create"
-            ? PHI_USER_MANAGEMENT_PAGE_OVERLAY_IDS.overlayCreate
-            : workflow === "edit"
-                ? PHI_USER_MANAGEMENT_PAGE_OVERLAY_IDS.overlayEdit
-                : PHI_USER_MANAGEMENT_PAGE_OVERLAY_IDS.overlayHistory;
-        send({
-            receiver: cmsAddress(overlayId),
-            channel: "dialog",
-            action: "activate",
-            value: null,
-            valueType: "none",
-            correlationId,
-        });
-    }, [send]);
+        emitCapability(`${workflow}DialogOpen`, null, correlationId);
+    }, [emitCapability]);
     const closeOverlay = useCallback((workflow, correlationId) => {
-        const overlayId = workflow === "create"
-            ? PHI_USER_MANAGEMENT_PAGE_OVERLAY_IDS.overlayCreate
-            : PHI_USER_MANAGEMENT_PAGE_OVERLAY_IDS.overlayEdit;
-        send({
-            receiver: cmsAddress(overlayId),
-            channel: "dialog",
-            action: "close",
-            value: null,
-            valueType: "none",
-            correlationId,
-        });
-    }, [send]);
-    const formAddressForWorkflow = useCallback((workflow) => workflow === "create" ? CREATE_FORM_ADDRESS : EDIT_FORM_ADDRESS, []);
-    const overlayWorkflowFromSender = useCallback((sender) => sender === CREATE_OVERLAY_ADDRESS
-        ? "create"
-        : sender === EDIT_OVERLAY_ADDRESS
-            ? "edit"
-            : null, []);
-    const commandWorkflowFromSender = useCallback((sender) => sender === CREATE_OVERLAY_ADDRESS ||
-        sender === CREATE_FORM_ADDRESS ||
-        sender === CREATE_CANCEL_ADDRESS ||
-        sender === CREATE_SAVE_ADDRESS
-        ? "create"
-        : sender === EDIT_OVERLAY_ADDRESS ||
-            sender === EDIT_FORM_ADDRESS ||
-            sender === EDIT_CANCEL_ADDRESS ||
-            sender === EDIT_SAVE_ADDRESS
-            ? "edit"
-            : null, []);
+        emitCapability(`${workflow}DialogClose`, null, correlationId);
+    }, [emitCapability]);
     const loadSelectionState = useCallback(async (rowIdentity, correlationId) => {
         if (!provider?.readRecord)
             return;
@@ -130,12 +73,12 @@ function PhiUserManagementControllerView({ address, runtime, }) {
             if (workflowRef.current.correlationId !== correlationId)
                 return;
             workflowRef.current.selectedSelf = record.self === true;
-            sendConditionState(cmsAddress(PHI_USER_MANAGEMENT_PAGE_WIDGET_IDS.widgetEditForm), correlationId);
+            emitCapability("editFormCondition", { state: conditionState() }, correlationId);
         }
         catch {
             workflowRef.current.selectedSelf = true;
         }
-    }, [provider, sendConditionState]);
+    }, [conditionState, emitCapability, provider]);
     usePhiRuntimeConditionStateResponder({ address, scope: "page", state: conditionState });
     usePhiSignalListener(useCallback((signal) => {
         if (signal.receiver !== address)
@@ -176,98 +119,40 @@ function PhiUserManagementControllerView({ address, runtime, }) {
             }
             return;
         }
-        if (signal.channel === "command" && signal.action === "activate" && signal.value === "cancel") {
-            const workflow = commandWorkflowFromSender(signal.sender);
-            if (workflow) {
-                send({
-                    receiver: formAddressForWorkflow(workflow),
-                    channel: "reset",
-                    action: "activate",
-                    value: null,
-                    valueType: "none",
-                    correlationId: signal.correlationId,
-                });
-                closeOverlay(workflow, signal.correlationId);
-            }
+        const commandWorkflow = signal.action === "activate" ? readFormWorkflow(signal.channel, "Command") : null;
+        if (commandWorkflow && signal.value === "cancel") {
+            emitCapability(`${commandWorkflow}FormReset`, null, signal.correlationId);
+            closeOverlay(commandWorkflow, signal.correlationId);
             return;
         }
-        if (signal.channel === "command" && signal.action === "activate" && signal.value === "save") {
-            const workflow = commandWorkflowFromSender(signal.sender);
-            if (!workflow || readOnly || submitting)
+        if (commandWorkflow && signal.value === "save") {
+            if (readOnly || submitting)
                 return;
-            send({
-                receiver: formAddressForWorkflow(workflow),
-                channel: "submit",
-                action: "activate",
-                value: null,
-                valueType: "none",
-                correlationId: signal.correlationId,
-            });
+            emitCapability(`${commandWorkflow}FormSubmit`, null, signal.correlationId);
             return;
         }
-        if (signal.channel === "dialog" && signal.action === "close") {
-            const workflow = overlayWorkflowFromSender(signal.sender);
+        const closeWorkflow = signal.action === "close" ? readFormWorkflow(signal.channel, "Dialog") : null;
+        if (closeWorkflow) {
             const request = readPhiOverlayCloseRequest(signal.value);
-            if (workflow && request && !submitting) {
-                send({
-                    receiver: formAddressForWorkflow(workflow),
-                    channel: "reset",
-                    action: "activate",
-                    value: null,
-                    valueType: "none",
-                    correlationId: signal.correlationId,
-                });
-                closeOverlay(workflow, signal.correlationId);
+            if (request && !submitting) {
+                emitCapability(`${closeWorkflow}FormReset`, null, signal.correlationId);
+                closeOverlay(closeWorkflow, signal.correlationId);
             }
             return;
         }
-        if (signal.channel === "submitting" && signal.action === "change" && typeof signal.value === "boolean") {
-            const workflow = signal.sender === CREATE_FORM_ADDRESS
-                ? "create"
-                : signal.sender === EDIT_FORM_ADDRESS
-                    ? "edit"
-                    : null;
-            if (!workflow)
-                return;
+        const submittingWorkflow = signal.action === "change" ? readFormWorkflow(signal.channel, "Submitting") : null;
+        if (submittingWorkflow && typeof signal.value === "boolean") {
             setSubmitting(signal.value);
-            send({
-                receiver: workflow === "create" ? CREATE_SAVE_ADDRESS : EDIT_SAVE_ADDRESS,
-                channel: "submitting",
-                action: "change",
-                value: signal.value,
-                valueType: "boolean",
-                correlationId: signal.correlationId,
-            });
-            send({
-                receiver: workflow === "create" ? CREATE_OVERLAY_ADDRESS : EDIT_OVERLAY_ADDRESS,
-                channel: "condition",
-                action: "change",
-                value: { state: conditionState(signal.value) },
-                valueType: "json",
-                valueSchema: PHI_SIGNAL_VALUE_SCHEMAS.runtimeConditionState,
-                correlationId: signal.correlationId,
-            });
+            emitCapability(`${submittingWorkflow}SaveSubmitting`, signal.value, signal.correlationId);
+            emitCapability(`${submittingWorkflow}DialogCondition`, { state: conditionState(signal.value) }, signal.correlationId);
             return;
         }
-        if (signal.channel === "submit" && signal.action === "activate") {
-            const workflow = signal.sender === cmsAddress(PHI_USER_MANAGEMENT_PAGE_WIDGET_IDS.widgetCreateForm)
-                ? "create"
-                : signal.sender === cmsAddress(PHI_USER_MANAGEMENT_PAGE_WIDGET_IDS.widgetEditForm)
-                    ? "edit"
-                    : null;
-            if (!workflow)
-                return;
-            closeOverlay(workflow, signal.correlationId);
-            send({
-                receiver: cmsAddress(PHI_USER_MANAGEMENT_PAGE_WIDGET_IDS.widgetTable),
-                channel: "reload",
-                action: "activate",
-                value: null,
-                valueType: "none",
-                correlationId: signal.correlationId,
-            });
+        const successWorkflow = signal.action === "activate" ? readFormWorkflow(signal.channel, "Submit") : null;
+        if (successWorkflow) {
+            closeOverlay(successWorkflow, signal.correlationId);
+            emitCapability("usersReload", null, signal.correlationId);
         }
-    }, [address, closeOverlay, commandWorkflowFromSender, conditionState, formAddressForWorkflow, loadSelectionState, openOverlay, overlayWorkflowFromSender, readOnly, send, submitting]), {
+    }, [address, closeOverlay, conditionState, emitCapability, loadSelectionState, openOverlay, readOnly, submitting]), {
         scopes: ["page"],
         receiver: address,
     });
@@ -283,34 +168,18 @@ function PhiUserManagementControllerView({ address, runtime, }) {
             return;
         if (workflowState.workflow === "edit") {
             deliveredWorkflowRef.current = deliveryKey;
-            send({
-                receiver: EDIT_FORM_ADDRESS,
-                channel: "action",
-                action: "activate",
-                value: workflowState.action,
-                valueType: "json",
-                valueSchema: PHI_SIGNAL_VALUE_SCHEMAS.tableAction,
-                correlationId: workflowState.correlationId,
-            });
+            emitCapability("editRecordOpen", workflowState.action, workflowState.correlationId);
             return;
         }
         if (workflowState.action.rowIdentity == null)
             return;
         deliveredWorkflowRef.current = deliveryKey;
-        send({
-            receiver: HISTORY_TABLE_ADDRESS,
-            channel: "filters",
-            action: "change",
-            value: { userId: workflowState.action.rowIdentity },
-            valueType: "json",
-            valueSchema: PHI_SIGNAL_VALUE_SCHEMAS.tableFilters,
-            correlationId: workflowState.correlationId,
-        });
-    }, [send, workflowState]);
+        emitCapability("historyFilters", { userId: workflowState.action.rowIdentity }, workflowState.correlationId);
+    }, [emitCapability, workflowState]);
     return null;
 }
 export const PHI_USER_MANAGEMENT_RUNTIME_CONTROLLER_PLUGIN = {
     ...PHI_USER_MANAGEMENT_RUNTIME_CONTROLLER_DEFINITION,
-    renderController: ({ key, address, runtime }) => (_jsx(PhiUserManagementControllerView, { address: address, runtime: runtime }, key)),
+    renderController: ({ key, address, runtime, config }) => (_jsx(PhiUserManagementControllerView, { address: address, runtime: runtime, config: config }, key)),
 };
 export const PhiUserManagementRuntimeControllerClient = createPhiRuntimeControllerClient(PHI_USER_MANAGEMENT_RUNTIME_CONTROLLER_PLUGIN);

package/plugins/runtime-modules/user-management/controller/definition.d.ts

@@ -1,4 +1,11 @@
-export type PhiUserManagementControllerConfig = Record<string, never>;
+import { type PhiSignalRouteSet } from "../../../../types/signals";
+/**
+ * Whom the Controller answers into: the users Table, the three dialogs, the two Forms and their save
+ * buttons, and the login history. The Page that holds them says so (`controllerSettings`).
+ */
+export type PhiUserManagementControllerConfig = {
+    signalRoutes: PhiSignalRouteSet | null;
+};
 export declare const PHI_USER_MANAGEMENT_RUNTIME_CONTROLLER_DEFINITION: {
     kind: "controller";
     pluginKey: string;
@@ -10,22 +17,27 @@ export declare const PHI_USER_MANAGEMENT_RUNTIME_CONTROLLER_DEFINITION: {
     runtimeSignals: {
         emits: ({
             id: string;
-            action: "activate";
+            action: "close";
             valueType: "none";
             valueSchema?: undefined;
         } | {
             id: string;
-            action: "close";
+            action: "activate";
             valueType: "none";
             valueSchema?: undefined;
         } | {
             id: string;
-            action: "activate";
+            action: "change";
+            valueType: "boolean";
+            valueSchema?: undefined;
+        } | {
+            id: string;
+            action: "change";
             valueType: "json";
             valueSchema: `${string}/signals/${string}`;
         } | {
             id: string;
-            action: "change";
+            action: "activate";
             valueType: "json";
             valueSchema: `${string}/signals/${string}`;
         })[];
@@ -58,9 +70,10 @@ export declare const PHI_USER_MANAGEMENT_RUNTIME_CONTROLLER_DEFINITION: {
             channel: string;
             action: "reload";
             valueType: "none";
-            valueSchema?: undefined;
         })[];
     };
-    defaultConfig: {};
-    parseConfig: () => PhiUserManagementControllerConfig;
+    defaultConfig: {
+        signalRoutes: null;
+    };
+    parseConfig: (raw: Record<string, unknown>) => PhiUserManagementControllerConfig;
 };

package/plugins/runtime-modules/user-management/controller/definition.js

@@ -1,5 +1,40 @@
-import { PHI_SIGNAL_VALUE_SCHEMAS } from "../../../../types/signals";
+import { PHI_SIGNAL_VALUE_SCHEMAS, readPhiSignalRouteSet, } from "../../../../types/signals";
 import { PHI_USER_MANAGEMENT_CONTROLLER_KEY, PHI_USER_MANAGEMENT_CONTROLLER_PLUGIN_KEY } from "../controller/address";
+/*
+ * Which workflow a signal belongs to is said by its channel, not by who sent it. The create and edit
+ * dialogs are the same Overlay, Form and toolbar twice, and telling them apart by sender meant holding
+ * every one of their Widget ids here -- so the Page routes each half on its own channel instead.
+ */
+const workflowListens = ["create", "edit"].flatMap((workflow) => [
+    {
+        id: `${workflow}FormSuccess`,
+        channel: `${workflow}Submit`,
+        action: "activate",
+        valueType: "json",
+        valueSchema: PHI_SIGNAL_VALUE_SCHEMAS.formResult,
+    },
+    { id: `${workflow}Command`, channel: `${workflow}Command`, action: "activate", valueType: "string" },
+    { id: `${workflow}Submitting`, channel: `${workflow}Submitting`, action: "change", valueType: "boolean" },
+    {
+        id: `${workflow}CloseRequest`,
+        channel: `${workflow}Dialog`,
+        action: "close",
+        valueType: "json",
+        valueSchema: PHI_SIGNAL_VALUE_SCHEMAS.overlayCloseRequest,
+    },
+]);
+const workflowEmits = ["create", "edit"].flatMap((workflow) => [
+    { id: `${workflow}DialogClose`, action: "close", valueType: "none" },
+    { id: `${workflow}FormSubmit`, action: "activate", valueType: "none" },
+    { id: `${workflow}FormReset`, action: "activate", valueType: "none" },
+    { id: `${workflow}SaveSubmitting`, action: "change", valueType: "boolean" },
+    {
+        id: `${workflow}DialogCondition`,
+        action: "change",
+        valueType: "json",
+        valueSchema: PHI_SIGNAL_VALUE_SCHEMAS.runtimeConditionState,
+    },
+]);
 export const PHI_USER_MANAGEMENT_RUNTIME_CONTROLLER_DEFINITION = {
     kind: "controller",
     pluginKey: PHI_USER_MANAGEMENT_CONTROLLER_PLUGIN_KEY,
@@ -10,23 +45,29 @@ export const PHI_USER_MANAGEMENT_RUNTIME_CONTROLLER_DEFINITION = {
     allowedMountScopes: ["page"],
     runtimeSignals: {
         emits: [
-            { id: "dialogOpen", action: "activate", valueType: "none" },
-            { id: "dialogClose", action: "close", valueType: "none" },
+            { id: "createDialogOpen", action: "activate", valueType: "none" },
+            { id: "editDialogOpen", action: "activate", valueType: "none" },
+            { id: "historyDialogOpen", action: "activate", valueType: "none" },
+            ...workflowEmits,
             {
-                id: "recordOpen",
+                id: "editRecordOpen",
                 action: "activate",
                 valueType: "json",
                 valueSchema: PHI_SIGNAL_VALUE_SCHEMAS.tableAction,
             },
             {
-                id: "filtersChange",
+                id: "editFormCondition",
+                action: "change",
+                valueType: "json",
+                valueSchema: PHI_SIGNAL_VALUE_SCHEMAS.runtimeConditionState,
+            },
+            {
+                id: "historyFilters",
                 action: "change",
                 valueType: "json",
                 valueSchema: PHI_SIGNAL_VALUE_SCHEMAS.tableFilters,
             },
-            { id: "reload", action: "activate", valueType: "none" },
-            { id: "formSubmit", action: "activate", valueType: "none" },
-            { id: "formReset", action: "activate", valueType: "none" },
+            { id: "usersReload", action: "activate", valueType: "none" },
             {
                 id: "conditionStateChange",
                 action: "change",
@@ -42,26 +83,13 @@ export const PHI_USER_MANAGEMENT_RUNTIME_CONTROLLER_DEFINITION = {
                 valueType: "json",
                 valueSchema: PHI_SIGNAL_VALUE_SCHEMAS.tableAction,
             },
-            {
-                id: "formSuccess",
-                channel: "submit",
-                action: "activate",
-                valueType: "json",
-                valueSchema: PHI_SIGNAL_VALUE_SCHEMAS.formResult,
-            },
-            { id: "formCommand", channel: "command", action: "activate", valueType: "string" },
-            { id: "formSubmitting", channel: "submitting", action: "change", valueType: "boolean" },
-            {
-                id: "overlayCloseRequest",
-                channel: "dialog",
-                action: "close",
-                valueType: "json",
-                valueSchema: PHI_SIGNAL_VALUE_SCHEMAS.overlayCloseRequest,
-            },
+            ...workflowListens,
             { id: "overlayState", channel: "state", action: "change", valueType: "boolean" },
             { id: "conditionStateRequest", channel: "condition", action: "reload", valueType: "none" },
         ],
     },
-    defaultConfig: {},
-    parseConfig: () => ({}),
+    defaultConfig: { signalRoutes: null },
+    parseConfig: (raw) => ({
+        signalRoutes: readPhiSignalRouteSet(raw.signalRoutes),
+    }),
 };

package/plugins/runtime-modules/user-management/definition.d.ts

@@ -1,5 +1,4 @@
 export declare const PHI_USER_MANAGEMENT_RUNTIME_MODULE_DEFINITION: {
-    moduleId: "@phis/ui/modules/user-management";
     kind: "module";
     eligibleAreas: readonly ["admin"];
     serverBinding: import("../../../types").PhiRuntimeModuleServerBinding;
@@ -184,4 +183,5 @@ export declare const PHI_USER_MANAGEMENT_RUNTIME_MODULE_DEFINITION: {
             actions?: undefined;
         })[];
     }[];
+    moduleId: "@phis/ui/modules/user-management";
 };

package/plugins/runtime-modules/user-management/definition.js

@@ -1,12 +1,12 @@
 import { PHI_USER_MANAGEMENT_RUNTIME_CONTROLLER_DEFINITION } from "../../../plugins/runtime-modules/user-management/controller/definition";
 import { PHI_USER_MANAGEMENT_CONTROLLER_TYPE } from "../../../plugins/runtime-modules/user-management/controller/address";
 import { buildPhiRuntimeModuleControllerDescriptor } from "../contracts";
-import { PHI_USER_MANAGEMENT_RUNTIME_MODULE_ID } from "./ids";
+import { PHI_USER_MANAGEMENT_RUNTIME_MODULE_IDENTITY } from "./ids";
 import { PHI_CORE_SERVER_BINDING } from "../../../types/server-capabilities";
 import { PHI_USER_MANAGEMENT_RUNTIME_DATA_PROVIDER_DESCRIPTORS } from "./data-providers";
 import { PHI_USER_MANAGEMENT_FORM_HANDLER_PROVIDER_DESCRIPTORS } from "../../../plugins/runtime-modules/user-management/forms";
 export const PHI_USER_MANAGEMENT_RUNTIME_MODULE_DEFINITION = {
-    moduleId: PHI_USER_MANAGEMENT_RUNTIME_MODULE_ID,
+    ...PHI_USER_MANAGEMENT_RUNTIME_MODULE_IDENTITY,
     kind: "module",
     eligibleAreas: ["admin"],
     serverBinding: PHI_CORE_SERVER_BINDING,

package/plugins/runtime-modules/user-management/forms.d.ts

@@ -2,10 +2,6 @@ export declare const PHI_USER_MANAGEMENT_FORM_IDS: {
     readonly create: `${string}/forms/${string}`;
     readonly edit: `${string}/forms/${string}`;
 };
-export declare const PHI_USER_MANAGEMENT_FORM_HANDLER_KEYS: {
-    readonly create: "site.user-management.create";
-    readonly edit: "site.user-management.edit";
-};
 export declare const PHI_USER_MANAGEMENT_RUNTIME_MODULE_FORMS: readonly [import("../contracts").PhiRuntimeModuleFormDefinition, import("../contracts").PhiRuntimeModuleFormDefinition];
 export declare const PHI_USER_MANAGEMENT_FORM_HANDLER_PROVIDER_DESCRIPTORS: {
     key: `${string}/${string}`;

package/plugins/runtime-modules/user-management/forms.js

@@ -1,17 +1,16 @@
+import { createPhiFormLabelSetLoader } from "../../../components/forms/shared-form-loaders";
 import { PHI_BASE_ROLE_OPTIONS } from "../../../constants/phi-base-role-metadata";
 import { PHI_USER_MANAGEMENT_RUNTIME_MODULE_ID } from "../../../plugins/runtime-modules/user-management/ids";
 import { createPhiFormId } from "../../../types/form-id";
 import { PHI_SHARED_PACKAGE_NAME } from "../../../types/signals";
-import { flattenPhiFormLabels } from "../../../components/forms/form-labels";
 import { PHI_FORM_FIELD_PROVIDER_KEYS, PHI_FORM_VALIDATION_PROVIDER_KEYS, createPhiSharedFormProviderKey, } from "../../../components/forms/form-provider-contract";
 import { definePhiRuntimeModuleForm } from "../../../components/forms/form-registry";
 import { createPhiUserManagementControllerAddress } from "./controller/address";
-import { readPhiServerApiCredentials } from "../../../helpers/phis-server-credentials";
 export const PHI_USER_MANAGEMENT_FORM_IDS = {
     create: createPhiFormId(PHI_SHARED_PACKAGE_NAME, "user-management/create"),
     edit: createPhiFormId(PHI_SHARED_PACKAGE_NAME, "user-management/edit"),
 };
-export const PHI_USER_MANAGEMENT_FORM_HANDLER_KEYS = {
+const PHI_USER_MANAGEMENT_FORM_HANDLER_KEYS = {
     create: "site.user-management.create",
     edit: "site.user-management.edit",
 };
@@ -75,6 +74,14 @@ const identityFields = [
         ],
         disabledWhen: readOnlyCondition,
     },
+    // The name a reader is shown where it is not the first and last name; empty is those two.
+    {
+        key: "displayName",
+        fieldProviderKey: PHI_FORM_FIELD_PROVIDER_KEYS.text,
+        label: label("displayName", "Display name"),
+        autoComplete: "nickname",
+        disabledWhen: readOnlyCondition,
+    },
     {
         key: "companyName",
         fieldProviderKey: PHI_FORM_FIELD_PROVIDER_KEYS.text,
@@ -129,37 +136,30 @@ function descriptor(formId, mode) {
         },
     };
 }
-async function loadLabels(context) {
-    const { getPhiAdminUsersTableWidgetLabels } = await import("../../../components/widgets/label-sets/admin-users");
-    const labels = await getPhiAdminUsersTableWidgetLabels({
-        apiBaseUrl: readPhiServerApiCredentials().apiBaseUrl,
-        internalToken: readPhiServerApiCredentials().internalToken,
-        locale: context.runtime.locale.current,
-    });
-    return flattenPhiFormLabels({
-        firstName: labels.editor.firstName,
-        firstNameRequired: labels.editor.firstName,
-        lastName: labels.editor.lastName,
-        lastNameRequired: labels.editor.lastName,
-        email: labels.editor.email,
-        emailRequired: labels.editor.email,
-        emailInvalid: labels.editor.email,
-        company: labels.editor.company,
-        roles: labels.editor.roles,
-        rolesPlaceholder: labels.editor.rolesPlaceholder,
-        rolesHint: labels.editor.selfRoleHint,
-        authOnlyHint: labels.editor.authOnlyHint,
-        createPasswordHint: labels.editor.createPasswordHint,
-        enabled: labels.columns.enabled,
-        changePassword: labels.editor.changePassword,
-        create: labels.editor.createButton,
-        creating: labels.editor.createButton,
-        save: labels.editor.saveButton,
-        saving: labels.editor.saveButton,
-        cancel: labels.confirm.cancel,
-        ...Object.fromEntries(PHI_BASE_ROLE_OPTIONS.map((option) => [`role_${option.value}`, option.label])),
-    });
-}
+const loadLabels = createPhiFormLabelSetLoader(() => import("../../../components/widgets/label-sets/admin-users").then((module) => module.getPhiAdminUsersTableWidgetLabels), (labels) => ({
+    firstName: labels.editor.firstName,
+    firstNameRequired: labels.editor.firstNameRequired,
+    lastName: labels.editor.lastName,
+    lastNameRequired: labels.editor.lastNameRequired,
+    email: labels.editor.email,
+    emailRequired: labels.editor.emailRequired,
+    emailInvalid: labels.editor.emailInvalid,
+    displayName: labels.editor.displayName,
+    company: labels.editor.company,
+    roles: labels.editor.roles,
+    rolesPlaceholder: labels.editor.rolesPlaceholder,
+    rolesHint: labels.editor.selfRoleHint,
+    authOnlyHint: labels.editor.authOnlyHint,
+    createPasswordHint: labels.editor.createPasswordHint,
+    enabled: labels.columns.enabled,
+    changePassword: labels.editor.changePassword,
+    create: labels.editor.createButton,
+    creating: labels.editor.creatingButton,
+    save: labels.editor.saveButton,
+    saving: labels.editor.savingButton,
+    cancel: labels.confirm.cancel,
+    ...Object.fromEntries(PHI_BASE_ROLE_OPTIONS.map((option) => [`role_${option.value}`, option.label])),
+}));
 export const PHI_USER_MANAGEMENT_RUNTIME_MODULE_FORMS = [
     definePhiRuntimeModuleForm({
         ownerModuleId: PHI_USER_MANAGEMENT_RUNTIME_MODULE_ID,

package/plugins/runtime-modules/user-management/ids.d.ts

@@ -1,4 +1,13 @@
 export declare const PHI_USER_MANAGEMENT_RUNTIME_MODULE_ID: "@phis/ui/modules/user-management";
+/**
+ * The Module's identity as its Label Sets inherit it (`definePhiRuntimeModuleLabelSet`): the id and,
+ * where a Module declares one, its source locale. Stated here beside the id and spread into the
+ * definition, so a Label Set a tree or a form reads does not import the definition that imports the
+ * tree -- and a Module that writes in another language says so once.
+ */
+export declare const PHI_USER_MANAGEMENT_RUNTIME_MODULE_IDENTITY: {
+    readonly moduleId: "@phis/ui/modules/user-management";
+};
 export declare const PHI_USER_MANAGEMENT_RUNTIME_DATA_PROVIDER_KEYS: {
     readonly table: `${string}/${string}`;
 };

package/plugins/runtime-modules/user-management/ids.js

@@ -1,6 +1,15 @@
 import { PHI_SHARED_PACKAGE_NAME } from "../../../types/signals";
 import { createPhiSharedRuntimeDataProviderKey } from "../../../constants/runtime-data-provider-key";
 export const PHI_USER_MANAGEMENT_RUNTIME_MODULE_ID = `${PHI_SHARED_PACKAGE_NAME}/modules/user-management`;
+/**
+ * The Module's identity as its Label Sets inherit it (`definePhiRuntimeModuleLabelSet`): the id and,
+ * where a Module declares one, its source locale. Stated here beside the id and spread into the
+ * definition, so a Label Set a tree or a form reads does not import the definition that imports the
+ * tree -- and a Module that writes in another language says so once.
+ */
+export const PHI_USER_MANAGEMENT_RUNTIME_MODULE_IDENTITY = {
+    moduleId: PHI_USER_MANAGEMENT_RUNTIME_MODULE_ID,
+};
 export const PHI_USER_MANAGEMENT_RUNTIME_DATA_PROVIDER_KEYS = {
     table: createPhiSharedRuntimeDataProviderKey("tables", "user-management"),
 };