node-opcua-data-model 2.55.0 → 2.56.0

package/source/localized_text.ts

@@ -1,188 +1,189 @@
-/**
- * @module node-opcua-data-model
- */
-import { assert } from "node-opcua-assert";
-import { decodeByte, decodeString, encodeByte, encodeString, LocaleId, UAString } from "node-opcua-basic-types";
-import { BinaryStream, OutputBinaryStream } from "node-opcua-binary-stream";
-import {
-    BaseUAObject,
-    buildStructuredType,
-    check_options_correctness_against_schema,
-    initialize_field,
-    parameters,
-    registerSpecialVariantEncoder,
-    StructuredTypeSchema
-} from "node-opcua-factory";
-
-export function coerceLocalizedText(value?: null | string | LocalizedTextOptions): LocalizedText | null {
-    if (value === undefined || value === null) {
-        return null;
-    }
-    if (value instanceof LocalizedText) {
-        return value;
-    }
-    return new LocalizedText(value);
-}
-
-// --------------------------------------------------------------------------------------------
-// see Part 3 - $8.5 page 63
-const schemaLocalizedText = buildStructuredType({
-    name: "LocalizedText",
-
-    baseType: "BaseUAObject",
-
-    fields: [
-        {
-            name: "locale",
-
-            fieldType: "LocaleId",
-
-            defaultValue: null
-        },
-        {
-            name: "text",
-
-            fieldType: "UAString",
-
-            defaultValue: null
-        }
-    ]
-});
-schemaLocalizedText.coerce = coerceLocalizedText;
-
-export interface LocalizedTextOptions {
-    locale?: LocaleId;
-    text?: UAString;
-}
-
-export class LocalizedText extends BaseUAObject {
-    static get schema(): StructuredTypeSchema {
-        return schemaLocalizedText;
-    }
-
-    public get schema(): StructuredTypeSchema {
-        return schemaLocalizedText;
-    }
-
-    public static possibleFields: string[] = ["locale", "text"];
-
-    public static coerce(value: any): LocalizedText | null {
-        return coerceLocalizedText(value);
-    }
-
-    public locale: LocaleId;
-    public text: UAString;
-
-    constructor(options?: LocalizedTextOptions | string | null) {
-        super();
-        if (options === null) {
-            this.locale = null;
-            this.text = null;
-            return;
-        }
-        if (typeof options === "string") {
-            this.locale = null;
-            this.text = options;
-            return;
-        }
-        /* istanbul ignore next */
-        if (parameters.debugSchemaHelper) {
-            const schema = schemaLocalizedText;
-            check_options_correctness_against_schema(this, schema, options);
-        }
-        this.locale = options?.locale || null;
-        this.text = options?.text || null;
-    }
-
-    public toString(): string {
-        return "locale=" + this.locale + " text=" + this.text;
-    }
-
-    // OPCUA Part 6 $ 5.2.2.14 : localizedText have a special encoding
-    public encode(stream: OutputBinaryStream) {
-        // tslint:disable:no-bitwise
-        const encodingMask = getLocalizeText_EncodingByte(this);
-
-        encodeByte(encodingMask, stream);
-        if ((encodingMask & 0x01) === 0x01) {
-            encodeString(this.locale, stream);
-        }
-
-        if ((encodingMask & 0x02) === 0x02) {
-            encodeString(this.text, stream);
-        }
-    }
-
-    public decodeDebug(stream: BinaryStream, options: any) {
-        let cursorBefore;
-        const tracer = options.tracer;
-        tracer.trace("start", options.name + "(" + "LocalizedText" + ")", stream.length, stream.length);
-        cursorBefore = stream.length;
-
-        const encodingMask = decodeByte(stream);
-        tracer.trace("member", "encodingByte", "0x" + encodingMask.toString(16), cursorBefore, stream.length, "Mask");
-        cursorBefore = stream.length;
-
-        if ((encodingMask & 0x01) === 0x01) {
-            this.locale = decodeString(stream);
-            tracer.trace("member", "locale", this.locale, cursorBefore, stream.length, "locale");
-            cursorBefore = stream.length;
-        } else {
-            this.locale = null;
-        }
-        if ((encodingMask & 0x02) === 0x02) {
-            this.text = decodeString(stream);
-            tracer.trace("member", "text", this.text, cursorBefore, stream.length, "text");
-            // cursor_before = stream.length;
-        } else {
-            this.text = null;
-        }
-        tracer.trace("end", options.name, stream.length, stream.length);
-    }
-
-    public decode(stream: BinaryStream): void {
-        const encodingMask = decodeByte(stream);
-        if ((encodingMask & 0x01) === 0x01) {
-            this.locale = decodeString(stream);
-        } else {
-            this.locale = null;
-        }
-        if ((encodingMask & 0x02) === 0x02) {
-            this.text = decodeString(stream);
-        } else {
-            this.text = null;
-        }
-    }
-}
-
-// not an extension object registerClassDefinition("LocalizedText", LocalizedText);
-registerSpecialVariantEncoder(LocalizedText);
-
-export type LocalizedTextLike = LocalizedTextOptions | string;
-
-function getLocalizeText_EncodingByte(localizedText: LocalizedText): number {
-    let encodingMask = 0;
-    if (localizedText.locale) {
-        encodingMask |= 0x01;
-    }
-    if (localizedText.text) {
-        encodingMask |= 0x02;
-    }
-    return encodingMask;
-}
-
-const emptyLocalizedText = new LocalizedText({});
-
-export function encodeLocalizedText(value: LocalizedText, stream: OutputBinaryStream): void {
-    if (value) {
-        value.encode(stream);
-    } else {
-        emptyLocalizedText.encode(stream);
-    }
-}
-
-export function decodeLocalizedText(stream: BinaryStream, value?: LocalizedText): LocalizedText {
-    value = value || new LocalizedText(null);
-    value.decode(stream);
-    return value;
-}
+/**
+ * @module node-opcua-data-model
+ */
+import { assert } from "node-opcua-assert";
+import { decodeByte, decodeString, encodeByte, encodeString, LocaleId, UAString } from "node-opcua-basic-types";
+import { BinaryStream, OutputBinaryStream } from "node-opcua-binary-stream";
+import {
+    BaseUAObject,
+    buildStructuredType,
+    check_options_correctness_against_schema,
+    DecodeDebugOptions,
+    initialize_field,
+    parameters,
+    registerSpecialVariantEncoder,
+    StructuredTypeSchema
+} from "node-opcua-factory";
+
+export function coerceLocalizedText(value?: null | string | LocalizedTextOptions): LocalizedText | null {
+    if (value === undefined || value === null) {
+        return null;
+    }
+    if (value instanceof LocalizedText) {
+        return value;
+    }
+    return new LocalizedText(value);
+}
+
+// --------------------------------------------------------------------------------------------
+// see Part 3 - $8.5 page 63
+const schemaLocalizedText = buildStructuredType({
+    name: "LocalizedText",
+
+    baseType: "BaseUAObject",
+
+    fields: [
+        {
+            name: "locale",
+
+            fieldType: "LocaleId",
+
+            defaultValue: null
+        },
+        {
+            name: "text",
+
+            fieldType: "UAString",
+
+            defaultValue: null
+        }
+    ]
+});
+schemaLocalizedText.coerce = coerceLocalizedText;
+
+export interface LocalizedTextOptions {
+    locale?: LocaleId;
+    text?: UAString;
+}
+
+export class LocalizedText extends BaseUAObject {
+    static get schema(): StructuredTypeSchema {
+        return schemaLocalizedText;
+    }
+
+    public get schema(): StructuredTypeSchema {
+        return schemaLocalizedText;
+    }
+
+    public static possibleFields: string[] = ["locale", "text"];
+
+    public static coerce(value?: null | string | LocalizedTextOptions): LocalizedText | null {
+        return coerceLocalizedText(value);
+    }
+
+    public locale: LocaleId;
+    public text: UAString;
+
+    constructor(options?: LocalizedTextOptions | string | null) {
+        super();
+        if (options === null) {
+            this.locale = null;
+            this.text = null;
+            return;
+        }
+        if (typeof options === "string") {
+            this.locale = null;
+            this.text = options;
+            return;
+        }
+        /* istanbul ignore next */
+        if (parameters.debugSchemaHelper) {
+            const schema = schemaLocalizedText;
+            check_options_correctness_against_schema(this, schema, options);
+        }
+        this.locale = options?.locale || null;
+        this.text = options?.text || null;
+    }
+
+    public toString(): string {
+        return "locale=" + this.locale + " text=" + this.text;
+    }
+
+    // OPCUA Part 6 $ 5.2.2.14 : localizedText have a special encoding
+    public encode(stream: OutputBinaryStream): void {
+        // tslint:disable:no-bitwise
+        const encodingMask = getLocalizeText_EncodingByte(this);
+
+        encodeByte(encodingMask, stream);
+        if ((encodingMask & 0x01) === 0x01) {
+            encodeString(this.locale, stream);
+        }
+
+        if ((encodingMask & 0x02) === 0x02) {
+            encodeString(this.text, stream);
+        }
+    }
+
+    public decodeDebug(stream: BinaryStream, options: DecodeDebugOptions): void {
+        let cursorBefore;
+        const tracer = options.tracer;
+        tracer.trace("start", options.name + "(" + "LocalizedText" + ")", stream.length, stream.length);
+        cursorBefore = stream.length;
+
+        const encodingMask = decodeByte(stream);
+        tracer.trace("member", "encodingByte", "0x" + encodingMask.toString(16), cursorBefore, stream.length, "Mask");
+        cursorBefore = stream.length;
+
+        if ((encodingMask & 0x01) === 0x01) {
+            this.locale = decodeString(stream);
+            tracer.trace("member", "locale", this.locale, cursorBefore, stream.length, "locale");
+            cursorBefore = stream.length;
+        } else {
+            this.locale = null;
+        }
+        if ((encodingMask & 0x02) === 0x02) {
+            this.text = decodeString(stream);
+            tracer.trace("member", "text", this.text, cursorBefore, stream.length, "text");
+            // cursor_before = stream.length;
+        } else {
+            this.text = null;
+        }
+        tracer.trace("end", options.name, stream.length, stream.length);
+    }
+
+    public decode(stream: BinaryStream): void {
+        const encodingMask = decodeByte(stream);
+        if ((encodingMask & 0x01) === 0x01) {
+            this.locale = decodeString(stream);
+        } else {
+            this.locale = null;
+        }
+        if ((encodingMask & 0x02) === 0x02) {
+            this.text = decodeString(stream);
+        } else {
+            this.text = null;
+        }
+    }
+}
+
+// not an extension object registerClassDefinition("LocalizedText", LocalizedText);
+registerSpecialVariantEncoder(LocalizedText);
+
+export type LocalizedTextLike = LocalizedTextOptions | string;
+
+function getLocalizeText_EncodingByte(localizedText: LocalizedText): number {
+    let encodingMask = 0;
+    if (localizedText.locale) {
+        encodingMask |= 0x01;
+    }
+    if (localizedText.text) {
+        encodingMask |= 0x02;
+    }
+    return encodingMask;
+}
+
+const emptyLocalizedText = new LocalizedText({});
+
+export function encodeLocalizedText(value: LocalizedText, stream: OutputBinaryStream): void {
+    if (value) {
+        value.encode(stream);
+    } else {
+        emptyLocalizedText.encode(stream);
+    }
+}
+
+export function decodeLocalizedText(stream: BinaryStream, value?: LocalizedText): LocalizedText {
+    value = value || new LocalizedText(null);
+    value.decode(stream);
+    return value;
+}

