node-opcua-modeler 2.64.1 → 2.65.0

package/distNodeJS/build_documentation_to_file.js

@@ -1,27 +1,27 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildDocumentationToFile = void 0;
-const fs = require("fs");
-const __1 = require("..");
-function buildDocumentationToFile(namespace, filename) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const str = yield (0, __1.buildDocumentationToString)(namespace);
-        const stream = fs.createWriteStream("documentation.md");
-        stream.write(str);
-        yield new Promise((resolve) => {
-            stream.on("finish", resolve);
-            stream.end();
-        });
-    });
-}
-exports.buildDocumentationToFile = buildDocumentationToFile;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildDocumentationToFile = void 0;
+const fs = require("fs");
+const __1 = require("..");
+function buildDocumentationToFile(namespace, filename, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const str = yield (0, __1.buildDocumentationToString)(namespace, options);
+        const stream = fs.createWriteStream("documentation.md");
+        stream.write(str);
+        yield new Promise((resolve) => {
+            stream.on("finish", resolve);
+            stream.end();
+        });
+    });
+}
+exports.buildDocumentationToFile = buildDocumentationToFile;
 //# sourceMappingURL=build_documentation_to_file.js.map

package/distNodeJS/build_documentation_to_file.js.map

@@ -1 +1 @@
-{"version":3,"file":"build_documentation_to_file.js","sourceRoot":"","sources":["../source_nodejs/build_documentation_to_file.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yBAAyB;AAEzB,0BAAgD;AAEhD,SAAsB,wBAAwB,CAAC,SAAoB,EAAE,QAAgB;;QACjF,MAAM,GAAG,GAAG,MAAM,IAAA,8BAA0B,EAAC,SAAS,CAAC,CAAC;QACxD,MAAM,MAAM,GAAG,EAAE,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC1B,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC7B,MAAM,CAAC,GAAG,EAAE,CAAC;QACjB,CAAC,CAAC,CAAC;IACP,CAAC;CAAA;AARD,4DAQC"}
+{"version":3,"file":"build_documentation_to_file.js","sourceRoot":"","sources":["../source_nodejs/build_documentation_to_file.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yBAAyB;AAEzB,0BAA2E;AAE3E,SAAsB,wBAAwB,CAAC,SAAoB,EAAE,QAAgB,EAAE,OAAmC;;QACtH,MAAM,GAAG,GAAG,MAAM,IAAA,8BAA0B,EAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACjE,MAAM,MAAM,GAAG,EAAE,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC1B,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC7B,MAAM,CAAC,GAAG,EAAE,CAAC;QACjB,CAAC,CAAC,CAAC;IACP,CAAC;CAAA;AARD,4DAQC"}

package/distNodeJS/build_model.d.ts

@@ -1,7 +1,7 @@
-import { BuildModelOptionsBase } from "..";
-import { Symbols } from "..";
-export declare function buildModel(data: BuildModelOptionsBase): Promise<{
-    markdown: string;
-    xmlModel: string;
-    symbols: Symbols;
-}>;
+import { BuildModelOptionsBase } from "..";
+import { Symbols } from "..";
+export declare function buildModel(data: BuildModelOptionsBase): Promise<{
+    markdown: string;
+    xmlModel: string;
+    symbols: Symbols;
+}>;

package/distNodeJS/build_model.js

@@ -1,22 +1,22 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildModel = void 0;
-const nodeJS_1 = require("node-opcua-address-space/nodeJS");
-const __1 = require("..");
-function buildModel(data) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const option1 = Object.assign(Object.assign({}, data), { xmlLoader: nodeJS_1.readNodeSet2XmlFile });
-        return (0, __1.buildModelInner)(option1);
-    });
-}
-exports.buildModel = buildModel;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildModel = void 0;
+const nodeJS_1 = require("node-opcua-address-space/nodeJS");
+const __1 = require("..");
+function buildModel(data) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const option1 = Object.assign(Object.assign({}, data), { xmlLoader: nodeJS_1.readNodeSet2XmlFile });
+        return (0, __1.buildModelInner)(option1);
+    });
+}
+exports.buildModel = buildModel;
 //# sourceMappingURL=build_model.js.map

