@kosdev-code/kos-dispense-sdk 0.1.0-dev.5880 → 0.1.0-next.1008

package/models/models/assembly/holder-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"holder-utils.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/assembly/holder-utils.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAiB,MAAM,iBAAiB,CAAC;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAExD,eAAO,MAAM,wBAAwB,0FAI5B,MAAM,cACD,eAAe,yBAAyB,CAAC,oCAoDtD,CAAC"}
+{"version":3,"file":"holder-utils.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/assembly/holder-utils.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAiB,MAAM,iBAAiB,CAAC;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAExD,eAAO,MAAM,wBAAwB,GACnC,yBAAyB,SAAS,MAAM,GAAG,GAAG,EAC9C,SAAS,SAAS,MAAM,GAAG,GAAG,EAE9B,OAAO,MAAM,EACb,YAAY,cAAc,CAAC,yBAAyB,CAAC,oCAoDtD,CAAC"}

package/models/models/assembly/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/assembly/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,yBAAyB,GAC1B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,KAAK,gBAAgB,MAAM,YAAY,CAAC;AAC/C,mBAAmB,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/assembly/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,yBAAyB,GAC1B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,KAAK,gBAAgB,MAAM,YAAY,CAAC;AAC/C,mBAAmB,SAAS,CAAC"}

package/models/models/assembly/nozzle-utils.d.ts

@@ -1,6 +1,5 @@
-import { AssemblyBoard } from '../types/assembly';
 import { BoardContainerModel } from '../board';
-
+import { AssemblyBoard } from '../types/assembly';
 export declare const mapAssemblyBoardToModel: (board: AssemblyBoard) => import('../board').BoardModel<{}>;
 export declare const assemblyBoardMap: (boardContainer: BoardContainerModel) => (board: AssemblyBoard) => void;
 //# sourceMappingURL=nozzle-utils.d.ts.map

package/models/models/assembly/nozzle-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nozzle-utils.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/assembly/nozzle-utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAS,KAAK,mBAAmB,EAAqB,MAAM,UAAU,CAAC;AAC9E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAGvD,eAAO,MAAM,uBAAuB,UAAW,aAAa,sCAc3D,CAAC;AAEF,eAAO,MAAM,gBAAgB,mBACV,mBAAmB,aAAa,aAAa,SAI7D,CAAC"}
+{"version":3,"file":"nozzle-utils.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/assembly/nozzle-utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAS,KAAK,mBAAmB,EAAqB,MAAM,UAAU,CAAC;AAC9E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAMvD,eAAO,MAAM,uBAAuB,GAAI,OAAO,aAAa,sCAc3D,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAC1B,gBAAgB,mBAAmB,MAAM,OAAO,aAAa,SAI7D,CAAC"}

package/models/models/assembly/pump-utils.d.ts

@@ -1,7 +1,6 @@
-import { AssemblyNozzle, AssemblyPump } from '../types/assembly';
-import { PumpContainerModel } from '../pump-container';
 import { HolderContainerModel } from '../holder-container';
-
+import { PumpContainerModel } from '../pump-container';
+import { AssemblyNozzle, AssemblyPump } from '../types/assembly';
 export declare const mapAssemblyPumpToModel: (nozzlePath: string, pump: AssemblyPump) => import('../pump').PumpModel<any>;
 export declare const assemblyPumpMap: (pumpContainer: PumpContainerModel) => (holderContainer: HolderContainerModel) => (nozzle: AssemblyNozzle) => (assemblyPump: AssemblyPump) => void;
 //# sourceMappingURL=pump-utils.d.ts.map

package/models/models/assembly/pump-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pump-utils.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/assembly/pump-utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAEhE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtE,eAAO,MAAM,sBAAsB,eACrB,MAAM,QACZ,YAAY,qCAsBnB,CAAC;AAEF,eAAO,MAAM,eAAe,kBACV,kBAAkB,uBAChB,oBAAoB,cAC7B,cAAc,oBACR,YAAY,SA0B1B,CAAC"}
+{"version":3,"file":"pump-utils.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/assembly/pump-utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAEhE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAKtE,eAAO,MAAM,sBAAsB,GACjC,YAAY,MAAM,EAClB,MAAM,YAAY,qCAsBnB,CAAC;AAEF,eAAO,MAAM,eAAe,GACzB,eAAe,kBAAkB,MACjC,iBAAiB,oBAAoB,MACrC,QAAQ,cAAc,MACtB,cAAc,YAAY,SA0B1B,CAAC"}

