@tolgee/core 5.8.0 → 5.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/dist/tolgee.cjs.js +650 -716
  2. package/dist/tolgee.cjs.js.map +1 -1
  3. package/dist/tolgee.cjs.min.js +1 -1
  4. package/dist/tolgee.cjs.min.js.map +1 -1
  5. package/dist/tolgee.esm.js +650 -716
  6. package/dist/tolgee.esm.js.map +1 -1
  7. package/dist/tolgee.esm.min.js +1 -1
  8. package/dist/tolgee.esm.min.js.map +1 -1
  9. package/dist/tolgee.esm.min.mjs +1 -1
  10. package/dist/tolgee.esm.min.mjs.map +1 -1
  11. package/dist/tolgee.esm.mjs +650 -716
  12. package/dist/tolgee.esm.mjs.map +1 -1
  13. package/dist/tolgee.umd.js +650 -716
  14. package/dist/tolgee.umd.js.map +1 -1
  15. package/dist/tolgee.umd.min.js +1 -1
  16. package/dist/tolgee.umd.min.js.map +1 -1
  17. package/lib/Controller/Cache/Cache.d.ts +14 -14
  18. package/lib/Controller/Controller.d.ts +23 -23
  19. package/lib/Controller/Events/EventEmitter.d.ts +1 -1
  20. package/lib/Controller/Events/EventEmitterSelective.d.ts +1 -1
  21. package/lib/Controller/Events/Events.d.ts +2 -2
  22. package/lib/Controller/Plugins/Plugins.d.ts +17 -17
  23. package/lib/Controller/State/State.d.ts +20 -20
  24. package/lib/Controller/State/initState.d.ts +1 -1
  25. package/lib/TolgeeCore.d.ts +2 -2
  26. package/lib/helpers.d.ts +2 -2
  27. package/package.json +2 -2
  28. package/src/Controller/Cache/Cache.ts +175 -193
  29. package/src/Controller/Controller.ts +105 -114
  30. package/src/Controller/Events/EventEmitter.ts +21 -22
  31. package/src/Controller/Events/EventEmitterSelective.ts +59 -58
  32. package/src/Controller/Events/Events.ts +41 -52
  33. package/src/Controller/Plugins/Plugins.ts +206 -219
  34. package/src/Controller/State/State.ts +135 -152
  35. package/src/Controller/State/initState.ts +3 -3
  36. package/src/Controller/ValueObserver.ts +11 -12
  37. package/src/TolgeeCore.ts +7 -7
  38. package/src/__test/cache.test.ts +3 -2
  39. package/src/helpers.ts +6 -5