package/source/node_class_mask.ts

@@ -1,47 +1,47 @@
-/**
- * @module node-opcua-data-model
- */
-// tslint:disable:no-bitwise
-
-// Specifies the NodeClasses of the TargetNodes. Only TargetNodes with the
-// selected NodeClasses are returned. The NodeClasses are assigned the
-// following bits:
-// If set to zero, then all NodeClasses are returned.
-// @example
-//    var mask = NodeClassMask.get("Object |  ObjectType");
-//    mask.value.should.eql(1 + (1<<3));
-
-export enum NodeClassMask {
-    Object=  (1 << 0),
-    Variable = (1 << 1),
-    Method=  (1 << 2),
-    ObjectType=  (1 << 3),
-    VariableType=  (1 << 4),
-    ReferenceType=  (1 << 5),
-    DataType= (1 << 6),
-    View= (1 << 7)
-}
-
-interface Enum {
-    [id: string]: number;
-}
-
-function makeFlagFromString<Type>(type: Enum, str: string): Type {
-    const flags = str.split(" | ");
-    let result: any = 0;
-    for (const flag of flags) {
-        result |= type[flag];
-    }
-    return result as Type;
-}
-
-// @example
-//      makeNodeClassMask("Method | Object").should.eql(5);
-export function makeNodeClassMask(str: string): NodeClassMask {
-    const classMask = makeFlagFromString<NodeClassMask>(NodeClassMask as any, str);
-    /* istanbul ignore next */
-    if (!classMask) {
-        throw new Error(" cannot find class mask for " + str);
-    }
-    return classMask;
-}
+/**
+ * @module node-opcua-data-model
+ */
+// tslint:disable:no-bitwise
+
+// Specifies the NodeClasses of the TargetNodes. Only TargetNodes with the
+// selected NodeClasses are returned. The NodeClasses are assigned the
+// following bits:
+// If set to zero, then all NodeClasses are returned.
+// @example
+//    var mask = NodeClassMask.get("Object |  ObjectType");
+//    mask.value.should.eql(1 + (1<<3));
+
+export enum NodeClassMask {
+    Object = 1 << 0,
+    Variable = 1 << 1,
+    Method = 1 << 2,
+    ObjectType = 1 << 3,
+    VariableType = 1 << 4,
+    ReferenceType = 1 << 5,
+    DataType = 1 << 6,
+    View = 1 << 7
+}
+
+interface Enum {
+    [id: string]: number;
+}
+
+function makeFlagFromString<Type>(type: Enum, str: string): Type {
+    const flags = str.split(" | ");
+    let result: any = 0;
+    for (const flag of flags) {
+        result |= type[flag];
+    }
+    return result as Type;
+}
+
+// @example
+//      makeNodeClassMask("Method | Object").should.eql(5);
+export function makeNodeClassMask(str: string): NodeClassMask {
+    const classMask = makeFlagFromString<NodeClassMask>(NodeClassMask as any, str);
+    /* istanbul ignore next */
+    if (!classMask) {
+        throw new Error(" cannot find class mask for " + str);
+    }
+    return classMask;
+}

