@computec/uibase 1.0.9 → 1.0.10

package/dist-amd/helpers/WebClientNavigationHelper.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Helper for navigating from UIAPI Web Client extensions to AppEngine plugin routes.
+ *
+ * AppEngine plugins are opened via the Web Client hash URL format:
+ * `#webclient-CompuTecWebClientStart-CompuTecWebClientStart&/{pluginId},{route}/{pluginName}`
+ *
+ * Routes containing path separators (e.g. `ctp/4/0`) must be double-encoded
+ * so that both the browser and the SAPUI5 router decode them correctly.
+ */
+export default class WebClientNavigationHelper {
+    private static readonly HASH_PREFIX;
+    /**
+     * Build the full Web Client hash URL for navigating to an AppEngine plugin route.
+     *
+     * @param pluginId  The plugin identifier (e.g. `"MRP"`)
+     * @param route     The SAPUI5 route path including parameters (e.g. `"ctp/4/0"`, `"wizard"`)
+     * @param pluginName Optional display name; defaults to `pluginId`
+     * @returns The complete hash URL string
+     *
+     * @example
+     * ```typescript
+     * WebClientNavigationHelper.buildPluginUrl("MRP", "ctp/4/0");
+     * // => "#webclient-CompuTecWebClientStart-CompuTecWebClientStart&/MRP,ctp%252F4%252F0/MRP"
+     *
+     * WebClientNavigationHelper.buildPluginUrl("MRP", "wizard");
+     * // => "#webclient-CompuTecWebClientStart-CompuTecWebClientStart&/MRP,wizard/MRP"
+     * ```
+     */
+    static buildPluginUrl(pluginId: string, route: string, pluginName?: string): string;
+    /**
+     * Navigate to an AppEngine plugin route using the SDKEnv `open` method.
+     *
+     * @param openFn    A function that opens a URL — typically `oEnv.open.bind(oEnv)` or `(url) => oEnv.open(url)`
+     * @param pluginId  The plugin identifier (e.g. `"MRP"`)
+     * @param route     The SAPUI5 route path including parameters (e.g. `"ctp/4/0"`)
+     * @param pluginName Optional display name; defaults to `pluginId`
+     *
+     * @example
+     * ```typescript
+     * // In a UIAPI controller:
+     * import { WebClientNavigationHelper } from "@computec/uibase";
+     *
+     * await WebClientNavigationHelper.openPlugin(
+     *     (url) => oEnv.open(url),
+     *     "MRP",
+     *     `ctp/${docEntry}/${lineNum}`
+     * );
+     * ```
+     */
+    static openPlugin(openFn: (url: string) => Promise<void>, pluginId: string, route: string, pluginName?: string): Promise<void>;
+}
+//# sourceMappingURL=WebClientNavigationHelper.d.ts.map

package/dist-amd/helpers/WebClientNavigationHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebClientNavigationHelper.d.ts","sourceRoot":"","sources":["../../src/helpers/WebClientNavigationHelper.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,OAAO,yBAAyB;IAC7C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CACyB;IAE5D;;;;;;;;;;;;;;;;OAgBG;WACW,cAAc,CAC3B,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,MAAM,GACjB,MAAM;IAKT;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,UAAU,CAC7B,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,EACtC,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC;CAIhB"}

package/dist-amd/helpers/WebClientNavigationHelper.js

