@frankieone/one-sdk 0.0.1-npm

package/dist/esm/modules/common/modules/vendorLoading.d.ts

@@ -0,0 +1,109 @@
+import type { Modules } from '../../config/index.js';
+import type { ModuleDefinition } from '../types';
+import { type InjectedState } from '../types';
+import type { Dictionary } from '../../../types/index.js';
+import type { EventHub } from './eventHub';
+/**
+ * Helper Closure function that defines a common logic to load and initialise vendor wrappers
+ * as well as the events that are emitted in the process.
+ *
+ * This function (the factory) returns another function (the loader)
+ *
+ * The factory takes as parameters an object containing:
+ * 1. sharedConfiguration: InjectedState, provided to all modules by default
+ * 2. vendorName: string,
+ * 3. vendorLoader: Function which parameters are
+ *      - initialOptions: { sharedConfiguration vendorName }, provided above
+ *      - wrapperOptions: options provided later to the loader function
+ *      returns the loaded vendor wrapper module containing a function called "initialise"
+ *
+ * The loader takes as parameters an object containing:
+ * 1. vendorWrapperOptions: Function which parameters are
+ *      - initialOptions: { sharedConfiguration, vendorName }
+ *      returns an object matching the required options passed to the "initialise" function mentioned above
+ * 2. "onSuccess" will be called with the Vendor Wrapper Context object as well as other parameters provided above. TBC
+ * 3. "onError" will be called with the Error object as well as other parameters provided above. TBC
+ *
+ * OBS 1: You may interrupt the initialisation chain by throwing an error or returning a rejected promise from any of the provided functions.
+ * OBS 2: Both vendorLoader and vendorWrapperOptions accept a shortcut version of their function
+ *    - vendorLoader may be provided as a dictionary mapping vendorName to a dynamic import function
+ *        ex: {
+ *              vendorABC: () => import("relative file path or url to the vendor module exporting a 'initialise' function"),
+ *              vendorXYZ: () => import("relative file path or url to the vendor module exporting a 'initialise' function"),
+ *            }
+ *
+ *    - vendorWrapperOptions may be provided as simply an object to be passed to the "initialise" function
+ *
+ * OBS 3: The vendor wrapper initialise function actually takes two parameters
+ *    sharedConfiguration, which is provided by default
+ *    vendorWrapperOptions, which is provided in the homonimous parameters of the loader function
+ *
+ * @param loaderOpts Required options for loading and initialising vendor wrappers
+ *
+ * @param options.vendorLoader ({ vendorName, sharedConfiguration }) => VendorModule OR Dictionary<VendorName, () => VendorModule
+ * @param options.onSuccess What happens after initialising the wrapperContext. Takes the context object as parameter
+ * @param options.onError What happens when an error is captured anywhere in the process. Takes the error object as parameter
+ *
+ * This function is a factory for the actual loader, with the signature
+ * 1) First generate the Vendor Wrapper Loader
+ * const loadVendor = mkVendorLoader(...options);
+ * 2) When its time, call the assynchronous vendorLoader
+ * const wrapperContext = await loadVendor(...options);
+ * 3) Subsequent calls to loadVendor will returned a cached wrapperContext object.
+ * wrapperContext === await loadVendor();
+ */
+export declare function mkVendorLoader<WrapperOptions extends Dictionary, WrapperContext, VendorName extends string>(loaderOpts: LoaderOptions<VendorName> & VendorLoaderOptions<WrapperOptions, WrapperContext, VendorName>): VendorLoader<WrapperOptions, WrapperContext, VendorName>;
+/**
+ * The `VendorLoader` is a function that takes as parameter a `Callbacks` object and returns a Promise of the Vendor `WrapperContext` object
+ * When wrapper doesn't have options, than `Callbacks` object is optional, since there's no `vendorWrapperOptions` to be provided
+ */
+export type VendorLoader<WrapperOptions extends Dictionary, WrapperContext, VendorName extends string> = (cs: Callbacks<WrapperOptions, WrapperContext, VendorName>) => Promise<WrapperContext>;
+/** Type VendorLoader function for a particula ModuleDefinition. Module["wrapperOptions"] must contain "eventHub".
+ * TODO: take eventHub from the sharedDependencies instead of the wrapperOptions
+ **/
+export type ModuleVendorLoader<M extends ModuleDefinition> = VendorLoader<M['wrapperOptions'], M['wrapperContext'], M['vendorName']>;
+export type RequiredEvents = {
+    vendor_sdk_loaded: [
+        {
+            componentName: Modules['moduleName'] | 'individual';
+            instanceName: string;
+            vendor: string;
+        }
+    ];
+    vendor_sdk_failed_loading: [{
+        vendor: string;
+        errorObject: unknown;
+    }];
+    error: [{
+        message: string;
+        payload: unknown;
+    }];
+};
+type VendorWrapperImport<Opts, Ctx> = Promise<{
+    initialise: (b: InjectedState, o: Opts) => Ctx | Promise<Ctx>;
+}>;
+type VendorWrapperImporter<Opts, Ctx, VendorName extends string> = (loaderOpts: LoaderOptions<VendorName>, wrapperOpts: Opts) => VendorWrapperImport<Opts, Ctx>;
+type VendorLoaderOptions<Opts, Ctx, VendorName extends string> = {
+    vendorLoader: VendorWrapperImporter<Opts, Ctx, VendorName> | Record<VendorName, VendorWrapperImporter<Opts, Ctx, VendorName> | null>;
+};
+type LoaderOptions<VendorName extends string> = {
+    vendorName: VendorName;
+    sharedConfiguration: InjectedState;
+};
+type RequiredDependencies = {
+    eventHub: EventHub<RequiredEvents>;
+};
+type MergedDependencies<WrapperOptions> = WrapperOptions & RequiredDependencies;
+/**
+ * Callbacks object containing:
+ * 1. vendorWrapperOptions: Function returning a `VendorWrapper` options object or the object itself
+ * 2. onSuccess: Function called when the vendor wrapper is successfully initialised
+ * 3. onError: Function called when an error is captured anywhere in the process
+ */
+type Callbacks<WrapperOptions extends Dictionary, Ctx, VendorName extends string> = {
+    onSuccess?: (context: Ctx, loaderOpts: LoaderOptions<VendorName>, wrapperOpts: WrapperOptions) => void;
+    onError?: (error: Error, loaderOpts: LoaderOptions<VendorName>, wrapperOpts: WrapperOptions) => void;
+    vendorWrapperOptions: MergedDependencies<WrapperOptions> | ((loaderOpts: LoaderOptions<VendorName>) => MergedDependencies<WrapperOptions>);
+};
+export {};
+//# sourceMappingURL=vendorLoading.d.ts.map

