react-i18next 11.8.2 → 11.8.6

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+### 11.8.6
+
+- typescript: Updated TS definitions (adding useSuspense option in TranslationProps) [1247](https://github.com/i18next/react-i18next/pull/1247)
+
+### 11.8.5
+
+- typescript: fix: Inference for specific keys ts 4.1 [1230](https://github.com/i18next/react-i18next/pull/1230)
+
+### 11.8.4
+
+- typescript: Add workaround to suppress infinite instantiation warning [1227](https://github.com/i18next/react-i18next/pull/1227)
+- typescript: withTranslation() typing fix for defaultProps [1226](https://github.com/i18next/react-i18next/pull/1226)
+- typescript: Accept const components prop for Trans [1224](https://github.com/i18next/react-i18next/pull/1224)
+
+### 11.8.3
+
+- Fix: Return type inference for t function (typescript 4.1) [1221](https://github.com/i18next/react-i18next/pull/1221)
+
 ### 11.8.2
 
 - fix: type definitions for typescript 4.1 [1220](https://github.com/i18next/react-i18next/pull/1220)

package/README.md

@@ -144,6 +144,7 @@ Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds
     <td align="center"><a href="http://twitter.com/jamuhl"><img src="https://avatars3.githubusercontent.com/u/977772?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jan Mühlemann</b></sub></a><br /><a href="https://github.com/i18next/react-i18next/commits?author=jamuhl" title="Code">💻</a> <a href="#example-jamuhl" title="Examples">💡</a> <a href="https://github.com/i18next/react-i18next/commits?author=jamuhl" title="Documentation">📖</a> <a href="#question-jamuhl" title="Answering Questions">💬</a></td>
     <td align="center"><a href="http://twitter.com/#!/adrirai"><img src="https://avatars0.githubusercontent.com/u/1086194?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Adriano Raiano</b></sub></a><br /><a href="https://github.com/i18next/react-i18next/commits?author=adrai" title="Code">💻</a> <a href="#example-adrai" title="Examples">💡</a> <a href="https://github.com/i18next/react-i18next/commits?author=adrai" title="Documentation">📖</a> <a href="#question-adrai" title="Answering Questions">💬</a></td>
     <td align="center"><a href="https://tigerabrodi.dev/"><img src="https://avatars1.githubusercontent.com/u/49603590?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tiger Abrodi</b></sub></a><br /><a href="#question-tigerabrodi" title="Answering Questions">💬</a> <a href="https://github.com/i18next/react-i18next/commits?author=tigerabrodi" title="Code">💻</a> <a href="https://github.com/i18next/react-i18next/pulls?q=is%3Apr+reviewed-by%3Atigerabrodi" title="Reviewed Pull Requests">👀</a></td>
+    <td align="center"><a href="https://github.com/pedrodurek"><img src="https://avatars1.githubusercontent.com/u/12190482?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Pedro Durek</b></sub></a><br /><a href="https://github.com/i18next/react-i18next/commits?author=pedrodurek" title="Code">💻</a> <a href="#example-pedrodurek" title="Examples">💡</a></td>
   </tr>
 </table>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-i18next",
-  "version": "11.8.2",
+  "version": "11.8.6",
   "description": "Internationalization for react done right. Using the i18next i18n ecosystem.",
   "main": "dist/commonjs/index.js",
   "types": "src/index.d.ts",
@@ -45,6 +45,9 @@
     "@babel/preset-env": "^7.3.1",
     "@babel/preset-react": "^7.0.0",
     "@babel/register": "^7.0.0",
+    "@testing-library/jest-dom": "^5.11.6",
+    "@testing-library/react": "^11.2.2",
+    "@testing-library/react-hooks": "^3.4.2",
     "@types/react": "^16.8.2",
     "all-contributors-cli": "^6.1.1",
     "babel-core": "^7.0.0-bridge.0",
@@ -56,15 +59,14 @@
     "cp-cli": "^2.0.0",
     "cross-env": "^6.0.3",
     "dtslint": "^0.9.1",
-    "enzyme": "^3.8.0",
-    "enzyme-adapter-react-16": "^1.9.1",
-    "enzyme-adapter-react-helper": "^1.3.2",
     "eslint": "6.8.0",
-    "eslint-config-airbnb": "18.0.1",
+    "eslint-config-airbnb": "^18.0.1",
     "eslint-config-prettier": "6.4.0",
-    "eslint-plugin-import": "2.18.2",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jest-dom": "^3.6.3",
     "eslint-plugin-jsx-a11y": "6.2.3",
     "eslint-plugin-react": "7.16.0",
+    "eslint-plugin-testing-library": "^3.10.1",
     "husky": "^3.0.3",
     "i18next": "^19.0.0",
     "jest": "24.8.0",
@@ -74,6 +76,7 @@
     "prettier": "2.2.1",
     "react": "^16.10.2",
     "react-dom": "^16.10.2",
+    "react-test-renderer": "^17.0.1",
     "rimraf": "2.6.3",
     "rollup": "1.19.4",
     "rollup-plugin-babel": "^4.3.2",
@@ -105,7 +108,6 @@
     "test": "cross-env BABEL_ENV=development jest --no-cache",
     "test:watch": "cross-env BABEL_ENV=development jest --no-cache --watch",
     "test:coverage": "cross-env BABEL_ENV=development jest --no-cache --coverage",
-    "test:coverageOldEnzymeAdapter": "enzyme-adapter-react-install 16 && cross-env BABEL_ENV=development jest --no-cache --coverage",
     "test:lint": "eslint ./src ./test",
     "test:typescript": "tslint --project tsconfig.json",
     "test:typescript:noninterop": "tslint --project tsconfig.nonEsModuleInterop.json",

package/src/index.d.ts

@@ -2,6 +2,7 @@ import i18next, { ReactOptions, i18n, ThirdPartyModule, WithT, TFunction, Resour
 import * as React from 'react';
 
 type Omit<T, K> = Pick<T, Exclude<keyof T, K>>;
+type Subtract<T extends K, K> = Omit<T, keyof K>;
 
 export type Namespace = string | string[];
 
@@ -33,7 +34,7 @@ export interface TransProps<E extends Element = HTMLDivElement>
   extends React.HTMLProps<E>,
     Partial<WithT> {
   children?: React.ReactNode;
-  components?: readonly React.ReactNode[] | { [tagName: string]: React.ReactNode };
+  components?: readonly React.ReactNode[] | { readonly [tagName: string]: React.ReactNode };
   count?: number;
   defaults?: string;
   i18n?: i18n;
@@ -92,9 +93,15 @@ export function withTranslation(
   options?: {
     withRef?: boolean;
   },
-): <P extends WithTranslation>(
-  component: React.ComponentType<P>,
-) => React.ComponentType<Omit<P, keyof WithTranslation> & WithTranslationProps>;
+): <
+  C extends React.ComponentType<React.ComponentProps<C> & WithTranslationProps>,
+  ResolvedProps = JSX.LibraryManagedAttributes<
+    C,
+    Subtract<React.ComponentProps<C>, WithTranslationProps>
+  >
+>(
+  component: C,
+) => React.ComponentType<Omit<ResolvedProps, keyof WithTranslation> & WithTranslationProps>;
 
 export interface I18nextProviderProps {
   i18n: i18n;
@@ -115,6 +122,7 @@ export interface TranslationProps {
   ) => React.ReactNode;
   ns?: Namespace;
   i18n?: i18n;
+  useSuspense?: boolean;
 }
 
 export function Translation(props: TranslationProps): any;

package/src/ts4.1/index.d.ts

@@ -9,14 +9,24 @@ import i18next, {
 } from 'i18next';
 import * as React from 'react';
 
+type Subtract<T extends K, K> = Omit<T, keyof K>;
+
+/**
+ * Due to a limitation/bug on typescript 4.1 (https://github.com/microsoft/TypeScript/issues/41406), we added
+ * "extends infer A ? A : never" in a few places to suppress the error "Type instantiation is excessively deep and possibly infinite."
+ * on cases where users have more than 22 namespaces. Once the issue is fixed, we can remove all instances of the workaround used.
+ *
+ * Reference of the bug reported: https://github.com/i18next/react-i18next/issues/1222
+ */
+
 /**
  * This interface can be augmented by users to add types to `react-i18next` default resources.
  */
 export interface Resources {}
 
-type ResourcesKey<T = keyof Resources> = [T] extends [never] ? string : T;
+type Fallback<F, T = keyof Resources> = [T] extends [never] ? F : T;
 
-export type Namespace = ResourcesKey | ResourcesKey[];
+export type Namespace<F = Fallback<string>> = F | F[];
 
 export function setDefaults(options: ReactOptions): void;
 export function getDefaults(): ReactOptions;
@@ -43,11 +53,13 @@ declare module 'i18next' {
 }
 
 // Normalize single namespace
-type OmitArrayProps<T> = Exclude<T, keyof any[]>;
-type AppendKeys<K1, K2> = `${K1 & string}.${OmitArrayProps<K2> & string}`;
+type AppendKeys<K1, K2> = `${K1 & string}.${K2 & string}`;
+type AppendKeys2<K1, K2> = `${K1 & string}.${Exclude<K2, keyof any[]> & string}`;
 type Normalize2<T, K = keyof T> = K extends keyof T
-  ? T[K] extends object
-    ? AppendKeys<K, keyof T[K]> | AppendKeys<K, Normalize2<T[K]>>
+  ? T[K] extends Record<string, any>
+    ? T[K] extends readonly any[]
+      ? AppendKeys2<K, keyof T[K]> | AppendKeys2<K, Normalize2<T[K]>>
+      : AppendKeys<K, keyof T[K]> | AppendKeys<K, Normalize2<T[K]>>
     : never
   : never;
 type Normalize<T> = keyof T | Normalize2<T>;
@@ -84,31 +96,39 @@ export type TFuncKey<N, T = Resources> = N extends (keyof T)[]
   ? Normalize<T[N]>
   : string;
 
-export type TFuncReturn<N, P, T = Resources> = N extends (keyof T)[]
-  ? NormalizeMultiReturn<T, P>
+export type TFuncReturn<N, TKeys, TDefaultResult, T = Resources> = N extends (keyof T)[]
+  ? NormalizeMultiReturn<T, TKeys>
   : N extends keyof T
-  ? NormalizeReturn<T[N], P>
-  : TFunctionResult;
+  ? NormalizeReturn<T[N], TKeys>
+  : Fallback<TDefaultResult>;
 
 export interface TFunction<N extends Namespace = DefaultNamespace> {
-  <K extends TFuncKey<N> | TemplateStringsArray, I extends object = StringMap>(
-    key: K | K[],
-    options?: TOptions<I> | string,
-  ): TFuncReturn<N, K>;
-  <K extends TFuncKey<N> | TemplateStringsArray, I extends object = StringMap>(
-    key: K | K[],
+  <
+    TKeys extends TFuncKey<N> | TemplateStringsArray extends infer A ? A : never,
+    TDefaultResult extends TFunctionResult = string,
+    TInterpolationMap extends object = StringMap
+  >(
+    key: TKeys | TKeys[],
+    options?: TOptions<TInterpolationMap> | string,
+  ): TFuncReturn<N, TKeys, TDefaultResult>;
+  <
+    TKeys extends TFuncKey<N> | TemplateStringsArray extends infer A ? A : never,
+    TDefaultResult extends TFunctionResult = string,
+    TInterpolationMap extends object = StringMap
+  >(
+    key: TKeys | TKeys[],
     defaultValue?: string,
-    options?: TOptions<I> | string,
-  ): TFuncReturn<N, K>;
+    options?: TOptions<TInterpolationMap> | string,
+  ): TFuncReturn<N, TKeys, TDefaultResult>;
 }
 
 export interface TransProps<
-  K extends TFuncKey<N>,
+  K extends TFuncKey<N> extends infer A ? A : never,
   N extends Namespace = DefaultNamespace,
   E extends Element = HTMLDivElement
 > extends React.HTMLProps<E> {
   children?: React.ReactNode;
-  components?: React.ReactNode[] | { [tagName: string]: React.ReactNode };
+  components?: readonly React.ReactNode[] | { readonly [tagName: string]: React.ReactNode };
   count?: number;
   defaults?: string;
   i18n?: i18n;
@@ -120,7 +140,7 @@ export interface TransProps<
   t?: TFunction<N>;
 }
 export function Trans<
-  K extends TFuncKey<N>,
+  K extends TFuncKey<N> extends infer A ? A : never,
   N extends Namespace = DefaultNamespace,
   E extends Element = HTMLDivElement
 >(props: TransProps<K, N, E>): React.ReactElement;
@@ -138,7 +158,7 @@ type UseTranslationResponse<N extends Namespace> = [TFunction<N>, i18n, boolean]
   ready: boolean;
 };
 
-type DefaultNamespace<T = 'translation'> = ResourcesKey extends T ? T : string;
+type DefaultNamespace<T = 'translation'> = Fallback<string> extends T ? T : string;
 
 export function useTranslation<N extends Namespace = DefaultNamespace>(
   ns?: N,
@@ -176,9 +196,15 @@ export function withTranslation<N extends Namespace = DefaultNamespace>(
   options?: {
     withRef?: boolean;
   },
-): <P extends WithTranslation<N>>(
-  component: React.ComponentType<P>,
-) => React.ComponentType<Omit<P, keyof WithTranslation<N>> & WithTranslationProps>;
+): <
+  C extends React.ComponentType<React.ComponentProps<C> & WithTranslationProps>,
+  ResolvedProps = JSX.LibraryManagedAttributes<
+    C,
+    Subtract<React.ComponentProps<C>, WithTranslationProps>
+  >
+>(
+  component: C,
+) => React.ComponentType<Omit<ResolvedProps, keyof WithTranslation<N>> & WithTranslationProps>;
 
 export interface I18nextProviderProps {
   i18n: i18n;
@@ -199,6 +225,7 @@ export interface TranslationProps<N extends Namespace = DefaultNamespace> {
   ) => React.ReactNode;
   ns?: N;
   i18n?: i18n;
+  useSuspense?: boolean;
 }
 
 export function Translation<N extends Namespace = DefaultNamespace>(