@kosdev-code/kos-ui-sdk 2.0.2

package/models/services/future/index.d.ts

@@ -0,0 +1,98 @@
+/**
+ * @category Service Module
+ * @name /services/future
+ * @version 1.0.0
+ * @author Matthew Holman <maholman@coca-cola.com>
+ *
+ * Services that can be invoked to perform operations on Futures
+ */
+/**
+ * The possible endState codes returned by a Future
+ */
+export declare enum FutureEndState {
+    Success = "SUCCESS",
+    Fail = "FAIL",
+    Aborted = "ABORT",
+    Canceled = "CANCEL"
+}
+/**
+ * The response from the server when an organization is
+ * created or updated
+ */
+export interface FutureResponse {
+    tracker?: string;
+    /** the id of the Future */
+    id: string;
+    /** the remaining time of the Future */
+    remainingTimeMs?: number;
+    /** the progress of the Future */
+    progress?: number;
+    /** the end state of the Future */
+    endState?: FutureEndState;
+    /** the reason for a failure */
+    reason?: string;
+    /** object containing client data */
+    clientData?: Record<string, unknown>;
+    /** object containing reason data */
+    reasonData?: {
+        name: string;
+        version: string;
+    } | {
+        vmId: string;
+        target: string;
+    } | {
+        vmId: string;
+        target: string;
+    }[];
+    /** object containing client data */
+    note?: string;
+}
+export interface FutureRequest {
+    /** the id of the Future to create */
+    id: string;
+}
+/**
+ * @category Service
+ * Retrieves the list of Futures.
+ */
+export declare const getFutures: () => Promise<import('../../../core').KosServiceResponse<FutureResponse[]> | undefined>;
+/**
+ * Removes an Future based on the id.
+ *
+ * While the immediate response to the request is empty, and additions will be broadcast
+ * to all interested listeners on the `/future/delete` event channel.
+ *
+ * @param futureId - the id of the future to be deleted
+ * @returns an empty response with status 200.
+ */
+export declare const deleteFuture: (id: string, path?: string) => Promise<import('../../../core').KosServiceResponse<unknown> | undefined>;
+/**
+ * Adds a new Future.
+ *
+ *
+ * While the immediate response to the request is empty, and additions will be broadcast
+ * to all interested listeners on the `/future/add` event channel.
+ *
+ * @param organization - the organization to be added
+ * @returns an empty response with status 200.
+ * @internal
+ */
+export declare const addFuture: (future: FutureRequest, path?: string) => Promise<import('../../../core').KosServiceResponse<any> | undefined>;
+/**
+ * Modifies an Future from the server based on the id.
+ *
+ * While the immediate response to the request is empty, and additions will be broadcast
+ * to all interested listeners on the `/future/update` event channel.
+ *
+ * @param id - the id of the Future to be modified
+ * @returns an empty response with status 200.
+ */
+export declare const modifyFuture: (id: string, model: FutureRequest, path?: string) => Promise<import('../../../core').KosServiceResponse<any> | undefined>;
+/**
+ * Cancels a Future from the server based on the id.
+ *
+ * @param id - the id of the Future to be modified
+ * @returns an empty response with status 200.
+ */
+export declare const cancelFuture: (id: string, path?: string) => Promise<import('../../../core').KosServiceResponse<any> | undefined>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/services/future/index.ts"],"names":[],"mappings":"AAMA;;;;;;;GAOG;AAEH;;GAEG;AACH,oBAAY,cAAc;IACxB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,OAAO,UAAU;IACjB,QAAQ,WAAW;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2BAA2B;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,uCAAuC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,+BAA+B;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,oCAAoC;IACpC,UAAU,CAAC,EACP;QACE,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,GACD;QACE,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,GACD;QACE,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,EAAE,CAAC;IACR,oCAAoC;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,qCAAqC;IACrC,EAAE,EAAE,MAAM,CAAC;CACZ;AAWD;;;GAGG;AACH,eAAO,MAAM,UAAU,yFAGtB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,OAAc,MAAM,4FAO5C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,WACZ,aAAa,wFAStB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,OACnB,MAAM,SACH,aAAa,wFAUrB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,OAAc,MAAM,wFAQ5C,CAAC"}

package/models/services/index.d.ts

@@ -0,0 +1,4 @@
+export * from './login';
+export * from './future';
+export * from './config-bean';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/models/services/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC"}

package/models/services/login/index.d.ts