package/dist/esm/modules/common/modules/vendorLoading.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vendorLoading.d.ts","sourceRoot":"","sources":["../../../../../modules/common/modules/vendorLoading.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAIzC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,wBAAgB,cAAc,CAAC,cAAc,SAAS,UAAU,EAAE,cAAc,EAAE,UAAU,SAAS,MAAM,EACzG,UAAU,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,mBAAmB,CAAC,cAAc,EAAE,cAAc,EAAE,UAAU,CAAC,GACtG,YAAY,CAAC,cAAc,EAAE,cAAc,EAAE,UAAU,CAAC,CA8G1D;AAMD;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,cAAc,SAAS,UAAU,EAAE,cAAc,EAAE,UAAU,SAAS,MAAM,IAAI,CACvG,EAAE,EAAE,SAAS,CAAC,cAAc,EAAE,cAAc,EAAE,UAAU,CAAC,KACtD,OAAO,CAAC,cAAc,CAAC,CAAC;AAC7B;;IAEI;AACJ,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,gBAAgB,IAAI,YAAY,CACvE,CAAC,CAAC,gBAAgB,CAAC,EACnB,CAAC,CAAC,gBAAgB,CAAC,EACnB,CAAC,CAAC,YAAY,CAAC,CAChB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,iBAAiB,EAAE;QACjB;YACE,aAAa,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,YAAY,CAAC;YACpD,YAAY,EAAE,MAAM,CAAC;YACrB,MAAM,EAAE,MAAM,CAAC;SAChB;KACF,CAAC;IACF,yBAAyB,EAAE,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IACtE,KAAK,EAAE,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;CAChD,CAAC;AAEF,KAAK,mBAAmB,CAAC,IAAI,EAAE,GAAG,IAAI,OAAO,CAAC;IAC5C,UAAU,EAAE,CAAC,CAAC,EAAE,aAAa,EAAE,CAAC,EAAE,IAAI,KAAK,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CAC/D,CAAC,CAAC;AACH,KAAK,qBAAqB,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,SAAS,MAAM,IAAI,CACjE,UAAU,EAAE,aAAa,CAAC,UAAU,CAAC,EACrC,WAAW,EAAE,IAAI,KACd,mBAAmB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAEpC,KAAK,mBAAmB,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,SAAS,MAAM,IAAI;IAC/D,YAAY,EACR,qBAAqB,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,CAAC,GAC5C,MAAM,CAAC,UAAU,EAAE,qBAAqB,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;CAC7E,CAAC;AAEF,KAAK,aAAa,CAAC,UAAU,SAAS,MAAM,IAAI;IAC9C,UAAU,EAAE,UAAU,CAAC;IACvB,mBAAmB,EAAE,aAAa,CAAC;CACpC,CAAC;AAKF,KAAK,oBAAoB,GAAG;IAC1B,QAAQ,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;CACpC,CAAC;AACF,KAAK,kBAAkB,CAAC,cAAc,IAAI,cAAc,GAAG,oBAAoB,CAAC;AAChF;;;;;GAKG;AACH,KAAK,SAAS,CAAC,cAAc,SAAS,UAAU,EAAE,GAAG,EAAE,UAAU,SAAS,MAAM,IAAI;IAClF,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,aAAa,CAAC,UAAU,CAAC,EAAE,WAAW,EAAE,cAAc,KAAK,IAAI,CAAC;IACvG,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,aAAa,CAAC,UAAU,CAAC,EAAE,WAAW,EAAE,cAAc,KAAK,IAAI,CAAC;IACrG,oBAAoB,EAChB,kBAAkB,CAAC,cAAc,CAAC,GAClC,CAAC,CAAC,UAAU,EAAE,aAAa,CAAC,UAAU,CAAC,KAAK,kBAAkB,CAAC,cAAc,CAAC,CAAC,CAAC;CACrF,CAAC"}

