smartbi-toolkit 1.0.1 → 1.1.0

package/dist/methods/ClientReportService.d.ts

@@ -0,0 +1,162 @@
+import type { AggregateType, ClientReportView, CustomFilterDataBean, OperatorType, OrderType, ReportData } from '../types';
+/**
+ * 打开一个报表
+ * @param queryId 报表ID
+ * @returns 返回打开的报表视图
+ */
+export declare const openQuery: (queryId: string) => Promise<ClientReportView>;
+/**
+ * 打开一个报表（不初始化）
+ * @param queryId 报表ID
+ * @returns 返回打开的报表视图
+ */
+export declare const openQueryWithoutInit: (queryId: string) => Promise<ClientReportView>;
+/**
+ * 取得一个表达式的值
+ * @param clientId 客户ID
+ * @param func 表达式
+ * @returns 表达式的值
+ */
+export declare const getFunctionValue: (clientId: string, func: string) => Promise<string>;
+/**
+ * 设置每页的行数
+ * @param clientId 客户ID
+ * @param rowsPerPage 每页行数
+ * @returns 无返回值
+ */
+export declare const setRowsPerPage: (clientId: string, rowsPerPage: number) => Promise<void>;
+/**
+ * 获取每页的行数
+ * @param clientId 客户ID
+ * @returns 每页行数
+ */
+export declare const getRowsPerPage: (clientId: string) => Promise<number>;
+/**
+ * 执行报表（新接口）
+ * @param clientId 客户ID
+ * @returns 报表的总行数
+ */
+export declare const executeQueryLong: (clientId: string) => Promise<number>;
+/**
+ * 获得报表数据
+ * @param clientId 客户ID
+ * @param pageNum 报表页码，指定获取报表的第几页，从0算起
+ * @returns 报表数据
+ */
+export declare const getReportData: (clientId: string, pageNum: number) => Promise<ReportData>;
+/**
+ * 获得原始报表数据
+ * @param clientId 客户ID
+ * @param pageNum 报表页码，指定获取报表的第几页，从0算起
+ * @returns 原始报表数据
+ */
+export declare const getRawReportData: (clientId: string, pageNum: number) => Promise<ReportData>;
+/**
+ * 将报表信息从服务端的会话状态中清除
+ * @param clientId 客户ID
+ * @returns 无返回值
+ */
+export declare const removeFromSession: (clientId: string) => Promise<void>;
+/**
+ * 设置参数值
+ * @param clientId 客户ID
+ * @param paramId 参数ID
+ * @param paramValue 参数值
+ * @param paramDisplayValue 参数显示值
+ * @returns 是否设置成功
+ */
+export declare const setParamValue: (clientId: string, paramId: string, paramValue: string, paramDisplayValue: string) => Promise<boolean>;
+/**
+ * 设置参数值（按名称）
+ * @param clientId 客户ID
+ * @param paramId 参数ID
+ * @param paramValue 参数值
+ * @param paramDisplayValue 参数显示值
+ * @returns 是否设置成功
+ */
+export declare const setParamValueByName: (clientId: string, paramId: string, paramValue: string, paramDisplayValue: string) => Promise<boolean>;
+/**
+ * 获得某个参数的默认值
+ * @param clientId 客户ID
+ * @param paramId 参数ID
+ * @returns 参数的默认值列表
+ */
+export declare const getParamDefaultValue: (clientId: string, paramId: string) => Promise<string[]>;
+/**
+ * 获得某个参数的候选值列表
+ * @param clientId 客户ID
+ * @param paramId 参数ID
+ * @returns 参数的候选值列表
+ */
+export declare const getParamStandbyValue: (clientId: string, paramId: string) => Promise<string[]>;
+/**
+ * 设置报表的排序字段
+ * @param clientId 客户ID
+ * @param fieldId 字段ID
+ * @param orderType 排序方式, ASC, DESC, NONE
+ * @returns 是否设置成功
+ */
+export declare const setOrderByType: (clientId: string, fieldId: string, orderType: OrderType | string) => Promise<boolean>;
+/**
+ * 设置字段聚合方式
+ * @param clientId 客户ID
+ * @param fieldId 字段ID
+ * @param aggregate 聚合方式 SUM, MIN, MAX, COUNT, DISTINCT_COUNT, AVG, NULL
+ * @returns 是否设置成功
+ */
+export declare const setFieldAggregate: (clientId: string, fieldId: string, aggregate: AggregateType | string) => Promise<boolean>;
+/**
+ * 获取报表中某字段的所有可能值
+ * @param clientId 客户ID
+ * @param fieldId 字段ID
+ * @returns 字段的所有可能值列表
+ */
+export declare const getFieldDistinctValues: (clientId: string, fieldId: string) => Promise<string[]>;
+/**
+ * 设置过滤条件
+ * @param clientId 客户ID
+ * @param fieldId 字段ID
+ * @param operator 操作符
+ * @param value 值
+ * @returns 是否设置成功
+ */
+export declare const setAutoCondition: (clientId: string, fieldId: string, operator: OperatorType | string, value: string) => Promise<boolean>;
+/**
+ * 设置自定义过滤条件
+ * @param clientId 客户ID
+ * @param filterData 过滤条件数据
+ * @returns 是否设置成功
+ */
+export declare const setCustomCondition: (clientId: string, filterData: CustomFilterDataBean) => Promise<boolean>;
+/**
+ * 设置客户端配置
+ * @param clientId 客户ID
+ * @param clientConfig 客户端配置
+ * @returns 无返回值
+ */
+export declare const setClientConfig: (clientId: string, clientConfig: string) => Promise<void>;
+/**
+ * 克隆查询
+ * @param clientId 客户ID
+ * @param parentNodeId 父节点ID
+ * * @param name 名称
+ * @param alias 别名
+ * @param desc 描述
+ * @returns 新克隆的查询ID
+ */
+export declare const cloneQuery: (clientId: string, parentNodeId: string, name: string, alias: string, desc: string) => Promise<string>;
+/**
+ * 覆盖查询
+ * @param clientId 客户ID
+ * @param replacedReportId 被替换的报表ID
+ * @param desc 描述
+ * @returns 是否覆盖成功
+ */
+export declare const overwriteQuery: (clientId: string, replacedReportId: string, desc: string) => Promise<boolean>;
+/**
+ * 导出报表
+ * @param clientId 客户ID
+ * @param reportId 报表ID
+ * @returns 无返回值
+ */
+export declare const dump: (clientId: string, reportId: string) => Promise<void>;

