@kosdev-code/kos-ddk-models 2.1.1 → 2.1.2

package/lib/trouble-action/types/index.d.ts

@@ -1,8 +1,103 @@
+/**
+ * Definition for a single trouble action mapping.
+ *
+ * Describes how a specific trouble type should be represented in the
+ * TroubleActionModel's state object. Each definition maps a trouble type
+ * to a state key-value pair that UI components can observe.
+ *
+ * @example
+ * ```typescript
+ * const agitationTroubleAction: TroubleActionData = {
+ *   troubleType: 'InsufficientAgitationTrouble',
+ *   stateKey: 'agitationRequired',
+ *   stateValue: 'true'
+ * };
+ * ```
+ *
+ * @category Trouble Configuration
+ * @see {@link TroubleActionOptions} for how definitions are provided to the model
+ */
 export interface TroubleActionData {
+  /**
+   * The trouble type identifier to monitor.
+   *
+   * Must match the type property of trouble objects in the TroubleContainer.
+   * When a trouble of this type becomes active, the associated state entry
+   * will be created.
+   *
+   * @example "InsufficientAgitationTrouble"
+   * @example "CartridgeEmptyTrouble"
+   */
   troubleType: string;
+
+  /**
+   * The key to use in the state object for this trouble.
+   *
+   * Defines the property name in the TroubleActionModel's state object.
+   * UI components will observe this key to react to the trouble condition.
+   *
+   * @example "agitationRequired"
+   * @example "cartridgeStatus"
+   */
   stateKey: string;
+
+  /**
+   * The value to set in the state object when this trouble is active.
+   *
+   * When the trouble becomes active, this value is assigned to the stateKey.
+   * When the trouble is resolved, the stateKey is set to undefined.
+   *
+   * @example "true"
+   * @example "empty"
+   * @example "maintenance_required"
+   */
   stateValue: string;
 }
+
+/**
+ * Configuration options for the TroubleActionModel.
+ *
+ * Provides the trouble action definitions that configure how the model
+ * maps active troubles to state values. These definitions are processed
+ * during model initialization to establish the trouble monitoring behavior.
+ *
+ * @example
+ * ```typescript
+ * const options: TroubleActionOptions = {
+ *   definitions: [
+ *     {
+ *       troubleType: 'InsufficientAgitationTrouble',
+ *       stateKey: 'agitationRequired',
+ *       stateValue: 'true'
+ *     },
+ *     {
+ *       troubleType: 'CartridgeEmptyTrouble',
+ *       stateKey: 'cartridgeStatus',
+ *       stateValue: 'empty'
+ *     },
+ *     {
+ *       troubleType: 'MaintenanceRequiredTrouble',
+ *       stateKey: 'systemStatus',
+ *       stateValue: 'maintenance'
+ *     }
+ *   ]
+ * };
+ * ```
+ *
+ * @category Model Configuration
+ * @see {@link TroubleActionData} for individual definition structure
+ * @see {@link TroubleActionModel} for how options are used during initialization
+ */
 export interface TroubleActionOptions {
+  /**
+   * Array of trouble action definitions to monitor.
+   *
+   * Each definition maps a specific trouble type to a state representation.
+   * The model will monitor all defined trouble types and update its state
+   * object accordingly when troubles become active or are resolved.
+   *
+   * The order of definitions affects priority when accessing the activeTrouble
+   * getter - the first matching trouble in the array will be returned.
+   */
   definitions: TroubleActionData[];
 }

package/lib/utilities/services/utilities-services.d.ts

@@ -8,6 +8,6 @@ type UtilityColumnsResponse = UtilityResponse[];
  * @category Service
  * Retrieves the initial utilities data.
  */
-export declare const getUtilities: () => Promise<UtilityColumnsResponse[] | undefined>;
+export declare const getUtilities: () => Promise<UtilityColumnsResponse[]>;
 export {};
 //# sourceMappingURL=utilities-services.d.ts.map

package/lib/utilities/services/utilities-services.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utilities-services.d.ts","sourceRoot":"","sources":["../../../../../../../packages/ddk/kos-ddk-models/src/lib/utilities/services/utilities-services.ts"],"names":[],"mappings":"AAeA,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,KAAK,sBAAsB,GAAG,eAAe,EAAE,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,YAAY,qDAQxB,CAAC"}
+{"version":3,"file":"utilities-services.d.ts","sourceRoot":"","sources":["../../../../../../../packages/ddk/kos-ddk-models/src/lib/utilities/services/utilities-services.ts"],"names":[],"mappings":"AAeA,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,KAAK,sBAAsB,GAAG,eAAe,EAAE,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,YAAY,yCAwBxB,CAAC"}

