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

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.
@@ -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.0",
   "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": "b8b2b67da494535658940856596359ebc27df7c1"
 }

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({
@@ -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/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<