node-opcua-address-space 2.132.0 → 2.133.0

package/distHelpers/assertHasMatchingReference.d.ts

@@ -2,7 +2,7 @@ import { AddReferenceOpts, BaseNode } from "..";
 /**
  * asserts that the provided reference exists in the node references
  *
- * @method assertHasMatchingReference
+
  *
  * @param node
  * @param reference (Reference}

package/distHelpers/assertHasMatchingReference.js

@@ -9,7 +9,7 @@ const node_opcua_nodeid_1 = require("node-opcua-nodeid");
 /**
  * asserts that the provided reference exists in the node references
  *
- * @method assertHasMatchingReference
+
  *
  * @param node
  * @param reference (Reference}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-opcua-address-space",
-    "version": "2.132.0",
+    "version": "2.133.0",
     "description": "pure nodejs OPCUA SDK - module address-space",
     "main": "./dist/src/index_current.js",
     "types": "./dist/source/index.d.ts",
@@ -16,54 +16,54 @@
         "c": "mocha --version"
     },
     "dependencies": {
-        "@types/lodash": "4.17.7",
+        "@types/lodash": "4.17.9",
         "@types/semver": "^7.5.8",
         "async": "^3.2.6",
         "chalk": "4.1.2",
         "dequeue": "^1.0.5",
         "lodash": "4.17.21",
-        "node-opcua-address-space-base": "2.132.0",
+        "node-opcua-address-space-base": "2.133.0",
         "node-opcua-assert": "2.120.0",
-        "node-opcua-basic-types": "2.132.0",
-        "node-opcua-binary-stream": "2.128.0",
-        "node-opcua-client-dynamic-extension-object": "2.132.0",
+        "node-opcua-basic-types": "2.133.0",
+        "node-opcua-binary-stream": "2.133.0",
+        "node-opcua-client-dynamic-extension-object": "2.133.0",
         "node-opcua-constants": "2.125.0",
-        "node-opcua-crypto": "4.9.4",
-        "node-opcua-data-access": "2.132.0",
-        "node-opcua-data-model": "2.132.0",
-        "node-opcua-data-value": "2.132.0",
-        "node-opcua-date-time": "2.132.0",
-        "node-opcua-debug": "2.128.0",
-        "node-opcua-enum": "2.128.0",
-        "node-opcua-extension-object": "2.132.0",
-        "node-opcua-factory": "2.132.0",
-        "node-opcua-nodeid": "2.128.0",
-        "node-opcua-nodeset-ua": "2.132.0",
-        "node-opcua-numeric-range": "2.132.0",
-        "node-opcua-object-registry": "2.128.0",
-        "node-opcua-pseudo-session": "2.132.0",
-        "node-opcua-service-browse": "2.132.0",
-        "node-opcua-service-call": "2.132.0",
-        "node-opcua-service-history": "2.132.0",
-        "node-opcua-service-translate-browse-path": "2.132.0",
-        "node-opcua-service-write": "2.132.0",
-        "node-opcua-status-code": "2.128.0",
-        "node-opcua-types": "2.132.0",
-        "node-opcua-utils": "2.128.0",
-        "node-opcua-variant": "2.132.0",
-        "node-opcua-xml2json": "2.128.0",
+        "node-opcua-crypto": "4.10.0",
+        "node-opcua-data-access": "2.133.0",
+        "node-opcua-data-model": "2.133.0",
+        "node-opcua-data-value": "2.133.0",
+        "node-opcua-date-time": "2.133.0",
+        "node-opcua-debug": "2.133.0",
+        "node-opcua-enum": "2.133.0",
+        "node-opcua-extension-object": "2.133.0",
+        "node-opcua-factory": "2.133.0",
+        "node-opcua-nodeid": "2.133.0",
+        "node-opcua-nodeset-ua": "2.133.0",
+        "node-opcua-numeric-range": "2.133.0",
+        "node-opcua-object-registry": "2.133.0",
+        "node-opcua-pseudo-session": "2.133.0",
+        "node-opcua-service-browse": "2.133.0",
+        "node-opcua-service-call": "2.133.0",
+        "node-opcua-service-history": "2.133.0",
+        "node-opcua-service-translate-browse-path": "2.133.0",
+        "node-opcua-service-write": "2.133.0",
+        "node-opcua-status-code": "2.133.0",
+        "node-opcua-types": "2.133.0",
+        "node-opcua-utils": "2.133.0",
+        "node-opcua-variant": "2.133.0",
+        "node-opcua-xml2json": "2.133.0",
         "semver": "^7.6.3",
         "set-prototype-of": "^1.0.0",
         "thenify": "^3.3.1",
         "xml-writer": "^1.7.0"
     },
     "devDependencies": {
-        "node-opcua-benchmarker": "2.128.0",
-        "node-opcua-leak-detector": "2.128.0",
+        "node-opcua-benchmarker": "2.133.0",
+        "node-opcua-leak-detector": "2.133.0",
         "node-opcua-nodesets": "2.121.0",
-        "node-opcua-packet-analyzer": "2.132.0",
-        "node-opcua-service-filter": "2.132.0",
-        "node-opcua-test-fixtures": "2.132.0",
+        "node-opcua-packet-analyzer": "2.133.0",
+        "node-opcua-service-filter": "2.133.0",
+        "node-opcua-test-fixtures": "2.133.0",
         "source-map-support": "^0.5.21"
     },
     "author": "Etienne Rossignon",
@@ -81,7 +81,7 @@
         "internet of things"
     ],
     "homepage": "http://node-opcua.github.io/",
-    "gitHead": "5fab0f1eac0e59abf94bab9034035aec44890456",
+    "gitHead": "921bb04f2e7ce3109dd051ff27a2210edf700344",
     "files": [
         "dist",
         "distHelpers",

package/source/helpers/argument_list.ts

@@ -229,12 +229,7 @@ export function isArgumentValid(addressSpace: IAddressSpace, argDefinition: Argu
 }
 
 /**
- * @method verifyArguments_ArgumentList
- * @param addressSpace
- * @param methodInputArguments
- * @param inputArguments
- * @return statusCode,inputArgumentResults
- */
+*/
 export function verifyArguments_ArgumentList(
     addressSpace: IAddressSpace,
     methodInputArguments: Argument[],

package/source/helpers/dump_tools.ts

@@ -66,10 +66,6 @@ export function dumpBrowseDescription(node: BaseNode, _browseDescription: Browse
 }
 
 /**
- * @method dumpReferences
- * @param addressSpace    {IAddressSpace}
- * @param references  {Array<Reference>|null}
- * @static
  */
 export function dumpReferences(addressSpace: IAddressSpace, references: UAReference[]): void {
     assert(addressSpace);

package/source/interfaces/alarms_and_conditions/condition_snapshot.ts

@@ -30,52 +30,32 @@ export interface ConditionSnapshot extends EventEmitter {
     branchId: NodeId | null;
 
     /**
-     * @method getBrandId
-     * @return {NodeId}
      */
     getBranchId(): NodeId;
     /**
-     * @method getEventId
-     * @return {ByteString}
      */
     getEventId(): Buffer;
     /**
-     * @method getRetain
-     * @return {Boolean}
      */
     getRetain(): boolean;
     /**
-     *
-     * @method setRetain
-     * @param retainFlag {Boolean}
      */
     setRetain(retainFlag: boolean): void;
 
     /**
-     * @method renewEventId
-     *
      */
     renewEventId(): void;
 
     /**
-     * @method getEnabledState
-     * @return {Boolean}
      */
     getEnabledState(): boolean;
     /**
-     * @method setEnabledState
-     * @param value {Boolean}
-     * @return void
      */
     setEnabledState(value: boolean, options?: ISetStateOptions): void;
     /**
-     * @method getEnabledStateAsString
-     * @return {String}
      */
     getEnabledStateAsString(): string;
     /**
-     * @method getComment
-     * @return {LocalizedText}
      */
     getComment(): LocalizedText;
 
@@ -88,20 +68,14 @@ export interface ConditionSnapshot extends EventEmitter {
      * a Method provides as an option the ability to set a Comment, then the value of this Variable is
      * reset to null if an optional comment is not provided.
      *
-     * @method setComment
-     * @param txtMessage {LocalizedText}
      */
     setComment(txtMessage: LocalizedTextLike, options?: IConditionVariableTypeSetterOptions): void;
     /**
      *
-     * @method setMessage
-     * @param txtMessage {LocalizedText}
      */
     setMessage(txtMessage: LocalizedTextLike | LocalizedText): void;
 
     /**
-     * @method setClientUserId
-     * @param userIdentity {String}
      */
     setClientUserId(userIdentity: string): void;
     /*
@@ -131,13 +105,10 @@ export interface ConditionSnapshot extends EventEmitter {
 
     /**
      * set the condition quality
-     * @method setQuality
-     * @param quality {StatusCode}
      */
     setQuality(quality: StatusCode, options?: IConditionVariableTypeSetterOptions): void;
     /**
-     * @method getQuality
-     * @return {StatusCode}
+     * 
      */
     getQuality(): StatusCode;
     /*
@@ -170,15 +141,9 @@ export interface ConditionSnapshot extends EventEmitter {
      * of 667 to 1 000, Events of medium urgency into the OPC severity range of 334 to 666 and
      * Events of low urgency into OPC severities of 1 to 333.
      */
-    /**
-     * @method setSeverity
-     * @param severity {UInt16}
-     */
     setSeverity(severity: UInt16, options?: IConditionVariableTypeSetterOptions): void;
 
     /**
-     * @method getSeverity
-     * @return {UInt16}
      */
     getSeverity(): UInt16;
 
@@ -189,14 +154,8 @@ export interface ConditionSnapshot extends EventEmitter {
      *  supplied via the Severity Property which is inherited from the BaseEventType.
      *
      */
-    /**
-     * @method setLastSeverity
-     * @param severity {UInt16}
-     */
     setLastSeverity(severity: UInt16, options?: IConditionVariableTypeSetterOptions): void;
     /**
-     * @method getLastSeverity
-     * @return {UInt16}
      */
     getLastSeverity(): UInt16;
 
@@ -216,8 +175,6 @@ export interface ConditionSnapshot extends EventEmitter {
      * The ReceiveTime shall always be returned as value and the Server is not allowed to return a
      * StatusCode for the ReceiveTime indicating an error.
      *
-     * @method setReceiveTime
-     * @param time {Date} : UTCTime
      */
     setReceiveTime(time: UtcTime): void;
     /**
@@ -226,33 +183,27 @@ export interface ConditionSnapshot extends EventEmitter {
      * possible. It often comes from the underlying system or device. Once set, intermediate OPC UA
      * Servers shall not alter the value.
      *
-     * @method setTime
-     * @param time {Date}
      */
     setTime(time: Date): void;
     /**
      * LocalTime is a structure containing the Offset and the DaylightSavingInOffset flag. The Offset
      * specifies the time difference (in minutes) between the Time Property and the time at the location
      * in which the event was issued. If DaylightSavingInOffset is TRUE, then Standard/Daylight
-     * savings time (DST) at the originating location is in effect and Offset includes the DST c orrection.
+     * savings time (DST) at the originating location is in effect and Offset includes the DST correction.
      * If FALSE then the Offset does not include DST correction and DST may or may not have been
      * in effect.
-     * @method setLocalTime
-     * @param localTime {TimeZone}
      */
     setLocalTime(localTime: TimeZoneDataType): void;
 
     // read only !
     getSourceName(): LocalizedText;
     /**
-     * @method getSourceNode
-     * return {NodeId}
+     *
      */
     getSourceNode(): NodeId;
 
     /**
-     * @method getEventType
-     * return {NodeId}
+     * 
      */
     getEventType(): NodeId;
     getMessage(): LocalizedText;

package/source/interfaces/state_machine/ua_shelved_state_machine_ex.ts

@@ -7,7 +7,7 @@ import { UATransitionEx } from "./ua_transition_ex";
 
 export interface UAShelvedStateMachineHelper {
     _timer: NodeJS.Timer | null;
-    _sheveldTime: Date;
+    _shelvedTime: Date;
     _unshelvedTime: Date;
     _duration: number;
 }

package/source/loader/load_nodeset2.ts

@@ -338,9 +338,6 @@ function makeNodeSetParserEngine(addressSpace: IAddressSpace, options: NodeSetLo
     /**
      * convert a nodeId
      *
-     * @method convertToNodeId
-     * @param nodeId {String|null}
-     * @return {NodeId}
      *
      * @example
      *    convertToNodeId("String") => resolve alias

package/source/session_context.ts

@@ -320,10 +320,6 @@ export class SessionContext implements ISessionContext {
         return false;
     }
     /**
-     * @method checkPermission
-     * @param node
-     * @param requestedPermission
-     * @return {Boolean} returns true of the current user is granted the requested Permission
      */
     public checkPermission(node: BaseNode, requestedPermission: PermissionType): boolean {
         const permissions = this.getPermissions(node);

package/src/address_space.ts

@@ -124,9 +124,6 @@ function _extract_namespace_and_browse_name_as_string(
 
 /**
  * returns true if str matches a nodeID, e.g i=123 or ns=...
- * @method isNodeIdString
- * @param str
- * @type {boolean}
  */
 function isNodeIdString(str: unknown): boolean {
     if (typeof str !== "string") {
@@ -200,9 +197,6 @@ export class AddressSpace implements AddressSpacePrivate {
     }
 
     /***
-     * @method getNamespace
-     * @param {string|number} namespace index or namespace uri.
-     * @return {NameSpace} the namespace
      */
     public getNamespace(namespaceIndexOrName: string | number): NamespacePrivate {
         if (typeof namespaceIndexOrName === "number") {
@@ -218,7 +212,6 @@ export class AddressSpace implements AddressSpacePrivate {
     }
 
     /***
-     * @method getDefaultNamespace
      * @return  the  default namespace (standard OPCUA namespace)
      */
     public getDefaultNamespace(): NamespacePrivate {
@@ -226,7 +219,6 @@ export class AddressSpace implements AddressSpacePrivate {
     }
 
     /***
-     * @method getOwnNamespace
      *
      * objects instances managed by the server will be created in this namespace.
      *
@@ -241,8 +233,6 @@ export class AddressSpace implements AddressSpacePrivate {
     }
 
     /**
-     * @method getNamespaceIndex
-     * @param namespaceUri
      * @return the namespace index of a namespace given by its namespace uri
      *
      */
@@ -252,7 +242,6 @@ export class AddressSpace implements AddressSpacePrivate {
     }
 
     /**
-     * @method registerNamespace
      *
      * register a new namespace,
      * it is OK to call registerNamespace even if namespace has already been registered; 
@@ -281,7 +270,6 @@ export class AddressSpace implements AddressSpacePrivate {
     }
 
     /***
-     * @method getNamespaceArray
      * @return {Namespace[]} the namespace array
      */
     public getNamespaceArray(): NamespacePrivate[] {
@@ -290,7 +278,6 @@ export class AddressSpace implements AddressSpacePrivate {
 
     /**
      *
-     * @method addAlias
      * @param alias {String} the alias name
      * @param nodeId {NodeId}
      * @internal
@@ -303,7 +290,6 @@ export class AddressSpace implements AddressSpacePrivate {
 
     /**
      * find an node by node Id
-     * @method findNode
      * @param nodeId   a nodeId or a string coerce-able to nodeID, representing the object to find.
      * @return {BaseNode|null}
      */
@@ -351,7 +337,6 @@ export class AddressSpace implements AddressSpacePrivate {
 
     /**
      *
-     * @method findObjectType
      * @param objectType  {String|NodeId|QualifiedName}
      * @param [namespaceIndex=0 {Number}] an optional namespace index
      * @return {UAObjectType|null}
@@ -386,7 +371,6 @@ export class AddressSpace implements AddressSpacePrivate {
     }
 
     /**
-     * @method findVariableType
      * @param variableType  {String|NodeId}
      * @param [namespaceIndex=0 {Number}] an optional namespace index
      * @return {UAObjectType|null}
@@ -414,7 +398,6 @@ export class AddressSpace implements AddressSpacePrivate {
 
     /**
      * Find the DataType node from a NodeId or a browseName
-     * @method findDataType
      * @param dataType {String|NodeId}
      * @param [namespaceIndex=0 {Number}] an optional namespace index
      * @return {DataType|null}
@@ -457,7 +440,6 @@ export class AddressSpace implements AddressSpacePrivate {
     }
 
     /**
-     * @method findCorrespondingBasicDataType
      *
      * @example
      *
@@ -521,7 +503,6 @@ export class AddressSpace implements AddressSpacePrivate {
 
     /**
      * find a ReferenceType by its inverse name.
-     * @method findReferenceTypeFromInverseName
      * @param inverseName  the inverse name of the ReferenceType to find
      * @deprecated
      */
@@ -530,7 +511,6 @@ export class AddressSpace implements AddressSpacePrivate {
     }
 
     /**
-     * @method findReferenceType
      * @param refType {String|NodeId}
      * @param [namespaceIndex=0 {Number}] an optional namespace index
      * @return {ReferenceType|null}
@@ -577,7 +557,6 @@ export class AddressSpace implements AddressSpacePrivate {
     /**
      * returns the inverse name of the referenceType.
      *
-     * @method inverseReferenceType
      * @param referenceType {String} : the reference type name
      * @return {String} the name of the inverse reference type.
      *
@@ -604,7 +583,6 @@ export class AddressSpace implements AddressSpacePrivate {
 
     /**
      * find an EventType node in the address space
-     * @method findEventType
      * @param eventTypeId {String|NodeId|UAObjectType} the eventType to find
      * @param namespaceIndex the namespace index of the event to find
      * @return {UAObjectType|null} the EventType found or null.
@@ -650,7 +628,6 @@ export class AddressSpace implements AddressSpacePrivate {
 
     /**
      * EventId is generated by the Server to uniquely identify a particular Event Notification.
-     * @method generateEventId
      * @return {Variant}  dataType: "ByteString"
      */
     public generateEventId(): VariantT<Buffer, DataType.ByteString> {
@@ -679,7 +656,6 @@ export class AddressSpace implements AddressSpacePrivate {
 
     /*=
      * construct a simple javascript object with all the default properties of the event
-     * @method constructEventData
      *
      * @return result.$eventDataSource {BaseNode} the event type node
      * @return result.eventId {NodeId} the
@@ -892,7 +868,6 @@ export class AddressSpace implements AddressSpacePrivate {
     /**
      * browse some path.
      *
-     * @method browsePath
      * @param  {BrowsePath} browsePath
      * @return {BrowsePathResult}
      *
@@ -1068,7 +1043,6 @@ export class AddressSpace implements AddressSpacePrivate {
 
     /**
      * cleanup all resources maintained by this addressSpace.
-     * @method dispose
      */
     public dispose(): void {
         this._namespaceArray.map((namespace: NamespacePrivate) => namespace.dispose());
@@ -1081,7 +1055,6 @@ export class AddressSpace implements AddressSpacePrivate {
 
     /**
      * register a function that will be called when the server will perform its shut down.
-     * @method registerShutdownTask
      */
     public registerShutdownTask(task: ShutdownTask): void {
         this._shutdownTask = this._shutdownTask || [];
@@ -1182,7 +1155,6 @@ export class AddressSpace implements AddressSpacePrivate {
      * walk up the hierarchy of objects until a view is found
      * objects may belong to multiples views.
      * Note: this method doesn't return the main view => Server object.
-     * @method extractRootViews
      * @param node {BaseNode}
      * @return {BaseNode[]}
      */
@@ -1548,7 +1520,6 @@ function _find_by_node_id<T extends BaseNode>(addressSpace: AddressSpace, nodeId
 
 /**
  * return true if nodeId is a UAFolder
- * @method _isFolder
  * @param addressSpace
  * @param folder
  * @return {Boolean}

package/src/alarms_and_conditions/condition.ts

@@ -42,19 +42,20 @@ function prepare_date(sourceTimestamp: { value: Date } | null) {
  A Condition’s EnabledState effects the generation of Event Notifications and as such results
  in the following specific behaviour:
  * When the Condition instance enters the Disabled state, the Retain Property of this
- Condition shall be set to FALSE by the Server to indicate to the Client that the
- Condition instance is currently not of interest to Clients.
+   Condition shall be set to FALSE by the Server to indicate to the Client that the
+   Condition instance is currently not of interest to Clients.
  * When the Condition instance enters the enabled state, the Condition shall be
- evaluated and all of its Properties updated to reflect the current values. If this
- evaluation causes the Retain Property to transition to TRUE for any ConditionBranch,
- then an Event Notification shall be generated for that ConditionBranch.
+   evaluated and all of its Properties updated to reflect the current values. If this
+   evaluation causes the Retain Property to transition to TRUE for any ConditionBranch,
+   then an Event Notification shall be generated for that ConditionBranch.
  * The Server may choose to continue to test for a Condition instance while it is
- Disabled. However, no Event Notifications will be generated while the Condition
- instance is disabled.
+   Disabled. However, no Event Notifications will be generated while the Condition
+   instance is disabled.
  * For any Condition that exists in the Address Space the Attributes and the following
- Variables will continue to have valid values even in the Disabled state; EventId, Event
- Type, Source Node, Source Name, Time, and EnabledState.
- Other properties may no longer provide current valid values.
+   Variables will continue to have valid values even in the Disabled state; EventId, Event
+   Type, Source Node, Source Name, Time, and EnabledState.
+   Other properties may no longer provide current valid values.
+   
  All Variables that are no longer provided shall return a status of BadConditionDisabled.
  The Event that reports the Disabled state  should report the properties as NULL or with a status
  of BadConditionDisabled.
@@ -75,9 +76,9 @@ function prepare_date(sourceTimestamp: { value: Date } | null) {
  // case, the SourceNode of this ReferenceType shall be an ObjectType or VariableType Node or
  // one of their InstanceDeclaration Nodes. The TargetNode shall be a Condition instance
  // declaration or a ConditionType. The following rules for instantiation apply:
- //  All HasCondition References used in a Type shall exist in instances of these Types as
+ // *  All HasCondition References used in a Type shall exist in instances of these Types as
  //    well.
- //  If the TargetNode in the Type definition is a ConditionType, the same TargetNode will
+ // *  If the TargetNode in the Type definition is a ConditionType, the same TargetNode will
  //    be referenced on the instance.
  // HasCondition References may be used solely in the instance space when they are not
  // available in Type definitions. In this case the SourceNode of this ReferenceType shall be an

package/src/alarms_and_conditions/condition_info_impl.ts

@@ -9,13 +9,7 @@ import { ConditionInfo, ConditionInfoOptions } from "../../source/interfaces/ala
 
 
 /**
- * @class ConditionInfo
- * @param options  {Object}
- * @param options.message   {String|LocalizedText} the event message
- * @param options.severity  {UInt16} severity
- * @param options.quality   {StatusCode} quality
- * @param options.retain   {Boolean} retain flag
- * @constructor
+ * @private
  */
 export class ConditionInfoImpl implements ConditionInfo {
     public message: LocalizedText | null = null;
@@ -46,9 +40,7 @@ export class ConditionInfoImpl implements ConditionInfo {
     }
 
     /**
-     * @method isDifferentFrom
-     * @param otherConditionInfo {ConditionInfo}
-     * @return {Boolean}
+     * 
      */
     public isDifferentFrom(otherConditionInfo: ConditionInfo): boolean {
         return (