@lark-project/cli
Version:
飞书项目插件开发工具
108 lines (107 loc) • 3.69 kB
TypeScript
/**
* 对齐 IDL：meego_idl/app_center/service.thrift Tool API
* - GET /goapi/v5/app/development/tool/version/list
* - GET /goapi/v5/app/development/tool/version/validversion
* - POST /goapi/v5/app/development/tool/version/info
* - PUT /goapi/v5/app/development/tool/version/info
* - POST /goapi/v5/app/development/tool/version/commit
*/
/**
* 插件版本发布状态（= `AppVersionInfo.status`）。
* 对齐 meego-openapp `packages/openapp/src/typings/openappModel.ts` 的 `PublishStatusType`。
* `OnShelf`（已上架）= **线上生效版本**：发布前权限/版本对比应以它为基线，
* 不能用「版本列表第一条」（那只是最新一条，可能是草稿/审核中）。
*/
export declare enum AppVersionStatus {
Unknown = 0,// 未知/待发布
Reviewing = 1,// 审核中
Reject = 2,// 已驳回
Pass = 3,// 待上架
OnShelf = 4,// 已上架（线上生效）
OffShelf = 5,// 已下架
Publishing = 6,// 发布中
Failed = 7
}
export interface AppVersionVisibilityInfo {
status?: 0 | 1;
project_key?: string[];
tenant_key?: string[];
show_store?: boolean;
display_id?: string[];
}
export interface AppVersionUpgradeStrategy {
strategy_type?: number;
limit_version?: string;
limit_type?: number;
}
export interface AppVersionInfo {
id?: string;
app_version?: string;
description?: Record<string, string>;
front_version?: string;
status?: number;
scene_type?: 1 | 2;
created_user?: unknown;
updated_user?: unknown;
visibility?: AppVersionVisibilityInfo;
created_time?: number;
updated_time?: number;
runtime_version?: string;
upgrade_strategy?: AppVersionUpgradeStrategy;
store_version?: string;
tenant_key?: string;
}
interface GetVersionListRequest {
siteDomain: string;
appKey: string;
}
interface GetAppVersionInfoListResponseBody {
list?: AppVersionInfo[];
}
/**
* 获取插件版本列表。
* IDL: api_app_development.GetAppVersionInfoListRequest / Response
*/
export declare function getVersionList({ siteDomain, appKey, }: GetVersionListRequest): Promise<GetAppVersionInfoListResponseBody>;
interface ValidateVersionRequest {
siteDomain: string;
appKey: string;
version: string;
}
interface APIValidVersionByAppkeyAndVersionRequestResponseBody {
reason: number;
}
/**
* 校验版本号合法性。
* IDL: api_app_development.APIValidVersionByAppkeyAndVersionRequest / Response
*/
export declare function validateVersion({ siteDomain, appKey, version, }: ValidateVersionRequest): Promise<APIValidVersionByAppkeyAndVersionRequestResponseBody>;
interface SaveVersionInfoRequest {
siteDomain: string;
appKey: string;
versionInfo: AppVersionInfo;
}
interface SaveAppVersionInfoResponseBody {
version_info?: AppVersionInfo;
}
/**
* 创建版本信息。
* IDL: api_app_development.SaveAppVersionInfoRequest / Response
*/
export declare function createVersionInfo({ siteDomain, appKey, versionInfo, }: SaveVersionInfoRequest): Promise<SaveAppVersionInfoResponseBody>;
/**
* 更新版本信息。
* IDL: api_app_development.SaveAppVersionInfoRequest / Response
*/
export declare function updateVersionInfo({ siteDomain, appKey, versionInfo, }: SaveVersionInfoRequest): Promise<SaveAppVersionInfoResponseBody>;
interface CommitVersionRequest {
siteDomain: string;
appKey: string;
appVersion: string;
}
/**
* 提交版本审核。
* IDL: api_app_development.ChangeAppVersionStatusRequest / Response
*/
export declare function commitVersion({ siteDomain, appKey, appVersion, }: CommitVersionRequest): Promise<SaveAppVersionInfoResponseBody>;
export {};