feat: Typescript 1/4 (#67)

* deps: bump vite

* build: add external types to socket.io file

* build: migrate error to ts

* build: enable typescript

* fix errorCode typing

* Reorder test key in defineConfig

---------

Co-authored-by: Lars Johansson <[email protected]>

Author: jimmycallin

package.json

@@ -2,7 +2,7 @@
   "name": "@ftrack/api",
   "description": "JavaScript API for ftrack.",
   "scripts": {
-    "lint": "eslint . && prettier -c .",
+    "lint": "tsc && eslint . && prettier -c .",
     "test": "vitest --run test && yarn lint",
     "build": "vite build",
     "prepack": "yarn build",
@@ -31,8 +31,9 @@
     "msw": "^1.0.0",
     "prettier": "^2.8.3",
     "typescript": "^4.9.5",
-    "vite": "^4.0.4",
-    "vitest": "^0.28.3"
+    "vite": "^4.1.1",
+    "vite-plugin-dts": "^1.7.2",
+    "vitest": "^0.28.4"
   },
   "repository": {
     "type": "git",

source/error.js renamed to source/error.ts

@@ -1,8 +1,4 @@
 // :copyright: Copyright (c) 2016 ftrack
-/**
- * Error namespace
- * @namespace error
- */
 
 /**
  *
@@ -12,15 +8,16 @@
  * @param  {string} name name of error class
  * @return {CustomError}      Custom error object
  */
-function errorFactory(name) {
-  function CustomError(message, errorCode) {
-    this.name = name;
-    this.message = message;
-    this.errorCode = errorCode;
-    this.stack = new Error().stack;
-  }
+function errorFactory(name: string) {
+  class CustomError extends Error {
+    errorCode?: string;
 
-  CustomError.prototype = new Error();
+    constructor(message: string, errorCode?: string) {
+      super(message);
+      this.name = name;
+      this.errorCode = errorCode;
+    }
+  }
 
   return CustomError;
 }

source/index.js renamed to source/index.ts

@@ -0,0 +1 @@
+export function connect(serverUrl: string, options: any): void;

source/socket.io-websocket-only.cjs.d.ts

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "useDefineForClassFields": true,
+    "module": "ESNext",
+    "lib": ["ESNext", "DOM"],
+    "moduleResolution": "Node",
+    "strict": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "noEmit": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "skipLibCheck": true,
+    "allowJs": true
+  },
+  "include": ["source"],
+  "exclude": ["source/socket.io-websocket-only.cjs"]
+}

tsconfig.json

@@ -1,13 +1,19 @@
-const path = require("path");
-const { defineConfig } = require("vite");
-const commonjs = require("@rollup/plugin-commonjs");
+import { defineConfig, UserConfig } from "vite";
+import { InlineConfig } from "vitest";
+import path from "path";
+import dts from "vite-plugin-dts";
+import commonjs from "@rollup/plugin-commonjs";
 
-module.exports = defineConfig({
+interface VitestConfigExport extends UserConfig {
+  test: InlineConfig;
+}
+
+export default defineConfig({
   build: {
     minify: false,
     sourcemap: true,
     lib: {
-      entry: path.resolve(__dirname, "source/index.js"),
+      entry: path.resolve(__dirname, "source/index.ts"),
       name: "ftrack-javascript-api",
       fileName: (format) => `ftrack-javascript-api.${format}.js`,
     },
@@ -26,6 +32,7 @@ module.exports = defineConfig({
       plugins: [commonjs({ include: "./source/socket.io-websocket-only.cjs" })],
     },
   },
+  plugins: [dts()],
   test: {
     environment: "jsdom",
     globals: true,
@@ -34,4 +41,4 @@ module.exports = defineConfig({
       fallbackCJS: true,
     },
   },
-});
+} as VitestConfigExport);