feat: new download engine (#4)

* feat: pausing and resuming downloads (even after sudden failure, without any corruption)
* feat: browser support using the (fetch and xhr API)
* feat: download statistics (speed, time left, etc.)
* feat: better CLI Progress bar (Node.js & Bun)
* feat: smart retry on fail (using async-retry)

BREAKING CHANGE: New API, Support for browser download
The new version has tests, better documentation, simpler API and many more customizations

.config/typedoc.json

@@ -1,11 +1,15 @@
 {
     "$schema": "https://typedoc.org/schema.json",
     "entryPoints": [
+        "../src/browser.ts",
         "../src/index.ts"
     ],
     "out": "../docs",
     "tsconfig": "../tsconfig.json",
-    "customCss": "./typedoc.css",
+    "plugin": [
+        "typedoc-material-theme",
+        "typedoc-plugin-missing-exports"
+    ],
     "readme": "../README.md",
     "excludeExternals": true,
     "excludeInternal": true,

.eslintrc.json

@@ -2,14 +2,16 @@
     "root": true,
     "env": {
         "node": true,
-        "browser": false,
+        "browser": true,
         "es6": true
     },
     "ignorePatterns": [
-        "/dist"
+        "/dist",
+        "/docs"
     ],
     "extends": [
-        "eslint:recommended"
+        "eslint:recommended",
+        "plugin:jsdoc/recommended"
     ],
     "globals": {
         "Atomics": "readonly",
@@ -29,13 +31,15 @@
             ],
             "extends": [
                 "eslint:recommended",
-                "plugin:@typescript-eslint/recommended"
+                "plugin:@typescript-eslint/recommended",
+                "plugin:jsdoc/recommended-typescript"
             ],
             "parser": "@typescript-eslint/parser",
             "plugins": [
                 "@typescript-eslint",
                 "import",
-                "node"
+                "jsdoc",
+                "n"
             ],
             "rules": {
                 "@typescript-eslint/explicit-module-boundary-types": [
@@ -56,20 +60,58 @@
                 ],
                 "@typescript-eslint/no-inferrable-types": [
                     "off"
+                ],
+                "jsdoc/require-param": [
+                    "off"
+                ],
+                "jsdoc/check-param-names": [
+                    "warn",
+                    {
+                        "checkDestructured": false
+                    }
+                ],
+                "jsdoc/require-returns": [
+                    "off"
+                ],
+                "jsdoc/require-jsdoc": [
+                    "off"
+                ],
+                "jsdoc/require-yields": [
+                    "off"
+                ],
+                "jsdoc/require-param-description": [
+                    "off"
                 ]
             }
+        },
+        {
+            "files": [
+                "test/**/**.ts"
+            ],
+            "rules": {
+                "max-len": [
+                    "off"
+                ]
+        }
         }
     ],
     "plugins": [
         "@typescript-eslint",
         "import",
-        "node"
+        "jsdoc",
+        "n"
     ],
     "settings": {
         "import/parsers": {
             "@typescript-eslint/parser": [
                 ".ts"
             ]
+        },
+        "jsdoc": {
+            "exemptDestructuredRootsFromChecks": true,
+            "tagNamePreference": {
+                "hidden": "hidden"
+            }
         }
     },
     "rules": {
@@ -162,15 +204,9 @@
                 "warnOnUnassignedImports": true
             }
         ],
-        "node/file-extension-in-import": [
+        "n/file-extension-in-import": [
             "error",
-            "always",
-            {
-                "tryExtensions": [
-                    ".js",
-                    ".json"
-                ]
-            }
+            "always"
         ],
         "newline-per-chained-call": [
             "error",
@@ -209,16 +245,6 @@
         "array-callback-return": [
             "error"
         ],
-        "valid-jsdoc": [
-            "error",
-            {
-                "requireParamType": true,
-                "requireReturnType": true,
-                "requireReturn": false,
-                "requireParamDescription": false,
-                "requireReturnDescription": false
-            }
-        ],
         "no-empty": [
             "error",
             {

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: ido-pluto

.github/PULL_REQUEST_TEMPLATE.md

@@ -23,8 +23,10 @@
 -->
 
 - [ ] Code is up-to-date with the `main` branch
-- [ ] `npm run format` to apply prettier formatting
+- [ ] `npm run format` to apply eslint formatting
+- [ ] `npm run test` passes with this change
 - [ ] This pull request links relevant issues as `Fixes #0000`
+- [ ] There are new or updated unit tests validating the change
 - [ ] Documentation has been updated to reflect this change
 - [ ] The new commits follow conventions explained
-  in [CONTRIBUTING.md](https://github.com/ido-pluto/pull/blob/main/CONTRIBUTING.md)
+  in [CONTRIBUTING.md](https://github.com/ido-pluto/ipull/blob/main/CONTRIBUTING.md)

.github/workflows/test.yml

@@ -11,6 +11,8 @@ jobs:
       - name: Install modules
         run: npm ci --ignore-scripts
       - name: ESLint
-        run: npx eslint --ext .js --ext .ts .
+        run: npm run lint
       - name: TypeScript validity
-        run: npm run test:typescript
+        run: npm run build
+      - name: Run Tests
+        run: npm run test