node-opcua-service-filter 2.56.2 → 2.61.0

package/LICENSE

@@ -1,20 +1,20 @@
-The MIT License (MIT)
-
-Copyright (c) 2014-2021 Etienne Rossignon
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2014-2021 Etienne Rossignon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-opcua-service-filter",
-    "version": "2.56.2",
+    "version": "2.61.0",
     "description": "pure nodejs OPCUA SDK - module -service-filter",
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
@@ -11,21 +11,21 @@
     },
     "dependencies": {
         "node-opcua-assert": "2.55.0",
-        "node-opcua-basic-types": "2.56.0",
+        "node-opcua-basic-types": "2.61.0",
         "node-opcua-binary-stream": "2.55.0",
         "node-opcua-constants": "2.52.0",
-        "node-opcua-data-model": "2.56.0",
-        "node-opcua-debug": "2.55.0",
-        "node-opcua-factory": "2.56.0",
-        "node-opcua-nodeid": "2.55.0",
-        "node-opcua-numeric-range": "2.56.0",
-        "node-opcua-service-translate-browse-path": "2.56.2",
+        "node-opcua-data-model": "2.61.0",
+        "node-opcua-debug": "2.61.0",
+        "node-opcua-factory": "2.61.0",
+        "node-opcua-nodeid": "2.61.0",
+        "node-opcua-numeric-range": "2.61.0",
+        "node-opcua-service-translate-browse-path": "2.61.0",
         "node-opcua-status-code": "2.56.0",
-        "node-opcua-types": "2.56.2",
-        "node-opcua-variant": "2.56.0"
+        "node-opcua-types": "2.61.0",
+        "node-opcua-variant": "2.61.0"
     },
     "devDependencies": {
-        "node-opcua-service-secure-channel": "2.56.2",
+        "node-opcua-service-secure-channel": "2.61.0",
         "should": "^13.2.3"
     },
     "author": "Etienne Rossignon",
@@ -43,5 +43,5 @@
         "internet of things"
     ],
     "homepage": "http://node-opcua.github.io/",
-    "gitHead": "45dbf2f65d96a91fae6e884bb5006af4249cf1fa"
+    "gitHead": "dd8776f047686ca791989f27e11ee48bfd8b61b7"
 }

package/source/imports.ts

@@ -1,33 +1,33 @@
-/**
- * @module node-opcua-service-filter
- */
-export  {
-
-    FilterOperator,
-
-    AttributeOperand,
-    ElementOperand,
-    FilterOperand,
-    LiteralOperand,
-    SimpleAttributeOperand,
-
-    MonitoringFilter,
-
-    ContentFilterElement,
-    ContentFilter,
-    EventFilter,
-    DataChangeFilter,
-
-    AttributeOperandOptions,
-    ElementOperandOptions,
-    FilterOperandOptions,
-    LiteralOperandOptions,
-    SimpleAttributeOperandOptions,
-
-    MonitoringFilterOptions,
-
-    ContentFilterElementOptions,
-    ContentFilterOptions,
-    EventFilterOptions
-
-} from "node-opcua-types";
+/**
+ * @module node-opcua-service-filter
+ */
+export  {
+
+    FilterOperator,
+
+    AttributeOperand,
+    ElementOperand,
+    FilterOperand,
+    LiteralOperand,
+    SimpleAttributeOperand,
+
+    MonitoringFilter,
+
+    ContentFilterElement,
+    ContentFilter,
+    EventFilter,
+    DataChangeFilter,
+
+    AttributeOperandOptions,
+    ElementOperandOptions,
+    FilterOperandOptions,
+    LiteralOperandOptions,
+    SimpleAttributeOperandOptions,
+
+    MonitoringFilterOptions,
+
+    ContentFilterElementOptions,
+    ContentFilterOptions,
+    EventFilterOptions
+
+} from "node-opcua-types";

package/source/index.ts