@@ -0,0 +1,73 @@
+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());
+    });
+};
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    /**
+     * Helper for navigating from UIAPI Web Client extensions to AppEngine plugin routes.
+     *
+     * AppEngine plugins are opened via the Web Client hash URL format:
+     * `#webclient-CompuTecWebClientStart-CompuTecWebClientStart&/{pluginId},{route}/{pluginName}`
+     *
+     * Routes containing path separators (e.g. `ctp/4/0`) must be double-encoded
+     * so that both the browser and the SAPUI5 router decode them correctly.
+     */
+    class WebClientNavigationHelper {
+        /**
+         * Build the full Web Client hash URL for navigating to an AppEngine plugin route.
+         *
+         * @param pluginId  The plugin identifier (e.g. `"MRP"`)
+         * @param route     The SAPUI5 route path including parameters (e.g. `"ctp/4/0"`, `"wizard"`)
+         * @param pluginName Optional display name; defaults to `pluginId`
+         * @returns The complete hash URL string
+         *
+         * @example
+         * ```typescript
+         * WebClientNavigationHelper.buildPluginUrl("MRP", "ctp/4/0");
+         * // => "#webclient-CompuTecWebClientStart-CompuTecWebClientStart&/MRP,ctp%252F4%252F0/MRP"
+         *
+         * WebClientNavigationHelper.buildPluginUrl("MRP", "wizard");
+         * // => "#webclient-CompuTecWebClientStart-CompuTecWebClientStart&/MRP,wizard/MRP"
+         * ```
+         */
+        static buildPluginUrl(pluginId, route, pluginName) {
+            const encodedRoute = encodeURIComponent(encodeURIComponent(route));
+            return `${WebClientNavigationHelper.HASH_PREFIX}&/${pluginId},${encodedRoute}/${pluginName !== null && pluginName !== void 0 ? pluginName : pluginId}`;
+        }
+        /**
+         * Navigate to an AppEngine plugin route using the SDKEnv `open` method.
+         *
+         * @param openFn    A function that opens a URL — typically `oEnv.open.bind(oEnv)` or `(url) => oEnv.open(url)`
+         * @param pluginId  The plugin identifier (e.g. `"MRP"`)
+         * @param route     The SAPUI5 route path including parameters (e.g. `"ctp/4/0"`)
+         * @param pluginName Optional display name; defaults to `pluginId`
+         *
+         * @example
+         * ```typescript
+         * // In a UIAPI controller:
+         * import { WebClientNavigationHelper } from "@computec/uibase";
+         *
+         * await WebClientNavigationHelper.openPlugin(
+         *     (url) => oEnv.open(url),
+         *     "MRP",
+         *     `ctp/${docEntry}/${lineNum}`
+         * );
+         * ```
+         */
+        static openPlugin(openFn, pluginId, route, pluginName) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const url = WebClientNavigationHelper.buildPluginUrl(pluginId, route, pluginName);
+                yield openFn(url);
+            });
+        }
+    }
+    WebClientNavigationHelper.HASH_PREFIX = "#webclient-CompuTecWebClientStart-CompuTecWebClientStart";
+    exports.default = WebClientNavigationHelper;
+});

package/dist-amd/index.d.ts

@@ -0,0 +1,37 @@
+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 WebClientNavigationHelper } from './helpers/WebClientNavigationHelper';
+export * from './helpers/WebClientNavigationHelper';
+export { default as AppEngineConfiguration } from './models/AppEngineConfiguration';
+export * from './models/AppEngineConfiguration';
+export { default as AppEngineException } from './models/AppEngineException';
+export * from './models/AppEngineException';
+export { default as DocumentedException } from './models/DocumentedException';
+export * from './models/DocumentedException';
+export { default as BaseBusinessObject } from './models/BaseBusinessObject';
+export * from './models/BaseBusinessObject';
+export { default as CompanyInfo } from './models/CompanyInfo';
+export * from './models/CompanyInfo';
+export { default as HeadersContentTypeEnum } from './models/enums/HeadersContentTypeEnum';
+export * from './models/enums/HeadersContentTypeEnum';
+export * from './models/enums/StorageTypeEnum';
+export { default as IAppEngineConfiguration } from './models/interfaces/IAppEngineConfiguration';
+export * from './models/interfaces/IAppEngineConfiguration';
+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';
+export { default as UserInfo } from './models/UserInfo';
+export * from './models/UserInfo';
+export { default as Version } from './models/Version';
+export * from './models/Version';
+//# sourceMappingURL=index.d.ts.map

