@tolgee/core 4.9.2 → 4.9.3-rc.d287ae9.0

package/src/Tolgee.test.ts

@@ -1,473 +0,0 @@
-jest.dontMock('./Tolgee');
-jest.dontMock('./services/DependencyService');
-
-import '@testing-library/jest-dom/extend-expect';
-import { mocked } from 'jest-mock';
-import { Tolgee } from './Tolgee';
-import {
-  configMock,
-  coreServiceMock,
-  eventServiceMock,
-  getMockedInstance,
-  observerMock,
-  propertiesMock,
-  textServiceMock,
-  translationServiceMock,
-} from '@testFixtures/mocked';
-import { EventEmitterImpl } from './services/EventEmitter';
-import { TextService } from './services/TextService';
-import { TextWrapper } from './wrappers/text/TextWrapper';
-import { ElementRegistrar } from './services/ElementRegistrar';
-import { NodeHelper } from './helpers/NodeHelper';
-import { TOLGEE_TARGET_ATTRIBUTE } from './Constants/Global';
-import { Properties } from './Properties';
-import { waitFor } from '@testing-library/dom';
-import { Translations } from './types';
-
-describe('Tolgee', () => {
-  let tolgee: Tolgee;
-
-  beforeEach(() => {
-    jest.clearAllMocks();
-    tolgee = Tolgee.init({});
-  });
-
-  test('can be created', () => {
-    expect(tolgee).not.toBeNull();
-  });
-
-  test('returns proper default language', () => {
-    configMock.mock.instances[0].defaultLanguage = 'testDefaultLanguage';
-    expect(configMock).toBeCalledTimes(1);
-    expect(tolgee.defaultLanguage).toEqual('testDefaultLanguage');
-  });
-
-  test('returns proper language', () => {
-    propertiesMock.mock.instances[0].currentLanguage = 'currentLang';
-    expect(tolgee.lang).toEqual('currentLang');
-  });
-
-  test('will load api key details', async () => {
-    propertiesMock.mock.instances[0].mode = 'development';
-    await tolgee.run();
-    expect(
-      coreServiceMock.mock.instances[0].loadApiKeyDetails
-    ).toHaveBeenCalledTimes(1);
-    expect(
-      coreServiceMock.mock.instances[0].loadApiKeyDetails
-    ).toHaveBeenCalledWith();
-  });
-
-  test('will not set properties.scopes on run in production mode', async () => {
-    propertiesMock.mock.instances[0].mode = 'production';
-    await tolgee.run();
-    expect(coreServiceMock.mock.instances[0].getApiKeyDetails).toBeCalledTimes(
-      0
-    );
-    expect(propertiesMock.mock.instances[0].scopes).toBeUndefined();
-  });
-
-  test('will run the observer when watch is on', async () => {
-    propertiesMock.mock.instances[0].config.watch = true;
-    await tolgee.run();
-    expect(observerMock.mock.instances[0].observe).toBeCalledTimes(1);
-  });
-
-  test('will not the observer when watch is off', async () => {
-    propertiesMock.mock.instances[0].config.watch = false;
-    await tolgee.run();
-    expect(observerMock.mock.instances[0].observe).toBeCalledTimes(0);
-  });
-
-  test('will try to get translations with current language from properties', async () => {
-    propertiesMock.mock.instances[0].currentLanguage = 'dummyLang';
-    await tolgee.run();
-    expect(
-      translationServiceMock.mock.instances[0].loadTranslations
-    ).toBeCalledWith();
-  });
-
-  test('will try to get translations with current language from properties', async () => {
-    propertiesMock.mock.instances[0].currentLanguage = 'dummyLang';
-    propertiesMock.mock.instances[0].config.preloadFallback = true;
-    propertiesMock.mock.instances[0].config.fallbackLanguage = 'fallbackLang';
-    await tolgee.run();
-    expect(
-      translationServiceMock.mock.instances[0].loadTranslations
-    ).toBeCalledWith();
-    expect(
-      translationServiceMock.mock.instances[0].loadTranslations
-    ).toBeCalledWith('fallbackLang');
-  });
-
-  test('will refresh translations using observer on run', async () => {
-    const htmlElement = document.createElement('dummyElement');
-    propertiesMock.mock.instances[0].config.targetElement = htmlElement;
-    await tolgee.run();
-    expect(getMockedInstance(TextWrapper).handleSubtree).toBeCalledWith(
-      htmlElement
-    );
-  });
-
-  test('will refresh translations using observer on refresh', async () => {
-    const htmlElement = document.createElement('dummyElement');
-    propertiesMock.mock.instances[0].config.targetElement = htmlElement;
-    await tolgee.run();
-    await tolgee.refresh();
-    expect(getMockedInstance(TextWrapper).handleSubtree).toBeCalledWith(
-      htmlElement
-    );
-  });
-
-  test('will get defaultLanguage from config', async () => {
-    propertiesMock.mock.instances[0].config.defaultLanguage = 'dummyLang';
-    expect(tolgee.defaultLanguage).toEqual('dummyLang');
-  });
-
-  describe('translation functions', () => {
-    const translatedDummyText = 'translatedDummyText';
-    const wrappedDummyText = 'wrappedDummyText';
-    const dummyKey = 'dummyText';
-    let mockedTranslate;
-    let mockedInstant;
-    let mockedWrap;
-    let mockedLoadTranslations;
-    const dummyParams = {};
-
-    beforeEach(() => {
-      tolgee.run();
-      mockedTranslate = mocked(textServiceMock.mock.instances[0].translate);
-      mockedInstant = mocked(textServiceMock.mock.instances[0].instant);
-      mockedWrap = getMockedInstance(TextWrapper).wrap;
-      mockedLoadTranslations = mocked(
-        translationServiceMock.mock.instances[0].loadTranslations
-      );
-      mockedTranslate.mockImplementation(async () => translatedDummyText);
-      mockedInstant.mockImplementation(() => translatedDummyText);
-      mockedWrap.mockImplementation(() => wrappedDummyText);
-    });
-
-    describe('async translate', () => {
-      test('will return wrapped string from text service in development mode', async () => {
-        propertiesMock.mock.instances[0].mode = 'development';
-        const translated = await tolgee.translate(dummyKey, dummyParams);
-
-        expect(mockedWrap).toBeCalledWith(
-          dummyKey,
-          dummyParams,
-          undefined,
-          'translatedDummyText'
-        );
-        expect(translated).toEqual(wrappedDummyText);
-      });
-
-      test('will return translated string from text service in production mode', async () => {
-        propertiesMock.mock.instances[0].mode = 'production';
-        const translated = await tolgee.translate(dummyKey, dummyParams);
-
-        expect(translated).toEqual(translatedDummyText);
-        expect(mockedWrap).not.toBeCalled();
-        expect(mockedTranslate).toBeCalledWith(
-          dummyKey,
-          dummyParams,
-          undefined,
-          undefined,
-          undefined
-        );
-      });
-
-      test('will not wrap when development is on, but noWrap is true', async () => {
-        propertiesMock.mock.instances[0].mode = 'development';
-        const translated = await tolgee.translate(dummyKey, dummyParams, true);
-
-        expect(mockedWrap).not.toBeCalled();
-        expect(translated).toEqual(translatedDummyText);
-      });
-
-      test('will wait for translations load before wrapping', async () => {
-        propertiesMock.mock.instances[0].mode = 'development';
-        await tolgee.translate(dummyKey, dummyParams);
-        expect(mockedLoadTranslations).toBeCalled();
-      });
-
-      test('passes default value to wrap fn', async () => {
-        propertiesMock.mock.instances[0].mode = 'development';
-        await tolgee.translate(dummyKey, dummyParams, false, 'Default');
-        expect(mockedWrap).toBeCalledWith(
-          'dummyText',
-          {},
-          'Default',
-          'translatedDummyText'
-        );
-      });
-
-      test('passes default value to translate fn', async () => {
-        propertiesMock.mock.instances[0].mode = 'development';
-        await tolgee.translate(dummyKey, dummyParams, true, 'Default');
-        expect(mockedTranslate).toBeCalledWith(
-          'dummyText',
-          {},
-          undefined,
-          undefined,
-          'Default'
-        );
-      });
-
-      test('props object works correctly', async () => {
-        propertiesMock.mock.instances[0].mode = 'development';
-        await tolgee.translate({
-          key: dummyKey,
-          params: dummyParams,
-          noWrap: true,
-          defaultValue: 'Default',
-        });
-        expect(mockedTranslate).toBeCalledWith(
-          dummyKey,
-          dummyParams,
-          undefined,
-          undefined,
-          'Default'
-        );
-      });
-
-      test('passes orEmpty correctly', async () => {
-        propertiesMock.mock.instances[0].mode = 'development';
-        await tolgee.translate({
-          key: dummyKey,
-          params: dummyParams,
-          noWrap: true,
-          orEmpty: true,
-        });
-        expect(mockedTranslate).toBeCalledWith(
-          dummyKey,
-          dummyParams,
-          undefined,
-          true,
-          undefined
-        );
-      });
-    });
-
-    describe('sync instant', () => {
-      test('will return wrapped string from text service in development mode', async () => {
-        propertiesMock.mock.instances[0].mode = 'development';
-        const dummyParams = {};
-        const translated = tolgee.instant(dummyKey, dummyParams);
-
-        expect(mockedWrap).toBeCalledWith(
-          dummyKey,
-          dummyParams,
-          undefined,
-          'translatedDummyText'
-        );
-        expect(translated).toEqual(wrappedDummyText);
-      });
-
-      test('will return translated string from text service in production mode', async () => {
-        propertiesMock.mock.instances[0].mode = 'production';
-        const translated = tolgee.instant(dummyKey, dummyParams);
-
-        expect(translated).toEqual(translatedDummyText);
-        expect(mockedWrap).not.toBeCalled();
-        expect(mockedInstant).toBeCalledWith(
-          dummyKey,
-          dummyParams,
-          undefined,
-          undefined,
-          undefined
-        );
-      });
-
-      test('will pass noEmpty parameter', () => {
-        tolgee.instant(dummyKey, dummyParams, undefined, true);
-        expect(mockedInstant).toBeCalledWith(
-          dummyKey,
-          dummyParams,
-          undefined,
-          true,
-          undefined
-        );
-      });
-
-      test('will not wrap when development is on, but noWrap is true', async () => {
-        propertiesMock.mock.instances[0].mode = 'development';
-        const translated = tolgee.instant(dummyKey, dummyParams, true);
-
-        expect(mockedWrap).not.toBeCalled();
-        expect(translated).toEqual(translatedDummyText);
-      });
-
-      test('will call instant with orEmpty true', async () => {
-        tolgee.instant(dummyKey, dummyParams, true, true);
-        expect(getMockedInstance(TextService).instant).toBeCalledWith(
-          dummyKey,
-          dummyParams,
-          undefined,
-          true,
-          undefined
-        );
-      });
-
-      test('passes default value to wrap fn', async () => {
-        propertiesMock.mock.instances[0].mode = 'development';
-        const dummyParams = {};
-        tolgee.instant(dummyKey, dummyParams, false, false, 'Default');
-
-        expect(mockedWrap).toBeCalledWith(
-          dummyKey,
-          dummyParams,
-          'Default',
-          'translatedDummyText'
-        );
-      });
-
-      test('props object works correctly', async () => {
-        propertiesMock.mock.instances[0].mode = 'development';
-        await tolgee.instant({
-          key: dummyKey,
-          params: dummyParams,
-          orEmpty: false,
-          noWrap: true,
-          defaultValue: 'Default',
-        });
-        expect(mockedInstant).toBeCalledWith(
-          dummyKey,
-          dummyParams,
-          undefined,
-          false,
-          'Default'
-        );
-      });
-    });
-
-    test('passes default value to instant fn', async () => {
-      propertiesMock.mock.instances[0].mode = 'development';
-      const dummyParams = {};
-      tolgee.instant(dummyKey, dummyParams, true, false, 'Default');
-
-      expect(mockedInstant).toBeCalledWith(
-        dummyKey,
-        dummyParams,
-        undefined,
-        false,
-        'Default'
-      );
-    });
-  });
-
-  test('will stop on stop function', () => {
-    getMockedInstance(Properties).config.targetElement = document.body;
-    NodeHelper.markElementAsTargetElement(document.body);
-    tolgee.run();
-    tolgee.stop();
-    expect(getMockedInstance(ElementRegistrar).cleanAll).toBeCalledTimes(1);
-    expect(observerMock.mock.instances[0].stopObserving).toBeCalledTimes(1);
-    expect(document.body).not.toHaveAttribute(TOLGEE_TARGET_ATTRIBUTE);
-  });
-
-  test('will return proper onLangChange emitter', () => {
-    const eventEmitter = new EventEmitterImpl();
-    (eventServiceMock.mock.instances[0] as any).LANGUAGE_CHANGED = eventEmitter;
-    expect(tolgee.onLangChange).toEqual(eventEmitter);
-  });
-
-  test('will return proper initialLoading', () => {
-    tolgee.properties.mode = 'production';
-    tolgee.properties.config.preloadFallback = true;
-    tolgee.properties.currentLanguage = 'cs';
-    tolgee.properties.config.staticData = {
-      cs: {},
-    };
-    expect(tolgee.initialLoading).toEqual(true);
-    tolgee.properties.config.fallbackLanguage = 'en';
-    tolgee.properties.config.preloadFallback = false;
-    expect(tolgee.initialLoading).toEqual(false);
-    tolgee.properties.config.preloadFallback = true;
-    tolgee.properties.config.staticData.en = {};
-    expect(tolgee.initialLoading).toEqual(false);
-    tolgee.properties.mode = 'development';
-    expect(tolgee.initialLoading).toEqual(false);
-  });
-
-  describe('lang setter', () => {
-    const dummyLang = 'dummyLang';
-    let loadTranslationsResolve: (value: Translations) => void;
-    let languageChangedEmitter;
-
-    beforeEach(() => {
-      languageChangedEmitter = (
-        eventServiceMock.mock.instances[0] as any
-      ).LANGUAGE_CHANGED = {
-        emit: jest.fn(),
-      };
-
-      translationServiceMock.mock.instances[0].loadTranslations = jest.fn(
-        async () =>
-          new Promise((resolve) => {
-            loadTranslationsResolve = resolve;
-          })
-      );
-      tolgee.lang = dummyLang;
-    });
-
-    test('will change the language', () => {
-      expect(propertiesMock.mock.instances[0].currentLanguage).toEqual(
-        dummyLang
-      );
-    });
-
-    test('emits the changed event', async () => {
-      expect(languageChangedEmitter.emit).toBeCalledTimes(0);
-      loadTranslationsResolve({});
-      await waitFor(() => {
-        expect(languageChangedEmitter.emit).toBeCalledTimes(1);
-        expect(languageChangedEmitter.emit).toBeCalledWith(dummyLang);
-      });
-    });
-  });
-
-  describe('changeLanguage method', () => {
-    const dummyLang = 'dummyLang';
-    let loadTranslationsResolve: (value: Translations) => void;
-    let languageChanged;
-    let changeLanguagePromise: Promise<void>;
-
-    beforeEach(() => {
-      languageChanged = (
-        eventServiceMock.mock.instances[0] as any
-      ).LANGUAGE_CHANGED = {
-        emit: jest.fn(),
-      };
-
-      translationServiceMock.mock.instances[0].loadTranslations = jest.fn(
-        async () =>
-          new Promise((resolve) => {
-            loadTranslationsResolve = resolve;
-          })
-      );
-      changeLanguagePromise = tolgee.changeLanguage(dummyLang);
-    });
-
-    test('will change the language', (done) => {
-      expect(propertiesMock.mock.instances[0].currentLanguage).not.toEqual(
-        dummyLang
-      );
-      changeLanguagePromise.then(() => {
-        expect(propertiesMock.mock.instances[0].currentLanguage).toEqual(
-          dummyLang
-        );
-        done();
-      });
-      loadTranslationsResolve({});
-    });
-
-    test('emits the change and loaded event', (done) => {
-      expect(languageChanged.emit).toBeCalledTimes(0);
-      changeLanguagePromise.then(() => {
-        expect(languageChanged.emit).toBeCalledTimes(1);
-        done();
-      });
-      loadTranslationsResolve({});
-    });
-  });
-});