package/dist/esm/modules/common/modules/vendorLoading.js

@@ -0,0 +1,153 @@
+import { OneSDKError } from '../errors/OneSDKError.class.js';
+/**
+ * Helper Closure function that defines a common logic to load and initialise vendor wrappers
+ * as well as the events that are emitted in the process.
+ *
+ * This function (the factory) returns another function (the loader)
+ *
+ * The factory takes as parameters an object containing:
+ * 1. sharedConfiguration: InjectedState, provided to all modules by default
+ * 2. vendorName: string,
+ * 3. vendorLoader: Function which parameters are
+ *      - initialOptions: { sharedConfiguration vendorName }, provided above
+ *      - wrapperOptions: options provided later to the loader function
+ *      returns the loaded vendor wrapper module containing a function called "initialise"
+ *
+ * The loader takes as parameters an object containing:
+ * 1. vendorWrapperOptions: Function which parameters are
+ *      - initialOptions: { sharedConfiguration, vendorName }
+ *      returns an object matching the required options passed to the "initialise" function mentioned above
+ * 2. "onSuccess" will be called with the Vendor Wrapper Context object as well as other parameters provided above. TBC
+ * 3. "onError" will be called with the Error object as well as other parameters provided above. TBC
+ *
+ * OBS 1: You may interrupt the initialisation chain by throwing an error or returning a rejected promise from any of the provided functions.
+ * OBS 2: Both vendorLoader and vendorWrapperOptions accept a shortcut version of their function
+ *    - vendorLoader may be provided as a dictionary mapping vendorName to a dynamic import function
+ *        ex: {
+ *              vendorABC: () => import("relative file path or url to the vendor module exporting a 'initialise' function"),
+ *              vendorXYZ: () => import("relative file path or url to the vendor module exporting a 'initialise' function"),
+ *            }
+ *
+ *    - vendorWrapperOptions may be provided as simply an object to be passed to the "initialise" function
+ *
+ * OBS 3: The vendor wrapper initialise function actually takes two parameters
+ *    sharedConfiguration, which is provided by default
+ *    vendorWrapperOptions, which is provided in the homonimous parameters of the loader function
+ *
+ * @param loaderOpts Required options for loading and initialising vendor wrappers
+ *
+ * @param options.vendorLoader ({ vendorName, sharedConfiguration }) => VendorModule OR Dictionary<VendorName, () => VendorModule
+ * @param options.onSuccess What happens after initialising the wrapperContext. Takes the context object as parameter
+ * @param options.onError What happens when an error is captured anywhere in the process. Takes the error object as parameter
+ *
+ * This function is a factory for the actual loader, with the signature
+ * 1) First generate the Vendor Wrapper Loader
+ * const loadVendor = mkVendorLoader(...options);
+ * 2) When its time, call the assynchronous vendorLoader
+ * const wrapperContext = await loadVendor(...options);
+ * 3) Subsequent calls to loadVendor will returned a cached wrapperContext object.
+ * wrapperContext === await loadVendor();
+ */
+export function mkVendorLoader(loaderOpts) {
+    const { vendorLoader, sharedConfiguration, vendorName } = loaderOpts;
+    const { globalEventHub, moduleMeta: { moduleName, instanceName }, } = sharedConfiguration;
+    // Store "telemetry-event-friendly" formatted component name for later use
+    const COMPONENT = moduleName.toUpperCase();
+    // Cache loaded context
+    // let theLoadedContext: WrapperContext;
+    // LoadTimeDependencies is the options passed to the wrapper at load time + eventHub + callbacks
+    const load = (callbacks) => {
+        const { onError = () => void 0, onSuccess = () => void 0, vendorWrapperOptions } = callbacks;
+        // vendorWrapperOptions may be provided as either an object or a function that returns an object
+        // That object will be merged with the initialOptions.inject object and sent throught the chain of callbacks
+        // to be then used to initialise the vendor wrapper as the wrapperOptions object
+        const wrapperOpts = isOptionsObject(vendorWrapperOptions) ? vendorWrapperOptions : vendorWrapperOptions(loaderOpts);
+        // The vendorLoader may be provided as either a function that returns a Module object which exports an "initialise" function
+        // or as a dictionary of VendorName and a function without parameter that dynamically loads and returns said Module object
+        // If passed as a function, the vendorLoader will be called with
+        // --- 1) the object initialOptions { sharedConfiguration, vendorName, inject }
+        // --- 2) the object wrapperOptions, containing the wrapper initialisation options + the extra dependencies (eventHub and others)
+        // When importing a module, include a webpackChunkName magic comment to beautify the file output and facilitate debugging
+        // import(/* webpackChunkName: 'debug-friendly-name' */ "path/to/wrapper/file.ts")
+        // This import is in the format { initialise: VendorWrapperInitialiseFunction }, where
+        // VendorWrapperInitialiseFunction = (InjectedState, WrapperOptions) => WrapperContext
+        const vendorImporter = typeof vendorLoader === 'function' ? vendorLoader : vendorLoader[vendorName];
+        const { eventHub } = wrapperOpts;
+        return (Promise.resolve(vendorImporter === null || vendorImporter === void 0 ? void 0 : vendorImporter(loaderOpts, wrapperOpts))
+            .then((vendorWrapper) => {
+            const isDictionaryLoader = typeof vendorLoader === 'object';
+            // If resulting loaded VendorModule is null, then it explicitly doesn't have a wrapper to be loaded
+            if (vendorWrapper === null) {
+                const errorMessage = `Vendor '${vendorName}' doesn't have a wrapper to be loaded. Maybe it's a headless vendor.`;
+                throw new Error(errorMessage);
+            }
+            // If resulting loaded VendorModule is not listed/undefined, throw error
+            if (!vendorWrapper) {
+                let errorMessage = `Vendor '${vendorName}' not recognised in ${COMPONENT}.`;
+                if (isDictionaryLoader)
+                    errorMessage += ` Found keys were ${JSON.stringify(Object.keys(vendorLoader))}`;
+                throw new Error(errorMessage);
+            }
+            // If loaded VendorModule doesn't contain an initialise function, throw error
+            if (!vendorWrapper.initialise) {
+                const errorMessage = `Loaded vendor module '${vendorName}' doesn't contain an 'initialise' function`;
+                throw new Error(errorMessage);
+            }
+            return vendorWrapper;
+        })
+            // If there were no issues loading the vendor module, initialise it with the provided options
+            .then((vendorWrapper) => vendorWrapper.initialise(sharedConfiguration, wrapperOpts))
+            // After initialising the vendor wrapper, which will load any required extra vendor dependencies
+            // Conclude the process by emitting events and calling the onSuccess or the onError callbacks
+            .then((wrapperContext) => {
+            eventHub.emit('vendor_sdk_loaded', {
+                componentName: moduleName,
+                instanceName,
+                vendor: loaderOpts.vendorName,
+            });
+            globalEventHub.emit('telemetry', {
+                eventName: `${COMPONENT}:VENDOR_WRAPPER_LOADED`,
+                data: {
+                    instanceName: instanceName,
+                    vendor: loaderOpts.vendorName,
+                },
+            });
+            onSuccess(wrapperContext, loaderOpts, wrapperOpts);
+            // theLoadedContext = wrapperContext;
+            // Vendor Wrapper Context is provided to the onSuccess callback and
+            // also returned from the function call wrapped in a Promise
+            return wrapperContext;
+        })
+            .catch((errorObject) => {
+            const oneSdkError = new OneSDKError(`Vendor sdk '${loaderOpts.vendorName}' failed loading`, {
+                errorObject,
+                vendor: loaderOpts.vendorName,
+            });
+            eventHub.emit('vendor_sdk_failed_loading', {
+                vendor: loaderOpts.vendorName,
+                errorObject,
+            });
+            eventHub.emit('error', oneSdkError);
+            globalEventHub.emit('telemetry', {
+                eventName: `${COMPONENT}:VENDOR_FAILED_LOADING`,
+                data: {
+                    instanceName: instanceName,
+                    vendor: loaderOpts.vendorName,
+                },
+                error: errorObject,
+            });
+            onError(errorObject, loaderOpts, wrapperOpts);
+            return null;
+        }));
+    };
+    // What happens when calling the loader function
+    return (callbacks) => {
+        // TODO:
+        // If vendor wrapper is already cached internally, simply resolve to it without reloading anything else
+        // if (theLoadedContext) return Promise.resolve(theLoadedContext);
+        // Otherwise trigger the callback chain defined in "load"
+        return load(callbacks);
+    };
+}
+const isOptionsObject = (opts) => typeof opts === 'object' && typeof opts.eventHub !== 'undefined';
+//# sourceMappingURL=vendorLoading.js.map

