rx-player 3.25.2 → 3.26.3-dev.2022021400

package/scripts/build/templates/experimental/tools/VideoThumbnailLoader/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+import VideoThumbnailLoader from "../../../__BUILD_DIR__/experimental/tools/VideoThumbnailLoader/index";
+export * from "../../../__BUILD_DIR__/experimental/tools/VideoThumbnailLoader/index";
+export default VideoThumbnailLoader;

package/scripts/build/templates/experimental/tools/VideoThumbnailLoader/index.js

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+import VideoThumbnailLoader from "../../../__BUILD_DIR__/experimental/tools/VideoThumbnailLoader/index.js";
+export * from "../../../__BUILD_DIR__/experimental/tools/VideoThumbnailLoader/index.js";
+export default VideoThumbnailLoader;

package/scripts/build/templates/experimental/tools/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/tools/index";

package/scripts/build/templates/experimental/tools/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/tools/index.js";

package/scripts/build/templates/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__/features/list/index";

package/scripts/build/templates/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__/features/list/index.js";

package/scripts/build/templates/logger/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+import logger from "../__BUILD_DIR__/log";
+export default logger;

package/scripts/build/templates/logger/index.js

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+import logger from "../__BUILD_DIR__/log.js";
+export default logger;

package/scripts/build/templates/minimal/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+import MinimalPlayer from "../__BUILD_DIR__/minimal";
+export default MinimalPlayer;

package/scripts/build/templates/minimal/index.js

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+import MinimalPlayer from "../__BUILD_DIR__/minimal.js";
+export default MinimalPlayer;

package/scripts/build/templates/tools/TextTrackRenderer.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+import TextTrackRenderer from "../__BUILD_DIR__/tools/TextTrackRenderer/index";
+export * from "../__BUILD_DIR__/tools/TextTrackRenderer/index";
+export default TextTrackRenderer;

package/scripts/build/templates/tools/TextTrackRenderer.js

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+import TextTrackRenderer from "../__BUILD_DIR__/tools/TextTrackRenderer/index.js";
+export * from "../__BUILD_DIR__/tools/TextTrackRenderer/index.js";
+export default TextTrackRenderer;

package/scripts/build/templates/tools/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__/tools/index";

package/scripts/build/templates/tools/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__/tools/index.js";

package/scripts/build/templates/tools/string-utils.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+import StringUtils from "../__BUILD_DIR__/tools/string_utils";
+export * from "../__BUILD_DIR__/tools/string_utils";
+export default StringUtils;

package/{dist/_esm5.processed/core/fetchers/segment/get_segment_backoff_options.d.ts → scripts/build/templates/tools/string-utils.js}

@@ -13,14 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { IBackoffOptions } from "../utils/try_urls_with_backoff";
-/**
- * @param {string} bufferType
- * @param {Object}
- * @returns {Object}
- */
-export default function getSegmentBackoffOptions(bufferType: string, { maxRetryRegular, maxRetryOffline, lowLatencyMode }: {
-    maxRetryRegular?: number;
-    maxRetryOffline?: number;
-    lowLatencyMode: boolean;
-}): IBackoffOptions;
+import StringUtils from "../__BUILD_DIR__/tools/string_utils.js";
+export * from "../__BUILD_DIR__/tools/string_utils.js";
+export default StringUtils;

package/scripts/build/templates/types/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__/public_types";

package/scripts/build/templates/types/index.js

@@ -0,0 +1,15 @@
+/**
+ * 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.
+ */

package/scripts/check_nodejs_import_compatibility.js

@@ -1,7 +1,35 @@
+/**
+ * # check_nodejs_import_compatibility
+ *
+ * This is a node.js script which tries to import the RxPlayer various exports
+ * and check if every one of them seems to be importable without issue.
+ *
+ * The goal is to check if the RxPlayer, at the origin made to run in a browser
+ * environment, can still be imported through node.js in specific cases like
+ * when the application uses [poorly optimized] server-side rendering.
+ *
+ * ---
+ *
+ * To be able to run this script:
+ *
+ *   1. You need first to produce the modular "minimal" build of the RxPlayer
+ *
+ *   2. You need to make sure that `import` statements can be used in the
+ *      node.js runtime you've ran. This possibility might depends on the
+ *      usage of supplementary supplementary packages like `esm`.
+ *
+ * After running this script, you know if it ran succesfully by seeing the
+ * string "SUCCESS!" being outputed to STDOUT.
+ *
+ * If it doesn't work, you should see a corresponding error output to STDERR.
+ */
+
 import fs from "fs";
 import RxPlayer from "../minimal/index.js";
 import * as Features from "../features/index.js";
-import * as Tools from "../experimental/tools/index.js";
+import * as ExperimentalFeatures from "../experimental/features/index.js";
+import * as ExperimentalTools from "../experimental/tools/index.js";
+import * as Tools from "../tools/index.js";
 
 let version = fs.readFileSync("./VERSION").toString();
 const indexOfFirstLineBreak = version.indexOf("\n");
@@ -14,9 +42,15 @@ if (RxPlayer.version !== version) {
     "Wrong RxPlayer version: " + "\n" +
     `Got "${RxPlayer.version}" but expected "${version}"`);
 }
+if (typeof ExperimentalFeatures !== "object" || ExperimentalFeatures === null) {
+  throw new Error("Invalid \"ExperimentalFeatures\" object exported.");
+}
 if (typeof Features !== "object" || Features === null) {
   throw new Error("Invalid \"Features\" object exported.");
 }
