node-opcua-address-space 2.98.0 → 2.98.2

package/dist/src/nodeset_tools/dump_to_bsd.js

@@ -0,0 +1,165 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dumpToBSD = void 0;
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_types_1 = require("node-opcua-types");
+const node_opcua_nodeid_1 = require("node-opcua-nodeid");
+const construct_namespace_dependency_1 = require("./construct_namespace_dependency");
+// tslint:disable-next-line: no-var-requires
+const XMLWriter = require("xml-writer");
+function dumpEnumeratedType(xw, e, name) {
+    xw.startElement("opc:EnumeratedType");
+    xw.writeAttribute("Name", name);
+    xw.writeAttribute("LengthInBits", "32");
+    for (const f of e.fields || []) {
+        xw.startElement("opc:EnumeratedValue");
+        xw.writeAttribute("Name", f.name);
+        (0, node_opcua_assert_1.assert)(f.value[0] === 0, "unsupported 64 bit value !");
+        xw.writeAttribute("Value", f.value[1].toString());
+        xw.endElement();
+    }
+    xw.endElement();
+}
+function buildXmlName(addressSpace, map, nodeId) {
+    if (node_opcua_nodeid_1.NodeId.sameNodeId(nodeId, node_opcua_nodeid_1.NodeId.nullNodeId)) {
+        return "ua:ExtensionObject";
+    }
+    const node = addressSpace.findNode(nodeId);
+    // istanbul ignore next
+    if (!node) {
+        throw new Error("Cannot find Node for" + (nodeId === null || nodeId === void 0 ? void 0 : nodeId.toString()));
+    }
+    const typeName = node.browseName.name;
+    const n = node.nodeId;
+    const prefix = (n.identifierType === node_opcua_nodeid_1.NodeIdType.NUMERIC && n.namespace === 0) ? (n.value <= 15 ? "opc" : "ua") : map[node.nodeId.namespace];
+    return prefix + ":" + (typeName === "Structure" && prefix === "ua" ? "ExtensionObject" : typeName);
+}
+// eslint-disable-next-line max-statements
+function dumpDataTypeStructure(xw, addressSpace, map, structureDefinition, structureDefinitionBase, name, doc) {
+    var _a, _b;
+    xw.startElement("opc:StructuredType");
+    xw.writeAttribute("Name", name);
+    xw.writeAttribute("BaseType", buildXmlName(addressSpace, map, structureDefinition.baseDataType));
+    if (doc) {
+        xw.startElement("opc:Documentation");
+        xw.text(doc);
+        xw.endElement();
+    }
+    const fields = structureDefinition.fields || [];
+    // get base class
+    const nbFieldsInBase = structureDefinitionBase ? ((_a = structureDefinitionBase.fields) === null || _a === void 0 ? void 0 : _a.length) || 0 : 0;
+    let optionalsCount = 0;
+    for (let index = nbFieldsInBase; index < fields.length; index++) {
+        const f = fields[index];
+        if (f.isOptional) {
+            xw.startElement("opc:Field");
+            xw.writeAttribute("Name", f.name + "Specified");
+            xw.writeAttribute("TypeName", "opc:Bit");
+            xw.endElement();
+            optionalsCount++;
+        }
+    }
+    // istanbul ignore next
+    if (optionalsCount >= 32) {
+        throw new Error("Too many optionals fields");
+    }
+    if (optionalsCount) {
+        /*
+                const padding = optionalsCount <= 8
+                    ? (8 - optionalsCount)
+                    : (optionalsCount <= 16)
+                        ? (16 - optionalsCount)
+                        : (32 - optionalsCount)
+                    ;
+        */
+        const padding = 32 - optionalsCount;
+        if (padding !== 0) {
+            xw.startElement("opc:Field");
+            xw.writeAttribute("Name", "Reserved1");
+            xw.writeAttribute("TypeName", "opc:Bit");
+            xw.writeAttribute("Length", padding.toString());
+            xw.endElement();
+        }
+    }
+    for (let index = nbFieldsInBase; index < fields.length; index++) {
+        const f = fields[index];
+        const isArray = f.valueRank > 0 && ((_b = f.arrayDimensions) === null || _b === void 0 ? void 0 : _b.length);
+        if (isArray) {
+            xw.startElement("opc:Field");
+            xw.writeAttribute("Name", "NoOf" + f.name);
+            xw.writeAttribute("TypeName", "opc:Int32");
+            if (f.isOptional) {
+                xw.writeAttribute("SwitchField", f.name + "Specified");
+            }
+            xw.endElement();
+        }
+        xw.startElement("opc:Field");
+        xw.writeAttribute("Name", f.name);
+        const typeName = buildXmlName(addressSpace, map, f.dataType);
+        xw.writeAttribute("TypeName", typeName);
+        if (isArray) {
+            xw.writeAttribute("LengthField", "NoOf" + f.name);
+        }
+        if (f.isOptional) {
+            xw.writeAttribute("SwitchField", f.name + "Specified");
+        }
+        xw.endElement();
+    }
+    xw.endElement();
+}
+function dumpDataTypeToBSD(xw, dataType, map) {
+    var _a;
+    const addressSpace = dataType.addressSpace;
+    const name = dataType.browseName.name;
+    const definition = dataType.getDefinition();
+    if (definition instanceof node_opcua_types_1.StructureDefinition) {
+        const structureDefinitionBase = (_a = dataType.subtypeOfObj) === null || _a === void 0 ? void 0 : _a.getStructureDefinition();
+        dumpDataTypeStructure(xw, addressSpace, map, definition, structureDefinitionBase, name);
+    }
+    if (definition instanceof node_opcua_types_1.EnumDefinition) {
+        dumpEnumeratedType(xw, definition, name);
+    }
+}
+function shortcut(namespace) {
+    return "n" + namespace.index;
+}
+function dumpToBSD(namespace) {
+    const dependency = (0, construct_namespace_dependency_1.constructNamespaceDependency)(namespace);
+    const addressSpace = namespace.addressSpace;
+    const xw = new XMLWriter(true);
+    //xx xw.startDocument():// { encoding: "utf-8", version: "1.0" });
+    xw.startElement("opc:TypeDictionary");
+    xw.writeAttribute("xmlns:opc", "http://opcfoundation.org/BinarySchema/");
+    xw.writeAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
+    xw.writeAttribute("xmlns:ua", "http://opcfoundation.org/UA/");
+    xw.writeAttribute("xmlns:tns", namespace.namespaceUri);
+    const map = {};
+    map[namespace.index] = "tns";
+    for (const dependantNamespace of dependency) {
+        const namespaceIndex = dependantNamespace.index;
+        if (namespaceIndex === 0 || namespaceIndex === namespace.index) {
+            continue;
+        }
+        const ns = shortcut(dependantNamespace);
+        map[namespaceIndex] = ns;
+        xw.writeAttribute(`xmlns:${ns}`, dependantNamespace.namespaceUri);
+    }
+    xw.writeAttribute("DefaultByteOrder", "LittleEndian");
+    xw.writeAttribute("TargetNamespace", namespace.namespaceUri);
+    // <opc:Import Namespace="http://opcfoundation.org/UA/"/>
+    for (const dependantNamespace of dependency) {
+        if (dependantNamespace.index === namespace.index) {
+            continue;
+        }
+        xw.startElement("opc:Import").writeAttribute("Namespace", dependantNamespace.namespaceUri).endElement();
+    }
+    //
+    for (const dataType of namespace._dataTypeIterator()) {
+        dumpDataTypeToBSD(xw, dataType, map);
+    }
+    xw.endElement();
+    //    xw.endDocument();
+    return xw.toString();
+}
+exports.dumpToBSD = dumpToBSD;
+//# sourceMappingURL=dump_to_bsd.js.map

