smartbi-toolkit 1.1.2 → 1.1.4

package/dist/methods/SSReport.d.ts

@@ -0,0 +1,86 @@
+import type { NameValuePair, Parameter, RunningInfo, SSReportExportType } from '../types';
+/**
+ * 打开电子表格报表
+ * @param id 报表ID
+ * @returns 无返回值
+ */
+export declare const openSSReport: (id: string) => Promise<void>;
+/**
+ * 关闭电子表格报表
+ * @returns 无返回值
+ */
+export declare const closeSSReport: () => Promise<void>;
+/**
+ * 获取参数列表
+ * @returns 返回参数列表
+ */
+export declare const getSSReportParamList: () => Promise<Parameter[]>;
+/**
+ * 根据参数ID获取参数备选值
+ * @param paramId 参数ID
+ * @returns 返回参数键值对
+ */
+export declare const getSSReportParamStandbyValue: (paramId: string) => Promise<NameValuePair[]>;
+/**
+ * 根据参数ID获取参数默认值
+ * @param pid 参数ID
+ * @returns 返回参数默认值
+ */
+export declare const getSSReportParamDefaultValueByPID: (pid: string) => Promise<string>;
+/**
+ * 导出电子表格（基础版）
+ * @param type 导出类型
+ * @param os 输出流
+ * @returns 无返回值
+ */
+export declare const exportSSReport: (type: SSReportExportType | string, os: any) => Promise<void>;
+/**
+ * 导出电子表格（带参数版）
+ * @param type 导出格式
+ * @param os 输出流
+ * @param postData 请求参数
+ * @returns 无返回值
+ */
+export declare const exportSSReportWithPostData: (type: SSReportExportType | string, os: any, postData: string) => Promise<void>;
+/**
+ * 设置参数值
+ * @param id 参数ID
+ * @param value 值
+ * @param displayValue 显示值
+ * @returns 无返回值
+ */
+export declare const setSSReportParamValue: (id: string, value: string, displayValue: string) => Promise<void>;
+/**
+ * 设置导出工作单的索引
+ * @param exportSheetIndexes 导出工作单的索引
+ * @returns 无返回值
+ */
+export declare const setSSReportExportSheetIndexes: (exportSheetIndexes: string) => Promise<void>;
+/**
+ * 设置是否导出公式
+ * @param exportFormula 是否导出公式
+ * @returns 无返回值
+ */
+export declare const setSSReportExportFormula: (exportFormula: boolean) => Promise<void>;
+/**
+ * 获取执行状态
+ * @returns 返回执行状态
+ */
+export declare const getSSReportExecutingState: () => Promise<RunningInfo>;
+/**
+ * 获取操作
+ * @returns 返回操作
+ */
+export declare const getSSReportOperation: () => Promise<string>;
+/**
+ * 设置操作
+ * @param operation 操作
+ * @returns 无返回值
+ */
+export declare const setSSReportOperation: (operation: string) => Promise<void>;
+/**
+ * 设置筛选条件
+ * @param filtersRule 筛选条件json
+ * @returns 无返回值
+ */
+export declare const setSSReportFiltersRule: (filtersRule: string) => Promise<void>;

package/dist/methods/SSReport.js

