smartbi-toolkit 1.1.3 → 1.2.0

package/dist/service/DataSourceService.js

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

package/dist/service/GraphicReportService.d.ts

@@ -0,0 +1,11 @@
+import { _ as GraphicReport } from "../types-DOYMZhxT.js";
+
+//#region src/service/GraphicReportService.d.ts
+/**
+ * 打开图形分析报表
+ * @param reportId 报表ID
+ * @returns 返回报表客户端ID
+ */
+declare const openGraphicReport: (reportId: string) => Promise<GraphicReport>;
+//#endregion
+export { openGraphicReport };

package/dist/service/GraphicReportService.js

@@ -0,0 +1,14 @@
+import { smartbi } from "../index.js";
+
+//#region src/service/GraphicReportService.ts
+/**
+* 打开图形分析报表
+* @param reportId 报表ID
+* @returns 返回报表客户端ID
+*/
+const openGraphicReport = (reportId) => {
+	return smartbi("GraphicReportService", "openGraphicReport", [reportId]);
+};
+
+//#endregion
+export { openGraphicReport };

package/dist/service/InsightReport.d.ts

@@ -0,0 +1,75 @@
+import { B as RunningInfo, D as NameValuePair, E as JSONArray, F as ReportData, j as Parameter } from "../types-DOYMZhxT.js";
+
+//#region src/service/InsightReport.d.ts
+/**
+ * 打开透视分析
+ * @param reportId 报表Id
+ * @returns 无返回值
+ */
+declare const open: (reportId: string) => Promise<void>;
+/**
+ * 获取参数列表
+ * @returns 返回参数列表
+ */
+declare const getParamList: () => Promise<Parameter[]>;
+/**
+ * 获取参数备选值
+ * @param paramId 参数Id
+ * @returns 返回备选值列表
+ */
+declare const getParamStandbyValue: (paramId: string) => Promise<NameValuePair[]>;
+/**
+ * 根据参数Id获取参数默认值
+ * @param pid 参数Id
+ * @returns 返回默认值字符串
+ */
+declare const getParamDefaultValueByPID: (pid: string) => Promise<string>;
+/**
+ * 根据参数Id获取参数默认值
+ * @param pid 参数Id
+ * @returns 返回默认值JSONArray
+ */
+declare const getParamDefaultValueByPID2: (pid: string) => Promise<JSONArray>;
+/**
+ * 导出
+ * @param type 导出类型
+ * @param delimiter 分隔符
+ * @param maxRow 最大行数
+ * @param resourceBasePath 资源基础路径
+ * @param valueType 值类型
+ * @param contentType 内容类型
+ * @param paramArr 可选参数数组
+ * @returns 无返回值
+ */
+declare const doExport: (type: string, delimiter: string, maxRow: string, resourceBasePath: string, valueType: string, contentType: string, paramArr?: JSONArray) => Promise<void>;
+/**
+ * 设置参数值
+ * @param id 参数Id
+ * @param value 参数真实值
+ * @param displayValue 参数显示值
+ * @returns 无返回值
+ */
+declare const setParamValue: (id: string, value: string, displayValue: string) => Promise<void>;
+/**
+ * 刷新对象
+ * @returns 无返回值
+ */
+declare const refreshObject: () => Promise<void>;
+/**
+ * 关闭透视分析
+ * @returns 无返回值
+ */
+declare const close: () => Promise<void>;
+/**
+ * 获取执行状态
+ * @returns 返回执行状态信息
+ */
+declare const getExecutingState: () => Promise<RunningInfo>;
+/**
+ * 取得报表的指定页
+ * @param pageIndex 页码
+ * @returns 返回报表数据
+ */
+declare const getPage: (pageIndex: number) => Promise<ReportData>;
+//#endregion
+export { close, doExport, getExecutingState, getPage, getParamDefaultValueByPID, getParamDefaultValueByPID2, getParamList, getParamStandbyValue, open, refreshObject, setParamValue };

package/dist/service/InsightReport.js