package/models/models/assembly/services/assembly-services.d.ts

@@ -1,5 +1,4 @@
 import { AssemblyResponse } from '../../types/assembly';
-
 /**
  * @category Service
  * Retrieves the initial assembly data.

package/models/models/assembly/services/assembly-services.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assembly-services.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/assembly/services/assembly-services.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAW7D;;;GAGG;AACH,eAAO,MAAM,WAAW,uGAIvB,CAAC"}
+{"version":3,"file":"assembly-services.d.ts","sourceRoot":"","sources":["../../../../../../../packages/kos-dispense-sdk/src/models/models/assembly/services/assembly-services.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAW7D;;;GAGG;AACH,eAAO,MAAM,WAAW,uGAIvB,CAAC"}

package/models/models/assembly/services/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/assembly/services/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/kos-dispense-sdk/src/models/models/assembly/services/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC"}

package/models/models/assembly/types/index.d.ts

@@ -1,7 +1,10 @@
-import { HolderModel } from '../../holder/types';
-import { BoardModel } from '../../board/types';
 import { IKosDataModel } from '@kosdev-code/kos-ui-sdk';
-
+import { BoardModel } from '../../board/types';
+import { HolderModel } from '../../holder/types';
+/**
+ * @kosService dispense.assembly
+ * @kosApiLevel 2
+ */
 export interface AssemblyOptions {}
 
 /**
@@ -12,6 +15,8 @@ export interface AssemblyOptions {}
  *
  *
  * @category Model
+ * @kosService dispense.assembly
+ * @kosApiLevel 2
  */
 export interface AssemblyModel<
   AssemblyExt extends object = any,

package/models/models/availability/availability-model.d.ts

@@ -1,89 +1,24 @@
-import { AvailabilityModel, AvailabilityOptions } from './types';
 import { KosModelRegistrationBean } from '@kosdev-code/kos-ui-sdk';
-
+import { AvailabilityModel, AvailabilityOptions } from './types';
 /**
- * # Availability
- *
- * The registration bean includes convenience methods for creating and working with AvailabilityModel instances.
- *
- * ## type
- * The type property is a string that identifies the model type.
- * The type is used to identify the model type in the model registry and to narrow down the model type in type predicates.  It's most frequently
- * used when declaring dependencies on models.
- *
- * @example
- * ```typescript
- *
- * @kosDependency({modelType: Availability.type, id: "beverageId"})
- * private beverageModel: AvailabilityModel;
- * ```
- *
- * ## factory
- *
- * The factory method creates a factory function that can be used to create new AvailabilityModel instances.
- *
- * The factory function is a curried function that takes the model id as the first argument and the options as the second argument.
- *
- * If a model with the specified id already exists, the factory function will return the existing model.  The options will be ignored
- * in this case and the existing model will be returned in its current state.
- *
- * @example
+ * Registration bean for {@link AvailabilityModel}.
  *
- * ```typescript
- * const cherryFlavor = Availability.factory("beverageId")({
- *  groupId: "flavor",
- *  rawId: "cherry",
- *  altId: "cherry",
- *  available: true,
- *  visible: true,
- *  // this data is added via extension point
- *  data: {
- *    name: "Cherry",
- *    description: "Cherry flavor",
- *   },
- *  });
- * ```
+ * - `type`: the model type, used by the model registry and in `@kosDependency` declarations.
+ * - `factory`: curried factory, `Availability.factory(id)(options)`. Returns the existing model when the id is already in use and ignores the options.
+ * - `predicate`: type guard that narrows an `IKosDataModel` to `AvailabilityModel`.
+ * - `registration`: registry entry that can be spread into an `IKosRegistry["models"]` map.
  *
- * @param predicate
- *
- * [Typescript type predicate](https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates) function that will identify and narrow down a model to a AvailabilityModel.
+ * Availability is not a singleton: each id has its own instance. `KosModelRegistry.dispense.models()` registers it.
  *
  * @example
  * ```typescript
- *
- * const model: IKosDataModel = ...; // some model
- *
- * if (Availability.predicate(model)) {
- *    // if the function evaluates to true, the model is narrowed down to AvailabilityModel
- *    // and the compiler will know that the model has the AvailabilityModel interface
- *    model.updateAvailability(false);
- * }
+ * @kosDependency({ modelType: Availability.type, id: "availabilityId" })
+ * private availability!: AvailabilityModel;
  * ```
  *
- * ## registration
- *
- * The registration property is an object that can be used to simplify registration of the model with the model registry.  The registration object
- * can be spread into the model registration and provides all of the required information to register the model implementation class against the model type.
- *
- *
- * @example
- *
- * In an application registration file you can declare the model registration as follows:
- *
- * **registration.ts**
- * ```typescript
- * import { Availability } from "@kosdev-code/kos-dispense-sdk";
- * ...
- * import { ExtensionManager, IKosRegistry } from "@kosdev-code/kos-ui-sdk";
- * export const kosModels: IKosRegistry["models"] = {
- *  ...Availability.registration,
- * };
- * ```
- *
- * ## registration.singleton
- *
- * The beverage model is not a singleton model.  This means that each time the factory function is called with a unique ID, a new model instance will be created.
- * If the factory function is called with an ID that already exists, the existing model will be returned.
- * */
+ * @param predicate Type guard that narrows an `IKosDataModel` to `AvailabilityModel`.
+ * @kosService dispense.availability
+ * @kosApiLevel 2
+ */
 export declare const Availability: Readonly<KosModelRegistrationBean<AvailabilityModel, AvailabilityOptions>>;
 //# sourceMappingURL=availability-model.d.ts.map

