@kosdev-code/kos-freestyle-sdk 0.1.0-dev.5873 → 0.1.0-next.1000

package/models/models/fcm-pump/fcm-pump-registration.d.ts

@@ -1,87 +1,22 @@
-import { FcmPumpModel } from './fcm-pump-model';
-import { FcmPumpOptions } from './types';
 import { KosModelRegistrationFactory } from '@kosdev-code/kos-ui-sdk';
-
+import { FcmPumpOptions } from './types';
+import { FcmPumpModel } from './fcm-pump-model';
 /**
- * # FcmPump
- *
- * The registration bean includes convenience methods for creating and working with FcmPumpModel 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: FcmPump.type, id: "fcmPumpId"})
- * private fcmPumpModel: FcmPumpModel;
- * ```
- *
- *
- * ## factory
- *
- * The factory method creates a factory function that can be used to create new FcmPumpModel 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 = FcmPump.factory("fcmPumpId")({
- *   // Add option data
- * });
- * ```
- 
-
+ * Registration bean for {@link FcmPumpModel}.
  *
- * ## predicate
+ * - `type`: the model type, used by the model registry and in `@kosDependency` declarations.
+ * - `factory`: curried factory, `FcmPump.factory(id)(options)`. Returns the existing model when the id is already in use and ignores the options.
+ * - `guard`: type guard that narrows an `IKosDataModel` to `FcmPumpModel`.
+ * - `instance(id)`: reads the model, or builds it from options.
+ * - `register()`: registers the model, and any related models, with the model registry.
  *
- * [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 FcmPumpModel.
+ * FcmPump is not a singleton: each id has its own instance. `KosModelRegistry.freestyle.models()` registers it.
  *
  * @example
  * ```typescript
- *
- * const model: IKosDataModel = ...; // some model
- *
- * if (FcmPump.predicate(model)) {
- *    // if the function evaluates to true, the model is narrowed down to FcmPumpModel
- *    // and the compiler will know that the model has the FcmPumpModel interface
- *    model.updateAvailability(false);
- * }
+ * @kosDependency({ modelType: FcmPump.type, id: "fcmPumpId" })
+ * private fcmPump!: FcmPumpModel;
  * ```
- *
- * ## 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 { FcmPump } from "@kos-ui/project-models";
- * import { KosModelRegistry } from "@kosdev-code/kos-dispense-sdk";
- *
- * import { initKosProvider } from "@kosdev-code/kos-ui-sdk";
- *
- * KosModelRegistry.dispense
- * .models()
- * .model(FcmPump);
- * ```
- *
- * ## registration.singleton
- 
- * The fcmPump 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.
- 
- * */
+ */
 export declare const FcmPump: KosModelRegistrationFactory<FcmPumpModel, FcmPumpOptions>;
 //# sourceMappingURL=fcm-pump-registration.d.ts.map

package/models/models/fcm-pump/fcm-pump-registration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fcm-pump-registration.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/fcm-pump/fcm-pump-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAgFK;AACL,eAAO,MAAM,OAAO,2DAMlB,CAAC"}
+{"version":3,"file":"fcm-pump-registration.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/fcm-pump/fcm-pump-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,OAAO,2DAMlB,CAAC"}

package/models/models/fcm-pump/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/fcm-pump/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,mBAAmB,SAAS,CAAC;AAC7B,YAAY,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,KAAK,eAAe,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/fcm-pump/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,mBAAmB,SAAS,CAAC;AAC7B,YAAY,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,KAAK,eAAe,MAAM,YAAY,CAAC"}

package/models/models/fcm-pump/services/fcm-pump-services.d.ts

@@ -1,5 +1,4 @@
 import { FutureResponse } from '@kosdev-code/kos-ui-sdk';