@@ -0,0 +1,118 @@
+import { smartbi } from "../index.js";
+
+//#region src/service/InsightReport.ts
+/**
+* 打开透视分析
+* @param reportId 报表Id
+* @returns 无返回值
+*/
+const open = (reportId) => {
+	return smartbi("InsightReport", "open", [reportId]);
+};
+/**
+* 获取参数列表
+* @returns 返回参数列表
+*/
+const getParamList = () => {
+	return smartbi("InsightReport", "getParamList", []);
+};
+/**
+* 获取参数备选值
+* @param paramId 参数Id
+* @returns 返回备选值列表
+*/
+const getParamStandbyValue = (paramId) => {
+	return smartbi("InsightReport", "getParamStandbyValue", [paramId]);
+};
+/**
+* 根据参数Id获取参数默认值
+* @param pid 参数Id
+* @returns 返回默认值字符串
+*/
+const getParamDefaultValueByPID = (pid) => {
+	return smartbi("InsightReport", "getParamDefaultValueByPID", [pid]);
+};
+/**
+* 根据参数Id获取参数默认值
+* @param pid 参数Id
+* @returns 返回默认值JSONArray
+*/
+const getParamDefaultValueByPID2 = (pid) => {
+	return smartbi("InsightReport", "getParamDefaultValueByPID2", [pid]);
+};
+/**
+* 导出
+* @param type 导出类型
+* @param delimiter 分隔符
+* @param maxRow 最大行数
+* @param resourceBasePath 资源基础路径
+* @param valueType 值类型
+* @param contentType 内容类型
+* @param paramArr 可选参数数组
+* @returns 无返回值
+*/
+const doExport = (type, delimiter, maxRow, resourceBasePath, valueType, contentType, paramArr) => {
+	if (paramArr !== void 0) return smartbi("InsightReport", "doExportWithParams", [
+		type,
+		delimiter,
+		maxRow,
+		resourceBasePath,
+		valueType,
+		contentType,
+		paramArr.toString()
+	]);
+	else return smartbi("InsightReport", "doExport", [
+		type,
+		delimiter,
+		maxRow,
+		resourceBasePath,
+		valueType,
+		contentType
+	]);
+};
+/**
+* 设置参数值
+* @param id 参数Id
+* @param value 参数真实值
+* @param displayValue 参数显示值
+* @returns 无返回值
+*/
+const setParamValue = (id, value, displayValue) => {
+	return smartbi("InsightReport", "setParamValue", [
+		id,
+		value,
+		displayValue
+	]);
+};
+/**
+* 刷新对象
+* @returns 无返回值
+*/
+const refreshObject = () => {
+	return smartbi("InsightReport", "refreshObject", []);
+};
+/**
+* 关闭透视分析
+* @returns 无返回值
+*/
+const close = () => {
+	return smartbi("InsightReport", "close", []);
+};
+/**
+* 获取执行状态
+* @returns 返回执行状态信息
+*/
+const getExecutingState = () => {
+	return smartbi("InsightReport", "getExecutingState", []);
+};
+/**
+* 取得报表的指定页
+* @param pageIndex 页码
+* @returns 返回报表数据
+*/
+const getPage = (pageIndex) => {
+	return smartbi("InsightReport", "getPage", [pageIndex]);
+};
+
+//#endregion
+export { close, doExport, getExecutingState, getPage, getParamDefaultValueByPID, getParamDefaultValueByPID2, getParamList, getParamStandbyValue, open, refreshObject, setParamValue };

package/dist/service/MetadataService.d.ts

@@ -0,0 +1,41 @@
+import { S as IDocument, c as CategoryResource, p as DocumentTreeNode } from "../types-DOYMZhxT.js";
+
+//#region src/service/MetadataService.d.ts
+/**
+ * 搜索被引用的资源(影响性分析)
+ * @param resId 要搜索的资源ID
+ * @param recursive 是否获取子节点
+ * @returns 返回树结构的被引用的资源列表
+ */
+declare const searchByReferenced: (resId: string, recursive: boolean) => Promise<DocumentTreeNode[]>;
+/**
+ * 搜索引用到的资源(血统分析)
+ * @param resId 要搜索的资源ID
+ * @param recursive 是否获取子节点
+ * @returns 返回树结构的被引用的资源列表
+ */
+declare const searchReferringTo: (resId: string, recursive: boolean) => Promise<DocumentTreeNode[]>;
+/**
+ * 检索当前用户是否具有权限检索对应的资源节点
+ * @param docs 要搜索的所有资源节点
+ * @returns 返回判断结果列表
+ */
+declare const checkPermission: (docs: IDocument[]) => Promise<boolean[]>;
+/**
+ * 搜索被引用的资源(影响性分析)
+ * @param res 要搜索的资源
+ * @param filters 允许返回的资源类型
+ * @param recursive 是否递归
+ * @returns 返回引用的资源
+ */
+declare const searchByReferencedRecursive: (res: CategoryResource, filters: string[], recursive: boolean) => Promise<IDocument[]>;
+/**
+ * 搜索引用到的资源(血统分析)
+ * @param res 要搜索的资源
+ * @param filters 允许返回的资源类型
+ * @param recursive 是否递归
+ * @returns 返回引用到的资源
+ */
+declare const searchReferringToRecursive: (res: CategoryResource, filters: string[], recursive: boolean) => Promise<IDocument[]>;
+//#endregion
+export { checkPermission, searchByReferenced, searchByReferencedRecursive, searchReferringTo, searchReferringToRecursive };

