@cloudbase/manager-node 5.8.7-beta.0 → 5.8.8-beta.0

package/lib/utils/storage-config.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toPhysicalKey = toPhysicalKey;
+exports.toLogicalPath = toLogicalPath;
+exports.resolveStorageConfig = resolveStorageConfig;
+exports.resolveBucketConfig = resolveBucketConfig;
+const error_1 = require("../error");
+function trimSlashes(p) {
+    return p.replace(/^\/+|\/+$/g, '');
+}
+/**
+ * 逻辑路径 → COS 物理 Key：共享桶环境拼上 basePath 前缀，basePath 为空时原样返回
+ * cloudPath 为空或为 '/' 时返回 `${basePath}/`，即共享桶内本环境的根目录
+ */
+function toPhysicalKey(basePath, cloudPath = '') {
+    const base = trimSlashes(basePath || '');
+    if (!base) {
+        return cloudPath;
+    }
+    return `${base}/${cloudPath.replace(/^\/+/, '')}`;
+}
+/**
+ * COS 物理 Key → 逻辑路径：去掉 basePath 前缀，basePath 为空或 Key 不在前缀下时原样返回
+ */
+function toLogicalPath(basePath, key) {
+    const base = trimSlashes(basePath || '');
+    const prefix = `${base}/`;
+    if (!base || !key || !key.startsWith(prefix)) {
+        return key;
+    }
+    return key.slice(prefix.length);
+}
+/**
+ * 解析环境的有效云存储配置
+ * 共享桶环境（Storages[0].Bucket 为空且 ExternalStorage.Enabled 为 true）下，桶名、地域、BasePath 从 ExternalStorage 读取；
+ * 普通环境保持读取 Storages[0].Bucket / Region，basePath 为空串
+ */
+function resolveStorageConfig(envConfig) {
+    var _a;
+    // 环境信息由带 @preLazy 的方法首次调用时加载，直接调用 getStorageConfig 可能早于加载
+    if (!envConfig) {
+        throw new error_1.CloudBaseError('环境信息尚未加载，无法获取存储配置，请先调用任一存储方法（如 listDirectoryFiles）或 environment.lazyInit() 完成初始化');
+    }
+    const storage = (_a = envConfig.Storages) === null || _a === void 0 ? void 0 : _a[0];
+    if (!storage) {
+        throw new error_1.CloudBaseError(`环境 ${envConfig === null || envConfig === void 0 ? void 0 : envConfig.EnvId} 未查询到云存储资源（Storages 为空），请确认环境 ID 正确且环境已开通云存储`);
+    }
+    return Object.assign({ env: envConfig.EnvId }, resolveBucketConfig({
+        envId: envConfig.EnvId,
+        bucket: storage.Bucket,
+        region: storage.Region,
+        externalStorage: storage.ExternalStorage
+    }));
+}
+/**
+ * 按共享桶规则解析有效桶，云存储（Storages）与静态托管（DescribeStaticStore）共用
+ * bucket 为空且 externalStorage.Enabled 为 true 时使用 ExternalStorage，否则使用环境自有桶，basePath 为空串
+ */
+function resolveBucketConfig(options) {
+    const { envId, bucket, region, externalStorage } = options;
+    if (!bucket && (externalStorage === null || externalStorage === void 0 ? void 0 : externalStorage.Enabled) === true) {
+        // 线上存在已启用外部存储但未返回桶名的环境，继续执行会在 COS 调用时报 missing param Bucket
+        if (!externalStorage.BucketName) {
+            throw new error_1.CloudBaseError(`环境 ${envId} 已启用外部存储（ExternalStorage），但未返回存储桶名称（BucketName），无法访问存储桶，请联系平台检查该环境的共享桶配置`);
+        }
+        return {
+            bucket: externalStorage.BucketName,
+            region: externalStorage.Region,
+            basePath: externalStorage.BasePath || ''
+        };
+    }
+    return { bucket, region, basePath: '' };
+}

package/package.json

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

package/types/env/index.d.ts

@@ -1,6 +1,6 @@
 import { Environment } from '../environment';
 import { IResponseInfo, AuthDomain, EnvInfo, LoginConfigItem, ICheckTcbServiceRes, ICreatePostpayRes, EnvBillingInfoItem, PriceResult } from '../interfaces';
