rx-player 3.33.0 → 3.33.1

package/scripts/fast_demo_build.js

@@ -1,129 +0,0 @@
-/**
- * # fast_demo_build.js
- *
- * This file allows to perform a "fast" build of the RxPlayer's demo, by using
- * esbuild.
- *
- * You can either run it directly as a script (run `node fast_demo_build.js -h`
- * to see the different options) or by requiring it as a node module.
- * If doing the latter you will obtain a function you will have to run with the
- * right options.
- */
-
-const path = require("path");
-const esbuild = require("esbuild");
-const getHumanReadableHours = require("./utils/get_human_readable_hours");
-
-// If true, this script is called directly
-if (require.main === module) {
-  const { argv } = process;
-  if (argv.includes("-h") || argv.includes("--help")) {
-    displayHelp();
-    process.exit(0);
-  }
-  const shouldWatch = argv.includes("-w") || argv.includes("--watch");
-  const shouldMinify = argv.includes("-m") || argv.includes("--minify");
-  const production = argv.includes("-p") || argv.includes("--production-mode");
-  const includeWasmParser = argv.includes("--include-wasm");
-  fastDemoBuild({
-    watch: shouldWatch,
-    minify: shouldMinify,
-    includeWasmParser,
-    production,
-  });
-} else {
-  // This script is loaded as a module
-  module.exports = fastDemoBuild;
-}
-
-/**
- * Build the demo with the given options.
- * @param {Object} options
- * @param {boolean} [options.minify] - If `true`, the output will be minified.
- * @param {boolean} [options.production] - If `false`, the code will be compiled
- * in "development" mode, which has supplementary assertions.
- * @param {boolean} [options.watch] - If `true`, the RxPlayer's files involve
- * will be watched and the code re-built each time one of them changes.
- * @param {boolean} [options.includeWasmParser] - If `true`, the WebAssembly MPD
- * parser of the RxPlayer will be used (if it can be requested).
- */
-function fastDemoBuild(options) {
-  const minify = !!options.minify;
-  const watch = !!options.watch;
-  const isDevMode = !options.production;
-  const includeWasmParser = !!options.includeWasmParser;
-
-  /** Declare a plugin to anounce when a build begins and ends */
-  const consolePlugin = {
-    name: "onEnd",
-    setup(build) {
-      build.onStart(() => {
-        console.log(`\x1b[33m[${getHumanReadableHours()}]\x1b[0m ` +
-          "New demo build started");
-      })
-      build.onEnd(result => {
-        if (result.errors.length > 0 || result.warnings.length > 0) {
-          const { errors, warnings } = result;
-          console.log(`\x1b[33m[${getHumanReadableHours()}]\x1b[0m ` +
-            `Demo re-built with ${errors.length} error(s) and ` +
-            ` ${warnings.length} warning(s) `);
-          return;
-        }
-        console.log(`\x1b[32m[${getHumanReadableHours()}]\x1b[0m ` +
-          "Demo built!");
-      });
-    },
-  };
-
-  // Create a context for incremental builds
-  esbuild.context({
-    entryPoints: [path.join(__dirname, "../demo/full/scripts/index.tsx")],
-    bundle: true,
-    target: "es2017",
-    minify,
-    outfile: path.join(__dirname, "../demo/full/bundle.js"),
-    plugins: [consolePlugin],
-    define: {
-      "process.env.NODE_ENV": JSON.stringify(isDevMode ? "development" : "production"),
-      __INCLUDE_WASM_PARSER__: JSON.stringify(includeWasmParser),
-      __ENVIRONMENT__: JSON.stringify({
-        PRODUCTION: 0,
-        DEV: 1,
-        CURRENT_ENV: isDevMode ? 1 : 0,
-      }),
-      __LOGGER_LEVEL__: JSON.stringify({
-        CURRENT_LEVEL: "INFO",
-      }),
-    }
-  })
-    .then((context) => {
-      if (watch) {
-        return context.watch();
-      }
-    })
-    .catch((err) => {
-      console.error(
-        `\x1b[31m[${getHumanReadableHours()}]\x1b[0m Demo build failed:`,
-        err);
-      process.exit(1);
-    });
-}
-
-/**
- * Display through `console.log` an helping message relative to how to run this
- * script.
- */
-function displayHelp() {
-  /* eslint-disable no-console */
-  console.log(
-  /* eslint-disable indent */
-`Usage: node generate_full_demo.js [options]
-Options:
-  -h, --help             Display this help
-  -m, --minify           Minify the built demo
-  -p, --production-mode  Build all files in production mode (less runtime checks, mostly).
-  -w, --watch            Re-build each time either the demo or library files change`,
-  /* eslint-enable indent */
-  );
-  /* eslint-enable no-console */
-}