package/src/TolgeeConfig.test.ts

@@ -1,21 +0,0 @@
-jest.dontMock('./TolgeeConfig');
-
-import { TolgeeConfig } from './TolgeeConfig';
-
-describe('TolgeeConfig', () => {
-  test('will be created with default targetElement', () => {
-    const tolgeeConfig = new TolgeeConfig();
-    expect(tolgeeConfig.targetElement).toEqual(document.body);
-  });
-
-  test('will be created with provided targetElement', () => {
-    const div = document.createElement('div');
-    const tolgeeConfig = new TolgeeConfig({ targetElement: div });
-    expect(tolgeeConfig.targetElement).toEqual(div);
-  });
-
-  test('will be created with default when empty object', () => {
-    const tolgeeConfig = new TolgeeConfig({});
-    expect(tolgeeConfig.targetElement).toEqual(document.body);
-  });
-});

package/src/TolgeeConfig.ts

@@ -1,134 +0,0 @@
-import { TreeTranslationsData } from './types';
-import { NodeHelper } from './helpers/NodeHelper';
-import { ModifierKey } from './Constants/ModifierKey';
-import { Mode } from 'fs';
-
-const API_KEY_LOCAL_STORAGE = '__tolgee_apiKey';
-const API_URL_LOCAL_STORAGE = '__tolgee_apiUrl';
-
-const DEFAULT_TARGET_ELEMENT_SUPPLIER = () => {
-  if (typeof document !== 'undefined') {
-    return document.body;
-  }
-};
-
-type UiConstructor = new (...args) => any;
-
-interface UiLibInterface {
-  UI: UiConstructor;
-}
-
-type UiType =
-  | UiConstructor
-  | UiLibInterface
-  | Promise<UiConstructor>
-  | Promise<UiLibInterface>;
-
-export class TolgeeConfig {
-  /**
-   * @deprecated This option won't have any effect,
-   * because mode is now automatically detected when apiKey + apiUrl are set
-   */
-  mode?: Mode;
-  apiUrl?: string;
-  apiKey?: string;
-  inputPrefix?: string = '%-%tolgee:';
-  inputSuffix?: string = '%-%';
-  /**
-   * Overrides all language settings
-   */
-  forceLanguage?: string;
-  /**
-   * Used when auto detection is not available or is turned off
-   */
-  defaultLanguage?: string = 'en';
-  /**
-   * Languages which can be used for language detection
-   * and also limits which values can be stored
-   */
-  availableLanguages?: string[];
-  /**
-   * Language which is used when no translation is available for current one
-   */
-  fallbackLanguage?: string;
-  /**
-   * Store user language in localStorage (default: true)
-   */
-  enableLanguageStore?: boolean = true;
-  /**
-   * Use auto language detection by browser locale (default: true)
-   */
-  enableLanguageDetection?: boolean = true;
-  filesUrlPrefix?: string = 'i18n/';
-  watch?: boolean;
-  ui?: UiType;
-  targetElement?: Element;
-  tagAttributes?: { [key: string]: string[] } = {
-    textarea: ['placeholder'],
-    input: ['value', 'placeholder'],
-    img: ['alt'],
-    '*': ['aria-label', 'title'],
-  };
-  highlightKeys?: ModifierKey[] = [ModifierKey.Alt];
-  passToParent?:
-    | (keyof HTMLElementTagNameMap)[]
-    | ((node: Element) => boolean) = ['option', 'optgroup'];
-  restrictedElements?: string[] = ['script', 'style'];
-  highlightColor?: string = 'rgb(255, 0, 0)';
-  highlightWidth?: number = 5;
-  /** localization data to use in production mode */
-  staticData?: {
-    [key: string]: TreeTranslationsData | (() => Promise<TreeTranslationsData>);
-  };
-  wrapperMode?: 'text' | 'invisible' = 'text';
-
-  /**
-   * When true, fallback language will be preloaded on Tolgee.run
-   */
-  preloadFallback?: boolean = false;
-  private _targetElement?: Element;
-
-  constructor(config?: TolgeeConfig) {
-    //workaround for: https://stackoverflow.com/questions/48725916/typescript-optional-property-with-a-getter
-    Object.defineProperty(this, 'targetElement', {
-      set(targetElement: Element) {
-        if (this.targetElement !== undefined) {
-          throw new Error('Target element is already defined!');
-        }
-        if (targetElement === undefined) {
-          this._targetElement = DEFAULT_TARGET_ELEMENT_SUPPLIER();
-        }
-        if (NodeHelper.isElementTargetElement(targetElement)) {
-          // eslint-disable-next-line no-console
-          console.error('Target element: ', this._targetElement);
-          throw new Error(
-            'An tolgee instance is inited with provided target element'
-          );
-        }
-        this._targetElement = targetElement;
-        NodeHelper.markElementAsTargetElement(this._targetElement);
-      },
-      get() {
-        return this._targetElement;
-      },
-    });
-
-    Object.assign(this, config || {});
-    if (typeof sessionStorage !== 'undefined') {
-      this.apiUrl =
-        sessionStorage.getItem(API_URL_LOCAL_STORAGE) || this.apiUrl;
-      this.apiKey =
-        sessionStorage.getItem(API_KEY_LOCAL_STORAGE) || this.apiKey;
-    }
-    if (this._targetElement === undefined) {
-      this._targetElement = DEFAULT_TARGET_ELEMENT_SUPPLIER();
-    }
-    this.fallbackLanguage = this.fallbackLanguage || this.defaultLanguage;
-    if (this.watch === undefined) {
-      this.watch = Boolean(this.apiKey && this.apiUrl);
-    }
-    if (this.availableLanguages === undefined && this.staticData) {
-      this.availableLanguages = Object.keys(this.staticData);
-    }
-  }
-}

