@lark-project/cli
Version:
飞书项目插件开发工具
105 lines (104 loc) • 4.32 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.commitVersion = exports.updateVersionInfo = exports.createVersionInfo = exports.validateVersion = exports.getVersionList = exports.AppVersionStatus = void 0;
const request_1 = require("../request");
const get_tool_auth_headers_1 = require("../get-tool-auth-headers");
/**
* 对齐 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`（已上架）= **线上生效版本**：发布前权限/版本对比应以它为基线，
* 不能用「版本列表第一条」（那只是最新一条，可能是草稿/审核中）。
*/
var AppVersionStatus;
(function (AppVersionStatus) {
AppVersionStatus[AppVersionStatus["Unknown"] = 0] = "Unknown";
AppVersionStatus[AppVersionStatus["Reviewing"] = 1] = "Reviewing";
AppVersionStatus[AppVersionStatus["Reject"] = 2] = "Reject";
AppVersionStatus[AppVersionStatus["Pass"] = 3] = "Pass";
AppVersionStatus[AppVersionStatus["OnShelf"] = 4] = "OnShelf";
AppVersionStatus[AppVersionStatus["OffShelf"] = 5] = "OffShelf";
AppVersionStatus[AppVersionStatus["Publishing"] = 6] = "Publishing";
AppVersionStatus[AppVersionStatus["Failed"] = 7] = "Failed";
})(AppVersionStatus || (exports.AppVersionStatus = AppVersionStatus = {}));
/**
* 获取插件版本列表。
* IDL: api_app_development.GetAppVersionInfoListRequest / Response
*/
async function getVersionList({ siteDomain, appKey, }) {
return (0, request_1.request)(`${siteDomain}/goapi/v5/app/development/tool/version/list`, {
method: 'GET',
params: {
app_key: appKey,
},
headers: await (0, get_tool_auth_headers_1.getToolAuthHeaders)(siteDomain),
});
}
exports.getVersionList = getVersionList;
/**
* 校验版本号合法性。
* IDL: api_app_development.APIValidVersionByAppkeyAndVersionRequest / Response
*/
async function validateVersion({ siteDomain, appKey, version, }) {
return (0, request_1.request)(`${siteDomain}/goapi/v5/app/development/tool/version/validversion`, {
method: 'GET',
params: {
app_key: appKey,
version,
},
headers: await (0, get_tool_auth_headers_1.getToolAuthHeaders)(siteDomain),
});
}
exports.validateVersion = validateVersion;
/**
* 创建版本信息。
* IDL: api_app_development.SaveAppVersionInfoRequest / Response
*/
async function createVersionInfo({ siteDomain, appKey, versionInfo, }) {
return (0, request_1.request)(`${siteDomain}/goapi/v5/app/development/tool/version/info`, {
method: 'POST',
data: {
app_key: appKey,
version_info: versionInfo,
},
headers: await (0, get_tool_auth_headers_1.getToolAuthHeaders)(siteDomain),
});
}
exports.createVersionInfo = createVersionInfo;
/**
* 更新版本信息。
* IDL: api_app_development.SaveAppVersionInfoRequest / Response
*/
async function updateVersionInfo({ siteDomain, appKey, versionInfo, }) {
return (0, request_1.request)(`${siteDomain}/goapi/v5/app/development/tool/version/info`, {
method: 'PUT',
data: {
app_key: appKey,
version_info: versionInfo,
},
headers: await (0, get_tool_auth_headers_1.getToolAuthHeaders)(siteDomain),
});
}
exports.updateVersionInfo = updateVersionInfo;
/**
* 提交版本审核。
* IDL: api_app_development.ChangeAppVersionStatusRequest / Response
*/
async function commitVersion({ siteDomain, appKey, appVersion, }) {
return (0, request_1.request)(`${siteDomain}/goapi/v5/app/development/tool/version/commit`, {
method: 'POST',
data: {
app_key: appKey,
app_version: appVersion,
},
headers: await (0, get_tool_auth_headers_1.getToolAuthHeaders)(siteDomain),
});
}
exports.commitVersion = commitVersion;