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

package/src/__test/languageStorage.test.ts

@@ -1,4 +1,4 @@
-import { Tolgee, TolgeePlugin, TolgeeInstance } from '../index';
+import { TolgeeCore, TolgeePlugin, TolgeeInstance } from '../index';
 
 describe('language storage plugin', () => {
   let tolgee: TolgeeInstance;
@@ -22,7 +22,7 @@ describe('language storage plugin', () => {
   });
 
   it('will restore language without loading', async () => {
-    tolgee = Tolgee()
+    tolgee = TolgeeCore()
       .use(StoragePlugin('en'))
       .init({
         defaultLanguage: 'es',
@@ -46,7 +46,7 @@ describe('language storage plugin', () => {
   });
 
   it('will restore language async', async () => {
-    tolgee = Tolgee()
+    tolgee = TolgeeCore()
       .use(StoragePlugin(Promise.resolve('en')))
       .init({
         defaultLanguage: 'es',
@@ -72,7 +72,7 @@ describe('language storage plugin', () => {
   });
 
   it('will fallback correctly', async () => {
-    tolgee = Tolgee()
+    tolgee = TolgeeCore()
       .use(StoragePlugin(Promise.resolve(undefined)))
       .init({
         defaultLanguage: 'es',
@@ -88,7 +88,7 @@ describe('language storage plugin', () => {
   });
 
   it('will return key before language is loaded', async () => {
-    tolgee = Tolgee()
+    tolgee = TolgeeCore()
       .use(StoragePlugin(Promise.resolve('en')))
       .init({
         defaultLanguage: 'es',
@@ -105,7 +105,7 @@ describe('language storage plugin', () => {
   });
 
   it('will store language value on language change', async () => {
-    tolgee = Tolgee()
+    tolgee = TolgeeCore()
       .use(StoragePlugin(Promise.resolve('en')))
       .init({
         defaultLanguage: 'es',
@@ -122,7 +122,7 @@ describe('language storage plugin', () => {
   });
 
   it('will ignore invalid values', () => {
-    tolgee = Tolgee()
+    tolgee = TolgeeCore()
       .use(StoragePlugin('eq'))
       .init({
         defaultLanguage: 'es',
@@ -135,11 +135,10 @@ describe('language storage plugin', () => {
     expect(tolgee.getLanguage()).toEqual('es');
   });
 
-  it('will return invalid value if no available languages', () => {
-    tolgee = Tolgee().use(StoragePlugin('eq')).init({
+  it('will throw an error when no available languages are specified', () => {
+    tolgee = TolgeeCore().use(StoragePlugin('eq')).init({
       defaultLanguage: 'es',
     });
-    tolgee.run();
-    expect(tolgee.getLanguage()).toEqual('eq');
+    expect(() => tolgee.run()).toThrowError('availableLanguages');
   });
 });

package/src/__test/languages.test.ts

@@ -1,16 +1,16 @@
-import { Tolgee, TreeTranslationsData } from '../index';
+import { TolgeeCore, TreeTranslationsData } from '../index';
 import { resolvablePromise } from './testTools';
 
 describe('language changes', () => {
   it('changes language', async () => {
-    const tolgee = Tolgee().init({ language: 'en' });
+    const tolgee = TolgeeCore().init({ language: 'en' });
     expect(tolgee.getLanguage()).toEqual('en');
     await tolgee.changeLanguage('es');
     expect(tolgee.getLanguage()).toEqual('es');
   });
 
   it('returns correct translation', async () => {
-    const tolgee = Tolgee().init({
+    const tolgee = TolgeeCore().init({
       language: 'en',
       staticData: { en: { hello: 'World' }, es: { hello: 'Mundo' } },
     });
@@ -24,7 +24,7 @@ describe('language changes', () => {
   it('fetches language data correctly', async () => {
     const [promiseEn, resolveEn] = resolvablePromise<TreeTranslationsData>();
     const [promiseEs, resolveEs] = resolvablePromise<TreeTranslationsData>();
-    const tolgee = Tolgee().init({
+    const tolgee = TolgeeCore().init({
       language: 'en',
       staticData: {
         en: () => promiseEn,
@@ -53,7 +53,7 @@ describe('language changes', () => {
     const [promiseEnIn, resolveEnIn] =
       resolvablePromise<TreeTranslationsData>();
 
-    const tolgee = Tolgee().init({
+    const tolgee = TolgeeCore().init({
       language: 'es',
       staticData: {
         en: () => promiseEn,
@@ -95,7 +95,7 @@ describe('language changes', () => {
   });
 
   it('will fallback to default value', () => {
-    const tolgee = Tolgee().init({
+    const tolgee = TolgeeCore().init({
       defaultLanguage: 'en',
     });
 
@@ -105,14 +105,14 @@ describe('language changes', () => {
   });
 
   it('will throw error when no language specified', () => {
-    const tolgee = Tolgee().init({});
+    const tolgee = TolgeeCore().init({});
 
     expect(() => tolgee.run()).toThrow(/'language'/);
   });
 
   it('loads fallback languages and namespaces', async () => {
     const loadNs = jest.fn(() => Promise.resolve(undefined as any));
-    const tolgee = Tolgee().init({
+    const tolgee = TolgeeCore().init({
       language: 'en',
       fallbackNs: ['fallback'],
       staticData: {

package/src/__test/loading.test.ts

@@ -1,4 +1,4 @@
-import { Tolgee, TreeTranslationsData } from '../index';
+import { TolgeeCore, TreeTranslationsData } from '../index';
 import { resolvablePromise } from './testTools';
 
 describe('loading', () => {
@@ -7,7 +7,7 @@ describe('loading', () => {
     const [promiseEs, resolveEs] = resolvablePromise<TreeTranslationsData>();
     const onLoadHandler = jest.fn(() => {});
     const onFetchingHandler = jest.fn(() => {});
-    const tolgee = Tolgee().init({
+    const tolgee = TolgeeCore().init({
       language: 'en',
       staticData: {
         en: () => promiseEn,

package/src/__test/namespaces.fallback.test.ts

@@ -1,8 +1,8 @@
-import { Tolgee } from '../Tolgee';
+import { TolgeeCore } from '../TolgeeCore';
 
 describe('namespaces fallback', () => {
   test('works with multiple and default', () => {
-    const tolgee = Tolgee().init({
+    const tolgee = TolgeeCore().init({
       language: 'en',
       staticData: {
         en: { '0': 'noNamespace' },
@@ -20,7 +20,7 @@ describe('namespaces fallback', () => {
   });
 
   test('works when no fallback specified', () => {
-    const tolgee = Tolgee().init({
+    const tolgee = TolgeeCore().init({
       language: 'en',
       staticData: {
         en: { '0': 'noNamespace' },
@@ -37,7 +37,7 @@ describe('namespaces fallback', () => {
   });
 
   test('works when data present but no fallback', () => {
-    const tolgee = Tolgee().init({
+    const tolgee = TolgeeCore().init({
       language: 'en',
       staticData: {
         en: { '0': 'noNamespace' },
@@ -55,7 +55,7 @@ describe('namespaces fallback', () => {
   });
 
   test('works with default', () => {
-    const tolgee = Tolgee().init({
+    const tolgee = TolgeeCore().init({
       language: 'en',
       staticData: {
         en: { '0': 'empty' },

package/src/__test/namespaces.test.ts

@@ -1,4 +1,4 @@
-import { Tolgee } from '../index';
+import { TolgeeCore } from '../index';
 
 const tolgeeWithNamespaces = () => {
   const promiseEnTest = jest.fn(() => Promise.resolve({ test: 'Test' }));
@@ -8,7 +8,7 @@ const tolgeeWithNamespaces = () => {
     Promise.resolve({ cancel: 'Cancellar' })
   );
 
-  return Tolgee().init({
+  return TolgeeCore().init({
     language: 'en',
     ns: ['common'],
     defaultNs: 'common',
@@ -23,7 +23,7 @@ const tolgeeWithNamespaces = () => {
 
 describe('language changes', () => {
   it('returns correct translation from namespace', () => {
-    const tolgee = Tolgee().init({
+    const tolgee = TolgeeCore().init({
       language: 'en',
       staticData: {
         en: { hello: 'World' },
@@ -36,7 +36,7 @@ describe('language changes', () => {
   });
 
   it('uses defaultNs', async () => {
-    const tolgee = Tolgee().init({
+    const tolgee = TolgeeCore().init({
       language: 'en',
       defaultNs: 'common',
       staticData: {

package/src/__test/options.test.ts

@@ -1,8 +1,8 @@
-import { Tolgee } from '../Tolgee';
+import { TolgeeCore } from '../TolgeeCore';
 
 describe('initial options', () => {
   it('combines options correctly', () => {
-    const tolgee = Tolgee()
+    const tolgee = TolgeeCore()
       .updateDefaults({
         observerType: 'text',
         observerOptions: { highlightColor: 'red', restrictedElements: ['a'] },
@@ -45,7 +45,7 @@ describe('initial options', () => {
   });
 
   it('sanitizes url', () => {
-    const tolgee = Tolgee().init({
+    const tolgee = TolgeeCore().init({
       language: 'cs',
       apiUrl: 'http://localhost:8080/',
       observerOptions: { highlightWidth: 90 },

package/src/__test/plugins.test.ts

@@ -1,4 +1,4 @@
-import { Tolgee } from '../Tolgee';
+import { TolgeeCore } from '../TolgeeCore';
 import {
   FinalFormatterMiddleware,
   FormatterMiddleware,
@@ -69,7 +69,7 @@ const formattersPlugin: TolgeePlugin = (tolgee, tools) => {
 
 describe('plugins', () => {
   it('wraps and formats translation', () => {
-    const tolgee = Tolgee().init({
+    const tolgee = TolgeeCore().init({
       language: 'en',
       staticData: { en: { hello: 'world' } },
     });
@@ -83,7 +83,7 @@ describe('plugins', () => {
   });
 
   it("won't format when observer doesn't return formattable text", () => {
-    const tolgee = Tolgee().init({
+    const tolgee = TolgeeCore().init({
       language: 'en',
       staticData: { en: { hello: 'world' } },
     });
@@ -97,7 +97,7 @@ describe('plugins', () => {
   });
 
   it("won't wrap before run", () => {
-    const tolgee = Tolgee().init({
+    const tolgee = TolgeeCore().init({
       language: 'en',
       staticData: { en: { hello: 'world' } },
     });

package/src/helpers.ts

@@ -60,3 +60,11 @@ export function unique<T>(arr: T[]) {
 export function sanitizeUrl(url: string | undefined) {
   return url ? url.replace(/\/+$/, '') : url;
 }
+
+export function getErrorMessage(error: any): string | undefined {
+  if (typeof error === 'string') {
+    return error;
+  } else if (typeof error?.message === 'string') {
+    return error.message;
+  }
+}

package/src/index.ts

@@ -1,5 +1,5 @@
 export { getFallback, getFallbackArray } from './helpers';
-export { Tolgee } from './Tolgee';
+export { TolgeeCore } from './TolgeeCore';
 export * from './types';
 export { getTranslateProps } from './TranslateParams';
 export { FormatSimple } from './FormatSimple/FormatSimple';

package/src/types/events.ts

@@ -20,8 +20,8 @@ export type ListenerEvent<T> = { value: T };
 export type Listener<T> = (e: ListenerEvent<T>) => void;
 
 export type TolgeeEvent =
-  | 'pendingLanguage'
   | 'language'
+  | 'pendingLanguage'
   | 'loading'
   | 'fetching'
   | 'initialLoad'
@@ -30,8 +30,8 @@ export type TolgeeEvent =
   | 'update';
 
 export interface EventType {
-  pendingLanguage: string;
   language: string;
+  pendingLanguage: string;
   loading: boolean;
   fetching: boolean;
   initialLoad: void;

package/src/types/index.ts

@@ -16,4 +16,4 @@ export type {
   ModifierKey,
 } from '../Controller/State/observerOptions';
 
-export type { TolgeeChainer, TolgeeInstance } from '../Tolgee';
+export type { TolgeeChainer, TolgeeInstance } from '../TolgeeCore';

package/src/types/plugin.ts

@@ -6,7 +6,7 @@ import {
   TranslatePropsInternal,
 } from './general';
 import type { ObserverOptionsInternal } from '../Controller/State/observerOptions';
-import { TolgeeInstance } from '../Tolgee';
+import { TolgeeInstance } from '../TolgeeCore';
 
 export type BackendDevProps = {
   apiUrl?: string;
@@ -145,24 +145,18 @@ export type UiKeyOption = {
   translation: string | undefined;
 };
 
-export interface UiMiddleware {
+export type UiMiddleware = (props: UiProps) => UiInterface;
+
+export interface UiInterface {
   handleElementClick(keysAndDefaults: UiKeyOption[], event: any): Promise<void>;
 }
 
-export type UiConstructor = new (props: UiProps) => UiMiddleware;
-
-export type UiLibMiddleware = {
-  UI: UiConstructor;
-};
-
-export type UiType = UiConstructor | UiLibMiddleware;
-
 export type PluginTools = Readonly<{
   setFinalFormatter: (formatter: FinalFormatterMiddleware | undefined) => void;
   addFormatter: (formatter: FormatterMiddleware | undefined) => void;
   setObserver: (observer: ObserverMiddleware | undefined) => void;
   hasObserver: () => boolean;
-  setUi: (ui: UiLibMiddleware | undefined) => void;
+  setUi: (ui: UiMiddleware | undefined) => void;
   hasUi: () => boolean;
   addBackend: (backend: BackendMiddleware | undefined) => void;
   setDevBackend: (backend: BackendDevMiddleware | undefined) => void;
@@ -172,10 +166,16 @@ export type PluginTools = Readonly<{
   setLanguageStorage: (
     languageStorage: LanguageStorageMiddleware | undefined
   ) => void;
-  onPrepare: (callback: () => void) => void;
 }>;
 
 export type TolgeePlugin = (
   tolgee: TolgeeInstance,
   tools: PluginTools
 ) => TolgeeInstance;
+
+export type FormatErrorHandler = (
+  error: string,
+  info: TranslatePropsInternal
+) => string;
+
+export type OnFormatError = string | FormatErrorHandler;