@@ -0,0 +1,114 @@
+import { smartbi } from "../index";
+/**
+ * 打开电子表格报表
+ * @param id 报表ID
+ * @returns 无返回值
+ */
+export const openSSReport = (id) => {
+    return smartbi('SSReport', 'open', [id]);
+};
+/**
+ * 关闭电子表格报表
+ * @returns 无返回值
+ */
+export const closeSSReport = () => {
+    return smartbi('SSReport', 'close', []);
+};
+/**
+ * 获取参数列表
+ * @returns 返回参数列表
+ */
+export const getSSReportParamList = () => {
+    return smartbi('SSReport', 'getParamList', []);
+};
+/**
+ * 根据参数ID获取参数备选值
+ * @param paramId 参数ID
+ * @returns 返回参数键值对
+ */
+export const getSSReportParamStandbyValue = (paramId) => {
+    return smartbi('SSReport', 'getParamStandbyValue', [paramId]);
+};
+/**
+ * 根据参数ID获取参数默认值
+ * @param pid 参数ID
+ * @returns 返回参数默认值
+ */
+export const getSSReportParamDefaultValueByPID = (pid) => {
+    return smartbi('SSReport', 'getParamDefaultValueByPID', [pid]);
+};
+/**
+ * 导出电子表格（基础版）
+ * @param type 导出类型
+ * @param os 输出流
+ * @returns 无返回值
+ */
+export const exportSSReport = (type, os) => {
+    return smartbi('SSReport', 'doExport', [type, os]);
+};
+/**
+ * 导出电子表格（带参数版）
+ * @param type 导出格式
+ * @param os 输出流
+ * @param postData 请求参数
+ * @returns 无返回值
+ */
+export const exportSSReportWithPostData = (type, os, postData) => {
+    return smartbi('SSReport', 'doExport', [type, os, postData]);
+};
+/**
+ * 设置参数值
+ * @param id 参数ID
+ * @param value 值
+ * @param displayValue 显示值
+ * @returns 无返回值
+ */
+export const setSSReportParamValue = (id, value, displayValue) => {
+    return smartbi('SSReport', 'setParamValue', [id, value, displayValue]);
+};
+/**
+ * 设置导出工作单的索引
+ * @param exportSheetIndexes 导出工作单的索引
+ * @returns 无返回值
+ */
+export const setSSReportExportSheetIndexes = (exportSheetIndexes) => {
+    return smartbi('SSReport', 'setExportSheetIndexes', [exportSheetIndexes]);
+};
+/**
+ * 设置是否导出公式
+ * @param exportFormula 是否导出公式
+ * @returns 无返回值
+ */
+export const setSSReportExportFormula = (exportFormula) => {
+    return smartbi('SSReport', 'setExportFormula', [exportFormula]);
+};
+/**
+ * 获取执行状态
+ * @returns 返回执行状态
+ */
+export const getSSReportExecutingState = () => {
+    return smartbi('SSReport', 'getExecutingState', []);
+};
+/**
+ * 获取操作
+ * @returns 返回操作
+ */
+export const getSSReportOperation = () => {
+    return smartbi('SSReport', 'getOperation', []);
+};
+/**
+ * 设置操作
+ * @param operation 操作
+ * @returns 无返回值
+ */
+export const setSSReportOperation = (operation) => {
+    return smartbi('SSReport', 'setOperation', [operation]);
+};
+/**
+ * 设置筛选条件
+ * @param filtersRule 筛选条件json
+ * @returns 无返回值
+ */
+export const setSSReportFiltersRule = (filtersRule) => {
+    return smartbi('SSReport', 'setFiltersRule', [filtersRule]);
+};

package/dist/methods/ScheduleTaskService.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 执行计划任务
+ * @param scheduleId 计划ID
+ * @returns 返回执行结果的布尔值
+ */
+export declare const executeSchedule: (scheduleId: string) => Promise<boolean>;
+/**
+ * 执行任务
+ * @param taskId 任务ID
+ * @returns 返回执行结果的布尔值
+ */
+export declare const executeTask: (taskId: string) => Promise<boolean>;

package/dist/methods/ScheduleTaskService.js

@@ -0,0 +1,18 @@
+// 定义SmartBI计划任务服务相关的类型接口
+import { smartbi } from "../index";
+/**
+ * 执行计划任务
+ * @param scheduleId 计划ID
+ * @returns 返回执行结果的布尔值
+ */
+export const executeSchedule = (scheduleId) => {
+    return smartbi('ScheduleTaskService', 'executeSchedule', [scheduleId]);
+};
+/**
+ * 执行任务
+ * @param taskId 任务ID
+ * @returns 返回执行结果的布尔值
+ */
+export const executeTask = (taskId) => {
+    return smartbi('ScheduleTaskService', 'executeTask', [taskId]);
+};

package/dist/methods/SimpleReportService.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 创建并打开一个报表
+ * @param reportId 报表ID
+ * @returns 返回打开的报表对象
+ */
+export declare const openReport: (reportId: string) => Promise<any>;
+/**
+ * 打开一个报表不初始化数据库链接
+ * @param reportId 报表ID
+ * @returns 返回打开的报表对象
+ */
+export declare const openReportWithoutInit: (reportId: string) => Promise<any>;

