node-opcua-file-transfer 2.64.0 → 2.65.1

package/package.json

@@ -1,59 +1,58 @@
 {
-  "name": "node-opcua-file-transfer",
-  "version": "2.64.0",
-  "description": "pure nodejs OPCUA SDK - module -server",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "dependencies": {
-    "node-opcua-address-space": "2.64.0",
-    "node-opcua-assert": "2.64.0",
-    "node-opcua-basic-types": "2.64.0",
-    "node-opcua-client": "2.64.0",
-    "node-opcua-constants": "2.64.0",
-    "node-opcua-data-model": "2.64.0",
-    "node-opcua-debug": "2.64.0",
-    "node-opcua-nodeid": "2.64.0",
-    "node-opcua-nodesets": "2.64.0",
-    "node-opcua-pki": "^2.13.0",
-    "node-opcua-pseudo-session": "2.64.0",
-    "node-opcua-secure-channel": "2.64.0",
-    "node-opcua-server": "2.64.0",
-    "node-opcua-service-call": "2.64.0",
-    "node-opcua-service-read": "2.64.0",
-    "node-opcua-service-translate-browse-path": "2.64.0",
-    "node-opcua-status-code": "2.64.0",
-    "node-opcua-types": "2.64.0",
-    "node-opcua-variant": "2.64.0"
-  },
-  "devDependencies": {
-    "memfs": "^3.4.1",
-    "node-opcua-binary-stream": "2.64.0",
-    "node-opcua-data-value": "2.64.0",
-    "node-opcua-leak-detector": "2.64.0",
-    "should": "^13.2.3",
-    "sinon": "^13.0.1"
-  },
-  "author": "Etienne Rossignon",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/node-opcua/node-opcua.git"
-  },
-  "keywords": [
-    "OPCUA",
-    "opcua",
-    "m2m",
-    "iot",
-    "opc ua",
-    "internet of things"
-  ],
-  "homepage": "http://node-opcua.github.io/",
-  "gitHead": "07dcdd8e8c7f2b55544c6e23023093e35674829c",
-  "scripts": {
-    "build": "tsc -b",
-    "lint": "eslint source/**/*.ts",
-    "clean": "node -e \"require('rimraf').sync('dist');\"",
-    "test": "mocha"
-  },
-  "readme": "## introduction\n\nthis package provides an implementation of the OPCUA File Transfer\nspecification as per OPCUA 1.0.4 part 5 Annex C (page 99)\n \n\n## installation\n\n```bash\n$ npm install node-opcua\n$ npm install node-opcua-file-transfer\n```\n\n## exposing a File node in the addressSpace\n\n```javascript\nimport { OPCUAServer, UAFile } from \"node-opcua\";\nimport { installFileType } from \"node-opcua-file-transfer\";\n\n```\n\n```typescript\n\nconst server = new OPCUAServer({\n\n});\n\nawait server.initialize();\n\n\n// let say we want to create a access to this file:\nconst my_data_filename = \"/data/someFile.txt\";\nawait promisify(fs.writeFile)(my_data_filename, \"some content\", \"utf8\");\n\n\n// now add a file object in the address Space\nconst addressSpace = server.engine.addressSpace;\n\n// retrieve the FileType UAObjectType\nconst fileType = addressSpace.findObjectType(\"FileType\")!;\n\n// create a instance of FileType \nconst myFile = fileType.instantiate({\n    nodeId: \"s=MyFile\",\n    browseName: \"MyFile\",\n    organizedBy: addressSpace.rootFolder.objects\n}) as UAFile;\n\n// now bind the opcuaFile object with our file\ninstallFileType(opcuaFile, { \n    filename: my_data_filename\n});\n\n```\n\n\n## accessing a File node from a node-opcua client : ClientFile\n\nWe assume that we have a valid OPCUA Client Session\n\n```javascript\nimport { OPCUAClient } from \"node-opcua\";\nimport { ClientFile } from \"node-opcua-file-transfer\";\n\nconst client = OPCUAClient.create({});\n\nawait client.connect();\nconst session = await client.createSession();\n```\n\nLet's assume that the nodeId of the file object is \"ns=1;s=MyFile\"\n\n```javascript\nimport {ClientFile,OpenFileMode } from \"node-opcua-file-transfer\";\n\n// \nconst fileNodeId = \"ns=1;s=MyFile\";\n\n// let's create a client file object from the session and nodeId\nconst clientFile = new ClientFile(session, fileNodeId);\n\n// let's open the file\nconst mode = OpenFileMode.ReadWriteAppend;\nawait clientFile.open(mode);\n\n// ... do some reading or writing\n\n// don't forget to close the file when done\nawait clientFile.close();\n```\n\n### operations\n\n#### ClientFile#size(): Promise<UInt64> :  get file size\n\nYou can read the size of the file at any time.\n``` javascript\nconst clientFile = new ClientFile(session, fileNodeId);\n\nconst size = await clientFile.size();\nconsole.log(\"the current file size is : \",size,\" bytes);\n```\n\n#### ClientFile#open(mode: OpenFileMode) : open a file\n\n```javascript \nconst mode = OpenFileMode.ReadWriteAppend;\nawait clientFile.open(mode);\n```\n\n#### OpenFileMode enumeration\n\n| Mode | Description |\n|------|-------------|\n| Read  |The file is opened for reading. the Write method cannot be executed. |\n| Write|The file is opened for writing. the Read cannot be executed. |\n| ReadWrite| The file is opened for reading an writing |\n| WriteEraseExisting | File is opened for writing only. The existing content of the file is erased and an empty file is provided. |\n| ReadWriteEraseExisting | File is opened for reading and writing.  The existing content of the file is erased and an empty file is provided.|\n| WriteAppend | File is opened for writing only and position is set at the end of the file |\n| ReadWriteAppend | File is opened for reading and writing and position is set at the end of the file |\n}\n#### ClientFile#close() : close a file\n\n```javascript \nconst mode = OpenFileMode.ReadWriteAppend;\nawait clientFile.open(mode);\n\n// ... do some reading or writing\n\n// don't forget to close the file when done\nawait clientFile.close();\n```\n#### ClientFile#setPosition(pos: UInt64) :  Setting read/write position\n\nOnce the file is opened, the position for reading or writing can be set\nusing setPosition. \n* setPosition expect a UInt64 parameter (see note below)\n* setPosition will throw an exception if file is not opened\n\n``` javascript\nconst clientFile = new ClientFile(session, fileNodeId);\n\nconst mode = OpenFileMode.ReadWriteAppend;\nawait clientFile.open(mode);\n\nawait client.setPosition([0,32]);\n\n```\n\n#### ClientFile#getPosition(): Promise<UInt64> Getting read/write position\nOnce the file is opened, the position for reading or writing can be retrieved\nusing getPosition. \n* getPosition returns a UInt64 parameter (see note below)\n* getPosition will throw an exception if file is not opened\n\n``` javascript\nconst clientFile = new ClientFile(session, fileNodeId);\n\nconst mode = OpenFileMode.ReadWriteAppend;\nawait clientFile.open(mode);\n\nawait client.setPosition(32);\n\n```\n\n#### ClientFile#write(buf: Buffer) : Writing data to the file\n\nData can be writing to the file at the current cursor position.\nData must be passed in a buffer.\n* write will throw an exception if file is not opened\n\n```javascript\nconst dataToWrite = Buffer.from(\"Some data\");\n\nconst mode = OpenFileMode.ReadWriteAppend;\nawait clientFile.open(mode);\nawait clientFile.write(dataToWrite);\n```\n\n\n#### ClientFile#read(): Promise<Buffer> :reading data to the file\n\nData can be writing to the file at the current cursor position.\nData must be passed in a buffer.\n* read will throw an exception if file is not opened\n\n```javascript\n\nconst mode = OpenFileMode.ReadWriteAppend;\nawait clientFile.open(mode);\n\n// read 200 bytes from position 32\nawait clientFile.setPosition([0,32]);\nconst data: Buffer = await clientFile.read(200);\n```\n\n### notes\n\nUInt64\n* At this time BigInt, is not supported by all version of nodeJs that are targeted by node-opcua.\nUInt64 values are currently stored into a array of 2 32bits numbers : [ High,Low]\n\n\n"
-}
+    "name": "node-opcua-file-transfer",
+    "version": "2.65.1",
+    "description": "pure nodejs OPCUA SDK - module -server",
+    "scripts": {
+        "build": "tsc -b",
+        "lint": "eslint source/**/*.ts",
+        "clean": "node -e \"require('rimraf').sync('dist');\"",
+        "test": "mocha"
+    },
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "dependencies": {
+        "node-opcua-address-space": "2.65.1",
+        "node-opcua-assert": "2.64.1",
+        "node-opcua-basic-types": "2.64.1",
+        "node-opcua-client": "2.65.1",
+        "node-opcua-constants": "2.64.1",
+        "node-opcua-data-model": "2.64.1",
+        "node-opcua-debug": "2.64.1",
+        "node-opcua-nodeid": "2.64.1",
+        "node-opcua-nodesets": "2.64.1",
+        "node-opcua-pki": "^2.14.1",
+        "node-opcua-pseudo-session": "2.65.1",
+        "node-opcua-secure-channel": "2.65.1",
+        "node-opcua-server": "2.65.1",
+        "node-opcua-service-call": "2.65.1",
+        "node-opcua-service-read": "2.65.1",
+        "node-opcua-service-translate-browse-path": "2.65.1",
+        "node-opcua-status-code": "2.64.1",
+        "node-opcua-types": "2.65.1",
+        "node-opcua-variant": "2.64.1"
+    },
+    "devDependencies": {
+        "memfs": "^3.4.1",
+        "node-opcua-binary-stream": "2.64.1",
+        "node-opcua-data-value": "2.64.1",
+        "node-opcua-leak-detector": "2.64.1",
+        "should": "^13.2.3",
+        "sinon": "^13.0.1"
+    },
+    "author": "Etienne Rossignon",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git://github.com/node-opcua/node-opcua.git"
+    },
+    "keywords": [
+        "OPCUA",
+        "opcua",
+        "m2m",
+        "iot",
+        "opc ua",
+        "internet of things"
+    ],
+    "homepage": "http://node-opcua.github.io/",
+    "gitHead": "494c1a72df17756dafa8661648d7ae4d89be89ea"
+}

package/readme.md

@@ -112,13 +112,12 @@ await clientFile.open(mode);
 
 | 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 |
+| 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 and writing |
+| WriteEraseExisting | File is open for writing only. The existing content of the file is erased and an empty file is provided. |
+| WriteAppend | File is open for writing only and the position is set at the end of the file |
+| ReadWriteAppend | File is opened for reading and writing and the position is set at the end of the file |
 }
 #### ClientFile#close() : close a file
 
@@ -181,9 +180,9 @@ 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 can be written 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
+* read will throw an exception if the file is not opened
 
 ```javascript
 
@@ -198,7 +197,7 @@ 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]
+* At this time BigInt, is not supported by all versions of nodeJs that are targeted by node-opcua.
+UInt64 values are currently stored into an array of 2 32bits numbers : [ High,Low]