package/source/nodeclass.ts

@@ -1,23 +1,23 @@
-/**
- * @module node-opcua-data-model
- */
-import { registerEnumeration } from "node-opcua-factory";
-
-export enum NodeClass {
-    Unspecified=       0,  // No classes are selected.
-    Object=            1,  // The node is an object.
-    Variable=          2,  // The node is a variable.
-    Method=            4,  // The node is a method.
-    ObjectType=        8,  // The node is an object type.
-    VariableType=     16,  // The node is an variable type.
-    ReferenceType=    32,  // The node is a reference type.
-    DataType=         64,  // The node is a data type.
-    View=            128   // The node is a view.
-}
-export const schemaEnumNodeClass = {
-    name: "NodeClass",
-
-    documentation: "A mask specifying the class of the node.",
-    enumValues: NodeClass
-};
-registerEnumeration(schemaEnumNodeClass);
+/**
+ * @module node-opcua-data-model
+ */
+import { registerEnumeration } from "node-opcua-factory";
+
+export enum NodeClass {
+    Unspecified = 0, // No classes are selected.
+    Object = 1, // The node is an object.
+    Variable = 2, // The node is a variable.
+    Method = 4, // The node is a method.
+    ObjectType = 8, // The node is an object type.
+    VariableType = 16, // The node is an variable type.
+    ReferenceType = 32, // The node is a reference type.
+    DataType = 64, // The node is a data type.
+    View = 128 // The node is a view.
+}
+export const schemaEnumNodeClass = {
+    name: "NodeClass",
+
+    documentation: "A mask specifying the class of the node.",
+    enumValues: NodeClass
+};
+registerEnumeration(schemaEnumNodeClass);

