node-opcua-file-transfer 2.71.0 → 2.72.2

package/dist/index.js

@@ -1,22 +1,22 @@
-"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/client_file"), exports);
-__exportStar(require("./server/file_type_helpers"), exports);
+"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/client_file"), exports);
+__exportStar(require("./server/file_type_helpers"), exports);
 //# sourceMappingURL=index.js.map

package/dist/open_mode.d.ts

@@ -1,39 +1,39 @@
-/**
- * @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
-}
+/**
+ * @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 +1,45 @@
-"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 = {}));
+"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/server/file_type_helpers.d.ts

@@ -1,70 +1,70 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-import { Stats, PathLike, OpenMode, NoParamCallback, WriteFileOptions } from "fs";
-import { UAFile, UAFile_Base, UAObjectType } from "node-opcua-address-space";
-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;
-}
-/**
- *
- */
-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
-     */
-    mineType?: string;
-    fileSystem?: AbstractFs;
-}
-export interface UAFileType extends UAObjectType, UAFile_Base {
-}
-/**
- *
- */
-export declare class FileTypeData {
-    _fs: AbstractFs;
-    filename: string;
-    maxSize: number;
-    mimeType: string;
-    private file;
-    private _openCount;
-    private _fileSize;
-    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>;
-}
-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;
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { Stats, PathLike, OpenMode, NoParamCallback, WriteFileOptions } from "fs";
+import { UAFile, UAFile_Base, UAObjectType } from "node-opcua-address-space";
+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;
+}
+/**
+ *
+ */
+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
+     */
+    mineType?: string;
+    fileSystem?: AbstractFs;
+}
+export interface UAFileType extends UAObjectType, UAFile_Base {
+}
+/**
+ *
+ */
+export declare class FileTypeData {
+    _fs: AbstractFs;
+    filename: string;
+    maxSize: number;
+    mimeType: string;
+    private file;
+    private _openCount;
+    private _fileSize;
+    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>;
+}
+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;