package/scripts/generate_certificate

@@ -1,19 +0,0 @@
-#!/bin/bash
-
-# Generate certificate
-# ====================
-#
-# This script allows to create a self-signed ssl certificate easily.
-# One of the goal here, is to be able to easily test HTTPS pages.
-#
-# An HTTPS server can then be created with the use of the generated
-# `localhost.crt` certificate and the `localhost.key` key.
-
-openssl req \
-  -x509 \
-  -out localhost.crt \
-  -keyout localhost.key \
-  -newkey rsa:2048 \
-  -nodes \
-  -sha256 \
-  -subj "/C=FR/L=Paris/O=CANAL+"

package/scripts/generate_demo_list.js

@@ -1,105 +0,0 @@
-#!/usr/bin/env node
-/* eslint-env node */
-
-/**
- * Generate demo list
- * ===========================
- *
- * ## How it works
- *
- * This script will generate a page listing the demos from various
- * versions of the rx-player.
- *
- * The demo should entirely be present in a directory called:
- * `/versions/VERSION_NUMBER/demo`
- *
- * Where VERSION_NUMBER is the version number in a semantic versioning scheme.
- *
- * The documentation homepage should be present in:
- * `/versions/VERSION_NUMBER/demo/index.html`
- *
- * This script was not written with portability in mind (it would have taken too
- * much time). It might thus break if file organization changes in this project.
- *
- *
- * ## How to run it
- *
- * To run this:
- *
- *   1. Be sure you are in the gh-pages branch
- *
- *   2. Call this script directly
- *
- *   3. a new file, `demo_page_by_version.html` should have been generated with
- *      all the right links.
- */
-
-const fs = require("fs");
-const path = require("path");
-const { encode } = require("html-entities");
-const semver = require("semver");
-
-const INITIAL_PATH = "./versions";
-
-function sortVersions(versions) {
-  return versions
-    .filter(v => semver.valid(v) != null)
-    .sort((a, b) => semver.gt(a, b) ? -1 : 1);
-}
-
-function isDirectory(source) {
-  return fs.lstatSync(source).isDirectory();
-}
-
-const style = `<style type="text/css">
-body { font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; color: #333; }
-ul { list-style-type: square; }
-li { margin-top: 8px; }
-a { color: #006; }
-a:hover { color: #076; }
-</style>`;
-const head = `<head>
-  <meta name="viewport" content="width=device-width, initial-scale=1">
-  <meta charset="utf-8">
-  <title>RxPlayer - Demo page by version</title>
-  ${style}
-</head>`;
-
-let body = "<body>";
-
-const files = fs.readdirSync(INITIAL_PATH);
-const versions = [];
-for (let i = 0; i < files.length; i++) {
-  const fileName = files[i];
-  const filePath = path.join(INITIAL_PATH, fileName);
-  if (isDirectory(filePath) && fs.existsSync(path.join(filePath, "demo"))) {
-    versions.push(fileName);
-  }
-}
-
-if (versions.length <= 0) {
-  body += "<h1>No Demo Available</h1>";
-} else {
-  body += "<h1>Demo page by version</h1>";
-  body += "<ul>";
-
-  const sortedVersions = sortVersions(versions);
-  for (let i = 0; i < sortedVersions.length; i++) {
-    const version = sortedVersions[i];
-    // const versionAsNumber = +version.split(".").join();
-    const dirPath = path.join(INITIAL_PATH, version, "demo/index.html");
-    body += `<li><a href=${encode(dirPath)}>` +
-      encode(version) +
-      "</a></li>";
-  }
-  body += "</ul>";
-}
-
-body += "<body/>";
-
-const html = "<html>" +
-  head +
-  body +
-  "<html>";
-
-fs.writeFileSync("./demo_page_by_version.html", html);

package/scripts/generate_documentation_list.js