-
 export type ElectricalTestErrorType = "errEEPROM" | "unknownError";
 export type ElectricalTestData = {
     error?: ElectricalTestErrorType;
@@ -13,5 +12,5 @@ export declare const performElectricalTest: (path: string) => Promise<Electrical
 export declare const performPreCalibrate: (pump: string, tracker?: string) => Promise<FutureResponse>;
 export declare const performCalibrate: (pump: string, tracker?: string) => Promise<FutureResponse>;
 export declare const performVerify: (pump: string, volume: string, tracker?: string) => Promise<FutureResponse>;
-export declare const performComplete: (pump: string, volume1: string, volume2: string) => Promise<string | undefined>;
+export declare const performComplete: (pump: string, volume1: string, volume2: string) => Promise<string>;
 //# sourceMappingURL=fcm-pump-services.d.ts.map

package/models/models/fcm-pump/services/fcm-pump-services.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fcm-pump-services.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/fcm-pump/services/fcm-pump-services.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,KAAK,cAAc,EAEpB,MAAM,yBAAyB,CAAC;AAWjC,MAAM,MAAM,uBAAuB,GAAG,WAAW,GAAG,cAAc,CAAC;AACnE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,CAAC,EAAE,uBAAuB,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG;IACnC,uBAAuB,GAAG,SAAS;IACnC,kBAAkB;CACnB,CAAC;AAEF,eAAO,MAAM,qBAAqB,SAC1B,MAAM,KACX,QAAQ,sBAAsB,CAoChC,CAAC;AAEF,eAAO,MAAM,mBAAmB,SAAgB,MAAM,YAAY,MAAM,4BAoCvE,CAAC;AAEF,eAAO,MAAM,gBAAgB,SAAgB,MAAM,YAAY,MAAM,4BAoCpE,CAAC;AAEF,eAAO,MAAM,aAAa,SAClB,MAAM,UACJ,MAAM,YACJ,MAAM,4BAqCjB,CAAC;AAyBF,eAAO,MAAM,eAAe,SACpB,MAAM,WACH,MAAM,WACN,MAAM,gCAuBhB,CAAC"}
+{"version":3,"file":"fcm-pump-services.d.ts","sourceRoot":"","sources":["../../../../../../../packages/kos-freestyle-sdk/src/models/models/fcm-pump/services/fcm-pump-services.ts"],"names":[],"mappings":"AAAA,OAAO,EAQL,KAAK,cAAc,EAEpB,MAAM,yBAAyB,CAAC;AAWjC,MAAM,MAAM,uBAAuB,GAAG,WAAW,GAAG,cAAc,CAAC;AACnE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,CAAC,EAAE,uBAAuB,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG;IACnC,uBAAuB,GAAG,SAAS;IACnC,kBAAkB;CACnB,CAAC;AAEF,eAAO,MAAM,qBAAqB,GAChC,MAAM,MAAM,KACX,OAAO,CAAC,sBAAsB,CAoChC,CAAC;AAEF,eAAO,MAAM,mBAAmB,GAAU,MAAM,MAAM,EAAE,UAAU,MAAM,4BAoCvE,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAU,MAAM,MAAM,EAAE,UAAU,MAAM,4BAoCpE,CAAC;AAEF,eAAO,MAAM,aAAa,GACxB,MAAM,MAAM,EACZ,QAAQ,MAAM,EACd,UAAU,MAAM,4BAqCjB,CAAC;AASF,eAAO,MAAM,eAAe,GAC1B,MAAM,MAAM,EACZ,SAAS,MAAM,EACf,SAAS,MAAM,oBAuBhB,CAAC"}

package/models/models/fcm-pump/services/index.d.ts.map

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

package/models/models/fcm-pump/types/index.d.ts

@@ -1,5 +1,3 @@
-import { IKosCompanionOptions } from '@kosdev-code/kos-ui-sdk';
 import { PumpModel, PumpOptions } from '@kosdev-code/kos-dispense-sdk';
-
-
+import { IKosCompanionOptions } from '@kosdev-code/kos-ui-sdk';
 export type FcmPumpOptions = IKosCompanionOptions<PumpModel, PumpOptions>;

package/models/models/freestyle-assembly/freestyle-assembly-model.d.ts

@@ -1,12 +1,11 @@
-import { FreestyleHolderModelExt, FreestyleModelAssemblyExt } from '../types/assembly';
-import { RemoteTrayContainerModel } from '../remote-tray';
-import { IceAgitatorModel } from '../ice-agitator';
-import { CartridgeAgitatorContainerModel, CartridgeAgitatorModel } from '../cartridge-agitator';
-import { CarbAgitatorModel } from '../carb-agitator';
-import { AssemblyModel, AssemblyOptions, BoardModel, HolderModel, PumpModel } from '@kosdev-code/kos-dispense-sdk';
-import { FreestyleAssemblyOptions } from './types';
 import { IKosDataModel, IKosIdentifiable, KosCreationContext, PublicModelInterface } from '@kosdev-code/kos-ui-sdk';
-
+import { FreestyleAssemblyOptions } from './types';
+import { AssemblyModel, AssemblyOptions, BoardModel, HolderModel, PumpModel } from '@kosdev-code/kos-dispense-sdk';
+import { CarbAgitatorModel } from '../carb-agitator';
+import { CartridgeAgitatorContainerModel, CartridgeAgitatorModel } from '../cartridge-agitator';
+import { IceAgitatorModel } from '../ice-agitator';
+import { RemoteTrayContainerModel } from '../remote-tray';
+import { FreestyleHolderModelExt, FreestyleModelAssemblyExt } from '../types/assembly';
 export declare const MODEL_TYPE = "freestyle-assembly-model";
 export declare const FEATURE_SUPPORTS_ICE = "iceAgitator";
 export declare const FEATURE_SUPPORTS_CARB = "carbTank";

package/models/models/freestyle-assembly/freestyle-assembly-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"freestyle-assembly-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/freestyle-assembly/freestyle-assembly-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAQjC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAExD,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,SAAS,EACf,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAgB,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,EACL,KAAK,+BAA+B,EACpC,KAAK,sBAAsB,EAC5B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,KAAK,EACV,uBAAuB,EACvB,yBAAyB,EAC1B,MAAM,mBAAmB,CAAC;AAE3B,eAAO,MAAM,UAAU,6BAA6B,CAAC;AAErD,eAAO,MAAM,oBAAoB,gBAAgB,CAAC;AAClD,eAAO,MAAM,qBAAqB,aAAa,CAAC;AAChD,eAAO,MAAM,6BAA6B,gBAAgB,CAAC;AAE3D,MAAM,MAAM,sBAAsB,GAChC,oBAAoB,CAAC,0BAA0B,CAAC,GAC9C,aAAa,CAAC,yBAAyB,EAAE,uBAAuB,CAAC,CAAC;AAEtE,qBAEa,0BACX,YACE,aAAa,EACb,gBAAgB,EAChB,aAAa,CAAC,yBAAyB,EAAE,uBAAuB,CAAC;IAEnE,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,CAAC,cAAc,CAAC,CAAoB;IAC3C,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,QAAQ,CAGd;IAGF,OAAO,CAAC,YAAY,CAA4B;gBAG9C,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,wBAAwB,EACjC,OAAO,EAAE,kBAAkB;IAW7B,IAAI,YAAY,IAAI,MAAM,EAAE,CAE3B;IACD,IAAI,WAAW,IAAI,MAAM,EAAE,CAE1B;IACD,IAAI,UAAU,IAAI,WAAW,CAAC,uBAAuB,CAAC,EAAE,CAEvD;IACD,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CAAC,uBAAuB,CAAC,EAAE;IAGxE,kBAAkB,CAChB,UAAU,EAAE,MAAM,GACjB,WAAW,CAAC,uBAAuB,CAAC,EAAE;IAGzC,IAAI,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAEpD;IACD,IAAI,SAAS,IAAI,MAAM,EAAE,CAExB;IAED,IAAI,MAAM,IAAI,UAAU,CAAC,GAAG,CAAC,EAAE,CAE9B;IACD,WAAW,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IAG3C,IAAI,WAAW,IAAI,gBAAgB,CAElC;IACD,IAAI,QAAQ,IAAI,iBAAiB,GAAG,SAAS,CAE5C;IAED,IAAI,kBAAkB,IAAI,+BAA+B,CAExD;IAED,IAAI,wBAAwB,IAAI,sBAAsB,CAErD;IACD,IAAI,uBAAuB,IAAI,sBAAsB,EAAE,CAEtD;IAED,IAAI,qBAAqB,IAAI,OAAO,CAEnC;IAED,IAAI,WAAW,IAAI,wBAAwB,CAE1C;IAED,IAAI,cAAc,IAAI,OAAO,CAI5B;IAID,IAAI,mBAAmB,IAAI,OAAO,CAEjC;IACD,IAAI,WAAW,YAEd;IAED,IAAI,YAAY,YAEf;IAEK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAQ7B"}
+{"version":3,"file":"freestyle-assembly-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/freestyle-assembly/freestyle-assembly-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAQjC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAExD,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,SAAS,EACf,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAgB,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,EACL,KAAK,+BAA+B,EACpC,KAAK,sBAAsB,EAC5B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,KAAK,EACV,uBAAuB,EACvB,yBAAyB,EAC1B,MAAM,mBAAmB,CAAC;AAE3B,eAAO,MAAM,UAAU,6BAA6B,CAAC;AAErD,eAAO,MAAM,oBAAoB,gBAAgB,CAAC;AAClD,eAAO,MAAM,qBAAqB,aAAa,CAAC;AAChD,eAAO,MAAM,6BAA6B,gBAAgB,CAAC;AAE3D,MAAM,MAAM,sBAAsB,GAChC,oBAAoB,CAAC,0BAA0B,CAAC,GAC9C,aAAa,CAAC,yBAAyB,EAAE,uBAAuB,CAAC,CAAC;AAEtE,qBAEa,0BACX,YACE,aAAa,EACb,gBAAgB,EAChB,aAAa,CAAC,yBAAyB,EAAE,uBAAuB,CAAC;IAEnE,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,CAAC,cAAc,CAAC,CAAoB;IAC3C,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,QAAQ,CAGd;IAGF,OAAO,CAAC,YAAY,CAA4B;gBAG9C,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,wBAAwB,EACjC,OAAO,EAAE,kBAAkB;IAW7B,IAAI,YAAY,IAAI,MAAM,EAAE,CAE3B;IACD,IAAI,WAAW,IAAI,MAAM,EAAE,CAE1B;IACD,IAAI,UAAU,IAAI,WAAW,CAAC,uBAAuB,CAAC,EAAE,CAEvD;IACD,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CAAC,uBAAuB,CAAC,EAAE;IAGxE,kBAAkB,CAChB,UAAU,EAAE,MAAM,GACjB,WAAW,CAAC,uBAAuB,CAAC,EAAE;IAGzC,IAAI,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAEpD;IACD,IAAI,SAAS,IAAI,MAAM,EAAE,CAExB;IAED,IAAI,MAAM,IAAI,UAAU,CAAC,GAAG,CAAC,EAAE,CAE9B;IACD,WAAW,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IAG3C,IAAI,WAAW,IAAI,gBAAgB,CAElC;IACD,IAAI,QAAQ,IAAI,iBAAiB,GAAG,SAAS,CAE5C;IAED,IAAI,kBAAkB,IAAI,+BAA+B,CAExD;IAED,IAAI,wBAAwB,IAAI,sBAAsB,CAErD;IACD,IAAI,uBAAuB,IAAI,sBAAsB,EAAE,CAEtD;IAED,IAAI,qBAAqB,IAAI,OAAO,CAEnC;IAED,IAAI,WAAW,IAAI,wBAAwB,CAE1C;IAED,IAAI,cAAc,IAAI,OAAO,CAI5B;IAID,IAAI,mBAAmB,IAAI,OAAO,CAEjC;IACD,IAAI,WAAW,YAEd;IAED,IAAI,YAAY,YAEf;IAEK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAQ7B"}

