FIX: remove JSDoc in build process (#379)

DimaDemchenko · mrlika · web-flow · commit ef0de12d4f6b · 2024-06-26T18:56:19.000+03:00
* Remove jsdoc in build files

* Update module and module resolution options in tsconfig.node.json files

* Make demo use minified files to test

* Don't remove comments if minify isn't enabled

* Improve Hls with Shaka demo

---------

Co-authored-by: Andriy Lysnevych &lt;andriy.lysnevych@novage.com.ua&gt;
diff --git a/demo/public/modules-demo/hls-with-shaka.html b/demo/public/modules-demo/hls-with-shaka.html
@@ -4,17 +4,17 @@
     <script type="importmap">
       {
         "imports": {
-          "p2p-media-loader-core": "./core/p2p-media-loader-core.es.js",
-          "p2p-media-loader-shaka": "./shaka/p2p-media-loader-shaka.es.js",
-          "p2p-media-loader-hlsjs": "./hlsjs/p2p-media-loader-hlsjs.es.js"
+          "p2p-media-loader-core": "./core/p2p-media-loader-core.es.min.js",
+          "p2p-media-loader-shaka": "./shaka/p2p-media-loader-shaka.es.min.js",
+          "p2p-media-loader-hlsjs": "./hlsjs/p2p-media-loader-hlsjs.es.min.js"
         }
       }
     </script>
 
     <script src="https://cdn.jsdelivr.net/npm/shaka-player@~4/dist/shaka-player.compiled.min.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/hls.js@~1/dist/hls.min.js"></script>
 
-    <script type="module" src="./demo.js"></script>
+    <script type="module" src="./hls-with-shaka.js"></script>
   </head>
   <body>
     <video id="video1" width="640" controls autoplay></video>
diff --git a/demo/public/modules-demo/hls-with-shaka.js b/demo/public/modules-demo/hls-with-shaka.js
@@ -5,40 +5,37 @@ const manifestUri = "https://test-streams.mux.dev/x36xhzz/x36xhzz.m3u8";
 
 async function initApp() {
   if (shaka.Player.isBrowserSupported()) {
-    initHlsPlayer();
-    await initShakaPlayer();
+    initHlsPlayer("video1");
+    await initShakaPlayer("video2");
   } else {
     console.error("Browser not supported!");
   }
 }
 
-function initHlsPlayer() {
-  const p2pEngine = new HlsJsP2PEngine();
-
-  const hls = new Hls({ ...p2pEngine.getHlsJsConfig() });
-  hls.attachMedia(document.getElementById("video1"));
+function initHlsPlayer(videoId) {
+  const HlsWithP2P = HlsJsP2PEngine.injectMixin(window.Hls);
+  const hls = new HlsWithP2P();
+  hls.attachMedia(document.getElementById(videoId));
   hls.on(Hls.Events.ERROR, function (event, data) {
     console.error("Error code", data.details, "object", data);
   });
 
-  p2pEngine.setHls(hls);
-
   try {
     hls.loadSource(manifestUri);
   } catch (e) {
     onError(e);
   }
 }
 
-async function initShakaPlayer() {
+async function initShakaPlayer(videoId) {
   ShakaP2PEngine.registerPlugins();
   const engine = new ShakaP2PEngine();
 
   const player = new shaka.Player();
-  await player.attach(document.getElementById("video2"));
+  await player.attach(document.getElementById(videoId));
   player.addEventListener("error", onErrorEvent);
 
-  engine.configureAndInitShakaPlayer(player);
+  engine.bindShakaPlayer(player);
 
   try {
     await player.load(manifestUri);
diff --git a/demo/public/modules-demo/player-vime.html b/demo/public/modules-demo/player-vime.html
@@ -6,8 +6,8 @@
     <script type="importmap">
       {
         "imports": {
-          "p2p-media-loader-core": "./core/p2p-media-loader-core.es.js",
-          "p2p-media-loader-hlsjs": "./hlsjs/p2p-media-loader-hlsjs.es.js"
+          "p2p-media-loader-core": "./core/p2p-media-loader-core.es.min.js",
+          "p2p-media-loader-hlsjs": "./hlsjs/p2p-media-loader-hlsjs.es.min.js"
         }
       }
     </script>
diff --git a/packages/p2p-media-loader-core/package.json b/packages/p2p-media-loader-core/package.json
@@ -60,6 +60,7 @@
     "nano-md5": "^1.0.5"
   },
   "devDependencies": {
+    "@rollup/plugin-terser": "^0.4.4",
     "@types/streamx": "^2.9.5",
     "vite-plugin-node-polyfills": "^0.21.0",
     "vitest": "^1.6.0"
diff --git a/packages/p2p-media-loader-core/tsconfig.node.json b/packages/p2p-media-loader-core/tsconfig.node.json
@@ -1,8 +1,8 @@
 {
   "extends": "../../tsconfig.base.json",
   "compilerOptions": {
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext"
+    "module": "ESNext",
+    "moduleResolution": "Bundler"
   },
   "include": ["vite.config.ts"]
 }
diff --git a/packages/p2p-media-loader-core/vite.config.ts b/packages/p2p-media-loader-core/vite.config.ts
@@ -1,6 +1,7 @@
 import { defineConfig } from "vite";
 import type { UserConfig } from "vite";
 import { nodePolyfills } from "vite-plugin-node-polyfills";
+import terser from "@rollup/plugin-terser";
 
 const getESMConfig = ({ minify }: { minify: boolean }): UserConfig => {
   return {
@@ -16,7 +17,16 @@ const getESMConfig = ({ minify }: { minify: boolean }): UserConfig => {
         entry: "src/index.ts",
       },
     },
-    plugins: [nodePolyfills()],
+    plugins: [
+      nodePolyfills(),
+      minify
+        ? terser({
+            format: {
+              comments: false,
+            },
+          })
+        : undefined,
+    ],
   };
 };
 
diff --git a/packages/p2p-media-loader-hlsjs/package.json b/packages/p2p-media-loader-hlsjs/package.json
@@ -54,6 +54,7 @@
     "p2p-media-loader-core": "workspace:*"
   },
   "devDependencies": {
+    "@rollup/plugin-terser": "^0.4.4",
     "hls.js": "^1.5.7"
   }
 }
diff --git a/packages/p2p-media-loader-hlsjs/tsconfig.node.json b/packages/p2p-media-loader-hlsjs/tsconfig.node.json
@@ -1,8 +1,8 @@
 {
   "extends": "../../tsconfig.base.json",
   "compilerOptions": {
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext"
+    "module": "ESNext",
+    "moduleResolution": "Bundler"
   },
   "include": ["vite.config.ts"]
 }
diff --git a/packages/p2p-media-loader-hlsjs/vite.config.ts b/packages/p2p-media-loader-hlsjs/vite.config.ts
@@ -1,5 +1,6 @@
 import { defineConfig } from "vite";
 import type { UserConfig } from "vite";
+import terser from "@rollup/plugin-terser";
 
 const getESMConfig = ({ minify }: { minify: boolean }): UserConfig => {
   return {
@@ -18,6 +19,15 @@ const getESMConfig = ({ minify }: { minify: boolean }): UserConfig => {
         external: ["p2p-media-loader-core"],
       },
     },
+    plugins: [
+      minify
+        ? terser({
+            format: {
+              comments: false,
+            },
+          })
+        : undefined,
+    ],
   };
 };
 
diff --git a/packages/p2p-media-loader-shaka/package.json b/packages/p2p-media-loader-shaka/package.json
@@ -55,6 +55,7 @@
     "p2p-media-loader-core": "workspace:*"
   },
   "devDependencies": {
+    "@rollup/plugin-terser": "^0.4.4",
     "shaka-player": "^4.9.9"
   }
 }
