node-opcua-file-transfer 2.52.0 → 2.56.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-file-transfer",
-  "version": "2.52.0",
+  "version": "2.56.0",
   "description": "pure nodejs OPCUA SDK - module -server",
   "scripts": {
     "build": "tsc -b",
@@ -11,31 +11,31 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "node-opcua-address-space": "2.52.0",
-    "node-opcua-assert": "2.52.0",
-    "node-opcua-basic-types": "2.52.0",
-    "node-opcua-client": "2.52.0",
+    "node-opcua-address-space": "2.56.0",
+    "node-opcua-assert": "2.55.0",
+    "node-opcua-basic-types": "2.56.0",
+    "node-opcua-client": "2.56.0",
     "node-opcua-constants": "2.52.0",
-    "node-opcua-data-model": "2.52.0",
-    "node-opcua-debug": "2.52.0",
-    "node-opcua-nodeid": "2.52.0",
+    "node-opcua-data-model": "2.56.0",
+    "node-opcua-debug": "2.55.0",
+    "node-opcua-nodeid": "2.55.0",
     "node-opcua-nodesets": "2.51.0",
     "node-opcua-pki": "^2.12.0",
-    "node-opcua-pseudo-session": "2.52.0",
-    "node-opcua-secure-channel": "2.52.0",
-    "node-opcua-server": "2.52.0",
-    "node-opcua-service-call": "2.52.0",
-    "node-opcua-service-read": "2.52.0",
-    "node-opcua-service-translate-browse-path": "2.52.0",
-    "node-opcua-status-code": "2.52.0",
-    "node-opcua-types": "2.52.0",
-    "node-opcua-variant": "2.52.0"
+    "node-opcua-pseudo-session": "2.56.0",
+    "node-opcua-secure-channel": "2.56.0",
+    "node-opcua-server": "2.56.0",
+    "node-opcua-service-call": "2.56.0",
+    "node-opcua-service-read": "2.56.0",
+    "node-opcua-service-translate-browse-path": "2.56.0",
+    "node-opcua-status-code": "2.56.0",
+    "node-opcua-types": "2.56.0",
+    "node-opcua-variant": "2.56.0"
   },
   "devDependencies": {
-    "memfs": "^3.2.4",
-    "node-opcua-binary-stream": "2.52.0",
-    "node-opcua-data-value": "2.52.0",
-    "node-opcua-leak-detector": "2.52.0",
+    "memfs": "^3.3.0",
+    "node-opcua-binary-stream": "2.55.0",
+    "node-opcua-data-value": "2.56.0",
+    "node-opcua-leak-detector": "2.56.0",
     "should": "^13.2.3",
     "sinon": "^11.1.2"
   },
@@ -54,5 +54,5 @@
     "internet of things"
   ],
   "homepage": "http://node-opcua.github.io/",
-  "gitHead": "3ec6296e8fd4df0e05b9d887f0b7dd20113a9ce1"
+  "gitHead": "9f6eac1c658c0d182fbe03cf58f799af468615eb"
 }

package/readme.md

