node-opcua-modeler 2.96.0 → 2.98.1

package/dist/displayNodeElement.js

@@ -1,221 +1,221 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.displayNodeElement = void 0;
-const node_opcua_address_space_1 = require("node-opcua-address-space");
-const node_opcua_data_model_1 = require("node-opcua-data-model");
-const node_opcua_nodeid_1 = require("node-opcua-nodeid");
-const node_opcua_variant_1 = require("node-opcua-variant");
-const tableHelper_1 = require("./tableHelper");
-const a = "ⓂⓄⓋⓥⓇ❗⟵	⟶⟷";
-function symbol(nodeClass) {
-    switch (nodeClass) {
-        case node_opcua_data_model_1.NodeClass.DataType:
-            return "Ⓓ";
-        case node_opcua_data_model_1.NodeClass.ObjectType:
-            return "ⓄT";
-        case node_opcua_data_model_1.NodeClass.VariableType:
-            return "ⓋT";
-        case node_opcua_data_model_1.NodeClass.Method:
-            return "Ⓜ";
-        case node_opcua_data_model_1.NodeClass.Object:
-            return "Ⓞ";
-        case node_opcua_data_model_1.NodeClass.Variable:
-            return "Ⓥ";
-        case node_opcua_data_model_1.NodeClass.View:
-            return "⦖";
-        default:
-            return "?";
-    }
-}
-const hasSubtypeNodeId = (0, node_opcua_nodeid_1.resolveNodeId)("HasSubtype");
-function encodeXML(s) {
-    return s.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;");
-}
-function _dumpReferenceVariable(v, value, dataType) {
-    const val = v.readValue().value.value;
-    if (v.dataType.isEmpty()) {
-        return { value, dataType };
-    }
-    if (v.isExtensionObject()) {
-        // don't do anything
-    }
-    else if (v.isEnumeration() && val !== null) {
-        const enumValue = v.readEnumValue();
-        value = enumValue.value + " (" + enumValue.name + ")";
-    }
-    else if (val instanceof Date) {
-        value = val ? val.toUTCString() : "";
-    }
-    else {
-        value = val ? val.toString() : "null";
-    }
-    const actualDataType = node_opcua_variant_1.DataType[v.readValue().value.dataType];
-    const basicDataType = node_opcua_variant_1.DataType[v.dataTypeObj.basicDataType];
-    dataType = v.dataTypeObj.browseName.toString();
-    if (basicDataType !== dataType) {
-        dataType = dataType + "(" + basicDataType + ")";
-    }
-    return { value, dataType };
-}
-function getTypeDefinitionAsText(node) {
-    if (node.nodeClass === node_opcua_data_model_1.NodeClass.Object || node.nodeClass === node_opcua_data_model_1.NodeClass.Variable)
-        return node.typeDefinitionObj.browseName.toString() || "";
-    return "";
-}
-// eslint-disable-next-line complexity
-function dumpReference(data, ref, options) {
-    (0, node_opcua_address_space_1.resolveReferenceNode)(data.node.addressSpace, ref);
-    if (!ref.isForward) {
-        return;
-    }
-    if (node_opcua_nodeid_1.NodeId.sameNodeId(ref.referenceType, hasSubtypeNodeId)) {
-        return; // ignore forward HasSubtype
-    }
-    // ignore subtype references
-    /* istanbul ignore next */
-    if (!ref.node) {
-        // tslint:disable-next-line: no-console
-        console.log(" Halt ", ref.toString({ addressSpace: data.node.addressSpace }));
-        return;
-    }
-    const dir = ref.isForward ? " " : " ";
-    const refNode = ref.node;
-    const refType = (0, node_opcua_address_space_1.resolveReferenceType)(data.node.addressSpace, ref);
-    if (options && options.filter && refType.browseName.name !== options.filter) {
-        return;
-    }
-    const key = ref.nodeId.toString() + ref.referenceType.toString();
-    if (data.alreadyDumped[key]) {
-        return;
-    }
-    // xx const r = refNode.findReferencesAsObject("HasModellingRule", true);
-    const modelingRule = refNode.modellingRule || ""; //  r[0] ? r[0].browseName.toString() : "/";
-    let value = "";
-    let dataType = "";
-    if (refNode.nodeClass === node_opcua_data_model_1.NodeClass.Variable) {
-        const v = refNode;
-        const t = _dumpReferenceVariable(v, value, dataType);
-        value = t.value;
-        dataType = t.dataType;
-        // findBasicDataType(v.dataTypeObj);
-    }
-    const prefix = options.prefix ? options.prefix + "." : "";
-    const row = [
-        "".padEnd(prefix.length) + refType.browseName.toString() + dir + symbol(refNode.nodeClass),
-        refNode.nodeId.toString(),
-        encodeXML(prefix + refNode.browseName.toString()),
-        modelingRule,
-        getTypeDefinitionAsText(refNode),
-        dataType,
-        value
-    ];
-    data.table.push(row);
-    data.descriptions.push({
-        description: refNode.description ? refNode.description.text || "" : "",
-        name: refNode.browseName.name,
-        type: dataType
-    });
-    // now push all children if there are any
-    if (options.recursive) {
-        const subReferences = refNode.findReferencesEx("HasChild", node_opcua_data_model_1.BrowseDirection.Forward);
-        if (subReferences.length) {
-            // xx console.log("refNode ", refNode.nodeId.toString(), refNode.toString());
-            const rowMidHeader = [encodeXML(prefix + refNode.browseName.toString()), "", "", "", "", "", ""];
-            data.table.push(rowMidHeader);
-            for (const subReference of subReferences) {
-                dumpReference(data, subReference, Object.assign(Object.assign({}, options), { prefix: prefix + refNode.browseName.toString(), recursive: false, filter: undefined }));
-            }
-        }
-    }
-    data.alreadyDumped[key] = 1;
-}
-function dumpReferences(data, _references, options) {
-    // xx for (const ref of references) {
-    // xx  dumpReference(ref, "HasSubtype");
-    // xx }
-    for (const ref of _references) {
-        dumpReference(data, ref, { filter: "HasTypeDefinition" });
-    }
-    for (const ref of _references) {
-        dumpReference(data, ref, { filter: "HasEncoding" });
-    }
-    for (const ref of _references) {
-        dumpReference(data, ref, Object.assign(Object.assign({}, options), { filter: "HasComponent" }));
-    }
-    for (const ref of _references) {
-        dumpReference(data, ref, Object.assign(Object.assign({}, options), { filter: "HasProperty" }));
-    }
-    for (const ref of _references) {
-        dumpReference(data, ref, Object.assign(Object.assign({}, options), { filter: "Organizes" }));
-    }
-    for (const ref of _references) {
-        dumpReference(data, ref, { filter: "HasInterface" });
-    }
-    for (const ref of _references) {
-        dumpReference(data, ref, {});
-    }
-    /// subElements = [];
-}
-function shortDescription(d) {
-    return d.split(/\.|\n/)[0];
-}
-function displayNodeElement(node, options) {
-    const recursive = options && options.recursive !== undefined ? !!options.recursive : true;
-    const head = ["ReferenceType", "NodeId", "BrowseName", "ModellingRule", "TypeDefinition", "DataType", "Value"];
-    function createTable() {
-        const table = new tableHelper_1.TableHelper(head);
-        table.push(["BrowseName: ", { colSpan: 6, content: node.browseName.toString() }]);
-        const superType = node.subtypeOfObj;
-        if (superType) {
-            table.push(["Base", superType.browseName.toString(), { colSpan: 6, content: node.browseName.toString() }]);
-        }
-        if (node.description) {
-            table.push(["Description", { colspan: 6, content: shortDescription(node.description.text || "") }]);
-        }
-        return table;
-    }
-    const table = createTable();
-    const alreadyDumped = {};
-    const descriptions = [];
-    const references = node.allReferences();
-    const data = { table, node, alreadyDumped, descriptions };
-    dumpReferences(data, references, { recursive });
-    function toText(table) {
-        if (options && options.format === "markdown") {
-            return table.toMarkdownTable();
-        }
-        else {
-            return table.toString();
-        }
-    }
-    const str = [];
-    const tables = [];
-    tables.push(table);
-    if (node.description) {
-        str.push(node.description.text || "");
-        str.push("");
-    }
-    str.push(toText(table));
-    const str2 = [];
-    // add property from base object/variable type
-    if (node.nodeClass === node_opcua_data_model_1.NodeClass.ObjectType || node.nodeClass === node_opcua_data_model_1.NodeClass.VariableType) {
-        const curNode = node;
-        let subtypeOf = curNode.subtypeOfObj;
-        while (subtypeOf) {
-            data.table = createTable();
-            data.table.push([subtypeOf.browseName.toString() + ":", "--", "--", "--"]);
-            const references2 = subtypeOf.allReferences();
-            dumpReferences(data, references2, { recursive: false });
-            str.push("<details>");
-            str.push("<summary>Base type: " + subtypeOf.browseName.toString() + "</summary>");
-            str.push("");
-            str.push(toText(data.table));
-            str.push("");
-            str2.push("</details>");
-            subtypeOf = subtypeOf.subtypeOfObj;
-        }
-    }
-    return str.join("\n") + str2.join("\n");
-}
-exports.displayNodeElement = displayNodeElement;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.displayNodeElement = void 0;
+const node_opcua_address_space_1 = require("node-opcua-address-space");
+const node_opcua_data_model_1 = require("node-opcua-data-model");
+const node_opcua_nodeid_1 = require("node-opcua-nodeid");
+const node_opcua_variant_1 = require("node-opcua-variant");
+const tableHelper_1 = require("./tableHelper");
+const a = "ⓂⓄⓋⓥⓇ❗⟵	⟶⟷";
+function symbol(nodeClass) {
+    switch (nodeClass) {
+        case node_opcua_data_model_1.NodeClass.DataType:
+            return "Ⓓ";
+        case node_opcua_data_model_1.NodeClass.ObjectType:
+            return "ⓄT";
+        case node_opcua_data_model_1.NodeClass.VariableType:
+            return "ⓋT";
+        case node_opcua_data_model_1.NodeClass.Method:
+            return "Ⓜ";
+        case node_opcua_data_model_1.NodeClass.Object:
+            return "Ⓞ";
+        case node_opcua_data_model_1.NodeClass.Variable:
+            return "Ⓥ";
+        case node_opcua_data_model_1.NodeClass.View:
+            return "⦖";
+        default:
+            return "?";
+    }
+}
+const hasSubtypeNodeId = (0, node_opcua_nodeid_1.resolveNodeId)("HasSubtype");
+function encodeXML(s) {
+    return s.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;");
+}
+function _dumpReferenceVariable(v, value, dataType) {
+    const val = v.readValue().value.value;
+    if (v.dataType.isEmpty()) {
+        return { value, dataType };
+    }
+    if (v.isExtensionObject()) {
+        // don't do anything
+    }
+    else if (v.isEnumeration() && val !== null) {
+        const enumValue = v.readEnumValue();
+        value = enumValue.value + " (" + enumValue.name + ")";
+    }
+    else if (val instanceof Date) {
+        value = val ? val.toUTCString() : "";
+    }
+    else {
+        value = val ? val.toString() : "null";
+    }
+    const actualDataType = node_opcua_variant_1.DataType[v.readValue().value.dataType];
+    const basicDataType = node_opcua_variant_1.DataType[v.dataTypeObj.basicDataType];
+    dataType = v.dataTypeObj.browseName.toString();
+    if (basicDataType !== dataType) {
+        dataType = dataType + "(" + basicDataType + ")";
+    }
+    return { value, dataType };
+}
+function getTypeDefinitionAsText(node) {
+    if (node.nodeClass === node_opcua_data_model_1.NodeClass.Object || node.nodeClass === node_opcua_data_model_1.NodeClass.Variable)
+        return node.typeDefinitionObj.browseName.toString() || "";
+    return "";
+}
+// eslint-disable-next-line complexity
+function dumpReference(data, ref, options) {
+    (0, node_opcua_address_space_1.resolveReferenceNode)(data.node.addressSpace, ref);
+    if (!ref.isForward) {
+        return;
+    }
+    if (node_opcua_nodeid_1.NodeId.sameNodeId(ref.referenceType, hasSubtypeNodeId)) {
+        return; // ignore forward HasSubtype
+    }
+    // ignore subtype references
+    /* istanbul ignore next */
+    if (!ref.node) {
+        // tslint:disable-next-line: no-console
+        console.log(" Halt ", ref.toString({ addressSpace: data.node.addressSpace }));
+        return;
+    }
+    const dir = ref.isForward ? " " : " ";
+    const refNode = ref.node;
+    const refType = (0, node_opcua_address_space_1.resolveReferenceType)(data.node.addressSpace, ref);
+    if (options && options.filter && refType.browseName.name !== options.filter) {
+        return;
+    }
+    const key = ref.nodeId.toString() + ref.referenceType.toString();
+    if (data.alreadyDumped[key]) {
+        return;
+    }
+    // xx const r = refNode.findReferencesAsObject("HasModellingRule", true);
+    const modelingRule = refNode.modellingRule || ""; //  r[0] ? r[0].browseName.toString() : "/";
+    let value = "";
+    let dataType = "";
+    if (refNode.nodeClass === node_opcua_data_model_1.NodeClass.Variable) {
+        const v = refNode;
+        const t = _dumpReferenceVariable(v, value, dataType);
+        value = t.value;
+        dataType = t.dataType;
+        // findBasicDataType(v.dataTypeObj);
+    }
+    const prefix = options.prefix ? options.prefix + "." : "";
+    const row = [
+        "".padEnd(prefix.length) + refType.browseName.toString() + dir + symbol(refNode.nodeClass),
+        refNode.nodeId.toString(),
+        encodeXML(prefix + refNode.browseName.toString()),
+        modelingRule,
+        getTypeDefinitionAsText(refNode),
+        dataType,
+        value
+    ];
+    data.table.push(row);
+    data.descriptions.push({
+        description: refNode.description ? refNode.description.text || "" : "",
+        name: refNode.browseName.name,
+        type: dataType
+    });
+    // now push all children if there are any
+    if (options.recursive) {
+        const subReferences = refNode.findReferencesEx("HasChild", node_opcua_data_model_1.BrowseDirection.Forward);
+        if (subReferences.length) {
+            // xx console.log("refNode ", refNode.nodeId.toString(), refNode.toString());
+            const rowMidHeader = [encodeXML(prefix + refNode.browseName.toString()), "", "", "", "", "", ""];
+            data.table.push(rowMidHeader);
+            for (const subReference of subReferences) {
+                dumpReference(data, subReference, Object.assign(Object.assign({}, options), { prefix: prefix + refNode.browseName.toString(), recursive: false, filter: undefined }));
+            }
+        }
+    }
+    data.alreadyDumped[key] = 1;
+}
+function dumpReferences(data, _references, options) {
+    // xx for (const ref of references) {
+    // xx  dumpReference(ref, "HasSubtype");
+    // xx }
+    for (const ref of _references) {
+        dumpReference(data, ref, { filter: "HasTypeDefinition" });
+    }
+    for (const ref of _references) {
+        dumpReference(data, ref, { filter: "HasEncoding" });
+    }
+    for (const ref of _references) {
+        dumpReference(data, ref, Object.assign(Object.assign({}, options), { filter: "HasComponent" }));
+    }
+    for (const ref of _references) {
+        dumpReference(data, ref, Object.assign(Object.assign({}, options), { filter: "HasProperty" }));
+    }
+    for (const ref of _references) {
+        dumpReference(data, ref, Object.assign(Object.assign({}, options), { filter: "Organizes" }));
+    }
+    for (const ref of _references) {
+        dumpReference(data, ref, { filter: "HasInterface" });
+    }
+    for (const ref of _references) {
+        dumpReference(data, ref, {});
+    }
+    /// subElements = [];
+}
+function shortDescription(d) {
+    return d.split(/\.|\n/)[0];
+}
+function displayNodeElement(node, options) {
+    const recursive = options && options.recursive !== undefined ? !!options.recursive : true;
+    const head = ["ReferenceType", "NodeId", "BrowseName", "ModellingRule", "TypeDefinition", "DataType", "Value"];
+    function createTable() {
+        const table = new tableHelper_1.TableHelper(head);
+        table.push(["BrowseName: ", { colSpan: 6, content: node.browseName.toString() }]);
+        const superType = node.subtypeOfObj;
+        if (superType) {
+            table.push(["Base", superType.browseName.toString(), { colSpan: 6, content: node.browseName.toString() }]);
+        }
+        if (node.description) {
+            table.push(["Description", { colspan: 6, content: shortDescription(node.description.text || "") }]);
+        }
+        return table;
+    }
+    const table = createTable();
+    const alreadyDumped = {};
+    const descriptions = [];
+    const references = node.allReferences();
+    const data = { table, node, alreadyDumped, descriptions };
+    dumpReferences(data, references, { recursive });
+    function toText(table) {
+        if (options && options.format === "markdown") {
+            return table.toMarkdownTable();
+        }
+        else {
+            return table.toString();
+        }
+    }
+    const str = [];
+    const tables = [];
+    tables.push(table);
+    if (node.description) {
+        str.push(node.description.text || "");
+        str.push("");
+    }
+    str.push(toText(table));
+    const str2 = [];
+    // add property from base object/variable type
+    if (node.nodeClass === node_opcua_data_model_1.NodeClass.ObjectType || node.nodeClass === node_opcua_data_model_1.NodeClass.VariableType) {
+        const curNode = node;
+        let subtypeOf = curNode.subtypeOfObj;
+        while (subtypeOf) {
+            data.table = createTable();
+            data.table.push([subtypeOf.browseName.toString() + ":", "--", "--", "--"]);
+            const references2 = subtypeOf.allReferences();
+            dumpReferences(data, references2, { recursive: false });
+            str.push("<details>");
+            str.push("<summary>Base type: " + subtypeOf.browseName.toString() + "</summary>");
+            str.push("");
+            str.push(toText(data.table));
+            str.push("");
+            str2.push("</details>");
+            subtypeOf = subtypeOf.subtypeOfObj;
+        }
+    }
+    return str.join("\n") + str2.join("\n");
+}
+exports.displayNodeElement = displayNodeElement;
 //# sourceMappingURL=displayNodeElement.js.map

