node-opcua-modeler 2.63.2 → 2.65.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/build_model_inner.d.ts +2 -2
- package/dist/build_model_inner.js +1 -1
- package/dist/build_model_inner.js.map +1 -1
- package/dist/displayNodeElement.js +25 -9
- package/dist/displayNodeElement.js.map +1 -1
- package/dist/dump_state_machine_to_graphviz.d.ts +6 -0
- package/dist/dump_state_machine_to_graphviz.js +120 -0
- package/dist/dump_state_machine_to_graphviz.js.map +1 -0
- package/dist/generate_markdown_doc.d.ts +39 -4
- package/dist/generate_markdown_doc.js +241 -79
- package/dist/generate_markdown_doc.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/to_graphivz.js +21 -9
- package/dist/to_graphivz.js.map +1 -1
- package/distNodeJS/build_documentation_to_file.d.ts +2 -1
- package/distNodeJS/build_documentation_to_file.js +2 -2
- package/distNodeJS/build_documentation_to_file.js.map +1 -1
- package/examples/make_model.ts +4 -3
- package/package.json +19 -19
- package/source/build_model_inner.ts +3 -5
- package/source/displayNodeElement.ts +27 -11
- package/source/generate_markdown_doc.ts +283 -91
- package/source/index.ts +2 -1
- package/source_nodejs/build_documentation_to_file.ts +3 -3
- package/source/to_graphivz.ts +0 -335
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AddressSpace,
|
|
1
|
+
import { AddressSpace, XmlLoaderAsyncFunc } from "node-opcua-address-space";
|
|
2
2
|
import { Symbols } from "./symbol";
|
|
3
3
|
export interface BuildModelOptionsBase {
|
|
4
4
|
version: string;
|
|
@@ -8,7 +8,7 @@ export interface BuildModelOptionsBase {
|
|
|
8
8
|
presetSymbols?: Symbols;
|
|
9
9
|
}
|
|
10
10
|
export interface BuildModelOptions extends BuildModelOptionsBase {
|
|
11
|
-
xmlLoader:
|
|
11
|
+
xmlLoader: XmlLoaderAsyncFunc;
|
|
12
12
|
}
|
|
13
13
|
export declare function buildModelInner(data: BuildModelOptions): Promise<{
|
|
14
14
|
markdown: string;
|
|
@@ -26,7 +26,7 @@ function buildModelInner(data) {
|
|
|
26
26
|
yield data.createModel(addressSpace);
|
|
27
27
|
const xmlModel = ns.toNodeset2XML();
|
|
28
28
|
const symbols = nodeIdManager.getSymbols();
|
|
29
|
-
const doc = yield (0, generate_markdown_doc_1.buildDocumentationToString)(ns);
|
|
29
|
+
const doc = yield (0, generate_markdown_doc_1.buildDocumentationToString)(ns, {});
|
|
30
30
|
addressSpace.dispose();
|
|
31
31
|
return { xmlModel, symbols, markdown: doc };
|
|
32
32
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"build_model_inner.js","sourceRoot":"","sources":["../source/build_model_inner.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,
|
|
1
|
+
{"version":3,"file":"build_model_inner.js","sourceRoot":"","sources":["../source/build_model_inner.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uEAAoH;AACpH,mEAAqE;AAcrE,SAAsB,eAAe,CAAC,IAAuB;;QACzD,IAAI;YACA,MAAM,YAAY,GAAG,uCAAY,CAAC,MAAM,EAAE,CAAC;YAE3C,wDAAwD;YACxD,MAAM,EAAE,GAAG,YAAY,CAAC,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAE7D,MAAM,aAAa,GAAI,EAAU,CAAC,cAA+B,CAAC;YAClE,IAAI,IAAI,CAAC,aAAa,EAAE;gBACpB,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;aAChD;YAED,MAAM,IAAA,kDAAuB,EAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAE3E,MAAM,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YAErC,MAAM,QAAQ,GAAG,EAAE,CAAC,aAAa,EAAE,CAAC;YACpC,MAAM,OAAO,GAAG,aAAa,CAAC,UAAU,EAAE,CAAC;YAC3C,MAAM,GAAG,GAAG,MAAM,IAAA,kDAA0B,EAAC,EAAE,EAAE,EAAE,CAAC,CAAC;YACrD,YAAY,CAAC,OAAO,EAAE,CAAC;YAEvB,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC;SAC/C;QAAC,OAAO,GAAG,EAAE;YACV,uCAAuC;YACvC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YAC1B,MAAM,GAAG,CAAC;SACb;IACL,CAAC;CAAA;AA3BD,0CA2BC"}
|
|
@@ -28,6 +28,9 @@ function symbol(nodeClass) {
|
|
|
28
28
|
}
|
|
29
29
|
}
|
|
30
30
|
const hasSubtypeNodeId = (0, node_opcua_nodeid_1.resolveNodeId)("HasSubtype");
|
|
31
|
+
function encodeXML(s) {
|
|
32
|
+
return s.replace("&", "&").replace("<", "<").replace(">", ">");
|
|
33
|
+
}
|
|
31
34
|
function dumpReference(data, ref, filter) {
|
|
32
35
|
(0, node_opcua_address_space_1.resolveReferenceNode)(data.node.addressSpace, ref);
|
|
33
36
|
if (!ref.isForward) {
|
|
@@ -47,11 +50,12 @@ function dumpReference(data, ref, filter) {
|
|
|
47
50
|
const refNode = ref.node;
|
|
48
51
|
const refType = (0, node_opcua_address_space_1.resolveReferenceType)(data.node.addressSpace, ref);
|
|
49
52
|
if (filter) {
|
|
50
|
-
if (refType.browseName.
|
|
53
|
+
if (refType.browseName.name !== filter) {
|
|
51
54
|
return;
|
|
52
55
|
}
|
|
53
56
|
}
|
|
54
|
-
|
|
57
|
+
const key = ref.nodeId.toString() + ref.referenceType.toString();
|
|
58
|
+
if (data.alreadyDumped[key]) {
|
|
55
59
|
return;
|
|
56
60
|
}
|
|
57
61
|
// xx const r = refNode.findReferencesAsObject("HasModellingRule", true);
|
|
@@ -85,7 +89,7 @@ function dumpReference(data, ref, filter) {
|
|
|
85
89
|
const row = [
|
|
86
90
|
refType.browseName.toString() + dir + symbol(refNode.nodeClass),
|
|
87
91
|
refNode.nodeId.toString(),
|
|
88
|
-
refNode.browseName.toString(),
|
|
92
|
+
encodeXML(refNode.browseName.toString()),
|
|
89
93
|
modelingRule,
|
|
90
94
|
refNode.typeDefinitionObj ? refNode.typeDefinitionObj.browseName.toString() : "",
|
|
91
95
|
dataType,
|
|
@@ -93,11 +97,11 @@ function dumpReference(data, ref, filter) {
|
|
|
93
97
|
];
|
|
94
98
|
data.table.push(row);
|
|
95
99
|
data.descriptions.push({
|
|
96
|
-
description: refNode.description ? refNode.description.
|
|
100
|
+
description: refNode.description ? refNode.description.text || "" : "",
|
|
97
101
|
name: refNode.browseName.name,
|
|
98
102
|
type: dataType
|
|
99
103
|
});
|
|
100
|
-
data.alreadyDumped[
|
|
104
|
+
data.alreadyDumped[key] = 1;
|
|
101
105
|
}
|
|
102
106
|
function dumpReferences(data, _references) {
|
|
103
107
|
// xx for (const ref of references) {
|
|
@@ -118,6 +122,15 @@ function dumpReferences(data, _references) {
|
|
|
118
122
|
for (const ref of _references) {
|
|
119
123
|
dumpReference(data, ref, "Organizes");
|
|
120
124
|
}
|
|
125
|
+
for (const ref of _references) {
|
|
126
|
+
dumpReference(data, ref, "HasInterface");
|
|
127
|
+
}
|
|
128
|
+
for (const ref of _references) {
|
|
129
|
+
dumpReference(data, ref, undefined);
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
function shortDescription(d) {
|
|
133
|
+
return d.split(/\.|\n/)[0];
|
|
121
134
|
}
|
|
122
135
|
function displayNodeElement(node, options) {
|
|
123
136
|
const head = ["ReferenceType", "NodeId", "BrowseName", "ModellingRule", "TypeDefinition", "DataType", "Value"];
|
|
@@ -129,7 +142,7 @@ function displayNodeElement(node, options) {
|
|
|
129
142
|
table.push(["Base", superType.browseName.toString(), { colSpan: 6, content: node.browseName.toString() }]);
|
|
130
143
|
}
|
|
131
144
|
if (node.description) {
|
|
132
|
-
table.push(["Description",
|
|
145
|
+
table.push(["Description", { colspan: 6, content: shortDescription(node.description.text || "") }]);
|
|
133
146
|
}
|
|
134
147
|
return table;
|
|
135
148
|
}
|
|
@@ -137,7 +150,6 @@ function displayNodeElement(node, options) {
|
|
|
137
150
|
const alreadyDumped = {};
|
|
138
151
|
const descriptions = [];
|
|
139
152
|
const references = node.allReferences();
|
|
140
|
-
const m = {};
|
|
141
153
|
const data = { table, node, alreadyDumped, descriptions };
|
|
142
154
|
dumpReferences(data, references);
|
|
143
155
|
function toText(table) {
|
|
@@ -151,6 +163,10 @@ function displayNodeElement(node, options) {
|
|
|
151
163
|
const str = [];
|
|
152
164
|
const tables = [];
|
|
153
165
|
tables.push(table);
|
|
166
|
+
if (node.description) {
|
|
167
|
+
str.push(node.description.text || "");
|
|
168
|
+
str.push("");
|
|
169
|
+
}
|
|
154
170
|
str.push(toText(table));
|
|
155
171
|
const str2 = [];
|
|
156
172
|
// add property from base object/variable type
|
|
@@ -159,13 +175,13 @@ function displayNodeElement(node, options) {
|
|
|
159
175
|
let subtypeOf = curNode.subtypeOfObj;
|
|
160
176
|
while (subtypeOf) {
|
|
161
177
|
data.table = createTable();
|
|
162
|
-
table.push([subtypeOf.browseName.toString() + ":", "--", "--", "--"]);
|
|
178
|
+
data.table.push([subtypeOf.browseName.toString() + ":", "--", "--", "--"]);
|
|
163
179
|
const references2 = subtypeOf.allReferences();
|
|
164
180
|
dumpReferences(data, references2);
|
|
165
181
|
str.push("<details>");
|
|
166
182
|
str.push("<summary>Base type: " + subtypeOf.browseName.toString() + "</summary>");
|
|
167
183
|
str.push("");
|
|
168
|
-
str.push(toText(table));
|
|
184
|
+
str.push(toText(data.table));
|
|
169
185
|
str.push("");
|
|
170
186
|
str2.push("</details>");
|
|
171
187
|
subtypeOf = subtypeOf.subtypeOfObj;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"displayNodeElement.js","sourceRoot":"","sources":["../source/displayNodeElement.ts"],"names":[],"mappings":";;;AAAA,uEAQkC;AAClC,iEAAkD;AAClD,yDAA0D;AAC1D,2DAA8C;AAC9C,+CAA4C;AAE5C,MAAM,CAAC,GAAG,YAAY,CAAC;AACvB,SAAS,MAAM,CAAC,SAAoB;IAChC,QAAQ,SAAS,EAAE;QACf,KAAK,iCAAS,CAAC,QAAQ;YACnB,OAAO,GAAG,CAAC;QACf,KAAK,iCAAS,CAAC,UAAU;YACrB,OAAO,IAAI,CAAC;QAChB,KAAK,iCAAS,CAAC,YAAY;YACvB,OAAO,IAAI,CAAC;QAChB,KAAK,iCAAS,CAAC,MAAM;YACjB,OAAO,GAAG,CAAC;QACf,KAAK,iCAAS,CAAC,MAAM;YACjB,OAAO,GAAG,CAAC;QACf,KAAK,iCAAS,CAAC,QAAQ;YACnB,OAAO,GAAG,CAAC;QACf,KAAK,iCAAS,CAAC,IAAI;YACf,OAAO,GAAG,CAAC;QACf;YACI,OAAO,GAAG,CAAC;KAClB;AACL,CAAC;AACD,MAAM,gBAAgB,GAAG,IAAA,iCAAa,EAAC,YAAY,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"displayNodeElement.js","sourceRoot":"","sources":["../source/displayNodeElement.ts"],"names":[],"mappings":";;;AAAA,uEAQkC;AAClC,iEAAkD;AAClD,yDAA0D;AAC1D,2DAA8C;AAC9C,+CAA4C;AAE5C,MAAM,CAAC,GAAG,YAAY,CAAC;AACvB,SAAS,MAAM,CAAC,SAAoB;IAChC,QAAQ,SAAS,EAAE;QACf,KAAK,iCAAS,CAAC,QAAQ;YACnB,OAAO,GAAG,CAAC;QACf,KAAK,iCAAS,CAAC,UAAU;YACrB,OAAO,IAAI,CAAC;QAChB,KAAK,iCAAS,CAAC,YAAY;YACvB,OAAO,IAAI,CAAC;QAChB,KAAK,iCAAS,CAAC,MAAM;YACjB,OAAO,GAAG,CAAC;QACf,KAAK,iCAAS,CAAC,MAAM;YACjB,OAAO,GAAG,CAAC;QACf,KAAK,iCAAS,CAAC,QAAQ;YACnB,OAAO,GAAG,CAAC;QACf,KAAK,iCAAS,CAAC,IAAI;YACf,OAAO,GAAG,CAAC;QACf;YACI,OAAO,GAAG,CAAC;KAClB;AACL,CAAC;AACD,MAAM,gBAAgB,GAAG,IAAA,iCAAa,EAAC,YAAY,CAAC,CAAC;AAKrD,SAAS,SAAS,CAAC,CAAS;IACxB,OAAO,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;AAC7E,CAAC;AAYD,SAAS,aAAa,CAAC,IAAU,EAAE,GAAgB,EAAE,MAAe;IAChE,IAAA,+CAAoB,EAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IAClD,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE;QAChB,OAAO;KACV;IACD,IAAI,0BAAM,CAAC,UAAU,CAAC,GAAG,CAAC,aAAa,EAAE,gBAAgB,CAAC,EAAE;QACxD,OAAO,CAAC,4BAA4B;KACvC;IACD,4BAA4B;IAC5B,0BAA0B;IAC1B,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE;QACX,uCAAuC;QACvC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;QAC9E,OAAO;KACV;IACD,MAAM,GAAG,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;IACtC,MAAM,OAAO,GAAG,GAAG,CAAC,IAAK,CAAC;IAE1B,MAAM,OAAO,GAAG,IAAA,+CAAoB,EAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IAClE,IAAI,MAAM,EAAE;QACR,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,KAAK,MAAM,EAAE;YACpC,OAAO;SACV;KACJ;IACD,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,GAAG,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;IACjE,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;QACzB,OAAO;KACV;IACD,yEAAyE;IACzE,MAAM,YAAY,GAAG,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,4CAA4C;IAE9F,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,IAAI,QAAQ,GAAG,EAAE,CAAC;IAClB,IAAI,OAAO,CAAC,SAAS,KAAK,iCAAS,CAAC,QAAQ,EAAE;QAC1C,MAAM,CAAC,GAAG,OAAqB,CAAC;QAEhC,MAAM,GAAG,GAAG,CAAC,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;QACtC,IAAI,CAAC,CAAC,iBAAiB,EAAE,EAAE;YACvB,oBAAoB;SACvB;aAAM,IAAI,CAAC,CAAC,aAAa,EAAE,IAAI,GAAG,KAAK,IAAI,EAAE;YAC1C,MAAM,SAAS,GAAG,CAAC,CAAC,aAAa,EAAE,CAAC;YACpC,KAAK,GAAG,SAAS,CAAC,KAAK,GAAG,IAAI,GAAG,SAAS,CAAC,IAAI,GAAG,GAAG,CAAC;SACzD;aAAM,IAAI,GAAG,YAAY,IAAI,EAAE;YAC5B,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACxC;aAAM;YACH,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;SACzC;QACD,MAAM,cAAc,GAAG,6BAAQ,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9D,MAAM,aAAa,GAAG,6BAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;QAC5D,QAAQ,GAAG,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;QAC/C,IAAI,aAAa,KAAK,QAAQ,EAAE;YAC5B,QAAQ,GAAG,QAAQ,GAAG,GAAG,GAAG,aAAa,GAAG,GAAG,CAAC;SACnD;QACD,oCAAoC;KACvC;IAED,MAAM,GAAG,GAAG;QACR,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC;QAC/D,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE;QACzB,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;QACxC,YAAY;QACX,OAAe,CAAC,iBAAiB,CAAC,CAAC,CAAE,OAAe,CAAC,iBAAiB,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE;QAClG,QAAQ;QACR,KAAK;KACR,CAAC;IAEF,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAErB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;QACnB,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE;QACtE,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,IAAK;QAC9B,IAAI,EAAE,QAAQ;KACjB,CAAC,CAAC;IACH,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAChC,CAAC;AACD,SAAS,cAAc,CAAC,IAAU,EAAE,WAA0B;IAC1D,qCAAqC;IACrC,wCAAwC;IACxC,OAAO;IACP,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE;QAC3B,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,CAAC,CAAC;KACjD;IACD,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE;QAC3B,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;KAC3C;IACD,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE;QAC3B,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,cAAc,CAAC,CAAC;KAC5C;IACD,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE;QAC3B,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;KAC3C;IACD,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE;QAC3B,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;KACzC;IACD,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE;QAC3B,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,cAAc,CAAC,CAAC;KAC5C;IACD,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE;QAC3B,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC;KACvC;AACL,CAAC;AAED,SAAS,gBAAgB,CAAC,CAAS;IAC/B,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/B,CAAC;AACD,SAAgB,kBAAkB,CAAC,IAAc,EAAE,OAA4B;IAC3E,MAAM,IAAI,GAAa,CAAC,eAAe,EAAE,QAAQ,EAAE,YAAY,EAAE,eAAe,EAAE,gBAAgB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAEzH,SAAS,WAAW;QAChB,MAAM,KAAK,GAAG,IAAI,yBAAW,CAAC,IAAI,CAAC,CAAC;QACpC,KAAK,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;QAElF,MAAM,SAAS,GAAI,IAAqB,CAAC,YAAY,CAAC;QACtD,IAAI,SAAS,EAAE;YACX,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;SAC9G;QAED,IAAI,IAAI,CAAC,WAAW,EAAE;YAClB,KAAK,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,IAAK,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;SACxG;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,KAAK,GAAG,WAAW,EAAE,CAAC;IAE5B,MAAM,aAAa,GAAwB,EAAE,CAAC;IAE9C,MAAM,YAAY,GAAkB,EAAE,CAAC;IAEvC,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;IAExC,MAAM,IAAI,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC;IAC1D,cAAc,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAEjC,SAAS,MAAM,CAAC,KAAkB;QAC9B,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,UAAU,EAAE;YAC1C,OAAO,KAAK,CAAC,eAAe,EAAE,CAAC;SAClC;aAAM;YACH,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;SAC3B;IACL,CAAC;IAED,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,MAAM,MAAM,GAAkB,EAAE,CAAC;IACjC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAEnB,IAAI,IAAI,CAAC,WAAW,EAAE;QAClB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAK,IAAI,EAAE,CAAC,CAAC;QACvC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;KAChB;IACD,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAExB,MAAM,IAAI,GAAa,EAAE,CAAC;IAE1B,8CAA8C;IAC9C,IAAI,IAAI,CAAC,SAAS,KAAK,iCAAS,CAAC,UAAU,IAAI,IAAI,CAAC,SAAS,KAAK,iCAAS,CAAC,YAAY,EAAE;QACtF,MAAM,OAAO,GAAG,IAAI,CAAC;QAErB,IAAI,SAAS,GAAI,OAAyC,CAAC,YAAY,CAAC;QACxE,OAAO,SAAS,EAAE;YACd,IAAI,CAAC,KAAK,GAAG,WAAW,EAAE,CAAC;YAC3B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;YAC3E,MAAM,WAAW,GAAG,SAAS,CAAC,aAAa,EAAE,CAAC;YAC9C,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YAElC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACtB,GAAG,CAAC,IAAI,CAAC,sBAAsB,GAAG,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,YAAY,CAAC,CAAC;YAClF,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACb,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7B,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACb,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAExB,SAAS,GAAI,SAA0B,CAAC,YAAY,CAAC;SACxD;KACJ;IACD,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5C,CAAC;AAvED,gDAuEC"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @module node-opcua-address-space
|
|
3
|
+
*/
|
|
4
|
+
import { UAStateMachineEx } from "node-opcua-address-space";
|
|
5
|
+
export declare function dumpStateMachineToPlantUML(stateMachineType: UAStateMachineEx): string;
|
|
6
|
+
export declare function dumpStateMachineToGraphViz(stateMachineType: UAStateMachineEx): string;
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.dumpStateMachineToGraphViz = exports.dumpStateMachineToPlantUML = void 0;
|
|
4
|
+
function dumpStateMachineToPlantUML(stateMachineType) {
|
|
5
|
+
const lines = [];
|
|
6
|
+
function w(str) {
|
|
7
|
+
lines.push(str);
|
|
8
|
+
}
|
|
9
|
+
function s(state) {
|
|
10
|
+
return state ? state.nodeId.value.toString() : "";
|
|
11
|
+
}
|
|
12
|
+
function n(state) {
|
|
13
|
+
return state ? state.browseName.name.toString() : "";
|
|
14
|
+
}
|
|
15
|
+
//w("@startuml "); // + stateMachineType.browseName.toString() + ".png");
|
|
16
|
+
// initial state if any
|
|
17
|
+
if (stateMachineType.initialState) {
|
|
18
|
+
w(" [*] --> " + s(stateMachineType.initialState));
|
|
19
|
+
w(" " + s(stateMachineType.initialState) + ":" + n(stateMachineType.initialState));
|
|
20
|
+
}
|
|
21
|
+
else {
|
|
22
|
+
w("[*] --> [*]");
|
|
23
|
+
}
|
|
24
|
+
function t(transition) {
|
|
25
|
+
let name = n(transition);
|
|
26
|
+
name = name.replace(":", "");
|
|
27
|
+
name = name.replace("To", "\\nTo\\n");
|
|
28
|
+
name = name.replace("Transition", "\\nTransition");
|
|
29
|
+
return name;
|
|
30
|
+
}
|
|
31
|
+
stateMachineType.states && stateMachineType.states.forEach((state) => w(" " + s(state) + ": " + n(state)));
|
|
32
|
+
stateMachineType.transitions && stateMachineType.transitions.forEach((transition) => w(" " + s(transition.fromStateNode) + " --> " + s(transition.toStateNode) + " : " + t(transition)));
|
|
33
|
+
// w("@enduml");
|
|
34
|
+
return lines.join("\n");
|
|
35
|
+
}
|
|
36
|
+
exports.dumpStateMachineToPlantUML = dumpStateMachineToPlantUML;
|
|
37
|
+
/*
|
|
38
|
+
@startuml
|
|
39
|
+
|
|
40
|
+
2930: Unshelved
|
|
41
|
+
|
|
42
|
+
2932: TimedShelved
|
|
43
|
+
|
|
44
|
+
2933: OneShotShelved
|
|
45
|
+
|
|
46
|
+
2930 --> 2932 : "2935\nUnshelvedToTimedShelved"
|
|
47
|
+
|
|
48
|
+
2930 --> 2933 : "2936\nUnshelvedToOneShotShelved"
|
|
49
|
+
|
|
50
|
+
2932 --> 2930 : "2940\nTimedShelvedToUnshelved"
|
|
51
|
+
|
|
52
|
+
2932 --> 2933 : "2942\nTimedShelvedToOneShotShelved"
|
|
53
|
+
|
|
54
|
+
2933 --> 2930 : "2943\nOneShotShelvedToUnshelved"
|
|
55
|
+
|
|
56
|
+
2933 --> 2932 : "2945\nOneShotShelvedToTimedShelved"
|
|
57
|
+
|
|
58
|
+
@enduml
|
|
59
|
+
|
|
60
|
+
*/
|
|
61
|
+
/*
|
|
62
|
+
digraph finite_state_machine {
|
|
63
|
+
rankdir=LR;
|
|
64
|
+
size="8,5"
|
|
65
|
+
node [shape = doublecircle]; LR_0 LR_3 LR_4 LR_8;
|
|
66
|
+
node [shape = circle];
|
|
67
|
+
LR_0 -> LR_2 [ label = "SS(B)" ];
|
|
68
|
+
LR_0 -> LR_1 [ label = "SS(S)" ];
|
|
69
|
+
LR_1 -> LR_3 [ label = "S($end)" ];
|
|
70
|
+
LR_2 -> LR_6 [ label = "SS(b)" ];
|
|
71
|
+
LR_2 -> LR_5 [ label = "SS(a)" ];
|
|
72
|
+
LR_2 -> LR_4 [ label = "S(A)" ];
|
|
73
|
+
LR_5 -> LR_7 [ label = "S(b)" ];
|
|
74
|
+
LR_5 -> LR_5 [ label = "S(a)" ];
|
|
75
|
+
LR_6 -> LR_6 [ label = "S(b)" ];
|
|
76
|
+
LR_6 -> LR_5 [ label = "S(a)" ];
|
|
77
|
+
LR_7 -> LR_8 [ label = "S(b)" ];
|
|
78
|
+
LR_7 -> LR_5 [ label = "S(a)" ];
|
|
79
|
+
LR_8 -> LR_6 [ label = "S(b)" ];
|
|
80
|
+
LR_8 -> LR_5 [ label = "S(a)" ];
|
|
81
|
+
}
|
|
82
|
+
*/
|
|
83
|
+
function dumpStateMachineToGraphViz(
|
|
84
|
+
/*StateMachineProxy*/
|
|
85
|
+
stateMachineType) {
|
|
86
|
+
const lines = [];
|
|
87
|
+
function w(str) {
|
|
88
|
+
lines.push(str);
|
|
89
|
+
}
|
|
90
|
+
function s(state) {
|
|
91
|
+
return state.nodeId.value.toString();
|
|
92
|
+
}
|
|
93
|
+
function n(state) {
|
|
94
|
+
return state.browseName.name.toString();
|
|
95
|
+
}
|
|
96
|
+
function s_full(state) {
|
|
97
|
+
return s(state) + ' [ label = "' + n(state) + '" ]';
|
|
98
|
+
}
|
|
99
|
+
w("digraph finite_state_machine {");
|
|
100
|
+
// initial state if any
|
|
101
|
+
if (stateMachineType.initialState) {
|
|
102
|
+
w("node [ shape = doublecircle];");
|
|
103
|
+
w(" _" + s_full(stateMachineType.initialState) + " ;");
|
|
104
|
+
}
|
|
105
|
+
w("node [ shape = circle];");
|
|
106
|
+
stateMachineType.states.forEach((state) => w(" _" + s_full(state)));
|
|
107
|
+
stateMachineType.transitions.forEach((transition) => w(" _" +
|
|
108
|
+
s(transition.fromStateNode) +
|
|
109
|
+
" -> _" +
|
|
110
|
+
s(transition.toStateNode) +
|
|
111
|
+
" [ " +
|
|
112
|
+
// " labeltooltip = \"" + i(transition) + "\" " +
|
|
113
|
+
', label = "' +
|
|
114
|
+
n(transition) +
|
|
115
|
+
'" ];'));
|
|
116
|
+
w("}");
|
|
117
|
+
return lines.join("\n");
|
|
118
|
+
}
|
|
119
|
+
exports.dumpStateMachineToGraphViz = dumpStateMachineToGraphViz;
|
|
120
|
+
//# sourceMappingURL=dump_state_machine_to_graphviz.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dump_state_machine_to_graphviz.js","sourceRoot":"","sources":["../source/dump_state_machine_to_graphviz.ts"],"names":[],"mappings":";;;AAuBA,SAAgB,0BAA0B,CAAC,gBAAkC;IAEzE,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,SAAS,CAAC,CAAC,GAAW;QAClB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpB,CAAC;IAED,SAAS,CAAC,CAAC,KAAe;QACtB,OAAO,KAAK,CAAA,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACrD,CAAC;IAED,SAAS,CAAC,CAAC,KAAe;QACtB,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,IAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1D,CAAC;IAEL,yEAAyE;IACrE,uBAAuB;IAEvB,IAAI,gBAAgB,CAAC,YAAY,EAAE;QAC/B,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;QAClD,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;KACtF;SAAM;QACH,CAAC,CAAC,aAAa,CAAC,CAAC;KACpB;IAED,SAAS,CAAC,CAAC,UAAoB;QAC3B,IAAI,IAAI,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC;QACzB,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAC7B,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACtC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,gBAAgB,CAAC,MAAM,IAAI,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAe,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAErH,gBAAgB,CAAC,WAAW,IAAI,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAA0B,EAAE,EAAE,CAChG,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,UAAU,CAAC,aAAc,CAAC,GAAG,OAAO,GAAG,CAAC,CAAC,UAAU,CAAC,WAAY,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CACxG,CAAC;IAEL,kBAAkB;IACf,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAE5B,CAAC;AA1CD,gEA0CC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,0BAA0B;AACtC,qBAAqB;AACrB,gBAAkC;IAElC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,SAAS,CAAC,CAAC,GAAW;QAClB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACnB,CAAC;IAED,SAAS,CAAC,CAAC,KAAe;QACtB,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;IACzC,CAAC;IAED,SAAS,CAAC,CAAC,KAAe;QACtB,OAAO,KAAK,CAAC,UAAU,CAAC,IAAK,CAAC,QAAQ,EAAE,CAAC;IAC7C,CAAC;IAED,SAAS,MAAM,CAAC,KAAe;QAC3B,OAAO,CAAC,CAAC,KAAK,CAAC,GAAG,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;IACxD,CAAC;IAED,CAAC,CAAC,gCAAgC,CAAC,CAAC;IACpC,uBAAuB;IAEvB,IAAI,gBAAgB,CAAC,YAAY,EAAE;QAC/B,CAAC,CAAC,+BAA+B,CAAC,CAAC;QACnC,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,gBAAgB,CAAC,YAAa,CAAC,GAAG,IAAI,CAAC,CAAC;KAC5D;IACD,CAAC,CAAC,yBAAyB,CAAC,CAAC;IAC7B,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAE/E,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAChD,CAAC,CACG,KAAK;QACD,CAAC,CAAC,UAAU,CAAC,aAAc,CAAC;QAC5B,OAAO;QACP,CAAC,CAAC,UAAU,CAAC,WAAY,CAAC;QAC1B,KAAK;QACL,mDAAmD;QACnD,aAAa;QACb,CAAC,CAAC,UAAU,CAAC;QACb,MAAM,CACb,CACJ,CAAC;IAEF,CAAC,CAAC,GAAG,CAAC,CAAC;IAEP,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAE5B,CAAC;AAjDD,gEAiDC"}
|
|
@@ -1,6 +1,41 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { BaseNode, INamespace, UADataType, UAObjectType, UAReferenceType, UAVariableType } from "node-opcua-address-space";
|
|
2
2
|
export interface IWriter {
|
|
3
|
-
writeLine(
|
|
3
|
+
writeLine(_str: string): void;
|
|
4
4
|
}
|
|
5
|
-
export declare
|
|
6
|
-
|
|
5
|
+
export declare class Writer implements IWriter {
|
|
6
|
+
private readonly stream;
|
|
7
|
+
constructor();
|
|
8
|
+
writeLine(str: string): void;
|
|
9
|
+
toString(): string;
|
|
10
|
+
}
|
|
11
|
+
export interface BuildDocumentationOptions {
|
|
12
|
+
node?: BaseNode;
|
|
13
|
+
dumpGraphics?: (writer: IWriter, type: UAObjectType | UAVariableType) => void;
|
|
14
|
+
}
|
|
15
|
+
export declare function buildDocumentationToString(namespace: INamespace, options?: BuildDocumentationOptions): Promise<string>;
|
|
16
|
+
export declare function extractTypes(namespace: INamespace, options?: BuildDocumentationOptions): {
|
|
17
|
+
dataTypes: UADataType[];
|
|
18
|
+
variableTypes: UAVariableType[];
|
|
19
|
+
objectTypes: UAObjectType[];
|
|
20
|
+
referenceTypes: UAReferenceType[];
|
|
21
|
+
dataTypeNode?: undefined;
|
|
22
|
+
} | {
|
|
23
|
+
dataTypes: UADataType[];
|
|
24
|
+
variableTypes: never[];
|
|
25
|
+
objectTypes: never[];
|
|
26
|
+
dataTypeNode: never[];
|
|
27
|
+
referenceTypes: never[];
|
|
28
|
+
} | {
|
|
29
|
+
dataTypes: never[];
|
|
30
|
+
variableTypes: never[];
|
|
31
|
+
objectTypes: UAObjectType[];
|
|
32
|
+
dataTypeNode: never[];
|
|
33
|
+
referenceTypes: never[];
|
|
34
|
+
} | {
|
|
35
|
+
dataTypes: never[];
|
|
36
|
+
variableTypes: UAVariableType[];
|
|
37
|
+
objectTypes: never[];
|
|
38
|
+
dataTypeNode: never[];
|
|
39
|
+
referenceTypes: never[];
|
|
40
|
+
};
|
|
41
|
+
export declare function buildDocumentation(namespace: INamespace, writer: IWriter, options?: BuildDocumentationOptions): Promise<void>;
|