package/dist/methods/SimpleReportService.js

@@ -0,0 +1,18 @@
+// 定义SmartBI简单报表服务相关的类型接口
+import { smartbi } from "../index";
+/**
+ * 创建并打开一个报表
+ * @param reportId 报表ID
+ * @returns 返回打开的报表对象
+ */
+export const openReport = (reportId) => {
+    return smartbi('SimpleReportService', 'openReport', [reportId]);
+};
+/**
+ * 打开一个报表不初始化数据库链接
+ * @param reportId 报表ID
+ * @returns 返回打开的报表对象
+ */
+export const openReportWithoutInit = (reportId) => {
+    return smartbi('SimpleReportService', 'openReportWithoutInit', [reportId]);
+};

package/dist/methods/SpreadSheetReportService.d.ts

@@ -0,0 +1,43 @@
+import type { NameValuePair } from '../types';
+/**
+ * 打开电子表格报表
+ * @param reportId 报表ID
+ * @returns 返回客户端ID
+ */
+export declare const openSpreadSheetReportQuery: (reportId: string) => Promise<any>;
+/**
+ * 关闭电子表格报表
+ * @param clientId 客户端ID
+ * @returns 无返回值
+ */
+export declare const closeSpreadSheetReportQuery: (clientId: string) => Promise<void>;
+/**
+ * 根据参数ID获取参数默认值
+ * @param panelId 参数面板ID
+ * @param paramId 参数ID
+ * @returns 返回参数默认值
+ */
+export declare const getSpreadSheetReportParamDefaultValueByPID: (panelId: string, paramId: string) => Promise<any[]>;
+/**
+ * 获取参数备选值
+ * @param panelId 参数面板ID
+ * @param paramId 参数ID
+ * @returns 返回参数标准值
+ */
+export declare const getSpreadSheetReportParamStandbyValue: (panelId: string, paramId: string) => Promise<NameValuePair[]>;
+/**
+ * 获取报表层面的参数默认值
+ * @param contextId 报表上下文会话id
+ * @param paramId 参数id
+ * @returns 返回报表参数默认值
+ */
+export declare const getSpreadSheetReportParamDefaultValueByContext: (contextId: string, paramId: string) => Promise<any[]>;
+/**
+ * 设置参数值
+ * @param panelId 参数面板ID
+ * @param paramId 参数ID
+ * @param value 值
+ * @param displayValue 显示值
+ * @returns 返回是否设置成功的布尔值
+ */
+export declare const setSpreadSheetReportParamValue: (panelId: string, paramId: string, value: string, displayValue: string) => Promise<boolean>;

package/dist/methods/SpreadSheetReportService.js

@@ -0,0 +1,55 @@
+import { smartbi } from "../index";
+/**
+ * 打开电子表格报表
+ * @param reportId 报表ID
+ * @returns 返回客户端ID
+ */
+export const openSpreadSheetReportQuery = (reportId) => {
+    return smartbi('SpreadSheetReportService', 'openQuery', [reportId]);
+};
+/**
+ * 关闭电子表格报表
+ * @param clientId 客户端ID
+ * @returns 无返回值
+ */
+export const closeSpreadSheetReportQuery = (clientId) => {
+    return smartbi('SpreadSheetReportService', 'closeQuery', [clientId]);
+};
+/**
+ * 根据参数ID获取参数默认值
+ * @param panelId 参数面板ID
+ * @param paramId 参数ID
+ * @returns 返回参数默认值
+ */
+export const getSpreadSheetReportParamDefaultValueByPID = (panelId, paramId) => {
+    return smartbi('SpreadSheetReportService', 'getParamDefaultValueByPID', [panelId, paramId]);
+};
+/**
+ * 获取参数备选值
+ * @param panelId 参数面板ID
+ * @param paramId 参数ID
+ * @returns 返回参数标准值
+ */
+export const getSpreadSheetReportParamStandbyValue = (panelId, paramId) => {
+    return smartbi('SpreadSheetReportService', 'getParamStandbyValue', [panelId, paramId]);
+};
+/**
+ * 获取报表层面的参数默认值
+ * @param contextId 报表上下文会话id
+ * @param paramId 参数id
+ * @returns 返回报表参数默认值
+ */
+export const getSpreadSheetReportParamDefaultValueByContext = (contextId, paramId) => {
+    return smartbi('SpreadSheetReportService', 'getReportParamDefaultValueByPID', [contextId, paramId]);
+};
+/**
+ * 设置参数值
+ * @param panelId 参数面板ID
+ * @param paramId 参数ID
+ * @param value 值
+ * @param displayValue 显示值
+ * @returns 返回是否设置成功的布尔值
+ */
+export const setSpreadSheetReportParamValue = (panelId, paramId, value, displayValue) => {
+    return smartbi('SpreadSheetReportService', 'setParamValue', [panelId, paramId, value, displayValue]);
+};

