fast-dirpy 0.1.0 → 0.1.2

package/README.md

@@ -6,23 +6,42 @@
 [![JSDocs][jsdocs-src]][jsdocs-href]
 [![License][license-src]][license-href]
 
-A simple library/CLI to download video using `dirpy.com`
+A simple library/CLI to download youtube(etc.) videos.
 
 ## Installation
 
-## As a library
+### As a library
 ```shell
 npm i fast-dirpy
 ```
 
-## As a **command line tool**
+### As a **command line tool**
 ```shell
 npm i fast-dirpy -g
 ```
 
-
 ## Usage
 
+### Config file
+
+> [!IMPORTANT]
+> `fast-dirpy.config` can be `fast-dirpy.config.['ts', 'mts', 'cts', 'js', 'mjs', 'cjs']`
+
+You can create a `fast-dirpy.config.ts` file in your library root or same location in command line.
+
+```ts
+import { defineConfig } from 'fast-dirpy'
+
+export default defineConfig({
+  proxy: {
+    protocol: 'http',
+    host: '127.0.0.1',
+    port: 7890,
+  },
+  timeout: 20000, // request timeout: 20s
+})
+```
+
 ### Use in command line
 
 #### Get Direct Link
@@ -32,13 +51,20 @@ npm i fast-dirpy -g
 # Proxy:
 #   -H, --proxyHost: proxy host
 #   -P, --proxyPort: proxy port
+
 fast-dirpy get https\://www.youtube.com/watch\?v\=SAXpBgkXt60 -H 127.0.0.1 -P 7890
 ```
 
+if you have set your proxy config in `fast-dirpy.config.ts`, you can omit proxy parameters:
+
+```shell
+fast-dirpy get https\://www.youtube.com/watch\?v\=SAXpBgkXt60
+```
+
 #### Download Video
 ```shell
 # get video direct link
-# Path: --path, -P: Downloaded video save path.
+# Path: --path, -p: Downloaded video save path.
 #
 # Proxy:
 #  -H, --proxyHost: proxy host.
@@ -46,27 +72,39 @@ fast-dirpy get https\://www.youtube.com/watch\?v\=SAXpBgkXt60 -H 127.0.0.1 -P 78
 fast-dirpy download https\://www.youtube.com/watch\?v\=SAXpBgkXt60 -p ./test.mp4  -H 127.0.0.1 -P 7890
 ```
 
+if you have set your proxy config in `fast-dirpy.config.ts`, you can omit proxy parameters:
+
+```shell
+fast-dirpy download https\://www.youtube.com/watch\?v\=SAXpBgkXt60 -p ./test.mp4
+```
+
+For further CLI help:
+
+```shell
+fast-dirpy --help
+```
+
 ### Use as a library
 ```ts
-import { getDirectLink, downloadVideoFromRawLink } from "fast-dirpy"
+import { downloadVideoFromRawLink, getDirectLink } from 'fast-dirpy'
 
 // get direct link
 const link = await getDirectLink(
-    "<url>",
-    {
-        host: "127.0.0.1",
-        port: 7890
-    }
+  '<url>',
+  {
+    host: '127.0.0.1',
+    port: 7890
+  }
 )
 
 // download video
