@lark-project/cli
Version:
飞书项目插件开发工具
53 lines (52 loc) • 2.31 kB
TypeScript
import { AppVersionVisibilityInfo } from './version';
/**
* 对齐 IDL:meego_idl/app_center/api/api_app_development.thrift
* - APIReleaseAppBaseInfoRequest / APIReleaseAppBaseInfoResponse
* - APIReleaseAppRequest / APIReleaseAppResponse
*
* Routes(**Tool 变体**,plugindevtoken 鉴权;路径前缀 ai_app 明示 AI 应用专用,
* 与登录态版本共享同一套 Request/Response struct):
* - POST /goapi/v5/app/development/tool/ai_app_base/release (APIAppDevelopmentToolReleaseAIAppBaseInfo)
* - POST /goapi/v5/app/development/tool/ai_app/release (APIAppDevelopmentToolReleaseAIApp)
*
* 用途:仅 AI 插件(app_type=1)的发布通道。普通插件仍走 version commit 三步走(tool/version/* 系列)。
*/
export declare enum AIReleaseType {
/** 首次发布。base info + 点位 + 全量内容一起上 */
Normal = 0,
/** 已上架后只发布点位变更,不重新发布 base info */
ReleasePointOnly = 1
}
interface ReleaseAppBaseInfoParams {
siteDomain: string;
appKey: string;
}
interface ReleaseAppBaseInfoResponseBody {
/** IDL: APIReleaseAppBaseInfoResponse 只有 BaseResp,无业务字段 */
[key: string]: unknown;
}
/**
* 把开发态的插件基础信息(name / icon / description / category)发布到线上。
* AI 插件首次发布前必须先调用此接口,否则线上拿不到展示信息。
* 增量发布点位时不需要重复调用。
*/
export declare function releaseAppBaseInfo({ siteDomain, appKey, }: ReleaseAppBaseInfoParams): Promise<ReleaseAppBaseInfoResponseBody>;
interface ReleaseAppParams {
siteDomain: string;
appKey: string;
/** 1=企业版本(Builtin) / 2=ISV 版本 */
sceneType: 1 | 2;
/** 前端产物版本号;'0' 表示无前端产物 */
frontVersion: string;
visibility: AppVersionVisibilityInfo;
releaseType: AIReleaseType;
}
interface ReleaseAppResponseBody {
/** IDL: APIReleaseAppResponse 只有 BaseResp,无业务字段 */
[key: string]: unknown;
}
/**
* AI 插件发布主调用。前端 publishAINodeConfigByPayload 等价于此函数。
*/
export declare function releaseApp({ siteDomain, appKey, sceneType, frontVersion, visibility, releaseType, }: ReleaseAppParams): Promise<ReleaseAppResponseBody>;
export {};