@logicflow/extension 1.2.4 → 1.2.6

package/cjs/bpmn-adapter/index.js

@@ -40,7 +40,7 @@ var __read = (this && this.__read) || function (o, n) {
     return ar;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BpmnXmlAdapter = exports.BpmnAdapter = void 0;
+exports.toNormalJson = exports.toXmlJson = exports.BpmnXmlAdapter = exports.BpmnAdapter = void 0;
 var bpmnIds_1 = require("./bpmnIds");
 var json2xml_1 = require("./json2xml");
 var xml2json_1 = require("./xml2json");
@@ -54,30 +54,62 @@ var BpmnElements;
     BpmnElements["SYSTEM"] = "bpmn:serviceTask";
     BpmnElements["FLOW"] = "bpmn:sequenceFlow";
 })(BpmnElements || (BpmnElements = {}));
-var defaultAttrs = ['-name', '-id', 'bpmn:incoming', 'bpmn:outgoing', '-sourceRef', '-targetRef'];
+var defaultAttrs = [
+    '-name',
+    '-id',
+    'bpmn:incoming',
+    'bpmn:outgoing',
+    '-sourceRef',
+    '-targetRef',
+];
 /**
  * 将普通json转换为xmlJson
  * xmlJson中property会以“-”开头
  * 如果没有“-”表示为子节点
+ * fix issue https://github.com/didi/LogicFlow/issues/718, contain the process of #text/#cdata and array
+ * @param retainedFields retainedField会和默认的defaultRetainedFields:
+ * ["properties", "startPoint", "endPoint", "pointsList"]合并
+ * 这意味着出现在这个数组里的字段当它的值是数组或是对象时不会被视为一个节点而是一个属性
+ * @reference node type reference https://www.w3schools.com/xml/dom_nodetype.asp
  */
