refactor: migrate to typescript, fixes #42

Author: MichaelSolati

.babelrc

@@ -3,21 +3,22 @@
   "version": "0.0.0-semantic-released",
   "description": "JS SDK for Typeform API",
   "scripts": {
-    "test:unit": "MOCK_AXIOS=true jest ./tests/unit",
-    "test:unit:watch": "MOCK_AXIOS=true jest ./tests/unit --watch",
-    "test:integration": "jest ./tests/integration/",
-    "test:integration:watch": "jest ./tests/integration/ --watch",
+    "test:unit": "jest ./tests/unit",
+    "test:unit:watch": "jest ./tests/unit --watch",
+    "test:integration": "jest ./tests/integration",
+    "test:integration:watch": "jest ./tests/integration --watch",
     "build": "rm -rf ./dist && rollup -c",
     "prepublish": "in-publish && npm run build || not-in-publish",
     "prepare": "npm run build",
-    "lint": "standard ./src",
+    "lint": "tslint --project tsconfig.json --config tslint.json",
     "semantic-release": "semantic-release",
     "server": "node ./tests/integration/mockServer.js",
     "server:dev": "nodemon ./tests/integration/mockServer.js"
   },
   "main": "dist/index.cjs.js",
   "browser": "dist/typeform-api.js",
   "module": "dist/index.esm.js",
+  "typings": "dist/index.d.ts",
   "engines": {
     "node": ">=8"
   },
@@ -51,61 +52,39 @@
     "axios": "^0.19.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.0.0-rc.1",
-    "@babel/core": "^7.0.0-rc.1",
-    "@babel/node": "^7.0.0-rc.1",
-    "@babel/plugin-proposal-object-rest-spread": "^7.0.0-rc.1",
-    "@babel/preset-env": "^7.0.0-rc.1",
-    "@commitlint/cli": "^7.5.2",
-    "@commitlint/config-conventional": "^7.5.0",
+    "@commitlint/cli": "^8.1.0",
+    "@commitlint/config-conventional": "^8.1.0",
+    "@types/jest": "^24.0.18",
     "axios-mock-adapter": "^1.17.0",
-    "babel-core": "^7.0.0-bridge.0",
-    "babel-eslint": "^8.2.3",
-    "babel-jest": "^22.4.3",
-    "babel-loader": "^7.1.4",
-    "eslint": "^5.16.0",
-    "eslint-config-standard": "^12.0.0",
-    "eslint-plugin-import": "^2.17.2",
-    "eslint-plugin-node": "^8.0.1",
-    "eslint-plugin-promise": "^4.1.1",
-    "eslint-plugin-standard": "^4.0.0",
-    "husky": "^2.1.0",
+    "husky": "^4.0.0-beta.1",
     "in-publish": "^2.0.0",
-    "jest": "^22.4.3",
-    "json-server": "^0.14.0",
-    "lint-staged": "^7.0.4",
-    "nodemon": "^1.18.3",
-    "rollup": "^1.20.0",
-    "rollup-plugin-commonjs": "^10.0.2",
+    "jest": "^24.9.0",
+    "json-server": "^0.15.1",
+    "lint-staged": "^9.2.5",
+    "nodemon": "^1.19.2",
+    "rollup": "^1.21.2",
+    "rollup-plugin-commonjs": "^10.1.0",
+    "rollup-plugin-copier": "^1.1.0",
     "rollup-plugin-json": "^4.0.0",
+    "rollup-plugin-node-builtins": "^2.1.2",
+    "rollup-plugin-node-globals": "^1.4.0",
     "rollup-plugin-node-resolve": "^5.2.0",
     "rollup-plugin-terser": "^5.1.1",
-    "semantic-release": "^15.13.19",
-    "standard": "^11.0.1"
-  },
-  "lint-staged": {
-    "*.js": [
-      "standard",
-      "git add"
-    ]
+    "rollup-plugin-typescript2": "^0.24.1",
+    "semantic-release": "^15.13.24",
+    "ts-jest": "^24.0.2",
+    "tslint": "^5.20.0",
+    "tslint-config-standard": "^8.0.1",
+    "typescript": "^3.6.2"
   },
   "jest": {
     "automock": false,
-    "setupFiles": [
-      "./tests/setupJest.js"
-    ],
-    "testURL": "http://localhost/"
-  },
-  "standard": {
-    "env": [
-      "jest"
-    ],
-    "globals": [
-      "axios"
-    ]
+    "testURL": "http://localhost/",
+    "preset": "ts-jest"
   },
   "husky": {
     "hooks": {
+      "pre-commit": "npm run lint",
       "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
     }
   }