package/dist/esm/modules/common/modules/vendorLoading.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vendorLoading.js","sourceRoot":"","sources":["../../../../../modules/common/modules/vendorLoading.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAI1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,UAAU,cAAc,CAC5B,UAAuG;IAEvG,MAAM,EAAE,YAAY,EAAE,mBAAmB,EAAE,UAAU,EAAE,GAAG,UAAU,CAAC;IACrE,MAAM,EACJ,cAAc,EACd,UAAU,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,GACzC,GAAG,mBAAmB,CAAC;IACxB,0EAA0E;IAC1E,MAAM,SAAS,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC;IAC3C,uBAAuB;IACvB,wCAAwC;IACxC,gGAAgG;IAChG,MAAM,IAAI,GAAG,CAAC,SAAgE,EAAE,EAAE;QAChF,MAAM,EAAE,OAAO,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,SAAS,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,oBAAoB,EAAE,GAAG,SAAS,CAAC;QAE7F,gGAAgG;QAChG,4GAA4G;QAC5G,gFAAgF;QAChF,MAAM,WAAW,GAAG,eAAe,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACpH,4HAA4H;QAC5H,0HAA0H;QAC1H,gEAAgE;QAChE,+EAA+E;QAC/E,iIAAiI;QACjI,yHAAyH;QACzH,kFAAkF;QAClF,sFAAsF;QACtF,sFAAsF;QACtF,MAAM,cAAc,GAClB,OAAO,YAAY,KAAK,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAE/E,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC;QAEjC,OAAO,CACL,OAAO,CAAC,OAAO,CAAC,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAG,UAAU,EAAE,WAAW,CAAC,CAAC;aACvD,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE;YACtB,MAAM,kBAAkB,GAAG,OAAO,YAAY,KAAK,QAAQ,CAAC;YAE5D,mGAAmG;YACnG,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;gBAC3B,MAAM,YAAY,GAAG,WAAW,UAAU,sEAAsE,CAAC;gBACjH,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;YAChC,CAAC;YACD,wEAAwE;YACxE,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,IAAI,YAAY,GAAG,WAAW,UAAU,uBAAuB,SAAS,GAAG,CAAC;gBAC5E,IAAI,kBAAkB;oBAAE,YAAY,IAAI,oBAAoB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;gBACxG,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;YAChC,CAAC;YACD,6EAA6E;YAC7E,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC;gBAC9B,MAAM,YAAY,GAAG,yBAAyB,UAAU,4CAA4C,CAAC;gBACrG,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;YAChC,CAAC;YACD,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC;YACF,6FAA6F;aAC5F,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,UAAU,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC;YACpF,gGAAgG;YAChG,6FAA6F;aAC5F,IAAI,CAAC,CAAC,cAAc,EAAE,EAAE;YACvB,QAAQ,CAAC,IAAI,CAAC,mBAAmB,EAAE;gBACjC,aAAa,EAAE,UAAU;gBACzB,YAAY;gBACZ,MAAM,EAAE,UAAU,CAAC,UAAU;aAC9B,CAAC,CAAC;YACH,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;gBAC/B,SAAS,EAAE,GAAG,SAAS,wBAAwB;gBAC/C,IAAI,EAAE;oBACJ,YAAY,EAAE,YAAY;oBAC1B,MAAM,EAAE,UAAU,CAAC,UAAU;iBAC9B;aACF,CAAC,CAAC;YAEH,SAAS,CAAC,cAAc,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;YACnD,qCAAqC;YACrC,mEAAmE;YACnE,4DAA4D;YAC5D,OAAO,cAAc,CAAC;QACxB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,WAAW,EAAE,EAAE;YACrB,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,eAAe,UAAU,CAAC,UAAU,kBAAkB,EAAE;gBAC1F,WAAW;gBACX,MAAM,EAAE,UAAU,CAAC,UAAU;aAC9B,CAAC,CAAC;YACH,QAAQ,CAAC,IAAI,CAAC,2BAA2B,EAAE;gBACzC,MAAM,EAAE,UAAU,CAAC,UAAU;gBAC7B,WAAW;aACZ,CAAC,CAAC;YACH,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YACpC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;gBAC/B,SAAS,EAAE,GAAG,SAAS,wBAAwB;gBAC/C,IAAI,EAAE;oBACJ,YAAY,EAAE,YAAY;oBAC1B,MAAM,EAAE,UAAU,CAAC,UAAU;iBAC9B;gBACD,KAAK,EAAE,WAAW;aACnB,CAAC,CAAC;YACH,OAAO,CAAC,WAAW,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;YAC9C,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CACL,CAAC;IACJ,CAAC,CAAC;IACF,gDAAgD;IAChD,OAAO,CAAC,SAAgE,EAAE,EAAE;QAC1E,QAAQ;QACR,uGAAuG;QACvG,kEAAkE;QAClE,yDAAyD;QACzD,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC;IACzB,CAAC,CAAC;AACJ,CAAC;AAqDD,MAAM,eAAe,GAAG,CAAC,IAAI,EAAgC,EAAE,CAC7D,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,WAAW,CAAC"}

