smartbi-toolkit 1.1.3 → 1.2.0

package/dist/service/Report.js

@@ -0,0 +1,275 @@
+import { smartbi } from "../index.js";
+
+//#region src/service/Report.ts
+/**
+* 取得当前报表名
+* @returns 当前报表名
+*/
+const getCurrentReportName = () => {
+	return smartbi("Report", "getCurrentReportName", []);
+};
+/**
+* 取得每页行数
+* @returns 每页行数
+*/
+const getRowsPerPage = () => {
+	return smartbi("Report", "getRowsPerPage", []);
+};
+/**
+* 取得报表的参数信息
+* @returns 参数列表
+*/
+const getReportParameters = () => {
+	return smartbi("Report", "getParameters", []);
+};
+/**
+* 取得报表的字段信息
+* @returns 字段列表
+*/
+const getReportFields = () => {
+	return smartbi("Report", "getFields", []);
+};
+/**
+* 打开一个报表
+* @param reportId 报表ID
+* @returns 无返回值
+*/
+const openReport = (reportId) => {
+	return smartbi("Report", "open", [reportId]);
+};
+/**
+* 打开一个报表（不初始化）
+* @param reportId 报表ID
+* @returns 无返回值
+*/
+const openReportWithoutInit = (reportId) => {
+	return smartbi("Report", "openWithoutInit", [reportId]);
+};
+/**
+* 执行报表
+* @param rowsPerPage 指定每页行数
+* @returns 报表总行数
+*/
+const executeReport = (rowsPerPage) => {
+	return smartbi("Report", "execute", [rowsPerPage]);
+};
+/**
+* 取得报表的指定页
+* @param pageIndex 页码
+* @returns 报表数据
+*/
+const getPage = (pageIndex) => {
+	return smartbi("Report", "getPage", [pageIndex]);
+};
+/**
+* 关闭报表
+* @returns 无返回值
+*/
+const closeReport = () => {
+	return smartbi("Report", "close", []);
+};
+/**
+* 设置参数值（仅值）
+* @param paramId 参数ID
+* @param paramValue 参数值
+* @returns 无返回值
+*/
+const setReportParamValueOnly = (paramId, paramValue) => {
+	return smartbi("Report", "setParamValue", [paramId, paramValue]);
+};
+/**
+* 设置参数值
+* @param paramId 参数ID
+* @param paramValue 参数值
+* @param displayValue 参数显示值
+* @returns 无返回值
+*/
+const setReportParamValue = (paramId, paramValue, displayValue) => {
+	return smartbi("Report", "setParamValue", [
+		paramId,
+		paramValue,
+		displayValue
+	]);
+};
+/**
+* 导出报表（基础版）
+* @param type 指定导出类型 EXCEL, TXT, CSV
+* @param delimiter 指定分割符（EXCEL类型不需要）
+* @param maxRow 指定最大行数
+* @param os 指定报表输出流
+* @returns 无返回值
+*/
+const doExport = (type, delimiter, maxRow, os) => {
+	return smartbi("Report", "doExport", [
+		type,
+		delimiter,
+		maxRow,
+		os
+	]);
+};
+/**
+* 导出报表（带资源路径）
+* @param type 指定导出类型 EXCEL, TXT, CSV
+* @param delimiter 指定分割符（EXCEL类型不需要）
+* @param maxRow 指定最大行数
+* @param os 指定报表输出流
+* @param resourceBasePath 资源基础路径
+* @returns 无返回值
+*/
+const doExportWithResourcePath = (type, delimiter, maxRow, os, resourceBasePath) => {
+	return smartbi("Report", "doExport", [
+		type,
+		delimiter,
+		maxRow,
+		os,
+		resourceBasePath
+	]);
+};
+/**
+* 导出报表（带值类型）
+* @param type 指定导出类型 EXCEL, TXT, CSV
+* @param delimiter 指定分割符（EXCEL类型不需要）
+* @param maxRow 指定最大行数
+* @param os 指定报表输出流
+* @param resourceBasePath 资源基础路径
+* @param valueType 值类型
+* @returns 无返回值
+*/
+const doExportWithValueType = (type, delimiter, maxRow, os, resourceBasePath, valueType) => {
+	return smartbi("Report", "doExport", [
+		type,
+		delimiter,
+		maxRow,
+		os,
+		resourceBasePath,
+		valueType
+	]);
+};
+/**
+* 导出报表（完整版）
+* @param type 指定导出类型 EXCEL, TXT, CSV
+* @param delimiter 指定分割符（EXCEL类型不需要）
+* @param maxRow 指定最大行数
+* @param os 指定报表输出流
+* @param resourceBasePath 资源基础路径
+* @param valueType 值类型
+* @param postData 数据
+* @returns 无返回值
+*/
+const doExportFull = (type, delimiter, maxRow, os, resourceBasePath, valueType, postData) => {
+	return smartbi("Report", "doExport", [
+		type,
+		delimiter,
+		maxRow,
+		os,
+		resourceBasePath,
+		valueType,
+		postData
+	]);
+};
+/**
+* 指定某个字段的排序方式
+* @param fieldId 字段ID
+* @param orderType 排序方式 ASC, DESC, NONE
+* @returns 无返回值
+*/
+const setReportOrderByType = (fieldId, orderType) => {
+	return smartbi("Report", "setOrderByType", [fieldId, orderType]);
+};
+/**
+* 指定某个字段的聚合方式
+* @param fieldId 字段ID
+* @param aggregate 聚合方式
+* @returns 无返回值
+*/
+const setReportFieldAggregate = (fieldId, aggregate) => {
+	return smartbi("Report", "setFieldAggregate", [fieldId, aggregate]);
+};
+/**
+* 指定报表过滤条件
+* @param fieldId 字段ID
+* @param operator 操作符
+* @param value 值
+* @returns 无返回值
+*/
+const setReportAutoCondition = (fieldId, operator, value) => {
+	return smartbi("Report", "setAutoCondition", [
+		fieldId,
+		operator,
+		value
+	]);
+};
+/**
+* 设置自定义过滤条件
+* @param filterData 过滤条件数据
+* @returns 是否设置成功
+*/
+const setReportCustomCondition = (filterData) => {
+	return smartbi("Report", "setCustomCondition", [filterData.toString()]);
+};
+/**
+* 读取报表数据
+* @param reportId 报表ID
+* @returns 无返回值
+*/
+const dumpReport = (reportId) => {
+	return smartbi("Report", "dump", [reportId]);
+};
+/**
+* 修改报表
+* @returns 无返回值
+*/
+const updateReportQuery = () => {
+	return smartbi("Report", "updateQuery", []);
+};
+/**
+* 获得某个参数的候选值列表
+* @param paramId 参数ID
+* @returns 参数的候选值列表
+*/
+const getReportParamStandbyValue = (paramId) => {
+	return smartbi("Report", "getParamStandbyValue", [paramId]);
+};
+/**
+* 获取执行状态
+* @returns 执行状态
+*/
+const getReportExecutingState = () => {
+	return smartbi("Report", "getExecutingState", []);
+};
+/**
+* 把报表查询结果复制在另一张新的报表中
+* @param reportId 报表ID
+* @param parentNodeId 父节点ID
+* @param name 名称
+* @param alias 别名
+* @param desc 描述
+* @returns 新的报表ID
+*/
+const cloneReportQuery = (reportId, parentNodeId, name, alias, desc) => {
+	return smartbi("Report", "cloneQuery", [
+		reportId,
+		parentNodeId,
+		name,
+		alias,
+		desc
+	]);
+};
+/**
+* 获取客户端配置
+* @returns 客户端配置
+*/
+const getReportClientConfig = () => {
+	return smartbi("Report", "getClientConfig", []);
+};
+/**
+* 设置客户端配置
+* @param clientConfig 客户端配置
+* @returns 无返回值
+*/
+const setReportClientConfig = (clientConfig) => {
+	return smartbi("Report", "setClientConfig", [clientConfig]);
+};
+
+//#endregion
+export { cloneReportQuery, closeReport, doExport, doExportFull, doExportWithResourcePath, doExportWithValueType, dumpReport, executeReport, getCurrentReportName, getPage, getReportClientConfig, getReportExecutingState, getReportFields, getReportParamStandbyValue, getReportParameters, getRowsPerPage, openReport, openReportWithoutInit, setReportAutoCondition, setReportClientConfig, setReportCustomCondition, setReportFieldAggregate, setReportOrderByType, setReportParamValue, setReportParamValueOnly, updateReportQuery };

