@cloudbase/manager-node 4.11.0-alpha.0 → 4.11.0-alpha.2

package/lib/docs/index.js

@@ -0,0 +1,288 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocsService = void 0;
+const http_request_1 = require("../utils/http-request");
+const DOCS_BASE_URL = 'https://docs.cloudbase.net';
+const CATEGORY_URL = `${DOCS_BASE_URL}/category.json`;
+const ALGOLIA_SEARCH_URL = 'https://70wjvl90pg-dsn.algolia.net/1/indexes/*/queries' +
+    '?x-algolia-agent=Algolia%20for%20JavaScript%20(4.19.1)%3B%20Browser%20(lite)%3B%20docsearch%20(3.6.1)%3B%20docsearch-react%20(3.6.1)%3B%20docusaurus%20(2.4.3)' +
+    '&x-algolia-api-key=69281afd904cb72b399c92fb62b3ce25' +
+    '&x-algolia-application-id=70WJVL90PG';
+const ALGOLIA_SEARCH_PARAMS = 'attributesToRetrieve=["hierarchy.lvl0","hierarchy.lvl1","hierarchy.lvl2","hierarchy.lvl3","hierarchy.lvl4","hierarchy.lvl5","hierarchy.lvl6","content","type","url"]' +
+    '&attributesToSnippet=["hierarchy.lvl1:10","hierarchy.lvl2:10","hierarchy.lvl3:10","hierarchy.lvl4:10","hierarchy.lvl5:10","hierarchy.lvl6:10","content:10"]' +
+    '&snippetEllipsisText=\u2026' +
+    '&highlightPreTag=<mark>&highlightPostTag=</mark>' +
+    '&hitsPerPage=20' +
+    '&clickAnalytics=false' +
+    '&facetFilters=["language:zh-Hans",["docusaurus_tag:default","docusaurus_tag:docs-default-current"]]';
+class DocsService {
+    async listModules() {
+        const category = await this.getCategory();
+        // 列出所有二级目录模块
+        const modules = new Set();
+        for (const topModule of Object.values(category)) {
+            if (typeof topModule === 'object') {
+                for (const key of Object.keys(topModule)) {
+                    modules.add(key);
+                }
+            }
+        }
+        return Array.from(modules).sort();
+    }
+    /**
+     * Case: tcb docs read 快速开始
+     * 根据模块名获取该模块下的所有文档（返回嵌套的对象结构）
+     */
+    async listModuleDocs(moduleName) {
+        const category = await this.getCategory();
+        // 先尝试直接匹配顶级模块
+        const moduleData = category[moduleName];
+        if (moduleData !== undefined) {
+            return moduleData;
+        }
+        // 递归搜索嵌套模块
+        const found = this.findNestedModule(category, moduleName);
+        if (found) {
+            return found;
+        }
+        throw new Error(`Module "${moduleName}" not found`);
+    }
+    /**
+     * Case: tcb docs read <任意输入>
+     * 统一的查找入口，自动识别输入格式并返回模块数据或文档URL
+     *
+     * 支持的输入格式：
+     * 1. URL路径格式（包含 /，相对或完整）: tcb docs read quick-start/create-env
+     * 2. 点分隔路径: tcb docs read 云托管.快速开始..NET 快速开始
+     * 3. 模块名: tcb docs read 快速开始 「命中第一个 底下其他同理」
+     * 4. 嵌套模块名: tcb docs read 微信生态（嵌套在"社区.最佳实践"下）
+     * 5. 文档标题: tcb docs read 小程序快速开始
+     * 6. 前缀模糊匹配: tcb docs read PHP（匹配 "PHP 快速开始"）
+     */
+    async findByName(input) {
+        const category = await this.getCategory();
+        // 模式1: URL路径格式（包含 /），直接作为文档URL返回
+        if (input.includes('/')) {
+            // 直接返回 URL 路径，交给 readDoc 处理
+            return { type: 'doc', data: input };
+        }
+        // 模式2: 点分隔的层级导航，如 "云托管.快速开始..NET 快速开始" 处理多点情况
+        if (input.includes('.')) {
+            const result = this.findByDotPath(category, input);
+            if (result) {
+                return result;
+            }
+            throw new Error(`未找到模块或文档 "${input}"`);
+        }
+        // 模式3: 模块名查找（顶级或嵌套）复用上面已获取的 category
+        const topLevelModule = category[input];
+        if (topLevelModule && typeof topLevelModule === 'object') {
+            return { type: 'module', data: topLevelModule };
+        }
+        const nestedModule = this.findNestedModule(category, input);
+        if (nestedModule) {
+            return { type: 'module', data: nestedModule };
+        }
+        // 模式4: 文档标题精确搜索
+        const docPath = this.findDocPathByTitle(category, input);
+        if (docPath) {
+            return { type: 'doc', data: docPath };
+        }
+        // 模式5: 前缀模糊搜索（处理含空格的 key 被命令行截断的情况）
+        const prefixResult = this.findByKeyPrefix(category, input);
+        if (prefixResult) {
+            return prefixResult;
+        }
+        throw new Error(`未找到模块或文档 "${input}"`);
+    }
+    async readDoc(docPath) {
+        const normalizedPath = docPath.endsWith('.md') ? docPath : `${docPath}/index.md`;
+        // 支持完整URL和相对路径
+        const url = normalizedPath.startsWith('http') ? normalizedPath : `${DOCS_BASE_URL}/${normalizedPath}`;
+        const res = await (0, http_request_1.fetchStream)(url);
+        let text = await res.text();
+        // 移除 UTF-8 BOM
+        if (text.charCodeAt(0) === 0xFEFF) {
+            text = text.slice(1);
+        }
+        return text;
+    }
+    async searchDocs(query) {
+        var _a, _b, _c;
+        const body = JSON.stringify({
+            requests: [
+                {
+                    query,
+                    indexName: 'cloudbase',
+                    params: ALGOLIA_SEARCH_PARAMS
+                }
+            ]
+        });
+        const res = await (0, http_request_1.fetch)(ALGOLIA_SEARCH_URL, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body
+        });
+        const hits = (_c = (_b = (_a = res === null || res === void 0 ? void 0 : res.results) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.hits) !== null && _c !== void 0 ? _c : [];
+        return hits.map((hit) => {
+            var _a, _b;
+            const levels = ['lvl6', 'lvl5', 'lvl4', 'lvl3', 'lvl2', 'lvl1', 'lvl0'];
+            const title = (_a = levels.map(l => { var _a; return (_a = hit.hierarchy) === null || _a === void 0 ? void 0 : _a[l]; }).find(Boolean)) !== null && _a !== void 0 ? _a : '';
+            return {
+                url: hit.url,
+                title,
+                content: (_b = hit.content) !== null && _b !== void 0 ? _b : null
+            };
+        });
+    }
+    async getCategory() {
+        return (0, http_request_1.fetch)(CATEGORY_URL);
+    }
+    // Case: tcb docs read PHP（模糊匹配出 "PHP 快速开始"，处理命令行空格截断问题）
+    // 在整棵树中查找以 prefix + 空格 开头的唯一 key
+    findByKeyPrefix(node, prefix) {
+        if (typeof node === 'string') {
+            return null;
+        }
+        for (const [key, value] of Object.entries(node)) {
+            if (key.startsWith(prefix + ' ')) {
+                if (typeof value === 'string') {
+                    return { type: 'doc', data: value };
+                }
+                else if (typeof value === 'object') {
+                    return { type: 'module', data: value };
+                }
+            }
+            if (typeof value === 'object') {
+                const found = this.findByKeyPrefix(value, prefix);
+                if (found) {
+                    return found;
+                }
+            }
+        }
+        return null;
+    }
+    // Case: tcb docs read 云托管.快速开始..NET 快速开始
+    // 使用贪心匹配策略：优先匹配最长的 key（避免 ".NET" 被错误分割）按分隔路径查找
+    // 若从根节点无法匹配，则在整棵树中深度优先搜索，支持输入中间路径段
+    findByDotPath(category, dotPath) {
+        const rootResult = this.matchDotPath(category, dotPath);
+        if (rootResult) {
+            return rootResult;
+        }
+        return this.searchDotPathInTree(category, dotPath);
+    }
+    // 从每个子节点尝试匹配 dotPath 支持中间路径段搜索
+    searchDotPathInTree(node, dotPath) {
+        if (typeof node !== 'object' || node === null) {
+            return null;
+        }
+        for (const value of Object.values(node)) {
+            if (typeof value === 'object' && value !== null) {
+                const result = this.matchDotPath(value, dotPath);
+                if (result) {
+                    return result;
+                }
+                const nested = this.searchDotPathInTree(value, dotPath);
+                if (nested) {
+                    return nested;
+                }
+            }
+        }
+        return null;
+    }
+    // 递归匹配点分隔路径
+    matchDotPath(node, remainingPath) {
+        if (!remainingPath) {
+            if (typeof node === 'string') {
+                return { type: 'doc', data: node };
+            }
+            else if (typeof node === 'object' && node !== null) {
+                return { type: 'module', data: node };
+            }
+            return null;
+        }
+        // 当前节点不是对象，无法继续匹配
+        if (typeof node !== 'object' || node === null) {
+            return null;
+        }
+        // 获取所有 key，按长度降序排序（贪心策略：优先匹配长 key）
+        const keys = Object.keys(node).sort((a, b) => b.length - a.length);
+        for (const key of keys) {
+            // 情况1: 完全匹配（路径末尾）
+            if (remainingPath === key) {
+                const value = node[key];
+                if (typeof value === 'string') {
+                    return { type: 'doc', data: value };
+                }
+                else if (typeof value === 'object') {
+                    return { type: 'module', data: value };
+                }
+            }
+            // 情况2: 前缀匹配（还有下级路径）
+            if (remainingPath.startsWith(key + '.')) {
+                const nextPath = remainingPath.slice(key.length + 1);
+                const result = this.matchDotPath(node[key], nextPath);
+                if (result) {
+                    return result;
+                }
+            }
+        }
+        // 情况3: 模糊前缀匹配（key 含空格，命令行未加引号时 remainingPath 被空格截断）
+        // 例如: remainingPath = "PHP" 匹配 key = "PHP 快速开始" 避免含空格时无法匹配 case：云托管.快速开始.PHP 快速开始
+        // 仅在 remainingPath 不含点时使用（确保是最后一个路径段）
+        if (!remainingPath.includes('.')) {
+            const fuzzyMatches = keys.filter(k => k.startsWith(remainingPath + ' '));
+            if (fuzzyMatches.length === 1) {
+                const value = node[fuzzyMatches[0]];
+                if (typeof value === 'string') {
+                    return { type: 'doc', data: value };
+                }
+                else if (typeof value === 'object') {
+                    return { type: 'module', data: value };
+                }
+            }
+        }
+        return null;
+    }
+    // Case: tcb docs read 微信生态（"微信生态"是嵌套在"社区/最佳实践"下的二级模块）
+    // 递归查找嵌套模块（不一定是顶级key）
+    findNestedModule(node, targetName) {
+        if (typeof node === 'string') {
+            return null;
+        }
+        for (const [key, value] of Object.entries(node)) {
+            if (key === targetName && typeof value === 'object') {
+                return value;
+            }
+            // 继续递归搜索
+            if (typeof value === 'object') {
+                const found = this.findNestedModule(value, targetName);
+                if (found) {
+                    return found;
+                }
+            }
+        }
+        return null;
+    }
+    // Case: tcb docs read 小程序快速开始（通过文档标题精确查找）
+    // 递归查找文档路径（匹配key而不是value）
+    findDocPathByTitle(node, targetTitle) {
+        if (typeof node === 'string') {
+            return null;
+        }
+        for (const [key, value] of Object.entries(node)) {
+            if (key === targetTitle && typeof value === 'string') {
+                return value;
+            }
+            if (typeof value === 'object') {
+                const found = this.findDocPathByTitle(value, targetTitle);
+                if (found) {
+                    return found;
+                }
+            }
+        }
+        return null;
+    }
+}
+exports.DocsService = DocsService;

