@computec/uibase 1.0.2

package/dist/helpers/ErrorHelper.d.ts

@@ -0,0 +1,15 @@
+export default class ErrorHelper {
+    /**
+     * @description Helper method that try to return Error type
+     * @returns
+     */
+    static getError(error: any): Error;
+    /**
+     * Check if the error is an AppEngineException
+     * @deprecated **Use AppEngineException.is instead**
+     * @param error any object
+     * @returns boolean
+     */
+    static isAppEngineException(error: any): error is import("..").IAppEngineException;
+}
+//# sourceMappingURL=ErrorHelper.d.ts.map

package/dist/helpers/ErrorHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ErrorHelper.d.ts","sourceRoot":"","sources":["../../src/helpers/ErrorHelper.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B;;;OAGG;WACW,QAAQ,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK;IAezC;;;;;OAKG;WACW,oBAAoB,CAAC,KAAK,EAAE,GAAG;CAG9C"}

package/dist/helpers/ErrorHelper.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const AppEngineException_1 = __importDefault(require("../models/AppEngineException"));
+class ErrorHelper {
+    /**
+     * @description Helper method that try to return Error type
+     * @returns
+     */
+    static getError(error) {
+        var _a;
+        switch (true) {
+            case error instanceof Error:
+                return error;
+            case typeof error === "string":
+                return new Error(error);
+            case AppEngineException_1.default.is(error):
+                return new AppEngineException_1.default(error).error;
+            case (_a = error === null || error === void 0 ? void 0 : error.error) === null || _a === void 0 ? void 0 : _a.message:
+                return new Error(error.error.message);
+            default:
+                return error;
+        }
+    }
+    /**
+     * Check if the error is an AppEngineException
+     * @deprecated **Use AppEngineException.is instead**
+     * @param error any object
+     * @returns boolean
+     */
+    static isAppEngineException(error) {
+        return AppEngineException_1.default.is(error);
+    }
+}
+exports.default = ErrorHelper;

package/dist/helpers/HttpClientHelper.d.ts

@@ -0,0 +1,42 @@
+import { IBasicHttpRequest } from "../communication/IBaseHttpClientOptions";
+export default class HttpClientHelper {
+    static readonly FULL_URL_PATTERN: RegExp;
+    static readonly NOT_AUTHENTICATED_ERROR_NAME = "RESPONSE_NOT_AUTHENTICATED";
+    /**
+     * @throws Error if response is not ok with message based on status code or response
+     */
+    static validateResponse(response: Response, restOptions: IBasicHttpRequest): Promise<boolean>;
+    /**
+     * @description Check if headers is an array of [string, string]
+     */
+    static isHeadersArrayType(headers: HeadersInit): headers is [string, string][];
+    /**
+     * @description Fetch data based on response content type
+     * @param response from fetch
+     * @returns
+     */
+    static fetchData(response: Response): Promise<any>;
+    /**
+     * @description prepares Url for fetch. If full url is provided, it will return it as is, otherwise it will append it to the current origin
+     * @param url
+     * @returns
+     */
+    static getFullUrl(url?: string): string;
+    /**
+     * @description Check if error is not authenticated
+     * @param error
+     * @returns
+     */
+    static isNotAuthenticated: (error: Error) => boolean;
+    private static _validateResponseType;
+    private static _throwErrorBasedOnResponse;
+    private static _getAcceptedType;
+    private static _isJsonType;
+    private static _isFileType;
+    private static _isTextType;
+    private static _isNullType;
+    private static _fetchJsonData;
+    private static _fetchFileData;
+    private static _fetchTextData;
+}
+//# sourceMappingURL=HttpClientHelper.d.ts.map

package/dist/helpers/HttpClientHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpClientHelper.d.ts","sourceRoot":"","sources":["../../src/helpers/HttpClientHelper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AAK5E,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACpC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,SAAmB;IACnD,MAAM,CAAC,QAAQ,CAAC,4BAA4B,gCAAgC;IAC5E;;OAEG;WACiB,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,iBAAiB;IASvF;;OAEG;WACW,kBAAkB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE;IAiBrF;;;;OAIG;WACW,SAAS,CAAC,QAAQ,EAAE,QAAQ;IAO1C;;;;OAIG;WACW,UAAU,CAAC,GAAG,CAAC,EAAE,MAAM;IAMrC;;;;OAIG;IACH,OAAc,kBAAkB,GAAI,OAAO,KAAK,aACc;IAG9D,OAAO,CAAC,MAAM,CAAC,qBAAqB;mBAqBf,0BAA0B;IAyB/C,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAU/B,OAAO,CAAC,MAAM,CAAC,WAAW;IAI1B,OAAO,CAAC,MAAM,CAAC,WAAW;IAI1B,OAAO,CAAC,MAAM,CAAC,WAAW;IAI1B,OAAO,CAAC,MAAM,CAAC,WAAW;mBAIL,cAAc;mBASd,cAAc;mBASd,cAAc;CASnC"}