package/models/models/freestyle-assembly/freestyle-assembly-registration.d.ts

@@ -1,89 +1,22 @@
-import { FreestyleAssemblyOptions } from './types';
-import { FreestyleAssemblyModel } from './freestyle-assembly-model';
 import { SingletonKosModelRegistrationFactory } from '@kosdev-code/kos-ui-sdk';
-
+import { FreestyleAssemblyModel } from './freestyle-assembly-model';
+import { FreestyleAssemblyOptions } from './types';
 /**
- * # FreestyleAssembly
- *
- * The registration bean includes convenience methods for creating and working with FreestyleAssemblyModel 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
+ * Registration bean for {@link FreestyleAssemblyModel}.
  *
- * @kosDependency({modelType: FreestyleAssembly.type, id: "freestyleAssemblyId"})
- * private freestyleAssemblyModel: FreestyleAssemblyModel;
- * ```
- *
- *
- * ## factory
- *
- * The factory method creates a factory function that can be used to create new FreestyleAssemblyModel instances.
- *
- 
- * As this is a singleton model, the factory function accepts the model options as its argument.
+ * - `type`: the model type, used by the model registry and in `@kosDependency` declarations.
+ * - `factory`: `FreestyleAssembly.factory(options)` returns the single instance, creating it on the first call.
+ * - `guard`: type guard that narrows an `IKosDataModel` to `FreestyleAssemblyModel`.
+ * - `instance()`: reads the model, or builds it from options.
+ * - `register()`: registers the model, and any related models, with the model registry.
  *
- * 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.
+ * FreestyleAssembly is a singleton. `KosModelRegistry.freestyle.models()` registers it.
  *
  * @example
  * ```typescript
- * const model = FreestyleAssembly.factory({
- *   // Add option data
- * });
+ * @kosDependency({ modelType: FreestyleAssembly.type })
+ * private freestyleAssembly!: FreestyleAssemblyModel;
  * ```
- 
-
- *
- * ## 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 FreestyleAssemblyModel.
- *
- * @example
- * ```typescript
- *
- * const model: IKosDataModel = ...; // some model
- *
- * if (FreestyleAssembly.predicate(model)) {
- *    // if the function evaluates to true, the model is narrowed down to FreestyleAssemblyModel
- *    // and the compiler will know that the model has the FreestyleAssemblyModel 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 { FreestyleAssembly } from "@kos-ui/project-models";
- * import { KosModelRegistry } from "@kosdev-code/kos-dispense-sdk";
- *
- * import { initKosProvider } from "@kosdev-code/kos-ui-sdk";
- *
- * KosModelRegistry.dispense
- * .models()
- * .model(FreestyleAssembly);
- * ```
- *
- * ## registration.singleton
- 
- * The freestyleAssembly 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.
- 
- * */
+ */
 export declare const FreestyleAssembly: SingletonKosModelRegistrationFactory<FreestyleAssemblyModel, FreestyleAssemblyOptions>;
 //# sourceMappingURL=freestyle-assembly-registration.d.ts.map

