node-opcua-file-transfer 2.97.0 → 2.98.0

package/dist/client/write_file.js

@@ -1,66 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeOPCUAFile = void 0;
-const fs = require("node:fs");
-const node_stream_1 = require("node:stream");
-const promises_1 = require("node:stream/promises");
-const node_opcua_binary_stream_1 = require("node-opcua-binary-stream");
-const node_opcua_debug_1 = require("node-opcua-debug");
-const client_file_1 = require("./client_file");
-const read_max_byte_string_length_1 = require("./read_max_byte_string_length");
-const debugLog = (0, node_opcua_debug_1.make_debugLog)("FileType");
-// const errorLog = make_errorLog("FileType");
-// const warningLog = make_warningLog("FileType");
-const doDebug = (0, node_opcua_debug_1.checkDebugFlag)("FileType");
-function getTransportMaxMessageSize(session) {
-    return session.getTransportSettings ? session.getTransportSettings().maxMessageSize : 0;
-}
-function writeOPCUAFile(clientFile, filePath, { chunkSize }) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const maxMessageSize = getTransportMaxMessageSize(clientFile.session);
-        chunkSize = chunkSize === undefined ? yield (0, read_max_byte_string_length_1.readMaxByteStringLength)(clientFile.session) : chunkSize;
-        chunkSize = Math.min(chunkSize, node_opcua_binary_stream_1.BinaryStream.maxByteStringLength);
-        if (maxMessageSize > 200) {
-            chunkSize = Math.min(chunkSize, maxMessageSize - 1000);
-        }
-        console.log("chunkSize = ", chunkSize, maxMessageSize);
-        if (!fs.existsSync(filePath)) {
-            throw new Error(`File ${filePath} does not exist`);
-        }
-        const readStream = fs.createReadStream(filePath, { highWaterMark: chunkSize });
-        yield clientFile.open(client_file_1.OpenFileMode.WriteEraseExisting);
-        yield clientFile.setPosition(0);
-        try {
-            const outStream = new node_stream_1.Writable({
-                write(chunk, encoding, callback) {
-                    doDebug && debugLog("writing chunk", chunk.length);
-                    clientFile
-                        .write(chunk)
-                        .then(() => callback())
-                        .catch((err) => callback(err));
-                }
-            });
-            // note: pipeline requires NodeJS 15 or above
-            yield (0, promises_1.pipeline)(readStream, outStream);
-        }
-        catch (e) {
-            debugLog(e.message);
-            throw e;
-        }
-        finally {
-            doDebug && debugLog("closing the OPCUA File");
-            yield clientFile.close();
-        }
-    });
-}
-exports.writeOPCUAFile = writeOPCUAFile;
-//# sourceMappingURL=write_file.js.map

package/dist/client/write_file.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"write_file.js","sourceRoot":"","sources":["../../source/client/write_file.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,8BAA8B;AAC9B,6CAAuC;AACvC,mDAAgD;AAGhD,uEAAwD;AAExD,uDAAiE;AAGjE,+CAA0D;AAC1D,+EAAwE;AAExE,MAAM,QAAQ,GAAG,IAAA,gCAAa,EAAC,UAAU,CAAC,CAAC;AAC3C,8CAA8C;AAC9C,kDAAkD;AAClD,MAAM,OAAO,GAAG,IAAA,iCAAc,EAAC,UAAU,CAAC,CAAC;AAE3C,SAAS,0BAA0B,CAAC,OAAsB;IACtD,OAAO,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5F,CAAC;AAED,SAAsB,cAAc,CAAC,UAAuB,EAAE,QAAgB,EAAE,EAAE,SAAS,EAA0B;;QACjH,MAAM,cAAc,GAAG,0BAA0B,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEtE,SAAS,GAAG,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,IAAA,qDAAuB,EAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACpG,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,uCAAY,CAAC,mBAAmB,CAAC,CAAC;QAClE,IAAI,cAAc,GAAG,GAAG,EAAE;YACtB,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,cAAc,GAAG,IAAI,CAAC,CAAC;SAC1D;QACD,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;QAEvD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,QAAQ,QAAQ,iBAAiB,CAAC,CAAC;SACtD;QACD,MAAM,UAAU,GAAG,EAAE,CAAC,gBAAgB,CAAC,QAAQ,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC,CAAC;QAC/E,MAAM,UAAU,CAAC,IAAI,CAAC,0BAAY,CAAC,kBAAkB,CAAC,CAAC;QACvD,MAAM,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QAChC,IAAI;YACA,MAAM,SAAS,GAAG,IAAI,sBAAQ,CAAC;gBAC3B,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ;oBAC3B,OAAO,IAAI,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;oBACnD,UAAU;yBACL,KAAK,CAAC,KAAK,CAAC;yBACZ,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;yBACtB,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;gBACvC,CAAC;aACJ,CAAC,CAAC;YACH,6CAA6C;YAC7C,MAAM,IAAA,mBAAQ,EAAC,UAAU,EAAE,SAAS,CAAC,CAAC;SACzC;QAAC,OAAO,CAAC,EAAE;YACR,QAAQ,CAAE,CAAW,CAAC,OAAO,CAAC,CAAC;YAC/B,MAAM,CAAC,CAAC;SACX;gBAAS;YACN,OAAO,IAAI,QAAQ,CAAC,wBAAwB,CAAC,CAAC;YAC9C,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC;SAC5B;IACL,CAAC;CAAA;AAnCD,wCAmCC"}

