Add TypeScript typings (#15)

Add TypeScript typings

Author: Naturalclar

.circleci/config.yml

@@ -135,10 +135,9 @@ workflows:
       - eslint:
           requires:
             - linux-checkout
-      # TODO: implement typescript types
-      # - type-check:
-      #     requires:
-      #     - linux-checkout      
+      - type-check:
+          requires:
+          - linux-checkout      
       - jest:
           requires:
             - linux-checkout

index.d.ts

@@ -0,0 +1,35 @@
+import React from 'react';
+import {ViewProps,ImageSourcePropType} from 'react-native';
+
+export type ProgressViewProps = ViewProps & {
+    /**
+   * The progress bar style.
+   */
+  progressViewStyle?: 'default' | 'bar',
+
+  /**
+   * The progress value (between 0 and 1).
+   */
+  progress?: number,
+
+  /**
+   * The tint color of the progress bar itself.
+   */
+  progressTintColor?: string,
+
+  /**
+   * The tint color of the progress bar track.
+   */
+  trackTintColor?: string,
+
+  /**
+   * A stretchable image to display as the progress bar.
+   */
+  progressImage?: ImageSourcePropType,
+
+  /**
+   * A stretchable image to display behind the progress bar.
+   */
+  trackImage?: ImageSourcePropType,
+}
+export class ProgressView extends React.Component<ProgressViewProps> {}

package.json

@@ -20,15 +20,19 @@
     "android",
     "ios",
     "js",
-    "react-native-progress-view.podspec"
+    "react-native-progress-view.podspec",
+    "index.js",
+    "index.d.ts"
   ],
-  "main": "js/index.js",
+  "main": "index.js",
+  "types":"index.d.ts",
   "scripts": {
     "flow": "flow",
     "lint": "eslint .",
     "run:ios": "node node_modules/react-native/local-cli/cli.js run-ios --project-path \"./example/ios\"",
     "start": "node node_modules/react-native/local-cli/cli.js start --projectRoot example --watchFolders $PWD",
-    "test": "jest"
+    "test": "jest",
+    "type-check":"tsc --noEmit"
   },
   "jest": {
     "preset": "react-native"
@@ -39,6 +43,8 @@
     "@babel/runtime": "^7.4.3",
     "@react-native-community/eslint-config": "^0.0.6",
     "@react-native-community/eslint-plugin": "^1.0.0",
+    "@types/react": "^16.9.19",
+    "@types/react-native": "^0.61.2",
     "babel-jest": "24.7.1",
     "babel-plugin-module-resolver": "^3.2.0",
     "eslint": "^6.8.0",
@@ -49,7 +55,8 @@
     "prettier": "^1.19.1",
     "react": "16.8.3",
     "react-native": "^0.61.5",
-    "react-test-renderer": "16.8.3"
+    "react-test-renderer": "16.8.3",
+    "typescript": "^3.7.5"
   },
   "peerDependencies": {
     "react": "^16.8.3",

tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
+    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
+    "lib": ["es6"],
+    "jsx": "react" /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */,
+    /* Strict Type-Checking Options */
+    "strict": true /* Enable all strict type-checking options. */,
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+  }
+}

yarn.lock

@@ -1256,6 +1256,27 @@
   resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.4.tgz#38fd73ddfd9b55abb1e1b2ed578cb55bd7b7d339"
   integrity sha512-8+KAKzEvSUdeo+kmqnKrqgeE+LcA0tjYWFY7RPProVYwnqDjukzO+3b6dLD56rYX5TdWejnEOLJYOIeh4CXKuA==
 
+"@types/prop-types@*":
+  version "15.7.3"
+  resolved "https://registry.yarnpkg.com/@types/prop-types/-/prop-types-15.7.3.tgz#2ab0d5da2e5815f94b0b9d4b95d1e5f243ab2ca7"
+  integrity sha512-KfRL3PuHmqQLOG+2tGpRO26Ctg+Cq1E01D2DMriKEATHgWLfeNDmq9e29Q9WIky0dQ3NPkd1mzYH8Lm936Z9qw==
+
+"@types/react-native@^0.61.2":
+  version "0.61.2"
+  resolved "https://registry.yarnpkg.com/@types/react-native/-/react-native-0.61.2.tgz#1ee4f1e1ad246d671399d1112a8a703020b7a38b"
+  integrity sha512-z15qGoBmZD6KIx3ZRYsqjelwBYXRMylPqz34swCH2exEk1EwOcPG2cp/TIpiN72lpByHlPvoMKbu8v1lzQrayw==
+  dependencies:
+    "@types/prop-types" "*"
+    "@types/react" "*"
+
+"@types/react@*", "@types/react@^16.9.19":
+  version "16.9.19"
+  resolved "https://registry.yarnpkg.com/@types/react/-/react-16.9.19.tgz#c842aa83ea490007d29938146ff2e4d9e4360c40"
+  integrity sha512-LJV97//H+zqKWMms0kvxaKYJDG05U2TtQB3chRLF8MPNs+MQh/H1aGlyDUxjaHvu08EAGerdX2z4LTBc7ns77A==
+  dependencies:
+    "@types/prop-types" "*"
+    csstype "^2.2.0"
+
 "@types/stack-utils@^1.0.1":
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/@types/stack-utils/-/stack-utils-1.0.1.tgz#0a851d3bd96498fa25c33ab7278ed3bd65f06c3e"
@@ -2283,6 +2304,11 @@ cssstyle@^2.0.0:
   dependencies:
     cssom "~0.3.6"
 
+csstype@^2.2.0:
+  version "2.6.8"
+  resolved "https://registry.yarnpkg.com/csstype/-/csstype-2.6.8.tgz#0fb6fc2417ffd2816a418c9336da74d7f07db431"
+  integrity sha512-msVS9qTuMT5zwAGCVm4mxfrZ18BNc6Csd0oJAtiFMZ1FAx1CCvy2+5MDmYoix63LM/6NDbNtodCiGYGmFgO0dA==
+
 dashdash@^1.12.0:
   version "1.14.1"
   resolved "https://registry.yarnpkg.com/dashdash/-/dashdash-1.14.1.tgz#853cfa0f7cbe2fed5de20326b8dd581035f6e2f0"
@@ -6907,6 +6933,11 @@ typedarray@^0.0.6:
   resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777"
   integrity sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c=
 
+typescript@^3.7.5:
+  version "3.7.5"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.7.5.tgz#0692e21f65fd4108b9330238aac11dd2e177a1ae"
+  integrity sha512-/P5lkRXkWHNAbcJIiHPfRoKqyd7bsyCma1hZNUGfn20qm64T6ZBlrzprymeu918H+mB/0rIg2gGK/BXkhhYgBw==
+
 ua-parser-js@^0.7.18:
   version "0.7.21"
   resolved "https://registry.yarnpkg.com/ua-parser-js/-/ua-parser-js-0.7.21.tgz#853cf9ce93f642f67174273cc34565ae6f308777"