smartbi-toolkit 1.1.3 → 1.2.0

package/dist/service/BusinessViewService.d.ts

@@ -0,0 +1,98 @@
+import { K as ViewMetaData, P as PropertyName } from "../types-DOYMZhxT.js";
+
+//#region src/service/BusinessViewService.d.ts
+/**
+ * 根据数据集（可视化查询、原生SQL查询、SQL查询）的ID查询其SQL语句
+ * @param bizViewId （可视化查询、原生SQL查询、SQL查询）的ID
+ * @returns 返回其SQL语句
+ */
+declare const getSqlString: (bizViewId: string) => Promise<string>;
+/**
+ * 打开业务查询以备读取结果集数据
+ * @param bizViewId 业务查询ID
+ * @param paramsJsonArrStr 报表的参数信息
+ * @param rowsPerPage 加载数据时每页返回的行数
+ * @param getTotalRows 是否获取总行数
+ * @returns 返回查询基本元数据信息
+ */
+declare const openLoadDataView: (bizViewId: string, paramsJsonArrStr: string, rowsPerPage: number, getTotalRows: boolean) => Promise<ViewMetaData>;
+/**
+ * 按页读取结果集数据
+ * @param loadDataClientId 打开查询后的客户端标识
+ * @param pageNum 页码(第1页的页码为0，第2页的页码为1，如此类推)
+ * @returns 返回原始报表数据
+ */
+declare const loadViewData: (loadDataClientId: string, pageNum: number) => Promise<string[][]>;
+/**
+ * 按页读取结果集数据
+ * @param loadDataClientId 打开查询后的客户端标识
+ * @param pageNum 页码(第1页的页码为0，第2页的页码为1，如此类推)
+ * @param dataFormatMap 数据格式映射，如："DOUBLE", "<浮点型-默认值>"，目前仅支持double
+ * @returns 返回原始报表数据
+ */
+declare const loadViewDataWithDataformat: (loadDataClientId: string, pageNum: number, dataFormatMap: Map<string, string>) => Promise<string[][]>;
+/**
+ * 关闭业务查询
+ * @param loadDataClientId 打开查询后的客户端标识
+ * @returns 无返回值
+ */
+declare const closeLoadDataView: (loadDataClientId: string) => Promise<void>;
+/**
+ * 打开业务查询
+ * @param bizViewId 打开业务查询ID
+ * @returns 返回业务查询结果
+ */
+declare const openBusinessView: (bizViewId: string) => Promise<any[]>;
+/**
+ * 关闭业务查询
+ * @param bizViewClientId 打开查询后的客户端标识
+ * @returns 无返回值
+ */
+declare const closeBusinessView: (bizViewClientId: string) => Promise<void>;
+/**
+ * 检测输出字段
+ * @param bizViewClientId 打开查询后的客户端标识
+ * @returns 无返回值
+ */
+declare const getRawSqlOutputField: (bizViewClientId: string) => Promise<void>;
+/**
+ * 检测输出字段
+ * @param clientId 客户端ID
+ * @returns 返回输出字段
+ */
+declare const detectOutputFields: (clientId: string) => Promise<any[]>;
+/**
+ * 覆盖业务视图
+ * @param bizViewClientId 业务视图ID
+ * @returns 无返回值
+ */
+declare const overwriteBusinessView: (bizViewClientId: string) => Promise<void>;
+/**
+ * 创建"原生SQL查询"数据集，并保存到指定目录下
+ * @param datasourceId 数据源ID
+ * @param sql "原生SQL查询"的SQL语句
+ * @param name 数据集的名称
+ * @param alias 数据集的别名
+ * @param desc 数据集的描述
+ * @param folderId 用来保存数据集的指定目录ID
+ * @returns 返回所创建的"原生SQL查询"数据集ID
+ */
+declare const createRawSqlQueryBusinessViewAndSave: (datasourceId: string, sql: string, name: string, alias: string, desc: string, folderId: string) => Promise<string>;
+/**
+ * 更新指定的"原生SQL查询"数据集的SQL语句，并自动检测输出字段
+ * @param businessViewId "原生SQL查询"数据集ID
+ * @param sql 新的SQL语句
+ * @returns 返回数据集ID
+ */
+declare const updateRawSqlQueryBusinessView: (businessViewId: string, sql: string) => Promise<string>;
+/**
+ * 设置输出字段信息
+ * @param businessViewClientId clientId
+ * @param fieldId 字段信息
+ * @param propertyName 属性名，如alias,desc,dataType,dataFormat,orderby,transformRule
+ * @param propertyValue 属性值
+ * @returns 无返回值
+ */
+declare const setOutputFieldInfo: (businessViewClientId: string, fieldId: string, propertyName: PropertyName, propertyValue: string) => Promise<void>;
+//#endregion
+export { closeBusinessView, closeLoadDataView, createRawSqlQueryBusinessViewAndSave, detectOutputFields, getRawSqlOutputField, getSqlString, loadViewData, loadViewDataWithDataformat, openBusinessView, openLoadDataView, overwriteBusinessView, setOutputFieldInfo, updateRawSqlQueryBusinessView };