package/dist/helpers/HttpClientHelper.js

@@ -0,0 +1,175 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const AppEngineException_1 = __importDefault(require("../models/AppEngineException"));
+const ErrorHelper_1 = __importDefault(require("./ErrorHelper"));
+const HeadersContentTypeEnum_1 = __importDefault(require("../models/enums/HeadersContentTypeEnum"));
+class HttpClientHelper {
+    /**
+     * @throws Error if response is not ok with message based on status code or response
+     */
+    static validateResponse(response, restOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!response.ok) {
+                yield this._throwErrorBasedOnResponse(response, restOptions);
+            }
+            this._validateResponseType(response, restOptions);
+            return true;
+        });
+    }
+    /**
+     * @description Check if headers is an array of [string, string]
+     */
+    static isHeadersArrayType(headers) {
+        if (!Array.isArray(headers)) {
+            return false;
+        }
+        for (let i = 0; i < headers.length; i++) {
+            if (!Array.isArray(headers[i]) || headers[i].length !== 2) {
+                return false;
+            }
+            if (typeof headers[i][0] !== "string" || typeof headers[i][1] !== "string") {
+                return false;
+            }
+        }
+        return true;
+    }
+    /**
+     * @description Fetch data based on response content type
+     * @param response from fetch
+     * @returns
+     */
+    static fetchData(response) {
+        const type = response.headers.get("Content-Type");
+        if (this._isJsonType(type))
+            return this._fetchJsonData(response);
+        if (this._isFileType(type))
+            return this._fetchFileData(response);
+        return this._fetchTextData(response);
+    }
+    /**
+     * @description prepares Url for fetch. If full url is provided, it will return it as is, otherwise it will append it to the current origin
+     * @param url
+     * @returns
+     */
+    static getFullUrl(url) {
+        if (!url)
+            return "";
+        if (this.FULL_URL_PATTERN.test(url))
+            return url;
+        return `${window.location.origin}/${url}`;
+    }
+    //#region Private methods
+    static _validateResponseType(response, restOptions) {
+        const responseType = response.headers.get("Content-Type");
+        const acceptedType = this._getAcceptedType(restOptions.headers);
+        let valid = true;
+        if (acceptedType) {
+            const acceptedTypesArray = acceptedType.split(",");
+            valid = acceptedTypesArray.some((acceptedType) => (this._isJsonType(acceptedType) && this._isJsonType(responseType)) ||
+                (this._isTextType(acceptedType) && this._isTextType(responseType)) ||
+                (this._isFileType(acceptedType) && this._isFileType(responseType)) ||
+                (this._isNullType(acceptedType) && this._isNullType(responseType)));
+        }
+        if (!valid)
+            throw new Error(`Wrong content type. Accepted type for request: ${acceptedType}, received type in response: ${responseType}.`);
+    }
+    static _throwErrorBasedOnResponse(response, restOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            switch (response.status) {
+                case 401:
+                    const error = new Error();
+                    error.name = HttpClientHelper.NOT_AUTHENTICATED_ERROR_NAME;
+                    error.message = response.statusText;
+                    throw error;
+                case 0:
+                    throw new Error("Server is not responding");
+                case 404:
+                    throw new Error(`Not found ${restOptions.url}`);
+                case 405:
+                    throw new Error(`Method ${restOptions.method} not allowed for endpoint: ${restOptions.url}`);
+            }
+            const result = yield this.fetchData(response);
+            if (AppEngineException_1.default.is(result))
+                throw new AppEngineException_1.default(result).error;
+            throw ErrorHelper_1.default.getError(result);
+        });
+    }
+    static _getAcceptedType(headers) {
+        if (!headers)
+            return null;
+        if (headers instanceof Headers)
+            return headers.get("Accepted");
+        if (this.isHeadersArrayType(headers)) {
+            const accepted = headers.find(([key]) => key === "Accepted");
+            if (accepted !== undefined)
+                return accepted[1];
+        }
+        return headers["Accepted"];
+    }
+    static _isJsonType(type) {
+        return type === null || type === void 0 ? void 0 : type.includes(HeadersContentTypeEnum_1.default.Json);
+    }
+    static _isFileType(type) {
+        return type === null || type === void 0 ? void 0 : type.includes(HeadersContentTypeEnum_1.default.OctetStream);
+    }
+    static _isTextType(type) {
+        return type === null || type === void 0 ? void 0 : type.includes(HeadersContentTypeEnum_1.default.Text);
+    }
+    static _isNullType(type) {
+        return type === HeadersContentTypeEnum_1.default.Null || type === null;
+    }
+    static _fetchJsonData(response) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield response.json();
+            }
+            catch (error) {
+                const err = ErrorHelper_1.default.getError(error);
+                throw new Error(`Could not load json data from response. ${err.message}`);
+            }
+        });
+    }
+    static _fetchFileData(response) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield response.blob();
+            }
+            catch (error) {
+                const err = ErrorHelper_1.default.getError(error);
+                throw new Error(`Could not load json data from response. ${err.message}`);
+            }
+        });
+    }
+    static _fetchTextData(response) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield response.text();
+            }
+            catch (error) {
+                const err = ErrorHelper_1.default.getError(error);
+                throw new Error(`Could not load text data from response. ${err.message}`);
+            }
+        });
+    }
+}
+HttpClientHelper.FULL_URL_PATTERN = /^https?:\/\//i;
+HttpClientHelper.NOT_AUTHENTICATED_ERROR_NAME = "RESPONSE_NOT_AUTHENTICATED";
+/**
+ * @description Check if error is not authenticated
+ * @param error
+ * @returns
+ */
+HttpClientHelper.isNotAuthenticated = (error) => error.name === HttpClientHelper.NOT_AUTHENTICATED_ERROR_NAME;
+exports.default = HttpClientHelper;

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+export { default as HttpClient } from './communication/HttpClient';
+export * from './communication/HttpClient';
+export { default as HttpClientCacheOptions } from './communication/HttpClientCacheOptions';
+export * from './communication/HttpClientCacheOptions';
+export * from './communication/IBaseHttpClientOptions';
+export { default as ErrorHelper } from './helpers/ErrorHelper';
+export * from './helpers/ErrorHelper';
+export { default as HttpClientHelper } from './helpers/HttpClientHelper';
+export * from './helpers/HttpClientHelper';
+export { default as AppEngineException } from './models/AppEngineException';
+export * from './models/AppEngineException';
+export { default as BaseBusinessObject } from './models/BaseBusinessObject';
+export * from './models/BaseBusinessObject';
+export { default as HeadersContentTypeEnum } from './models/enums/HeadersContentTypeEnum';
+export * from './models/enums/HeadersContentTypeEnum';
+export * from './models/enums/StorageTypeEnum';
+export { default as IAppEngineException } from './models/interfaces/IAppEngineException';
+export * from './models/interfaces/IAppEngineException';
+export { default as LocalStorage } from './models/LocalStorage';
+export * from './models/LocalStorage';
+export { default as Session } from './models/Session';
+export * from './models/Session';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACnE,cAAc,4BAA4B,CAAC;AAC3C,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAC3F,cAAc,wCAAwC,CAAC;AACvD,cAAc,wCAAwC,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC/D,cAAc,uBAAuB,CAAC;AACtC,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACzE,cAAc,4BAA4B,CAAC;AAC3C,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAC5E,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAC5E,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAC1F,cAAc,uCAAuC,CAAC;AACtD,cAAc,gCAAgC,CAAC;AAC/C,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,yCAAyC,CAAC;AACzF,cAAc,yCAAyC,CAAC;AACxD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAChE,cAAc,uBAAuB,CAAC;AACtC,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACtD,cAAc,kBAAkB,CAAC"}

