rx-player 3.25.2 → 3.26.3-dev.2022021400

package/scripts/list-npm-scripts.js

@@ -0,0 +1,99 @@
+/**
+ * # list-npm-scripts
+ *
+ * Script displaying a readable preview of all nom scripts by relying on the
+ * `scripts-list` key in a package.json.
+ *
+ * The basic idea what to start from/take inspiration from what the
+ * `npm-scripts-info` npm package does and adapt it to a case where a lot of
+ * scripts for very different matters are present.
+ */
+
+const fs = require("fs");
+const readline = require("readline");
+const path = require("path");
+
+run();
+
+async function run() {
+  const pkg = getPackageJSONContent();
+  if (!("scripts-list" in pkg)) {
+    console.log("No \"scripts-list\" key in the `package.json` file.");
+    process.exit(0);
+  }
+
+  const scriptsList = pkg["scripts-list"];
+  const groupNames = Object.keys(scriptsList);
+  if (groupNames.length === 0) {
+    console.log("Nothing found in \"scripts-list\" in the `package.json` file.");
+    process.exit(0);
+  }
+  console.log("\x1b[33m~~~~~~~~~~~~~~~~ RxPlayer scripts ~~~~~~~~~~~~~~~~\n");
+  console.log("\x1b[34m============ What do you want to do? =============\n");
+  groupNames.forEach((key, groupIdx) => {
+    console.log(`\x1b[32m${groupIdx + 1}.\x1b[37m ${key}`);
+  });
+  console.log("");
+  const answer = await readInput("Your choice (leave empty to exit): ");
+  if (answer == null || answer === "") {
+    process.exit(0);
+  }
+  const groupNum = Number(answer);
+  if (isNaN(groupNum) || groupNum <= 0 || groupNum > groupNames.length) {
+    console.error("Invalid number given");
+    process.exit(1);
+  }
+
+  console.log("");
+  const wantedGroupName = groupNames[groupNum - 1];
+  console.log(`\x1b[34m>>>> ${wantedGroupName}\x1b[37m`);
+  console.log("");
+  const subGroup = scriptsList[wantedGroupName];
+  const subGroupEntries = Object.entries(subGroup);
+  if (subGroupEntries.length === 0) {
+    console.log("Nothing found in in the chosen category.");
+    process.exit(0);
+  }
+
+  displayGroupCommands(subGroupEntries);
+
+  process.exit(0);
+}
+
+function displayGroupCommands(
+  groupEntries,
+  indentation = ""
+) {
+  groupEntries.forEach(([name, val]) => {
+    if (typeof val === "string") {
+      console.log(`${indentation}[\x1b[32mnpm run ${name}\x1b[37m]:`);
+      console.log(`${indentation}  ${val}\n`);
+    } else if (typeof val === "object") {
+      console.log(`${indentation}\x1b[33m${name}\x1b[37m\n`);
+      const deeper = Object.entries(val);
+      displayGroupCommands(deeper, indentation + "  ");
+      console.log("");
+    }
+  });
+}
+
+function readInput(query) {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+
+  return new Promise(resolve => rl.question(query, ans => {
+    rl.close();
+    resolve(ans);
+  }));
+}
+
+function getPackageJSONContent() {
+  const filename = path.join(process.cwd(), 'package.json');
+  if (!fs.existsSync(filename)) {
+    throw new Error('`package.json` was not found in the current working directory.');
+  }
+  return JSON.parse(fs.readFileSync(filename, 'utf8'));
+}
+

package/scripts/run_standalone_demo.js

@@ -22,5 +22,6 @@ require("./generate_standalone_demo");
 launchStaticServer(path.join(__dirname, "../demo/standalone/"),
                    { certificatePath: path.join(__dirname, "../localhost.crt"),
                      keyPath: path.join(__dirname, "../localhost.key"),
+                     verbose: true,
                      httpPort: 8001,
                      httpsPort: 8444 });

package/scripts/{run_full_demo.js → start_demo_web_server.js}

@@ -9,19 +9,32 @@
  * an HTTPS (only if a certificate and key have been generated) server to serve
  * it, on the port 8000 and 8443 respectively.
  *
