smartbi-toolkit 1.1.3 → 1.2.0

package/dist/service/OfficeReport.js

@@ -0,0 +1,74 @@
+import { smartbi } from "../index.js";
+
+//#region src/service/OfficeReport.ts
+/**
+* 打开Word分析报告
+* @param id Word分析报告id
+* @returns 无返回值
+*/
+const openOfficeReport = (id) => {
+	return smartbi("OfficeReport", "open", [id]);
+};
+/**
+* 关闭Word分析报告
+* @returns 无返回值
+*/
+const closeOfficeReport = () => {
+	return smartbi("OfficeReport", "close", []);
+};
+/**
+* 获取Word分析报告参数列表
+* @returns 返回参数列表
+*/
+const getOfficeReportParamList = () => {
+	return smartbi("OfficeReport", "getParamList", []);
+};
+/**
+* 根据参数ID获取参数备选值
+* @param paramId 参数ID
+* @returns 返回参数备选值列表
+*/
+const getOfficeReportParamStandbyValue = (paramId) => {
+	return smartbi("OfficeReport", "getParamStandbyValue", [paramId]);
+};
+/**
+* 根据参数ID获取参数默认值
+* @param pid 参数ID
+* @returns 返回参数默认值
+*/
+const getOfficeReportParamDefaultValueByPID = (pid) => {
+	return smartbi("OfficeReport", "getParamDefaultValueByPID", [pid]);
+};
+/**
+* 设置参数值
+* @param id 参数ID
+* @param value 参数真实值
+* @param displayValue 参数显示值
+* @returns 无返回值
+*/
+const setOfficeReportParamValue = (id, value, displayValue) => {
+	return smartbi("OfficeReport", "setParamValue", [
+		id,
+		value,
+		displayValue
+	]);
+};
+/**
+* 导出Word分析报告
+* @param type 导出类型
+* @param os 输出流
+* @returns 无返回值
+*/
+const exportOfficeReport = (type, os) => {
+	return smartbi("OfficeReport", "doExport", [type, os]);
+};
+/**
+* 获取执行状态
+* @returns 返回执行状态信息
+*/
+const getOfficeReportExecutingState = () => {
+	return smartbi("OfficeReport", "getExecutingState", []);
+};
+
+//#endregion
+export { closeOfficeReport, exportOfficeReport, getOfficeReportExecutingState, getOfficeReportParamDefaultValueByPID, getOfficeReportParamList, getOfficeReportParamStandbyValue, openOfficeReport, setOfficeReportParamValue };

package/dist/service/OfficeReportService.d.ts

@@ -0,0 +1,40 @@
+import { D as NameValuePair } from "../types-DOYMZhxT.js";
+
+//#region src/service/OfficeReportService.d.ts
+/**
+ * 打开报表
+ * @param reportId 报表ID
+ * @returns 返回报表的JSON对象
+ */
+declare const openReport: (reportId: string) => Promise<any>;
+/**
+ * 关闭报表
+ * @param clientId 客户端ID
+ * @returns 无返回值
+ */
+declare const closeReport: (clientId: string) => Promise<void>;
+/**
+ * 获取参数备选值
+ * @param panelId 参数面板会话ID
+ * @param paramId 参数ID
+ * @returns 返回参数备选值列表
+ */
+declare const getParamStandbyValue: (panelId: string, paramId: string) => Promise<NameValuePair[]>;
+/**
+ * 根据参数ID获取参数默认值
+ * @param panelId 参数面板会话ID
+ * @param paramId 参数ID
+ * @returns 返回参数默认值的JSON数组
+ */
+declare const getParamDefaultValueByPID: (panelId: string, paramId: string) => Promise<any[]>;
+/**
+ * 设置参数值
+ * @param panelId 参数面板ID
+ * @param paramId 参数ID
+ * @param value 参数真实值
+ * @param displayValue 参数显示值
+ * @returns 返回是否设置成功的布尔值
+ */
+declare const setParamValue: (panelId: string, paramId: string, value: string, displayValue: string) => Promise<boolean>;
+//#endregion
+export { closeReport, getParamDefaultValueByPID, getParamStandbyValue, openReport, setParamValue };