package/distNodeJS/index.d.ts

@@ -1,5 +1,5 @@
-export * from "./symbol_cvs";
-export * from "./build_model";
-export * from "./build_documentation_to_file";
-export * from "..";
-export { generateAddressSpace } from "node-opcua-address-space/nodeJS";
+export * from "./symbol_cvs";
+export * from "./build_model";
+export * from "./build_documentation_to_file";
+export * from "..";
+export { generateAddressSpace } from "node-opcua-address-space/nodeJS";

package/distNodeJS/index.js

@@ -1,20 +1,20 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateAddressSpace = void 0;
-__exportStar(require("./symbol_cvs"), exports);
-__exportStar(require("./build_model"), exports);
-__exportStar(require("./build_documentation_to_file"), exports);
-__exportStar(require(".."), exports);
-var nodeJS_1 = require("node-opcua-address-space/nodeJS");
-Object.defineProperty(exports, "generateAddressSpace", { enumerable: true, get: function () { return nodeJS_1.generateAddressSpace; } });
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateAddressSpace = void 0;
+__exportStar(require("./symbol_cvs"), exports);
+__exportStar(require("./build_model"), exports);
+__exportStar(require("./build_documentation_to_file"), exports);
+__exportStar(require(".."), exports);
+var nodeJS_1 = require("node-opcua-address-space/nodeJS");
+Object.defineProperty(exports, "generateAddressSpace", { enumerable: true, get: function () { return nodeJS_1.generateAddressSpace; } });
 //# sourceMappingURL=index.js.map

package/distNodeJS/symbol_cvs.d.ts

@@ -1,3 +1,3 @@
-import { Symbols } from "..";
-export declare function saveSymbolsToCSV(csvFilename: string, symbols: Symbols): Promise<void>;
-export declare function getPresetSymbolsFromCSV(csvFilename: string): Promise<Symbols>;
+import { Symbols } from "..";
+export declare function saveSymbolsToCSV(csvFilename: string, symbols: Symbols): Promise<void>;
+export declare function getPresetSymbolsFromCSV(csvFilename: string): Promise<Symbols>;

package/distNodeJS/symbol_cvs.js

@@ -1,64 +1,64 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPresetSymbolsFromCSV = exports.saveSymbolsToCSV = void 0;
-const fs = require("fs");
-const csv_parse_1 = require("csv-parse");
-const __1 = require("..");
-// node 14 onward : import { readFile, writeFile } from "fs/promises";
-const { readFile, writeFile } = fs.promises;
-function saveSymbolsToCSV(csvFilename, symbols) {
-    return __awaiter(this, void 0, void 0, function* () {
-        yield writeFile(csvFilename, (0, __1.toCSV)(symbols), "utf-8");
-    });
-}
-exports.saveSymbolsToCSV = saveSymbolsToCSV;
-function getPresetSymbolsFromCSV(csvFilename) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (!fs.existsSync(csvFilename)) {
-            return [];
-        }
-        try {
-            const data = yield readFile(csvFilename, "utf-8");
-            const records = yield new Promise((resolve) => {
-                const output = [];
-                (0, csv_parse_1.parse)(data, {
-                    cast: (value, context) => {
-                        if (context.index === 1) {
-                            return parseInt(value, 10);
-                        }
-                        return value;
-                    }
-                })
-                    .on("readable", function () {
-                    let record = this.read();
-                    while (record) {
-                        output.push(record);
-                        record = this.read();
-                    }
-                })
-                    .on("end", () => {
-                    resolve(output);
-                });
-            });
-            return records;
-        }
-        catch (err) {
-            if (err instanceof Error) {
-                // tslint:disable-next-line: no-console
-                console.log("getPresetSymbols err = ", err.message);
-            }
-            return [];
-        }
-    });
-}
-exports.getPresetSymbolsFromCSV = getPresetSymbolsFromCSV;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPresetSymbolsFromCSV = exports.saveSymbolsToCSV = void 0;
+const fs = require("fs");
+const csv_parse_1 = require("csv-parse");
+const __1 = require("..");
+// node 14 onward : import { readFile, writeFile } from "fs/promises";
+const { readFile, writeFile } = fs.promises;
+function saveSymbolsToCSV(csvFilename, symbols) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield writeFile(csvFilename, (0, __1.toCSV)(symbols), "utf-8");
+    });
+}
+exports.saveSymbolsToCSV = saveSymbolsToCSV;
+function getPresetSymbolsFromCSV(csvFilename) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!fs.existsSync(csvFilename)) {
+            return [];
+        }
+        try {
+            const data = yield readFile(csvFilename, "utf-8");
+            const records = yield new Promise((resolve) => {
+                const output = [];
+                (0, csv_parse_1.parse)(data, {
+                    cast: (value, context) => {
+                        if (context.index === 1) {
+                            return parseInt(value, 10);
+                        }
+                        return value;
+                    }
+                })
+                    .on("readable", function () {
+                    let record = this.read();
+                    while (record) {
+                        output.push(record);
+                        record = this.read();
+                    }
+                })
+                    .on("end", () => {
+                    resolve(output);
+                });
+            });
+            return records;
+        }
+        catch (err) {
+            if (err instanceof Error) {
+                // tslint:disable-next-line: no-console
+                console.log("getPresetSymbols err = ", err.message);
+            }
+            return [];
+        }
+    });
+}
+exports.getPresetSymbolsFromCSV = getPresetSymbolsFromCSV;
 //# sourceMappingURL=symbol_cvs.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-opcua-modeler",