package/src/__integration/FormatterIcu.test.ts

@@ -1,80 +0,0 @@
-jest.autoMockOff();
-
-import '@testing-library/jest-dom/extend-expect';
-import { IcuFormatter, Tolgee } from '../index';
-import mockTranslations from './mockTranslations';
-import fetchMock from 'jest-fetch-mock';
-import { testConfig } from './testConfig';
-
-const API_URL = 'http://localhost';
-const API_KEY = 'dummyApiKey';
-
-const fetch = fetchMock.mockResponse(async (req) => {
-  if (req.url.includes('/v2/api-keys/current')) {
-    return JSON.stringify(testConfig);
-  } else if (req.url.includes('/v2/projects/translations/en')) {
-    return JSON.stringify(mockTranslations);
-  }
-  throw new Error('Invalid request');
-});
-
-describe('Tolgee with icu formatter', () => {
-  let tolgee: Tolgee;
-  beforeEach(async () => {
-    fetch.enableMocks();
-    tolgee = Tolgee.use(IcuFormatter).init({
-      targetElement: document.body,
-      apiKey: API_KEY,
-      apiUrl: API_URL,
-      inputPrefix: '{{',
-      inputSuffix: '}}',
-      watch: false,
-    });
-    document.body.innerHTML = '';
-    await tolgee.run();
-  });
-
-  afterEach(() => {
-    tolgee.stop();
-  });
-
-  it('Formats variable', async () => {
-    const translation = await tolgee.translate(
-      'peter_dogs',
-      { dogsCount: '10' },
-      true
-    );
-    expect(translation).toEqual('Peter has 10 dogs.');
-
-    const instantTranslation = tolgee.instant(
-      'peter_dogs',
-      { dogsCount: '10' },
-      true
-    );
-    expect(instantTranslation).toEqual('Peter has 10 dogs.');
-  });
-
-  it('Wont format key', async () => {
-    const translation = await tolgee.translate(
-      'weird {key}',
-      { key: '10' },
-      true
-    );
-    expect(translation).toEqual('weird {key}');
-
-    const instantTranslation = tolgee.instant(
-      'weird {key}',
-      { key: '10' },
-      true
-    );
-    expect(instantTranslation).toEqual('weird {key}');
-  });
-
-  it('Returns key if missing', async () => {
-    const translation = await tolgee.translate('nonexistant', undefined, true);
-    expect(translation).toEqual('nonexistant');
-
-    const instantTranslation = tolgee.instant('nonexistant', undefined, true);
-    expect(instantTranslation).toEqual('nonexistant');
-  });
-});