package/dist/generate_markdown_doc.d.ts

@@ -1,41 +1,41 @@
-import { BaseNode, INamespace, UADataType, UAObjectType, UAReferenceType, UAVariableType } from "node-opcua-address-space";
-export interface IWriter {
-    writeLine(_str: string): void;
-}
-export declare class Writer implements IWriter {
-    private readonly stream;
-    constructor();
-    writeLine(str: string): void;
-    toString(): string;
-}
-export interface BuildDocumentationOptions {
-    node?: BaseNode;
-    dumpGraphics?: (writer: IWriter, type: UAObjectType | UAVariableType) => void;
-}
-export declare function buildDocumentationToString(namespace: INamespace, options?: BuildDocumentationOptions): Promise<string>;
-export declare function extractTypes(namespace: INamespace, options?: BuildDocumentationOptions): {
-    dataTypes: UADataType[];
-    variableTypes: UAVariableType[];
-    objectTypes: UAObjectType[];
-    referenceTypes: UAReferenceType[];
-    dataTypeNode?: undefined;
-} | {
-    dataTypes: UADataType[];
-    variableTypes: never[];
-    objectTypes: never[];
-    dataTypeNode: never[];
-    referenceTypes: never[];
-} | {
-    dataTypes: never[];
-    variableTypes: never[];
-    objectTypes: UAObjectType[];
-    dataTypeNode: never[];
-    referenceTypes: never[];
-} | {
-    dataTypes: never[];
-    variableTypes: UAVariableType[];
-    objectTypes: never[];
-    dataTypeNode: never[];
-    referenceTypes: never[];
-};
-export declare function buildDocumentation(namespace: INamespace, writer: IWriter, options?: BuildDocumentationOptions): Promise<void>;
+import { BaseNode, INamespace, UADataType, UAObjectType, UAReferenceType, UAVariableType } from "node-opcua-address-space";
+export interface IWriter {
+    writeLine(_str: string): void;
+}
+export declare class Writer implements IWriter {
+    private readonly stream;
+    constructor();
+    writeLine(str: string): void;
+    toString(): string;
+}
+export interface BuildDocumentationOptions {
+    node?: BaseNode;
+    dumpGraphics?: (writer: IWriter, type: UAObjectType | UAVariableType) => void;
+}
+export declare function buildDocumentationToString(namespace: INamespace, options?: BuildDocumentationOptions): Promise<string>;
+export declare function extractTypes(namespace: INamespace, options?: BuildDocumentationOptions): {
+    dataTypes: UADataType[];
+    variableTypes: UAVariableType[];
+    objectTypes: UAObjectType[];
+    referenceTypes: UAReferenceType[];
+    dataTypeNode?: undefined;
+} | {
+    dataTypes: UADataType[];
+    variableTypes: never[];
+    objectTypes: never[];
+    dataTypeNode: never[];
+    referenceTypes: never[];
+} | {
+    dataTypes: never[];
+    variableTypes: never[];
+    objectTypes: UAObjectType[];
+    dataTypeNode: never[];
+    referenceTypes: never[];
+} | {
+    dataTypes: never[];
+    variableTypes: UAVariableType[];
+    objectTypes: never[];
+    dataTypeNode: never[];
+    referenceTypes: never[];
+};
+export declare function buildDocumentation(namespace: INamespace, writer: IWriter, options?: BuildDocumentationOptions): Promise<void>;