@kosdev-code/kos-ui-sdk 2.0.2

package/core/util/service-factory.d.ts

@@ -0,0 +1,177 @@
+import { KosServiceResponse } from './kos-fetch';
+
+/**
+ * Resolves the service URL configuration.
+ * @param _service - The optional service name (not used).
+ * @returns An object with `isMock` and `URL` properties.
+ */
+export declare const resolveServiceUrl: (_service?: string) => {
+    isMock: boolean;
+    URL: string;
+};
+/**
+ * Represents parameters for deleting an entity from the server.
+ */
+interface DeleteModelParams extends CommonParams {
+    id: string;
+    urlOverride?: string;
+    tracker?: string;
+}
+/**
+ * Represents common parameters shared across different service operations.
+ */
+type CommonParams = Partial<Orderable> & Partial<StudioRequest> & Partial<FosRequest> & Partial<RoutableRequest> & Partial<TimeoutAware>;
+/**
+ * Represents parameters for fetching a list of entities.
+ */
+interface GetAllParams extends CommonParams {
+    urlOverride?: string;
+    tracker?: string;
+}
+/**
+ * Represents parameters for fetching a single entity by ID.
+ */
+interface GetModelByIdParams extends GetAllParams {
+    id: string;
+}
+interface Orderable {
+    ordered: boolean;
+}
+interface TimeoutAware {
+    timeout: number;
+}
+interface FosRequest {
+    fos: boolean;
+    bridge: boolean;
+}
+interface StudioRequest {
+    studio: boolean;
+}
+interface RoutableRequest {
+    destinationAddress: string;
+}
+interface AddModelParams<Request> extends Partial<Orderable>, Partial<StudioRequest>, Partial<FosRequest>, Partial<RoutableRequest>, Partial<TimeoutAware> {
+    model: Request;
+    urlOverride?: string;
+    tracker?: string;
+}
+interface ModifyModelParams<Request> extends Partial<Orderable>, Partial<StudioRequest>, Partial<FosRequest>, Partial<RoutableRequest>, Partial<TimeoutAware> {
+    model?: Request;
+    id: string;
+    urlOverride?: string;
+}
+export declare class FetchError<T extends Record<string, any> | string = {
+    error: string;
+}> extends Error {
+    payload?: T;
+    constructor(message: string, payload?: T);
+}
+/**
+ * Represents parameters for creating a service instance.
+ */
+interface ServiceFactoryParams {
+    destinationAddress?: string;
+    basePath: string;
+    getAllPath?: string;
+    getOnePath?: string;
+    deleteModelPath?: string;
+    addModelPath?: string;
+    modifyModelPath?: string;
+    mock?: boolean;
+}
+/**
+ * A factory for creating service instances with common configurations.
+ */
+export declare const ServiceFactory: {
+    /**
+     * Builds a service instance with the specified configuration.
+     *
+     * @param params - The configuration parameters for the service instance.
+     * @returns An object with service methods for interacting with the server.
+     *
+     * @example
+     * // Create a Kos service instance for managing entities.
+     * const entityService = ServiceFactory.build({
+     *   basePath: "/api/entities",
+     *   getAllPath: "/list",
+     *   getOnePath: "/get",
+     *   deleteModelPath: "/delete",
+     *   addModelPath: "/add",
+     *   modifyModelPath: "/modify",
+     * });
+     *
+     * // Fetch a list of entities.
+     * const entities = await entityService.getAll({ ordered: true });
+     *
+     * // Get details of a specific entity by ID.
+     * const entityDetails = await entityService.getModelById({ id: "entity123" });
+     *
+     * // Add a new entity to the server.
+     * const newEntity = { name: "New Entity" };
+     * await entityService.addModel({ model: newEntity });
+     *
+     * // Modify an existing entity.
+     * const updatedEntity = { id: "entity123", name: "Updated Entity" };
+     * await entityService.modifyModel({ model: updatedEntity });
+     */
+    build: ({ destinationAddress, basePath, getAllPath, getOnePath, deleteModelPath, addModelPath, modifyModelPath, mock, }: ServiceFactoryParams) => {
+        /**
+         * Retrieves a list of entities managed by the kOS Server.
+         *
+         * @param params - The parameters for the request, including common options.
+         * @returns The list of entities.
+         */
+        getAll: <Response>({ urlOverride, ordered, studio, fos, bridge, timeout, destinationAddress: destinationAddressOverride, }: GetAllParams) => Promise<KosServiceResponse<Response[]> | undefined>;
+        /**
+         * Retrieves details of a specific entity by its ID.
+         *
+         * @param params - The parameters for the request, including common options and the entity ID.
+         * @returns Details of the requested entity.
+         */
+        getModelById: <Response_1>({ urlOverride, id, ordered, studio, fos, bridge, timeout, destinationAddress: destinationAddressOverride, }: GetModelByIdParams) => Promise<KosServiceResponse<Response_1> | undefined>;
+        /**
+         * Retrieves details of a single entity.
+         *
+         * @param params - The parameters for the request, including common options.
+         * @returns Details of the requested entity.
+         */
+        getOne: <Response_2>({ urlOverride, ordered, studio, fos, bridge, tracker, timeout, destinationAddress: destinationAddressOverride, }: GetAllParams) => Promise<KosServiceResponse<Response_2> | undefined>;
+        /**
+         * Adds a new entity to the server.
+         *
+         * @param params - The parameters for the request, including common options and the new entity model.
+         * @returns An empty response with status 200.
+         */
+        addModel: <Request>({ model, urlOverride, ordered, tracker, studio, fos, bridge, timeout, destinationAddress: destinationAddressOverride, }: AddModelParams<Request>) => Promise<KosServiceResponse<any> | undefined>;
+        /**
+         * Deletes an entity from the server based on its ID.
+         *
+         * @param params - The parameters for the request, including common options and the entity ID.
+         * @returns An empty response with status 200.
+         */
+        deleteModel: <ResponseType = unknown>({ id, tracker, urlOverride, ordered, studio, fos, bridge, destinationAddress: destinationAddressOverride, }: DeleteModelParams) => Promise<KosServiceResponse<ResponseType> | undefined>;
+        /**
+         * Modifies an existing entity on the server.
+         *
+         * @param params - The parameters for the request, including common options and the entity model.
+         * @returns An empty response with status 200.
+         */
+        modifyModel: <Request_1>({ model, id, urlOverride, ordered, studio, fos, bridge, timeout, destinationAddress: destinationAddressOverride, }: ModifyModelParams<Request_1>) => Promise<KosServiceResponse<any> | undefined>;
+        /**
+         * Modifies an existing entity on the server using the HTTP PUT method.
+         *
+         * @param params - The parameters for the request, including common options and the entity model.
+         * @returns An empty response with status 200.
+         */
+        putModel: <Request_1>({ model, id, urlOverride, ordered, studio, fos, bridge, timeout, destinationAddress: destinationAddressOverride, }: ModifyModelParams<Request_1>) => Promise<KosServiceResponse<any> | undefined>;
+        /**
+         * Adds a new entity to the server using the HTTP POST method.
+         *
+         * @param params - The parameters for the request, including common options and the new entity model.
+         * @returns An empty response with status 200.
+         */
+        postModel: <Request>({ model, urlOverride, ordered, tracker, studio, fos, bridge, timeout, destinationAddress: destinationAddressOverride, }: AddModelParams<Request>) => Promise<KosServiceResponse<any> | undefined>;
+    };
+};
+export {};
+//# sourceMappingURL=service-factory.d.ts.map