-downloadVideoFromRawLink({
-    url,
-    path: "./download.mp4",
-    proxy: {
-        host: "127.0.0.1",
-        port: 7890
-    }
+await downloadVideoFromRawLink({
+  url,
+  path: './download.mp4',
+  proxy: {
+    host: '127.0.0.1',
+    port: 7890
+  }
 })
 ```
 

package/bin/fast-dirpy.js

@@ -1,4 +1,4 @@
 #!/usr/bin/env node
 'use strict'
 
-import '../dist/cli.js'
+import '../dist/cli.js'

package/package.json

@@ -1,18 +1,22 @@
 {
   "name": "fast-dirpy",
-  "version": "0.1.0",
   "type": "module",
+  "version": "0.1.2",
   "description": "A simple library/CLI to download video using dirpy.com",
   "author": "Vincent-the-gamer",
+  "license": "MIT",
+  "homepage": "https://github.com/Vincent-the-gamer/fast-dirpy#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Vincent-the-gamer/fast-dirpy.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Vincent-the-gamer/fast-dirpy/issues"
+  },
+  "sideEffects": false,
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "bin": {
-    "fast-dirpy": "bin/fast-dirpy.js"
-  },
   "typesVersions": {
     "*": {
       ".": [
@@ -21,39 +25,40 @@
       ]
     }
   },
-  "license": "MIT",
-  "homepage": "https://github.com/Vincent-the-gamer/fast-dirpy#readme",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Vincent-the-gamer/fast-dirpy.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Vincent-the-gamer/fast-dirpy/issues"
+  "bin": {
+    "fast-dirpy": "bin/fast-dirpy.js"
   },
+  "files": [
+    "dist"
+  ],
   "publishConfig": {
     "registry": "https://registry.npmjs.com",
     "access": "public"
   },
-  "sideEffects": false,
+  "dependencies": {
+    "axios": "^1.8.4",
+    "cac": "^6.7.14",
+    "jsdom": "^26.0.0",
+    "restore-cursor": "^5.1.0",
+    "unconfig": "^7.3.1"
+  },
   "devDependencies": {
+    "@antfu/eslint-config": "^4.11.0",
     "@types/node": "^22.13.14",
-    "taze": "^19.0.2",
+    "deepmerge": "^4.3.1",
+    "eslint": "^9.23.0",
+    "taze": "^19.0.4",
     "tsup": "^8.4.0",
     "tsx": "^4.19.3",
     "typescript": "^5.8.2",
     "vitest": "^3.0.9"
   },
-  "dependencies": {
-    "axios": "^1.8.4",
-    "cac": "^6.7.14",
-    "jsdom": "^26.0.0",
-    "restore-cursor": "^5.1.0"
-  },
   "scripts": {
     "tsx": "tsx",
     "build": "tsup",
     "test": "vitest",
     "dep": "taze major",
+    "lint:fix": "eslint . --fix",
     "login": "pnpm login --registry https://registry.npmjs.com"
   }
 }

package/dist/chunk-KX4T6SEL.js

@@ -1,2 +0,0 @@
-import p from"axios";import f from"jsdom";import y from"fs";function c(o){return o?.host&&o.port?{protocol:"http",host:o?.host,port:o?.port}:void 0}var{JSDOM:w}=f;async function h(o,r){let t=c(r||{}),{data:n}=await p.get("https://dirpy.com/studio",{params:{url:encodeURIComponent(o)},headers:{"User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.0.0 Safari/537.36"},proxy:t,timeout:3e4}),{window:e}=new w(n),{src:s}=e.document.getElementById("media-source");return s}async function x(o){let{proxy:r,path:t,url:n}=o,e=c(r||{}),s=y.createWriteStream(t);return(await p({url:n,method:"GET",responseType:"stream",proxy:e,onDownloadProgress:i=>{let{loaded:a,total:d,progress:m}=i,l=`loaded:${a}  total: ${d}  progress: ${(m*100).toFixed(2)}%
-`;console.log(l)}})).data.pipe(s),new Promise((i,a)=>{s.on("finish",i),s.on("error",a)})}async function S(o){let{proxy:r,path:t,url:n}=o,e=await h(n,r);await x({url:e,path:t,proxy:r})}export{h as a,S as b};

package/dist/cli.d.ts

@@ -1,2 +0,0 @@
-
-export {  }

package/dist/cli.js

@@ -1 +0,0 @@
-import{a as i,b as r}from"./chunk-KX4T6SEL.js";import{cac as a}from"cac";var p={name:"fast-dirpy",version:"0.1.0",type:"module",description:"A simple library/CLI to download video using dirpy.com",author:"Vincent-the-gamer",main:"dist/index.js",module:"dist/index.js",types:"dist/index.d.ts",files:["dist"],bin:{"fast-dirpy":"bin/fast-dirpy.js"},typesVersions:{"*":{".":["./dist/index.d.ts","./dist/cli.d.ts"]}},scripts:{tsx:"tsx",build:"tsup",test:"vitest",dep:"taze major",login:"pnpm login --registry https://registry.npmjs.com"},license:"MIT",homepage:"https://github.com/Vincent-the-gamer/fast-dirpy#readme",repository:{type:"git",url:"git+https://github.com/Vincent-the-gamer/fast-dirpy.git"},bugs:{url:"https://github.com/Vincent-the-gamer/fast-dirpy/issues"},publishConfig:{registry:"https://registry.npmjs.com",access:"public"},sideEffects:!1,devDependencies:{"@types/node":"^22.13.14",taze:"^19.0.2",tsup:"^8.4.0",tsx:"^4.19.3",typescript:"^5.8.2",vitest:"^3.0.9"},dependencies:{axios:"^1.8.4",cac:"^6.7.14",jsdom:"^26.0.0","restore-cursor":"^5.1.0"}};import c from"restore-cursor";var o=a("fast-dirpy");o.command("get <url>","get video direct link.").option("--proxyHost, -H <proxyHost>","Proxy host.").option("--proxyPort, -P <proxyPort>","Proxy port.").action(async(s,t)=>{let e=await i(s,{host:t.proxyHost||null,port:t.proxyPort||null});console.log(e)});o.command("download <url>","download a video.").option("--path, -p <path>","Download destination path + filename. e.g. /xxx/example.mp4.").option("--proxyHost, -H <proxyHost>","Proxy host.").option("--proxyPort, -P <proxyPort>","Proxy port.").action(async(s,t)=>{let e=t.proxyHost||null,n=t.proxyPort||null;r({url:s,path:t.path||"./download.mp4",proxy:{host:e,port:n}})});o.help();o.version(p.version);o.parse();c();

package/dist/index.d.ts

@@ -1,10 +0,0 @@
-declare function getDirectLink(url: string, proxy?: Record<string, any>): Promise<string>;
-interface DownloadParams {
-    url: string;
-    path: string;
-    puppeteer?: boolean;
-    proxy?: Record<string, any>;
-}
-declare function downloadVideoFromRawLink(params: DownloadParams): Promise<void>;
-
-export { downloadVideoFromRawLink, getDirectLink };

package/dist/index.js

@@ -1 +0,0 @@
-import{a as o,b as r}from"./chunk-KX4T6SEL.js";export{r as downloadVideoFromRawLink,o as getDirectLink};