@@ -1,42 +1,42 @@
-/**
- * @module node-opcua-service-filter
- */
-export * from "./imports";
-export * from "./tools_event_filter";
-
-// The SimpleAttributeOperand is a simplified form of the AttributeOperand and all of the rules that
-// apply to the AttributeOperand also apply to the SimpleAttributeOperand. The examples provided in
-// B.1 only use AttributeOperand, however, the AttributeOperand can be replaced by a
-// SimpleAttributeOperand whenever all ReferenceTypes in the RelativePath are subtypes of
-// HierarchicalReferences and the targets are Object or Variable Nodes and an Alias is not required
-
-// typeDefinitionId
-// This parameter restricts the operand to instances of the TypeDefinitionNode or
-// one of its subtypes.
-// { name: "typeDefinitionId", fieldType:"NodeId",documentation:"NodeId of a TypeDefinitionNode."},
-
-// browsePath
-// A relative path to a Node.
-// This parameter specifies a relative path using a list of BrowseNames instead of
-// the RelativePath structure used in the AttributeOperand. The list of
-// BrowseNames is equivalent to a RelativePath that specifies forward references
-// which are subtypes of the HierarchicalReferences ReferenceType.
-// All Nodes followed by the browsePath shall be of the NodeClass Object or
-// Variable.
-// If this list is empty the Node is the instance of the TypeDefinition.
-//  { name: "browsePath", isArray:true, fieldType:"QualifiedName"},
-
-// Id of the Attribute. The IntegerId is defined in 7.13.
-// The Value Attribute shall be supported by all Servers. The support of other
-// Attributes depends on requirements set in Profiles or other parts of this
-// specification.
-// { name: "attributeId", fieldType:"IntegerId"},
-
-// This parameter is used to identify a single element of an array, or a single range
-// of indexes for an array. The first element is identified by index 0 (zero).
-// This parameter is ignored if the selected Node is not a Variable or the Value of a
-// Variable is not an array.
-// The parameter is null if not specified.
-// All values in the array are used if this parameter is not specified.
-// The NumericRange type is defined in 7.21.
-// { name: "indexRange", fieldType:"NumericRange"}
+/**
+ * @module node-opcua-service-filter
+ */
+export * from "./imports";
+export * from "./tools_event_filter";
+
+// The SimpleAttributeOperand is a simplified form of the AttributeOperand and all of the rules that
+// apply to the AttributeOperand also apply to the SimpleAttributeOperand. The examples provided in
+// B.1 only use AttributeOperand, however, the AttributeOperand can be replaced by a
+// SimpleAttributeOperand whenever all ReferenceTypes in the RelativePath are subtypes of
+// HierarchicalReferences and the targets are Object or Variable Nodes and an Alias is not required
+
+// typeDefinitionId
+// This parameter restricts the operand to instances of the TypeDefinitionNode or
+// one of its subtypes.
+// { name: "typeDefinitionId", fieldType:"NodeId",documentation:"NodeId of a TypeDefinitionNode."},
+
+// browsePath
+// A relative path to a Node.
+// This parameter specifies a relative path using a list of BrowseNames instead of
+// the RelativePath structure used in the AttributeOperand. The list of
+// BrowseNames is equivalent to a RelativePath that specifies forward references
+// which are subtypes of the HierarchicalReferences ReferenceType.
+// All Nodes followed by the browsePath shall be of the NodeClass Object or
+// Variable.
+// If this list is empty the Node is the instance of the TypeDefinition.
+//  { name: "browsePath", isArray:true, fieldType:"QualifiedName"},
+
+// Id of the Attribute. The IntegerId is defined in 7.13.
+// The Value Attribute shall be supported by all Servers. The support of other
+// Attributes depends on requirements set in Profiles or other parts of this
+// specification.
+// { name: "attributeId", fieldType:"IntegerId"},
+
+// This parameter is used to identify a single element of an array, or a single range
+// of indexes for an array. The first element is identified by index 0 (zero).
+// This parameter is ignored if the selected Node is not a Variable or the Value of a
+// Variable is not an array.
+// The parameter is null if not specified.
+// All values in the array are used if this parameter is not specified.
+// The NumericRange type is defined in 7.21.
+// { name: "indexRange", fieldType:"NumericRange"}

