@kosdev-code/kos-ui-sdk 0.1.0-dev.5053

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/cancellable-promise.d.ts

@@ -0,0 +1,49 @@
+/**
+ * A Promise that can be cancelled and provides progress/state tracking
+ */
+export interface CancellablePromise<T> extends Promise<T> {
+    /**
+     * Cancel this specific operation
+     */
+    cancel(): Promise<void>;
+    /**
+     * Get the underlying AbortController for this operation
+     */
+    getController(): AbortController | undefined;
+    /**
+     * Check if this operation is cancelled
+     */
+    isCancelled(): boolean;
+    /**
+     * Current progress of the operation (0-1)
+     */
+    readonly progress: number;
+    /**
+     * Current status of the operation
+     */
+    readonly status: string;
+    /**
+     * Whether the operation is currently running
+     */
+    readonly isRunning: boolean;
+    /**
+     * Subscribe to progress updates
+     * Returns a dispose function to clean up the subscription
+     */
+    onProgressUpdate(callback: (progress: number, status: string) => void): () => void;
+}
+/**
+ * Options for creating a cancellable promise with progress tracking
+ */
+export interface CancellablePromiseOptions<T> {
+    promise: Promise<T>;
+    abortController?: AbortController;
+    cancelFuture?: () => Promise<void>;
+    future?: any;
+}
+/**
+ * Create a cancellable promise wrapper with reactive progress tracking
+ */
+export declare function createCancellablePromise<T>(promise: Promise<T>, abortController?: AbortController, cancelFuture?: () => Promise<void>, future?: any): CancellablePromise<T>;
+export declare function createCancellablePromise<T>(options: CancellablePromiseOptions<T>): CancellablePromise<T>;
+//# sourceMappingURL=cancellable-promise.d.ts.map

package/models/types/cancellable-promise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancellable-promise.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/models/types/cancellable-promise.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAC;IACvD;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExB;;OAEG;IACH,aAAa,IAAI,eAAe,GAAG,SAAS,CAAC;IAE7C;;OAEG;IACH,WAAW,IAAI,OAAO,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,gBAAgB,CACd,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,GACnD,MAAM,IAAI,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB,CAAC,CAAC;IAC1C,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,YAAY,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,CAAC,EAAE,GAAG,CAAC;CACd;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,EACxC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,eAAe,CAAC,EAAE,eAAe,EACjC,YAAY,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,EAClC,MAAM,CAAC,EAAE,GAAG,GACX,kBAAkB,CAAC,CAAC,CAAC,CAAC;AACzB,wBAAgB,wBAAwB,CAAC,CAAC,EACxC,OAAO,EAAE,yBAAyB,CAAC,CAAC,CAAC,GACpC,kBAAkB,CAAC,CAAC,CAAC,CAAC"}

package/models/types/future-interfaces.d.ts

