@kosdev-code/kos-ddk-models 3.1.0 → 3.1.2

package/index.d.ts

@@ -13,6 +13,7 @@ export * from './lib/enrollment';
 export * from './lib/ingredient-summary';
 export * from './lib/lockout';
 export * from './lib/macro-assignment';
+export * from './lib/mock';
 export * from './lib/network-test';
 export * from './lib/nutritive-sweetener';
 export * from './lib/plain-water';

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../packages/kos-ddk-models/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../packages/kos-ddk-models/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}

package/index.js

@@ -9,16 +9,16 @@ const { URL: URL$d } = kosUiSdk.resolveServiceUrl("AUTH_SERVICE");
 const { getOne: getOne$4, postModel: postModel$4 } = kosUiSdk.ServiceFactory.build({
   basePath: `${URL$d}/api/auth`
 });
-const log$e = kosUiSdk.KosLog.createLogger({ name: "auth-service", group: "Services" });
+const log$f = kosUiSdk.KosLog.createLogger({ name: "auth-service", group: "Services" });
 const getCurrentRole = async () => {
-  log$e.debug("sending GET for auth");
+  log$f.debug("sending GET for auth");
   const response = await getOne$4({
     urlOverride: `${URL$d}/api/app/kosdev.ddk/auth/role`
   });
   return response;
 };
 const sendPinCode = async (pinCode) => {
-  log$e.debug("sending POST for auth");
+  log$f.debug("sending POST for auth");
   const response = await postModel$4({
     urlOverride: `${URL$d}/api/app/kosdev.ddk/auth/pincode/${pinCode}`,
     model: {}
@@ -164,19 +164,19 @@ const { URL: URL$c } = kosUiSdk.resolveServiceUrl("SETUP-STEP_SERVICE");
 const { getAll: getAll$9, postModel: postModel$3 } = kosUiSdk.ServiceFactory.build({
   basePath: `${URL$c}/api/setup-step`
 });
-const log$d = kosUiSdk.KosLog.createLogger({
+const log$e = kosUiSdk.KosLog.createLogger({
   name: "setup-step-service",
   group: "Services"
 });
 const getSetupSteps = async () => {
-  log$d.debug("sending GET for setup-step");
+  log$e.debug("sending GET for setup-step");
   const response = await getAll$9({
     urlOverride: `${URL$c}/api/app/kosdev.ddk/setup/steps`
   });
   return response;
 };
 const markStepComplete = async (stepId) => {
-  log$d.debug("sending POST for setup-step");
+  log$e.debug("sending POST for setup-step");
   const response = await postModel$3({
     urlOverride: `${URL$c}/api/app/kosdev.ddk/setup/complete/${stepId}`,
     model: {}
@@ -410,9 +410,9 @@ const { URL: URL$b } = kosUiSdk.resolveServiceUrl("AUTH_SERVICE");
 const { getOne: getOne$3, getAll: getAll$8 } = kosUiSdk.ServiceFactory.build({
   basePath: `${URL$b}/api/app/kosdev.ddk/ncui/`
 });
-const log$c = kosUiSdk.KosLog.createLogger({ name: "auth-service", group: "Services" });
+const log$d = kosUiSdk.KosLog.createLogger({ name: "auth-service", group: "Services" });
 const getCuis = async () => {
-  log$c.debug("sending GET for cuis");
+  log$d.debug("sending GET for cuis");
   const response = await getAll$8({
     urlOverride: `${URL$b}/api/app/kosdev.ddk/cui`
   });
@@ -422,13 +422,13 @@ const getCuis = async () => {
   return response.data;
 };
 const getNavigation = async () => {
-  log$c.debug("sending GET for navigation");
+  log$d.debug("sending GET for navigation");
   try {
     const extensionResponse = await getAll$8({
       urlOverride: `${URL$b}/api/kos/descriptor/app:kosdev.ddk:ncuiDescriptor/kondra.ncui.navigations`
     });
     if (extensionResponse?.status !== 200) {
-      log$c.info(`no extensions found, using base data`);
+      log$d.info(`no extensions found, using base data`);
       const response = await getAll$8({
         urlOverride: `${URL$b}/api/kos/descriptor/system:app/kondra.ncui.navigations`
       });
@@ -443,14 +443,14 @@ const getNavigation = async () => {
   }
 };
 const navigateToCui = async () => {
-  log$c.debug("navigating to CUI");
+  log$d.debug("navigating to CUI");
   const response = await getOne$3({
     urlOverride: `${URL$b}/api/app/kosdev.ddk/cui/open`
   });
   return response;
 };
 const navigateToNCui$1 = async () => {
-  log$c.debug("navigating to NCUI");
+  log$d.debug("navigating to NCUI");
   const response = await getOne$3({
     urlOverride: `${URL$b}/api/app/kosdev.ddk/ncui/open`
   });
@@ -867,12 +867,12 @@ const { URL: URL$a } = kosUiSdk.resolveServiceUrl("ANIMATION_SERVICE");
 const { getAll: getAll$7 } = kosUiSdk.ServiceFactory.build({
   basePath: `${URL$a}/api/animation`
 });
-const log$b = kosUiSdk.KosLog.createLogger({
+const log$c = kosUiSdk.KosLog.createLogger({
   name: "animation-service",
   group: "Services"
 });
 const getAnimations = async () => {
-  log$b.debug("sending GET for animation");
+  log$c.debug("sending GET for animation");
   const response = await getAll$7({});
   return response;
 };
@@ -903,7 +903,7 @@ let CarbWaterModelImpl = class {
     const carbHolder = this.assemblyModel.getHoldersByGroup("carb")[0];
     const pump = carbHolder.pumps.data[0];
     const model = kosUiSdk.getKosCompanionModel(pump, kosFreestyleSdk.FcmPump.type);
-    return model;
+    return model ?? carbHolder;
   }
   // -------------------LIFECYCLE----------------------------
   async init() {
@@ -934,7 +934,7 @@ const { URL: URL$9 } = kosUiSdk.resolveServiceUrl("COPY-LOGS_SERVICE");
 const { getAll: getAll$6, getOne: getOne$2, postModel: postModel$2, deleteModel } = kosUiSdk.ServiceFactory.build({
   basePath: `${URL$9}/api/copy-logs`
 });
-const log$a = kosUiSdk.KosLog.createLogger({
+const log$b = kosUiSdk.KosLog.createLogger({
   name: "copy-logs-service",
   group: "Services"
 });
@@ -972,7 +972,7 @@ const copyLogFromVolume = async (volumeId, tracker) => {
   return response.data;
 };
 const getVolumes = async () => {
-  log$a.debug("sending GET for copy-logs");
+  log$b.debug("sending GET for copy-logs");
   try {
     const response = await getAll$6({
       urlOverride: `${URL$9}/api/app/kosdev.ddk/copyLogs/volumes/size`
@@ -980,14 +980,14 @@ const getVolumes = async () => {
     return [void 0, response?.data];
   } catch (error) {
     if (error instanceof kosUiSdk.FetchError) {
-      log$a.error(`Error fetching log file size: ${error.payload.error}`);
+      log$b.error(`Error fetching log file size: ${error.payload.error}`);
       return [error.payload.error, void 0];
     }
   }
   return ["unknownError", void 0];
 };
 const getLogFileSize = async () => {
-  log$a.debug("sending GET for log file size");
+  log$b.debug("sending GET for log file size");
   try {
     const response = await getOne$2({
       urlOverride: `${URL$9}/api/app/kosdev.ddk/copyLogs/files/size`
@@ -995,7 +995,7 @@ const getLogFileSize = async () => {
     return [void 0, response?.data];
   } catch (error) {
     if (error instanceof kosUiSdk.FetchError) {
-      log$a.error(`Error fetching log file size: ${error.payload.error}`);
+      log$b.error(`Error fetching log file size: ${error.payload.error}`);
       return [error.payload.error, void 0];
     }
   }
@@ -1232,12 +1232,12 @@ CopyLogsModelImpl = __decorateClass$h([
   kosUiSdk.kosLoggerAware()
 ], CopyLogsModelImpl);
 const CopyLogs = CopyLogsModelImpl.Registration;
-const log$9 = kosUiSdk.KosLog.createLogger({
+const log$a = kosUiSdk.KosLog.createLogger({
   name: "dashboard-operations-service",
   group: "Services"
 });
 const resolveAll = async (troubleIds, tracker) => {
-  log$9.debug("resolveAll");
+  log$a.debug("resolveAll");
   const response = await kosUiSdk.TroubleServices.bulkResolveTroubles(
     troubleIds,
     void 0,
@@ -1246,7 +1246,7 @@ const resolveAll = async (troubleIds, tracker) => {
   return response;
 };
 const resolveTrouble = async (troubleId, tracker) => {
-  log$9.debug("resolveTrouble");
+  log$a.debug("resolveTrouble");
   const response = await kosUiSdk.TroubleServices.resolveTrouble(
     troubleId,
     void 0,
@@ -1426,12 +1426,12 @@ const { URL: URL$8 } = kosUiSdk.resolveServiceUrl("DISPENSER_SERVICE");
 const { getAll: getAll$5 } = kosUiSdk.ServiceFactory.build({
   basePath: `${URL$8}/api/dispenser`
 });
-const log$8 = kosUiSdk.KosLog.createLogger({
+const log$9 = kosUiSdk.KosLog.createLogger({
   name: "dispenser-service",
   group: "Services"
 });
 const getDispensers = async () => {
-  log$8.debug("sending GET for dispenser");
+  log$9.debug("sending GET for dispenser");
   const response = await getAll$5({});
   return response;
 };
@@ -1492,12 +1492,12 @@ const { URL: URL$7 } = kosUiSdk.resolveServiceUrl("DISPENSER-INFO_SERVICE");
 const { getAll: getAll$4 } = kosUiSdk.ServiceFactory.build({
   basePath: `${URL$7}/api/dispenser-info`
 });
-const log$7 = kosUiSdk.KosLog.createLogger({
+const log$8 = kosUiSdk.KosLog.createLogger({
   name: "dispenser-info-service",
   group: "Services"
 });
 const getDispenserInfos = async () => {
-  log$7.debug("sending GET for dispenser-info");
+  log$8.debug("sending GET for dispenser-info");
   const response = await getAll$4({});
   return response;
 };
@@ -1552,12 +1552,12 @@ const { URL: URL$6 } = kosUiSdk.resolveServiceUrl("ENROLLMENT_SERVICE");
 const { getAll: getAll$3 } = kosUiSdk.ServiceFactory.build({
   basePath: `${URL$6}/api/enrollment`
 });
-const log$6 = kosUiSdk.KosLog.createLogger({
+const log$7 = kosUiSdk.KosLog.createLogger({
   name: "enrollment-service",
   group: "Services"
 });
 const getEnrollments = async () => {
-  log$6.debug("sending GET for enrollment");
+  log$7.debug("sending GET for enrollment");
   const response = await getAll$3({});
   return response;
 };
@@ -1726,9 +1726,9 @@ const { URL: URL$5 } = kosUiSdk.resolveServiceUrl("LOCKOUT_SERVICE");
 const { postModel: postModel$1 } = kosUiSdk.ServiceFactory.build({
   basePath: `${URL$5}/api/app/kosdev.ddk/lockout`
 });
-const log$5 = kosUiSdk.KosLog.createLogger({ name: "lockout-service", group: "Services" });
+const log$6 = kosUiSdk.KosLog.createLogger({ name: "lockout-service", group: "Services" });
 const lock = async () => {
-  log$5.info("lock");
+  log$6.info("lock");
   const response = await postModel$1({
     model: {},
     urlOverride: `${URL$5}/api/app/kosdev.ddk/lockout/lockNow`
@@ -1736,7 +1736,7 @@ const lock = async () => {
   return response;
 };
 const unlock = async (pin) => {
-  log$5.info("unlock");
+  log$6.info("unlock");
   const response = await postModel$1({
     model: {},
     urlOverride: `${URL$5}/api/app/kosdev.ddk/lockout/unlock/${pin}`
@@ -2043,6 +2043,126 @@ const MacroAssignment = {
     MODEL_TYPE$a
   )
 };
+const descriptorValue = (ncui, path) => path.split(".").reduce(
+  (value, key) => value && typeof value === "object" ? value[key] : void 0,
+  { kondra: { ncui } }
+);
+const descriptorSetupSteps = (steps, backend) => steps.map((step) => ({
+  complete: false,
+  preStep: false,
+  exclusive: false,
+  ...backend.find((existing) => existing.name === step.name),
+  ...step
+}));
+const withUtility = (columns, entry, column = columns.length - 1) => columns.length === 0 ? [[entry]] : columns.map((items, i) => i === column ? [...items, entry] : items);
+const withNavigation = (items, entry, parent) => {
+  if (!parent) return [...items, entry];
+  const [head, ...rest] = parent.split(".");
+  return items.map(
+    (item) => item.name === head ? {
+      ...item,
+      children: withNavigation(
+        item.children ?? [],
+        entry,
+        rest.join(".") || void 0
+      )
+    } : item
+  );
+};
+const withSetupStep = (steps, entry, before) => {
+  const step = { complete: false, preStep: false, exclusive: false, ...entry };
+  const at = before ? steps.findIndex((s) => s.name === before) : -1;
+  return at < 0 ? [...steps, step] : [...steps.slice(0, at), step, ...steps.slice(at)];
+};
+const log$5 = kosUiSdk.KosLog.createLogger({ name: "ddk-mock" });
+const NCUI_DESCRIPTOR = "/api/kos/descriptor/app:kosdev.ddk:ncuiDescriptor";
+const ANY_DESCRIPTOR = "/api/kos/descriptor/:descriptor";
+const SETUP_STEPS = "/api/app/kosdev.ddk/setup/steps";
+const onData = (change) => (body) => {
+  const envelope = body;
+  if (envelope?.data === void 0) return body;
+  return { ...envelope, data: change(envelope.data) };
+};
+const lastSegment = (path) => path.split("/").pop() ?? "";
+const createDdkMockHelpers = (kosMock) => {
+  const removeAll = (...handles) => () => handles.forEach((handle) => handle.remove());
+  return {
+    useDescriptor(descriptor) {
+      const ncui = "kondra" in descriptor ? descriptor.kondra.ncui : descriptor;
+      const handles = [
+        kosMock.get(
+          `${NCUI_DESCRIPTOR}/:path`,
+          (req) => ({ data: descriptorValue(ncui, lastSegment(req.path)) }),
+          {
+            id: "ddk-ncui-descriptor",
+            description: "DDK: the descriptor project as the installed NCUI descriptor",
+            // Paths the descriptor does not have reach the backend.
+            when: (req) => descriptorValue(ncui, lastSegment(req.path)) !== void 0
+          }
+        )
+      ];
+      const steps = ncui.setup?.steps;
+      if (steps) {
+        handles.push(
+          kosMock.transformResponse(
+            "GET",
+            SETUP_STEPS,
+            onData(
+              (backend) => descriptorSetupSteps(steps, backend)
+            ),
+            { description: "DDK: the descriptor project's setup steps" }
+          )
+        );
+      }
+      return removeAll(...handles);
+    },
+    addUtility(entry, { column } = {}) {
+      return removeAll(
+        kosMock.transformResponse(
+          "GET",
+          `${ANY_DESCRIPTOR}/kondra.ncui.utilities`,
+          onData(
+            (columns) => withUtility(columns, entry, column)
+          ),
+          { description: `DDK: utility ${entry.name}` }
+        )
+      );
+    },
+    addNavigation(entry, { parent } = {}) {
+      return removeAll(
+        kosMock.transformResponse(
+          "GET",
+          `${ANY_DESCRIPTOR}/kondra.ncui.navigations`,
+          onData(
+            (items) => withNavigation(items, entry, parent)
+          ),
+          { description: `DDK: navigation ${entry.name}` }
+        )
+      );
+    },
+    addSetupStep(entry, { before } = {}) {
+      return removeAll(
+        kosMock.transformResponse(
+          "GET",
+          SETUP_STEPS,
+          onData(
+            (steps) => withSetupStep(steps, entry, before)
+          ),
+          { description: `DDK: setup step ${entry.name}` }
+        )
+      );
+    }
+  };
+};
+const registerDdkMock = () => {
+  const kosMock = globalThis.KosMock;
+  if (typeof kosMock?.extend !== "function") return;
+  try {
+    kosMock.extend("ddk", createDdkMockHelpers);
+  } catch (error) {
+    log$5.warn("kosMock.ddk not registered", error?.message);
+  }
+};
 var __getOwnPropDesc$9 = Object.getOwnPropertyDescriptor;
 var __decorateClass$9 = (decorators, target, key, kind) => {
   var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc$9(target, key) : target;
@@ -2360,7 +2480,7 @@ let PlainWaterModelImpl = class {
     const waterHolder = this.getHolder();
     const pump = waterHolder?.pumps?.data?.[0];
     const model = kosUiSdk.getKosCompanionModel(pump, kosFreestyleSdk.FcmPump.type);
-    return model;
+    return model ?? waterHolder;
   }
   // -------------------LIFECYCLE----------------------------
   async init() {
@@ -2890,8 +3010,9 @@ let TroubleActionModelImpl = class {
    * Gets the first active trouble that has an associated action definition.
    *
    * Returns the first trouble found that matches any of the configured trouble
-   * action definitions. If multiple troubles are active, priority is determined
-   * by the order of trouble type keys in the troubleActionData object.
+   * action definitions, checking the trouble types in definition order. If
+   * troubles of several defined types are active, the earliest-defined type wins
+   * (in the DDK hosts, plugin load order).
    *
    * @returns The active trouble model, or undefined if no matching troubles exist
    *
@@ -2908,18 +3029,12 @@ let TroubleActionModelImpl = class {
    * @see {@link TroubleContainerModel} for trouble data structure
    */
   get activeTrouble() {
-    const actions = Object.keys(this.troubleActionData);
-    if (actions.length > 0) {
-      const firstAction = actions[0];
-      const troubles = this.troubleContainer.troubles.getIndexByKey(
+    for (const troubleType of Object.keys(this.troubleActionData)) {
+      const [trouble] = this.troubleContainer.troubles.getIndexByKey(
         "byType",
-        firstAction
+        troubleType
       );
-      if (troubles.length > 0) {
-        return troubles[0];
-      } else {
-        return void 0;
-      }
+      if (trouble) return trouble;
     }
     return void 0;
   }
@@ -3091,11 +3206,13 @@ exports.Utilities = Utilities;
 exports.UtilitiesContainer = UtilitiesContainer;
 exports.UtilitiesServices = index$1;
 exports.calculateTimeDifference = calculateTimeDifference;
+exports.createDdkMockHelpers = createDdkMockHelpers;
 exports.executeDashboardKeyFactory = executeDashboardKeyFactory;
 exports.isMacroGroup = isMacroGroup;
 exports.isMicroGroup = isMicroGroup;
 exports.macroHolderMap = macroHolderMap;
 exports.registerDashboardKeyFactory = registerDashboardKeyFactory;
+exports.registerDdkMock = registerDdkMock;
 exports.toSeconds = toSeconds;
 exports.toTimeComponents = toTimeComponents;
 exports.troubleVisibilityFilter = troubleVisibilityFilter;