package/dist/service/OfficeReportService.js

@@ -0,0 +1,56 @@
+import { smartbi } from "../index.js";
+
+//#region src/service/OfficeReportService.ts
+/**
+* 打开报表
+* @param reportId 报表ID
+* @returns 返回报表的JSON对象
+*/
+const openReport = (reportId) => {
+	return smartbi("OfficeReportService", "openReport", [reportId]);
+};
+/**
+* 关闭报表
+* @param clientId 客户端ID
+* @returns 无返回值
+*/
+const closeReport = (clientId) => {
+	return smartbi("OfficeReportService", "closeReport", [clientId]);
+};
+/**
+* 获取参数备选值
+* @param panelId 参数面板会话ID
+* @param paramId 参数ID
+* @returns 返回参数备选值列表
+*/
+const getParamStandbyValue = (panelId, paramId) => {
+	return smartbi("OfficeReportService", "getParamStandbyValue", [panelId, paramId]);
+};
+/**
+* 根据参数ID获取参数默认值
+* @param panelId 参数面板会话ID
+* @param paramId 参数ID
+* @returns 返回参数默认值的JSON数组
+*/
+const getParamDefaultValueByPID = (panelId, paramId) => {
+	return smartbi("OfficeReportService", "getParamDefaultValueByPID", [panelId, paramId]);
+};
+/**
+* 设置参数值
+* @param panelId 参数面板ID
+* @param paramId 参数ID
+* @param value 参数真实值
+* @param displayValue 参数显示值
+* @returns 返回是否设置成功的布尔值
+*/
+const setParamValue = (panelId, paramId, value, displayValue) => {
+	return smartbi("OfficeReportService", "setParamValue", [
+		panelId,
+		paramId,
+		value,
+		displayValue
+	]);
+};
+
+//#endregion
+export { closeReport, getParamDefaultValueByPID, getParamStandbyValue, openReport, setParamValue };

package/dist/service/OltpMetadataService.d.ts

@@ -0,0 +1,23 @@
+import { W as TableField, a as CalcField, d as DataSource } from "../types-DOYMZhxT.js";
+
+//#region src/service/OltpMetadataService.d.ts
+/**
+ * 获取计算字段对象的基本信息
+ * @param calcFieldById 计算字段ID
+ * @returns 返回计算字段对象
+ */
+declare const getCalcFieldById: (calcFieldById: string) => Promise<CalcField>;
+/**
+ * 获取指定的数据源的详细信息
+ * @param dataSourceID 数据源连接的ID值
+ * @returns 返回数据源对象
+ */
+declare const getOltpDataSource: (dataSourceID: string) => Promise<DataSource>;
+/**
+ * 获取指定的表的字段的详细信息，包括：数据类型、字段长度
+ * @param fieldId 表的字段
+ * @returns 返回表的字段的详细信息
+ */
+declare const getFieldAttribute: (fieldId: string) => Promise<TableField>;
+//#endregion
+export { getCalcFieldById, getFieldAttribute, getOltpDataSource };

package/dist/service/OltpMetadataService.js

@@ -0,0 +1,30 @@
+import { smartbi } from "../index.js";
+
+//#region src/service/OltpMetadataService.ts
+/**
+* 获取计算字段对象的基本信息
+* @param calcFieldById 计算字段ID
+* @returns 返回计算字段对象
+*/
+const getCalcFieldById = (calcFieldById) => {
+	return smartbi("OltpMetadataService", "getCalcFieldById", [calcFieldById]);
+};
+/**
+* 获取指定的数据源的详细信息
+* @param dataSourceID 数据源连接的ID值
+* @returns 返回数据源对象
+*/
+const getOltpDataSource = (dataSourceID) => {
+	return smartbi("OltpMetadataService", "getDataSource", [dataSourceID]);
+};
+/**
+* 获取指定的表的字段的详细信息，包括：数据类型、字段长度
+* @param fieldId 表的字段
+* @returns 返回表的字段的详细信息
+*/
+const getFieldAttribute = (fieldId) => {
+	return smartbi("OltpMetadataService", "getFieldAttribute", [fieldId]);
+};
+
+//#endregion
+export { getCalcFieldById, getFieldAttribute, getOltpDataSource };

