@cloudbase/toolbox 0.7.17-beta.2 → 0.7.17

package/lib/auth/index.d.ts

@@ -43,6 +43,10 @@ export interface WebAuthOptions {
     client_id?: string;
     /** Device Flow 回调，获取设备码后通知调用方 */
     onDeviceCode?: DeviceFlowOptions['onDeviceCode'];
+    /** 自定义 OAuth API 请求的 endpoint */
+    getOAuthEndpoint?: DeviceFlowOptions['getOAuthEndpoint'];
+    /** 静默模式，不打印任何日志 */
+    silent?: boolean;
 }
 export interface LoginByApiSecretOptions {
     /**

package/lib/auth/index.js

@@ -82,7 +82,7 @@ class AuthSupervisor {
      */
     loginByWebAuth(options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { getAuthUrl, throwError, noBrowser, callbackTimeout, flow = 'device', client_id, onDeviceCode } = options;
+            const { getAuthUrl, throwError, noBrowser, callbackTimeout, flow = 'device', client_id, onDeviceCode, getOAuthEndpoint, silent } = options;
             if (this.cacheCredential && this.needCache && !this.isCacheExpire()) {
                 return this.cacheCredential;
             }
@@ -95,11 +95,12 @@ class AuthSupervisor {
                 credential = yield (0, web_auth_1.getAuthTokenFromWeb)({
                     getAuthUrl,
                     noBrowser,
-                    callbackTimeout
+                    callbackTimeout,
+                    silent
                 });
             }
             else {
-                credential = yield (0, oauth_1.getAuthTokenByDeviceFlow)({ client_id, onDeviceCode });
+                credential = yield (0, oauth_1.getAuthTokenByDeviceFlow)({ client_id, onDeviceCode, getOAuthEndpoint, getAuthUrl, silent });
             }
             credential = (0, common_1.resolveCredential)(credential);
             try {

package/lib/auth/oauth.d.ts

@@ -7,5 +7,11 @@ export interface DeviceFlowOptions {
         device_code: string;
         expires_in: number;
     }) => void;
+    /** 自定义 OAuth API 请求的 endpoint */
+    getOAuthEndpoint?: (rawEndpoint: string) => string;
+    /** 自定义授权跳转链接 */
+    getAuthUrl?: (rawUrl: string) => string;
+    /** 静默模式，不打印任何日志 */
+    silent?: boolean;
 }
 export declare function getAuthTokenByDeviceFlow(options?: DeviceFlowOptions): Promise<Credential>;

package/lib/auth/oauth.js

@@ -16,6 +16,7 @@ const error_1 = require("../error");
 const coding_1 = require("../coding");
 const system_1 = require("../system");
 const web_auth_1 = require("./web-auth");
+/** 默认国内站 应用侧可通过 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 POLL_ERROR_CODES = {
@@ -26,14 +27,14 @@ const POLL_ERROR_CODES = {
 };
 const SUCCESS_CODE = 'NORMAL';
 function fetchDeviceCode(options = {}) {
-    const { client_id = DEFAULT_CLIENT_ID } = options;
-    return (0, net_1.postFetch)(`${OAUTH_ENDPOINT}/device/code`, { client_id });
+    const { client_id = DEFAULT_CLIENT_ID, endpoint = 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 } = options;
+        const { device_code, client_id = DEFAULT_CLIENT_ID, endpoint = OAUTH_ENDPOINT } = options;
         const mac = yield (0, system_1.getMacAddress)();
-        return (0, net_1.postFetch)(`${OAUTH_ENDPOINT}/token`, {
+        return (0, net_1.postFetch)(`${endpoint}/token`, {
             device_code,
             client_id,
             grant_type: 'urn:ietf:params:oauth:grant-type:device_code',
@@ -52,8 +53,9 @@ function sleep(ms) {
 }
 function getAuthTokenByDeviceFlow(options = {}) {
     return __awaiter(this, void 0, void 0, function* () {
-        const { client_id, onDeviceCode } = options;
-        const deviceCodeResp = yield fetchDeviceCode({ client_id });
+        const { client_id, onDeviceCode, getOAuthEndpoint, getAuthUrl, silent } = options;
+        const endpoint = getOAuthEndpoint ? getOAuthEndpoint(OAUTH_ENDPOINT) : OAUTH_ENDPOINT;
+        const deviceCodeResp = yield fetchDeviceCode({ client_id, endpoint });
         if (deviceCodeResp.code !== SUCCESS_CODE) {
             throw new error_1.CloudBaseError('Device Flow fetchDeviceCode failed', {
                 code: deviceCodeResp.code,
@@ -61,15 +63,17 @@ function getAuthTokenByDeviceFlow(options = {}) {
             });
         }
         const { device_code, user_code, expires_in, interval } = deviceCodeResp.result;
-        // const defaultVerificationUri = deviceCodeResp.result.verification_uri || `${CLI_AUTH_BASE_URL}#/cli-auth`;
         // 暂时不消费 verification_uri，由客户端控制跳转
         const defaultVerificationUri = `${web_auth_1.CLI_AUTH_BASE_URL}#/cli-auth`;
         // from=cli 后续考虑改用 client_id，因为 toolbox 作为公共依赖，可能被不同 client 所引用
-        const verification_uri = `${defaultVerificationUri}?user_code=${user_code}&from=cli&mode=device`;
-        // 打印授权信息，引导用户操作
-        console.log('\n\n若链接未自动打开，请手动复制至浏览器，或尝试其他登录方式:');
-        console.log(`\n${verification_uri}`);
-        console.log(`\n用户码: ${user_code}\n`);
+        const rawVerificationUri = `${defaultVerificationUri}?user_code=${user_code}&from=cli&flow=device`;
+        const verification_uri = getAuthUrl ? getAuthUrl(rawVerificationUri) : rawVerificationUri;
+        if (!silent) {
+            // 打印授权信息，引导用户操作
+            console.log('\n\n若链接未自动打开，请手动复制至浏览器，或尝试其他登录方式:');
+            console.log(`\n${verification_uri}`);
+            console.log(`\n用户码: ${user_code}\n`);
+        }
         // 尝试自动打开授权页面
         yield (0, web_1.openUrl)(verification_uri);
         if (onDeviceCode) {
@@ -81,7 +85,7 @@ function getAuthTokenByDeviceFlow(options = {}) {
             yield sleep(pollInterval * 1000);
             let resp;
             try {
-                resp = yield fetchPollToken({ device_code, interval: pollInterval, client_id });
+                resp = yield fetchPollToken({ device_code, interval: pollInterval, client_id, endpoint });
             }
             catch (e) {
                 throw new error_1.CloudBaseError('Device Flow 轮询请求失败', { original: e });

package/lib/auth/web-auth.d.ts

@@ -4,4 +4,6 @@ export declare function getAuthTokenFromWeb(options?: {
     getAuthUrl?: (rawUrl: string) => string;
     noBrowser?: boolean;
     callbackTimeout?: number;
+    /** 静默模式，不打印任何日志 */
+    silent?: boolean;
 }): Promise<Credential>;

