node-opcua-address-space 2.178.0 → 2.179.0

package/src/state_machine/ua_two_state_variable.ts

@@ -15,6 +15,7 @@ import { VariableTypeIds } from "node-opcua-constants";
 import {
     BrowseDirection,
     coerceLocalizedText,
+    coerceLocalizedTextStrict,
     type LocalizedText,
     type LocalizedTextLike,
     type QualifiedNameLike
@@ -93,13 +94,13 @@ function _getEffectiveDisplayName<_T, _DT extends DataType>(
     }
     const boolValue = node.getValue();
 
-    let subStateNodes;
+    let subStateNodes: BaseNode[];
     if (boolValue) {
         subStateNodes = node.findReferencesExAsObject("HasTrueSubState", BrowseDirection.Forward);
     } else {
         subStateNodes = node.findReferencesExAsObject("HasFalseSubState", BrowseDirection.Forward);
     }
-    const _states = subStateNodes.forEach((_n: any) => {
+    const _states = subStateNodes.forEach((_n: BaseNode) => {
         // todo happen
     });
 
@@ -113,7 +114,7 @@ function _getHumanReadableString(node: UATwoStateVariableImpl): DataValueT<Local
         const _c = dataValue.clone() as DataValueT<LocalizedText, DataType.LocalizedText>;
         _c.value = new Variant({
             dataType: DataType.LocalizedText,
-            value: coerceLocalizedText("")!
+            value: coerceLocalizedTextStrict("")
         }) as VariantT<LocalizedText, DataType.LocalizedText>;
 
         return _c;
@@ -199,6 +200,7 @@ export declare interface UATwoStateVariableImpl extends UATwoStateVariableEx {
 /***
  * @class UATwoStateVariable
  */
+// biome-ignore lint/suspicious/noUnsafeDeclarationMerging: interface adds typed members/overloads for this class
 export class UATwoStateVariableImpl extends UAVariableImplT<LocalizedText, DataType.LocalizedText> implements UATwoStateVariableEx {
     private _trueState?: string;
     private _falseState?: string;
@@ -222,7 +224,7 @@ export class UATwoStateVariableImpl extends UAVariableImplT<LocalizedText, DataT
                     value: coerceLocalizedText(options.trueState)
                 });
             } else {
-                this._trueState = coerceLocalizedText(options.trueState)?.text!;
+                this._trueState = coerceLocalizedTextStrict(options.trueState).text ?? undefined;
             }
             if (this.falseState) {
                 this.falseState.setValueFromSource({
@@ -230,7 +232,7 @@ export class UATwoStateVariableImpl extends UAVariableImplT<LocalizedText, DataT
                     value: coerceLocalizedText(options.falseState)
                 });
             } else {
-                this._falseState = coerceLocalizedText(options.falseState)?.text!;
+                this._falseState = coerceLocalizedTextStrict(options.falseState).text ?? undefined;
             }
         }
 
@@ -305,10 +307,11 @@ export class UATwoStateVariableImpl extends UAVariableImplT<LocalizedText, DataT
         // EffectiveDisplayName will be constructed by adding the EnabledState
         // and the State of the addTrue state
         if (this.effectiveDisplayName) {
+            const effectiveDisplayName = this.effectiveDisplayName as UAVariableImpl;
             this.id.on("value_changed", () => {
-                (this.effectiveDisplayName! as UAVariableImpl)._internal_set_dataValue(_getEffectiveDisplayName(this));
+                effectiveDisplayName._internal_set_dataValue(_getEffectiveDisplayName(this));
             });
-            (this.effectiveDisplayName! as UAVariableImpl)._internal_set_dataValue(_getEffectiveDisplayName(this));
+            effectiveDisplayName._internal_set_dataValue(_getEffectiveDisplayName(this));
         }
     }
     /**
@@ -344,10 +347,10 @@ export class UATwoStateVariableImpl extends UAVariableImplT<LocalizedText, DataT
         return dataValue.value.value.text?.toString() || "";
     }
     public getTrueState(): LocalizedText {
-        return this.trueState ? this.trueState.readValue().value.value : coerceLocalizedText(this._trueState || "TRUE")!;
+        return this.trueState ? this.trueState.readValue().value.value : coerceLocalizedTextStrict(this._trueState || "TRUE");
     }
     public getFalseState(): LocalizedText {
-        return this.falseState ? this.falseState.readValue().value.value : coerceLocalizedText(this._falseState || "FALSE")!;
+        return this.falseState ? this.falseState.readValue().value.value : coerceLocalizedTextStrict(this._falseState || "FALSE");
     }
     // TODO : shall we care about overloading the remove_backward_reference method ?
     // some TrueSubState and FalseSubState relationship may be added later

package/src/tool_isSubtypeOf.ts

@@ -4,7 +4,6 @@
 
 import type {
     BaseNode,
-    BaseNodeEvents,
     UADataType,
     UAObjectType,
     UAReference,
@@ -26,11 +25,7 @@ function _filterSubType(reference: UAReference) {
 
 export type BaseNodeConstructor<T extends BaseNode> = new () => T;
 
-function _slow_isSubtypeOf<T extends UAType>(
-    this: T,
-    Class: typeof BaseNodeImpl,
-    baseType: T | NodeIdLike
-): boolean {
+function _slow_isSubtypeOf<T extends UAType>(this: T, Class: typeof BaseNodeImpl, baseType: T | NodeIdLike): boolean {
     if (!(baseType instanceof Class)) {
         const node = this.addressSpace.findNode(baseType as NodeIdLike);
         if (!node || !(node instanceof Class)) {
@@ -117,9 +112,7 @@ export type IsSubtypeOfFunc<T extends UAType> = (this: T, baseType: T) => boolea
 
 export type UAType = UAReferenceType | UADataType | UAObjectType | UAVariableType;
 
-export function construct_isSubtypeOf<T extends UAType>(
-    Class: typeof BaseNodeImpl
-): IsSubtypeOfFunc<T> {
+export function construct_isSubtypeOf<T extends UAType>(Class: typeof BaseNodeImpl): IsSubtypeOfFunc<T> {
     return wrap_memoize(function (this: T, baseType: T | NodeIdLike): boolean {
         if (!(baseType instanceof Class)) {
             throw new Error(

package/src/ua_data_type_impl.ts

@@ -272,7 +272,6 @@ export class UADataTypeImpl extends BaseNodeImpl implements UADataType {
         return definition as EnumDefinition;
     }
 
-    // eslint-disable-next-line complexity
     public _getDefinition(): DataTypeDefinition | null {
         if (this.$fullDefinition !== undefined) {
             return this.$fullDefinition;
@@ -314,7 +313,6 @@ export class UADataTypeImpl extends BaseNodeImpl implements UADataType {
             this.$fullDefinition = makeStructureDefinition(basicDataType, defaultEncodingId, definitionFields, isUnion);
         } else if (isEnumeration) {
             const allPartialDefinitions: StructureFieldOptions[][] = [];
-            // eslint-disable-next-line @typescript-eslint/no-this-alias
             let dataTypeNode: UADataTypeImpl | null = this;
             while (dataTypeNode && !isRootDataType(dataTypeNode)) {
                 if (dataTypeNode.$partialDefinition) {
@@ -420,10 +418,12 @@ function makeStructureDefinition(
     const hasSubtypedFields = fields.filter((field) => field.allowSubTypes).length > 0;
 
     if (hasSubtypedFields && doDebug) {
-        debugLog("Fields with subtypes:");
+        // c8 ignore next
+        doDebug && debugLog("Fields with subtypes:");
         for (const field of fields) {
             if (field.allowSubTypes) {
-                debugLog("  ", field.name, field.dataType?.toString());
+                // c8 ignore next
+                doDebug && debugLog("  ", field.name, field.dataType?.toString());
             }
         }
     }

package/src/ua_method_impl.ts

@@ -15,7 +15,7 @@ import {
     type MethodFunctorC,
     makeDefaultCloneExtraInfo,
     type UAMethod,
-    type UAMethodEvents, 
+    type UAMethodEvents,
     type UAObject,
     type UAObjectType,
     type UAVariable
@@ -23,7 +23,7 @@ import {
 import { assert } from "node-opcua-assert";
 import { AttributeIds, type DiagnosticInfo, NodeClass, type QualifiedNameLike } from "node-opcua-data-model";
 import { DataValue, type DataValueLike } from "node-opcua-data-value";
-import { make_debugLog, make_errorLog, make_warningLog } from "node-opcua-debug";
+import { checkDebugFlag, make_debugLog, make_errorLog, make_warningLog } from "node-opcua-debug";
 import type { NodeId } from "node-opcua-nodeid";
 import type { NumericRange } from "node-opcua-numeric-range";
 import { Argument } from "node-opcua-service-call";
@@ -38,6 +38,7 @@ import { _handle_hierarchy_parent } from "./namespace_impl";
 
 const warningLog = make_warningLog(__filename);
 const debugLog = make_debugLog(__filename);
+const doDebug = checkDebugFlag(__filename);
 const errorLog = make_errorLog(__filename);
 
 function default_check_valid_argument(arg: unknown): boolean {
@@ -157,7 +158,7 @@ export class UAMethodImpl extends BaseNodeImpl<UAMethodEvents> implements UAMeth
         inputArguments: VariantLike[] | null,
         context: ISessionContext,
         callback?: CallbackT<CallMethodResultOptions>
-    ): any {
+    ): Promise<CallMethodResultOptions> | undefined {
         // c8 ignore next
         if (!callback) {
             throw new Error("execute need to be promisified");
@@ -174,7 +175,8 @@ export class UAMethodImpl extends BaseNodeImpl<UAMethodEvents> implements UAMeth
         // c8 ignore next
         if (!object) {
             errorLog("UAMethod#execute expects a valid object");
-            return callback(null, { statusCode: StatusCodes.BadInternalError });
+            callback(null, { statusCode: StatusCodes.BadInternalError });
+            return;
         }
 
         if (object.nodeClass !== NodeClass.Object && object.nodeClass !== NodeClass.ObjectType) {
@@ -186,24 +188,29 @@ export class UAMethodImpl extends BaseNodeImpl<UAMethodEvents> implements UAMeth
                     " called for a node that is not a Object/ObjectType but " +
                     NodeClass[context.object?.nodeClass as number]
             );
-            return callback(null, { statusCode: StatusCodes.BadNodeIdInvalid });
+            callback(null, { statusCode: StatusCodes.BadNodeIdInvalid });
+            return;
         }
         if (!this._asyncExecutionFunction) {
             warningLog(`Method ${this.nodeId.toString()} ${this.browseName.toString()} has not been bound`);
-            return callback(null, { statusCode: StatusCodes.BadInternalError });
+            callback(null, { statusCode: StatusCodes.BadInternalError });
+            return;
         }
 
         if (!this.getExecutableFlag(context)) {
             warningLog(`Method ${this.nodeId.toString()} ${this.browseName.toString()} is not executable`);
-            return callback(null, { statusCode: StatusCodes.BadNotExecutable });
+            callback(null, { statusCode: StatusCodes.BadNotExecutable });
+            return;
         }
 
         if (context.isAccessRestricted(this)) {
-            return callback(null, { statusCode: StatusCodes.BadSecurityModeInsufficient });
+            callback(null, { statusCode: StatusCodes.BadSecurityModeInsufficient });
+            return;
         }
 
         if (!context.checkPermission(this, PermissionType.Call)) {
-            return callback(null, { statusCode: StatusCodes.BadUserAccessDenied });
+            callback(null, { statusCode: StatusCodes.BadUserAccessDenied });
+            return;
         }
 
         // verify that input arguments are correct
@@ -240,7 +247,8 @@ export class UAMethodImpl extends BaseNodeImpl<UAMethodEvents> implements UAMeth
                         inputArgumentResults: coercedInputArguments?.map(() => status) || [],
                         inputArgumentDiagnosticInfos
                     };
-                    return callback?.(null, callMethodResult);
+                    callback?.(null, callMethodResult);
+                    return;
                 }
             }
 
@@ -252,8 +260,11 @@ export class UAMethodImpl extends BaseNodeImpl<UAMethodEvents> implements UAMeth
                     context,
                     (err: Error | null, callMethodResult?: CallMethodResultOptions) => {
                         if (err) {
-                            debugLog(err.message);
-                            debugLog(err);
+                            // c8 ignore next
+                            if (doDebug) {
+                                debugLog(err.message);
+                                debugLog(err);
+                            }
                         }
                         callMethodResult = callMethodResult || {};
 
@@ -296,6 +307,7 @@ export class UAMethodImpl extends BaseNodeImpl<UAMethodEvents> implements UAMeth
             const callMethodResponse = { statusCode: StatusCodes.BadInternalError };
             callback?.(err as Error, callMethodResponse);
         });
+        return undefined;
     }
 
     public clone(options: CloneOptions, optionalFilter?: CloneFilter, extraInfo?: CloneExtraInfo): UAMethod {
@@ -345,8 +357,6 @@ export class UAMethodImpl extends BaseNodeImpl<UAMethodEvents> implements UAMeth
     }
 }
 
-// tslint:disable:no-var-requires
-// tslint:disable:max-line-length
 import { withCallback } from "thenify-ex";
 
 UAMethodImpl.prototype.execute = withCallback(UAMethodImpl.prototype.execute);

package/src/ua_object_type_impl.ts

@@ -12,21 +12,24 @@ import type {
     UAReference
 } from "node-opcua-address-space-base";
 import { assert } from "node-opcua-assert";
-import { AttributeIds, NodeClass } from "node-opcua-data-model";
+import { AttributeIds, type LocalizedTextLike, NodeClass } from "node-opcua-data-model";
 import { DataValue, type DataValueLike } from "node-opcua-data-value";
 import type { NodeId } from "node-opcua-nodeid";
 import { StatusCodes } from "node-opcua-status-code";
-import { isNullOrUndefined } from "node-opcua-utils";
 import { DataType } from "node-opcua-variant";
 
 import { SessionContext } from "../source/session_context";
 import { initialize_properties_and_components } from "./_instantiate_helpers";
 import type { AddressSpacePrivate } from "./address_space_private";
-import { BaseNodeImpl } from "./base_node_impl";
+import { BaseNodeImpl, type InternalBaseNodeOptions } from "./base_node_impl";
 import { ToStringBuilder, UAObjectType_toString } from "./base_node_private";
 import { construct_isSubtypeOf, get_subtypeOf, get_subtypeOfObj } from "./tool_isSubtypeOf";
 import { assertUnusedChildBrowseName, topMostParentIsObjectTypeOrVariableType } from "./ua_variable_type_impl";
 
+export interface UAObjectTypeOptions extends InternalBaseNodeOptions {
+    isAbstract?: boolean | null;
+}
+
 export class UAObjectTypeImpl extends BaseNodeImpl<BaseNodeEvents> implements UAObjectType {
     public readonly nodeClass = NodeClass.ObjectType;
     public readonly isAbstract: boolean;
@@ -48,9 +51,9 @@ export class UAObjectTypeImpl extends BaseNodeImpl<BaseNodeEvents> implements UA
     /** @deprecated - use  isSubtypeOf instead */
     public isSupertypeOf = construct_isSubtypeOf<UAObjectType>(UAObjectTypeImpl);
 
