yuque-dl 1.0.4 → 1.0.6

package/.np-config.js

@@ -0,0 +1,3 @@
+export default {
+  tests: false
+}

package/dist/cjs/cli.js

@@ -1,5 +1,6 @@
 'use strict';
 
+var node_fs = require('node:fs');
 var cac = require('cac');
 var index = require('./index-4969d150.js');
 require('node:fs/promises');
@@ -10,9 +11,10 @@ require('progress');
 require('rand-user-agent');
 require('pull-md-img');
 
-var version = "1.0.3";
-
 const cli = cac.cac('yuque-dl');
+// 不能直接使用 import {version} from '../package.json'
+// 否则declaration 生成的d.ts 会多一层src目录
+const { version } = JSON.parse(node_fs.readFileSync(new URL('../../package.json', (typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (document.currentScript && document.currentScript.src || new URL('cli.js', document.baseURI).href)))).toString());
 cli
     .command('<url>', 'request url')
     .option('-d, --distDir <dir>', '下载的目录 eg: -d download', {

package/dist/es/cli.js

@@ -1,3 +1,4 @@
+import { readFileSync } from 'node:fs';
 import { cac } from 'cac';
 import { m as main, l as logger } from './index-5cda90ca.js';
 import 'node:fs/promises';
@@ -8,9 +9,10 @@ import 'progress';
 import 'rand-user-agent';
 import 'pull-md-img';
 
-var version = "1.0.3";
-
 const cli = cac('yuque-dl');
+// 不能直接使用 import {version} from '../package.json'
+// 否则declaration 生成的d.ts 会多一层src目录
+const { version } = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url)).toString());
 cli
     .command('<url>', 'request url')
     .option('-d, --distDir <dir>', '下载的目录 eg: -d download', {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yuque-dl",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "yuque 知识库下载",
   "type": "module",
   "bin": {
@@ -12,7 +12,7 @@
     "build:bundle": "rollup -c rollup.config.ts --configPlugin typescript",
     "build:types": "tsc --emitDeclarationOnly --outDir types -p tsconfig.base.json",
     "clean": "rm -rf dist types",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "publish": "np"
   },
   "repository": {
     "type": "git",
@@ -33,6 +33,7 @@
     "@typescript-eslint/eslint-plugin": "^6.3.0",
     "@typescript-eslint/parser": "^6.3.0",
     "jest": "^29.6.2",
+    "np": "^8.0.4",
     "npm-run-all": "^4.1.5",
     "rollup": "^3.28.0",
     "tslib": "^2.6.1"
@@ -48,11 +49,11 @@
   },
   "dependencies": {
     "axios": "^1.4.0",
+    "cac": "^6.7.14",
     "log4js": "^6.9.1",
     "progress": "^2.0.3",
-    "pull-md-img": "^0.0.19",
-    "rand-user-agent": "1.0.109",
-    "cac": "^6.7.14"
+    "pull-md-img": "^0.0.20",
+    "rand-user-agent": "1.0.109"
   },
   "engines": {
     "node": "^14.18.0 || >=16.0.0"

package/tsconfig.base.json

@@ -10,8 +10,12 @@
     "esModuleInterop": true,
     "useUnknownInCatchVariables": false,
     "resolveJsonModule": true,
+    "paths": {
+      "@/*": ["./*"],
+    }
   },
   "include": [
-    "src/**/*"
-  ]
+    "./src/**/*"
+  ],
+
 }

package/types/Process.d.ts

@@ -0,0 +1,23 @@
+import progress from 'progress';
+import type { KnowledgeBase } from './types/KnowledgeBaseResponse';
+export interface IProcessItem {
+    path: string;
+    toc: KnowledgeBase.Toc;
+    pathIdList: string[];
+    pathTitleList: string[];
+}
+export declare type IProcess = IProcessItem[];
+export default class Progress {
+    bookPath: string;
+    processFilePath: string;
+    processInfo: IProcess;
+    curr: number;
+    total: number;
+    isDownloadInterrupted: boolean;
+    bar: progress | null;
+    completePromise: Promise<void> | null;
+    constructor(bookPath: string, total: number);
+    init(): Promise<void>;
+    getProgress(): Promise<IProcess>;
+    updateProgress(progressItem: IProcessItem): Promise<void>;
+}

package/types/cli.d.ts

@@ -0,0 +1,3 @@
+export interface IOptions {
+    distDir: string;
+}

package/types/config.d.ts

