feat(FEC-13371): Refactor: Migrate to TypeScript (from Flow) (#213)

Refactor: Migration to TypeScript'

Related PRs
kaltura/kaltura-player-js#661
kaltura/playkit-js#726
kaltura/playkit-js-providers#225
kaltura/playkit-js-dash#254
kaltura/playkit-js-ui#815
kaltura/playkit-js-browserslist-config#1

solves FEC-13371


Co-authored-by: JonathanTGold <jonathan.gold@[email protected]>

.eslintrc.json

@@ -1,26 +1,69 @@
 {
-  "parser": "babel-eslint",
-  "extends": ["eslint:recommended", "plugin:flowtype/recommended"],
-  "plugins": ["prettier", "import", "flowtype", "mocha-no-only"],
-  "env": {
-    "browser": true,
-    "es6": true,
-    "mocha": true,
-    "amd": true,
-    "commonjs": true
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "indent": ["error", 2],
+    "react/prefer-stateless-function": "off",
+    "max-len": ["warn", {"code": 500}],
+    "eol-last": "off",
+    "prettier/prettier": "off",
+    "@typescript-eslint/explicit-function-return-type": "warn",
+    "@typescript-eslint/no-non-null-assertion": "off",
+    "@typescript-eslint/no-unused-vars": "error",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/explicit-member-accessibility": [
+      "error",
+      {
+        "accessibility": "explicit",
+        "overrides": {
+          "accessors": "explicit",
+          "constructors": "no-public",
+          "methods": "explicit",
+          "properties": "explicit",
+          "parameterProperties": "explicit"
+        }
+      }
+    ],
+    "@typescript-eslint/ban-types": [
+      "error",
+      {
+        "extendDefaults": true,
+        "types": {
+          "Function": false // Overrides the rule for "Function" type only
+        }
+      }
+    ],
+    "block-scoped-var": "error",
+    "eqeqeq": "error",
+    "no-var": "error",
+    "no-console": "error",
+    "prefer-const": "error",
+    "prefer-arrow-callback": "error",
+    "no-trailing-spaces": "error",
+    "quotes": ["warn", "single", {"avoidEscape": true}],
+    "no-restricted-properties": [
+      "error",
+      {
+        "object": "describe",
+        "property": "only"
+      },
+      {
+        "object": "it",
+        "property": "only"
+      }
+    ]
   },
-  "globals": {
-    "should": true,
-    "sinon": true,
-    "__VERSION__": true,
-    "__NAME__": true,
-    "process": true,
-    "__dirname": true
+  "overrides": [],
+  "settings": {
+    "jest": {
+      "version": 26
+    }
   },
-  "rules": {
-    "prettier/prettier": "error",
-    "mocha-no-only/mocha-no-only": "off",
-    "require-jsdoc": ["error"],
-    "valid-jsdoc": ["error"]
+  "env": {
+    "browser": true,
+    "commonjs": true,
+    "es6": true
   }
 }

.github/workflows/run_canary.yaml

@@ -13,5 +13,6 @@ jobs:
     uses: kaltura/playkit-js-common/.github/workflows/canary_dependency.yaml@master
     secrets: inherit
     with:
+      node-version: "20.x"
       schema-type: "playerV3Versions"
-      tests-yarn-run-to-execute: 'build eslint flow test'
+      tests-yarn-run-to-execute: 'build lint type-check test'

.github/workflows/run_prod.yaml

@@ -18,7 +18,8 @@ jobs:
       PLAYER_MSTEAMS_WEBHOOK: ${{ secrets.PLAYER_MSTEAMS_WEBHOOK }}
       PLAYER_GITHUB_BOT_TOKEN: ${{ secrets.PLAYER_GITHUB_BOT_TOKEN }}
     with:
+      node-version: "20.x"
       type: "dependency"
       env: "prod"
       schema-type: "playerV3Versions"
-      tests-yarn-run-to-execute: 'build eslint flow test'
+      tests-yarn-run-to-execute: 'build lint type-check test'

.github/workflows/run_tests.yaml

@@ -8,14 +8,35 @@ on:
       - "*"
 
 jobs:
-  running-tests:
+  build:
     uses: kaltura/ovp-pipelines-pub/.github/workflows/player_tests.yaml@master
     with:
-      yarn-run-to-execute: 'build eslint flow test'
+      node-version: '20.x'
+      yarn-run-to-execute: 'build'
+  test:
+    uses: kaltura/ovp-pipelines-pub/.github/workflows/player_tests.yaml@master
+    with:
+      node-version: '20.x'
+      yarn-run-to-execute: 'test'
+  type-check:
+    uses: kaltura/ovp-pipelines-pub/.github/workflows/player_tests.yaml@master
+    with:
+      node-version: '20.x'
+      yarn-run-to-execute: 'type-check'
+  build-types:
+    uses: kaltura/ovp-pipelines-pub/.github/workflows/player_tests.yaml@master
+    with:
+      node-version: '20.x'
+      yarn-run-to-execute: 'build:types'
+  lint:
+    uses: kaltura/ovp-pipelines-pub/.github/workflows/player_tests.yaml@master
+    with:
+      node-version: '20.x'
+      yarn-run-to-execute: 'lint'
   notification:
     if: always()
     uses: kaltura/ovp-pipelines-pub/.github/workflows/notification.yaml@master
-    needs: running-tests
+    needs: [build, test, type-check, lint]
     secrets:
       PLAYER_MSTEAMS_WEBHOOK: ${{ secrets.PLAYER_MSTEAMS_WEBHOOK }}
     with:

.gitignore

@@ -43,3 +43,7 @@ jspm_packages
 .idea
 
 dist/
+lib
+api-extractor/report/
+api-extractor/report-temp/
+api-extractor/playkit-js-hls.api.json

api-extractor.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
+  "bundledPackages": [],
+  "compiler": {},
+  "apiReport": {
+    "enabled": true,
+    "reportFolder": "<projectFolder>/api-extractor/report",
+    "reportTempFolder": "<projectFolder>/api-extractor/report-temp"
+  },
+  "docModel": {
+    "enabled": true,
+    "apiJsonFilePath": "<projectFolder>/api-extractor/<unscopedPackageName>.api.json"
+  },
+  "dtsRollup": {
+    "enabled": true,
+    "untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts"
+  },
+  "tsdocMetadata": {},
+  "messages": {
+    "compilerMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    },
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    },
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    }
+  }
+}