node-opcua-address-space 2.97.0 → 2.98.1

package/dist/source/continuation_points/continuation_point_manager.js

@@ -1,201 +1,201 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContinuationPointManager = void 0;
-/**
- * @module node-opcua-server
- */
-const node_opcua_status_code_1 = require("node-opcua-status-code");
-const node_opcua_debug_1 = require("node-opcua-debug");
-const warningLog = (0, node_opcua_debug_1.make_warningLog)(__filename);
-let counter = 0;
-function make_key() {
-    // return crypto.randomBytes(32);
-    counter += 1;
-    return Buffer.from(counter.toString(), "utf-8");
-}
-/**
- * from https://reference.opcfoundation.org/v104/Core/docs/Part4/7.6/
- *
- * A ContinuationPoint is used to pause a Browse, QueryFirst or HistoryRead operation and allow it to be restarted later by calling BrowseNext,
- * QueryNext or HistoryRead.
- * - Operations are paused when the number of results found exceeds the limits set by either the Client or the Server.
- * - The Client specifies the maximum number of results per operation in the request message.
- * - A Server shall not return more than this number of results but it may return fewer results.
- * - The Server allocates a  ContinuationPoint if there are more results to return.
- * - Servers shall support at least one ContinuationPoint per Session.
- * - Servers specify a maximum number of ContinuationPoints per Session in the ServerCapabilities Object defined in OPC 10000-5.
- * - ContinuationPoints remain active until
- *     a/ the Client retrieves the remaining results,
- *     b/ or, the Client releases the ContinuationPoint
- *     c/ or the Session is closed.
- * - A Server shall automatically free ContinuationPoints from prior requests from a Session if they are needed to process a new request
- *   from this Session.
- * - The Server returns a Bad_ContinuationPointInvalid error if a Client tries to use a ContinuationPoint that has been released.
- * - A Client can avoid this situation by completing paused operations before starting new operations.
- *   For Session-less Service invocations, the ContinuationPoints are shared across all Session-less Service invocations from all Clients.
- *   The Server shall support at least the maximum number of ContinuationPoints it would allow for one Session.
- *
- * - Requests will often specify multiple operations that may or may not require a ContinuationPoint.
- * - A Server shall process the operations until it uses the maximum number of continuation points in this response.
- *   Once that happens the Server shall return a Bad_NoContinuationPoints error for any remaining operations. A Client can avoid
- *   this situation by sending requests with a number of operations that do not exceed the maximum number  of ContinuationPoints
- *   per Session defined for the Service in the ServerCapabilities Object defined in OPC 10000-5.
- *   A Client restarts an operation by passing the ContinuationPoint back to the Server. Server should always be able to reuse the ContinuationPoint
- *   provided so Servers shall never return Bad_NoContinuationPoints error when continuing a previously halted operation.
- *   A ContinuationPoint is a subtype of the ByteString data type.
- *
- *
- * for historical access: https://reference.opcfoundation.org/v104/Core/docs/Part11/6.3/
- *
- * The continuationPoint parameter in the HistoryRead Service is used to mark a point from which to continue
- * the read if not all values could be returned in one response. The value is opaque for the Client and is
- * only used to maintain the state information for the Server to continue from. *
- *
- * For HistoricalDataNode requests, a Server may use the timestamp of the last returned data item if the timestamp
- * is unique. This can reduce the need in the Server to store state information for the continuation point.
- * The Client specifies the maximum number of results per operation in the request Message. A Server shall
- * not return more than this number of results but it may return fewer results. The Server allocates a
- * ContinuationPoint if there are more results to return. The Server may return fewer results due to buffer issues
- * or other internal constraints. It may also be required to return a continuationPoint due to HistoryRead
- * parameter constraints. If a request is taking a long time to calculate and is approaching the timeout time, the
- * Server may return partial results with a continuation point. This may be done if the calculation is going to
- * take more time than the Client timeout. In some cases it may take longer than the Client timeout to calculate
- * even one result. Then the Server may return zero results with a continuation point that allows the Server to
- * resume the calculation on the next Client read call. For additional discussions regarding ContinuationPoints
- * and HistoryRead please see the individual extensible HistoryReadDetails parameter in 6.4.
- * If the Client specifies a ContinuationPoint, then the HistoryReadDetails parameter and the TimestampsToReturn
- * parameter are ignored, because it does not make sense to request different parameters when continuing from a
- * previous call. It is permissible to change the dataEncoding parameter with each request.
- * If the Client specifies a ContinuationPoint that is no longer valid, then the Server shall return a
- * Bad_ContinuationPointInvalid error.
- * If the releaseContinuationPoints parameter is set in the request the Server shall not return any data and shall
- * release all ContinuationPoints passed in the request. If the ContinuationPoint for an operation is missing or
- * invalid then the StatusCode for the operation shall be Bad_ContinuationPointInvalid.
- */
-class ContinuationPointManager {
-    constructor() {
-        this._map = new Map();
-    }
-    /**
-     * returns true if the current number of active continuation point has reached the limit
-     * specified in maxContinuationPoint
-     * @param maxBrowseContinuationPoint
-     */
-    hasReachedMaximum(maxContinuationPoint) {
-        if (maxContinuationPoint === 0) {
-            return false;
-        }
-        const nbContinuationPoints = this._map.size;
-        return nbContinuationPoints >= maxContinuationPoint;
-    }
-    clearContinuationPoints() {
-        // call when a new request to the server is received
-        this._map.clear();
-    }
-    registerHistoryReadRaw(numValuesPerNode, dataValues, continuationData) {
-        return this._register(numValuesPerNode, dataValues, continuationData);
-    }
-    getNextHistoryReadRaw(numValues, continuationData) {
-        return this._getNext(numValues, continuationData);
-    }
-    registerReferences(maxElements, values, continuationData) {
-        return this._register(maxElements, values, continuationData);
-    }
-    /**
-     * - releaseContinuationPoints = TRUE
-     *
-     *  passed continuationPoints shall be reset to free resources in
-     *  the Server. The continuation points are released and the results
-     *  and diagnosticInfos arrays are empty.
-     *
-     * - releaseContinuationPoints = FALSE
-     *
-     *   passed continuationPoints shall be used to get the next set of
-     *   browse information
-     */
-    getNextReferences(numValues, continuationData) {
-        return this._getNext(numValues, continuationData);
-    }
-    _register(maxValues, values, continuationData) {
-        if (continuationData.releaseContinuationPoints) {
-            this.clearContinuationPoints();
-            return {
-                continuationPoint: undefined,
-                values: [],
-                statusCode: node_opcua_status_code_1.StatusCodes.Good
-            };
-        }
-        if (!continuationData.continuationPoint && !continuationData.index) {
-            if (this._map.size > 0) {
-                warningLog("flushing pending continuationPoints", this._map.size);
-                this.clearContinuationPoints();
-            }
-        }
-        if (maxValues >= 1) {
-            // now make sure that only the requested number of value is returned
-            if (values.length === 0) {
-                return {
-                    continuationPoint: undefined,
-                    values: null,
-                    statusCode: node_opcua_status_code_1.StatusCodes.GoodNoData
-                };
-            }
-        }
-        maxValues = maxValues || values.length;
-        if (maxValues >= values.length) {
-            return {
-                continuationPoint: undefined,
-                values,
-                statusCode: node_opcua_status_code_1.StatusCodes.Good
-            };
-        }
-        // split the array in two ( values)
-        const current_block = values.splice(0, maxValues);
-        const key = make_key();
-        const keyHash = key.toString("utf-8");
-        const result = {
-            continuationPoint: key,
-            values: current_block,
-            statusCode: node_opcua_status_code_1.StatusCodes.Good
-        };
-        // create
-        const data = {
-            maxElements: maxValues,
-            values: values
-        };
-        this._map.set(keyHash, data);
-        return result;
-    }
-    _getNext(numValues, continuationData) {
-        if (!continuationData.continuationPoint) {
-            return {
-                continuationPoint: undefined,
-                values: null,
-                statusCode: node_opcua_status_code_1.StatusCodes.BadContinuationPointInvalid
-            };
-        }
-        const keyHash = continuationData.continuationPoint.toString("utf-8");
-        const data = this._map.get(keyHash);
-        if (!data) {
-            return {
-                continuationPoint: undefined,
-                values: null,
-                statusCode: node_opcua_status_code_1.StatusCodes.BadContinuationPointInvalid
-            };
-        }
-        const values = data.values.splice(0, numValues || data.maxElements);
-        let continuationPoint = continuationData.continuationPoint;
-        if (data.values.length === 0 || continuationData.releaseContinuationPoints) {
-            // no more data available for next call
-            this._map.delete(keyHash);
-            continuationPoint = undefined;
-        }
-        return {
-            continuationPoint,
-            values,
-            statusCode: node_opcua_status_code_1.StatusCodes.Good
-        };
-    }
-}
-exports.ContinuationPointManager = ContinuationPointManager;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContinuationPointManager = void 0;
+/**
+ * @module node-opcua-server
+ */
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+const node_opcua_debug_1 = require("node-opcua-debug");
+const warningLog = (0, node_opcua_debug_1.make_warningLog)(__filename);
+let counter = 0;
+function make_key() {
+    // return crypto.randomBytes(32);
+    counter += 1;
+    return Buffer.from(counter.toString(), "utf-8");
+}
+/**
+ * from https://reference.opcfoundation.org/v104/Core/docs/Part4/7.6/
+ *
+ * A ContinuationPoint is used to pause a Browse, QueryFirst or HistoryRead operation and allow it to be restarted later by calling BrowseNext,
+ * QueryNext or HistoryRead.
+ * - Operations are paused when the number of results found exceeds the limits set by either the Client or the Server.
+ * - The Client specifies the maximum number of results per operation in the request message.
+ * - A Server shall not return more than this number of results but it may return fewer results.
+ * - The Server allocates a  ContinuationPoint if there are more results to return.
+ * - Servers shall support at least one ContinuationPoint per Session.
+ * - Servers specify a maximum number of ContinuationPoints per Session in the ServerCapabilities Object defined in OPC 10000-5.
+ * - ContinuationPoints remain active until
+ *     a/ the Client retrieves the remaining results,
+ *     b/ or, the Client releases the ContinuationPoint
+ *     c/ or the Session is closed.
+ * - A Server shall automatically free ContinuationPoints from prior requests from a Session if they are needed to process a new request
+ *   from this Session.
+ * - The Server returns a Bad_ContinuationPointInvalid error if a Client tries to use a ContinuationPoint that has been released.
+ * - A Client can avoid this situation by completing paused operations before starting new operations.
+ *   For Session-less Service invocations, the ContinuationPoints are shared across all Session-less Service invocations from all Clients.
+ *   The Server shall support at least the maximum number of ContinuationPoints it would allow for one Session.
+ *
+ * - Requests will often specify multiple operations that may or may not require a ContinuationPoint.
+ * - A Server shall process the operations until it uses the maximum number of continuation points in this response.
+ *   Once that happens the Server shall return a Bad_NoContinuationPoints error for any remaining operations. A Client can avoid
+ *   this situation by sending requests with a number of operations that do not exceed the maximum number  of ContinuationPoints
+ *   per Session defined for the Service in the ServerCapabilities Object defined in OPC 10000-5.
+ *   A Client restarts an operation by passing the ContinuationPoint back to the Server. Server should always be able to reuse the ContinuationPoint
+ *   provided so Servers shall never return Bad_NoContinuationPoints error when continuing a previously halted operation.
+ *   A ContinuationPoint is a subtype of the ByteString data type.
+ *
+ *
+ * for historical access: https://reference.opcfoundation.org/v104/Core/docs/Part11/6.3/
+ *
+ * The continuationPoint parameter in the HistoryRead Service is used to mark a point from which to continue
+ * the read if not all values could be returned in one response. The value is opaque for the Client and is
+ * only used to maintain the state information for the Server to continue from. *
+ *
+ * For HistoricalDataNode requests, a Server may use the timestamp of the last returned data item if the timestamp
+ * is unique. This can reduce the need in the Server to store state information for the continuation point.
+ * The Client specifies the maximum number of results per operation in the request Message. A Server shall
+ * not return more than this number of results but it may return fewer results. The Server allocates a
+ * ContinuationPoint if there are more results to return. The Server may return fewer results due to buffer issues
+ * or other internal constraints. It may also be required to return a continuationPoint due to HistoryRead
+ * parameter constraints. If a request is taking a long time to calculate and is approaching the timeout time, the
+ * Server may return partial results with a continuation point. This may be done if the calculation is going to
+ * take more time than the Client timeout. In some cases it may take longer than the Client timeout to calculate
+ * even one result. Then the Server may return zero results with a continuation point that allows the Server to
+ * resume the calculation on the next Client read call. For additional discussions regarding ContinuationPoints
+ * and HistoryRead please see the individual extensible HistoryReadDetails parameter in 6.4.
+ * If the Client specifies a ContinuationPoint, then the HistoryReadDetails parameter and the TimestampsToReturn
+ * parameter are ignored, because it does not make sense to request different parameters when continuing from a
+ * previous call. It is permissible to change the dataEncoding parameter with each request.
+ * If the Client specifies a ContinuationPoint that is no longer valid, then the Server shall return a
+ * Bad_ContinuationPointInvalid error.
+ * If the releaseContinuationPoints parameter is set in the request the Server shall not return any data and shall
+ * release all ContinuationPoints passed in the request. If the ContinuationPoint for an operation is missing or
+ * invalid then the StatusCode for the operation shall be Bad_ContinuationPointInvalid.
+ */
+class ContinuationPointManager {
+    constructor() {
+        this._map = new Map();
+    }
+    /**
+     * returns true if the current number of active continuation point has reached the limit
+     * specified in maxContinuationPoint
+     * @param maxBrowseContinuationPoint
+     */
+    hasReachedMaximum(maxContinuationPoint) {
+        if (maxContinuationPoint === 0) {
+            return false;
+        }
+        const nbContinuationPoints = this._map.size;
+        return nbContinuationPoints >= maxContinuationPoint;
+    }
+    clearContinuationPoints() {
+        // call when a new request to the server is received
+        this._map.clear();
+    }
+    registerHistoryReadRaw(numValuesPerNode, dataValues, continuationData) {
+        return this._register(numValuesPerNode, dataValues, continuationData);
+    }
+    getNextHistoryReadRaw(numValues, continuationData) {
+        return this._getNext(numValues, continuationData);
+    }
+    registerReferences(maxElements, values, continuationData) {
+        return this._register(maxElements, values, continuationData);
+    }
+    /**
+     * - releaseContinuationPoints = TRUE
+     *
+     *  passed continuationPoints shall be reset to free resources in
+     *  the Server. The continuation points are released and the results
+     *  and diagnosticInfos arrays are empty.
+     *
+     * - releaseContinuationPoints = FALSE
+     *
+     *   passed continuationPoints shall be used to get the next set of
+     *   browse information
+     */
+    getNextReferences(numValues, continuationData) {
+        return this._getNext(numValues, continuationData);
+    }
+    _register(maxValues, values, continuationData) {
+        if (continuationData.releaseContinuationPoints) {
+            this.clearContinuationPoints();
+            return {
+                continuationPoint: undefined,
+                values: [],
+                statusCode: node_opcua_status_code_1.StatusCodes.Good
+            };
+        }
+        if (!continuationData.continuationPoint && !continuationData.index) {
+            if (this._map.size > 0) {
+                warningLog("flushing pending continuationPoints", this._map.size);
+                this.clearContinuationPoints();
+            }
+        }
+        if (maxValues >= 1) {
+            // now make sure that only the requested number of value is returned
+            if (values.length === 0) {
+                return {
+                    continuationPoint: undefined,
+                    values: null,
+                    statusCode: node_opcua_status_code_1.StatusCodes.GoodNoData
+                };
+            }
+        }
+        maxValues = maxValues || values.length;
+        if (maxValues >= values.length) {
+            return {
+                continuationPoint: undefined,
+                values,
+                statusCode: node_opcua_status_code_1.StatusCodes.Good
+            };
+        }
+        // split the array in two ( values)
+        const current_block = values.splice(0, maxValues);
+        const key = make_key();
+        const keyHash = key.toString("utf-8");
+        const result = {
+            continuationPoint: key,
+            values: current_block,
+            statusCode: node_opcua_status_code_1.StatusCodes.Good
+        };
+        // create
+        const data = {
+            maxElements: maxValues,
+            values: values
+        };
+        this._map.set(keyHash, data);
+        return result;
+    }
+    _getNext(numValues, continuationData) {
+        if (!continuationData.continuationPoint) {
+            return {
+                continuationPoint: undefined,
+                values: null,
+                statusCode: node_opcua_status_code_1.StatusCodes.BadContinuationPointInvalid
+            };
+        }
+        const keyHash = continuationData.continuationPoint.toString("utf-8");
+        const data = this._map.get(keyHash);
+        if (!data) {
+            return {
+                continuationPoint: undefined,
+                values: null,
+                statusCode: node_opcua_status_code_1.StatusCodes.BadContinuationPointInvalid
+            };
+        }
+        const values = data.values.splice(0, numValues || data.maxElements);
+        let continuationPoint = continuationData.continuationPoint;
+        if (data.values.length === 0 || continuationData.releaseContinuationPoints) {
+            // no more data available for next call
+            this._map.delete(keyHash);
+            continuationPoint = undefined;
+        }
+        return {
+            continuationPoint,
+            values,
+            statusCode: node_opcua_status_code_1.StatusCodes.Good
+        };
+    }
+}
+exports.ContinuationPointManager = ContinuationPointManager;
 //# sourceMappingURL=continuation_point_manager.js.map

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