package/source/permission_flag.ts

@@ -25,14 +25,14 @@ export enum PermissionFlag {
     ReadRolePermissions = 2,
     /**
      * The Client is allowed to write to Attributes other than the Value,
-     * Historizing or RolePermissions Attribute if the WriteMask indicates that 
+     * Historizing or RolePermissions Attribute if the WriteMask indicates that
      * the Attribute is writeable.
      * This bit affects the value of a UserWriteMask Attribute.
      * This Permission is valid for all NodeClasses.
      */
     WriteAttribute = 4,
     /**
-     * The Client is allowed to write to the RolePermissions Attribute if the WriteMask 
+     * The Client is allowed to write to the RolePermissions Attribute if the WriteMask
      * indicates that the Attribute is writeable.
      * This bit affects the value of the UserWriteMask Attribute.
      * This Permission is valid for all NodeClasses.
@@ -81,14 +81,14 @@ export enum PermissionFlag {
      */
     DeleteHistory = 1024,
     /**
-     * A Client only receives an Event if this bit is set on the Node identified 
+     * A Client only receives an Event if this bit is set on the Node identified
      * by the EventTypeId field and on the Node identified by the SourceNode field.
      * This Permission is only valid for EventType Nodes or SourceNodes.
      */
     ReceiveEvents = 2048,
     /**
-     * The Client is allowed to call the Method if this bit is set on the Object or 
-     * ObjectType Node passed in the Call request and the Method Instance associated 
+     * The Client is allowed to call the Method if this bit is set on the Object or
+     * ObjectType Node passed in the Call request and the Method Instance associated
      * with that Object or ObjectType.
      * This bit affects the UserExecutable Attribute when set on Method Node.
      * This Permission is only valid for Objects, ObjectType or Methods.
@@ -101,7 +101,7 @@ export enum PermissionFlag {
     AddReference = 8192,
     /**
      * The Client is allowed to remove references from the Node.
-     * This Permission is valid for all NodeClasses. 
+     * This Permission is valid for all NodeClasses.
      */
     RemoveReference = 16384,
     /**
@@ -117,7 +117,8 @@ export enum PermissionFlag {
     AddNode = 65536
 }
 
-export const allPermissions = PermissionFlag.Browse |
+export const allPermissions =
+    PermissionFlag.Browse |
     PermissionFlag.Browse |
     PermissionFlag.ReadRolePermissions |
     PermissionFlag.WriteAttribute |
@@ -146,7 +147,6 @@ export function makePermissionFlag(str: string | number | null): number {
 }
 
 export function permissionFlagToString(permissionFlag: PermissionFlag): string {
-
     const retVal = [];
     for (const [key, value] of Object.entries(PermissionFlag)) {
         const numKey = parseInt(key, 10);

package/source/qualified_name.ts

@@ -98,7 +98,7 @@ export class QualifiedName extends BaseUAObject {
         return this.name || "<null>";
     }
 
-    public isEmpty() {
+    public isEmpty(): boolean {
         return !this.name || this.name.length === 0;
     }
 }
@@ -154,8 +154,8 @@ export function coerceQualifiedName(value: null | QualifiedNameLike): QualifiedN
     } else if (typeof value === "string") {
         return stringToQualifiedName(value);
     } else {
-        assert(value.hasOwnProperty("namespaceIndex"));
-        assert(value.hasOwnProperty("name"));
+        assert(Object.prototype.hasOwnProperty.call(value, "namespaceIndex"));
+        assert(Object.prototype.hasOwnProperty.call(value, "name"));
         return new QualifiedName(value);
     }
 }