smartbi-toolkit 1.1.3 → 1.2.0

package/README.md

@@ -51,7 +51,7 @@ noop()
 该工具为vite插件，可以一键生成ext扩展包，但需要有java和Apache Ant环境
 
 ```javascript
-import vitePluginSmartbi from 'smartbi-toolkit/VitePluginSmartbi'
+import vitePluginSmartbi from 'smartbi-toolkit/vite-plugin/VitePluginSmartbi'
 
 export default defineConfig({
     plugins: [
@@ -69,7 +69,7 @@ export type VitePluginSmartbiOptions = {
      */
     name: string
     /**
-     * 插件别名
+     * 插件名称
      */
     alias?: string
     /**
@@ -80,6 +80,10 @@ export type VitePluginSmartbiOptions = {
      * 优先级
      */
     priority?: number
+    /**
+     * 插件版本
+     */
+    version?: string
     /**
      * 输出目录
      */
@@ -92,19 +96,63 @@ export type VitePluginSmartbiOptions = {
      * vision到html中间的路径
      */
     appendPath?: string,
+};
+```
+
+
+### ext新扩展包构建工具，通过vite实现 对应smartbix那套的扩展包
+环境同上，构建工具封装
+
+```javascript
+import vitePluginSmartbi from 'smartbi-toolkit/vite-plugin/VitePluginSmartbix'
+
+export default defineConfig({
+    plugins: [
+        VitePluginSmartbix({
+            name:'ext-test',
+        })
+    ],
+})
+```
+#### 参数说明
+```typescript
+export type VitePluginSmartbiOptions = {
+    /**
+     * 插件名称
+     */
+    name: string
+    /**
+     * 插件名称
+     */
+    alias?: string
+    /**
+     * 插件描述
+     */
+    desc?: string
+    /**
+     * 优先级
+     */
+    priority?: number
     /**
      * 插件版本
      */
     version?: string
+    /**
+     * 扩展根目录
+     */
+    libRoot?: string
+    /**
+     * 输出路径
+     */
+    output?: string,
 };
 ```
 
+### 在smartbi-toolkit/service/xxxxService中，实现官方文档定义的接口
 
-### 在smartbi-toolkit/xxxxService中，实现你官方文档定义的接口
-
-* 代码大部分由AI通过官方文档生成，基本和官方保持一致，部分ts类型等可能存在错误
-* 如遇到接口不可用，可以尝试使用smartbi()方法调用，如果依旧不可以，请查看官方文档，官方文档内也有相当大的一部分方法不可以
-* 大部分接口均由AI通过官方文档生成JsDoc
+* 代码大部分由AI通过官方文档生成，基本和官方保持一致，部分ts类型等可能存在错误。
+* 如遇到接口不可用，可以尝试使用smartbi()方法调用，如果依旧不可以，请查看官方文档。（注：官方文档内也有相当大的一部分方法不可以）
+* 大部分接口均由AI通过官方文档生成jsdoc
 * 官方文档https://wiki.smartbi.com.cn/api/javaapi/index.html
 
 