package/lib/utilities/utilities-container-model.d.ts

@@ -2,6 +2,10 @@ import { UtilitiesModel, UtilitiesContainerModel, UtilitiesContainerOptions } fr
 import { KosCreationContext, IKosModelContainer, IKosDataModel } from '../../../../../sdk/kos-ui-sdk/src/index.ts';
 
 export declare const MODEL_TYPE = "utilities-container-model";
+/**
+ * @kosService ddk.utilities
+ * @kosApiLevel 1
+ */
 export declare class UtilitiesContainerModelImpl implements UtilitiesContainerModel, IKosDataModel {
     id: string;
     private logger;

package/lib/utilities/utilities-container-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utilities-container-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/ddk/kos-ddk-models/src/lib/utilities/utilities-container-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,kBAAkB,EAClB,kBAAkB,EAClB,aAAa,EACd,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EACV,cAAc,EACd,uBAAuB,EACvB,yBAAyB,EAE1B,MAAM,SAAS,CAAC;AAIjB,eAAO,MAAM,UAAU,8BAA8B,CAAC;AAEtD,qBACa,2BACX,YAAW,uBAAuB,EAAE,aAAa;IAEjD,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,CAAC,MAAM,CAAmB;IAEvB,OAAO,CAAC,OAAO,CAAqC;gBAE5D,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,yBAAyB,EACnC,OAAO,EAAE,kBAAkB;IAc7B,IAAI,IAAI,qBAEP;IAED,IAAI,MAAM,uCAET;IAED,IAAI,OAAO,IAAI,MAAM,EAAE,CAItB;IAED,QAAQ,CAAC,KAAK,EAAE,cAAc;IAI9B,WAAW,CAAC,EAAE,EAAE,MAAM;IAItB,QAAQ,CAAC,EAAE,EAAE,MAAM;IAInB,oBAAoB,CAAC,EAAE,EAAE,MAAM;IAMzB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAoB5B"}
+{"version":3,"file":"utilities-container-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/ddk/kos-ddk-models/src/lib/utilities/utilities-container-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,kBAAkB,EAClB,kBAAkB,EAClB,aAAa,EACd,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EACV,cAAc,EACd,uBAAuB,EACvB,yBAAyB,EAE1B,MAAM,SAAS,CAAC;AAIjB,eAAO,MAAM,UAAU,8BAA8B,CAAC;AAEtD;;;GAGG;AACH,qBACa,2BACX,YAAW,uBAAuB,EAAE,aAAa;IAEjD,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,CAAC,MAAM,CAAmB;IAEvB,OAAO,CAAC,OAAO,CAAqC;gBAE5D,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,yBAAyB,EACnC,OAAO,EAAE,kBAAkB;IAc7B,IAAI,IAAI,qBAEP;IAED,IAAI,MAAM,uCAET;IAED,IAAI,OAAO,IAAI,MAAM,EAAE,CAItB;IAED,QAAQ,CAAC,KAAK,EAAE,cAAc;IAI9B,WAAW,CAAC,EAAE,EAAE,MAAM;IAItB,QAAQ,CAAC,EAAE,EAAE,MAAM;IAInB,oBAAoB,CAAC,EAAE,EAAE,MAAM;IAMzB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAoB5B"}

package/lib/utilities/utilities-model.d.ts

@@ -2,6 +2,10 @@ import { UtilitiesModel, UtilitiesOptions } from './types';
 import { IKosDataModel, KosCreationContext } from '../../../../../sdk/kos-ui-sdk/src/index.ts';
 
 export declare const MODEL_TYPE = "utilities-model";
+/**
+ * @kosService ddk.utilities
+ * @kosApiLevel 1
+ */
 export declare class UtilitiesModelImpl implements UtilitiesModel, IKosDataModel {
     id: string;
     name: string;

package/lib/utilities/utilities-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utilities-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/ddk/kos-ddk-models/src/lib/utilities/utilities-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EAEb,kBAAkB,EACnB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhE,eAAO,MAAM,UAAU,oBAAoB,CAAC;AAE5C,qBACa,kBAAmB,YAAW,cAAc,EAAE,aAAa;IACtE,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,CAAC,MAAM,CAAmB;gBAG/B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,gBAAgB,EACzB,OAAO,EAAE,kBAAkB;IAU7B,WAAW,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI;IAM5C,IAAI,QAAQ,WAEX;IAED,IAAI,OAAO,WAEV;IAIK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}
+{"version":3,"file":"utilities-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/ddk/kos-ddk-models/src/lib/utilities/utilities-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EAEb,kBAAkB,EACnB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhE,eAAO,MAAM,UAAU,oBAAoB,CAAC;AAE5C;;;GAGG;AACH,qBACa,kBAAmB,YAAW,cAAc,EAAE,aAAa;IACtE,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,CAAC,MAAM,CAAmB;gBAG/B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,gBAAgB,EACzB,OAAO,EAAE,kBAAkB;IAU7B,WAAW,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI;IAM5C,IAAI,QAAQ,WAEX;IAED,IAAI,OAAO,WAEV;IAIK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "@kosdev-code/kos-ddk-models",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "dependencies": {
-    "@kosdev-code/kos-ui-sdk": "~2.1.2",
-    "@kosdev-code/kos-dispense-sdk": "~2.1.2",
-    "@kosdev-code/kos-freestyle-sdk": "~2.1.2"
+    "@kosdev-code/kos-ui-sdk": "~2.1.0",
+    "@kosdev-code/kos-dispense-sdk": "~2.1.0",
+    "@kosdev-code/kos-freestyle-sdk": "~2.1.0"
   },
+  "kosModels": "./kos-models.json",
   "main": "./index.js",
   "module": "./index.mjs",
   "typings": "./index.d.ts",
   "kos": {
     "build": {
-      "gitHash": "61a3abcdecff6c02b084e4f5bf6cc0362bbf51a9"
+      "gitHash": "424ce681eaa2f82db88daaaa810780ec0bde0952"
     }
   },
   "publishConfig": {

package/start/start-model.d.ts

@@ -3,6 +3,10 @@ import { IKosDataModel, IKosIdentifiable, KosCreationContext, PublicModelInterfa
 
 export declare const MODEL_TYPE = "start-model";
 export type StartModel = PublicModelInterface<StartModelImpl>;
+/**
+ * @kosService ddk.start
+ * @kosApiLevel 1
+ */
 export declare class StartModelImpl implements IKosDataModel, IKosIdentifiable {
     id: string;
     private logger;

package/start/start-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"start-model.d.ts","sourceRoot":"","sources":["../../../../../packages/ddk/kos-ddk-models/src/start/start-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAClB,oBAAoB,EAErB,MAAM,yBAAyB,CAAC;AAOjC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C,eAAO,MAAM,UAAU,gBAAgB,CAAC;AAExC,MAAM,MAAM,UAAU,GAAG,oBAAoB,CAAC,cAAc,CAAC,CAAC;AAE9D,qBACa,cAAe,YAAW,aAAa,EAAE,gBAAgB;IACpE,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IAGjC,OAAO,CAAC,QAAQ,CAAyB;gBAGvC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,kBAAkB;IAU7B,IAAI,cAAc,YAOjB;IAED,IAAI,kBAAkB,YAOrB;IAEK,QAAQ;IAMR,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}
+{"version":3,"file":"start-model.d.ts","sourceRoot":"","sources":["../../../../../packages/ddk/kos-ddk-models/src/start/start-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAClB,oBAAoB,EAErB,MAAM,yBAAyB,CAAC;AAOjC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C,eAAO,MAAM,UAAU,gBAAgB,CAAC;AAExC,MAAM,MAAM,UAAU,GAAG,oBAAoB,CAAC,cAAc,CAAC,CAAC;AAE9D;;;GAGG;AACH,qBACa,cAAe,YAAW,aAAa,EAAE,gBAAgB;IACpE,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IAGjC,OAAO,CAAC,QAAQ,CAAyB;gBAGvC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,kBAAkB;IAU7B,IAAI,cAAc,YAOjB;IAED,IAAI,kBAAkB,YAOrB;IAEK,QAAQ;IAMR,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}

package/utils/openapi-index.d.ts

@@ -0,0 +1,2 @@
+export * as kosdev_ddk from './services/kosdev.ddk/snapshot/openapi';
+//# sourceMappingURL=openapi-index.d.ts.map

package/utils/openapi-index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi-index.d.ts","sourceRoot":"","sources":["../../../../../packages/ddk/kos-ddk-models/src/utils/openapi-index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,wCAAwC,CAAC"}