package/dist-amd/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,yBAAyB,EAAE,MAAM,qCAAqC,CAAC;AAC3F,cAAc,qCAAqC,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACpF,cAAc,iCAAiC,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAC5E,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAC9E,cAAc,8BAA8B,CAAC;AAC7C,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAC5E,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAC9D,cAAc,sBAAsB,CAAC;AACrC,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAC1F,cAAc,uCAAuC,CAAC;AACtD,cAAc,gCAAgC,CAAC;AAC/C,OAAO,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACjG,cAAc,6CAA6C,CAAC;AAC5D,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;AACjC,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACxD,cAAc,mBAAmB,CAAC;AAClC,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACtD,cAAc,kBAAkB,CAAC"}

package/dist-amd/index.js

@@ -0,0 +1,56 @@
+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 };
+};
+define(["require", "exports", "./communication/HttpClient", "./communication/HttpClient", "./communication/HttpClientCacheOptions", "./communication/HttpClientCacheOptions", "./communication/IBaseHttpClientOptions", "./helpers/ErrorHelper", "./helpers/ErrorHelper", "./helpers/HttpClientHelper", "./helpers/HttpClientHelper", "./helpers/WebClientNavigationHelper", "./helpers/WebClientNavigationHelper", "./models/AppEngineConfiguration", "./models/AppEngineConfiguration", "./models/AppEngineException", "./models/AppEngineException", "./models/DocumentedException", "./models/DocumentedException", "./models/BaseBusinessObject", "./models/BaseBusinessObject", "./models/CompanyInfo", "./models/CompanyInfo", "./models/enums/HeadersContentTypeEnum", "./models/enums/HeadersContentTypeEnum", "./models/enums/StorageTypeEnum", "./models/interfaces/IAppEngineConfiguration", "./models/interfaces/IAppEngineException", "./models/LocalStorage", "./models/LocalStorage", "./models/Session", "./models/Session", "./models/UserInfo", "./models/UserInfo", "./models/Version", "./models/Version"], function (require, exports, HttpClient_1, HttpClient_2, HttpClientCacheOptions_1, HttpClientCacheOptions_2, IBaseHttpClientOptions_1, ErrorHelper_1, ErrorHelper_2, HttpClientHelper_1, HttpClientHelper_2, WebClientNavigationHelper_1, WebClientNavigationHelper_2, AppEngineConfiguration_1, AppEngineConfiguration_2, AppEngineException_1, AppEngineException_2, DocumentedException_1, DocumentedException_2, BaseBusinessObject_1, BaseBusinessObject_2, CompanyInfo_1, CompanyInfo_2, HeadersContentTypeEnum_1, HeadersContentTypeEnum_2, StorageTypeEnum_1, IAppEngineConfiguration_1, IAppEngineException_1, LocalStorage_1, LocalStorage_2, Session_1, Session_2, UserInfo_1, UserInfo_2, Version_1, Version_2) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.Version = exports.UserInfo = exports.Session = exports.LocalStorage = exports.HeadersContentTypeEnum = exports.CompanyInfo = exports.BaseBusinessObject = exports.DocumentedException = exports.AppEngineException = exports.AppEngineConfiguration = exports.WebClientNavigationHelper = exports.HttpClientHelper = exports.ErrorHelper = exports.HttpClientCacheOptions = exports.HttpClient = void 0;
+    Object.defineProperty(exports, "HttpClient", { enumerable: true, get: function () { return __importDefault(HttpClient_1).default; } });
+    __exportStar(HttpClient_2, exports);
+    Object.defineProperty(exports, "HttpClientCacheOptions", { enumerable: true, get: function () { return __importDefault(HttpClientCacheOptions_1).default; } });
+    __exportStar(HttpClientCacheOptions_2, exports);
+    __exportStar(IBaseHttpClientOptions_1, exports);
+    Object.defineProperty(exports, "ErrorHelper", { enumerable: true, get: function () { return __importDefault(ErrorHelper_1).default; } });
+    __exportStar(ErrorHelper_2, exports);
+    Object.defineProperty(exports, "HttpClientHelper", { enumerable: true, get: function () { return __importDefault(HttpClientHelper_1).default; } });
+    __exportStar(HttpClientHelper_2, exports);
+    Object.defineProperty(exports, "WebClientNavigationHelper", { enumerable: true, get: function () { return __importDefault(WebClientNavigationHelper_1).default; } });
+    __exportStar(WebClientNavigationHelper_2, exports);
+    Object.defineProperty(exports, "AppEngineConfiguration", { enumerable: true, get: function () { return __importDefault(AppEngineConfiguration_1).default; } });
+    __exportStar(AppEngineConfiguration_2, exports);
+    Object.defineProperty(exports, "AppEngineException", { enumerable: true, get: function () { return __importDefault(AppEngineException_1).default; } });
+    __exportStar(AppEngineException_2, exports);
+    Object.defineProperty(exports, "DocumentedException", { enumerable: true, get: function () { return __importDefault(DocumentedException_1).default; } });
+    __exportStar(DocumentedException_2, exports);
+    Object.defineProperty(exports, "BaseBusinessObject", { enumerable: true, get: function () { return __importDefault(BaseBusinessObject_1).default; } });
+    __exportStar(BaseBusinessObject_2, exports);
+    Object.defineProperty(exports, "CompanyInfo", { enumerable: true, get: function () { return __importDefault(CompanyInfo_1).default; } });
+    __exportStar(CompanyInfo_2, exports);
+    Object.defineProperty(exports, "HeadersContentTypeEnum", { enumerable: true, get: function () { return __importDefault(HeadersContentTypeEnum_1).default; } });
+    __exportStar(HeadersContentTypeEnum_2, exports);
+    __exportStar(StorageTypeEnum_1, exports);
+    __exportStar(IAppEngineConfiguration_1, exports);
+    __exportStar(IAppEngineException_1, exports);
+    Object.defineProperty(exports, "LocalStorage", { enumerable: true, get: function () { return __importDefault(LocalStorage_1).default; } });
+    __exportStar(LocalStorage_2, exports);
+    Object.defineProperty(exports, "Session", { enumerable: true, get: function () { return __importDefault(Session_1).default; } });
+    __exportStar(Session_2, exports);
+    Object.defineProperty(exports, "UserInfo", { enumerable: true, get: function () { return __importDefault(UserInfo_1).default; } });
+    __exportStar(UserInfo_2, exports);
+    Object.defineProperty(exports, "Version", { enumerable: true, get: function () { return __importDefault(Version_1).default; } });
+    __exportStar(Version_2, exports);
+});

