@lovrabet/lovrabet-cli 2.3.7 → 2.3.8-beta.2

package/lib/core/api-client.d.ts

@@ -1,53 +1,24 @@
-/**
- * @fileoverview Management API client using raw `fetch`.
- *
- * Why a separate module from `sdk-client.ts`: the SDK (`@lovrabet/sdk`) is designed
- * for runtime operations (data/SQL/Backend Function execution) and encapsulates the SDK client
- * lifecycle. This module handles authenticated API calls that the SDK does not
- * cover: listing datasets, fetching app lists, querying runtime contracts, etc.
- *
- * Why `X-User-AK` auth: the runtime CLI uses AccessKey authentication exclusively.
- * The AK is set as a module-level variable (`_activeAK`) and read by every request.
- * The `finalize` hook clears it after each command to prevent AK leakage.
- *
- * Design decision: management API paths use `/client/`; narrowly scoped runtime
- * contract lookups may use `/api/` when the backend exposes a non-enumerating endpoint.
- */
+import type { DataList, PageResult, UserCustomSqlDTO as SqlQuery, DatasetMeta as DatasetItem, RuntimeArtifactDTO as RuntimeArtifactItem, PersonalBffScript as PersonalBffItem, PersonalBffUpsertRequest as PersonalBffUpsertInput, FileUploadResponse as RuntimeFileUploadResponse, FileUrlResponse as RuntimeFileUrlResponse, OcrRecognizeResponse as RuntimeOcrResponse, ApprovalFlowTaskItem, ApprovalFlowTaskDetail, ApprovalFlowApproveRequest as ApprovalFlowApproveInput, ApprovalFlowTransferRequest as ApprovalFlowTransferInput, AppRoleUpdateParam, AppRoleVO as RuntimeAppRole, AppRoleUserVO as RuntimeRoleUsers, AppEmployee as RuntimeAppUser, BaseRoleVO as RuntimePermitRole, ResourcePermitDTO as RuntimeResourcePermit, MenuPermitDTO as RuntimePagePermit, AppMenuPermitVO as RuntimeEvaluatedResource, MenuRolePermitNodeVO as RuntimeMenuRolePermitNode, AppDatasetPermitVO as RuntimeDatasetPermit, AppDatasetRolePermitVO as RuntimeDatasetRolePermit, NotificationChannelConfig as NotificationChannelConfigItem } from "@lovrabet/sdk";
+export type { ApprovalFlowApproveRequest as ApprovalFlowApproveInput, ApprovalFlowTransferRequest as ApprovalFlowTransferInput, UserCustomSqlDTO as SqlQuery, DatasetMeta as DatasetItem, RuntimeArtifactDTO as RuntimeArtifactItem, PersonalBffScript as PersonalBffItem, PersonalBffUpsertRequest as PersonalBffUpsertInput, FileUploadResponse as RuntimeFileUploadResponse, FileUrlResponse as RuntimeFileUrlResponse, OcrRecognizeResponse as RuntimeOcrResponse, ApprovalFlowTaskItem, ApprovalFlowTaskDetail, AppRoleVO as RuntimeAppRole, AppUserBaseVO as RuntimeRoleUserRef, AppRoleUserVO as RuntimeRoleUsers, AppEmployee as RuntimeAppUser, BaseRoleVO as RuntimePermitRole, ResourcePermitDTO as RuntimeResourcePermit, MenuPermitDTO as RuntimePagePermit, AppMenuPermitVO as RuntimeEvaluatedResource, MenuRolePermitNodeVO as RuntimeMenuRolePermitNode, AppDatasetPermitVO as RuntimeDatasetPermit, AppDatasetActionRolePermitVO as RuntimeDatasetActionRolePermit, AppDatasetRolePermitVO as RuntimeDatasetRolePermit, NotificationChannelConfig as NotificationChannelConfigItem, } from "@lovrabet/sdk";
 import type { Paging } from "../framework/response.js";
 /** Sets the active AccessKey used for all subsequent API calls. */
 export declare function setActiveAK(ak: string): void;
 /** Clears the active AccessKey after command completion. */
 export declare function clearActiveAK(): void;
