@kosdev-code/kos-ddk-models 0.1.0-dev.10

package/lib/settings/services/index.d.ts

@@ -0,0 +1,2 @@
+export * from './settings-services';
+//# sourceMappingURL=index.d.ts.map

package/lib/settings/services/index.d.ts.map

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

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

@@ -0,0 +1,12 @@
+import { ncuiLanguageDataProps } from '../types';
+interface SettingsResponse {
+    id: string;
+}
+/**
+ * @category Service
+ * Retrieves the initial settings data.
+ */
+export declare const getSettings: () => Promise<import('@kosdev-code/kos-ui-sdk').KosServiceResponse<SettingsResponse[]> | undefined>;
+export declare const getNcuiLanguage: () => Promise<import('@kosdev-code/kos-ui-sdk').KosServiceResponse<ncuiLanguageDataProps[][]> | undefined>;
+export {};
+//# sourceMappingURL=settings-services.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"settings-services.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-ddk-models/src/lib/settings/services/settings-services.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAYjD,UAAU,gBAAgB;IACxB,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,qGAIvB,CAAC;AAEF,eAAO,MAAM,eAAe,4GAK3B,CAAC"}

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

@@ -0,0 +1,28 @@
+import { IKosModelLogger, KosConfigProperty, KosContextLogger, KosCreationContext, KosServiceResponse } from '@kosdev-code/kos-ui-sdk';
+import { SettingsModel, SettingsOptions, ncuiLanguageDataProps } from './types';
+export declare const MODEL_TYPE = "settings-model";
+/**
+ * @kosService ddk.settings
+ * @kosApiLevel 1
+ */
+export declare class SettingsModelImpl implements SettingsModel, IKosModelLogger {
+    id: string;
+    logger: KosContextLogger;
+    ncuiLanguageData: KosServiceResponse<ncuiLanguageDataProps> | undefined;
+    resolveDelaysMs: KosConfigProperty<number>;
+    dateFormat: KosConfigProperty<number>;
+    timeFormat: KosConfigProperty<number>;
+    hidePlainWaterBev: KosConfigProperty<boolean>;
+    hideCarbWaterBev: KosConfigProperty<boolean>;
+    ncuiLanguage: KosConfigProperty<string>;
+    name: KosConfigProperty<string>;
+    activateAndRebootTime: KosConfigProperty<number>;
+    horizontalMode: KosConfigProperty<boolean>;
+    constructor(modelId: string, _options: SettingsOptions, context: KosCreationContext);
+    ready(): Promise<void>;
+    getNcuiLanguageList(): Promise<void>;
+    load(): Promise<void>;
+    handleUpdateDisplayMode(): void;
+    updateDisplayMode(): void;
+}
+//# sourceMappingURL=settings-model.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"settings-model.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ddk-models/src/lib/settings/settings-model.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,yBAAyB,CAAC;AAMjC,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,qBAAqB,EACtB,MAAM,SAAS,CAAC;AAEjB,eAAO,MAAM,UAAU,mBAAmB,CAAC;AAE3C;;;GAGG;AACH,qBACa,iBAAkB,YAAW,aAAa,EAAE,eAAe;IACtE,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,gBAAgB,CAAC;IACzB,gBAAgB,EAAE,kBAAkB,CAAC,qBAAqB,CAAC,GAAG,SAAS,CAAC;IAOxE,eAAe,EAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAO5C,UAAU,EAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAMvC,UAAU,EAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAMvC,iBAAiB,EAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAM/C,gBAAgB,EAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAM9C,YAAY,EAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAMzC,IAAI,EAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAMjC,qBAAqB,EAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAMlD,cAAc,EAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;gBAE1C,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,eAAe,EACzB,OAAO,EAAE,kBAAkB;IAQvB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAgBpC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAsB3B,uBAAuB;IAIvB,iBAAiB;CAOlB"}

package/lib/settings/settings-registration.d.ts