package/dist/methods/ClientReportService.js

@@ -0,0 +1,206 @@
+import { smartbi } from "../index";
+/**
+ * 打开一个报表
+ * @param queryId 报表ID
+ * @returns 返回打开的报表视图
+ */
+export const openQuery = (queryId) => {
+    return smartbi('ClientReportService', 'openQuery', [queryId]);
+};
+/**
+ * 打开一个报表（不初始化）
+ * @param queryId 报表ID
+ * @returns 返回打开的报表视图
+ */
+export const openQueryWithoutInit = (queryId) => {
+    return smartbi('ClientReportService', 'openQueryWithoutInit', [queryId]);
+};
+/**
+ * 取得一个表达式的值
+ * @param clientId 客户ID
+ * @param func 表达式
+ * @returns 表达式的值
+ */
+export const getFunctionValue = (clientId, func) => {
+    return smartbi('ClientReportService', 'getFunctionValue', [clientId, func]);
+};
+/**
+ * 设置每页的行数
+ * @param clientId 客户ID
+ * @param rowsPerPage 每页行数
+ * @returns 无返回值
+ */
+export const setRowsPerPage = (clientId, rowsPerPage) => {
+    return smartbi('ClientReportService', 'setRowsPerPage', [clientId, rowsPerPage]);
+};
+/**
+ * 获取每页的行数
+ * @param clientId 客户ID
+ * @returns 每页行数
+ */
+export const getRowsPerPage = (clientId) => {
+    return smartbi('ClientReportService', 'getRowsPerPage', [clientId]);
+};
+/**
+ * 执行报表（新接口）
+ * @param clientId 客户ID
+ * @returns 报表的总行数
+ */
+export const executeQueryLong = (clientId) => {
+    return smartbi('ClientReportService', 'executeQueryLong', [clientId]);
+};
+/**
+ * 获得报表数据
+ * @param clientId 客户ID
+ * @param pageNum 报表页码，指定获取报表的第几页，从0算起
+ * @returns 报表数据
+ */
+export const getReportData = (clientId, pageNum) => {
+    return smartbi('ClientReportService', 'getReportData', [clientId, pageNum]);
+};
+/**
+ * 获得原始报表数据
+ * @param clientId 客户ID
+ * @param pageNum 报表页码，指定获取报表的第几页，从0算起
+ * @returns 原始报表数据
+ */
+export const getRawReportData = (clientId, pageNum) => {
+    return smartbi('ClientReportService', 'getRawReportData', [clientId, pageNum]);
+};
+/**
+ * 将报表信息从服务端的会话状态中清除
+ * @param clientId 客户ID
+ * @returns 无返回值
+ */
+export const removeFromSession = (clientId) => {
+    return smartbi('ClientReportService', 'removeFromSession', [clientId]);
+};
+/**
+ * 设置参数值
+ * @param clientId 客户ID
+ * @param paramId 参数ID
+ * @param paramValue 参数值
+ * @param paramDisplayValue 参数显示值
+ * @returns 是否设置成功
+ */
+export const setParamValue = (clientId, paramId, paramValue, paramDisplayValue) => {
+    return smartbi('ClientReportService', 'setParamValue', [clientId, paramId, paramValue, paramDisplayValue]);
+};
+/**
+ * 设置参数值（按名称）
+ * @param clientId 客户ID
+ * @param paramId 参数ID
+ * @param paramValue 参数值
+ * @param paramDisplayValue 参数显示值
+ * @returns 是否设置成功
+ */
+export const setParamValueByName = (clientId, paramId, paramValue, paramDisplayValue) => {
+    return smartbi('ClientReportService', 'setParamValueByName', [clientId, paramId, paramValue, paramDisplayValue]);
+};
+/**
+ * 获得某个参数的默认值
+ * @param clientId 客户ID
+ * @param paramId 参数ID
+ * @returns 参数的默认值列表
+ */
+export const getParamDefaultValue = (clientId, paramId) => {
+    return smartbi('ClientReportService', 'getParamDefaultValue', [clientId, paramId]);
+};
+/**
+ * 获得某个参数的候选值列表
+ * @param clientId 客户ID
+ * @param paramId 参数ID
+ * @returns 参数的候选值列表
+ */
+export const getParamStandbyValue = (clientId, paramId) => {
+    return smartbi('ClientReportService', 'getParamStandbyValue', [clientId, paramId]);
+};
+/**
+ * 设置报表的排序字段
+ * @param clientId 客户ID
+ * @param fieldId 字段ID
+ * @param orderType 排序方式, ASC, DESC, NONE
+ * @returns 是否设置成功
+ */
+export const setOrderByType = (clientId, fieldId, orderType) => {
+    return smartbi('ClientReportService', 'setOrderByType', [clientId, fieldId, orderType]);
+};
+/**
+ * 设置字段聚合方式
+ * @param clientId 客户ID
+ * @param fieldId 字段ID
+ * @param aggregate 聚合方式 SUM, MIN, MAX, COUNT, DISTINCT_COUNT, AVG, NULL
+ * @returns 是否设置成功
+ */
+export const setFieldAggregate = (clientId, fieldId, aggregate) => {
+    return smartbi('ClientReportService', 'setFieldAggregate', [clientId, fieldId, aggregate]);
+};
+/**
+ * 获取报表中某字段的所有可能值
+ * @param clientId 客户ID
+ * @param fieldId 字段ID
+ * @returns 字段的所有可能值列表
+ */
+export const getFieldDistinctValues = (clientId, fieldId) => {
+    return smartbi('ClientReportService', 'getFieldDistinctValues', [clientId, fieldId]);
+};
+/**
+ * 设置过滤条件
+ * @param clientId 客户ID
+ * @param fieldId 字段ID
+ * @param operator 操作符
+ * @param value 值
+ * @returns 是否设置成功
+ */
+export const setAutoCondition = (clientId, fieldId, operator, value) => {
+    return smartbi('ClientReportService', 'setAutoCondition', [clientId, fieldId, operator, value]);
+};
+/**
+ * 设置自定义过滤条件
+ * @param clientId 客户ID
+ * @param filterData 过滤条件数据
+ * @returns 是否设置成功
+ */
+export const setCustomCondition = (clientId, filterData) => {
+    return smartbi('ClientReportService', 'setCustomCondition', [clientId, filterData.toString()]);
+};
+/**
+ * 设置客户端配置
+ * @param clientId 客户ID
+ * @param clientConfig 客户端配置
+ * @returns 无返回值
+ */
+export const setClientConfig = (clientId, clientConfig) => {
+    return smartbi('ClientReportService', 'setClientConfig', [clientId, clientConfig]);
+};
+/**
+ * 克隆查询
+ * @param clientId 客户ID
+ * @param parentNodeId 父节点ID
+ * * @param name 名称
+ * @param alias 别名
+ * @param desc 描述
+ * @returns 新克隆的查询ID
+ */
+export const cloneQuery = (clientId, parentNodeId, name, alias, desc) => {
+    return smartbi('ClientReportService', 'cloneQuery', [clientId, parentNodeId, name, alias, desc]);
+};
+/**
+ * 覆盖查询
+ * @param clientId 客户ID
+ * @param replacedReportId 被替换的报表ID
+ * @param desc 描述
+ * @returns 是否覆盖成功
+ */
+export const overwriteQuery = (clientId, replacedReportId, desc) => {
+    return smartbi('ClientReportService', 'overwriteQuery', [clientId, replacedReportId, desc]);
+};
+/**
+ * 导出报表
+ * @param clientId 客户ID
+ * @param reportId 报表ID
+ * @returns 无返回值
+ */
+export const dump = (clientId, reportId) => {
+    return smartbi('ClientReportService', 'dump', [clientId, reportId]);
+};