package/core/util/service-factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service-factory.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/core/util/service-factory.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAGH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAGtD;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,cAAe,MAAM;;;CAIlD,CAAC;AAOF;;GAEG;AACH,UAAU,iBAAkB,SAAQ,YAAY;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAuDD;;GAEG;AACH,KAAK,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC,GACpC,OAAO,CAAC,aAAa,CAAC,GACtB,OAAO,CAAC,UAAU,CAAC,GACnB,OAAO,CAAC,eAAe,CAAC,GACxB,OAAO,CAAC,YAAY,CAAC,CAAC;AAExB;;GAEG;AACH,UAAU,YAAa,SAAQ,YAAY;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,UAAU,kBAAmB,SAAQ,YAAY;IAC/C,EAAE,EAAE,MAAM,CAAC;CACZ;AAsMD,UAAU,SAAS;IACjB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,UAAU,YAAY;IACpB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,UAAU;IAClB,GAAG,EAAE,OAAO,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,UAAU,aAAa;IACrB,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,UAAU,eAAe;IACvB,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AACD,UAAU,cAAc,CAAC,OAAO,CAC9B,SAAQ,OAAO,CAAC,SAAS,CAAC,EACxB,OAAO,CAAC,aAAa,CAAC,EACtB,OAAO,CAAC,UAAU,CAAC,EACnB,OAAO,CAAC,eAAe,CAAC,EACxB,OAAO,CAAC,YAAY,CAAC;IACvB,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,iBAAiB,CAAC,OAAO,CACjC,SAAQ,OAAO,CAAC,SAAS,CAAC,EACxB,OAAO,CAAC,aAAa,CAAC,EACtB,OAAO,CAAC,UAAU,CAAC,EACnB,OAAO,CAAC,eAAe,CAAC,EACxB,OAAO,CAAC,YAAY,CAAC;IACvB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,qBAAa,UAAU,CACrB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAC1D,SAAQ,KAAK;IACb,OAAO,CAAC,EAAE,CAAC,CAAC;gBACA,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;CAKzC;AA6HD;;GAEG;AACH,UAAU,oBAAoB;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;GAEG;AACH,eAAO,MAAM,cAAc;IACzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;6HAUA,oBAAoB;QAGnB;;;;;WAKG;oIAjYJ,YAAY;QAoYX;;;;;WAKG;gJA9RJ,kBAAkB;QAqSjB;;;;;WAKG;+IA9VJ,YAAY;QAiWX;;;;;WAKG;qJAnMJ,eAAe,OAAO,CAAC;QAsMtB;;;;;WAKG;2JArhBJ,iBAAiB;QA4hBhB;;;;;WAKG;;QAQH;;;;;WAKG;;QAQH;;;;;WAKG;sJAjPJ,eAAe,OAAO,CAAC;;CAqP3B,CAAC"}

