smartbi-toolkit 1.1.4 → 1.2.0

package/dist/methods/CatalogService.js

@@ -1,230 +0,0 @@
-import { smartbi } from "../index";
-/**
- * 判断某个资源是否可访问。
- * 参数:
- * elementId - 资源ID
- * type - 访问类型:
- * 1.引用权限：REF
- * 2.查看权限：READ
- * 3.编辑权限：WRITE
- * @param elementId 资源ID
- * @param type 访问类型
- * @returns 返回是否有权限的布尔值
- */
-export const isCatalogElementAccessible = (elementId, type) => {
-    return smartbi('CatalogService', 'isCatalogElementAccessible', [elementId, type]);
-};
-/**
- * 获取资源树的顶层节点列表
- * @returns 返回顶层节点列表，节点类型为CatalogElement
- */
-export const getRootElements = () => {
-    return smartbi('CatalogService', 'getRootElements', []);
-};
-/**
- * 获得指定节点的子节点列表
- * @param nodeId 指定节点ID
- * @returns 返回子节点列表，节点类型为CatalogElement
- */
-export const getChildElements = (nodeId) => {
-    return smartbi('CatalogService', 'getChildElements', [nodeId]);
-};
-/**
- * 创建目录
- * @param parentNodeId 父目录ID
- * @param name 目录名称
- * @param alias 目录别名
- * @param desc 目录描述
- * @param type 目录类型,此项可为空,系统会自动根据父目录的类型进行设置
- * @param hiddenInBrowse 是否在浏览模块中隐藏此目录
- * @returns 返回创建的目录对象，类型为CatalogElement
- */
-export const createFolder = (parentNodeId, name, alias, desc, type, hiddenInBrowse) => {
-    return smartbi('CatalogService', 'createFolder', [parentNodeId, name, alias, desc, type, hiddenInBrowse]);
-};
-/**
- * 通过ID创建目录
- * @param parentNodeId 父目录ID
- * @param id 目录ID
- * @param name 目录名称
- * @param alias 目录别名
- * @param desc 目录描述
- * @param type 目录类型,此项可为空,系统会自动根据父目录的类型进行设置
- * @param hiddenInBrowse 是否在浏览模块中隐藏此目录
- * @returns 返回创建的目录对象，类型为CatalogElement
- */
-export const createFolderById = (parentNodeId, id, name, alias, desc, type, hiddenInBrowse) => {
-    return smartbi('CatalogService', 'createFolderById', [parentNodeId, id, name, alias, desc, type, hiddenInBrowse]);
-};
-/**
- * 通过ID访问资源
- * @param elementId 资源ID
- * @returns 返回资源对象，类型为CatalogElement
- */
-export const getCatalogElementById = (elementId) => {
-    return smartbi('CatalogService', 'getCatalogElementById', [elementId]);
-};
-/**
- * 通过类型获取结点
- * @param type 节点类型
- * @returns 返回指定类型的节点列表，节点类型为CatalogElement
- */
-export const getCatalogElementByType = (type) => {
-    return smartbi('CatalogService', 'getCatalogElementByType', [type]);
-};
-/**
- * 获取目录下指定类型的子元素
- * @param parentNodeId 父节点ID
- * @param types 要获取的子元素类型数组
- * @returns 返回指定类型的子元素列表，节点类型为CatalogElement
- */
-export const getChildElementsByTypes = (parentNodeId, types) => {
-    return smartbi('CatalogService', 'getChildElementsByTypes', [parentNodeId, types.toString()]);
-};
-/**
- * 获取资源直接被授予的权限信息
- * @param resId 资源ID
- * @returns 返回资源直接被授予的权限信息，类型为ResourcePermission
- */
-export const getAssignedPermissions = (resId) => {
-    return smartbi('CatalogService', 'getAssignedPermissions', [resId]);
-};
-/**
- * 获取资源继承的权限信息
- * @param resId 资源ID
- * @returns 返回资源继承的权限信息列表，类型为ResourcePermissionItem[]
- */
-export const getInheritedPermissions = (resId) => {
-    return smartbi('CatalogService', 'getInheritedPermissions', [resId]);
-};
-/**
- * 通过ID删除资源
- * @param id 资源ID
- * @returns 无返回值
- */
-export const deleteCatalogElement = (id) => {
-    return smartbi('CatalogService', 'deleteCatalogElement', [id]);
-};
-/**
- * 根据别名或名称模糊查询资源信息
- * @param alias 别名或名称关键字
- * @param purview "READ"："查看"； "WRITE"："编辑"； "REF"："引用"
- * @returns 返回搜索结果列表，类型为ICatalogSearchResult[]
- */
-export const searchCatalogElementLikeAlias = (alias, purview) => {
-    return smartbi('CatalogService', 'searchCatalogElementLikeAlias', [alias, purview]);
-};
-/**
- * 设置该资源的组权限
- * @param elementId 资源ID
- * @param groupId 组ID
- * @param type 权限类型
- * @param inherited 是否继承
- * @param permissionDescendType 权限下降类型
- * @param isGroupDescend 是否组下降
- * @returns 无返回值
- */
-export const setAssignedPermissionByGroup = (elementId, groupId, type, inherited, permissionDescendType, isGroupDescend) => {
-    return smartbi('CatalogService', 'setAssignedPermissionByGroup', [elementId, groupId, type, inherited, permissionDescendType, isGroupDescend]);
-};
-/**
- * 设置该资源的角色权限
- * @param elementId 资源ID
- * @param roleId 角色ID
- * @param type 权限类型
- * @param inherited 是否继承
- * @param permissionDescendType 权限下降类型
- * @returns 无返回值
- */
-export const setAssignedPermissionByRole = (elementId, roleId, type, inherited, permissionDescendType) => {
-    return smartbi('CatalogService', 'setAssignedPermissionByRole', [elementId, roleId, type, inherited, permissionDescendType]);
-};
-/**
- * 设置该资源的用户权限
- * @param elementId 资源ID
- * @param userId 用户ID
- * @param type 权限类型
- * @param inherited 是否继承
- * @param permissionDescendType 权限下降类型
- * @returns 无返回值
- */
-export const setAssignedPermissionByUser = (elementId, userId, type, inherited, permissionDescendType) => {
-    return smartbi('CatalogService', 'setAssignedPermissionByUser', [elementId, userId, type, inherited, permissionDescendType]);
-};
-/**
- * 更换资源节点的图片
- * @param id 资源ID
- * @param image 图片路径或图片数据
- * @returns 无返回值
- */
-export const updateCatalogElementImage = (id, image) => {
-    return smartbi('CatalogService', 'updateCatalogElementImage', [id, image]);
-};
-/**
- * 根据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 无返回值
- */
-export const updateCatalogNode = (id, jsonNodeConfig, wholeExtended) => {
-    return smartbi('CatalogService', 'updateCatalogNode', [id, jsonNodeConfig, wholeExtended]);
-};
-/**
- * 创建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
- */
-export const createURLLink = (parentFolderId, urlName, urlAlias, urlDesc, url, setting) => {
-    return smartbi('CatalogService', 'createURLLink', [parentFolderId, urlName, urlAlias, urlDesc, url, setting]);
-};
-/**
- * 更新WEB链接
- * @param urlID 结点ID
- * @param urlAlias URL别名
- * @param urlDesc URL描述
- * @param url URL地址
- * @param setting   设置是否新窗口打开以及是否传递登录信息
- * 设置在当前窗口打开设置如下: {"currentWindow":true}
- * 设置在当前窗口打开并传递登录信息设置如下: {"currentWindow":true,"autoLogin":true}
- * 如果此值设置为空，则系统会默认为在新窗口打开并不传递登录信
- * @returns 无返回值
- */
-export const updateURLLink = (urlID, urlAlias, urlDesc, url, setting) => {
-    return smartbi('CatalogService', 'updateURLLink', [urlID, urlAlias, urlDesc, url, setting]);
-};
-/**
- * 复制粘贴并返回新ID
- * @param toId 目标ID
- * @param srcId 源ID
- * @param name 名称
- * @param alias 别名
- * @param desc 描述
- * @returns 返回新创建元素的ID
- */
-export const copyAndPasteReturnNewId = (toId, srcId, name, alias, desc) => {
-    return smartbi('CatalogService', 'copyAndPasteReturnNewId', [toId, srcId, name, alias, desc]);
-};
-/**
- * 创建资源树结点
- * 注意：此方法是单纯新建一个树结点，调用此方法前，必须存在此结点类型的实体资源.
- * @param parentId 父ID
- * @param id ID
- * @param name 名称
- * @param alias 别名
- * @param desc 描述
- * @param order 顺序
- * @param type 类型
- * @returns 返回创建的资源节点，类型为CatalogElement
- */
-export const createCatalogElement = (parentId, id, name, alias, desc, order, type) => {
-    return smartbi('CatalogService', 'createCatalogElement', [parentId, id, name, alias, desc, order, type]);
-};

