smartbi-toolkit 1.1.0 → 1.1.2

package/README.md

@@ -5,12 +5,15 @@
 
 ### 在smartbi-toolkit中封装了通用的请求方法
 
-* smartbi方法,具体可以
-
+* smartbi方法,RMI方法调用封装
 ```javascript
 smartbi('服务名', '方法名', ['参数1', '参数2', '...']).then(res => {
 })
 ```
+* 登录方法
+```javascript
+login('用户名', '密码').then(res => {})
+```
 
 * setSmartbiEnv 为开发环境设置smartbi变量，注意账号密码安全问题，不要直接把账号密码写入,在开发环境设置后可实现自动登录，生产环境需要自行实现登录，或者运行在smartbi下，无需登录
 
@@ -19,23 +22,96 @@ setSmartbiEnv({
     dev: {
         username: 'admin',
         password: 'manager',
-    }
+    }, // smartbi开发环境下的账号密码，注意打包时不要填写，避免信息暴露
+    mode:'dev', // dev/ prod 开发和生产模式 。默认dev模式，该参数可忽略，只影响到smartbi的判断
+    path:'/smartbi',// smartbi服务路径，默认为/smartbi，如果部署在tomcat的ROOT目录下，该参数改为 "/"
+    noop:30000 //心跳循环时间，默认30秒
 })
 ```
+* 开始心跳
+```javascript
+startHeartbeat()
+```
+* 停止心跳
+```javascript
+stopHeartbeat()
+```
+
+* 心跳方法，不使用startHeartbeat()和stopHeartbeat()方法，手动实现心跳
+```javascript
+noop()
+```
+
+### ext扩展包构建工具，通过vite实现
+该工具为vite插件，可以一键生成ext扩展包，但需要有java和Apache Ant环境
+
+```javascript
+import vitePluginSmartbi from 'smartbi-toolkit/VitePluginSmartbi'
+
+export default defineConfig({
+    plugins: [
+        vitePluginSmartbi({
+            name:'ext-test',
+        })
+    ],
+})
+```
+#### 参数说明
+```typescript
+export type VitePluginSmartbiOptions = {
+    /**
+     * 插件名称
+     */
+    name: string
+    /**
+     * 插件别名
+     */
+    alias?: string
+    /**
+     * 插件描述
+     */
+    desc?: string
+    /**
+     * 优先级
+     */
+    priority?: number
+    /**
+     * 输出目录
+     */
+    output?: string
+    /**
+     * html重命名
+     */
+    indexRename?: string
+    /**
+     * vision到html中间的路径
+     */
+    appendPath?: string,
+    /**
+     * 插件版本
+     */
+    version?: string
+};
+```
+
 
 ### 在smartbi-toolkit/xxxxService中，实现你官方文档定义的接口
 
-* 该部分文档代码由AI生成，不保证正确性，如果遇到错误或者不可用，
-* 具体方法参考文档https://wiki.smartbi.com.cn/api/javaapi/index.html或者jsdoc
+* 代码大部分由AI通过官方文档生成，基本和官方保持一致，部分ts类型等可能存在错误
+* 如遇到接口不可用，可以尝试使用smartbi()方法调用，如果依旧不可以，请查看官方文档，官方文档内也有相当大的一部分方法不可以
+* 大部分接口均由AI通过官方文档生成JsDoc
+* 官方文档https://wiki.smartbi.com.cn/api/javaapi/index.html
+
 
-### 在smartbi-toolkit/CatalogService内，通过官方文档实现了“资源目录服务”接口
-* 参考文档https://wiki.smartbi.com.cn/api/javaapi/index.html?smartbi/sdk/service/catalog/CatalogService.html
 
 
 ### todo 开发中功能，后续实现
 1. 其他服务接口
-   * 未实现的接口，大部分来自官方api稳定，由于smartbi版本或者文档版本造成的使用过程中的偏差，部分接口来自Smartbi-SDK.jar提取
-2. 扩展包构建工具
-   * 提供基于vite插件的扩展包构建工具，可将前端单页面应用直接打包成ext扩展包功能
+   * Smartbi-SDK.jar中包含的，但官方文档没有的接口
+   * 其他可通过rmi调用的接口
+2. TS类型优化
+   * TS类型没有完善，部分通过AI生成，后续需要从SDK中提取完整的类型信息
+3. 封装参数
+   * 目前参数封装为数组，后续需要封装为对象
 
    

package/package.json

@@ -1,16 +1,22 @@
 {
   "name": "smartbi-toolkit",
   "private": false,
-  "version": "1.1.0",
+  "version": "1.1.2",
   "keys": [
     "smartbi",
     "扩展包",
     "ext",
-    "typescript"
+    "typescript",
+    "smartbi-toolkit"
   ],
   "type": "module",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "description": "SmartBI 非官方JS sdk和ext构建工具",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/StillAlexLiu/smartbi-toolkit.git"
+  },
   "exports": {
     ".": {
       "import": "./dist/index.js",

package/dist/index.d.ts

@@ -1,22 +0,0 @@
-export type SmartbiDev = {
-    username: string;
-    password: string;
-};
-export declare const setSmartbiEnv: ({ path, dev, noop, mode }: {
-    path?: "/smartbi" | "" | string;
-    dev?: SmartbiDev;
-    mode?: "dev" | "prod";
-    noop?: number;
-}) => void;
-type Status = 'pending' | 'online' | 'offline';
-type PostStack = () => void;
-export declare const emit: () => void, on: (call: PostStack) => void, handler: (requireLogin: boolean) => Promise<void>, setStatus: (value: Status) => void;
-export declare const smartbi: <T>(className: string, methodName: string, params: Array<string | number | boolean | null | undefined>, requireLogin?: boolean) => Promise<T>;
-/**
- * 登录smartbi服务
- */
-export declare const login: (form?: {
-    username: string;
-    password: string;
-}) => Promise<unknown>;
-export {};

package/dist/index.js

@@ -1,99 +0,0 @@
-import axios from "axios";
-const __smartbi_env = {
-    username: '',
-    password: '',
-    smartbiPath: '/smartbi', mode: 'prod'
-};
-export const setSmartbiEnv = ({ path = '/smartbi', dev, noop = 3000, mode = 'prod' }) => {
-    console.log(path, dev, noop);
-    __smartbi_env.username = dev?.username || '';
-    __smartbi_env.username = dev?.username || '';
-    __smartbi_env.mode = mode;
-    if (dev) {
-        console.log("请勿将账号信息直接赋值到username和password中，避免暴露账号密码，如需要，可考虑从环境变量.env文件中获取");
-    }
-};
-const postStack = () => {
-    const postList = new Set();
-    let status = 'offline';
-    return {
-        setStatus(value) {
-            status = value;
-        },
-        emit() {
-            postList.forEach(call => {
-                call();
-            });
-            postList.clear();
-        },
-        on(call) {
-            postList.add(call);
-        },
-        handler(requireLogin) {
-            return new Promise(resolve => {
-                if (requireLogin) {
-                    if (status === 'offline') {
-                        status = 'pending';
-                        login().then(() => {
-                            emit();
-                            resolve();
-                        });
-                    }
-                    else if (status === 'online') {
-                        resolve();
-                    }
-                    else if (status === 'pending') {
-                        on(() => {
-                            resolve();
-                        });
-                    }
-                }
-                else {
-                    resolve();
-                }
-            });
-        }
-    };
-};
-export const { emit, on, handler, setStatus } = postStack();
-export const smartbi = (className, methodName, params, requireLogin = __smartbi_env.mode === 'dev') => {
-    return new Promise((resolve, reject) => {
-        handler(requireLogin)
-            .then(() => {
-            return axios.post(`${__smartbi_env.smartbiPath}/vision/RMIServlet`, {
-                className,
-                methodName,
-                params: JSON.stringify(params),
-            }, {
-                headers: {
-                    'Content-Type': 'application/x-www-form-urlencoded',
-                    'X-Requested-With': 'XMLHttpRequest',
-                },
-            });
-        })
-            .then(res => {
-            if (res.data.retCode === 0) {
-                resolve(res.data.result);
-            }
-            else {
-                console.error('smartbi返回状态错误');
-                console.error(res.data.stackTrace);
-                reject(new Error(res.data.stackTrace));
-            }
-        })
-            .catch(e => {
-            reject(e);
-        });
-    });
-};
-/**
- * 登录smartbi服务
- */
-export const login = (form) => {
-    return new Promise(resolve => {
-        smartbi('UserService', 'login', [form?.username || __smartbi_env.username, form?.password || __smartbi_env.password], false).then(value => {
-            setStatus('online');
-            resolve(value);
-        });
-    });
-};

package/dist/main.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/main.js

@@ -1,18 +0,0 @@
-import { setSmartbiEnv } from './index';
-import { getRootElements } from './methods/CatalogService';
-setSmartbiEnv({
-    dev: {
-        username: 'admin',
-        password: 'Bi@2024!!!!!!!!',
-    },
-    mode: 'dev'
-});
-// smartbi('x', 'x', [1, 2, 3]).then(value => {
-//     console.log(value)
-// })
-getRootElements().then(value => {
-    console.log(value);
-    value.forEach(item => {
-        console.log(item.fullPath);
-    });
-});

package/dist/methods/AnalysisReportService.d.ts

@@ -1,93 +0,0 @@
-import type { IResult, RunningInfo, IParameter, Parameter, NameValuePair, AllExportTypeMap } from '../types';
-/**
- * 打开多维报表
- * @param reportId 报表ID
- * @returns 返回报表客户端ID
- */
-export declare const openAnalysisReport: (reportId: string) => Promise<string>;
-/**
- * 打开多维报表（不初始化）
- * @param reportId 报表ID
- * @returns 返回报表客户端ID
- */
-export declare const openOlapReportWithoutInit: (reportId: string) => Promise<string>;
-/**
- * 关闭多维报表
- * @param clientId 客户端ID
- * @returns 无返回值
- */
-export declare const closeAnalysisReport: (clientId: string) => Promise<void>;
-/**
- * 设置多维报表参数值
- * @param clientId 客户端ID
- * @param id 参数ID
- * @param value 参数值
- * @param displayValue 参数显示值
- * @returns 无返回值
- */
-export declare const setParamValue: (clientId: string, id: string, value: string, displayValue: string) => Promise<void>;
-/**
- * 执行多维查询
- * @param clientId 客户端ID
- * @returns 返回查询结果
- */
-export declare const executeQuery: (clientId: string) => Promise<IResult>;
-/**
- * 导出报表
- * @param clientId 客户端ID
- * @param exportType 导出类型
- * @param delimiter 分割符
- * @param os 输出流
- * @param resourceBasePath 资源路径前缀(可选)
- * @param valueType 值类型(可选)
- * @returns 无返回值
- */
-export declare const doExport: (clientId: string, exportType: keyof AllExportTypeMap | string, delimiter: string, os: any, // 输出流
-resourceBasePath?: string, valueType?: string) => Promise<void>;
-/**
- * 设置参数为默认值
- * @param clientId 客户端ID
- * @param paramId 参数ID
- * @returns 无返回值
- */
-export declare const setParameterValueAsDefault: (clientId: string, paramId: string) => Promise<void>;
-/**
- * 获取参数
- * @param clientId 客户端ID
- * @param paramId 参数ID
- * @returns 返回参数信息
- */
-export declare const getParameter: (clientId: string, paramId: string) => Promise<IParameter>;
-/**
- * 获取参数显示值
- * @param clientId 客户端ID
- * @param paramId 参数ID
- * @returns 返回参数显示值
- */
-export declare const getParameterDisplayValue: (clientId: string, paramId: string) => Promise<string>;
-/**
- * 获取参数默认值
- * @param clientId 客户端ID
- * @param paramId 参数ID
- * @returns 返回参数默认值列表
- */
-export declare const getParameterDefaultValue: (clientId: string, paramId: string) => Promise<string[]>;
-/**
- * 获取所有参数
- * @param clientId 客户端ID
- * @returns 返回参数列表
- */
-export declare const getParameters: (clientId: string) => Promise<Parameter[]>;
-/**
- * 获取参数候选值列表
- * @param clientId 客户端ID
- * @param paramId 参数ID
- * @returns 返回候选值列表
- */
-export declare const getParamStandbyValue: (clientId: string, paramId: string) => Promise<NameValuePair[]>;
-/**
- * 获取执行状态
- * @param clientId 客户端ID
- * @returns 返回执行状态信息
- */
-export declare const getExecutingState: (clientId: string) => Promise<RunningInfo>;

package/dist/methods/AnalysisReportService.js

@@ -1,126 +0,0 @@
-/**
- * 打开多维报表
- * @param reportId 报表ID
- * @returns 返回报表客户端ID
- */
-export const openAnalysisReport = (reportId) => {
-    return smartbi('AnalysisReportService', 'openAnalysisReport', [reportId]);
-};
-/**
- * 打开多维报表（不初始化）
- * @param reportId 报表ID
- * @returns 返回报表客户端ID
- */
-export const openOlapReportWithoutInit = (reportId) => {
-    return smartbi('AnalysisReportService', 'openOlapReportWithoutInit', [reportId]);
-};
-/**
- * 关闭多维报表
- * @param clientId 客户端ID
- * @returns 无返回值
- */
-export const closeAnalysisReport = (clientId) => {
-    return smartbi('AnalysisReportService', 'closeAnalysisReport', [clientId]);
-};
-/**
- * 设置多维报表参数值
- * @param clientId 客户端ID
- * @param id 参数ID
- * @param value 参数值
- * @param displayValue 参数显示值
- * @returns 无返回值
- */
-export const setParamValue = (clientId, id, value, displayValue) => {
-    return smartbi('AnalysisReportService', 'setParamValue', [clientId, id, value, displayValue]);
-};
-/**
- * 执行多维查询
- * @param clientId 客户端ID
- * @returns 返回查询结果
- */
-export const executeQuery = (clientId) => {
-    return smartbi('AnalysisReportService', 'executeQuery', [clientId]);
-};
-/**
- * 导出报表
- * @param clientId 客户端ID
- * @param exportType 导出类型
- * @param delimiter 分割符
- * @param os 输出流
- * @param resourceBasePath 资源路径前缀(可选)
- * @param valueType 值类型(可选)
- * @returns 无返回值
- */
-export const doExport = (clientId, exportType, delimiter, os, // 输出流
-resourceBasePath, valueType) => {
-    const params = [clientId, exportType, delimiter, os];
-    if (resourceBasePath !== undefined) {
-        params.push(resourceBasePath);
-        if (valueType !== undefined) {
-            params.push(valueType);
-        }
-    }
-    return smartbi('AnalysisReportService', 'doExport', params);
-};
-/**
- * 设置参数为默认值
- * @param clientId 客户端ID
- * @param paramId 参数ID
- * @returns 无返回值
- */
-export const setParameterValueAsDefault = (clientId, paramId) => {
-    return smartbi('AnalysisReportService', 'setParameterValueAsDefault', [clientId, paramId]);
-};
-/**
- * 获取参数
- * @param clientId 客户端ID
- * @param paramId 参数ID
- * @returns 返回参数信息
- */
-export const getParameter = (clientId, paramId) => {
-    return smartbi('AnalysisReportService', 'getParameter', [clientId, paramId]);
-};
-/**
- * 获取参数显示值
- * @param clientId 客户端ID
- * @param paramId 参数ID
- * @returns 返回参数显示值
- */
-export const getParameterDisplayValue = (clientId, paramId) => {
-    return smartbi('AnalysisReportService', 'getParameterDisplayValue', [clientId, paramId]);
-};
-/**
- * 获取参数默认值
- * @param clientId 客户端ID
- * @param paramId 参数ID
- * @returns 返回参数默认值列表
- */
-export const getParameterDefaultValue = (clientId, paramId) => {
-    return smartbi('AnalysisReportService', 'getParameterDefaultValue', [clientId, paramId]);
-};
-/**
- * 获取所有参数
- * @param clientId 客户端ID
- * @returns 返回参数列表
- */
-export const getParameters = (clientId) => {
-    return smartbi('AnalysisReportService', 'getParameters', [clientId]);
-};
-/**
- * 获取参数候选值列表
- * @param clientId 客户端ID
- * @param paramId 参数ID
- * @returns 返回候选值列表
- */
-export const getParamStandbyValue = (clientId, paramId) => {
-    return smartbi('AnalysisReportService', 'getParamStandbyValue', [clientId, paramId]);
-};
-/**
- * 获取执行状态
- * @param clientId 客户端ID
- * @returns 返回执行状态信息
- */
-export const getExecutingState = (clientId) => {
-    return smartbi('AnalysisReportService', 'getExecutingState', [clientId]);
-};
-import { smartbi } from "../index";

package/dist/methods/BusinessThemeService.d.ts

@@ -1,8 +0,0 @@
-/**
- * 创建业务对象
- * @param businessThemeId 业务主题ID
- * @param parentId 业务对象父ID
- * @param tableId 表ID
- * @returns 无返回值
- */
-export declare const createBusinessThemeObject: (businessThemeId: string, parentId: string, tableId: string) => Promise<void>;

package/dist/methods/BusinessThemeService.js

@@ -1,11 +0,0 @@
-import { smartbi } from '../index';
-/**
- * 创建业务对象
- * @param businessThemeId 业务主题ID
- * @param parentId 业务对象父ID
- * @param tableId 表ID
- * @returns 无返回值
- */
-export const createBusinessThemeObject = (businessThemeId, parentId, tableId) => {
-    return smartbi('BusinessThemeService', 'createBusinessThemeObject', [businessThemeId, parentId, tableId]);
-};

package/dist/methods/BusinessViewService.d.ts

@@ -1,94 +0,0 @@
-import type { FieldProperty, ViewMetaData } from '../types';
-/**
- * 根据数据集（可视化查询、原生SQL查询、SQL查询）的ID查询其SQL语句
- * @param bizViewId （可视化查询、原生SQL查询、SQL查询）的ID
- * @returns 返回其SQL语句
- */
-export declare const getSqlString: (bizViewId: string) => Promise<string>;
-/**
- * 打开业务查询以备读取结果集数据
- * @param bizViewId 业务查询ID
- * @param paramsJsonArrStr 报表的参数信息
- * @param rowsPerPage 加载数据时每页返回的行数
- * @param getTotalRows 是否获取总行数
- * @returns 返回查询基本元数据信息
- */
-export declare const openLoadDataView: (bizViewId: string, paramsJsonArrStr: string, rowsPerPage: number, getTotalRows: boolean) => Promise<ViewMetaData>;
-/**
- * 按页读取结果集数据
- * @param loadDataClientId 打开查询后的客户端标识
- * @param pageNum 页码(第1页的页码为0，第2页的页码为1，如此类推)
- * @returns 返回原始报表数据
- */
-export declare const loadViewData: (loadDataClientId: string, pageNum: number) => Promise<string[][]>;
-/**
- * 按页读取结果集数据
- * @param loadDataClientId 打开查询后的客户端标识
- * @param pageNum 页码(第1页的页码为0，第2页的页码为1，如此类推)
- * @param dataFormatMap 数据格式映射，如："DOUBLE", "<浮点型-默认值>"，目前仅支持double
- * @returns 返回原始报表数据
- */
-export declare const loadViewDataWithDataformat: (loadDataClientId: string, pageNum: number, dataFormatMap: Map<string, string>) => Promise<string[][]>;
-/**
- * 关闭业务查询
- * @param loadDataClientId 打开查询后的客户端标识
- * @returns 无返回值
- */
-export declare const closeLoadDataView: (loadDataClientId: string) => Promise<void>;
-/**
- * 打开业务查询
- * @param bizViewId 打开业务查询ID
- * @returns 返回业务查询结果
- */
-export declare const openBusinessView: (bizViewId: string) => Promise<any[]>;
-/**
- * 关闭业务查询
- * @param bizViewClientId 打开查询后的客户端标识
- * @returns 无返回值
- */
-export declare const closeBusinessView: (bizViewClientId: string) => Promise<void>;
-/**
- * 检测输出字段
- * @param bizViewClientId 打开查询后的客户端标识
- * @returns 无返回值
- */
-export declare const getRawSqlOutputField: (bizViewClientId: string) => Promise<void>;
-/**
- * 检测输出字段
- * @param clientId 客户端ID
- * @returns 返回输出字段
- */
-export declare const detectOutputFields: (clientId: string) => Promise<any[]>;
-/**
- * 覆盖业务视图
- * @param bizViewClientId 业务视图ID
- * @returns 无返回值
- */
-export 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
- */
-export 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
- */
-export 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 无返回值
- */
-export declare const setOutputFieldInfo: (businessViewClientId: string, fieldId: string, propertyName: FieldProperty, propertyValue: string) => Promise<void>;