package/models/models/freestyle-assembly/freestyle-assembly-registration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"freestyle-assembly-registration.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/freestyle-assembly/freestyle-assembly-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oCAAoC,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAKzE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAkFK;AACL,eAAO,MAAM,iBAAiB,wFAM5B,CAAC"}
+{"version":3,"file":"freestyle-assembly-registration.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/freestyle-assembly/freestyle-assembly-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oCAAoC,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAKzE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAExD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,iBAAiB,wFAM5B,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/freestyle-assembly/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AACtE,mBAAmB,SAAS,CAAC;AAC7B,YAAY,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/freestyle-assembly/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AACtE,mBAAmB,SAAS,CAAC;AAC7B,YAAY,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC"}

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

@@ -1,7 +1,5 @@
-import { IKosCompanionOptions } from '@kosdev-code/kos-ui-sdk';
 import { AssemblyModel, AssemblyOptions } from '@kosdev-code/kos-dispense-sdk';
-
-
+import { IKosCompanionOptions } from '@kosdev-code/kos-ui-sdk';
 export type FreestyleAssemblyOptions = IKosCompanionOptions<
   AssemblyModel,
   AssemblyOptions

package/models/models/freestyle-holder/freestyle-holder-model.d.ts

@@ -1,7 +1,6 @@
-import { HolderModel } from '@kosdev-code/kos-dispense-sdk';
-import { FreestyleHolderOptions } from './types';
 import { FutureDelegate, IFutureModel, IKosDataModel, IKosIdentifiable, KosCreationContext, PublicModelInterface } from '@kosdev-code/kos-ui-sdk';
