Merge remote-tracking branch 'origin' into smp-imscjs-1.0.11

Author: jlks

.eslintignore

@@ -1,19 +1,16 @@
-# unsupported
-*.html
-*.md
-*.sh
-*.yaml
+# Exclude everything
+*
 
-# deps
-node_modules/
-
-# build
-docs/
-dist/
-dist-local/
-
-# configs
-.nvmrc
-*.config.*
-rollup.*.js
-.*ignore
+# Re-include supported file formats and locations
+!./*.js
+!./*.cjs
+!./*.mjs
+!./*.ts
+!./*.cts
+!./*.mts
+!src/**/*.js
+!src/**/*.cjs
+!src/**/*.mjs
+!src/**/*.ts
+!src/**/*.cts
+!src/**/*.mts

.eslintrc.yaml

@@ -2,6 +2,6 @@
 node_modules/
 
 # build
-docs/
 dist/
 dist-local/
+docs/api/

.prettierignore

@@ -1,10 +1,11 @@
 semi: false
 tabWidth: 2
+endOfLine: lf
 printWidth: 120
 singleQuote: false
-trailingComma: "es5"
+trailingComma: es5
 bracketSameLine: true
-endOfLine: "lf"
+quoteProps: consistent
 overrides:
   - files:
       - "*.html"

.prettierrc.yaml

@@ -1,3 +1,3 @@
 {
-  "presets": [["@babel/preset-env"]]
+  "presets": [["@babel/preset-env"], ["@babel/preset-typescript"]]
 }

babel.config.json

@@ -39,7 +39,7 @@ type failoverResetTime = number is FiniteNumber
 Provide a sorting algorithm to reorder the available media sources after a failover.
 
 ```ts
-type failoverSort = (...sources: [...string]) => [...string]
+type failoverSort = (sources: string[]) => string[]
 ```
 
 ### `streaming.seekDurationPadding`

docs/tutorials/02-settings-and-overrides.md

@@ -1,11 +1,25 @@
-During development, `bigscreen-player` offers a form of debugging with an on-screen debugger. Using this tool, specific events can be monitored to check successful execution of the program logic. This is particularly useful where no native JS consoles are accessible on certain devices.
+BigscreenPlayer offers logging through "Chronicle", our own debugging solution. This tool can be used to monitor specific events and changes in metrics over time in order to validate execution of the program logic.
+
+## On-Screen Debugging
+
+We offer an on-screen debugger as part of our solution. This is particularly useful where no native JavaScript consoles are natively accessible on devices.
 
 The on-screen debugger can be shown using:
-```
+
+```js
 bigscreenPlayer.toggleDebug()
 ```
 
-### The Chronicle
-The debug-tool latches on top of the `chronicle` which acts similarly to the plugin interface. It has a reference to all of the callbacks that need to be updated upon a debug event occurring. 
+## Structured Logging
+
+Logs in the Chronicle are _structured_. What is more, logs are captured even when the on-screen debugger isn't active. You can access the complete record of the playback session using:
+
+```js
+bigscreenPlayer.getDebugLogs()
+```
+
+You can find the full structure of the data returned by this function in the source file `chronicle.ts`. In short, `getDebugLogs` returns the Chronicle record as a flat array of entries. Each entry falls into one of three (3) categories:
 
-This could allow for a possible extension of the debugging interface *if* needed.
+1. Message: Unstructured string data. Think `console` output.
+2. Metrics: Values that change over time, such as dropped frames.
+3. Traces: Snapshots and one-of data, such as errors and events.

docs/tutorials/Debugging.md

@@ -11,6 +11,9 @@
   "cdn-failover": {
     "title": "CDN Failover"
   },
+  "debugging": {
+    "title": "Debugging"
+  },
   "live-streaming": {
     "title": "Live"
   }

docs/tutorials/tutorials.json

@@ -0,0 +1,19 @@
+import { FlatCompat } from "@eslint/eslintrc"
+import js from "@eslint/js"
+import path from "node:path"
+import { fileURLToPath } from "node:url"
+
+// Mimick CommonJS variables
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  resolvePluginsRelativeTo: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+})
+
+export const sonarjs = {
+  configs: { recommended: compat.extends("plugin:sonarjs/recommended") },
+}