@@ -1,204 +1,204 @@
-## introduction
-
-this package provides an implementation of the OPCUA File Transfer
-specification as per OPCUA 1.0.4 part 5 Annex C (page 99)
- 
-
-## installation
-
-```bash
-$ npm install node-opcua
-$ npm install node-opcua-file-transfer
-```
-
-## exposing a File node in the addressSpace
-
-```javascript
-import { OPCUAServer, UAFileType } from "node-opcua";
-import { installFileType } from "node-opcua-file-transfer";
-
-```
-
-```typescript
-
-const server = new OPCUAServer({
-
-});
-
-await server.initialize();
-
-
-// let say we want to create a access to this file:
-const my_data_filename = "/data/someFile.txt";
-await promisify(fs.writeFile)(my_data_filename, "some content", "utf8");
-
-
-// now add a file object in the address Space
-const addressSpace = server.engine.addressSpace;
-
-// retrieve the FileType UAObjectType
-const fileType = addressSpace.findObjectType("FileType")!;
-
-// create a instance of FileType 
-const myFile = fileType.instantiate({
-    nodeId: "s=MyFile",
-    browseName: "MyFile",
-    organizedBy: addressSpace.rootFolder.objects
-}) as UAFileType;
-
-// now bind the opcuaFile object with our file
-installFileType(opcuaFile, { 
-    filename: my_data_filename
-});
-
-```
-
-
-## accessing a File node from a node-opcua client : ClientFile
-
-We assume that we have a valid OPCUA Client Session
-
-```javascript
-import { OPCUAClient } from "node-opcua";
-import { ClientFile } from "node-opcua-file-transfer";
-
-const client = OPCUAClient.create({});
-
-await client.connect();
-const session = await client.createSession();
-```
-
-Let's assume that the nodeId of the file object is "ns=1;s=MyFile"
-
-```javascript
-import {ClientFile,OpenFileMode } from "node-opcua-file-transfer";
-
-// 
-const fileNodeId = "ns=1;s=MyFile";
-
-// let's create a client file object from the session and nodeId
-const clientFile = new ClientFile(session, fileNodeId);
-
-// let's open the file
-const mode = OpenFileMode.ReadWriteAppend;
-await clientFile.open(mode);
-
-// ... do some reading or writing
-
-// don't forget to close the file when done
-await clientFile.close();
-```
-
-### operations
-
-#### ClientFile#size(): Promise<UInt64> :  get file size
-
-You can read the size of the file at any time.
-``` javascript
-const clientFile = new ClientFile(session, fileNodeId);
-
-const size = await clientFile.size();
-console.log("the current file size is : ",size," bytes);
-```
-
-#### ClientFile#open(mode: OpenFileMode) : open a file
-
-```javascript 
-const mode = OpenFileMode.ReadWriteAppend;
-await clientFile.open(mode);
-```
-
-#### OpenFileMode enumeration
-
-| Mode | Description |
-|------|-------------|
-| Read  |The file is opened for reading. the Write method cannot be executed. |
-| Write|The file is opened for writing. the Read cannot be executed. |
-| ReadWrite| The file is opened for reading an writing |
-| WriteEraseExisting | File is opened for writing only. The existing content of the file is erased and an empty file is provided. |
-| ReadWriteEraseExisting | File is opened for reading and writing.  The existing content of the file is erased and an empty file is provided.|
-| WriteAppend | File is opened for writing only and position is set at the end of the file |
-| ReadWriteAppend | File is opened for reading and writing and position is set at the end of the file |
-}
-#### ClientFile#close() : close a file
-
-```javascript 
-const mode = OpenFileMode.ReadWriteAppend;
-await clientFile.open(mode);
-
-// ... do some reading or writing
-
-// don't forget to close the file when done
-await clientFile.close();
-```
-#### ClientFile#setPosition(pos: UInt64) :  Setting read/write position
-
-Once the file is opened, the position for reading or writing can be set
-using setPosition. 
-* setPosition expect a UInt64 parameter (see note below)
-* setPosition will throw an exception if file is not opened
-
-``` javascript
-const clientFile = new ClientFile(session, fileNodeId);
-
-const mode = OpenFileMode.ReadWriteAppend;
-await clientFile.open(mode);
-
-await client.setPosition([0,32]);
-
-```
-
-#### ClientFile#getPosition(): Promise<UInt64> Getting read/write position
-Once the file is opened, the position for reading or writing can be retrieved
-using getPosition. 
-* getPosition returns a UInt64 parameter (see note below)
-* getPosition will throw an exception if file is not opened
-
-``` javascript
-const clientFile = new ClientFile(session, fileNodeId);
-
-const mode = OpenFileMode.ReadWriteAppend;
-await clientFile.open(mode);
-
-await client.setPosition(32);
-
-```
-
-#### ClientFile#write(buf: Buffer) : Writing data to the file
-
-Data can be writing to the file at the current cursor position.
-Data must be passed in a buffer.
-* write will throw an exception if file is not opened
-
-```javascript
-const dataToWrite = Buffer.from("Some data");
-
-const mode = OpenFileMode.ReadWriteAppend;
-await clientFile.open(mode);
-await clientFile.write(dataToWrite);
-```
-
-
-#### ClientFile#read(): Promise<Buffer> :reading data to the file
-
-Data can be writing to the file at the current cursor position.
-Data must be passed in a buffer.
-* read will throw an exception if file is not opened
-
-```javascript
-
-const mode = OpenFileMode.ReadWriteAppend;
-await clientFile.open(mode);
-
-// read 200 bytes from position 32
-await clientFile.setPosition([0,32]);
-const data: Buffer = await clientFile.read(200);
-```
-
-### notes
-
-UInt64
-* At this time BigInt, is not supported by all version of nodeJs that are targeted by node-opcua.
-UInt64 values are currently stored into a array of 2 32bits numbers : [ High,Low]
-
-
+## introduction
+
+this package provides an implementation of the OPCUA File Transfer
+specification as per OPCUA 1.0.4 part 5 Annex C (page 99)
+ 
+
+## installation
+
+```bash
+$ npm install node-opcua
+$ npm install node-opcua-file-transfer
+```
+
+## exposing a File node in the addressSpace
+
+```javascript
+import { OPCUAServer, UAFileType } from "node-opcua";
+import { installFileType } from "node-opcua-file-transfer";
+
+```
+
+```typescript
+
+const server = new OPCUAServer({
+
+});
+
+await server.initialize();
+
+
+// let say we want to create a access to this file:
+const my_data_filename = "/data/someFile.txt";
+await promisify(fs.writeFile)(my_data_filename, "some content", "utf8");
+
+
+// now add a file object in the address Space
+const addressSpace = server.engine.addressSpace;
+
+// retrieve the FileType UAObjectType
+const fileType = addressSpace.findObjectType("FileType")!;
+
+// create a instance of FileType 
+const myFile = fileType.instantiate({
+    nodeId: "s=MyFile",
+    browseName: "MyFile",
+    organizedBy: addressSpace.rootFolder.objects
+}) as UAFileType;
+
+// now bind the opcuaFile object with our file
+installFileType(opcuaFile, { 
+    filename: my_data_filename
+});
+
+```
+
+
+## accessing a File node from a node-opcua client : ClientFile
+
+We assume that we have a valid OPCUA Client Session
+
+```javascript
+import { OPCUAClient } from "node-opcua";
+import { ClientFile } from "node-opcua-file-transfer";
+
+const client = OPCUAClient.create({});
+
+await client.connect();
+const session = await client.createSession();
+```
+
+Let's assume that the nodeId of the file object is "ns=1;s=MyFile"
+
+```javascript
+import {ClientFile,OpenFileMode } from "node-opcua-file-transfer";
+
+// 
+const fileNodeId = "ns=1;s=MyFile";
+
+// let's create a client file object from the session and nodeId
+const clientFile = new ClientFile(session, fileNodeId);
+
+// let's open the file
+const mode = OpenFileMode.ReadWriteAppend;
+await clientFile.open(mode);
+
+// ... do some reading or writing
+
+// don't forget to close the file when done
+await clientFile.close();
+```
+
+### operations
+
+#### ClientFile#size(): Promise<UInt64> :  get file size
+
+You can read the size of the file at any time.
+``` javascript
+const clientFile = new ClientFile(session, fileNodeId);
+
+const size = await clientFile.size();
+console.log("the current file size is : ",size," bytes);
+```
+
+#### ClientFile#open(mode: OpenFileMode) : open a file
+
+```javascript 
+const mode = OpenFileMode.ReadWriteAppend;
+await clientFile.open(mode);
+```
+
+#### OpenFileMode enumeration
+
+| Mode | Description |
+|------|-------------|
+| Read  |The file is opened for reading. the Write method cannot be executed. |
+| Write|The file is opened for writing. the Read cannot be executed. |
+| ReadWrite| The file is opened for reading an writing |
+| WriteEraseExisting | File is opened for writing only. The existing content of the file is erased and an empty file is provided. |
+| ReadWriteEraseExisting | File is opened for reading and writing.  The existing content of the file is erased and an empty file is provided.|
+| WriteAppend | File is opened for writing only and position is set at the end of the file |
+| ReadWriteAppend | File is opened for reading and writing and position is set at the end of the file |
+}
+#### ClientFile#close() : close a file
+
+```javascript 
+const mode = OpenFileMode.ReadWriteAppend;
+await clientFile.open(mode);
+
+// ... do some reading or writing
+
+// don't forget to close the file when done
+await clientFile.close();
+```
+#### ClientFile#setPosition(pos: UInt64) :  Setting read/write position
+
+Once the file is opened, the position for reading or writing can be set
+using setPosition. 
+* setPosition expect a UInt64 parameter (see note below)
+* setPosition will throw an exception if file is not opened
+
+``` javascript
+const clientFile = new ClientFile(session, fileNodeId);
+
+const mode = OpenFileMode.ReadWriteAppend;
+await clientFile.open(mode);
+
+await client.setPosition([0,32]);
+
+```
+
+#### ClientFile#getPosition(): Promise<UInt64> Getting read/write position
+Once the file is opened, the position for reading or writing can be retrieved
+using getPosition. 
+* getPosition returns a UInt64 parameter (see note below)
+* getPosition will throw an exception if file is not opened
+
+``` javascript
+const clientFile = new ClientFile(session, fileNodeId);
+
+const mode = OpenFileMode.ReadWriteAppend;
+await clientFile.open(mode);
+
+await client.setPosition(32);
+
+```
+
+#### ClientFile#write(buf: Buffer) : Writing data to the file
+
+Data can be writing to the file at the current cursor position.
+Data must be passed in a buffer.
+* write will throw an exception if file is not opened
+
+```javascript
+const dataToWrite = Buffer.from("Some data");
+
+const mode = OpenFileMode.ReadWriteAppend;
+await clientFile.open(mode);
+await clientFile.write(dataToWrite);
+```
+
+
+#### ClientFile#read(): Promise<Buffer> :reading data to the file
+
+Data can be writing to the file at the current cursor position.
+Data must be passed in a buffer.
+* read will throw an exception if file is not opened
+
+```javascript
+
+const mode = OpenFileMode.ReadWriteAppend;
+await clientFile.open(mode);
+
+// read 200 bytes from position 32
+await clientFile.setPosition([0,32]);
+const data: Buffer = await clientFile.read(200);
+```
+
+### notes
+
+UInt64
+* At this time BigInt, is not supported by all version of nodeJs that are targeted by node-opcua.
+UInt64 values are currently stored into a array of 2 32bits numbers : [ High,Low]
+
+