package/dist/service/ParameterService.d.ts

@@ -0,0 +1,15 @@
+//#region src/service/ParameterService.d.ts
+/**
+ * 根据参数ID获取参数默认值SQL语句
+ * @param paramId 参数ID
+ * @returns 返回SQL语句
+ */
+declare const getParameterDefaultSQLById: (paramId: string) => Promise<string>;
+/**
+ * 根据参数ID获取参数备选值SQL语句
+ * @param paramId 参数ID
+ * @returns 返回SQL语句
+ */
+declare const getParameterStandbySQLById: (paramId: string) => Promise<string>;
+//#endregion
+export { getParameterDefaultSQLById, getParameterStandbySQLById };

package/dist/service/ParameterService.js

@@ -0,0 +1,22 @@
+import { smartbi } from "../index.js";
+
+//#region src/service/ParameterService.ts
+/**
+* 根据参数ID获取参数默认值SQL语句
+* @param paramId 参数ID
+* @returns 返回SQL语句
+*/
+const getParameterDefaultSQLById = (paramId) => {
+	return smartbi("ParameterService", "getParameterDefaultSQLById", [paramId]);
+};
+/**
+* 根据参数ID获取参数备选值SQL语句
+* @param paramId 参数ID
+* @returns 返回SQL语句
+*/
+const getParameterStandbySQLById = (paramId) => {
+	return smartbi("ParameterService", "getParameterStandbySQLById", [paramId]);
+};
+
+//#endregion
+export { getParameterDefaultSQLById, getParameterStandbySQLById };

package/dist/service/PoolService.d.ts

@@ -0,0 +1,14 @@
+//#region src/service/PoolService.d.ts
+/**
+ * 清除所有连接池
+ * @returns 无返回值
+ */
+declare const clearAllPools: () => Promise<void>;
+/**
+ * 根据连接池名称清除连接池
+ * @param poolName 连接池名称
+ * @returns 无返回值
+ */
+declare const clearPoolByName: (poolName: string) => Promise<void>;
+//#endregion
+export { clearAllPools, clearPoolByName };

package/dist/service/PoolService.js

@@ -0,0 +1,21 @@
+import { smartbi } from "../index.js";
+
+//#region src/service/PoolService.ts
+/**
+* 清除所有连接池
+* @returns 无返回值
+*/
+const clearAllPools = () => {
+	return smartbi("PoolService", "clearAllPools", []);
+};
+/**
+* 根据连接池名称清除连接池
+* @param poolName 连接池名称
+* @returns 无返回值
+*/
+const clearPoolByName = (poolName) => {
+	return smartbi("PoolService", "clearPoolByName", [poolName]);
+};
+
+//#endregion
+export { clearAllPools, clearPoolByName };

package/dist/service/PortalService.d.ts

