rx-player 3.25.2 → 3.26.3-dev.2022021400

package/jest.config.js

@@ -1,7 +1,5 @@
 /* eslint-env node */
 
-const coverageIsWanted = !!process.env.RXP_COVERAGE;
-
 module.exports = {
   // to uncomment to display logs.
   // verbose: false,
@@ -9,14 +7,12 @@ module.exports = {
   preset: "ts-jest",
   testEnvironment: "jsdom",
   testMatch: ["**/?(*.)+(spec|test).[jt]s?(x)"],
-  collectCoverage: coverageIsWanted,
   collectCoverageFrom: [
     "src/**/*.ts",
     "!src/**/index.ts",
     "!**/__tests__/**",
   ],
   globals: {
-    __DEV__: true,
     "ts-jest": {
       tsconfig: {
         target: "es2017",
@@ -39,5 +35,33 @@ module.exports = {
         ],
       },
     },
+    __FEATURES__: {
+      IS_DISABLED: 0,
+      IS_ENABLED: 1,
+
+      BIF_PARSER: 1,
+      DASH: 1,
+      DIRECTFILE: 1,
+      EME: 1,
+      HTML_SAMI: 1,
+      HTML_SRT: 1,
+      HTML_TTML: 1,
+      HTML_VTT: 1,
+      LOCAL_MANIFEST: 1,
+      METAPLAYLIST: 1,
+      NATIVE_SAMI: 1,
+      NATIVE_SRT: 1,
+      NATIVE_TTML: 1,
+      NATIVE_VTT: 1,
+      SMOOTH: 1,
+    },
+    __ENVIRONMENT__: {
+      PRODUCTION: 0,
+      DEV: 1,
+      CURRENT_ENV: 1,
+    },
+    __LOGGER_LEVEL__: {
+      CURRENT_LEVEL: "\"NONE\"",
+    },
   },
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "rx-player",
   "author": "Canal+",
-  "version": "3.25.2",
+  "version": "3.26.3-dev.2022021400",
   "description": "Canal+ HTML5 Video Player",
   "main": "./dist/rx-player.js",
   "keywords": [
@@ -24,79 +24,37 @@
   "bugs": "https://github.com/canalplus/rx-player/issues",
   "license": "Apache-2.0",
   "sideEffects": false,
-  "scripts-info": {
-    "build": "Build the player in dist/rx-player.js",
-    "build:all": "Perform all possible builds of the player (regular RxPlayer builds and the WebAssembly DASH MPD parser release build).",
-    "build:min": "Build the player and minify it in dist/rx-player.min.js",
-    "build:min:report": "Build the player then minify it in dist/rx-player.min.js and display a report on its size",
-    "build:modular": "Build the modular build of the rx-player and create corresponding files and directories.",
-    "build:report": "Build the player in dist/rx-player.js and display a report on its size",
-    "build:rxp:all": "Perform all possible builds of the RxPlayer main code (that is, excluding the WebAssembly DASH MPD parser build).",
-    "build:watch": "Build the player as a minified version in dist/rx-player.min.js each times the files update",
-    "build:min:watch": "Build the player in dist/rx-player.js each times the files update",
-    "build:wasm:debug": "Build the DASH MPD parser written in rust as WebAssembly into debug mode, and output the result as dist/mpd-parser.wasm",
-    "build:wasm:release": "Build the DASH MPD parser written in rust as WebAssembly into release mode, and output the result as dist/mpd-parser.wasm",
-    "certificate": "Generate a certificate to be able to use HTTPS locally for the demo pages (`npm run start` and `npm run standalone` will then listen to HTTPS requests through a communicated port)",
-    "check": "Check the validity of the src directory by running the linter, type checker and unit tests",
-    "check:all": "Check the validity of the whole project by running linters, type checkers and every tests",
-    "check:types": "Check TypeScript typings in src",
-    "demo": "Build the demo in demo/bundle.js",
-    "demo:min": "Build the demo and minify it in demo/bundle.js",
-    "demo:watch": "Build the demo in demo/bundle.js each times the files update.",
-    "doc": "Generate the HTML documentation in doc/generated/pages",
-    "info": "Display the description of all npm scripts for this project",
-    "lint": "Lint rx-player source files",
-    "lint:demo": "Lint demo source files",
-    "lint:tests": "Lint integration tests source files",
-    "standalone": "Build and launch the \"standalone\" demo (without any UI) on a local server. Re-build on file updates.",
-    "start": "Build and launch the \"full\" demo (with a UI) with the non-minified RxPlayer on a local server. Re-build on file updates.",
-    "start:min": "Build and launch the \"full\" demo (with a UI) with the minified RxPlayer on a local server. Re-build on file updates.",
-    "test": "Launch unit and integration tests in multiple browser environments",
-    "test:integration": "Launch integration tests in multiple browser environments",
-    "test:integration:chrome": "Launch integration tests in a Chrome browser.",
-    "test:integration:chrome:watch": "Launch integration tests in Chrome each times the files update",
-    "test:integration:coverage": "Launch integration tests in multiple browser environments and produce a coverage report in tests/integration/coverage",
-    "test:integration:firefox": "Launch integration tests in a Firefox browser.",
-    "test:integration:firefox:watch": "Launch integration tests in Firefox each times the files update",
-    "test:memory": "Launch memory tests",
-    "test:memory:chrome:watch": "Launch memory tests in Chrome each times the files update",
-    "test:unit": "Launch unit tests",
-    "test:unit:coverage": "Launch unit tests and produce a coverage report",
-    "update-version": "Update the version to the string given in argument (example: `npm run update-version 3.8.0`). Will update the codebase and perform every builds."
-  },
   "scripts": {
-    "build": "webpack --progress --config webpack.config.js",
+    "build": "webpack --progress --config webpack.config.js --env production",
     "build:all": "npm run build && npm run build:min && npm run build:wasm:release && npm run build:modular",
-    "build:min": "cross-env RXP_MINIFY=true webpack --progress --config webpack.config.js",
-    "build:min:report": "cross-env RXP_SIZE_REPORT=true cross-env RXP_MINIFY=true webpack --progress --config webpack.config.js",
-    "build:modular": "./scripts/generate_builds",
-    "build:report": "cross-env RXP_SIZE_REPORT=true webpack --progress --config webpack.config.js",
+    "build:min": "webpack --progress --config webpack.config.js --env minify --env production",
+    "build:min:report": "webpack --progress --config webpack.config.js --env minify --env production --env reportSize",
+    "build:modular": "./scripts/build/generate_build.js",
+    "build:report": "webpack --progress --config webpack.config.js --env production --env reportSize",
     "build:rxp:all": "npm run build && npm run build:min && npm run build:modular",
-    "build:watch": "webpack --progress --config webpack.config.js -w",
-    "build:min:watch": "cross-env RXP_MINIFY=true webpack --progress --config webpack.config.js -w",
+    "build:watch": "webpack --progress --config webpack.config.js -w -env production",
+    "build:min:watch": "webpack --progress --config webpack.config.js -w --env production --env minify",
     "build:wasm:debug": "cd ./src/parsers/manifest/dash/wasm-parser && cargo build --target wasm32-unknown-unknown && cp target/wasm32-unknown-unknown/debug/mpd_node_parser.wasm ../../../../../dist/mpd-parser.wasm",
     "build:wasm:release": "cd ./src/parsers/manifest/dash/wasm-parser && cargo build --target wasm32-unknown-unknown --release && wasm-opt -O3 -o ../../../../../dist/mpd-parser.wasm target/wasm32-unknown-unknown/release/mpd_node_parser.wasm && cd ../../../../../ && npm run wasm-strip",
     "certificate": "./scripts/generate_certificate",
-    "check": "npm run check:types && npm run lint && npm run test:unit",
+    "check": "npm run check:types && npm run lint",
     "check:all": "npm run check:types && npm run lint && npm run lint:demo && npm run lint:tests && npm run test && npm run test:memory && node -r esm ./scripts/check_nodejs_import_compatibility.js",
     "check:appveyor": "npm run check:types && npm run lint && npm run lint:demo && npm run lint:tests && npm run test:appveyor",
-    "check:travis": "npm run check:types && npm run lint && npm run lint:demo && npm run lint:tests && npm run test:travis",
     "check:types": "tsc --noEmit --project .",
-    "demo": "cross-env RXP_METAPLAYLIST=true node ./scripts/generate_full_demo.js",
-    "demo:min": "cross-env RXP_METAPLAYLIST=true RXP_MINIFY=true node ./scripts/generate_full_demo.js",
-    "demo:watch": "cross-env RXP_METAPLAYLIST=true node ./scripts/generate_full_demo.js --watch",
-    "doc": "rm -rf doc/generated; node ./scripts/doc-generator/index.js doc/ doc/generated",
-    "info": "node scripts/list-npm-scripts-info.js",
+    "check:types:watch": "tsc --noEmit --watch --project .",
+    "demo": "node ./scripts/generate_full_demo.js --production-mode",
+    "demo:min": "node ./scripts/generate_full_demo.js --production-mode --minify",
+    "demo:watch": "node ./scripts/generate_full_demo.js --watch --production-mode",
+    "doc": "rm -rf doc/generated; node ./scripts/doc-generator/index.js doc/ doc/generated \"$(cat VERSION)\"",
     "lint": "eslint src -c .eslintrc.js",
     "lint:demo": "eslint demo/full/scripts",
     "lint:tests": "eslint tests/**/*.js",
-    "prepare:modular": "tsc -p tsconfig.modules.json",
+    "list": "node scripts/list-npm-scripts.js",
     "prepublishOnly": "npm run build:modular",
-    "standalone": "cross-env RXP_METAPLAYLIST=true RXP_ENV=development node ./scripts/run_standalone_demo.js",
-    "start": "cross-env RXP_METAPLAYLIST=true RXP_ENV=development node ./scripts/run_full_demo.js",
-    "start:min": "cross-env RXP_METAPLAYLIST=true RXP_MINIFY=true node ./scripts/run_full_demo.js",
+    "standalone": "node ./scripts/run_standalone_demo.js",
+    "start": "node ./scripts/start_demo_web_server.js",
+    "s": "node ./scripts/start_demo_web_server.js --fast",
     "wasm-strip": "node scripts/wasm-strip.js dist/mpd-parser.wasm",
-    "test": "npm run test:unit && npm run test:integration",
     "test:appveyor": "npm run test:unit && npm run test:memory",
     "test:integration": "node tests/integration/run.js --bchromehl --bfirefoxhl",
     "test:integration:appveyor": "node --max-old-space-size=2048 ./tests/integration/run.js --bchromehl",
@@ -105,12 +63,10 @@
     "test:integration:coverage": "node tests/integration/run.js --bchromehl --bfirefoxhl --coverage",
     "test:integration:firefox": "node tests/integration/run.js --bfirefox",
     "test:integration:firefox:watch": "node tests/integration/run.js --bfirefox --watch",
-    "test:integration:travis": "node tests/integration/run.js --bchromehl",
     "test:memory": "node tests/memory/run.js --bchromehl",
     "test:memory:chrome:watch": "node tests/memory/run.js --bchrome --watch",
-    "test:travis": "npm run test:unit && npm run test:integration:travis",
     "test:unit": "jest",
-    "test:unit:coverage": "cross-env RXP_COVERAGE=true jest",
+    "test:unit:coverage": "jest --coverage",
     "update-version": "npm run version --git-tag-version=false",
     "version": "./scripts/update-version"
   },
@@ -121,65 +77,125 @@
   "dependencies": {
     "next-tick": "1.1.0",
     "pinkie": "2.0.4",
-    "rxjs": "7.1.0"
+    "rxjs": "7.4.0"
   },
   "devDependencies": {
-    "@babel/core": "7.14.3",
-    "@babel/plugin-transform-runtime": "7.14.3",
-    "@babel/preset-env": "7.14.4",
-    "@babel/preset-react": "7.13.13",
-    "@types/chai": "4.2.18",
-    "@types/jest": "26.0.23",
-    "@types/mocha": "8.2.2",
-    "@types/node": "15.12.2",
-    "@types/sinon": "10.0.2",
-    "@typescript-eslint/eslint-plugin": "4.26.1",
-    "@typescript-eslint/eslint-plugin-tslint": "4.26.1",
-    "@typescript-eslint/parser": "4.26.1",
+    "@babel/core": "7.16.7",
+    "@babel/plugin-transform-runtime": "7.16.7",
+    "@babel/preset-env": "7.16.7",
+    "@babel/preset-react": "7.16.7",
+    "@types/chai": "4.3.0",
+    "@types/jest": "27.4.0",
+    "@types/mocha": "9.0.0",
+    "@types/node": "17.0.7",
+    "@types/sinon": "10.0.6",
+    "@typescript-eslint/eslint-plugin": "5.8.1",
+    "@typescript-eslint/eslint-plugin-tslint": "5.8.1",
+    "@typescript-eslint/parser": "5.8.1",
     "arraybuffer-loader": "1.0.8",
-    "babel-loader": "8.2.2",
+    "babel-loader": "8.2.3",
     "chai": "4.3.4",
     "cheerio": "1.0.0-rc.10",
-    "core-js": "3.14.0",
-    "cross-env": "7.0.3",
-    "css-loader": "5.2.6",
-    "eslint": "7.28.0",
-    "eslint-plugin-import": "2.23.4",
-    "eslint-plugin-jsdoc": "35.1.3",
-    "eslint-plugin-react": "7.24.0",
+    "core-js": "3.20.2",
+    "esbuild": "0.14.10",
+    "eslint": "8.6.0",
+    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-jsdoc": "37.5.0",
+    "eslint-plugin-react": "7.28.0",
     "esm": "3.2.25",
-    "express": "4.17.1",
-    "file-loader": "6.2.0",
-    "highlight.js": "11.0.1",
+    "express": "4.17.2",
+    "highlight.js": "11.3.1",
+    "html-entities": "2.3.2",
     "istanbul-instrumenter-loader": "3.0.1",
-    "jest": "27.0.4",
-    "karma": "6.3.3",
+    "jest": "27.4.5",
+    "karma": "6.3.14",
     "karma-chrome-launcher": "3.1.0",
     "karma-coverage-istanbul-reporter": "3.0.3",
-    "karma-firefox-launcher": "2.1.1",
+    "karma-firefox-launcher": "2.1.2",
     "karma-mocha": "2.0.1",
-    "karma-mocha-reporter": "2.2.5",
     "karma-webpack": "5.0.0",
-    "markdown-it": "12.0.6",
-    "markdown-it-emoji": "2.0.0",
-    "mocha": "9.0.0",
+    "markdown-it": "12.3.0",
+    "mocha": "9.1.3",
     "mocha-loader": "5.1.5",
     "raw-loader": "4.0.2",
     "react": "17.0.2",
     "react-dom": "17.0.2",
-    "regenerator-runtime": "0.13.7",
-    "sanitize-html": "2.4.0",
+    "regenerator-runtime": "0.13.9",
+    "rimraf": "3.0.2",
     "semver": "7.3.5",
-    "sinon": "11.1.1",
-    "style-loader": "2.0.0",
-    "terser-webpack-plugin": "5.1.3",
-    "ts-jest": "27.0.3",
-    "ts-loader": "9.2.3",
+    "sinon": "12.0.1",
+    "terser-webpack-plugin": "5.3.0",
+    "ts-jest": "27.1.2",
+    "ts-loader": "9.2.6",
     "tslint": "6.1.3",
-    "typescript": "4.3.2",
-    "url-loader": "4.1.1",
-    "webpack": "5.38.1",
-    "webpack-bundle-analyzer": "4.4.2",
-    "webpack-cli": "4.7.2"
+    "typescript": "4.5.4",
+    "webpack": "5.65.0",
+    "webpack-bundle-analyzer": "4.5.0",
+    "webpack-cli": "4.9.1"
+  },
+  "scripts-list": {
+    "Build a demo page (e.g. to test a code change)": {
+      "start": "Build the \"full\" demo (with a UI) with the non-minified RxPlayer and serve it on a local server. Re-build on file updates.",
+      "s": "Very fast version of `start` which does not perform type-checking. This script can be useful for quick testing",
+      "demo": "Build the demo in demo/bundle.js",
+      "demo:min": "Build the demo and minify it in demo/bundle.js",
+      "demo:watch": "Build the demo in demo/bundle.js each times the files update.",
+      "standalone": "Build and launch the \"standalone\" demo (without any UI) on a local server. Re-build on file updates.",
+      "certificate": "Generate a certificate to be able to use HTTPS locally for the demo pages (`npm run start` and `npm run standalone` will then listen to HTTPS requests through a communicated port)"
+    },
+    "Type-check or lint the current code": {
+      "check": "Check the validity of the src directory by running the type checker and linter on it",
+      "check:all": "Check the validity of the whole project by running linters, type checkers and every tests",
+      "check:types": "Check TypeScript typings in src",
+      "check:types:watch": "Check TypeScript typings in src each time files change",
+      "lint": "Lint rx-player source files",
+      "lint:demo": "Lint demo source files",
+      "lint:tests": "Lint integration tests source files"
+    },
+    "Run tests": {
+      "Integration tests (test the whole API)": {
+        "test:integration": "Launch integration tests in multiple browser environments",
+        "test:integration:chrome": "Launch integration tests in a Chrome browser.",
+        "test:integration:chrome:watch": "Launch integration tests in Chrome each times the files update",
+        "test:integration:coverage": "Launch integration tests in multiple browser environments and produce a coverage report in tests/integration/coverage",
+        "test:integration:firefox": "Launch integration tests in a Firefox browser.",
+        "test:integration:firefox:watch": "Launch integration tests in Firefox each times the files update"
+      },
+      "Unit tests (test particular functions)": {
+        "test:unit": "Launch unit tests",
+        "test:unit:coverage": "Launch unit tests and produce a coverage report"
+      },
+      "Memory tests (test memory usage to avoid memory leaks)": {
+        "test:memory": "Launch memory tests",
+        "test:memory:chrome:watch": "Launch memory tests in Chrome each times the files update"
+      }
+    },
+    "Build the player or one of its sub-parts": {
+      "Modular builds (then imported through the rx-player/minimal path)": {
+        "build:modular": "Build the modular build of the rx-player and create corresponding files and directories."
+      },
+      "Legacy builds (bundles)": {
+        "build": "Build the player in dist/rx-player.js",
+        "build:min": "Build the player and minify it in dist/rx-player.min.js",
+        "build:min:report": "Build the player then minify it in dist/rx-player.min.js and display a report on its size",
+        "build:min:watch": "Build the player in dist/rx-player.js each times the files update",
+        "build:report": "Build the player in dist/rx-player.js and display a report on its size",
+        "build:watch": "Build the player as a minified version in dist/rx-player.min.js each times the files update"
+      },
+      "WebAssembly MPD parser builds (needs Rust, Cargo and binaryen)": {
+        "build:wasm:debug": "Build the DASH MPD parser written in rust as WebAssembly into debug mode, and output the result as dist/mpd-parser.wasm",
+        "build:wasm:release": "Build the DASH MPD parser written in rust as WebAssembly into release mode, and output the result as dist/mpd-parser.wasm"
+      },
+      "Combinations of multiple builds": {
+        "build:all": "Perform all possible builds of the player (regular RxPlayer builds and the WebAssembly DASH MPD parser release build).",
+        "build:rxp:all": "Perform all possible builds of the RxPlayer main code (that is, excluding the WebAssembly DASH MPD parser build)."
+      }
+    },
+    "Build the documentation pages": {
+      "doc": "Generate the HTML documentation in doc/generated/pages"
+    },
+    "Update the RxPlayer's version": {
+      "update-version": "Update the version to the string given in argument (example: `npm run update-version 3.8.0`). Will update the codebase and perform every builds."
+    }
   }
 }

package/scripts/README.md

@@ -0,0 +1,11 @@
+# RxPlayer scripts #############################################################
+
+This directory contains various scripts allowing to perform various actions on
+the RxPlayer:
+  - Serving/deploying the demo pages
+  - Generating complex builds
+  - Performing repetitive action performed before each release
+  - and many other things
+
+Each script here should begin with a comment explaining what it does and - if
+it's not obvious - why this is needed.

package/scripts/build/constants.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Copyright 2015 CANAL+ Group
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* eslint-disable @typescript-eslint/naming-convention */
+
+// Define build-time constants corresponding to the modular build.
+
+declare const enum __LOGGER_LEVEL__ {
+  CURRENT_LEVEL = "NONE",
+}
+
+declare const enum __ENVIRONMENT__ {
+  PRODUCTION = 0,
+  DEV = 1,
+  CURRENT_ENV = PRODUCTION,
+}
+
+declare const enum __FEATURES__ {
+  IS_DISABLED = 0,
+  IS_ENABLED = 1,
+
+  BIF_PARSER = IS_DISABLED,
+  DASH = IS_DISABLED,
+  DIRECTFILE = IS_DISABLED,
+  EME = IS_DISABLED,
+  HTML_SAMI = IS_DISABLED,
+  HTML_SRT = IS_DISABLED,
+  HTML_TTML = IS_DISABLED,
+  HTML_VTT = IS_DISABLED,
+  LOCAL_MANIFEST = IS_DISABLED,
+  METAPLAYLIST = IS_DISABLED,
+  NATIVE_SAMI = IS_DISABLED,
+  NATIVE_SRT = IS_DISABLED,
+  NATIVE_TTML = IS_DISABLED,
+  NATIVE_VTT = IS_DISABLED,
+  SMOOTH = IS_DISABLED,
+}

package/scripts/build/generate_build.js

@@ -0,0 +1,197 @@
+#!/usr/bin/env node
+/* eslint-env node */
+
+/**
+ * =================
+ * generate_build.js
+ * =================
+ *
+ * This file allows to produce the main RxPlayer's [modular] build.
+ *
+ * To run it, just call this file through your node.js binary:
+ * ```sh
+ * node generate_build.js
+ * ```
+ *
+ * For now it heavily relies on unix-like utilities such as `find` and `sed` and
+ * spawns new process to run them inside that script.
+ * More cross-platform and safer solutions should be found in the future.
+ */
+
+const { spawn } = require("child_process");
+const fs = require("fs/promises");
+const os = require("os");
+const path = require("path");
+const rimraf = require("rimraf");
+
+const BUILD_DIR_FROM_ROOT = "dist/_esm5.processed";
+
+const ROOT_DIR = path.join(__dirname, "../../");
+const TEMPLATE_DIR = path.join(__dirname, "../../scripts/build/templates");
+const TMP_BUILD_DIR = path.join(ROOT_DIR, "dist/_esm5.raw");
+const BUILD_DIR = path.join(ROOT_DIR, BUILD_DIR_FROM_ROOT);
+const BUILD_ARTEFACTS_TO_REMOVE = [
+  "dist/_esm5.processed",
+  "dist/_esm5.raw",
+  "features",
+  "minimal",
+  "experimental",
+  "tools",
+  "types",
+  "logger"
+];
+
+generateBuild();
+
+/**
+ * @returns {Promise}
+ */
+async function generateBuild() {
+  try {
+    console.log(" 🧹 Removing previous build artefacts...");
+    await removePreviousBuildArtefacts();
+
+    console.log(" ⚙️  Compiling project with TypeScript...");
+    await compile();
+
+    console.log(" 🚚 Moving built code to its final directory...");
+    await fs.rename(TMP_BUILD_DIR, BUILD_DIR);
+
+    console.log(" 📦 Generating imported files from templates...");
+    await generateImportFilesFromTemplates();
+  } catch (err) {
+    console.error(
+      "Fatal error:",
+      err instanceof Error ? err.message : err
+    );
+    process.exit(1);
+  }
+
+  console.log(" 🙌 SUCCESS!");
+}
+
+/**
+ * Remove directories and files from a previously built RxPlayer.
+ * @returns {Promise}
+ */
+async function removePreviousBuildArtefacts() {
+  await Promise.all(BUILD_ARTEFACTS_TO_REMOVE.map((name) => {
+    const relativePath = path.join(ROOT_DIR, name);
+    return removeFile(relativePath);
+  }));
+}
+
+/**
+ * Compile the project by spawning a separate procress running TypeScript.
+ * @returns {Promise}
+ */
+async function compile() {
+    // Sadly TypeScript compiler API seems to be sub-par.
+    // I did not find for example how to exclude some files (our unit tests)
+    // easily by running typescript directly from NodeJS.
+    // So we just spawn a separate process running tsc:
+    await spawnProm(
+      "npx tsc -p",
+      [path.join(ROOT_DIR, "tsconfig.modules.json")],
+      (code) => new Error(`Compilation process exited with code ${code}`),
+    );
+}
+
+/**
+ * @returns {Promise}
+ */
+async function generateImportFilesFromTemplates() {
+  const dir = await fs.readdir(TEMPLATE_DIR);
+  const proms = [];
+  for (let f of dir) {
+    proms.push(processTemplateFileOrDir(f));
+  }
+  await Promise.all(proms);
+
+  /**
+   * @returns {Promise}
+   */
+  async function processTemplateFileOrDir(fileName) {
+    const filePath = path.join(TEMPLATE_DIR, fileName);
+    const fileDest = path.join(ROOT_DIR, fileName);
+    await copyDir(filePath, fileDest);
+    await replaceTokensInTemplates(fileDest);
+  }
+}
+
+/**
+ * @param {string} fileName
+ * @returns {Promise}
+ */
+function removeFile(fileName) {
+  return new Promise((res, rej) => {
+    rimraf(fileName, (err) => {
+      if (err !== null && err !== undefined) {
+        rej(err);
+      }
+      res();
+    });
+  });
+}
+
+/**
+ * @param {string} command
+ * @param {Array.<string>} args
+ * @param {Function} errorOnCode
+ */
+function spawnProm(command, args, errorOnCode) {
+  return new Promise((res, rej) => {
+    spawn(command, args, { shell: true, stdio: "inherit" })
+      .on("close", (code) => {
+        if (code !== 0) {
+          rej(errorOnCode(code));
+        }
+        res();
+      });
+  });
+}
+
+/**
+ * @returns {Promise}
+ */
+async function copyDir(src, dest) {
+  await fs.mkdir(dest, { recursive: true });
+  let entries = await fs.readdir(src, { withFileTypes: true });
+
+  for (let entry of entries) {
+    let srcPath = path.join(src, entry.name);
+    let destPath = path.join(dest, entry.name);
+
+    entry.isDirectory() ?
+      await copyDir(srcPath, destPath) :
+      await fs.copyFile(srcPath, destPath);
+  }
+}
+
+/**
+ * @returns {Promise}
+ */
+async function replaceTokensInTemplates(fileDest) {
+  const sedDir = BUILD_DIR_FROM_ROOT.replace(/\//g, "\\/");
+  switch (os.type()) {
+    case "Darwin":
+      await spawnProm(
+        `find "${fileDest}" -type f -iname '*.js' ` +
+          `-exec sed -i.DELETE -E "s/__BUILD_DIR__/${sedDir}/g" {} \\;`,
+        [],
+        (code) => new Error(`Template process exited with code ${code}`),
+      );
+      await spawnProm(
+        `find  "${fileDest}" -type f -name "*.DELETE" -delete`,
+        [],
+        (code) => new Error(`Template cleaning process exited with code ${code}`),
+      );
+
+    case "Linux":
+      await spawnProm(
+        `find "${fileDest}" -type f -exec sed -i -E "s/__BUILD_DIR__/${sedDir}/g" '{}' \\;`,
+        [],
+        (code) => new Error(`Template process exited with code ${code}`),
+      );
+  }
+}

package/scripts/build/templates/experimental/features/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2015 CANAL+ Group
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from "../../__BUILD_DIR__/experimental/features/index";

package/scripts/build/templates/experimental/features/index.js

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2015 CANAL+ Group
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from "../../__BUILD_DIR__/experimental/features/index.js";