-function toXmlJson(json) {
-    var xmlJson = {};
-    Object.entries(json).forEach(function (_a) {
-        var _b = __read(_a, 2), key = _b[0], value = _b[1];
-        if (typeof value !== 'object') {
-            if (key.indexOf('-') === 0) { // 如果本来就是“-”开头的了，那就不处理了。
-                xmlJson[key] = value;
+var defaultRetainedFields = ['properties', 'startPoint', 'endPoint', 'pointsList'];
+function toXmlJson(retainedFields) {
+    var fields = retainedFields
+        ? defaultRetainedFields.concat(retainedFields) : defaultRetainedFields;
+    return function (json) {
+        function ToXmlJson(obj) {
+            var xmlJson = {};
+            if (typeof obj === 'string') {
+                return obj;
             }
-            else {
-                xmlJson["-" + key] = value;
+            if (Array.isArray(obj)) {
+                return obj.map(function (j) { return ToXmlJson(j); });
             }
+            Object.entries(obj).forEach(function (_a) {
+                var _b = __read(_a, 2), key = _b[0], value = _b[1];
+                if (typeof value !== 'object') {
+                    // node type reference https://www.w3schools.com/xml/dom_nodetype.asp
+                    if (key.indexOf('-') === 0
+                        || ['#text', '#cdata-section', '#comment'].includes(key)) {
+                        xmlJson[key] = value;
+                    }
+                    else {
+                        xmlJson["-" + key] = value;
+                    }
+                }
+                else if (fields.includes(key)) {
+                    xmlJson["-" + key] = ToXmlJson(value);
+                }
+                else {
+                    xmlJson[key] = ToXmlJson(value);
+                }
+            });
+            return xmlJson;
         }
-        else {
-            xmlJson[key] = toXmlJson(value);
-        }
-    });
-    return xmlJson;
+        return ToXmlJson(json);
+    };
 }
+exports.toXmlJson = toXmlJson;
 /**
  * 将xmlJson转换为普通的json，在内部使用。
  */
@@ -85,23 +117,26 @@ function toNormalJson(xmlJson) {
     var json = {};
     Object.entries(xmlJson).forEach(function (_a) {
         var _b = __read(_a, 2), key = _b[0], value = _b[1];
-        if (typeof value === 'string') {
-            if (key.indexOf('-') === 0) { // 如果本来就是“-”开头的了，那就不处理了。
-                json[key.substr(1)] = value;
-            }
-            else {
-                json[key] = value;
-            }
+        if (key.indexOf('-') === 0) {
+            json[key.substring(1)] = json2xml_1.handleAttributes(value);
         }
-        else if (typeof value === 'object') {
+        else if (typeof value === 'string') {
+            json[key] = value;
+        }
+        else if (Object.prototype.toString.call(value) === '[object Object]') {
             json[key] = toNormalJson(value);
         }
+        else if (Array.isArray(value)) {
+            // contain the process of array
+            json[key] = value.map(function (v) { return toNormalJson(v); });
+        }
         else {
             json[key] = value;
         }
     });
     return json;
 }
+exports.toNormalJson = toNormalJson;
 /**
  * 设置bpmn process信息
  * 目标格式请参考examples/bpmn.json
@@ -110,7 +145,7 @@ function toNormalJson(xmlJson) {
  * 2）如果只有一个子元素，json中表示为正常属性
  * 3）如果是多个子元素，json中使用数组存储
  */
-function convertLf2ProcessData(bpmnProcessData, data) {
+function convertLf2ProcessData(bpmnProcessData, data, retainedFields) {
     var nodeMap = new Map();
     data.nodes.forEach(function (node) {
         var _a;
@@ -121,21 +156,20 @@ function convertLf2ProcessData(bpmnProcessData, data) {
             processNode['-name'] = node.text.value;
         }
         if (node.properties) {
-            var properties = toXmlJson(node.properties);
+            var properties = toXmlJson(retainedFields)(node.properties);
             Object.assign(processNode, properties);
         }
         nodeMap.set(node.id, processNode);
         if (!bpmnProcessData[node.type]) {
             bpmnProcessData[node.type] = processNode; // 如果只有一个子元素，json中表示为正常属性
         }
-        else if (Array.isArray(bpmnProcessData[node.type])) { // 如果是多个子元素，json中使用数组存储
+        else if (Array.isArray(bpmnProcessData[node.type])) {
+            // 如果是多个子元素，json中使用数组存储
             bpmnProcessData[node.type].push(processNode);
         }
-        else { // 如果是多个子元素，json中使用数组存储
-            bpmnProcessData[node.type] = [
-                bpmnProcessData[node.type],
-                processNode,
-            ];
+        else {
+            // 如果是多个子元素，json中使用数组存储
+            bpmnProcessData[node.type] = [bpmnProcessData[node.type], processNode];
         }
     });
     var sequenceFlow = data.edges.map(function (edge) {
@@ -148,10 +182,7 @@ function convertLf2ProcessData(bpmnProcessData, data) {
             targetNode['bpmn:incoming'].push(edge.id);
         }
         else {
-            targetNode['bpmn:incoming'] = [
-                targetNode['bpmn:incoming'],
-                edge.id,
-            ];
+            targetNode['bpmn:incoming'] = [targetNode['bpmn:incoming'], edge.id];
         }
         var edgeConfig = {
             '-id': edge.id,
@@ -162,7 +193,7 @@ function convertLf2ProcessData(bpmnProcessData, data) {
             edgeConfig['-name'] = (_b = edge.text) === null || _b === void 0 ? void 0 : _b.value;
         }
         if (edge.properties) {
-            var properties = toXmlJson(edge.properties);
+            var properties = toXmlJson(retainedFields)(edge.properties);
             Object.assign(edgeConfig, properties);
         }
         return edgeConfig;
@@ -177,11 +208,9 @@ function convertLf2ProcessData(bpmnProcessData, data) {
         else if (Array.isArray(sourceNode['bpmn:outgoing'])) {
             sourceNode['bpmn:outgoing'].push(edge.id);
         }
-        else { // 字符串转数组
-            sourceNode['bpmn:outgoing'] = [
-                sourceNode['bpmn:outgoing'],
-                edge.id,
-            ];
+        else {
+            // 字符串转数组
+            sourceNode['bpmn:outgoing'] = [sourceNode['bpmn:outgoing'], edge.id];
         }
     });
     bpmnProcessData[BpmnElements.FLOW] = sequenceFlow;
@@ -195,7 +224,10 @@ function convertLf2DiagramData(bpmnDiagramData, data) {
         var edgeId = edge.id;
         var pointsList = edge.pointsList.map(function (_a) {
             var x = _a.x, y = _a.y;
-            return ({ '-x': x, '-y': y });
+            return ({
+                '-x': x,
+                '-y': y,
+            });
         });
         var diagramData = {
             '-id': edgeId + "_di",
@@ -281,7 +313,8 @@ function convertBpmn2LfData(bpmnData) {
 }
 function getLfNodes(value, shapes, key) {
     var nodes = [];
-    if (Array.isArray(value)) { // 数组
+    if (Array.isArray(value)) {
+        // 数组
         value.forEach(function (val) {
             var shapeValue;
             if (Array.isArray(shapes)) {
@@ -337,7 +370,8 @@ function getNodeConfig(shapeValue, type, processValue) {
             value: name,
         };
         // 自定义文本位置
-        if (shapeValue['bpmndi:BPMNLabel'] && shapeValue['bpmndi:BPMNLabel']['dc:Bounds']) {
+        if (shapeValue['bpmndi:BPMNLabel']
+            && shapeValue['bpmndi:BPMNLabel']['dc:Bounds']) {
             var textBounds = shapeValue['bpmndi:BPMNLabel']['dc:Bounds'];
             text.x = Number(textBounds['-x']) + Number(textBounds['-width']) / 2;
             text.y = Number(textBounds['-y']) + Number(textBounds['-height']) / 2;
@@ -432,9 +466,14 @@ var BpmnAdapter = /** @class */ (function () {
     function BpmnAdapter(_a) {
         var _this = this;
         var lf = _a.lf;
-        this.adapterOut = function (data) {
+        /**
+         * @param retainedFields?: string[] (可选)属性保留字段，retainedField会和默认的defaultRetainedFields:
+         * ["properties", "startPoint", "endPoint", "pointsList"]合并，
+         * 这意味着出现在这个数组里的字段当它的值是数组或是对象时不会被视为一个节点而是一个属性。
+         */
+        this.adapterOut = function (data, retainedFields) {
             var bpmnProcessData = __assign({}, _this.processAttributes);
-            convertLf2ProcessData(bpmnProcessData, data);
+            convertLf2ProcessData(bpmnProcessData, data, retainedFields);
             var bpmnDiagramData = {
                 '-id': 'BPMNPlane_1',
                 '-bpmnElement': bpmnProcessData['-id'],
@@ -457,7 +496,7 @@ var BpmnAdapter = /** @class */ (function () {
             }
         };
         lf.adapterIn = function (data) { return _this.adapterIn(data); };
-        lf.adapterOut = function (data) { return _this.adapterOut(data); };
+        lf.adapterOut = function (data, retainedFields) { return _this.adapterOut(data, retainedFields); };
         this.processAttributes = {
             '-isExecutable': 'true',
             '-id': "Process_" + bpmnIds_1.getBpmnId(),
@@ -510,8 +549,8 @@ var BpmnXmlAdapter = /** @class */ (function (_super) {
             var json = xml2json_1.lfXml2Json(bpmnData);
             return _this.adapterIn(json);
         };
-        _this.adapterXmlOut = function (data) {
-            var outData = _this.adapterOut(data);
+        _this.adapterXmlOut = function (data, retainedFields) {
+            var outData = _this.adapterOut(data, retainedFields);
             return json2xml_1.lfJson2Xml(outData);
         };
         var lf = data.lf;

package/cjs/bpmn-adapter/json2xml.js

@@ -1,62 +1,94 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lfJson2Xml = void 0;
-/**
- * This work is licensed under Creative Commons GNU LGPL License.
- * License:
- * Version: 0.9
- * Author:  Stefan Goessner/2006
- * Web:     http://goessner.net/
- */
-function addIndSpace(ind, deep) {
-    for (var i = 0; i < deep; i++) {
-        ind += '  ';
-    }
-    return ind;
+exports.handleAttributes = exports.lfJson2Xml = void 0;
+function type(obj) {
+    return Object.prototype.toString.call(obj);
 }
-function toXml(v, name, ind, deep) {
-    var xml = "";
-    if (v instanceof Array) {
-        for (var i = 0, n = v.length; i < n; i++) {
-            xml += addIndSpace(ind, deep) + toXml(v[i], name, ind, deep + 1);
+function addSpace(depth) {
+    return "  ".repeat(depth);
+}
+function handleAttributes(o) {
+    var t = o;
+    if (type(o) === "[object Object]") {
+        t = {};
+        Object.keys(o).forEach(function (k) {
+            var tk = k;
+            if (k.charAt(0) === "-") {
+                tk = k.substring(1);
+            }
+            t[tk] = handleAttributes(o[k]);
+        });
+    }
+    else if (Array.isArray(o)) {
+        t = [];
+        o.forEach(function (item, index) {
+            t[index] = handleAttributes(item);
+        });
+    }
+    return t;
+}
+exports.handleAttributes = handleAttributes;
+;
+function getAttributes(obj) {
+    var tmp = obj;
+    try {
+        if (typeof tmp !== "string") {
+            tmp = JSON.parse(obj);
         }
     }
-    else if (typeof (v) == "object") {
-        var hasChild = false;
-        xml += addIndSpace(ind, deep) + "<" + name;
-        for (var m in v) {
-            if (m.charAt(0) == "-")
-                xml += " " + m.substr(1) + "=\"" + v[m].toString() + "\"";
-            else
-                hasChild = true;
+    catch (error) {
+        tmp = JSON.stringify(handleAttributes(obj)).replace(/"/g, "'");
+    }
+    return tmp;
+}
+var tn = "\t\n";
+// @see issue https://github.com/didi/LogicFlow/issues/718, refactoring of function toXml
+function toXml(obj, name, depth) {
+    var frontSpace = addSpace(depth);
+    var str = "";
+    if (name === "#text") {
+        return tn + frontSpace + obj;
+    }
+    else if (name === "#cdata-section") {
+        return tn + frontSpace + "<![CDATA[" + obj + "]]>";
+    }
+    else if (name === "#comment") {
+        return tn + frontSpace + "<!--" + obj + "-->";
+    }
+    if (("" + name).charAt(0) === "-") {
+        return " " + name.substring(1) + '="' + getAttributes(obj) + '"';
+    }
+    else {
+        if (Array.isArray(obj)) {
+            obj.forEach(function (item) {
+                str += toXml(item, name, depth + 1);
+            });
         }
-        xml += hasChild ? ">" : " />";
-        if (hasChild) {
-            for (var m in v) {
-                if (m == "#text")
-                    xml += v[m];
-                else if (m == "#cdata")
-                    xml += "<![CDATA[" + v[m] + "]]>";
-                else if (m.charAt(0) != "-")
-                    xml += toXml(v[m], m, ind, deep + 1);
-            }
-            xml += addIndSpace(ind, deep) + "</" + name + ">";
+        else if (type(obj) === "[object Object]") {
+            var keys = Object.keys(obj);
+            var attributes_1 = "";
+            var children_1 = "";
+            str += (depth === 0 ? "" : tn + frontSpace) + "<" + name;
+            keys.forEach(function (k) {
+                k.charAt(0) === "-"
+                    ? (attributes_1 += toXml(obj[k], k, depth + 1))
+                    : (children_1 += toXml(obj[k], k, depth + 1));
+            });
+            str +=
+                attributes_1 +
+                    (children_1 !== "" ? ">" + children_1 + (tn + frontSpace) + "</" + name + ">" : " />");
         }
         else {
-            // xml += addIndSpace(ind, deep);
+            str += tn + frontSpace + ("<" + name + ">" + obj.toString() + "</" + name + ">");
         }
     }
-    else {
-        xml += addIndSpace(ind, deep) + "<" + name + ">" + v.toString() + "</" + name + ">";
-    }
-    return xml;
+    return str;
 }
-;
 function lfJson2Xml(o) {
-    var xmlStr = "";
+    var xmlStr = "<LogicFlow>\t\n";
     for (var m in o) {
-        xmlStr += toXml(o[m], m, "\t\n", 0);
+        xmlStr += toXml(o[m], m, 0);
     }
-    return xmlStr;
+    return xmlStr + "\t\n</LogicFlow>";
 }
 exports.lfJson2Xml = lfJson2Xml;

package/cjs/bpmn-adapter/xml2json.js

@@ -106,35 +106,43 @@ XML.ObjTree.prototype.parseDOM = function (root) {
         tmp[root.nodeName] = json; // root nodeName  
         json = tmp;
     }
-    return json;
+    return json["LogicFlow"];
 };
 //  method: parseElement( element )  
+/**
+ * @reference node type reference https://www.w3schools.com/xml/dom_nodetype.asp
+ */
 XML.ObjTree.prototype.parseElement = function (elem) {
-    //  COMMENT_NODE  
+    //  PROCESSING_INSTRUCTION_NODE  
     if (elem.nodeType == 7) {
         return;
     }
-    //  TEXT_NODE CDATA_SECTION_NODE  
-    if (elem.nodeType == 3 || elem.nodeType == 4) {
+    //  TEXT_NODE CDATA_SECTION_NODE COMMENT_NODE
+    if (elem.nodeType == 3 || elem.nodeType == 4 || elem.nodeType == 8) {
         var bool = elem.nodeValue.match(/[^\x00-\x20]/);
         if (bool == null)
             return; // ignore white spaces  
         return elem.nodeValue;
     }
-    var retVal;
+    var retVal = null;
     var cnt = {};
-    //  parse attributes  
     if (elem.attributes && elem.attributes.length) {
         retVal = {};
         for (var i = 0; i < elem.attributes.length; i++) {
             var key = elem.attributes[i].nodeName;
-            if (typeof (key) != "string")
+            if (typeof key != "string")
                 continue;
             var val = elem.attributes[i].nodeValue;
+            try {
+                val = JSON.parse(elem.attributes[i].nodeValue.replace(/'/g, '"'));
+            }
+            catch (error) {
+                val = elem.attributes[i].nodeValue;
+            }
             if (!val)
                 continue;
             key = this.attr_prefix + key;
-            if (typeof (cnt[key]) == "undefined")
+            if (typeof cnt[key] == "undefined")
                 cnt[key] = 0;
             cnt[key]++;
             this.addNode(retVal, key, cnt[key], val);
@@ -147,7 +155,7 @@ XML.ObjTree.prototype.parseElement = function (elem) {
             textOnly = false; // some attributes exists  
         for (var i = 0; i < elem.childNodes.length && textOnly; i++) {
             var nType = elem.childNodes[i].nodeType;
-            if (nType == 3 || nType == 4)
+            if (nType == 3 || nType == 4 || nType == 8)
                 continue;
             textOnly = false;
         }
@@ -175,6 +183,12 @@ XML.ObjTree.prototype.parseElement = function (elem) {
             }
         }
     }
+    else {
+        // @see issue https://github.com/didi/LogicFlow/issues/1068
+        // if retVal is null, that means the elem doesn't have any attributes and children, 
+        // the elem would be like: <a /> or <a></a>, so set retVal to empty object {}
+        retVal === null && (retVal = {});
+    }
     return retVal;
 };
 //  method: addNode( hash, key, count, value )  

package/cjs/insert-node-in-polyline/index.js

@@ -21,6 +21,7 @@ var __spread = (this && this.__spread) || function () {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InsertNodeInPolyline = void 0;
+var core_1 = require("@logicflow/core");
 var lodash_es_1 = require("lodash-es");
 var edge_1 = require("./edge");
 var InsertNodeInPolyline = /** @class */ (function () {
@@ -61,24 +62,53 @@ var InsertNodeInPolyline = /** @class */ (function () {
             });
         }
     };
+    /**
+     * 插入节点前校验规则
+     * @param sourceNodeId
+     * @param targetNodeId
+     * @param sourceAnchorId
+     * @param targetAnchorId
+     * @param nodeData
+     */
+    // fix: https://github.com/didi/LogicFlow/issues/1078
+    InsertNodeInPolyline.prototype.checkRuleBeforeInsetNode = function (sourceNodeId, targetNodeId, sourceAnchorId, targetAnchorId, nodeData) {
+        var sourceNodeModel = this._lf.getNodeModelById(sourceNodeId);
+        var targetNodeModel = this._lf.getNodeModelById(targetNodeId);
+        var sourceAnchorInfo = sourceNodeModel.getAnchorInfo(sourceAnchorId);
+        var targetAnchorInfo = targetNodeModel.getAnchorInfo(targetAnchorId);
+        var sourceRuleResultData = sourceNodeModel.isAllowConnectedAsSource(nodeData, sourceAnchorInfo, targetAnchorInfo);
+        var targetRuleResultData = targetNodeModel.isAllowConnectedAsTarget(nodeData, sourceAnchorInfo, targetAnchorInfo);
+        var _a = core_1.formateAnchorConnectValidateData(sourceRuleResultData), isSourcePass = _a.isAllPass, sourceMsg = _a.msg;
+        var _b = core_1.formateAnchorConnectValidateData(targetRuleResultData), isTargetPass = _b.isAllPass, targetMsg = _b.msg;
+        return {
+            isPass: isSourcePass && isTargetPass,
+            sourceMsg: sourceMsg,
+            targetMsg: targetMsg,
+        };
+    };
     InsertNodeInPolyline.prototype.insetNode = function (nodeData) {
+        var _this = this;
         var edges = this._lf.graphModel.edges;
         var nodeModel = this._lf.getNodeModelById(nodeData.id);
         for (var i = 0; i < edges.length; i++) {
             // eslint-disable-next-line max-len
             var _a = edge_1.isNodeInSegment(nodeModel, edges[i], this.deviation), crossIndex = _a.crossIndex, crossPoints = _a.crossPoints;
             if (crossIndex >= 0) {
-                var _b = edges[i], sourceNodeId = _b.sourceNodeId, targetNodeId = _b.targetNodeId, id = _b.id, type = _b.type, pointsList = _b.pointsList;
+                var _b = edges[i], sourceNodeId = _b.sourceNodeId, targetNodeId = _b.targetNodeId, id = _b.id, type = _b.type, pointsList = _b.pointsList, sourceAnchorId = _b.sourceAnchorId, targetAnchorId = _b.targetAnchorId;
                 // fix https://github.com/didi/LogicFlow/issues/996
                 var startPoint = lodash_es_1.cloneDeep(pointsList[0]);
                 var endPoint = lodash_es_1.cloneDeep(crossPoints.startCrossPoint);
+                this._lf.deleteEdge(id);
+                var checkResult = this.checkRuleBeforeInsetNode(sourceNodeId, targetNodeId, sourceAnchorId, targetAnchorId, nodeData);
                 this._lf.addEdge({
                     type: type,
                     sourceNodeId: sourceNodeId,
                     targetNodeId: nodeData.id,
                     startPoint: startPoint,
                     endPoint: endPoint,
-                    pointsList: __spread(pointsList.slice(0, crossIndex), [crossPoints.startCrossPoint]),
+                    pointsList: __spread(pointsList.slice(0, crossIndex), [
+                        crossPoints.startCrossPoint,
+                    ]),
                 });
                 this._lf.addEdge({
                     type: type,
@@ -86,10 +116,24 @@ var InsertNodeInPolyline = /** @class */ (function () {
                     targetNodeId: targetNodeId,
                     startPoint: lodash_es_1.cloneDeep(crossPoints.endCrossPoint),
                     endPoint: lodash_es_1.cloneDeep(pointsList[pointsList.length - 1]),
-                    pointsList: __spread([crossPoints.endCrossPoint], pointsList.slice(crossIndex)),
+                    pointsList: __spread([
+                        crossPoints.endCrossPoint
+                    ], pointsList.slice(crossIndex)),
                 });
-                this._lf.deleteEdge(id);
-                break;
+                if (!checkResult.isPass) {
+                    this._lf.graphModel.eventCenter.emit(core_1.EventType.CONNECTION_NOT_ALLOWED, {
+                        data: nodeData,
+                        msg: checkResult.targetMsg || checkResult.sourceMsg,
+                    });
+                    // FIXME:在关闭了历史记录的情况下，撤销操作会不生效。
+                    setTimeout(function () {
+                        _this._lf.undo();
+                    }, 200);
+                    break;
+                }
+                else {
+                    break;
+                }
             }
         }
     };

package/es/bpmn-adapter/index.d.ts

@@ -1,3 +1,8 @@
+declare function toXmlJson(retainedFields?: string[]): (json: string | any[] | Object) => any;
+/**
+ * 将xmlJson转换为普通的json，在内部使用。
+ */
+declare function toNormalJson(xmlJson: any): {};
 declare class BpmnAdapter {
     static pluginName: string;
     static shapeConfigMap: Map<any, any>;
@@ -21,7 +26,12 @@ declare class BpmnAdapter {
         lf: any;
     });
     setCustomShape(key: any, val: any): void;
-    adapterOut: (data: any) => {
+    /**
+     * @param retainedFields?: string[] (可选)属性保留字段，retainedField会和默认的defaultRetainedFields:
+     * ["properties", "startPoint", "endPoint", "pointsList"]合并，
+     * 这意味着出现在这个数组里的字段当它的值是数组或是对象时不会被视为一个节点而是一个属性。
+     */
+    adapterOut: (data: any, retainedFields?: string[]) => {
         'bpmn:definitions': {
             [key: string]: any;
             "-id": string;
@@ -47,7 +57,7 @@ declare class BpmnXmlAdapter extends BpmnAdapter {
         nodes: any[];
         edges: any[];
     };
-    adapterXmlOut: (data: any) => string;
+    adapterXmlOut: (data: any, retainedFields?: string[]) => string;
 }
-export { BpmnAdapter, BpmnXmlAdapter, };
+export { BpmnAdapter, BpmnXmlAdapter, toXmlJson, toNormalJson };
 export default BpmnAdapter;