package/source/index.ts

@@ -1,5 +1,5 @@
-/**
- * @module node-opcua-file-transfer
- */
-export * from "./client/client_file";
-export * from "./server/file_type_helpers";
+/**
+ * @module node-opcua-file-transfer
+ */
+export * from "./client/client_file";
+export * from "./server/file_type_helpers";

package/source/open_mode.ts

@@ -1,41 +1,41 @@
-/**
- * @module node-opcua-file-transfer-server
- */
-export enum OpenFileModeMask {
-    ReadBit = 0x01,
-    WriteBit = 0x02,
-    EraseExistingBit = 0x04,
-    AppendBit = 0x08,
-}
-
-export enum OpenFileMode {
-    /**
-     *       Read         bit 0   The file is opened for reading. If this bit is not
-     *                            set the Read Method cannot be executed.
-     */
-    Read = OpenFileModeMask.ReadBit,
-    /**
-     *      Write         bit 1   The file is opened for writing. If this bit is not
-     *                            set the Write Method cannot be executed.
-     *
-     */
-    Write = OpenFileModeMask.WriteBit,
-    ReadWrite = OpenFileModeMask.ReadBit + OpenFileModeMask.WriteBit,
-
-    /**
-     *
-     *  WriteEraseExisting
-     *      EraseExisting 2   This bit can only be set if the file is opened for writing
-     *                        (Write bit is set). The existing content of the file is
-     *                        erased and an empty file is provided.
-     */
-    WriteEraseExisting = OpenFileModeMask.EraseExistingBit + OpenFileModeMask.WriteBit,
-    ReadWriteEraseExisting = OpenFileModeMask.EraseExistingBit + OpenFileModeMask.WriteBit + OpenFileModeMask.ReadBit,
-    /**
-     *      Append        3   When the Append bit is set the file is opened at end
-     *                        of the file, otherwise at begin of the file.
-     *                        The SetPosition Method can be used to change the position.
-     */
-    WriteAppend = OpenFileModeMask.AppendBit + OpenFileModeMask.WriteBit,
-    ReadWriteAppend = OpenFileModeMask.AppendBit + OpenFileModeMask.WriteBit + OpenFileModeMask.ReadBit,
-}
+/**
+ * @module node-opcua-file-transfer-server
+ */
+export enum OpenFileModeMask {
+    ReadBit = 0x01,
+    WriteBit = 0x02,
+    EraseExistingBit = 0x04,
+    AppendBit = 0x08,
+}
+
+export enum OpenFileMode {
+    /**
+     *       Read         bit 0   The file is opened for reading. If this bit is not
+     *                            set the Read Method cannot be executed.
+     */
+    Read = OpenFileModeMask.ReadBit,
+    /**
+     *      Write         bit 1   The file is opened for writing. If this bit is not
+     *                            set the Write Method cannot be executed.
+     *
+     */
+    Write = OpenFileModeMask.WriteBit,
+    ReadWrite = OpenFileModeMask.ReadBit + OpenFileModeMask.WriteBit,
+
+    /**
+     *
+     *  WriteEraseExisting
+     *      EraseExisting 2   This bit can only be set if the file is opened for writing
+     *                        (Write bit is set). The existing content of the file is
+     *                        erased and an empty file is provided.
+     */
+    WriteEraseExisting = OpenFileModeMask.EraseExistingBit + OpenFileModeMask.WriteBit,
+    ReadWriteEraseExisting = OpenFileModeMask.EraseExistingBit + OpenFileModeMask.WriteBit + OpenFileModeMask.ReadBit,
+    /**
+     *      Append        3   When the Append bit is set the file is opened at end
+     *                        of the file, otherwise at begin of the file.
+     *                        The SetPosition Method can be used to change the position.
+     */
+    WriteAppend = OpenFileModeMask.AppendBit + OpenFileModeMask.WriteBit,
+    ReadWriteAppend = OpenFileModeMask.AppendBit + OpenFileModeMask.WriteBit + OpenFileModeMask.ReadBit,
+}