@tolgee/core 5.7.0-prerelease.fa761114.0 → 5.7.3

package/lib/Controller/Controller.d.ts

@@ -14,7 +14,7 @@ export declare const Controller: ({ options }: StateServiceProps) => Readonly<{
     loadRecord: (descriptor: CacheDescriptor) => Promise<import("../types").TranslationsFlat>;
     isLoading: (ns?: NsFallback) => boolean;
     isLoaded: (ns?: NsFallback) => boolean;
-    t: TFnType<import("../types").DefaultParamType, string>;
+    t: TFnType<import("../types").DefaultParamType, string, import("../types").TranslationKey>;
     isDev: () => boolean;
     run: () => Promise<void | undefined>;
     stop: () => void;
@@ -31,61 +31,9 @@ export declare const Controller: ({ options }: StateServiceProps) => Readonly<{
         language: string;
         namespace: string;
     }[];
-    addPlugin: (tolgeeInstance: Readonly<{
-        on: import("../types").TolgeeOn<keyof import("../types").EventType>;
-        onNsUpdate: (handler: import("../types").Listener<undefined>) => import("../types").SubscriptionSelective;
-        setEmmiterActive: (active: boolean) => void;
-        getLanguage: () => string | undefined;
-        getPendingLanguage: () => string | undefined;
-        changeLanguage: (language: string) => Promise<void>;
-        changeTranslation: (descriptor: CacheDescriptor, key: string, value: string) => {
-            revert: () => void;
-        };
-        addActiveNs: (ns: NsFallback, forget?: boolean) => Promise<void>;
-        removeActiveNs: (ns: NsFallback) => void;
-        loadRecords: (descriptors: CacheDescriptor[]) => Promise<import("../types").TranslationsFlat[]>;
-        loadRecord: (descriptor: CacheDescriptor) => Promise<import("../types").TranslationsFlat>;
-        addStaticData: (data: import("./State/initState").TolgeeStaticData | undefined) => void;
-        getRecord: (descriptor: CacheDescriptor) => import("../types").TranslationsFlat | undefined;
-        getAllRecords: () => {
-            data: import("../types").TranslationsFlat;
-            language: string;
-            namespace: string;
-        }[];
-        isLoaded: (ns?: NsFallback) => boolean;
-        isInitialLoading: () => boolean;
-        isLoading: (ns?: NsFallback) => boolean;
-        isFetching: (ns?: NsFallback) => boolean;
-        isRunning: () => boolean;
-        run: () => Promise<void | undefined>;
-        stop: () => void;
-        t: TFnType<import("../types").DefaultParamType, string>;
-        highlight: import("../types").HighlightInterface;
-        getInitialOptions: () => {
-            apiUrl?: string | undefined;
-            apiKey?: string | undefined;
-            projectId?: string | number | undefined;
-            language?: string | undefined;
-            defaultLanguage?: string | undefined;
-            availableLanguages?: string[] | undefined;
-            fallbackLanguage?: import("../types").FallbackLanguageOption;
-            ns?: string[] | undefined;
-            fallbackNs?: import("../types").FallbackGeneral;
-            defaultNs: string;
-            staticData?: import("./State/initState").TolgeeStaticData | undefined;
-            observerType: "invisible" | "text";
-            observerOptions: import("./State/observerOptions").ObserverOptionsInternal;
-            onFormatError: import("../types").OnFormatError;
-        };
-        isDev: () => boolean;
-        wrap: (params: import("../types").WrapperWrapProps) => string | undefined;
-        unwrap: (text: string) => import("../types").Unwrapped;
-        overrideCredentials(credentials: import("../types").DevCredentials): void;
-        addPlugin(plugin: import("../types").TolgeePlugin | undefined): void;
-        updateOptions(options?: TolgeeOptions | undefined): void;
-    }>, plugin: import("../types").TolgeePlugin) => void;
+    addPlugin: (tolgeeInstance: import("../TolgeeCore").TolgeeInstance, plugin: import("../types").TolgeePlugin) => void;
     formatTranslation: ({ formatEnabled, ...props }: {
-        key: string;
+        key: import("../types").TranslationKey;
         defaultValue?: string | undefined;
         params?: import("../types").TranslateParams<import("../types").DefaultParamType> | undefined;
     } & import("../types").TranslateOptions & {
@@ -145,7 +93,7 @@ export declare const Controller: ({ options }: StateServiceProps) => Readonly<{
     onRunningChange: import("./Events/EventEmitter").EventEmitterInstance<boolean>;
     onCacheChange: import("./Events/EventEmitter").EventEmitterInstance<import("../types").CacheDescriptorWithKey>;
     onUpdate: import("./Events/EventEmitterSelective").EventEmitterSelectiveInstance;
-    setEmmiterActive: (active: boolean) => void;
+    setEmitterActive: (active: boolean) => void;
     on: import("../types").TolgeeOn<keyof import("../types").EventType>;
 }>;
 export declare type ControllerInstance = ReturnType<typeof Controller>;

package/lib/Controller/Events/Events.d.ts

@@ -8,7 +8,7 @@ export declare const Events: (getFallbackNs: () => string[], getDefaultNs: () =>
     onRunningChange: import("./EventEmitter").EventEmitterInstance<boolean>;
     onCacheChange: import("./EventEmitter").EventEmitterInstance<CacheDescriptorWithKey>;
     onUpdate: import("./EventEmitterSelective").EventEmitterSelectiveInstance;
-    setEmmiterActive: (active: boolean) => void;
+    setEmitterActive: (active: boolean) => void;
     on: TolgeeOn<keyof import("../../types").EventType>;
 }>;
 export declare type EventsInstance = ReturnType<typeof Events>;

package/lib/Controller/Plugins/Plugins.d.ts

@@ -2,7 +2,7 @@ import { BackendDevMiddleware, BackendGetRecord, TranslatePropsInternal, Highlig
 export declare const Plugins: (getLanguage: () => string | undefined, getInitialOptions: () => TolgeeOptionsInternal, getAvailableLanguages: () => string[] | undefined, getTranslationNs: (props: KeyAndNamespacesInternal) => string[], getTranslation: (props: KeyAndNamespacesInternal) => string | undefined, changeTranslation: ChangeTranslationInterface) => Readonly<{
     addPlugin: (tolgeeInstance: TolgeeInstance, plugin: TolgeePlugin) => void;
     formatTranslation: ({ formatEnabled, ...props }: {
-        key: string;
+        key: import("../../types").TranslationKey;
         defaultValue?: string | undefined;
         params?: import("../../types").TranslateParams<import("../../types").DefaultParamType> | undefined;
     } & import("../../types").TranslateOptions & {

package/lib/TolgeeCore.d.ts

@@ -1,4 +1,4 @@
-import { TolgeeOptions, TolgeePlugin, DevCredentials } from './types';
+import { TolgeeOptions, TolgeePlugin, DevCredentials, TFnType, DefaultParamType, TranslationKey } from './types';
 declare const createTolgee: (options: TolgeeOptions) => Readonly<{
     /**
      * Listen to tolgee events.
@@ -21,7 +21,7 @@ declare const createTolgee: (options: TolgeeOptions) => Readonly<{
     /**
      * Turn off/on events emitting. Is on by default.
      */
-    setEmmiterActive: (active: boolean) => void;
+    setEmitterActive: (active: boolean) => void;
     /**
      * @return current language if set.
      */
@@ -119,7 +119,7 @@ declare const createTolgee: (options: TolgeeOptions) => Readonly<{
      * Returns translated and formatted key.
      * If Observer is present and tolgee is running, wraps result to be identifiable in the DOM.
      */
-    t: import("./types").TFnType<import("./types").DefaultParamType, string>;
+    t: TFnType<DefaultParamType, string, TranslationKey>;
     /**
      * Highlight keys that match selection.
      */
@@ -132,9 +132,7 @@ declare const createTolgee: (options: TolgeeOptions) => Readonly<{
         apiKey?: string | undefined;
         projectId?: string | number | undefined;
         language?: string | undefined;
-        defaultLanguage?: string | undefined; /**
-         * Turn off/on events emitting. Is on by default.
-         */
+        defaultLanguage?: string | undefined;
         availableLanguages?: string[] | undefined;
         fallbackLanguage?: import("./types").FallbackLanguageOption;
         ns?: string[] | undefined;
@@ -178,7 +176,9 @@ declare const createTolgee: (options: TolgeeOptions) => Readonly<{
      */
     updateOptions(options?: TolgeeOptions): void;
 }>;
-export declare type TolgeeInstance = ReturnType<typeof createTolgee>;
+export declare type TolgeeInstance = Omit<ReturnType<typeof createTolgee>, 't'> & {
+    t: TFnType<DefaultParamType, string, TranslationKey>;
+};
 export declare type TolgeeChainer = {
     /**
      * Add plugin, plugins are applied when `init` method is called.

package/lib/types/general.d.ts

@@ -1,6 +1,6 @@
 export declare type FallbackGeneral = undefined | false | string | string[];
 export declare type NsType = string;
-export declare type KeyType = string;
+export declare type TranslationKey = string & Record<never, never>;
 export declare type NsFallback = undefined | NsType | NsType[];
 export declare type FallbackLanguageObject = Record<string, FallbackGeneral>;
 export declare type FallbackLanguageOption = FallbackGeneral | FallbackLanguageObject;
@@ -13,8 +13,8 @@ export declare type TranslateOptions = {
     noWrap?: boolean;
     orEmpty?: boolean;
 };
-export declare type TranslateProps<T = DefaultParamType> = {
-    key: KeyType;
+export declare type TranslateProps<T = DefaultParamType, K extends string = TranslationKey> = {
+    key: K;
     defaultValue?: string;
     params?: TranslateParams<T>;
 } & TranslateOptions;
@@ -25,10 +25,10 @@ declare type PropType<TObj> = TObj[keyof TObj];
 export declare type CombinedOptions<T> = TranslateOptions & {
     [key: string]: T | PropType<TranslateOptions>;
 };
-export declare type TFnType<T = DefaultParamType, R = string> = {
-    (key: string, defaultValue?: string, options?: CombinedOptions<T>): R;
-    (key: string, options?: CombinedOptions<T>): R;
-    (props: TranslateProps<T>): R;
+export declare type TFnType<T = DefaultParamType, R = string, K extends string = TranslationKey> = {
+    (key: K, defaultValue?: string, options?: CombinedOptions<T>): R;
+    (key: K, options?: CombinedOptions<T>): R;
+    (props: TranslateProps<T, K>): R;
 };
 export declare type KeyAndNamespacesInternal = Pick<TranslatePropsInternal, 'key' | 'ns'>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tolgee/core",
-  "version": "5.7.0-prerelease.fa761114.0",
+  "version": "5.7.3",
   "description": "Library providing ability to translate messages directly in context of developed application.",
   "main": "./dist/tolgee.cjs.js",
   "module": "./dist/tolgee.esm.js",
@@ -67,5 +67,5 @@
     "access": "public"
   },
   "sideEffects": false,
-  "gitHead": "422387761e8f4e032a8d3c0dc9a1422deb5f3dba"
+  "gitHead": "fde08c663fc22333a09c1a6f8e976d16c500e79e"
 }

package/src/Controller/Events/Events.ts

@@ -48,7 +48,7 @@ export const Events = (
     }
   };
 
-  function setEmmiterActive(active: boolean) {
+  function setEmitterActive(active: boolean) {
     emitterActive = active;
   }
 
@@ -61,7 +61,7 @@ export const Events = (
     onRunningChange,
     onCacheChange,
     onUpdate,
-    setEmmiterActive,
+    setEmitterActive,
     on,
   });
 };

package/src/TolgeeCore.ts

@@ -1,6 +1,13 @@
 import { Controller } from './Controller/Controller';
 import { combineOptions } from './Controller/State/initState';
-import { TolgeeOptions, TolgeePlugin, DevCredentials } from './types';
+import {
+  TolgeeOptions,
+  TolgeePlugin,
+  DevCredentials,
+  TFnType,
+  DefaultParamType,
+  TranslationKey,
+} from './types';
 
 const createTolgee = (options: TolgeeOptions) => {
   const controller = Controller({
@@ -39,7 +46,7 @@ const createTolgee = (options: TolgeeOptions) => {
     /**
      * Turn off/on events emitting. Is on by default.
      */
-    setEmmiterActive: controller.setEmmiterActive,
+    setEmitterActive: controller.setEmitterActive,
 
     /**
      * @return current language if set.
@@ -214,7 +221,10 @@ const createTolgee = (options: TolgeeOptions) => {
   return tolgee;
 };
 
-export type TolgeeInstance = ReturnType<typeof createTolgee>;
+export type TolgeeInstance = Omit<ReturnType<typeof createTolgee>, 't'> & {
+  // enabling generics (when inferred they are lost)
+  t: TFnType<DefaultParamType, string, TranslationKey>;
+};
 
 export type TolgeeChainer = {
   /**

package/src/__test/events.test.ts

@@ -47,11 +47,11 @@ describe('events', () => {
     await tolgee.changeLanguage('es');
     expect(eventHandler).toBeCalledTimes(2);
 
-    tolgee.setEmmiterActive(false);
+    tolgee.setEmitterActive(false);
     await tolgee.changeLanguage('en');
     expect(eventHandler).toBeCalledTimes(2);
 
-    tolgee.setEmmiterActive(true);
+    tolgee.setEmitterActive(true);
     await tolgee.changeLanguage('es');
     expect(eventHandler).toBeCalledTimes(4);
   });

package/src/types/general.ts

@@ -2,7 +2,9 @@ export type FallbackGeneral = undefined | false | string | string[];
 
 export type NsType = string;
 
-export type KeyType = string;
+// This prevents typescript to optimize this to 'string'
+// this type needs to be overritable everywhere
+export type TranslationKey = string & Record<never, never>;
 
 export type NsFallback = undefined | NsType | NsType[];
 
@@ -22,8 +24,11 @@ export type TranslateOptions = {
   orEmpty?: boolean;
 };
 
-export type TranslateProps<T = DefaultParamType> = {
-  key: KeyType;
+export type TranslateProps<
+  T = DefaultParamType,
+  K extends string = TranslationKey
+> = {
+  key: K;
   defaultValue?: string;
   params?: TranslateParams<T>;
 } & TranslateOptions;
@@ -38,10 +43,14 @@ export type CombinedOptions<T> = TranslateOptions & {
   [key: string]: T | PropType<TranslateOptions>;
 };
 
-export type TFnType<T = DefaultParamType, R = string> = {
-  (key: string, defaultValue?: string, options?: CombinedOptions<T>): R;
-  (key: string, options?: CombinedOptions<T>): R;
-  (props: TranslateProps<T>): R;
+export type TFnType<
+  T = DefaultParamType,
+  R = string,
+  K extends string = TranslationKey
+> = {
+  (key: K, defaultValue?: string, options?: CombinedOptions<T>): R;
+  (key: K, options?: CombinedOptions<T>): R;
+  (props: TranslateProps<T, K>): R;
 };
 
 export type KeyAndNamespacesInternal = Pick<