@cloudbase/toolbox 0.7.20 → 0.7.21-beta.0

package/lib/auth/common.d.ts

@@ -1,4 +1,10 @@
+import { LocalStore } from '../localstore';
 import { Credential, WebAuthCredential, RequestConfig } from '../types';
+export declare const DEFAULT_CLIENT_ID = "cloudbase-cli";
+export declare const configStore: LocalStore<{
+    customOAuthEndpoint?: string;
+    client_id?: string;
+}>;
 export declare function checkAuth(credential: Credential, options?: RequestConfig): Promise<any>;
 export declare function resolveCredential(data: Partial<Credential> & Partial<WebAuthCredential>): Credential;
 export declare function resolveWebCredential(credential: Credential): WebAuthCredential;

package/lib/auth/common.js

@@ -9,9 +9,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveWebCredential = exports.resolveCredential = exports.checkAuth = void 0;
+exports.resolveWebCredential = exports.resolveCredential = exports.checkAuth = exports.configStore = exports.DEFAULT_CLIENT_ID = void 0;
 const cloud_api_1 = require("@cloudbase/cloud-api");
 const config_1 = require("../config");
+const localstore_1 = require("../localstore");
+exports.DEFAULT_CLIENT_ID = 'cloudbase-cli';
+exports.configStore = new localstore_1.LocalStore({}, 'config');
 // 调用 CheckTcbService 接口，检查密钥是否有效
 // 相比 DescribeEnvs，该接口不会返回环境列表，仅验证登录态，性能更好
 function checkAuth(credential, options = {}) {
@@ -39,7 +42,7 @@ function checkAuth(credential, options = {}) {
 exports.checkAuth = checkAuth;
 // 兼容解析旧的登录态
 function resolveCredential(data) {
-    let { secretId, secretKey, token, accessTokenExpired, tmpSecretId, tmpSecretKey, tmpToken, tmpExpired, expired, authTime, refreshToken, uin, hash, envId } = data;
+    let { secretId, secretKey, token, accessTokenExpired, tmpSecretId, tmpSecretKey, tmpToken, tmpExpired, expired, authTime, refreshToken, uin, hash, envId, envIds, envList, envBillingInfoList } = data;
     // 兼容旧的登录态信息
     token = token || tmpToken;
     secretId = secretId || tmpSecretId;
@@ -55,12 +58,15 @@ function resolveCredential(data) {
         refreshToken,
         uin,
         hash,
-        envId
+        envId,
+        envIds,
+        envList,
+        envBillingInfoList
     };
 }
 exports.resolveCredential = resolveCredential;
 function resolveWebCredential(credential) {
-    const { secretId, secretKey, token, accessTokenExpired, expired, authTime, refreshToken, uin, hash, envId } = credential;
+    const { secretId, secretKey, token, accessTokenExpired, expired, authTime, refreshToken, uin, hash, envId, envIds, envList, envBillingInfoList } = credential;
     const webCredential = {
         tmpSecretId: secretId,
         tmpSecretKey: secretKey,
@@ -71,7 +77,10 @@ function resolveWebCredential(credential) {
         refreshToken,
         uin,
         hash,
-        envId
+        envId,
+        envIds,
+        envList,
+        envBillingInfoList
     };
     return webCredential;
 }

package/lib/auth/credential.js

@@ -8,6 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCredentialWithoutCheck = exports.checkAndGetCredential = exports.isCamRefused = exports.refreshTmpToken = exports.getCredentialData = exports.ENV_NAME = exports.authStore = void 0;
 const cloud_api_1 = require("@cloudbase/cloud-api");
@@ -67,12 +78,53 @@ function refreshTmpToken(metaData) {
         const mac = yield (0, system_1.getMacAddress)();
         const hash = (0, coding_1.md5Encoding)(mac);
         metaData.hash = hash;
+        // 读取自定义 OAuth 配置
+        const customOAuthEndpoint = yield common_1.configStore.get('customOAuthEndpoint');
+        if (customOAuthEndpoint) {
+            // ===== 自定义模式 =====
+            const clientId = (yield common_1.configStore.get('client_id')) || common_1.DEFAULT_CLIENT_ID;
+            const body = {
+                grant_type: metaData.isLogout ? 'revoke_token' : 'refresh_token',
+                refresh_token: metaData.refreshToken,
+                client_id: clientId,
+            };
+            const res = yield async_1.AsyncMerge.merge(() => (0, cloud_api_1.fetch)(`${customOAuthEndpoint}/token`, {
+                method: 'POST',
+                timeout: 15000,
+                body: JSON.stringify(body),
+                headers: { 'Content-Type': 'application/json' }
+            }, (0, system_1.getProxy)()), 'refreshToken', {
+                maxAge: 5000
+            });
+            // 自定义模式错误响应：{ error, error_description }
+            if (res.error) {
+                throw new error_1.CloudBaseError(res.error_description || res.error, {
+                    action: metaData.isLogout ? 'RevokeToken' : 'RefreshAccessToken',
+                    code: res.error,
+                });
+            }
+            // 登出（revoke_token）成功，无需返回凭证
+            if (metaData.isLogout) {
+                return res;
+            }
+            // 刷新 token 成功响应直接是 WebAuthCredential（无 code/data 包装）
+            if (!res || !res.tmpSecretId) {
+                throw new error_1.CloudBaseError('Token 刷新失败，可能是网络访问异常，请尝试重试');
+            }
+            if (metaData.envId) {
+                res.envId = metaData.envId;
+            }
+            return res;
+        }
+        // ===== 标准模式 =====
         const credential = (0, common_1.resolveWebCredential)(metaData);
+        // 发送请求时不带 envIds/envList/envBillingInfoList
+        const { envIds: _a, envList: _b, envBillingInfoList: _c } = credential, requestBody = __rest(credential, ["envIds", "envList", "envBillingInfoList"]);
         const res = yield async_1.AsyncMerge.merge(() => (0, cloud_api_1.fetch)(refreshTokenUrl, {
             method: 'POST',
             // 超时时间：15S
             timeout: 15000,
-            body: JSON.stringify(credential),
+            body: JSON.stringify(requestBody),
             headers: { 'Content-Type': 'application/json' }
         }, (0, system_1.getProxy)()), 'refreshToken', {
             maxAge: 5000

package/lib/auth/oauth.js

@@ -16,9 +16,24 @@ const error_1 = require("../error");
 const coding_1 = require("../coding");
 const system_1 = require("../system");
 const web_auth_1 = require("./web-auth");
+const common_1 = require("./common");
 /** 默认国内站 应用侧可通过 getOAuthEndpoint 覆写 */
-const OAUTH_ENDPOINT = process.env.TCB_OAUTH_ENDPOINT || 'https://tcb-api.cloud.tencent.com/qcloud-tcb/v1/oauth';
-const DEFAULT_CLIENT_ID = 'cloudbase-toolbox';
+const DEFAULT_OAUTH_ENDPOINT = process.env.TCB_OAUTH_ENDPOINT || 'https://tcb-api.cloud.tencent.com/qcloud-tcb/v1/oauth';
+/**
+ * 解析 OAuth Endpoint，优先级：getOAuthEndpoint > customOAuthEndpoint > default
+ */
+function resolveOAuthEndpoint(getOAuthEndpoint) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (getOAuthEndpoint) {
+            return getOAuthEndpoint(DEFAULT_OAUTH_ENDPOINT);
+        }
+        const customOAuthEndpoint = yield common_1.configStore.get('customOAuthEndpoint');
+        if (customOAuthEndpoint) {
+            return customOAuthEndpoint;
+        }
+        return DEFAULT_OAUTH_ENDPOINT;
+    });
+}
 const POLL_ERROR_CODES = {
     AUTHORIZATION_PENDING: 'authorization_pending',
     SLOW_DOWN: 'slow_down',
@@ -27,12 +42,12 @@ const POLL_ERROR_CODES = {
 };
 const SUCCESS_CODE = 'NORMAL';
 function fetchDeviceCode(options = {}) {
-    const { client_id = DEFAULT_CLIENT_ID, endpoint = OAUTH_ENDPOINT } = options;
+    const { client_id = common_1.DEFAULT_CLIENT_ID, endpoint = DEFAULT_OAUTH_ENDPOINT } = options;
     return (0, net_1.postFetch)(`${endpoint}/device/code`, { client_id });
 }
 function fetchPollToken(options) {
     return __awaiter(this, void 0, void 0, function* () {
-        const { device_code, client_id = DEFAULT_CLIENT_ID, endpoint = OAUTH_ENDPOINT } = options;
+        const { device_code, client_id = common_1.DEFAULT_CLIENT_ID, endpoint = DEFAULT_OAUTH_ENDPOINT } = options;
         const mac = yield (0, system_1.getMacAddress)();
         return (0, net_1.postFetch)(`${endpoint}/token`, {
             device_code,
@@ -89,7 +104,7 @@ function unwrapTokenResponse(raw, custom) {
 function getAuthTokenByDeviceFlow(options = {}) {
     return __awaiter(this, void 0, void 0, function* () {
         const { client_id, onDeviceCode, getOAuthEndpoint, getAuthUrl, silent, custom } = options;
-        const endpoint = getOAuthEndpoint ? getOAuthEndpoint(OAUTH_ENDPOINT) : OAUTH_ENDPOINT;
+        const endpoint = yield resolveOAuthEndpoint(getOAuthEndpoint);
         // ---- 获取 device code ----
         const deviceCodeRaw = yield fetchDeviceCode({ client_id, endpoint });
         const { data: deviceCodeData } = unwrapDeviceCodeResponse(deviceCodeRaw, !!custom);

package/lib/types.d.ts

@@ -1,3 +1,88 @@
+export interface EnvInfo {
+    EnvId: string;
+    PackageType?: string;
+    EnvType?: string;
+    IsDauPackage?: boolean;
+    Source?: string;
+    Alias?: string;
+    Status?: string;
+    PayMode?: string;
+    Tags?: Record<string, string>[];
+    PackageName?: string;
+    IsAutoDegrade?: boolean;
+    EnvChannel?: string;
+    Region?: string;
+    IsDefault?: boolean;
+    PackageId?: string;
+    CreateTime?: string;
+    UpdateTime?: string;
+    Databases?: {
+        InstanceId: string;
+        Region: string;
+        Status: string;
+        UpdateTime: string;
+    }[];
+    Storages?: {
+        Region: string;
+        Bucket: string;
+        CdnDomain: string;
+        AppId: string;
+    }[];
+    Functions?: {
+        Namespace: string;
+        Region: string;
+    }[];
+    LogServices?: {
+        LogsetName: string;
+        LogsetId: string;
+        TopicName: string;
+        TopicId: string;
+        Region: string;
+    }[];
+    StaticStorages?: {
+        Type: string;
+        Bucket: string;
+        Region: string;
+        Status: string;
+    }[];
+    CustomLogServices?: {
+        ClsTopicId: string;
+        ClsRegion: string;
+        ClsLogsetId: string;
+        CreateTime: string;
+    }[];
+}
+export interface OrderInfo {
+    TranId?: string;
+    PackageId?: string;
+    TranType?: string;
+    TranStatus?: string;
+    UpdateTime?: string;
+    CreateTime?: string;
+    PayMode?: string;
+    ExtensionId?: string;
+    ResourceReady?: string;
+    Flag?: string;
+    ReqBody?: string;
+}
+export interface EnvBillingInfoItem {
+    EnvId: string;
+    PackageId?: string;
+    PackageName?: string;
+    IsAutoRenew?: boolean;
+    Status?: string;
+    PayMode?: string;
+    IsolatedTime?: string;
+    ExpireTime?: string;
+    CreateTime?: string;
+    UpdateTime?: string;
+    FreeQuota?: string;
+    PaymentChannel?: string;
+    ExtPackageType?: string;
+    OrderInfo?: OrderInfo;
+    IsAlwaysFree?: boolean;
+    EnableOverrun?: boolean;
+}
 export interface Credential {
     secretId: string;
     secretKey: string;
@@ -9,6 +94,12 @@ export interface Credential {
     uin?: string;
     hash?: string;
     envId?: string;
+    /** 该用户可用的环境 ID 列表（有序，与 envList 顺序一致） */
+    envIds?: string[];
+    /** 环境批量详情，结构同 DescribeEnvs 接口返回的 EnvList */
+    envList?: EnvInfo[];
+    /** 环境计费信息列表，结构同 DescribeBillingInfo 接口返回的 EnvBillingInfoList */
+    envBillingInfoList?: EnvBillingInfoItem[];
 }
 export interface WebAuthCredential {
     tmpSecretId: string;
@@ -21,6 +112,12 @@ export interface WebAuthCredential {
     uin?: string;
     hash?: string;
     envId?: string;
+    /** 该用户可用的环境 ID 列表（有序，与 envList 顺序一致） */
+    envIds?: string[];
+    /** 环境批量详情，结构同 DescribeEnvs 接口返回的 EnvList */
+    envList?: EnvInfo[];
+    /** 环境计费信息列表，结构同 DescribeBillingInfo 接口返回的 EnvBillingInfoList */
+    envBillingInfoList?: EnvBillingInfoItem[];
 }
 export interface RequestConfig {
     proxy?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cloudbase/toolbox",
-    "version": "0.7.20",
+    "version": "0.7.21-beta.0",
     "description": "The toolbox for cloudbase",
     "main": "lib/index.js",
     "scripts": {