package/lib/docs/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/index.js

@@ -1,6 +1,7 @@
 "use strict";
 const context_1 = require("./context");
 const environmentManager_1 = require("./environmentManager");
+const docs_1 = require("./docs");
 class CloudBase {
     /**
      * init 初始化 为单例
@@ -81,6 +82,12 @@ class CloudBase {
     get user() {
         return this.currentEnvironment().getUserService();
     }
+    get docs() {
+        if (!this.docsService) {
+            this.docsService = new docs_1.DocsService();
+        }
+        return this.docsService;
+    }
     getEnvironmentManager() {
         return this.environmentManager;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cloudbase/manager-node",
-    "version": "4.11.0-alpha.0",
+    "version": "4.11.0-alpha.2",
     "description": "The node manage service api for cloudbase.",
     "main": "lib/index.js",
     "scripts": {

package/types/docs/index.d.ts

@@ -0,0 +1,37 @@
+import { SearchResult, ModuleDocs } from './types';
+export declare class DocsService {
+    listModules(): Promise<string[]>;
+    /**
+     * Case: tcb docs read 快速开始
+     * 根据模块名获取该模块下的所有文档（返回嵌套的对象结构）
+     */
+    listModuleDocs(moduleName: string): Promise<ModuleDocs>;
+    /**
+     * Case: tcb docs read <任意输入>
+     * 统一的查找入口，自动识别输入格式并返回模块数据或文档URL
+     *
+     * 支持的输入格式：
+     * 1. URL路径格式（包含 /，相对或完整）: tcb docs read quick-start/create-env
+     * 2. 点分隔路径: tcb docs read 云托管.快速开始..NET 快速开始
+     * 3. 模块名: tcb docs read 快速开始 「命中第一个 底下其他同理」
+     * 4. 嵌套模块名: tcb docs read 微信生态（嵌套在"社区.最佳实践"下）
+     * 5. 文档标题: tcb docs read 小程序快速开始
+     * 6. 前缀模糊匹配: tcb docs read PHP（匹配 "PHP 快速开始"）
+     */
+    findByName(input: string): Promise<{
+        type: 'module';
+        data: ModuleDocs;
+    } | {
+        type: 'doc';
+        data: string;
+    }>;
+    readDoc(docPath: string): Promise<string>;
+    searchDocs(query: string): Promise<SearchResult[]>;
+    private getCategory;
+    private findByKeyPrefix;
+    private findByDotPath;
+    private searchDotPathInTree;
+    private matchDotPath;
+    private findNestedModule;
+    private findDocPathByTitle;
+}

