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

Refactor: Migrate playkit to TypeScript (from Flow)

solves FEC-13371

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

.eslintignore

@@ -1,3 +1,5 @@
-/flow-typed/
-/coverage
-/dist
+dist/
+types/
+demo/
+webpack.config.js
+tsconfig.json

.eslintrc

@@ -0,0 +1,60 @@
+{
+  "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",
+    "@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": "warn",
+    "@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"
+        }
+      }
+    ],
+    "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"
+      }
+    ]
+  },
+  "overrides": [],
+  "settings": {
+    "jest": {
+      "version": 26
+    }
+  },
+  "env": {
+    "browser": true,
+    "commonjs": true,
+    "es6": true
+  }
+}

.github/workflows/run_canary.yaml

@@ -20,5 +20,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

@@ -1,45 +1,7 @@
-# MacOS
-.DS_Store
-
-# Logs
-logs
-*.log
-npm-debug.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
+dist
+lib
 node_modules
-jspm_packages
-
-# Optional npm cache directory
-.npm
-.npmrc
-
-# Optional REPL history
-.node_repl_history
-
-.idea
-
-dist/
+*.log
+api-extractor/report/
+api-extractor/report-temp/
+api-extractor/playkit-js.api.json

.prettierrc

@@ -1,12 +1,9 @@
 {
-  "printWidth": 150,
+  "printWidth": 200,
   "tabWidth": 2,
   "useTabs": false,
   "semi": true,
   "singleQuote": true,
   "trailingComma": "none",
-  "bracketSpacing": false,
-  "jsxBracketSameLine": true,
-  "arrowParens": "avoid",
   "proseWrap": "preserve"
 }

api-extractor.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "<projectFolder>/lib/playkit.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"
+      }
+    }
+  }
+}