package/dist/esm/modules/common/shared/KvpList.d.ts

@@ -0,0 +1,30 @@
+import { Kvp } from "./models/general";
+type KvpType = Kvp["kvpType"];
+export declare class KvpList {
+    private list;
+    constructor(list?: Kvp[]);
+    static convertToType(v?: string, _t?: KvpType): string;
+    deleteEntry(key: any): void;
+    findKvpObject(key: string | RegExp): Kvp | null;
+    findKvpValue(key: string | RegExp): string | null;
+    findNumericKvpValue(key: string): number | null;
+    findArrayKvpValue(key: string | RegExp): string[] | null;
+    findBooleanKvpValue(key: string): boolean | null;
+    filterKvpKeyByRegex(regex: RegExp): KvpList;
+    addKvp(kvp: Kvp): void;
+    replaceKvp(kvp: Kvp): void;
+    static mkKvp(k?: string, v?: any, t?: string, isStringify?: boolean): Kvp;
+    get transformed(): Kvp[];
+    toJSON(): Kvp[];
+    static fromJSON(list: Kvp[]): KvpList;
+    filter(cb: (e: Kvp) => boolean): KvpList;
+    toObject(): {
+        [key: string]: any;
+    };
+    get kvpList(): Kvp[];
+    static fromObject(obj: {
+        [key: string]: any;
+    }): KvpList;
+}
+export {};
+//# sourceMappingURL=KvpList.d.ts.map