package/dist/service/SSReport.d.ts

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

package/dist/service/SSReport.js

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

package/dist/service/ScheduleTaskService.d.ts

@@ -0,0 +1,15 @@
+//#region src/service/ScheduleTaskService.d.ts
+/**
+ * 执行计划任务
+ * @param scheduleId 计划ID
+ * @returns 返回执行结果的布尔值
+ */
+declare const executeSchedule: (scheduleId: string) => Promise<boolean>;
+/**
+ * 执行任务
+ * @param taskId 任务ID
+ * @returns 返回执行结果的布尔值
+ */
+declare const executeTask: (taskId: string) => Promise<boolean>;
+//#endregion
+export { executeSchedule, executeTask };

package/dist/service/ScheduleTaskService.js

@@ -0,0 +1,22 @@
+import { smartbi } from "../index.js";
+
+//#region src/service/ScheduleTaskService.ts
+/**
+* 执行计划任务
+* @param scheduleId 计划ID
+* @returns 返回执行结果的布尔值
+*/
+const executeSchedule = (scheduleId) => {
+	return smartbi("ScheduleTaskService", "executeSchedule", [scheduleId]);
+};
+/**
+* 执行任务
+* @param taskId 任务ID
+* @returns 返回执行结果的布尔值
+*/
+const executeTask = (taskId) => {
+	return smartbi("ScheduleTaskService", "executeTask", [taskId]);
+};
+
+//#endregion
+export { executeSchedule, executeTask };