@@ -0,0 +1,55 @@
+import { FutureAwareContainer, IFutureModel } from '../models/future/future-types';
+
+/**
+ * Core Future handler interface - minimal requirement for @kosFuture methods
+ */
+export interface FutureHandlerContainer<T extends object = Record<string, unknown>> {
+    futureHandler: FutureAwareContainer<T>;
+}
+/**
+ * Future state getters interface - for accessing Future progress/status
+ * This is what external consumers typically need
+ */
+export interface FutureStateAccessor<T extends Record<string, any> = Record<string, any>> {
+    readonly future?: IFutureModel<T>;
+    readonly progress: number;
+    readonly status: string;
+    readonly isRunning: boolean;
+    readonly isCancelled: boolean;
+}
+/**
+ * Future control interface - for canceling operations
+ */
+export interface FutureController {
+    cancelFuture(): Promise<void>;
+}
+/**
+ * Future update callback interface - for models that need custom behavior
+ * This can be separated from the core container if not all models need it
+ */
+export interface FutureUpdateHandler<T extends Record<string, any> = Record<string, any>> {
+    onFutureUpdate?(future: IFutureModel<T>): void;
+}
+/**
+ * Complete Future container - combines all interfaces
+ * Use this when you need everything internally
+ */
+export interface CompleteFutureContainer<T extends Record<string, any> = Record<string, any>> extends FutureHandlerContainer<T>, FutureStateAccessor<T>, FutureController, FutureUpdateHandler<T> {
+}
+/**
+ * External Future interface - what external consumers typically need
+ * This is perfect for PublicModelInterface usage
+ */
+export interface ExternalFutureInterface<T extends Record<string, any> = Record<string, any>> extends FutureStateAccessor<T>, FutureController {
+}
+/**
+ * Type helper for adding Future support to existing model interfaces
+ * Usage: export type MyModel = PublicModelInterface<MyModelImpl> & ExternalFutureInterface;
+ */
+export type WithFutureSupport<T> = T & ExternalFutureInterface;
+/**
+ * Type helper for internal model implementations that need minimal Future support
+ * Usage: export class MyModelImpl implements IKosDataModel, InternalFutureContainer
+ */
+export type InternalFutureContainer<T extends object = Record<string, unknown>> = FutureHandlerContainer<T> & Partial<FutureStateAccessor & FutureController>;
+//# sourceMappingURL=future-interfaces.d.ts.map

package/models/types/future-interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"future-interfaces.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/models/types/future-interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACV,oBAAoB,EACpB,YAAY,EACb,MAAM,+BAA+B,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,sBAAsB,CACrC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAE1C,aAAa,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC;CACxC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAClC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAEnD,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IAClC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAClC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAEnD,cAAc,CAAC,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB,CACtC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CACnD,SAAQ,sBAAsB,CAAC,CAAC,CAAC,EAC/B,mBAAmB,CAAC,CAAC,CAAC,EACtB,gBAAgB,EAChB,mBAAmB,CAAC,CAAC,CAAC;CAAG;AAE7B;;;GAGG;AACH,MAAM,WAAW,uBAAuB,CACtC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CACnD,SAAQ,mBAAmB,CAAC,CAAC,CAAC,EAC5B,gBAAgB;CAAG;AAEvB;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,CAAC,GAAG,uBAAuB,CAAC;AAE/D;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CACjC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACxC,sBAAsB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,mBAAmB,GAAG,gBAAgB,CAAC,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/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './cancellable-promise';
+export * from './future-interfaces';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/models/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC"}

package/models/utils/cancellable-future-call.d.ts

@@ -0,0 +1,54 @@
+import { CancellablePromise } from '../types/cancellable-promise';
+import { FutureContainer } from '../models/future/future-types';
+
+/**
+ * Wraps a @kosFuture method call to return a CancellablePromise
+ * This gives you direct cancellation control without needing to access model.future
+ *
+ * @example
+ * ```typescript
+ * // Instead of:
+ * const promise = model.performOperation('data');
+ * // Later: await model.future?.cancelFuture();
+ *
+ * // Use:
+ * const cancellable = makeCancellable(model, m => m.performOperation('data'));
+ * // Later: await cancellable.cancel();
+ * ```
+ */
+export declare function makeCancellable<T extends FutureContainer, R>(model: T, methodCall: (model: T) => Promise<R>): CancellablePromise<R>;
+/**
+ * Alternative approach using method decoration at call time
+ * This is more explicit but requires wrapping individual calls
+ *
+ * @example
+ * ```typescript
+ * const cancellable = withCancellation(model, 'performOperation', 'data');
+ * await cancellable.cancel();
+ * ```
+ */
+export declare function withCancellation<T extends FutureContainer, K extends keyof T>(model: T, methodName: K, ...args: T[K] extends (...args: infer A) => any ? A : never): CancellablePromise<T[K] extends (...args: any[]) => Promise<infer R> ? R : never>;
+/**
+ * Batch cancellation utility for multiple operations
+ *
+ * @example
+ * ```typescript
+ * const batch = createCancellationBatch();
+ *
+ * const op1 = batch.add(model, m => m.performOperation1());
+ * const op2 = batch.add(model, m => m.performOperation2());
+ *
+ * // Cancel all operations at once
+ * await batch.cancelAll();
+ * ```
+ */
+export declare class CancellationBatch {
+    private operations;
+    add<T extends FutureContainer, R>(model: T, methodCall: (model: T) => Promise<R>): CancellablePromise<R>;
+    cancelAll(): Promise<void>;
+    getAllControllers(): Array<AbortController | undefined>;
+    getActiveCount(): number;
+    clear(): void;
+}
+export declare function createCancellationBatch(): CancellationBatch;
+//# sourceMappingURL=cancellable-future-call.d.ts.map

