smartbi-toolkit 1.0.1 → 1.1.0

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,28 @@
+export interface SystemConfig {
+    id: string;
+    key: string;
+    name: string;
+    value: string;
+    description?: string;
+    category?: string;
+    dataType?: string;
+    defaultValue?: string;
+    editable?: boolean;
+    [key: string]: any;
+}
+/**
+ * 获取系统设置
+ * @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,24 @@
+// 定义SmartBI系统配置服务相关的类型接口
+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', []);
+};