diff --git a/packages/p2p-media-loader-shaka/tsconfig.node.json b/packages/p2p-media-loader-shaka/tsconfig.node.json
@@ -1,8 +1,8 @@
 {
   "extends": "../../tsconfig.base.json",
   "compilerOptions": {
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext"
+    "module": "ESNext",
+    "moduleResolution": "Bundler"
   },
   "include": ["vite.config.ts"]
 }
diff --git a/packages/p2p-media-loader-shaka/vite.config.ts b/packages/p2p-media-loader-shaka/vite.config.ts
@@ -1,5 +1,6 @@
 import { defineConfig } from "vite";
 import type { UserConfig } from "vite";
+import terser from "@rollup/plugin-terser";
 
 const getESMConfig = ({ minify }: { minify: boolean }): UserConfig => {
   return {
@@ -18,6 +19,16 @@ const getESMConfig = ({ minify }: { minify: boolean }): UserConfig => {
         external: ["p2p-media-loader-core"],
       },
     },
+    plugins: [
+      minify
+        ? terser({
+            format: {
+              comments: false,
+            },
+          })
+        : undefined,
+      ,
+    ],
   };
 };
 
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,8 @@`
`6`	`6`	`<script type="importmap">`
`7`	`7`	`{`
`8`	`8`	`"imports": {`
`9`		`- "p2p-media-loader-core": "./core/p2p-media-loader-core.es.js",`
`10`		`- "p2p-media-loader-hlsjs": "./hlsjs/p2p-media-loader-hlsjs.es.js"`
	`9`	`+ "p2p-media-loader-core": "./core/p2p-media-loader-core.es.min.js",`
	`10`	`+ "p2p-media-loader-hlsjs": "./hlsjs/p2p-media-loader-hlsjs.es.min.js"`
`11`	`11`	`}`
`12`	`12`	`}`
`13`	`13`	`</script>`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`	`1`	`{`
`2`	`2`	`"extends": "../../tsconfig.base.json",`
`3`	`3`	`"compilerOptions": {`
`4`		`- "module": "NodeNext",`
`5`		`- "moduleResolution": "NodeNext"`
	`4`	`+ "module": "ESNext",`
	`5`	`+ "moduleResolution": "Bundler"`
`6`	`6`	`},`
`7`	`7`	`"include": ["vite.config.ts"]`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,7 @@`
`54`	`54`	`"p2p-media-loader-core": "workspace:*"`
`55`	`55`	`},`
`56`	`56`	`"devDependencies": {`
	`57`	`+ "@rollup/plugin-terser": "^0.4.4",`
`57`	`58`	`"hls.js": "^1.5.7"`
`58`	`59`	`}`
`59`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@`
`55`	`55`	`"p2p-media-loader-core": "workspace:*"`
`56`	`56`	`},`
`57`	`57`	`"devDependencies": {`
	`58`	`+ "@rollup/plugin-terser": "^0.4.4",`
`58`	`59`	`"shaka-player": "^4.9.9"`
`59`	`60`	`}`
`60`	`61`	`}`