-    "version": "2.64.1",
+    "version": "2.65.0",
     "description": "pure nodejs OPCUA SDK - module - model",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -15,10 +15,10 @@
         "chalk": "4.1.2",
         "cli-table3": "^0.6.1",
         "csv-parse": "5.0.4",
-        "node-opcua-address-space": "2.64.1",
+        "node-opcua-address-space": "2.65.0",
         "node-opcua-assert": "2.64.1",
         "node-opcua-basic-types": "2.64.1",
-        "node-opcua-client-dynamic-extension-object": "2.64.1",
+        "node-opcua-client-dynamic-extension-object": "2.65.0",
         "node-opcua-constants": "2.64.1",
         "node-opcua-data-model": "2.64.1",
         "node-opcua-factory": "2.64.1",
@@ -26,9 +26,9 @@
         "node-opcua-nodesets": "2.64.1",
         "node-opcua-numeric-range": "2.64.1",
         "node-opcua-schemas": "2.64.1",
-        "node-opcua-service-translate-browse-path": "2.64.1",
+        "node-opcua-service-translate-browse-path": "2.65.0",
         "node-opcua-status-code": "2.64.1",
-        "node-opcua-types": "2.64.1",
+        "node-opcua-types": "2.65.0",
         "node-opcua-variant": "2.64.1",
         "node-opcua-xml2json": "2.64.1"
     },
@@ -49,5 +49,5 @@
         "internet of things"
     ],
     "homepage": "http://node-opcua.github.io/",
-    "gitHead": "b65b8738603cd475d7d99a2b20b0ae9d32b4110c"
+    "gitHead": "59b9cae30fb45633ad501f9cf3b74fb9d05e8960"
 }

package/source/build_model_inner.ts

@@ -1,6 +1,4 @@
-import { 
-    AddressSpace, 
-    Namespace, NodeIdManager, XmlLoaderFunc, generateAddressSpaceRaw } from "node-opcua-address-space";
+import { AddressSpace, NodeIdManager, XmlLoaderAsyncFunc, generateAddressSpaceRaw } from "node-opcua-address-space";
 import { buildDocumentationToString } from "./generate_markdown_doc";
 import { Symbols } from "./symbol";
 