package/source/tools_event_filter.ts

@@ -1,169 +1,169 @@
-/**
- * @module node-opcua-service-filter
- */
-// tslint:disable:object-literal-shorthand
-// tslint:disable:only-arrow-functions
-// tslint:disable:max-line-length
-
-import { assert } from "node-opcua-assert";
-import { ObjectTypeIds } from "node-opcua-constants";
-import { AttributeIds, stringToQualifiedName } from "node-opcua-data-model";
-import { checkDebugFlag, make_debugLog } from "node-opcua-debug";
-import { makeNodeId, NodeId, resolveNodeId, sameNodeId } from "node-opcua-nodeid";
-import { DataType, Variant } from "node-opcua-variant";
-
-import { EventFilter, SimpleAttributeOperand } from "./imports";
-
-const debugLog = make_debugLog(__filename);
-const doDebug = checkDebugFlag(__filename);
-
-/**
- * helper to construct event filters:
- * construct a simple event filter
- *
- *
- * @example
- *
- *     constructEventFilter(["SourceName","Message","ReceiveTime"]);
- *
- *     constructEventFilter(["SourceName",{namespaceIndex:2 , "MyData"}]);
- *     constructEventFilter(["SourceName","2:MyData" ]);
- *
- *     constructEventFilter(["SourceName" ,["EnabledState","EffectiveDisplayName"] ]);
- *     constructEventFilter(["SourceName" ,"EnabledState.EffectiveDisplayName" ]);
- *
- */
-export function constructEventFilter(arrayOfNames: string[] | string, conditionTypes?: NodeId[] | NodeId): EventFilter {
-    if (!Array.isArray(arrayOfNames)) {
-        return constructEventFilter([arrayOfNames], conditionTypes);
-    }
-    if (conditionTypes && !Array.isArray(conditionTypes)) {
-        return constructEventFilter(arrayOfNames, [conditionTypes]);
-    }
-    // istanbul ignore next
-    if (!(arrayOfNames instanceof Array)) {
-        throw new Error("internal error");
-    }
-    // replace "string" element in the form A.B.C into [ "A","B","C"]
-    const arrayOfNames2 = arrayOfNames.map((path) => {
-        if (typeof path !== "string") {
-            return path;
-        }
-        return path.split(".");
-    });
-
-    const arrayOfNames3 = arrayOfNames2.map((path) => {
-        if (Array.isArray(path)) {
-            return path.map(stringToQualifiedName);
-        }
-        return path;
-    });
-    // replace "string" elements in arrayOfName with QualifiedName in namespace 0
-    const arrayOfNames4 = arrayOfNames3.map((s) => {
-        return typeof s === "string" ? stringToQualifiedName(s) : s;
-    });
-
-    // construct browse paths array
-    const browsePaths = arrayOfNames4.map((s) => {
-        return Array.isArray(s) ? s : [s];
-    });
-
-    // Part 4 page 127:
-    // In some cases the same BrowsePath will apply to multiple EventTypes. If the Client specifies the BaseEventType
-    // in the SimpleAttributeOperand then the Server shall evaluate the BrowsePath without considering the Type.
-
-    // [..]
-    // The SimpleAttributeOperand structure allows the Client to specify any Attribute, however, the Server is only
-    // required to support the Value Attribute for Variable Nodes and the NodeId Attribute for Object Nodes.
-    // That said, profiles defined in Part 7 may make support for additional Attributes mandatory.
-    let selectClauses = browsePaths.map((browsePath) => {
-        return new SimpleAttributeOperand({
-            attributeId: AttributeIds.Value,
-            browsePath,
-            indexRange: undefined, //  NumericRange
-            typeDefinitionId: makeNodeId(ObjectTypeIds.BaseEventType) // i=2041
-        });
-    });
-
-    if (conditionTypes && conditionTypes instanceof Array) {
-        const extraSelectClauses = conditionTypes.map((nodeId) => {
-            return new SimpleAttributeOperand({
-                attributeId: AttributeIds.NodeId,
-                browsePath: undefined,
-                indexRange: undefined, //  NumericRange
-                typeDefinitionId: nodeId // conditionType for instance
-            });
-        });
-        selectClauses = selectClauses.concat(extraSelectClauses);
-    }
-
-    const filter = new EventFilter({
-        selectClauses: selectClauses,
-
-        whereClause: {
-            // ContentFilter
-            elements: [
-                // ContentFilterElement
-                // {
-                //    filterOperator: FilterOperator.IsNull,
-                //    filterOperands: [ //
-                //        new ElementOperand({
-                //            index: 123
-                //        }),
-                //        new AttributeOperand({
-                //            nodeId: "i=10",
-                //            alias: "someText",
-                //            browsePath: { //RelativePath
-                //
-                //            },
-                //            attributeId: AttributeIds.Value
-                //        })
-                //    ]
-                // }
-            ]
-        }
-    });
-    return filter;
-}
-
-/**
- * @class SimpleAttributeOperand
- * @method toPath
- * @return {String}
- *
- * @example:
- *
- *
- */
-function simpleAttributeOperandToPath(self: SimpleAttributeOperand): string {
-    if (!self.browsePath) {
-        return "";
-    }
-    return self.browsePath
-        .map((a) => {
-            return a.name;
-        })
-        .join("/");
-}
-
-/**
- * @class SimpleAttributeOperand
- * @method toShortString
- * @return {String}
- *
- * @example:
- *
- *
- */
-export function simpleAttributeOperandToShortString(
-    self: SimpleAttributeOperand,
-    addressSpace: any // Address Space
-): string {
-    let str = "";
-    if (addressSpace) {
-        const n = addressSpace.findNode(self.typeDefinitionId)!;
-        str += n.BrowseName.toString();
-    }
-    str += "[" + self.typeDefinitionId.toString() + "]" + simpleAttributeOperandToPath(self);
-    return str;
-}
+/**
+ * @module node-opcua-service-filter
+ */
+// tslint:disable:object-literal-shorthand
+// tslint:disable:only-arrow-functions
+// tslint:disable:max-line-length
+
+import { assert } from "node-opcua-assert";
+import { ObjectTypeIds } from "node-opcua-constants";
+import { AttributeIds, stringToQualifiedName } from "node-opcua-data-model";
+import { checkDebugFlag, make_debugLog } from "node-opcua-debug";
+import { makeNodeId, NodeId, resolveNodeId, sameNodeId } from "node-opcua-nodeid";
+import { DataType, Variant } from "node-opcua-variant";
+
+import { EventFilter, SimpleAttributeOperand } from "./imports";
+
+const debugLog = make_debugLog(__filename);
+const doDebug = checkDebugFlag(__filename);
+
+/**
+ * helper to construct event filters:
+ * construct a simple event filter
+ *
+ *
+ * @example
+ *
+ *     constructEventFilter(["SourceName","Message","ReceiveTime"]);
+ *
+ *     constructEventFilter(["SourceName",{namespaceIndex:2 , "MyData"}]);
+ *     constructEventFilter(["SourceName","2:MyData" ]);
+ *
+ *     constructEventFilter(["SourceName" ,["EnabledState","EffectiveDisplayName"] ]);
+ *     constructEventFilter(["SourceName" ,"EnabledState.EffectiveDisplayName" ]);
+ *
+ */
+export function constructEventFilter(arrayOfNames: string[] | string, conditionTypes?: NodeId[] | NodeId): EventFilter {
+    if (!Array.isArray(arrayOfNames)) {
+        return constructEventFilter([arrayOfNames], conditionTypes);
+    }
+    if (conditionTypes && !Array.isArray(conditionTypes)) {
+        return constructEventFilter(arrayOfNames, [conditionTypes]);
+    }
+    // istanbul ignore next
+    if (!(arrayOfNames instanceof Array)) {
+        throw new Error("internal error");
+    }
+    // replace "string" element in the form A.B.C into [ "A","B","C"]
+    const arrayOfNames2 = arrayOfNames.map((path) => {
+        if (typeof path !== "string") {
+            return path;
+        }
+        return path.split(".");
+    });
+
+    const arrayOfNames3 = arrayOfNames2.map((path) => {
+        if (Array.isArray(path)) {
+            return path.map(stringToQualifiedName);
+        }
+        return path;
+    });
+    // replace "string" elements in arrayOfName with QualifiedName in namespace 0
+    const arrayOfNames4 = arrayOfNames3.map((s) => {
+        return typeof s === "string" ? stringToQualifiedName(s) : s;
+    });
+
+    // construct browse paths array
+    const browsePaths = arrayOfNames4.map((s) => {
+        return Array.isArray(s) ? s : [s];
+    });
+
+    // Part 4 page 127:
+    // In some cases the same BrowsePath will apply to multiple EventTypes. If the Client specifies the BaseEventType
+    // in the SimpleAttributeOperand then the Server shall evaluate the BrowsePath without considering the Type.
+
+    // [..]
+    // The SimpleAttributeOperand structure allows the Client to specify any Attribute, however, the Server is only
+    // required to support the Value Attribute for Variable Nodes and the NodeId Attribute for Object Nodes.
+    // That said, profiles defined in Part 7 may make support for additional Attributes mandatory.
+    let selectClauses = browsePaths.map((browsePath) => {
+        return new SimpleAttributeOperand({
+            attributeId: AttributeIds.Value,
+            browsePath,
+            indexRange: undefined, //  NumericRange
+            typeDefinitionId: makeNodeId(ObjectTypeIds.BaseEventType) // i=2041
+        });
+    });
+
+    if (conditionTypes && conditionTypes instanceof Array) {
+        const extraSelectClauses = conditionTypes.map((nodeId) => {
+            return new SimpleAttributeOperand({
+                attributeId: AttributeIds.NodeId,
+                browsePath: undefined,
+                indexRange: undefined, //  NumericRange
+                typeDefinitionId: nodeId // conditionType for instance
+            });
+        });
+        selectClauses = selectClauses.concat(extraSelectClauses);
+    }
+
+    const filter = new EventFilter({
+        selectClauses: selectClauses,
+
+        whereClause: {
+            // ContentFilter
+            elements: [
+                // ContentFilterElement
+                // {
+                //    filterOperator: FilterOperator.IsNull,
+                //    filterOperands: [ //
+                //        new ElementOperand({
+                //            index: 123
+                //        }),
+                //        new AttributeOperand({
+                //            nodeId: "i=10",
+                //            alias: "someText",
+                //            browsePath: { //RelativePath
+                //
+                //            },
+                //            attributeId: AttributeIds.Value
+                //        })
+                //    ]
+                // }
+            ]
+        }
+    });
+    return filter;
+}
+
+/**
+ * @class SimpleAttributeOperand
+ * @method toPath
+ * @return {String}
+ *
+ * @example:
+ *
+ *
+ */
+function simpleAttributeOperandToPath(self: SimpleAttributeOperand): string {
+    if (!self.browsePath) {
+        return "";
+    }
+    return self.browsePath
+        .map((a) => {
+            return a.name;
+        })
+        .join("/");
+}
+
+/**
+ * @class SimpleAttributeOperand
+ * @method toShortString
+ * @return {String}
+ *
+ * @example:
+ *
+ *
+ */
+export function simpleAttributeOperandToShortString(
+    self: SimpleAttributeOperand,
+    addressSpace: any // Address Space
+): string {
+    let str = "";
+    if (addressSpace) {
+        const n = addressSpace.findNode(self.typeDefinitionId)!;
+        str += n.BrowseName.toString();
+    }
+    str += "[" + self.typeDefinitionId.toString() + "]" + simpleAttributeOperandToPath(self);
+    return str;
+}