@@ -0,0 +1,78 @@
+import { KosServiceResponse } from '../../../core';
+
+interface LoginResponse {
+    token: string;
+}
+/**
+ * Convienience function to provide Studio specific login functions defaulting the url
+ * Studio endpoint.
+ * @param username - the username of the user to log in
+ * @param password - the password of the user to log in
+ * @returns a login response with the token of the logged in user
+ *
+ * @internal
+ * @see login
+ */
+export declare const studioLogin: (username: string, password: string) => Promise<KosServiceResponse<LoginResponse> | null>;
+/**
+ * Attempts a log in against the specified URL.
+ * @param username - the username of the user to log in
+ * @param password - the password of the user to log in
+ * @param url - the url to send the login request to.
+ * @defaultValue - defaults to the Admin server URL.
+ *
+ * @returns a login response with the token of the logged in user
+ */
+export declare const login: (username: string, password: string, url?: string) => Promise<KosServiceResponse<LoginResponse> | null>;
+/**
+ * Convienience function to provide Studio specific password reset functions defaulting the url
+ * Studio endpoint.
+ * @param username - the userID of the user to start the password reset process.
+ * @returns an API response with no value.
+ *
+ * @see startPasswordReset
+ * @internal
+ */
+export declare const studioStartPasswordReset: (userId: string) => Promise<KosServiceResponse<unknown> | null>;
+/**
+ * When a user is first created or if the password is forgotten.  A user can request
+ * a password reset from thier Organization administrator.  The administrator will end
+ * up calling this function in order to initiate the request and have reset token sent
+ * to the user on thier specified e-mail address (or other method.)
+ * The token, received by the user, can be used as part of the reset call to provide a new password.
+ *
+ * @param userId - the user ID of the suer to start the password reset process.
+ * @param url - the url to send the login request to.
+ * @defaultValue - defaults to the Admin server URL.
+ * @returns an API response with no value.
+ * @internal
+ * @see resetPassword
+ */
+export declare const startPasswordReset: (userId: string, url?: string, destinationAddress?: string) => Promise<KosServiceResponse<unknown> | null>;
+/**
+ * Convienience function to provide Studio specific password reset functions defaulting the url
+ * Studio endpoint.
+ * @param token - the reset token recieved as part of the `startPasswordReset` process
+ * @param password - the new password to be used by the user specified in the token.
+ * @returns an API response with no value.
+ * @internal
+ * @see startPasswordReset
+ */
+export declare const studioResetPassword: (token: string, password: string) => Promise<KosServiceResponse<unknown> | null>;
+/**
+ * Resets the password for the user.
+ *
+ * @param token - the reset token recieved as part of the `startPasswordReset` process
+ * @param password - the new password to be used by the user specified in the token.
+ * @param url - the url to send the login request to.
+ * @defaultValue - defaults to the Admin server URL.
+ * @returns an API response with no value.
+ *
+ * @internal
+ * @see resetPassword
+ */
+export declare const resetPassword: (token: string, password: string, url?: string) => Promise<KosServiceResponse<unknown> | null>;
+export declare const studioAcceptOrgInvitation: (token: string, password: string, name: string) => Promise<KosServiceResponse<unknown> | null>;
+export declare const acceptOrgInvitation: (token: string, password: string, name: string, url?: string) => Promise<KosServiceResponse<unknown> | null>;
+export {};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/services/login/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAI/E,UAAU,aAAa;IACrB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,aAAoB,MAAM,YAAY,MAAM,sDACT,CAAC;AAE5D;;;;;;;;GAQG;AACH,eAAO,MAAM,KAAK,aACN,MAAM,YACN,MAAM,oEAmBjB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB,WAAkB,MAAM,gDACgB,CAAC;AAE9E;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,kBAAkB,WACrB,MAAM,2FAgBf,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,UAAiB,MAAM,YAAY,MAAM,gDACD,CAAC;AAEzE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,aAAa,UACjB,MAAM,YACH,MAAM,8DA8BjB,CAAC;AAEF,eAAO,MAAM,yBAAyB,UAC7B,MAAM,YACH,MAAM,QACV,MAAM,gDAOX,CAAC;AACJ,eAAO,MAAM,mBAAmB,UACvB,MAAM,YACH,MAAM,QACV,MAAM,8DA+Bb,CAAC"}

package/models/services/trouble/index.d.ts

