myetv-player 1.0.0 → 1.0.8

package/.github/workflows/codeql.yml

@@ -0,0 +1,100 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL Advanced"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  schedule:
+    - cron: '29 21 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze (${{ matrix.language }})
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners (GitHub.com only)
+    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    permissions:
+      # required for all workflows
+      security-events: write
+
+      # required to fetch internal or private CodeQL packs
+      packages: read
+
+      # only required for workflows in private repositories
+      actions: read
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - language: actions
+          build-mode: none
+        - language: javascript-typescript
+          build-mode: none
+        # CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
+        # Use `c-cpp` to analyze code written in C, C++ or both
+        # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
+        # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
+        # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
+        # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
+        # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
+        # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    # Add any setup steps before running the `github/codeql-action/init` action.
+    # This includes steps like installing compilers or runtimes (`actions/setup-node`
+    # or others). This is typically only required for manual builds.
+    # - name: Setup runtime (example)
+    #   uses: actions/setup-example@v1
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        build-mode: ${{ matrix.build-mode }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+    # If the analyze step fails for one of the languages you are analyzing with
+    # "We were unable to automatically build your code", modify the matrix above
+    # to set the build mode to "manual" for that language. Then modify this step
+    # to build your code.
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+    - if: matrix.build-mode == 'manual'
+      shell: bash
+      run: |
+        echo 'If you are using a "manual" build mode for one or more of the' \
+          'languages you are analyzing, replace this with the commands to build' \
+          'your code, for example:'
+        echo '  make bootstrap'
+        echo '  make release'
+        exit 1
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+      with:
+        category: "/language:${{matrix.language}}"

package/README.md

@@ -1,7 +1,31 @@
+[![CodeQL Advanced](https://github.com/OskarCosimo/myetv-video-player-opensource/actions/workflows/codeql.yml/badge.svg)](https://github.com/OskarCosimo/myetv-video-player-opensource/actions/workflows/codeql.yml) [![Node.js Package](https://github.com/OskarCosimo/myetv-video-player-opensource/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/OskarCosimo/myetv-video-player-opensource/actions/workflows/npm-publish.yml)
+
 # MYETV Audio/Video Player Open Source
 
 A modern and complete HTML5 + JavaScript + css video player with custom controls, multiple quality support, subtitles, Picture-in-Picture and much more.
 
+## Table of Contents
+
+- [Features](#features)
+- [Demo Page](#demo-page)
+- [Installation](#installation)
+- [Basic Usage](#basic-usage)
+- [Initialization Options](#initialization-options)
+- [Api Methods](#api-methods)
+- [Api Events](#api-events)
+- [Keyboard Controls](#keyboard-controls)
+- [CSS Customization](#css-customization)
+- [Browser Compatibility](#browser-compatibility)
+- [Plugins Feature](#plugins-feature)
+- [Chapters Feature](#chapters-feature)
+- [Playlist Feature](#playlist-feature)
+- [Adaptive Streaming (HLS/DASH)](#adaptive-streaming-hlsdash)
+- [Supported Browsers](#supported-browsers)
+- [License](#license)
+- [Contributing](#contributing)
+
+---
+
 ## Features
 
 - **Custom controls** with intelligent auto-hide
@@ -75,8 +99,9 @@ const player = new MYETVvideoplayer('my-video', {
 | `subtitlesEnabled` | boolean | `false` | Enable/Disable subtitles at player ready |
 | `chapters` | string | json | Enable/Disable chapters: chapter can be in json format or string format (see below) |
 | `plugins` | string | json | Add a customized plugin to the player to extend its functionality (see below) |
+| `seekHandleShape` | string | `true` | Edit the shape of the seek controlbar. Shape type: none, circle, square, diamond, arrow, triangle, heart, star |
 | `showSeekTooltip` | boolean | `true` | Show tooltip during seek |
-| `volumeSlider` | string | `horizontal` | Volume slider 'horizontal' or 'vertical': the horizontal slider is always visible and have the automatic fallback to vertical under 550px of width; the vertical slider is only vertical at any width and automatically disapper if mouse is not hover the volume button |
+| `volumeSlider` | string | `show` | Volume slider 'show' or 'hide': with "show" the volume slider is always visible and have the automatic fallback to "hide" under 550px of width; with "hide" the volume slider is visible only at mouse over |
 | `autoplay` | boolean | `false` | Start video automatically |
 | `loop` | boolean | `false` | Optional if the video should loop
 | `resolution` | string | `normal` | resolution type: "normal" same resolution of the native video; "4:3"; "16:9"; "stretched" the video will be stretched in all the container; "fit-to-screen" the video will fit the screen but can be cutted; "scale-to-fit" fit the screen but preserve aspect ration and not cut |
@@ -188,26 +213,7 @@ player.setChapters([...]);
 player.clearChapters();
 ```
 ### Plugins Controls
-```
-// Add plugins dynamically
-player.usePlugin('youtube', {
-    apiKey: 'your-api-key'
-});
-
-// Upload YouTube videos (based on the YouTube plugin example)
-player.loadYouTubeVideo('dQw4w9WgXcQ');
-
-// Check if a plugin is active
-if (player.hasPlugin('youtube')) {
-    console.log('YouTube plugin is active');
-}
-
-// Get plugin instance
-const youtubePlugin = player.getPlugin('youtube');
-
-// Remove plugins from the player
-player.removePlugin('youtube');
-```
+[Plugins Help: https://github.com/OskarCosimo/myetv-video-player-opensource/blob/main/plugins/README.md](https://github.com/OskarCosimo/myetv-video-player-opensource/blob/main/plugins/README.md)
 ### Screen Controls
 ```
 // Fullscreen and Picture-in-Picture
@@ -218,7 +224,7 @@ player.togglePictureInPicture();  // Toggle Picture-in-Picture
 ```
 ### Brand Logo Controls
 ```
-// Fullscreen and Picture-in-Picture
+// Brand Logo in controlbar
 player.setBrandLogo(enabled, url, linkUrl)    //change brand logo dynamically
 player.getBrandLogoSettings()    //get current brand logo settings
 ```
@@ -245,6 +251,18 @@ player.removeWatermark();
 //hide with the controlbar or always show the watermark logo
 player.setWatermarkAutoHide(false);
 ```
+### Controlbar seek shape
+```
+// Change dynamically
+player.setSeekHandleShape('heart');
+
+// Get the current shape
+console.log(player.getSeekHandleShape()); // "heart"
+
+// Show all available shape
+console.log(player.getAvailableSeekHandleShapes());
+// ["none", "circle", "square", "diamond", "arrow", "triangle", "heart", "star"]
+```
 ### Playlist Controls
 ```
 player.nextVideo();                    // Next Video
@@ -728,43 +746,10 @@ Minimal DOM manipulation thanks to CSS-based theming
 
 Hardware-accelerated transitions for smooth playback
 
-## Plguins feature
+## Plugins feature
 The player supports custom plugins to extend its functionality. Every plugins must have its own documentation to clearly known how to use it. Plugins are modular so you can add or remove any plugins whenever you want. This is just an example based on two plugins.
-### Add a plguin to the player
-```
-<!-- Google Analytics 4 -->
-<script async src="https://www.googletagmanager.com/gtag/js?id=G-XXXXXXXXXX"></script>
-<script>
-    window.dataLayer = window.dataLayer || [];
-    function gtag(){dataLayer.push(arguments);}
-    gtag('js', new Date());
-    gtag('config', 'G-XXXXXXXXXX');
-</script>
-<!-- Player bundle -->
-<script src="dist/myetv-player.min.js"></script>
-<!-- Plugin bundle -->
-<script src="plugins/youtube/myetv-player-youtube-plugin.js"></script>
-<script src="plugins/google-analytics/myetv-player-g-analytics-plugin.js"></script>
-```
-### Initialization exmples with plugins
-```
-const player = new MYETVPlayer('my-video', {
-    debug: true,
-    plugins: {
-        youtube: {
-            videoId: 'dQw4w9WgXcQ',  // Video ID of YouTube (example)
-            apiKey: 'your-api-key',
-            autoplay: false
-        },
-        analytics: {
-                platform: 'ga4',
-                videoTitle: 'My Awesome Video',
-                videoCategory: 'Tutorial',
-                videoId: 'video-001'
-            }
-    }
-});
-```
+
+[Plugins and Feature Help: https://github.com/OskarCosimo/myetv-video-player-opensource/tree/main/plugins](https://github.com/OskarCosimo/myetv-video-player-opensource/tree/main/plugins)
 
 ## Chapters feature
 Supports flexible time formats (HH:MM:SS, MM:SS, or seconds) and images url (optional)
@@ -862,5 +847,11 @@ Push to the branch (git push origin feature/feature-name)
 
 Create a Pull Request
 
+Contact MYETV here: [https://support.myetv.tv](https://support.myetv.tv)
+
+Donate to the project here: [https://blog.myetv.tv/donate-to-developers/](https://blog.myetv.tv/donate-to-developers/)
+
+Watch MYETV here: [https://www.myetv.tv](https://www.myetv.tv)
+
 ## Bug Reports
 To report bugs or request features, open an issue in the repository.

package/SECURITY.md

@@ -0,0 +1,50 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.x.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+We take the security of MYETV Video Player seriously. If you discover a security vulnerability, please report it responsibly.
+
+### How to Report
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them via one of the following methods:
+- The best way is: open a ticket here: [https://support.myetv.tv](https://support.myetv.tv)
+- Use GitHub's private vulnerability reporting feature in the Security tab of this repository
+- Email: admin@myetv.tv (This method is susceptible to email provider security like spam or otherwise)
+
+### What to Include
+
+To help us better understand and resolve the issue, please include:
+- A clear description of the vulnerability
+- Steps to reproduce the issue
+- Affected versions of MYETV Video Player
+- Potential impact and severity assessment
+- Any suggested fixes or patches (if available)
+- Your environment details (browser, OS, etc.)
+
+### Response Timeline
+
+- **Acknowledgment:** We will confirm receipt of your report within **48 hours**
+- **Initial Assessment:** We will provide an initial evaluation within **7 days**
+- **Progress Updates:** We will keep you informed about the progress of resolving the issue
+- **Resolution:** Once a fix is developed, we will coordinate the release and disclosure timeline with you
+
+### Disclosure Policy
+
+We follow responsible disclosure principles:
+- Please allow us reasonable time to investigate and fix the vulnerability before public disclosure
+- We will credit you in the security advisory (unless you prefer to remain anonymous)
+- Once the fix is released, we will publish a security advisory with details about the vulnerability
+- We appreciate your cooperation in keeping MYETV users safe
+
+Thank you for helping to keep MYETV Video Player secure!