@cloudbase/manager-node 5.8.3 → 5.8.5

package/types/deploy/StateStore.d.ts

@@ -1,174 +0,0 @@
-/** hosting 文件指纹（hash + size；size 用于懒加载 diff 预判，避免为未变文件重复读内容） */
-export interface IHostingFileFingerprint {
-    hash: string;
-    size: number;
-}
-/** 快照中指纹值：兼容旧格式（纯 string = 仅 hash，size 未知） */
-export type HostingFileValue = string | IHostingFileFingerprint;
-/** hosting 状态快照条目（产物指纹，不存文件内容） */
-export interface IHostingStateEntry {
-    name: string;
-    deployPath?: string;
-    /** 相对路径 → 文件指纹（兼容旧格式：纯字符串 = 仅 hash，size 未知） */
-    files: Record<string, HostingFileValue>;
-}
-/** hosting 文件级 diff 结果（懒加载：size 预判 + 按需 hash） */
-export interface IHostingFileDiff {
-    added: string[];
-    modified: string[];
-    deleted: string[];
-    totalChanged: number;
-    /** 本地与快照完全一致（可跳过部署） */
-    unchanged: boolean;
-    /** true = 文件数超过指纹上限，diff 被放弃，需降级为全量部署 */
-    overLimit?: boolean;
-}
-/** hosting 指纹扫描选项 */
-export interface IHostingScanOptions {
-    /** 指纹文件数上限：超过则抛 HostingFilesOverLimitError（默认 50000；0 = 不限） */
-    maxFiles?: number;
-    /** hash 截断长度（hex 位数，默认 16；64 = 完整 sha256） */
-    hashLength?: number;
-}
-/** diffHostingFiles 选项（继承扫描选项，追加忽略规则） */
-export interface IHostingDiffOptions extends IHostingScanOptions {
-    /** 自定义忽略规则（追加到默认 node_modules / .DS_Store 之后） */
-    ignore?: string[];
-}
-/** hosting 指纹文件数超过上限时抛出（触发降级为全量部署） */
-export declare class HostingFilesOverLimitError extends Error {
-    fileCount: number;
-    limit: number;
-    constructor(fileCount: number, limit: number);
-}
-/** 默认指纹文件数上限（防快照膨胀与 I/O 失控） */
-export declare const DEFAULT_MAX_HOSTING_FILES = 50000;
-/** 默认 hash 截断长度（16 位 hex = 64bit，碰撞概率可忽略；快照体积减半） */
-export declare const DEFAULT_HASH_LENGTH = 16;
-/** app 状态快照条目（仅 diff 相关字段，不写 envVariables 等敏感信息） */
-export interface IAppStateEntry {
-    serviceName?: string;
-    installCommand?: string;
-    buildCommand?: string;
-    outputDir?: string;
-    deployPath?: string;
-}
-/** 部署状态快照（.cloudbase/state.json） */
-export interface IDeployState {
-    version: number;
-    updatedAt: string;
-    gitCommit?: string;
-    /** 写入快照时的目标环境 ID：跨环境切换（如上海 → 新加坡）后旧快照不可信，skip 判定强制失效 */
-    envId?: string;
-    resources: {
-        hosting?: IHostingStateEntry[];
-        gateway?: unknown;
-        app?: IAppStateEntry;
-    };
-}
-interface IStateStoreOptions {
-    /** 项目根目录（默认 process.cwd()） */
-    cwd?: string;
-    /** 环境名（--env production 等）：按环境分文件 state.{env}.json */
-    env?: string;
-    /** 自定义 state 路径（优先于 cwd+env 推导） */
-    stateFile?: string;
-}
-/**
- * 部署状态快照（StateStore）
- *
- * 职责：读写 `.cloudbase/state.json`（默认），为 dry-run 的 hosting/app diff 提供本地基准，
- * 避免每次 diff 都拉取云端。
- *
- * 指纹算法：hosting = 产物目录逐文件内容 sha256（相对路径为 key）。
- * 只存 hash 不存内容，体积 = O(文件数)；app 快照不写入 envVariables（敏感过滤）。
- */
-export declare class StateStore {
-    private cwd;
-    private env?;
-    private stateFile?;
-    constructor(options?: IStateStoreOptions);
-    /**
-     * 计算 state 文件路径：
-     * - 自定义 stateFile 优先
-     * - 否则 {cwd}/.cloudbase/state.json（无 env）或 state.{env}.json（多环境隔离）
-     */
-    getFilePath(): string;
-    /**
-     * 读取状态快照；文件不存在或 JSON 损坏返回 null（缺失降级，由调用方走云端兜底）
-     */
-    read(): IDeployState | null;
-    /**
-     * 写入状态快照（自动补 version/updatedAt/gitCommit，自动创建 .cloudbase 目录）
-     */
-    write(state: {
-        resources: IDeployState['resources'];
-        gitCommit?: string;
-        /** 本次部署的目标环境 ID（用于跨环境切换时使旧快照 skip 判定失效） */
-        envId?: string;
-    }): void;
-    /**
-     * 计算产物目录逐文件 sha256 指纹（仅 hash，兼容旧调用）
-     *
-     * @param projectPath 产物目录（hosting 的 outputDir / root）
-     * @param ignore 自定义忽略规则（追加到默认 node_modules / .DS_Store 之后）
-     * @param options 扫描选项（maxFiles / hashLength）
-     * @returns 相对路径（/ 分隔）→ 文件内容 sha256（默认截断 16 位）
-     */
-    computeHostingFiles(projectPath: string, ignore?: string[], options?: IHostingScanOptions): Promise<Record<string, string>>;
-    /**
-     * 计算产物目录逐文件指纹（hash + size）
-     *
-     * - 强制忽略 node_modules / .DS_Store（与传入 ignore 合并，不可关闭）
-     * - hash 默认截断为 16 位 hex（hashLength 可调，64 = 完整 sha256）
-     * - 文件数超过 maxFiles 抛 HostingFilesOverLimitError（防快照膨胀与 I/O 失控）
-     *
-     * @param projectPath 产物目录（hosting 的 outputDir / root）
-     * @param ignore 自定义忽略规则
-     * @param options 扫描选项（maxFiles / hashLength）
-     * @returns 相对路径（/ 分隔）→ { hash, size }
-     */
-    computeHostingFingerprints(projectPath: string, ignore?: string[], options?: IHostingScanOptions): Promise<Record<string, IHostingFileFingerprint>>;
-    /**
-     * 计算产物目录与快照的变更集（懒加载）
-     *
-     * 优化：先 stat 拿 size，size 与快照不同的文件直接判定变更（不读文件内容），
-     * 只有 size 相同（或旧快照 size 未知）的文件才读内容 hash 对比，
-     * 避免为未变文件做无谓的 I/O 与 hash。
-     * 文件数超过 maxFiles 时放弃 diff，返回 overLimit=true（调用方应降级为全量部署）。
-     *
-     * @param projectPath 产物目录（hosting 的 outputDir / root）
-     * @param previous 上次快照指纹（undefined = 首次部署，全部视为新增）
-     * @param options 选项（ignore / maxFiles / hashLength）
-     */
-    diffHostingFiles(projectPath: string, previous: Record<string, HostingFileValue> | undefined, options?: IHostingDiffOptions): Promise<IHostingFileDiff>;
-    /**
-     * 提取 app 配置快照（仅 diff 白名单字段）
-     * envVariables / ignore 等非 diff 字段与敏感信息不进入快照
-     */
-    buildAppConfig(config: {
-        serviceName?: string;
-        installCommand?: string;
-        buildCommand?: string;
-        outputDir?: string;
-        deployPath?: string;
-        [key: string]: unknown;
-    }): IAppStateEntry | undefined;
-    private hashFile;
-    /** 合并默认忽略规则（node_modules / .DS_Store 不可被调用方关闭） */
-    private mergeIgnore;
-    /** 归一化快照指纹值：旧格式（纯 string = 仅 hash，size 未知用 -1 表示） */
-    private normalizeFileValue;
-    /**
-     * 是否命中忽略规则：
-     * - 目录模式（结尾 /）：匹配该目录及其下所有
-     * - glob（含 **）：转换为正则匹配相对路径
-     * - 其余：精确/前缀匹配
-     */
-    private isIgnored;
-    private matchPattern;
-    private escapeRegExp;
-    /** 解析当前 git commit（非 git 仓库或失败返回 undefined，不阻断） */
-    private resolveGitCommit;
-}
-export {};