@@ -0,0 +1,59 @@
+/**
+ * @category Service Module
+ * @name /services/trouble
+ * @version 1.0.0
+ * @author Mark Pomerant <mpomerant@coca-cola.com>
+ *
+ * Services that can be invoked to perform operations on Troubles
+ */
+/**
+ * The response from the server when an organization is
+ * created or updated
+ */
+export interface TroubleResponse {
+    /** the id of the Trouble */
+    id: string;
+    /** the name of the Trouble */
+    name: string;
+}
+export interface TroubleRequest {
+    /** the name of the Trouble to create */
+    name: string;
+}
+/**
+ * @category Service
+ * Retrieves the list of Troubles.
+ */
+export declare const getTroubles: () => Promise<import('../../../core').KosServiceResponse<TroubleResponse[]> | undefined>;
+/**
+ * Adds a new Trouble.
+ *
+ *
+ * While the immediate response to the request is empty, and additions will be broadcast
+ * to all interested listeners on the `/api/troubles/add` event channel.
+ *
+ * @param organization - the organization to be added
+ * @returns an empty response with status 200.
+ */
+export declare const addTrouble: (trouble: TroubleRequest) => Promise<import('../../../core').KosServiceResponse<any> | undefined>;
+/**
+ * Removes an Trouble based on the id.
+ *
+ * While the immediate response to the request is empty, and additions will be broadcast
+ * to all interested listeners on the `/api/troubles/delete` event channel.
+ *
+ * @param troubleId - the id of the Trouble to be deleted
+ * @returns an empty response with status 200.
+ */
+export declare const deleteTrouble: (id: string) => Promise<import('../../../core').KosServiceResponse<unknown> | undefined>;
+/**
+ * Modifies an Trouble from the server based on the id.
+ *
+ * While the immediate response to the request is empty, and additions will be broadcast
+ * to all interested listeners on the `/api/troubles/update` event channel.
+ *
+ * @param id - the id of the Trouble to be modified
+ * @returns an empty response with status 200.
+ */
+export declare const modifyTrouble: (id: string, model: TroubleRequest) => Promise<import('../../../core').KosServiceResponse<any> | undefined>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/services/trouble/index.ts"],"names":[],"mappings":"AAMA;;;;;;;GAOG;AAEH;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,4BAA4B;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAC7B,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;CACd;AAMD;;;GAGG;AACH,eAAO,MAAM,WAAW,0FAGvB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,YAAmB,cAAc,yEAIvD,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,OAAc,MAAM,6EAI7C,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,OAAc,MAAM,SAAS,cAAc,yEAOpE,CAAC"}

package/models/types/global.d.ts

@@ -0,0 +1,19 @@
+declare namespace NodeJS {
+  export interface ProcessEnv {
+    KOS_ALLOW_ANONYMOUS: string;
+    KOS_PLATFORM: string;
+    KOS_LOG_WS: string;
+    KOS_LOGIN_URL: string;
+    KOS_APP_PORT: string;
+    KOS_PORT: string;
+    KOS_STUDIO_PORT: string;
+    KOS_CONNECTION_ALIAS: string;
+    KOS_MOCK_WS: string;
+    KOS_LOG_WS: string;
+    KOS_FOS_PORT: string;
+    KOS_USE_FOS: string;
+    KOS_WS_TIMEOUT: string;
+    KOS_LOG_LEVEL: string;
+    KOS_MOCK_FETCH: string;
+  }
+}

package/models/utils/client.d.ts