@@ -0,0 +1,70 @@
+import { D as NameValuePair, j as Parameter } from "../types-DOYMZhxT.js";
+
+//#region src/service/PortalService.d.ts
+/**
+ * 打开整个页面
+ * @param pageId 页面ID
+ * @returns 返回客户端ID
+ */
+declare const openEntirePage: (pageId: string) => Promise<string>;
+/**
+ * 执行页面中所有的查询
+ * @param clientId 客户端ID
+ * @param portletType 组件类型
+ * @returns 无返回值
+ */
+declare const excuteAllQueryInPage: (clientId: string, portletType: string[]) => Promise<void>;
+/**
+ * 关闭整个页面
+ * @param clientId 客户端ID
+ * @returns 无返回值
+ */
+declare const closeEntirePage: (clientId: string) => Promise<void>;
+/**
+ * 导出页面
+ * @param clientId 客户端ID
+ * @param exportType 导出类型
+ * @param pageWidth 页面大小
+ * @param os 输出流
+ * @param postData 可选参数 - 参数
+ * @returns 无返回值
+ */
+declare const doExport: (clientId: string, exportType: string, pageWidth: number, os: any, postData?: string) => Promise<void>;
+/**
+ * 根据参数ID获取参数默认值
+ * @param clientId 客户端ID
+ * @param paramId 参数ID
+ * @returns 返回参数默认值
+ */
+declare const getParamDefaultValue: (clientId: string, paramId: string) => Promise<string>;
+/**
+ * 根据参数ID获取参数默认值列表
+ * @param clientId 客户端ID
+ * @param paramId 参数ID
+ * @returns 返回参数默认值列表
+ */
+declare const getParamDefaultValues: (clientId: string, paramId: string) => Promise<string[]>;
+/**
+ * 设置参数值
+ * @param clientId 客户端ID
+ * @param paramId 参数ID
+ * @param paramValue 参数值
+ * @param paramDisplayValue 参数显示值
+ * @returns 无返回值
+ */
+declare const setParamValue: (clientId: string, paramId: string, paramValue: string, paramDisplayValue: string) => Promise<void>;
+/**
+ * 获取页面的参数列表
+ * @param pageId 页面ID
+ * @returns 返回参数列表
+ */
+declare const getParameters: (pageId: string) => Promise<Parameter[]>;
+/**
+ * 获取参数备选值
+ * @param clientId 客户端ID
+ * @param paramId 参数ID
+ * @returns 返回参数标准值
+ */
+declare const getParamStandbyValue: (clientId: string, paramId: string) => Promise<NameValuePair[]>;
+//#endregion
+export { closeEntirePage, doExport, excuteAllQueryInPage, getParamDefaultValue, getParamDefaultValues, getParamStandbyValue, getParameters, openEntirePage, setParamValue };

package/dist/service/PortalService.js

@@ -0,0 +1,106 @@
+import { smartbi } from "../index.js";
+
+//#region src/service/PortalService.ts
+/**
+* 打开整个页面
+* @param pageId 页面ID
+* @returns 返回客户端ID
+*/
+const openEntirePage = (pageId) => {
+	return smartbi("PortalService", "openEntirePage", [pageId]);
+};
+/**
+* 执行页面中所有的查询
+* @param clientId 客户端ID
+* @param portletType 组件类型
+* @returns 无返回值
+*/
+const excuteAllQueryInPage = (clientId, portletType) => {
+	return smartbi("PortalService", "excuteAllQueryInPage", [clientId, portletType.toString()]);
+};
+/**
+* 关闭整个页面
+* @param clientId 客户端ID
+* @returns 无返回值
+*/
+const closeEntirePage = (clientId) => {
+	return smartbi("PortalService", "closeEntirePage", [clientId]);
+};
+/**
+* 导出页面
+* @param clientId 客户端ID
+* @param exportType 导出类型
+* @param pageWidth 页面大小
+* @param os 输出流
+* @param postData 可选参数 - 参数
+* @returns 无返回值
+*/
+const doExport = (clientId, exportType, pageWidth, os, postData) => {
+	if (postData !== void 0) return smartbi("PortalService", "doExport", [
+		clientId,
+		exportType,
+		pageWidth,
+		os,
+		postData
+	]);
+	else return smartbi("PortalService", "doExport", [
+		clientId,
+		exportType,
+		pageWidth,
+		os
+	]);
+};
+/**
+* 根据参数ID获取参数默认值
+* @param clientId 客户端ID
+* @param paramId 参数ID
+* @returns 返回参数默认值
+*/
+const getParamDefaultValue = (clientId, paramId) => {
+	return smartbi("PortalService", "getParamDefaultValue", [clientId, paramId]);
+};
+/**
+* 根据参数ID获取参数默认值列表
+* @param clientId 客户端ID
+* @param paramId 参数ID
+* @returns 返回参数默认值列表
+*/
+const getParamDefaultValues = (clientId, paramId) => {
+	return smartbi("PortalService", "getParamDefaultValues", [clientId, paramId]);
+};
+/**
+* 设置参数值
+* @param clientId 客户端ID
+* @param paramId 参数ID
+* @param paramValue 参数值
+* @param paramDisplayValue 参数显示值
+* @returns 无返回值
+*/
+const setParamValue = (clientId, paramId, paramValue, paramDisplayValue) => {
+	return smartbi("PortalService", "setParamValue", [
+		clientId,
+		paramId,
+		paramValue,
+		paramDisplayValue
+	]);
+};
+/**
+* 获取页面的参数列表
+* @param pageId 页面ID
+* @returns 返回参数列表
+*/
+const getParameters = (pageId) => {
+	return smartbi("PortalService", "getParameters", [pageId]);
+};
+/**
+* 获取参数备选值
+* @param clientId 客户端ID
+* @param paramId 参数ID
+* @returns 返回参数标准值
+*/
+const getParamStandbyValue = (clientId, paramId) => {
+	return smartbi("PortalService", "getParamStandbyValue", [clientId, paramId]);
+};
+
+//#endregion
+export { closeEntirePage, doExport, excuteAllQueryInPage, getParamDefaultValue, getParamDefaultValues, getParamStandbyValue, getParameters, openEntirePage, setParamValue };

