node-opcua-utils 2.51.0

package/dist/timestamp.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.timestamp = void 0;
+function w(s, length) {
+    return ("000" + s).substr(-length);
+}
+function t(d) {
+    return w(d.getUTCHours(), 2) + ":"
+        + w(d.getUTCMinutes(), 2) + ":"
+        + w(d.getUTCSeconds(), 2) + ":"
+        + w(d.getMilliseconds(), 3);
+}
+function timestamp() {
+    return t(new Date());
+}
+exports.timestamp = timestamp;
+//# sourceMappingURL=timestamp.js.map

package/dist/timestamp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timestamp.js","sourceRoot":"","sources":["../source/timestamp.ts"],"names":[],"mappings":";;;AAAA,SAAS,CAAC,CAAC,CAAkB,EAAE,MAAc;IACzC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AACvC,CAAC;AAED,SAAS,CAAC,CAAC,CAAO;IACd,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG;UAC5B,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG;UAC7B,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG;UAC7B,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,CAAC;AACpC,CAAC;AAED,SAAgB,SAAS;IACrB,OAAO,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;AACzB,CAAC;AAFD,8BAEC"}

package/dist/watchdog.d.ts

@@ -0,0 +1,56 @@
+/// <reference types="node" />
+/**
+ * @module node-opcua-utils
+ */
+import { EventEmitter } from "events";
+declare type ArbitraryClockTick = number;
+declare type DurationInMillisecond = number;
+export interface IWatchdogData2 {
+    key: number;
+    subscriber: ISubscriber;
+    timeout: DurationInMillisecond;
+    lastSeen: ArbitraryClockTick;
+    visitCount: number;
+}
+export interface ISubscriber {
+    _watchDog?: WatchDog;
+    _watchDogData?: IWatchdogData2;
+    watchdogReset: () => void;
+    keepAlive?: () => void;
+    onClientSeen?: () => void;
+}
+export declare class WatchDog extends EventEmitter {
+    static emptyKeepAlive: () => void;
+    /**
+     * returns the number of subscribers using the WatchDog object.
+     */
+    get subscriberCount(): number;
+    private readonly _watchdogDataMap;
+    private _counter;
+    private _currentTime;
+    private _timer;
+    private readonly _visitSubscriberB;
+    constructor();
+    /**
+     * add a subscriber to the WatchDog.
+     * @method addSubscriber
+     *
+     * add a subscriber to the WatchDog.
+     *
+     * This method modifies the subscriber be adding a
+     * new method to it called 'keepAlive'
+     * The subscriber must also provide a "watchdogReset". watchdogReset will be called
+     * if the subscriber failed to call keepAlive withing the timeout period.
+     * @param subscriber
+     * @param timeout
+     * @return the numerical key associated with this subscriber
+     */
+    addSubscriber(subscriber: ISubscriber, timeout: number): number;
+    removeSubscriber(subscriber: ISubscriber): void;
+    shutdown(): void;
+    getCurrentSystemTick(): ArbitraryClockTick;
+    private _visit_subscriber;
+    private _start_timer;
+    private _stop_timer;
+}
+export {};

package/dist/watchdog.js

