@computec/uibase 1.0.2

package/dist/models/BaseBusinessObject.js

@@ -0,0 +1,187 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * @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.
+ */
+class BaseBusinessObject {
+    constructor() {
+        /**
+         * 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.
+         */
+        this.USE_RAW_DATA = false;
+        /**
+         * 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
+         */
+        this._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() {
+        return (this._rawData = {});
+    }
+    /**
+     * 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(data) {
+        const instance = new this();
+        instance.fillData(data);
+        return instance;
+    }
+    /**
+     * 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(data) {
+        return (data || []).map((item) => this.create(item));
+    }
+    /**
+     * 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.
+     */
+    getField(field) {
+        try {
+            return this._rawData[field];
+        }
+        catch (error) {
+            return null;
+        }
+    }
+    /**
+     * 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) {
+        const useRawData = this.USE_RAW_DATA;
+        const result = (data || {});
+        result["_rawData"] = undefined;
+        Object.assign(this, result);
+        if (useRawData)
+            this._rawData = result;
+        return 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() {
+        return this.cloneInternal(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() {
+        return this.constructor.create(this);
+    }
+    cloneInternal(objectToClone) {
+        return Object.assign(new this.constructor(), objectToClone);
+    }
+    /**
+     * 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() {
+        return Object.assign(Object.assign({}, this), { _rawData: undefined, USE_RAW_DATA: undefined });
+    }
+}
+exports.default = BaseBusinessObject;

package/dist/models/LocalStorage.d.ts

@@ -0,0 +1,9 @@
+import { StorageTypeEnum } from "./enums/StorageTypeEnum";
+export default class LocalStorage {
+    static put<T>(key: string, value: T, type?: StorageTypeEnum): void;
+    static get<T>(key: string, type?: StorageTypeEnum): T | null;
+    static remove(key: string, type?: StorageTypeEnum): void;
+    private static _prepareValueForStorage;
+    private static _parseValue;
+}
+//# sourceMappingURL=LocalStorage.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LocalStorage.d.ts","sourceRoot":"","sources":["../../src/models/LocalStorage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,MAAM,CAAC,OAAO,OAAO,YAAY;WAClB,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,GAAE,eAAyC;WAU7E,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,eAAyC,GAAG,CAAC,GAAG,IAAI;WAiB9E,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,eAAyC;IAQjF,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAItC,OAAO,CAAC,MAAM,CAAC,WAAW;CAO1B"}

package/dist/models/LocalStorage.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const StorageTypeEnum_1 = require("./enums/StorageTypeEnum");
+class LocalStorage {
+    static put(key, value, type = StorageTypeEnum_1.StorageTypeEnum.session) {
+        const valueToStore = this._prepareValueForStorage(value);
+        if (valueToStore === null)
+            return;
+        if (type === StorageTypeEnum_1.StorageTypeEnum.session) {
+            window.sessionStorage.setItem(key, valueToStore);
+        }
+        else if (type == StorageTypeEnum_1.StorageTypeEnum.local) {
+            window.localStorage.setItem(key, valueToStore);
+        }
+    }
+    static get(key, type = StorageTypeEnum_1.StorageTypeEnum.session) {
+        let value;
+        switch (type) {
+            case StorageTypeEnum_1.StorageTypeEnum.session:
+                value = window.sessionStorage.getItem(key);
+                break;
+            case StorageTypeEnum_1.StorageTypeEnum.local:
+                value = window.localStorage.getItem(key);
+                break;
+            default:
+                return null;
+        }
+        if (value === null)
+            return null;
+        return this._parseValue(value);
+    }
+    static remove(key, type = StorageTypeEnum_1.StorageTypeEnum.session) {
+        if (type === StorageTypeEnum_1.StorageTypeEnum.session) {
+            window.sessionStorage.removeItem(key);
+        }
+        else if (type === StorageTypeEnum_1.StorageTypeEnum.local) {
+            window.localStorage.removeItem(key);
+        }
+    }
+    static _prepareValueForStorage(value) {
+        if (typeof value === "object" && value !== null)
+            return JSON.stringify(value);
+        return value;
+    }
+    static _parseValue(str) {
+        try {
+            JSON.parse(str);
+            return JSON.parse(str);
+        }
+        catch (_a) { }
+        return str;
+    }
+}
+exports.default = LocalStorage;

package/dist/models/Session.d.ts

@@ -0,0 +1,18 @@
+export default class Session {
+    CompanyId: string;
+    ApiKey?: string;
+    UserName: string;
+    Language: string;
+    ClientId: string;
+    FormMode: boolean;
+    AppType: string;
+    SAPWebClient: boolean;
+    CompanyName: string;
+    CompanyDB: string;
+    ServerAddress: string;
+    ServerDescription: string;
+    SLDServerAddress: string;
+    SLDServerDescription: string;
+    Theme?: string;
+}
+//# sourceMappingURL=Session.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Session.d.ts","sourceRoot":"","sources":["../../src/models/Session.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,OAAO;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,OAAO,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/dist/models/Session.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Session {
+}
+exports.default = Session;

package/dist/models/enums/HeadersContentTypeEnum.d.ts

@@ -0,0 +1,8 @@
+declare enum HeadersContentTypeEnum {
+    Json = "application/json",
+    Text = "text/plain",
+    OctetStream = "application/octet-stream",
+    Null = "null"
+}
+export default HeadersContentTypeEnum;
+//# sourceMappingURL=HeadersContentTypeEnum.d.ts.map

package/dist/models/enums/HeadersContentTypeEnum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HeadersContentTypeEnum.d.ts","sourceRoot":"","sources":["../../../src/models/enums/HeadersContentTypeEnum.ts"],"names":[],"mappings":"AAAA,aAAK,sBAAsB;IACzB,IAAI,qBAAqB;IACzB,IAAI,eAAe;IACnB,WAAW,6BAA6B;IACxC,IAAI,SAAS;CACd;AAED,eAAe,sBAAsB,CAAC"}

package/dist/models/enums/HeadersContentTypeEnum.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var HeadersContentTypeEnum;
+(function (HeadersContentTypeEnum) {
+    HeadersContentTypeEnum["Json"] = "application/json";
+    HeadersContentTypeEnum["Text"] = "text/plain";
+    HeadersContentTypeEnum["OctetStream"] = "application/octet-stream";
+    HeadersContentTypeEnum["Null"] = "null";
+})(HeadersContentTypeEnum || (HeadersContentTypeEnum = {}));
+exports.default = HeadersContentTypeEnum;

package/dist/models/enums/StorageTypeEnum.d.ts

@@ -0,0 +1,5 @@
+export declare enum StorageTypeEnum {
+    session = 0,
+    local = 1
+}
+//# sourceMappingURL=StorageTypeEnum.d.ts.map

package/dist/models/enums/StorageTypeEnum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageTypeEnum.d.ts","sourceRoot":"","sources":["../../../src/models/enums/StorageTypeEnum.ts"],"names":[],"mappings":"AAAA,oBAAY,eAAe;IAC1B,OAAO,IAAA;IACP,KAAK,IAAA;CACL"}

package/dist/models/enums/StorageTypeEnum.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorageTypeEnum = void 0;
+var StorageTypeEnum;
+(function (StorageTypeEnum) {
+    StorageTypeEnum[StorageTypeEnum["session"] = 0] = "session";
+    StorageTypeEnum[StorageTypeEnum["local"] = 1] = "local";
+})(StorageTypeEnum || (exports.StorageTypeEnum = StorageTypeEnum = {}));

package/dist/models/interfaces/IAppEngineException.d.ts

@@ -0,0 +1,7 @@
+export default interface IAppEngineException {
+    Title?: string;
+    Detail?: string;
+    title?: string;
+    detail?: string;
+}
+//# sourceMappingURL=IAppEngineException.d.ts.map

package/dist/models/interfaces/IAppEngineException.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAppEngineException.d.ts","sourceRoot":"","sources":["../../../src/models/interfaces/IAppEngineException.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,WAAW,mBAAmB;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/models/interfaces/IAppEngineException.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist-ui5/resources/computec/appengine/uibase/.library

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<library xmlns="http://www.sap.com/sap.ui.library.xsd">
+    <name>computec.appengine.uibase</name>
+    <vendor>CompuTec S.A.</vendor>
+    <version>1.0.2</version>
+    <copyright>Copyright (c) CompuTec S.A.2025</copyright>
+    <title>uibase</title>
+    <documentation>Core library required by AppEngine plugins</documentation>
+    <dependencies>
+        <dependency>
+            <libraryName>sap.ui.core</libraryName>
+            <libraryName>sap.m</libraryName>
+        </dependency>
+    </dependencies>
+</library>