package/core/util/session-utils.d.ts

@@ -0,0 +1,3 @@
+export declare const getKosSessionKey: () => string;
+export declare const isLocalRefId: (id?: string) => boolean;
+//# sourceMappingURL=session-utils.d.ts.map

package/core/util/session-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"session-utils.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/core/util/session-utils.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,gBAAgB,QAAO,MAA8B,CAAC;AAEnE,eAAO,MAAM,YAAY,QAAS,MAAM,KAAG,OAC8B,CAAC"}

package/core/util/setRandomInterval.d.ts

@@ -0,0 +1,5 @@
+declare const setRandomInterval: (context: any, intervalFunction: any, minDelay: any, maxDelay: any) => {
+    clear(): void;
+};
+export default setRandomInterval;
+//# sourceMappingURL=setRandomInterval.d.ts.map

package/core/util/setRandomInterval.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setRandomInterval.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/core/util/setRandomInterval.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,iBAAiB;;CAsBtB,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/core/util/wait-for-request.d.ts

@@ -0,0 +1,15 @@
+import { KosServiceResponse } from './kos-fetch';
+
+export interface ErrorResponse {
+    error?: string;
+}
+export declare const waitForRequest: <ResponseType extends ErrorResponse>(requestId: string, timeout?: number) => Promise<ResponseType>;
+export declare const sendRequest: <R, T extends KosServiceResponse<any>>(requestPromise: (param: R) => Promise<T | undefined>, params: R, refId: string) => Promise<T | undefined>;
+interface SyncPublishParams<T> {
+    topic: string;
+    msg: T;
+    requestId?: string;
+}
+export declare const syncPublish: <T, R extends ErrorResponse>({ topic, msg, requestId, }: SyncPublishParams<T>) => Promise<R>;
+export {};
+//# sourceMappingURL=wait-for-request.d.ts.map

package/core/util/wait-for-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wait-for-request.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/core/util/wait-for-request.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEjD,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,eAAO,MAAM,cAAc,kDACd,MAAM,4CAqBf,CAAC;AAEL,eAAO,MAAM,WAAW,yDACN,CAAC,KAAK,EAAE,CAAC,KAAK,QAAQ,CAAC,GAAG,SAAS,CAAC,UAC5C,CAAC,SACF,MAAM,2BAqBd,CAAC;AAEF,UAAU,iBAAiB,CAAC,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,CAAC,CAAC;IACP,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AACD,eAAO,MAAM,WAAW,2DAIrB,kBAAkB,CAAC,CAAC,eAStB,CAAC"}

package/core/util/when-ready.d.ts

@@ -0,0 +1,21 @@
+import { IKosDataModel } from '../core/kosModel';
+
+/**
+ * Asynchronously waits for a Kos Data Model to become ready for use.
+ *
+ * This utility function is used to ensure that a Kos Data Model is fully
+ * loaded and ready to be accessed before performing any operations on it.
+ *
+ * @category Utility
+ * @name whenReady
+ * @version 1.0.0
+ * @param dataModel - The Kos Data Model to wait for readiness.
+ * @throws {Error} If the specified data model is not found or if it has no ID.
+ * @returns A promise that resolves to the same data model when it becomes ready.
+ *
+ * @example
+ * // Wait for the 'dataModel' to become ready before using it.
+ * const dataModel = await whenReady(dataModel);
+ */
+export declare const whenReady: (dataModel: IKosDataModel) => Promise<IKosDataModel>;
+//# sourceMappingURL=when-ready.d.ts.map

package/core/util/when-ready.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"when-ready.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/core/util/when-ready.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,SAAS,cAAqB,aAAa,2BAmBvD,CAAC"}