Browse Source

feat(ts) introduce TypeScript

This is just the stepping stone towards the goal of eventually having
lib-jitsi-meet fully written in JS.

- introduce ts-loader for webpack
- webpack will continue generating the UMD bundle
- tsc will generate an ES6 module
- output all bundles to dist/
tags/v0.0.2
Saúl Ibarra Corretgé 3 years ago
parent
commit
a0dc169186
7 changed files with 261 additions and 5 deletions
  1. 1
    0
      .eslintignore
  2. 1
    0
      .gitignore
  3. 220
    0
      package-lock.json
  4. 5
    2
      package.json
  5. 26
    0
      tsconfig.json
  6. 5
    1
      webpack-shared-config.js
  7. 3
    2
      webpack.config.js

+ 1
- 0
.eslintignore View File

@@ -1,5 +1,6 @@
1 1
 # The build artifacts of the lib-jiti-meet project.
2 2
 lib-jitsi-meet.*
3
+dist/
3 4
 
4 5
 # Third-party source code which we (1) do not want to modify or (2) try to
5 6
 # modify as little as possible.

+ 1
- 0
.gitignore View File

@@ -13,3 +13,4 @@ npm-*.log
13 13
 .DS_Store
14 14
 stats.json
15 15
 .vscode
16
+dist

+ 220
- 0
package-lock.json View File

@@ -45,6 +45,8 @@
45 45
         "karma-webpack": "5.0.0",
46 46
         "process": "0.11.10",
47 47
         "string-replace-loader": "3.0.3",
48
+        "ts-loader": "9.2.5",
49
+        "typescript": "4.3.5",
48 50
         "webpack": "5.57.1",
49 51
         "webpack-bundle-analyzer": "4.4.2",
50 52
         "webpack-cli": "4.9.0"
@@ -5126,6 +5128,19 @@
5126 5128
       "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==",
5127 5129
       "dev": true
5128 5130
     },
5131
+    "node_modules/micromatch": {
5132
+      "version": "4.0.4",
5133
+      "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.4.tgz",
5134
+      "integrity": "sha512-pRmzw/XUcwXGpD9aI9q/0XOwLNygjETJ8y0ao0wdqprrzDa4YnxLcz7fQRZr8voh8V10kGhABbNcHVk5wHgWwg==",
5135
+      "dev": true,
5136
+      "dependencies": {
5137
+        "braces": "^3.0.1",
5138
+        "picomatch": "^2.2.3"
5139
+      },
5140
+      "engines": {
5141
+        "node": ">=8.6"
5142
+      }
5143
+    },
5129 5144
     "node_modules/mime": {
5130 5145
       "version": "2.5.2",
5131 5146
       "resolved": "https://registry.npmjs.org/mime/-/mime-2.5.2.tgz",
@@ -6351,6 +6366,110 @@
6351 6366
         "node": ">=6"
6352 6367
       }
6353 6368
     },