-import { CalculatePackageCreatePriceParams, CalculatePackageRenewPriceParams, CalculatePackageModifyPriceParams, DescribeHttpServiceRouteParams, DescribeHttpServiceRouteRes, VerifyHttpServiceRouteParams, VerifyHttpServiceRouteRes, CreateHttpServiceRouteParams, CreateHttpServiceRouteRes, ModifyHttpServiceRouteParams, ModifyHttpServiceRouteRes, DeleteHttpServiceRouteParams, DeleteHttpServiceRouteRes, PurgeHttpServiceCacheParams, PurgeHttpServiceCacheRes, DescribeHttpServiceCachePurgeTaskParams, DescribeHttpServiceCachePurgeTaskRes, BindCustomDomainParams, BindCustomDomainRes, DeleteCustomDomainParams, DeleteCustomDomainRes, DescribeCertificatesParams, DescribeCertificatesRes } from './type';
+import { CalculatePackageCreatePriceParams, CalculatePackageRenewPriceParams, CalculatePackageModifyPriceParams, DescribeHttpServiceRouteParams, DescribeHttpServiceRouteRes, VerifyHttpServiceRouteParams, VerifyHttpServiceRouteRes, CreateHttpServiceRouteParams, CreateHttpServiceRouteRes, ModifyHttpServiceRouteParams, ModifyHttpServiceRouteRes, DeleteHttpServiceRouteParams, DeleteHttpServiceRouteRes, BindCustomDomainParams, BindCustomDomainRes, DeleteCustomDomainParams, DeleteCustomDomainRes, DescribeCertificatesParams, DescribeCertificatesRes } from './type';
 import { CreateBillingDealParams, CreateEnvParams, BaasPackageInfo, DescribeBaasPackageListParams, ModifyEnvPlanParams, RenewEnvParams, DestroyEnvParams, DescribeEnvsParams, DescribeEnvInfoParams, DescribeEnvInfoResponse, DescribeEnvAccountCircleParams, DescribeEnvAccountCircleRes, DescribeCreditsUsageDetailParams, EnvPkgCreditsUsage } from '../interfaces/tcb.interface';
 type SOURCE = 'miniapp' | 'qcloud';
 interface IDeleteDomainRes {
@@ -864,8 +864,14 @@ export declare class EnvService {
      */
     describeBillingInfo(params: {
         EnvId?: string;
+        /** 分页条数 */
+        Limit?: number;
+        /** 分页偏移 */
+        Offset?: number;
     }): Promise<{
         EnvBillingInfoList: EnvBillingInfoItem[];
+        /** 环境总数（实测与实际可翻页的条数不一致，不宜直接作为总数展示） */
+        Total?: number;
         RequestId: string;
     }>;
     /**
@@ -922,21 +928,6 @@ export declare class EnvService {
      * @returns {Promise<DeleteHttpServiceRouteRes>}
      */
     deleteHttpServiceRoute(params: DeleteHttpServiceRouteParams): Promise<DeleteHttpServiceRouteRes>;
-    /**
-     * 清除HTTP访问服务域名缓存
-     * 支持 CDN 和 EO 两种缓存类型。CDN 仅支持 PURGE_URL 刷新方式；PURGE_PREFIX / PURGE_HOST 仅 EO 支持
-     * 清除缓存后会生成任务ID，可通过 DescribeHTTPServiceCachePurgeTask 查询任务进度和详细信息
-     * @param {PurgeHttpServiceCacheParams} params 清除缓存参数
-     * @returns {Promise<PurgeHttpServiceCacheRes>}
-     */
-    purgeHttpServiceCache(params: PurgeHttpServiceCacheParams): Promise<PurgeHttpServiceCacheRes>;
-    /**
-     * 查询HTTP访问服务域名缓存清除任务详情
-     * 通过 purgeHttpServiceCache 清除域名缓存后，可传入任务ID查询清除任务状态、时间、缓存类型等信息；也可不传任务ID查询历史任务记录
-     * @param {DescribeHttpServiceCachePurgeTaskParams} params 查询参数
-     * @returns {Promise<DescribeHttpServiceCachePurgeTaskRes>}
-     */
-    describeHttpServiceCachePurgeTask(params: DescribeHttpServiceCachePurgeTaskParams): Promise<DescribeHttpServiceCachePurgeTaskRes>;
     /**
      * 绑定自定义域名到HTTP访问服务
      * 底层调用 CreateHTTPServiceRoute API，专用于域名绑定场景

package/types/env/type.d.ts

@@ -414,62 +414,6 @@ export interface DeleteHttpServiceRouteParams {
 export interface DeleteHttpServiceRouteRes {
     RequestId: string;
 }
-/**
- * PurgeHTTPServiceCache 请求参数
- * 用于清除HTTP访问服务域名缓存，支持 CDN 和 EO 两种缓存类型
- */
-export interface PurgeHttpServiceCacheParams {
-    EnvId: string;
-    Domain: string;
-    CacheType: 'CDN' | 'EO';
-    PurgeType: 'PURGE_URL' | 'PURGE_PREFIX' | 'PURGE_HOST';
-    Targets: string[];
-}
-/**
- * PurgeHTTPServiceCache 返回结果
- */
-export interface PurgeHttpServiceCacheRes {
-    CacheType: 'CDN' | 'EO';
-    TaskId: string;
-    RequestId: string;
-}
-/**
- * 缓存清除任务详情
- */
-export interface HTTPServiceCachePurgeTask {
-    TaskId: string;
-    CacheType: 'CDN' | 'EO';
-    Status: 'PROCESSING' | 'SUCCESS' | 'FAILED' | 'TIMEOUT' | 'CANCELED';
-    PurgeType: 'PURGE_URL' | 'PURGE_PREFIX' | 'PURGE_HOST';
-    Method: 'INVALIDATE' | 'DELETE';
-    Targets: string[];
-    FailReason?: string;
-    CreateTime: string;
-    UpdateTime: string;
-}
-/**
- * DescribeHTTPServiceCachePurgeTask 请求参数
- * 用于查询HTTPService域名缓存清除任务详情
- */
-export interface DescribeHttpServiceCachePurgeTaskParams {
-    EnvId: string;
-    Domain: string;
-    CacheType: 'CDN' | 'EO';
-    TaskId?: string;
-    PurgeType?: 'PURGE_URL' | 'PURGE_PREFIX' | 'PURGE_HOST';
-    StartTime?: string;
-    EndTime?: string;
-    Offset?: number;
-    Limit?: number;
-}
-/**
- * DescribeHTTPServiceCachePurgeTask 返回结果
- */
-export interface DescribeHttpServiceCachePurgeTaskRes {
-    Tasks: HTTPServiceCachePurgeTask[];
-    TotalCount: number;
-    RequestId: string;
-}
 /**
  * 绑定自定义域名的域名参数
  * 与 HTTPServiceDomainParam 类似，但不包含 Routes（绑定域名场景）

package/types/hosting/index.d.ts

@@ -1,5 +1,5 @@
 import { Environment } from '../environment';
-import { IListFileInfo } from '../interfaces';
+import { ExternalStorage, IListFileInfo } from '../interfaces';
 export interface IProgressData {
     loaded: number;
     total: number;
@@ -116,10 +116,12 @@ export interface IHostingInfo {
     CdnDomain: string;
     Bucket: string;
     Regoin: string;
+    Region?: string;
     Status: string;
     MaxDomain: number;
     Id: number;
     PolicyId: number;
+    ExternalStorage?: ExternalStorage;
 }
 export interface IRoutingRules {
     keyPrefixEquals?: string;
@@ -261,6 +263,11 @@ export declare class HostingService {
      * 检查 hosting 服务状态
      */
     private checkStatus;
+    /**
+     * 检查 hosting 服务状态并解析有效桶，兼容共享桶（ExternalStorage）环境
+     * 静态托管的共享桶与 BasePath 独立于云存储，不能复用 StorageService.getStorageConfig
+     */
+    private getHostingBucket;
     /**
      * 获取配置
      */

package/types/interfaces/tcb.interface.d.ts

@@ -450,6 +450,7 @@ export interface CreateEnvParams {
     Alias: string;
     PackageId: string;
     Resources: string[];
+    ExternalStorage?: ExternalStorage;
     Period?: number;
     AutoVoucher?: boolean;
     Tags?: Tag[];

package/types/storage/index.d.ts

@@ -1,5 +1,6 @@
 import { Environment } from '../environment';
 import { IUploadMetadata, IListFileInfo, IFileInfo, ITempUrlInfo, IResponseInfo } from '../interfaces';
+import { IStorageConfig } from '../utils/storage-config';
 import { IUploadObjectHttpOptions, IUploadObjectHttpResult, IDeleteObjectHttpOptions, IDeleteObjectHttpResult, IDeleteObjectsHttpOptions, IDeletedObjectInfo, ICopyObjectHttpOptions, ICopyObjectHttpResult, IMoveObjectHttpOptions, IMoveObjectHttpResult, IListObjectsHttpOptions, IListObjectsHttpResult, ISignObjectHttpOptions, ISignObjectHttpResult, ISignObjectsHttpOptions, ISignObjectsHttpResult, ISignUploadObjectHttpOptions, ISignUploadObjectHttpResult, IUploadObjectBySignHttpOptions, IUploadObjectBySignHttpResult, IDownloadAuthenticatedObjectHttpOptions, IDownloadObjectHttpOptions, IDownloadPublicObjectHttpOptions, IDownloadObjectBySignHttpOptions, IDownloadObjectHttpResult, IGetObjectInfoAuthenticatedHttpOptions, IGetObjectInfoPublicHttpOptions, IGetObjectInfoHttpResult, IConsistentUploadOptions, IConsistentUploadResult, ILocalManifestItem, IManifestDiffResult, IManifestVerifyResult, IPruneResult, IRemoteManifestItem } from './type';
 export interface IProgressData {
     loaded: number;
@@ -34,12 +35,19 @@ export interface IFilesOptions extends IOptions {
 export interface ICustomOptions {
     bucket: string;
     region: string;
+    /**
+     * 共享桶（ExternalStorage）内的目录前缀。*Custom 方法不会自动读取环境的 BasePath，
+     * 未传时按 COS 原始 Key 处理；传入后入参按逻辑路径处理，返回的 Key 映射回逻辑路径
+     */
+    basePath?: string;
 }
 export interface IWalkCloudDirOptions {
     prefix: string;
     bucket: string;
     region: string;
     marker?: string;
+    /** 同 ICustomOptions.basePath */
+    basePath?: string;
 }
 export interface IGetRemoteManifestOptions extends ICustomOptions {
     /** 云端前缀，无前导斜杠（如 'dist'）；空串表示整桶 */
@@ -104,6 +112,8 @@ export interface IGetBucketOpions {
     prefix?: string;
     marker?: string;
     maxKeys?: number;
+    /** 同 ICustomOptions.basePath：传入后 prefix / marker 按逻辑路径处理，返回的 Contents.Key、NextMarker 映射回逻辑路径 */
+    basePath?: string;
 }
 export type AclType = 'READONLY' | 'PRIVATE' | 'ADMINWRITE' | 'ADMINONLY' | 'CUSTOM';
 export interface IStorageAclRule {
@@ -202,6 +212,7 @@ export declare class StorageService {
     getRemoteManifest(prefix: string): Promise<IRemoteManifestItem[]>;
     /**
      * 获取远端 manifest，支持自定义 Bucket 和 Region。prefix 规则同 getRemoteManifest。
+     * 不会自动拼接环境的共享桶 BasePath，需要时显式传入 basePath
      */
     getRemoteManifestCustom(options: IGetRemoteManifestOptions): Promise<IRemoteManifestItem[]>;
     /**
@@ -291,6 +302,7 @@ export declare class StorageService {
     uploadFiles(options: IFilesOptions): Promise<void>;
     /**
      * 上传文件，支持自定义 Bucket 和 Region
+     * 不会自动拼接环境的共享桶 BasePath，需要时显式传入 basePath；fileId 始终按逻辑路径 cloudPath 获取
      * @param {string} localPath
      * @param {string} cloudPath
      * @param {string} bucket
@@ -311,6 +323,7 @@ export declare class StorageService {
     uploadDirectory(options: IFileOptions): Promise<void>;
     /**
      * 上传文件夹，支持自定义 Region 和 Bucket
+     * 不会自动拼接环境的共享桶 BasePath，需要时显式传入 basePath
      * @param {string} localPath
      * @param {string} cloudPath
      * @param {number} parallel
@@ -348,6 +361,7 @@ export declare class StorageService {
     createCloudDirectroy(cloudPath: string): Promise<void>;
     /**
      * 创建一个空的文件夹，支持自定义 Region 和 Bucket
+     * 不会自动拼接环境的共享桶 BasePath，需要时显式传入 basePath
      * @param {string} cloudPath
      * @param {string} bucket
      * @param {string} region
@@ -400,6 +414,7 @@ export declare class StorageService {
     deleteFile(cloudPathList: string[]): Promise<void>;
     /**
      * 删除文件，可以指定 Bucket 和 Region
+     * 不会自动拼接环境的共享桶 BasePath，cloudPathList 按 COS 原始 Key 处理
      * @param {string[]} cloudPathList
      * @param {string} bucket
      * @param {string} region
@@ -425,6 +440,7 @@ export declare class StorageService {
     }>;
     /**
      * 删除文件，可以指定 bucket 和 region
+     * 不会自动拼接环境的共享桶 BasePath，需要时显式传入 basePath；返回的 Key 为逻辑路径
      * @param {string} cloudPath
      * @param {string} bucket
      * @param {string} region
@@ -497,6 +513,7 @@ export declare class StorageService {
     walkCloudDir(prefix: string, marker?: string): Promise<IListFileInfo[]>;
     /**
      * 遍历云端文件夹，支持自定义 Bucket 和 Region
+     * 不会自动拼接环境的共享桶 BasePath，需要时显式传入 basePath；传入后返回的 Key 为逻辑路径
      * @param {string} prefix
      * @param {string} [marker]
      * @param {string} bucket
@@ -686,9 +703,10 @@ export declare class StorageService {
      */
     private cloudPathToFileId;
     /**
-     * 获取存储桶配置
+     * 获取存储桶配置，兼容共享桶（ExternalStorage）环境
+     * basePath 为共享桶内的目录前缀，普通环境为空串
      */
-    private getStorageConfig;
+    getStorageConfig(): IStorageConfig;
     /**
      * 带重试功能的上传多文件函数
      * @param uploadFiles sdk上传函数

package/types/storage/type.d.ts

@@ -377,6 +377,8 @@ export interface IConsistentUploadOptions {
      * 未指定时默认识别所有层级下的 index.html。
      */
     entries?: string[];
+    /** 共享桶（ExternalStorage）内的目录前缀，未传时按 COS 原始 Key 处理 */
+    basePath?: string;
 }
 /** 远端多余文件清理结果 */
 export interface IPruneResult {

package/types/utils/storage-config.d.ts

@@ -0,0 +1,36 @@
+import { EnvInfo, ExternalStorage } from '../interfaces';
+export interface IStorageConfig {
+    env: string;
+    region: string;
+    bucket: string;
+    basePath: string;
+}
+/**
+ * 逻辑路径 → COS 物理 Key：共享桶环境拼上 basePath 前缀，basePath 为空时原样返回
+ * cloudPath 为空或为 '/' 时返回 `${basePath}/`，即共享桶内本环境的根目录
+ */
+export declare function toPhysicalKey(basePath: string, cloudPath?: string): string;
+/**
+ * COS 物理 Key → 逻辑路径：去掉 basePath 前缀，basePath 为空或 Key 不在前缀下时原样返回
+ */
+export declare function toLogicalPath(basePath: string, key: string): string;
+/**
+ * 解析环境的有效云存储配置
+ * 共享桶环境（Storages[0].Bucket 为空且 ExternalStorage.Enabled 为 true）下，桶名、地域、BasePath 从 ExternalStorage 读取；
+ * 普通环境保持读取 Storages[0].Bucket / Region，basePath 为空串
+ */
+export declare function resolveStorageConfig(envConfig: EnvInfo): IStorageConfig;
+/**
+ * 按共享桶规则解析有效桶，云存储（Storages）与静态托管（DescribeStaticStore）共用
+ * bucket 为空且 externalStorage.Enabled 为 true 时使用 ExternalStorage，否则使用环境自有桶，basePath 为空串
+ */
+export declare function resolveBucketConfig(options: {
+    envId: string;
+    bucket: string;
+    region: string;
+    externalStorage?: ExternalStorage;
+}): {
+    bucket: string;
+    region: string;
+    basePath: string;
+};