-/** Public runtime contract for one known Backend Function endpoint. */
-export interface BffEndpointContract {
-    appCode: string;
-    functionName: string;
-    description?: string;
-    version?: number;
-    gmtModified?: string | number;
-}
+export type BffEndpointContract = Awaited<ReturnType<typeof getBffEndpointContract>>;
 /**
  * Fetches one known Backend Function endpoint contract by its stable runtime identity.
  * The runtime exposes an AK-authenticated exact endpoint keyed by appCode + functionName.
  * Platform-only fields returned by older backends are intentionally discarded here.
  */
-export declare function getBffEndpointContract(appCode: string, functionName: string): Promise<BffEndpointContract>;
-/** Metadata for a SQL query returned by the management API. */
-export interface SqlQuery {
-    id: number;
-    tenantCode?: string;
+export declare function getBffEndpointContract(appCode: string, functionName: string): Promise<{
     appCode: string;
-    sqlCode: string;
-    sqlName: string;
-    dbId?: number;
-    sqlContent?: string;
-    sqlConfig?: string | null;
-    params?: string | null;
-}
-export interface SqlListResult {
-    tableData: SqlQuery[];
-    paging: Paging;
-}
+    functionName: string;
+    description: string | undefined;
+    version: number | undefined;
+    gmtModified: number | null | undefined;
+}>;
+export type SqlListResult = DataList<SqlQuery>;
 /**
  * Fetches SQL query metadata by `sqlCode`.
  *
@@ -61,39 +32,6 @@ export interface SqlListResult {
  * handle both shapes.
  */
 export declare function getSqlQueryInfo(appCode: string, sqlCode: string): Promise<SqlQuery>;