package/dist/service/BusinessViewService.js

@@ -0,0 +1,146 @@
+import { smartbi } from "../index.js";
+
+//#region src/service/BusinessViewService.ts
+/**
+* 根据数据集（可视化查询、原生SQL查询、SQL查询）的ID查询其SQL语句
+* @param bizViewId （可视化查询、原生SQL查询、SQL查询）的ID
+* @returns 返回其SQL语句
+*/
+const getSqlString = (bizViewId) => {
+	return smartbi("BusinessViewService", "getSqlString", [bizViewId]);
+};
+/**
+* 打开业务查询以备读取结果集数据
+* @param bizViewId 业务查询ID
+* @param paramsJsonArrStr 报表的参数信息
+* @param rowsPerPage 加载数据时每页返回的行数
+* @param getTotalRows 是否获取总行数
+* @returns 返回查询基本元数据信息
+*/
+const openLoadDataView = (bizViewId, paramsJsonArrStr, rowsPerPage, getTotalRows) => {
+	return smartbi("BusinessViewService", "openLoadDataView", [
+		bizViewId,
+		paramsJsonArrStr,
+		rowsPerPage,
+		getTotalRows
+	]);
+};
+/**
+* 按页读取结果集数据
+* @param loadDataClientId 打开查询后的客户端标识
+* @param pageNum 页码(第1页的页码为0，第2页的页码为1，如此类推)
+* @returns 返回原始报表数据
+*/
+const loadViewData = (loadDataClientId, pageNum) => {
+	return smartbi("BusinessViewService", "loadViewData", [loadDataClientId, pageNum]);
+};
+/**
+* 按页读取结果集数据
+* @param loadDataClientId 打开查询后的客户端标识
+* @param pageNum 页码(第1页的页码为0，第2页的页码为1，如此类推)
+* @param dataFormatMap 数据格式映射，如："DOUBLE", "<浮点型-默认值>"，目前仅支持double
+* @returns 返回原始报表数据
+*/
+const loadViewDataWithDataformat = (loadDataClientId, pageNum, dataFormatMap) => {
+	return smartbi("BusinessViewService", "loadViewDataWithDataformat", [
+		loadDataClientId,
+		pageNum,
+		dataFormatMap.toString()
+	]);
+};
+/**
+* 关闭业务查询
+* @param loadDataClientId 打开查询后的客户端标识
+* @returns 无返回值
+*/
+const closeLoadDataView = (loadDataClientId) => {
+	return smartbi("BusinessViewService", "closeLoadDataView", [loadDataClientId]);
+};
+/**
+* 打开业务查询
+* @param bizViewId 打开业务查询ID
+* @returns 返回业务查询结果
+*/
+const openBusinessView = (bizViewId) => {
+	return smartbi("BusinessViewService", "openBusinessView", [bizViewId]);
+};
+/**
+* 关闭业务查询
+* @param bizViewClientId 打开查询后的客户端标识
+* @returns 无返回值
+*/
+const closeBusinessView = (bizViewClientId) => {
+	return smartbi("BusinessViewService", "closeBusinessView", [bizViewClientId]);
+};
+/**
+* 检测输出字段
+* @param bizViewClientId 打开查询后的客户端标识
+* @returns 无返回值
+*/
+const getRawSqlOutputField = (bizViewClientId) => {
+	return smartbi("BusinessViewService", "getRawSqlOutputField", [bizViewClientId]);
+};
+/**
+* 检测输出字段
+* @param clientId 客户端ID
+* @returns 返回输出字段
+*/
+const detectOutputFields = (clientId) => {
+	return smartbi("BusinessViewService", "detectOutputFields", [clientId]);
+};
+/**
+* 覆盖业务视图
+* @param bizViewClientId 业务视图ID
+* @returns 无返回值
+*/
+const overwriteBusinessView = (bizViewClientId) => {
+	return smartbi("BusinessViewService", "overwriteBusinessView", [bizViewClientId]);
+};
+/**
+* 创建"原生SQL查询"数据集，并保存到指定目录下
+* @param datasourceId 数据源ID
+* @param sql "原生SQL查询"的SQL语句
+* @param name 数据集的名称
+* @param alias 数据集的别名
+* @param desc 数据集的描述
+* @param folderId 用来保存数据集的指定目录ID
+* @returns 返回所创建的"原生SQL查询"数据集ID
+*/
+const createRawSqlQueryBusinessViewAndSave = (datasourceId, sql, name, alias, desc, folderId) => {
+	return smartbi("BusinessViewService", "createRawSqlQueryBusinessViewAndSave", [
+		datasourceId,
+		sql,
+		name,
+		alias,
+		desc,
+		folderId
+	]);
+};
+/**
+* 更新指定的"原生SQL查询"数据集的SQL语句，并自动检测输出字段
+* @param businessViewId "原生SQL查询"数据集ID
+* @param sql 新的SQL语句
+* @returns 返回数据集ID
+*/
+const updateRawSqlQueryBusinessView = (businessViewId, sql) => {
+	return smartbi("BusinessViewService", "updateRawSqlQueryBusinessView", [businessViewId, sql]);
+};
+/**
+* 设置输出字段信息
+* @param businessViewClientId clientId
+* @param fieldId 字段信息
+* @param propertyName 属性名，如alias,desc,dataType,dataFormat,orderby,transformRule
+* @param propertyValue 属性值
+* @returns 无返回值
+*/
+const setOutputFieldInfo = (businessViewClientId, fieldId, propertyName, propertyValue) => {
+	return smartbi("BusinessViewService", "setOutputFieldInfo", [
+		businessViewClientId,
+		fieldId,
+		propertyName,
+		propertyValue
+	]);
+};
+
+//#endregion
+export { closeBusinessView, closeLoadDataView, createRawSqlQueryBusinessViewAndSave, detectOutputFields, getRawSqlOutputField, getSqlString, loadViewData, loadViewDataWithDataformat, openBusinessView, openLoadDataView, overwriteBusinessView, setOutputFieldInfo, updateRawSqlQueryBusinessView };