@@ -0,0 +1,156 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WatchDog = void 0;
+/**
+ * @module node-opcua-utils
+ */
+const events_1 = require("events");
+const node_opcua_assert_1 = require("node-opcua-assert");
+/**
+ * a arbitrary clock which is system dependant and
+ * insensible to clock drifts ....
+ *
+ */
+function _getCurrentSystemTick() {
+    if (process && process.hrtime) {
+        const h = process.hrtime();
+        const n = h[1] / 1000000;
+        (0, node_opcua_assert_1.assert)(n <= 1000);
+        return h[0] * 1000 + n;
+    }
+    else {
+        // fallback to Date as process.hrtime doesn't exit
+        return Date.now();
+    }
+}
+function hasExpired(watchDogData, currentTime) {
+    const elapsedTime = currentTime - watchDogData.lastSeen;
+    return elapsedTime > watchDogData.timeout;
+}
+function keepAliveFunc() {
+    (0, node_opcua_assert_1.assert)(this._watchDog instanceof WatchDog);
+    // istanbul ignore next
+    if (!this._watchDogData || !this._watchDog) {
+        throw new Error("Internal error");
+    }
+    (0, node_opcua_assert_1.assert)(typeof this._watchDogData.key === "number");
+    this._watchDogData.lastSeen = this._watchDog.getCurrentSystemTick();
+    if (this.onClientSeen) {
+        this.onClientSeen();
+    }
+}
+class WatchDog extends events_1.EventEmitter {
+    constructor() {
+        super();
+        this._watchdogDataMap = {};
+        this._counter = 0;
+        this._currentTime = this.getCurrentSystemTick();
+        this._visitSubscriberB = this._visit_subscriber.bind(this);
+        this._timer = null; // as NodeJS.Timer;
+    }
+    /**
+     * returns the number of subscribers using the WatchDog object.
+     */
+    get subscriberCount() {
+        return Object.keys(this._watchdogDataMap).length;
+    }
+    /**
+     * add a subscriber to the WatchDog.
+     * @method addSubscriber
+     *
+     * add a subscriber to the WatchDog.
+     *
+     * This method modifies the subscriber be adding a
+     * new method to it called 'keepAlive'
+     * The subscriber must also provide a "watchdogReset". watchdogReset will be called
+     * if the subscriber failed to call keepAlive withing the timeout period.
+     * @param subscriber
+     * @param timeout
+     * @return the numerical key associated with this subscriber
+     */
+    addSubscriber(subscriber, timeout) {
+        this._currentTime = this.getCurrentSystemTick();
+        timeout = timeout || 1000;
+        (0, node_opcua_assert_1.assert)(typeof timeout === "number", " invalid timeout ");
+        (0, node_opcua_assert_1.assert)(typeof subscriber.watchdogReset === "function", " the subscriber must provide a watchdogReset method ");
+        (0, node_opcua_assert_1.assert)(typeof subscriber.keepAlive !== "function" || subscriber.keepAlive === WatchDog.emptyKeepAlive);
+        this._counter += 1;
+        const key = this._counter;
+        subscriber._watchDog = this;
+        subscriber._watchDogData = {
+            key,
+            lastSeen: this._currentTime,
+            subscriber,
+            timeout,
+            visitCount: 0
+        };
+        this._watchdogDataMap[key] = subscriber._watchDogData;
+        if (subscriber.onClientSeen) {
+            subscriber.onClientSeen();
+        }
+        subscriber.keepAlive = keepAliveFunc.bind(subscriber);
+        // start timer when the first subscriber comes in
+        if (this.subscriberCount === 1) {
+            (0, node_opcua_assert_1.assert)(this._timer === null);
+            this._start_timer();
+        }
+        (0, node_opcua_assert_1.assert)(this._timer !== null);
+        return key;
+    }
+    removeSubscriber(subscriber) {
+        if (!subscriber._watchDog) {
+            return; // already removed !!!
+        }
+        if (!subscriber._watchDogData) {
+            throw new Error("Internal error");
+        }
+        (0, node_opcua_assert_1.assert)(subscriber._watchDog instanceof WatchDog);
+        (0, node_opcua_assert_1.assert)(typeof subscriber._watchDogData.key === "number");
+        (0, node_opcua_assert_1.assert)(typeof subscriber.keepAlive === "function");
+        (0, node_opcua_assert_1.assert)(this._watchdogDataMap.hasOwnProperty(subscriber._watchDogData.key));
+        delete this._watchdogDataMap[subscriber._watchDogData.key];
+        delete subscriber._watchDog;
+        delete subscriber._watchDogData;
+        subscriber.keepAlive = WatchDog.emptyKeepAlive;
+        // delete timer when the last subscriber comes out
+        if (this.subscriberCount === 0) {
+            this._stop_timer();
+        }
+    }
+    shutdown() {
+        (0, node_opcua_assert_1.assert)(this._timer === null && Object.keys(this._watchdogDataMap).length === 0, " leaking subscriber in watchdog");
+    }
+    getCurrentSystemTick() {
+        return _getCurrentSystemTick();
+    }
+    _visit_subscriber() {
+        this._currentTime = this.getCurrentSystemTick();
+        const expiredSubscribers = Object.values(this._watchdogDataMap).filter((watchDogData) => {
+            watchDogData.visitCount += 1;
+            return hasExpired(watchDogData, this._currentTime);
+        });
+        if (expiredSubscribers.length) {
+            this.emit("timeout", expiredSubscribers);
+        }
+        expiredSubscribers.forEach((watchDogData) => {
+            this.removeSubscriber(watchDogData.subscriber);
+            watchDogData.subscriber.watchdogReset();
+        });
+    }
+    _start_timer() {
+        (0, node_opcua_assert_1.assert)(this._timer === null, " setInterval already called ?");
+        this._timer = setInterval(this._visitSubscriberB, 1000);
+    }
+    _stop_timer() {
+        (0, node_opcua_assert_1.assert)(this._timer !== null, "_stop_timer already called ?");
+        if (this._timer !== null) {
+            clearInterval(this._timer);
+            this._timer = null;
+        }
+    }
+}
+exports.WatchDog = WatchDog;
+WatchDog.emptyKeepAlive = () => {
+    /* */
+};
+//# sourceMappingURL=watchdog.js.map