package/dist/common/abstract_fs.d.ts

@@ -1,19 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-import { Stats, PathLike, OpenMode, NoParamCallback, WriteFileOptions } from "fs";
-export interface ReadStreamOptions {
-}
-export interface AbstractFs {
-    stat(path: PathLike, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void;
-    open(path: PathLike, flags: OpenMode, callback: (err: NodeJS.ErrnoException | null, fd: number) => void): void;
-    write<TBuffer extends NodeJS.ArrayBufferView>(fd: number, buffer: TBuffer, offset: number | undefined | null, length: number | undefined | null, position: number | undefined | null, callback: (err: NodeJS.ErrnoException | null, bytesWritten: number, buffer: TBuffer) => void): void;
-    read<TBuffer extends NodeJS.ArrayBufferView>(fd: number, buffer: TBuffer, offset: number, length: number, position: number | null, callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: TBuffer) => void): void;
-    close(fd: number, callback: NoParamCallback): void;
-    writeFile(path: PathLike | number, data: string | NodeJS.ArrayBufferView, options: WriteFileOptions, callback: NoParamCallback): void;
-    readFile(path: PathLike | number, options: {
-        encoding: BufferEncoding;
-        flag?: string;
-    } | string, callback: (err: NodeJS.ErrnoException | null, data: string) => void): void;
-    existsSync(filename: string): boolean;
-}

package/dist/common/abstract_fs.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=abstract_fs.js.map