package/dist/index.js

@@ -0,0 +1,50 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Session = exports.LocalStorage = exports.HeadersContentTypeEnum = exports.BaseBusinessObject = exports.AppEngineException = exports.HttpClientHelper = exports.ErrorHelper = exports.HttpClientCacheOptions = exports.HttpClient = void 0;
+var HttpClient_1 = require("./communication/HttpClient");
+Object.defineProperty(exports, "HttpClient", { enumerable: true, get: function () { return __importDefault(HttpClient_1).default; } });
+__exportStar(require("./communication/HttpClient"), exports);
+var HttpClientCacheOptions_1 = require("./communication/HttpClientCacheOptions");
+Object.defineProperty(exports, "HttpClientCacheOptions", { enumerable: true, get: function () { return __importDefault(HttpClientCacheOptions_1).default; } });
+__exportStar(require("./communication/HttpClientCacheOptions"), exports);
+__exportStar(require("./communication/IBaseHttpClientOptions"), exports);
+var ErrorHelper_1 = require("./helpers/ErrorHelper");
+Object.defineProperty(exports, "ErrorHelper", { enumerable: true, get: function () { return __importDefault(ErrorHelper_1).default; } });
+__exportStar(require("./helpers/ErrorHelper"), exports);
+var HttpClientHelper_1 = require("./helpers/HttpClientHelper");
+Object.defineProperty(exports, "HttpClientHelper", { enumerable: true, get: function () { return __importDefault(HttpClientHelper_1).default; } });
+__exportStar(require("./helpers/HttpClientHelper"), exports);
+var AppEngineException_1 = require("./models/AppEngineException");
+Object.defineProperty(exports, "AppEngineException", { enumerable: true, get: function () { return __importDefault(AppEngineException_1).default; } });
+__exportStar(require("./models/AppEngineException"), exports);
+var BaseBusinessObject_1 = require("./models/BaseBusinessObject");
+Object.defineProperty(exports, "BaseBusinessObject", { enumerable: true, get: function () { return __importDefault(BaseBusinessObject_1).default; } });
+__exportStar(require("./models/BaseBusinessObject"), exports);
+var HeadersContentTypeEnum_1 = require("./models/enums/HeadersContentTypeEnum");
+Object.defineProperty(exports, "HeadersContentTypeEnum", { enumerable: true, get: function () { return __importDefault(HeadersContentTypeEnum_1).default; } });
+__exportStar(require("./models/enums/HeadersContentTypeEnum"), exports);
+__exportStar(require("./models/enums/StorageTypeEnum"), exports);
+__exportStar(require("./models/interfaces/IAppEngineException"), exports);
+var LocalStorage_1 = require("./models/LocalStorage");
+Object.defineProperty(exports, "LocalStorage", { enumerable: true, get: function () { return __importDefault(LocalStorage_1).default; } });
+__exportStar(require("./models/LocalStorage"), exports);
+var Session_1 = require("./models/Session");
+Object.defineProperty(exports, "Session", { enumerable: true, get: function () { return __importDefault(Session_1).default; } });
+__exportStar(require("./models/Session"), exports);