@@ -2,20 +2,20 @@ import { CacheDescriptor, CacheDescriptorInternal, CacheDescriptorWithKey, NsFal
2
2
  import { EventEmitterInstance } from '../Events/EventEmitter';
3
3
  import { TolgeeStaticData } from '../State/initState';
4
4
  import { ValueObserverInstance } from '../ValueObserver';
5
- export declare const Cache: (onCacheChange: EventEmitterInstance<CacheDescriptorWithKey>, backendGetRecord: BackendGetRecord, backendGetDevRecord: BackendGetDevRecord, withDefaultNs: (descriptor: CacheDescriptor) => CacheDescriptorInternal, isInitialLoading: () => boolean, fetchingObserver: ValueObserverInstance<boolean>, loadingObserver: ValueObserverInstance<boolean>) => Readonly<{
6
- addStaticData: (data: TolgeeStaticData | undefined) => void;
7
- invalidate: () => void;
8
- addRecord: (descriptor: CacheDescriptorInternal, data: TreeTranslationsData) => void;
9
- exists: (descriptor: CacheDescriptorInternal, strict?: boolean) => boolean;
10
- getRecord: (descriptor: CacheDescriptor) => TranslationsFlat | undefined;
11
- getTranslation: (descriptor: CacheDescriptorInternal, key: string) => TranslationValue;
12
- getTranslationNs: (namespaces: string[], languages: string[], key: string) => string[];
13
- getTranslationFallback: (namespaces: string[], languages: string[], key: string) => string | undefined;
14
- changeTranslation: (descriptor: CacheDescriptorInternal, key: string, value: TranslationValue) => void;
15
- isFetching: (ns?: NsFallback) => boolean;
16
- isLoading: (language: string | undefined, ns?: NsFallback) => boolean;
17
- loadRecords: (descriptors: CacheDescriptor[], isDev: boolean) => Promise<TranslationsFlat[]>;
18
- getAllRecords: () => {
5
+ export declare function Cache(onCacheChange: EventEmitterInstance<CacheDescriptorWithKey>, backendGetRecord: BackendGetRecord, backendGetDevRecord: BackendGetDevRecord, withDefaultNs: (descriptor: CacheDescriptor) => CacheDescriptorInternal, isInitialLoading: () => boolean, fetchingObserver: ValueObserverInstance<boolean>, loadingObserver: ValueObserverInstance<boolean>): Readonly<{
6
+ addStaticData(data: TolgeeStaticData | undefined): void;
7
+ invalidate(): void;
8
+ addRecord(descriptor: CacheDescriptorInternal, data: TreeTranslationsData): void;
9
+ exists(descriptor: CacheDescriptorInternal, strict?: boolean): boolean;
10
+ getRecord(descriptor: CacheDescriptor): TranslationsFlat | undefined;
11
+ getTranslation(descriptor: CacheDescriptorInternal, key: string): TranslationValue;
12
+ getTranslationNs(namespaces: string[], languages: string[], key: string): string[];
13
+ getTranslationFallback(namespaces: string[], languages: string[], key: string): string | undefined;
14
+ changeTranslation(descriptor: CacheDescriptorInternal, key: string, value: TranslationValue): void;
15
+ isFetching(ns?: NsFallback): boolean;
16
+ isLoading(language: string | undefined, ns?: NsFallback): boolean;
17
+ loadRecords(descriptors: CacheDescriptor[], isDev: boolean): Promise<TranslationsFlat[]>;
18
+ getAllRecords(): {
19
19
  data: TranslationsFlat;
20
20
  language: string;
21
21
  namespace: string;
@@ -2,22 +2,22 @@ import { CacheDescriptor, NsFallback, TolgeeOptions, TFnType, KeyAndNamespacesIn
2
2
  declare type StateServiceProps = {
3
3
  options?: Partial<TolgeeOptions>;
4
4
  };
5
- export declare const Controller: ({ options }: StateServiceProps) => Readonly<{
5
+ export declare function Controller({ options }: StateServiceProps): Readonly<{
6
6
  init: (options: Partial<TolgeeOptions>) => void;
7
- changeLanguage: (language: string) => Promise<void>;
8
7
  getTranslation: ({ key, ns, language }: KeyAndNamespacesInternal) => string | undefined;
9
8
  changeTranslation: (descriptor: CacheDescriptor, key: string, value: string) => {
10
- revert: () => void;
9
+ revert(): void;
11
10
  };
12
- addActiveNs: (ns: NsFallback, forget?: boolean) => Promise<void>;
13
- loadRecords: (descriptors: CacheDescriptor[]) => Promise<import("../types").TranslationsFlat[]>;
14
- loadRecord: (descriptor: CacheDescriptor) => Promise<import("../types").TranslationsFlat>;
15
- isLoading: (ns?: NsFallback) => boolean;
16
- isLoaded: (ns?: NsFallback) => boolean;
11
+ changeLanguage(language: string): Promise<void>;
12
+ addActiveNs(ns: NsFallback, forget?: boolean): Promise<void>;
13
+ loadRecords(descriptors: CacheDescriptor[]): Promise<import("../types").TranslationsFlat[]>;
14
+ loadRecord(descriptor: CacheDescriptor): Promise<import("../types").TranslationsFlat>;
15
+ isLoading(ns?: NsFallback): boolean;
16
+ isLoaded(ns?: NsFallback): boolean;
17
17
  t: TFnType<import("../types").DefaultParamType, string, import("../types").TranslationKey>;
18
- isDev: () => boolean;
19
- run: () => Promise<void | undefined>;
20
- stop: () => void;
18
+ isDev(): boolean;
19
+ run(): Promise<void | undefined>;
20
+ stop(): void;
21
21
  addStaticData: (data: import("./State/initState").TolgeeStaticData | undefined) => void;
22
22
  invalidate: () => void;
23
23
  addRecord: (descriptor: import("../types").CacheDescriptorInternal, data: import("../types").TreeTranslationsData) => void;
@@ -32,27 +32,27 @@ export declare const Controller: ({ options }: StateServiceProps) => Readonly<{
32
32
  namespace: string;
33
33
  }[];
34
34
  addPlugin: (tolgeeInstance: import("../TolgeeCore").TolgeeInstance, plugin: import("../types").TolgeePlugin) => void;
35
- formatTranslation: ({ formatEnabled, ...props }: {
36
- key: import("../types").TranslationKey;
37
- defaultValue?: string | undefined;
38
- params?: import("../types").TranslateParams<import("../types").DefaultParamType> | undefined;
39
- } & import("../types").TranslateOptions & {
40
- translation?: string | undefined;
41
- } & {
42
- formatEnabled?: boolean | undefined;
43
- }) => string;
35
+ getLanguageStorage: () => import("../types").LanguageStorageMiddleware | undefined;
36
+ getInitialLanguage: () => string | Promise<string | undefined> | Promise<string | Promise<string | undefined> | undefined> | undefined;
37
+ setStoredLanguage: (language: string) => void;
44
38
  getDevBackend: () => import("../types").BackendDevMiddleware | undefined;
45
39
  getBackendRecord: import("../types").BackendGetRecord;
46
40
  getBackendDevRecord: import("../types").BackendGetRecord;
47
41
  getLanguageDetector: () => import("../types").LanguageDetectorMiddleware | undefined;
48
- getLanguageStorage: () => import("../types").LanguageStorageMiddleware | undefined;
49
- getInitialLanguage: () => string | Promise<string | undefined> | Promise<string | Promise<string | undefined> | undefined> | undefined;
50
- setStoredLanguage: (language: string) => void;
51
42
  retranslate: () => void;
52
43
  highlight: import("../types").HighlightInterface;
53
44
  unwrap: (text: string) => import("../types").Unwrapped;
54
45
  wrap: (params: import("../types").WrapperWrapProps) => string | undefined;
55
46
  hasDevBackend: () => boolean;
47
+ formatTranslation: ({ formatEnabled, ...props }: {
48
+ key: import("../types").TranslationKey;
49
+ defaultValue?: string | undefined;
50
+ params?: import("../types").TranslateParams<import("../types").DefaultParamType> | undefined;
51
+ } & import("../types").TranslateOptions & {
52
+ translation?: string | undefined;
53
+ } & {
54
+ formatEnabled?: boolean | undefined;
55
+ }) => string;
56
56
  isRunning: () => boolean;
57
57
  setRunning: (value: boolean) => void;
58
58
  isInitialLoading: () => boolean;
@@ -1,5 +1,5 @@
1
1
  import { Subscription, Listener } from '../../types';
2
- export declare const EventEmitter: <T>(isActive: () => boolean) => EventEmitterInstance<T>;
2
+ export declare function EventEmitter<T>(isActive: () => boolean): EventEmitterInstance<T>;
3
3
  export declare type EventEmitterInstance<T> = {
4
4
  readonly listen: (handler: Listener<T>) => Subscription;
5
5
  readonly emit: (data: T) => void;
@@ -1,5 +1,5 @@
1
1
  import { Subscription, Listener, SubscriptionSelective } from '../../types';
2
- export declare const EventEmitterSelective: (isActive: () => boolean, getFallbackNs: () => string[], getDefaultNs: () => string) => EventEmitterSelectiveInstance;
2
+ export declare function EventEmitterSelective(isActive: () => boolean, getFallbackNs: () => string[], getDefaultNs: () => string): EventEmitterSelectiveInstance;
3
3
  export declare type EventEmitterSelectiveInstance = {
4
4
  readonly listenSome: (handler: Listener<undefined>) => SubscriptionSelective;
5
5
  readonly listen: (handler: Listener<undefined>) => Subscription;
@@ -1,5 +1,5 @@
1
1
  import { CacheDescriptorWithKey, TolgeeOn } from '../../types';
2
- export declare const Events: (getFallbackNs: () => string[], getDefaultNs: () => string) => Readonly<{
2
+ export declare function Events(getFallbackNs: () => string[], getDefaultNs: () => string): Readonly<{
3
3
  onPendingLanguageChange: import("./EventEmitter").EventEmitterInstance<string>;
4
4
  onLanguageChange: import("./EventEmitter").EventEmitterInstance<string>;
5
5
  onLoadingChange: import("./EventEmitter").EventEmitterInstance<boolean>;
@@ -8,7 +8,7 @@ export declare const Events: (getFallbackNs: () => string[], getDefaultNs: () =>
8
8
  onRunningChange: import("./EventEmitter").EventEmitterInstance<boolean>;
9
9
  onCacheChange: import("./EventEmitter").EventEmitterInstance<CacheDescriptorWithKey>;
10
10
  onUpdate: import("./EventEmitterSelective").EventEmitterSelectiveInstance;
11
- setEmitterActive: (active: boolean) => void;
11
+ setEmitterActive(active: boolean): void;
12
12
  on: TolgeeOn<keyof import("../../types").EventType>;
13
13
  }>;
14
14
  export declare type EventsInstance = ReturnType<typeof Events>;
@@ -1,7 +1,21 @@
1
1
  import { BackendDevMiddleware, BackendGetRecord, TranslatePropsInternal, HighlightInterface, LanguageDetectorMiddleware, LanguageStorageMiddleware, ChangeTranslationInterface, WrapperWrapProps, Unwrapped, KeyAndNamespacesInternal, TolgeePlugin, TolgeeInstance, TolgeeOptionsInternal } from '../../types';
2
- export declare const Plugins: (getLanguage: () => string | undefined, getInitialOptions: () => TolgeeOptionsInternal, getAvailableLanguages: () => string[] | undefined, getTranslationNs: (props: KeyAndNamespacesInternal) => string[], getTranslation: (props: KeyAndNamespacesInternal) => string | undefined, changeTranslation: ChangeTranslationInterface) => Readonly<{
2
+ export declare function Plugins(getLanguage: () => string | undefined, getInitialOptions: () => TolgeeOptionsInternal, getAvailableLanguages: () => string[] | undefined, getTranslationNs: (props: KeyAndNamespacesInternal) => string[], getTranslation: (props: KeyAndNamespacesInternal) => string | undefined, changeTranslation: ChangeTranslationInterface): Readonly<{
3
3
  addPlugin: (tolgeeInstance: TolgeeInstance, plugin: TolgeePlugin) => void;
4
- formatTranslation: ({ formatEnabled, ...props }: {
4
+ run(): void;
5
+ stop(): void;
6
+ getLanguageStorage(): LanguageStorageMiddleware | undefined;
7
+ getInitialLanguage(): string | Promise<string | undefined> | Promise<string | Promise<string | undefined> | undefined> | undefined;
8
+ setStoredLanguage(language: string): void;
9
+ getDevBackend(): BackendDevMiddleware | undefined;
10
+ getBackendRecord: BackendGetRecord;
11
+ getBackendDevRecord: BackendGetRecord;
12
+ getLanguageDetector(): LanguageDetectorMiddleware | undefined;
13
+ retranslate(): void;
14
+ highlight: HighlightInterface;
15
+ unwrap(text: string): Unwrapped;
16
+ wrap(params: WrapperWrapProps): string | undefined;
17
+ hasDevBackend(): boolean;
18
+ formatTranslation({ formatEnabled, ...props }: {
5
19
  key: import("../../types").TranslationKey;
6
20
  defaultValue?: string | undefined;
7
21
  params?: import("../../types").TranslateParams<import("../../types").DefaultParamType> | undefined;
@@ -9,20 +23,6 @@ export declare const Plugins: (getLanguage: () => string | undefined, getInitial
9
23
  translation?: string | undefined;
10
24
  } & {
11
25
  formatEnabled?: boolean | undefined;
12
- }) => string;
13
- getDevBackend: () => BackendDevMiddleware | undefined;
14
- getBackendRecord: BackendGetRecord;
15
- getBackendDevRecord: BackendGetRecord;
16
- getLanguageDetector: () => LanguageDetectorMiddleware | undefined;
17
- getLanguageStorage: () => LanguageStorageMiddleware | undefined;
18
- getInitialLanguage: () => string | Promise<string | undefined> | Promise<string | Promise<string | undefined> | undefined> | undefined;
19
- setStoredLanguage: (language: string) => void;
20
- run: () => void;
21
- stop: () => void;
22
- retranslate: () => void;
23
- highlight: HighlightInterface;
24
- unwrap: (text: string) => Unwrapped;
25
- wrap: (params: WrapperWrapProps) => string | undefined;
26
- hasDevBackend: () => boolean;
26
+ }): string;
27
27
  }>;
28
28
  export declare type PluginsInstance = ReturnType<typeof Plugins>;
@@ -1,17 +1,17 @@
1
1
  import { CacheDescriptor, CacheDescriptorInternal, DevCredentials, NsFallback, NsType } from '../../types';
2
2
  import { EventEmitterInstance } from '../Events/EventEmitter';
3
3
  import { TolgeeOptions } from './initState';
4
- export declare const State: (onLanguageChange: EventEmitterInstance<string>, onPendingLanguageChange: EventEmitterInstance<string>, onRunningChange: EventEmitterInstance<boolean>) => Readonly<{
5
- init: (options?: Partial<TolgeeOptions>) => void;
6
- isRunning: () => boolean;
7
- setRunning: (value: boolean) => void;
8
- isInitialLoading: () => boolean;
9
- setInitialLoading: (value: boolean) => void;
10
- getLanguage: () => string | undefined;
11
- setLanguage: (language: string) => void;
12
- getPendingLanguage: () => string | undefined;
13
- setPendingLanguage: (language: string) => void;
14
- getInitialOptions: () => {
4
+ export declare function State(onLanguageChange: EventEmitterInstance<string>, onPendingLanguageChange: EventEmitterInstance<string>, onRunningChange: EventEmitterInstance<boolean>): Readonly<{
5
+ init(options?: Partial<TolgeeOptions>): void;
6
+ isRunning(): boolean;
7
+ setRunning(value: boolean): void;
8
+ isInitialLoading(): boolean;
9
+ setInitialLoading(value: boolean): void;
10
+ getLanguage(): string | undefined;
11
+ setLanguage(language: string): void;
12
+ getPendingLanguage(): string | undefined;
13
+ setPendingLanguage(language: string): void;
14
+ getInitialOptions(): {
15
15
  apiUrl?: string | undefined;
16
16
  apiKey?: string | undefined;
17
17
  projectId?: string | number | undefined;
@@ -27,14 +27,14 @@ export declare const State: (onLanguageChange: EventEmitterInstance<string>, onP
27
27
  observerOptions: import("./observerOptions").ObserverOptionsInternal;
28
28
  onFormatError: import("../../types").OnFormatError;
29
29
  };
30
- addActiveNs: (ns: NsFallback) => void;
31
- removeActiveNs: (ns: NsFallback) => void;
32
- getRequiredNamespaces: () => string[];
33
- getFallbackLangs: (lang?: string) => string[];
34
- getFallbackNs: () => string[];
35
- getDefaultNs: (ns?: NsType) => string;
36
- getAvailableLanguages: () => string[] | undefined;
37
- withDefaultNs: (descriptor: CacheDescriptor) => CacheDescriptorInternal;
38
- overrideCredentials: (credentials: DevCredentials) => void;
30
+ addActiveNs(ns: NsFallback): void;
31
+ removeActiveNs(ns: NsFallback): void;
32
+ getRequiredNamespaces(): string[];
33
+ getFallbackLangs(lang?: string): string[];
34
+ getFallbackNs(): string[];
35
+ getDefaultNs(ns?: NsType): string;
36
+ getAvailableLanguages(): string[] | undefined;
37
+ withDefaultNs(descriptor: CacheDescriptor): CacheDescriptorInternal;
38
+ overrideCredentials(credentials: DevCredentials): void;
39
39
  }>;
40
40
  export declare type StateInstance = ReturnType<typeof State>;
@@ -84,4 +84,4 @@ export declare type State = {
84
84
  isRunning: boolean;
85
85
  };
86
86
  export declare const combineOptions: <T extends TolgeeOptions>(...states: (T | undefined)[]) => T;
87
- export declare const initState: (options?: Partial<TolgeeOptions>, previousState?: State) => State;
87
+ export declare function initState(options?: Partial<TolgeeOptions>, previousState?: State): State;
@@ -1,5 +1,5 @@
1
1
  import { TolgeeOptions, TolgeePlugin, DevCredentials, TFnType, DefaultParamType, TranslationKey } from './types';
2
- declare const createTolgee: (options: TolgeeOptions) => Readonly<{
2
+ declare function createTolgee(options: TolgeeOptions): Readonly<{
3
3
  /**
4
4
  * Listen to tolgee events.
5
5
  */
@@ -44,7 +44,7 @@ declare const createTolgee: (options: TolgeeOptions) => Readonly<{
44
44
  * @return object with revert method.
45
45
  */
46
46
  changeTranslation: (descriptor: import("./types").CacheDescriptor, key: string, value: string) => {
47
- revert: () => void;
47
+ revert(): void;
48
48
  };
49
49
  /**
50
50
  * Adds namespace(s) list of active namespaces. And if tolgee is running, loads required data.
package/lib/helpers.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { FallbackGeneral, FallbackLanguageOption } from './types';
2
2
  export declare function isPromise(value: any): boolean;
3
- export declare const valueOrPromise: <T, R>(value: T | Promise<T>, callback: (value: T) => R) => R | Promise<R>;
4
- export declare const missingOptionError: (option: string) => string;
3
+ export declare function valueOrPromise<T, R>(value: T | Promise<T>, callback: (value: T) => R): R | Promise<R>;
4
+ export declare function missingOptionError(option: string): string;
5
5
  export declare function isObject(item: any): boolean;
6
6
  export declare function getFallback(value: FallbackGeneral): string[] | undefined;
7
7
  export declare function getFallbackArray(value: FallbackGeneral): string[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tolgee/core",
3
- "version": "5.8.0",
3
+ "version": "5.8.2",
4
4
  "description": "Library providing ability to translate messages directly in context of developed application.",
5
5
  "main": "./dist/tolgee.cjs.js",
6
6
  "module": "./dist/tolgee.esm.js",
@@ -67,5 +67,5 @@
67
67
  "access": "public"
68
68
  },
69
69
  "sideEffects": false,
70
- "gitHead": "a6185bf50f9319a81cbd4d768daf56417427d14e"
70
+ "gitHead": "18b78e3b96983f4e869874f5e37f758200e592e1"
71
71
  }