@@ -1,5 +1,5 @@
-/**
- * @module node-opcua-address-space
- */
-import { BrowseDirection } from "node-opcua-data-model";
-export declare function adjustBrowseDirection(browseDirection: BrowseDirection | null | undefined, defaultValue: BrowseDirection): BrowseDirection;
+/**
+ * @module node-opcua-address-space
+ */
+import { BrowseDirection } from "node-opcua-data-model";
+export declare function adjustBrowseDirection(browseDirection: BrowseDirection | null | undefined, defaultValue: BrowseDirection): BrowseDirection;

package/dist/source/helpers/adjust_browse_direction.js

@@ -1,12 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.adjustBrowseDirection = void 0;
-function adjustBrowseDirection(browseDirection, defaultValue) {
-    // istanbul ignore next
-    if (browseDirection === null || browseDirection === undefined) {
-        return defaultValue;
-    }
-    return browseDirection;
-}
-exports.adjustBrowseDirection = adjustBrowseDirection;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adjustBrowseDirection = void 0;
+function adjustBrowseDirection(browseDirection, defaultValue) {
+    // istanbul ignore next
+    if (browseDirection === null || browseDirection === undefined) {
+        return defaultValue;
+    }
+    return browseDirection;
+}
+exports.adjustBrowseDirection = adjustBrowseDirection;
 //# sourceMappingURL=adjust_browse_direction.js.map

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

