node-opcua-modeler 2.164.2 → 2.165.0

package/source/displayNodeElement.ts

@@ -1,19 +1,18 @@
 import {
-    BaseNode,
-    UAReference,
-    UAObjectType,
-    UAVariable,
+    type BaseNode,
     resolveReferenceNode,
     resolveReferenceType,
-    UAVariableType,
-    UAObject
+    type UAObject,
+    type UAObjectType,
+    type UAReference,
+    type UAVariable,
+    type UAVariableType
 } from "node-opcua-address-space";
 import { BrowseDirection, NodeClass } from "node-opcua-data-model";
 import { NodeId, resolveNodeId } from "node-opcua-nodeid";
 import { DataType } from "node-opcua-variant";
 import { TableHelper } from "./tableHelper";
 
-
 function symbol(nodeClass: NodeClass) {
     switch (nodeClass) {
         case NodeClass.DataType:
@@ -46,9 +45,9 @@ function encodeXML(s: string) {
 interface Data {
     table: TableHelper;
     node: BaseNode;
-    alreadyDumped: Record<string, any>;
+    alreadyDumped: Record<string, number>;
     descriptions: Description[];
-    subElements?: any[];
+    subElements?: unknown[];
 }
 interface Description {
     description: string;
@@ -62,7 +61,7 @@ interface DumpReferenceOptions {
     prefix?: string;
 }
 
-function _dumpReferenceVariable(v: UAVariable, value: any, dataType: string): { value: any; dataType: string } {
+function _dumpReferenceVariable(v: UAVariable, value: string, dataType: string): { value: string; dataType: string } {
     const val = v.readValue().value.value;
     if (v.dataType.isEmpty()) {
         return { value, dataType };
@@ -72,17 +71,17 @@ function _dumpReferenceVariable(v: UAVariable, value: any, dataType: string): {
         // don't do anything
     } else if (v.isEnumeration() && val !== null) {
         const enumValue = v.readEnumValue();
-        value = enumValue.value + " (" + enumValue.name + ")";
+        value = `${enumValue.value} (${enumValue.name})`;
     } else if (val instanceof Date) {
         value = val ? val.toUTCString() : "";
     } else {
         value = val ? val.toString() : "null";
     }
-    const actualDataType = DataType[v.readValue().value.dataType];
+    const _actualDataType = DataType[v.readValue().value.dataType];
     const basicDataType = DataType[v.dataTypeObj.basicDataType];
     dataType = v.dataTypeObj.browseName.toString();
     if (basicDataType !== dataType) {
-        dataType = dataType + "(" + basicDataType + ")";
+        dataType = `${dataType}(${basicDataType})`;
     }
     return { value, dataType };
 }
@@ -104,15 +103,14 @@ function dumpReference(data: Data, ref: UAReference, options: DumpReferenceOptio
     // ignore subtype references
     /* c8 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 refNode = ref.node;
 
     const refType = resolveReferenceType(data.node.addressSpace, ref);
-    if (options && options.filter && refType.browseName.name !== options.filter) {
+    if (options?.filter && refType.browseName.name !== options.filter) {
         return;
     }
     const key = ref.nodeId.toString() + ref.referenceType.toString();
@@ -131,8 +129,8 @@ function dumpReference(data: Data, ref: UAReference, options: DumpReferenceOptio
         dataType = t.dataType;
         // findBasicDataType(v.dataTypeObj);
     }
- 
-    const prefix = options.prefix ? options.prefix + "." : "";
+
+    const prefix = options.prefix ? `${options.prefix}.` : "";
     const row = [
         "".padEnd(prefix.length) + refType.browseName.toString() + dir + symbol(refNode.nodeClass),
         refNode.nodeId.toString(),
@@ -147,7 +145,7 @@ function dumpReference(data: Data, ref: UAReference, options: DumpReferenceOptio
 
     data.descriptions.push({
         description: refNode.description ? refNode.description.text || "" : "",
-        name: refNode.browseName.name!,
+        name: refNode.browseName.name ?? "",
         type: dataType
     });
 
@@ -217,15 +215,15 @@ export function displayNodeElement(node: BaseNode, options?: DisplayNodeOptions)
             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! || "") }]);
+        if (node.description?.text) {
+            table.push(["Description", { colspan: 6, content: shortDescription(node.description?.text ?? "") }]);
         }
         return table;
     }
 
     const table = createTable();
 
-    const alreadyDumped: Record<string, any> = {};
+    const alreadyDumped: Record<string, number> = {};
 
     const descriptions: Description[] = [];
 
@@ -248,7 +246,7 @@ export function displayNodeElement(node: BaseNode, options?: DisplayNodeOptions)
     tables.push(table);
 
     if (node.description) {
-        str.push(node.description.text! || "");
+        str.push(node.description.text ?? "");
         str.push("");
     }
     str.push(toText(table));
@@ -262,13 +260,13 @@ export function displayNodeElement(node: BaseNode, options?: DisplayNodeOptions)
         let subtypeOf = (curNode as UAObjectType | UAVariableType).subtypeOfObj;
         while (subtypeOf) {
             data.table = createTable();
-            data.table.push([subtypeOf.browseName.toString() + ":", "--", "--", "--"]);
+            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(`<summary>Base type: ${subtypeOf.browseName.toString()}</summary>`);
             str.push("");
             str.push(toText(data.table));
             str.push("");

package/source/generate_markdown_doc.ts

@@ -1,5 +1,4 @@
-/* eslint-disable max-statements */
-import {
+import type {
     BaseNode,
     INamespace,
     UADataType,
@@ -11,7 +10,7 @@ import {
 } from "node-opcua-address-space";
 import { coerceUInt32 } from "node-opcua-basic-types";
 import { NodeClass } from "node-opcua-data-model";
-import { StructureField } from "node-opcua-types";
+import type { StructureField } from "node-opcua-types";
 import { DataType } from "node-opcua-variant";
 
 import { displayNodeElement } from "./displayNodeElement";
@@ -30,15 +29,11 @@ interface NamespacePriv2 extends INamespace {
     _aliasCount(): number;
 }
 export interface IWriter {
-    // eslint-disable-next-line no-unused-vars
     writeLine(_str: string): void;
 }
 
 export class Writer implements IWriter {
     private readonly stream: string[] = [];
-    constructor() {
-        /* empty */
-    }
     public writeLine(str: string): void {
         this.stream.push(str);
     }
@@ -62,7 +57,7 @@ export async function buildDocumentationToString(namespace: INamespace, options?
 const toDataTypeStr = (p: BaseNode): string => {
     if (p.nodeClass === NodeClass.Variable) {
         const v = p as UAVariable;
-        const arr = v.valueRank == 1 ? "[]" : "";
+        const arr = v.valueRank === 1 ? "[]" : "";
         const brn = toDataTypeStr((p as UAVariable).dataTypeObj);
         return brn + arr;
     }
@@ -85,7 +80,7 @@ function dataTypeEnumerationToMarkdown(dataType: UADataType): string {
 
     writer.writeLine("");
     const definition = dataType.getEnumDefinition();
-    writer.writeLine("\nBasic Type: " + (DataType as any)[DataType.Int32]);
+    writer.writeLine(`\nBasic Type: ${DataType[DataType.Int32]}`);
     writer.writeLine("");
 
     const table = new TableHelper(["Name", "Value", "Description"]);
@@ -111,10 +106,10 @@ function dumpTypeRepresentation(uaType: UAObjectType | UADataType | UAReferenceT
     const table = new TableHelper(["Name", "Attribute"]);
     table.push(["NodeId", uaType.nodeId.toString()]);
     table.push(["NamespaceUri", uaType.addressSpace.getNamespaceUri(uaType.nodeId.namespace)]);
-    table.push(["BrowseName", uaType.browseName.name!.toString()]);
+    table.push(["BrowseName", uaType.browseName.name?.toString()]);
     table.push(["NodeClass", NodeClass[uaType.nodeClass]]);
     if (uaType.nodeClass === NodeClass.ReferenceType) {
-        table.push(["InverseName", (uaType as UAReferenceType).inverseName!.text]);
+        table.push(["InverseName", (uaType as UAReferenceType).inverseName?.text]);
         // table.push(["IsSymmetric", (uaType as UAReferenceType).isSymetric ? "Yes" : "No"]);
     }
     table.push(["IsAbstract", uaType.isAbstract ? "Yes" : "No"]);
@@ -130,7 +125,7 @@ function dumpTypeRepresentation(uaType: UAObjectType | UADataType | UAReferenceT
 
         if (uaType.subtypeOfObj) {
             const referenceName = "HasSubType";
-            const p = uaType.subtypeOfObj!;
+            const p = uaType.subtypeOfObj;
             const nodeClass = NodeClass[p.nodeClass];
             const browseName = p.browseName.toString();
             const dataTypeStr = toDataTypeStr(p);
@@ -167,16 +162,16 @@ function dataTypeStructureToMarkdown(dataType: UADataType): string {
     }
 
     const definition = dataType.getStructureDefinition();
-    writer.writeLine("\nBasic Type: " + (DataType as any)[dataType.basicDataType]);
+    writer.writeLine(`\nBasic Type: ${DataType[dataType.basicDataType]}`);
     writer.writeLine("");
     writer.writeLine(`The fields of the ${dataType.browseName.name} DataType are defined in the following table:`);
 
     const c = (f: StructureField) => {
-        let dataTypeString = addressSpace.findDataType(f.dataType)!.browseName.toString();
+        let dataTypeString = addressSpace.findDataType(f.dataType)?.browseName.toString();
         if (f.valueRank === 1) {
             dataTypeString += "[]";
         } else if (f.valueRank >= 2) {
-            dataTypeString += "[" + f.arrayDimensions?.map((d) => "" + d).join(" ") + "]";
+            dataTypeString += `[${f.arrayDimensions?.map((d) => `${d}`).join(" ")}]`;
         }
         //       f.maxStringLength ? f.maxStringLength : "",
         //       f.arrayDimensions ? f.arrayDimensions : "",
@@ -185,7 +180,7 @@ function dataTypeStructureToMarkdown(dataType: UADataType): string {
     const table = new TableHelper(["Name", "Type", "Description"]);
     table.push([dataType.browseName.name, "Structure"]);
     for (const f of definition.fields || []) {
-        table.push(["   " + f.name, c(f), (f.description.text || "").replace(/\n/g, "<br>")]);
+        table.push([`   ${f.name}`, c(f), (f.description.text || "").replace(/\n/g, "<br>")]);
     }
     writer.writeLine(table.toMarkdownTable());
 
@@ -205,7 +200,7 @@ function dataTypeToMarkdown(dataType: UADataType): string {
         if (dataType.description) {
             writer.writeLine(dataType.description.text || "");
         }
-        writer.writeLine("\nBasic Type: " + (DataType as any)[dataType.basicDataType]);
+        writer.writeLine(`\nBasic Type: ${DataType[dataType.basicDataType]}`);
         writer.writeLine("");
         return writer.toString();
     }
@@ -279,7 +274,7 @@ export async function buildDocumentation(
     const { dataTypes, objectTypes, variableTypes } = extractTypes(namespace, options);
 
     writer.writeLine("");
-    writer.writeLine("# Namespace " + namespaceUri);
+    writer.writeLine(`# Namespace ${namespaceUri}`);
     writer.writeLine("");
 
     // -------------- writeReferences
@@ -288,13 +283,13 @@ export async function buildDocumentation(
         writer.writeLine("##  References ");
         writer.writeLine("");
         for (const referenceType of namespacePriv._referenceTypeIterator()) {
-            writer.writeLine("\n\n###  reference " + referenceType.browseName.name!);
+            writer.writeLine(`\n\n###  reference ${referenceType.browseName.name ?? ""}`);
             dumpReferenceType(referenceType);
         }
     }
 
     function d(node: BaseNode): string {
-        return node.description && node.description.text ? node.description!.text!.toString() : "";
+        return node.description?.text ? node.description?.text?.toString() : "";
     }
 
     // -------------- writeDataType
@@ -303,7 +298,7 @@ export async function buildDocumentation(
         writer.writeLine("## DataTypes");
         writer.writeLine("");
         for (const dataType of dataTypes) {
-            writer.writeLine("\n\n### " + dataType.browseName.name!.toString());
+            writer.writeLine(`\n\n### ${dataType.browseName.name?.toString()}`);
             writer.writeLine("");
             writer.writeLine(dataTypeToMarkdown(dataType));
         }
@@ -314,7 +309,7 @@ export async function buildDocumentation(
         writer.writeLine("## ObjectTypes");
         writer.writeLine("");
         for (const objectType of objectTypes) {
-            writer.writeLine("\n\n### " + objectType.browseName.name!.toString());
+            writer.writeLine(`\n\n### ${objectType.browseName.name?.toString()}`);
             writer.writeLine(d(objectType));
 
             if (options.dumpGraphics) {
@@ -325,12 +320,12 @@ export async function buildDocumentation(
             writer.writeLine(displayNodeElement(objectType, { format: "markdown" }));
 
             for (const comp of objectType.getComponents()) {
-                writer.writeLine("\n\n#### " + comp.browseName.name!.toString());
+                writer.writeLine(`\n\n#### ${comp.browseName.name?.toString()}`);
                 writer.writeLine("");
                 writer.writeLine(d(comp));
             }
             for (const comp of objectType.getProperties()) {
-                writer.writeLine("\n\n#### " + comp.browseName.name!.toString());
+                writer.writeLine(`\n\n#### ${comp.browseName.name?.toString()}`);
                 writer.writeLine("");
                 writer.writeLine(d(comp));
             }
@@ -342,7 +337,7 @@ export async function buildDocumentation(
         writer.writeLine("## VariableTypes");
         writer.writeLine("");
         for (const variableType of variableTypes) {
-            writer.writeLine("\n\n### " + variableType.browseName.name!.toString());
+            writer.writeLine(`\n\n### ${variableType.browseName.name?.toString()}`);
             writer.writeLine(d(variableType));
             writer.writeLine("");
 
@@ -352,8 +347,9 @@ export async function buildDocumentation(
             // enumerate components
             writer.writeLine(displayNodeElement(variableType, { format: "markdown" }));
             for (const reference of variableType.allReferences()) {
-                const n = reference.node!;
-                writer.writeLine("\n\n#### " + n.browseName.name!.toString());
+                const n = reference.node;
+                if (!n) continue;
+                writer.writeLine(`\n\n#### ${n.browseName.name?.toString()}`);
                 writer.writeLine("");
                 writer.writeLine(d(n));
             }

package/source/index.ts

@@ -1,30 +1,24 @@
-export * from "./types";
-export * from "./displayNodeElement";
-export * from "./promoteToMandatory";
-export * from "./setNamespaceMetaData";
-export * from "./build_model_inner";
-export * from "./addExtensionObjectDataType";
-export * from "./symbol";
-export * from "./to_cvs";
-export * from "./generate_markdown_doc";
-export * from "./tableHelper";
-
 //
 export * from "node-opcua-address-space";
-export * from "node-opcua-nodesets";
-export * from "node-opcua-variant";
 export * from "node-opcua-assert";
+export * from "node-opcua-assert";
+export * from "node-opcua-basic-types";
+export * from "node-opcua-constants";
+export {
+    DataTypeIds,
+    MethodIds,
+    ObjectIds,
+    ObjectTypeIds,
+    ReferenceTypeIds,
+    VariableIds,
+    VariableTypeIds
+} from "node-opcua-constants";
 export * from "node-opcua-data-model";
 export * from "node-opcua-nodeid";
+export * from "node-opcua-nodesets";
 export * from "node-opcua-numeric-range";
-export * from "node-opcua-status-code";
-export * from "node-opcua-basic-types";
-export * from "node-opcua-constants";
-export * from "node-opcua-assert";
 export * from "node-opcua-service-translate-browse-path";
-
-export { MethodIds, DataTypeIds, ReferenceTypeIds, VariableIds, VariableTypeIds, ObjectTypeIds, ObjectIds } from "node-opcua-constants";
-
+export * from "node-opcua-status-code";
 export {
     DataTypeDefinition,
     EnumDefinition,
@@ -32,3 +26,14 @@ export {
     StructureDefinition,
     StructureDefinitionOptions
 } from "node-opcua-types";
+export * from "node-opcua-variant";
+export * from "./addExtensionObjectDataType";
+export * from "./build_model_inner";
+export * from "./displayNodeElement";
+export * from "./generate_markdown_doc";
+export * from "./promoteToMandatory";
+export * from "./setNamespaceMetaData";
+export * from "./symbol";
+export * from "./tableHelper";
+export * from "./to_cvs";
+export * from "./types";

package/source/promoteToMandatory.ts

@@ -1,5 +1,6 @@
-import {
+import type {
     BaseNode,
+    ModellingRuleType,
     UADataType,
     UAMethod,
     UAObject,
@@ -7,12 +8,11 @@ import {
     UAReference,
     UAReferenceType,
     UAVariable,
-    UAVariableType,
-    ModellingRuleType
+    UAVariableType
 } from "node-opcua-address-space";
 import { NodeClass } from "node-opcua-data-model";
-import { makeBrowsePath } from "node-opcua-service-translate-browse-path";
 import { make_warningLog } from "node-opcua-debug";
+import { makeBrowsePath } from "node-opcua-service-translate-browse-path";
 
 import { displayNodeElement } from "./displayNodeElement";
 
@@ -43,7 +43,7 @@ function findReferenceToNode(node1: BaseNode, node2: BaseNode): UAReference {
             }
         }
 
-        throw new Error("Internal Error cannot find ref from node " + node1.nodeId.toString() + " " + node2.nodeId.toString());
+        throw new Error(`Internal Error cannot find ref from node ${node1.nodeId.toString()} ${node2.nodeId.toString()}`);
     }
     return ref;
 }
@@ -55,26 +55,26 @@ export function getChildInTypeOrBaseType(
 ): { propInSuperType: UAConcrete; reference: UAReference } {
     const addressSpace = node.addressSpace;
 
-    const subtypeOf = node.subtypeOfObj!;
+    const subtypeOf = node.subtypeOfObj;
     /* c8 ignore next */
     if (!subtypeOf) {
         throw new Error("Expecting a super type");
     }
 
     const browseResult = addressSpace.browsePath(makeBrowsePath(subtypeOf.nodeId, `.${namespaceIndex}:${propertyName}`));
-    const propNodeId = !browseResult.targets || !browseResult.targets[0] ? null : browseResult.targets[0].targetId!;
+    const propNodeId = !browseResult.targets || !browseResult.targets[0] ? null : browseResult.targets[0].targetId;
 
     /* c8 ignore next */
     if (!propNodeId) {
         displayNodeElement(subtypeOf);
-        throw new Error("property " + propertyName + " do not exists on " + subtypeOf.browseName.toString() + " or any superType");
+        throw new Error(`property ${propertyName} do not exists on ${subtypeOf.browseName.toString()} or any superType`);
     }
 
-    const propInSuperType = addressSpace.findNode(propNodeId)! as UAVariable | UAMethod | UAObject;
+    const propInSuperType = addressSpace.findNode(propNodeId) as UAVariable | UAMethod | UAObject;
 
     /* c8 ignore next */
     if (!propInSuperType) {
-        throw new Error("cannot find " + propNodeId.toString());
+        throw new Error(`cannot find ${propNodeId.toString()}`);
     }
     // replicate property
     const reference = findReferenceToNode(subtypeOf, propInSuperType);
@@ -94,11 +94,10 @@ export function promoteToMandatory(node: UAObjectType | UAVariableType, property
     // check mandatory
     /* c8 ignore next */
     if (propInSuperType.modellingRule === "Mandatory") {
-        warningLog("property " + propertyName + " is already Mandatory in super type");
+        warningLog(`property ${propertyName} is already Mandatory in super type`);
     }
 
     return promoteChild(node, propertyName, namespaceIndex, "Mandatory");
-
 }
 
 export function promoteChild(

package/source/tableHelper.ts

@@ -1,46 +1,28 @@
-// tslint:disable-next-line: no-var-requires
 const Table = require("cli-table3");
 
-const chars1 = {
-    // tslint:disable-next-line: object-literal-sort-keys
-    "top": "-", "top-mid": "+", "top-left": "+", "top-right": "+"
-    , "bottom": "-", "bottom-mid": "+", "bottom-left": "+", "bottom-right": "+"
-    , "left": "|", "left-mid": "+", "mid": "-", "mid-mid": "+"
-    , "right": "|", "right-mid": "+", "middle": "|"
-};
-
-const chars2 = {
-    // tslint:disable-next-line: object-literal-sort-keys
-    "top": " ", "top-mid": "   ", "top-left": "  ", "top-right": "  "
-    , "bottom": " ", "bottom-mid": "   ", "bottom-left": "  ", "bottom-right": " "
-    , "left": "| ", "left-mid": "| ", "mid": "-", "mid-mid": " | "
-    , "right": " |", "right-mid": "| ", "middle": " | "
-};
-const chars3 = {
-    // tslint:disable-next-line: object-literal-sort-keys
-    "top": "", "top-mid": "", "top-left": "", "top-right": ""
-    , "bottom": "", "bottom-mid": "", "bottom-left": "", "bottom-right": ""
-    , "left": "| ", "left-mid": "", "mid": "-", "mid-mid": " | "
-    , "right": " |", "right-mid": "", "middle": " | "
-};
-chars1;
-chars2;
-chars3;
-
-function toMarkdownTable(table: { head: string[], rows: string[][] }): string {
-
+function toMarkdownTable(table: { head: string[]; rows: string[][] }): string {
     const t = [];
 
-    t.push("| " + table.head.join(" | ") + " |");
-    t.push("| " + table.head.map(() => "---").join(" | ") + " |");
+    t.push(`| ${table.head.join(" | ")} |`);
+    t.push(`| ${table.head.map(() => "---").join(" | ")} |`);
     for (const r of table.rows) {
-        t.push("| " + r.join(" | ") + " |");
+        t.push(`| ${r.join(" | ")} |`);
     }
     return t.join("\n");
 }
 
-export class TableHelper {
+interface CellWithContent {
+    content: string;
+}
 
+function extractContent(c: unknown): string {
+    if (typeof c === "object" && c !== null && "content" in c) {
+        return (c as CellWithContent).content;
+    }
+    return String(c);
+}
+
+export class TableHelper {
     private readonly rows: string[][] = [];
     private readonly table: typeof Table;
     private readonly head: string[];
@@ -48,15 +30,13 @@ export class TableHelper {
         this.rows = [];
         // instantiate
         this.table = new Table({
-            // chars,
-            head,
-            // colWidths: [100, 200, 50, 50,]
+            head
         });
         this.head = head;
     }
     public push(row: unknown[]): void {
         this.table.push(row);
-        const row2 = row.map((c: any) => (c.content) ? c.content : c);
+        const row2 = row.map(extractContent);
         this.rows.push(row2);
     }
     public toString(): string {

package/source/to_cvs.ts

@@ -1,4 +1,4 @@
-import { Symbols } from "./symbol";
+import type { Symbols } from "./symbol";
 
 export function toCSV(arr: Symbols) {
     const line: string[] = [];

package/source/types.ts

@@ -1 +1 @@
-export { UANamespaceMetadata } from "node-opcua-address-space";
+export { UANamespaceMetadata } from "node-opcua-address-space";