@e-mc/watch 0.8.7 → 0.9.0

package/LICENSE

@@ -1,11 +1,11 @@
-Copyright 2024 An Pham
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
+Copyright 2024 An Pham
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,6 +1,6 @@
 # @e-mc/watch
 
-* NodeJS 14
+* NodeJS 14/16
 * ES2020
 
 ## General Usage
@@ -9,12 +9,12 @@
 
 ## Interface
 
-- https://www.unpkg.com/@e-mc/types@0.8.7/lib/index.d.ts
+* [View Source](https://www.unpkg.com/@e-mc/types@0.9.0/lib/index.d.ts)
 
 ```typescript
 import type { IFileManager, ModuleConstructor } from "./index";
 import type { ExternalAsset } from "./asset";
-import type { IClient, IPermission } from "./core";
+import type { HostInitConfig, IClient, IPermission } from "./core";
 import type { FinalizeResult, PostFinalizeCallback } from "./filemanager";
 import type { WatchModule } from "./settings";
 import type { IFileGroup, ModifiedPostFinalizeListener, SecureOptions } from "./watch";
@@ -23,6 +23,7 @@ import type * as ws from "ws";
 
 interface IWatch extends IClient<IFileManager, WatchModule, ModifiedPostFinalizeListener> {
     connectTimeout: number;
+    init(config?: HostInitConfig): this;
     start(assets: ExternalAsset[], permission?: IPermission | null): void;
     modified(watch: IFileGroup<ExternalAsset>): Promise<FinalizeResult | void>;
     configureServer(options: SecureOptions): boolean;
@@ -31,7 +32,7 @@ interface IWatch extends IClient<IFileManager, WatchModule, ModifiedPostFinalize
     setSSLCert(value: string): boolean;
     hasSecureProtocol(): boolean;
     whenModified?(assets: ExternalAsset[], postFinalize: PostFinalizeCallback): IFileManager;
-    whenModified?(assets: ExternalAsset[], sanitize?: boolean | PostFinalizeCallback, postFinalize?: PostFinalizeCallback): IFileManager;
+    whenModified?(assets: ExternalAsset[], sanitize?: boolean, postFinalize?: PostFinalizeCallback): IFileManager;
     set assets(value: ExternalAsset[]);
     get assets(): ExternalAsset[];
     set interval(value);
@@ -50,18 +51,83 @@ interface WatchConstructor extends ModuleConstructor {
     checkTimeout(client: ws): boolean;
     readonly prototype: IWatch;
     new(module?: WatchModule): IWatch;
-    /* @deprecated */
-    new(interval?: number, port?: number, securePort?: number, extensions?: unknown[]): IWatch;
 }
 ```
 
+## Settings
+
+```typescript
+import type { PermittedDirectories } from "./core";
+
+import type { SecureVersion } from "tls";
+
+interface WatchModule {
+    // handler: "@e-mc/watch";
+    extensions?: string[];
+    timeout?: number | string;
+    interval?: number | string;
+    port?: number;
+    secure?: {
+        port?: number;
+        ca?: string;
+        key?: string;
+        cert?: string;
+        passphrase?: string;
+        version?: SecureVersion;
+    };
+    settings?: {
+        broadcast_id?: string | string[];
+        users?: Record<string, Record<string, unknown>>;
+    };
+    permission?: PermittedDirectories;
+}
+```
+
+### Example usage
+
+```javascript
+const Watch = require("@e-mc/watch");
+
+const instance = new Watch({ interval: 100, port: 8080 });
+instance.init();
+
+instance.whenModified = (assets) => {
+    assets.forEach(item => console.log(item.uri));
+};
+
+const assets = [
+    { localUri: "/path/workspace/output/image1.png", uri: "http://hostname/path/document1.png", watch: true },
+    { localUri: "/path/workspace/output/image2.png", uri: "http://hostname/path/document2.png", watch: true }
+];
+
+instance.start(assets, { disk_read: ["/path/workspace/output/**"] });
+```
+
+## NodeJS 14 LTS
+
+Any optional fail safe dependencies were removed as of `E-mc 0.9`. The code itself will still be *ES2020* and will continue to work equivalently when self-installing these dependencies:
+
+### Under 15.4 + 16.0
+
+```sh
+npm i abort-controller event-target-shim
+```
+
+### Under 14.17 + 15.6
+
+```sh
+  npm i uuid
+```
+
 ## References
 
-- https://www.unpkg.com/@e-mc/types@0.8.7/lib/asset.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.7/lib/core.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.7/lib/filemanager.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.7/lib/settings.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.7/lib/watch.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.0/lib/asset.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.0/lib/core.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.0/lib/filemanager.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.0/lib/settings.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.0/lib/watch.d.ts
+
+* https://www.npmjs.com/package/@types/ws
 
 ## LICENSE
 

package/filegroup/index.js

@@ -1,6 +1,5 @@
 "use strict";
 var _a, _b, _c, _d, _e, _f;
-Object.defineProperty(exports, "__esModule", { value: true });
 const util = require("util");
 const ws = require("ws");
 const types_1 = require("@e-mc/types");
@@ -208,9 +207,5 @@ class FileGroup extends core_1.AbortComponent {
 _a = kServer, _b = kStarted, _c = kPaused, _d = kEtag, _e = kLastModified, _f = kSockets;
 FileGroup.CONNECTION_TIMEOUT = 10 * 60000;
 FileGroup.CLIENT_SESSION = new Map();
-exports.default = FileGroup;
 
-if (exports.default) {
-    module.exports = exports.default;
-    module.exports.default = exports.default;
-}
+module.exports = FileGroup;

package/index.d.ts

@@ -1,5 +1,5 @@
-import type { IFileManager, WatchConstructor } from '../types/lib';
-
-declare const Watch: WatchConstructor<IFileManager>;
-
+import type { IFileManager, WatchConstructor } from '../types/lib';
+
+declare const Watch: WatchConstructor<IFileManager>;
+
 export = Watch;

package/index.js

@@ -1,6 +1,5 @@
 "use strict";
 var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-Object.defineProperty(exports, "__esModule", { value: true });
 const path = require("path");
 const fs = require("fs");
 const https = require("https");
@@ -26,6 +25,15 @@ const DISK_MAP = new Map();
 const PORT_MAP = new Map();
 const SECURE_MAP = new Map();
 let STATE_MAP = new WeakSet();
+function isConnectionTimeout(err) {
+    switch (err instanceof Error && err.code) {
+        case 'ETIMEDOUT':
+        case 'ECONNRESET':
+            return true;
+        default:
+            return false;
+    }
+}
 function abortTimeout(group) {
     group.timeout.aborted = true;
     const watcher = group.watcher;
@@ -63,6 +71,23 @@ function closeServer(map) {
 }
 const formatDate = (value) => new Date(value).toLocaleString().replace(/\/20\d+, /, '@').replace(/:\d+ (AM|PM)$/, (...match) => match[1]);
 class Watch extends core_1.Client {
+    constructor() {
+        super(...arguments);
+        this.connectTimeout = Watch.PROCESS_TIMEOUT;
+        this._moduleName = 'watch';
+        this._assets = [];
+        this._extensions = [];
+        this._hostEvents = [];
+        this[_a] = types_1.THRESHOLD.WATCH_INTERVAL;
+        this[_b] = 80;
+        this[_c] = 443;
+        this[_d] = '';
+        this[_e] = '';
+        this[_f] = '';
+        this[_g] = '';
+        this[_h] = undefined;
+        this[_j] = undefined;
+    }
     static createServer(port, secure, active) {
         if (typeof secure === 'boolean') {
             active = secure;
@@ -76,10 +101,10 @@ class Watch extends core_1.Client {
                 }
                 const { ca, passphrase, version, config } = secure;
                 let { key, cert } = secure;
-                if (key && cert && (key = request_1.default.readTLSKey(key, true)) && (cert = request_1.default.readTLSKey(cert, true))) {
+                if (key && cert && (key = request_1.readTLSKey(key, true)) && (cert = request_1.readTLSKey(cert, true))) {
                     const server = https.createServer({
                         ...config,
-                        ca: ca && request_1.default.readCACert(ca, true) || undefined,
+                        ca: ca && request_1.readCACert(ca, true) || undefined,
                         key: passphrase ? [{ pem: key, passphrase }] : key,
                         cert,
                         minVersion: version || config?.minVersion
@@ -114,16 +139,16 @@ class Watch extends core_1.Client {
         }
         wss.on('connection', function (socket) {
             socket.on('message', function () {
-                filegroup_1.default.CLIENT_SESSION.delete(this);
+                filegroup_1.CLIENT_SESSION.delete(this);
             });
             socket.on('close', function () {
-                filegroup_1.default.CLIENT_SESSION.delete(this);
+                filegroup_1.CLIENT_SESSION.delete(this);
             });
-            this.clients.forEach(client => filegroup_1.default.checkTimeout(client));
+            this.clients.forEach(client => filegroup_1.checkTimeout(client));
         });
         wss.on('error', function (err) {
             const data = JSON.stringify({ event: types_1.WATCH_EVENT.ERROR, errors: [err.message] });
-            this.clients.forEach(client => filegroup_1.default.checkTimeout(client) && client.send(data));
+            this.clients.forEach(client => filegroup_1.checkTimeout(client) && client.send(data));
         });
         wss.on('close', function () {
             this.clients.forEach(client => client.terminate());
@@ -135,50 +160,28 @@ class Watch extends core_1.Client {
         closeFileGroup(DISK_MAP);
         closeServer(PORT_MAP);
         closeServer(SECURE_MAP);
-        filegroup_1.default.CLIENT_SESSION.clear();
+        filegroup_1.CLIENT_SESSION.clear();
         STATE_MAP = new WeakSet();
     }
     static checkTimeout(client) {
-        return filegroup_1.default.checkTimeout(client);
+        return filegroup_1.checkTimeout(client);
     }
     static setTimeout(value) {
         if ((value = (0, types_1.parseTime)(value)) > 0) {
-            filegroup_1.default.CONNECTION_TIMEOUT = Math.min(value, core_1.Client.MAX_TIMEOUT);
+            filegroup_1.CONNECTION_TIMEOUT = Math.min(value, core_1.Client.MAX_TIMEOUT);
         }
     }
-    constructor(data, port, securePort, extensions) {
-        super(data);
-        this.connectTimeout = Watch.PROCESS_TIMEOUT;
-        this._moduleName = 'watch';
-        this._assets = [];
-        this._extensions = [];
-        this._hostEvents = [];
-        this[_a] = types_1.THRESHOLD.WATCH_INTERVAL;
-        this[_b] = 80;
-        this[_c] = 443;
-        this[_d] = '';
-        this[_e] = '';
-        this[_f] = '';
-        this[_g] = '';
-        this[_h] = undefined;
-        this[_j] = undefined;
-        let interval;
-        if ((0, types_1.isPlainObject)(data)) {
-            let secure;
-            ({ interval, port, secure, extensions } = data);
-            if (secure) {
-                securePort = secure.port;
-                if (secure.cert && secure.key) {
-                    this.configureServer(secure);
-                }
+    init(config) {
+        const { interval, port, secure } = this.module;
+        if (secure) {
+            this.securePort = (0, util_1.asInt)(secure.port);
+            if (secure.cert && secure.key) {
+                this.configureServer(secure);
             }
         }
         this.interval = (0, util_1.asInt)(interval);
         this.port = (0, util_1.asInt)(port);
-        this.securePort = (0, util_1.asInt)(securePort);
-        if (Array.isArray(extensions)) {
-            this.module.extensions = extensions;
-        }
+        return super.init(config);
     }
     start(assets, permission) {
         var _k;
@@ -191,15 +194,14 @@ class Watch extends core_1.Client {
         const settings = this.getUserSettings();
         const destMap = Object.create(null);
         for (const item of assets) {
-            if ((0, types_1.ignoreFlag)(item.flags)) {
-                continue;
-            }
-            const { bundleId, uri, localUri } = item;
-            if (!(0, types_1.isEmpty)(bundleId)) {
-                (destMap[_k = ':' + bundleId] || (destMap[_k] = [])).push(item);
-            }
-            else if (uri && localUri) {
-                (destMap[localUri] || (destMap[localUri] = [])).push(item);
+            if (!(0, types_1.ignoreFlag)(item.flags)) {
+                const { bundleId, uri, localUri } = item;
+                if (!(0, types_1.isEmpty)(bundleId)) {
+                    (destMap[_k = ':' + bundleId] || (destMap[_k] = [])).push(item);
+                }
+                else if (uri && localUri) {
+                    (destMap[localUri] || (destMap[localUri] = [])).push(item);
+                }
             }
         }
         for (let dest in destMap) {
@@ -227,7 +229,7 @@ class Watch extends core_1.Client {
                         }
                         if ((0, types_1.watchFlag)(other.flags)) {
                             if (!other.watch) {
-                                other = filegroup_1.default.cloneAsset(other);
+                                other = filegroup_1.cloneAsset(other);
                                 other.watch = { ...watch };
                             }
                             other.flags &= ~1;
@@ -328,7 +330,7 @@ class Watch extends core_1.Client {
                 }
                 const interval = getInterval(item) || watchInterval || this.interval;
                 const watching = (uri, esm) => {
-                    const group = new filegroup_1.default(uri, main ? assets : items, startTime, this.willAbort("(watch)"));
+                    const group = new filegroup_1(uri, main ? assets : items, startTime, this.willAbort("(watch)"));
                     group.add(expires, socketId, id);
                     if (main) {
                         group.main = main;
@@ -428,7 +430,7 @@ class Watch extends core_1.Client {
                             return status;
                         }
                         const url = group.url || (group.url = new URL(uri));
-                        const request = this.host?.Request || new request_1.default();
+                        const request = this.host?.Request || new request_1();
                         const agentTimeout = Math.max(timeout.interval * 10, this.connectTimeout);
                         const opts = request.opts(url, { method: 'HEAD', httpVersion: 1, timeout: agentTimeout, agentTimeout });
                         (function recurse() {
@@ -488,19 +490,17 @@ class Watch extends core_1.Client {
                                     }
                                     else {
                                         if (isMap(map)) {
-                                            reject(valid ? (0, types_1.errorValue)('ETag not supported', uri) : (0, types_1.errorMessage)(statusCode, 'Invalid HTTP request', uri));
+                                            reject(valid ? (0, types_1.errorValue)("ETag not supported", uri) : (0, types_1.errorMessage)(statusCode, 'Invalid HTTP request', uri));
                                             return;
                                         }
                                         watchExpired(HTTP_MAP, group);
                                         abortTimeout(target);
                                     }
-                                    if (client) {
-                                        client.destroy();
-                                    }
+                                    client?.destroy();
                                     resolve();
                                 })
                                     .on('error', err => {
-                                    if (!timeout.aborted && !(core_1.Client.isErrorCode(err, 'ETIMEDOUT', 'ECONNRESET') && ++timeout.retries <= 10)) {
+                                    if (!timeout.aborted && !(isConnectionTimeout(err) && ++timeout.retries <= 10)) {
                                         reject(err);
                                         return;
                                     }
@@ -529,7 +529,7 @@ class Watch extends core_1.Client {
                                     }
                                 }
                             })
-                                .catch(err => {
+                                .catch((err) => {
                                 fatalError(HTTP_MAP, target, err);
                                 client?.destroy();
                             });
@@ -548,7 +548,7 @@ class Watch extends core_1.Client {
                             }
                             const map = DISK_MAP.get(uri);
                             switch (event) {
-                                case 'change': {
+                                case 'change':
                                     if (isMap(map)) {
                                         try {
                                             const mtime = Math.floor(fs.statSync(uri).mtimeMs);
@@ -579,11 +579,8 @@ class Watch extends core_1.Client {
                                             this.writeFail(["Unable to read file", path.basename(uri)], err, { type: 32, fatal: false });
                                         }
                                     }
-                                }
                                 case 'rename':
-                                    if (map) {
-                                        map.clear();
-                                    }
+                                    map?.clear();
                                     watchExpired(DISK_MAP, group, event === 'rename' ? 'File renamed: ' + filename : undefined);
                                     abortTimeout(target);
                                     break;
@@ -647,7 +644,7 @@ class Watch extends core_1.Client {
         let items, sanitize = false;
         if (watch.main) {
             sanitize = watch.assets.length > assets.length;
-            items = sanitize ? watch.assets.map(item => filegroup_1.default.cloneAsset(item)) : assets.map(item => (0, types_1.cloneObject)(item, true));
+            items = sanitize ? watch.assets.map(item => filegroup_1.cloneAsset(item)) : assets.map(item => (0, types_1.cloneObject)(item, true));
         }
         else {
             items = [];
@@ -665,9 +662,9 @@ class Watch extends core_1.Client {
                 sanitize = true;
             }
             if (sanitize) {
-                items = watch.assets.map(item => filegroup_1.default.cloneAsset(item));
+                items = watch.assets.map(item => filegroup_1.cloneAsset(item));
             }
-            if (watch.related.length) {
+            if ((0, types_1.isArray)(watch.related)) {
                 items.push(...watch.related);
             }
         }
@@ -692,32 +689,31 @@ class Watch extends core_1.Client {
                 catch {
                 }
             }
-            if (!manager) {
-                return;
-            }
-            if (host && watch.document) {
-                for (const { instance } of host.Document) {
-                    if (host.hasDocument(instance, watch.document)) {
-                        const result = instance.watchInit?.(watch, items, sanitize);
-                        if (result) {
-                            if ((0, types_1.isArray)(result.using)) {
-                                manager.using(...result.using);
-                            }
-                            if (Array.isArray(result.dataSource)) {
-                                const document = manager.find(instance.moduleName);
-                                if (document) {
-                                    document.dataSource = result.dataSource;
+            if (manager) {
+                if (host && watch.document) {
+                    for (const { instance } of host.Document) {
+                        if (host.hasDocument(instance, watch.document)) {
+                            const result = instance.watchInit?.(watch, items, sanitize);
+                            if (result) {
+                                if ((0, types_1.isArray)(result.using)) {
+                                    manager.using(...result.using);
+                                }
+                                if (Array.isArray(result.dataSource)) {
+                                    const document = manager.find(instance.moduleName);
+                                    if (document) {
+                                        document.dataSource = result.dataSource;
+                                    }
                                 }
                             }
-                        }
-                        const listener = instance.watchModified?.(watch, items);
-                        if (typeof listener === 'function') {
-                            manager.on('end', listener);
+                            const listener = instance.watchModified?.(watch, items);
+                            if (typeof listener === 'function') {
+                                manager.on('end', listener);
+                            }
                         }
                     }
                 }
+                return await manager.start();
             }
-            return await manager.start();
         }
         catch (err) {
             this.writeFail(["Unknown", watch.url?.pathname || path.basename(watch.uri)], err);
@@ -730,10 +726,10 @@ class Watch extends core_1.Client {
         if (ca) {
             this.setCA(ca);
         }
-        if (request_1.default.isCert(key) || core_1.Client.isPath(key = path.resolve(key = key.trim())) && this.canRead(key, { ownPermissionOnly: true })) {
+        if (request_1.isCert(key) || core_1.Client.isPath(key = path.resolve(key = key.trim())) && this.canRead(key, { ownPermissionOnly: true })) {
             this[kTlsKey] = key.trim();
         }
-        if (request_1.default.isCert(cert) || core_1.Client.isPath(cert = path.resolve(cert = cert.trim())) && this.canRead(cert, { ownPermissionOnly: true })) {
+        if (request_1.isCert(cert) || core_1.Client.isPath(cert = path.resolve(cert = cert.trim())) && this.canRead(cert, { ownPermissionOnly: true })) {
             this[kTlsCert] = cert.trim();
         }
         if ((0, types_1.isString)(passphrase)) {
@@ -770,10 +766,10 @@ class Watch extends core_1.Client {
     setSSLKey(value) {
         this[kTlsConfig] = { secureProtocol: 'SSLv23_method' };
         this[kTlsVersion] = undefined;
-        return !!(this[kTlsKey] = request_1.default.readTLSKey(value, true));
+        return !!(this[kTlsKey] = request_1.readTLSKey(value, true));
     }
     setSSLCert(value) {
-        return !!(this[kTlsCert] = request_1.default.readTLSCert(value, true));
+        return !!(this[kTlsCert] = request_1.readTLSCert(value, true));
     }
     hasSecureProtocol() {
         return !!this[kTlsKey] && !!this[kTlsCert];
@@ -783,7 +779,7 @@ class Watch extends core_1.Client {
     }
     set host(value) {
         super.host = value;
-        if (value && (0, types_1.isArray)(value.assets)) {
+        if ((0, types_1.isArray)(value?.assets)) {
             this.assets = value.assets;
         }
     }
@@ -828,9 +824,5 @@ class Watch extends core_1.Client {
 }
 _a = kInterval, _b = kPort, _c = kSecurePort, _d = kCa, _e = kTlsKey, _f = kTlsCert, _g = kTlsPassphrase, _h = kTlsVersion, _j = kTlsConfig;
 Watch.PROCESS_TIMEOUT = 5 * 1000;
-exports.default = Watch;
 
-if (exports.default) {
-    module.exports = exports.default;
-    module.exports.default = exports.default;
-}
+module.exports = Watch;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/watch",
-  "version": "0.8.7",
+  "version": "0.9.0",
   "description": "Watch constructor for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -20,10 +20,10 @@
   "license": "BSD 3-Clause",
   "homepage": "https://github.com/anpham6/e-mc#readme",
   "dependencies": {
-    "@e-mc/core": "0.8.7",
-    "@e-mc/request": "0.8.7",
-    "@e-mc/types": "0.8.7",
-    "picomatch": "^3.0.1",
+    "@e-mc/core": "0.9.0",
+    "@e-mc/request": "0.9.0",
+    "@e-mc/types": "0.9.0",
+    "picomatch": "^4.0.2",
     "ws": "^8.16.0"
   }
 }