@kosdev-code/kos-ddk-model-components 3.1.1 → 3.1.3

package/index.js

@@ -3,11 +3,11 @@ import { jsx, jsxs, Fragment } from "@emotion/react/jsx-runtime";
 import styled from "@emotion/styled";
 import { useComponentConfigurationContext, Modal, Header, BackButton, Content as Content$1, InfoCard, Footer as Footer$6, Button, CloseButton, ProgressBar, LabelInformation, BodyMediumInformation, InputCard, WorkflowModal, StatusIndicator, InputRangeCard, ToggleCard, PickerCard, Card, SwitchCard, MultiPickerCard, LabelDate, Table, LabelInformationExtraSmall, getItemData, TapAndHoldButton, ComponentConfigurationProvider, useAbbreviation, getFillColor, HolderDashboardCard, FuelGauge, UtilityModalHeading, FrameContainer, FrameBody, TabContainer, SettingsSubheading, StatusCard, NotificationCard, TabViewLayout, TabRouter, Tabs, CompactCloseButton, QuestionIconStyle, CancelProceedFooter, ErrorInputCard, StatusBar, ModalContainer, InfoContainer, FailureCard, useNavigate, Sidebar, HeadingExtraLarge, InfoMessage, InstructionCard, SwitchPickerCard } from "@kosdev-code/kos-ddk-components";
 import React, { useState, useEffect, useCallback, useMemo, createContext, useContext, useRef, useLayoutEffect, Suspense } from "react";
-import { AgitationControl, toTimeComponents, toSeconds, Animation, Application, CarbWater, CopyLogs, DashboardOperations, DispenserInfo, Door, IngredientSummary, MacroAssignment, NetworkTest, NetworkTestContainer, NutritiveSweetener, PlainWater, Lockout, TroubleActionManager, DDKModels, Reboot, Settings, SetupStep, SetupStepContainer, Start, Utilities, UtilitiesContainer, troubleVisibilityFilter } from "@kosdev-code/kos-ddk-models";
+import { AgitationControl, toTimeComponents, toSeconds, Animation, Application, CarbWater, CopyLogs, DashboardOperations, DispenserInfo, Door, IngredientSummary, MacroAssignment, NetworkTest, NetworkTestContainer, NutritiveSweetener, PlainWater, registerDdkMock, Lockout, TroubleActionManager, DDKModels, Reboot, Settings, SetupStep, SetupStepContainer, Start, Utilities, UtilitiesContainer, troubleVisibilityFilter } from "@kosdev-code/kos-ddk-models";
 import { SuccessIcon, MessageErrorIcon, TimeIcon, CalendarIcon, MessageInformationIconWithBackground } from "@kosdev-code/kos-ddk-styles";
 import { DispenseExtensionManager, Assembly, Pump, useBoardContainer, withAssembly } from "@kosdev-code/kos-dispense-sdk";
 import { FcmPump, SpmPump, CgpPump, LfcvPump, KosModelRegistry, CarbAgitator, KosExtensionManager, FreestyleAssembly, FreestyleHolder, useFreestyleAssemblyContext, FreestylePump } from "@kosdev-code/kos-freestyle-sdk";
-import { useKosPluginsContext, useReactiveExtensionRegistry, useExtensionComponent, DynamicComponent } from "@kosdev-code/kos-ui-plugin";
+import { useKosPluginsContext, buildRankedExtensionMap, useReactiveExtensionRegistry, useExtensionComponent, DynamicComponent } from "@kosdev-code/kos-ui-plugin";
 import { createExtensionSchema, extensionPointId, defineExtensionPoint, createViewAwareTransform, validateWithSchema, validateRankIfPresent, validateDescriptorFormat } from "@kosdev-code/kos-ui-plugin/utilities";
 import { useLocation, useSearchParams } from "react-router-dom";
 class IntentAction {
@@ -5397,9 +5397,9 @@ const DashboardSummarySchema = createExtensionSchema(
   },
   { rankable: true }
 );