package/dist/service/SimpleReportService.d.ts

@@ -0,0 +1,15 @@
+//#region src/service/SimpleReportService.d.ts
+/**
+ * 创建并打开一个报表
+ * @param reportId 报表ID
+ * @returns 返回打开的报表对象
+ */
+declare const openReport: (reportId: string) => Promise<any>;
+/**
+ * 打开一个报表不初始化数据库链接
+ * @param reportId 报表ID
+ * @returns 返回打开的报表对象
+ */
+declare const openReportWithoutInit: (reportId: string) => Promise<any>;
+//#endregion
+export { openReport, openReportWithoutInit };

package/dist/service/SimpleReportService.js

@@ -0,0 +1,22 @@
+import { smartbi } from "../index.js";
+
+//#region src/service/SimpleReportService.ts
+/**
+* 创建并打开一个报表
+* @param reportId 报表ID
+* @returns 返回打开的报表对象
+*/
+const openReport = (reportId) => {
+	return smartbi("SimpleReportService", "openReport", [reportId]);
+};
+/**
+* 打开一个报表不初始化数据库链接
+* @param reportId 报表ID
+* @returns 返回打开的报表对象
+*/
+const openReportWithoutInit = (reportId) => {
+	return smartbi("SimpleReportService", "openReportWithoutInit", [reportId]);
+};
+
+//#endregion
+export { openReport, openReportWithoutInit };

package/dist/service/SpreadSheetReportService.d.ts

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

package/dist/service/SpreadSheetReportService.js

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

package/dist/service/SystemConfigService.d.ts

@@ -0,0 +1,21 @@
+import { U as SystemConfig } from "../types-DOYMZhxT.js";
+
+//#region src/service/SystemConfigService.d.ts
+/**
+ * 获取系统设置
+ * @returns 返回系统设置对象列表
+ */
+declare const getSystemConfigs: () => Promise<SystemConfig[]>;
+/**
+ * 根据键获取系统配置
+ * @param key 配置键
+ * @returns 返回系统配置对象
+ */
+declare const getSystemConfig: (key: string) => Promise<SystemConfig>;
+/**
+ * 清空缓存
+ * @returns 无返回值
+ */
+declare const clearSystemConfigCache: () => Promise<void>;
+//#endregion
+export { clearSystemConfigCache, getSystemConfig, getSystemConfigs };