smartbi-toolkit 1.0.1 → 1.1.0

package/dist/methods/OltpMetadataService.d.ts

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

package/dist/methods/OltpMetadataService.js

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

package/dist/methods/ParameterService.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 根据参数ID获取参数默认值SQL语句
+ * @param paramId 参数ID
+ * @returns 返回SQL语句
+ */
+export declare const getParameterDefaultSQLById: (paramId: string) => Promise<string>;
+/**
+ * 根据参数ID获取参数备选值SQL语句
+ * @param paramId 参数ID
+ * @returns 返回SQL语句
+ */
+export declare const getParameterStandbySQLById: (paramId: string) => Promise<string>;

package/dist/methods/ParameterService.js

@@ -0,0 +1,18 @@
+// 定义SmartBI参数服务相关的类型接口
+import { smartbi } from "../index";
+/**
+ * 根据参数ID获取参数默认值SQL语句
+ * @param paramId 参数ID
+ * @returns 返回SQL语句
+ */
+export const getParameterDefaultSQLById = (paramId) => {
+    return smartbi('ParameterService', 'getParameterDefaultSQLById', [paramId]);
+};
+/**
+ * 根据参数ID获取参数备选值SQL语句
+ * @param paramId 参数ID
+ * @returns 返回SQL语句
+ */
+export const getParameterStandbySQLById = (paramId) => {
+    return smartbi('ParameterService', 'getParameterStandbySQLById', [paramId]);
+};

package/dist/methods/PoolService.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 清除所有连接池
+ * @returns 无返回值
+ */
+export declare const clearAllPools: () => Promise<void>;
+/**
+ * 根据连接池名称清除连接池
+ * @param poolName 连接池名称
+ * @returns 无返回值
+ */
+export declare const clearPoolByName: (poolName: string) => Promise<void>;

package/dist/methods/PoolService.js

@@ -0,0 +1,17 @@
+// 定义SmartBI连接池服务相关的类型接口
+import { smartbi } from "../index";
+/**
+ * 清除所有连接池
+ * @returns 无返回值
+ */
+export const clearAllPools = () => {
+    return smartbi('PoolService', 'clearAllPools', []);
+};
+/**
+ * 根据连接池名称清除连接池
+ * @param poolName 连接池名称
+ * @returns 无返回值
+ */
+export const clearPoolByName = (poolName) => {
+    return smartbi('PoolService', 'clearPoolByName', [poolName]);
+};

package/dist/methods/PortalService.d.ts

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

package/dist/methods/PortalService.js

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

package/dist/methods/Report.d.ts

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

package/dist/methods/Report.js

