react-i18next 11.15.1 → 11.15.5

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+### 11.15.5
+
+- types: fix never return type when using plurals [1453](https://github.com/i18next/react-i18next/pull/1453)
+
+### 11.15.4
+
+- types: add values field to Plural component in macros [1446](https://github.com/i18next/react-i18next/pull/1446)
+
+### 11.15.3
+
+- types: fix for issue introduced with type extension for react-native [1436](https://github.com/i18next/react-i18next/pull/1436)
+
+### 11.15.2
+
+- types: TypeScript interface for the Trans component does now accept react-native props [1418](https://github.com/i18next/react-i18next/pull/1418)
+
 ### 11.15.1
 
 - add missing types for shouldUnescape and useTranslation [1429](https://github.com/i18next/react-i18next/pull/1429)

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 i18next
+Copyright (c) 2022 i18next
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -4,15 +4,9 @@
 [![Code Climate](https://codeclimate.com/github/codeclimate/codeclimate/badges/gpa.svg)](https://codeclimate.com/github/i18next/react-i18next)
 [![Coverage Status](https://coveralls.io/repos/github/i18next/react-i18next/badge.svg)](https://coveralls.io/github/i18next/react-i18next)
 [![Quality][quality-badge] ][quality-url]
-[![dependencies][dependencies-image] ][dependencies-url]
-[![devdependencies][devdependencies-image] ][devdependencies-url]
 
 [npm-icon]: https://nodei.co/npm/react-i18next.png?downloads=true
 [npm-url]: https://npmjs.org/package/react-i18next
-[dependencies-image]: https://david-dm.org/i18next/react-i18next.png
-[dependencies-url]: https://david-dm.org/i18next/react-i18next
-[devdependencies-image]: https://david-dm.org/i18next/react-i18next/dev-status.png
-[devdependencies-url]: https://david-dm.org/i18next/react-i18next#info=devDependencies
 [quality-badge]: http://npm.packagequality.com/shield/react-i18next.svg
 [quality-url]: http://packagequality.com/#?package=react-i18next
 
@@ -36,8 +30,9 @@ npm i react-i18next@legacy
 
 ### Documentation
 
-The documentation is published on [react.i18next.com](https://react.i18next.com)
-The general i18next documentation is published on [www.i18next.com](https://www.i18next.com)
+The documentation is published on [react.i18next.com](https://react.i18next.com) and PR changes can be supplied [here](https://github.com/i18next/react-i18next-gitbook).
+
+The general i18next documentation is published on [www.i18next.com](https://www.i18next.com) and PR changes can be supplied [here](https://github.com/i18next/i18next-gitbook).
 
 ### What will my code look like?
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-i18next",
-  "version": "11.15.1",
+  "version": "11.15.5",
   "description": "Internationalization for react done right. Using the i18next i18n ecosystem.",
   "main": "dist/commonjs/index.js",
   "types": "./index.d.ts",
@@ -93,6 +93,14 @@
     "i18next": ">= 19.0.0",
     "react": ">= 16.8.0"
   },
+  "peerDependenciesMeta": {
+    "react-dom": {
+      "optional": true
+    },
+    "react-native": {
+      "optional": true
+    }
+  },
   "scripts": {
     "clean": "rimraf dist && mkdirp dist",
     "copy": "cp-cli ./dist/umd/react-i18next.min.js ./react-i18next.min.js && cp-cli ./dist/umd/react-i18next.js ./react-i18next.js",
@@ -109,9 +117,9 @@
     "test:watch": "cross-env BABEL_ENV=development jest --no-cache --watch",
     "test:coverage": "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",
-    "test:typescript:customtypes": "tslint --project ./test/typescript/custom-types/tsconfig.json",
+    "test:typescript": "tslint --project tsconfig.json '**/*.ts'",
+    "test:typescript:noninterop": "tslint --project tsconfig.nonEsModuleInterop.json '**/*.ts'",
+    "test:typescript:customtypes": "tslint --project ./test/typescript/custom-types/tsconfig.json '**/*.ts'",
     "contributors:add": "all-contributors add",
     "contributors:generate": "all-contributors generate",
     "prettier": "prettier --write \"{,**/}*.{ts,tsx,js,json,md}\""

package/ts4.1/icu.macro.d.ts

@@ -14,6 +14,7 @@ declare module 'react-i18next/icu.macro' {
     i18n?: i18n;
     ns?: N;
     count: number;
+    values?: {};
     zero?: string | React.ReactElement;
     one?: string | React.ReactElement;
     two?: string | React.ReactElement;

package/ts4.1/index.d.ts

@@ -95,8 +95,10 @@ declare module 'i18next' {
   }
 }
 
+type PluralSuffix = 'zero' | 'one' | 'two' | 'few' | 'many' | 'other';
+
 type WithOrWithoutPlural<K> = TypeOptions['jsonFormat'] extends 'v4'
-  ? K extends `${infer B}_${'zero' | 'one' | 'two' | 'few' | 'many' | 'other'}`
+  ? K extends `${infer B}_${PluralSuffix}`
     ? B | K
     : K
   : K;
@@ -130,10 +132,10 @@ type NormalizeMulti<T, U extends keyof T, L = LastOf<U>> = L extends U
   ? AppendNS<L, Normalize<T[L]>> | NormalizeMulti<T, Exclude<U, L>>
   : never;
 
-type CustomTypeParameters = {
+interface CustomTypeParameters {
   returnNull?: boolean;
   returnEmptyString?: boolean;
-};
+}
 
 type TypeOptionsFallback<TranslationValue, Option, MatchingValue> = Option extends false
   ? TranslationValue extends MatchingValue
@@ -150,6 +152,12 @@ export type NormalizeByTypeOptions<
   R = TypeOptionsFallback<TranslationValue, Options['returnEmptyString'], ''>
 > = TypeOptionsFallback<R, Options['returnNull'], null>;
 
+type StringIfPlural<T> = TypeOptions['jsonFormat'] extends 'v4'
+  ? T extends `${string}_${PluralSuffix}`
+    ? string
+    : never
+  : never;
+
 type NormalizeReturn<
   T,
   V,
@@ -162,7 +170,7 @@ type NormalizeReturn<
   ? K extends keyof T
     ? NormalizeReturn<T[K], R>
     : never
-  : never;
+  : StringIfPlural<keyof T>;
 
 type NormalizeMultiReturn<T, V> = V extends `${infer N}:${infer R}`
   ? N extends keyof T
@@ -234,12 +242,12 @@ export interface TFunction<N extends Namespace = DefaultNamespace, TKPrefix = un
   ): TFuncReturn<N, TKeys, TDefaultResult, TKPrefix>;
 }
 
-export interface TransProps<
+export type TransProps<
   K extends TFuncKey<N, TKPrefix> extends infer A ? A : never,
   N extends Namespace = DefaultNamespace,
   TKPrefix = undefined,
-  E extends Element = HTMLDivElement
-> extends React.HTMLProps<E> {
+  E = React.HTMLProps<HTMLDivElement>
+> = E & {
   children?: React.ReactNode;
   components?: readonly React.ReactNode[] | { readonly [tagName: string]: React.ReactNode };
   count?: number;
@@ -252,13 +260,13 @@ export interface TransProps<
   values?: {};
   shouldUnescape?: boolean;
   t?: TFunction<N, TKPrefix>;
-}
+};
 
 export function Trans<
   K extends TFuncKey<N, TKPrefix> extends infer A ? A : never,
   N extends Namespace = DefaultNamespace,
   TKPrefix extends KeyPrefix<N> = undefined,
-  E extends Element = HTMLDivElement
+  E = React.HTMLProps<HTMLDivElement>
 >(props: TransProps<K, N, TKPrefix, E>): React.ReactElement;
 
 export function useSSR(initialI18nStore: Resource, initialLanguage: string): void;

package/tslint.json

@@ -2,6 +2,14 @@
   "defaultSeverity": "error",
   "extends": "dtslint/dtslint.json",
   "rules": {
-    "semicolon": false
+    "array-type": [true, "array"],
+    "no-empty-interface": false,
+    "no-redundant-jsdoc": false,
+    "no-unnecessary-generics": false,
+    "semicolon": false,
+    "strict-export-declare-modifiers": false
+  },
+  "linterOptions": {
+    "exclude": ["node_modules/**/*"]
   }
 }