package/models/utils/cancellable-future-call.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancellable-future-call.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/models/utils/cancellable-future-call.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAGvE;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,EAC1D,KAAK,EAAE,CAAC,EACR,UAAU,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,GACnC,kBAAkB,CAAC,CAAC,CAAC,CAkCvB;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,SAAS,MAAM,CAAC,EAC3E,KAAK,EAAE,CAAC,EACR,UAAU,EAAE,CAAC,EACb,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,KAAK,GAC1D,kBAAkB,CACnB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAC9D,CAoCA;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,UAAU,CAAsC;IAExD,GAAG,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,EAC9B,KAAK,EAAE,CAAC,EACR,UAAU,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,GACnC,kBAAkB,CAAC,CAAC,CAAC;IAMlB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAWhC,iBAAiB,IAAI,KAAK,CAAC,eAAe,GAAG,SAAS,CAAC;IAIvD,cAAc,IAAI,MAAM;IAIxB,KAAK,IAAI,IAAI;CAGd;AAED,wBAAgB,uBAAuB,IAAI,iBAAiB,CAE3D"}

package/models/utils/cancellable-service.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Utility for creating cancellable service functions
+ */
+export type CancellableFunction<T extends (...args: any[]) => any> = T & {
+    /**
+     * Cancel any in-flight request
+     */
+    cancel: () => void;
+    /**
+     * Get the current AbortController
+     */
+    getController: () => AbortController | undefined;
+    /**
+     * Check if there's an active request
+     */
+    isActive: () => boolean;
+};
+/**
+ * Creates a cancellable version of a service function.
+ * The service function must accept an AbortSignal as its last parameter.
+ *
+ * @example
+ * ```typescript
+ * // Original service
+ * const getUsers = async (params?: UserParams, signal?: AbortSignal) => {
+ *   return api.get('/users', params, { signal });
+ * };
+ *
+ * // Make it cancellable
+ * const cancellableGetUsers = createCancellableService(getUsers);
+ *
+ * // Use it
+ * const users = await cancellableGetUsers({ page: 1 });
+ *
+ * // Cancel if needed
+ * cancellableGetUsers.cancel();
+ * ```
+ */
+export declare function createCancellableService<TArgs extends any[], TReturn>(serviceFunction: (...args: [...TArgs, AbortSignal?]) => Promise<TReturn>): CancellableFunction<(...args: TArgs) => Promise<TReturn>>;
+/**
+ * Creates a cancellable service class that manages multiple service functions
+ *
+ * @example
+ * ```typescript
+ * class UserService extends CancellableServiceManager {
+ *   getUsers = this.createMethod(async (params?: UserParams, signal?: AbortSignal) => {
+ *     return api.get('/users', params, { signal });
+ *   });
+ *
+ *   getUser = this.createMethod(async (id: string, signal?: AbortSignal) => {
+ *     return api.get(`/users/${id}`, undefined, { signal });
+ *   });
+ * }
+ * ```
+ */
+export declare class CancellableServiceManager {
+    private controllers;
+    /**
+     * Create a cancellable method
+     */
+    protected createMethod<TArgs extends any[], TReturn>(name: string, serviceFunction: (...args: [...TArgs, AbortSignal?]) => Promise<TReturn>): CancellableFunction<(...args: TArgs) => Promise<TReturn>>;
+    /**
+     * Cancel a specific method's request
+     */
+    cancelMethod(name: string): void;
+    /**
+     * Cancel all active requests
+     */
+    cancelAll(): void;
+    /**
+     * Get all active method names
+     */
+    getActiveMethods(): string[];
+    /**
+     * Check if any requests are active
+     */
+    hasActiveRequests(): boolean;
+}
+//# sourceMappingURL=cancellable-service.d.ts.map