package/types/docs/types.d.ts

@@ -0,0 +1,24 @@
+export type CategoryNode = string | {
+    [key: string]: CategoryNode;
+};
+export interface Category {
+    [key: string]: CategoryNode;
+}
+export interface ModuleDocs {
+    [key: string]: CategoryNode;
+}
+export interface DocEntry {
+    title: string;
+    path: string;
+}
+export interface SearchHit {
+    url: string;
+    content: string | null;
+    type: string;
+    hierarchy: Record<string, string | null>;
+}
+export interface SearchResult {
+    url: string;
+    title: string;
+    content: string | null;
+}

package/types/index.d.ts

@@ -12,6 +12,7 @@ import { ThirdService } from './third';
 import { AccessService } from './access';
 import { UserService } from './user';
 import { CloudBaseRunService } from './cloudBaseRun';
+import { DocsService } from './docs';
 interface CloudBaseConfig {
     secretId?: string;
     secretKey?: string;
@@ -37,6 +38,7 @@ declare class CloudBase {
     private context;
     private cloudBaseConfig;
     private environmentManager;
+    private docsService;
     constructor(config?: CloudBaseConfig);
     addEnvironment(envId: string): void;
     currentEnvironment(): Environment;
@@ -52,6 +54,7 @@ declare class CloudBase {
     get env(): EnvService;
     get third(): ThirdService;
     get user(): UserService;
+    get docs(): DocsService;
     getEnvironmentManager(): EnvironmentManager;
     getManagerConfig(): CloudBaseConfig;
     get isInternalEndpoint(): Boolean;