package/dist/methods/ClientCombinedReportService.js

@@ -1,82 +0,0 @@
-// ClientCombinedReportService 服务方法
-import { smartbi } from "../index";
-/**
- * 打开一个即席查询报表
- * @param queryId 报表ID
- * @returns 返回打开的报表视图，类型为IClientCombinedReportView
- */
-export const openQuery = (queryId) => {
-    return smartbi('ClientCombinedReportService', 'openQuery', [queryId]);
-};
-/**
- * 打开一个即席查询报表（不初始化）
- * @param queryId 报表ID
- * @returns 返回打开的报表视图，类型为IClientCombinedReportView
- */
-export const openQueryWithoutInit = (queryId) => {
-    return smartbi('ClientCombinedReportService', 'openQueryWithoutInit', [queryId]);
-};
-/**
- * 同步条件面板参数
- * @param combinedClientId combinedClientId
- * @param condPanelClientId condPanelClientId
- * @returns 无返回值
- */
-export const updateConditionPanel = (combinedClientId, condPanelClientId) => {
-    return smartbi('ClientCombinedReportService', 'updateConditionPanel', [combinedClientId, condPanelClientId]);
-};
-/**
- * 将报表信息从服务端的会话状态中清除
- * @param combinedClientId 客户ID
- * @returns 无返回值
- */
-export const removeFromSession = (combinedClientId) => {
-    return smartbi('ClientCombinedReportService', 'removeFromSession', [combinedClientId]);
-};
-/**
- * 克隆查询
- * @param clientId 客户端ID
- * @param parentNodeId 父节点ID
- * @param name 名称
- * @param alias 别名
- * @param desc 描述
- * @returns 返回新客户端ID
- */
-export const cloneQuery = (clientId, parentNodeId, name, alias, desc) => {
-    return smartbi('ClientCombinedReportService', 'cloneQuery', [clientId, parentNodeId, name, alias, desc]);
-};
-/**
- * 导出报表
- * @param clientId 客户端ID
- * @param reportId 报表ID
- * @returns 无返回值
- */
-export const dump = (clientId, reportId) => {
-    return smartbi('ClientCombinedReportService', 'dump', [clientId, reportId]);
-};
-/**
- * 覆盖查询
- * @param clientId 客户端ID
- * @param replacedReportId 报表ID
- * @param desc 描述
- * @returns 返回true/false
- */
-export const overwriteQuery = (clientId, replacedReportId, desc) => {
-    return smartbi('ClientCombinedReportService', 'overwriteQuery', [clientId, replacedReportId, desc]);
-};
-/**
- * 获取即席查询的数据来源类型
- * @param queryId 即席查询id
- * @returns 返回数据来源类型
- */
-export const getDataSourceType = (queryId) => {
-    return smartbi('ClientCombinedReportService', 'getDataSourceType', [queryId]);
-};
-/**
- * 获取即席查询的类型
- * @param reportId 即席查询id
- * @returns 返回类型
- */
-export const getExtendedType = (reportId) => {
-    return smartbi('ClientCombinedReportService', 'getExtendedType', [reportId]);
-};