@@ -0,0 +1,5 @@
+declare const _default: {
+    knowledgeBaseReg: RegExp;
+    dist: string;
+};
+export default _default;

package/types/index.d.ts

@@ -0,0 +1,11 @@
+import type { IOptions } from './cli';
+import type { KnowledgeBase } from './types/KnowledgeBaseResponse';
+interface IKnowledgeBaseInfo {
+    bookId?: number;
+    tocList?: KnowledgeBase.Toc[];
+    bookName?: string;
+    bookDesc?: string;
+}
+declare function getKnowledgeBaseInfo(url: string): Promise<IKnowledgeBaseInfo>;
+declare function main(url: string, options: IOptions): Promise<void>;
+export { getKnowledgeBaseInfo, main };

package/types/log.d.ts

@@ -0,0 +1,3 @@
+import log4js from 'log4js';
+declare const _default: log4js.Logger;
+export default _default;

package/types/types/ArticleResponse.d.ts

@@ -0,0 +1,42 @@
+export declare namespace ArticleResponse {
+    interface RootObject {
+        meta: Meta;
+        data: Data;
+    }
+    interface Data {
+        id: number;
+        space_id: number;
+        type: string;
+        sub_type?: any;
+        format: string;
+        title: string;
+        slug: string;
+        public: number;
+        status: number;
+        read_status: number;
+        created_at: string;
+        content_updated_at: string;
+        published_at: string;
+        first_published_at: string;
+        sourcecode: string;
+        last_editor?: any;
+        _serializer: string;
+    }
+    interface Meta {
+        abilities: Abilities;
+        latestReviewStatus: number;
+    }
+    interface Abilities {
+        create: boolean;
+        destroy: boolean;
+        update: boolean;
+        read: boolean;
+        export: boolean;
+        manage: boolean;
+        join: boolean;
+        share: boolean;
+        force_delete: boolean;
+        create_collaborator: boolean;
+        destroy_comment: boolean;
+    }
+}

package/types/types/KnowledgeBaseResponse.d.ts