@@ -0,0 +1,85 @@
+import { SingletonKosModelRegistrationBean } from '@kosdev-code/kos-ui-sdk';
+import { SettingsModel, SettingsOptions } from './types';
+/**
+ * # Settings
+ *
+ * The registration bean includes convenience methods for creating and working with SettingsModel 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: Settings.type, id: "settingsId"})
+ * private settingsModel: SettingsModel;
+ * ```
+ *
+ *
+ * ## factory
+ *
+ * The factory method creates a factory function that can be used to create new SettingsModel 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 = Settings.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 SettingsModel.
+ *
+ * @example
+ * ```typescript
+ *
+ * const model: IKosDataModel = ...; // some model
+ *
+ * if (Settings.predicate(model)) {
+ *    // if the function evaluates to true, the model is narrowed down to SettingsModel
+ *    // and the compiler will know that the model has the SettingsModel 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 { Settings } from "@kos-ui/kos-dispenser-model";
+ * ...
+ * import { ExtensionManager, IKosRegistry } from "@kosdev-code/kos-ui-sdk";
+ * export const kosModels: IKosRegistry["models"] = {
+ *  ...Settings.registration,
+ * };
+ * ```
+ *
+ * ## registration.singleton
+ 
+ * The settings 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 Settings: Readonly<SingletonKosModelRegistrationBean<SettingsModel, SettingsOptions>>;
+//# sourceMappingURL=settings-registration.d.ts.map

package/lib/settings/settings-registration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings-registration.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ddk-models/src/lib/settings/settings-registration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,yBAAyB,CAAC;AAGjF,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAgFK;AACL,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAC7B,iCAAiC,CAAC,aAAa,EAAE,eAAe,CAAC,CAWlE,CAAC"}

package/lib/settings/types/index.d.ts

@@ -0,0 +1,24 @@
+import { IKosDataModel, KosConfigProperty, KosServiceResponse } from '@kosdev-code/kos-ui-sdk';
+export interface SettingsOptions {}
+
+export interface languagesProps {
+  name: string;
+  locale: string;
+}
+export interface ncuiLanguageDataProps {
+  languages: languagesProps[];
+}
+
+export interface SettingsModel extends SettingsOptions, IKosDataModel {
+  activateAndRebootTime: KosConfigProperty<number>;
+  dateFormat: KosConfigProperty<number>;
+  hideCarbWaterBev: KosConfigProperty<boolean>;
+  hidePlainWaterBev: KosConfigProperty<boolean>;
+  horizontalMode: KosConfigProperty<boolean>;
+  id: string;
+  name: KosConfigProperty<string>;
+  ncuiLanguage: KosConfigProperty<string>;
+  ncuiLanguageData: KosServiceResponse<ncuiLanguageDataProps> | undefined;
+  resolveDelaysMs: KosConfigProperty<number>;
+  timeFormat: KosConfigProperty<number>;
+}

package/lib/setup-step/index.d.ts

@@ -0,0 +1,5 @@
+export { SetupStepContainer } from './setup-step-container-registration';
+export { SetupStep } from './setup-step-registration';
+export type * from './types';
+export * as SetupStepServices from './services';
+//# sourceMappingURL=index.d.ts.map

package/lib/setup-step/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ddk-models/src/lib/setup-step/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,mBAAmB,SAAS,CAAC;AAC7B,OAAO,KAAK,iBAAiB,MAAM,YAAY,CAAC"}

package/lib/setup-step/services/index.d.ts

@@ -0,0 +1,2 @@
+export * from './setup-step-services';
+//# sourceMappingURL=index.d.ts.map

package/lib/setup-step/services/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-ddk-models/src/lib/setup-step/services/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC"}

package/lib/setup-step/services/setup-step-services.d.ts

@@ -0,0 +1,13 @@
+export interface SetupStepResponse {
+    name: string;
+    complete: boolean;
+    preStep: boolean;
+    exclusive: boolean;
+}
+/**
+ * @category Service
+ * Retrieves the initial setup-step data.
+ */
+export declare const getSetupSteps: () => Promise<import('@kosdev-code/kos-ui-sdk').KosServiceResponse<SetupStepResponse[]> | undefined>;
+export declare const markStepComplete: (stepId: string) => Promise<import('@kosdev-code/kos-ui-sdk').KosServiceResponse<any> | undefined>;
+//# sourceMappingURL=setup-step-services.d.ts.map