package/dist-amd/models/AppEngineConfiguration.d.ts

@@ -0,0 +1,26 @@
+import BaseBusinessObject from "./BaseBusinessObject";
+import IAppEngineConfiguration from "./interfaces/IAppEngineConfiguration";
+export default class AppEngineConfiguration extends BaseBusinessObject implements IAppEngineConfiguration {
+    Code: number;
+    Name?: string;
+    U_CoreVersion?: string;
+    U_CoreDbVersion?: string;
+    U_AESrvAddr?: string;
+    U_LicenseServer?: string;
+    U_CompanyGuid?: string;
+    U_ApiKey?: string;
+    U_CmdTimeout?: number;
+    U_ConnTimeout?: number;
+    U_MaxPoolSize?: number;
+    U_MinPoolSize?: number;
+    U_AStartDate?: Date;
+    U_AEndDate?: Date;
+    U_OpeningMode?: string;
+    U_TimeZone?: string;
+    U_SldServer?: string;
+    U_SapLicenseServer?: string;
+    U_ApiGatewayAddress?: string;
+    U_SLServer?: string;
+    U_GMapAPIKey: string;
+}
+//# sourceMappingURL=AppEngineConfiguration.d.ts.map

package/dist-amd/models/AppEngineConfiguration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppEngineConfiguration.d.ts","sourceRoot":"","sources":["../../src/models/AppEngineConfiguration.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AACtD,OAAO,uBAAuB,MAAM,sCAAsC,CAAC;AAE3E,MAAM,CAAC,OAAO,OAAO,sBACpB,SAAQ,kBACR,YAAW,uBAAuB;IAElC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACrB"}