@@ -0,0 +1,401 @@
+export declare namespace KnowledgeBase {
+    interface Response {
+        me: Me;
+        notification: Notification;
+        settings: Settings;
+        env: string;
+        space: Space;
+        isYuque: boolean;
+        isPublicCloud: boolean;
+        isEnterprise: boolean;
+        isUseAntLogin: boolean;
+        defaultSpaceHost: string;
+        timestamp: number;
+        traceId: string;
+        siteName: string;
+        siteTip?: any;
+        activityTip?: any;
+        topTip?: any;
+        readTip: Notification;
+        questionRecommend?: any;
+        dashboardBannerRecommend?: any;
+        imageServiceDomains: string[];
+        sharePlatforms: string[];
+        locale: string;
+        matchCondition: MatchCondition;
+        empInfo: Notification;
+        group: Group;
+        book: Book;
+        groupMemberInfo: GroupMemberInfo;
+        userSettings: Notification;
+        interest: Interest;
+        canUseAiWriting: boolean;
+        canUseAiLegal: boolean;
+        canUseAiReading: boolean;
+        aiWritingStreamType: any[];
+        legalAnimationTime: number;
+        canUseAiTag: boolean;
+        canUseAiTestCase: boolean;
+        paymentInfo: PaymentInfo;
+        login: Login;
+        enableCoverageDeploy: boolean;
+        isDesktopApp: boolean;
+        isOnlineDesktopApp: boolean;
+        isIsomorphicDesktopApp: boolean;
+        isAssistant: boolean;
+        isAlipayApp: boolean;
+        isDingTalkApp: boolean;
+        isDingTalkMiniApp: boolean;
+        isDingTalkDesktopApp: boolean;
+        isYuqueMobileApp: boolean;
+        tracertConfig: TracertConfig;
+    }
+    interface TracertConfig {
+        spmAPos: string;
+        spmBPos?: any;
+    }
+    interface Login {
+        loginType: string;
+        enablePlatforms: string[];
+        isWechatMobileApp: boolean;
+    }
+    interface PaymentInfo {
+        paymentBizInstId: string;
+    }
+    interface Interest {
+        interests: Interests;
+        limits: Limits;
+        owner: Owner;
+        limit: Member;
+    }
+    interface Owner {
+        id: number;
+        type: string;
+        member_level: string;
+        isTopLevel: boolean;
+        isMemberTopLevel: boolean;
+        isPaid: boolean;
+        isExpired: boolean;
+    }
+    interface Limits {
+        normal: Normal;
+        member: Member;
+    }
+    interface Member {
+        max_group_member_number: number;
+        max_book_collaborator_number: number;
+        max_book_number?: any;
+        max_resource_total_size: number;
+        max_single_file_size: number;
+        max_single_image_size: number;
+        max_single_video_size: number;
+        max_doc_collaborator_number: number;
+        max_doc_nologin_pv?: any;
+    }
+    interface Normal {
+        max_group_member_number: number;
+        max_book_collaborator_number: number;
+        max_book_number: number;
+        max_resource_total_size: number;
+        max_single_image_size: number;
+        max_single_video_size: number;
+        max_single_file_size: number;
+        max_doc_collaborator_number: number;
+        max_doc_nologin_pv: number;
+    }
+    interface Interests {
+        book_webhook: boolean;
+        open_ocr: boolean;
+        create_public_resource: boolean;
+        book_statistics: boolean;
+        book_security: boolean;
+    }
+    interface GroupMemberInfo {
+        usage: Usage;
+        expired_at: string;
+        countDownDays: number;
+        isAllowRenew: boolean;
+        receipt?: any;
+        groupOwners: GroupOwner[];
+        hasOrder: boolean;
+    }
+    interface GroupOwner {
+        id: number;
+        type: string;
+        login: string;
+        name: string;
+        description?: string;
+        avatar?: string;
+        avatar_url: string;
+        followers_count: number;
+        following_count: number;
+        status: number;
+        public: number;
+        scene?: any;
+        created_at: string;
+        updated_at: string;
+        expired_at?: string;
+        isPaid: boolean;
+        member_level: number;
+        memberLevelName?: string;
+        hasMemberLevel: boolean;
+        isTopLevel: boolean;
+        isNewbie: boolean;
+        profile?: any;
+        organizationUser?: any;
+        _serializer: string;
+    }
+    interface Usage {
+        attachment_size: number;
+        image_size: number;
+        video_size: number;
+        attachment_size_month: number;
+        image_size_month: number;
+        video_size_month: number;
+        max_upload_size: number;
+        _serializer: string;
+    }
+    interface Book {
+        id: number;
+        type: string;
+        slug: string;
+        name: string;
+        toc: Toc[];
+        toc_updated_at: string;
+        description: string;
+        creator_id: number;
+        menu_type: number;
+        items_count: number;
+        likes_count: number;
+        watches_count: number;
+        user_id: number;
+        abilities: Abilities2;
+        public: number;
+        extend_private: number;
+        scene?: any;
+        source?: any;
+        created_at: string;
+        updated_at: string;
+        pinned_at?: any;
+        archived_at?: any;
+        layout: string;
+        doc_typography: string;
+        doc_viewport: string;
+        announcement?: any;
+        should_manually_create_uid: boolean;
+        catalog_tail_type: string;
+        catalog_display_level: number;
+        cover: string;
+        comment_count?: any;
+        organization_id: number;
+        status: number;
+        indexed_level: number;
+        privacy_migrated: boolean;
+        collaboration_count: number;
+        content_updated_at: string;
+        content_updated_at_ms: number;
+        copyright_watermark: string;
+        enable_announcement: boolean;
+        enable_auto_publish: boolean;
+        enable_comment: boolean;
+        enable_document_copy: boolean;
+        enable_export: boolean;
+        enable_search_engine: boolean;
+        enable_toc: boolean;
+        enable_trash: boolean;
+        enable_visitor_watermark: boolean;
+        enable_webhook: boolean;
+        image_copyright_watermark: string;
+        original: number;
+        resource_size: number;
+        user?: any;
+        contributors?: any;
+        _serializer: string;
+    }
+    interface Abilities2 {
+        create_doc: boolean;
+        destroy: boolean;
+        export: boolean;
+        export_doc: boolean;
+        read: boolean;
+        read_private: boolean;
+        update: boolean;
+        create_collaborator: boolean;
+        manage: boolean;
+        share: boolean;
+        modify_setting: boolean;
+    }
+    interface Toc {
+        type: string;
+        title: string;
+        uuid: string;
+        url: string;
+        prev_uuid: string;
+        sibling_uuid: string;
+        child_uuid: string;
+        parent_uuid: string;
+        doc_id: number;
+        level: number;
+        id: number;
+        open_window: number;
+        visible: number;
+    }
+    interface Group {
+        id: number;
+        type: string;
+        login: string;
+        name: string;
+        description: string;
+        avatar: string;
+        avatar_url: string;
+        owner_id: number;
+        books_count: number;
+        public_books_count: number;
+        topics_count: number;
+        public_topics_count: number;
+        members_count: number;
+        abilities: Abilities;
+        settings: Settings2;
+        public: number;
+        extend_private: number;
+        scene?: any;
+        created_at: string;
+        updated_at: string;
+        expired_at: string;
+        deleted_at?: any;
+        organization_id: number;
+        isPaid: boolean;
+        member_level: number;
+        memberLevelName: string;
+        hasMemberLevel: boolean;
+        isTopLevel: boolean;
+        grains_sum: number;
+        status: number;
+        source?: any;
+        zone_id: number;
+        isPermanentPunished: boolean;
+        isWiki: boolean;
+        isPublicPage: boolean;
+        organization?: any;
+        owners?: any;
+        _serializer: string;
+    }
+    interface Settings2 {
+        homepage: Homepage;
+        navigation: string[];
+        group: Notification;
+        id: number;
+        created_at: string;
+        updated_at: string;
+        space_id: number;
+        group_id: number;
+        topic_enable: number;
+        resource_enable: number;
+        thread_enable: number;
+        issue_enable: number;
+        role_for_add_member: number;
+        external_enable: number;
+        permission: Permission;
+    }
+    interface Permission {
+        create_member: boolean;
+        create_book: boolean;
+        create_book_collaborator: boolean;
+        modify_book_setting: boolean;
+        share_book: boolean;
+        export_book: boolean;
+        share_doc: boolean;
+        export_doc: boolean;
+        force_delete_doc: boolean;
+    }
+    interface Homepage {
+        layout: Layout;
+        version: number;
+    }
+    interface Layout {
+        header: string[];
+        content: string[];
+        aside: string[];
+    }
+    interface Abilities {
+        create_book: boolean;
+        create_member: boolean;
+        destroy: boolean;
+        read: boolean;
+        read_private: boolean;
+        update: boolean;
+        manage: boolean;
+        restore: boolean;
+    }
+    interface MatchCondition {
+        page: string;
+    }
+    interface Space {
+        id: number;
+        login: string;
+        name: string;
+        short_name?: any;
+        status: number;
+        account_id: number;
+        logo?: any;
+        description: string;
+        created_at?: any;
+        updated_at?: any;
+        host: string;
+        displayName: string;
+        logo_url: string;
+        enable_password: boolean;
+        enable_watermark: boolean;
+        _serializer: string;
+    }
+    interface Settings {
+        allowed_link_schema: string[];
+        enable_link_interception: boolean;
+        enable_new_user_public_ability_forbid: boolean;
+        user_registry_forbidden_level: string;
+        watermark_enable: string;
+        public_space_doc_search_enable: boolean;
+        lake_enabled_groups: string;
+        image_proxy_root: string;
+        max_import_task_count: number;
+        enable_search: boolean;
+        enable_serviceworker: boolean;
+        enable_lazyload_card: string;
+        editor_canary: Editorcanary;
+        enable_attachment_multipart: boolean;
+        enable_custom_video_player: boolean;
+        conference_gift_num: number;
+        intranet_safe_tip: string[];
+        publication_enable_whitelist: any[];
+        foreign_phone_registry_enabled_organization_whitelist: string[];
+        disabled_login_modal_pop_default: boolean;
+        enable_open_in_mobile_app: boolean;
+        enable_wechat_guide_qrcode: boolean;
+        enable_issue: boolean;
+        enable_blank_page_detect: boolean;
+        zone_ant_auth_keepalive_enabled_domains: any[];
+        enable_new_group_page_whitelist: any[];
+        enable_web_ocr: Enablewebocr;
+        customer_staff_dingtalk_id: string;
+        enable_desktop_force_local: boolean;
+        support_extension_download_url: boolean;
+    }
+    interface Enablewebocr {
+        enable: boolean;
+        enableBrowsers: string[];
+        _users: number[];
+        percent: number;
+    }
+    interface Editorcanary {
+        card_lazy_init: number;
+        retryOriginImage: number;
+    }
+    interface Notification {
+    }
+    interface Me {
+        avatar_url: string;
+        avatar: string;
+        language: string;
+        is_admin: boolean;
+    }
+}

package/types/utils.d.ts

@@ -0,0 +1,6 @@
+declare function randUserAgent({ browser, os, device }: {
+    browser?: string | undefined;
+    os?: string | undefined;
+    device?: string | undefined;
+}): any;
+export { randUserAgent };