-
+import { FreestyleHolderOptions } from './types';
+import { HolderModel } from '@kosdev-code/kos-dispense-sdk';
 export declare const MODEL_TYPE = "freestyle-holder-model";
 export declare const freestyleHolderFactory: (holder: HolderModel) => "freestyle-holder-model" | undefined;
 export type FreestyleHolderModel = PublicModelInterface<FreestyleHolderModelImpl>;

package/models/models/freestyle-holder/freestyle-holder-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"freestyle-holder-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/freestyle-holder/freestyle-holder-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,cAAc,EAEd,YAAY,EACZ,aAAa,EACb,gBAAgB,EAGhB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAQjC,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAEtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AASjE,eAAO,MAAM,UAAU,2BAA2B,CAAC;AAoCnD,eAAO,MAAM,sBAAsB,WAAY,WAAW,yCAKzD,CAAC;AACF,MAAM,MAAM,oBAAoB,GAC9B,oBAAoB,CAAC,wBAAwB,CAAC,CAAC;AAEjD,qBACa,wBACX,YAAW,aAAa,EAAE,gBAAgB,EAAE,cAAc;IAE1D,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,MAAM,CAAkC;IAChD,OAAO,CAAC,OAAO,CAAa;IAE5B,MAAM,CAAC,EAAE,YAAY,CAAC;gBAEpB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,sBAAsB,EAC/B,OAAO,EAAE,kBAAkB;IAQ7B,IAAI,OAAO,uBAEV;IACD,IAAI,QAAQ,wBAEX;IACK,OAAO;IAuBb,IAAI,QAAQ,IAAI,OAAO,CAOtB;IAIK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}
+{"version":3,"file":"freestyle-holder-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/freestyle-holder/freestyle-holder-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,cAAc,EAEd,YAAY,EACZ,aAAa,EACb,gBAAgB,EAGhB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AASjC,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAEtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAajE,eAAO,MAAM,UAAU,2BAA2B,CAAC;AAoCnD,eAAO,MAAM,sBAAsB,GAAI,QAAQ,WAAW,yCAKzD,CAAC;AACF,MAAM,MAAM,oBAAoB,GAC9B,oBAAoB,CAAC,wBAAwB,CAAC,CAAC;AAEjD,qBACa,wBACX,YAAW,aAAa,EAAE,gBAAgB,EAAE,cAAc;IAE1D,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,MAAM,CAAkC;IAChD,OAAO,CAAC,OAAO,CAAa;IAE5B,MAAM,CAAC,EAAE,YAAY,CAAC;gBAEpB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,sBAAsB,EAC/B,OAAO,EAAE,kBAAkB;IAQ7B,IAAI,OAAO,IACwC,MAAM,GAAG,SAAS,CACpE;IACD,IAAI,QAAQ,wBAEX;IACK,OAAO;IAuBb,IAAI,QAAQ,IAAI,OAAO,CAOtB;IAIK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}

package/models/models/freestyle-holder/freestyle-holder-registration.d.ts

@@ -1,87 +1,22 @@
-import { FreestyleHolderOptions } from './types';
-import { FreestyleHolderModel } from './freestyle-holder-model';
 import { KosModelRegistrationFactory } from '@kosdev-code/kos-ui-sdk';
-
+import { FreestyleHolderModel } from './freestyle-holder-model';
+import { FreestyleHolderOptions } from './types';
 /**
- * # FreestyleHolder
- *
- * The registration bean includes convenience methods for creating and working with FreestyleHolderModel 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: FreestyleHolder.type, id: "freestyleHolderId"})
- * private freestyleHolderModel: FreestyleHolderModel;
- * ```
- *
- *
- * ## factory
- *
- * The factory method creates a factory function that can be used to create new FreestyleHolderModel 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 = FreestyleHolder.factory("freestyleHolderId")({
- *   // Add option data
- * });
- * ```
- 
-
+ * Registration bean for {@link FreestyleHolderModel}.
  *
- * ## predicate
+ * - `type`: the model type, used by the model registry and in `@kosDependency` declarations.
+ * - `factory`: curried factory, `FreestyleHolder.factory(id)(options)`. Returns the existing model when the id is already in use and ignores the options.
+ * - `guard`: type guard that narrows an `IKosDataModel` to `FreestyleHolderModel`.
+ * - `instance(id)`: reads the model, or builds it from options.
+ * - `register()`: registers the model, and any related models, with the model registry.
  *
- * [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 FreestyleHolderModel.
+ * FreestyleHolder is not a singleton: each id has its own instance. `KosModelRegistry.freestyle.models()` registers it.
  *
  * @example
  * ```typescript
- *
- * const model: IKosDataModel = ...; // some model
- *
- * if (FreestyleHolder.predicate(model)) {
- *    // if the function evaluates to true, the model is narrowed down to FreestyleHolderModel
- *    // and the compiler will know that the model has the FreestyleHolderModel interface
- *    model.updateAvailability(false);
- * }
+ * @kosDependency({ modelType: FreestyleHolder.type, id: "freestyleHolderId" })
+ * private freestyleHolder!: FreestyleHolderModel;
  * ```
- *
- * ## 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 { FreestyleHolder } from "@kos-ui/project-models";
- * import { KosModelRegistry } from "@kosdev-code/kos-dispense-sdk";
- *
- * import { initKosProvider } from "@kosdev-code/kos-ui-sdk";
- *
- * KosModelRegistry.dispense
- * .models()
- * .model(FreestyleHolder);
- * ```
- *
- * ## registration.singleton
- 
- * The freestyleHolder 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.
- 
- * */
+ */
 export declare const FreestyleHolder: KosModelRegistrationFactory<FreestyleHolderModel, FreestyleHolderOptions>;
 //# sourceMappingURL=freestyle-holder-registration.d.ts.map

package/models/models/freestyle-holder/freestyle-holder-registration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"freestyle-holder-registration.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/freestyle-holder/freestyle-holder-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAErE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAgFK;AACL,eAAO,MAAM,eAAe,2EAM1B,CAAC"}
+{"version":3,"file":"freestyle-holder-registration.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/freestyle-holder/freestyle-holder-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAErE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAEtD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,eAAe,2EAM1B,CAAC"}