package/models/utils/cancellable-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancellable-service.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/models/utils/cancellable-service.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,IAAI,CAAC,GAAG;IACvE;;OAEG;IACH,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB;;OAEG;IACH,aAAa,EAAE,MAAM,eAAe,GAAG,SAAS,CAAC;IACjD;;OAEG;IACH,QAAQ,EAAE,MAAM,OAAO,CAAC;CACzB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,SAAS,GAAG,EAAE,EAAE,OAAO,EACnE,eAAe,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,KAAK,EAAE,WAAW,CAAC,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,GACvE,mBAAmB,CAAC,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,CAuC3D;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,yBAAyB;IACpC,OAAO,CAAC,WAAW,CAAsC;IAEzD;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,KAAK,SAAS,GAAG,EAAE,EAAE,OAAO,EACjD,IAAI,EAAE,MAAM,EACZ,eAAe,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,KAAK,EAAE,WAAW,CAAC,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,GACvE,mBAAmB,CAAC,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IA4B5D;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQhC;;OAEG;IACH,SAAS,IAAI,IAAI;IAOjB;;OAEG;IACH,gBAAgB,IAAI,MAAM,EAAE;IAI5B;;OAEG;IACH,iBAAiB,IAAI,OAAO;CAG7B"}

package/models/utils/client.d.ts