-const EXTENSION_ID$8 = extensionPointId("ddk", "dashboard", "summary");
+const EXTENSION_ID$9 = extensionPointId("ddk", "dashboard", "summary");
 const DashboardSummaryExtension = defineExtensionPoint({
-  id: EXTENSION_ID$8,
+  id: EXTENSION_ID$9,
   contributionKey: "dashboardSummary",
   displayName: "Dashboard Summary",
   description: "Extension point for dashboard summary plugin configurations with view support",
@@ -5419,9 +5419,9 @@ const DashboardSummaryExtension = defineExtensionPoint({
   },
   transform: createViewAwareTransform()
 });
-const EXTENSION_POINT_DASHBOARD_SUMMARY = EXTENSION_ID$8;
-const EXTENSION_POINT_DASHBOARD_SUMMARY_DEF = `${EXTENSION_ID$8}.def`;
-const EXTENSION_POINT_DASHBOARD_SUMMARY_VIEW = `${EXTENSION_ID$8}.view`;
+const EXTENSION_POINT_DASHBOARD_SUMMARY = EXTENSION_ID$9;
+const EXTENSION_POINT_DASHBOARD_SUMMARY_DEF = `${EXTENSION_ID$9}.def`;
+const EXTENSION_POINT_DASHBOARD_SUMMARY_VIEW = `${EXTENSION_ID$9}.view`;
 const DashboardDetailSchema = createExtensionSchema(
   {
     type: literalType("dashboard.detail").describe("Extension type, must be 'dashboard.detail'"),
@@ -5429,9 +5429,9 @@ const DashboardDetailSchema = createExtensionSchema(
   },
   { rankable: true }
 );
-const EXTENSION_ID$7 = extensionPointId("ddk", "dashboard", "detail");
+const EXTENSION_ID$8 = extensionPointId("ddk", "dashboard", "detail");
 const DashboardDetailExtension = defineExtensionPoint({
-  id: EXTENSION_ID$7,
+  id: EXTENSION_ID$8,
   contributionKey: "dashboardDetail",
   displayName: "Dashboard Detail",
   description: "Extension point for dashboard detail plugin configurations with view support",
@@ -5451,9 +5451,9 @@ const DashboardDetailExtension = defineExtensionPoint({
   },
   transform: createViewAwareTransform()
 });
-const EXTENSION_POINT_DASHBOARD_DETAIL = EXTENSION_ID$7;
-const EXTENSION_POINT_DASHBOARD_DETAIL_DEF = `${EXTENSION_ID$7}.def`;
-const EXTENSION_POINT_DASHBOARD_DETAIL_VIEW = `${EXTENSION_ID$7}.view`;
+const EXTENSION_POINT_DASHBOARD_DETAIL = EXTENSION_ID$8;
+const EXTENSION_POINT_DASHBOARD_DETAIL_DEF = `${EXTENSION_ID$8}.def`;
+const EXTENSION_POINT_DASHBOARD_DETAIL_VIEW = `${EXTENSION_ID$8}.view`;
 const DashboardPumpDetailSchema = createExtensionSchema(
   {
     type: literalType("dashboard.detail.pump").describe("Extension type, must be 'dashboard.detail.pump'"),
@@ -5463,9 +5463,9 @@ const DashboardPumpDetailSchema = createExtensionSchema(
   },
   { rankable: true }
 );
-const EXTENSION_ID$6 = extensionPointId("ddk", "dashboard", "pump-detail");
+const EXTENSION_ID$7 = extensionPointId("ddk", "dashboard", "pump-detail");
 const DashboardPumpDetailExtension = defineExtensionPoint({
-  id: EXTENSION_ID$6,
+  id: EXTENSION_ID$7,
   contributionKey: "dashboardPumpDetail",
   displayName: "Dashboard Pump Detail",
   description: "Extension point for dashboard pump detail plugin configurations with view support",
@@ -5483,9 +5483,42 @@ const DashboardPumpDetailExtension = defineExtensionPoint({
   },
   transform: createViewAwareTransform()
 });
-const EXTENSION_POINT_DASHBOARD_PUMP_DETAIL = EXTENSION_ID$6;
-const EXTENSION_POINT_DASHBOARD_PUMP_DETAIL_DEF = `${EXTENSION_ID$6}.def`;
-const EXTENSION_POINT_DASHBOARD_PUMP_DETAIL_VIEW = `${EXTENSION_ID$6}.view`;
+const EXTENSION_POINT_DASHBOARD_PUMP_DETAIL = EXTENSION_ID$7;
+const EXTENSION_POINT_DASHBOARD_PUMP_DETAIL_DEF = `${EXTENSION_ID$7}.def`;
+const EXTENSION_POINT_DASHBOARD_PUMP_DETAIL_VIEW = `${EXTENSION_ID$7}.view`;
+const DashboardPumpSummarySchema = createExtensionSchema(
+  {
+    type: literalType("dashboard.summary.pump").describe("Extension type, must be 'dashboard.summary.pump'"),
+    dashboardKey: stringType().min(1, "Dashboard key is required").describe(
+      "Key used to match this extension with dashboard pumps: the holder's dashboard key, by default its first pump's type (e.g. 'cgp', 'lfcv')."
+    )
+  },
+  { rankable: true }
+);
+const EXTENSION_ID$6 = extensionPointId("ddk", "dashboard", "pump-summary");
+const DashboardPumpSummaryExtension = defineExtensionPoint({
+  id: EXTENSION_ID$6,
+  contributionKey: "dashboardPumpSummary",
+  displayName: "Dashboard Pump Summary",
+  description: "Extension point for the body of a holder's dashboard card by pump type; the card keeps its default body when none matches",
+  hasView: true,
+  isRankable: true,
+  schema: DashboardPumpSummarySchema,
+  metadata: {
+    exportName: "DashboardPumpSummaryExtension",
+    category: "Dashboard"
+  },
+  validate: (data, context) => {
+    if (!validateWithSchema(DashboardPumpSummarySchema, data, context)) {
+      return;
+    }
+    validateRankIfPresent(data, context);
+  },
+  transform: createViewAwareTransform()
+});
+const EXTENSION_POINT_DASHBOARD_PUMP_SUMMARY = EXTENSION_ID$6;
+const EXTENSION_POINT_DASHBOARD_PUMP_SUMMARY_DEF = `${EXTENSION_ID$6}.def`;
+const EXTENSION_POINT_DASHBOARD_PUMP_SUMMARY_VIEW = `${EXTENSION_ID$6}.view`;
 const DashboardMacroSummarySchema = createExtensionSchema(
   {
     type: literalType("dashboard.macro.summary").describe("Extension type, must be 'dashboard.macro.summary'"),
@@ -5551,11 +5584,14 @@ const CuiExtension = defineExtensionPoint({
 const EXTENSION_POINT_CUI = EXTENSION_ID$4;
 const EXTENSION_POINT_CUI_DEF = `${EXTENSION_ID$4}.def`;
 const EXTENSION_POINT_CUI_VIEW = `${EXTENSION_ID$4}.view`;
-const NavViewSchema = createExtensionSchema({
-  navDescriptor: stringType().min(1, "Navigation descriptor is required").describe(
-    "Descriptor used to identify and map the navigation functionality"
-  )
-});
+const NavViewSchema = createExtensionSchema(
+  {
+    navDescriptor: stringType().min(1, "Navigation descriptor is required").describe(
+      "Descriptor used to identify and map the navigation functionality"
+    )
+  },
+  { rankable: true }
+);
 const EXTENSION_ID$3 = extensionPointId("ddk", "nav", "view");
 const NavViewExtension = defineExtensionPoint({
   id: EXTENSION_ID$3,
@@ -5563,7 +5599,7 @@ const NavViewExtension = defineExtensionPoint({
   displayName: "Navigation Views",
   description: "Extension point for navigation view plugin configurations with view support",
   hasView: true,
-  isRankable: false,
+  isRankable: true,
   schema: NavViewSchema,
   metadata: {
     exportName: "NavViewExtension",
@@ -5579,6 +5615,7 @@ const NavViewExtension = defineExtensionPoint({
       data.navDescriptor,
       context
     );
+    validateRankIfPresent(data, context);
   },
   transform: createViewAwareTransform()
 });
@@ -5716,7 +5753,10 @@ const useViewExtensions = ({
   const setupStepsExt = getExtensions(extensionPoint);
   const namespaces = setupStepsExt.map((ext) => ext.data.namespace) || [];
   const { t } = useKosTranslation([defaultNamespace, ...new Set(namespaces)]);
-  const contributionMap = setupStepsExt.reduce(
+  const rankedSteps = Object.values(
+    buildRankedExtensionMap(setupStepsExt, EXT_KEY[extensionPoint])
+  );
+  const contributionMap = rankedSteps.reduce(
     (acc, _step) => {
       const step = _step;
       const data = step.data;
@@ -5730,7 +5770,7 @@ const useViewExtensions = ({
     },
     {}
   );
-  const labelMap = setupStepsExt.reduce((acc, _step) => {
+  const labelMap = rankedSteps.reduce((acc, _step) => {
     const step = _step;
     const data = step.data;
     acc[data[EXT_KEY[extensionPoint]]] = `${data.namespace}:${data.title}`;
@@ -5976,6 +6016,7 @@ const UTILITIES_EXTENSION_ID = EXTENSION_POINT_IDS.UTILITIES;
 DashboardSummaryExtension.register();
 DashboardDetailExtension.register();
 DashboardPumpDetailExtension.register();
+DashboardPumpSummaryExtension.register();
 DashboardMacroSummaryExtension.register();
 CuiExtension.register();
 NavViewExtension.register();
@@ -5995,6 +6036,10 @@ console.log(
   `Registered DashboardPumpDetailExtension:`,
   DashboardPumpDetailExtension.id
 );
+console.log(
+  `Registered DashboardPumpSummaryExtension:`,
+  DashboardPumpSummaryExtension.id
+);
 console.log(
   `Registered DashboardMacroSummaryExtension:`,
   DashboardMacroSummaryExtension.id
@@ -6005,6 +6050,7 @@ console.log(`Registered SetupExtension:`, SetupExtension.id);
 console.log(`Registered TroubleActionExtension:`, TroubleActionExtension.id);
 console.log(`Registered ViewExtension:`, ViewExtension.id);
 const initDDKRegistration = () => {
+  registerDdkMock();
   KosModelRegistry.freestyle.models().model(Lockout).model(Device).model(TroubleActionManager).model(CopyLogs).model(Door).model(AgitationControl).companion(Assembly.type, () => {
     if (KosFeatureFlags.isFeatureEnabled("carbTank")) {
       return CarbAgitator.type;
@@ -6033,8 +6079,7 @@ const initDDKRegistration = () => {
     return true;
   };
   const remoteNNSVisibilityMapper = (id, context) => {
-    if (id !== "settings.remoteNNS" && id !== "dashboard.remoteNNS")
-      return true;
+    if (id !== "settings.remote-nns") return true;
     if (!context) return true;
     const { assembly } = context;
     if (!assembly) return true;
@@ -6197,9 +6242,12 @@ function withStart(WrappedComponent) {
 const useTroubleActionState = () => {
   const modelId = TroubleActionManager.type;
   const { getExtensions } = usePluginExtensions();
-  const troubleActionExtensions = getExtensions(TroubleActionExtension.id).map(
-    (ext) => ext.data
-  );
+  const troubleActionExtensions = Object.values(
+    buildRankedExtensionMap(
+      getExtensions(TroubleActionExtension.id),
+      "troubleType"
+    )
+  ).map((ext) => ext.data);
   const result = useKosModel({
     modelId,
     modelType: TroubleActionManager.type,
@@ -6877,6 +6925,9 @@ const useVisibleTroubles = (holder) => {
   return { visibleTroubles, initialized };
 };
 const log$2 = KosLog.createLogger({ name: "holder-group-view" });
+const rankedByDashboardKey = (exts) => Object.fromEntries(
+  Object.entries(buildRankedExtensionMap(exts, "dashboardKey")).filter(([, ext]) => !!ext.data).map(([dashboardKey, ext]) => [dashboardKey, ext.data])
+);
 log$2.debug("holder-group-view component loaded");
 const CardTitle$1 = styled.div`
   align-items: start;
@@ -6961,7 +7012,26 @@ const HolderCard = kosComponent(
       " ",
       ingredientName
     ] });
-    const body = assigned && hasFuelGuage && !hasTroubles && initialized ? summaryBody ?? /* @__PURE__ */ jsx(
+    const key = ExtensionManager.executeDashboardKeyFactory(holder) || "";
+    const summaryExts = useMemo(
+      () => getExtensions(DashboardPumpSummaryExtension.id),
+      [getExtensions]
+    );
+    const summaries = useMemo(
+      () => rankedByDashboardKey(summaryExts),
+      [summaryExts]
+    );
+    const DashboardPumpSummaryComponent = useExtensionComponent(
+      DashboardPumpSummaryExtension
+    );
+    const pumpSummary = !summaryBody && summaries[key] && DashboardPumpSummaryComponent ? /* @__PURE__ */ jsx(
+      DashboardPumpSummaryComponent,
+      {
+        module: summaries[key]?.id,
+        holder
+      }
+    ) : void 0;
+    const body = assigned && !hasTroubles && initialized && pumpSummary ? pumpSummary : assigned && hasFuelGuage && !hasTroubles && initialized ? summaryBody ?? /* @__PURE__ */ jsx(
       FuelGauge,
       {
         color: hasTroubles ? "var(--ddk-generic-color-white)" : void 0,
@@ -6970,19 +7040,11 @@ const HolderCard = kosComponent(
       }
     ) : null;
     const indicatorColor = assigned && hasFuelGuage && !hasTroubles && initialized && getFillColor(fillPercent) || void 0;
-    const key = ExtensionManager.executeDashboardKeyFactory(holder) || "";
     const exts = useMemo(
       () => getExtensions(DashboardPumpDetailExtension.id),
       [getExtensions]
     );
-    const details = useMemo(
-      () => exts.filter((ext) => !!ext.data).reduce((acc, ext) => {
-        const data2 = ext.data;
-        acc[data2.dashboardKey] = ext.data;
-        return acc;
-      }, {}),
-      [exts]
-    );
+    const details = useMemo(() => rankedByDashboardKey(exts), [exts]);
     const hasExtension = !!details[key];
     const { HolderContent, modalOptions } = useHolderContent(holder);
     const DashboardPumpDetailComponent = useExtensionComponent(
@@ -7173,10 +7235,8 @@ const MacroSummaryBody = kosComponent(
   ({ holder, dashboardKey, fallbackStatus }) => {
     const { getExtensions } = usePluginExtensions();
     const exts = getExtensions(DashboardMacroSummaryExtension.id);
-    const findByKey = (k) => exts.find((ext) => {
-      const data = ext.data;
-      return data?.dashboardKey === k;
-    });
+    const ranked = buildRankedExtensionMap(exts, "dashboardKey");
+    const findByKey = (k) => k ? ranked[k] : void 0;
     const match = findByKey(holder.name) ?? findByKey(dashboardKey);
     const Component = useExtensionComponent(DashboardMacroSummaryExtension);
     if (match && Component) {
@@ -7225,11 +7285,9 @@ const MacroHolderCard = kosComponent(
     const modalTitle = /* @__PURE__ */ jsx(CardTitle, { children: titleText });
     const key = ExtensionManager.executeDashboardKeyFactory(holder) || "";
     const exts = getExtensions(DashboardPumpDetailExtension.id);
-    const details = exts.filter((ext) => !!ext.data).reduce((acc, ext) => {
-      const data2 = ext.data;
-      acc[data2.dashboardKey] = ext.data;
-      return acc;
-    }, {});
+    const details = Object.fromEntries(
+      Object.entries(buildRankedExtensionMap(exts, "dashboardKey")).filter(([, ext]) => !!ext.data).map(([dashboardKey, ext]) => [dashboardKey, ext.data])
+    );
     const hasExtension = !!details[key];
     const { HolderContent, modalOptions } = useHolderContent(holder);
     const DashboardPumpDetailComponent = useExtensionComponent(
@@ -9206,28 +9264,28 @@ const StateExperience = kosComponent(
     useEffect(() => {
       const dispose = kosAutoEffect(() => {
         const ext = getExtensions(TroubleActionExtension.id);
+        const byTroubleType = buildRankedExtensionMap(ext, "troubleType");
         const getStateKeyForTroubleType = (troubleType) => {
-          const extension = ext.find(
-            (e) => e.data.troubleType === troubleType
-          );
+          const extension = byTroubleType[troubleType];
           const data = extension?.data;
           return extension ? data.stateKey ?? data.troubleType : void 0;
         };
-        const experienceMap = ext.reduce(
-          (acc, extension) => {
-            const data = extension.data;
-            const mapKey = data.stateKey ?? data.troubleType;
-            acc[mapKey] = {
-              extension: TroubleActionExtension.id,
-              module: extension.id,
-              namespace: data.namespace,
-              title: data.title,
-              stateValue: data.stateValue ?? data.troubleType
-            };
-            return acc;
-          },
-          {}
-        );
+        const byStateKey = buildRankedExtensionMap(ext, (extension) => {
+          const data = extension.data;
+          return data.stateKey ?? data.troubleType;
+        });
+        const experienceMap = Object.values(byStateKey).reduce((acc, extension) => {
+          const data = extension.data;
+          const mapKey = data.stateKey ?? data.troubleType;
+          acc[mapKey] = {
+            extension: TroubleActionExtension.id,
+            module: extension.id,
+            namespace: data.namespace,
+            title: data.title,
+            stateValue: data.stateValue ?? data.troubleType
+          };
+          return acc;
+        }, {});
         const currentTroubleType = troubleAction?.activeTroubleType;
         const currentTrouble = troubleAction?.activeTrouble;
         const currentStateKey = currentTroubleType ? getStateKeyForTroubleType(currentTroubleType) : void 0;
@@ -9536,6 +9594,7 @@ export {
   DashboardOperationsContext,
   DashboardOperationsProvider,
   DashboardPumpDetailExtension,
+  DashboardPumpSummaryExtension,
   DashboardSummaryExtension,
   DatePickerCard,
   DiagnosticsModal,
@@ -9557,6 +9616,9 @@ export {
   EXTENSION_POINT_DASHBOARD_PUMP_DETAIL,
   EXTENSION_POINT_DASHBOARD_PUMP_DETAIL_DEF,
   EXTENSION_POINT_DASHBOARD_PUMP_DETAIL_VIEW,
+  EXTENSION_POINT_DASHBOARD_PUMP_SUMMARY,
+  EXTENSION_POINT_DASHBOARD_PUMP_SUMMARY_DEF,
+  EXTENSION_POINT_DASHBOARD_PUMP_SUMMARY_VIEW,
   EXTENSION_POINT_DASHBOARD_SUMMARY,
   EXTENSION_POINT_DASHBOARD_SUMMARY_DEF,
   EXTENSION_POINT_DASHBOARD_SUMMARY_VIEW,