package/models/models/freestyle-holder/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/freestyle-holder/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,mBAAmB,SAAS,CAAC;AAC7B,YAAY,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/freestyle-holder/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,mBAAmB,SAAS,CAAC;AAC7B,YAAY,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC"}

package/models/models/freestyle-holder/types/index.d.ts

@@ -1,7 +1,5 @@
-import { IKosCompanionOptions } from '@kosdev-code/kos-ui-sdk';
 import { HolderModel, HolderOptions } from '@kosdev-code/kos-dispense-sdk';
-
-
+import { IKosCompanionOptions } from '@kosdev-code/kos-ui-sdk';
 export type FreestyleHolderOptions = IKosCompanionOptions<
   HolderModel,
   HolderOptions

package/models/models/freestyle-nozzle/freestyle-nozzle-model.d.ts

@@ -1,7 +1,6 @@
-import { FreestyleNozzleOptions } from './types';
-import { FreestyleNutritionInfoResponse } from './services';
 import { IKosDataModel, IKosIdentifiable, KosCreationContext, PublicModelInterface } from '@kosdev-code/kos-ui-sdk';
-
+import { FreestyleNutritionInfoResponse } from './services';
+import { FreestyleNozzleOptions } from './types';
 export declare const MODEL_TYPE = "freestyle-nozzle-model";
 export type FreestyleNozzleModel = PublicModelInterface<FreestyleNozzleModelImpl>;
 export declare class FreestyleNozzleModelImpl implements IKosDataModel, IKosIdentifiable {

package/models/models/freestyle-nozzle/freestyle-nozzle-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"freestyle-nozzle-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/freestyle-nozzle/freestyle-nozzle-model.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAQjC,OAAO,EAEL,KAAK,8BAA8B,EACpC,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAEtD,eAAO,MAAM,UAAU,2BAA2B,CAAC;AAEnD,MAAM,MAAM,oBAAoB,GAC9B,oBAAoB,CAAC,wBAAwB,CAAC,CAAC;AAEjD,qBAEa,wBACX,YAAW,aAAa,EAAE,gBAAgB;IAE1C,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,SAAS,CAAW;IAC5B,OAAO,CAAC,cAAc,CAAC,CAAiC;gBAEtD,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,sBAAsB,EAC/B,OAAO,EAAE,kBAAkB;IAQ7B,IAAI,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,EAE9B;IACD,IAAI,aAAa,+CAEhB;IAED,IAAI,gBAAgB;;;MAEnB;IAOK,uBAAuB;IA0BvB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B,MAAM,IAAI,IAAI;IAGR,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}
+{"version":3,"file":"freestyle-nozzle-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/freestyle-nozzle/freestyle-nozzle-model.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAQjC,OAAO,EAEL,KAAK,8BAA8B,EACpC,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAEtD,eAAO,MAAM,UAAU,2BAA2B,CAAC;AAEnD,MAAM,MAAM,oBAAoB,GAC9B,oBAAoB,CAAC,wBAAwB,CAAC,CAAC;AAEjD,qBAEa,wBACX,YAAW,aAAa,EAAE,gBAAgB;IAE1C,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,SAAS,CAAW;IAC5B,OAAO,CAAC,cAAc,CAAC,CAAiC;gBAEtD,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,sBAAsB,EAC/B,OAAO,EAAE,kBAAkB;IAQ7B,IAAI,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,EAE9B;IACD,IAAI,aAAa,+CAEhB;IAED,IAAI,gBAAgB;;;MAEnB;IAOK,uBAAuB;IA0BvB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B,MAAM,IAAI,IAAI;IAGR,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}

package/models/models/freestyle-nozzle/freestyle-nozzle-registration.d.ts

@@ -1,87 +1,22 @@
-import { FreestyleNozzleOptions } from './types';
-import { FreestyleNozzleModel } from './freestyle-nozzle-model';
 import { KosModelRegistrationFactory } from '@kosdev-code/kos-ui-sdk';
-
+import { FreestyleNozzleModel } from './freestyle-nozzle-model';
+import { FreestyleNozzleOptions } from './types';
 /**
- * # FreestyleNozzle
- *
- * The registration bean includes convenience methods for creating and working with FreestyleNozzleModel 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: FreestyleNozzle.type, id: "freestyleNozzleId"})
- * private freestyleNozzleModel: FreestyleNozzleModel;
- * ```
- *
- *
- * ## factory
- *
- * The factory method creates a factory function that can be used to create new FreestyleNozzleModel 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 = FreestyleNozzle.factory("freestyleNozzleId")({
- *   // Add option data
- * });
- * ```
- 
-
+ * Registration bean for {@link FreestyleNozzleModel}.
  *
- * ## predicate
+ * - `type`: the model type, used by the model registry and in `@kosDependency` declarations.
+ * - `factory`: curried factory, `FreestyleNozzle.factory(id)(options)`. Returns the existing model when the id is already in use and ignores the options.
+ * - `guard`: type guard that narrows an `IKosDataModel` to `FreestyleNozzleModel`.
+ * - `instance(id)`: reads the model, or builds it from options.
+ * - `register()`: registers the model, and any related models, with the model registry.
  *
- * [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 FreestyleNozzleModel.
+ * FreestyleNozzle is not a singleton: each id has its own instance. `KosModelRegistry.freestyle.models()` registers it.
  *
  * @example
  * ```typescript
- *
- * const model: IKosDataModel = ...; // some model
- *
- * if (FreestyleNozzle.predicate(model)) {
- *    // if the function evaluates to true, the model is narrowed down to FreestyleNozzleModel
- *    // and the compiler will know that the model has the FreestyleNozzleModel interface
- *    model.updateAvailability(false);
- * }
+ * @kosDependency({ modelType: FreestyleNozzle.type, id: "freestyleNozzleId" })
+ * private freestyleNozzle!: FreestyleNozzleModel;
  * ```
- *
- * ## 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 { FreestyleNozzle } from "@kos-ui/project-models";
- * import { KosModelRegistry } from "@kosdev-code/kos-dispense-sdk";
- *
- * import { initKosProvider } from "@kosdev-code/kos-ui-sdk";
- *
- * KosModelRegistry.dispense
- * .models()
- * .model(FreestyleNozzle);
- * ```
- *
- * ## registration.singleton
- 
- * The freestyleNozzle 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.
- 
- * */
+ */
 export declare const FreestyleNozzle: KosModelRegistrationFactory<FreestyleNozzleModel, FreestyleNozzleOptions>;
 //# sourceMappingURL=freestyle-nozzle-registration.d.ts.map

package/models/models/freestyle-nozzle/freestyle-nozzle-registration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"freestyle-nozzle-registration.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/freestyle-nozzle/freestyle-nozzle-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAErE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAgFK;AACL,eAAO,MAAM,eAAe,2EAM1B,CAAC"}
+{"version":3,"file":"freestyle-nozzle-registration.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/freestyle-nozzle/freestyle-nozzle-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAErE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAEtD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,eAAe,2EAM1B,CAAC"}

package/models/models/freestyle-nozzle/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/freestyle-nozzle/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,mBAAmB,SAAS,CAAC;AAC7B,YAAY,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AACrE,OAAO,KAAK,uBAAuB,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/freestyle-nozzle/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,mBAAmB,SAAS,CAAC;AAC7B,YAAY,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AACrE,OAAO,KAAK,uBAAuB,MAAM,YAAY,CAAC"}

package/models/models/freestyle-nozzle/services/freestyle-nozzle-services.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"freestyle-nozzle-services.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/freestyle-nozzle/services/freestyle-nozzle-services.ts"],"names":[],"mappings":"AAeA,UAAU,cAAc;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AACD,UAAU,eAAe;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,cAAc,EAAE,CAAC;CAC1B;AACD,MAAM,WAAW,8BAA8B;IAC7C,MAAM,CAAC,EAAE;QACP,SAAS,EAAE,MAAM,CAAC;QAClB,eAAe,EAAE,MAAM,CAAC;QACxB,WAAW,EAAE,MAAM,CAAC;QACpB,kBAAkB,EAAE,MAAM,CAAC;KAC5B,CAAC;IACF,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAI5B;AAED,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM;CAI5B;AACD;;;GAGG;AACH,eAAO,MAAM,yBAAyB,oBACnB,MAAM,cACX,MAAM,WACT,MAAM,EAAE,8DA8BlB,CAAC"}
+{"version":3,"file":"freestyle-nozzle-services.d.ts","sourceRoot":"","sources":["../../../../../../../packages/kos-freestyle-sdk/src/models/models/freestyle-nozzle/services/freestyle-nozzle-services.ts"],"names":[],"mappings":"AAgBA,UAAU,cAAc;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AACD,UAAU,eAAe;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,cAAc,EAAE,CAAC;CAC1B;AACD,MAAM,WAAW,8BAA8B;IAC7C,MAAM,CAAC,EAAE;QACP,SAAS,EAAE,MAAM,CAAC;QAClB,eAAe,EAAE,MAAM,CAAC;QACxB,WAAW,EAAE,MAAM,CAAC;QACpB,kBAAkB,EAAE,MAAM,CAAC;KAC5B,CAAC;IACF,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAI5B;AAED,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM;CAI5B;AACD;;;GAGG;AACH,eAAO,MAAM,yBAAyB,GACpC,iBAAiB,MAAM,EACvB,YAAY,MAAM,EAClB,SAAS,MAAM,EAAE,EACjB,gBAAiC,4CA6BlC,CAAC"}