package/dist/models/AppEngineException.d.ts

@@ -0,0 +1,11 @@
+import IAppEngineException from "./interfaces/IAppEngineException";
+export default class AppEngineException implements IAppEngineException {
+    Title?: string;
+    Detail?: string;
+    title?: string;
+    detail?: string;
+    constructor(error?: any);
+    get error(): Error;
+    static is(error: any): error is IAppEngineException;
+}
+//# sourceMappingURL=AppEngineException.d.ts.map

package/dist/models/AppEngineException.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppEngineException.d.ts","sourceRoot":"","sources":["../../src/models/AppEngineException.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,kCAAkC,CAAC;AAEnE,MAAM,CAAC,OAAO,OAAO,kBAAmB,YAAW,mBAAmB;IACpE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEJ,KAAK,CAAC,EAAE,GAAG;IASvB,IAAI,KAAK,UAER;IAED,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,mBAAmB;CAOpD"}

package/dist/models/AppEngineException.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class AppEngineException {
+    constructor(error) {
+        if (error) {
+            this.Title = error.Title;
+            this.Detail = error.Detail;
+            this.title = error.title;
+            this.detail = error.detail;
+        }
+    }
+    get error() {
+        return new Error(this.Detail || this.detail);
+    }
+    static is(error) {
+        let isTitle = error["Title"] !== undefined || error["title"] !== undefined;
+        let isDetails = error["Detail"] !== undefined || error["detail"] !== undefined;
+        return isTitle && isDetails;
+    }
+}
+exports.default = AppEngineException;

package/dist/models/BaseBusinessObject.d.ts