package/dist/watchdog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"watchdog.js","sourceRoot":"","sources":["../source/watchdog.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,mCAAsC;AACtC,yDAA2C;AAK3C;;;;GAIG;AACH,SAAS,qBAAqB;IAC1B,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE;QAC3B,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QAC3B,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;QACzB,IAAA,0BAAM,EAAC,CAAC,IAAI,IAAI,CAAC,CAAC;QAClB,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC;KAC1B;SAAM;QACH,kDAAkD;QAClD,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;KACrB;AACL,CAAC;AAmBD,SAAS,UAAU,CAAC,YAA4B,EAAE,WAA+B;IAC7E,MAAM,WAAW,GAAG,WAAW,GAAG,YAAY,CAAC,QAAQ,CAAC;IACxD,OAAO,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC;AAC9C,CAAC;AAED,SAAS,aAAa;IAClB,IAAA,0BAAM,EAAC,IAAI,CAAC,SAAS,YAAY,QAAQ,CAAC,CAAC;IAC3C,uBAAuB;IACvB,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;QACxC,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;IACD,IAAA,0BAAM,EAAC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC;IACnD,IAAI,CAAC,aAAa,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,oBAAoB,EAAE,CAAC;IACpE,IAAI,IAAI,CAAC,YAAY,EAAE;QACnB,IAAI,CAAC,YAAY,EAAE,CAAC;KACvB;AACL,CAAC;AAED,MAAa,QAAS,SAAQ,qBAAY;IAiBtC;QACI,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QAClB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAChD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3D,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,mBAAmB;IAC3C,CAAC;IArBD;;OAEG;IACH,IAAI,eAAe;QACf,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC;IACrD,CAAC;IAkBD;;;;;;;;;;;;;OAaG;IACI,aAAa,CAAC,UAAuB,EAAE,OAAe;QACzD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAChD,OAAO,GAAG,OAAO,IAAI,IAAI,CAAC;QAC1B,IAAA,0BAAM,EAAC,OAAO,OAAO,KAAK,QAAQ,EAAE,mBAAmB,CAAC,CAAC;QACzD,IAAA,0BAAM,EAAC,OAAO,UAAU,CAAC,aAAa,KAAK,UAAU,EAAE,sDAAsD,CAAC,CAAC;QAC/G,IAAA,0BAAM,EAAC,OAAO,UAAU,CAAC,SAAS,KAAK,UAAU,IAAI,UAAU,CAAC,SAAS,KAAK,QAAQ,CAAC,cAAc,CAAC,CAAC;QAEvG,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC;QACnB,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE1B,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,UAAU,CAAC,aAAa,GAAG;YACvB,GAAG;YACH,QAAQ,EAAE,IAAI,CAAC,YAAY;YAC3B,UAAU;YACV,OAAO;YACP,UAAU,EAAE,CAAC;SACE,CAAC;QAEpB,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC;QAEtD,IAAI,UAAU,CAAC,YAAY,EAAE;YACzB,UAAU,CAAC,YAAY,EAAE,CAAC;SAC7B;QAED,UAAU,CAAC,SAAS,GAAG,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEtD,iDAAiD;QACjD,IAAI,IAAI,CAAC,eAAe,KAAK,CAAC,EAAE;YAC5B,IAAA,0BAAM,EAAC,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC;YAC7B,IAAI,CAAC,YAAY,EAAE,CAAC;SACvB;QACD,IAAA,0BAAM,EAAC,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC;QAC7B,OAAO,GAAG,CAAC;IACf,CAAC;IAEM,gBAAgB,CAAC,UAAuB;QAC3C,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE;YACvB,OAAO,CAAC,sBAAsB;SACjC;QACD,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;SACrC;QAED,IAAA,0BAAM,EAAC,UAAU,CAAC,SAAS,YAAY,QAAQ,CAAC,CAAC;QACjD,IAAA,0BAAM,EAAC,OAAO,UAAU,CAAC,aAAa,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC;QACzD,IAAA,0BAAM,EAAC,OAAO,UAAU,CAAC,SAAS,KAAK,UAAU,CAAC,CAAC;QACnD,IAAA,0BAAM,EAAC,IAAI,CAAC,gBAAgB,CAAC,cAAc,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;QAE3E,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QAC3D,OAAO,UAAU,CAAC,SAAS,CAAC;QAC5B,OAAO,UAAU,CAAC,aAAa,CAAC;QAChC,UAAU,CAAC,SAAS,GAAG,QAAQ,CAAC,cAAc,CAAC;QAE/C,kDAAkD;QAClD,IAAI,IAAI,CAAC,eAAe,KAAK,CAAC,EAAE;YAC5B,IAAI,CAAC,WAAW,EAAE,CAAC;SACtB;IACL,CAAC;IAEM,QAAQ;QACX,IAAA,0BAAM,EAAC,IAAI,CAAC,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,iCAAiC,CAAC,CAAC;IACvH,CAAC;IAEM,oBAAoB;QACvB,OAAO,qBAAqB,EAAE,CAAC;IACnC,CAAC;IAEO,iBAAiB;QACrB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAEhD,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,YAA4B,EAAE,EAAE;YACpG,YAAY,CAAC,UAAU,IAAI,CAAC,CAAC;YAC7B,OAAO,UAAU,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,IAAI,kBAAkB,CAAC,MAAM,EAAE;YAC3B,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;SAC5C;QACD,kBAAkB,CAAC,OAAO,CAAC,CAAC,YAA4B,EAAE,EAAE;YACxD,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YAC/C,YAAY,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC;QAC5C,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,YAAY;QAChB,IAAA,0BAAM,EAAC,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,+BAA+B,CAAC,CAAC;QAC9D,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;IAC5D,CAAC;IAEO,WAAW;QACf,IAAA,0BAAM,EAAC,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,8BAA8B,CAAC,CAAC;QAC7D,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE;YACtB,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC3B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;SACtB;IACL,CAAC;;AAzIL,4BA0IC;AAzIU,uBAAc,GAAG,GAAG,EAAE;IACzB,KAAK;AACT,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,38 @@
+{
+    "name": "node-opcua-utils",
+    "version": "2.51.0",
+    "description": "pure nodejs OPCUA SDK - module -utils",
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "scripts": {
+        "build": "tsc -b",
+        "test": "mocha",
+        "clean": "node -e \"require('rimraf').sync('dist');\""
+    },
+    "dependencies": {
+        "browser-process-hrtime": "^1.0.0",
+        "chalk": "4.1.2",
+        "node-opcua-assert": "2.51.0"
+    },
+    "devDependencies": {
+        "@types/node": "16.7.10",
+        "should": "^13.2.3",
+        "sinon": "^11.1.2"
+    },
+    "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": "75feb111daf7ec65fa0111e4fa5beb8987fd4945"
+}

package/source/buffer_ellipsis.ts

@@ -0,0 +1,13 @@
+/**
+ * @module node-opcua-utils
+ */
+export function buffer_ellipsis(buffer: Buffer, start?: number, end?: number): string {
+    start = start || 0;
+    end = end || buffer.length;
+    if (end - start < 40) {
+        return buffer.slice(start, end).toString("hex");
+    }
+    return buffer.slice(start, start + 10).toString("hex") + " ... " + buffer.slice(end - 10, end).toString("hex");
+}
+
+exports.buffer_ellipsis = buffer_ellipsis;

package/source/compare_buffers.ts

@@ -0,0 +1,23 @@
+/**
+ * @module node-opcua-utils
+ */
+// tslint:disable:no-console
+import * as chalk from "chalk";
+import { buffer_ellipsis } from "./buffer_ellipsis";
+
+export function compare_buffers(buf1: Buffer, buf2: Buffer, max_length?: number): void {
+    max_length = max_length || buf2.length;
+    const block_length = 80;
+    let cursor = 0;
+    while (cursor < max_length) {
+        const slice1 = buf1.slice(cursor, cursor + block_length);
+        const slice2 = buf2.slice(cursor, cursor + block_length);
+        if (slice2.toString("hex") !== slice1.toString("hex")) {
+            console.log("pos = ", cursor);
+            console.log("slice1 :", chalk.yellow(buffer_ellipsis(slice1)));
+            console.log("slice2 :", chalk.blue(buffer_ellipsis(slice2)));
+        }
+        cursor += block_length;
+    }
+    // xx buf1.length.should.equal(max_length);
+}

package/source/get_clock_tick.ts

@@ -0,0 +1,18 @@
+/**
+ * @module node-opcua-utils
+ */
+export let get_clock_tick: () => number;
+require("browser-process-hrtime");
+
+if (process && process.hrtime) {
+    const tickOrigin = process.hrtime()[0];
+    // clock it as a double in millisecond
+    // so we can measure very tiny time intervals
+    get_clock_tick = () => {
+        const hrt = process.hrtime();
+        const r = (hrt[0] - tickOrigin) * 1000.0 + Math.ceil((hrt[1] / 1e6) * 1000) / 1000;
+        return r;
+    };
+} else {
+    get_clock_tick = () => Date.now();
+}

package/source/get_function_parameters_name.ts

@@ -0,0 +1,13 @@
+/**
+ * @module node-opcua-utils
+ */
+const STRIP_COMMENTS = /((\/\/.*$)|(\/\*[\s\S]*?\*\/))/gm;
+const ARGUMENT_NAMES = /([^\s,]+)/g;
+
+// tslint:disable-next-line:ban-types
+export function getFunctionParameterNames(func: Function) {
+    const fnStr = func.toString().replace(STRIP_COMMENTS, "");
+    let result = fnStr.slice(fnStr.indexOf("(") + 1, fnStr.indexOf(")")).match(ARGUMENT_NAMES);
+    if (result === null) { result = []; }
+    return result;
+}

package/source/index.ts

@@ -0,0 +1,46 @@
+/**
+ * @module node-opcua-utils
+ */
+// tslint:disable:no-bitwise
+import { assert } from "node-opcua-assert";
+
+/**
+ * set a flag
+ * @method set_flag
+ */
+export function set_flag(value: number, mask: number | { value: number }): number {
+    if ((mask as any).value) {
+        mask = (mask as any).value;
+    }
+    assert(!mask.hasOwnProperty("value"));
+    assert(mask !== undefined);
+    return value | (mask as number);
+}
+/**
+ * check if a set of bits are set in the values
+ * @method check_flag
+ */
+export function check_flag(value: number, mask: number | { value: number }): boolean {
+    if ((mask as any).value) {
+        mask = (mask as any).value;
+    }
+    assert(!mask.hasOwnProperty("value"));
+    return (value & (mask as number)) === (mask as number);
+}
+
+export function isNullOrUndefined(value: any): boolean {
+    return value === undefined || value === null;
+}
+
+export { buffer_ellipsis } from "./buffer_ellipsis";
+export { capitalizeFirstLetter, lowerFirstLetter } from "./string_utils";
+export { getObjectClassName } from "./object_classname";
+export { get_clock_tick } from "./get_clock_tick";
+export { compare_buffers } from "./compare_buffers";
+export { getFunctionParameterNames } from "./get_function_parameters_name";
+export * from "./watchdog";
+export { setDeprecated } from "./set_deprecated";
+export { replaceBufferWithHexDump } from "./replace_buffer_with_hex_dump";
+export * from "./timestamp";
+export * from "./line_file";
+export * from "./match_uri";

package/source/line_file.ts

@@ -0,0 +1,24 @@
+/**
+ * @module node-opcua-utils
+ */
+
+export class LineFile {
+    private _line: string[];
+
+    constructor() {
+        this._line = [];
+    }
+
+    public write(...arg: string[]): void {
+        let str = "";
+        // tslint:disable:prefer-for-of
+        for (let i = 0; i < arguments.length; i++) {
+            str += arguments[i];
+        }
+        this._line.push(str);
+    }
+
+    public toString(endOfLine: "\n" | "\r" = "\n"): string {
+        return this._line.join(endOfLine);
+    }
+}

package/source/match_uri.ts

@@ -0,0 +1,19 @@
+/**
+ * @module node-opcua-utils
+ */
+/**
+ * returns true if two endpoint matches the same address:
+ *
+ * @see https://www.dnscheck.co/faq
+ * @see https://tools.ietf.org/html/rfc4343 : Domain Name System (DNS) Case Insensitivity Clarification
+ *
+ */
+export function matchUri(endpointUri1: string | null, endpointUri2: string | null) {
+    if (endpointUri1 === null) {
+        return endpointUri2 === null;
+    }
+    if (endpointUri2 === null) {
+        return endpointUri1 === null;
+    }
+    return endpointUri1.toLowerCase() === endpointUri2.toLowerCase();
+}

package/source/object_classname.ts

@@ -0,0 +1,11 @@
+/**
+ * @module node-opcua-utils
+ */
+/**
+ * @method getObjectClassName
+ * @param obj
+ * @return {string}
+ */
+export function getObjectClassName(obj: object): string {
+    return Object.prototype.toString.call(obj).slice(8, -1);
+}

package/source/replace_buffer_with_hex_dump.ts

@@ -0,0 +1,15 @@
+/**
+ * @module node-opcua-utils
+ */
+export function replaceBufferWithHexDump(obj: any): any {
+    for (const p in obj) {
+        if (obj.hasOwnProperty(p)) {
+            if (obj[p] instanceof Buffer) {
+                obj[p] = "<BUFFER>" + obj[p].toString("hex") + "</BUFFER>";
+            } else if (typeof obj[p] === "object") {
+                replaceBufferWithHexDump(obj[p]);
+            }
+        }
+    }
+    return obj;
+}

package/source/set_deprecated.ts

@@ -0,0 +1,28 @@
+/**
+ * @module node-opcua-utils
+ */
+// tslint:disable:ban-types
+import * as chalk from "chalk";
+import { assert } from "node-opcua-assert";
+
+/* istanbul ignore next */
+export function setDeprecated(constructor: Function, methodName: string, helpString: string): void {
+
+    const oldMethod = constructor.prototype[methodName];
+
+    assert(oldMethod instanceof Function,
+      "expecting a valid " + methodName + "method on class " + constructor.constructor.name);
+
+    let counter = 0;
+    constructor.prototype[methodName] = function() {
+        if (counter % 1000 === 0) {
+            // tslint:disable:no-console
+            console.log(chalk.green("Warning !"),
+              chalk.green(chalk.bold(constructor.name + "#" + methodName), " is now deprecated"));
+            console.log("         ", helpString);
+        }
+        counter++;
+        return oldMethod.apply(this, arguments);
+    };
+
+}

package/source/string_utils.ts

@@ -0,0 +1,121 @@
+/**
+ * @module node-opcua-utils
+ */
+// tslint:disable:variable-name
+export function capitalizeFirstLetter(str: string): string {
+    if (str == null) {
+        return str;
+    }
+    return str.substr(0, 1).toUpperCase() + str.substr(1);
+}
+
+const ACode = "A".charCodeAt(0);
+const ZCode = "Z".charCodeAt(0);
+export function isUpperCaseChar(c: string): boolean {
+    const code = c.charCodeAt(0);
+    return code >= ACode && code <= ZCode;
+}
+const aCode = "a".charCodeAt(0);
+const zCode = "z".charCodeAt(0);
+export function isAlpha(c: string): boolean {
+    const code = c.charCodeAt(0);
+    return (code >= ACode && code <= ZCode) || (code >= aCode && code <= zCode);
+}
+
+export function countUpperCaseSlow(str: string): number {
+    return str.split("").reduce((p, c) => p + (isUpperCaseChar(c) ? 1 : 0), 0);
+}
+export function countAlphaSlow(str: string): number {
+    return str.split("").reduce((p, c) => p + (isAlpha(c) ? 1 : 0), 0);
+}
+
+export function countUpperCase(str: string): number {
+    let count = 0;
+    const n = str.length
+    for (let i=0; i < n ; i++) {
+        count += isUpperCaseChar(str[i]) ? 1 : 0;
+    }
+    return count;
+}
+export function countAlpha(str: string): number {
+    let count = 0;
+    const n = str.length
+    for (let i=0; i < n ; i++) {
+        count += isAlpha(str[i]) ? 1 : 0;
+    }
+    return count;
+}
+
+/**
+ *
+ * lowerFirstLetter convert a OPCUA Identifier to a javascript Identifier
+ *
+ * @summary
+ *
+ *  OPCUA and Javascript use two different rules to build identifiers.
+ *
+ *  OPCUA Identifier usually starts with a upper case letter and word are join together, this is known as  
+ *  the Pascal case, or CapitalizedWords convention.  (for instance HelloWorld)
+ *  But sometime, OPCUA indentifiers do not follow this convention strictly and we can find various 
+ *  other convention being applied such as underscore between word, or addintion of ACRONYMED prefixes.
+ *  On it's own, this causes great confusion and inconsistancy in programming style.
+ *
+ *  Javascritpt uses a slightly different convention called camelCase where word are joined together
+ *  and inner words starts with a capital letter whereas first word starts with a lower case letter. 
+ *  (for instance helloWorld)
+ *
+ *  In node-opcua we have taken the opinionated decision to consistently use camelCase convention for
+ *  object properties so that all the code look nice and consistent.
+ *  the lowerFirstLetter method can be used to easily convert from the OPCUA  naming convention 
+ *  to javascript naming convention by applying the following rules.
+ *
+ *   * each ascii sequence in a identifier will be converted to lower camel case.
+ *   * when an identifier only contains upper case letter then it will be untouched. ( i.e CQDF => CQFD)
+ *     (this rules helps to preserve acronyms)
+ *   * when a identifier starts with more than one UpperCase letter but still contain lowercase letter
+ *     then the first Uppercase letter excluding the last one will be converted to lower case
+ *     ( ie:  EURange = > euRange)
+ *   * when a identifier contains several sequences delimited with underscores (_) the above rules
+ *     will be applied to each of the element of the sequence
+ *     ( ie: ALM_FlowOutOfTolerance => ALM_flowOutOfTolerance ( ALM=>ALM , FlowOutOfTolerance=>flowOutOfTolerance)
+ *
+ * @reference
+ *    * https://en.wikipedia.org/wiki/Camel_case
+ *    * https://en.wikipedia.org/wiki/Hungarian_notation
+ *    * http://wiki.c2.com/?UnderscoreVersusCapitalAndLowerCaseVariableNaming
+ *
+ *
+ *
+ * @example
+ *  HelloWorld => helloWorld
+ *  XAxis      => xAxis
+ *  EURange    => euRange
+ *  DATE       => DATE
+ *  XYZ        => XYZ
+ *  AB         => AB
+ *  Ab         => ab
+ *  A          => a
+ *  T1ABC8     => T1ABC8
+ *  F_ABC_D    => F_ABC_D
+ *  ALM_Timeout    => ALM_timeout
+ *  SV_GasOn       => SV_gasOn
+ *  DI_VAL_FlowImp => DI_VAL_flowImp
+ */
+export function lowerFirstLetter(str: string): string {
+    if (str == null) {
+        return str;
+    }
+    // at least, 2 all upper
+    if (str.length >= 2 && countUpperCase(str) === countAlpha(str)) {
+        return str;
+    }
+
+    if (str.match(/\_/)) {
+        return str.split("_").map(lowerFirstLetter).join("_");
+    }
+    let result = str.substr(0, 1).toLowerCase() + str.substr(1);
+    if (result.length > 3 && isUpperCaseChar(str[1]) && isUpperCaseChar(str[2])) {
+        result = str.substr(0, 2).toLowerCase() + str.substr(2);
+    }
+    return result;
+}

package/source/timestamp.ts

@@ -0,0 +1,15 @@
+function w(s: string | number, length: number): string {
+    return ("000" + s).substr(-length);
+}
+
+function t(d: Date): string {
+    return w(d.getUTCHours(), 2) + ":"
+        + w(d.getUTCMinutes(), 2) + ":"
+        + w(d.getUTCSeconds(), 2) + ":"
+        + w(d.getMilliseconds(), 3);
+}
+
+export function timestamp() {
+    return t(new Date());
+}
+