@@ -1,109 +0,0 @@
-#!/usr/bin/env node
-/* eslint-env node */
-
-/**
- * Generate documentation list
- * ===========================
- *
- * ## How it works
- *
- * This script will generate a page listing the documentation from various
- * versions of the rx-player.
- *
- * The documentation should entirely be present in a directory called:
- * `/versions/VERSION_NUMBER/doc`
- *
- * Where VERSION_NUMBER is the version number in a semantic versioning scheme.
- *
- * The documentation homepage should be present in:
- * `/versions/VERSION_NUMBER/doc/pages/index.html`
- *
- * This script was not written with portability in mind (it would have taken too
- * much time). It might thus break if file organization changes in this project.
- *
- *
- * ## How to run it
- *
- * To run this:
- *
- *   1. Be sure you are in the gh-pages branch
- *
- *   2. Call this script directly
- *
- *   3. a new file, `documentation_pages_by_version.html` should have been
- *      generated with all the right links.
- */
-
-const fs = require("fs");
-const path = require("path");
-const { encode } = require("html-entities");
-const semver = require("semver");
-
-const INITIAL_PATH = "./versions";
-
-function sortVersions(versions) {
-  return versions
-    .filter(v => semver.valid(v) != null)
-    .sort((a, b) => semver.gt(a, b) ? -1 : 1);
-}
-
-function isDirectory(source) {
-  return fs.lstatSync(source).isDirectory();
-}
-
-const style = `<style type="text/css">
-body { font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; color: #333; }
-ul { list-style-type: square; }
-li { margin-top: 8px; }
-a { color: #006; }
-a:hover { color: #076; }
-</style>`;
-const head = `<head>
-  <meta name="viewport" content="width=device-width, initial-scale=1">
-  <meta charset="utf-8">
-  <title>RxPlayer - Documentation pages by version</title>
-  ${style}
-</head>`;
-
-let body = "<body>";
-
-const files = fs.readdirSync(INITIAL_PATH);
-const versions = [];
-for (let i = 0; i < files.length; i++) {
-  const fileName = files[i];
-  const filePath = path.join(INITIAL_PATH, fileName);
-  if (isDirectory(filePath) && fs.existsSync(path.join(filePath, "doc"))) {
-    versions.push(fileName);
-  }
-}
-
-if (versions.length <= 0) {
-  body += "<h1>No Documentation Available</h1>";
-} else {
-  body += "<h1>Documentation pages by version</h1>";
-  body += "<ul>";
-
-  const sortedVersions = sortVersions(versions);
-  for (let i = 0; i < sortedVersions.length; i++) {
-    const version = sortedVersions[i];
-
-    // documentation homepage changed for the v3.26.1
-    const dirPath = semver.gte(version, "3.26.1") ?
-      path.join(INITIAL_PATH, version, "doc/api/Overview.html") :
-      path.join(INITIAL_PATH, version, "doc/pages/index.html");
-
-    body += `<li><a href=${encode(dirPath)}>` +
-      encode(version) +
-      "</a></li>";
-  }
-  body += "</ul>";
-}
-
-body += "<body/>";
-
-const html = "<html>" +
-  head +
-  body +
-  "<html>";
-
-fs.writeFileSync("./documentation_pages_by_version.html", html);

package/scripts/generate_full_demo.js