package/dist/methods/ClientInsightService.js

@@ -1,107 +0,0 @@
-import { smartbi } from "../index";
-/**
- * 清空透视分析临时表
- * @returns 无返回值
- */
-export const cleanTempTablePool = () => {
-    return smartbi('ClientInsightService', 'cleanTempTablePool', []);
-};
-/**
- * 打开透视分析
- * @param reportId 报表Id
- * @param pageId 页面Id
- * @returns 返回JSON对象
- */
-export const openQuery = (reportId, pageId) => {
-    return smartbi('ClientInsightService', 'openQuery', [reportId, pageId]);
-};
-/**
- * 获取参数备选值
- * @param panelId 参数面板ClientId
- * @param paramId 参数Id
- * @returns 返回键值对列表
- */
-export const getParamStandbyValue = (panelId, paramId) => {
-    return smartbi('ClientInsightService', 'getParamStandbyValue', [panelId, paramId]);
-};
-/**
- * 根据参数Id获取参数默认值
- * @param panelId 参数面板ClientId
- * @param paramId 参数Id
- * @returns 返回JSON数组
- */
-export const getParamDefaultValueByPID = (panelId, paramId) => {
-    return smartbi('ClientInsightService', 'getParamDefaultValueByPID', [panelId, paramId]);
-};
-/**
- * 设置参数值
- * @param panelId 参数面板ClientId
- * @param paramId 参数Id
- * @param value 参数真实值
- * @param displayValue 参数显示值
- * @returns 无返回值
- */
-export const setParamValue = (panelId, paramId, value, displayValue) => {
-    return smartbi('ClientInsightService', 'setParamValue', [panelId, paramId, value, displayValue]);
-};
-/**
- * 关闭透视分析
- * @param clientId clientId
- * @returns 无返回值
- */
-export const close = (clientId) => {
-    return smartbi('ClientInsightService', 'close', [clientId]);
-};
-/**
- * 创建透视分析
- * @param businessViewId 业务查询ID
- * @param name 名称
- * @param alias 别名
- * @param desc 描述
- * @param folderId 保存目录的ID
- * @returns 返回透视分析ID
- */
-export const createInsightQuery = (businessViewId, name, alias, desc, folderId) => {
-    return smartbi('ClientInsightService', 'createInsightQuery', [businessViewId, name, alias, desc, folderId]);
-};
-/**
- * 重新获取报表对象的当前状态
- * @param clientId clientId
- * @returns 返回查询结果JSON对象
- */
-export const getInsightQuery = (clientId) => {
-    return smartbi('ClientInsightService', 'getInsightQuery', [clientId]);
-};
-/**
- * 获取透视分析系统选项导出使用缓存默认值
- * @returns 返回systemconfig
- */
-export const getExportWithCacheConfig = () => {
-    return smartbi('ClientInsightService', 'getExportWithCacheConfig', []);
-};
-/**
- * 获取原始报表数据
- * @param clientId 客户端ID
- * @param pageNum 页码
- * @returns 返回原始报表数据
- */
-export const getRawReportData = (clientId, pageNum) => {
-    return smartbi('ClientInsightService', 'getRawReportData', [clientId, pageNum]);
-};
-/**
- * 取得一个表达式的值
- * @param clientId 客户ID
- * @param func 表达式
- * @returns 返回表达式的值
- */
-export const getFunctionValue = (clientId, func) => {
-    return smartbi('ClientInsightService', 'getFunctionValue', [clientId, func]);
-};
-/**
- * 取得clientConfig
- * @param clientId 客户ID
- * @returns 返回clientConfig
- */
-export const getClientConfig = (clientId) => {
-    return smartbi('ClientInsightService', 'getClientConfig', [clientId]);
-};

package/dist/methods/ClientReportService.js

@@ -1,206 +0,0 @@
-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

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

package/dist/methods/CombinedReportService.js

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