yuque-dl 1.0.24 → 1.0.26

package/README.md

@@ -2,7 +2,7 @@
 
 语雀知识库下载为本地markdown
 
-![header](https://socialify.git.ci/gxr404/yuque-dl/image?description=1&descriptionEditable=%E8%AF%AD%E9%9B%80%E7%9F%A5%E8%AF%86%E5%BA%93%E4%B8%8B%E8%BD%BD&issues=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2Fgxr404%2Fyuque-dl%2Fmain%2Fassets%2Flogo.png&name=1&pattern=Circuit%20Board&pulls=1&stargazers=1&theme=Light)
+![header](https://socialify.git.ci/gxr404/yuque-dl/image?description=1&descriptionEditable=%E8%AF%AD%E9%9B%80%E7%9F%A5%E8%AF%86%E5%BA%93%E4%B8%8B%E8%BD%BD&issues=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2Fgxr404%2Fyuque-dl%2Fmain%2Fdocs%2Fassets%2Flogo.png&name=1&pattern=Circuit%20Board&pulls=1&stargazers=1&theme=Light)
 
 ## Install
 
@@ -27,7 +27,8 @@ $ yuque-dl --help
   Options:
     -d, --distDir <dir>  下载的目录 eg: -d download (default: download)
     -i, --ignoreImg      忽略图片不下载 (default: false)
-    -t, --token <token>  语雀的cookie "_yuque_session (default: )
+    -k, --key <key>      指定语雀的 cookie key，默认是 "_yuque_session"
+    -t, --token <token>  语雀的cookie key 对应的值
     -h, --help           Display this message
     -v, --version        Display version number
 ```
@@ -41,7 +42,7 @@ yuque-dl "https://www.yuque.com/yuque/thyzgp"
 
 ## Example
 
-![demo](./assets/demo.gif)
+![demo](./docs/assets/demo.gif)
 
 ## 私有知识库
 
@@ -51,7 +52,15 @@ yuque-dl "https://www.yuque.com/yuque/thyzgp"
 yuque-dl "https://www.yuque.com/yuque/thyzgp" -t "abcd..."
 ```
 
-[token的获取请看](./GET_TOEKN.md)
+[token的获取请看](./docs/GET_TOEKN.md)
+
+## 企业私有服务
+
+企业服务有自己的域名(黄色语雀logo)，非`yuque.com`结尾, 如`https://yuque.antfin.com/r/zone`
+
+这种情况 token的key不唯一, 不一定是为`_yuque_session` 需用户使用 `-v` 指定 token的key,`-t` 指定 token的值。
+
+至于`key`具体是什么只能靠用户自己在 `浏览器Devtools-> Application -> Cookies` 里找了🤔
 
 ## Feature
 

package/dist/cjs/cli.js

@@ -1 +1 @@
-"use strict";var e=require("node:fs"),r=require("cac"),o=require("./index-852c3568.js");require("node:fs/promises"),require("pull-md-img"),require("ora"),require("cli-progress"),require("log4js"),require("axios"),require("rand-user-agent");var n="undefined"!=typeof document?document.currentScript:null;const i=r.cac("yuque-dl"),{version:t}=JSON.parse(e.readFileSync(new URL("../../package.json","undefined"==typeof document?require("url").pathToFileURL(__filename).href:n&&n.src||new URL("cli.js",document.baseURI).href)).toString());i.command("<url>","语雀知识库url").option("-d, --distDir <dir>","下载的目录 eg: -d download",{default:"download"}).option("-i, --ignoreImg","忽略图片不下载",{default:!1}).option("-t, --token <token>",'语雀的cookie "_yuque_session"').action((async(e,r)=>{try{await o.main(e,r)}catch(e){o.logger.error(e.message||"unknown exception")}})),i.help(),i.version(t);try{i.parse()}catch(e){o.logger.error(e.message||"unknown exception"),process.exit(1)}
+"use strict";var e=require("node:fs"),r=require("cac"),o=require("./index-87c3a8dd.js");require("node:fs/promises"),require("pull-md-img"),require("ora"),require("cli-progress"),require("log4js"),require("axios"),require("rand-user-agent");var n="undefined"!=typeof document?document.currentScript:null;const i=r.cac("yuque-dl"),{version:t}=JSON.parse(e.readFileSync(new URL("../../package.json","undefined"==typeof document?require("url").pathToFileURL(__filename).href:n&&n.src||new URL("cli.js",document.baseURI).href)).toString());i.command("<url>","语雀知识库url").option("-d, --distDir <dir>","下载的目录 eg: -d download",{default:"download"}).option("-i, --ignoreImg","忽略图片不下载",{default:!1}).option("-k, --key <key>",'语雀的cookie key， 默认是 "_yuque_session"， 在某些企业版本中 key 不一样').option("-t, --token <token>","语雀的cookie key 对应的值").action((async(e,r)=>{try{await o.main(e,r)}catch(e){o.logger.error(e.message||"unknown exception")}})),i.help(),i.version(t);try{i.parse()}catch(e){o.logger.error(e.message||"unknown exception"),process.exit(1)}

package/dist/cjs/index-87c3a8dd.js

@@ -0,0 +1 @@
+"use strict";var e=require("node:fs/promises"),t=require("pull-md-img"),r=require("ora"),o=require("cli-progress"),s=require("log4js"),i=require("axios"),n=require("rand-user-agent");var a,c,l=(s.configure({appenders:{cheese:{type:"console",layout:{type:"pattern",pattern:"%[%c [%p]:%] %m%n"}}},categories:{default:{appenders:["cheese"],level:"trace"}}}),s.getLogger("yuque-dl"));class u{constructor(e,t){this.bookPath="",this.progressFilePath="",this.progressInfo=[],this.curr=0,this.total=0,this.isDownloadInterrupted=!1,this.bar=null,this.completePromise=null,this.bookPath=e,this.progressFilePath=`${e}/progress.json`,this.total=t}async init(){this.progressInfo=await this.getProgress(),this.curr=this.progressInfo.length,this.curr!==this.total&&(this.curr>0&&this.curr!==this.total&&(this.isDownloadInterrupted=!0,l.info("根据上次数据继续断点下载")),this.bar=new o.SingleBar({format:"Download [{bar}] {percentage}% | {value}/{total}"},o.Presets.legacy),this.bar.start(this.total,this.curr))}async getProgress(){let t=[];try{const r=await e.readFile(this.progressFilePath,{encoding:"utf8"});t=JSON.parse(r)}catch(r){r&&"ENOENT"===r.code&&await e.writeFile(this.progressFilePath,JSON.stringify(t),{encoding:"utf8"})}return t}async updateProgress(t,r){this.curr=this.curr+1,r&&(this.progressInfo.push(t),await e.writeFile(this.progressFilePath,JSON.stringify(this.progressInfo),{encoding:"utf8"})),this.bar&&(this.bar.update(this.curr),this.curr>=this.total&&(this.bar.stop(),console.log("")))}pause(){this.bar&&this.bar.stop()}continue(){this.clearLine(2),this.bar?.start(this.total,this.curr)}clearLine(e){if(!(e<=0)&&"function"==typeof process?.stderr?.cursorTo){process.stderr.cursorTo(0);for(let t=0;t<e;t++)process.stderr.moveCursor(0,-1),process.stderr.clearLine(1)}}}class h{constructor(e){this.summaryInfo=e}async genFile(){const{bookName:t,bookDesc:r,bookPath:o,uuidMap:s}=this.summaryInfo;let i=`# ${t}\n\n`;r&&(i+=`> ${r}\n\n`);let n=i;const a=[];s.forEach((e=>{const t=e.toc,r=t.parent_uuid,o=this.findTree(a,r),s={text:t.title.replace(/[\\/:*?"<>|\n\r]/g,"_").replace(/\s/,""),id:t.uuid,level:1,type:""},i=t.type.toLocaleLowerCase();"title"===i||""!==t.child_uuid?(s.type="title","boolean"!=typeof o?(Array.isArray(o.children)||(o.children=[]),s.level=o.level+1,o.children.push(s)):(s.level=1,a.push(s))):(s.type="link",s.link="link"===i?e.toc.url:e.path,"boolean"!=typeof o?(Array.isArray(o.children)||(o.children=[]),s.level=o.level+1,o.children.push(s)):(s.level=1,a.push(s)))}));n+=this.genSummaryContent(a,"");try{await e.writeFile(`${o}/SUMMARY.md`,n)}catch(e){l.error("Generate Summary Error")}}genSummaryContent(e,t){for(const r of e){if("title"===r.type)t+=`\n${"".padStart(r.level+1,"#")} ${r.text}\n\n`;else if("link"===r.type){const e=r.link?r.link.replace(/\s/g,"%20"):r.link;t+=`- [${r.text}](${e})\n`}Array.isArray(r.children)&&(t+=this.genSummaryContent(r.children,""))}return t}findIdItem(e,t){if(e.id===t)return e;if(e.children){const r=this.findTree(e.children,t);if(r)return r}return!1}findTree(e,t){if(!t)return!1;for(const r of e){const e=this.findIdItem(r,t);if(e)return e}return!1}}!function(e){e.TITLE="title",e.LINK="link",e.DOC="doc"}(a||(a={})),function(e){e.BOARD="board",e.TABLE="table",e.SHEET="sheet",e.DOC="doc"}(c||(c={}));const d=new Map([[c.BOARD,"画板类型"],[c.TABLE,"数据表类型"],[c.SHEET,"表格类型"],[c.DOC,"文档类型"]]),p="_yuque_session",g="https://www.yuque.com";function f({browser:e="chrome",os:t="mac os",device:r="desktop"}){r=r.toLowerCase(),e=e.toLowerCase(),t=t.toLowerCase();let o=n(r,e,t);if("chrome"===e)for(;o.includes("Chrome-Lighthouse")||o.includes("Gener8")||o.includes("HeadlessChrome")||o.includes("SMTBot");)o=n(r,e,t);if("safari"===e)for(;o.includes("Applebot");)o=n(r,e,t);return o}function w(e){const{key:t=p,token:r}=e,o={"user-agent":f({browser:"chrome",device:"desktop"})};return r&&(o.cookie=`${t}=${r};`),o}function k(e){return{headers:w(e),beforeRedirect:t=>{t.headers={...t?.headers||{},...w(e)}}}}const m=e=>{const{articleUrl:t,bookId:r,token:o,key:s,host:n=g}=e;let a=`${n}/api/docs/${t}`;const c={book_id:String(r),merge_dynamic_data:String(!1),mode:"markdown"},l=new URLSearchParams(c).toString();return a=`${a}?${l}`,i.get(a,k({token:o,key:s})).then((({data:e,status:t})=>({apiUrl:a,httpStatus:t,response:e})))};async function y(o){const{articleInfo:s,progressBar:i,token:n,key:a}=o,{bookId:l,itemUrl:u,savePath:h,saveFilePath:p,uuid:g,articleUrl:f,articleTitle:w,ignoreImg:k,host:y}=s,{httpStatus:b,apiUrl:$,response:I}=await m({articleUrl:u,bookId:l,token:n,host:y,key:a}),L=I?.data?.type?.toLocaleLowerCase();if([c.BOARD,c.SHEET,c.TABLE].includes(L)){const e=d.get(L);throw new Error(`download article Error: 暂不支持“${e}”的文档`)}if("string"!=typeof I?.data?.sourcecode)throw new Error(`download article Error: ${$}, http status ${b}`);let E=I.data.sourcecode;if(!k){i.pause(),console.log("");const e=r({text:`下载 "${w}" 的图片中...`});e.start();try{E=await t.run(E,{dist:h,imgDir:`./img/${g}`,isIgnoreConsole:!0})}catch(e){let t=`download article image Error: ${e.message}`;throw e.error&&e.url&&(t=`download article image Error ${e.url}: ${e.error?.message}`),new Error(t)}finally{e.stop(),i.continue()}}E=E.replace(/<br(\s?)\/>/gm,"\n"),w&&(E=`# ${w}\n\x3c!--page header--\x3e\n\n${E}\n\n`),f&&(E+=`\x3c!--page footer--\x3e\n- 原文: <${f}>`);try{return await e.writeFile(p,E),!0}catch(e){throw new Error(`download article Error ${f}: ${e.message}`)}}function b(e){if(!e)return"";return e.replace(/[\\/:*?"<>|\n\r]/g,"_").replace(/\s/g,"")}exports.downloadArticle=y,exports.logger=l,exports.main=async function(t,r){const{bookId:o,tocList:s,bookName:n,bookDesc:c,bookSlug:d,host:p}=await((e,t)=>{const r=/decodeURIComponent\("(.+)"\)\);/m;return i.get(e,k(t)).then((({data:e="",status:t})=>200===t?e:"")).then((e=>{const t=r.exec(e)??"";if(!t[1])return{};const o=JSON.parse(decodeURIComponent(t[1]));return o.book?{bookId:o.book.id,bookSlug:o.book.slug,tocList:o.book.toc||[],bookName:o.book.name||"",bookDesc:o.book.description||"",host:o.space?.host||g}:{}}))})(t,{token:r.token,key:r.key});if(!o)throw new Error("No found book id");if(!s||0===s.length)throw new Error("No found toc list");const f=`${r.distDir}/${n?b(n):o}`;await e.mkdir(f,{recursive:!0});const w=s.length,m=new u(f,w);if(await m.init(),m.curr===w)return m.bar&&m.bar.stop(),void l.info(`√ 已完成: ${process.cwd()}/${f}`);const $=new Map;m.isDownloadInterrupted&&m.progressInfo.forEach((e=>{$.set(e.toc.uuid,e)}));const I=t.replace(new RegExp(`(.*?/${d}).*`),"$1");await async function(t){const{articleUrlPrefix:r,total:o,uuidMap:s,tocList:i,bookPath:n,bookId:c,progressBar:u,host:h,options:d}=t;let p=0,g=0,f=0;const w=[],k=[];for(let t=0;t<o;t++){const o=i[t];if("string"!=typeof o.type)continue;if(s.get(o.uuid))continue;const l=o.type.toLocaleLowerCase();if(l===a.TITLE||""!==o.child_uuid||l===a.LINK){let t=o;const r=[],i=[];for(;t;)r.unshift(b(t.title)),i.unshift(t.uuid),t=s.get(t.parent_uuid)?s.get(t.parent_uuid).toc:void 0;const c={path:r.join("/"),pathTitleList:r,pathIdList:i,toc:o};l===a.LINK?(f+=1,k.push(c)):await e.mkdir(`${n}/${r.join("/")}`,{recursive:!0}),s.set(o.uuid,c),await u.updateProgress(c,l!==a.LINK)}else if(o.url){g+=1;let e={path:"",pathTitleList:[],pathIdList:[]};s.get(o.parent_uuid)&&(e=s.get(o.parent_uuid));const t=b(o.title),i=[...e.pathTitleList,`${t}.md`],a=[...e.pathIdList,o.uuid],l={path:i.join("/"),pathTitleList:i,pathIdList:a,toc:o};let f=!0;const k=`${r}/${o.url}`;try{const t={bookId:c,itemUrl:o.url,savePath:`${n}/${e.path}`,saveFilePath:`${n}/${l.path}`,uuid:o.uuid,articleUrl:k,articleTitle:o.title,ignoreImg:d.ignoreImg,host:h};await y({articleInfo:t,progressBar:u,token:d.token,key:d.key})}catch(e){f=!1,p+=1,w.push({articleUrl:k,errItem:l,errMsg:e.message,err:e})}s.set(o.uuid,l),await u.updateProgress(l,f)}}if(f>0){l.warn("该知识库存在以下外链文章");for(const e of k)l.warn(`———— ✕ ${e.path} ${e.toc.url}`)}if(p>0){l.error(`本次执行总数${g}篇，✕ 失败${p}篇`);for(const e of w)l.error(`${e.errItem.path} ———— ${e.articleUrl}`),l.error(`———— ✕ ${e.errMsg}`);l.error("o(╥﹏╥)o 由于网络波动或链接失效以上下载失败，可重新执行命令重试(PS:不会影响已下载成功的数据)")}}({articleUrlPrefix:I,total:w,uuidMap:$,tocList:s,bookPath:f,bookId:o,progressBar:m,host:p,options:r});const L=new h({bookPath:f,bookName:n,bookDesc:c,uuidMap:$});await L.genFile();const E=process.cwd();l.info(`√ 生成目录 ${E}/${f}/SUMMARY.md`),m.curr===w&&l.info(`√ 已完成: ${E}/${f}`),process.exit(0)};

package/dist/cjs/index.js

@@ -1 +1 @@
-"use strict";require("node:fs/promises"),require("pull-md-img"),require("ora");var r=require("./index-852c3568.js");require("cli-progress"),require("log4js"),require("axios"),require("rand-user-agent"),exports.downloadArticle=r.downloadArticle,exports.main=r.main;
+"use strict";require("node:fs/promises"),require("pull-md-img"),require("ora");var r=require("./index-87c3a8dd.js");require("cli-progress"),require("log4js"),require("axios"),require("rand-user-agent"),exports.downloadArticle=r.downloadArticle,exports.main=r.main;

package/dist/es/cli.js

@@ -1 +1 @@
-import{readFileSync as o}from"node:fs";import{cac as r}from"cac";import{m as e,l as i}from"./index-16978a9a.js";import"node:fs/promises";import"pull-md-img";import"ora";import"cli-progress";import"log4js";import"axios";import"rand-user-agent";const t=r("yuque-dl"),{version:n}=JSON.parse(o(new URL("../../package.json",import.meta.url)).toString());t.command("<url>","语雀知识库url").option("-d, --distDir <dir>","下载的目录 eg: -d download",{default:"download"}).option("-i, --ignoreImg","忽略图片不下载",{default:!1}).option("-t, --token <token>",'语雀的cookie "_yuque_session"').action((async(o,r)=>{try{await e(o,r)}catch(o){i.error(o.message||"unknown exception")}})),t.help(),t.version(n);try{t.parse()}catch(o){i.error(o.message||"unknown exception"),process.exit(1)}
+import{readFileSync as o}from"node:fs";import{cac as e}from"cac";import{m as r,l as i}from"./index-0527d511.js";import"node:fs/promises";import"pull-md-img";import"ora";import"cli-progress";import"log4js";import"axios";import"rand-user-agent";const t=e("yuque-dl"),{version:n}=JSON.parse(o(new URL("../../package.json",import.meta.url)).toString());t.command("<url>","语雀知识库url").option("-d, --distDir <dir>","下载的目录 eg: -d download",{default:"download"}).option("-i, --ignoreImg","忽略图片不下载",{default:!1}).option("-k, --key <key>",'语雀的cookie key， 默认是 "_yuque_session"， 在某些企业版本中 key 不一样').option("-t, --token <token>","语雀的cookie key 对应的值").action((async(o,e)=>{try{await r(o,e)}catch(o){i.error(o.message||"unknown exception")}})),t.help(),t.version(n);try{t.parse()}catch(o){i.error(o.message||"unknown exception"),process.exit(1)}

package/dist/es/index-0527d511.js

@@ -0,0 +1 @@
+import t,{writeFile as e,mkdir as r}from"node:fs/promises";import o from"pull-md-img";import s from"ora";import i from"cli-progress";import n from"log4js";import a from"axios";import c from"rand-user-agent";var l,u,h=(n.configure({appenders:{cheese:{type:"console",layout:{type:"pattern",pattern:"%[%c [%p]:%] %m%n"}}},categories:{default:{appenders:["cheese"],level:"trace"}}}),n.getLogger("yuque-dl"));class d{constructor(t,e){this.bookPath="",this.progressFilePath="",this.progressInfo=[],this.curr=0,this.total=0,this.isDownloadInterrupted=!1,this.bar=null,this.completePromise=null,this.bookPath=t,this.progressFilePath=`${t}/progress.json`,this.total=e}async init(){this.progressInfo=await this.getProgress(),this.curr=this.progressInfo.length,this.curr!==this.total&&(this.curr>0&&this.curr!==this.total&&(this.isDownloadInterrupted=!0,h.info("根据上次数据继续断点下载")),this.bar=new i.SingleBar({format:"Download [{bar}] {percentage}% | {value}/{total}"},i.Presets.legacy),this.bar.start(this.total,this.curr))}async getProgress(){let e=[];try{const r=await t.readFile(this.progressFilePath,{encoding:"utf8"});e=JSON.parse(r)}catch(r){r&&"ENOENT"===r.code&&await t.writeFile(this.progressFilePath,JSON.stringify(e),{encoding:"utf8"})}return e}async updateProgress(e,r){this.curr=this.curr+1,r&&(this.progressInfo.push(e),await t.writeFile(this.progressFilePath,JSON.stringify(this.progressInfo),{encoding:"utf8"})),this.bar&&(this.bar.update(this.curr),this.curr>=this.total&&(this.bar.stop(),console.log("")))}pause(){this.bar&&this.bar.stop()}continue(){this.clearLine(2),this.bar?.start(this.total,this.curr)}clearLine(t){if(!(t<=0)&&"function"==typeof process?.stderr?.cursorTo){process.stderr.cursorTo(0);for(let e=0;e<t;e++)process.stderr.moveCursor(0,-1),process.stderr.clearLine(1)}}}class p{constructor(t){this.summaryInfo=t}async genFile(){const{bookName:e,bookDesc:r,bookPath:o,uuidMap:s}=this.summaryInfo;let i=`# ${e}\n\n`;r&&(i+=`> ${r}\n\n`);let n=i;const a=[];s.forEach((t=>{const e=t.toc,r=e.parent_uuid,o=this.findTree(a,r),s={text:e.title.replace(/[\\/:*?"<>|\n\r]/g,"_").replace(/\s/,""),id:e.uuid,level:1,type:""},i=e.type.toLocaleLowerCase();"title"===i||""!==e.child_uuid?(s.type="title","boolean"!=typeof o?(Array.isArray(o.children)||(o.children=[]),s.level=o.level+1,o.children.push(s)):(s.level=1,a.push(s))):(s.type="link",s.link="link"===i?t.toc.url:t.path,"boolean"!=typeof o?(Array.isArray(o.children)||(o.children=[]),s.level=o.level+1,o.children.push(s)):(s.level=1,a.push(s)))}));n+=this.genSummaryContent(a,"");try{await t.writeFile(`${o}/SUMMARY.md`,n)}catch(t){h.error("Generate Summary Error")}}genSummaryContent(t,e){for(const r of t){if("title"===r.type)e+=`\n${"".padStart(r.level+1,"#")} ${r.text}\n\n`;else if("link"===r.type){const t=r.link?r.link.replace(/\s/g,"%20"):r.link;e+=`- [${r.text}](${t})\n`}Array.isArray(r.children)&&(e+=this.genSummaryContent(r.children,""))}return e}findIdItem(t,e){if(t.id===e)return t;if(t.children){const r=this.findTree(t.children,e);if(r)return r}return!1}findTree(t,e){if(!e)return!1;for(const r of t){const t=this.findIdItem(r,e);if(t)return t}return!1}}!function(t){t.TITLE="title",t.LINK="link",t.DOC="doc"}(l||(l={})),function(t){t.BOARD="board",t.TABLE="table",t.SHEET="sheet",t.DOC="doc"}(u||(u={}));const f=new Map([[u.BOARD,"画板类型"],[u.TABLE,"数据表类型"],[u.SHEET,"表格类型"],[u.DOC,"文档类型"]]),g="_yuque_session",m="https://www.yuque.com";function w({browser:t="chrome",os:e="mac os",device:r="desktop"}){r=r.toLowerCase(),t=t.toLowerCase(),e=e.toLowerCase();let o=c(r,t,e);if("chrome"===t)for(;o.includes("Chrome-Lighthouse")||o.includes("Gener8")||o.includes("HeadlessChrome")||o.includes("SMTBot");)o=c(r,t,e);if("safari"===t)for(;o.includes("Applebot");)o=c(r,t,e);return o}function k(t){const{key:e=g,token:r}=t,o={"user-agent":w({browser:"chrome",device:"desktop"})};return r&&(o.cookie=`${e}=${r};`),o}function y(t){return{headers:k(t),beforeRedirect:e=>{e.headers={...e?.headers||{},...k(t)}}}}const b=t=>{const{articleUrl:e,bookId:r,token:o,key:s,host:i=m}=t;let n=`${i}/api/docs/${e}`;const c={book_id:String(r),merge_dynamic_data:String(!1),mode:"markdown"},l=new URLSearchParams(c).toString();return n=`${n}?${l}`,a.get(n,y({token:o,key:s})).then((({data:t,status:e})=>({apiUrl:n,httpStatus:e,response:t})))};async function $(t){const{articleInfo:r,progressBar:i,token:n,key:a}=t,{bookId:c,itemUrl:l,savePath:h,saveFilePath:d,uuid:p,articleUrl:g,articleTitle:m,ignoreImg:w,host:k}=r,{httpStatus:y,apiUrl:$,response:I}=await b({articleUrl:l,bookId:c,token:n,host:k,key:a}),L=I?.data?.type?.toLocaleLowerCase();if([u.BOARD,u.SHEET,u.TABLE].includes(L)){const t=f.get(L);throw new Error(`download article Error: 暂不支持“${t}”的文档`)}if("string"!=typeof I?.data?.sourcecode)throw new Error(`download article Error: ${$}, http status ${y}`);let E=I.data.sourcecode;if(!w){i.pause(),console.log("");const t=s({text:`下载 "${m}" 的图片中...`});t.start();try{E=await o.run(E,{dist:h,imgDir:`./img/${p}`,isIgnoreConsole:!0})}catch(t){let e=`download article image Error: ${t.message}`;throw t.error&&t.url&&(e=`download article image Error ${t.url}: ${t.error?.message}`),new Error(e)}finally{t.stop(),i.continue()}}E=E.replace(/<br(\s?)\/>/gm,"\n"),m&&(E=`# ${m}\n\x3c!--page header--\x3e\n\n${E}\n\n`),g&&(E+=`\x3c!--page footer--\x3e\n- 原文: <${g}>`);try{return await e(d,E),!0}catch(t){throw new Error(`download article Error ${g}: ${t.message}`)}}function I(t){if(!t)return"";return t.replace(/[\\/:*?"<>|\n\r]/g,"_").replace(/\s/g,"")}async function L(t,e){const{bookId:o,tocList:s,bookName:i,bookDesc:n,bookSlug:c,host:u}=await((t,e)=>{const r=/decodeURIComponent\("(.+)"\)\);/m;return a.get(t,y(e)).then((({data:t="",status:e})=>200===e?t:"")).then((t=>{const e=r.exec(t)??"";if(!e[1])return{};const o=JSON.parse(decodeURIComponent(e[1]));return o.book?{bookId:o.book.id,bookSlug:o.book.slug,tocList:o.book.toc||[],bookName:o.book.name||"",bookDesc:o.book.description||"",host:o.space?.host||m}:{}}))})(t,{token:e.token,key:e.key});if(!o)throw new Error("No found book id");if(!s||0===s.length)throw new Error("No found toc list");const f=`${e.distDir}/${i?I(i):o}`;await r(f,{recursive:!0});const g=s.length,w=new d(f,g);if(await w.init(),w.curr===g)return w.bar&&w.bar.stop(),void h.info(`√ 已完成: ${process.cwd()}/${f}`);const k=new Map;w.isDownloadInterrupted&&w.progressInfo.forEach((t=>{k.set(t.toc.uuid,t)}));const b=t.replace(new RegExp(`(.*?/${c}).*`),"$1");await async function(t){const{articleUrlPrefix:e,total:o,uuidMap:s,tocList:i,bookPath:n,bookId:a,progressBar:c,host:u,options:d}=t;let p=0,f=0,g=0;const m=[],w=[];for(let t=0;t<o;t++){const o=i[t];if("string"!=typeof o.type)continue;if(s.get(o.uuid))continue;const h=o.type.toLocaleLowerCase();if(h===l.TITLE||""!==o.child_uuid||h===l.LINK){let t=o;const e=[],i=[];for(;t;)e.unshift(I(t.title)),i.unshift(t.uuid),t=s.get(t.parent_uuid)?s.get(t.parent_uuid).toc:void 0;const a={path:e.join("/"),pathTitleList:e,pathIdList:i,toc:o};h===l.LINK?(g+=1,w.push(a)):await r(`${n}/${e.join("/")}`,{recursive:!0}),s.set(o.uuid,a),await c.updateProgress(a,h!==l.LINK)}else if(o.url){f+=1;let t={path:"",pathTitleList:[],pathIdList:[]};s.get(o.parent_uuid)&&(t=s.get(o.parent_uuid));const r=I(o.title),i=[...t.pathTitleList,`${r}.md`],l=[...t.pathIdList,o.uuid],h={path:i.join("/"),pathTitleList:i,pathIdList:l,toc:o};let g=!0;const w=`${e}/${o.url}`;try{const e={bookId:a,itemUrl:o.url,savePath:`${n}/${t.path}`,saveFilePath:`${n}/${h.path}`,uuid:o.uuid,articleUrl:w,articleTitle:o.title,ignoreImg:d.ignoreImg,host:u};await $({articleInfo:e,progressBar:c,token:d.token,key:d.key})}catch(t){g=!1,p+=1,m.push({articleUrl:w,errItem:h,errMsg:t.message,err:t})}s.set(o.uuid,h),await c.updateProgress(h,g)}}if(g>0){h.warn("该知识库存在以下外链文章");for(const t of w)h.warn(`———— ✕ ${t.path} ${t.toc.url}`)}if(p>0){h.error(`本次执行总数${f}篇，✕ 失败${p}篇`);for(const t of m)h.error(`${t.errItem.path} ———— ${t.articleUrl}`),h.error(`———— ✕ ${t.errMsg}`);h.error("o(╥﹏╥)o 由于网络波动或链接失效以上下载失败，可重新执行命令重试(PS:不会影响已下载成功的数据)")}}({articleUrlPrefix:b,total:g,uuidMap:k,tocList:s,bookPath:f,bookId:o,progressBar:w,host:u,options:e});const L=new p({bookPath:f,bookName:i,bookDesc:n,uuidMap:k});await L.genFile();const E=process.cwd();h.info(`√ 生成目录 ${E}/${f}/SUMMARY.md`),w.curr===g&&h.info(`√ 已完成: ${E}/${f}`),process.exit(0)}export{$ as d,h as l,L as m};

package/dist/es/index.js

@@ -1 +1 @@
-import"node:fs/promises";import"pull-md-img";import"ora";export{d as downloadArticle,m as main}from"./index-16978a9a.js";import"cli-progress";import"log4js";import"axios";import"rand-user-agent";
+import"node:fs/promises";import"pull-md-img";import"ora";export{d as downloadArticle,m as main}from"./index-0527d511.js";import"cli-progress";import"log4js";import"axios";import"rand-user-agent";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yuque-dl",
-  "version": "1.0.24",
+  "version": "1.0.26",
   "description": "yuque 知识库下载",
   "type": "module",
   "bin": {
@@ -61,7 +61,7 @@
     "cli-progress": "^3.12.0",
     "log4js": "^6.9.1",
     "ora": "^7.0.1",
-    "pull-md-img": "^0.0.25",
+    "pull-md-img": "^0.0.26",
     "rand-user-agent": "1.0.109"
   },
   "engines": {

package/types/api.d.ts

@@ -6,14 +6,21 @@ interface IKnowledgeBaseInfo {
     tocList?: KnowledgeBase.Toc[];
     bookName?: string;
     bookDesc?: string;
+    host?: string;
 }
-type TGetKnowledgeBaseInfo = (url: string, token?: string) => Promise<IKnowledgeBaseInfo>;
+interface GetHeaderParams {
+    key?: string;
+    token?: string;
+}
+type TGetKnowledgeBaseInfo = (url: string, headerParams: GetHeaderParams) => Promise<IKnowledgeBaseInfo>;
 /** 获取知识库数据信息 */
 export declare const getKnowledgeBaseInfo: TGetKnowledgeBaseInfo;
 interface GetMdDataParams {
     articleUrl: string;
     bookId: number;
+    host?: string;
     token?: string;
+    key?: string;
 }
 interface IGetDocsMdDataRes {
     apiUrl: string;

package/types/cli.d.ts

@@ -1,5 +1,6 @@
 export interface IOptions {
     distDir: string;
     ignoreImg: boolean;
-    token: string;
+    token?: string;
+    key?: string;
 }

package/types/constant.d.ts

@@ -16,4 +16,8 @@ declare enum ARTICLE_CONTENT_TYPE {
     DOC = "doc"
 }
 declare const articleContentMap: Map<ARTICLE_CONTENT_TYPE, string>;
-export { ARTICLE_TOC_TYPE, ARTICLE_CONTENT_TYPE, articleContentMap };
+/** 默认语雀cookie KEY */
+declare const DEFAULT_COOKIE_KEY = "_yuque_session";
+/** 默认语雀域名 */
+declare const DEFAULT_DOMAIN = "https://www.yuque.com";
+export { ARTICLE_TOC_TYPE, ARTICLE_CONTENT_TYPE, articleContentMap, DEFAULT_COOKIE_KEY, DEFAULT_DOMAIN };

package/types/index.d.ts

@@ -1,6 +1,6 @@
 import ProgressBar from './ProgressBar';
 import type { IOptions } from './cli';
-interface IDownloadArticleParams {
+interface ArticleInfo {
     bookId: number;
     itemUrl: string;
     savePath: string;
@@ -9,8 +9,19 @@ interface IDownloadArticleParams {
     articleTitle: string;
     articleUrl: string;
     ignoreImg: boolean;
+    host?: string;
+}
+interface DownloadArticleParams {
+    /** 文章信息 */
+    articleInfo: ArticleInfo;
+    /** 进度条实例 */
+    progressBar: ProgressBar;
+    /** 语雀cookie token的值 */
+    token?: string;
+    /** 语雀cookie token的key */
+    key?: string;
 }
 /** 下载单篇文章 */
-declare function downloadArticle(params: IDownloadArticleParams, progressBar: ProgressBar, token?: string): Promise<boolean>;
+declare function downloadArticle(params: DownloadArticleParams): Promise<boolean>;
 declare function main(url: string, options: IOptions): Promise<void>;
 export { downloadArticle, main };

package/.eslintrc.cjs

@@ -1,21 +0,0 @@
-module.exports = {
-  env: {
-    node: true,
-  },
-  parser: '@typescript-eslint/parser',
-  plugins: [
-    '@typescript-eslint',
-  ],
-  extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/recommended',
-  ],
-  rules: {
-    semi: ['error', 'never'],
-    'no-console': 'off',
-    'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],
-    // TODO
-    '@typescript-eslint/no-explicit-any': 'off',
-    '@typescript-eslint/no-non-null-assertion': 'off'
-  },
-}

package/.prettierrc.js

@@ -1,7 +0,0 @@
-export default {
-  semi: false,
-  endOfLine: 'lf',
-  singleQuote: true,
-  tabWidth: 2,
-  useTabs: false,
-}

package/GET_TOEKN.md

@@ -1,18 +0,0 @@
-# 如何获取语雀的token
-
-> 以chrome为例其他浏览器也类似
-
-1. 登录语雀，浏览器右击菜单"检查"或点击快捷键 F12(Mac是Option+Command+J)
-2. 退出控制台后点击 `Application`
-3. 点击左侧`Cookies` 下的 `https://www.yuque.com`
-4. 右侧列表中找到 `Name`为 `_yuque_session` 双击`Value`列复制 **Value的值**(也就是下面图片中绿色部分)
-
-![geToken](./assets/getoken.png)
-
-之后就可以在终端执行
-
-```bash
-yuque-dl "知识库的url" -t "复制的token"
-```
-
-> 🚨Tips: cookie为个人登录的信息，请勿泄露自己的cookie给其他人

package/dist/cjs/index-852c3568.js

@@ -1 +0,0 @@
-"use strict";var t=require("node:fs/promises"),e=require("pull-md-img"),r=require("ora"),o=require("cli-progress"),s=require("log4js"),i=require("axios"),n=require("rand-user-agent");var a,c,l=(s.configure({appenders:{cheese:{type:"console",layout:{type:"pattern",pattern:"%[%c [%p]:%] %m%n"}}},categories:{default:{appenders:["cheese"],level:"trace"}}}),s.getLogger("yuque-dl"));class u{constructor(t,e){this.bookPath="",this.progressFilePath="",this.progressInfo=[],this.curr=0,this.total=0,this.isDownloadInterrupted=!1,this.bar=null,this.completePromise=null,this.bookPath=t,this.progressFilePath=`${t}/progress.json`,this.total=e}async init(){this.progressInfo=await this.getProgress(),this.curr=this.progressInfo.length,this.curr!==this.total&&(this.curr>0&&this.curr!==this.total&&(this.isDownloadInterrupted=!0,l.info("根据上次数据继续断点下载")),this.bar=new o.SingleBar({format:"Download [{bar}] {percentage}% | {value}/{total}"},o.Presets.legacy),this.bar.start(this.total,this.curr))}async getProgress(){let e=[];try{const r=await t.readFile(this.progressFilePath,{encoding:"utf8"});e=JSON.parse(r)}catch(r){r&&"ENOENT"===r.code&&await t.writeFile(this.progressFilePath,JSON.stringify(e),{encoding:"utf8"})}return e}async updateProgress(e,r){this.curr=this.curr+1,r&&(this.progressInfo.push(e),await t.writeFile(this.progressFilePath,JSON.stringify(this.progressInfo),{encoding:"utf8"})),this.bar&&(this.bar.update(this.curr),this.curr>=this.total&&(this.bar.stop(),console.log("")))}pause(){this.bar&&this.bar.stop()}continue(){this.clearLine(2),this.bar?.start(this.total,this.curr)}clearLine(t){if(!(t<=0)&&"function"==typeof process?.stderr?.cursorTo){process.stderr.cursorTo(0);for(let e=0;e<t;e++)process.stderr.moveCursor(0,-1),process.stderr.clearLine(1)}}}class d{constructor(t){this.summaryInfo=t}async genFile(){const{bookName:e,bookDesc:r,bookPath:o,uuidMap:s}=this.summaryInfo;let i=`# ${e}\n\n`;r&&(i+=`> ${r}\n\n`);let n=i;const a=[];s.forEach((t=>{const e=t.toc,r=e.parent_uuid,o=this.findTree(a,r),s={text:e.title.replace(/[\\/:*?"<>|\n\r]/g,"_").replace(/\s/,""),id:e.uuid,level:1,type:""},i=e.type.toLocaleLowerCase();"title"===i||""!==e.child_uuid?(s.type="title","boolean"!=typeof o?(Array.isArray(o.children)||(o.children=[]),s.level=o.level+1,o.children.push(s)):(s.level=1,a.push(s))):(s.type="link",s.link="link"===i?t.toc.url:t.path,"boolean"!=typeof o?(Array.isArray(o.children)||(o.children=[]),s.level=o.level+1,o.children.push(s)):(s.level=1,a.push(s)))}));n+=this.genSummaryContent(a,"");try{await t.writeFile(`${o}/SUMMARY.md`,n)}catch(t){l.error("Generate Summary Error")}}genSummaryContent(t,e){for(const r of t){if("title"===r.type)e+=`\n${"".padStart(r.level+1,"#")} ${r.text}\n\n`;else if("link"===r.type){const t=r.link?r.link.replace(/\s/g,"%20"):r.link;e+=`- [${r.text}](${t})\n`}Array.isArray(r.children)&&(e+=this.genSummaryContent(r.children,""))}return e}findIdItem(t,e){if(t.id===e)return t;if(t.children){const r=this.findTree(t.children,e);if(r)return r}return!1}findTree(t,e){if(!e)return!1;for(const r of t){const t=this.findIdItem(r,e);if(t)return t}return!1}}!function(t){t.TITLE="title",t.LINK="link",t.DOC="doc"}(a||(a={})),function(t){t.BOARD="board",t.TABLE="table",t.SHEET="sheet",t.DOC="doc"}(c||(c={}));const h=new Map([[c.BOARD,"画板类型"],[c.TABLE,"数据表类型"],[c.SHEET,"表格类型"],[c.DOC,"文档类型"]]);function p({browser:t="chrome",os:e="mac os",device:r="desktop"}){r=r.toLowerCase(),t=t.toLowerCase(),e=e.toLowerCase();let o=n(r,t,e);if("chrome"===t)for(;o.includes("Chrome-Lighthouse")||o.includes("Gener8")||o.includes("HeadlessChrome")||o.includes("SMTBot");)o=n(r,t,e);if("safari"===t)for(;o.includes("Applebot");)o=n(r,t,e);return o}function g(t){const e={"user-agent":p({browser:"chrome",device:"desktop"})};return t&&(e.cookie=`_yuque_session=${t}`),e}const f=t=>{const{articleUrl:e,bookId:r,token:o}=t;let s=`https://www.yuque.com/api/docs/${e}`;const n={book_id:String(r),merge_dynamic_data:String(!1),mode:"markdown"},a=new URLSearchParams(n).toString();return s=`${s}?${a}`,i.get(s,{headers:g(o)}).then((({data:t,status:e})=>({apiUrl:s,httpStatus:e,response:t})))};async function w(o,s,i){const{bookId:n,itemUrl:a,savePath:l,saveFilePath:u,uuid:d,articleUrl:p,articleTitle:g,ignoreImg:w}=o,{httpStatus:m,apiUrl:b,response:$}=await f({articleUrl:a,bookId:n,token:i}),k=$?.data?.type?.toLocaleLowerCase();if([c.BOARD,c.SHEET,c.TABLE].includes(k)){const t=h.get(k);throw new Error(`download article Error: 暂不支持“${t}”的文档`)}if("string"!=typeof $?.data?.sourcecode)throw new Error(`download article Error: ${b}, http status ${m}`);let y=$.data.sourcecode;if(!w){s.pause(),console.log("");const t=r({text:`下载 "${g}" 的图片中...`});t.start();try{y=await e.run(y,{dist:l,imgDir:`./img/${d}`,isIgnoreConsole:!0})}catch(t){let e=`download article image Error: ${t.message}`;throw t.error&&t.url&&(e=`download article image Error ${t.url}: ${t.error?.message}`),new Error(e)}finally{t.stop(),s.continue()}}y=y.replace(/<br(\s?)\/>/gm,"\n"),g&&(y=`# ${g}\n\x3c!--page header--\x3e\n\n${y}\n\n`),p&&(y+=`\x3c!--page footer--\x3e\n- 原文: <${p}>`);try{return await t.writeFile(u,y),!0}catch(t){throw new Error(`download article Error ${p}: ${t.message}`)}}function m(t){if(!t)return"";return t.replace(/[\\/:*?"<>|\n\r]/g,"_").replace(/\s/g,"")}exports.downloadArticle=w,exports.logger=l,exports.main=async function(e,r){const{bookId:o,tocList:s,bookName:n,bookDesc:c,bookSlug:h}=await((t,e)=>{const r=/decodeURIComponent\("(.+)"\)\);/m;return i.get(t,{headers:g(e)}).then((({data:t="",status:e})=>200===e?t:"")).then((t=>{const e=r.exec(t)??"";if(!e[1])return{};const o=JSON.parse(decodeURIComponent(e[1]));return o.book?{bookId:o.book.id,bookSlug:o.book.slug,tocList:o.book.toc||[],bookName:o.book.name||"",bookDesc:o.book.description||""}:{}}))})(e,r.token);if(!o)throw new Error("No found book id");if(!s||0===s.length)throw new Error("No found toc list");const p=`${r.distDir}/${n?m(n):o}`;await t.mkdir(p,{recursive:!0});const f=s.length,b=new u(p,f);if(await b.init(),b.curr===f)return b.bar&&b.bar.stop(),void l.info(`√ 已完成: ${process.cwd()}/${p}`);const $=new Map;b.isDownloadInterrupted&&b.progressInfo.forEach((t=>{$.set(t.toc.uuid,t)}));const k=e.replace(new RegExp(`(.*?/${h}).*`),"$1");await async function(e){const{articleUrlPrefix:r,total:o,uuidMap:s,tocList:i,bookPath:n,bookId:c,progressBar:u,options:d}=e;let h=0,p=0,g=0;const f=[],b=[];for(let e=0;e<o;e++){const o=i[e];if("string"!=typeof o.type)continue;if(s.get(o.uuid))continue;const l=o.type.toLocaleLowerCase();if(l===a.TITLE||""!==o.child_uuid||l===a.LINK){let e=o;const r=[],i=[];for(;e;)r.unshift(m(e.title)),i.unshift(e.uuid),e=s.get(e.parent_uuid)?s.get(e.parent_uuid).toc:void 0;const c={path:r.join("/"),pathTitleList:r,pathIdList:i,toc:o};l===a.LINK?(g+=1,b.push(c)):await t.mkdir(`${n}/${r.join("/")}`,{recursive:!0}),s.set(o.uuid,c),await u.updateProgress(c,l!==a.LINK)}else if(o.url){p+=1;let t={path:"",pathTitleList:[],pathIdList:[]};s.get(o.parent_uuid)&&(t=s.get(o.parent_uuid));const e=m(o.title),i=[...t.pathTitleList,`${e}.md`],a=[...t.pathIdList,o.uuid],l={path:i.join("/"),pathTitleList:i,pathIdList:a,toc:o};let g=!0;const b=`${r}/${o.url}`;try{await w({bookId:c,itemUrl:o.url,savePath:`${n}/${t.path}`,saveFilePath:`${n}/${l.path}`,uuid:o.uuid,articleUrl:b,articleTitle:o.title,ignoreImg:d.ignoreImg},u,d.token)}catch(t){g=!1,h+=1,f.push({articleUrl:b,errItem:l,errMsg:t.message,err:t})}s.set(o.uuid,l),await u.updateProgress(l,g)}}if(g>0){l.warn("该知识库存在以下外链文章");for(const t of b)l.warn(`———— ✕ ${t.path} ${t.toc.url}`)}if(h>0){l.error(`本次执行总数${p}篇，✕ 失败${h}篇`);for(const t of f)l.error(`${t.errItem.path} ———— ${t.articleUrl}`),l.error(`———— ✕ ${t.errMsg}`);l.error("o(╥﹏╥)o 由于网络波动或链接失效以上下载失败，可重新执行命令重试(PS:不会影响已下载成功的数据)")}}({articleUrlPrefix:k,total:f,uuidMap:$,tocList:s,bookPath:p,bookId:o,progressBar:b,options:r});const y=new d({bookPath:p,bookName:n,bookDesc:c,uuidMap:$});await y.genFile();const I=process.cwd();l.info(`√ 生成目录 ${I}/${p}/SUMMARY.md`),b.curr===f&&l.info(`√ 已完成: ${I}/${p}`),process.exit(0)};

package/dist/es/index-16978a9a.js

@@ -1 +0,0 @@
-import t,{writeFile as e,mkdir as r}from"node:fs/promises";import o from"pull-md-img";import s from"ora";import i from"cli-progress";import n from"log4js";import a from"axios";import c from"rand-user-agent";var l,u,d=(n.configure({appenders:{cheese:{type:"console",layout:{type:"pattern",pattern:"%[%c [%p]:%] %m%n"}}},categories:{default:{appenders:["cheese"],level:"trace"}}}),n.getLogger("yuque-dl"));class h{constructor(t,e){this.bookPath="",this.progressFilePath="",this.progressInfo=[],this.curr=0,this.total=0,this.isDownloadInterrupted=!1,this.bar=null,this.completePromise=null,this.bookPath=t,this.progressFilePath=`${t}/progress.json`,this.total=e}async init(){this.progressInfo=await this.getProgress(),this.curr=this.progressInfo.length,this.curr!==this.total&&(this.curr>0&&this.curr!==this.total&&(this.isDownloadInterrupted=!0,d.info("根据上次数据继续断点下载")),this.bar=new i.SingleBar({format:"Download [{bar}] {percentage}% | {value}/{total}"},i.Presets.legacy),this.bar.start(this.total,this.curr))}async getProgress(){let e=[];try{const r=await t.readFile(this.progressFilePath,{encoding:"utf8"});e=JSON.parse(r)}catch(r){r&&"ENOENT"===r.code&&await t.writeFile(this.progressFilePath,JSON.stringify(e),{encoding:"utf8"})}return e}async updateProgress(e,r){this.curr=this.curr+1,r&&(this.progressInfo.push(e),await t.writeFile(this.progressFilePath,JSON.stringify(this.progressInfo),{encoding:"utf8"})),this.bar&&(this.bar.update(this.curr),this.curr>=this.total&&(this.bar.stop(),console.log("")))}pause(){this.bar&&this.bar.stop()}continue(){this.clearLine(2),this.bar?.start(this.total,this.curr)}clearLine(t){if(!(t<=0)&&"function"==typeof process?.stderr?.cursorTo){process.stderr.cursorTo(0);for(let e=0;e<t;e++)process.stderr.moveCursor(0,-1),process.stderr.clearLine(1)}}}class p{constructor(t){this.summaryInfo=t}async genFile(){const{bookName:e,bookDesc:r,bookPath:o,uuidMap:s}=this.summaryInfo;let i=`# ${e}\n\n`;r&&(i+=`> ${r}\n\n`);let n=i;const a=[];s.forEach((t=>{const e=t.toc,r=e.parent_uuid,o=this.findTree(a,r),s={text:e.title.replace(/[\\/:*?"<>|\n\r]/g,"_").replace(/\s/,""),id:e.uuid,level:1,type:""},i=e.type.toLocaleLowerCase();"title"===i||""!==e.child_uuid?(s.type="title","boolean"!=typeof o?(Array.isArray(o.children)||(o.children=[]),s.level=o.level+1,o.children.push(s)):(s.level=1,a.push(s))):(s.type="link",s.link="link"===i?t.toc.url:t.path,"boolean"!=typeof o?(Array.isArray(o.children)||(o.children=[]),s.level=o.level+1,o.children.push(s)):(s.level=1,a.push(s)))}));n+=this.genSummaryContent(a,"");try{await t.writeFile(`${o}/SUMMARY.md`,n)}catch(t){d.error("Generate Summary Error")}}genSummaryContent(t,e){for(const r of t){if("title"===r.type)e+=`\n${"".padStart(r.level+1,"#")} ${r.text}\n\n`;else if("link"===r.type){const t=r.link?r.link.replace(/\s/g,"%20"):r.link;e+=`- [${r.text}](${t})\n`}Array.isArray(r.children)&&(e+=this.genSummaryContent(r.children,""))}return e}findIdItem(t,e){if(t.id===e)return t;if(t.children){const r=this.findTree(t.children,e);if(r)return r}return!1}findTree(t,e){if(!e)return!1;for(const r of t){const t=this.findIdItem(r,e);if(t)return t}return!1}}!function(t){t.TITLE="title",t.LINK="link",t.DOC="doc"}(l||(l={})),function(t){t.BOARD="board",t.TABLE="table",t.SHEET="sheet",t.DOC="doc"}(u||(u={}));const f=new Map([[u.BOARD,"画板类型"],[u.TABLE,"数据表类型"],[u.SHEET,"表格类型"],[u.DOC,"文档类型"]]);function g({browser:t="chrome",os:e="mac os",device:r="desktop"}){r=r.toLowerCase(),t=t.toLowerCase(),e=e.toLowerCase();let o=c(r,t,e);if("chrome"===t)for(;o.includes("Chrome-Lighthouse")||o.includes("Gener8")||o.includes("HeadlessChrome")||o.includes("SMTBot");)o=c(r,t,e);if("safari"===t)for(;o.includes("Applebot");)o=c(r,t,e);return o}function m(t){const e={"user-agent":g({browser:"chrome",device:"desktop"})};return t&&(e.cookie=`_yuque_session=${t}`),e}const w=t=>{const{articleUrl:e,bookId:r,token:o}=t;let s=`https://www.yuque.com/api/docs/${e}`;const i={book_id:String(r),merge_dynamic_data:String(!1),mode:"markdown"},n=new URLSearchParams(i).toString();return s=`${s}?${n}`,a.get(s,{headers:m(o)}).then((({data:t,status:e})=>({apiUrl:s,httpStatus:e,response:t})))};async function b(t,r,i){const{bookId:n,itemUrl:a,savePath:c,saveFilePath:l,uuid:d,articleUrl:h,articleTitle:p,ignoreImg:g}=t,{httpStatus:m,apiUrl:b,response:$}=await w({articleUrl:a,bookId:n,token:i}),y=$?.data?.type?.toLocaleLowerCase();if([u.BOARD,u.SHEET,u.TABLE].includes(y)){const t=f.get(y);throw new Error(`download article Error: 暂不支持“${t}”的文档`)}if("string"!=typeof $?.data?.sourcecode)throw new Error(`download article Error: ${b}, http status ${m}`);let k=$.data.sourcecode;if(!g){r.pause(),console.log("");const t=s({text:`下载 "${p}" 的图片中...`});t.start();try{k=await o.run(k,{dist:c,imgDir:`./img/${d}`,isIgnoreConsole:!0})}catch(t){let e=`download article image Error: ${t.message}`;throw t.error&&t.url&&(e=`download article image Error ${t.url}: ${t.error?.message}`),new Error(e)}finally{t.stop(),r.continue()}}k=k.replace(/<br(\s?)\/>/gm,"\n"),p&&(k=`# ${p}\n\x3c!--page header--\x3e\n\n${k}\n\n`),h&&(k+=`\x3c!--page footer--\x3e\n- 原文: <${h}>`);try{return await e(l,k),!0}catch(t){throw new Error(`download article Error ${h}: ${t.message}`)}}function $(t){if(!t)return"";return t.replace(/[\\/:*?"<>|\n\r]/g,"_").replace(/\s/g,"")}async function y(t,e){const{bookId:o,tocList:s,bookName:i,bookDesc:n,bookSlug:c}=await((t,e)=>{const r=/decodeURIComponent\("(.+)"\)\);/m;return a.get(t,{headers:m(e)}).then((({data:t="",status:e})=>200===e?t:"")).then((t=>{const e=r.exec(t)??"";if(!e[1])return{};const o=JSON.parse(decodeURIComponent(e[1]));return o.book?{bookId:o.book.id,bookSlug:o.book.slug,tocList:o.book.toc||[],bookName:o.book.name||"",bookDesc:o.book.description||""}:{}}))})(t,e.token);if(!o)throw new Error("No found book id");if(!s||0===s.length)throw new Error("No found toc list");const u=`${e.distDir}/${i?$(i):o}`;await r(u,{recursive:!0});const f=s.length,g=new h(u,f);if(await g.init(),g.curr===f)return g.bar&&g.bar.stop(),void d.info(`√ 已完成: ${process.cwd()}/${u}`);const w=new Map;g.isDownloadInterrupted&&g.progressInfo.forEach((t=>{w.set(t.toc.uuid,t)}));const y=t.replace(new RegExp(`(.*?/${c}).*`),"$1");await async function(t){const{articleUrlPrefix:e,total:o,uuidMap:s,tocList:i,bookPath:n,bookId:a,progressBar:c,options:u}=t;let h=0,p=0,f=0;const g=[],m=[];for(let t=0;t<o;t++){const o=i[t];if("string"!=typeof o.type)continue;if(s.get(o.uuid))continue;const d=o.type.toLocaleLowerCase();if(d===l.TITLE||""!==o.child_uuid||d===l.LINK){let t=o;const e=[],i=[];for(;t;)e.unshift($(t.title)),i.unshift(t.uuid),t=s.get(t.parent_uuid)?s.get(t.parent_uuid).toc:void 0;const a={path:e.join("/"),pathTitleList:e,pathIdList:i,toc:o};d===l.LINK?(f+=1,m.push(a)):await r(`${n}/${e.join("/")}`,{recursive:!0}),s.set(o.uuid,a),await c.updateProgress(a,d!==l.LINK)}else if(o.url){p+=1;let t={path:"",pathTitleList:[],pathIdList:[]};s.get(o.parent_uuid)&&(t=s.get(o.parent_uuid));const r=$(o.title),i=[...t.pathTitleList,`${r}.md`],l=[...t.pathIdList,o.uuid],d={path:i.join("/"),pathTitleList:i,pathIdList:l,toc:o};let f=!0;const m=`${e}/${o.url}`;try{await b({bookId:a,itemUrl:o.url,savePath:`${n}/${t.path}`,saveFilePath:`${n}/${d.path}`,uuid:o.uuid,articleUrl:m,articleTitle:o.title,ignoreImg:u.ignoreImg},c,u.token)}catch(t){f=!1,h+=1,g.push({articleUrl:m,errItem:d,errMsg:t.message,err:t})}s.set(o.uuid,d),await c.updateProgress(d,f)}}if(f>0){d.warn("该知识库存在以下外链文章");for(const t of m)d.warn(`———— ✕ ${t.path} ${t.toc.url}`)}if(h>0){d.error(`本次执行总数${p}篇，✕ 失败${h}篇`);for(const t of g)d.error(`${t.errItem.path} ———— ${t.articleUrl}`),d.error(`———— ✕ ${t.errMsg}`);d.error("o(╥﹏╥)o 由于网络波动或链接失效以上下载失败，可重新执行命令重试(PS:不会影响已下载成功的数据)")}}({articleUrlPrefix:y,total:f,uuidMap:w,tocList:s,bookPath:u,bookId:o,progressBar:g,options:e});const k=new p({bookPath:u,bookName:i,bookDesc:n,uuidMap:w});await k.genFile();const I=process.cwd();d.info(`√ 生成目录 ${I}/${u}/SUMMARY.md`),g.curr===f&&d.info(`√ 已完成: ${I}/${u}`),process.exit(0)}export{b as d,d as l,y as m};

package/rollup.config.ts

@@ -1,26 +0,0 @@
-import { defineConfig } from 'rollup'
-import typescript from '@rollup/plugin-typescript'
-import terser from '@rollup/plugin-terser'
-
-export default defineConfig({
-  input: {
-    index: 'src/index.ts',
-    cli: 'src/cli.ts'
-  },
-  output:[
-    {
-      format: "cjs",
-      dir: "dist/cjs"
-    },
-    {
-      format: "es",
-      dir: "dist/es",
-    },
-  ],
-  plugins: [
-    typescript(),
-    terser()
-  ]
-})
-
-