- * You can run it as a script through `node run_full_demo.js`.
+ * You can run it as a script through `node start_demo_web_server.js`.
  * Be aware that this demo will be built again every time either one of the
  * full demo file or one of the library file is updated.
  */
 
 const path = require("path");
-const generateFullDemo = require("./generate_full_demo");
+const fastBuild = require("./fast_demo_build");
+const slowBuild = require("./generate_full_demo");
 const launchStaticServer = require("./launch_static_server");
 
-generateFullDemo({ watch: true });
+const shouldRunFastVersion = process.argv.includes("--fast") ||
+                             process.argv.includes("-f");
+
+if (shouldRunFastVersion) {
+  fastBuild({ watch: true,
+              minify: false,
+              production: false });
+} else {
+  slowBuild({ watch: true,
+              minify: false,
+              production: false });
+}
 
 launchStaticServer(path.join(__dirname, "../demo/full/"),
                    { certificatePath: path.join(__dirname, "../localhost.crt"),
                      keyPath: path.join(__dirname, "../localhost.key"),
+                     verbose: true,
                      httpPort: 8000,
                      httpsPort: 8443 });

package/scripts/update-version

@@ -31,4 +31,11 @@ echo $version > VERSION
 npm install
 npm run build
 npm run build:min
-./scripts/generate_builds
+npm run build:wasm:release
+npm run build:modular
+
+echo "creating types for legacy code bases..."
+rm -f dist/rx-player.d.ts rx-player.min.d.ts
+echo "${copyright_text}
+import RxPlayer from \"./_esm5.processed/index\";
+export default RxPlayer;" | tee dist/rx-player.d.ts dist/rx-player.min.d.ts > /dev/null

package/scripts/{display_webpack_errors.js → utils/display_webpack_errors.js}

@@ -1,9 +1,5 @@
 /* eslint-env node */
 
-/**
- * This file is a node module. It should not be run directly.
- */
-
 /**
  * Format errors returned by webpack and display it through a `console.log`
  * call.

package/scripts/{get_human_readable_hours.js → utils/get_human_readable_hours.js}

@@ -1,9 +1,5 @@
 /* eslint-env node */
 
-/**
- * This file is a node module. It should not be run directly.
- */
-
 /**
  * Return the current date into a more readable `HH:mm:ss.fff`
  * (hours:minutes:seconds.milliseconds) format.

package/sonar-project.properties

@@ -1,6 +1,7 @@
 sonar.projectKey=rx-player
+sonar.organization=rx-player
 sonar.projectName=rx-player
-sonar.projectVersion=3.25.2
+sonar.projectVersion=3.26.3-dev.2022021400
 sonar.sources=./src,./demo,./tests
 sonar.exclusions=demo/full/bundle.js,demo/standalone/lib.js,demo/bundle.js
 sonar.host.url=https://sonarcloud.io

package/src/compat/__tests__/add_text_track.test.ts

@@ -14,12 +14,13 @@
  * limitations under the License.
  */
 
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+// Needed for calling require (which itself is needed to mock properly) because
+// it is not type-checked:
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 /* eslint-disable @typescript-eslint/no-var-requires */
 /* eslint-disable @typescript-eslint/no-unsafe-call */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable @typescript-eslint/no-unsafe-return */