package/lib/auth/web-auth.js

@@ -18,7 +18,7 @@ exports.CLI_AUTH_BASE_URL = 'https://tcb.cloud.tencent.com/dev';
 // 打开云开发控制台，获取授权
 function getAuthTokenFromWeb(options = {}) {
     return __awaiter(this, void 0, void 0, function* () {
-        const { getAuthUrl, noBrowser, callbackTimeout } = options;
+        const { getAuthUrl, noBrowser, callbackTimeout, silent } = options;
         const mac = yield (0, system_1.getMacAddress)();
         const os = (0, system_1.getOSInfo)();
         const macHash = (0, coding_1.md5Encoding)(mac);
@@ -44,7 +44,8 @@ function getAuthTokenFromWeb(options = {}) {
             return cliAuthUrl;
         }, 'login', {
             noBrowser,
-            callbackTimeout
+            callbackTimeout,
+            silent
         });
         const credential = (0, common_1.resolveCredential)(query);
         return credential;

package/lib/web/web.d.ts

@@ -6,6 +6,8 @@ export type CheckFn = (query: IQuery) => Promise<void>;
 export interface GetDataFromWebOptions {
     noBrowser?: boolean;
     callbackTimeout?: number;
+    /** 静默模式，不打印任何日志，也不自动打开浏览器 */
+    silent?: boolean;
 }
 export declare function isTruthyFlag(value?: string): boolean;
 export declare function openUrl(url: string): Promise<boolean>;

package/lib/web/web.js

@@ -118,17 +118,20 @@ function openUrl(url) {
 exports.openUrl = openUrl;
 // 从 Web 页面中获取数据
 function getDataFromWeb(getUrl, type, options = {}) {
-    var _a, _b;
+    var _a, _b, _c;
     return __awaiter(this, void 0, void 0, function* () {
         const { server, port } = yield createLocalServer();
         const noBrowser = (_a = options.noBrowser) !== null && _a !== void 0 ? _a : isTruthyFlag(process.env.TCB_NO_BROWSER);
         const callbackTimeout = (_b = options.callbackTimeout) !== null && _b !== void 0 ? _b : 180000;
+        const silent = (_c = options.silent) !== null && _c !== void 0 ? _c : false;
         if (!Number.isFinite(callbackTimeout) || callbackTimeout <= 0) {
             throw new error_1.CloudBaseError('callbackTimeout must be a positive number');
         }
         const url = getUrl(port);
-        console.log('\n\n若链接未自动打开，请手动复制至浏览器，或尝试其他登录方式:');
-        console.log(`\n${url}\n`);
+        if (!silent) {
+            console.log('\n\n若链接未自动打开，请手动复制至浏览器，或尝试其他登录方式:');
+            console.log(`\n${url}\n`);
+        }
         if (!noBrowser) {
             // 对 url 转码, 避免 wsl 无法正常打开地址
             // https://www.npmjs.com/package/open#url

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cloudbase/toolbox",
-    "version": "0.7.17-beta.2",
+    "version": "0.7.17",
     "description": "The toolbox for cloudbase",
     "main": "lib/index.js",
     "scripts": {
@@ -67,4 +67,4 @@
         }
     },
     "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
-}
+}