6369
+    "node_modules/ts-loader": {
6370
+      "version": "9.2.5",
6371
+      "resolved": "https://registry.npmjs.org/ts-loader/-/ts-loader-9.2.5.tgz",
6372
+      "integrity": "sha512-al/ATFEffybdRMUIr5zMEWQdVnCGMUA9d3fXJ8dBVvBlzytPvIszoG9kZoR+94k6/i293RnVOXwMaWbXhNy9pQ==",
6373
+      "dev": true,
6374
+      "dependencies": {
6375
+        "chalk": "^4.1.0",
6376
+        "enhanced-resolve": "^5.0.0",
6377
+        "micromatch": "^4.0.0",
6378
+        "semver": "^7.3.4"
6379
+      },
6380
+      "engines": {
6381
+        "node": ">=12.0.0"
6382
+      },
6383
+      "peerDependencies": {
6384
+        "typescript": "*",
6385
+        "webpack": "^5.0.0"
6386
+      }
6387
+    },
6388
+    "node_modules/ts-loader/node_modules/ansi-styles": {
6389
+      "version": "4.3.0",
6390
+      "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
6391
+      "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
6392
+      "dev": true,
6393
+      "dependencies": {
6394
+        "color-convert": "^2.0.1"
6395
+      },
6396
+      "engines": {
6397
+        "node": ">=8"
6398
+      },
6399
+      "funding": {
6400
+        "url": "https://github.com/chalk/ansi-styles?sponsor=1"
6401
+      }
6402
+    },
6403
+    "node_modules/ts-loader/node_modules/chalk": {
6404
+      "version": "4.1.2",
6405
+      "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz",
6406
+      "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==",
6407
+      "dev": true,
6408
+      "dependencies": {
6409
+        "ansi-styles": "^4.1.0",
6410
+        "supports-color": "^7.1.0"
6411
+      },
6412
+      "engines": {
6413
+        "node": ">=10"
6414
+      },
6415
+      "funding": {
6416
+        "url": "https://github.com/chalk/chalk?sponsor=1"
6417
+      }
6418
+    },
6419
+    "node_modules/ts-loader/node_modules/color-convert": {
6420
+      "version": "2.0.1",
6421
+      "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
6422
+      "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
6423
+      "dev": true,
6424
+      "dependencies": {
6425
+        "color-name": "~1.1.4"
6426
+      },
6427
+      "engines": {
6428
+        "node": ">=7.0.0"
6429
+      }
6430
+    },
6431
+    "node_modules/ts-loader/node_modules/color-name": {
6432
+      "version": "1.1.4",
6433
+      "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
6434
+      "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==",
6435
+      "dev": true
6436
+    },
6437
+    "node_modules/ts-loader/node_modules/has-flag": {
6438
+      "version": "4.0.0",
6439
+      "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
6440
+      "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==",
6441
+      "dev": true,
6442
+      "engines": {
6443
+        "node": ">=8"
6444
+      }
6445
+    },
6446
+    "node_modules/ts-loader/node_modules/semver": {
6447
+      "version": "7.3.5",
6448
+      "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz",
6449
+      "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==",
6450
+      "dev": true,
6451
+      "dependencies": {
6452
+        "lru-cache": "^6.0.0"
6453
+      },
6454
+      "bin": {
6455
+        "semver": "bin/semver.js"
6456
+      },
6457
+      "engines": {
6458
+        "node": ">=10"
6459
+      }
6460
+    },
6461
+    "node_modules/ts-loader/node_modules/supports-color": {
6462
+      "version": "7.2.0",
6463
+      "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
6464
+      "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==",
6465
+      "dev": true,
6466
+      "dependencies": {
6467
+        "has-flag": "^4.0.0"
6468
+      },
6469
+      "engines": {
6470
+        "node": ">=8"
6471
+      }
6472
+    },
6354 6473
     "node_modules/tsconfig-paths": {
6355 6474
       "version": "3.11.0",
6356 6475
       "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.11.0.tgz",
@@ -6412,6 +6531,19 @@
6412 6531
         "node": ">= 0.6"
6413 6532
       }
6414 6533
     },
6534
+    "node_modules/typescript": {
6535
+      "version": "4.3.5",
6536
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.3.5.tgz",
6537
+      "integrity": "sha512-DqQgihaQ9cUrskJo9kIyW/+g0Vxsk8cDtZ52a3NGh0YNTfpUSArXSohyUGnvbPazEPLu398C0UxmKSOrPumUzA==",
6538
+      "dev": true,
6539
+      "bin": {
6540
+        "tsc": "bin/tsc",
6541
+        "tsserver": "bin/tsserver"
6542
+      },
6543
+      "engines": {
6544
+        "node": ">=4.2.0"
6545
+      }
6546
+    },
6415 6547
     "node_modules/ua-parser-js": {
6416 6548
       "version": "0.7.21",
6417 6549
       "resolved": "https://registry.npmjs.org/ua-parser-js/-/ua-parser-js-0.7.21.tgz",
@@ -10952,6 +11084,16 @@
10952 11084
       "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==",
10953 11085
       "dev": true
10954 11086
     },
