smart-admin-web 10.5.0

package/dist/api/index.d.ts

@@ -0,0 +1,672 @@
+import { components } from './schema';
+import { AddUserInput, AddUserOutput, ChunkInitOutput, ConfigInput, CronPreviewOutput, DashboardSummary, DataScopeType, DictItem, DictItemInput, DictTypeInput, DuplicateStrategy, FileUploadOutput, ImportCommitResult, ImportPreview, ImportRow, JobDashboard, JobHandlersOutput, JobInput, LoginOutput, ModuleInput, ModuleRow, MyModulesOutput, MySessionItem, NoticeMineItem, NoticePublishInput, OnlineSessionItem, OrgInput, PermissionRouteItem, PositionInput, RoleInput, ServerInfoOutput, SysConfig, SysDictItem, SysDictType, SysExceptionLog, SysFile, SysJob, SysJobLog, SysLoginLog, SysNotice, SysOpLog, SysOrg, SysPosition, SysRole, SysRoleDataScope, UpdateUserInput, UserDetail, UserItem, UserProfile } from '../types/api';
+import { MenuInput, MenuNode, MenuTreeNode } from '../types/menu';
+/** 业务错误(含后端 code / msgKey);视图 catch 后经 translateError 展示。 */
+export declare class ApiError extends Error {
+    code: number;
+    msgKey?: string;
+    args?: Record<string, unknown>;
+    constructor(code: number, msgKey?: string, args?: Record<string, unknown>, message?: string);
+}
+/**
+ * 解包 openapi-fetch 结果,同时容忍两种形状:
+ *   - 2xx:body 是 Result<T> 信封;code!==0 抛 ApiError,否则返回 data.data。
+ *   - 非 2xx:enveloped(401/403/429)有 code → 抛带 code 的 ApiError;
+ *            ProblemDetails(400 校验 / 500)无 code → 抛 status + title/detail。
+ */
+export declare function unwrap<T>(res: {
+    data?: unknown;
+    error?: unknown;
+    response: Response;
+}): T;
+/**
+ * 按「方法 + 站内路径」调一个运行期才知道 url 的接口(通知动作按钮这类场景),
+ * 走同一套中间件(令牌 / CSRF / 刷新重放 / 超时)与信封解包。url 必须是 /api/ 开头的站内路径,
+ * 调用方先用 lib/noticeActions 的 classifyNoticeAction 把关。
+ */
+export declare function callApi<T = unknown>(method: 'GET' | 'POST', url: string, body?: unknown): Promise<T>;
+/**
+ * 分页三件套复用(每个列表端点都重复):
+ *   - 前端 {page,pageSize} → 后端 record 属性 {Current,Size}(PascalCase;ASP.NET 绑定大小写不敏感但类型要 Pascal)。
+ *     `...pageParams(p)` 展进各端点自己的 PascalCase 过滤条件,查询对象仍逐端点强类型校验(不走 any)。
+ *   - 后端 PagedList<T>({current,size,total,items}) → SmartTable fetcher 契约的 {items,total}。
+ *
+ * 二者连同 unwrap/ApiError 一起从包入口导出,是<b>应用写自己 API 模块的接缝</b>:应用的 `src/api/<域>.ts`
+ * 从 smart-admin-web 导入它们,分页端点就与内核端点同一套映射。包内没有别的调用方也必须留着,别当未使用导出清掉。
+ */
+export declare const pageParams: (p: {
+    page: number;
+    pageSize: number;
+}) => {
+    Current: number;
+    Size: number;
+};
+/**
+ * 「编号 + 名称 + 关键字 + 排序」这套列表参数是后端 CRUD 模板的默认产出,二十来个端点逐字重复。
+ * 不带 Keyword 的端点用 `Omit<ListParams, 'keyword'>`,别把不存在的过滤条件写进签名骗调用方。
+ */
+export interface ListParams {
+    page: number;
+    pageSize: number;
+    keyword?: string;
+    number?: string;
+    name?: string;
+    sortField?: string;
+    sortOrder?: string;
+}
+/**
+ * ListParams → 后端 PascalCase 查询串。
+ * undefined 字段由 openapi-fetch 的 querySerializer 直接跳过,所以不带 keyword 的端点复用它也不会多发参数。
+ */
+export declare const listQuery: (p: ListParams) => {
+    Keyword: string | undefined;
+    Number: string | undefined;
+    Name: string | undefined;
+    SortField: string | undefined;
+    SortOrder: string | undefined;
+    Current: number;
+    Size: number;
+};
+/**
+ * SmartTable 的 daterange 控件回传 `[开始, 结束]`(YYYY-MM-DD),后端要拆成两个参数。
+ * 结束日必须补 23:59:59,否则"筛到今天"会把今天已经发生的数据全部漏掉(纯日期串等价于当天 00:00:00)。
+ * 各域 API 模块的参数名不同(XxxStart/XxxEnd),所以这里只回中性的 start/end 由调用方改名。
+ */
+export declare const dayRange: (range?: [string, string] | null) => {
+    start: string | undefined;
+    end: string | undefined;
+};
+export declare function toPage<T>(res: Parameters<typeof unwrap>[0]): {
+    items: T[];
+    total: number;
+};
+/**
+ * 下载 xlsx 等二进制:parseAs blob + 手查 ok(坑 2:unwrap 假定 JSON 信封)。
+ * AdminExceptionFilter 对业务失败仍回 HTTP 200 + JSON 信封,故还要辨 content-type /
+ * 是否以 `{` 开头,避免把错误信封当 xlsx 触发下载。
+ *
+ * 与 unwrap/pageParams/toPage 一样是<b>应用接缝</b>:应用 `src/api/<域>.ts` 的导出端点从 smart-admin-web 导入它,
+ * 别在自己文件里再抄一份错误信封嗅探(抄漏一个分支就会把失败信封当 xlsx 存到用户磁盘上)。
+ */
+export declare function unwrapDownload(res: {
+    data?: unknown;
+    error?: unknown;
+    response: Response;
+}): Promise<Blob>;
+/**
+ * 归一 ImportPreview:int64/int 序列化噪音 → number,缺省数组补齐。
+ * 与 unwrap/unwrapDownload 一样是<b>应用接缝</b>:应用 `src/api/<域>.ts` 接自己的导入端点时从 smart-admin-web 导入它,
+ * 别各自抄一份归一逻辑 —— 漏一个 Number() 就会让 ImportWizard 的错误计数错位。
+ */
+export declare function normalizePreview(raw: ImportPreview): ImportPreview;
+export declare function normalizeCommit(raw: ImportCommitResult): ImportCommitResult;
+/**
+ * 回传行:schema 把 cells 标成 `Record<string, string>`(无 null),而运行时/编辑态允许空。
+ * 发送前把 null/undefined 收成 `''`,避免 openapi-fetch 类型卡死。
+ * 同为应用接缝,见 normalizePreview 上的说明。
+ */
+export declare function toWireRows(rows: ImportRow[]): {
+    index: number;
+    cells: Record<string, string>;
+    errors: {
+        columnKey: string;
+        code: number;
+        args: Record<string, never> | null | undefined;
+    }[];
+}[];
+export declare const authApi: {
+    login: (body: {
+        account: string;
+        password: string;
+        captchaId?: string;
+        captchaCode?: string;
+    }) => Promise<LoginOutput>;
+    logout: () => Promise<boolean>;
+    captcha: () => Promise<{
+        captchaId: string;
+        svg: string;
+        type?: string;
+    }>;
+    /** 短信二次验证:凭密码登录 40009 信令下发的挑战 Id + 短信码完成登录。 */
+    smsChallengeLogin: (body: {
+        challengeId: string;
+        code: string;
+    }) => Promise<LoginOutput>;
+    /** 短信二次验证:重发验证码(服务端冷却/日上限,过频抛 40008)。 */
+    smsChallengeResend: (body: {
+        challengeId: string;
+    }) => Promise<{
+        expiresSeconds: number;
+        resendSeconds: number;
+    }>;
+    /** TOTP 二次验证完成登录(40018 / SSO totpChallenge);走 openapi-fetch → CSRF/credentials 中间件生效。 */
+    totpChallengeLogin: (body: {
+        challengeId: string;
+        code: string;
+    }) => Promise<LoginOutput>;
+    /** 短时再认证(高危写操作 40024 后由中间件唤起;窗口约 5 分钟)。 */
+    reauth: (body: {
+        method?: string;
+        totpCode?: string;
+        password?: string;
+    }) => Promise<void>;
+    /** 免密登录发码(图形验证码启用时须携带;响应不区分手机号是否存在,防枚举)。 */
+    smsLoginSend: (body: {
+        phone: string;
+        captchaId?: string;
+        captchaCode?: string;
+    }) => Promise<{
+        expiresSeconds: number;
+        resendSeconds: number;
+    }>;
+    /** 免密登录:手机号 + 短信码换令牌。 */
+    smsLogin: (body: {
+        phone: string;
+        code: string;
+    }) => Promise<LoginOutput>;
+};
+/** TOTP 自助绑定 / 恢复 / 管理员清除(ADR 0006;无邀请路径)。 */
+export declare const mfaApi: {
+    bindStart: (body: components["schemas"]["TotpBindStartInput"]) => Promise<{
+        bindChallengeId?: string;
+        otpauthUri?: string;
+        seed?: string;
+        expiresSeconds?: number | string;
+    }>;
+    bindComplete: (body: components["schemas"]["TotpBindCompleteInput"]) => Promise<{
+        recoveryCodes?: string[];
+    }>;
+    recovery: (body: components["schemas"]["TotpRecoveryInput"]) => Promise<void>;
+    clear: (body: components["schemas"]["TotpClearMfaInput"]) => Promise<void>;
+};
+/** 高敏权限自定义追加(内核默认只读;写操作须 reauth)。 */
+export declare const highSensApi: {
+    list: () => Promise<{
+        defaults?: string[];
+        customs?: components["schemas"]["HighSensitivityPermissionItem"][];
+    }>;
+    add: (body: components["schemas"]["HighSensitivityPermissionInput"]) => Promise<{
+        id?: number | string;
+        permissionCode?: string;
+        remark?: null | string;
+    }>;
+    remove: (id: number) => Promise<void>;
+};
+export interface ExternalProvider {
+    code: string;
+    displayName: string;
+    icon?: string | null;
+}
+/** 管理端:全部已注册 provider(含已禁用)+ enabled / linkByAccount 两个运营开关。 */
+export interface ExternalProviderAdmin extends ExternalProvider {
+    enabled: boolean;
+    linkByAccount: boolean;
+}
+export interface ExternalBinding {
+    provider: string;
+    displayName?: string | null;
+    boundAt: string;
+}
+export declare const externalAuthApi: {
+    /** 登录页可用的外部登录方式(启用的);空数组 = 不显 SSO 区。 */
+    providers: () => Promise<ExternalProvider[]>;
+    /** 管理端全量列表(含已禁用);系统配置「第三方登录」Tab。 */
+    providersAll: () => Promise<ExternalProviderAdmin[]>;
+    /** 发起某 provider 登录的 URL(顶层浏览器导航,不走 fetch —— 后端 302 跳 IdP)。 */
+    authorizeUrl: (code: string) => string;
+    /** 一次性票据换令牌(登录回调后);票据无效/过期/已用抛 40014。 */
+    exchange: (ticket: string) => Promise<LoginOutput>;
+    /** 认领未绑定 SSO 的 pending-link(账密登录后);票据无效 40014,已被他人绑 40017。 */
+    claimPendingLink: (pendingLink: string) => Promise<boolean>;
+    /** 我的外部账号绑定列表(个人中心)。 */
+    bindings: () => Promise<ExternalBinding[]>;
+    /** 发起绑定:返回授权 URL,前端跳转开始 OAuth 往返(回调把身份绑到当前用户)。 */
+    bindStart: (code: string) => Promise<{
+        authorizeUrl: string;
+    }>;
+    /** 解绑某 provider 的外部账号。 */
+    unbind: (code: string) => Promise<boolean>;
+};
+export declare const dashboardApi: {
+    /** 工作台首页统计([ActiveSession]:任何登录用户可取,无需权限码)。 */
+    summary: () => Promise<DashboardSummary>;
+};
+export declare const personalApi: {
+    modules: () => Promise<MyModulesOutput>;
+    menu: (moduleId: number) => Promise<MenuNode[]>;
+    setDefaultModule: (moduleId: number) => Promise<boolean>;
+    profile: () => Promise<UserProfile>;
+    /** 改自己的资料(全量替换语义:缺字段即置空,前端整表单提交)。 */
+    updateProfile: (body: {
+        name: string;
+        nickname?: string | null;
+        phone?: string | null;
+        email?: string | null;
+        gender?: string | null;
+        avatar?: string | null;
+    }) => Promise<boolean>;
+    /** 我的活跃会话列表(个人视角;isCurrent = 本次请求所用会话)。 */
+    sessions: () => Promise<MySessionItem[]>;
+    /** 下线自己的某个会话;他人的/不存在的一律 42024(不区分,防探测)。 */
+    kickSession: (sessionId: string) => Promise<boolean>;
+    updatePassword: (body: {
+        oldPassword: string;
+        newPassword: string;
+    }) => Promise<boolean>;
+    /** 当前用户权限码集合(= 规范化路由);喂给 authStore.permissionCodes 驱动 v-auth。超管返回空集。 */
+    permissions: () => Promise<string[]>;
+};
+export declare const userApi: {
+    /** 归一后端 PagedList<UserItem>({current,size,total,items}) → SmartTable fetcher 契约的 {items,total}。 */
+    page: (params: {
+        page: number;
+        pageSize: number;
+        account?: string;
+        name?: string;
+        orgId?: number;
+        roleId?: number;
+        sortField?: string;
+        sortOrder?: string;
+    }) => Promise<{
+        items: UserItem[];
+        total: number;
+    }>;
+    /** 用户详情(含 roleIds,编辑回显 + 提交时原样带回避免清空角色)。 */
+    detail: (id: number) => Promise<UserDetail>;
+    /** 新增用户;返回新 Id + 实际生效的初始口令(留空 password 时后端随机生成,不接住就没人知道这个号的密码)。 */
+    add: (body: AddUserInput) => Promise<AddUserOutput>;
+    update: (id: number, body: UpdateUserInput) => Promise<boolean>;
+    remove: (id: number) => Promise<boolean>;
+    /** 批量软删除;集合含超管后端整体拒绝(SuperAdminProtected)。 */
+    batchRemove: (ids: number[]) => Promise<boolean>;
+    /** 重置密码;返回实际生效的初始密码(newPassword 留空 = 后端默认初始密码)。 */
+    resetPassword: (id: number, newPassword?: string | null) => Promise<string>;
+    /** 专用启停端点(非全量 update)。 */
+    setEnabled: (id: number, enabled: boolean) => Promise<boolean>;
+    /** 下载用户导入模板(xlsx)。[ActiveSession],无需独立权限码。 */
+    importTemplate: () => Promise<Blob>;
+    /**
+     * 上传 xlsx 预览校验。multipart:`file` + 可选 `mapping`(JSON 字符串:表头→列 Key)。
+     * bodySerializer 建 FormData(坑 3:与 fileApi.upload 同型)。
+     */
+    importPreview: (file: File, mapping?: Record<string, string>) => Promise<ImportPreview>;
+    /** 对前端改过的行重新校验(不碰文件)。 */
+    importValidate: (rows: ImportRow[]) => Promise<ImportPreview>;
+    /** 下载错误报告 xlsx(原列 +「错误原因」列)。 */
+    importErrorReport: (rows: ImportRow[]) => Promise<Blob>;
+    /** 按策略提交导入(部分提交:有错行跳过;服务端重校验,不信任前端 Errors)。 */
+    importCommit: (rows: ImportRow[], strategy?: DuplicateStrategy) => Promise<ImportCommitResult>;
+    /**
+     * 导出用户 xlsx。筛选条件与列表同源(Account/Name/OrgId/RoleId…)+ `columns` 逗号分隔列 Key。
+     * 返回 blob,不进信封。
+     */
+    export: (params: {
+        account?: string;
+        name?: string;
+        orgId?: number;
+        roleId?: number;
+        enabled?: boolean;
+        sortField?: string;
+        sortOrder?: string;
+        /** 逗号分隔列 Key;缺省 = 档案 DefaultSelected */
+        columns?: string;
+    }) => Promise<Blob>;
+};
+export declare const orgApi: {
+    /** 全部机构(平铺,按 Sort、Id 排序)。前端 buildTree 拼树。下拉 / 树表复用。 */
+    list: () => Promise<SysOrg[]>;
+    add: (body: OrgInput) => Promise<number>;
+    update: (id: number, body: OrgInput) => Promise<boolean>;
+    remove: (id: number) => Promise<boolean>;
+    /** 复制机构子树(整支克隆挂到源节点同级),返回新根 Id。 */
+    copy: (id: number, body?: {
+        name?: string;
+    }) => Promise<number>;
+};
+export declare const positionApi: {
+    /** 职位分页;搜索键 name → PascalCase Name;sortField/sortOrder → 后端安全排序。下拉(拉大页)/ SmartTable 复用。 */
+    page: (params: {
+        page: number;
+        pageSize: number;
+        name?: string;
+        sortField?: string;
+        sortOrder?: string;
+    }) => Promise<{
+        items: SysPosition[];
+        total: number;
+    }>;
+    add: (body: PositionInput) => Promise<number>;
+    update: (id: number, body: PositionInput) => Promise<boolean>;
+    remove: (id: number) => Promise<boolean>;
+};
+export declare const roleApi: {
+    /** 角色分页;搜索键 name → PascalCase Name。列表用 + 用户/授权页拉一大页当下拉源。 */
+    page: (params: {
+        page: number;
+        pageSize: number;
+        name?: string;
+    }) => Promise<{
+        items: SysRole[];
+        total: number;
+    }>;
+    add: (body: RoleInput) => Promise<number>;
+    update: (id: number, body: RoleInput) => Promise<boolean>;
+    remove: (id: number) => Promise<boolean>;
+    /** 批量删除角色(各自级联清关联)。 */
+    batchRemove: (ids: number[]) => Promise<boolean>;
+    /** 某角色当前授予的菜单 Id 集合(授权抽屉回显)。 */
+    getMenus: (id: number) => Promise<number[]>;
+    /** 全量设置角色授予的菜单(空数组 = 收回全部)。 */
+    setMenus: (roleId: number, menuIds: number[]) => Promise<boolean>;
+    /** 某角色的数据范围配置(未配置返回 null)。 */
+    getDataScope: (id: number) => Promise<SysRoleDataScope | null>;
+    /** 设置角色数据范围;customOrgIds 仅 scopeType=Custom(5)时有意义。 */
+    setDataScope: (roleId: number, scopeType: DataScopeType, customOrgIds?: number[]) => Promise<boolean>;
+    /** 某角色当前关联的用户 Id 集合(授权用户抽屉回显)。 */
+    getUsers: (id: number) => Promise<number[]>;
+    /** 全量设置角色关联的用户(空数组 = 收回全部)。 */
+    setUsers: (roleId: number, userIds: number[]) => Promise<boolean>;
+};
+export declare const moduleApi: {
+    list: () => Promise<ModuleRow[]>;
+    add: (body: ModuleInput) => Promise<number>;
+    update: (id: number, body: ModuleInput) => Promise<boolean>;
+    remove: (id: number) => Promise<boolean>;
+};
+export declare const configApi: {
+    /** 归一后端 PagedList<SysConfig> → SmartTable {items,total};搜索键 configKey/name/groupCode → PascalCase 查询参。 */
+    page: (params: {
+        page: number;
+        pageSize: number;
+        configKey?: string;
+        name?: string;
+        groupCode?: string;
+        excludedGroupCodes?: string[];
+    }) => Promise<{
+        items: SysConfig[];
+        total: number;
+    }>;
+    add: (body: ConfigInput) => Promise<number>;
+    update: (id: number, body: ConfigInput) => Promise<boolean>;
+    remove: (id: number) => Promise<boolean>;
+    /**
+     * 取某分组下全部配置(完整行,含 id/key/value),供分类配置中心结构化表单回填。
+     * 逐页取全:结构化表单按键回写,漏取的字段会拿默认值把库里的真实值覆盖掉。
+     */
+    listByGroup: (group: string) => Promise<SysConfig[]>;
+    /** 批量按键回写配置值(结构化表单保存);仅更新已存在键,未知键后端忽略。 */
+    saveBatch: (items: {
+        configKey: string;
+        configValue?: string | null;
+    }[]) => Promise<boolean>;
+    /** 站点信息(匿名可读:站点标题/副标题/版权等品牌展示白名单)。 */
+    siteInfo: () => Promise<{
+        title?: string | null;
+        subtitle?: string | null;
+        copyright?: string | null;
+        copyrightUrl?: string | null;
+        logo?: string | null;
+        captchaEnabled?: boolean;
+        smsLoginEnabled?: boolean;
+    }>;
+    /** 当前生效密码策略(任何登录用户可读);改密页据此展示真实规则清单,免配置读权限。 */
+    passwordPolicy: () => Promise<{
+        minLength: number;
+        requireUpper: boolean;
+        requireLower: boolean;
+        requireDigit: boolean;
+        requireSpecial: boolean;
+    }>;
+};
+export declare const logApi: {
+    /** 登录日志分页;账号模糊 + 成败 + 时间范围。 */
+    loginPage: (params: {
+        page: number;
+        pageSize: number;
+        account?: string;
+        success?: boolean;
+        createTime?: [string, string] | null;
+    }) => Promise<{
+        items: SysLoginLog[];
+        total: number;
+    }>;
+    /** 清空登录日志(硬删,不可恢复)。 */
+    loginClear: () => Promise<boolean>;
+    /** 操作日志分页;操作名模糊 + 成败 + 操作人(精确)+ 接口路径(模糊)+ 时间范围——审计要能答"谁在什么时候干了什么"。 */
+    opPage: (params: {
+        page: number;
+        pageSize: number;
+        title?: string;
+        success?: boolean;
+        operatorId?: number;
+        path?: string;
+        createTime?: [string, string] | null;
+    }) => Promise<{
+        items: SysOpLog[];
+        total: number;
+    }>;
+    /** 清空操作日志(硬删,不可恢复)。 */
+    opClear: () => Promise<boolean>;
+    /**
+     * 导出操作日志 xlsx。筛选与 opPage 同源 + `columns` 逗号分隔列 Key。
+     * 返回 blob(坑 2);不进信封。
+     */
+    opExport: (params: {
+        title?: string;
+        success?: boolean;
+        operatorId?: number;
+        path?: string;
+        createTime?: [string, string] | null;
+        columns?: string;
+    }) => Promise<Blob>;
+    /** 异常日志分页;接口路径模糊 + 异常类型模糊 + 时间范围。 */
+    exceptionPage: (params: {
+        page: number;
+        pageSize: number;
+        path?: string;
+        exceptionType?: string;
+        createTime?: [string, string] | null;
+    }) => Promise<{
+        items: SysExceptionLog[];
+        total: number;
+    }>;
+    /** 清空异常日志(硬删,不可恢复)。 */
+    exceptionClear: () => Promise<boolean>;
+};
+export declare const monitorApi: {
+    /** 服务器运行快照(CPU/内存/磁盘/运行时;后端含一次约 500ms 的 CPU 采样)。 */
+    server: () => Promise<ServerInfoOutput>;
+};
+export declare const cacheApi: {
+    /** 清全部用户的权限/数据范围缓存(返回被清用户数)。 */
+    flushAuth: () => Promise<number>;
+    /** 清全部字典项缓存(返回被清字典类型数)。 */
+    flushDict: () => Promise<number>;
+    /** 清全部系统配置缓存(返回被清配置项数)。 */
+    flushConfig: () => Promise<number>;
+    /** 递增门户代际,令所有用户的门户菜单/模块缓存整体失效(返回新代际值)。 */
+    rebuildPortal: () => Promise<number>;
+};
+export declare const dictApi: {
+    /** 按类型编码取字典项(服务端已按 sort 排序)。归一 int64 序列化噪音 → DictItem 投影,供 stores/dict 缓存消费。 */
+    items: (typeCode: string) => Promise<DictItem[]>;
+};
+export declare const dictAdminApi: {
+    /** 字典类型分页;搜索键 code/name → PascalCase Code/Name 查询参。 */
+    typePage: (params: {
+        page: number;
+        pageSize: number;
+        code?: string;
+        name?: string;
+    }) => Promise<{
+        items: SysDictType[];
+        total: number;
+    }>;
+    typeAdd: (body: DictTypeInput) => Promise<number>;
+    typeUpdate: (id: number, body: DictTypeInput) => Promise<boolean>;
+    typeRemove: (id: number) => Promise<boolean>;
+    /** 批量删除字典类型(各自级联删项)。 */
+    typeBatchRemove: (ids: number[]) => Promise<boolean>;
+    /** 某类型下的字典项(管理端:含停用、带 id;非下拉缓存源)。ponytail: 拉一页 200(Api:MaxPageSize 上限),字典项数量小,真超再分页。 */
+    items: (typeCode: string) => Promise<SysDictItem[]>;
+    itemAdd: (body: DictItemInput) => Promise<number>;
+    itemUpdate: (id: number, body: DictItemInput) => Promise<boolean>;
+    itemRemove: (id: number) => Promise<boolean>;
+    /** 批量删除字典项。 */
+    itemBatchRemove: (ids: number[]) => Promise<boolean>;
+};
+export declare const fileApi: {
+    /** 文件分页;搜索键 originalName → 后端 FileName 模糊过滤。 */
+    page: (params: {
+        page: number;
+        pageSize: number;
+        originalName?: string;
+    }) => Promise<{
+        items: SysFile[];
+        total: number;
+    }>;
+    /** 上传单个文件:bodySerializer 建 FormData(字段名 file),openapi-fetch 对 FormData 不注入 json header,浏览器自动补 boundary(client.ts 无需改)。 */
+    upload: (file: File) => Promise<FileUploadOutput>;
+    /** 下载:parseAs blob 取原始字节(非信封,不套 unwrap);Bearer 由 client 拦截器自动带。 */
+    download: (id: number) => Promise<Blob>;
+    remove: (id: number) => Promise<boolean>;
+    /** 批量软删除文件记录(物理文件保留)。 */
+    batchRemove: (ids: number[]) => Promise<boolean>;
+    /** 分片初始化:秒传探测 + 已收分片(断点续传)。 */
+    chunkInit: (body: {
+        fileHash: string;
+        fileName: string;
+        totalSize: number;
+        chunkCount: number;
+    }) => Promise<ChunkInitOutput>;
+    /** 上传单个分片(multipart:uploadId + index + chunk),同 upload 用 bodySerializer 建 FormData。 */
+    chunkUpload: (uploadId: string, index: number, chunk: Blob) => Promise<boolean>;
+    /** 完成:触发服务端合并 + 哈希校验 + 三道关 + 落库。 */
+    chunkComplete: (body: {
+        uploadId: string;
+        fileHash: string;
+        fileName: string;
+        chunkCount: number;
+    }) => Promise<FileUploadOutput>;
+};
+export declare const sessionApi: {
+    /** 在线会话分页(只读)。后端仅支持按 UserId 过滤,这里不带业务搜索。 */
+    online: (params: {
+        page: number;
+        pageSize: number;
+    }) => Promise<{
+        items: OnlineSessionItem[];
+        total: number;
+    }>;
+    /** 强制下线:按 sessionId 踢会话。 */
+    kick: (sessionId: string) => Promise<boolean>;
+};
+export declare const noticeApi: {
+    /** 管理端分页(全量);搜索键 title/type → PascalCase 查询参。 */
+    page: (params: {
+        page: number;
+        pageSize: number;
+        title?: string;
+        type?: number;
+    }) => Promise<{
+        items: SysNotice[];
+        total: number;
+    }>;
+    publish: (body: NoticePublishInput) => Promise<number>;
+    remove: (id: number) => Promise<boolean>;
+    /** 我的通知分页(含已读标记);onlyUnread 供"未读"页签用。 */
+    mine: (params: {
+        page: number;
+        pageSize: number;
+        onlyUnread?: boolean;
+    }) => Promise<{
+        items: NoticeMineItem[];
+        total: number;
+    }>;
+    /** 当前用户未读通知数(顶栏角标轮询)。 */
+    unreadCount: () => Promise<number>;
+    markRead: (id: number) => Promise<boolean>;
+    markAllRead: () => Promise<boolean>;
+};
+export declare const menuApi: {
+    tree: () => Promise<MenuTreeNode[]>;
+    /** 可授权路由清单(后端 EndpointDataSource 实时算出,含消费方自建控制器);喂菜单表单「权限码」下拉,免手敲。 */
+    routes: () => Promise<PermissionRouteItem[]>;
+    add: (body: MenuInput) => Promise<number>;
+    update: (id: number, body: MenuInput) => Promise<boolean>;
+    remove: (id: number) => Promise<boolean>;
+};
+export declare const jobApi: {
+    /** 任务分页;搜索键 name/status/handlerKind → PascalCase 查询参。行含全列,编辑表单直接用行数据。 */
+    page: (params: {
+        page: number;
+        pageSize: number;
+        name?: string;
+        status?: number;
+        handlerKind?: number;
+        sortField?: string;
+        sortOrder?: string;
+    }) => Promise<{
+        items: SysJob[];
+        total: number;
+    }>;
+    add: (body: JobInput) => Promise<number>;
+    update: (id: number, body: JobInput) => Promise<boolean>;
+    remove: (id: number) => Promise<boolean>;
+    /** 批量删除(命中内置任务后端整批拒绝 47014)。 */
+    batchRemove: (ids: number[]) => Promise<boolean>;
+    /** 专用启停端点:true=恢复调度并重算下次执行时刻(顺带清连败计数),false=暂停。 */
+    setEnabled: (id: number, enabled: boolean) => Promise<boolean>;
+    /** 执行一次(收到请求的副本本机执行,不经选主、不影响调度节奏)。 */
+    run: (id: number) => Promise<boolean>;
+    /** cron 预览([ActiveSession] 任何登录用户可用;POST 因 cron 含 `? #` 走 query 有转义坑)。 */
+    previewCron: (body: {
+        cron: string;
+        count?: number;
+        from?: string | null;
+    }) => Promise<CronPreviewOutput>;
+    /** 已注册的编译处理器清单(表单下拉数据源,免手打 HandlerName)。 */
+    handlers: () => Promise<JobHandlersOutput>;
+    /**
+     * 执行记录分页。startRange 是 SmartTable daterange 的 [开始, 结束] 日期串,
+     * 拆成后端 StartFrom/StartTo,结束日补 23:59:59(同 splitRange 的理由,但参数名不同,不复用)。
+     */
+    logPage: (params: {
+        page: number;
+        pageSize: number;
+        jobId?: number;
+        runStatus?: number;
+        startRange?: [string, string] | null;
+        fireInstanceId?: number;
+    }) => Promise<{
+        items: SysJobLog[];
+        total: number;
+    }>;
+    /** 终止一次执行(跨节点写终止旗标,目标节点最迟 KillPollSeconds 后停)。 */
+    kill: (logId: number) => Promise<boolean>;
+    /** 清空执行记录(硬删;运行中的一律保留),返回删除行数。 */
+    logClear: (body: {
+        beforeDays?: number | null;
+        jobId?: number | null;
+    }) => Promise<number>;
+    /** 监控仪表盘(今日成败/在飞/趋势/即将执行/集群节点)。 */
+    dashboard: () => Promise<JobDashboard>;
+};
+export interface RecycleBinItem {
+    id: number;
+    name: string;
+    code: string | null;
+    deletedAt: string | null;
+    deletedBy: number | null;
+}
+export declare const recycleApi: {
+    page: (type: string) => (params: {
+        page: number;
+        pageSize: number;
+    }) => Promise<{
+        items: RecycleBinItem[];
+        total: number;
+    }>;
+    restore: (type: string, id: number) => Promise<boolean>;
+    purge: (type: string, id: number) => Promise<boolean>;
+};