@como/como-client 0.9.3 → 0.9.5

package/README.md

@@ -6,10 +6,37 @@ A cross platform SDK for como backend API.
 
 - To run this project source code locally make sure you're running node 8.x.x or later.
 - To run the project example - `node ${workspaceFolder}/test.js`.
-- To run all unit tests run - `npm test`.
+- Install dependencies with `corepack yarn install --frozen-lockfile`. Yarn is the
+  source of truth; the ignored local `package-lock.json` is not maintained.
+- To build and run the offline dependency compatibility tests, run `npm test`.
+  This does not run the live QA example in `test.js`. The development test runner
+  requires Node 14 or later; this release was checked on Node 22.
 - To publish a new version to npm - `npm publish`. Make sure to increment the package version in `${workspaceFolder}/package.json`.
 
 ## Development in [vscode](https://code.visualstudio.com/)
 
 - The configuration is set in `${workspaceFolder}/.vscode/launch.json`
-- Use `Launch Program` pre-defined configuration to run.
+- Use `Launch Program` pre-defined configuration to run.
+
+## Security release 0.9.5
+
+- Axios is patched within the existing 0.x API line to `^0.34.0`.
+- Mocha and Chai are development dependencies only, so consumers no longer
+  install the SDK's old Mocha 5 dependency tree, including its `inflight` path.
+  Build/test tooling can still have separate development-only advisories.
+- `babel-runtime` is an explicit runtime dependency because the published
+  compiled files import it.
+- The package entrypoint is `index.js`, which loads `lib/como.js`. `npm pack`
+  builds `lib/` through `prepack`; source-only `src/` paths are not published.
+  Existing `lib/como` and interceptor imports remain available.
+
+The offline tests cover the service-consumed exports, HTTP JSON/redirect/error
+handling, bearer-token refresh, credential updates, signed sign-on requests,
+location state and resource URLs. They do not certify browser/mobile runtimes
+or live authentication/CDN services.
+
+Release this SDK before changing a consumer's registry dependency to `0.9.5`.
+Do not commit a consumer lockfile referring to an unpublished registry version
+or a machine-local sibling path. Review unrelated working-tree edits before
+packing or publishing; a package includes the current source, not only staged
+Git changes.

package/lib/como.js