package/models/models/availability/availability-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"availability-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/availability/availability-model.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,KAAK,wBAAwB,EAC9B,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAoEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAmFK;AACL,eAAO,MAAM,YAAY,EAAE,QAAQ,CACjC,wBAAwB,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,CAgBjE,CAAC"}
+{"version":3,"file":"availability-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/availability/availability-model.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,KAAK,wBAAwB,EAC9B,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAoEtE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,YAAY,EAAE,QAAQ,CACjC,wBAAwB,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,CAgBjE,CAAC"}

package/models/models/availability/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/availability/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,YAAY,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/availability/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,YAAY,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC"}

package/models/models/availability/types/index.d.ts

@@ -1,7 +1,8 @@
 import { IKosDataModel, KosParentAware, NoteAware } from '@kosdev-code/kos-ui-sdk';
-
 /**
  * Options for creating an AvailabilityModel.
+ * @kosService dispense.availability
+ * @kosApiLevel 2
  */
 export interface AvailabilityOptions<
   AdditionalData extends object = any,
@@ -33,22 +34,15 @@ export interface AvailabilityOptions<
   properties?: Properties;
 }
 /**
- *
- *
  * Represents the nodes of the Beverage Availability graph for a nozzle.
  *
- * @typeParam AdditionalData - Any additional data that is added to a node at the application layer.
- *
- * @example The base GraphNode from the backend will have an id, type, available and visible properties.  However,
- * a given implementation might extend the Beverage Graph node to include additional data, such as the beverage name or
- * an image url.  This additional data would be added to the node and would be represented by the AdditionalData type parameter.
- * ```typescript
- * const model: AvailabilityModel<{icon: string}> = ...;
- * ```
- * would allow for visibility of all the base properties as well as the additional data (icon) that might be on the message payload from
- * the backend.
+ * @typeParam AdditionalData - Application data added to a node by the
+ * {@link ExtensionType.AvailabilityMapper} extension point, such as a beverage name or image url.
+ * It is exposed on `data`, so `AvailabilityModel<{ icon: string }>` types `model.data.icon`.
  *
  * @category Model
+ * @kosService dispense.availability
+ * @kosApiLevel 2
  */
 export interface AvailabilityModel<
   AdditionalData extends object = any,

package/models/models/board/board-container-model.d.ts

@@ -1,9 +1,16 @@
-import { BoardLinkEvent } from './types/services';
-import { BoardContainerOptions, BoardModel } from './types';
 import { IKosDataModel, KosCreationContext } from '@kosdev-code/kos-ui-sdk';
-
+import { BoardContainerOptions, BoardModel } from './types';
+import { BoardLinkEvent } from './types/services';
 export declare const MODEL_TYPE = "board-container-model";
+/**
+ * @kosService dispense.board
+ * @kosApiLevel 2
+ */
 export declare const TOPIC_BOARD_LINKED = "/kos/hardware/board/linked";