package/dist/service/MetadataService.js

@@ -0,0 +1,60 @@
+import { smartbi } from "../index.js";
+
+//#region src/service/MetadataService.ts
+/**
+* 搜索被引用的资源(影响性分析)
+* @param resId 要搜索的资源ID
+* @param recursive 是否获取子节点
+* @returns 返回树结构的被引用的资源列表
+*/
+const searchByReferenced = (resId, recursive) => {
+	return smartbi("MetadataService", "searchByReferenced", [resId, recursive]);
+};
+/**
+* 搜索引用到的资源(血统分析)
+* @param resId 要搜索的资源ID
+* @param recursive 是否获取子节点
+* @returns 返回树结构的被引用的资源列表
+*/
+const searchReferringTo = (resId, recursive) => {
+	return smartbi("MetadataService", "searchReferringTo", [resId, recursive]);
+};
+/**
+* 检索当前用户是否具有权限检索对应的资源节点
+* @param docs 要搜索的所有资源节点
+* @returns 返回判断结果列表
+*/
+const checkPermission = (docs) => {
+	return smartbi("MetadataService", "checkPermission", [docs.toString()]);
+};
+/**
+* 搜索被引用的资源(影响性分析)
+* @param res 要搜索的资源
+* @param filters 允许返回的资源类型
+* @param recursive 是否递归
+* @returns 返回引用的资源
+*/
+const searchByReferencedRecursive = (res, filters, recursive) => {
+	return smartbi("MetadataService", "searchByReferencedRecursive", [
+		JSON.stringify(res),
+		filters.toString(),
+		recursive
+	]);
+};
+/**
+* 搜索引用到的资源(血统分析)
+* @param res 要搜索的资源
+* @param filters 允许返回的资源类型
+* @param recursive 是否递归
+* @returns 返回引用到的资源
+*/
+const searchReferringToRecursive = (res, filters, recursive) => {
+	return smartbi("MetadataService", "searchReferringToRecursive", [
+		JSON.stringify(res),
+		filters.toString(),
+		recursive
+	]);
+};
+
+//#endregion
+export { checkPermission, searchByReferenced, searchByReferencedRecursive, searchReferringTo, searchReferringToRecursive };

package/dist/service/OfficeReport.d.ts

@@ -0,0 +1,53 @@
+import { B as RunningInfo, O as OfficeReportExportType, j as Parameter } from "../types-DOYMZhxT.js";
+
+//#region src/service/OfficeReport.d.ts
+/**
+ * 打开Word分析报告
+ * @param id Word分析报告id
+ * @returns 无返回值
+ */
+declare const openOfficeReport: (id: string) => Promise<void>;
+/**
+ * 关闭Word分析报告
+ * @returns 无返回值
+ */
+declare const closeOfficeReport: () => Promise<void>;
+/**
+ * 获取Word分析报告参数列表
+ * @returns 返回参数列表
+ */
+declare const getOfficeReportParamList: () => Promise<Parameter[]>;
+/**
+ * 根据参数ID获取参数备选值
+ * @param paramId 参数ID
+ * @returns 返回参数备选值列表
+ */
+declare const getOfficeReportParamStandbyValue: (paramId: string) => Promise<any[]>;
+/**
+ * 根据参数ID获取参数默认值
+ * @param pid 参数ID
+ * @returns 返回参数默认值
+ */
+declare const getOfficeReportParamDefaultValueByPID: (pid: string) => Promise<string>;
+/**
+ * 设置参数值
+ * @param id 参数ID
+ * @param value 参数真实值
+ * @param displayValue 参数显示值
+ * @returns 无返回值
+ */
+declare const setOfficeReportParamValue: (id: string, value: string, displayValue: string) => Promise<void>;
+/**
+ * 导出Word分析报告
+ * @param type 导出类型
+ * @param os 输出流
+ * @returns 无返回值
+ */
+declare const exportOfficeReport: (type: OfficeReportExportType | string, os: any) => Promise<void>;
+/**
+ * 获取执行状态
+ * @returns 返回执行状态信息
+ */
+declare const getOfficeReportExecutingState: () => Promise<RunningInfo>;
+//#endregion
+export { closeOfficeReport, exportOfficeReport, getOfficeReportExecutingState, getOfficeReportParamDefaultValueByPID, getOfficeReportParamList, getOfficeReportParamStandbyValue, openOfficeReport, setOfficeReportParamValue };