support intl.get(key) type check

examples/typescript-example/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "react-intl-universal-typescript-example",
+  "version": "1.0.0",
+  "private": true,
+  "author": "[email protected]",
+  "license": "BSD-3-Clause",
+  "devDependencies": {
+    "react-scripts": "^0.9.0"
+  },
+  "dependencies": {
+    "react-intl-universal": "*",
+    "typescript": "^3.0.3"
+  },
+  "scripts": {
+    "tsc": "tsc"
+  }
+}

examples/typescript-example/src/index.tsx

@@ -0,0 +1,6 @@
+import intl from 'react-intl-universal';
+intl.get('sign')
+intl.get('invalid');
+intl.getHTML('sign');
+intl.get('invalid');
+intl.get('sign');

examples/typescript-example/src/locales/en.json

@@ -0,0 +1,3 @@
+{
+  "sign": "sign"
+}

examples/typescript-example/src/locales/zh.json

@@ -0,0 +1,3 @@
+{
+  "sign": "登录"
+}

examples/typescript-example/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "sourceMap": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "jsx": "preserve",
+    "module": "commonjs",
+    "target": "es2015",
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "lib": ["es2017", "dom", "dom.iterable"],
+    "noEmit": true,
+    "pretty": true,
+    "skipLibCheck": true,
+    "skipDefaultLibCheck": true,
+    "strict": true
+  },
+  "include": ["**/*.ts", "**/*.tsx", "**/*.js", "**/*.jsx"],
+  "exclude": ["node_modules", "**/*.spec.ts"]
+}

examples/typescript-example/typings/module.ts

@@ -0,0 +1,4 @@
+import * as en from '../src/locales/en.json';
+declare module 'react-intl-universal' {
+  export interface Message extends Record<keyof typeof en, string> {}
+}

typings/index.d.ts

@@ -1,4 +1,10 @@
 declare module "react-intl-universal" {
+    /**
+     * Intl translation type definition
+     * @example { 'sign': string, 'logout': string }
+     */
+    export interface Message {}
+    type Key = keyof Message;
     /**
      * Helper: determine user's locale via URL, cookie, and browser's language.
      * You may not this API, if you have other rules to determine user's locale.
@@ -33,7 +39,7 @@ declare module "react-intl-universal" {
      * @param {string} key The string representing key in locale data file
      * @returns {string} message
      */
-    export function get(key: string): string;
+    export function get(key: Key): string;
 
     /**
      * Get the formatted message by key
@@ -48,18 +54,18 @@ declare module "react-intl-universal" {
      * @param {string} key The string representing key in locale data file
      * @returns {React.Element} message
      */
-    export function getHTML(key: string): string;
+    export function getHTML(key: Key): string;
 
     /**
      * Get the formatted html message by key.
      * @param {string} key The string representing key in locale data file
      * @param {Object} variables Variables in message
      * @returns {React.Element} message
      */
-    export function getHTML(key: string, value: any): string;
+    export function getHTML(key: Key, value: any): string;
 
     /**
-     * Get the inital options 
+     * Get the inital options
      * @returns {Object} options includes currentLocale and locales
      */
     export function getInitOptions(): ReactIntlUniversalOptions;
@@ -76,7 +82,7 @@ declare module "react-intl-universal" {
 
     /**
      * Load more locales after init
-     * @param {Object} locales App locale data 
+     * @param {Object} locales App locale data
      */
     export function load(locales: { [key: string]: any }): void;
 
@@ -88,7 +94,7 @@ declare module "react-intl-universal" {
         urlLocaleKey?: string;
         warningHandler?: (message?: any, error?: any) => void;
     }
-    
+
     export interface ReactIntlUniversalMessageDescriptor {
         id: string,
         defaultMessage?: string,