+/**
+ * @kosService dispense.board
+ * @kosApiLevel 2
+ */
 export declare const TOPIC_BOARD_UNLINKED = "/kos/hardware/board/unlinked";
 /**
  * @kosService dispense.board

package/models/models/board/board-container-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"board-container-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/board/board-container-model.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,aAAa,EAGb,kBAAkB,EACnB,MAAM,yBAAyB,CAAC;AASjC,OAAO,KAAK,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACjE,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,eAAO,MAAM,UAAU,0BAA0B,CAAC;AAClD,eAAO,MAAM,kBAAkB,+BAA+B,CAAC;AAC/D,eAAO,MAAM,oBAAoB,iCAAiC,CAAC;AAEnE;;;GAGG;AACH,qBACa,mBAAoB,YAAW,aAAa;IACvD,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACvB,OAAO,CAAC,MAAM,CAAiC;gBAEvD,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,qBAAqB,EAC9B,OAAO,EAAE,kBAAkB;IAa7B,IAAI,SAAS,qBAEZ;IAED,WAAW,IAAI,IAAI;IAInB,QAAQ,CAAC,KAAK,EAAE,UAAU;IAI1B,WAAW,CAAC,EAAE,EAAE,MAAM;IAItB,WAAW,CAAC,cAAc,EAAE,cAAc;IAiB1C,oBAAoB,CAAC,cAAc,EAAE,cAAc;IAenD,sBAAsB,CAAC,cAAc,EAAE,cAAc;CAWtD;AAED,MAAM,WAAW,mBAAmB;CAAG"}
+{"version":3,"file":"board-container-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/board/board-container-model.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,aAAa,EAGb,kBAAkB,EACnB,MAAM,yBAAyB,CAAC;AASjC,OAAO,KAAK,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACjE,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,eAAO,MAAM,UAAU,0BAA0B,CAAC;AAClD;;;GAGG;AACH,eAAO,MAAM,kBAAkB,+BAA+B,CAAC;AAC/D;;;GAGG;AACH,eAAO,MAAM,oBAAoB,iCAAiC,CAAC;AAEnE;;;GAGG;AACH,qBACa,mBAAoB,YAAW,aAAa;IACvD,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACvB,OAAO,CAAC,MAAM,CAAiC;gBAEvD,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,qBAAqB,EAC9B,OAAO,EAAE,kBAAkB;IAa7B,IAAI,SAAS,qBAEZ;IAED,WAAW,IAAI,IAAI;IAInB,QAAQ,CAAC,KAAK,EAAE,UAAU;IAI1B,WAAW,CAAC,EAAE,EAAE,MAAM;IAItB,WAAW,CAAC,cAAc,EAAE,cAAc;IAiB1C,oBAAoB,CAAC,cAAc,EAAE,cAAc;IAenD,sBAAsB,CAAC,cAAc,EAAE,cAAc;CAWtD;AAED,MAAM,WAAW,mBAAmB;CAAG"}

package/models/models/board/board-container-registration.d.ts

@@ -1,87 +1,23 @@
-import { BoardContainerOptions } from './types';
-import { BoardContainerModel } from './board-container-model';
 import { SingletonKosModelRegistrationBean } from '@kosdev-code/kos-ui-sdk';
-
+import { BoardContainerModel } from './board-container-model';
+import { BoardContainerOptions } from './types';
 /**
- * # BoardContainer
+ * Registration bean for {@link BoardContainerModel}.
  *
- * The registration bean includes convenience methods for creating and working with BoardContainerModel instances.
+ * - `type`: the model type, used by the model registry and in `@kosDependency` declarations.
+ * - `factory`: `BoardContainer.factory(options)` returns the single instance, creating it on the first call.
+ * - `predicate`: type guard that narrows an `IKosDataModel` to `BoardContainerModel`.
+ * - `registration`: registry entry that can be spread into an `IKosRegistry["models"]` map.
  *
- * ## type
- * The type property is a string that identifies the model type.
- * The type is used to identify the model type in the model registry and to narrow down the model type in type predicates.  It's most frequently
- * used when declaring dependencies on models.
+ * BoardContainer is a singleton. `KosModelRegistry.dispense.models()` registers it.
  *
  * @example
  * ```typescript
- *
- * @kosDependency({modelType: BoardContainer.type, id: "boardContainerId"})
- * private boardContainerModel: BoardContainerModel;
+ * @kosDependency({ modelType: BoardContainer.type })
+ * private boardContainer!: BoardContainerModel;
  * ```
- *
- *
- * ## factory
- *
- * The factory method creates a factory function that can be used to create new BoardContainerModel instances.
- *
- 
- * As this is a singleton model, the factory function accepts the model options as its argument.
- *
- * If a model with the same model type already exists, the factory function will return the existing model.  The options will be ignored
- * in this case and the existing model will be returned in its current state.
- *
- * @example
- * ```typescript
- * const model = BoardContainer.factory({
- *   // Add option data
- * });
- * ```
- 
-
- *
- * ## predicate
- *
- * [Typescript type predicate](https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates) function that will identify and narrow down a model to a BoardContainerModel.
- *
- * @example
- * ```typescript
- *
- * const model: IKosDataModel = ...; // some model
- *
- * if (BoardContainer.predicate(model)) {
- *    // if the function evaluates to true, the model is narrowed down to BoardContainerModel
- *    // and the compiler will know that the model has the BoardContainerModel interface
- *    model.updateAvailability(false);
- * }
- * ```
- *
- * ## registration
- *
- * The registration property is an object that can be used to simplify registration of the model with the model registry.  The registration object
- * can be spread into the model registration and provides all of the required information to register the model implementation class against the model type.
- *
- *
- * @example
- *
- * In an application registration file you can declare the model registration as follows:
- *
- * **registration.ts**
- * ```typescript
- * import { BoardContainer } from "@kosdev-code/kos-dispense-sdk";
- * ...
- * import { ExtensionManager, IKosRegistry } from "@kosdev-code/kos-ui-sdk";
- * export const kosModels: IKosRegistry["models"] = {
- *  ...BoardContainer.registration,
- * };
- * ```
- *
- * ## registration.singleton
- 
- * The boardContainer model is a singleton model.  This means that each time the factory function is called , the same instance will be returned.
- * If the model does not yet exist, it will be created passing in the provided options to initialize it.
- *
- * Singleton models don't require an ID as they will use the model type as their ID to guarantee uniqueness throughout the system.
- 
- * */
+ * @kosService dispense.board
+ * @kosApiLevel 2
+ */
 export declare const BoardContainer: Readonly<SingletonKosModelRegistrationBean<BoardContainerModel, BoardContainerOptions>>;
 //# sourceMappingURL=board-container-registration.d.ts.map