@@ -0,0 +1,158 @@
+type BaseBusinessObjectConstructor<T extends BaseBusinessObject> = {
+    new (): T;
+    create<U extends T>(this: BaseBusinessObjectConstructor<U>, data: Record<string, unknown> | object): U;
+    createMany<U extends T>(this: BaseBusinessObjectConstructor<U>, data: Record<string, unknown>[] | object[]): U[];
+};
+/**
+ * @experimental
+ * It is possible that this class will be removed or change name in the future.
+ * @class
+ * @abstract
+ * This abstract class is used to transform data from the server to business logic.
+ * It's currently marked as experimental, which means it may change in the future.
+ *
+ * **Static methods**:
+ *
+ * @static {function} `create` - This method is used to create a new instance of the class filled with the provided data.
+ * @static {function} `createMany` - This method is used to create multiple new instances of the class filled with the provided data.
+ *
+ * **Methods and properties**:
+ *
+ * @property {boolean} `USE_RAW_DATA` - This property is used to determine if the instance should use the raw data from the server.
+ * @property {function} `fillData` - This method is used to fill the instance with data from the server.
+ * @property {function} `clone` - This abstract method should be implemented in child classes to clone the instance.
+ * @property {function} `toJSON` - This method is used to remove the _rawData property from the object before converting it to JSON.
+ * @property {function} `getField` - This method is used to retrieve the value of a specific field from the _rawData object.
+ * @property {function} `cleanRaw` - This method is to reset the _rawData property to an empty object.
+ */
+export default abstract class BaseBusinessObject {
+    /**
+     * This property is used to determine if the instance should use the raw data from the server.
+     * If set to true, the instance will store the raw data in the _rawData property.
+     * This property is set to false by default.
+     * @method getField - This method is used to retrieve the value of a specific field from the _rawData object.
+     */
+    protected USE_RAW_DATA: boolean;
+    /**
+     * This property is used to store the raw data from the server.
+     * It is an empty object by default.
+     * The property is only used if the USE_RAW_DATA property is set to true.
+     * _rawData can be usefull when you need initial data to be able to revert the object to its original state.
+     * @method getField - This method is used to retrieve the value of a specific field from the _rawData object.
+     * @private
+     * @type {Record<string, unknown>}
+     * @memberof BaseBusinessObject
+     */
+    private _rawData;
+    /**
+     * This method is to reset the _rawData property to an empty object.
+     *
+     * **Recommendations**
+     *
+     * - Use this method aware that you will lose the initial data of the object.
+     * - **IMPORTANT** The method is recommended to use in `fillData` method when you don't use `getField` method in `toJSON` method.
+     * - It is useful when you need to clean the raw data from the object or you want to optimize the memory usage.
+     * @returns {}
+     */
+    cleanRaw(): {};
+    /**
+     * Creates a new instance of the class filled with the provided data.
+     *
+     * @template T The type of the instance to create.
+     * @param {new () => T} this The constructor of the class to create an instance of.
+     * @param {Record<string, unknown>} data The data to fill the instance with.
+     * @returns {T} The new instance of the class filled with the provided data.
+     *
+     * @example
+     * // Example data from the server
+     * const data = { Code: 'US', Name: 'United States' };
+     *
+     * // Create a new Country instance filled with the data
+     * const country = Country.create(data);
+     *
+     * console.log(country.Code); // 'US'
+     * console.log(country.Name); // 'United States'
+     */
+    static create<T extends BaseBusinessObject, U extends T>(this: BaseBusinessObjectConstructor<U>, data: Record<string, unknown> | object): U;
+    /**
+     * Creates multiple new instances of the class filled with the provided data.
+     *
+     * @template T The type of the instances to create.
+     * @param {new () => T} this The constructor of the class to create instances of.
+     * @param {Record<string, unknown>[]} data The array of data to fill the instances with.
+     * @returns {T[]} The new instances of the class filled with the provided data.
+     *
+     * @example
+     * // Example array of data from the server
+     * const dataArray = [{ Code: 'US', Name: 'United States' }, { Code: 'CA', Name: 'Canada' }];
+     *
+     * // Create new Country instances filled with the data
+     * const countries = Country.createMany(dataArray);
+     *
+     * console.log(countries[0].Code); // 'US'
+     * console.log(countries[0].Name); // 'United States'
+     * console.log(countries[1].Code); // 'CA'
+     * console.log(countries[1].Name); // 'Canada'
+     */
+    static createMany<T extends BaseBusinessObject, U extends T>(this: BaseBusinessObjectConstructor<U>, data: Record<string, unknown>[] | object[]): U[];
+    /**
+     * This method is used to retrieve the value of a specific field from the _rawData object.
+     * It takes in a field parameter which represents the name of the field to retrieve.
+     * It tries to access the value of the field from the _rawData object using the provided field name.
+     * If the field exists, it returns the value casted to the specified type T.
+     * If the field does not exist or an error occurs, it returns null.
+     *
+     * @param field The name of the field to retrieve.
+     * @returns The value of the specified field casted to type T, or null if the field does not exist or an error occurs.
+     */
+    protected getField<T = object>(field: string): T;
+    /**
+     * Fills the instance with data from the server.
+     *
+     * @param {Record<string, unknown>} data - The data from the server.
+     * @returns {BaseBusinessObject} The instance of the class filled with the server data.
+     */
+    fillData(data: Record<string, unknown> | object): this;
+    /**
+     * Creates a clone of the instance.
+     *
+     * It is more optimized than structuredClone method. It is recommended to use this method when you don't need to deep clone the object.
+     *
+     * **Recommendations**
+     *
+     * - Use this method when you don't need to deep clone the object.
+     * - It is useful when you need to create a new instance of the class filled with the same data as the original instance.
+     * - Remember that the method doesn't clone the lower level objects.
+     *
+     * @returns {BaseBusinessObject} A clone of the instance.
+     */
+    clone(): this;
+    /**
+     * Creates a structured clone of the instance.
+     *
+     * Simple method that use `create` method to create a new instance of the class filled with the same data as the original instance.
+     *
+     * It is more expensive than the `clone` method. It is recommended to use this method when you need to deep clone the object.
+     *
+     * **Important**
+     * - Remember that you decide what nested objects is cloned. Please check `fillData` method.
+     * - `fillData` method give possibility to clone nested objects that what you need to clone.
+     *
+     * **Recommendations**
+     *
+     * - Use this method when you need to deep clone the object.
+     * - The method is more expensive than the `clone` method.
+     *
+     * @returns {BaseBusinessObject} A clone of the instance.
+     */
+    structuredClone(): this;
+    protected cloneInternal(objectToClone: unknown): this;
+    /**
+     * Remove the _rawData property from the object before converting it to JSON.
+     * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
+     * @returns Record<string, unknown>
+     */
+    toJSON(): Record<string, unknown>;
+}
+export {};
+//# sourceMappingURL=BaseBusinessObject.d.ts.map

