@tolgee/core 5.0.0-alpha.1 → 5.0.0-alpha.2

package/dist/tolgee.umd.js

@@ -45,8 +45,16 @@
     function sanitizeUrl(url) {
         return url ? url.replace(/\/+$/, '') : url;
     }
+    function getErrorMessage(error) {
+        if (typeof error === 'string') {
+            return error;
+        }
+        else if (typeof (error === null || error === void 0 ? void 0 : error.message) === 'string') {
+            return error.message;
+        }
+    }
 
-    const EventEmitter = () => {
+    const EventEmitter = (isActive) => {
         let handlers = [];
         const listen = (handler) => {
             const handlerWrapper = (e) => {
@@ -60,12 +68,14 @@
             };
         };
         const emit = (data) => {
-            handlers.forEach((handler) => handler({ value: data }));
+            if (isActive()) {
+                handlers.forEach((handler) => handler({ value: data }));
+            }
         };
         return Object.freeze({ listen, emit });
     };
 
-    const EventEmitterSelective = (getFallbackNs, getDefaultNs) => {
+    const EventEmitterSelective = (isActive, getFallbackNs, getDefaultNs) => {
         const listeners = new Set();
         const partialListeners = new Set();
         const listen = (handler) => {
@@ -139,26 +149,32 @@
             callHandlers(namespacesArray);
         };
         const emit = (ns, delayed) => {
-            queue.push(ns);
-            if (!delayed) {
-                solveQueue();
-            }
-            else {
-                setTimeout(solveQueue, 0);
+            if (isActive()) {
+                queue.push(ns);
+                if (!delayed) {
+                    solveQueue();
+                }
+                else {
+                    setTimeout(solveQueue, 0);
+                }
             }
         };
         return Object.freeze({ listenSome, listen, emit });
     };
 
     const Events = (getFallbackNs, getDefaultNs) => {
-        const onPendingLanguageChange = EventEmitter();
-        const onLanguageChange = EventEmitter();
-        const onLoadingChange = EventEmitter();
-        const onFetchingChange = EventEmitter();
-        const onInitialLoaded = EventEmitter();
-        const onRunningChange = EventEmitter();
-        const onCacheChange = EventEmitter();
-        const onUpdate = EventEmitterSelective(getFallbackNs, getDefaultNs);
+        let emitterActive = true;
+        function isActive() {
+            return emitterActive;
+        }
+        const onPendingLanguageChange = EventEmitter(isActive);
+        const onLanguageChange = EventEmitter(isActive);
+        const onLoadingChange = EventEmitter(isActive);
+        const onFetchingChange = EventEmitter(isActive);
+        const onInitialLoaded = EventEmitter(isActive);
+        const onRunningChange = EventEmitter(isActive);
+        const onCacheChange = EventEmitter(isActive);
+        const onUpdate = EventEmitterSelective(isActive, getFallbackNs, getDefaultNs);
         onInitialLoaded.listen(() => onUpdate.emit());
         onLanguageChange.listen(() => onUpdate.emit());
         onCacheChange.listen(({ value }) => {
@@ -184,6 +200,9 @@
                     return onUpdate.listen(handler);
             }
         };
+        function setEmmiterActive(active) {
+            emitterActive = active;
+        }
         return Object.freeze({
             onPendingLanguageChange,
             onLanguageChange,
@@ -193,6 +212,7 @@
             onRunningChange,
             onCacheChange,
             onUpdate,
+            setEmmiterActive,
             on,
         });
     };
@@ -432,9 +452,78 @@
         });
     };
 