11087
+    "micromatch": {
11088
+      "version": "4.0.4",
11089
+      "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.4.tgz",
11090
+      "integrity": "sha512-pRmzw/XUcwXGpD9aI9q/0XOwLNygjETJ8y0ao0wdqprrzDa4YnxLcz7fQRZr8voh8V10kGhABbNcHVk5wHgWwg==",
11091
+      "dev": true,
11092
+      "requires": {
11093
+        "braces": "^3.0.1",
11094
+        "picomatch": "^2.2.3"
11095
+      }
11096
+    },
10955 11097
     "mime": {
10956 11098
       "version": "2.5.2",
10957 11099
       "resolved": "https://registry.npmjs.org/mime/-/mime-2.5.2.tgz",
@@ -11900,6 +12042,78 @@
11900 12042
       "integrity": "sha512-gduQwd1rOdDMGxFG1gEvhV88Oirdo2p+KjoYFU7k2g+i7n6AFFbDQ5kMPUsW0pNbfQsB/cwXvT1i4Bue0s9g5g==",
11901 12043
       "dev": true
11902 12044
     },
12045
+    "ts-loader": {
12046
+      "version": "9.2.5",
12047
+      "resolved": "https://registry.npmjs.org/ts-loader/-/ts-loader-9.2.5.tgz",
12048
+      "integrity": "sha512-al/ATFEffybdRMUIr5zMEWQdVnCGMUA9d3fXJ8dBVvBlzytPvIszoG9kZoR+94k6/i293RnVOXwMaWbXhNy9pQ==",
12049
+      "dev": true,
12050
+      "requires": {
12051
+        "chalk": "^4.1.0",
12052
+        "enhanced-resolve": "^5.0.0",
12053
+        "micromatch": "^4.0.0",
12054
+        "semver": "^7.3.4"
12055
+      },
12056
+      "dependencies": {
12057
+        "ansi-styles": {
12058
+          "version": "4.3.0",
12059
+          "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
12060
+          "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
12061
+          "dev": true,
12062
+          "requires": {
12063
+            "color-convert": "^2.0.1"
12064
+          }
12065
+        },
12066
+        "chalk": {
12067
+          "version": "4.1.2",
12068
+          "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz",
12069
+          "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==",
12070
+          "dev": true,
12071
+          "requires": {
12072
+            "ansi-styles": "^4.1.0",
12073
+            "supports-color": "^7.1.0"
12074
+          }
12075
+        },
12076
+        "color-convert": {
12077
+          "version": "2.0.1",
12078
+          "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
12079
+          "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
12080
+          "dev": true,
12081
+          "requires": {
12082
+            "color-name": "~1.1.4"
12083
+          }
12084
+        },
12085
+        "color-name": {
12086
+          "version": "1.1.4",
12087
+          "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
12088
+          "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==",
12089
+          "dev": true
12090
+        },
12091
+        "has-flag": {
12092
+          "version": "4.0.0",
12093
+          "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
12094
+          "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==",
12095
+          "dev": true
12096
+        },
12097
+        "semver": {
12098
+          "version": "7.3.5",
12099
+          "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz",
12100
+          "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==",
12101
+          "dev": true,
12102
+          "requires": {
12103
+            "lru-cache": "^6.0.0"
12104
+          }
12105
+        },
12106
+        "supports-color": {
12107
+          "version": "7.2.0",
12108
+          "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
12109
+          "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==",
12110
+          "dev": true,
12111
+          "requires": {
12112
+            "has-flag": "^4.0.0"
12113
+          }
12114
+        }
12115
+      }
12116
+    },
11903 12117
     "tsconfig-paths": {
11904 12118
       "version": "3.11.0",
11905 12119
       "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.11.0.tgz",
@@ -11948,6 +12162,12 @@
11948 12162
         "mime-types": "~2.1.24"
11949 12163
       }
11950 12164
     },