@@ -0,0 +1,63 @@
+import { paths } from './types';
+import { AvailableMethods, ClientResponse } from '../../core';
+
+export declare const api: {
+    get: <K extends "/api/vfs" | "/api/ext/dispense/soldOuts/troubles" | "/api/ext/dispense/soldOuts/db" | "/api/kos/time/timezone" | "/api/kos/storage/devices" | "/api/ext/freestyle/can/read/float/{boardPath}/{index}/{subIndex}" | "/api/ext/freestyle/can/read/int/{boardPath}/{index}/{subIndex}" | "/api/ext/freestyle/can/stats" | "/api/ext/freestyle/can/stats/raw" | "/api/app/kosdev.ddk/cui" | "/api/app/kosdev.ddk/cui/open" | "/api/kos/criticalData/sources" | "/api/kos/criticalData/data" | "/api/kos/criticalData/data/{name}" | "/api/app/kosdev.ddk/ncui/plugins" | "/api/app/kosdev.ddk/ncui/open" | "/api/kos/browser" | "/api/kos/browser/redirect" | "/api/kos/future/traces" | "/api/kos/future/traces/{traceId}/events" | "/api/app/tccc.fits/medusa/profiles" | "/api/app/tccc.fits/medusa/profiles/{profileId}/recipes" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/{testId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/builder/blocks" | "/api/app/tccc.fits/medusa/profiles/{profileId}/builder/bevs" | "/api/app/tccc.fits/medusa/profiles/{profileId}/map" | "/api/app/tccc.fits/medusa/profiles/{profileId}/results" | "/api/app/tccc.fits/medusa/profiles/{profileId}/results/{resultsId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/results/{resultsId}/entries/{startIdx}/{endIdx}" | "/api/kos/descriptor/{path}" | "/api/kos/descriptor/{path}/{dotted}" | "/api/kos/device" | "/api/kos/device/assemblies" | "/api/kos/device/serialNumber" | "/api/app/kosdev.ddk/auth/role" | "/api/ext/freestyle/microCalibration/report/{board}" | "/api/ext/freestyle/microCalibration/cal/{pump}" | "/api/ext/freestyle/fcm/calibration/{pump}/baseline" | "/api/ext/dispense/nozzle/nozzle/pipeline/ingredient/intent/{path}/{intent}" | "/api/ext/dispense/nozzle/nozzle/pipeline/ingredient/intent/{path}/{intent}/volume" | "/api/ext/dispense/nozzle/nozzle/pipeline/ingredient/intent/{path}/{intent}/time" | "/api/kos/localization/context/{*path}" | "/api/kos/localization/contexts" | "/api/kos/ota/paused" | "/api/kos/ota/artifacts" | "/api/app/kosdev.ddk/setup/steps" | "/api/app/kosdev.ddk/setup/steps/reset" | "/api/kos/troubles" | "/api/kos/troubles/{troubleId}" | "/api/kos/update/available" | "/api/kos/nodeMgr/node/{nodeId}/blockedManifests" | "/api/kos/nodeMgr/blockedManifests" | "/api/kos/manifest/node" | "/api/kos/manifest/device" | "/api/kos/manifest/info" | "/api/kos/config/schema" | "/api/kos/config/schema/{path}" | "/api/kos/config/{path}" | "/api/kos/config/details/{options}" | "/api/kos/config/details/{path}/{options}" | "/api/kos/config/value/merged/{scopedPath}/{attr}" | "/api/kos/config/value/{scopedPath}/{attr}" | "/api/kos/config/bean/defaults/{scopedPath}" | "/api/kos/config/bean/merged/{path}" | "/api/kos/config/bean/overrides/{scopedPath}" | "/api/app/kosdev.ddk/network/reports" | "/api/app/kosdev.ddk/network/tests" | "/api/app/kosdev.ddk/network/tests/run/{id}" | "/api/app/kosdev.ddk/network/tests/run/group/{group}" | "/api/kos/network/interfaces" | "/api/app/tccc.fits/scales" | "/api/app/tccc.fits/scales/ifaces" | "/api/ext/freestyle/ice/types" | "/api/app/tccc.fits/persistence/sources" | "/api/kos/state/paths" | "/api/kos/state/{path}" | "/api/ext/dispense/ingredients" | "/api/ext/dispense/ingredients/sources" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/select" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/availability" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/availability/groups/{group}" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/graph/node/{id}" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/graph/beverages" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/graph/nodes" | "/api/kos/handles" | "/api/kos/handles/{path}" | "/api/kos/handles/{path}/{view}" | "/api/kos/handles/views" | "/api/ext/dispense/metrics" | "/api/ext/dispense/metrics/names" | "/api/ext/dispense/metrics/{name}" | "/api/ext/dispense/metrics/{nozzle}/names" | "/api/ext/dispense/metrics/{nozzle}/{name}" | "/api/kos/regions" | "/api/kos/regions/info" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/engine/nutrition/{bevId}" | "/api/ext/dispense/assignments" | "/api/ext/freestyle/brandset/nutrition/{bevId}" | "/api/ext/freestyle/brandset/grantProperties" | "/api/kos/openapi/{*baseUrl}" | "/api/app/kosdev.ddk/copyLogs/volumes/size" | "/api/app/kosdev.ddk/copyLogs/files/size" | "/api/app/tccc.fits/session" | "/api/app/tccc.fits/session/data/{key}" | "/api/app/tccc.fits.sim/scales" | "/api/app/tccc.fits.sim/scales/{serialNum}" | "/api/app/tccc.fits.sim/scales/{serialNum}/pour/stop" | "/api/app/tccc.fits.sim/scales/{serialNum}/pour/start" | "/api/app/tccc.fits.sim/scales/{serialNum}/reading" | "/api/app/tccc.fits.sim/pumps" | "/api/ext/cms/screens/context/{*path}" | "/api/ext/cms/screens/contexts" | "/api/kos/troubles/debug" | "/api/kos/troubles/debug/{troubleId}">(endpoint: K, params?: (paths[K]["get"] extends {
+        parameters: infer P;
+    } ? P : never) | undefined, options?: {
+        ordered?: boolean | undefined;
+        tracker?: string | undefined;
+        destinationAddress?: string | undefined;
+        bridge?: boolean | undefined;
+        timeout?: number | undefined;
+        fos?: boolean | undefined;
+        studio?: boolean | undefined;
+        signal?: AbortSignal | undefined;
+    } | undefined) => Promise<import('../../core').ServiceResponse<ClientResponse<paths, K, "get">>>;
+    post: <K_1 extends "/api/ext/dispense/soldOuts/container/{pump}/{reason}" | "/api/ext/dispense/soldOuts/slice/{pump}/{reason}" | "/api/kos/time/date" | "/api/kos/time/timezone" | "/api/kos/time/time" | "/api/ext/freestyle/can/stats" | "/api/ext/freestyle/can/write/byte/{boardPath}/{index}/{subIndex}/{val}" | "/api/ext/freestyle/can/write/short/{boardPath}/{index}/{subIndex}/{val}" | "/api/ext/freestyle/can/write/float/{boardPath}/{index}/{subIndex}/{val}" | "/api/ext/freestyle/can/write/int/{boardPath}/{index}/{subIndex}/{val}" | "/api/kos/criticalData/data" | "/api/kos/criticalData/data/{name}" | "/api/app/kosdev.ddk/ncui/reboot" | "/api/kos/browser/{nodeId}" | "/api/kos/browser/{nodeId}/{name}" | "/api/kos/browser/intent" | "/api/kos/browser/url" | "/api/kos/future/{futureId}/cancel" | "/api/app/tccc.fits/medusa/profile" | "/api/app/tccc.fits/medusa/profiles/{profileId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/resume" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/exit" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/stop" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/{testId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/{testId}/json" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/{testId}/run" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/pause" | "/api/app/tccc.fits/medusa/profiles/{profileId}/test" | "/api/app/tccc.fits/medusa/profiles/{profileId}/activate" | "/api/app/tccc.fits/medusa/profiles/{profileId}/builder/blocks" | "/api/app/tccc.fits/medusa/profiles/{profileId}/builder/bevs/{bevId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/recipe" | "/api/app/tccc.fits/medusa/profiles/{profileId}/mapper/discovery" | "/api/app/tccc.fits/medusa/profiles/{profileId}/mapper/builder" | "/api/app/tccc.fits/medusa/profiles/{profileId}/results/{resultsId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/validate" | "/api/app/tccc.fits/medusa/profiles/{profileId}/validate/all" | "/api/kos/device/serialNumber/{serialNum}" | "/api/app/kosdev.ddk/auth/pincode/{pin}" | "/api/ext/freestyle/microCalibration/cal/{pump}/running/{val}" | "/api/ext/freestyle/microCalibration/cal/{pump}/code/{code}" | "/api/ext/freestyle/microCalibration/cal/{pump}/baseline/{val}" | "/api/ext/freestyle/microCalibration/cal/{pump}/both/{val}" | "/api/ext/freestyle/fcm/calibration/{pump}/calibrate" | "/api/ext/freestyle/fcm/calibration/{pump}/preCalibrate" | "/api/ext/freestyle/fcm/calibration/{pump}/verify/{calVolume}" | "/api/ext/freestyle/fcm/calibration/{pump}/baseline/{value}" | "/api/ext/freestyle/fcm/calibration/{pump}/complete/{calVolume}/{verifyVolume}" | "/api/ext/dispense/nozzle/nozzle/pipeline/ingredient/pour/{path}/{intent}" | "/api/kos/ota/resume/{name}" | "/api/kos/ota/cancel" | "/api/kos/ota/cancel/{name}" | "/api/kos/ota/pause/{name}" | "/api/app/kosdev.ddk/setup/complete/{stepName}" | "/api/app/kosdev.ddk/lockout/unlock/{pin}" | "/api/kos/troubles/resolve" | "/api/kos/troubles/resolve/{troubleId}" | "/api/kos/update/install" | "/api/kos/nodeMgr/reboot" | "/api/kos/nodeMgr/node/{nodeId}/reboot" | "/api/kos/nodeMgr/node/{nodeId}/blockedManifests/{manifestId}" | "/api/kos/nodeMgr/blockedManifests/{manifestId}" | "/api/kos/config/{path}" | "/api/kos/config/bulk" | "/api/ext/dispense/pumpEvents/replaceLine/{holder}" | "/api/ext/dispense/pumpEvents/replacePump/{pump}" | "/api/app/tccc.fits/scales/{serialNum}" | "/api/ext/freestyle/ice/type/{path}/{type}" | "/api/app/tccc.fits/persistence/sources/{storageId}/{name}" | "/api/handle/assembly:core:board:macro:agitator:agit/test" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/select" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/pour" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/fixed/{name}" | "/api/ext/dispense/metrics/{name}" | "/api/ext/dispense/metrics/{nozzle}/{name}" | "/api/ext/dispense/assignments" | "/api/ext/freestyle/fcm/diagnostics/{pump}/pressureTest" | "/api/ext/freestyle/fcm/diagnostics/{pump}/opennessTest" | "/api/ext/freestyle/fcm/diagnostics/{pump}/flowTest" | "/api/ext/freestyle/fcm/diagnostics/{pump}/electricalTest" | "/api/ext/freestyle/brandset/grantProperties" | "/api/app/kosdev.ddk/copyLogs/eraseAndCopy/{id}" | "/api/app/kosdev.ddk/copyLogs/{id}" | "/api/app/tccc.fits/session/pop/all" | "/api/app/tccc.fits/session/pop/include/{type}" | "/api/app/tccc.fits/session/pop/to/{type}" | "/api/app/tccc.fits/session/data/{key}" | "/api/app/tccc.fits.sim/scales/{serialNum}/disconnect" | "/api/app/tccc.fits.sim/scales/{serialNum}/reading/reset" | "/api/app/tccc.fits.sim/scales/{serialNum}/reading/{value}" | "/api/app/tccc.fits.sim/scales/{serialNum}/connect" | "/api/app/tccc.fits.sim/scale" | "/api/app/tccc.fits.sim/pumps/{pumpPath}/disconnect" | "/api/app/tccc.fits.sim/pumps/{pumpPath}/reading/unlock" | "/api/app/tccc.fits.sim/pumps/{pumpPath}/reading/lock" | "/api/app/tccc.fits.sim/pumps/{pumpPath}/connect/{serialNum}">(endpoint: K_1, params?: (paths[K_1]["post"] extends {
+        parameters: infer P_1;
+    } ? P_1 : never) | undefined, body?: (paths[K_1]["post"] extends {
+        requestBody: {
+            content: infer B;
+        };
+    } ? B[keyof B] : never) | undefined, options?: {
+        ordered?: boolean | undefined;
+        tracker?: string | undefined;
+        destinationAddress?: string | undefined;
+        bridge?: boolean | undefined;
+        timeout?: number | undefined;
+        fos?: boolean | undefined;
+        studio?: boolean | undefined;
+        signal?: AbortSignal | undefined;
+    } | undefined) => Promise<import('../../core').ServiceResponse<ClientResponse<paths, K_1, "post">>>;
+    put: <K_2 extends never>(endpoint: K_2, params?: (paths[K_2]["put"] extends {
+        parameters: infer P_2;
+    } ? P_2 : never) | undefined, body?: (paths[K_2]["put"] extends {
+        requestBody: {
+            content: infer B_1;
+        };
+    } ? B_1[keyof B_1] : never) | undefined, options?: {
+        ordered?: boolean | undefined;
+        tracker?: string | undefined;
+        destinationAddress?: string | undefined;
+        bridge?: boolean | undefined;
+        timeout?: number | undefined;
+        fos?: boolean | undefined;
+        studio?: boolean | undefined;
+        signal?: AbortSignal | undefined;
+    } | undefined) => Promise<import('../../core').ServiceResponse<ClientResponse<paths, K_2, "put">>>;
+    delete: <K_3 extends "/api/kos/criticalData/data/{name}" | "/api/app/tccc.fits/medusa/profiles/{profileId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/recipes/{name}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/{testId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/builder/blocks" | "/api/app/tccc.fits/medusa/profiles/{profileId}/builder/bevs/{bevId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/results/{resultsId}" | "/api/kos/nodeMgr/node/{nodeId}/blockedManifests" | "/api/kos/nodeMgr/node/{nodeId}/blockedManifests/{manifestId}" | "/api/kos/nodeMgr/blockedManifests/{manifestId}" | "/api/app/tccc.fits/scales/{serialNum}" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/select" | "/api/ext/dispense/metrics/{name}" | "/api/ext/dispense/metrics/{nozzle}/{name}" | "/api/ext/dispense/assignments/{holderPath}" | "/api/app/kosdev.ddk/copyLogs/{id}" | "/api/app/tccc.fits/session/data/{key}" | "/api/app/tccc.fits.sim/scales/{serialNum}">(endpoint: K_3, params?: (paths[K_3]["delete"] extends {
+        parameters: infer P_3;
+    } ? P_3 : never) | undefined, options?: {
+        ordered?: boolean | undefined;
+        tracker?: string | undefined;
+        destinationAddress?: string | undefined;
+        bridge?: boolean | undefined;
+        timeout?: number | undefined;
+        fos?: boolean | undefined;
+        studio?: boolean | undefined;
+        signal?: AbortSignal | undefined;
+    } | undefined) => Promise<import('../../core').ServiceResponse<ClientResponse<paths, K_3, "delete">>>;
+};
+export type BaseResponseType<K extends keyof paths, M extends AvailableMethods<paths[K]>> = ClientResponse<paths, K, M>;
+//# sourceMappingURL=client.d.ts.map

package/models/utils/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/models/utils/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACpB,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,eAAO,MAAM,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAAwB,CAAC;AAEzC,MAAM,MAAM,gBAAgB,CAC1B,CAAC,SAAS,MAAM,KAAK,EACrB,CAAC,SAAS,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAClC,cAAc,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC"}

package/models/utils/conversion-utils.d.ts

@@ -0,0 +1,41 @@
+import { UnitSource } from '../models/region-info/types';
+
+export type UnitConversionSource = string | UnitSource;
+/**
+ * Region-aware unit conversion utility that can be used to convert between units of measure.
+ *
+ * When converting between units of measure, the source and target unit can be specified as a string or as a {@see UnitSource} object.
+ * @example
+ * in the simplest case, the source and target units can be specified as strings so long as they belong to the same measure (volume, length etc):
+ *
+ * ```typescript
+ * import { convert } from "@kosdev-code/kos-ui-sdk";
+ *
+ * const value = convert(1000, "milliliter", "fluid-ounce");
+ * ```
+ *
+ * The to unit can be omitted in which case the value will be converted to the default unit for the selected region measure:
+ * @example
+ * ```typescript
+ * import { convert } from "@kosdev-code/kos-ui-sdk";
+ *
+ * // convert 1000 milliliters to the default unit for the region. If the region is set to US, the value will be converted to fluid ounces.
+ * const value = convert(1000, "milliliter");
+ * ```
+ *
+ * The source and target units can also be specified as {@see UnitSource} objects:
+ * @example
+ * ```typescript
+ * import { convert } from "@kosdev-code/kos-ui-sdk";
+ *
+ * const value = convert(1000, {name: "milliliter", measure: "volume", system: "si"}, {name: "fluid-ounce", measure: "volume", system: "us"});
+ * ```
+ * In this case properties on the source and target are all optional so long as either the name or measure is specified.
+ *
+ * @param value - the value to convert
+ * @param from - the source unit
+ * @param to - the target unit. If omitted, the value will be converted to the default unit for the region measure.
+ * @returns the converted value
+ */
+export declare const convert: (value: number, from: UnitConversionSource, to?: UnitConversionSource) => string;
+//# sourceMappingURL=conversion-utils.d.ts.map

package/models/utils/conversion-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conversion-utils.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/models/utils/conversion-utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAmB,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAE1E,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,UAAU,CAAC;AAsBvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,eAAO,MAAM,OAAO,UACX,MAAM,QACP,oBAAoB,OACrB,oBAAoB,WAqB1B,CAAC"}

package/models/utils/core-registration-manager.d.ts

@@ -0,0 +1,21 @@
+import { RegistrationManager, RegistrationResult } from '../../core';
+
+export declare const registerCoreModels: <R>(root: R) => () => {
+    preload: (type: string) => RegistrationResult<R>;
+    model: <T extends import('../../core').BaseKosModelRegistrationBean<any, any> | import('../../core/core/registration/model-registration').KosModelRegistrationType<any, any>>(registration: T, preload?: boolean | undefined) => RegistrationResult<R>;
+    companion: (parentType: string, companion: import('../../core').KosCompanionModelType<any>) => RegistrationResult<R>;
+    legacy: <T_1 extends import('../../core').IKosModelRegistration>(type: string, registration: T_1) => RegistrationResult<R>;
+};
+type ModelRegistry<R> = {
+    core: {
+        models: () => RegistrationResult<R>;
+    };
+    preload: ReturnType<typeof RegistrationManager.model.preloadModel>;
+    model: ReturnType<typeof RegistrationManager.model.register>;
+    companion: ReturnType<typeof RegistrationManager.companion.register>;
+};
+declare const _KosModelRegistry: {};
+type KosModelRegistryType = ModelRegistry<typeof _KosModelRegistry>;
+declare const KosModelRegistry: KosModelRegistryType;
+export { KosModelRegistry };
+//# sourceMappingURL=core-registration-manager.d.ts.map

package/models/utils/core-registration-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core-registration-manager.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/models/utils/core-registration-manager.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EAGnB,KAAK,kBAAkB,EACxB,MAAM,YAAY,CAAC;AAgBpB,eAAO,MAAM,kBAAkB,YACnB,CAAC;;;;;CA2BV,CAAC;AAEJ,KAAK,aAAa,CAAC,CAAC,IAAI;IACtB,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC,CAAC,CAAC,CAAA;KAAE,CAAC;IAC9C,OAAO,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACnE,KAAK,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC7D,SAAS,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;CACtE,CAAC;AAEF,QAAA,MAAM,iBAAiB,IAAK,CAAC;AAc7B,KAAK,oBAAoB,GAAG,aAAa,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAEpE,QAAA,MAAM,gBAAgB,EAAE,oBAA+C,CAAC;AAExE,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/models/utils/extension-manager.d.ts

@@ -0,0 +1,21 @@
+import { TroubleModel } from '../models/trouble/types';
+import { PropertyMapper } from '../../core';
+
+type TroubleRankMapper<AdditionalData extends object = Record<string, any>> = PropertyMapper<TroubleModel<AdditionalData>, number, any>;
+type TroubleRoleMapper<AdditionalData extends object = Record<string, any>> = PropertyMapper<TroubleModel<AdditionalData>, string, any>;
+export declare class CoreExtensionManager {
+    /**
+     * Maps the rank property of the trouble into the {@link TroubleModel}
+     * */
+    registerTroubleRankMapper(troubleRankMapper: TroubleRankMapper): this;
+    /**
+     * Maps the role property of the trouble into the {@link TroubleModel}
+     * */
+    registerTroubleRoleMapper(troubleRoleMapper: TroubleRoleMapper): this;
+    /**
+     * Maps the color property of the trouble into the {@link TroubleModel}
+     * */
+    registerTroubleColorMapper(troubleColorMapper: TroubleRoleMapper): this;
+}
+export {};
+//# sourceMappingURL=extension-manager.d.ts.map

package/models/utils/extension-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extension-manager.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/models/utils/extension-manager.ts"],"names":[],"mappings":"AAEA,OAAO,EAAoB,cAAc,EAAE,MAAM,YAAY,CAAC;AAE9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAE5D,KAAK,iBAAiB,CAAC,cAAc,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IACxE,cAAc,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;AAK5D,KAAK,iBAAiB,CAAC,cAAc,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IACxE,cAAc,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;AAE5D,qBAAa,oBAAoB;IAC/B;;SAEK;IACL,yBAAyB,CAAC,iBAAiB,EAAE,iBAAiB;IAQ9D;;SAEK;IACL,yBAAyB,CAAC,iBAAiB,EAAE,iBAAiB;IAQ9D;;SAEK;IACL,0BAA0B,CAAC,kBAAkB,EAAE,iBAAiB;CAOjE"}

package/models/utils/future-manager/index.d.ts

@@ -0,0 +1,9 @@
+import { FutureResponse } from '../../services/future';
+import { IFutureModel } from '../../models/future/future-types';
+
+export declare const FutureManager: {
+    buildFutureModel: (payload: FutureResponse) => IFutureModel;
+    initiateFuture: (payload: FutureResponse) => IFutureModel<Record<string, unknown>>;
+    getFuture: <T extends {}>(id: string) => IFutureModel<T>;
+};
+//# sourceMappingURL=index.d.ts.map

package/models/utils/future-manager/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/utils/future-manager/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAGrE,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAuCvD,eAAO,MAAM,aAAa;gCApCS,cAAc,KAAG,YAAY;8BAc/B,cAAc;kCAaV,MAAM;CAa1C,CAAC"}

package/models/utils/index.d.ts

@@ -0,0 +1,11 @@
+export * from './client';
+export * from './conversion-utils';
+export * from './core-registration-manager';
+export * from './extension-manager';
+export * from './future-manager';
+export * from './persistence-store';
+export * from './prop-utils';
+export * from './region-utils';
+export * from './timer-manager';
+export * from './timezone-utils';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/models/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC"}