package/dist/esm/modules/common/shared/KvpList.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KvpList.d.ts","sourceRoot":"","sources":["../../../../../modules/common/shared/KvpList.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AAEvC,KAAK,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC;AAC9B,qBAAa,OAAO;IAClB,OAAO,CAAC,IAAI,CAAQ;gBACR,IAAI,GAAE,GAAG,EAAO;IAG5B,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,GAAE,OAA0B;IAU/D,WAAW,CAAC,GAAG,KAAA;IAIf,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,GAAG,GAAG,IAAI;IAQ/C,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI;IAKjD,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAM/C,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI;IAMxD,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI;IAMhD,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAQ3C,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAGtB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAS1B,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,UAAO,GAAG,GAAG;IAatE,IAAI,WAAW,IAAI,GAAG,EAAE,CAIvB;IAED,MAAM,IAAI,GAAG,EAAE;IAIf,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;IAIrC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,OAAO;IAG9B,QAAQ,IAAI;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;IASlC,IAAI,OAAO,UAEV;IACD,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;CAM9C"}

package/dist/esm/modules/common/shared/KvpList.js

@@ -0,0 +1,140 @@
+export class KvpList {
+    constructor(list = []) {
+        Object.defineProperty(this, "list", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.list = list;
+    }
+    static convertToType(v, _t = "general.string") {
+        // replace undefined with null
+        if (!v)
+            return null;
+        return v;
+        // switch(t) {
+        //   case "general.string": return v;
+        //   case "general.datetime": return new Date(v);
+        //   default : JSON.parse(v);
+        // }
+    }
+    deleteEntry(key) {
+        const index = this.list.findIndex((kvp) => kvp.kvpKey === key);
+        if (index >= 0)
+            this.list.splice(index, 1);
+    }
+    findKvpObject(key) {
+        var _a;
+        if (typeof key === "string")
+            key = "^" + key + "$"; //Make string to find exact match
+        const kvpKeyExistsAndEquals = (kvpKey) => {
+            if (!kvpKey)
+                return false;
+            return kvpKey === null || kvpKey === void 0 ? void 0 : kvpKey.toLowerCase().match(new RegExp(key, "i"));
+        };
+        return ((_a = this.list) === null || _a === void 0 ? void 0 : _a.find(({ kvpKey }) => kvpKeyExistsAndEquals(kvpKey))) || null;
+    }
+    findKvpValue(key) {
+        var _a;
+        const kvp = this.findKvpObject(key);
+        if (kvp === null)
+            return null;
+        return (_a = kvp.kvpValue) !== null && _a !== void 0 ? _a : null;
+    }
+    findNumericKvpValue(key) {
+        const value = this.findKvpValue(key);
+        if (value === null)
+            return null;
+        if (value.length === 0)
+            return NaN;
+        return +value; // convert to number, either integer, float or NaN in case it's not a number
+    }
+    findArrayKvpValue(key) {
+        const value = this.findKvpValue(key);
+        if (value === null)
+            return null;
+        if (value.length === 0)
+            return [];
+        return value.split(",");
+    }
+    findBooleanKvpValue(key) {
+        const value = this.findKvpValue(key);
+        if (value === "true")
+            return true;
+        if (value === "false")
+            return false;
+        return null;
+    }
+    filterKvpKeyByRegex(regex) {
+        const cb = (kvp) => {
+            var _a;
+            const kvpKey = (_a = kvp.kvpKey) !== null && _a !== void 0 ? _a : null;
+            if (!kvpKey)
+                return false;
+            return regex.test(kvpKey);
+        };
+        return this.filter(cb);
+    }
+    addKvp(kvp) {
+        this.list.push(kvp);
+    }
+    replaceKvp(kvp) {
+        if (kvp.kvpKey && !this.findKvpValue(kvp.kvpKey))
+            return this.addKvp(kvp);
+        this.list.forEach((k) => {
+            var _a, _b;
+            if (k.kvpKey === kvp.kvpKey) {
+                k.kvpType = (_a = kvp.kvpType) !== null && _a !== void 0 ? _a : undefined;
+                k.kvpValue = (_b = kvp.kvpValue) !== null && _b !== void 0 ? _b : null;
+            }
+        });
+    }
+    static mkKvp(k, v, t, isStringify = true) {
+        if (!v)
+            v = ""; //value can not be null or undefined, must be an empty string
+        if (isStringify && typeof v !== "string") {
+            v = JSON.stringify(v);
+        }
+        const kvp = {
+            kvpKey: k,
+            kvpValue: v,
+        };
+        if (t)
+            kvp.kvpType = t;
+        return kvp;
+    }
+    get transformed() {
+        return this.list.map((kvp) => KvpList.mkKvp(kvp.kvpKey, KvpList.convertToType(kvp.kvpValue, kvp.kvpType), kvp.kvpType));
+    }
+    toJSON() {
+        return this.transformed;
+    }
+    static fromJSON(list) {
+        return new KvpList(list);
+    }
+    filter(cb) {
+        return new KvpList(this.list.filter(cb));
+    }
+    toObject() {
+        return this.list.reduce((carry, kvp) => {
+            var _a;
+            const key = kvp.kvpKey;
+            const value = (_a = kvp.kvpValue) !== null && _a !== void 0 ? _a : null;
+            if (!key)
+                return {};
+            carry[key] = value;
+            return carry;
+        }, {});
+    }
+    get kvpList() {
+        return this.list;
+    }
+    static fromObject(obj) {
+        const mkKvpFromEntries = (entry) => KvpList.mkKvp(entry[0], entry[1]);
+        const kvpEntries = Object.entries(obj);
+        const kvpList = kvpEntries.map(mkKvpFromEntries);
+        return new KvpList(kvpList);
+    }
+}
+//# sourceMappingURL=KvpList.js.map

package/dist/esm/modules/common/shared/KvpList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KvpList.js","sourceRoot":"","sources":["../../../../../modules/common/shared/KvpList.ts"],"names":[],"mappings":"AAGA,MAAM,OAAO,OAAO;IAElB,YAAY,OAAc,EAAE;QADpB;;;;;WAAY;QAElB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IACD,MAAM,CAAC,aAAa,CAAC,CAAU,EAAE,KAAc,gBAAgB;QAC7D,8BAA8B;QAC9B,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACpB,OAAO,CAAC,CAAC;QACT,cAAc;QACd,qCAAqC;QACrC,iDAAiD;QACjD,6BAA6B;QAC7B,IAAI;IACN,CAAC;IACD,WAAW,CAAC,GAAG;QACb,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAQ,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC;QACpE,IAAI,KAAK,IAAI,CAAC;YAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAC7C,CAAC;IACD,aAAa,CAAC,GAAoB;;QAChC,IAAI,OAAO,GAAG,KAAK,QAAQ;YAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,iCAAiC;QACrF,MAAM,qBAAqB,GAAG,CAAC,MAAM,EAAE,EAAE;YACvC,IAAI,CAAC,MAAM;gBAAE,OAAO,KAAK,CAAC;YAC1B,OAAO,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,GAAG,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QAC3D,CAAC,CAAC;QACF,OAAO,CAAA,MAAA,IAAI,CAAC,IAAI,0CAAE,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,KAAI,IAAI,CAAC;IAChF,CAAC;IACD,YAAY,CAAC,GAAoB;;QAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,GAAG,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC;QAC9B,OAAO,MAAA,GAAG,CAAC,QAAQ,mCAAI,IAAI,CAAC;IAC9B,CAAC;IACD,mBAAmB,CAAC,GAAW;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC;QAChC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,GAAG,CAAC;QACnC,OAAO,CAAC,KAAK,CAAC,CAAC,4EAA4E;IAC7F,CAAC;IACD,iBAAiB,CAAC,GAAoB;QACpC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC;QAChC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QAClC,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IACD,mBAAmB,CAAC,GAAW;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,KAAK,KAAK,MAAM;YAAE,OAAO,IAAI,CAAC;QAClC,IAAI,KAAK,KAAK,OAAO;YAAE,OAAO,KAAK,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IACD,mBAAmB,CAAC,KAAa;QAC/B,MAAM,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE;;YACjB,MAAM,MAAM,GAAG,MAAA,GAAG,CAAC,MAAM,mCAAI,IAAI,CAAC;YAClC,IAAI,CAAC,MAAM;gBAAE,OAAO,KAAK,CAAC;YAC1B,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACzB,CAAC;IACD,MAAM,CAAC,GAAQ;QACb,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtB,CAAC;IACD,UAAU,CAAC,GAAQ;QACjB,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC;YAAE,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1E,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;;YACtB,IAAI,CAAC,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE,CAAC;gBAC5B,CAAC,CAAC,OAAO,GAAG,MAAA,GAAG,CAAC,OAAO,mCAAI,SAAS,CAAC;gBACrC,CAAC,CAAC,QAAQ,GAAG,MAAA,GAAG,CAAC,QAAQ,mCAAI,IAAI,CAAC;YACpC,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IACD,MAAM,CAAC,KAAK,CAAC,CAAU,EAAE,CAAO,EAAE,CAAU,EAAE,WAAW,GAAG,IAAI;QAC9D,IAAI,CAAC,CAAC;YAAE,CAAC,GAAG,EAAE,CAAC,CAAC,6DAA6D;QAC7E,IAAI,WAAW,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YACzC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QACxB,CAAC;QAED,MAAM,GAAG,GAAG;YACV,MAAM,EAAE,CAAC;YACT,QAAQ,EAAE,CAAC;SACL,CAAC;QACT,IAAI,CAAC;YAAE,GAAG,CAAC,OAAO,GAAG,CAAC,CAAC;QACvB,OAAO,GAAG,CAAC;IACb,CAAC;IACD,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAC3B,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,CACzF,CAAC;IACJ,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,IAAW;QACzB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED,MAAM,CAAC,EAAuB;QAC5B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3C,CAAC;IACD,QAAQ;QACN,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,GAAQ,EAAE,EAAE;;YAC1C,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC;YACvB,MAAM,KAAK,GAAG,MAAA,GAAG,CAAC,QAAQ,mCAAI,IAAI,CAAC;YACnC,IAAI,CAAC,GAAG;gBAAE,OAAO,EAAE,CAAC;YACpB,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACnB,OAAO,KAAK,CAAC;QACf,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IACD,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IACD,MAAM,CAAC,UAAU,CAAC,GAA2B;QAC3C,MAAM,gBAAgB,GAAG,CAAC,KAAoB,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACrF,MAAM,UAAU,GAAoB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACxD,MAAM,OAAO,GAAU,UAAU,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACxD,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;CACF"}

package/dist/esm/modules/common/shared/data/aus_states.json

@@ -0,0 +1,10 @@
+[
+    { "alpha3Code": "NSW", "name": "New South Wales" },
+    { "alpha3Code": "VIC", "name": "Victoria" },
+    { "alpha3Code": "QLD", "name": "Queensland" },
+    { "alpha3Code": "TAS", "name": "Tasmania" },
+    { "alpha3Code": "SA", "name": "South Australia" },
+    { "alpha3Code": "WA", "name": "Western Australia" },
+    { "alpha3Code": "NT", "name": "Northern Territory" },
+    { "alpha3Code": "ACT", "name": "Australian Capital Territory" }
+]