-/** A dataset returned by the list API. */
-export interface DatasetItem {
-    id: number;
-    name: string;
-    code: string;
-    source?: string;
-    description?: string;
-    dbtableConfig?: {
-        tableName?: string;
-        dbId?: number;
-        dbName?: string;
-        dbType?: string;
-        datasetKey?: string;
-        pkField?: string;
-        allFields?: string;
-    };
-    [key: string]: any;
-}
-export interface RuntimeArtifactItem {
-    id: number;
-    appCode: string;
-    artifactType?: string;
-    name?: string;
-    content?: string;
-    compiledContent?: string;
-    metadata?: Record<string, unknown>;
-    source?: string;
-    favorite?: boolean;
-    deleted?: number | boolean;
-    createTime?: string;
-    updateTime?: string;
-    [key: string]: unknown;
-}
 export interface RuntimeArtifactUpsertInput {
     artifactType: "react_module";
     name?: string;
@@ -101,69 +39,10 @@ export interface RuntimeArtifactUpsertInput {
     metadata?: Record<string, unknown>;
     source: "AGENT";
 }
-export interface PersonalBffItem {
-    id: number;
-    appCode?: string;
-    functionName?: string;
-    description?: string;
-    scriptType?: string;
-    scriptContent?: string;
-    config?: Record<string, unknown> | null;
-    version?: number | string;
-    createUserId?: number | string;
-    gmtCreate?: string;
-    gmtModified?: string;
-    createTime?: string;
-    updateTime?: string;
-    [key: string]: unknown;
-}
-export interface PersonalBffUpsertInput {
-    functionName?: string;
-    description?: string;
-    scriptContent?: string;
-    sourceSessionId?: string;
-}
 export interface DatasetSdkUsageResponse {
     markdown?: string;
     [key: string]: unknown;
 }
-export interface RuntimeFileUploadResponse {
-    fileName?: string | null;
-    filePath?: string | null;
-    fileUrl?: string | null;
-    downloadFlag?: boolean;
-    fileType?: string | null;
-    size?: number | null;
-    sourceDir?: string | null;
-    [key: string]: unknown;
-}
-export interface RuntimeFileUrlResponse {
-    fileName?: string | null;
-    filePath?: string | null;
-    fileUrl?: string | null;
-    downloadFlag?: boolean;
-    longTerm?: boolean;
-    expiresInDays?: number | null;
-    [key: string]: unknown;
-}
-export interface RuntimeOcrResponse {
-    requestId?: string;
-    type?: string;
-    scene?: string;
-    text?: string;
-    lines?: string[];
-    kvData?: Record<string, unknown>;
-    width?: number;
-    height?: number;
-    pageNo?: number | null;
-    subImageCount?: number | null;
-    algoVersion?: string | null;
-    kvExcelUrl?: string | null;
-    xmlResult?: string | null;
-    rawData?: string | null;
-    creditsCharged?: number;
-    [key: string]: unknown;
-}
 /** A personal knowledge-base entry returned by the runtime API. */
 export interface PersonalKnowledgeBaseItem {
     id: string;
@@ -339,83 +218,7 @@ export interface LoginUserInfo {
     email?: string | null;
     [key: string]: unknown;
 }
-/** Runtime approval task returned by the current task APIs. */
-export interface ApprovalFlowTaskItem {
-    id?: string;
-    name?: string;
-    taskDefinitionKey?: string;
-    assignee?: string;
-    assigneeName?: string;
-    transferCandidates?: Array<{
-        userId?: string;
-        userName?: string;
-    }>;
-    processInstanceId?: string;
-    flowCode?: string;
-    flowName?: string;
-    appCode?: string;
-    initiatorUserId?: string;
-    initiatorUsername?: string;
-    datasetCode?: string;
-    pageId?: number;
-    operationType?: string;
-    dataId?: unknown;
-    detailUrl?: string;
-    taskStatus?: string;
-    processStatus?: string;
-    createTime?: number;
-    endTime?: number;
-    processStartTime?: number;
-    [key: string]: unknown;
-}
-/** Page envelope returned by `GET /client/approve/todo`. */
-export interface ApprovalFlowTodoPage {
-    records: ApprovalFlowTaskItem[];
-    currentPage?: number;
-    pageSize?: number;
-    totalCount?: number;
-    totalPages?: number;
-    [key: string]: unknown;
-}
-/** Task detail returned by `GET /client/flow/task/{taskId}`. */
-export interface ApprovalFlowTaskDetail {
-    id?: string;
-    name?: string;
-    taskDefinitionKey?: string;
-    assignee?: string;
-    assigneeName?: string;
-    processInstanceId?: string;
-    appCode?: string;
-    dataId?: unknown;
-    createTime?: number;
-    endTime?: number;
-    status?: string;
-    canHandle?: boolean;
-    canCancel?: boolean;
-    transferCandidates?: Array<{
-        userId?: string;
-        userName?: string;
-    }>;
-    formData?: Record<string, unknown>;
-    identityLinks?: Array<Record<string, unknown>>;
-    timeline?: Record<string, unknown>;
-    [key: string]: unknown;
-}
-/** Request body accepted by `POST /client/flow/approve`. */
-export interface ApprovalFlowApproveInput {
-    appCode: string;
-    taskId: string;
-    approved: boolean;
-    comment?: string;
-    variables?: Record<string, unknown>;
-}
-/** Request body accepted by `POST /client/flow/task/transfer`. */
-export interface ApprovalFlowTransferInput {
-    appCode: string;
-    taskId: string;
-    targetUserId: string;
-    comment?: string;
-}
+export type ApprovalFlowTodoPage = PageResult<ApprovalFlowTaskItem>;
 export type RuntimeScheduleKind = "CRON" | "ONCE";
 export type RuntimeScheduleModel = "kimi/k3" | "deepseek-v4-flash-0731" | "deepseek-v4-pro-0813";
 export type RuntimeScheduleTaskStatus = "QUEUED" | "RUNNING" | "COMPLETED" | "FAILED" | "CANCELLED";
@@ -459,9 +262,9 @@ export declare function listApprovalTodo(appCode: string, currentPage?: number,
 /** Fetches one approval task detail for the AccessKey-authenticated user. */
 export declare function getApprovalTaskDetail(taskId: string, appCode: string): Promise<ApprovalFlowTaskDetail>;
 /** Approves or rejects one approval task. */
-export declare function approveApprovalTask(input: ApprovalFlowApproveInput): Promise<unknown>;
+export declare function approveApprovalTask(input: ApprovalFlowApproveInput): Promise<null>;
 /** Transfers one approval task to a Runtime-authorized target user. */
-export declare function transferApprovalTask(input: ApprovalFlowTransferInput): Promise<unknown>;
+export declare function transferApprovalTask(input: ApprovalFlowTransferInput): Promise<null>;
 /** Fetches the current user's app list from the remote API. */
 export declare function getMyApps(): Promise<RemoteAppItem[]>;
 /**
@@ -504,7 +307,7 @@ export declare function listDatasets(appCode: string, options?: {
  * The server endpoint also accepts `id`, but runtime CLI keeps `code` as the
  * public contract because it is stable across environments and visible to users.
  */
-export declare function getDatasetDetail(datasetCode: string): Promise<any>;
+export declare function getDatasetDetail(datasetCode: string): Promise<unknown>;
 /** 导入只消费 AK Client 契约；写入结果不明时由检查点回查，不自动重试。 */
 export declare function getDatasetImportContract(appCode: string, datasetCode: string): Promise<any>;
 export declare function createDatasetImportBatch(appCode: string, datasetCode: string, body: {
@@ -533,18 +336,9 @@ export declare function queryRuntimeFileUrl(filePath: string, options?: {
     download?: boolean;
     longTerm?: boolean;
 }): Promise<RuntimeFileUrlResponse>;
-export declare function recognizeRuntimeOcr(appCode: string, input: {
-    url: string;
-    type: string;
-}): Promise<RuntimeOcrResponse>;
+export declare function recognizeRuntimeOcr(appCode: string, input: import("@lovrabet/sdk").OcrRecognizeRequest): Promise<RuntimeOcrResponse>;
 export declare function getRuntimeAppConfigByKey(appCode: string, key: string): Promise<string>;
 export type NotificationChannelType = "EMAIL" | "FEISHU" | "DINGTALK" | "WECOM" | "WEBHOOK";
-export interface NotificationChannelConfigItem {
-    configCode?: string | null;
-    configName?: string | null;
-    channelType?: string | null;
-    description?: string | null;
-}
 /** Lists app-level notification configs without using the development Cookie flow. */
 export declare function listNotificationChannelConfigs(appCode: string, channelType: NotificationChannelType): Promise<NotificationChannelConfigItem[]>;
 export declare function listRuntimeArtifacts(appCode: string, options?: {
@@ -608,34 +402,6 @@ export declare function getRuntimeSkillVersionDiagram(appCode: string, skillCode
 /** Downloads a runtime Skill package through SkillHub. */
 export declare function downloadRuntimeSkillPackage(scope: "personal" | "company" | "builtin", skillCode: string, appCode: string, version?: string): Promise<Buffer>;
 export type RuntimeAppRoleType = "ADMIN" | "USER" | "OWNER" | "CUSTOM";
-export interface RuntimeAppRole {
-    id: number;
-    appCode: string;
-    roleCode: string;
-    roleName: string;
-    roleType: RuntimeAppRoleType;
-    permits?: Record<string, string[]>;
-    remark?: string;
-    extend?: string;
-    userCount: number;
-    permitCount: number;
-    gmtCreate?: string;
-    gmtModified?: string;
-}
-export interface RuntimeRoleUserRef {
-    userId: number;
-    username?: string;
-    nickname?: string;
-    status?: string;
-}
-export interface RuntimeRoleUsers {
-    id: number;
-    roleCode: string;
-    roleName: string;
-    roleType: RuntimeAppRoleType;
-    userList: RuntimeRoleUserRef[];
-    applyUserList?: RuntimeRoleUserRef[];
-}
 export interface RuntimeAppRoleListOptions {
     roleName?: string;
     currentPage?: number;
@@ -651,97 +417,11 @@ export declare function createRuntimeAppRole(input: {
     roleName: string;
     remark?: string;
 }): Promise<RuntimeAppRole>;
-export declare function updateRuntimeAppRole(input: {
-    id: number;
-    appCode: string;
-    roleCode?: string;
-    roleName?: string;
-    remark?: string;
-}): Promise<RuntimeAppRole>;
-export declare function deleteRuntimeAppRole(id: number): Promise<boolean>;
+export declare function updateRuntimeAppRole(input: AppRoleUpdateParam): Promise<RuntimeAppRole>;
+export declare function deleteRuntimeAppRole(id: number): Promise<void>;
 export declare function listRuntimeRoleUsers(appCode: string): Promise<RuntimeRoleUsers[]>;
-export declare function updateRuntimeRoleUsers(appCode: string, roleList: RuntimeRoleUsers[]): Promise<boolean>;
-export interface RuntimeAppUser {
-    code: string | number;
-    userName: string;
-    nickName?: string;
-    displayName?: string;
-    status?: string;
-}
+export declare function updateRuntimeRoleUsers(appCode: string, roleList: RuntimeRoleUsers[]): Promise<void>;
 export declare function listRuntimeAppUsers(appCode: string): Promise<RuntimeAppUser[]>;
-export interface RuntimePermitRole {
-    id: number;
-    roleType: RuntimeAppRoleType | "ALL" | "SELF" | "PUBLIC";
-    roleName: string;
-    allowed?: boolean;
-}
-export interface RuntimeResourcePermit {
-    id?: number;
-    appCode?: string;
-    menuId?: number | null;
-    pageId?: number | null;
-    resourceCode: string;
-    resourceType: string;
-    resourceName?: string;
-    rolePermit: RuntimePermitRole[] | null;
-    dataPermit?: RuntimePermitRole[] | null;
-    fieldPermit?: string;
-    extend?: string;
-}
-export interface RuntimePagePermit {
-    menuId: number;
-    pageId?: number;
-    appCode: string;
-    datasetCode?: string;
-    menuPermit: RuntimeResourcePermit;
-    dataCreate?: RuntimeResourcePermit;
-    dataUpdate?: RuntimeResourcePermit;
-    dataDelete?: RuntimeResourcePermit;
-    dataDetail?: RuntimeResourcePermit;
-    dataExport?: RuntimeResourcePermit;
-    dataPermit?: RuntimeResourcePermit;
-}
-export interface RuntimeEvaluatedResource {
-    resourceType: string;
-    resourceCode: string;
-    resourceName?: string;
-    allowed?: boolean;
-    allowedActions?: string[];
-    appCode?: string;
-    menuType?: string;
-    pageId?: number | null;
-    pageNodeList?: RuntimeEvaluatedResource[] | null;
-}
-export interface RuntimeMenuRolePermitNode {
-    id: number;
-    parentId?: number;
-    label: string;
-    type?: string;
-    path?: string;
-    pageId?: number | null;
-    permitId?: number | null;
-    rolePermit: RuntimePermitRole[] | null;
-    children?: RuntimeMenuRolePermitNode[];
-}
-export interface RuntimeDatasetPermit {
-    appCode?: string;
-    datasetCode: string;
-    datasetName?: string;
-    dataPermitList: RuntimeEvaluatedResource[];
-}
-export interface RuntimeDatasetActionRolePermit {
-    permitId?: number | null;
-    resourceType: string;
-    resourceCode: string;
-    resourceName?: string;
-    rolePermit: RuntimePermitRole[] | null;
-}
-export interface RuntimeDatasetRolePermit {
-    appCode?: string;
-    datasetCode: string;
-    datasetName?: string;
-    dataPermitList: RuntimeDatasetActionRolePermit[];
-}
 export declare function listRuntimePermitRoles(appCode: string, options?: {
     needSelf?: boolean;
     needPublic?: boolean;
@@ -750,7 +430,7 @@ export declare function getRuntimePagePermit(menuId: number): Promise<RuntimePag
 export declare function saveRuntimePagePermit(input: RuntimePagePermit): Promise<RuntimePagePermit>;
 export declare function getRuntimeRoleMenuResources(appCode: string, roleId: number): Promise<RuntimeEvaluatedResource[]>;
 export declare function listRuntimeMenuRolePermits(appCode: string): Promise<RuntimeMenuRolePermitNode[]>;
-export declare function saveRuntimeMenuRolePermits(appCode: string, permitList: RuntimeResourcePermit[]): Promise<boolean>;
+export declare function saveRuntimeMenuRolePermits(appCode: string, permitList: RuntimeResourcePermit[]): Promise<void>;
 export declare function listRuntimeDatasetPermits(appCode: string, roleId: number): Promise<RuntimeDatasetPermit[]>;
 export declare function listRuntimeDatasetRolePermits(appCode: string): Promise<RuntimeDatasetRolePermit[]>;
-export declare function saveRuntimeDatasetRolePermits(appCode: string, permitList: RuntimeResourcePermit[]): Promise<boolean>;
+export declare function saveRuntimeDatasetRolePermits(appCode: string, permitList: RuntimeResourcePermit[]): Promise<void>;