12165
+    "typescript": {
12166
+      "version": "4.3.5",
12167
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.3.5.tgz",
12168
+      "integrity": "sha512-DqQgihaQ9cUrskJo9kIyW/+g0Vxsk8cDtZ52a3NGh0YNTfpUSArXSohyUGnvbPazEPLu398C0UxmKSOrPumUzA==",
12169
+      "dev": true
12170
+    },
11951 12171
     "ua-parser-js": {
11952 12172
       "version": "0.7.21",
11953 12173
       "resolved": "https://registry.npmjs.org/ua-parser-js/-/ua-parser-js-0.7.21.tgz",

+ 5
- 2
package.json View File

@@ -51,6 +51,8 @@
51 51
     "karma-webpack": "5.0.0",
52 52
     "process": "0.11.10",
53 53
     "string-replace-loader": "3.0.3",
54
+    "ts-loader": "9.2.5",
55
+    "typescript": "4.3.5",
54 56
     "webpack": "5.57.1",
55 57
     "webpack-bundle-analyzer": "4.4.2",
56 58
     "webpack-cli": "4.9.0"
@@ -58,12 +60,13 @@
58 60
   "scripts": {
59 61
     "lint": "eslint .",
60 62
     "lint-fix": "eslint . --fix",
61
-    "postinstall": "webpack",
63
+    "postinstall": "webpack && tsc",
62 64
     "test": "karma start karma.conf.js",
63 65
     "test-watch": "karma start karma.conf.js --no-single-run",
64 66
     "validate": "npm ls",
65 67
     "watch": "webpack --config webpack.config.js --watch --mode development"
66 68
   },
67
-  "main": "./index.js",
69
+  "browser": "dist/umd/lib-jitsi-meet.min.js",
70
+  "module": "dist/esm/JitsiMeetJS.js",
68 71
   "license": "Apache-2.0"
69 72
 }

+ 26
- 0
tsconfig.json View File

@@ -0,0 +1,26 @@
1
+{
2
+  "compilerOptions": {
3
+    "target": "es6",
4
+    "module": "es6",
5
+    "declaration": false,
6
+    "sourceMap": true,
7
+    "allowJs": true,
8
+    "skipLibCheck": true,
9
+    "esModuleInterop": true,
10
+    "allowSyntheticDefaultImports": true,
11
+    "lib": [
12
+      "esnext",
13
+      "dom"
14
+    ],
15
+    "outDir": "dist/esm/",
16
+  },
17
+  "exclude": [
18
+    "doc",
19
+    "dist",
20
+    "**/*.spec.js",
21
+    "*.conf*.js",
22
+    "webpack*.js",
23
+    "lib-jitsi-meet.*.js",
24
+    "types"
25
+  ]
26
+}

+ 5
- 1
webpack-shared-config.js View File

@@ -52,7 +52,11 @@ module.exports = (minimize, analyzeBundle) => {
52 52
                         ]
53 53
                     ]
54 54
                 },
55
-                test: /\.js$/
55
+                test: /\.(js|ts)$/
56
+            }, {
57
+                exclude: /node_modules/,
58
+                test: /\.ts$/,
59
+                use: 'ts-loader'
56 60
             } ]
57 61
         },
58 62
         node: {

+ 3
- 2
webpack.config.js View File

@@ -1,3 +1,4 @@
1
+const path = require('path');
1 2
 const process = require('process');
2 3
 
3 4
 const sharedConfig = require('./webpack-shared-config');
@@ -16,7 +17,7 @@ module.exports = (_env, argv) => {
16 17
             output: Object.assign({}, config.output, {
17 18
                 library: 'JitsiMeetJS',
18 19
                 libraryTarget: 'umd',
19
-                path: process.cwd()
20
+                path: path.join(process.cwd(), 'dist', 'umd')
20 21
             })
21 22
         }),
22 23
         {
@@ -26,7 +27,7 @@ module.exports = (_env, argv) => {
26 27
             mode,
27 28
             output: {
28 29
                 filename: 'lib-jitsi-meet.e2ee-worker.js',
29
-                path: process.cwd()
30
+                path: path.join(process.cwd(), 'dist', 'umd')
30 31
             },
31 32
             optimization: {
32 33
                 minimize: false

Loading…
Cancel
Save