+    /******************************************************************************
+    Copyright (c) Microsoft Corporation.
+
+    Permission to use, copy, modify, and/or distribute this software for any
+    purpose with or without fee is hereby granted.
+
+    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+    REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+    AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+    INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+    LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+    OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+    PERFORMANCE OF THIS SOFTWARE.
+    ***************************************************************************** */
+
+    function __rest(s, e) {
+        var t = {};
+        for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+            t[p] = s[p];
+        if (s != null && typeof Object.getOwnPropertySymbols === "function")
+            for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+                if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                    t[p[i]] = s[p[i]];
+            }
+        return t;
+    }
+
+    const defaultObserverOptions = {
+        tagAttributes: {
+            textarea: ['placeholder'],
+            input: ['value', 'placeholder'],
+            img: ['alt'],
+            '*': ['aria-label', 'title'],
+        },
+        restrictedElements: ['script', 'style'],
+        highlightKeys: ['Alt'],
+        highlightColor: 'rgb(255, 0, 0)',
+        highlightWidth: 5,
+        inputPrefix: '%-%tolgee:',
+        inputSuffix: '%-%',
+        passToParent: ['option', 'optgroup'],
+    };
+
+    const DEFAULT_FORMAT_ERROR = 'invalid';
+    const defaultValues = {
+        defaultNs: '',
+        observerOptions: defaultObserverOptions,
+        observerType: 'invisible',
+        onFormatError: DEFAULT_FORMAT_ERROR,
+    };
+    const combineOptions = (...states) => {
+        let result = {};
+        states.forEach((state) => {
+            result = Object.assign(Object.assign(Object.assign({}, result), state), { observerOptions: Object.assign(Object.assign({}, result.observerOptions), state === null || state === void 0 ? void 0 : state.observerOptions) });
+        });
+        return result;
+    };
+    const initState = (options, previousState) => {
+        const initialOptions = combineOptions(defaultValues, previousState === null || previousState === void 0 ? void 0 : previousState.initialOptions, options);
+        // remove extra '/' from url end
+        initialOptions.apiUrl = sanitizeUrl(initialOptions.apiUrl);
+        return {
+            initialOptions,
+            activeNamespaces: (previousState === null || previousState === void 0 ? void 0 : previousState.activeNamespaces) || new Map(),
+            language: previousState === null || previousState === void 0 ? void 0 : previousState.language,
+            pendingLanguage: previousState === null || previousState === void 0 ? void 0 : previousState.language,
+            isInitialLoading: false,
+            isRunning: false,
+        };
+    };
+
     const Plugins = (getLanguage, getInitialOptions, getAvailableLanguages, getTranslationNs, getTranslation, changeTranslation) => {
-        let prepared = false;
-        let onPrepareQueue = [];
         const plugins = {
             ui: undefined,
             observer: undefined,
@@ -495,7 +584,7 @@
             instances.finalFormatter = formatter;
         };
         const setUi = (ui) => {
-            plugins.ui = (ui === null || ui === void 0 ? void 0 : ui.UI) || ui;
+            plugins.ui = ui;
         };
         const hasUi = () => {
             return Boolean(plugins.ui);
@@ -503,6 +592,9 @@
         const setLanguageStorage = (storage) => {
             instances.languageStorage = storage;
         };
+        const getLanguageStorage = () => {
+            return instances.languageStorage;
+        };
         const setStoredLanguage = (language) => {
             var _a;
             (_a = instances.languageStorage) === null || _a === void 0 ? void 0 : _a.setLanguage(language);
@@ -542,11 +634,11 @@
         const setDevBackend = (backend) => {
             instances.devBackend = backend;
         };
-        const run = (isDev) => {
-            var _a, _b;
-            if (!instances.ui && plugins.ui) {
+        const run = () => {
+            var _a, _b, _c;
+            if (!instances.ui) {
                 const { apiKey, apiUrl, projectId } = getInitialOptions();
-                instances.ui = new plugins.ui({
+                instances.ui = (_a = plugins.ui) === null || _a === void 0 ? void 0 : _a.call(plugins, {
                     apiKey: apiKey,
                     apiUrl: apiUrl,
                     projectId,
@@ -555,13 +647,13 @@
                 });
             }
             if (!instances.observer) {
-                instances.observer = (_a = plugins.observer) === null || _a === void 0 ? void 0 : _a.call(plugins, {
+                instances.observer = (_b = plugins.observer) === null || _b === void 0 ? void 0 : _b.call(plugins, {
                     translate,
                     onClick,
                     options: getInitialOptions().observerOptions,
                 });
             }
-            (_b = instances.observer) === null || _b === void 0 ? void 0 : _b.run({ mouseHighlight: isDev });
+            (_c = instances.observer) === null || _c === void 0 ? void 0 : _c.run({ mouseHighlight: true });
         };
         const getDevBackend = () => {
             return instances.devBackend;
@@ -604,9 +696,6 @@
             var _a;
             (_a = instances.observer) === null || _a === void 0 ? void 0 : _a.retranslate();
         };
-        const onPrepare = (callback) => {
-            onPrepareQueue.push(callback);
-        };
         function addPlugin(tolgeeInstance, plugin) {
             const pluginTools = Object.freeze({
                 setFinalFormatter,
@@ -619,46 +708,68 @@
                 addBackend,
                 setLanguageDetector,
                 setLanguageStorage,
-                onPrepare,
             });
             plugin(tolgeeInstance, pluginTools);
-            if (prepared) {
-                prepare();
-            }
         }
-        function formatTranslation({ key, translation, defaultValue, noWrap, params, orEmpty, ns, formatEnabled, }) {
-            var _a;
+        function formatTranslation(_a) {
+            var _b;
+            var { formatEnabled } = _a, props = __rest(_a, ["formatEnabled"]);
+            const { key, translation, defaultValue, noWrap, params, orEmpty, ns } = props;
             const formattableTranslation = translation || defaultValue;
             let result = formattableTranslation || (orEmpty ? '' : key);
-            if (instances.observer && !noWrap) {
-                result = instances.observer.wrap({
-                    key,
-                    translation: result,
-                    defaultValue,
-                    params,
-                    ns,
-                });
-            }
             const language = getLanguage();
-            const isFormatEnabled = formatEnabled || !((_a = instances.observer) === null || _a === void 0 ? void 0 : _a.outputNotFormattable);
-            if (formattableTranslation && language && isFormatEnabled) {
-                for (const formatter of instances.formatters) {
-                    result = formatter.format({
+            const isFormatEnabled = formatEnabled || !((_b = instances.observer) === null || _b === void 0 ? void 0 : _b.outputNotFormattable);
+            const wrap = (result) => {
+                if (instances.observer && !noWrap) {
+                    return instances.observer.wrap({
+                        key,
+                        translation: result,
+                        defaultValue,
+                        params,
+                        ns,
+                    });
+                }
+                return result;
+            };
+            result = wrap(result);
+            try {
+                if (formattableTranslation && language && isFormatEnabled) {
+                    for (const formatter of instances.formatters) {
+                        result = formatter.format({
+                            translation: result,
+                            language,
+                            params,
+                        });
+                    }
+                }
+                if (instances.finalFormatter &&
+                    formattableTranslation &&
+                    language &&
+                    isFormatEnabled) {
+                    result = instances.finalFormatter.format({
                         translation: result,
                         language,
                         params,
                     });
                 }
             }
-            if (instances.finalFormatter &&
-                formattableTranslation &&
-                language &&
-                isFormatEnabled) {
-                result = instances.finalFormatter.format({
-                    translation: result,
-                    language,
-                    params,
-                });
+            catch (e) {
+                // eslint-disable-next-line no-console
+                console.error(e);
+                const errorMessage = getErrorMessage(e) || DEFAULT_FORMAT_ERROR;
+                const onFormatError = getInitialOptions().onFormatError;
+                const formatErrorType = typeof onFormatError;
+                if (formatErrorType === 'string') {
+                    result = onFormatError;
+                }
+                else if (formatErrorType === 'function') {
+                    result = onFormatError(errorMessage, props);
+                }
+                else {
+                    result = DEFAULT_FORMAT_ERROR;
+                }
+                // wrap error message, so it's detectable
+                result = wrap(result);
             }
             return result;
         }
@@ -672,22 +783,14 @@
             }
             return params.translation;
         };
-        function prepare() {
-            prepared = true;
-            while (onPrepareQueue.length) {
-                const queue = onPrepareQueue;
-                onPrepareQueue = [];
-                queue.forEach((callback) => callback());
-            }
-        }
         return Object.freeze({
-            prepare,
             addPlugin,
             formatTranslation,
             getDevBackend,
             getBackendRecord,
             getBackendDevRecord,
             getLanguageDetector,
+            getLanguageStorage,
             getInitialLanguage,
             setStoredLanguage,
             run,
@@ -718,48 +821,6 @@
         });
     };
 
-    const defaultObserverOptions = {
-        tagAttributes: {
-            textarea: ['placeholder'],
-            input: ['value', 'placeholder'],
-            img: ['alt'],
-            '*': ['aria-label', 'title'],
-        },
-        restrictedElements: ['script', 'style'],
-        highlightKeys: ['Alt'],
-        highlightColor: 'rgb(255, 0, 0)',
-        highlightWidth: 5,
-        inputPrefix: '%-%tolgee:',
-        inputSuffix: '%-%',
-        passToParent: ['option', 'optgroup'],
-    };
-
-    const defaultValues = {
-        defaultNs: '',
-        observerOptions: defaultObserverOptions,
-        observerType: 'invisible',
-    };
-    const combineOptions = (...states) => {
-        let result = {};
-        states.forEach((state) => {
-            result = Object.assign(Object.assign(Object.assign({}, result), state), { observerOptions: Object.assign(Object.assign({}, result.observerOptions), state === null || state === void 0 ? void 0 : state.observerOptions) });
-        });
-        return result;
-    };
-    const initState = (options, previousState) => {
-        const initialOptions = combineOptions(defaultValues, previousState === null || previousState === void 0 ? void 0 : previousState.initialOptions, options);
-        // remove extra '/' from url end
-        initialOptions.apiUrl = sanitizeUrl(initialOptions.apiUrl);
-        return {
-            initialOptions,
-            activeNamespaces: (previousState === null || previousState === void 0 ? void 0 : previousState.activeNamespaces) || new Map(),
-            language: previousState === null || previousState === void 0 ? void 0 : previousState.language,
-            pendingLanguage: previousState === null || previousState === void 0 ? void 0 : previousState.language,
-            isInitialLoading: false,
-            isRunning: false,
-        };
-    };
-
     const State = (onLanguageChange, onPendingLanguageChange, onRunningChange) => {
         let state = initState();
         let devCredentials = undefined;
@@ -897,33 +958,6 @@
         });
     };
 
-    /******************************************************************************
-    Copyright (c) Microsoft Corporation.
-
-    Permission to use, copy, modify, and/or distribute this software for any
-    purpose with or without fee is hereby granted.
-
-    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-    REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-    AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-    INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-    LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-    OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-    PERFORMANCE OF THIS SOFTWARE.
-    ***************************************************************************** */
-
-    function __rest(s, e) {
-        var t = {};
-        for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-            t[p] = s[p];
-        if (s != null && typeof Object.getOwnPropertySymbols === "function")
-            for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-                if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                    t[p[i]] = s[p[i]];
-            }
-        return t;
-    }
-
     function parseCombinedOptions(_a) {
         var { ns, noWrap, orEmpty, params } = _a, rest = __rest(_a, ["ns", "noWrap", "orEmpty", "params"]);
         const options = {
@@ -1121,15 +1155,15 @@
             return cache.loadRecords(descriptors, isDev());
         }
         const checkCorrectConfiguration = () => {
-            const languageDetector = pluginService.getLanguageDetector();
-            if (languageDetector) {
+            const languageComputable = pluginService.getLanguageDetector() || pluginService.getLanguageStorage();
+            if (languageComputable) {
                 const availableLanguages = state.getAvailableLanguages();
                 if (!availableLanguages) {
                     throw new Error(missingOptionError('availableLanguages'));
                 }
             }
             if (!state.getLanguage() && !state.getInitialOptions().defaultLanguage) {
-                if (languageDetector) {
+                if (languageComputable) {
                     throw new Error(missingOptionError('defaultLanguage'));
                 }
                 else {
@@ -1145,7 +1179,7 @@
                     cache.invalidate();
                 }
                 state.setRunning(true);
-                pluginService.run(isDev());
+                pluginService.run();
                 result = loadInitial();
             }
             return Promise.resolve(result);
@@ -1207,6 +1241,10 @@
              * ```
              */
             onNsUpdate: controller.onUpdate.listenSome,
+            /**
+             * Turn off/on events emitting. Is on by default.
+             */
+            setEmmiterActive: controller.setEmmiterActive,
             /**
              * @return current language if set.
              */
@@ -1321,13 +1359,17 @@
              */
             unwrap: controller.unwrap,
             /**
-             * Override creadentials passed on initialization
+             * Override creadentials passed on initialization.
+             *
+             * When called in running state, tolgee stops and runs again.
              */
             overrideCredentials(credentials) {
                 withRestart(() => controller.overrideCredentials(credentials));
             },
             /**
-             * Add tolgee plugin.
+             * Add tolgee plugin after initialization.
+             *
+             * When called in running state, tolgee stops and runs again.
              */
             addPlugin(plugin) {
                 if (plugin) {
@@ -1356,7 +1398,7 @@
      * const tolgee = Tolgee().use(...).init(...)
      * ```
      */
-    const Tolgee = () => {
+    const TolgeeCore = () => {
         const state = {
             plugins: [],
             options: {},
@@ -1534,7 +1576,7 @@
     };
 
     exports.FormatSimple = FormatSimple;
-    exports.Tolgee = Tolgee;
+    exports.TolgeeCore = TolgeeCore;
     exports.getFallback = getFallback;
     exports.getFallbackArray = getFallbackArray;
     exports.getTranslateProps = getTranslateProps;