+if (typeof ExperimentalTools !== "object" || ExperimentalTools === null) {
+  throw new Error("Invalid \"ExperimentalTools\" object exported.");
+}
 if (typeof Tools !== "object" || Tools === null) {
   throw new Error("Invalid \"Tools\" object exported.");
 }

package/scripts/doc-generator/construct_table_of_contents.js

@@ -5,15 +5,13 @@
  * @param {string} md - The markdown content
  * @returns {string}
  */
-module.exports = function constructTableOfContents(md) {
+function constructTableOfContents(md) {
   const tocLines = [];
   const newContent = [];
   const lines = md.split(/\r\n|\n|\r/);
 
-  // Objects used to avoid duplicates
-  const generatedTitleURIs = {};
-  const generatedChapterURIs = {};
-  const generatedSubchapterURIs = {};
+  // Object used to avoid duplicates
+  const generatedAnchors = {};
 
   // The inputed markdown is read line by line.
   // When a h1, h2 or h3 is encountered in it, add a new list entry
@@ -22,18 +20,14 @@ module.exports = function constructTableOfContents(md) {
   // add `<a>` links just before the corresponding h1, h2 or h3 elements in the
   // inputed markdown.
   // All Markdown parsing done here corresponds to the CommonMark spec (v0.29)
-  // TODO this should be much more efficient and less error-prone if integrated
-  // as a markdown-it plugin.
+  // TODO this might be more efficient and less error-prone if integrated as a
+  // markdown-it plugin.
   for (let i = 0, len = lines.length; i < len; i++) {
     if (/^ *# +/.test(lines[i])) {
       const regExec = /^ *# +(.*)$/.exec(lines[i]);
       if (regExec && regExec[1]) {
         const tocLine = regExec[1].replace(/ #* *$/, "").trim();
-        let uri = "title-" + encodeURI(tocLine);
-        while (generatedTitleURIs[uri] === true) {
-          uri += "-bis";
-        }
-        generatedTitleURIs[uri] = true;
+        let uri = generateAnchorName(tocLine);
         tocLines.push(`[${tocLine}](#${uri})`);
         newContent.push(`<a name="${uri}"></a>`);
       }
@@ -41,11 +35,7 @@ module.exports = function constructTableOfContents(md) {
       const regExec = /^ *## +(.*)$/.exec(lines[i]);
       if (regExec && regExec[1]) {
         const tocLine = regExec[1].replace(/ #* *$/, "").trim();
-        let uri = "chapter-" + encodeURI(tocLine);
-        while (generatedChapterURIs[uri] === true) {
-          uri += "-bis";
-        }
-        generatedChapterURIs[uri] = true;
+        let uri = generateAnchorName(tocLine);
         tocLines.push(`  - [${tocLine}](#${uri})`);
         newContent.push(`<a name="${uri}"></a>`);
       }
@@ -53,17 +43,34 @@ module.exports = function constructTableOfContents(md) {
       const regExec = /^ *### +(.*)$/.exec(lines[i]);
       if (regExec && regExec[1]) {
         const tocLine = regExec[1].replace(/ #* *$/, "").trim();
-        let uri = "subchapter-" + encodeURI(tocLine);
-        while (generatedSubchapterURIs[uri] === true) {
-          uri += "-bis";
-        }
-        generatedSubchapterURIs[uri] = true;
+        let uri = generateAnchorName(tocLine);
         tocLines.push(`    - [${tocLine}](#${uri})`);
         newContent.push(`<a name="${uri}"></a>`);
       }
     }
     newContent.push(lines[i]);
   }
-  return { toc: tocLines.join("\n"),
-           content: newContent.join("\n") };
+  return {
+    tocMd: tocLines.join("\n"),
+    nbTocElements: tocLines.length,
+    content: newContent.join("\n"),
+  };
+
+  function generateAnchorName(title) {
+    const baseUri = encodeURI(title.toLowerCase().replace(/ /g, "_"))
+    if (generatedAnchors[baseUri] !== true) {
+      generatedAnchors[baseUri] = true;
+      return baseUri;
+    }
+    let i = 1;
+    let resultUri;
+    do {
+      resultUri = `${baseUri}_(${i})`;
+      i++;
+    } while (generatedAnchors[resultUri] === true);
+    generatedAnchors[resultUri] = true;
+    return resultUri;
+  }
 };
+
+module.exports = constructTableOfContents;

package/scripts/doc-generator/convert_MD_to_HMTL.js

@@ -1,11 +1,12 @@
 const hljs = require("highlight.js");
-const emoji = require("markdown-it-emoji");
 const md = require("markdown-it")({
-  highlight: function (str, lang) {
+  highlight(str, lang) {
     if (lang && hljs.getLanguage(lang)) {
       try {
         return hljs.highlight(str, { language: lang }).value;
-      } catch (_) {}
+      } catch (_) {
+        /* don't care for now */
+      }
     }
     return "";
   },
@@ -15,11 +16,6 @@ const md = require("markdown-it")({
   xhtmlOut: true,
 });
 
-md.use(emoji);
-md.renderer.rules.emoji = function(token, idx) {
-  return `<span class="emoji emoji_${token[idx].markup}">${token[idx].content}</span>`;
-};
-
 /**
  * Convert the Markdown document given into an HTML page.
  * @param {string} mdStr