@@ -1,201 +0,0 @@
-#!/usr/bin/env node
-/* eslint-env node */
-
-/**
- * Build the full demo
- * ===================
- *
- * This script allows to build the full demo locally, by using Webpack's bundler.
- *
- * You can either run it directly as a script (run `node
- * generate_full_demo.js -h` to see the different options) or by requiring it as
- * a node module.
- * If doing the latter you will obtain a function you will have to run with the
- * right options.
- */
-
-const path = require("path");
-const TerserPlugin = require("terser-webpack-plugin");
-const Webpack = require("webpack");
-const displayWebpackErrors = require("./utils/display_webpack_errors");
-const getHumanReadableHours = require("./utils/get_human_readable_hours");
-
-// If true, this script is called directly
-if (require.main === module) {
-  const { argv } = process;
-  if (argv.includes("-h") || argv.includes("--help")) {
-    displayHelp();
-    process.exit(0);
-  }
-  const shouldWatch = argv.includes("-w") || argv.includes("--watch");
-  const shouldMinify = argv.includes("-m") || argv.includes("--minify");
-  const production = argv.includes("-p") || argv.includes("--production-mode");
-  const includeWasmParser = argv.includes("--include-wasm");
-  generateFullDemo({
-    watch: shouldWatch,
-    minify: shouldMinify,
-    production,
-    includeWasmParser,
-  });
-} else {
-  // This script is loaded as a module
-  module.exports = generateFullDemo;
-}
-
-/**
- * Build the demo with the given options.
- * @param {Object} options
- * @param {boolean} [options.minify] - If `true`, the output will be minified.
- * @param {boolean} [options.production] - If `false`, the code will be compiled
- * in "development" mode, which has supplementary assertions.
- * @param {boolean} [options.watch] - If `true`, the RxPlayer's files involve
- * will be watched and the code re-built each time one of them changes.
- * @param {boolean} [options.includeWasmParser] - If `true`, the WebAssembly MPD
- * parser of the RxPlayer will be used (if it can be requested).
- */
-function generateFullDemo(options) {
-  const shouldMinify = options.minify === true;
-  const isDevMode = options.production !== true;
-  const includeWasmParser = options.includeWasmParser === true;
-
-  const webpackDemoConfig = {
-    mode: isDevMode ? "development" : "production",
-    entry: path.join(__dirname, "../demo/full/scripts/index.tsx"),
-    resolve: {
-      extensions: [".ts", ".tsx", ".js", ".jsx", ".json"],
-    },
-    output: {
-      path: path.join(__dirname, "../demo/full"),
-      filename: "bundle.js",
-    },
-    optimization: {
-      minimize: shouldMinify,
-      minimizer: shouldMinify ? [
-        new TerserPlugin(),
-      ] : [],
-    },
-    performance: {
-      maxEntrypointSize: shouldMinify ? 1000000 : 2500000,
-      maxAssetSize: shouldMinify ? 1000000 : 2500000,
-    },
-    module: {
-      rules: [
-        {
-          test: /\.tsx?$/,
-          use: [{
-            loader: "ts-loader",
-            options: {
-              compilerOptions: { sourceMap: true },
-            },
-          }],
-        },
-        {
-          test: /\.jsx?$/,
-          use: {
-            loader: "babel-loader",
-            options: {
-              cacheDirectory: true,
-              presets: [
-                "@babel/react",
-                ["@babel/env", { loose: true, modules: false }],
-              ],
-            },
-          },
-        },
-      ],
-    },
-    plugins: [
-      new Webpack.DefinePlugin({
-        __INCLUDE_WASM_PARSER__: includeWasmParser,
-        __ENVIRONMENT__: {
-          PRODUCTION: 0,
-          DEV: 1,
-          CURRENT_ENV: isDevMode ? 1 : 0,
-        },
-        __LOGGER_LEVEL__: {
-          CURRENT_LEVEL: "\"INFO\"",
-        },
-      }),
-    ],
-    watchOptions: {
-      ignored: /node_modules/,
-    },
-  };
-  const demoCompiler = Webpack(webpackDemoConfig);
-  if (!options.watch) {
-    /* eslint-disable no-console */
-    console.log(`\x1b[35m[${getHumanReadableHours()}]\x1b[0m ` +
-                "Building demo...");
-    /* eslint-enable no-console */
-    demoCompiler.run(onDemoResult);
-  } else {
-    /* eslint-disable no-console */
-    console.log(`\x1b[35m[${getHumanReadableHours()}]\x1b[0m ` +
-                "Building demo...");
-    /* eslint-enable no-console */
-    const demoCompilerWatching = demoCompiler.watch({ aggregateTimeout: 300 },
-                                                    onDemoResult);
-
-    demoCompilerWatching.compiler.hooks.watchRun.intercept({
-      call() {
-        /* eslint-disable no-console */
-        console.log(`\x1b[35m[${getHumanReadableHours()}]\x1b[0m ` +
-                    "Re-building demo");
-        /* eslint-enable no-console */
-      },
-    });
-  }
-}
-
-/**
- * Display results when the demo finished to build.
- * @param {Error|null|undefined} err
- * @param {Object} stats
- */
-function onDemoResult(err, stats) {
-  if (err) {
-    /* eslint-disable no-console */
-    console.error(`\x1b[31m[${getHumanReadableHours()}]\x1b[0m Could not compile demo:`,
-                  err);
-    /* eslint-enable no-console */
-    return;
-  }
-
-  if (stats.compilation.errors && stats.compilation.errors.length ||
-      stats.compilation.warnings && stats.compilation.warnings.length)
-  {
-    const errors = stats.compilation.errors || [];
-    const warnings = stats.compilation.warnings || [];
-    displayWebpackErrors(errors, warnings);
-    /* eslint-disable no-console */
-    console.log(`\x1b[33m[${getHumanReadableHours()}]\x1b[0m ` +
-                `Demo built with ${errors.length} error(s) and ` +
-                ` ${warnings.length} warning(s) ` +
-                `(in ${stats.endTime - stats.startTime} ms).`);
-    /* eslint-enable no-console */
-  } else {
-    /* eslint-disable no-console */
-    console.log(`\x1b[32m[${getHumanReadableHours()}]\x1b[0m Demo built ` +
-                `(in ${stats.endTime - stats.startTime} ms).`);
-    /* eslint-enable no-console */
-  }
-}
-
-/**
- * Display through `console.log` an helping message relative to how to run this
- * script.
- */
-function displayHelp() {
-  /* eslint-disable no-console */
-  console.log(
-  /* eslint-disable indent */
-`Usage: node generate_full_demo.js [options]
-Options:
-  -h, --help             Display this help
-  -m, --minify           Minify the built demo
-  -p, --production-mode  Build all files in production mode (less runtime checks, mostly).
-  -w, --watch            Re-build each time either the demo or library files change`,
-  /* eslint-enable indent */
-  );
-  /* eslint-enable no-console */
-}