package/models/models/board/board-container-registration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"board-container-registration.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/board/board-container-registration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,yBAAyB,CAAC;AAEjF,OAAO,EAAE,mBAAmB,EAAc,MAAM,yBAAyB,CAAC;AAE1E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAgFK;AACL,eAAO,MAAM,cAAc,EAAE,QAAQ,CACnC,iCAAiC,CAAC,mBAAmB,EAAE,qBAAqB,CAAC,CAc9E,CAAC"}
+{"version":3,"file":"board-container-registration.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/board/board-container-registration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,yBAAyB,CAAC;AAEjF,OAAO,EAAE,mBAAmB,EAAc,MAAM,yBAAyB,CAAC;AAE1E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAErD;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,cAAc,EAAE,QAAQ,CACnC,iCAAiC,CAAC,mBAAmB,EAAE,qBAAqB,CAAC,CAc9E,CAAC"}

package/models/models/board/board-model.d.ts

@@ -1,6 +1,5 @@
-import { BoardModel, BoardOptions } from './types';
 import { IKosDataModel, KosCreationContext } from '@kosdev-code/kos-ui-sdk';
-
+import { BoardModel, BoardOptions } from './types';
 export declare const MODEL_TYPE = "board-model";
 /**
  * @kosService dispense.board

package/models/models/board/board-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"board-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/board/board-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EAEb,kBAAkB,EACnB,MAAM,yBAAyB,CAAC;AAOjC,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAIxD,eAAO,MAAM,UAAU,gBAAgB,CAAC;AAwBxC;;;GAGG;AACH,qBACa,cAAc,CAAC,cAAc,SAAS,MAAM,GAAG,EAAE,CAC5D,YAAW,aAAa,EAAE,UAAU,CAAC,cAAc,CAAC;IAEpD,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAG,MAAM,CAAC;IACd,IAAI,EAAG,MAAM,CAAC;IACd,IAAI,EAAG,MAAM,CAAC;IACd,MAAM,EAAG,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,MAAM,CAAmB;gBAE/B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,kBAAkB;IAQ7B,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;IAMlC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}
+{"version":3,"file":"board-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/board/board-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EAEb,kBAAkB,EACnB,MAAM,yBAAyB,CAAC;AAOjC,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAIxD,eAAO,MAAM,UAAU,gBAAgB,CAAC;AAwBxC;;;GAGG;AACH,qBACa,cAAc,CAAC,cAAc,SAAS,MAAM,GAAG,EAAE,CAC5D,YAAW,aAAa,EAAE,UAAU,CAAC,cAAc,CAAC;IAEpD,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAG,MAAM,CAAC;IACd,IAAI,EAAG,MAAM,CAAC;IACd,IAAI,EAAG,MAAM,CAAC;IACd,MAAM,EAAG,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,MAAM,CAAmB;gBAE/B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,kBAAkB;IAQ7B,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;IAMlC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}

package/models/models/board/board-registration.d.ts

@@ -1,84 +1,22 @@
-import { BoardModel, BoardOptions } from './types';
 import { KosModelRegistrationBean } from '@kosdev-code/kos-ui-sdk';
-
+import { BoardModel, BoardOptions } from './types';
 /**
- * # Board
- *
- * The registration bean includes convenience methods for creating and working with BoardModel instances.
- *
- * ## type
- * The type property is a string that identifies the model type.
- * The type is used to identify the model type in the model registry and to narrow down the model type in type predicates.  It's most frequently
- * used when declaring dependencies on models.
- *
- * @example
- * ```typescript
- *
- * @kosDependency({modelType: Board.type, id: "boardId"})
- * private boardModel: BoardModel;
- * ```
- *
- *
- * ## factory
- *
- * The factory method creates a factory function that can be used to create new BoardModel instances.
- *
- 
- * The factory function is a curried function that takes the model id as the first argument and the options as the second argument.
- *
- * If a model with the specified id already exists, the factory function will return the existing model.  The options will be ignored
- * in this case and the existing model will be returned in its current state.
- *
- * @example
- * ```typescript
- * const model = Board.factory("boardId")({
- *   // Add option data
- * });
- * ```
- 
-
+ * Registration bean for {@link BoardModel}.
  *
- * ## predicate
+ * - `type`: the model type, used by the model registry and in `@kosDependency` declarations.
+ * - `factory`: curried factory, `Board.factory(id)(options)`. Returns the existing model when the id is already in use and ignores the options.
+ * - `predicate`: type guard that narrows an `IKosDataModel` to `BoardModel`.
+ * - `registration`: registry entry that can be spread into an `IKosRegistry["models"]` map.
  *
- * [Typescript type predicate](https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates) function that will identify and narrow down a model to a BoardModel.
+ * Board is not a singleton: each id has its own instance. `KosModelRegistry.dispense.models()` registers it.
  *
  * @example
  * ```typescript
- *
- * const model: IKosDataModel = ...; // some model
- *
- * if (Board.predicate(model)) {
- *    // if the function evaluates to true, the model is narrowed down to BoardModel
- *    // and the compiler will know that the model has the BoardModel interface
- *    model.updateAvailability(false);
- * }
+ * @kosDependency({ modelType: Board.type, id: "boardId" })
+ * private board!: BoardModel;
  * ```
- *
- * ## registration
- *
- * The registration property is an object that can be used to simplify registration of the model with the model registry.  The registration object
- * can be spread into the model registration and provides all of the required information to register the model implementation class against the model type.
- *
- *
- * @example
- *
- * In an application registration file you can declare the model registration as follows:
- *
- * **registration.ts**
- * ```typescript
- * import { Board } from "@kosdev-code/kos-dispense-sdk";
- * ...
- * import { ExtensionManager, IKosRegistry } from "@kosdev-code/kos-ui-sdk";
- * export const kosModels: IKosRegistry["models"] = {
- *  ...Board.registration,
- * };
- * ```
- *
- * ## registration.singleton
- 
- * The board model is NOT a singleton model.  This means that each time the factory function is called with a unique ID, a new model instance will be created.
- * If the factory function is called with an ID that already exists, the existing model will be returned.
- 
- * */
+ * @kosService dispense.board
+ * @kosApiLevel 2
+ */
 export declare const Board: Readonly<KosModelRegistrationBean<BoardModel, BoardOptions>>;
 //# sourceMappingURL=board-registration.d.ts.map