package/models/models/freestyle-nozzle/services/index.d.ts.map

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

package/models/models/freestyle-nozzle/types/index.d.ts

@@ -1,7 +1,5 @@
-import { IKosCompanionOptions } from '@kosdev-code/kos-ui-sdk';
 import { NozzleModel, NozzleOptions } from '@kosdev-code/kos-dispense-sdk';
-
-
+import { IKosCompanionOptions } from '@kosdev-code/kos-ui-sdk';
 export type FreestyleNozzleOptions = IKosCompanionOptions<
   NozzleModel,
   NozzleOptions

package/models/models/freestyle-pump/freestyle-pump-model.d.ts

@@ -1,7 +1,6 @@
-import { ReplacePumpData, ReplacePumpErrorType } from './services';
-import { FreestylePumpOptions } from './types';
 import { IKosDataModel, IKosIdentifiable, KosCreationContext, PublicModelInterface } from '@kosdev-code/kos-ui-sdk';
-
+import { FreestylePumpOptions } from './types';
+import { ReplacePumpData, ReplacePumpErrorType } from './services';
 export declare const MODEL_TYPE = "freestyle-pump-model";
 export type FreestylePumpModel = PublicModelInterface<FreestylePumpModelImpl>;
 export declare class FreestylePumpModelImpl implements IKosDataModel, IKosIdentifiable {

package/models/models/freestyle-pump/freestyle-pump-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"freestyle-pump-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/freestyle-pump/freestyle-pump-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAGpD,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,oBAAoB,EAC1B,MAAM,YAAY,CAAC;AAEpB,eAAO,MAAM,UAAU,yBAAyB,CAAC;AAEjD,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,CAAC,sBAAsB,CAAC,CAAC;AAE9E,qBACa,sBAAuB,YAAW,aAAa,EAAE,gBAAgB;IAC5E,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,IAAI,CAAY;gBAEtB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,oBAAoB,EAC7B,OAAO,EAAE,kBAAkB;IASvB,WAAW,CACf,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,CAAC,oBAAoB,EAAE,eAAe,CAAC,CAAC;CAQpD"}
+{"version":3,"file":"freestyle-pump-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/freestyle-pump/freestyle-pump-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAGpD,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,oBAAoB,EAC1B,MAAM,YAAY,CAAC;AAEpB,eAAO,MAAM,UAAU,yBAAyB,CAAC;AAEjD,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,CAAC,sBAAsB,CAAC,CAAC;AAE9E,qBACa,sBAAuB,YAAW,aAAa,EAAE,gBAAgB;IAC5E,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,IAAI,CAAY;gBAEtB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,oBAAoB,EAC7B,OAAO,EAAE,kBAAkB;IASvB,WAAW,CACf,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,CAAC,oBAAoB,EAAE,eAAe,CAAC,CAAC;CAQpD"}