package/lib/setup-step/services/setup-step-services.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup-step-services.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-ddk-models/src/lib/setup-step/services/setup-step-services.ts"],"names":[],"mappings":"AAcA,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;;GAGG;AACH,eAAO,MAAM,aAAa,sGAMzB,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAU,QAAQ,MAAM,mFAOpD,CAAC"}

package/lib/setup-step/setup-step-container-model.d.ts

@@ -0,0 +1,32 @@
+import { IKosModelContainer, KosCreationContext } from '@kosdev-code/kos-ui-sdk';
+import { AuthModel } from '../auth';
+import { SetupStepResponse } from './services';
+import { SetupStepContainerModel, SetupStepContainerOptions, SetupStepModel } from './types';
+export declare const MODEL_TYPE = "setup-step-container-model";
+/**
+ * @kosService ddk.setup-step
+ * @kosApiLevel 1
+ */
+export declare class SetupStepContainerModelImpl implements SetupStepContainerModel {
+    id: string;
+    private _currentStep?;
+    private logger;
+    models: IKosModelContainer<SetupStepModel>;
+    authModel: AuthModel;
+    constructor(modelId: string, options: SetupStepContainerOptions, context: KosCreationContext);
+    get currentStep(): SetupStepModel | undefined;
+    setCurrentStep(id: string): void;
+    nextStep(): void;
+    get hasIncompletePreSteps(): boolean;
+    get setupRequired(): boolean;
+    get firstIncompleteStep(): SetupStepModel | undefined;
+    get isLastStep(): boolean;
+    get data(): SetupStepModel[];
+    getModel(id: string): SetupStepModel | undefined;
+    addModel(model: SetupStepModel): void;
+    removeModel(id: string): void;
+    init(): Promise<void>;
+    load(): Promise<void>;
+    handleStepChanges(steps: SetupStepResponse[]): void;
+}
+//# sourceMappingURL=setup-step-container-model.d.ts.map

package/lib/setup-step/setup-step-container-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup-step-container-model.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ddk-models/src/lib/setup-step/setup-step-container-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAElB,kBAAkB,EACnB,MAAM,yBAAyB,CAAC;AASjC,OAAO,EAAQ,KAAK,SAAS,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,EAAiB,KAAK,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAEnE,OAAO,KAAK,EAEV,uBAAuB,EACvB,yBAAyB,EACzB,cAAc,EACf,MAAM,SAAS,CAAC;AAEjB,eAAO,MAAM,UAAU,+BAA+B,CAAC;AAevD;;;GAGG;AACH,qBACa,2BAA4B,YAAW,uBAAuB;IACzE,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,YAAY,CAAC,CAAiB;IACtC,OAAO,CAAC,MAAM,CAAmB;IACvB,MAAM,EAAE,kBAAkB,CAAC,cAAc,CAAC,CAAC;IAGrD,SAAS,EAAG,SAAS,CAAC;gBAGpB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,yBAAyB,EAClC,OAAO,EAAE,kBAAkB;IAe7B,IAAI,WAAW,+BAEd;IAED,cAAc,CAAC,EAAE,EAAE,MAAM;IAMzB,QAAQ;IAYR,IAAI,qBAAqB,YAExB;IAED,IAAI,aAAa,YAEhB;IACD,IAAI,mBAAmB,+BAEtB;IACD,IAAI,UAAU,YAIb;IAED,IAAI,IAAI,qBAEP;IAED,QAAQ,CAAC,EAAE,EAAE,MAAM;IAInB,QAAQ,CAAC,KAAK,EAAE,cAAc;IAI9B,WAAW,CAAC,EAAE,EAAE,MAAM;IAKhB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IA2B3B,iBAAiB,CAAC,KAAK,EAAE,iBAAiB,EAAE;CAe7C"}

package/lib/setup-step/setup-step-container-registration.d.ts