package/dist/methods/CombinedReportService.d.ts

@@ -0,0 +1,7 @@
+import type { ICombinedReport } from '../types';
+/**
+ * 创建并打开一个报表
+ * @param reportId 报表ID
+ * @returns 返回打开的报表对象，类型为ICombinedReport
+ */
+export declare const openReport: (reportId: string) => Promise<ICombinedReport>;

package/dist/methods/CombinedReportService.js

@@ -0,0 +1,10 @@
+// CombinedReportService 服务方法
+import { smartbi } from "../index";
+/**
+ * 创建并打开一个报表
+ * @param reportId 报表ID
+ * @returns 返回打开的报表对象，类型为ICombinedReport
+ */
+export const openReport = (reportId) => {
+    return smartbi('CombinedReportService', 'openReport', [reportId]);
+};

package/dist/methods/DataSourceService.d.ts

@@ -0,0 +1,178 @@
+import type { BasicField, DataSource, DriverType, JDBCTable, SDKGridData } from '../types';
+/**
+ * 创建数据源
+ * @param name 数据源名称
+ * @param connectUserName 连接用户名
+ * @param connectPassword 连接密码
+ * @param maxConnection 最大连接数
+ * @param driverType 数据库类型
+ * @param driverClassName 驱动程序类名
+ * @param url 连接字符串
+ * @returns 返回数据源ID
+ */
+export declare const createDataSource: (name: string, connectUserName: string, connectPassword: string, maxConnection: number, driverType: DriverType | string, driverClassName: string, url: string) => Promise<string>;
+/**
+ * 创建数据源（带目录参数）
+ * @param name 数据源名称
+ * @param connectUserName 连接用户名
+ * @param connectPassword 连接密码
+ * @param maxConnection 最大连接数
+ * @param driverType 数据库类型
+ * @param driverClassName 驱动程序类名
+ * @param url 连接字符串
+ * @param driverCatalog 驱动目录
+ * @returns 返回数据源ID
+ */
+export declare const createDataSourceWithCatalog: (name: string, connectUserName: string, connectPassword: string, maxConnection: number, driverType: DriverType | string, driverClassName: string, url: string, driverCatalog: string) => Promise<string>;
+/**
+ * 创建数据源（带事务隔离级别）
+ * @param name 数据源名称
+ * @param connectUserName 连接用户名
+ * @param connectPassword 连接密码
+ * @param maxConnection 最大连接数
+ * @param driverType 数据库类型
+ * @param driverClassName 驱动程序类名
+ * @param url 连接字符串
+ * @param driverCatalog 驱动目录
+ * @param transactionIsolation 事务隔离级别
+ * @returns 返回数据源ID
+ */
+export declare const createDataSourceWithTransactionIsolation: (name: string, connectUserName: string, connectPassword: string, maxConnection: number, driverType: DriverType | string, driverClassName: string, url: string, driverCatalog: string, transactionIsolation: number) => Promise<string>;
+/**
+ * 修改数据源
+ * @param id 数据源ID
+ * @param connectUserName 连接用户名
+ * @param connectPassword 连接密码
+ * @param maxConnection 最大连接数
+ * @param driverType 数据库类型
+ * @param driverClassName 驱动程序类名
+ * @param url 连接字符串
+ */
+export declare const updateDataSource: (id: string, connectUserName: string, connectPassword: string, maxConnection: number, driverType: DriverType | string, driverClassName: string, url: string) => Promise<void>;
+/**
+ * 修改数据源（带目录参数）
+ * @param id 数据源ID
+ * @param connectUserName 连接用户名
+ * @param connectPassword 连接密码
+ * @param maxConnection 最大连接数
+ * @param driverType 数据库类型
+ * @param driverClassName 驱动程序类名
+ * @param url 连接字符串
+ * @param driverCatalog 驱动目录
+ */
+export declare const updateDataSourceWithCatalog: (id: string, connectUserName: string, connectPassword: string, maxConnection: number, driverType: DriverType | string, driverClassName: string, url: string, driverCatalog: string) => Promise<void>;
+/**
+ * 修改数据源（带事务隔离级别）
+ * @param id 数据源ID
+ * @param connectUserName 连接用户名
+ * @param connectPassword 连接密码
+ * @param maxConnection 最大连接数
+ * @param driverType 数据库类型
+ * @param driverClassName 驱动程序类名
+ * @param url 连接字符串
+ * @param driverCatalog 驱动目录
+ * @param transactionIsolation 事务隔离级别
+ */
+export declare const updateDataSourceWithTransactionIsolation: (id: string, connectUserName: string, connectPassword: string, maxConnection: number, driverType: DriverType | string, driverClassName: string, url: string, driverCatalog: string, transactionIsolation: number) => Promise<void>;
+/**
+ * 删除数据源
+ * @param dataSourceID 数据源ID
+ */
+export declare const deleteDataSource: (dataSourceID: string) => Promise<void>;
+/**
+ * 获取数据源
+ * @param dataSourceID 数据源ID
+ * @returns 返回数据源对象
+ */
+export declare const getDataSource: (dataSourceID: string) => Promise<DataSource>;
+/**
+ * 给数据源添加表
+ * @param dataSourceId 数据源ID
+ * @param tableList 表列表
+ */
+export declare const addTablesToDataSource: (dataSourceId: string, tableList: JDBCTable[]) => Promise<void>;
+/**
+ * 删除数据源的表、视图、存储过程
+ * @param dataSourceId 数据源ID
+ * @param schemaName 模式名称
+ * @param tableNameList 表名列表
+ */
+export declare const removeTablesFromDataSource: (dataSourceId: string, schemaName: string, tableNameList: string[]) => Promise<void>;
+/**
+ * 删除数据库表
+ * @param dsId 数据源ID
+ * @param schemaName 模式名称
+ * @param tableNameList 表名列表
+ */
+export declare const removeTables: (dsId: string, schemaName: string, tableNameList: string[]) => Promise<void>;
+/**
+ * 同步schema表
+ * @param dataSourceID 数据源ID
+ * @param schema 模式名称
+ */
+export declare const synchTablesToDataSource: (dataSourceID: string, schema: string) => Promise<void>;
+/**
+ * 同步catalog下面schema表
+ * @param dataSourceID 数据源ID
+ * @param catalog 目录名称
+ * @param schema 模式名称
+ */
+export declare const synchTablesToDataSourceWithCatalog: (dataSourceID: string, catalog: string, schema: string) => Promise<void>;
+/**
+ * 同步表
+ * @param tableId 表ID
+ */
+export declare const syncTable: (tableId: string) => Promise<void>;
+/**
+ * 修改表属性
+ * @param tableId 表ID
+ * @param tableAlias 表别名
+ * @param fieldList 字段列表
+ */
+export declare const updateTablePropertys: (tableId: string, tableAlias: string, fieldList: BasicField[]) => Promise<void>;
+/**
+ * 获取表字段
+ * @param tabelId 表ID
+ * @returns 返回字段列表
+ */
+export declare const getFields: (tabelId: string) => Promise<BasicField[]>;
+/**
+ * 获取"数据源"节点下某张表的数据
+ * @param tableId 表ID
+ * @param maxRows 最大行数
+ * @returns 返回表数据
+ */
+export declare const getSampleTableData: (tableId: string, maxRows: number) => Promise<SDKGridData>;
+/**
+ * 执行指定SQL语句，返回相应结果集
+ * @param dataSourceID 数据源ID
+ * @param sql SQL语句
+ * @param maxRows 最大行数
+ * @param format 是否格式化
+ * @param cacheable 是否缓存
+ * @returns 返回结果集数据
+ */
+export declare const execute: (dataSourceID: string, sql: string, maxRows: number, format: boolean, cacheable: boolean) => Promise<SDKGridData>;
+/**
+ * 直接执行指定SQL语句，返回相应结果集，不从缓存中返回结果集
+ * @param dataSourceID 数据源ID
+ * @param sql SQL语句
+ * @returns 返回结果集数据
+ */
+export declare const executeNoCacheable: (dataSourceID: string, sql: string) => Promise<SDKGridData>;
+/**
+ * 直接执行SQL语句，可以是INSERT, UPDATE, DELETE语句，也可以是SQL DDL语句
+ * @param dataSourceID 数据源ID
+ * @param sql SQL语句
+ * @returns 返回影响的行数
+ */
+export declare const executeUpdate: (dataSourceID: string, sql: string) => Promise<number>;
+/**
+ * 获取未格式化的原始的结果集数据
+ * @param dsId 数据源ID
+ * @param sql SQL语句
+ * @param pageNum 页码
+ * @param rowPerPage 每页行数
+ * @returns 返回结果集数据
+ */
+export declare const getDataByQuerySql: (dsId: string, sql: string, pageNum: number, rowPerPage: number) => Promise<SDKGridData>;