package/scripts/generate_standalone_demo.js

@@ -1,82 +0,0 @@
-#!/usr/bin/env node
-/* eslint-env node */
-
-/**
- * Build the standalone demo
- * =========================
- *
- * This script allows to build the simple standalone demo locally.
- *
- * You can run it as a script through `node generate_standalone_demo.js`.
- * Be aware that this demo will be built again every time one of the library
- * file is updated.
- */
-
-const Webpack = require("webpack");
-const path = require("path");
-const displayWebpackErrors = require("./utils/display_webpack_errors");
-const getHumanReadableHours = require("./utils/get_human_readable_hours");
-
-const webpackConfig = require("../webpack.config.js");
-
-/* eslint-disable no-console */
-console.log(
-  `\x1b[35m[${getHumanReadableHours()}]\x1b[0m ` +
-    "Building demo..."
-);
-/* eslint-enable no-console */
-
-const config = webpackConfig({
-  production: false,
-  minify: false,
-  reportSize: false,
-});
-
-// overwrite entries/output (ugly but just werks and did not find any better for now)
-config.entry = path.join(__dirname, "../src/index.ts");
-config.output.path = __dirname;
-config.output.filename = "../demo/standalone/lib.js";
-
-const compiler = Webpack(config);
-
-const compilerWatching = compiler.watch({
-  aggregateTimeout: 300,
-}, (err, stats) => {
-  if (err) {
-    /* eslint-disable no-console */
-    console.error(`\x1b[31m[${getHumanReadableHours()}]\x1b[0m Could not compile demo:`, err);
-    /* eslint-enable no-console */
-    return;
-  }
-
-  if (
-    stats.compilation.errors && stats.compilation.errors.length ||
-    stats.compilation.warnings && stats.compilation.warnings.length
-  ) {
-    const errors = stats.compilation.errors || [];
-    const warnings = stats.compilation.warnings || [];
-    displayWebpackErrors(errors, warnings);
-    /* eslint-disable no-console */
-    console.log(
-      `\x1b[33m[${getHumanReadableHours()}]\x1b[0m ` +
-      `Demo built with ${errors.length} error(s) and ` +
-      ` ${warnings.length} warning(s) (in ${stats.endTime - stats.startTime} ms).`
-    );
-    /* eslint-enable no-console */
-  } else {
-    /* eslint-disable no-console */
-    console.log(`\x1b[32m[${getHumanReadableHours()}]\x1b[0m Demo built (in ${stats.endTime - stats.startTime} ms).`);
-    /* eslint-enable no-console */
-  }
-});
-
-compilerWatching.compiler.hooks.watchRun.intercept({
-  call() {
-    /* eslint-disable no-console */
-    console.log(
-      `\x1b[35m[${getHumanReadableHours()}]\x1b[0m ` +
-      "Re-building demo"
-    );
-    /* eslint-enable no-console */
-  },
-});