@@ -112,11 +160,10 @@ export type VitePluginSmartbiOptions = {
 
 ### todo 开发中功能，后续实现
 1. 其他服务接口
-   * Smartbi-SDK.jar中包含的，但官方文档没有的接口
-   * 其他可通过rmi调用的接口
+    * Smartbi-SDK.jar中包含的，但官方文档没有的接口
 2. TS类型优化
-   * TS类型没有完善，部分通过AI生成，后续需要从SDK中提取完整的类型信息
-3. 封装参数
-   * 目前参数封装为数组，后续需要封装为对象
+    * TS类型没有完善，部分通过AI生成，后续需要从SDK中提取完整的类型信息
+3. 封装参数(可能会做)
+    * 目前参数封装为数组，后续需要封装为对象
 
    

package/dist/common-Cnq1SoER.d.ts

@@ -0,0 +1,25 @@
+//#region src/common/common.d.ts
+type WebProjectConfig = {
+  /**
+   * 插件名称
+   */
+  name: string;
+  /**
+   * 插件名称
+   */
+  alias?: string;
+  /**
+   * 插件描述
+   */
+  desc?: string;
+  /**
+   * 优先级
+   */
+  priority?: number;
+  /**
+   * 插件版本
+   */
+  version?: string;
+};
+//#endregion
+export { WebProjectConfig as t };

package/dist/console-BJttltN4.js

@@ -0,0 +1,93 @@
+import { ensureFile } from "fs-extra";
+import { writeFile } from "fs/promises";
+import { resolve } from "node:path";
+import chalk from "chalk";
+
+//#region src/common/common.ts
+const buildWebProject = ({ name, alias, desc, priority, version }, rootPath) => {
+	return {
+		web: `<web-app/>`,
+		applicationContext: `<?xml version="1.0" encoding="UTF-8"?>
+        <!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN 2.0//EN" "http://www.springframework.org/dtd/spring-beans-2.0.dtd">
+        <beans>
+            <bean id="framework" class="smartbi.framework.Framework" factory-method="getInstance">
+                <property name="modules">
+                    <map>
+                    </map>
+                </property>
+            </bean>
+            <bean id="rmi" class="smartbi.framework.rmi.RMIModule" factory-method="getInstance">
+                <property name="modules">
+                    <map>
+                    </map>
+                </property>
+            </bean>
+        </beans>
+    `,
+		extension: `<?xml version="1.0" encoding="UTF-8"?>
+        <!DOCTYPE extension SYSTEM "extension.dtd">
+        <extension name="${name}" alias="${alias || name}" desc="${desc || name}" :priority="${priority || 100}" version="${version || "1.0"}">
+            <enable-jsp-processor />
+        </extension>
+    `,
+		portlet: `<?xml version="1.0" encoding="UTF-8"?>
+        <portlet-app>
+        </portlet-app>
+    `,
+		build: `<?xml version="1.0" encoding="UTF-8"?>
+        <project name="${name}" default="dist">
+            <target name="dist" >
+                <tstamp>
+                    <format property="today" pattern="yyyy-MM-dd HH:mm:ss"/>
+                </tstamp>
+                <echo file="${resolve(rootPath, "META-INF/version.txt")}" message="\${today}"/>
+        
+                <jar destfile="${resolve(rootPath, `../${name}.ext`)}" duplicate="preserve">
+                    <fileset dir="${rootPath}"/>
+                </jar>
+            </target>
+        </project>
+`
+	};
+};
+const makeWebDir = (rootPath, config) => {
+	return new Promise((r) => {
+		const { web, applicationContext, extension, portlet, build } = buildWebProject(config, rootPath);
+		const paths = {
+			"WEB-INF/web.xml": web,
+			"META-INF/applicationContext.xml": applicationContext,
+			"META-INF/extension.xml": extension,
+			"META-INF/portlet.xml": portlet
+		};
+		const plist = Object.keys(paths).map((_path) => {
+			return new Promise((r) => {
+				const filePath = resolve(rootPath, _path);
+				ensureFile(filePath).then(() => {
+					return writeFile(filePath, paths[_path]);
+				}).then(() => {
+					r();
+				});
+			});
+		});
+		Promise.all(plist).then(() => {
+			writeFile(resolve(rootPath, "../build.xml"), build).then(() => {
+				r();
+			});
+		});
+	});
+};
+
+//#endregion
+//#region src/common/console.ts
+const info = (msg) => {
+	console.log(chalk.blue(msg));
+};
+const error = (msg) => {
+	console.log(chalk.red(msg));
+};
+const success = (msg) => {
+	console.log(chalk.green(msg));
+};
+
+//#endregion
+export { makeWebDir as i, info as n, success as r, error as t };

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+import * as axios$1 from "axios";
+
+//#region src/index.d.ts
+type SmartbiDev = {
+  username: string;
+  password: string;
+};
+declare const setSmartbiEnv: ({
+  path,
+  dev,
+  noop,
+  mode
+}: {
+  path?: "/smartbi" | "" | string;
+  dev?: SmartbiDev;
+  mode?: "dev" | "prod";
+  noop?: number;
+}) => void;
+/**
+ * pending：登录中
+ * online：已登录
+ * offline：未登录
+ */
+type Status = 'pending' | 'online' | 'offline';
+declare const setStatus: (value: Status) => void, startHeatBeat: () => void, stopHeatBeat: () => void;
+declare const smartbi: <T>(className: string, methodName: string, params: Array<string | number | boolean | null | undefined>, requireLogin?: boolean) => Promise<T>;
+/**
+ * 登录smartbi服务
+ */
+declare const login: (form?: {
+  username: string;
+  password: string;
+}) => Promise<unknown>;
+/**
+ * 心跳
+ */
+declare const noop: () => Promise<axios$1.AxiosResponse<any, any, {}>>;
+//#endregion
+export { SmartbiDev, login, noop, setSmartbiEnv, setStatus, smartbi, startHeatBeat, stopHeatBeat };

package/dist/index.js

@@ -0,0 +1,111 @@
+import axios from "axios";
+
+//#region src/index.ts
+const __smartbi_env = {
+	username: "",
+	password: "",
+	smartbiPath: "/smartbi",
+	mode: "prod",
+	noop: 3e4
+};
+const HEADERS = {
+	"Content-Type": "application/x-www-form-urlencoded",
+	"X-Requested-With": "XMLHttpRequest"
+};
+const setSmartbiEnv = ({ path = "/smartbi", dev, noop = 3e4, mode = "prod" }) => {
+	__smartbi_env.username = dev?.username || "";
+	__smartbi_env.password = dev?.password || "";
+	__smartbi_env.smartbiPath = path;
+	__smartbi_env.mode = mode;
+	__smartbi_env.noop = noop;
+	if (dev) console.log("请勿将账号信息直接赋值到username和password中，避免暴露账号密码，如需要，可考虑从环境变量.env文件中获取");
+};
+const smartbiInit = () => {
+	const postList = /* @__PURE__ */ new Set();
+	let timer = 0;
+	let status = "offline";
+	return {
+		stopHeatBeat() {
+			try {
+				clearInterval(timer);
+			} catch (e) {
+				console.error(e);
+			}
+		},
+		startHeatBeat() {
+			this.stopHeatBeat();
+			timer = setInterval(() => {
+				if (status === "online") noop().then(() => {});
+			}, __smartbi_env.noop);
+		},
+		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();
+			});
+		}
+	};
+};
+const { emit, on, handler, setStatus, startHeatBeat, stopHeatBeat } = smartbiInit();
+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: HEADERS });
+		}).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服务
+*/
+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);
+		});
+	});
+};
+/**
+* 心跳
+*/
+const noop = () => {
+	return axios.get(__smartbi_env.smartbiPath + "/vision/noop.jsp", { headers: HEADERS });
+};
+
+//#endregion
+export { login, noop, setSmartbiEnv, setStatus, smartbi, startHeatBeat, stopHeatBeat };

package/dist/service/AnalysisReportService.d.ts

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

package/dist/service/AnalysisReportService.js

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

package/dist/service/BusinessThemeService.d.ts

@@ -0,0 +1,11 @@
+//#region src/service/BusinessThemeService.d.ts
+/**
+ * 创建业务对象
+ * @param businessThemeId 业务主题ID
+ * @param parentId 业务对象父ID
+ * @param tableId 表ID
+ * @returns 无返回值
+ */
+declare const createBusinessThemeObject: (businessThemeId: string, parentId: string, tableId: string) => Promise<void>;
+//#endregion
+export { createBusinessThemeObject };

package/dist/service/BusinessThemeService.js

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