node-opcua-address-space 2.75.0 → 2.76.0

package/dist/source/helpers/argument_list.js

@@ -1,259 +1,259 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyArguments_ArgumentList = exports.isArgumentValid = exports.getMethodDeclaration_ArgumentList = exports.binaryStoreSize_ArgumentList = exports.decode_ArgumentList = exports.encode_ArgumentList = void 0;
-/* eslint-disable complexity */
-/**
- * @module node-opcua-address-space
- */
-const node_opcua_assert_1 = require("node-opcua-assert");
-const ec = require("node-opcua-basic-types");
-const node_opcua_binary_stream_1 = require("node-opcua-binary-stream");
-const node_opcua_debug_1 = require("node-opcua-debug");
-const factories = require("node-opcua-factory");
-const node_opcua_nodeid_1 = require("node-opcua-nodeid");
-const node_opcua_status_code_1 = require("node-opcua-status-code");
-const node_opcua_variant_1 = require("node-opcua-variant");
-const node_opcua_variant_2 = require("node-opcua-variant");
-const node_opcua_constants_1 = require("node-opcua-constants");
-const node_opcua_data_model_1 = require("node-opcua-data-model");
-const debugLog = (0, node_opcua_debug_1.make_debugLog)(__filename);
-const warningLog = (0, node_opcua_debug_1.make_warningLog)(__filename);
-const doDebug = (0, node_opcua_debug_1.checkDebugFlag)(__filename);
-function myfindBuiltInType(dataType) {
-    return factories.findBuiltInType(node_opcua_variant_1.DataType[dataType]);
-}
-function encode_ArgumentList(definition, args, stream) {
-    (0, node_opcua_assert_1.assert)(definition.length === args.length);
-    (0, node_opcua_assert_1.assert)(Array.isArray(definition));
-    (0, node_opcua_assert_1.assert)(Array.isArray(args));
-    (0, node_opcua_assert_1.assert)(definition.length === args.length);
-    (0, node_opcua_assert_1.assert)(definition.length >= 0);
-    // we only encode arguments by following the definition
-    for (let i = 0; i < definition.length; i++) {
-        const def = definition[i];
-        const value = args[i];
-        const encodeFunc = myfindBuiltInType(def.dataType).encode;
-        // assert((def.valueRank === -1) || (def.valueRank === 0));
-        // todo : handle -3 -2
-        const isArray = def.valueRank && (def.valueRank === 1 || def.valueRank !== -1);
-        if (isArray) {
-            ec.encodeArray(value, stream, encodeFunc);
-        }
-        else {
-            encodeFunc(value, stream);
-        }
-    }
-}
-exports.encode_ArgumentList = encode_ArgumentList;
-function decode_ArgumentList(definition, stream) {
-    // istanbul ignore next
-    if (!Array.isArray(definition)) {
-        throw new Error("This BaseDataType cannot be decoded because it has no definition.\n" +
-            "Please construct a BaseDataType({definition : [{dataType: DataType.UInt32 }]});");
-    }
-    const args = [];
-    let value;
-    for (const def of definition) {
-        const decodeFunc = myfindBuiltInType(def.dataType).decode;
-        // xx assert(def.valueRank === -1 || def.valueRank==0);
-        const isArray = def.valueRank === 1 || def.valueRank === -1;
-        if (isArray) {
-            value = ec.decodeArray(stream, decodeFunc);
-        }
-        else {
-            value = decodeFunc(stream);
-        }
-        args.push(value);
-    }
-    return args;
-}
-exports.decode_ArgumentList = decode_ArgumentList;
-function binaryStoreSize_ArgumentList(description, args) {
-    (0, node_opcua_assert_1.assert)(Array.isArray(description));
-    (0, node_opcua_assert_1.assert)(Array.isArray(args));
-    (0, node_opcua_assert_1.assert)(args.length === description.length);
-    const stream = new node_opcua_binary_stream_1.BinaryStreamSizeCalculator();
-    encode_ArgumentList(description, args, stream);
-    return stream.length;
-}
-exports.binaryStoreSize_ArgumentList = binaryStoreSize_ArgumentList;
-function getMethodDeclaration_ArgumentList(addressSpace, objectId, methodId) {
-    // find object in address space
-    const obj = addressSpace.findNode(objectId);
-    if (!obj) {
-        // istanbul ignore next
-        if (doDebug) {
-            debugLog("cannot find node ", objectId.toString());
-        }
-        return { statusCode: node_opcua_status_code_1.StatusCodes.BadNodeIdUnknown };
-    }
-    let objectMethod = obj.getMethodById(methodId);
-    if (!objectMethod) {
-        // the method doesn't belong to the object, nevertheless
-        // the method can be called
-        objectMethod = addressSpace.findNode(methodId);
-        if (!objectMethod || objectMethod.nodeClass !== node_opcua_data_model_1.NodeClass.Method) {
-            warningLog("cannot find method with id", methodId.toString(), "object Id = ", objectId.toString());
-            return { statusCode: node_opcua_status_code_1.StatusCodes.BadMethodInvalid };
-        }
-    }
-    const methodDeclarationId = objectMethod.methodDeclarationId;
-    const methodDeclaration = addressSpace.findNode(methodDeclarationId);
-    if (!methodDeclaration) {
-        //  return {statusCode: StatusCodes.BadMethodInvalid};
-        return { statusCode: node_opcua_status_code_1.StatusCodes.Good, methodDeclaration: objectMethod };
-    }
-    // istanbul ignore next
-    if (methodDeclaration.nodeClass !== node_opcua_data_model_1.NodeClass.Method) {
-        throw new Error("Expecting a Method here");
-    }
-    return { statusCode: node_opcua_status_code_1.StatusCodes.Good, methodDeclaration };
-}
-exports.getMethodDeclaration_ArgumentList = getMethodDeclaration_ArgumentList;
-function checkValueRank(argDefinition, arg) {
-    const isArray = arg.arrayType === node_opcua_variant_2.VariantArrayType.Array;
-    const isMatrix = arg.arrayType === node_opcua_variant_2.VariantArrayType.Matrix;
-    if (argDefinition.valueRank > 0) {
-        if (argDefinition.valueRank === 1) {
-            if (!isArray) {
-                return false;
-            }
-        }
-        else {
-            if (!isMatrix) {
-                return false;
-            }
-        }
-    }
-    else if (argDefinition.valueRank === -1) {
-        // SCALAR
-        if (isArray || isMatrix) {
-            return false;
-        }
-    }
-    else if (argDefinition.valueRank === -2) {
-        // ANY
-    }
-    else if (argDefinition.valueRank === -3) {
-        // Scalar or OneDim
-        if (isMatrix) {
-            return false;
-        }
-    }
-    else if (argDefinition.valueRank === 0) {
-        // array or matrix
-        if (!isArray && !isMatrix) {
-            return false;
-        }
-    }
-    return true;
-}
-/**
- * @private
- */
-function isArgumentValid(addressSpace, argDefinition, arg) {
-    (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(argDefinition, "dataType"));
-    (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(argDefinition, "valueRank"));
-    const argDefDataType = addressSpace.findDataType(argDefinition.dataType);
-    const argDataType = addressSpace.findDataType((0, node_opcua_nodeid_1.resolveNodeId)(arg.dataType));
-    // istanbul ignore next
-    if (!argDefDataType) {
-        debugLog("dataType ", argDefinition.dataType.toString(), "doesn't exist");
-        return false;
-    }
-    if (argDefinition.valueRank >= 0 && arg.dataType === node_opcua_variant_1.DataType.Null) {
-        // this is valid to receive an empty array ith DataType.Null;
-        return true;
-    }
-    if (!checkValueRank(argDefinition, arg)) {
-        return false;
-    }
-    // istanbul ignore next
-    if (!argDataType) {
-        debugLog(" cannot find dataType ", arg.dataType, (0, node_opcua_nodeid_1.resolveNodeId)(arg.dataType));
-        debugLog(" arg = ", arg.toString());
-        debugLog(" def =", argDefinition.toString());
-        return false;
-    }
-    // istanbul ignore next
-    if (doDebug) {
-        debugLog(" checking argDefDataType ", argDefDataType.toString());
-        debugLog(" checking argDataType ", argDataType.toString());
-    }
-    if (argDataType.nodeId.value === argDefDataType.nodeId.value) {
-        return true;
-    }
-    // check that dataType is of the same type (derived )
-    if (argDefDataType.isSupertypeOf(argDataType)) {
-        // like argDefDataType IntegerId and argDataType Uint32
-        return true;
-    }
-    if (argDataType.isSupertypeOf(argDefDataType)) {
-        // like argDefDataType BaseDataType and argDataType any Type
-        return true;
-    }
-    // special case for Enumeration
-    if (arg.dataType === node_opcua_variant_1.DataType.Int32) {
-        const enumDataType = addressSpace.findDataType((0, node_opcua_nodeid_1.coerceNodeId)(node_opcua_constants_1.DataTypeIds.Enumeration));
-        if (argDefDataType.isSupertypeOf(enumDataType)) {
-            return true;
-        }
-    }
-    return false;
-}
-exports.isArgumentValid = isArgumentValid;
-/**
- * @method verifyArguments_ArgumentList
- * @param addressSpace
- * @param methodInputArguments
- * @param inputArguments
- * @return statusCode,inputArgumentResults
- */
-function verifyArguments_ArgumentList(addressSpace, methodInputArguments, inputArguments) {
-    const inputArgumentResults = methodInputArguments.map((methodInputArgument, index) => {
-        const argument = inputArguments[index];
-        if (!argument) {
-            return node_opcua_status_code_1.StatusCodes.BadNoData;
-        }
-        else if (!isArgumentValid(addressSpace, methodInputArgument, argument)) {
-            return node_opcua_status_code_1.StatusCodes.BadTypeMismatch;
-        }
-        else {
-            return node_opcua_status_code_1.StatusCodes.Good;
-        }
-    });
-    if (methodInputArguments.length > inputArguments.length) {
-        // istanbul ignore next
-        if (doDebug) {
-            debugLog("verifyArguments_ArgumentList " +
-                "\n       The client did  specify too many input arguments for the method.  " +
-                "\n        expected : " +
-                methodInputArguments.length +
-                "" +
-                "\n        actual   : " +
-                inputArguments.length);
-        }
-        return { inputArgumentResults, statusCode: node_opcua_status_code_1.StatusCodes.BadArgumentsMissing };
-    }
-    if (methodInputArguments.length < inputArguments.length) {
-        // istanbul ignore next
-        if (doDebug) {
-            debugLog(" verifyArguments_ArgumentList " +
-                "\n        The client did not specify all of the input arguments for the method. " +
-                "\n        expected : " +
-                methodInputArguments.length +
-                "" +
-                "\n        actual   : " +
-                inputArguments.length);
-        }
-        return { inputArgumentResults, statusCode: node_opcua_status_code_1.StatusCodes.BadTooManyArguments };
-    }
-    return {
-        inputArgumentResults,
-        statusCode: inputArgumentResults.includes(node_opcua_status_code_1.StatusCodes.BadTypeMismatch) || inputArgumentResults.includes(node_opcua_status_code_1.StatusCodes.BadOutOfRange)
-            ? node_opcua_status_code_1.StatusCodes.BadInvalidArgument
-            : node_opcua_status_code_1.StatusCodes.Good
-    };
-}
-exports.verifyArguments_ArgumentList = verifyArguments_ArgumentList;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.verifyArguments_ArgumentList = exports.isArgumentValid = exports.getMethodDeclaration_ArgumentList = exports.binaryStoreSize_ArgumentList = exports.decode_ArgumentList = exports.encode_ArgumentList = void 0;
+/* eslint-disable complexity */
+/**
+ * @module node-opcua-address-space
+ */
+const node_opcua_assert_1 = require("node-opcua-assert");
+const ec = require("node-opcua-basic-types");
+const node_opcua_binary_stream_1 = require("node-opcua-binary-stream");
+const node_opcua_debug_1 = require("node-opcua-debug");
+const factories = require("node-opcua-factory");
+const node_opcua_nodeid_1 = require("node-opcua-nodeid");
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+const node_opcua_variant_1 = require("node-opcua-variant");
+const node_opcua_variant_2 = require("node-opcua-variant");
+const node_opcua_constants_1 = require("node-opcua-constants");
+const node_opcua_data_model_1 = require("node-opcua-data-model");
+const debugLog = (0, node_opcua_debug_1.make_debugLog)(__filename);
+const warningLog = (0, node_opcua_debug_1.make_warningLog)(__filename);
+const doDebug = (0, node_opcua_debug_1.checkDebugFlag)(__filename);
+function myfindBuiltInType(dataType) {
+    return factories.findBuiltInType(node_opcua_variant_1.DataType[dataType]);
+}
+function encode_ArgumentList(definition, args, stream) {
+    (0, node_opcua_assert_1.assert)(definition.length === args.length);
+    (0, node_opcua_assert_1.assert)(Array.isArray(definition));
+    (0, node_opcua_assert_1.assert)(Array.isArray(args));
+    (0, node_opcua_assert_1.assert)(definition.length === args.length);
+    (0, node_opcua_assert_1.assert)(definition.length >= 0);
+    // we only encode arguments by following the definition
+    for (let i = 0; i < definition.length; i++) {
+        const def = definition[i];
+        const value = args[i];
+        const encodeFunc = myfindBuiltInType(def.dataType).encode;
+        // assert((def.valueRank === -1) || (def.valueRank === 0));
+        // todo : handle -3 -2
+        const isArray = def.valueRank && (def.valueRank === 1 || def.valueRank !== -1);
+        if (isArray) {
+            ec.encodeArray(value, stream, encodeFunc);
+        }
+        else {
+            encodeFunc(value, stream);
+        }
+    }
+}
+exports.encode_ArgumentList = encode_ArgumentList;
+function decode_ArgumentList(definition, stream) {
+    // istanbul ignore next
+    if (!Array.isArray(definition)) {
+        throw new Error("This BaseDataType cannot be decoded because it has no definition.\n" +
+            "Please construct a BaseDataType({definition : [{dataType: DataType.UInt32 }]});");
+    }
+    const args = [];
+    let value;
+    for (const def of definition) {
+        const decodeFunc = myfindBuiltInType(def.dataType).decode;
+        // xx assert(def.valueRank === -1 || def.valueRank==0);
+        const isArray = def.valueRank === 1 || def.valueRank === -1;
+        if (isArray) {
+            value = ec.decodeArray(stream, decodeFunc);
+        }
+        else {
+            value = decodeFunc(stream);
+        }
+        args.push(value);
+    }
+    return args;
+}
+exports.decode_ArgumentList = decode_ArgumentList;
+function binaryStoreSize_ArgumentList(description, args) {
+    (0, node_opcua_assert_1.assert)(Array.isArray(description));
+    (0, node_opcua_assert_1.assert)(Array.isArray(args));
+    (0, node_opcua_assert_1.assert)(args.length === description.length);
+    const stream = new node_opcua_binary_stream_1.BinaryStreamSizeCalculator();
+    encode_ArgumentList(description, args, stream);
+    return stream.length;
+}
+exports.binaryStoreSize_ArgumentList = binaryStoreSize_ArgumentList;
+function getMethodDeclaration_ArgumentList(addressSpace, objectId, methodId) {
+    // find object in address space
+    const obj = addressSpace.findNode(objectId);
+    if (!obj) {
+        // istanbul ignore next
+        if (doDebug) {
+            debugLog("cannot find node ", objectId.toString());
+        }
+        return { statusCode: node_opcua_status_code_1.StatusCodes.BadNodeIdUnknown };
+    }
+    let objectMethod = obj.getMethodById(methodId);
+    if (!objectMethod) {
+        // the method doesn't belong to the object, nevertheless
+        // the method can be called
+        objectMethod = addressSpace.findNode(methodId);
+        if (!objectMethod || objectMethod.nodeClass !== node_opcua_data_model_1.NodeClass.Method) {
+            warningLog("cannot find method with id", methodId.toString(), "object Id = ", objectId.toString());
+            return { statusCode: node_opcua_status_code_1.StatusCodes.BadMethodInvalid };
+        }
+    }
+    const methodDeclarationId = objectMethod.methodDeclarationId;
+    const methodDeclaration = addressSpace.findNode(methodDeclarationId);
+    if (!methodDeclaration) {
+        //  return {statusCode: StatusCodes.BadMethodInvalid};
+        return { statusCode: node_opcua_status_code_1.StatusCodes.Good, methodDeclaration: objectMethod };
+    }
+    // istanbul ignore next
+    if (methodDeclaration.nodeClass !== node_opcua_data_model_1.NodeClass.Method) {
+        throw new Error("Expecting a Method here");
+    }
+    return { statusCode: node_opcua_status_code_1.StatusCodes.Good, methodDeclaration };
+}
+exports.getMethodDeclaration_ArgumentList = getMethodDeclaration_ArgumentList;
+function checkValueRank(argDefinition, arg) {
+    const isArray = arg.arrayType === node_opcua_variant_2.VariantArrayType.Array;
+    const isMatrix = arg.arrayType === node_opcua_variant_2.VariantArrayType.Matrix;
+    if (argDefinition.valueRank > 0) {
+        if (argDefinition.valueRank === 1) {
+            if (!isArray) {
+                return false;
+            }
+        }
+        else {
+            if (!isMatrix) {
+                return false;
+            }
+        }
+    }
+    else if (argDefinition.valueRank === -1) {
+        // SCALAR
+        if (isArray || isMatrix) {
+            return false;
+        }
+    }
+    else if (argDefinition.valueRank === -2) {
+        // ANY
+    }
+    else if (argDefinition.valueRank === -3) {
+        // Scalar or OneDim
+        if (isMatrix) {
+            return false;
+        }
+    }
+    else if (argDefinition.valueRank === 0) {
+        // array or matrix
+        if (!isArray && !isMatrix) {
+            return false;
+        }
+    }
+    return true;
+}
+/**
+ * @private
+ */
+function isArgumentValid(addressSpace, argDefinition, arg) {
+    (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(argDefinition, "dataType"));
+    (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(argDefinition, "valueRank"));
+    const argDefDataType = addressSpace.findDataType(argDefinition.dataType);
+    const argDataType = addressSpace.findDataType((0, node_opcua_nodeid_1.resolveNodeId)(arg.dataType));
+    // istanbul ignore next
+    if (!argDefDataType) {
+        debugLog("dataType ", argDefinition.dataType.toString(), "doesn't exist");
+        return false;
+    }
+    if (argDefinition.valueRank >= 0 && arg.dataType === node_opcua_variant_1.DataType.Null) {
+        // this is valid to receive an empty array ith DataType.Null;
+        return true;
+    }
+    if (!checkValueRank(argDefinition, arg)) {
+        return false;
+    }
+    // istanbul ignore next
+    if (!argDataType) {
+        debugLog(" cannot find dataType ", arg.dataType, (0, node_opcua_nodeid_1.resolveNodeId)(arg.dataType));
+        debugLog(" arg = ", arg.toString());
+        debugLog(" def =", argDefinition.toString());
+        return false;
+    }
+    // istanbul ignore next
+    if (doDebug) {
+        debugLog(" checking argDefDataType ", argDefDataType.toString());
+        debugLog(" checking argDataType ", argDataType.toString());
+    }
+    if (argDataType.nodeId.value === argDefDataType.nodeId.value) {
+        return true;
+    }
+    // check that dataType is of the same type (derived )
+    if (argDefDataType.isSupertypeOf(argDataType)) {
+        // like argDefDataType IntegerId and argDataType Uint32
+        return true;
+    }
+    if (argDataType.isSupertypeOf(argDefDataType)) {
+        // like argDefDataType BaseDataType and argDataType any Type
+        return true;
+    }
+    // special case for Enumeration
+    if (arg.dataType === node_opcua_variant_1.DataType.Int32) {
+        const enumDataType = addressSpace.findDataType((0, node_opcua_nodeid_1.coerceNodeId)(node_opcua_constants_1.DataTypeIds.Enumeration));
+        if (argDefDataType.isSupertypeOf(enumDataType)) {
+            return true;
+        }
+    }
+    return false;
+}
+exports.isArgumentValid = isArgumentValid;
+/**
+ * @method verifyArguments_ArgumentList
+ * @param addressSpace
+ * @param methodInputArguments
+ * @param inputArguments
+ * @return statusCode,inputArgumentResults
+ */
+function verifyArguments_ArgumentList(addressSpace, methodInputArguments, inputArguments) {
+    const inputArgumentResults = methodInputArguments.map((methodInputArgument, index) => {
+        const argument = inputArguments[index];
+        if (!argument) {
+            return node_opcua_status_code_1.StatusCodes.BadNoData;
+        }
+        else if (!isArgumentValid(addressSpace, methodInputArgument, argument)) {
+            return node_opcua_status_code_1.StatusCodes.BadTypeMismatch;
+        }
+        else {
+            return node_opcua_status_code_1.StatusCodes.Good;
+        }
+    });
+    if (methodInputArguments.length > inputArguments.length) {
+        // istanbul ignore next
+        if (doDebug) {
+            debugLog("verifyArguments_ArgumentList " +
+                "\n       The client did  specify too many input arguments for the method.  " +
+                "\n        expected : " +
+                methodInputArguments.length +
+                "" +
+                "\n        actual   : " +
+                inputArguments.length);
+        }
+        return { inputArgumentResults, statusCode: node_opcua_status_code_1.StatusCodes.BadArgumentsMissing };
+    }
+    if (methodInputArguments.length < inputArguments.length) {
+        // istanbul ignore next
+        if (doDebug) {
+            debugLog(" verifyArguments_ArgumentList " +
+                "\n        The client did not specify all of the input arguments for the method. " +
+                "\n        expected : " +
+                methodInputArguments.length +
+                "" +
+                "\n        actual   : " +
+                inputArguments.length);
+        }
+        return { inputArgumentResults, statusCode: node_opcua_status_code_1.StatusCodes.BadTooManyArguments };
+    }
+    return {
+        inputArgumentResults,
+        statusCode: inputArgumentResults.includes(node_opcua_status_code_1.StatusCodes.BadTypeMismatch) || inputArgumentResults.includes(node_opcua_status_code_1.StatusCodes.BadOutOfRange)
+            ? node_opcua_status_code_1.StatusCodes.BadInvalidArgument
+            : node_opcua_status_code_1.StatusCodes.Good
+    };
+}
+exports.verifyArguments_ArgumentList = verifyArguments_ArgumentList;
 //# sourceMappingURL=argument_list.js.map

package/dist/source/helpers/call_helpers.d.ts

@@ -1,6 +1,6 @@
-import { CallMethodRequest } from "node-opcua-service-call";
-import { CallMethodResultOptions } from "node-opcua-types";
-import { ISessionContext, IAddressSpace } from "node-opcua-address-space-base";
-declare type ResponseCallback<T> = (err: Error | null, result?: T) => void;
-export declare function callMethodHelper(context: ISessionContext, addressSpace: IAddressSpace, callMethodRequest: CallMethodRequest, callback: ResponseCallback<CallMethodResultOptions>): void;
-export {};
+import { CallMethodRequest } from "node-opcua-service-call";
+import { CallMethodResultOptions } from "node-opcua-types";
+import { ISessionContext, IAddressSpace } from "node-opcua-address-space-base";
+declare type ResponseCallback<T> = (err: Error | null, result?: T) => void;
+export declare function callMethodHelper(context: ISessionContext, addressSpace: IAddressSpace, callMethodRequest: CallMethodRequest, callback: ResponseCallback<CallMethodResultOptions>): void;
+export {};