package/models/models/board/board-registration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"board-registration.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/board/board-registration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AAGxE,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KA8EK;AACL,eAAO,MAAM,KAAK,EAAE,QAAQ,CAC1B,wBAAwB,CAAC,UAAU,EAAE,YAAY,CAAC,CAWnD,CAAC"}
+{"version":3,"file":"board-registration.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/board/board-registration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AAGxE,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAExD;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,KAAK,EAAE,QAAQ,CAC1B,wBAAwB,CAAC,UAAU,EAAE,YAAY,CAAC,CAWnD,CAAC"}

package/models/models/board/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/board/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAE7C,mBAAmB,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/board/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAE7C,mBAAmB,SAAS,CAAC"}

package/models/models/board/types/index.d.ts

@@ -1,6 +1,4 @@
 import { IKosDataModel } from '@kosdev-code/kos-ui-sdk';
-
-
 // ---------------  Board ---------------
 
 export interface LinkType {
@@ -10,6 +8,10 @@ export interface LinkType {
   firmwareVersions?: string[];
   [k: string]: string;
 }
+/**
+ * @kosService dispense.board
+ * @kosApiLevel 2
+ */
 export interface BoardOptions<AdditionalData extends object = any> {
   type: string;
   name: string;
@@ -21,8 +23,16 @@ export interface BoardOptions<AdditionalData extends object = any> {
 }
 
 // ---------------  BoardContainer ---------------
+/**
+ * @kosService dispense.board
+ * @kosApiLevel 2
+ */
 export interface BoardContainerOptions {}
 
+/**
+ * @kosService dispense.board
+ * @kosApiLevel 2
+ */
 export interface BoardModel<AdditionalData extends object = {}>
   extends AdditionalData,
     IKosDataModel {

package/models/models/board/types/services.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"services.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/board/types/services.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE;QACJ,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd"}
+{"version":3,"file":"services.d.ts","sourceRoot":"","sources":["../../../../../../../packages/kos-dispense-sdk/src/models/models/board/types/services.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE;QACJ,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd"}

package/models/models/board/utils/board-trouble-data-mapper.d.ts

@@ -1,6 +1,5 @@
-import { BoardTroubleData } from './board-trouble-resolver';
 import { TroubleModel } from '@kosdev-code/kos-ui-sdk';
-
+import { BoardTroubleData } from './board-trouble-resolver';
 export declare const boardTroubleDataMapper: (trouble: TroubleModel<BoardTroubleData>) => Promise<{
     boardName: string;
 }>;

package/models/models/board/utils/board-trouble-data-mapper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"board-trouble-data-mapper.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/board/utils/board-trouble-data-mapper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAG5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAEjE,eAAO,MAAM,sBAAsB,YACxB,aAAa,gBAAgB,CAAC;;EAOxC,CAAC"}
+{"version":3,"file":"board-trouble-data-mapper.d.ts","sourceRoot":"","sources":["../../../../../../../packages/kos-dispense-sdk/src/models/models/board/utils/board-trouble-data-mapper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAG5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAEjE,eAAO,MAAM,sBAAsB,GACjC,SAAS,YAAY,CAAC,gBAAgB,CAAC;;EAOxC,CAAC"}

package/models/models/board/utils/board-trouble-resolver.d.ts

@@ -1,5 +1,4 @@
 import { TroubleModel } from '@kosdev-code/kos-ui-sdk';
-
 export interface BoardTroubleData {
     boardPath: string;
 }

package/models/models/board/utils/board-trouble-resolver.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"board-trouble-resolver.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/board/utils/board-trouble-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,KAAK,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAQzE,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,eAAO,MAAM,oBAAoB,YACtB,aAAa,gBAAgB,CAAC,sBA0BxC,CAAC"}
+{"version":3,"file":"board-trouble-resolver.d.ts","sourceRoot":"","sources":["../../../../../../../packages/kos-dispense-sdk/src/models/models/board/utils/board-trouble-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,KAAK,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAQzE,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,eAAO,MAAM,oBAAoB,GAC/B,SAAS,YAAY,CAAC,gBAAgB,CAAC,sBA0BxC,CAAC"}