.eslintrc.js

@@ -1,8 +1,20 @@
+import builtins from 'rollup-plugin-node-builtins'
 import commonjs from 'rollup-plugin-commonjs'
+import copier from 'rollup-plugin-copier'
 import json from 'rollup-plugin-json'
+import globals from 'rollup-plugin-node-globals'
 import resolveModule from 'rollup-plugin-node-resolve'
-import pkg from './package.json'
 import { terser } from 'rollup-plugin-terser'
+import typescript from 'rollup-plugin-typescript2'
+import pkg from './package.json'
+
+const copy = copier({
+  items: [{
+    src: 'src/typeform-types.ts',
+    dest: 'dist/typeform-types.ts',
+    createPath: true
+  }]
+})
 
 const onwarn = (warning, rollupWarn) => {
   if (warning.code !== 'CIRCULAR_DEPENDENCY') {
@@ -11,14 +23,13 @@ const onwarn = (warning, rollupWarn) => {
 }
 
 const plugins = [
-  commonjs({
-    include: ['node_modules/**']
-  }),
-  json()
+  typescript(),
+  json(),
+  copy
 ]
 
 export default [{
-  input: 'src/index.js',
+  input: 'src/index.ts',
   output: [{
     file: pkg.main,
     format: 'cjs',
@@ -30,27 +41,36 @@ export default [{
   }],
   onwarn,
   plugins: [
-    resolveModule({
-      mainFields: ['main', 'module'],
-      preferBuiltins: true
+    resolveModule(),
+    commonjs({
+      include: ['node_modules/**']
     }),
     ...plugins
   ],
   external: ['http', 'https', 'url', 'zlib', 'assert', 'stream', 'tty', 'util', 'os']
 }, {
-  input: 'src/index.js',
+  input: 'src/index.ts',
   output: {
     file: pkg.browser,
     format: 'umd',
     name: 'typeformAPI',
-    exports: 'named'
+    exports: 'named',
+    intro: 'const global = window;'
   },
   onwarn,
   plugins: [
     resolveModule({
-      mainFields: ['browser']
+      browser: true
     }),
-    terser(),
-    ...plugins
+    commonjs({
+      include: ['node_modules/**'],
+      browser: true,
+      preferBuiltins: false,
+      ignoreGlobal: false
+    }),
+    ...plugins,
+    globals(),
+    builtins(),
+    terser()
   ]
 }]

package-lock.json

@@ -1,4 +1,6 @@
-export const FONTS_AVAILABLE = [
+import { Typeform } from '../typeform-types'
+
+export const FONTS_AVAILABLE: Typeform.Font[] = [
   'Acme',
   'Arial',
   'Arvo',
@@ -33,4 +35,4 @@ export const FONTS_AVAILABLE = [
   'Vollkorn'
 ]
 
-export const API_BASE_URL = 'https://api.typeform.com'
+export const API_BASE_URL: Typeform.API_URL = 'https://api.typeform.com'

package.json

@@ -1,9 +1,10 @@
 import axios from 'axios'
 import { API_BASE_URL } from './constants'
+import { Typeform } from './typeform-types'
 
-export const clientConstructor = ({ token, ...options }) => {
+export const clientConstructor = ({ token, ...options }: Typeform.ClientArg): Typeform.HTTPClient => {
   return {
-    request: (args) => {
+    request: (args: Typeform.Request) => {
       const {
         url,
         data,
@@ -23,6 +24,7 @@ export const clientConstructor = ({ token, ...options }) => {
         ...otherArgs
       }
 
+      // @ts-ignore
       return axios({
         url: requestUrl,
         ...requestParameters,
@@ -34,8 +36,8 @@ export const clientConstructor = ({ token, ...options }) => {
           Authorization: `bearer ${token}`
         }
       })
-        .then(response => response.data)
-        .catch(error => {
+        .then((response: any) => response.data)
+        .catch((error: any) => {
           if (error && error.response && error.response.data && error.response.data.description) {
             throw new Error(error.response.data.description)
           } else {
@@ -46,7 +48,7 @@ export const clientConstructor = ({ token, ...options }) => {
   }
 }
 
-export const buildUrlWithParams = (url, params = {}) => {
+export const buildUrlWithParams = (url: string, params: Typeform.DocumentData = {}): string => {
   const queryParams = Object.keys(params)
     .filter((key) => params[key] !== undefined && params[key] !== null)
     .map((key) => `${encodeURIComponent(key)}=${encodeURIComponent(params[key])}`)