@@ -0,0 +1,85 @@
+import { SingletonKosModelRegistrationBean } from '@kosdev-code/kos-ui-sdk';
+import { SetupStepContainerModel, SetupStepContainerOptions } from './types';
+/**
+ * # SetupStepContainer
+ *
+ * The registration bean includes convenience methods for creating and working with SetupStepContainerModel 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: SetupStepContainer.type, id: "setupStepContainerId"})
+ * private setupStepContainerModel: SetupStepContainerModel;
+ * ```
+ *
+ *
+ * ## factory
+ *
+ * The factory method creates a factory function that can be used to create new SetupStepContainerModel 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 = SetupStepContainer.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 SetupStepContainerModel.
+ *
+ * @example
+ * ```typescript
+ *
+ * const model: IKosDataModel = ...; // some model
+ *
+ * if (SetupStepContainer.predicate(model)) {
+ *    // if the function evaluates to true, the model is narrowed down to SetupStepContainerModel
+ *    // and the compiler will know that the model has the SetupStepContainerModel 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 { SetupStepContainer } from "@kos-ui/kos-dispenser-model";
+ * ...
+ * import { ExtensionManager, IKosRegistry } from "@kosdev-code/kos-ui-sdk";
+ * export const kosModels: IKosRegistry["models"] = {
+ *  ...SetupStepContainer.registration,
+ * };
+ * ```
+ *
+ * ## registration.singleton
+ 
+ * The setupStepContainer 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 SetupStepContainer: Readonly<SingletonKosModelRegistrationBean<SetupStepContainerModel, SetupStepContainerOptions>>;
+//# sourceMappingURL=setup-step-container-registration.d.ts.map

package/lib/setup-step/setup-step-container-registration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup-step-container-registration.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ddk-models/src/lib/setup-step/setup-step-container-registration.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,yBAAyB,CAAC;AAEjF,OAAO,KAAK,EACV,uBAAuB,EACvB,yBAAyB,EAC1B,MAAM,SAAS,CAAC;AAMjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAgFK;AACL,eAAO,MAAM,kBAAkB,EAAE,QAAQ,CACvC,iCAAiC,CAC/B,uBAAuB,EACvB,yBAAyB,CAC1B,CAeF,CAAC"}

package/lib/setup-step/setup-step-model.d.ts

@@ -0,0 +1,24 @@
+import { IKosDataModel, KosCreationContext } from '@kosdev-code/kos-ui-sdk';
+import { SetupStepModel, SetupStepOptions } from './types';
+export declare const MODEL_TYPE = "setup-step-model";
+/**
+ * @kosService ddk.setup-step
+ * @kosApiLevel 1
+ */
+export declare class SetupStepModelImpl implements SetupStepModel, IKosDataModel {
+    id: string;
+    idx: number;
+    name: string;
+    complete: boolean;
+    preStep: boolean;
+    exclusive: boolean;
+    private logger;
+    constructor(modelId: string, options: SetupStepOptions, context: KosCreationContext);
+    updateModel(options: SetupStepOptions): void;
+    get titleKey(): string;
+    get bodyKey(): string;
+    completeStep(): Promise<void>;
+    init(): Promise<void>;
+    load(): Promise<void>;
+}
+//# sourceMappingURL=setup-step-model.d.ts.map

package/lib/setup-step/setup-step-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup-step-model.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ddk-models/src/lib/setup-step/setup-step-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EAEb,kBAAkB,EACnB,MAAM,yBAAyB,CAAC;AAGjC,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhE,eAAO,MAAM,UAAU,qBAAqB,CAAC;AAE7C;;;GAGG;AACH,qBACa,kBAAmB,YAAW,cAAc,EAAE,aAAa;IACtE,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IAEnB,OAAO,CAAC,MAAM,CAAmB;gBAE/B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,gBAAgB,EACzB,OAAO,EAAE,kBAAkB;IAW7B,WAAW,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI;IAQ5C,IAAI,QAAQ,WAEX;IAED,IAAI,OAAO,WAEV;IAEK,YAAY;IAWZ,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}

package/lib/setup-step/setup-step-registration.d.ts