package/dist/common/abstract_fs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"abstract_fs.js","sourceRoot":"","sources":["../../source/common/abstract_fs.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -1,6 +0,0 @@
-/**
- * @module node-opcua-file-transfer
- */
-export * from "./client";
-export * from "./server/file_type_helpers";
-export * from "./common/abstract_fs";

package/dist/index.js

@@ -1,23 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * @module node-opcua-file-transfer
- */
-__exportStar(require("./client"), exports);
-__exportStar(require("./server/file_type_helpers"), exports);
-__exportStar(require("./common/abstract_fs"), exports);
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../source/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;GAEG;AACH,2CAAyB;AACzB,6DAA2C;AAC3C,uDAAqC"}

package/dist/open_mode.d.ts

@@ -1,39 +0,0 @@
-/**
- * @module node-opcua-file-transfer-server
- */
-export declare enum OpenFileModeMask {
-    ReadBit = 1,
-    WriteBit = 2,
-    EraseExistingBit = 4,
-    AppendBit = 8
-}
-export declare enum OpenFileMode {
-    /**
-     *       Read         bit 0   The file is opened for reading. If this bit is not
-     *                            set the Read Method cannot be executed.
-     */
-    Read = 1,
-    /**
-     *      Write         bit 1   The file is opened for writing. If this bit is not
-     *                            set the Write Method cannot be executed.
-     *
-     */
-    Write = 2,
-    ReadWrite = 3,
-    /**
-     *
-     *  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 = 6,
-    ReadWriteEraseExisting = 7,
-    /**
-     *      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 = 10,
-    ReadWriteAppend = 11
-}

package/dist/open_mode.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenFileMode = exports.OpenFileModeMask = void 0;
-/**
- * @module node-opcua-file-transfer-server
- */
-var OpenFileModeMask;
-(function (OpenFileModeMask) {
-    OpenFileModeMask[OpenFileModeMask["ReadBit"] = 1] = "ReadBit";
-    OpenFileModeMask[OpenFileModeMask["WriteBit"] = 2] = "WriteBit";
-    OpenFileModeMask[OpenFileModeMask["EraseExistingBit"] = 4] = "EraseExistingBit";
-    OpenFileModeMask[OpenFileModeMask["AppendBit"] = 8] = "AppendBit";
-})(OpenFileModeMask = exports.OpenFileModeMask || (exports.OpenFileModeMask = {}));
-var OpenFileMode;
-(function (OpenFileMode) {
-    /**
-     *       Read         bit 0   The file is opened for reading. If this bit is not
-     *                            set the Read Method cannot be executed.
-     */
-    OpenFileMode[OpenFileMode["Read"] = 1] = "Read";
-    /**
-     *      Write         bit 1   The file is opened for writing. If this bit is not
-     *                            set the Write Method cannot be executed.
-     *
-     */
-    OpenFileMode[OpenFileMode["Write"] = 2] = "Write";
-    OpenFileMode[OpenFileMode["ReadWrite"] = 3] = "ReadWrite";
-    /**
-     *
-     *  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.
-     */
-    OpenFileMode[OpenFileMode["WriteEraseExisting"] = 6] = "WriteEraseExisting";
-    OpenFileMode[OpenFileMode["ReadWriteEraseExisting"] = 7] = "ReadWriteEraseExisting";
-    /**
-     *      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.
-     */
-    OpenFileMode[OpenFileMode["WriteAppend"] = 10] = "WriteAppend";
-    OpenFileMode[OpenFileMode["ReadWriteAppend"] = 11] = "ReadWriteAppend";
-})(OpenFileMode = exports.OpenFileMode || (exports.OpenFileMode = {}));
-//# sourceMappingURL=open_mode.js.map

package/dist/open_mode.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"open_mode.js","sourceRoot":"","sources":["../source/open_mode.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,gBAKX;AALD,WAAY,gBAAgB;IACxB,6DAAc,CAAA;IACd,+DAAe,CAAA;IACf,+EAAuB,CAAA;IACvB,iEAAgB,CAAA;AACpB,CAAC,EALW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAK3B;AAED,IAAY,YA8BX;AA9BD,WAAY,YAAY;IACpB;;;OAGG;IACH,+CAA+B,CAAA;IAC/B;;;;OAIG;IACH,iDAAiC,CAAA;IACjC,yDAAgE,CAAA;IAEhE;;;;;;OAMG;IACH,2EAAkF,CAAA;IAClF,mFAAiH,CAAA;IACjH;;;;OAIG;IACH,8DAAoE,CAAA;IACpE,sEAAmG,CAAA;AACvG,CAAC,EA9BW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QA8BvB"}

package/dist/server/file_type_helpers.d.ts

@@ -1,81 +0,0 @@
-/**
- * @module node-opcua-file-transfer
- */
-/// <reference types="node" />
-import { UAFile, UAFile_Base, UAObjectType } from "node-opcua-address-space";
-import { NodeIdLike } from "node-opcua-nodeid";
-import { AbstractFs } from "../common/abstract_fs";
-/**
- *
- */
-export interface FileOptions {
-    /**
-     * the filaname of the physical file which is managed by the OPCUA filetpye
-     */
-    filename: string;
-    /**
-     * the maximum allowed size of the  phisical file.
-     */
-    maxSize?: number;
-    /**
-     * an optional mimeType
-     */
-    mimeType?: string;
-    fileSystem?: AbstractFs;
-    nodeId?: NodeIdLike;
-    /**
-     * the maximum number of bytes that can be read from the file
-     * in a single read call
-     * - if not specified or 0, we assume Int32 limit
-     */
-    maxChunkSize?: number;
-    refreshFileContentFunc?: () => Promise<void>;
-}
-export interface UAFileType extends UAObjectType, UAFile_Base {
-}
-/**
- *
- */
-export declare class FileTypeData {
-    _fs: AbstractFs;
-    filename: string;
-    maxSize: number;
-    mimeType: string;
-    maxChunkSizeBytes: number;
-    private file;
-    private _openCount;
-    private _fileSize;
-    static maxChunkSize: number;
-    refreshFileContentFunc?: () => Promise<void>;
-    constructor(options: FileOptions, file: UAFile);
-    set openCount(value: number);
-    get openCount(): number;
-    set fileSize(value: number);
-    get fileSize(): number;
-    /**
-     * refresh position and size
-     * this method should be call by the server if the file
-     * is modified externally
-     *
-     */
-    refresh(): Promise<void>;
-    refreshFileContent(): Promise<void>;
-}
-export declare function writeFile(fileSystem: AbstractFs, filename: string, content: Buffer): Promise<void>;
-/**
- * @private
- */
-export interface UAFileEx extends UAFile {
-    $fileData: FileTypeData;
-}
-/**
- * @orivate
- */
-export declare function getFileData(opcuaFile2: UAFile): FileTypeData;
-export declare const defaultMaxSize = 100000000;
-/**
- * bind all methods of a UAFile OPCUA node
- * @param file the OPCUA Node that has a typeDefinition of FileType
- * @param options the options
- */
-export declare function installFileType(_file: UAFile, options: FileOptions): void;