smartbi-toolkit 1.0.1 → 1.1.2

package/README.md

@@ -0,0 +1,117 @@
+# 非官方smartbi开发工具包
+
+* 可用于第三方系统上使用smartbi接口服务，封装了常用接口
+* 扩展包构建工具封装 （todo）
+
+### 在smartbi-toolkit中封装了通用的请求方法
+
+* smartbi方法,RMI方法调用封装
+```javascript
+smartbi('服务名', '方法名', ['参数1', '参数2', '...']).then(res => {
+})
+```
+* 登录方法
+```javascript
+login('用户名', '密码').then(res => {})
+```
+
+* setSmartbiEnv 为开发环境设置smartbi变量，注意账号密码安全问题，不要直接把账号密码写入,在开发环境设置后可实现自动登录，生产环境需要自行实现登录，或者运行在smartbi下，无需登录
+
+```javascript
+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通过官方文档生成，基本和官方保持一致，部分ts类型等可能存在错误
+* 如遇到接口不可用，可以尝试使用smartbi()方法调用，如果依旧不可以，请查看官方文档，官方文档内也有相当大的一部分方法不可以
+* 大部分接口均由AI通过官方文档生成JsDoc
+* 官方文档https://wiki.smartbi.com.cn/api/javaapi/index.html
+
+
+
+
+### todo 开发中功能，后续实现
+1. 其他服务接口
+   * Smartbi-SDK.jar中包含的，但官方文档没有的接口
+   * 其他可通过rmi调用的接口
+2. TS类型优化
+   * TS类型没有完善，部分通过AI生成，后续需要从SDK中提取完整的类型信息
+3. 封装参数
+   * 目前参数封装为数组，后续需要封装为对象
+
+   

package/package.json

@@ -1,35 +1,159 @@
 {
   "name": "smartbi-toolkit",
   "private": false,
-  "version": "1.0.1",
+  "version": "1.1.2",
+  "keys": [
+    "smartbi",
+    "扩展包",
+    "ext",
+    "typescript",
+    "smartbi-toolkit"
+  ],
   "type": "module",
-  "module": "./dist/SmartbiToolbox.es.js",
+  "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/SmartbiToolbox.es.js",
+      "import": "./dist/index.js",
       "types": "./dist/index.d.ts"
     },
+    "./VitePluginSmartbi": {
+      "import": "./dist/vite-plugin-smartbi/index.js",
+      "types": "./dist/vite-plugin-smartbi/index.d.ts"
+    },
+    "./AnalysisReportService": {
+      "import": "./dist/methods/AnalysisReportService.js",
+      "types": "./dist/methods/AnalysisReportService.d.ts"
+    },
+    "./BusinessThemeService": {
+      "import": "./dist/methods/BusinessThemeService.js",
+      "types": "./dist/methods/BusinessThemeService.d.ts"
+    },
+    "./BusinessViewService": {
+      "import": "./dist/methods/BusinessViewService.js",
+      "types": "./dist/methods/BusinessViewService.d.ts"
+    },
     "./CatalogService": {
-      "import": "./dist/CatalogService.es.js",
+      "import": "./dist/methods/CatalogService.js",
       "types": "./dist/methods/CatalogService.d.ts"
+    },
+    "./ClientCombinedReportService": {
+      "import": "./dist/methods/ClientCombinedReportService.js",
+      "types": "./dist/methods/ClientCombinedReportService.d.ts"
+    },
+    "./ClientInsightService": {
+      "import": "./dist/methods/ClientInsightService.js",
+      "types": "./dist/methods/ClientInsightService.d.ts"
+    },
+    "./ClientReportService": {
+      "import": "./dist/methods/ClientReportService.js",
+      "types": "./dist/methods/ClientReportService.d.ts"
+    },
+    "./CombinedReportService": {
+      "import": "./dist/methods/CombinedReportService.js",
+      "types": "./dist/methods/CombinedReportService.d.ts"
+    },
+    "./DataSourceService": {
+      "import": "./dist/methods/DataSourceService.js",
+      "types": "./dist/methods/DataSourceService.d.ts"
+    },
+    "./GraphicReportService": {
+      "import": "./dist/methods/GraphicReportService.js",
+      "types": "./dist/methods/GraphicReportService.d.ts"
+    },
+    "./InsightReport": {
+      "import": "./dist/methods/InsightReport.js",
+      "types": "./dist/methods/InsightReport.d.ts"
+    },
+    "./MetadataService": {
+      "import": "./dist/methods/MetadataService.js",
+      "types": "./dist/methods/MetadataService.d.ts"
+    },
+    "./OfficeReport": {
+      "import": "./dist/methods/OfficeReport.js",
+      "types": "./dist/methods/OfficeReport.d.ts"
+    },
+    "./OfficeReportService": {
+      "import": "./dist/methods/OfficeReportService.js",
+      "types": "./dist/methods/OfficeReportService.d.ts"
+    },
+    "./OltpMetadataService": {
+      "import": "./dist/methods/OltpMetadataService.js",
+      "types": "./dist/methods/OltpMetadataService.d.ts"
+    },
+    "./ParameterService": {
+      "import": "./dist/methods/ParameterService.js",
+      "types": "./dist/methods/ParameterService.d.ts"
+    },
+    "./PoolService": {
+      "import": "./dist/methods/PoolService.js",
+      "types": "./dist/methods/PoolService.d.ts"
+    },
+    "./PortalService": {
+      "import": "./dist/methods/PortalService.js",
+      "types": "./dist/methods/PortalService.d.ts"
+    },
+    "./Report": {
+      "import": "./dist/methods/Report.js",
+      "types": "./dist/methods/Report.d.ts"
+    },
+    "./SSReport": {
+      "import": "./dist/methods/SSReport.js",
+      "types": "./dist/methods/SSReport.d.ts"
+    },
+    "./ScheduleTaskService": {
+      "import": "./dist/methods/ScheduleTaskService.js",
+      "types": "./dist/methods/ScheduleTaskService.d.ts"
+    },
+    "./SimpleReportService": {
+      "import": "./dist/methods/SimpleReportService.js",
+      "types": "./dist/methods/SimpleReportService.d.ts"
+    },
+    "./SpreadSheetReportService": {
+      "import": "./dist/methods/SpreadSheetReportService.js",
+      "types": "./dist/methods/SpreadSheetReportService.d.ts"
+    },
+    "./SystemConfigService": {
+      "import": "./dist/methods/SystemConfigService.js",
+      "types": "./dist/methods/SystemConfigService.d.ts"
+    },
+    "./TimeConsuming": {
+      "import": "./dist/methods/TimeConsuming.js",
+      "types": "./dist/methods/TimeConsuming.d.ts"
+    },
+    "./TimeConsumingService": {
+      "import": "./dist/methods/TimeConsumingService.js",
+      "types": "./dist/methods/TimeConsumingService.d.ts"
+    },
+    "./UserManagerService": {
+      "import": "./dist/methods/UserManagerService.js",
+      "types": "./dist/methods/UserManagerService.d.ts"
     }
   },
   "scripts": {
-    "dev": "vite",
-    "b": "tsc",
-    "build": "tsc && vite build",
-    "preview": "vite preview"
+    "build": "tsc"
   },
   "files": [
     "dist"
   ],
   "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^25.0.10",
     "typescript": "~5.9.3",
-    "vite": "8.0.0-beta.8",
-    "vite-plugin-dts": "^4.5.4"
+    "vite": "8.0.0-beta.9"
+  },
+  "peerDependencies": {
+    "axios": "^1.3.6",
+    "chalk": "^5.2.0"
   },
   "dependencies": {
-    "axios": "^1.13.2"
+    "axios": "^1.13.2",
+    "chalk": "^5.6.2",
+    "fs-extra": "^11.3.3"
   }
 }

package/dist/CatalogService.es.js

@@ -1,112 +0,0 @@
-import { smartbi } from "./SmartbiToolbox.es.js";
-const AccessType = {
-	REF: "REF",
-	READ: "READ",
-	WRITE: "WRITE"
-}, CatalogElementType = {
-	FOLDER: "FOLDER",
-	SIMPLE_REPORT: "SIMPLE_REPORT",
-	ANALYSIS_REPORT: "ANALYSIS_REPORT",
-	COMBINED_QUERY: "COMBINED_QUERY",
-	INSIGHT: "INSIGHT",
-	OLAP_REPORT: "OLAP_REPORT",
-	DASHBOARD: "DASHBOARD",
-	SMARTBIX_PAGE: "SMARTBIX_PAGE",
-	DATASET: "DATASET",
-	VISUAL: "VISUAL",
-	SQL: "SQL",
-	PROCEDURE: "PROCEDURE",
-	NATIVE_SQL: "NATIVE_SQL",
-	JAVA: "JAVA",
-	SMARTBIX_DATASET: "SMARTBIX_DATASET",
-	AUGMENTED_DATASET: "AUGMENTED_DATASET",
-	BUSINESS_VIEW: "BUSINESS_VIEW",
-	BUSINESS_SUBJECT: "BUSINESS_SUBJECT",
-	BUSINESS_QUERY: "BUSINESS_QUERY",
-	SPREADSHEET_REPORT: "SPREADSHEET_REPORT",
-	WEB_SPREADSHEET_REPORT: "WEB_SPREADSHEET_REPORT",
-	DATA_PROCESS: "SMARTBI_DATAPROCESS",
-	ETL_AUTOMATION: "ETL_AUTOMATION",
-	JOB_FLOW: "JOB_FLOW",
-	DATA_MINING: "SMARTBI_MINING",
-	URL_LINK: "URL",
-	EXCEL_IMPORT_TEMPLATE: "excelimport",
-	TXT_QUERY_OBJECT: "TXTQUERYOBJECT",
-	TXT_DATA_SOURCE: "TXTDATASOURCE",
-	SCHEMA: "SCHEMA",
-	OLD_DATASET: "OLD_DATASET"
-}, PermissionType = {
-	REF: "REF",
-	READ: "READ",
-	WRITE: "WRITE"
-}, PermissionDescendType = {
-	ALL: "ALL",
-	NONE: "NONE",
-	READ_WRITE: "READ_WRITE"
-}, isCatalogElementAccessible = (y, b) => smartbi("CatalogService", "isCatalogElementAccessible", [y, b]), getRootElements = () => smartbi("CatalogService", "getRootElements", []), getChildElements = (y) => smartbi("CatalogService", "getChildElements", [y]), createFolder = (y, b, x, S, C, w) => smartbi("CatalogService", "createFolder", [
-	y,
-	b,
-	x,
-	S,
-	C,
-	w
-]), createFolderById = (y, b, x, S, C, w, T) => smartbi("CatalogService", "createFolderById", [
-	y,
-	b,
-	x,
-	S,
-	C,
-	w,
-	T
-]), getCatalogElementById = (y) => smartbi("CatalogService", "getCatalogElementById", [y]), getCatalogElementByType = (y) => smartbi("CatalogService", "getCatalogElementByType", [y]), getChildElementsByTypes = (y, b) => smartbi("CatalogService", "getChildElementsByTypes", [y, b.toString()]), getAssignedPermissions = (y) => smartbi("CatalogService", "getAssignedPermissions", [y]), getInheritedPermissions = (y) => smartbi("CatalogService", "getInheritedPermissions", [y]), deleteCatalogElement = (y) => smartbi("CatalogService", "deleteCatalogElement", [y]), searchCatalogElementLikeAlias = (y, b) => smartbi("CatalogService", "searchCatalogElementLikeAlias", [y, b]), setAssignedPermissionByGroup = (y, b, x, S, C, w) => smartbi("CatalogService", "setAssignedPermissionByGroup", [
-	y,
-	b,
-	x,
-	S,
-	C,
-	w
-]), setAssignedPermissionByRole = (y, b, x, S, C) => smartbi("CatalogService", "setAssignedPermissionByRole", [
-	y,
-	b,
-	x,
-	S,
-	C
-]), setAssignedPermissionByUser = (y, b, x, S, C) => smartbi("CatalogService", "setAssignedPermissionByUser", [
-	y,
-	b,
-	x,
-	S,
-	C
-]), updateCatalogElementImage = (y, b) => smartbi("CatalogService", "updateCatalogElementImage", [y, b]), updateCatalogNode = (y, b, x) => smartbi("CatalogService", "updateCatalogNode", [
-	y,
-	b,
-	x
-]), createURLLink = (y, b, x, S, C, w) => smartbi("CatalogService", "createURLLink", [
-	y,
-	b,
-	x,
-	S,
-	C,
-	w
-]), updateURLLink = (y, b, x, S, C) => smartbi("CatalogService", "updateURLLink", [
-	y,
-	b,
-	x,
-	S,
-	C
-]), copyAndPasteReturnNewId = (y, b, x, S, C) => smartbi("CatalogService", "copyAndPasteReturnNewId", [
-	y,
-	b,
-	x,
-	S,
-	C
-]), createCatalogElement = (y, b, x, S, C, w, T) => smartbi("CatalogService", "createCatalogElement", [
-	y,
-	b,
-	x,
-	S,
-	C,
-	w,
-	T
-]);
-export { AccessType, CatalogElementType, PermissionDescendType, PermissionType, copyAndPasteReturnNewId, createCatalogElement, createFolder, createFolderById, createURLLink, deleteCatalogElement, getAssignedPermissions, getCatalogElementById, getCatalogElementByType, getChildElements, getChildElementsByTypes, getInheritedPermissions, getRootElements, isCatalogElementAccessible, searchCatalogElementLikeAlias, setAssignedPermissionByGroup, setAssignedPermissionByRole, setAssignedPermissionByUser, updateCatalogElementImage, updateCatalogNode, updateURLLink };

package/dist/SmartbiToolbox.es.js

@@ -1,51 +0,0 @@
-import axios from "axios";
-var __smartbi_env = {
-	username: "",
-	password: "",
-	smartbiPath: "/smartbi"
-};
-const setSmartbiEnv = ({ path: e = "/smartbi", dev: r, noop: i = 3e3 }) => {
-	console.log(e, r, i), __smartbi_env.username = r?.username || "", __smartbi_env.password = r?.password || "", r && console.log("请勿将账号信息直接赋值到username和password中，避免暴露账号密码，如需要，可考虑从环境变量.env文件中获取");
-}, { emit, on, handler, setStatus } = (() => {
-	let e = /* @__PURE__ */ new Set(), n = "offline";
-	return {
-		setStatus(e) {
-			n = e;
-		},
-		emit() {
-			e.forEach((e) => {
-				e();
-			}), e.clear();
-		},
-		on(n) {
-			e.add(n);
-		},
-		handler(e) {
-			return new Promise((r) => {
-				e ? n === "offline" ? (n = "pending", login().then(() => {
-					emit(), r();
-				})) : n === "online" ? r() : n === "pending" && on(() => {
-					r();
-				}) : r();
-			});
-		}
-	};
-})(), smartbi = (r, i, a, o = !0) => new Promise((s, c) => {
-	handler(o).then(() => axios.post(`${__smartbi_env.smartbiPath}/vision/RMIServlet`, {
-		className: r,
-		methodName: i,
-		params: JSON.stringify(a)
-	}, { headers: {
-		"Content-Type": "application/x-www-form-urlencoded",
-		"X-Requested-With": "XMLHttpRequest"
-	} })).then((e) => {
-		e.data.retCode === 0 ? s(e.data.result) : (console.error("smartbi返回状态错误"), console.error(e.data.stackTrace), c(Error(e.data.stackTrace)));
-	}).catch((e) => {
-		c(e);
-	});
-}), login = (e) => new Promise((r) => {
-	smartbi("UserService", "login", [e?.username || __smartbi_env.username, e?.password || __smartbi_env.password], !1).then((e) => {
-		setStatus("online"), r(e);
-	});
-});
-export { emit, handler, login, on, setSmartbiEnv, setStatus, smartbi };

package/dist/index.d.ts

@@ -1,22 +0,0 @@
-export type SmartbiDev = {
-    username: string;
-    password: string;
-};
-export declare const setSmartbiEnv: ({ path, dev, noop, }: {
-    path?: "/smartbi" | "" | string;
-    dev?: SmartbiDev;
-    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 {};
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAAG;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CACpB,CAAA;AASD,eAAO,MAAM,aAAa,GAAI,sBAIG;IAC7B,IAAI,CAAC,EAAE,UAAU,GAAG,EAAE,GAAG,MAAM,CAAC;IAChC,GAAG,CAAC,EAAE,UAAU,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB,SAOA,CAAA;AACD,KAAK,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAA;AAC9C,KAAK,SAAS,GAAG,MAAM,IAAI,CAAA;AAwC3B,eAAO,MAAO,IAAI,cAAE,EAAE,SA1BL,SAAS,WA0BF,OAAO,iBAvBD,OAAO,KAAG,OAAO,CAAC,IAAI,CAAC,EAuBpB,SAAS,UAnCjB,MAAM,SAmC0B,CAAA;AACzD,eAAO,MAAM,OAAO,GAAI,CAAC,EACrB,WAAW,MAAM,EACjB,YAAY,MAAM,EAClB,QAAQ,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC,EAC3D,eAAc,OAAc,KAC7B,OAAO,CAAC,CAAC,CA4BX,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,KAAK,GAAI,OAAO;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAA;CACnB,qBAOA,CAAA"}

package/dist/main.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":""}

package/dist/methods/CatalogService.d.ts

@@ -1,270 +0,0 @@
-export interface ICatalogElement {
-    id: string;
-    name: string;
-    alias: string;
-    description?: string;
-    type: string;
-    parentId?: string;
-    children?: ICatalogElement[];
-    createTime?: Date;
-    updateTime?: Date;
-    [key: string]: any;
-}
-export interface IResourcePermission {
-    resourceId: string;
-    permissions: string[];
-    grantedBy: string;
-    grantTime: Date;
-    [key: string]: any;
-}
-export interface IResourcePermissionItem {
-    itemId: string;
-    itemName: string;
-    permissionType: string;
-    inherited: boolean;
-    [key: string]: any;
-}
-export interface ICatalogSearchResult {
-    id: string;
-    name: string;
-    alias: string;
-    type: string;
-    parentId: string;
-    score: number;
-    [key: string]: any;
-}
-export type AccessType = 'REF' | 'READ' | 'WRITE';
-export declare const AccessType: {
-    REF: "REF";
-    READ: "READ";
-    WRITE: "WRITE";
-};
-export type CatalogElementType = 'FOLDER' | 'SIMPLE_REPORT' | 'ANALYSIS_REPORT' | 'COMBINED_QUERY' | 'INSIGHT' | 'OLAP_REPORT' | 'DASHBOARD' | 'SMARTBIX_PAGE' | 'DATASET' | 'VISUAL' | 'SQL' | 'PROCEDURE' | 'NATIVE_SQL' | 'JAVA' | 'SMARTBIX_DATASET' | 'AUGMENTED_DATASET' | 'BUSINESS_VIEW' | 'BUSINESS_SUBJECT' | 'BUSINESS_QUERY' | 'SPREADSHEET_REPORT' | 'WEB_SPREADSHEET_REPORT' | 'SMARTBI_DATAPROCESS' | 'ETL_AUTOMATION' | 'JOB_FLOW' | 'SMARTBI_MINING' | 'URL' | 'excelimport' | 'TXTQUERYOBJECT' | 'TXTDATASOURCE' | 'SCHEMA' | 'OLD_DATASET';
-export declare const CatalogElementType: {
-    FOLDER: "FOLDER";
-    SIMPLE_REPORT: "SIMPLE_REPORT";
-    ANALYSIS_REPORT: "ANALYSIS_REPORT";
-    COMBINED_QUERY: "COMBINED_QUERY";
-    INSIGHT: "INSIGHT";
-    OLAP_REPORT: "OLAP_REPORT";
-    DASHBOARD: "DASHBOARD";
-    SMARTBIX_PAGE: "SMARTBIX_PAGE";
-    DATASET: "DATASET";
-    VISUAL: "VISUAL";
-    SQL: "SQL";
-    PROCEDURE: "PROCEDURE";
-    NATIVE_SQL: "NATIVE_SQL";
-    JAVA: "JAVA";
-    SMARTBIX_DATASET: "SMARTBIX_DATASET";
-    AUGMENTED_DATASET: "AUGMENTED_DATASET";
-    BUSINESS_VIEW: "BUSINESS_VIEW";
-    BUSINESS_SUBJECT: "BUSINESS_SUBJECT";
-    BUSINESS_QUERY: "BUSINESS_QUERY";
-    SPREADSHEET_REPORT: "SPREADSHEET_REPORT";
-    WEB_SPREADSHEET_REPORT: "WEB_SPREADSHEET_REPORT";
-    DATA_PROCESS: "SMARTBI_DATAPROCESS";
-    ETL_AUTOMATION: "ETL_AUTOMATION";
-    JOB_FLOW: "JOB_FLOW";
-    DATA_MINING: "SMARTBI_MINING";
-    URL_LINK: "URL";
-    EXCEL_IMPORT_TEMPLATE: "excelimport";
-    TXT_QUERY_OBJECT: "TXTQUERYOBJECT";
-    TXT_DATA_SOURCE: "TXTDATASOURCE";
-    SCHEMA: "SCHEMA";
-    OLD_DATASET: "OLD_DATASET";
-};
-export type PermissionType = 'REF' | 'READ' | 'WRITE';
-export declare const PermissionType: {
-    REF: "REF";
-    READ: "READ";
-    WRITE: "WRITE";
-};
-export type PermissionDescendType = 'ALL' | 'NONE' | 'READ_WRITE';
-export declare const PermissionDescendType: {
-    ALL: "ALL";
-    NONE: "NONE";
-    READ_WRITE: "READ_WRITE";
-};
-export type HiddenInBrowse = boolean;
-/**
- * 判断某个资源是否可访问。
- * 参数:
- * elementId - 资源ID
- * type - 访问类型:
- * 1.引用权限：REF
- * 2.查看权限：READ
- * 3.编辑权限：WRITE
- * @param elementId 资源ID
- * @param type 访问类型
- * @returns 返回是否有权限的布尔值
- */
-export declare const isCatalogElementAccessible: (elementId: string, type: AccessType) => Promise<boolean>;
-/**
- * 获取资源树的顶层节点列表
- * @returns 返回顶层节点列表，节点类型为ICatalogElement
- */
-export declare const getRootElements: () => Promise<ICatalogElement[]>;
-/**
- * 获得指定节点的子节点列表
- * @param nodeId 指定节点ID
- * @returns 返回子节点列表，节点类型为ICatalogElement
- */
-export declare const getChildElements: (nodeId: string) => Promise<ICatalogElement[]>;
-/**
- * 创建目录
- * @param parentNodeId 父目录ID
- * @param name 目录名称
- * @param alias 目录别名
- * @param desc 目录描述
- * @param type 目录类型,此项可为空,系统会自动根据父目录的类型进行设置
- * @param hiddenInBrowse 是否在浏览模块中隐藏此目录
- * @returns 返回创建的目录对象，类型为ICatalogElement
- */
-export declare const createFolder: (parentNodeId: string, name: string, alias: string, desc: string, type: CatalogElementType | string, hiddenInBrowse: HiddenInBrowse) => Promise<ICatalogElement>;
-/**
- * 通过ID创建目录
- * @param parentNodeId 父目录ID
- * @param id 目录ID
- * @param name 目录名称
- * @param alias 目录别名
- * @param desc 目录描述
- * @param type 目录类型,此项可为空,系统会自动根据父目录的类型进行设置
- * @param hiddenInBrowse 是否在浏览模块中隐藏此目录
- * @returns 返回创建的目录对象，类型为ICatalogElement
- */
-export declare const createFolderById: (parentNodeId: string, id: string, name: string, alias: string, desc: string, type: CatalogElementType | string, hiddenInBrowse: HiddenInBrowse) => Promise<ICatalogElement>;
-/**
- * 通过ID访问资源
- * @param elementId 资源ID
- * @returns 返回资源对象，类型为ICatalogElement
- */
-export declare const getCatalogElementById: (elementId: string) => Promise<ICatalogElement>;
-/**
- * 通过类型获取结点
- * @param type 节点类型
- * @returns 返回指定类型的节点列表，节点类型为ICatalogElement
- */
-export declare const getCatalogElementByType: (type: CatalogElementType | string) => Promise<ICatalogElement[]>;
-/**
- * 获取目录下指定类型的子元素
- * @param parentNodeId 父节点ID
- * @param types 要获取的子元素类型数组
- * @returns 返回指定类型的子元素列表，节点类型为ICatalogElement
- */
-export declare const getChildElementsByTypes: (parentNodeId: string, types: (CatalogElementType | string)[]) => Promise<ICatalogElement[]>;
-/**
- * 获取资源直接被授予的权限信息
- * @param resId 资源ID
- * @returns 返回资源直接被授予的权限信息，类型为IResourcePermission
- */
-export declare const getAssignedPermissions: (resId: string) => Promise<IResourcePermission>;
-/**
- * 获取资源继承的权限信息
- * @param resId 资源ID
- * @returns 返回资源继承的权限信息列表，类型为IResourcePermissionItem[]
- */
-export declare const getInheritedPermissions: (resId: string) => Promise<IResourcePermissionItem[]>;
-/**
- * 通过ID删除资源
- * @param id 资源ID
- * @returns 无返回值
- */
-export declare const deleteCatalogElement: (id: string) => Promise<void>;
-/**
- * 根据别名或名称模糊查询资源信息
- * @param alias 别名或名称关键字
- * @param purview 权限范围
- * @returns 返回搜索结果列表，类型为ICatalogSearchResult[]
- */
-export declare const searchCatalogElementLikeAlias: (alias: string, purview: string) => Promise<ICatalogSearchResult[]>;
-/**
- * 设置该资源的组权限
- * @param elementId 资源ID
- * @param groupId 组ID
- * @param type 权限类型
- * @param inherited 是否继承
- * @param permissionDescendType 权限下降类型
- * @param isGroupDescend 是否组下降
- * @returns 无返回值
- */
-export 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 无返回值
- */
-export 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 无返回值
- */
-export declare const setAssignedPermissionByUser: (elementId: string, userId: string, type: PermissionType, inherited: boolean, permissionDescendType: PermissionDescendType) => Promise<void>;
-/**
- * 更换资源节点的图片
- * @param id 资源ID
- * @param image 图片路径或图片数据
- * @returns 无返回值
- */
-export declare const updateCatalogElementImage: (id: string, image: string) => Promise<void>;
-/**
- * 根据ID修改资源信息
- * @param id 资源ID
- * @param jsonNodeConfig JSON节点配置
- * @param wholeExtended 完整扩展信息
- * @returns 无返回值
- */
-export 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 设置参数
- * @returns 返回新创建的URL链接ID
- */
-export declare const createURLLink: (parentFolderId: string, urlName: string, urlAlias: string, urlDesc: string, url: string, setting: string) => Promise<string>;
-/**
- * 更新WEB链接
- * @param urlID URL ID
- * @param urlAlias URL别名
- * @param urlDesc URL描述
- * @param url URL地址
- * @param setting 设置参数
- * @returns 无返回值
- */
-export 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
- */
-export 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 返回创建的资源节点，类型为ICatalogElement
- */
-export declare const createCatalogElement: (parentId: string, id: string, name: string, alias: string, desc: string, order: number, type: CatalogElementType | string) => Promise<ICatalogElement>;
-//# sourceMappingURL=CatalogService.d.ts.map

package/dist/methods/CatalogService.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CatalogService.d.ts","sourceRoot":"","sources":["../../src/methods/CatalogService.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,eAAe;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAC7B,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,UAAU,CAAC,EAAE,IAAI,CAAC;IAElB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,IAAI,CAAC;IAEhB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,OAAO,CAAC;IAEnB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IAEd,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAGD,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;AAGlD,eAAO,MAAM,UAAU;;;;CAItB,CAAC;AAGF,MAAM,MAAM,kBAAkB,GAExB,QAAQ,GAGR,eAAe,GACf,iBAAiB,GACjB,gBAAgB,GAChB,SAAS,GACT,aAAa,GAGb,WAAW,GACX,eAAe,GAGf,SAAS,GACT,QAAQ,GACR,KAAK,GACL,WAAW,GACX,YAAY,GACZ,MAAM,GACN,kBAAkB,GAClB,mBAAmB,GAGnB,eAAe,GACf,kBAAkB,GAClB,gBAAgB,GAGhB,oBAAoB,GACpB,wBAAwB,GAGxB,qBAAqB,GACrB,gBAAgB,GAChB,UAAU,GACV,gBAAgB,GAGhB,KAAK,GACL,aAAa,GACb,gBAAgB,GAChB,eAAe,GACf,QAAQ,GAGR,aAAa,CAAC;AAGpB,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiD9B,CAAC;AAGF,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;AAGtD,eAAO,MAAM,cAAc;;;;CAI1B,CAAC;AAGF,MAAM,MAAM,qBAAqB,GAAG,KAAK,GAAG,MAAM,GAAG,YAAY,CAAC;AAGlE,eAAO,MAAM,qBAAqB;;;;CAIjC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC;AAIrC;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,0BAA0B,GAAI,WAAW,MAAM,EAAE,MAAM,UAAU,KAAG,OAAO,CAAC,OAAO,CAE/F,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe,QAAO,OAAO,CAAC,eAAe,EAAE,CAE3D,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAAI,QAAQ,MAAM,KAAG,OAAO,CAAC,eAAe,EAAE,CAE1E,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY,GACrB,cAAc,MAAM,EACpB,MAAM,MAAM,EACZ,OAAO,MAAM,EACb,MAAM,MAAM,EACZ,MAAM,kBAAkB,GAAG,MAAM,EACjC,gBAAgB,cAAc,KAC/B,OAAO,CAAC,eAAe,CAEzB,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,GACzB,cAAc,MAAM,EACpB,IAAI,MAAM,EACV,MAAM,MAAM,EACZ,OAAO,MAAM,EACb,MAAM,MAAM,EACZ,MAAM,kBAAkB,GAAG,MAAM,EACjC,gBAAgB,cAAc,KAC/B,OAAO,CAAC,eAAe,CAEzB,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,GAAI,WAAW,MAAM,KAAG,OAAO,CAAC,eAAe,CAEhF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,GAAI,MAAM,kBAAkB,GAAG,MAAM,KAAG,OAAO,CAAC,eAAe,EAAE,CAEpG,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,GAAI,cAAc,MAAM,EAAE,OAAO,CAAC,kBAAkB,GAAG,MAAM,CAAC,EAAE,KAAG,OAAO,CAAC,eAAe,EAAE,CAE/H,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GAAI,OAAO,MAAM,KAAG,OAAO,CAAC,mBAAmB,CAEjF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,GAAI,OAAO,MAAM,KAAG,OAAO,CAAC,uBAAuB,EAAE,CAExF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,IAAI,MAAM,KAAG,OAAO,CAAC,IAAI,CAE7D,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B,GAAI,OAAO,MAAM,EAAE,SAAS,MAAM,KAAG,OAAO,CAAC,oBAAoB,EAAE,CAE5G,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B,GACrC,WAAW,MAAM,EACjB,SAAS,MAAM,EACf,MAAM,cAAc,EACpB,WAAW,OAAO,EAClB,uBAAuB,qBAAqB,EAC5C,gBAAgB,OAAO,KACxB,OAAO,CAAC,IAAI,CAEd,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,2BAA2B,GACpC,WAAW,MAAM,EACjB,QAAQ,MAAM,EACd,MAAM,cAAc,EACpB,WAAW,OAAO,EAClB,uBAAuB,qBAAqB,KAC7C,OAAO,CAAC,IAAI,CAEd,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,2BAA2B,GACpC,WAAW,MAAM,EACjB,QAAQ,MAAM,EACd,MAAM,cAAc,EACpB,WAAW,OAAO,EAClB,uBAAuB,qBAAqB,KAC7C,OAAO,CAAC,IAAI,CAEd,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,GAAI,IAAI,MAAM,EAAE,OAAO,MAAM,KAAG,OAAO,CAAC,IAAI,CAEjF,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAAI,IAAI,MAAM,EAAE,gBAAgB,MAAM,EAAE,eAAe,MAAM,KAAG,OAAO,CAAC,IAAI,CAEzG,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,GACtB,gBAAgB,MAAM,EACtB,SAAS,MAAM,EACf,UAAU,MAAM,EAChB,SAAS,MAAM,EACf,KAAK,MAAM,EACX,SAAS,MAAM,KAChB,OAAO,CAAC,MAAM,CAEhB,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,GACtB,OAAO,MAAM,EACb,UAAU,MAAM,EAChB,SAAS,MAAM,EACf,KAAK,MAAM,EACX,SAAS,MAAM,KAChB,OAAO,CAAC,IAAI,CAEd,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB,GAChC,MAAM,MAAM,EACZ,OAAO,MAAM,EACb,MAAM,MAAM,EACZ,OAAO,MAAM,EACb,MAAM,MAAM,KACb,OAAO,CAAC,MAAM,CAEhB,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,oBAAoB,GAC7B,UAAU,MAAM,EAChB,IAAI,MAAM,EACV,MAAM,MAAM,EACZ,OAAO,MAAM,EACb,MAAM,MAAM,EACZ,OAAO,MAAM,EACb,MAAM,kBAAkB,GAAG,MAAM,KAClC,OAAO,CAAC,eAAe,CAEzB,CAAA"}