@@ -883,7 +883,7 @@ var Como = function () {
         key: 'login',
         value: function () {
             var _ref12 = (0, _asyncToGenerator3.default)( /*#__PURE__*/_regenerator2.default.mark(function _callee12(identifier, type, reCaptchaToken, recaptchaTokenType, devicePlatform, isWhatsapp) {
-                var api, data, _error$response$data8, code, message;
+                var api, data, _error$response$data8, code, message, retryAfter, loginError;
 
                 return _regenerator2.default.wrap(function _callee12$(_context12) {
                     while (1) {
@@ -903,17 +903,25 @@ var Como = function () {
                                 _context12.t0 = _context12['catch'](1);
 
                                 if (!(_context12.t0.response && _context12.t0.response.data)) {
-                                    _context12.next = 13;
+                                    _context12.next = 15;
                                     break;
                                 }
 
-                                _error$response$data8 = _context12.t0.response.data, code = _error$response$data8.code, message = _error$response$data8.message;
-                                throw new Error(code || message);
+                                _error$response$data8 = _context12.t0.response.data, code = _error$response$data8.code, message = _error$response$data8.message, retryAfter = _error$response$data8.retryAfter;
+                                loginError = new Error(code || message);
+                                // When a request lands inside its OTP backoff the server states how long
+                                // to wait. Only code and message used to survive this rethrow, which left
+                                // the app inventing a countdown of its own.
 
-                            case 13:
+                                if (typeof retryAfter === 'number') {
+                                    loginError.retryAfter = retryAfter;
+                                }
+                                throw loginError;
+
+                            case 15:
                                 throw _context12.t0;
 
-                            case 14:
+                            case 16:
                             case 'end':
                                 return _context12.stop();
                         }
@@ -942,7 +950,7 @@ var Como = function () {
         key: 'loginVerify',
         value: function () {
             var _ref13 = (0, _asyncToGenerator3.default)( /*#__PURE__*/_regenerator2.default.mark(function _callee13(identifier, type, code, reCaptchaToken, recaptchaTokenType, devicePlatform) {
-                var api, _ref14, consent, _error$response$data9, errCode, message;
+                var api, _ref14, consent, _error$response$data9, errCode, message, retryAfter, verifyError;
 
                 return _regenerator2.default.wrap(function _callee13$(_context13) {
                     while (1) {
@@ -970,17 +978,16 @@ var Como = function () {
                                     break;
                                 }
 
-                                _error$response$data9 = _context13.t0.response.data, errCode = _error$response$data9.code, message = _error$response$data9.message;
+                                _error$response$data9 = _context13.t0.response.data, errCode = _error$response$data9.code, message = _error$response$data9.message, retryAfter = _error$response$data9.retryAfter;
+                                // The wrong-code case keeps reporting the message rather than the code,
+                                // since callers match on that string.
 
-                                if (!(message && message === 'Invalid verification Code')) {
-                                    _context13.next = 15;
-                                    break;
-                                }
-
-                                throw new Error(message);
+                                verifyError = message && message === 'Invalid verification Code' ? new Error(message) : new Error(errCode || message);
 
-                            case 15:
-                                throw new Error(errCode || message);
+                                if (typeof retryAfter === 'number') {
+                                    verifyError.retryAfter = retryAfter;
+                                }
+                                throw verifyError;
 
                             case 16:
                                 throw _context13.t0;

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@como/como-client",
-  "version": "0.9.3",
+  "version": "0.9.5",
   "description": "Client module for Como's loaylty API",
-  "main": "src/como.js",
+  "main": "index.js",
+  "packageManager": "yarn@1.22.22",
   "scripts": {
-    "test": "mocha",
-    "prepublishOnly": "node_modules/babel-cli/bin/babel.js src --out-dir lib"
+    "build": "babel src --out-dir lib",
+    "test": "npm run build && mocha --timeout 10000 \"test/**/*.test.js\"",
+    "prepack": "npm run build",
+    "prepublishOnly": "npm run build"
   },
   "files": [
     "/lib",
@@ -26,11 +29,10 @@
   },
   "homepage": "https://github.com/ConduitMobileRND/como-client-lib#readme",
   "dependencies": {
-    "axios": "^0.30.2",
-    "chai": "^4.1.2",
+    "axios": "^0.34.0",
+    "babel-runtime": "^6.26.0",
     "json-stable-stringify": "1.0.1",
     "jssha": "^3.2.0",
-    "mocha": "^5.2.0",
     "moment-timezone": "^0.5.35",
     "ramda": "^0.25.0"
   },
@@ -45,7 +47,7 @@
     "eslint": "^4.19.1",
     "eslint-config-airbnb-base": "^12.1.0",
     "eslint-plugin-import": "^2.12.0",
-    "mocha": "^5.2.0",
+    "mocha": "^10.8.2",
     "supertest": "^3.1.0",
     "webpack": "^4.8.3",
     "webpack-cli": "^2.1.4"

package/src/como.js

@@ -1,1077 +0,0 @@
-const moment = require('moment-timezone');
-const ramda = require('ramda');
-const environmentConfig = require('./config/env');
-const APIService = require('./services');
-const comoExternalUrlTranslator = require('./utils/comoExternalUrlTranslator');
-const resourceNames = require('./constants/resourceNames');
-const urlsUtils = require('./utils/urls');
-
-const INITIAL_COMO_DATA = {
-    env: environmentConfig,
-    token: null,
-    locationId: null,
-    locationState: null,
-    installationId: null,
-    membership: null,
-    assets: null,
-    reCaptchaSiteKey: null,
-    mainResources: {},
-};
-
-class Como {
-    constructor() {
-        this.comoData = {};
-    }
-
-    async refreshTokenIfNeeded() {
-        const { refresher, expiresIn } = this.comoData;
-        if (!refresher) {
-            console.log('No refresh for %o', this.comoData);
-        } else if (expiresIn && moment(expiresIn).subtract(60, 'seconds').isBefore(moment())) {
-            await refresher();
-        }
-    }
-
-
-    /**
-     * Sign the user and returns guest token & refresh token.
-     * Requires init.
-     */
-    // async signon(source) {
-    //     const { InitApi: api } = this.comoData;
-    //     try {
-    //         const data = await api.signOn(this.comoData.installationId, this.comoData.locationId, this.comoData.refreshToken, source);
-    //         if (data && data.config && data.config.loyaltyCDN) {
-    //             this.comoData.env_params.services_root_cdn = data.config.loyaltyCDN;
-    //         }
-    //         return data;
-    //     } catch (error) {
-    //         if (error.response && error.response.data) {
-    //             const { code, message } = error.response.data;
-    //             throw new Error(code || message);
-    //         }
-    //         throw error;
-    //     }
-    // }
-
-    /**
-     *
-     * @param {Object} environment Environemnt object
-     * @param {string} environment.id Environment Id
-     * @param {string} environment.locationId Location Id
-     * @param {string} environment.installationId Unique installation id
-     * @param {Object} credentials Member credentials (Optional)
-     * @param {string} accessToken session id string (Optional)
-     * @param {string} refreshToken refresh token string (Optional)
-     * @param {string} expiresIn access token expiration date formatted (Optional)
-     * @param {function} refreshCallback an event callback which fires each time user's tokens gets refreshed
-     * @param {boolean} enableSignon if disabled signOn api call will not be fired. Enabled by default.
-     */
-    async init(environment, credentials, refreshCallback, enableSignon = true) {
-        const isExists = (x => !ramda.isNil(x) && !ramda.isEmpty(x));
-        const {
-            id: environmentId, locationId, installationId, source, binaryVersion, phoenixVersion,
-        } = environment;
-        if (!isExists(environmentId) || !isExists(locationId) || !isExists(installationId)) {
-            throw new Error(`missing parameters: ${environment}`);
-        }
-
-        this.comoData = {
-            ...INITIAL_COMO_DATA,
-            ...credentials,
-            installationId,
-            locationId,
-            source,
-            env_params: {
-                ...INITIAL_COMO_DATA.env[environmentId],
-            },
-            tempTokenData: {},
-            config: {},
-        };
-
-        const updateCredentials = (creds, isNew = false) => {
-            this.updateLocalCreds(creds);
-            if (refreshCallback && isNew) {
-                refreshCallback(creds);
-            }
-        };
-
-        const getCredentials = this.getCredentials.bind(this);
-        const { gateway } = this.comoData.env_params;
-        const { service, refresher, initService } = APIService
-            .getService(gateway, installationId, getCredentials, updateCredentials, source, binaryVersion, phoenixVersion);
-        this.comoData.api = service;
-        this.comoData.initApi = initService;
-        this.comoData.refresher = refresher;
-
-        const { accessToken, refreshToken, expiresIn } = credentials;
-        let credExist = isExists(accessToken) && isExists(refreshToken);
-        const isExpired = credExist && expiresIn && moment(expiresIn).isBefore(moment());
-        let refreshFailed = false;
-        if (isExpired) {
-            try {
-                const data = await this.comoData.initApi.refreshToken(installationId, refreshToken || 'none', locationId, source);
-                this.comoData.config = data.config;
-                console.log(`signOn with isExpired true result:${JSON.stringify(data)}`);
-                updateCredentials(data, true);
-            } catch (e) {
-                console.error(`Failed to refresh token, installationId:${installationId}, refreshToken:${this.comoData.refreshToken}, locationId:${locationId}, source:${source}`);
-                // refresh failed - need to revoke and signOn again
-                initService.logError({
-                    method: 'refreshToken', installationId, locationId, source, refreshToken, error: e.message,
-                });
-                refreshFailed = true;
-            }
-        }
-        let interval = 0;
-        if (refreshFailed || !credExist) {
-            while (!credExist && interval < 3000) {
-                try {
-                    const data = await this.comoData.initApi.signOn(installationId, locationId, source);
-                    this.comoData.config = data.config;
-                    console.log(`signOn with refreshFailed result:${JSON.stringify(data)}`);
-                    updateCredentials(data, true);
-                    credExist = true;
-                } catch (e) {
-                    console.error(`Failed to signOn, installationId:${installationId}, locationId:${locationId}, source:${source},interval:${interval}, error:${e}`);
-                    interval += 1000;
-                    initService.logError({
-                        method: 'signOn no accessToken', accessToken, isExpired, refreshFailed, credExist, installationId, locationId, source, refreshToken, interval, error: e.message,
-                    });
-                    await new Promise(r => setTimeout(r, interval));
-                }
-            }
-        } else if (!isExpired) {
-            let signOnSuccessfully = false;
-            while (!signOnSuccessfully && interval < 3000) {
-                try {
-                    console.log(`signOn with installationId:${installationId}, locationId:${locationId}, source:${source},accessToken:${accessToken}`);
-                    const data = await this.comoData.initApi.signOn(installationId, locationId, source, accessToken);
-                    this.comoData.config = data.config;
-                    console.log(`signOn with result " ${JSON.stringify(data)}`);
-                    if (data && data.accessToken) {
-                        console.log('signOn- updating credentials');
-                        updateCredentials(data, true);
-                    }
-                    if (data && data.config && data.config.recaptchaSiteKey) {
-                        this.comoData.reCaptchaSiteKey = data.config.recaptchaSiteKey;
-                    }
-                    signOnSuccessfully = true;
-                } catch (e) {
-                    console.error(`Failed signOn with accessToken, installationId:${installationId}, locationId:${locationId}, source:${source},accessToken:${accessToken}, error:${e.message}`);
-                    interval += 1000;
-                    initService.logError({
-                        method: 'signOn with credentials', accessToken, isExpired, refreshFailed, credExist, installationId, locationId, source, refreshToken, interval, error: e.message,
-                    });
-                    await new Promise(r => setTimeout(r, interval));
-                }
-            }
-        }
-        if (!this.comoData.token) {
-            this.comoData.token = this.comoData.accessToken;
-        }
-        return this.getCredentials();
-    }
-
-    /**
-     * Updates the como.js local credentials settings.
-     * Used when making api calls to janua.
-     *
-     * @param {Object} credentials credentials to update.
-     * @param {Object} accessToken access token to update.
-     * @param {Object} refreshToken refresh token to update.
-     * @param {Object} expiresIn access token expiry date to update.
-     */
-    updateLocalCreds(credentials = {}) {
-        this.comoData.accessToken = credentials.accessToken;
-        this.comoData.token = credentials.accessToken;
-        this.comoData.refreshToken = credentials.refreshToken;
-        this.comoData.expiresIn = credentials.expiresIn;
-        if (credentials && credentials.config) {
-            this.comoData.reCaptchaSiteKey = credentials.config.recaptchaSiteKey;
-            if (credentials.config.recaptcha) {
-                this.comoData.recaptchaConfig = credentials.config.recaptcha;
-            }
-        }
-    }
-
-    getExternalUrlByID(itemID, gpsData, assetID, accessibilityData) {
-        const locationData = this.comoData.mainResources[resourceNames.LOCATION_DATA];
-        if (locationData && locationData.WebViews && locationData.WebViews[0].item) {
-            const possibleWebViews = locationData.WebViews[0].item.filter(u => u.id === itemID);
-            const url = possibleWebViews && possibleWebViews[0] && possibleWebViews[0].url;
-            return this.translateExternalUrl(url, gpsData, assetID, accessibilityData);
-        }
-        return null;
-    }
-
-    async translateExternalUrl(url, gpsData, assetID, accessibilityData, devicePlatform = 'notImplemented') {
-        const legacyUrl = await this.getAppModulesLegacyBaseUrl();
-        let externalUrl = url;
-        if (externalUrl && externalUrl.startsWith(legacyUrl)) {
-            externalUrl = externalUrl.replace(legacyUrl, this.comoData.env_params.app_modules_root);
-        }
-        const {
-            api, locationId, token, env_params: env, membership, assets,
-        } = this.comoData;
-        const locationData = this.comoData.mainResources && this.comoData.mainResources[resourceNames.LOCATION_DATA];
-        const apiObjects = { api, servicesRoot: env.services_root };
-        const dataToUse = {
-            locationId, token, membership, locationData, assets, gpsData, assetID, accessibilityData, devicePlatform,
-        };
-        const translatedData = await comoExternalUrlTranslator.translateUrl(externalUrl, apiObjects, dataToUse);
-        if (translatedData.tempTokenData.temporaryToken) {
-            this.comoData.tempTokenData[translatedData.tempTokenData.temporaryToken] = translatedData.tempTokenData.expirationDate;
-        }
-        return translatedData && translatedData.translatedUrl && translatedData.translatedUrl.length ? translatedData.translatedUrl : '';
-    }
-
-    async getFeedbackFormData() {
-        const {
-            locationId, env_params: env, api,
-        } = this.comoData;
-        return api.getFeedbackFormData(env.zapp_root, locationId);
-    }
-
-    /**
-     *
-     * @param {Object} form registration form values
-     * @param {Object} verification flow
-     * @param {string} reCaptchaToken
-     * @param {Object} source(registration origin)
-     */
-    async register(form, verification, reCaptchaToken, source) {
-        const { api } = this.comoData;
-        try {
-            const data = await api.register(form, verification, reCaptchaToken, source);
-            return data;
-        } catch (error) {
-            if (error.response && error.response.data) {
-                const { code, message } = error.response.data;
-                throw new Error(code || message);
-            }
-            throw error;
-        }
-    }
-
-    /**
-     *
-     * @param {string} verification flow (code & verification step)
-     * @param {string} type verification type
-     * @param {Object} form registration form values
-     * @param {string} reCaptchaToken
-     */
-    async registerVerify(verification, type, form, reCaptchaToken) {
-        const { api } = this.comoData;
-        try {
-            const data = await api.registerVerify(verification, type, form, reCaptchaToken);
-            return data;
-        } catch (error) {
-            if (error.response && error.response.data) {
-                const { code, message } = error.response.data;
-                throw new Error(code || message);
-            }
-            throw error;
-        }
-    }
-
-    /**
-     *
-     * @param {Object} form update form values
-     * @param {string} reCaptchaToken
-     * @param {string} verification
-     * @param {string} source request source
-     */
-    async updateProfile(form, reCaptchaToken, verification, source) {
-        const { api } = this.comoData;
-        try {
-            const data = await api.updateProfile(form, reCaptchaToken, verification, source);
-            return data;
-        } catch (error) {
-            if (error.response && error.response.data) {
-                const { code, message } = error.response.data;
-                throw new Error(code || message);
-            }
-            throw error;
-        }
-    }
-
-    /**
-     *
-     * @param {string} verificationCode code verification sent by 3rd party
-     * @param {string} type verification type
-     * @param {Object} form update form values
-     * @param {string} reCaptchaToken
-     * @param {string} source request source
-     */
-    async updateProfileVerify(verificationCode, type, form, reCaptchaToken, source) {
-        const { api } = this.comoData;
-        try {
-            const data = await api.updateProfileVerify(verificationCode, type, form, reCaptchaToken, source);
-            return data;
-        } catch (error) {
-            if (error.response && error.response.data) {
-                const { code, message } = error.response.data;
-                throw new Error(code || message);
-            }
-            throw error;
-        }
-    }
-
-    /**
-     * @param {string} language language code
-     */
-    async updateLanguage(language) {
-        const { api } = this.comoData;
-        try {
-            const data = await api.updateLanguage(language);
-            return data;
-        } catch (error) {
-            if (error.response && error.response.data) {
-                const { code, message } = error.response.data;
-                throw new Error(code || message);
-            }
-            throw error;
-        }
-    }
-
-    /**
-     *
-     * @param {string} unsubscribeSms unsubscribe user at location
-     * @param {string} PhoneNumber phone number to identify user
-     */
-    async unsubscribeSms(PhoneNumber) {
-        const { api, locationId } = this.comoData;
-        try {
-            const identifier = { PhoneNumber };
-            const data = await api.unsubscribeSms(locationId, identifier);
-            return data;
-        } catch (error) {
-            if (error.response && error.response.data) {
-                const { code, message } = error.response.data;
-                throw new Error(code || message);
-            }
-            throw error;
-        }
-    }
-
-    /**
-     *
-     * @param {string} unsubscribeWhatsapp unsubscribe user at location
-     * @param {string} PhoneNumber phone number to identify user
-     */
-    async unsubscribeWhatsapp(PhoneNumber) {
-        const { api, locationId } = this.comoData;
-        try {
-            const identifier = { PhoneNumber };
-            const data = await api.unsubscribeWhatsapp(locationId, identifier);
-            return data;
-        } catch (error) {
-            if (error.response && error.response.data) {
-                const { code, message } = error.response.data;
-                throw new Error(code || message);
-            }
-            throw error;
-        }
-    }
-
-    /**
-     *
-     * @param {Object} identifier an object which identifies the user by its credentials
-     * @param {string} type login type i.e PhoneNumber/Email/etc
-     * @param {reCaptchaToken} reCaptcha token for login chalenge
-     * @param {recaptchaTokenType} recaptcha token type - score/human
-     * @param {devicePlatform} device platform i.e. ios/android
-     * @param {boolean} isWhatsapp optional flag for whatsapp login flow
-     */
-    async login(identifier, type, reCaptchaToken, recaptchaTokenType, devicePlatform, isWhatsapp) {
-        const { api } = this.comoData;
-        try {
-            const data = await api.logIn(type, identifier, reCaptchaToken, recaptchaTokenType, devicePlatform, isWhatsapp);
-            return data;
-        } catch (error) {
-            if (error.response && error.response.data) {
-                const { code, message } = error.response.data;
-                throw new Error(code || message);
-            }
-            throw error;
-        }
-    }
-
-    /**
-     *
-     * @param {Object} identifier key-value identifiers
-     * @param {*} type login type i.e PhoneNumber/Email/etc
-     * @param {*} code a 2-factor verification code sent to the client
-     * @param {reCaptchaToken} reCaptcha token for login challenge
-     * @param {recaptchaTokenType} recaptcha token type - score/human
-     * @param {devicePlatform} device platform i.e. ios/android
-     */
-    async loginVerify(identifier, type, code, reCaptchaToken, recaptchaTokenType, devicePlatform) {
-        const { api } = this.comoData;
-        try {
-            const { consent } = await api.logInVerify(code, type, identifier, reCaptchaToken, recaptchaTokenType, devicePlatform);
-            this.comoData.consent = consent;
-        } catch (error) {
-            if (error.response && error.response.data) {
-                const { code: errCode, message } = error.response.data;
-                if (message && message === 'Invalid verification Code') {
-                    throw new Error(message);
-                }
-                throw new Error(errCode || message);
-            }
-            throw error;
-        }
-
-        return this.getCredentials();
-    }
-
-    /**
-     * Reload and sets the internal membership state.
-     * To get the reloaded membership make sure to call getMembership();
-     * @param onlyAssetKeys - include assets list full data or only the asset keys
-     * @returns {Promise<void>}
-     */
-    async reloadMembership(onlyAssetKeys = false) {
-        const {
-            env_params: env, locationId, api,
-        } = this.comoData;
-        const membership = await api.getUserAtLocation(env.zapp_root, locationId, onlyAssetKeys);
-        this.comoData.membership = membership;
-    }
-
-    /**
-     * Send an Open app request to update server.
-     */
-    async openApp(data) {
-        const {
-            api, locationId, env_params: env,
-        } = this.comoData;
-
-        return api.openApp(env.zapp_root, locationId, data);
-    }
-
-    /**
-     * Update membership status (permissions).
-     * @param {boolean} pushEnable
-     * @param {boolean} locationEnable
-     */
-    async clientUpdateMembership(pushEnable, locationEnable) {
-        const {
-            api, locationId, token, env_params: env,
-        } = this.comoData;
-        try {
-            return api.clientUpdateMembership(env.services_root, locationId, pushEnable, locationEnable);
-        } catch (e) {
-            console.log(`clientUpdateMembership failed, token:${token}, locationId:${locationId}, error: ${e}`);
-        }
-    }
-
-    /**
-     * Downloads the main resource by its id and sets the resource in the main resource's map.
-     * @param {string} resourceId Main resource id
-     */
-
-    async downloadMainResource(resourceId) {
-        try {
-            const resource = this.comoData.mainResourcesMap[resourceId];
-            if (!resource) {
-                const err = `resource ${resourceId} not found!`;
-                throw new Error(err);
-            }
-
-            const { env_params: env, api } = this.comoData;
-            const responseJson = await api.getLoyaltyResource(
-                env.services_root_cdn,
-                resource.id,
-                ('Namespace' in resource) ? resource.Namespace : `location_${this.comoData.locationId}`,
-                resource.Version,
-                this.comoData.locationId,
-            );
-
-            this.comoData.mainResources[resourceId] = responseJson;
-        } catch (e) {
-            console.log(`downloadMainResource failed, resourceId:${resourceId}, locationId:${this.comoData.locationId}, this.comoData.mainResourcesMap: ${this.comoData.mainResourcesMap}, error: ${e}`);
-            throw new Error(e);
-        }
-    }
-
-
-    /**
-     * Reload and sets the internal location state.
-     * To get the reloaded location state make sure to call getLocationState();
-     */
-    async reloadLocationState() {
-        const { api } = this.comoData;
-        const state = await api.getLocationState(this.comoData.env_params.zapp_root, this.comoData.locationId);
-        this.comoData.locationState = state;
-        const mainResources = state.MainResources.Resource;
-
-        this.comoData.mainResourcesMap = mainResources.reduce((total, obj) => {
-            total[obj.id] = obj; // eslint-disable-line no-param-reassign
-            return total;
-        }, {});
-    }
-
-    /**
-     * Requests an app client id by the user's location id.
-     */
-    async getAppClientID() {
-        const {
-            env_params: env, locationId, api,
-        } = this.comoData;
-        await this.refreshTokenIfNeeded();
-        const responseJson = await api.getShortUserId(env.zapp_root, locationId);
-        return responseJson.ID;
-    }
-
-    /**
-     * Requests a generated payment code from the loyalty server
-     */
-    async getPaymentCode() {
-        const {
-            env_params: env, locationId, api,
-        } = this.comoData;
-        const responseJson = await api.getPaymentCode(env.zapp_root, locationId);
-        return responseJson.VerificationCode;
-    }
-
-    /**
-     * Logout the user identified by its accessToken
-     */
-    async logout() {
-        const { api } = this.comoData;
-        try {
-            const response = await api.logOut();
-            return response;
-        } catch (error) {
-            if (error.response && error.response.data) {
-                const { code: errCode, message } = error.response.data;
-                throw new Error(errCode || message);
-            }
-            throw error;
-        }
-    }
-
-    /**
-     *
-     * @param {string} assetKey asset's id
-     */
-    async redeemAsset(assetKey) {
-        const {
-            env_params: env, locationId, api,
-        } = this.comoData;
-        await this.refreshTokenIfNeeded();
-        const responseJson = await api.redeemAsset(env.zapp_root, locationId, assetKey);
-        return responseJson;
-    }
-
-    /**
-     *
-     * @param {string} itemId item's id
-     */
-    async purchaseAsset(itemId) {
-        const {
-            env_params: env, locationId, api,
-        } = this.comoData;
-        const responseJson = await api.purchaseAsset(env.zapp_root, locationId, itemId);
-        return responseJson;
-    }
-
-    async getUserPointShopDataAPI2() {
-        const {
-            env_params: env, locationId, api,
-        } = this.comoData;
-        const responseJson = await api.getUserPointShopDataAPI2(env.zapp_root, locationId);
-        return responseJson;
-    }
-
-
-    async purchaseAssetAPI2(assetID) {
-        const {
-            env_params: env, locationId, api,
-        } = this.comoData;
-        const responseJson = await api.purchaseAssetAPI2(env.zapp_root, locationId, assetID);
-        return responseJson;
-    }
-
-    /**
-     * Reload and sets the internal assets (expired and valid) state.
-     * To get the reloaded assets make sure to call como.getAssets();
-     */
-    async reloadAssets() {
-        const {
-            env_params: env, locationId, api,
-        } = this.comoData;
-        const responseJson = await api.memberAssets(env.services_root, locationId);
-        this.comoData.assets = responseJson;
-    }
-
-    /**
-     * Merge the default app text with the location specific app texts
-     * Both DefaultAppTexts and AppTexts are a MainResource that needs to be downloaded before merge
-     */
-    mergeTexts() {
-        if (this.comoData.mainResources.AppTexts && this.comoData.mainResources.DefaultAppTexts) {
-            this.comoData.app_texts = this.comoData.mainResources.DefaultAppTexts;
-            Object.keys(this.comoData.mainResources.AppTexts).forEach(key => {
-                this.comoData.app_texts[key] = this.comoData.mainResources.AppTexts[key];
-            });
-        }
-    }
-
-    /**
-     *
-     * @param {string} key app text key
-     */
-    getTextForKey(key) { return this.comoData.app_texts[key]; }
-
-    /**
-     * Downloads the main resources:
-     * - LocationData
-     * - Menu
-     * - Updates
-     * - TCAlts
-     * - AppTexts
-     * - DefaultAppTexts
-     */
-    async downloadMainResources() {
-        const resources = [
-            'LocationData',
-            'Menu',
-            'Updates',
-            'TCAlts',
-            'AppTexts',
-            'DefaultAppTexts',
-        ];
-        const downloadMainResource = this.downloadMainResource.bind(this);
-        const downloads = resources.map(downloadMainResource);
-        await Promise.all(downloads);
-        this.mergeTexts();
-    }
-
-    /**
-     *
-     * @param {string} type form type
-     */
-    loadForm(type) {
-        const { api, locationId } = this.comoData;
-
-        return api.getForm(type, locationId);
-    }
-
-    /**
-     *
-     * @param {string} type configuration type
-     */
-    getConfigration(type) {
-        const { api, locationId } = this.comoData;
-        const locationState = this.getLocationState();
-        let version = null;
-        if (locationState) {
-            version = locationState.PublishVersion;
-        }
-
-        return api.getConfiguration(type, locationId, version);
-    }
-
-    /**
-     *
-     * @param {string} type resource type
-     */
-    getResource(type) {
-        const { api, locationId } = this.comoData;
-        return api.getResource(type, locationId);
-    }
-
-    /**
-     *
-     * Get all legacy resources (Zapp)
-     */
-    getLegacyResources() {
-        const { api, locationId } = this.comoData;
-        return api.getZappResource(locationId);
-    }
-
-    /**
-     * Generates a new referral code for friend-referral
-     */
-    generateReferralCode() {
-        const {
-            api, locationId, env_params: env,
-        } = this.comoData;
-
-        return api.generateReferralCode(env.services_root, locationId);
-    }
-
-    /**
-     * Check that referral code is valid
-     */
-    verifyReferralCode(code) {
-        const {
-            api, locationId, env_params: env,
-        } = this.comoData;
-
-        return api.verifyReferralCode(env.services_root, locationId, code);
-    }
-
-    /**
-     * Returns current accessToken and refreshToken
-     * Caution: make sure to pass refresh callback to init to get the latest credentials
-     */
-    getCredentials() {
-        const {
-            accessToken, refreshToken, expiresIn, consent, locationId,
-        } = this.comoData;
-        return {
-            accessToken, refreshToken, expiresIn, consent, locationId,
-        };
-    }
-
-    /**
-     * Returns the current accessToken
-     * Caution: make sure to pass refresh callback to como.init to get the latest credentials
-     */
-    getToken() { return this.comoData.token; }
-
-    /**
-     * Returns the como.js initialized installation id
-     */
-    getInstallationId() { return this.comoData.installationId; }
-
-    /**
-     * Return the user membership object
-     * Make sure to call reloadMembership() to reload the membership object.
-     */
-    getMembership() { return this.comoData.membership; }
-
-    /**
-     * Return the user assets object
-     * Make sure to call reloadAssets() to reload the assets object.
-     */
-    getAssets() { return this.comoData.assets; }
-
-    /**
-     * Return service recaptch config
-     */
-    async getRecaptchaConfig() {
-        await this.refreshTokenIfNeeded();
-        return this.comoData.recaptchaConfig;
-    }
-
-    /**
-     * Returns the location specific registration web url
-     */
-    async getRegistrationUrl(overrides) {
-        await this.refreshTokenIfNeeded();
-        const {
-            token, installationId, locationId, env_params: env,
-        } = this.comoData;
-
-        return urlsUtils.appendQuery(
-            `${env.app_modules_root}/register?token=${token}&locationid=${locationId}`,
-            {
-                ...this.getCredentials(),
-                installationId,
-                disableSuccessScreen: 'true',
-                ...overrides,
-            },
-        );
-    }
-
-    /**
-     * Returns the location specific profile web url
-     */
-    async getProfileUrl(overrides) {
-        await this.refreshTokenIfNeeded();
-        const {
-            token, installationId, locationId, env_params: env,
-        } = this.comoData;
-
-        return urlsUtils.appendQuery(
-            `${env.app_modules_root}/profile?token=${token}&locationid=${locationId}`,
-            {
-                ...this.getCredentials(),
-                installationId,
-                disableSuccessScreen: 'true',
-                ...overrides,
-            },
-        );
-    }
-
-    /**
-     * Returns the location specific login web url
-     */
-    async getLoginUrl() {
-        await this.refreshTokenIfNeeded();
-        const { token, locationId, env_params: env } = this.comoData;
-        return `${env.app_modules_root}/login?token=${token}&locationid=${locationId}`;
-    }
-
-    /**
-    * Returns the location data Portability url
-    */
-    async getDataPortabilityUrl(url, overrides) {
-        await this.refreshTokenIfNeeded();
-        const {
-            installationId,
-        } = this.comoData;
-
-        return urlsUtils.appendQuery(
-            `${url}`,
-            {
-                installationId,
-                ...overrides,
-            },
-        );
-    }
-
-    /**
-     * Returns app-modules legacy root url
-     */
-    async getAppModulesLegacyBaseUrl() {
-        await this.refreshTokenIfNeeded();
-        const { env_params: env } = this.comoData;
-        return `${env.app_modules_legacy_root}`;
-    }
-
-    /**
-     * Returns the location specific friend referral web url
-     */
-    getFriendReferralInviteLink(referral) {
-        const { env_params: env, locationId } = this.comoData;
-        const cpBaseUrl = env.cp_base_url.replace('{location_id}', locationId);
-        return `${cpBaseUrl}/auth/signin?onboardingflow=register&ReferralCode=${referral}`;
-    }
-
-    /**
-     * Return the location state
-     * Make sure to call reloadLocationState() to reload the location state object.
-     */
-    getLocationState() { return this.comoData.locationState; }
-
-    /**
-     * Returns the location point shop items
-     */
-    getPointShopItems() { return this.comoData.mainResources.menu.gifts_shop_item; }
-
-    /**
-     *
-     * @param {string} resourceName resource name
-     */
-    getMainResource(resourceName) { return this.comoData.mainResources[resourceName]; }
-
-    /**
-     *
-     * @param {string} resourceId resource id
-     * @param {string} namespace resource namespace
-     * @param {string|number} version resource version
-     */
-    getResourceUrl(resourceId, namespace, version) {
-        const { api, env_params: env, locationId } = this.comoData;
-        return api.getResourceUrl(env.services_root_cdn, resourceId, namespace, version, locationId);
-    }
-
-    getPurchaseReportUrl() {
-        const { env_params: env } = this.comoData;
-        return `${env.purchase_connect_base_url}/Purchase/Report`;
-    }
-
-    getCdnUrl() {
-        return this.comoData.env_params.services_root_cdn;
-    }
-
-    /**
-     * @param {string} identifier fcm token created by firebase
-     * @param {boolean} isFirebaseProjectMigrated is migrated to new firebase project
-     */
-    sendPushChannel(identifier, isFirebaseProjectMigrated = false) {
-        const {
-            api, locationId, env_params: env,
-        } = this.comoData;
-        return api.sendPushChannel(env.services_root, locationId, identifier, isFirebaseProjectMigrated);
-    }
-
-    async getRegionConfig() {
-        const {
-            api, locationId, env_params: env,
-        } = this.comoData;
-        return api.getClientBusinessBackend(env.zapp_root, locationId);
-    }
-
-    /**
-     * @param {string} code coupon code entered by user on App
-     */
-    sendCouponCode(code) {
-        const {
-            api, locationId, env_params: env,
-        } = this.comoData;
-        return api.sendCouponCode(env.zapp_root, locationId, code);
-    }
-
-    async addPaymentMethod(cardToken) {
-        const {
-            api, locationId, token, env_params: env,
-        } = this.comoData;
-        return api.addPaymentMethod(env.services_root, locationId, token, cardToken);
-    }
-
-    async knowYourData(email) {
-        const {
-            api, locationId, env_params: env,
-        } = this.comoData;
-        return api.knowYourData(env.services_root, locationId, email);
-    }
-
-    async consentWithdraw(consentData) {
-        const {
-            api, locationId, env_params: env,
-        } = this.comoData;
-        return api.consentWithdraw(env.services_root, locationId, consentData);
-    }
-
-    async getPaymentMethods() {
-        const {
-            env_params: env, locationId, api,
-        } = this.comoData;
-        const responseJson = await api.getPaymentMethods(env.services_root, locationId);
-        return responseJson;
-    }
-
-    /**
-     * @param {Integer} amount to charge
-     * @param {String} creditCardToken to charge from
-     * @param {String} itemName for submit purchase
-     * @param {String} itemNumber for submit purchase
-     * @param {String} membershipKey for user identification
-     */
-    async payInApp(amount, creditCardToken, itemName, itemNumber, membershipKey) {
-        const {
-            env_params: env, token, locationId, api,
-        } = this.comoData;
-        const responseJson = await api.payInApp(env.services_root, locationId, token, amount, creditCardToken, itemName, itemNumber, membershipKey);
-        return responseJson;
-    }
-
-    /**
-     * @param {string} creditCardToken which card to delete
-     */
-    async deletePayment(creditCardToken) {
-        const {
-            env_params: env, token, locationId, api,
-        } = this.comoData;
-        const responseJson = await api.deletePayment(env.services_root, locationId, token, creditCardToken);
-        return responseJson;
-    }
-    /**
-     * @param {string} tag for Pop-up Message Trigger (Optional param)
-     */
-    async getMemberMessages(tag, limit, offset, fetchExpiredMessages = false) {
-        const {
-            api, locationId, env_params: env,
-        } = this.comoData;
-        await this.refreshTokenIfNeeded();
-        return api.getMemberMessages(env.services_root, locationId, tag, limit, offset, fetchExpiredMessages);
-    }
-
-    /**
-     * @param {string} keysList keys of the messages to mark as read
-     */
-    markAsReadMemberMessages(keysList) {
-        const {
-            api, locationId, env_params: env,
-        } = this.comoData;
-        return api.markAsReadMemberMessages(env.services_root, locationId, keysList);
-    }
-
-    /**
-     * @param {String} receiver to share with
-     * @param {String} sender name
-     * @param {Integer} amount to share
-     * @param {String} type of wallet
-     */
-    async budgetTransfer(receiver, sender, amount, wallet) {
-        const {
-            api, locationId, env_params: env,
-        } = this.comoData;
-        return api.budgetTransfer(env.services_root, locationId, receiver, sender, amount, wallet);
-    }
-
-    /**
-     * @param {string} claimId key of the credit claim to read the data for
-     */
-    getCreditClaimData(claimId) {
-        const {
-            api, env_params: env,
-        } = this.comoData;
-        return api.getCreditClaimData(env.services_root, claimId);
-    }
-
-
-    /**
-     * @param {String} claimCode to use for budget transfer claim
-     */
-    async budgetTransferClaim(claimCode) {
-        const {
-            api, locationId, env_params: env,
-        } = this.comoData;
-        return api.budgetTransferClaim(env.services_root, locationId, claimCode);
-    }
-
-    /**
-     * API call for claim generic action. To specify your trigger button, you need to associate it with a particular item, asset or tag.
-     * @param {string} assetKey - asset to claim
-     * @param {string} itemId - item id to claim
-     * @param {string} tag - claim all with tag
-     */
-    claim(assetKey, itemId, tag) {
-        const {
-            env_params: env, locationId, api,
-        } = this.comoData;
-        return api.claim(env.zapp_root, locationId, assetKey, itemId, tag);
-    }
-
-    /**
-     * Log user action
-     * @param {string} action
-     * @param {string} logData - log information
-     */
-    async logUserAction(action, logData) {
-        const {
-            env_params: env, locationId, api,
-        } = this.comoData;
-        return api.logUserAction(env.zapp_root, locationId, action, logData);
-    }
-
-    /**
-     * Member purchase history
-     * @param {string} limit - how manay items to return (if exists) -  default value is 25
-     * @param {string} offset - default value is 0(next offset would be 25)
-     */
-    async getPurchaseHistory(limit, offset) {
-        const {
-            locationId, api, membership,
-        } = this.comoData;
-        return api.getPurchaseHistory(locationId, membership.Key, limit, offset);
-    }
-
-    /**
-     * Get app texts for multi languages - only for apps that has project set in translation service
-     */
-    getAppTextsV2() {
-        const { api, locationId } = this.comoData;
-        return api.getAllTranslations(locationId);
-    }
-
-    /**
-     * Generate a temporary token for the location
-     * @param {number} timeToLive time to live in seconds
-     * @returns {string} temporary token
-     */
-    async generateTemporaryToken(timeToLive = 60) {
-        const { api, locationId, env_params: env } = this.comoData;
-        return api.generateTemporaryToken(env.services_root, locationId, timeToLive);
-    }
-}
-
-module.exports = Como;