-    constructor(options: any) {
+    constructor(options: UAObjectTypeOptions) {
         super(options);
-        this.isAbstract = isNullOrUndefined(options.isAbstract) ? false : options.isAbstract;
+        this.isAbstract = options.isAbstract ?? false;
     }
 
     public readAttribute(context: ISessionContext, attributeId: AttributeIds): DataValue {
@@ -123,7 +126,10 @@ export class UAObjectTypeImpl extends BaseNodeImpl<BaseNodeEvents> implements UA
             browseName: options.browseName,
             componentOf: options.componentOf,
             displayName: options.displayName || "",
-            description: options.description === undefined ? this.description?.clone() : options.description,
+            description:
+                options.description === undefined
+                    ? (this.description?.clone() as LocalizedTextLike | undefined)
+                    : options.description,
             encodingOf: options.encodingOf,
             eventSourceOf: options.eventSourceOf,
             notifierOf: options.notifierOf,

package/src/ua_reference_type_impl.ts

@@ -4,7 +4,7 @@
 
 import type { BaseNodeEvents, UAReference, UAReferenceType } from "node-opcua-address-space-base";
 import { assert } from "node-opcua-assert";
-import { AttributeIds, coerceLocalizedText, LocalizedText, type LocalizedTextOptions, NodeClass } from "node-opcua-data-model";
+import { AttributeIds, LocalizedText, type LocalizedTextOptions, NodeClass } from "node-opcua-data-model";
 import { DataValue, type DataValueLike } from "node-opcua-data-value";
 import type { NodeId } from "node-opcua-nodeid";
 import { StatusCodes } from "node-opcua-status-code";
@@ -112,8 +112,7 @@ export class UAReferenceTypeImpl extends BaseNodeImpl<BaseNodeEvents> implements
         this.isAbstract = options.isAbstract === undefined ? false : !!options.isAbstract;
         this.symmetric = options.symmetric === undefined ? false : !!options.symmetric;
         // Note: Inverse name is not required anymore in 1.0.4
-        this.inverseName =
-            new LocalizedText(options.inverseName || this.browseName.name);
+        this.inverseName = new LocalizedText(options.inverseName || this.browseName.name);
 
         ReferenceTypeCounter.count += 1;
     }