package/dist/methods/SystemConfigService.d.ts

@@ -0,0 +1,17 @@
+import type { SystemConfig } from '../types';
+/**
+ * 获取系统设置
+ * @returns 返回系统设置对象列表
+ */
+export declare const getSystemConfigs: () => Promise<SystemConfig[]>;
+/**
+ * 根据键获取系统配置
+ * @param key 配置键
+ * @returns 返回系统配置对象
+ */
+export declare const getSystemConfig: (key: string) => Promise<SystemConfig>;
+/**
+ * 清空缓存
+ * @returns 无返回值
+ */
+export declare const clearSystemConfigCache: () => Promise<void>;

package/dist/methods/SystemConfigService.js

@@ -0,0 +1,23 @@
+import { smartbi } from "../index";
+/**
+ * 获取系统设置
+ * @returns 返回系统设置对象列表
+ */
+export const getSystemConfigs = () => {
+    return smartbi('SystemConfigService', 'getSystemConfigs', []);
+};
+/**
+ * 根据键获取系统配置
+ * @param key 配置键
+ * @returns 返回系统配置对象
+ */
+export const getSystemConfig = (key) => {
+    return smartbi('SystemConfigService', 'getSystemConfig', [key]);
+};
+/**
+ * 清空缓存
+ * @returns 无返回值
+ */
+export const clearSystemConfigCache = () => {
+    return smartbi('SystemConfigService', 'clearCache', []);
+};

package/dist/methods/TimeConsuming.d.ts

@@ -0,0 +1,6 @@
+import type { RunningInfo } from '../types';
+/**
+ * 获取状态信息
+ * @returns 返回执行状态信息
+ */
+export declare const loadTimeConsuming: () => Promise<RunningInfo>;

package/dist/methods/TimeConsuming.js

@@ -0,0 +1,9 @@
+// 定义SmartBI耗时分析相关的类型接口
+import { smartbi } from "../index";
+/**
+ * 获取状态信息
+ * @returns 返回执行状态信息
+ */
+export const loadTimeConsuming = () => {
+    return smartbi('TimeConsuming', 'load', []);
+};

package/dist/methods/TimeConsumingService.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 获取执行时间信息
+ * @returns 返回执行时间信息的JSON对象
+ */
+export declare const loadRunningTimeConsuming: () => Promise<any>;

package/dist/methods/TimeConsumingService.js

@@ -0,0 +1,9 @@
+// 导入公共类型
+import { smartbi } from "../index";
+/**
+ * 获取执行时间信息
+ * @returns 返回执行时间信息的JSON对象
+ */
+export const loadRunningTimeConsuming = () => {
+    return smartbi('TimeConsumingService', 'loadRunning', []);
+};

package/dist/methods/UserManagerService.d.ts

