@cloudbase/manager-node 4.2.10 → 4.3.0

package/lib/utils/index.js

@@ -1,36 +1,54 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.upperCaseObjKey = exports.upperCaseStringFisrt = exports.sleep = exports.rsaEncrypt = exports.getEnvVar = exports.getRuntime = exports.compressToZip = void 0;
-const fs_1 = __importDefault(require("fs"));
+exports.guid6 = void 0;
+exports.compressToZip = compressToZip;
+exports.downloadAndExtractRemoteZip = downloadAndExtractRemoteZip;
+exports.getRuntime = getRuntime;
+exports.getEnvVar = getEnvVar;
+exports.rsaEncrypt = rsaEncrypt;
+exports.sleep = sleep;
+exports.upperCaseStringFisrt = upperCaseStringFisrt;
+exports.upperCaseObjKey = upperCaseObjKey;
+exports.fetchTemplates = fetchTemplates;
 const archiver_1 = __importDefault(require("archiver"));
 const crypto_1 = __importDefault(require("crypto"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const lodash_1 = __importDefault(require("lodash"));
+const path_1 = __importDefault(require("path"));
+const stream_1 = require("stream");
+const unzipper_1 = __importDefault(require("unzipper"));
 const constant_1 = require("../constant");
-var uuid_1 = require("./uuid");
-Object.defineProperty(exports, "guid6", { enumerable: true, get: function () { return uuid_1.guid6; } });
-__exportStar(require("./cloud-api-request"), exports);
+const http_request_1 = require("./http-request");
 __exportStar(require("./auth"), exports);
+__exportStar(require("./cloud-api-request"), exports);
 __exportStar(require("./cloudbase-request"), exports);
-__exportStar(require("./http-request"), exports);
 __exportStar(require("./envLazy"), exports);
 __exportStar(require("./fs"), exports);
+__exportStar(require("./http-request"), exports);
+var uuid_1 = require("./uuid");
+Object.defineProperty(exports, "guid6", { enumerable: true, get: function () { return uuid_1.guid6; } });
 async function compressToZip(option) {
     const { dirPath, outputPath, ignore, pattern = '**/*' } = option;
     return new Promise((resolve, reject) => {
-        const output = fs_1.default.createWriteStream(outputPath);
-        const archive = archiver_1.default('zip');
+        const output = fs_extra_1.default.createWriteStream(outputPath);
+        const archive = (0, archiver_1.default)('zip');
         output.on('close', function () {
             resolve({
                 zipPath: outputPath,
@@ -51,15 +69,42 @@ async function compressToZip(option) {
         archive.finalize();
     });
 }
-exports.compressToZip = compressToZip;
+/**
+ * 下载并解压云托管模板到指定目录
+ * @param {string} downloadUrl 模板下载地址
+ * @param {string} targetPath 目标路径
+ * @returns {Promise<void>}
+ * @throws 当下载失败或解压失败时抛出错误
+ */
+async function downloadAndExtractRemoteZip(downloadUrl, targetPath) {
+    const downloadResponse = await (0, http_request_1.fetchStream)(downloadUrl);
+    if (!downloadResponse.ok) {
+        throw new Error(`下载失败，状态码: ${downloadResponse.status}`);
+    }
+    if (!downloadResponse.body) {
+        throw new Error('下载响应中没有数据流');
+    }
+    // 将响应数据转为Buffer
+    const zipBuffer = Buffer.from(await downloadResponse.arrayBuffer());
+    // 创建目标目录
+    const dirPath = path_1.default.resolve(targetPath);
+    await fs_extra_1.default.ensureDir(dirPath);
+    // 使用unzipper解压
+    await new Promise((resolve, reject) => {
+        const bufferStream = new stream_1.PassThrough();
+        bufferStream.end(zipBuffer);
+        bufferStream
+            .pipe(unzipper_1.default.Extract({ path: dirPath }))
+            .on('close', resolve)
+            .on('error', reject);
+    });
+}
 function getRuntime() {
     return process.env[constant_1.ENV_NAME.ENV_RUNENV];
 }
-exports.getRuntime = getRuntime;
 function getEnvVar(envName) {
     return process.env[envName];
 }
-exports.getEnvVar = getEnvVar;
 function rsaEncrypt(data) {
     const buffer = Buffer.from(data);
     const encrypted = crypto_1.default.publicEncrypt({
@@ -68,7 +113,6 @@ function rsaEncrypt(data) {
     }, buffer);
     return encrypted.toString('base64');
 }
-exports.rsaEncrypt = rsaEncrypt;
 function sleep(time) {
     return new Promise(resolve => {
         setTimeout(() => {
@@ -76,11 +120,9 @@ function sleep(time) {
         }, time);
     });
 }
-exports.sleep = sleep;
 function upperCaseStringFisrt(str) {
     return str.slice(0, 1).toUpperCase().concat(str.slice(1));
 }
-exports.upperCaseStringFisrt = upperCaseStringFisrt;
 function upperCaseObjKey(object) {
     const type = Object.prototype.toString.call(object).slice(8, -1);
     if (type === 'Object') {
@@ -100,4 +142,15 @@ function upperCaseObjKey(object) {
     }
     return object;
 }
-exports.upperCaseObjKey = upperCaseObjKey;
+/**
+ * 获取函数模板列表
+ * @param type 函数模板类型，支持 'scfFunc' 和 'tcbrFunc'
+ * @returns
+ */
+async function fetchTemplates(types) {
+    const apiUrl = 'https://qcloud-tcb-console-1258344699.ap-shanghai.service.tcloudbase.com/func_tpl/v1.0/function_list/find?skip=0&limit=500';
+    const responseData = await (0, http_request_1.fetch)(apiUrl, {
+        method: 'POST'
+    });
+    return responseData.data.filter((item) => lodash_1.default.intersection(types, item.funcTypes).length > 0);
+}

package/lib/utils/runenv.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkIsInScf = void 0;
+exports.checkIsInScf = checkIsInScf;
 function checkIsInScf() {
     // TENCENTCLOUD_RUNENV
     return process.env.TENCENTCLOUD_RUNENV === 'SCF';
 }
-exports.checkIsInScf = checkIsInScf;

package/lib/utils/uuid.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.uuidv4 = exports.guid6 = void 0;
+exports.guid6 = guid6;
+exports.uuidv4 = uuidv4;
 // 环境 uuid
 function guid6() {
     return Math.floor((1 + Math.random()) * 0x1000000)
         .toString(16)
         .substring(1);
 }
-exports.guid6 = guid6;
 function uuidv4() {
     return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
         const r = (Math.random() * 16) | 0;
@@ -15,4 +15,3 @@ function uuidv4() {
         return v.toString(16);
     });
 }
-exports.uuidv4 = uuidv4;

package/package.json

@@ -1,15 +1,18 @@
 {
     "name": "@cloudbase/manager-node",
-    "version": "4.2.10",
+    "version": "4.3.0",
     "description": "The node manage service api for cloudbase.",
     "main": "lib/index.js",
     "scripts": {
         "build": "rimraf lib types && npx tsc",
-        "test": "jest --runInBand --detectOpenHandles --coverage --testTimeout=50000",
+        "test:coverage": "jest --runInBand --detectOpenHandles --coverage --testTimeout=50000",
+        "test": "jest --runInBand --detectOpenHandles --testTimeout=50000",
         "lint": "eslint \"./**/*.ts\"",
         "lint:fix": "eslint --fix \"./**/*.ts\"",
         "prepublishOnly": "npm run build",
-        "watch": "rimraf lib types && tsc -w"
+        "watch": "rimraf lib types && tsc -w",
+        "link": "node scripts/link.js",
+        "unlink": "node scripts/link.js -d"
     },
     "repository": {
         "type": "git",
@@ -19,9 +22,12 @@
     "license": "ISC",
     "typings": "types/index.d.ts",
     "devDependencies": {
+        "@lerna/create-symlink": "^6.4.1",
+        "@types/fs-extra": "^11.0.4",
         "@types/jest": "^24.0.18",
         "@types/node": "^12.7.4",
         "@types/node-fetch": "^2.5.0",
+        "@types/unzipper": "^0.10.11",
         "@typescript-eslint/eslint-plugin": "^3.7.1",
         "@typescript-eslint/parser": "^3.7.1",
         "eslint": "^7.6.0",
@@ -31,18 +37,21 @@
         "lint-staged": "^9.2.5",
         "rimraf": "^3.0.0",
         "ts-jest": "^24.1.0",
-        "typescript": "^3.8.3"
+        "typescript": "^5.8.3"
     },
     "dependencies": {
         "@cloudbase/database": "^0.6.2",
         "archiver": "^3.1.1",
-        "cos-nodejs-sdk-v5": "2.14.0",
+        "cos-nodejs-sdk-v5": "^2.14.0",
         "del": "^5.1.0",
+        "fs-extra": "^11.3.0",
         "https-proxy-agent": "^5.0.1",
+        "lodash": "^4.17.21",
         "make-dir": "^3.0.0",
         "micromatch": "^4.0.2",
         "node-fetch": "^2.6.0",
         "query-string": "^6.8.3",
+        "unzipper": "^0.12.3",
         "walkdir": "^0.4.1"
     },
     "husky": {
@@ -55,5 +64,6 @@
             "eslint --fix",
             "git add"
         ]
-    }
+    },
+    "packageManager": "yarn@1.22.22"
 }

package/scripts/link.js

@@ -0,0 +1,98 @@
+/**
+ * Tencent is pleased to support the open source community by making CloudBaseFramework - 云原生一体化部署工具 available.
+ *
+ * Copyright (C) 2020 THL A29 Limited, a Tencent company.  All rights reserved.
+ *
+ * Please refer to license text included with this package for license details.
+ */
+
+const os = require('os')
+const fs = require('fs')
+const fse = require('fs-extra')
+const del = require('del')
+const path = require('path')
+const mkdirp = require('mkdirp')
+const { execSync } = require('child_process')
+const { createSymlink } = require('@lerna/create-symlink')
+
+const globalNpmPath = execSync('npm root -g', {
+    encoding: 'utf-8'
+}).trim()
+// 如果不支持workspace 可以用下面写死
+// const globalNpmPath = '/usr/local/lib/node_modules';
+
+async function main() {
+    const unlink = process.argv?.[2] === '-d'
+    await linkCore(unlink)
+}
+
+async function linkCore(unlink = false) {
+    const jsonString = await fs.readFileSync(path.join(__dirname, '../package.json'))
+    const { name } = JSON.parse(jsonString)
+    await link(path.join(process.cwd()), path.join(globalNpmPath, '@cloudbase/cli'), name, unlink)
+}
+
+function isSymlink(path) {
+    const stats = fs.lstatSync(path)
+    return stats.isSymbolicLink()
+}
+
+// 将 global tcb cli 工具中的 framework-core link 到 packages/framework-core
+async function link(src, dest, packageName, unlink = false) {
+    const prevCwd = process.cwd()
+    const destPlugin = path.join(dest, 'node_modules', '@cloudbase')
+    // 确保目录存在
+    mkdirp.sync(destPlugin)
+    // 切换 cwd
+    process.chdir(destPlugin)
+
+    const pathName = packageName.replace('@cloudbase/', '')
+    const backupPathName = `${pathName}_backup`
+
+    if (unlink) {
+        if (fs.existsSync(pathName) && !isSymlink(pathName)) {
+            console.log(`【失败】${pathName} 不是软链接`, process.cwd())
+            return
+        }
+
+        if (fs.existsSync(pathName) && fs.existsSync(backupPathName)) {
+            // 删除软链接
+            del.sync([pathName])
+
+            // 恢复备份
+            fse.moveSync(backupPathName, pathName)
+
+            // 删除软链接
+            console.log('【成功】删除软链接：', process.cwd())
+        } else {
+            console.info(
+                `不存在 ${pathName} 或 ${backupPathName}，请重装安装 npm i @cloudbase/cli -g`,
+                process.cwd()
+            )
+        }
+    } else {
+        // 创建软链接
+
+        if (fs.existsSync(pathName)) {
+            if (!fs.existsSync(backupPathName)) {
+                // 不存在备份则进行备份
+
+                if (!isSymlink(pathName)) {
+                    // 不是软链接才备份
+                    fse.moveSync(pathName, backupPathName)
+                }
+            } else {
+                // 存在备份则直接删除
+                del.sync([pathName])
+            }
+        }
+
+        await createSymlink(src, pathName, 'junction')
+        console.log('【成功】创建软链接：', process.cwd())
+    }
+
+    // 切回源目录
+    process.chdir(prevCwd)
+}
+
+main()

package/tsconfig.json

@@ -11,7 +11,8 @@
         "declaration": true,
         "declarationDir": "./types",
         "experimentalDecorators": true,
-        "newLine": "LF"
+        "newLine": "LF",
+        "skipLibCheck": true
     },
     "include": ["src/**/*"],
     "exclude": ["node_modules", "test"]

package/types/cloudrun/index.d.ts

@@ -0,0 +1,81 @@
+import { Environment } from '../environment';
+import { IResponseInfo } from '../interfaces';
+import { CloudrunServerType, ICloudrunDetailResponse, ICloudrunListResponse, ITemplate } from './type';
+/**
+ * 云托管服务管理类
+ * 提供云托管服务的初始化、下载、列表查询和删除等功能
+ */
+export declare class CloudRunService {
+    private environment;
+    private tcbrService;
+    private tcbService;
+    constructor(environment: Environment);
+    /**
+     * 初始化云托管代码项目
+     * @param {Object} params 初始化参数
+     * @param {string} params.serverName 服务名称，将作为项目目录名
+     * @param {string} [params.template='helloworld'] 模板标识符，默认为'helloworld'
+     * @param {string} [params.targetPath='.'] 目标路径，默认为当前目录
+     * @returns {Promise<void>}
+     * @throws 当模板不存在、下载失败或解压失败时抛出错误
+     */
+    init(params: {
+        serverName: string;
+        template?: string;
+        targetPath?: string;
+    }): Promise<{
+        projectDir: string;
+    }>;
+    /**
+     * 下载云托管服务代码到本地目录
+     * @param {Object} params 下载参数
+     * @param {string} params.serverName 要下载的服务名称
+     * @param {string} params.targetPath 下载的目标路径(绝对路径或相对路径)
+     * @returns {Promise<void>}
+     * @throws 当以下情况发生时抛出错误:
+     * - 未找到服务版本
+     * - 获取下载地址失败
+     * - 下载或解压过程中出错
+     */
+    download(params: {
+        serverName: string;
+        targetPath: string;
+    }): Promise<void>;
+    /**
+     * 获取云托管服务列表
+     * @param {Object} [params] 查询参数
+     * @param {number} [params.pageSize] 每页数量
+     * @param {number} [params.pageNum] 页码
+     * @param {string} [params.serverName] 服务名称筛选
+     * @param {string} [params.serverType] 服务类型筛选
+     * @returns {Promise<ICloudrunListResponse>} 包含服务列表和总数等信息的响应对象
+     */
+    list(params?: {
+        pageSize?: number;
+        pageNum?: number;
+        serverName?: string;
+        serverType?: CloudrunServerType;
+    }): Promise<ICloudrunListResponse>;
+    /**
+     *查询云托管服务详情
+     * @param {Object} params 查询参数
+     * @param {string} params.serverName 要查询的服务名称
+     * @returns {Promise<ICloudrunDetailResponse>} 返回服务详情响应对象
+     */
+    detail(params: {
+        serverName: string;
+    }): Promise<ICloudrunDetailResponse>;
+    /**
+     * 删除指定的云托管服务
+     * @param {string} serverName - 要删除的服务名称，必须是在当前环境中已存在的服务
+     * @returns {Promise<IResponseInfo>} 返回删除操作的响应信息
+     */
+    delete(params: {
+        serverName: string;
+    }): Promise<IResponseInfo>;
+    /**
+     * 获取云托管服务模板列表
+     * @returns {Promise<ITemplate[]>} 返回模板数组
+     */
+    getTemplates(): Promise<ITemplate[]>;
+}