@vectorx/cloud-toolkit 0.5.1 → 1.0.0

package/types/container/types.d.ts

@@ -1,3 +1,5 @@
+import type { CloudEnvironment, CloudEnvironmentCreateRequest, CloudEnvironmentUpdateRequest } from "../env.kit";
+import type { FunDeployOptions, FunDeployResult, FunDevOptions, FunDevRuntime } from "../fun.kit";
 import type { CheckStatusRequest, CheckStatusResponse } from "../services/auth-service";
 import type { BuildPreCheckResponse, IBuildPreCheckParams, IDeployParams } from "../services/upload-service";
 export interface IAuthService {
@@ -11,9 +13,43 @@ export interface IUploadService {
     buildPreCheck(params: IBuildPreCheckParams): Promise<BuildPreCheckResponse>;
     deploy(params: IDeployParams): Promise<any>;
 }
+export interface ICloudEnvService {
+    getCloudEnvironments(cloudEnvId?: string): Promise<CloudEnvironment[]>;
+    getCloudEnvironment(cloudEnvId: string): Promise<CloudEnvironment | null>;
+    createCloudEnvironment(payload: CloudEnvironmentCreateRequest): Promise<CloudEnvironment>;
+    updateCloudEnvironment(payload: CloudEnvironmentUpdateRequest): Promise<CloudEnvironment>;
+}
+export interface IFunService {
+    startFunDev(options?: FunDevOptions): Promise<FunDevRuntime>;
+    deploy(options: FunDeployOptions): Promise<FunDeployResult>;
+    getPublishHistory(options: {
+        envId: string;
+        pageNo?: number;
+        pageSize?: number;
+    }): Promise<{
+        pkgList: Array<{
+            cloud_env_id: string;
+            desc: string;
+            resource_id: string;
+            committer_id: string;
+            committer_name: string;
+            committer_time: number;
+        }>;
+        total: number;
+    }>;
+}
+export interface CloudEnvInfo {
+    cloud_env_name: string;
+    status: number;
+    cloud_env_id: string;
+    description?: string;
+    create_time?: string;
+    update_time?: string;
+}
 export interface LoginInfo {
     secret_id: string;
     cli_token: string;
     create_at: number;
     expire_in_sec: number;
+    cloudEnvInfo?: CloudEnvInfo | null;
 }

package/types/env.kit.d.ts

@@ -0,0 +1,43 @@
+export interface CloudEnvironment {
+    cloud_env_name: string;
+    status: number;
+    cloud_env_id: string;
+    description?: string;
+    creator_id?: string;
+    create_time?: string;
+    update_time?: string;
+    env_variables?: unknown;
+}
+export interface CloudEnvironmentListData {
+    envs: CloudEnvironment[];
+}
+export interface CloudEnvironmentListResponse {
+    code: number;
+    msg: string;
+    success: boolean;
+    data: CloudEnvironmentListData;
+}
+export interface CloudEnvironmentCreateRequest {
+    cloud_env_name: string;
+    description?: string;
+}
+export interface CloudEnvironmentCreateResponse {
+    code: number;
+    msg: string;
+    success: boolean;
+    data: CloudEnvironment;
+}
+export interface CloudEnvironmentUpdateRequest {
+    cloud_env_id: string;
+    env_variables: string;
+}
+export interface CloudEnvironmentUpdateResponse {
+    code: number;
+    msg: string;
+    success: boolean;
+    data: CloudEnvironment;
+}
+export declare function getCloudEnvironments(cloudEnvId?: string): Promise<CloudEnvironment[]>;
+export declare function getCloudEnvironment(cloudEnvId: string): Promise<CloudEnvironment | null>;
+export declare function createCloudEnvironment(payload: CloudEnvironmentCreateRequest): Promise<CloudEnvironment>;
+export declare function updateCloudEnvironment(payload: CloudEnvironmentUpdateRequest): Promise<CloudEnvironment>;

package/types/fun.kit.d.ts

@@ -0,0 +1,63 @@
+export interface FunDevOptions {
+    workDir?: string;
+    uiPort?: number;
+    apiPort?: number;
+    watch?: boolean;
+    open?: boolean;
+    quiet?: boolean;
+    envId?: string;
+    mode?: "agent" | "fun";
+    deps?: {
+        startFunctionDebugger?: (opts: any) => Promise<{
+            uiUrl: string;
+            apiUrl: string;
+            wsUrl: string;
+            close: () => Promise<void>;
+        }>;
+    };
+}
+export interface FunDevRuntime {
+    workDir: string;
+    uiUrl: string;
+    apiUrl: string;
+    wsUrl: string;
+    ffUrl: string;
+    close: () => Promise<void>;
+}
+export type LogType = "info" | "success" | "error" | "warn";
+export interface LogCollector {
+    addLog(log: string, type?: LogType, loading?: boolean): void;
+}
+export interface FunDeployOptions {
+    envId: string;
+    workDir?: string;
+    includeNodeModules?: boolean;
+    desc?: string;
+    logCollector?: LogCollector;
+}
+export interface FunDeployResult {
+    success: boolean;
+    code: number;
+    msg?: string;
+    publisher?: string;
+}
+export interface PublishHistoryItem {
+    cloud_env_id: string;
+    desc: string;
+    resource_id: string;
+    committer_id: string;
+    committer_name: string;
+    committer_time: number;
+}
+export interface FunPublishHistoryOptions {
+    envId: string;
+    pageNo?: number;
+    pageSize?: number;
+}
+export interface FunPublishHistoryResult {
+    pkgList: PublishHistoryItem[];
+    total: number;
+}
+export declare function startFunDev(options?: FunDevOptions): Promise<FunDevRuntime>;
+export declare function deployFun(options: FunDeployOptions): Promise<FunDeployResult>;
+export declare function getPublishHistory(options: FunPublishHistoryOptions): Promise<FunPublishHistoryResult>;

package/types/index.d.ts

@@ -1,4 +1,6 @@
 export * from "./agent.kit";
+export * from "./fun.kit";
+export * from "./env.kit";
 export { Uploader } from "./utils/cos-uploader";
 export * from "./container";
 export * from "./services";
@@ -10,4 +12,6 @@ export * from "./utils/tracker";
 export * from "./utils/port-finder";
 export * from "./utils/open-browser";
 export * from "./utils/output";
+export * from "./utils/table";
+export * from "./utils/fun-project-validator";
 export { TokenRequest, TokenResponse, UploadTempPermit, InternalTokenRequest, } from "./services/upload-service";

package/types/services/cloud-env-service.d.ts

@@ -0,0 +1,10 @@
+import type { ICloudEnvService } from "../container";
+import type { CloudEnvironment, CloudEnvironmentCreateRequest, CloudEnvironmentUpdateRequest } from "../env.kit";
+export declare class CloudEnvService implements ICloudEnvService {
+    private readonly authService;
+    constructor();
+    getCloudEnvironments(cloudEnvId?: string): Promise<CloudEnvironment[]>;
+    getCloudEnvironment(cloudEnvId: string): Promise<CloudEnvironment | null>;
+    createCloudEnvironment(payload: CloudEnvironmentCreateRequest): Promise<CloudEnvironment>;
+    updateCloudEnvironment(payload: CloudEnvironmentUpdateRequest): Promise<CloudEnvironment>;
+}

package/types/services/fun-service.d.ts

@@ -0,0 +1,23 @@
+import type { IFunService } from "../container";
+import type { FunDeployOptions, FunDeployResult, FunDevOptions, FunDevRuntime } from "../fun.kit";
+export declare class FunService implements IFunService {
+    private readonly authService;
+    constructor();
+    startFunDev(options?: FunDevOptions): Promise<FunDevRuntime>;
+    deploy(options: FunDeployOptions): Promise<FunDeployResult>;
+    getPublishHistory(options: {
+        envId: string;
+        pageNo?: number;
+        pageSize?: number;
+    }): Promise<{
+        pkgList: Array<{
+            cloud_env_id: string;
+            desc: string;
+            resource_id: string;
+            committer_id: string;
+            committer_name: string;
+            committer_time: number;
+        }>;
+        total: number;
+    }>;
+}

package/types/services/index.d.ts

@@ -1,2 +1,4 @@
 export * from "./auth-service";
 export * from "./upload-service";
+export * from "./cloud-env-service";
+export * from "./fun-service";

package/types/utils/fun-project-validator.d.ts

@@ -0,0 +1,22 @@
+export interface FunValidationResult {
+    valid: boolean;
+    errors: string[];
+    warnings?: string[];
+}
+export interface FunctionConfig {
+    name: string;
+    directory: string;
+    source: string;
+    triggerPath: string;
+}
+export interface CloudFunctionConfig {
+    functionsRoot: string;
+    functions?: FunctionConfig[];
+}
+export declare class FunProjectValidator {
+    private workDir;
+    constructor(workDir: string);
+    validate(): Promise<FunValidationResult>;
+    private validateFunctionsConfig;
+    private validateDependencies;
+}

package/types/utils/table.d.ts

@@ -0,0 +1,2 @@
+import { type TableOptions } from "cli-table3";
+export declare function printHorizontalTable(head: string[], data?: (string | number)[][], options?: TableOptions): void;

package/types/utils/tracker/apm.d.ts

@@ -0,0 +1,28 @@
+import type { IBase } from "./tracker";
+interface ISequence {
+    context_sdkSeqId: number;
+    context_sdkSessionId: string;
+    context_pageSessionId: string;
+    clientTime: number;
+}
+interface IReqItem {
+    sequence: ISequence;
+    measurement_name: string;
+    measurement_data: Record<string, any>;
+}
+export declare class APM {
+    private reportQueue;
+    private allowReport;
+    private eventSeq;
+    private context;
+    private baseData;
+    setContext(userId: string, base?: IBase): void;
+    setAppVersion(appVersion: string): void;
+    private startReport;
+    private getSequence;
+    private _request;
+    private batchReport;
+    private timer;
+    report(measurement_name: string, measurement_data?: IReqItem["measurement_data"]): void;
+}
+export {};

package/types/utils/tracker/cli-apm.d.ts

@@ -0,0 +1,27 @@
+export declare const CLI_MEASUREMENT_NAME = "vectorx_cloud_cli_usage";
+export type CliApmCommandStatus = 0 | 1;
+export type CliApmExceptionSource = "uncaughtException" | "unhandledRejection";
+export type CliApmErrorType = "auth" | "http" | "validation" | "biz" | "unknown";
+export interface InitCliApmOptions {
+    cliVersion?: string;
+    userId?: string;
+}
+export interface CliCommandMeta {
+    cmd_path: string;
+    cmd_root?: string;
+    params_count?: number;
+    options_keys?: string[];
+}
+export declare function initCliApm(options?: InitCliApmOptions): void;
+export declare function setCliApmCurrentCommand(cmdPath?: string): void;
+export declare function createCliCommandTracker(meta: CliCommandMeta): {
+    reportSuccess(durationMs: number): void;
+    reportFail(durationMs: number, err: any): void;
+};
+export declare function reportCliException(source: CliApmExceptionSource, err: any): void;
+export interface CliHttpErrorMeta {
+    method?: string;
+    url?: string;
+    status_code?: number;
+}
+export declare function reportCliHttpError(meta: CliHttpErrorMeta, err?: any): void;

package/types/utils/tracker/index.d.ts

@@ -1,27 +1,4 @@
-import type { IBase } from "./tracker";
-interface ISequence {
-    context_sdkSeqId: number;
-    context_sdkSessionId: string;
-    context_pageSessionId: string;
-    clientTime: number;
-}
-interface IReqItem {
-    suquence: ISequence;
-    measurement_name: string;
-    measurement_data: Record<string, any>;
-}
-export declare class APM {
-    private reportQueue;
-    private allowReport;
-    private eventSeq;
-    private context;
-    private baseData;
-    setContext(userId: string, base?: IBase): void;
-    private startReport;
-    private getSequence;
-    private _request;
-    private bactchReport;
-    private timer;
-    report(measurement_name: string, measurement_data?: IReqItem["measurement_data"]): void;
-}
-export {};
+export * from "./tracker";
+export * from "./device";
+export * from "./apm";
+export * from "./cli-apm";