package/dist/src/nodeset_tools/dump_to_bsd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dump_to_bsd.js","sourceRoot":"","sources":["../../../src/nodeset_tools/dump_to_bsd.ts"],"names":[],"mappings":";;;AACA,yDAA2C;AAC3C,uDAAuE;AACvE,yDAAgE;AAIhE,qFAAgF;AAEhF,4CAA4C;AAC5C,MAAM,SAAS,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AAExC,SAAS,kBAAkB,CAAC,EAAa,EAAE,CAAiB,EAAE,IAAY;IACtE,EAAE,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC;IACtC,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAChC,EAAE,CAAC,cAAc,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IACxC,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,EAAE,EAAE;QAC5B,EAAE,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC;QACvC,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,IAAK,CAAC,CAAC;QACnC,IAAA,0BAAM,EAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,4BAA4B,CAAC,CAAC;QACvD,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QAClD,EAAE,CAAC,UAAU,EAAE,CAAC;KACnB;IACD,EAAE,CAAC,UAAU,EAAE,CAAC;AACpB,CAAC;AACD,SAAS,YAAY,CAAC,YAAiC,EAAE,GAA8B,EAAE,MAAc;IACnG,IAAI,0BAAM,CAAC,UAAU,CAAC,MAAM,EAAE,0BAAM,CAAC,UAAU,CAAC,EAAE;QAC9C,OAAO,oBAAoB,CAAC;KAC/B;IACD,MAAM,IAAI,GAAG,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,uBAAuB;IACvB,IAAI,CAAC,IAAI,EAAE;QACP,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,EAAE,CAAA,CAAC,CAAC;KAChE;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,IAAK,CAAC;IAEvC,MAAM,CAAC,GAAG,IAAI,CAAC,MAAiB,CAAC;IACjC,MAAM,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,KAAK,8BAAU,CAAC,OAAO,IAAI,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC5I,OAAO,MAAM,GAAG,GAAG,GAAG,CAAC,QAAQ,KAAK,WAAW,IAAI,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;AACvG,CAAC;AAED,0CAA0C;AAC1C,SAAS,qBAAqB,CAC1B,EAAa,EACb,YAA2B,EAC3B,GAA8B,EAC9B,mBAAwC,EACxC,uBAA+D,EAC/D,IAAY,EACZ,GAAY;;IAEZ,EAAE,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC;IACtC,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAChC,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,YAAY,CAAC,YAAmC,EAAE,GAAG,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAC;IAExH,IAAI,GAAG,EAAE;QACL,EAAE,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC;QACrC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACb,EAAE,CAAC,UAAU,EAAE,CAAC;KACnB;IAED,MAAM,MAAM,GAAG,mBAAmB,CAAC,MAAM,IAAI,EAAE,CAAC;IAChD,iBAAiB;IACjB,MAAM,cAAc,GAAG,uBAAuB,CAAC,CAAC,CAAC,CAAA,MAAA,uBAAuB,CAAC,MAAM,0CAAE,MAAM,KAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAEjG,IAAI,cAAc,GAAG,CAAC,CAAC;IACvB,KAAK,IAAI,KAAK,GAAG,cAAc,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QAC7D,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QACxB,IAAI,CAAC,CAAC,UAAU,EAAE;YACd,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;YAC7B,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,GAAG,WAAW,CAAC,CAAC;YAChD,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;YACzC,EAAE,CAAC,UAAU,EAAE,CAAC;YAChB,cAAc,EAAE,CAAC;SACpB;KACJ;IAED,uBAAuB;IACvB,IAAI,cAAc,IAAI,EAAE,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;KAChD;IAED,IAAI,cAAc,EAAE;QAChB;;;;;;;UAOE;QACF,MAAM,OAAO,GAAG,EAAE,GAAG,cAAc,CAAC;QACpC,IAAI,OAAO,KAAK,CAAC,EAAE;YACf,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;YAC7B,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YACvC,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;YACzC,EAAE,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;YAChD,EAAE,CAAC,UAAU,EAAE,CAAC;SACnB;KACJ;IACD,KAAK,IAAI,KAAK,GAAG,cAAc,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QAC7D,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,OAAO,GAAG,CAAC,CAAC,SAAS,GAAG,CAAC,KAAI,MAAA,CAAC,CAAC,eAAe,0CAAE,MAAM,CAAA,CAAC;QAE7D,IAAI,OAAO,EAAE;YACT,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;YAC7B,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,IAAK,CAAC,CAAC;YAC5C,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;YAC3C,IAAI,CAAC,CAAC,UAAU,EAAE;gBACd,EAAE,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC,CAAC,IAAI,GAAG,WAAW,CAAC,CAAC;aAC1D;YACD,EAAE,CAAC,UAAU,EAAE,CAAC;SACnB;QAED,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAC7B,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,IAAK,CAAC,CAAC;QAEnC,MAAM,QAAQ,GAAG,YAAY,CAAC,YAAmC,EAAE,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC;QACpF,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACxC,IAAI,OAAO,EAAE;YACT,EAAE,CAAC,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,CAAC,CAAC,IAAK,CAAC,CAAC;SACtD;QACD,IAAI,CAAC,CAAC,UAAU,EAAE;YACd,EAAE,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC,CAAC,IAAI,GAAG,WAAW,CAAC,CAAC;SAC1D;QACD,EAAE,CAAC,UAAU,EAAE,CAAC;KACnB;IACD,EAAE,CAAC,UAAU,EAAE,CAAC;AACpB,CAAC;AAED,SAAS,iBAAiB,CAAC,EAAa,EAAE,QAAoB,EAAE,GAA8B;;IAC1F,MAAM,YAAY,GAAG,QAAQ,CAAC,YAAY,CAAC;IAE3C,MAAM,IAAI,GAAW,QAAQ,CAAC,UAAU,CAAC,IAAK,CAAC;IAE/C,MAAM,UAAU,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAC;IAC5C,IAAI,UAAU,YAAY,sCAAmB,EAAE;QAC3C,MAAM,uBAAuB,GAAG,MAAA,QAAQ,CAAC,YAAY,0CAAE,sBAAsB,EAAE,CAAC;QAChF,qBAAqB,CAAC,EAAE,EAAE,YAAY,EAAE,GAAG,EAAE,UAAU,EAAE,uBAAuB,EAAE,IAAI,CAAC,CAAC;KAC3F;IACD,IAAI,UAAU,YAAY,iCAAc,EAAE;QACtC,kBAAkB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;KAC5C;AACL,CAAC;AAED,SAAS,QAAQ,CAAC,SAAqB;IACnC,OAAO,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC;AACjC,CAAC;AACD,SAAgB,SAAS,CAAC,SAA2B;IACjD,MAAM,UAAU,GAAiB,IAAA,6DAA4B,EAAC,SAAS,CAAC,CAAC;IAEzE,MAAM,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC;IAE5C,MAAM,EAAE,GAAc,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;IAE1C,kEAAkE;IAElE,EAAE,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC;IAEtC,EAAE,CAAC,cAAc,CAAC,WAAW,EAAE,wCAAwC,CAAC,CAAC;IACzE,EAAE,CAAC,cAAc,CAAC,WAAW,EAAE,2CAA2C,CAAC,CAAC;IAC5E,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,8BAA8B,CAAC,CAAC;IAC9D,EAAE,CAAC,cAAc,CAAC,WAAW,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;IAEvD,MAAM,GAAG,GAA8B,EAAE,CAAC;IAE1C,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;IAE7B,KAAK,MAAM,kBAAkB,IAAI,UAAU,EAAE;QACzC,MAAM,cAAc,GAAG,kBAAkB,CAAC,KAAK,CAAC;QAChD,IAAI,cAAc,KAAK,CAAC,IAAI,cAAc,KAAK,SAAS,CAAC,KAAK,EAAE;YAC5D,SAAS;SACZ;QACD,MAAM,EAAE,GAAG,QAAQ,CAAC,kBAAkB,CAAC,CAAC;QACxC,GAAG,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC;QACzB,EAAE,CAAC,cAAc,CAAC,SAAS,EAAE,EAAE,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC;KACrE;IAED,EAAE,CAAC,cAAc,CAAC,kBAAkB,EAAE,cAAc,CAAC,CAAC;IACtD,EAAE,CAAC,cAAc,CAAC,iBAAiB,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;IAE7D,yDAAyD;IACzD,KAAK,MAAM,kBAAkB,IAAI,UAAU,EAAE;QACzC,IAAI,kBAAkB,CAAC,KAAK,KAAK,SAAS,CAAC,KAAK,EAAE;YAC9C,SAAS;SACZ;QACD,EAAE,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,cAAc,CAAC,WAAW,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC,UAAU,EAAE,CAAC;KAC3G;IACD,EAAE;IACF,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,iBAAiB,EAAE,EAAE;QAClD,iBAAiB,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;KACxC;IACD,EAAE,CAAC,UAAU,EAAE,CAAC;IAChB,uBAAuB;IAEvB,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC;AACzB,CAAC;AAhDD,8BAgDC"}

package/dist/src/nodeset_tools/nodeset_to_xml.d.ts

@@ -0,0 +1,10 @@
+import { BaseNode } from "node-opcua-address-space-base";
+export declare function sortByBrowseName(x: BaseNode, y: BaseNode): number;
+type NodeIdString = string;
+export interface BuildAliasesData {
+    aliases: Record<string, NodeIdString>;
+    aliases_visited?: Record<string, unknown>;
+}
+export interface DumpXMLOptions {
+}
+export {};