@@ -1,33 +1,33 @@
-import { BinaryStream, OutputBinaryStream } from "node-opcua-binary-stream";
-import { NodeId } from "node-opcua-nodeid";
-import { Argument } from "node-opcua-service-call";
-import { StatusCode } from "node-opcua-status-code";
-import { Variant } from "node-opcua-variant";
-import { DataType } from "node-opcua-variant";
-import { IAddressSpace, UAMethod } from "node-opcua-address-space-base";
-export interface ArgumentDef {
-    dataType: DataType;
-    valueRank?: undefined | number;
-}
-export declare function encode_ArgumentList(definition: ArgumentDef[], args: any[], stream: OutputBinaryStream): void;
-export declare function decode_ArgumentList(definition: ArgumentDef[], stream: BinaryStream): any[];
-export declare function binaryStoreSize_ArgumentList(description: ArgumentDef[], args: any[]): number;
-export declare function getMethodDeclaration_ArgumentList(addressSpace: IAddressSpace, objectId: NodeId, methodId: NodeId): {
-    statusCode: StatusCode;
-    methodDeclaration?: UAMethod;
-};
-/**
- * @private
- */
-export declare function isArgumentValid(addressSpace: IAddressSpace, argDefinition: Argument, arg: Variant): boolean;
-/**
- * @method verifyArguments_ArgumentList
- * @param addressSpace
- * @param methodInputArguments
- * @param inputArguments
- * @return statusCode,inputArgumentResults
- */
-export declare function verifyArguments_ArgumentList(addressSpace: IAddressSpace, methodInputArguments: Argument[], inputArguments: Variant[]): {
-    inputArgumentResults?: StatusCode[];
-    statusCode: StatusCode;
-};
+import { BinaryStream, OutputBinaryStream } from "node-opcua-binary-stream";
+import { NodeId } from "node-opcua-nodeid";
+import { Argument } from "node-opcua-service-call";
+import { StatusCode } from "node-opcua-status-code";
+import { Variant } from "node-opcua-variant";
+import { DataType } from "node-opcua-variant";
+import { IAddressSpace, UAMethod } from "node-opcua-address-space-base";
+export interface ArgumentDef {
+    dataType: DataType;
+    valueRank?: undefined | number;
+}
+export declare function encode_ArgumentList(definition: ArgumentDef[], args: any[], stream: OutputBinaryStream): void;
+export declare function decode_ArgumentList(definition: ArgumentDef[], stream: BinaryStream): any[];
+export declare function binaryStoreSize_ArgumentList(description: ArgumentDef[], args: any[]): number;
+export declare function getMethodDeclaration_ArgumentList(addressSpace: IAddressSpace, objectId: NodeId, methodId: NodeId): {
+    statusCode: StatusCode;
+    methodDeclaration?: UAMethod;
+};
+/**
+ * @private
+ */
+export declare function isArgumentValid(addressSpace: IAddressSpace, argDefinition: Argument, arg: Variant): boolean;
+/**
+ * @method verifyArguments_ArgumentList
+ * @param addressSpace
+ * @param methodInputArguments
+ * @param inputArguments
+ * @return statusCode,inputArgumentResults
+ */
+export declare function verifyArguments_ArgumentList(addressSpace: IAddressSpace, methodInputArguments: Argument[], inputArguments: Variant[]): {
+    inputArgumentResults?: StatusCode[];
+    statusCode: StatusCode;
+};