@@ -0,0 +1,230 @@
+import { smartbi } from "../index";
+/**
+ * 取得当前报表名
+ * @returns 当前报表名
+ */
+export const getCurrentReportName = () => {
+    return smartbi('Report', 'getCurrentReportName', []);
+};
+/**
+ * 取得每页行数
+ * @returns 每页行数
+ */
+export const getRowsPerPage = () => {
+    return smartbi('Report', 'getRowsPerPage', []);
+};
+/**
+ * 取得报表的参数信息
+ * @returns 参数列表
+ */
+export const getReportParameters = () => {
+    return smartbi('Report', 'getParameters', []);
+};
+/**
+ * 取得报表的字段信息
+ * @returns 字段列表
+ */
+export const getReportFields = () => {
+    return smartbi('Report', 'getFields', []);
+};
+/**
+ * 打开一个报表
+ * @param reportId 报表ID
+ * @returns 无返回值
+ */
+export const openReport = (reportId) => {
+    return smartbi('Report', 'open', [reportId]);
+};
+/**
+ * 打开一个报表（不初始化）
+ * @param reportId 报表ID
+ * @returns 无返回值
+ */
+export const openReportWithoutInit = (reportId) => {
+    return smartbi('Report', 'openWithoutInit', [reportId]);
+};
+/**
+ * 执行报表
+ * @param rowsPerPage 指定每页行数
+ * @returns 报表总行数
+ */
+export const executeReport = (rowsPerPage) => {
+    return smartbi('Report', 'execute', [rowsPerPage]);
+};
+/**
+ * 取得报表的指定页
+ * @param pageIndex 页码
+ * @returns 报表数据
+ */
+export const getPage = (pageIndex) => {
+    return smartbi('Report', 'getPage', [pageIndex]);
+};
+/**
+ * 关闭报表
+ * @returns 无返回值
+ */
+export const closeReport = () => {
+    return smartbi('Report', 'close', []);
+};
+/**
+ * 设置参数值（仅值）
+ * @param paramId 参数ID
+ * @param paramValue 参数值
+ * @returns 无返回值
+ */
+export const setReportParamValueOnly = (paramId, paramValue) => {
+    return smartbi('Report', 'setParamValue', [paramId, paramValue]);
+};
+/**
+ * 设置参数值
+ * @param paramId 参数ID
+ * @param paramValue 参数值
+ * @param displayValue 参数显示值
+ * @returns 无返回值
+ */
+export 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 无返回值
+ */
+export 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 无返回值
+ */
+export 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 无返回值
+ */
+export 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 无返回值
+ */
+export 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 无返回值
+ */
+export const setReportOrderByType = (fieldId, orderType) => {
+    return smartbi('Report', 'setOrderByType', [fieldId, orderType]);
+};
+/**
+ * 指定某个字段的聚合方式
+ * @param fieldId 字段ID
+ * @param aggregate 聚合方式
+ * @returns 无返回值
+ */
+export const setReportFieldAggregate = (fieldId, aggregate) => {
+    return smartbi('Report', 'setFieldAggregate', [fieldId, aggregate]);
+};
+/**
+ * 指定报表过滤条件
+ * @param fieldId 字段ID
+ * @param operator 操作符
+ * @param value 值
+ * @returns 无返回值
+ */
+export const setReportAutoCondition = (fieldId, operator, value) => {
+    return smartbi('Report', 'setAutoCondition', [fieldId, operator, value]);
+};
+/**
+ * 设置自定义过滤条件
+ * @param filterData 过滤条件数据
+ * @returns 是否设置成功
+ */
+export const setReportCustomCondition = (filterData) => {
+    return smartbi('Report', 'setCustomCondition', [filterData.toString()]);
+};
+/**
+ * 读取报表数据
+ * @param reportId 报表ID
+ * @returns 无返回值
+ */
+export const dumpReport = (reportId) => {
+    return smartbi('Report', 'dump', [reportId]);
+};
+/**
+ * 修改报表
+ * @returns 无返回值
+ */
+export const updateReportQuery = () => {
+    return smartbi('Report', 'updateQuery', []);
+};
+/**
+ * 获得某个参数的候选值列表
+ * @param paramId 参数ID
+ * @returns 参数的候选值列表
+ */
+export const getReportParamStandbyValue = (paramId) => {
+    return smartbi('Report', 'getParamStandbyValue', [paramId]);
+};
+/**
+ * 获取执行状态
+ * @returns 执行状态
+ */
+export const getReportExecutingState = () => {
+    return smartbi('Report', 'getExecutingState', []);
+};
+/**
+ * 把报表查询结果复制在另一张新的报表中
+ * @param reportId 报表ID
+ * @param parentNodeId 父节点ID
+ * @param name 名称
+ * @param alias 别名
+ * @param desc 描述
+ * @returns 新的报表ID
+ */
+export const cloneReportQuery = (reportId, parentNodeId, name, alias, desc) => {
+    return smartbi('Report', 'cloneQuery', [reportId, parentNodeId, name, alias, desc]);
+};
+/**
+ * 获取客户端配置
+ * @returns 客户端配置
+ */
+export const getReportClientConfig = () => {
+    return smartbi('Report', 'getClientConfig', []);
+};
+/**
+ * 设置客户端配置
+ * @param clientConfig 客户端配置
+ * @returns 无返回值
+ */
+export const setReportClientConfig = (clientConfig) => {
+    return smartbi('Report', 'setClientConfig', [clientConfig]);
+};