package/dist/service/Report.d.ts

@@ -0,0 +1,182 @@
+import { B as RunningInfo, F as ReportData, I as ReportExportType, u as CustomFilterDataBean } from "../types-DOYMZhxT.js";
+
+//#region src/service/Report.d.ts
+/**
+ * 取得当前报表名
+ * @returns 当前报表名
+ */
+declare const getCurrentReportName: () => Promise<string>;
+/**
+ * 取得每页行数
+ * @returns 每页行数
+ */
+declare const getRowsPerPage: () => Promise<number>;
+/**
+ * 取得报表的参数信息
+ * @returns 参数列表
+ */
+declare const getReportParameters: () => Promise<any[]>;
+/**
+ * 取得报表的字段信息
+ * @returns 字段列表
+ */
+declare const getReportFields: () => Promise<any[]>;
+/**
+ * 打开一个报表
+ * @param reportId 报表ID
+ * @returns 无返回值
+ */
+declare const openReport: (reportId: string) => Promise<void>;
+/**
+ * 打开一个报表（不初始化）
+ * @param reportId 报表ID
+ * @returns 无返回值
+ */
+declare const openReportWithoutInit: (reportId: string) => Promise<void>;
+/**
+ * 执行报表
+ * @param rowsPerPage 指定每页行数
+ * @returns 报表总行数
+ */
+declare const executeReport: (rowsPerPage: number) => Promise<number>;
+/**
+ * 取得报表的指定页
+ * @param pageIndex 页码
+ * @returns 报表数据
+ */
+declare const getPage: (pageIndex: number) => Promise<ReportData>;
+/**
+ * 关闭报表
+ * @returns 无返回值
+ */
+declare const closeReport: () => Promise<void>;
+/**
+ * 设置参数值（仅值）
+ * @param paramId 参数ID
+ * @param paramValue 参数值
+ * @returns 无返回值
+ */
+declare const setReportParamValueOnly: (paramId: string, paramValue: string) => Promise<void>;
+/**
+ * 设置参数值
+ * @param paramId 参数ID
+ * @param paramValue 参数值
+ * @param displayValue 参数显示值
+ * @returns 无返回值
+ */
+declare const setReportParamValue: (paramId: string, paramValue: string, displayValue: string) => Promise<void>;
+/**
+ * 导出报表（基础版）
+ * @param type 指定导出类型 EXCEL, TXT, CSV
+ * @param delimiter 指定分割符（EXCEL类型不需要）
+ * @param maxRow 指定最大行数
+ * @param os 指定报表输出流
+ * @returns 无返回值
+ */
+declare const doExport: (type: ReportExportType | string, delimiter: string, maxRow: string, os: any) => Promise<void>;
+/**
+ * 导出报表（带资源路径）
+ * @param type 指定导出类型 EXCEL, TXT, CSV
+ * @param delimiter 指定分割符（EXCEL类型不需要）
+ * @param maxRow 指定最大行数
+ * @param os 指定报表输出流
+ * @param resourceBasePath 资源基础路径
+ * @returns 无返回值
+ */
+declare const doExportWithResourcePath: (type: ReportExportType | string, delimiter: string, maxRow: string, os: any, resourceBasePath: string) => Promise<void>;
+/**
+ * 导出报表（带值类型）
+ * @param type 指定导出类型 EXCEL, TXT, CSV
+ * @param delimiter 指定分割符（EXCEL类型不需要）
+ * @param maxRow 指定最大行数
+ * @param os 指定报表输出流
+ * @param resourceBasePath 资源基础路径
+ * @param valueType 值类型
+ * @returns 无返回值
+ */
+declare const doExportWithValueType: (type: ReportExportType | string, delimiter: string, maxRow: string, os: any, resourceBasePath: string, valueType: string) => Promise<void>;
+/**
+ * 导出报表（完整版）
+ * @param type 指定导出类型 EXCEL, TXT, CSV
+ * @param delimiter 指定分割符（EXCEL类型不需要）
+ * @param maxRow 指定最大行数
+ * @param os 指定报表输出流
+ * @param resourceBasePath 资源基础路径
+ * @param valueType 值类型
+ * @param postData 数据
+ * @returns 无返回值
+ */
+declare const doExportFull: (type: ReportExportType | string, delimiter: string, maxRow: string, os: any, resourceBasePath: string, valueType: string, postData: string) => Promise<void>;
+/**
+ * 指定某个字段的排序方式
+ * @param fieldId 字段ID
+ * @param orderType 排序方式 ASC, DESC, NONE
+ * @returns 无返回值
+ */
+declare const setReportOrderByType: (fieldId: string, orderType: string) => Promise<void>;
+/**
+ * 指定某个字段的聚合方式
+ * @param fieldId 字段ID
+ * @param aggregate 聚合方式
+ * @returns 无返回值
+ */
+declare const setReportFieldAggregate: (fieldId: string, aggregate: string) => Promise<void>;
+/**
+ * 指定报表过滤条件
+ * @param fieldId 字段ID
+ * @param operator 操作符
+ * @param value 值
+ * @returns 无返回值
+ */
+declare const setReportAutoCondition: (fieldId: string, operator: string, value: string) => Promise<void>;
+/**
+ * 设置自定义过滤条件
+ * @param filterData 过滤条件数据
+ * @returns 是否设置成功
+ */
+declare const setReportCustomCondition: (filterData: CustomFilterDataBean) => Promise<boolean>;
+/**
+ * 读取报表数据
+ * @param reportId 报表ID
+ * @returns 无返回值
+ */
+declare const dumpReport: (reportId: string) => Promise<void>;
+/**
+ * 修改报表
+ * @returns 无返回值
+ */
+declare const updateReportQuery: () => Promise<void>;
+/**
+ * 获得某个参数的候选值列表
+ * @param paramId 参数ID
+ * @returns 参数的候选值列表
+ */
+declare const getReportParamStandbyValue: (paramId: string) => Promise<any[]>;
+/**
+ * 获取执行状态
+ * @returns 执行状态
+ */
+declare const getReportExecutingState: () => Promise<RunningInfo>;
+/**
+ * 把报表查询结果复制在另一张新的报表中
+ * @param reportId 报表ID
+ * @param parentNodeId 父节点ID
+ * @param name 名称
+ * @param alias 别名
+ * @param desc 描述
+ * @returns 新的报表ID
+ */
+declare const cloneReportQuery: (reportId: string, parentNodeId: string, name: string, alias: string, desc: string) => Promise<string>;
+/**
+ * 获取客户端配置
+ * @returns 客户端配置
+ */
+declare const getReportClientConfig: () => Promise<string>;
+/**
+ * 设置客户端配置
+ * @param clientConfig 客户端配置
+ * @returns 无返回值
+ */
+declare const setReportClientConfig: (clientConfig: string) => Promise<void>;
+//#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 };