package/dist/models/BaseBusinessObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseBusinessObject.d.ts","sourceRoot":"","sources":["../../src/models/BaseBusinessObject.ts"],"names":[],"mappings":"AAAA,KAAK,6BAA6B,CAAC,CAAC,SAAS,kBAAkB,IAAI;IACjE,QAAQ,CAAC,CAAC;IACV,MAAM,CAAC,CAAC,SAAS,CAAC,EAChB,IAAI,EAAE,6BAA6B,CAAC,CAAC,CAAC,EACtC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GACrC,CAAC,CAAC;IACL,UAAU,CAAC,CAAC,SAAS,CAAC,EACpB,IAAI,EAAE,6BAA6B,CAAC,CAAC,CAAC,EACtC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,MAAM,EAAE,GACzC,CAAC,EAAE,CAAC;CACR,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,kBAAkB;IAC9C;;;;;OAKG;IACH,SAAS,CAAC,YAAY,UAAS;IAC/B;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAQ,CAA+B;IAE/C;;;;;;;;;OASG;IACI,QAAQ;IAGf;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,kBAAkB,EAAE,CAAC,SAAS,CAAC,EACrD,IAAI,EAAE,6BAA6B,CAAC,CAAC,CAAC,EACtC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GACrC,CAAC;IAMJ;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,kBAAkB,EAAE,CAAC,SAAS,CAAC,EACzD,IAAI,EAAE,6BAA6B,CAAC,CAAC,CAAC,EACtC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,MAAM,EAAE,GACzC,CAAC,EAAE;IAIN;;;;;;;;;OASG;IACH,SAAS,CAAC,QAAQ,CAAC,CAAC,GAAG,MAAM,EAAE,KAAK,EAAE,MAAM;IAQ5C;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAU/C;;;;;;;;;;;;OAYG;IACH,KAAK,IAAI,IAAI;IAIb;;;;;;;;;;;;;;;;;OAiBG;IACH,eAAe,IAAI,IAAI;IAMvB,SAAS,CAAC,aAAa,CAAC,aAAa,EAAE,OAAO,GAAG,IAAI;IAIrD;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAOlC"}