@@ -0,0 +1,236 @@
+import type { User, Role, Department, FunctionPermission, ExtensionAttribute } from '../types';
+/**
+ * 创建用户
+ * @param parentGroupId 父组ID
+ * @param userName 用户名
+ * @param userAlias 用户别名
+ * @param desc 描述
+ * @param password 密码
+ * @param isEnabled 是否启用
+ * @param forceChangePassword 是否强制修改密码(可选)
+ * @returns 返回新创建的用户ID
+ */
+export declare const createUser: (parentGroupId: string, userName: string, userAlias: string, desc: string, password: string, isEnabled: boolean, forceChangePassword?: boolean) => Promise<string>;
+/**
+ * 指定ID创建用户
+ * @param parentGroupId 父组ID
+ * @param userId 用户ID
+ * @param userName 用户名
+ * @param userAlias 用户别名
+ * @param desc 描述
+ * @param password 密码
+ * @param isEnabled 是否启用
+ * @param forceChangePassword 是否强制修改密码(可选)
+ */
+export declare const createUserById: (parentGroupId: string, userId: string, userName: string, userAlias: string, desc: string, password: string, isEnabled: boolean, forceChangePassword?: boolean) => Promise<void>;
+/**
+ * 删除用户
+ * @param userId 用户ID
+ * @returns 返回是否删除成功的布尔值
+ */
+export declare const deleteUser: (userId: string) => Promise<boolean>;
+/**
+ * 通过用户ID获取用户信息
+ * @param id 用户ID
+ * @returns 返回用户信息
+ */
+export declare const getUserById: (id: string) => Promise<User>;
+/**
+ * 通过用户名称获取用户信息
+ * @param name 用户名称
+ * @returns 返回用户信息
+ */
+export declare const getUserByName: (name: string) => Promise<User>;
+/**
+ * 根据用户扩展属性获取用户信息
+ * @param key 属性键
+ * @param value 属性值
+ * @returns 返回用户列表
+ */
+export declare const getUserByAttribute: (key: string, value: string) => Promise<User[]>;
+/**
+ * 获取系统中的用户列表
+ * @returns 返回用户列表
+ */
+export declare const getAllUsers: () => Promise<User[]>;
+/**
+ * 获取当前登录用户信息
+ * @returns 返回当前用户信息
+ */
+export declare const getCurrentUser: () => Promise<User>;
+/**
+ * 修改当前用户的密码
+ * @param oldPassword 旧密码
+ * @param newPassword 新密码
+ */
+export declare const changePassword: (oldPassword: string, newPassword: string) => Promise<void>;
+/**
+ * 获取用户密码
+ * @param userName 用户名
+ * @returns 返回用户密码
+ */
+export declare const getPassword: (userName: string) => Promise<string>;
+/**
+ * 创建角色
+ * @param roleName 角色名称
+ * @param roleAlias 角色别名
+ * @param desc 描述
+ * @param groupId 组ID
+ * @returns 返回新创建的角色ID
+ */
+export declare const createRole: (roleName: string, roleAlias: string, desc: string, groupId: string) => Promise<string>;
+/**
+ * 删除角色
+ * @param roleId 角色ID
+ * @returns 返回是否删除成功的布尔值
+ */
+export declare const deleteRole: (roleId: string) => Promise<boolean>;
+/**
+ * 通过ID获取角色
+ * @param id 角色ID
+ * @returns 返回角色信息
+ */
+export declare const getRoleById: (id: string) => Promise<Role>;
+/**
+ * 通过角色名称获取角色对象
+ * @param name 角色名称
+ * @returns 返回角色信息
+ */
+export declare const getRoleByName: (name: string) => Promise<Role>;
+/**
+ * 获取系统中的角色列表
+ * @returns 返回角色列表
+ */
+export declare const getAllRoles: () => Promise<Role[]>;
+/**
+ * 给用户分配角色
+ * @param userId 用户ID
+ * @param roleIdList 角色ID列表
+ * @returns 返回是否分配成功的布尔值
+ */
+export declare const assignRolesToUser: (userId: string, roleIdList: string[]) => Promise<boolean>;
+/**
+ * 给角色分配用户
+ * @param roleId 角色ID
+ * @param userIdList 用户ID列表
+ * @returns 返回是否分配成功的布尔值
+ */
+export declare const assignUsersToRole: (roleId: string, userIdList: string[]) => Promise<boolean>;
+/**
+ * 创建组
+ * @param parentGroupId 父组ID
+ * @param groupName 组名称
+ * @param groupAlias 组别名
+ * @param desc 描述
+ * @param departmentCode 组编号
+ * @returns 返回新创建的组ID
+ */
+export declare const createDepartment: (parentGroupId: string, groupName: string, groupAlias: string, desc: string, departmentCode: string) => Promise<string>;
+/**
+ * 删除组
+ * @param groupId 组ID
+ * @returns 返回是否删除成功的布尔值
+ */
+export declare const deleteDepartment: (groupId: string) => Promise<boolean>;
+/**
+ * 通过ID获取组对象
+ * @param id 组ID
+ * @returns 返回组信息
+ */
+export declare const getDepartmentById: (id: string) => Promise<Department>;
+/**
+ * 通过组名称获取组对象
+ * @param name 组名称
+ * @returns 返回组信息
+ */
+export declare const getDepartmentByName: (name: string) => Promise<Department>;
+/**
+ * 通过组编号获取组对象
+ * @param code 组编号
+ * @returns 返回组信息
+ */
+export declare const getDepartmentByCode: (code: string) => Promise<Department>;
+/**
+ * 获取系统中的组列表
+ * @returns 返回组列表
+ */
+export declare const getAllDepartments: () => Promise<Department[]>;
+/**
+ * 获取用户的所属组
+ * @param userId 用户ID
+ * @returns 返回用户所属组列表
+ */
+export declare const getDepartmentsOfUser: (userId: string) => Promise<Department[]>;
+/**
+ * 修改组所拥有的用户
+ * @param groupId 组ID
+ * @param userIdList 用户ID列表
+ * @returns 返回是否修改成功的布尔值
+ */
+export declare const assignUsersToGroup: (groupId: string, userIdList: string[]) => Promise<boolean>;
+/**
+ * 修改用户的所属组
+ * @param userId 用户ID
+ * @param groupId 组ID列表
+ * @returns 返回是否修改成功的布尔值
+ */
+export declare const assignDepartmentsToUser: (userId: string, groupId: string[]) => Promise<boolean>;
+/**
+ * 添加扩展属性
+ * @param userId 用户ID
+ * @param key 属性键
+ * @param value 属性值
+ * @param longValue 长值
+ * @returns 返回是否添加成功的布尔值
+ */
+export declare const addUserAttribute: (userId: string, key: string, value: string, longValue: string) => Promise<boolean>;
+/**
+ * 获取指定的属性值
+ * @param userId 用户ID
+ * @param key 属性键
+ * @returns 返回扩展属性
+ */
+export declare const getUserAttribute: (userId: string, key: string) => Promise<ExtensionAttribute>;
+/**
+ * 获取某用户所有的属性值
+ * @param userId 用户ID
+ * @returns 返回用户所有扩展属性列表
+ */
+export declare const getAllUserAttributes: (userId: string) => Promise<ExtensionAttribute[]>;
+/**
+ * 创建操作权限
+ * @param funcId 权限ID
+ * @param parentFuncId 父权限ID
+ * @param funcName 权限名称
+ * @param funcAlias 权限别名
+ * @param funcDesc 权限描述
+ * @returns 返回是否创建成功的布尔值
+ */
+export declare const createFunction: (funcId: string, parentFuncId: string, funcName: string, funcAlias: string, funcDesc: string) => Promise<boolean>;
+/**
+ * 删除操作权限
+ * @param funcId 权限ID
+ * @returns 返回是否删除成功的布尔值
+ */
+export declare const deleteFunction: (funcId: string) => Promise<boolean>;
+/**
+ * 通过操作权限ID获取操作权限对象
+ * @param funcId 权限ID
+ * @returns 返回权限信息
+ */
+export declare const getFunctionById: (funcId: string) => Promise<FunctionPermission>;
+/**
+ * 获取所有操作权限列表
+ * @returns 返回权限列表
+ */
+export declare const getAllFunctions: () => Promise<FunctionPermission[]>;
+/**
+ * 获取License中的关键信息
+ * @returns 返回License信息
+ */
+export declare const getLicenseInfo: () => Promise<any>;
+/**
+ * 获取系统中所有License模块名称列表
+ * @returns 返回License模块名称列表
+ */
+export declare const getLicenses: () => Promise<string[]>;