package/dist-amd/models/AppEngineConfiguration.js

@@ -0,0 +1,11 @@
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+define(["require", "exports", "./BaseBusinessObject"], function (require, exports, BaseBusinessObject_1) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    BaseBusinessObject_1 = __importDefault(BaseBusinessObject_1);
+    class AppEngineConfiguration extends BaseBusinessObject_1.default {
+    }
+    exports.default = AppEngineConfiguration;
+});

package/dist-amd/models/AppEngineException.d.ts

@@ -0,0 +1,21 @@
+import BaseError from "./BaseError";
+import IAppEngineException from "./interfaces/IAppEngineException";
+/**
+ * Concrete implementation of AppEngine-specific exceptions.
+ * Handles business logic errors and application-specific error conditions
+ * with structured Title and Detail information following RFC 7807 principles.
+ *
+ * @extends BaseError
+ * @implements IAppEngineException
+ */
+export default class AppEngineException extends BaseError implements IAppEngineException {
+    protected static exceptionName: string;
+    Title: string;
+    Detail: string;
+    constructor(error?: any);
+    fillData(data: Record<string, unknown> | object): this;
+    get message(): string;
+    get error(): this;
+    static is(obj: any): obj is IAppEngineException;
+}
+//# sourceMappingURL=AppEngineException.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AppEngineException.d.ts","sourceRoot":"","sources":["../../src/models/AppEngineException.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,mBAAmB,MAAM,kCAAkC,CAAC;AAEnE;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,SAAU,YAAW,mBAAmB;IACvF,SAAS,CAAC,MAAM,CAAC,aAAa,EAAE,MAAM,CAAwB;IAC9D,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;gBAEH,KAAK,CAAC,EAAE,GAAG;IAQvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,IAAI;IAMtD,IAAI,OAAO,WAEV;IAED,IAAI,KAAK,SAER;IAED,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,mBAAmB;CAW/C"}

package/dist-amd/models/AppEngineException.js

@@ -0,0 +1,46 @@
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+define(["require", "exports", "./BaseError"], function (require, exports, BaseError_1) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    BaseError_1 = __importDefault(BaseError_1);
+    /**
+     * Concrete implementation of AppEngine-specific exceptions.
+     * Handles business logic errors and application-specific error conditions
+     * with structured Title and Detail information following RFC 7807 principles.
+     *
+     * @extends BaseError
+     * @implements IAppEngineException
+     */
+    class AppEngineException extends BaseError_1.default {
+        constructor(error) {
+            super();
+            if (error) {
+                this.Title = error.Title;
+                this.Detail = error.Detail;
+            }
+        }
+        fillData(data) {
+            super.fillData(data);
+            return this;
+        }
+        get message() {
+            return this.Detail;
+        }
+        get error() {
+            return this;
+        }
+        static is(obj) {
+            if (typeof obj !== "object" || obj === null)
+                return false;
+            const candidate = obj;
+            return ("Title" in candidate &&
+                typeof candidate.Title === "string" &&
+                "Detail" in candidate &&
+                typeof candidate.Detail === "string" && candidate.Title === this.exceptionName);
+        }
+    }
+    AppEngineException.exceptionName = "AppEngineException";
+    exports.default = AppEngineException;
+});

package/dist-amd/models/BaseBusinessObject.d.ts

@@ -0,0 +1,157 @@
+export 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>;
+}
+//# sourceMappingURL=BaseBusinessObject.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BaseBusinessObject.d.ts","sourceRoot":"","sources":["../../src/models/BaseBusinessObject.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,kBAAkB,IAAI;IACxE,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"}