@@ -12,7 +10,7 @@ export interface BuildModelOptionsBase {
     presetSymbols?: Symbols;
 }
 export interface BuildModelOptions extends BuildModelOptionsBase {
-    xmlLoader: XmlLoaderFunc;
+    xmlLoader: XmlLoaderAsyncFunc;
 }
 
 export async function buildModelInner(data: BuildModelOptions): Promise<{ markdown: string; xmlModel: string; symbols: Symbols }> {
@@ -33,7 +31,7 @@ export async function buildModelInner(data: BuildModelOptions): Promise<{ markdo
 
         const xmlModel = ns.toNodeset2XML();
         const symbols = nodeIdManager.getSymbols();
-        const doc = await buildDocumentationToString(ns);
+        const doc = await buildDocumentationToString(ns, {});
         addressSpace.dispose();
 
         return { xmlModel, symbols, markdown: doc };

package/source/displayNodeElement.ts

@@ -147,7 +147,9 @@ function dumpReferences(data: Data, _references: UAReference[]) {
         dumpReference(data, ref, "Organizes");
     }
     for (const ref of _references) {
-        console.log(data.node!.addressSpace!.findReferenceType(ref.referenceType)!.toString());
+        dumpReference(data, ref, "HasInterface");
+    }
+    for (const ref of _references) {
         dumpReference(data, ref, undefined);
     }
 }
@@ -181,8 +183,6 @@ export function displayNodeElement(node: BaseNode, options?: DisplayNodeOptions)
 
     const references = node.allReferences();
 
-    const m = {};
-
     const data = { table, node, alreadyDumped, descriptions };
     dumpReferences(data, references);
 

package/source/generate_markdown_doc.ts

@@ -1,8 +1,7 @@
 /* eslint-disable max-statements */
 import {
     BaseNode,
-    dumpReferenceDescription,
-    Namespace,
+    INamespace,
     UADataType,
     UAObject,
     UAObjectType,
@@ -12,15 +11,13 @@ import {
 } from "node-opcua-address-space";
 import { coerceUInt32 } from "node-opcua-basic-types";
 import { NodeClass } from "node-opcua-data-model";
-import { NodeId } from "node-opcua-nodeid";
 import { StructureField } from "node-opcua-types";
 import { DataType } from "node-opcua-variant";
 
 import { displayNodeElement } from "./displayNodeElement";
 import { TableHelper } from "./tableHelper";
-import { dumpClassHierachry, graphVizToPlantUml, opcuaToDot } from "./to_graphivz";
 
-interface NamespacePriv2 {
+interface NamespacePriv2 extends INamespace {
     nodeIterator(): IterableIterator<BaseNode>;
     _objectTypeIterator(): IterableIterator<UAObjectType>;
     _objectTypeCount(): number;
@@ -33,14 +30,16 @@ interface NamespacePriv2 {
     _aliasCount(): number;
 }
 export interface IWriter {
-    writeLine(...args: any[]): void;
+    // eslint-disable-next-line no-unused-vars
+    writeLine(_str: string): void;
 }
-class Writer implements IWriter {
+
+export class Writer implements IWriter {
     private readonly stream: string[] = [];
     constructor() {
         /* empty */
     }
-    public writeLine(str: string) {
+    public writeLine(str: string): void {
         this.stream.push(str);
     }
     public toString(): string {
@@ -48,17 +47,18 @@ class Writer implements IWriter {
     }
 }
 
-export async function buildDocumentationToString(namespace: Namespace): Promise<string> {
+export interface BuildDocumentationOptions {
+    node?: BaseNode;
+
+    dumpGraphics? :(writer: IWriter, type: UAObjectType | UAVariableType)=>void;
+}
+
+export async function buildDocumentationToString(namespace: INamespace, options?: BuildDocumentationOptions): Promise<string> {
     const writer = new Writer();
-    await buildDocumentation(namespace, writer);
+    await buildDocumentation(namespace, writer, options);
     return writer.toString();
 }
 
-interface V {
-    valueRank?: number;
-    arrayDimensions?: number[];
-    dataType: NodeId;
-}
 const toDataTypeStr = (p: BaseNode): string => {
     if (p.nodeClass === NodeClass.Variable) {
         const v = p as UAVariable;
@@ -74,7 +74,6 @@ const toDataTypeStr = (p: BaseNode): string => {
     return "";
 };
 function dataTypeEnumerationToMarkdown(dataType: UADataType): string {
-    const addressSpace = dataType.addressSpace;
     const writer = new Writer();
 
     writer.writeLine("");
@@ -217,19 +216,73 @@ function dumpReferenceType(referenceType: UAReferenceType): string {
     writer.writeLine(str);
     return writer.toString();
 }
-export async function buildDocumentation(namespace: Namespace, writer: IWriter): Promise<void> {
-    const addressSpace = namespace.addressSpace;
+
+export function extractTypes(namespace: INamespace, options?: BuildDocumentationOptions) {
+    const namespacePriv = namespace as unknown as NamespacePriv2;
+    if (!options || !options.node) {
+        const dataTypes = [...namespacePriv._dataTypeIterator()];
+        const objectTypes = [...namespacePriv._objectTypeIterator()];
+        const variableTypes = [...namespacePriv._variableTypeIterator()];
+        const referenceTypes = [...namespacePriv._referenceTypeIterator()];
+        return { dataTypes, variableTypes, objectTypes, referenceTypes };
+    }
+    const node = options.node;
+
+    if (node.nodeClass === NodeClass.DataType) {
+        const dataTypes: UADataType[] = [];
+        let dataType = node as UADataType;
+        dataTypes.push(dataType);
+        while (dataType.subtypeOfObj && dataType.subtypeOfObj.nodeId.namespace === namespace.index) {
+            dataType = dataType.subtypeOfObj;
+            dataTypes.push(dataType);
+        }
+        return { dataTypes, variableTypes: [], objectTypes: [], dataTypeNode: [], referenceTypes: [] };
+    } else if (node.nodeClass === NodeClass.ObjectType) {
+        const objectTypes: UAObjectType[] = [];
+        let objectType = node as UAObjectType;
+        objectTypes.push(objectType);
+        while (objectType.subtypeOfObj && objectType.subtypeOfObj.nodeId.namespace === namespace.index) {
+            objectType = objectType.subtypeOfObj;
+            objectTypes.push(objectType);
+        }
+        return { dataTypes: [], variableTypes: [], objectTypes, dataTypeNode: [], referenceTypes: [] };
+    } else if (node.nodeClass === NodeClass.VariableType) {
+        const variableTypes: UAVariableType[] = [];
+        let variableType = node as UAVariableType;
+        variableTypes.push(variableType);
+        while (variableType.subtypeOfObj && variableType.subtypeOfObj.nodeId.namespace === namespace.index) {
+            variableType = variableType.subtypeOfObj;
+            variableTypes.push(variableType);
+        }
+        return { dataTypes: [], variableTypes, objectTypes: [], dataTypeNode: [], referenceTypes: [] };
+    }
+
+    const dataTypes = [...namespacePriv._dataTypeIterator()];
+    const objectTypes = [...namespacePriv._objectTypeIterator()];
+    const variableTypes = [...namespacePriv._variableTypeIterator()];
+    const referenceTypes = [...namespacePriv._referenceTypeIterator()];
+    return { dataTypes, variableTypes, objectTypes, referenceTypes };
+}
+
+export async function buildDocumentation(
+    namespace: INamespace,
+    writer: IWriter,
+    options?: BuildDocumentationOptions
+): Promise<void> {
+
+    options = options || {};
+    
+    const namespacePriv = namespace as unknown as NamespacePriv2;
 
     const namespaceUri = namespace.namespaceUri;
     // -------- Documentation
 
-    const nsIndex = addressSpace.getNamespaceIndex(namespaceUri);
+    const { dataTypes, objectTypes, variableTypes } = extractTypes(namespace, options);
 
     writer.writeLine("");
     writer.writeLine("# Namespace " + namespaceUri);
     writer.writeLine("");
 
-    const namespacePriv = namespace as unknown as NamespacePriv2;
     // -------------- writeReferences
     if (namespacePriv._referenceTypeCount() > 0) {
         writer.writeLine("");
@@ -240,32 +293,34 @@ export async function buildDocumentation(namespace: Namespace, writer: IWriter):
             dumpReferenceType(referenceType);
         }
     }
+
     function d(node: BaseNode): string {
         return node.description ? node.description!.text!.toString() : "";
     }
+
     // -------------- writeDataType
-    if (namespacePriv._dataTypeCount() > 0) {
+    if (dataTypes.length > 0) {
         writer.writeLine("");
         writer.writeLine("## DataTypes");
         writer.writeLine("");
-        for (const dataType of namespacePriv._dataTypeIterator()) {
+        for (const dataType of dataTypes) {
             writer.writeLine("\n\n### " + dataType.browseName.name!.toString());
             writer.writeLine("");
             writer.writeLine(dataTypeToMarkdown(dataType));
         }
     }
     // -------------- writeObjectType
-    if (namespacePriv._objectTypeCount() > 0) {
+    if (objectTypes.length > 0) {
         writer.writeLine("");
         writer.writeLine("## ObjectTypes");
         writer.writeLine("");
-        for (const objectType of namespacePriv._objectTypeIterator()) {
+        for (const objectType of objectTypes) {
             writer.writeLine("\n\n### " + objectType.browseName.name!.toString());
             writer.writeLine(d(objectType));
 
-            writer.writeLine(graphVizToPlantUml(dumpClassHierachry(objectType, { showBaseType: true, depth: 2 })));
-
-            writer.writeLine(graphVizToPlantUml(opcuaToDot(objectType)));
+            if (options.dumpGraphics) {
+                await options.dumpGraphics(writer, objectType);
+            }
 
             // enumerate components
             writer.writeLine(displayNodeElement(objectType, { format: "markdown" }));
@@ -283,19 +338,18 @@ export async function buildDocumentation(namespace: Namespace, writer: IWriter):
         }
     }
     // -------------- writeVariableType
-    if (namespacePriv._variableTypeCount() > 0) {
+    if (variableTypes.length > 0) {
         writer.writeLine("");
         writer.writeLine("## VariableTypes");
         writer.writeLine("");
-        for (const variableType of namespacePriv._variableTypeIterator()) {
+        for (const variableType of variableTypes) {
             writer.writeLine("\n\n### " + variableType.browseName.name!.toString());
             writer.writeLine(d(variableType));
             writer.writeLine("");
 
-            writer.writeLine(graphVizToPlantUml(dumpClassHierachry(variableType, { showBaseType: true, depth: 2 })));
-
-            writer.writeLine(graphVizToPlantUml(opcuaToDot(variableType)));
-
+            if (options.dumpGraphics) {
+                await options.dumpGraphics(writer, variableType);
+            }
             // enumerate components
             writer.writeLine(displayNodeElement(variableType, { format: "markdown" }));
             for (const reference of variableType.allReferences()) {
@@ -307,3 +361,4 @@ export async function buildDocumentation(namespace: Namespace, writer: IWriter):
         }
     }
 }
+

package/source/index.ts

@@ -6,8 +6,9 @@ export * from "./build_model_inner";
 export * from "./addExtensionObjectDataType";
 export * from "./symbol";
 export * from "./to_cvs";
-export * from "./to_graphivz";
 export * from "./generate_markdown_doc";
+export * from "./tableHelper";
+
 //
 export * from "node-opcua-address-space";
 export * from "node-opcua-nodesets";

package/source_nodejs/build_documentation_to_file.ts

@@ -1,9 +1,9 @@
 import * as fs from "fs";
 import { Namespace } from "node-opcua-address-space";
-import { buildDocumentationToString } from "..";
+import { BuildDocumentationOptions, buildDocumentationToString } from "..";
 
-export async function buildDocumentationToFile(namespace: Namespace, filename: string) {
-    const str = await buildDocumentationToString(namespace);
+export async function buildDocumentationToFile(namespace: Namespace, filename: string, options?: BuildDocumentationOptions) {
+    const str = await buildDocumentationToString(namespace, options);
     const stream = fs.createWriteStream("documentation.md");
     stream.write(str);
     await new Promise((resolve) => {