package/dist/service/CatalogService.d.ts

@@ -0,0 +1,192 @@
+import { L as ResourcePermission, M as PermissionDescendType, N as PermissionType, R as ResourcePermissionItem, o as CatalogElement, s as CatalogElementType, t as AccessType, v as HiddenInBrowse, y as ICatalogSearchResult } from "../types-DOYMZhxT.js";
+
+//#region src/service/CatalogService.d.ts
+/**
+ * 判断某个资源是否可访问。
+ * 参数:
+ * elementId - 资源ID
+ * type - 访问类型:
+ * 1.引用权限：REF
+ * 2.查看权限：READ
+ * 3.编辑权限：WRITE
+ * @param elementId 资源ID
+ * @param type 访问类型
+ * @returns 返回是否有权限的布尔值
+ */
+declare const isCatalogElementAccessible: (elementId: string, type: AccessType) => Promise<boolean>;
+/**
+ * 获取资源树的顶层节点列表
+ * @returns 返回顶层节点列表，节点类型为CatalogElement
+ */
+declare const getRootElements: () => Promise<CatalogElement[]>;
+/**
+ * 获得指定节点的子节点列表
+ * @param nodeId 指定节点ID
+ * @returns 返回子节点列表，节点类型为CatalogElement
+ */
+declare const getChildElements: (nodeId: string) => Promise<CatalogElement[]>;
+/**
+ * 创建目录
+ * @param parentNodeId 父目录ID
+ * @param name 目录名称
+ * @param alias 目录别名
+ * @param desc 目录描述
+ * @param type 目录类型,此项可为空,系统会自动根据父目录的类型进行设置
+ * @param hiddenInBrowse 是否在浏览模块中隐藏此目录
+ * @returns 返回创建的目录对象，类型为CatalogElement
+ */
+declare const createFolder: (parentNodeId: string, name: string, alias: string, desc: string, type: CatalogElementType | string, hiddenInBrowse: HiddenInBrowse) => Promise<CatalogElement>;
+/**
+ * 通过ID创建目录
+ * @param parentNodeId 父目录ID
+ * @param id 目录ID
+ * @param name 目录名称
+ * @param alias 目录别名
+ * @param desc 目录描述
+ * @param type 目录类型,此项可为空,系统会自动根据父目录的类型进行设置
+ * @param hiddenInBrowse 是否在浏览模块中隐藏此目录
+ * @returns 返回创建的目录对象，类型为CatalogElement
+ */
+declare const createFolderById: (parentNodeId: string, id: string, name: string, alias: string, desc: string, type: CatalogElementType | string, hiddenInBrowse: HiddenInBrowse) => Promise<CatalogElement>;
+/**
+ * 通过ID访问资源
+ * @param elementId 资源ID
+ * @returns 返回资源对象，类型为CatalogElement
+ */
+declare const getCatalogElementById: (elementId: string) => Promise<CatalogElement>;
+/**
+ * 通过类型获取结点
+ * @param type 节点类型
+ * @returns 返回指定类型的节点列表，节点类型为CatalogElement
+ */
+declare const getCatalogElementByType: (type: CatalogElementType | string) => Promise<CatalogElement[]>;
+/**
+ * 获取目录下指定类型的子元素
+ * @param parentNodeId 父节点ID
+ * @param types 要获取的子元素类型数组
+ * @returns 返回指定类型的子元素列表，节点类型为CatalogElement
+ */
+declare const getChildElementsByTypes: (parentNodeId: string, types: (CatalogElementType | string)[]) => Promise<CatalogElement[]>;
+/**
+ * 获取资源直接被授予的权限信息
+ * @param resId 资源ID
+ * @returns 返回资源直接被授予的权限信息，类型为ResourcePermission
+ */
+declare const getAssignedPermissions: (resId: string) => Promise<ResourcePermission>;
+/**
+ * 获取资源继承的权限信息
+ * @param resId 资源ID
+ * @returns 返回资源继承的权限信息列表，类型为ResourcePermissionItem[]
+ */
+declare const getInheritedPermissions: (resId: string) => Promise<ResourcePermissionItem[]>;
+/**
+ * 通过ID删除资源
+ * @param id 资源ID
+ * @returns 无返回值
+ */
+declare const deleteCatalogElement: (id: string) => Promise<void>;
+/**
+ * 根据别名或名称模糊查询资源信息
+ * @param alias 别名或名称关键字
+ * @param purview "READ"："查看"； "WRITE"："编辑"； "REF"："引用"
+ * @returns 返回搜索结果列表，类型为ICatalogSearchResult[]
+ */
+declare const searchCatalogElementLikeAlias: (alias: string, purview: AccessType) => Promise<ICatalogSearchResult[]>;
+/**
+ * 设置该资源的组权限
+ * @param elementId 资源ID
+ * @param groupId 组ID
+ * @param type 权限类型
+ * @param inherited 是否继承
+ * @param permissionDescendType 权限下降类型
+ * @param isGroupDescend 是否组下降
+ * @returns 无返回值
+ */
+declare const setAssignedPermissionByGroup: (elementId: string, groupId: string, type: PermissionType, inherited: boolean, permissionDescendType: PermissionDescendType, isGroupDescend: boolean) => Promise<void>;
+/**
+ * 设置该资源的角色权限
+ * @param elementId 资源ID
+ * @param roleId 角色ID
+ * @param type 权限类型
+ * @param inherited 是否继承
+ * @param permissionDescendType 权限下降类型
+ * @returns 无返回值
+ */
+declare const setAssignedPermissionByRole: (elementId: string, roleId: string, type: PermissionType, inherited: boolean, permissionDescendType: PermissionDescendType) => Promise<void>;
+/**
+ * 设置该资源的用户权限
+ * @param elementId 资源ID
+ * @param userId 用户ID
+ * @param type 权限类型
+ * @param inherited 是否继承
+ * @param permissionDescendType 权限下降类型
+ * @returns 无返回值
+ */
+declare const setAssignedPermissionByUser: (elementId: string, userId: string, type: PermissionType, inherited: boolean, permissionDescendType: PermissionDescendType) => Promise<void>;
+/**
+ * 更换资源节点的图片
+ * @param id 资源ID
+ * @param image 图片路径或图片数据
+ * @returns 无返回值
+ */
+declare const updateCatalogElementImage: (id: string, image: string) => Promise<void>;
+/**
+ * 根据ID修改资源信息
+ * @param id 资源ID
+ * @param jsonNodeConfig JSON节点配置 资源定义，json字符串，格式如下： "{\"alias\":\"复选框_报表2\",\"desc\":\"复选框_报表2\",\"deletedExtKeys\":\"hasChild,detectChild\",\"extended\":\"{'customImage':'Foldera.jpg','hiddenInBrowse':'false'}\"}" alias: 可选属性，别名 desc: 可选属性，描述 deletedExtKeys：可选属性，需要删除的扩展属性的key，参数内容可以不包含该属性 extended：可选属性，需要新增或修改的扩展属性内容，参数内容可以不包含该属性
+ * @param wholeExtended 完整的扩展内容，json字符串，格式如下：{"extended": "{\"hasChild\":\"false\",\"hiddenInBrowse\":\"false\"}"}。 该参数内容可为空。如不为空，扩展字段内容将全部替换为该参数内容，否则只对扩展属性进行增量添加。
+ * @returns 无返回值
+ */
+declare const updateCatalogNode: (id: string, jsonNodeConfig: string, wholeExtended: string) => Promise<void>;
+/**
+ * 创建WEB链接
+ * @param parentFolderId 父文件夹ID
+ * @param urlName URL名称
+ * @param urlAlias URL别名
+ * @param urlDesc URL描述
+ * @param url URL地址
+ * @param setting  设置是否新窗口打开以及是否传递登录信息
+ * 设置在当前窗口打开设置如下: {"currentWindow":true}
+ * 设置在当前窗口打开并传递登录信息设置如下: {"currentWindow":true,"autoLogin":true}
+ * 如果此值设置为空，则系统会默认为在新窗口打开并不传递登录信息
+ * @returns 返回新创建的URL链接ID
+ */
+declare const createURLLink: (parentFolderId: string, urlName: string, urlAlias: string, urlDesc: string, url: string, setting: string) => Promise<string>;
+/**
+ * 更新WEB链接
+ * @param urlID 结点ID
+ * @param urlAlias URL别名
+ * @param urlDesc URL描述
+ * @param url URL地址
+ * @param setting   设置是否新窗口打开以及是否传递登录信息
+ * 设置在当前窗口打开设置如下: {"currentWindow":true}
+ * 设置在当前窗口打开并传递登录信息设置如下: {"currentWindow":true,"autoLogin":true}
+ * 如果此值设置为空，则系统会默认为在新窗口打开并不传递登录信
+ * @returns 无返回值
+ */
+declare const updateURLLink: (urlID: string, urlAlias: string, urlDesc: string, url: string, setting: string) => Promise<void>;
+/**
+ * 复制粘贴并返回新ID
+ * @param toId 目标ID
+ * @param srcId 源ID
+ * @param name 名称
+ * @param alias 别名
+ * @param desc 描述
+ * @returns 返回新创建元素的ID
+ */
+declare const copyAndPasteReturnNewId: (toId: string, srcId: string, name: string, alias: string, desc: string) => Promise<string>;
+/**
+ * 创建资源树结点
+ * 注意：此方法是单纯新建一个树结点，调用此方法前，必须存在此结点类型的实体资源.
+ * @param parentId 父ID
+ * @param id ID
+ * @param name 名称
+ * @param alias 别名
+ * @param desc 描述
+ * @param order 顺序
+ * @param type 类型
+ * @returns 返回创建的资源节点，类型为CatalogElement
+ */
+declare const createCatalogElement: (parentId: string, id: string, name: string, alias: string, desc: string, order: number, type: CatalogElementType | string) => Promise<CatalogElement>;
+//#endregion
+export { copyAndPasteReturnNewId, createCatalogElement, createFolder, createFolderById, createURLLink, deleteCatalogElement, getAssignedPermissions, getCatalogElementById, getCatalogElementByType, getChildElements, getChildElementsByTypes, getInheritedPermissions, getRootElements, isCatalogElementAccessible, searchCatalogElementLikeAlias, setAssignedPermissionByGroup, setAssignedPermissionByRole, setAssignedPermissionByUser, updateCatalogElementImage, updateCatalogNode, updateURLLink };