+/* eslint-disable @typescript-eslint/no-unsafe-argument */
 
 describe("compat - addTextTrack", () => {
   beforeEach(() => {
@@ -31,7 +32,7 @@ describe("compat - addTextTrack", () => {
       id: "textTrack1",
       HIDDEN: "hidden",
       SHOWING: "showing",
-    };
+    } as unknown as TextTrack;
     const mockAddTextTrack = jest.fn(() => null);
     const fakeMediaElement = {
       textTracks: [ fakeTextTrack ],
@@ -56,8 +57,8 @@ describe("compat - addTextTrack", () => {
       id: "textTrack1",
       HIDDEN: "hidden",
       SHOWING: "showing",
-    };
-    const fakeTextTracks: any[] = [];
+    } as unknown as TextTrack;
+    const fakeTextTracks: TextTrack[] = [];
     const mockAddTextTrack = jest.fn(() => {
       fakeTextTracks.push(fakeTextTrack);
       return fakeTextTrack;
@@ -99,8 +100,8 @@ describe("compat - addTextTrack", () => {
       kind: undefined,
     };
 
-    const fakeTextTracks: any[] = [];
-    const fakeChildNodes: any[] = [];
+    const fakeTextTracks: TextTrack[] = [];
+    const fakeChildNodes: ChildNode[] = [];
 
     const mockAppendChild = jest.fn((_trackElement) => {
       fakeChildNodes.push(_trackElement);
@@ -138,14 +139,14 @@ describe("compat - addTextTrack", () => {
       id: "textTrack1",
       HIDDEN: "hidden",
       SHOWING: "showing",
-    };
+    } as unknown as TextTrack;
     const fakeTextTrackElement = {
       track: fakeTextTrack,
       kind: undefined,
-    };
+    } as unknown as HTMLTrackElement;
 
-    const fakeTextTracks: any[] = [];
-    const fakeChildNodes: any[] = [];
+    const fakeTextTracks: TextTrack[] = [];
+    const fakeChildNodes: HTMLTrackElement[] = [];
 
     const mockAppendChild = jest.fn((_trackElement) => {
       fakeChildNodes.push(_trackElement);

package/src/compat/__tests__/browser_compatibility_types.test.ts

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+// Needed for calling require (which itself is needed to mock properly) because
+// it is not type-checked:
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 /* eslint-disable @typescript-eslint/no-var-requires */
@@ -22,6 +24,13 @@
 /* eslint-disable @typescript-eslint/no-unsafe-return */
 
 describe("compat - browser compatibility types", () => {
+  interface IFakeWindow {
+    MediaSource? : unknown;
+    MozMediaSource? : unknown;
+    WebKitMediaSource? : unknown;
+    MSMediaSource? : unknown;
+  }
+  const win = window as IFakeWindow;
   beforeEach(() => {
     jest.resetModules();
   });
@@ -30,114 +39,114 @@ describe("compat - browser compatibility types", () => {
     jest.mock("../is_node", () => ({ __esModule: true as const,
                                      default: true }));
 
-    const origMediaSource = (window as any).MediaSource;
-    const origMozMediaSource = (window as any).MozMediaSource;
-    const origWebKitMediaSource = (window as any).WebKitMediaSource;
-    const origMSMediaSource = (window as any).MSMediaSource;
+    const origMediaSource = win.MediaSource;
+    const origMozMediaSource = win.MozMediaSource;
+    const origWebKitMediaSource = win.WebKitMediaSource;
+    const origMSMediaSource = win.MSMediaSource;
 
-    (window as any).MediaSource = { a: 1 };
-    (window as any).MozMediaSource = { a: 2 };
-    (window as any).WebKitMediaSource = { a: 3 };
-    (window as any).MSMediaSource = { a: 4 };
+    win.MediaSource = { a: 1 };
+    win.MozMediaSource = { a: 2 };
+    win.WebKitMediaSource = { a: 3 };
+    win.MSMediaSource = { a: 4 };
 
     const { MediaSource_ } = require("../browser_compatibility_types");
     expect(MediaSource_).toEqual(undefined);
 
-    (window as any).MediaSource = origMediaSource;
-    (window as any).MozMediaSource = origMozMediaSource;
-    (window as any).WebKitMediaSource = origWebKitMediaSource;
-    (window as any).MSMediaSource = origMSMediaSource;
+    win.MediaSource = origMediaSource;
+    win.MozMediaSource = origMozMediaSource;
+    win.WebKitMediaSource = origWebKitMediaSource;
+    win.MSMediaSource = origMSMediaSource;
   });
 
   it("should use the native MediaSource if defined", () => {
     jest.mock("../is_node", () => ({ __esModule: true as const,
                                      default: false }));
 
-    const origMediaSource = (window as any).MediaSource;
-    const origMozMediaSource = (window as any).MozMediaSource;
-    const origWebKitMediaSource = (window as any).WebKitMediaSource;
-    const origMSMediaSource = (window as any).MSMediaSource;
+    const origMediaSource = win.MediaSource;
+    const origMozMediaSource = win.MozMediaSource;
+    const origWebKitMediaSource = win.WebKitMediaSource;
+    const origMSMediaSource = win.MSMediaSource;
 
-    (window as any).MediaSource = { a: 1 };
-    (window as any).MozMediaSource = { a: 2 };
-    (window as any).WebKitMediaSource = { a: 3 };
-    (window as any).MSMediaSource = { a: 4 };
+    win.MediaSource = { a: 1 };
+    win.MozMediaSource = { a: 2 };
+    win.WebKitMediaSource = { a: 3 };
+    win.MSMediaSource = { a: 4 };
 
     const { MediaSource_ } = require("../browser_compatibility_types");
     expect(MediaSource_).toEqual({ a: 1 });
 
-    (window as any).MediaSource = origMediaSource;
-    (window as any).MozMediaSource = origMozMediaSource;
-    (window as any).WebKitMediaSource = origWebKitMediaSource;
-    (window as any).MSMediaSource = origMSMediaSource;
+    win.MediaSource = origMediaSource;
+    win.MozMediaSource = origMozMediaSource;
+    win.WebKitMediaSource = origWebKitMediaSource;
+    win.MSMediaSource = origMSMediaSource;
   });
 
   it("should use MozMediaSource if defined and MediaSource is not", () => {
     jest.mock("../is_node", () => ({ __esModule: true as const,
                                      default: false }));
 
-    const origMediaSource = (window as any).MediaSource;
-    const origMozMediaSource = (window as any).MozMediaSource;
-    const origWebKitMediaSource = (window as any).WebKitMediaSource;
-    const origMSMediaSource = (window as any).MSMediaSource;
+    const origMediaSource = win.MediaSource;
+    const origMozMediaSource = win.MozMediaSource;
+    const origWebKitMediaSource = win.WebKitMediaSource;
+    const origMSMediaSource = win.MSMediaSource;
 
-    (window as any).MediaSource = undefined;
-    (window as any).MozMediaSource = { a: 2 };
-    (window as any).WebKitMediaSource = undefined;
-    (window as any).MSMediaSource = undefined;
+    win.MediaSource = undefined;
+    win.MozMediaSource = { a: 2 };
+    win.WebKitMediaSource = undefined;
+    win.MSMediaSource = undefined;
 
     const { MediaSource_ } = require("../browser_compatibility_types");
     expect(MediaSource_).toEqual({ a: 2 });
 
-    (window as any).MediaSource = origMediaSource;
-    (window as any).MozMediaSource = origMozMediaSource;
-    (window as any).WebKitMediaSource = origWebKitMediaSource;
-    (window as any).MSMediaSource = origMSMediaSource;
+    win.MediaSource = origMediaSource;
+    win.MozMediaSource = origMozMediaSource;
+    win.WebKitMediaSource = origWebKitMediaSource;
+    win.MSMediaSource = origMSMediaSource;
   });
 
   it("should use WebKitMediaSource if defined and MediaSource is not", () => {
     jest.mock("../is_node", () => ({ __esModule: true as const,
                                      default: false }));
 
-    const origMediaSource = (window as any).MediaSource;
-    const origMozMediaSource = (window as any).MozMediaSource;
-    const origWebKitMediaSource = (window as any).WebKitMediaSource;
-    const origMSMediaSource = (window as any).MSMediaSource;
+    const origMediaSource = win.MediaSource;
+    const origMozMediaSource = win.MozMediaSource;
+    const origWebKitMediaSource = win.WebKitMediaSource;
+    const origMSMediaSource = win.MSMediaSource;
 
-    (window as any).MediaSource = undefined;
-    (window as any).MozMediaSource = undefined;
-    (window as any).WebKitMediaSource = { a: 3 };
-    (window as any).MSMediaSource = undefined;
+    win.MediaSource = undefined;
+    win.MozMediaSource = undefined;
+    win.WebKitMediaSource = { a: 3 };
+    win.MSMediaSource = undefined;
 
     const { MediaSource_ } = require("../browser_compatibility_types");
     expect(MediaSource_).toEqual({ a: 3 });
 
-    (window as any).MediaSource = origMediaSource;
-    (window as any).MozMediaSource = origMozMediaSource;
-    (window as any).WebKitMediaSource = origWebKitMediaSource;
-    (window as any).MSMediaSource = origMSMediaSource;
+    win.MediaSource = origMediaSource;
+    win.MozMediaSource = origMozMediaSource;
+    win.WebKitMediaSource = origWebKitMediaSource;
+    win.MSMediaSource = origMSMediaSource;
   });
 
   it("should use MSMediaSource if defined and MediaSource is not", () => {
     jest.mock("../is_node", () => ({ __esModule: true as const,
                                      default: false }));
 
-    const origMediaSource = (window as any).MediaSource;
-    const origMozMediaSource = (window as any).MozMediaSource;
-    const origWebKitMediaSource = (window as any).WebKitMediaSource;
-    const origMSMediaSource = (window as any).MSMediaSource;
+    const origMediaSource = win.MediaSource;
+    const origMozMediaSource = win.MozMediaSource;
+    const origWebKitMediaSource = win.WebKitMediaSource;
+    const origMSMediaSource = win.MSMediaSource;
 
-    (window as any).MediaSource = undefined;
-    (window as any).MozMediaSource = undefined;
-    (window as any).WebKitMediaSource = undefined;
-    (window as any).MSMediaSource = { a: 4 };
+    win.MediaSource = undefined;
+    win.MozMediaSource = undefined;
+    win.WebKitMediaSource = undefined;
+    win.MSMediaSource = { a: 4 };
 
     const { MediaSource_ } = require("../browser_compatibility_types");
     expect(MediaSource_).toEqual({ a: 4 });
 
-    (window as any).MediaSource = origMediaSource;
-    (window as any).MozMediaSource = origMozMediaSource;
-    (window as any).WebKitMediaSource = origWebKitMediaSource;
-    (window as any).MSMediaSource = origMSMediaSource;
+    win.MediaSource = origMediaSource;
+    win.MozMediaSource = origMozMediaSource;
+    win.WebKitMediaSource = origWebKitMediaSource;
+    win.MSMediaSource = origMSMediaSource;
   });
 });

package/src/compat/__tests__/browser_version.test.ts

@@ -30,7 +30,9 @@ describe("Compat - Browser version", () => {
                           /* eslint-enable no-param-reassign */
                         }))(navigator.userAgent));
 
-  const nav: any = navigator;
+  const nav = navigator as {
+    userAgent: string;
+  };
 
   afterEach(() => {
     nav.userAgent = origUserAgent;

package/src/compat/__tests__/change_source_buffer_type.test.ts

@@ -23,7 +23,7 @@ describe("Compat - tryToChangeSourceBufferType", () => {
   /* eslint-enable max-len */
 
     const spy = jest.spyOn(log, "warn");
-    const fakeSourceBuffer : any = {};
+    const fakeSourceBuffer : SourceBuffer = {} as unknown as SourceBuffer;
     expect(tryToChangeSourceBufferType(fakeSourceBuffer, "toto"))
       .toBe(false);
     expect(spy).not.toHaveBeenCalled();
@@ -35,7 +35,7 @@ describe("Compat - tryToChangeSourceBufferType", () => {
 
     const spy = jest.spyOn(log, "warn");
     const changeTypeFn = jest.fn();
-    const fakeSourceBuffer : any = { changeType: changeTypeFn };
+    const fakeSourceBuffer = { changeType: changeTypeFn } as unknown as SourceBuffer;
     expect(tryToChangeSourceBufferType(fakeSourceBuffer, "toto"))
       .toBe(true);
     expect(spy).not.toHaveBeenCalled();
@@ -48,7 +48,7 @@ describe("Compat - tryToChangeSourceBufferType", () => {
     const spy = jest.spyOn(log, "warn");
     const err = new Error("bar");
     const changeTypeFn = jest.fn(() => { throw err; });
-    const fakeSourceBuffer : any = { changeType: changeTypeFn };
+    const fakeSourceBuffer = { changeType: changeTypeFn } as unknown as SourceBuffer;
     expect(tryToChangeSourceBufferType(fakeSourceBuffer, "toto"))
       .toBe(false);
     expect(spy).toHaveBeenCalledTimes(1);