hlsdownloader 3.0.1 → 3.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +17 -50
  2. package/package.json +63 -54
package/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  <div align="center">
2
- <a href="https://nurrony.github.io/hlsdownloader/" alt="HLSDownloader Logo"><img alt="HLSDownloader" style="height: 200px; width: 200px;border-radius: 5px;" src="./assets/logo.png" /></a><br />
2
+
3
+ [![HLSDownloader](./assets/logo.png)](https://nurrony.github.io/hlsdownloader/)<br />
4
+
3
5
  </div>
4
6
 
5
7
  <p align="center" style="font-size: 18px;">
@@ -11,40 +13,20 @@
11
13
  </p>
12
14
 
13
15
  <div align="center">
14
- <a href="https://www.npmjs.com/package/hlsdownloader" target="_blank">
15
- <img alt="Version" src="https://img.shields.io/npm/v/hlsdownloader.svg?style=flat-square">
16
- </a>
17
- <a href="https://www.npmjs.com/package/hlsdownloader" target="_blank">
18
- <img src="https://img.shields.io/badge/node-%3E%3D18-blue.svg?style=flat-square" />
19
- </a>
20
- <a href="https://github.com/nurrony/hlsdownloader/actions/workflows/test.yaml" target="_blank">
21
- <img src=https://github.com/nurrony/hlsdownloader/actions/workflows/test.yaml/badge.svg?style=flat-square" />
22
- </a>
23
- <a href="https://nurrony.github.io/hlsdownloader" target="_blank">
24
- <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg?style=flat-square" />
25
- </a>
26
- <a href="https://codecov.io/gh/nurrony/hlsdownloader" >
27
- <img src="https://codecov.io/gh/nurrony/hlsdownloader/graph/badge.svg?token=er50RqLH6T?style=flat-square"/>
28
- </a>
29
- <a href="https://github.com/nurrony/hlsdownloader/graphs/commit-activity" target="_blank">
30
- <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg?style=flat-square" />
31
- </a>
32
- <a href="https://github.com/nurrony/hlsdownloader/blob/master/LICENSE" target="_blank">
33
- <img alt="License: MIT" src="https://img.shields.io/github/license/nurrony/hlsdownloader?style=flat-square" />
34
- </a>
35
- <a href="https://npmjs.com/package/hlsdownloader" target="_blank">
36
- <img alt="Semver: Badge" src="https://img.shields.io/badge/%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079?style=flat-square" />
37
- </a>
38
- <a href="https://npm-stat.com/charts.html?package=hlsdownloader" target="_blank">
39
- <img alt="Downloads: HLSDownloader" src="https://img.shields.io/npm/dm/hlsdownloader.svg?style=flat-square" />
40
- </a>
41
- <a href="https://bundlephobia.com/package/hlsdownloader@latest" target="_blank">
42
- <img alt="Min Bundle Size: HLSDownloader" src="https://img.shields.io/bundlephobia/minzip/hlsdownloader?style=flat-square" />
43
- </a>
44
- <a href="https://bundlephobia.com/package/hlsdownloader@latest" target="_blank">
45
- <img alt="Min Bundle Size: HLSDownloader" src="https://img.shields.io/badge/dynamic/json?url=https://packagephobia.com/v2/api.json?p=hlsdownloader&query=$.install.pretty&label=install%20size&style=flat-square" />
46
- </a>
47
- <br /> <br />
16
+
17
+ [![Version](https://img.shields.io/npm/v/hlsdownloader.svg?style=flat-square)](https://www.npmjs.com/package/hlsdownloader)
18
+ [![Node](https://img.shields.io/badge/node-%3E%3D18-blue.svg?style=flat-square)](https://www.npmjs.com/package/hlsdownloader)
19
+ [![CI](https://github.com/nurrony/hlsdownloader/actions/workflows/test.yaml/badge.svg?style=flat-square)](https://github.com/nurrony/hlsdownloader/actions/workflows/test.yaml)
20
+ [![Documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg?style=flat-square)](https://nurrony.github.io/hlsdownloader)
21
+ [![Coverage](https://codecov.io/gh/nurrony/hlsdownloader/graph/badge.svg?token=er50RqLH6T?style=flat-square)](https://codecov.io/gh/nurrony/hlsdownloader)
22
+ [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg?style=flat-square) ](https://github.com/nurrony/hlsdownloader/graphs/commit-activity)
23
+ [![License: MIT](https://img.shields.io/github/license/nurrony/hlsdownloader?style=flat-square) ](https://github.com/nurrony/hlsdownloader/blob/master/LICENSE)
24
+ [![Semver: Badge](https://img.shields.io/badge/%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079?style=flat-square) ](https://npmjs.com/package/hlsdownloader)
25
+ [![Downloads: HLSDownloader](https://img.shields.io/npm/dm/hlsdownloader.svg?style=flat-square) ](https://npm-stat.com/charts.html?package=hlsdownloader)
26
+ [![Min Bundle Size: HLSDownloader](https://img.shields.io/bundlephobia/minzip/hlsdownloader?style=flat-square) ](https://bundlephobia.com/package/hlsdownloader@latest)
27
+ [![Known Vulnerabilities](https://snyk.io/test/github/nurrony/hlsdownloader/badge.svg)](https://snyk.io/test/github/nurrony/hlsdownloader)
28
+ <br /> <br />
29
+
48
30
  </div>
49
31
 
50
32
  > ⚠️
@@ -53,21 +35,6 @@
53
35
  > ⚠️
54
36
  > <strong>HLSDownloader `v2.x.x` is no longer maintained and we will not accept any backport requests.</strong>
55
37
 
56
- ## Table of Contents
57
-
58
- - [Features](#features)
59
- - [Prerequisites](#prerequisites)
60
- - [Installation](#installation)
61
- - [How to use](#how-to-use)
62
- - [Advance Usage](#advance-usage)
63
- - [Running Tests](#running-tests)
64
- - [Generate Documentations](#generate-documentations)
65
- - [Authors](#authors)
66
- - [Contributing](#contributing)
67
- - [Show your support](#show-your-support)
68
- - [Special Thanks to](#special-thanks-to)
69
- - [License](#license)
70
-
71
38
  ## Features
72
39
 
73
40
  - Retryable
package/package.json CHANGED
@@ -1,91 +1,100 @@
1
1
  {
2
2
  "author": {
3
- "name": "Nur Rony",
4
3
  "email": "pro.nmrony@gmail.com",
4
+ "name": "Nur Rony",
5
5
  "url": "https://nurrony.github.io"
6
6
  },
7
7
  "bugs": {
8
8
  "url": "https://github.com/nurrony/hlsdownloader/issues"
9
9
  },
10
- "type": "module",
10
+ "config": {
11
+ "commitizen": {
12
+ "path": "cz-conventional-changelog"
13
+ }
14
+ },
15
+ "dependencies": {
16
+ "ky": "^1.2.0",
17
+ "p-limit": "^5.0.0"
18
+ },
11
19
  "description": "Downloads HLS Playlist file and TS chunks",
20
+ "devDependencies": {
21
+ "@commitlint/cli": "^18.4.3",
22
+ "@commitlint/config-conventional": "^18.4.3",
23
+ "@types/jest": "^29.5.11",
24
+ "clean-jsdoc-theme": "^4.2.17",
25
+ "esbuild": "^0.19.9",
26
+ "eslint": "^8.56.0",
27
+ "husky": "^8.0.0",
28
+ "jest": "^29.7.0",
29
+ "jsdoc": "^4.0.2",
30
+ "prettier": "^3.1.1",
31
+ "rimraf": "^5.0.5",
32
+ "semantic-release": "22.0.12"
33
+ },
12
34
  "engines": {
13
35
  "node": ">=18",
14
36
  "npm": ">=9"
15
37
  },
38
+ "exports": {
39
+ "default": "./build/index.js"
40
+ },
41
+ "files": [
42
+ "build"
43
+ ],
16
44
  "homepage": "https://nurrony.github.io/hlsdownloader",
45
+ "hooks": {
46
+ "pre-commit": "npm run commitlint ${1} && npm run lint:fix && npm run lint && npm test"
47
+ },
17
48
  "keywords": [
49
+ "cdn-priming",
50
+ "chunk",
51
+ "download",
52
+ "download-playlists",
53
+ "downloader",
18
54
  "HLS",
55
+ "hlsdownloader",
56
+ "live",
57
+ "livestream",
19
58
  "m3u8",
59
+ "m3u8downloader",
20
60
  "playlist",
21
- "downloader",
22
- "hlsdownloader",
23
- "m3u8downloader"
24
- ],
25
- "files": [
26
- "build"
61
+ "streaming",
62
+ "streaming-video"
27
63
  ],
28
- "main": "./build/index.js",
29
- "exports": {
30
- "default": "./build/index.js"
31
- },
32
64
  "license": "MIT",
65
+ "main": "./build/index.js",
33
66
  "name": "hlsdownloader",
67
+ "release": {
68
+ "branches": [
69
+ "master"
70
+ ],
71
+ "debug": true
72
+ },
34
73
  "repository": {
35
74
  "type": "git+https",
36
75
  "url": "git+https://github.com/nurrony/hlsdownloader.git"
37
76
  },
38
77
  "scripts": {
39
- "semantic-release": "semantic-release",
40
- "prepublishOnly": "npm run build",
41
78
  "build": "npm run lint:fix && npm run lint && npm test && npm run build:clean && npm run compile && echo '📦 Build artifact has been generated successfully.'",
42
- "coverage": "NODE_OPTIONS=--experimental-vm-modules npx jest --coverage",
43
- "prepare": "husky install",
44
79
  "build:clean": "rimraf -fr build && echo '🧹 Build artifacts has been cleaned.'",
80
+ "commitlint": "NODE_OPTIONS=--experimental-vm-modules npx commitlint --edit && echo '🔖 Commit message guidelines are followed properly.'",
45
81
  "compile": "npx esbuild --outdir=build --platform=node --format=esm --target=node18 --packages=external --bundle --minify --tree-shaking=true --keep-names src/index.js",
46
- "docs:gen": "npm run docs:clean && NODE_OPTIONS=--experimental-vm-modules jsdoc -c jsdoc.json && echo '📄 Docs has been generated successfully.'",
82
+ "coverage": "NODE_OPTIONS=--experimental-vm-modules npx jest --coverage",
47
83
  "docs:clean": "rimraf -fr ./docs && echo '🧹 All docs has been cleaned.'",
84
+ "docs:gen": "npm run docs:clean && NODE_OPTIONS=--experimental-vm-modules jsdoc -c jsdoc.json && echo '📄 Docs has been generated successfully.'",
85
+ "example": "NODE_OPTIONS=--experimental-vm-modules node example.mjs",
48
86
  "lint": "eslint . --ext .js && echo '💄 Coding style guideline has been followed properly.'",
49
87
  "lint:fix": "eslint . --ext .js --fix && echo '🔧 Coding style has been fixed as per guideline.'",
88
+ "prepare": "husky install",
89
+ "prepublishOnly": "npm run build",
50
90
  "prod:start": "node index.js",
51
- "test:coverage:clean": "rimraf -fr ./coverage && echo '🧹 All test coverage reports has been cleaned.'",
91
+ "semantic-release": "semantic-release",
52
92
  "test": "npm run test:coverage:clean && NODE_OPTIONS=--experimental-vm-modules npx jest",
53
- "example": "NODE_OPTIONS=--experimental-vm-modules node example.mjs",
93
+ "test:coverage:clean": "rimraf -fr ./coverage && echo '🧹 All test coverage reports has been cleaned.'",
54
94
  "test:watch": "NODE_OPTIONS=--experimental-vm-modules npx jest --no-cache --watch",
55
- "version": "echo $npm_package_version",
56
- "commitlint": "NODE_OPTIONS=--experimental-vm-modules npx commitlint --edit && echo '🔖 Commit message guidelines are followed properly.'"
57
- },
58
- "config": {
59
- "commitizen": {
60
- "path": "cz-conventional-changelog"
61
- }
62
- },
63
- "release": {
64
- "debug": true,
65
- "branches": [
66
- "master"
67
- ]
95
+ "version": "echo $npm_package_version"
68
96
  },
69
- "version": "3.0.1",
70
- "devDependencies": {
71
- "@commitlint/cli": "^18.4.3",
72
- "@commitlint/config-conventional": "^18.4.3",
73
- "@types/jest": "^29.5.11",
74
- "clean-jsdoc-theme": "^4.2.17",
75
- "esbuild": "^0.19.9",
76
- "eslint": "^8.56.0",
77
- "husky": "^8.0.0",
78
- "jest": "^29.7.0",
79
- "jsdoc": "^4.0.2",
80
- "prettier": "^3.1.1",
81
- "rimraf": "^5.0.5",
82
- "semantic-release": "22.0.12"
83
- },
84
- "hooks": {
85
- "pre-commit": "npm run commitlint ${1} && npm run lint:fix && npm run lint && npm test"
86
- },
87
- "dependencies": {
88
- "ky": "^1.1.3",
89
- "p-limit": "^5.0.0"
90
- }
97
+ "snyk": true,
98
+ "type": "module",
99
+ "version": "3.0.3"
91
100
  }