@@ -0,0 +1,83 @@
+import { KosModelRegistrationBean } from '@kosdev-code/kos-ui-sdk';
+import { SetupStepModel, SetupStepOptions } from './types';
+/**
+ * # SetupStep
+ *
+ * The registration bean includes convenience methods for creating and working with SetupStepModel 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: SetupStep.type, id: "setupStepId"})
+ * private setupStepModel: SetupStepModel;
+ * ```
+ *
+ *
+ * ## factory
+ *
+ * The factory method creates a factory function that can be used to create new SetupStepModel 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 = SetupStep.factory("setupStepId")({
+ *   // 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 SetupStepModel.
+ *
+ * @example
+ * ```typescript
+ *
+ * const model: IKosDataModel = ...; // some model
+ *
+ * if (SetupStep.predicate(model)) {
+ *    // if the function evaluates to true, the model is narrowed down to SetupStepModel
+ *    // and the compiler will know that the model has the SetupStepModel 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 { SetupStep } from "@kos-ui/kos-dispenser-model";
+ * ...
+ * import { ExtensionManager, IKosRegistry } from "@kosdev-code/kos-ui-sdk";
+ * export const kosModels: IKosRegistry["models"] = {
+ *  ...SetupStep.registration,
+ * };
+ * ```
+ *
+ * ## registration.singleton
+ 
+ * The setupStep 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 SetupStep: Readonly<KosModelRegistrationBean<SetupStepModel, SetupStepOptions>>;
+//# sourceMappingURL=setup-step-registration.d.ts.map

package/lib/setup-step/setup-step-registration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup-step-registration.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ddk-models/src/lib/setup-step/setup-step-registration.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAGhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KA8EK;AACL,eAAO,MAAM,SAAS,EAAE,QAAQ,CAC9B,wBAAwB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAW3D,CAAC"}

package/lib/setup-step/types/index.d.ts

@@ -0,0 +1,38 @@
+import { IKosIdentifiable, IKosModelHolder, IKosDataModel } from '@kosdev-code/kos-ui-sdk';
+// ---------------  SetupStep ---------------
+
+export interface SetupStepOptions {
+  name: string;
+  idx: number;
+  complete: boolean; // true if the step is complete
+  preStep: boolean; // true if this step is a pre-step
+  exclusive: boolean; // if true, hide all non-exclusive steps
+}
+
+export interface SetupStepModel extends IKosDataModel {
+  idx: number;
+  name: string;
+  complete: boolean; // true if the step is complete
+  preStep: boolean; // true if this step is a pre-step
+  exclusive: boolean; // if true, hide all non-exclusive steps
+  readonly titleKey: string;
+  updateModel: (options: SetupStepOptions) => void;
+  completeStep: () => Promise<void>;
+}
+
+// ---------------  SetupStepContainer ---------------
+export interface SetupStepContainerOptions {}
+
+export interface SetupStepContainerModel
+  extends IKosDataModel,
+    IKosModelHolder<SetupStepModel> {
+  currentStep?: SetupStepModel;
+  readonly setupRequired: boolean;
+  readonly hasIncompletePreSteps: boolean;
+  setCurrentStep: (id: stepName) => void;
+  nextStep: () => void;
+  readonly firstIncompleteStep: SetupStepModel<IKosDataModel>;
+  readonly isLastStep: boolean;
+}
+
+export type IdentifiableStep = SetupStepOptions & IKosIdentifiable;

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

@@ -0,0 +1,7 @@
+/**
+ * (C) Copyright 2024, TCCC, All rights reserved.
+ */
+export { TroubleAction as TroubleActionManager } from './trouble-action-model';
+export type { TroubleActionModel as TroubleActionManagerModel } from './trouble-action-model';
+export type { TroubleActionData as TroubleActionManagerData, TroubleActionOptions as TroubleActionManagerOptions, } from './types';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ddk-models/src/lib/trouble-action/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,aAAa,IAAI,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC/E,YAAY,EAAE,kBAAkB,IAAI,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAC9F,YAAY,EACV,iBAAiB,IAAI,wBAAwB,EAC7C,oBAAoB,IAAI,2BAA2B,GACpD,MAAM,SAAS,CAAC"}