@@ -0,0 +1,79 @@
+import { paths } from './types';
+import { AvailableMethods, ClientResponse } from '../../core';
+
+export declare const api: {
+    get: <K extends "/api/kos/network/interfaces" | "/api/app/kosdev.ddk/auth/role" | "/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/localization/context/{*path}" | "/api/kos/localization/contexts" | "/api/kos/browser" | "/api/kos/browser/redirect" | "/api/app/kosdev.ddk/cui" | "/api/app/kosdev.ddk/cui/open" | "/api/kos/future/traces" | "/api/kos/future/traces/{traceId}/events" | "/api/kos/ota/paused" | "/api/kos/ota/artifacts" | "/api/app/kosdev.ddk/copyLogs/volumes/size" | "/api/app/kosdev.ddk/copyLogs/files/size" | "/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/kos/state/paths" | "/api/kos/state/{path}" | "/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/ext/freestyle/microCalibration/report/{board}" | "/api/ext/freestyle/microCalibration/cal/{pump}" | "/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/ext/freestyle/brandset/nutrition/{bevId}" | "/api/ext/freestyle/brandset/grantProperties" | "/api/kos/storage/devices" | "/api/ext/freestyle/fcm/calibration/{pump}/baseline" | "/api/kos/update/available" | "/api/ext/dispense/ingredients" | "/api/ext/dispense/ingredients/sources" | "/api/kos/troubles" | "/api/kos/troubles/{troubleId}" | "/api/kos/handles" | "/api/kos/handles/{path}" | "/api/kos/handles/{path}/{view}" | "/api/kos/handles/views" | "/api/kos/openapi/{*baseUrl}" | "/api/kos/manifest/node" | "/api/kos/manifest/device" | "/api/kos/manifest/info" | "/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/time/timezone" | "/api/ext/dispense/soldOuts/troubles" | "/api/ext/dispense/soldOuts/db" | "/api/vfs" | "/api/app/kosdev.ddk/setup/steps" | "/api/app/kosdev.ddk/setup/steps/reset" | "/api/kos/regions" | "/api/kos/regions/info" | "/api/ext/dispense/assignments" | "/api/kos/descriptor/{path}" | "/api/kos/descriptor/{path}/{dotted}" | "/api/kos/nodeMgr/node/{nodeId}/blockedManifests" | "/api/kos/nodeMgr/blockedManifests" | "/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/device" | "/api/kos/device/assemblies" | "/api/kos/device/serialNumber" | "/api/ext/freestyle/ice/types" | "/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/app/tccc.fits/scales" | "/api/app/tccc.fits/scales/ifaces" | "/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/app/tccc.fits/persistence/sources" | "/api/ext/cms/screens/context/{*path}" | "/api/ext/cms/screens/contexts" | "/api/kos/troubles/debug" | "/api/kos/troubles/debug/{troubleId}" | "/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/ext/dispense/nozzle/nozzle/pipeline/beverage/engine/nutrition/{bevId}" | "/api/app/tccc.fits/session" | "/api/app/tccc.fits/session/data/{key}">(endpoint: K, params?: (paths[K]["get"] extends {
+        parameters: infer P;
+    } ? P : never) | undefined, options?: {
+        ordered?: boolean | undefined;
+        tracker?: string | undefined;
+        timeout?: number | undefined;
+        destinationAddress?: string | undefined;
+        bridge?: boolean | undefined;
+        headers?: Record<string, string> | undefined;
+        fos?: boolean | undefined;
+        studio?: boolean | undefined;
+        signal?: AbortSignal | undefined;
+        stream?: boolean | undefined;
+        responseType?: "text" | "json" | "arraybuffer" | "blob" | undefined;
+    } | undefined) => Promise<import('../../core').ServiceResponse<ClientResponse<paths, K, "get">>>;
+    post: <K_1 extends "/api/app/kosdev.ddk/auth/pincode/{pin}" | "/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/kos/browser/{nodeId}" | "/api/kos/browser/{nodeId}/{name}" | "/api/kos/browser/intent" | "/api/kos/browser/url" | "/api/kos/future/{futureId}/cancel" | "/api/kos/ota/resume/{name}" | "/api/kos/ota/cancel" | "/api/kos/ota/cancel/{name}" | "/api/kos/ota/pause/{name}" | "/api/app/kosdev.ddk/copyLogs/eraseAndCopy/{id}" | "/api/app/kosdev.ddk/copyLogs/{id}" | "/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/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/dispense/metrics/{name}" | "/api/ext/dispense/metrics/{nozzle}/{name}" | "/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/kos/config/{path}" | "/api/kos/config/bulk" | "/api/ext/freestyle/brandset/grantProperties" | "/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/kos/update/install" | "/api/kos/troubles/resolve" | "/api/kos/troubles/resolve/{troubleId}" | "/api/ext/dispense/pumpEvents/replaceLine/{holder}" | "/api/ext/dispense/pumpEvents/replacePump/{pump}" | "/api/kos/time/date" | "/api/kos/time/timezone" | "/api/kos/time/time" | "/api/ext/dispense/soldOuts/container/{pump}/{reason}" | "/api/ext/dispense/soldOuts/slice/{pump}/{reason}" | "/api/app/kosdev.ddk/setup/complete/{stepName}" | "/api/ext/dispense/assignments" | "/api/kos/nodeMgr/reboot" | "/api/kos/nodeMgr/node/{nodeId}/reboot" | "/api/kos/nodeMgr/node/{nodeId}/blockedManifests/{manifestId}" | "/api/kos/nodeMgr/blockedManifests/{manifestId}" | "/api/app/kosdev.ddk/lockout/unlock/{pin}" | "/api/kos/criticalData/data" | "/api/kos/criticalData/data/{name}" | "/api/app/kosdev.ddk/ncui/reboot" | "/api/kos/device/serialNumber/{serialNum}" | "/api/ext/freestyle/ice/type/{path}/{type}" | "/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/app/tccc.fits/scales/{serialNum}" | "/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}" | "/api/app/tccc.fits/persistence/sources/{storageId}/{name}" | "/api/ext/dispense/nozzle/nozzle/pipeline/ingredient/pour/{path}/{intent}" | "/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/handle/assembly:core:board:macro:agitator:agit/test">(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;
+        timeout?: number | undefined;
+        destinationAddress?: string | undefined;
+        bridge?: boolean | undefined;
+        headers?: Record<string, string> | undefined;
+        fos?: boolean | undefined;
+        studio?: boolean | undefined;
+        signal?: AbortSignal | undefined;
+        stream?: boolean | undefined;
+        responseType?: "text" | "json" | "arraybuffer" | "blob" | 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;
+        timeout?: number | undefined;
+        destinationAddress?: string | undefined;
+        bridge?: boolean | undefined;
+        headers?: Record<string, string> | undefined;
+        fos?: boolean | undefined;
+        studio?: boolean | undefined;
+        signal?: AbortSignal | undefined;
+        stream?: boolean | undefined;
+        responseType?: "text" | "json" | "arraybuffer" | "blob" | undefined;
+    } | undefined) => Promise<import('../../core').ServiceResponse<ClientResponse<paths, K_2, "put">>>;
+    delete: <K_3 extends "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/select" | "/api/app/kosdev.ddk/copyLogs/{id}" | "/api/ext/dispense/metrics/{name}" | "/api/ext/dispense/metrics/{nozzle}/{name}" | "/api/ext/dispense/assignments/{holderPath}" | "/api/kos/nodeMgr/node/{nodeId}/blockedManifests" | "/api/kos/nodeMgr/node/{nodeId}/blockedManifests/{manifestId}" | "/api/kos/nodeMgr/blockedManifests/{manifestId}" | "/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/app/tccc.fits/scales/{serialNum}" | "/api/app/tccc.fits.sim/scales/{serialNum}" | "/api/app/tccc.fits/session/data/{key}">(endpoint: K_3, params?: (paths[K_3]["delete"] extends {
+        parameters: infer P_3;
+    } ? P_3 : never) | undefined, body?: (paths[K_3]["put"] extends {
+        requestBody: {
+            content: infer B_1;
+        };
+    } ? B_1[keyof B_1] : never) | undefined, options?: {
+        ordered?: boolean | undefined;
+        tracker?: string | undefined;
+        timeout?: number | undefined;
+        destinationAddress?: string | undefined;
+        bridge?: boolean | undefined;
+        headers?: Record<string, string> | undefined;
+        fos?: boolean | undefined;
+        studio?: boolean | undefined;
+        signal?: AbortSignal | undefined;
+        stream?: boolean | undefined;
+        responseType?: "text" | "json" | "arraybuffer" | "blob" | 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,67 @@
+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;
+/**
+ * Converts a numeric value from one unit to another, formats the result, and returns
+ * an object containing the converted value, display strings, and the unit.
+ *
+ * @param value - The numeric value to convert.
+ * @param from - The source unit or unit system to convert from.
+ * @param to - (Optional) The target unit or unit system to convert to. If not provided, uses the default unit system.
+ * @param format - (Optional) Formatting options for the output, including minimum and maximum decimal places.
+ * @param format.minDecimals - (Optional) Minimum number of decimal places in the formatted output.
+ * @param format.maxDecimals - (Optional) Maximum number of decimal places in the formatted output.
+ * @returns An object containing:
+ *   - `value`: The converted value as a string.
+ *   - `display`: The formatted value with unit in long form.
+ *   - `shortDisplay`: The formatted value with unit in short form.
+ *   - `unit`: The unit used for the converted value.
+ * @throws If the RegionInfo model is not found.
+ */
+export declare const convertWithUnits: (value: number, from: UnitConversionSource, to?: UnitConversionSource, format?: {
+    minDecimals?: number;
+    maxDecimals?: number;
+}) => {
+    value: string;
+    display: string;
+    shortDisplay: string;
+    unit: 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;AA6BF;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,gBAAgB,UACpB,MAAM,QACP,oBAAoB,OACrB,oBAAoB,WAChB;IACP,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,KACA;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CA4CtE,CAAC"}