@e-mc/watch 0.8.5 → 0.8.6

package/LICENSE

@@ -1,7 +1,11 @@
-Copyright 2024 Mile Square Park
+Copyright 2024 An Pham
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+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,7 +1,68 @@
 # @e-mc/watch
 
-PEP 402
+* NodeJS 14
+* ES2020
+
+## General Usage
+
+* [Read the Docs](https://e-mc.readthedocs.io)
+
+## Interface
+
+- https://www.unpkg.com/@e-mc/types@0.8.6/lib/index.d.ts
+
+```typescript
+import type { IFileManager, ModuleConstructor } from "./index";
+import type { ExternalAsset } from "./asset";
+import type { IClient, IPermission } from "./core";
+import type { FinalizeResult, PostFinalizeCallback } from "./filemanager";
+import type { WatchModule } from "./settings";
+import type { IFileGroup, ModifiedPostFinalizeListener, SecureOptions } from "./watch";
+
+import type * as ws from "ws";
+
+interface IWatch extends IClient<IFileManager, WatchModule, ModifiedPostFinalizeListener> {
+    connectTimeout: number;
+    start(assets: ExternalAsset[], permission?: IPermission | null): void;
+    modified(watch: IFileGroup<ExternalAsset>): Promise<FinalizeResult | void>;
+    configureServer(options: SecureOptions): boolean;
+    setCA(value: string): boolean;
+    setSSLKey(value: string): boolean;
+    setSSLCert(value: string): boolean;
+    hasSecureProtocol(): boolean;
+    whenModified?(assets: ExternalAsset[], postFinalize: PostFinalizeCallback): IFileManager;
+    whenModified?(assets: ExternalAsset[], sanitize?: boolean | PostFinalizeCallback, postFinalize?: PostFinalizeCallback): IFileManager;
+    set assets(value: ExternalAsset[]);
+    get assets(): ExternalAsset[];
+    set interval(value);
+    get interval(): number;
+    set port(value);
+    get port(): number;
+    set securePort(value);
+    get securePort(): number;
+}
+
+interface WatchConstructor extends ModuleConstructor {
+    createServer(port: number, active: boolean): ws.Server | null;
+    createServer(port: number, secure?: SecureOptions | null, active?: boolean): ws.Server | null;
+    shutdown(): void;
+    setTimeout(value: number | string): void;
+    checkTimeout(client: ws): boolean;
+    readonly prototype: IWatch;
+    new(module?: WatchModule): IWatch;
+    /* @deprecated */
+    new(interval?: number, port?: number, securePort?: number, extensions?: unknown[]): IWatch;
+}
+```
+
+## References
+
+- https://www.unpkg.com/@e-mc/types@0.8.6/lib/asset.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.6/lib/core.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.6/lib/filemanager.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.6/lib/settings.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.6/lib/watch.d.ts
 
 ## LICENSE
 
-MIT
+BSD 3-Clause

package/filegroup/index.js

@@ -3,8 +3,8 @@ 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("../../types");
-const core_1 = require("../../core");
+const types_1 = require("@e-mc/types");
+const core_1 = require("@e-mc/core");
 const kServer = Symbol('server');
 const kStarted = Symbol('started');
 const kPaused = Symbol('paused');
@@ -151,7 +151,7 @@ class FileGroup extends core_1.AbortComponent {
     set related(value) {
         this._related = value.map(item => {
             item = FileGroup.cloneAsset(item);
-            item.flags = 1 /* ASSET_FLAG.IGNORE */;
+            item.flags = 1;
             return item;
         });
     }
@@ -206,7 +206,7 @@ class FileGroup extends core_1.AbortComponent {
     }
 }
 _a = kServer, _b = kStarted, _c = kPaused, _d = kEtag, _e = kLastModified, _f = kSockets;
-FileGroup.CONNECTION_TIMEOUT = 10 * 60000 /* TIME.m */;
+FileGroup.CONNECTION_TIMEOUT = 10 * 60000;
 FileGroup.CLIENT_SESSION = new Map();
 exports.default = FileGroup;
 

package/index.js

@@ -6,11 +6,11 @@ const fs = require("fs");
 const https = require("https");
 const ws = require("ws");
 const pm = require("picomatch");
-const util_1 = require("../request/util");
-const types_1 = require("../types");
-const core_1 = require("../core");
-const request_1 = require("../request");
-const filegroup_1 = require("./filegroup");
+const util_1 = require("@e-mc/request/util");
+const types_1 = require("@e-mc/types");
+const core_1 = require("@e-mc/core");
+const request_1 = require("@e-mc/request");
+const filegroup_1 = require("@e-mc/watch/filegroup");
 const kInterval = Symbol('interval');
 const kPort = Symbol('port');
 const kSecurePort = Symbol('securePort');
@@ -116,7 +116,7 @@ class Watch extends core_1.Client {
             }
         }
         catch (err) {
-            this.writeFail("Unknown" /* ERR_MESSAGE.UNKNOWN */, err);
+            this.writeFail("Unknown", err);
         }
         if (!wss) {
             return null;
@@ -163,8 +163,8 @@ class Watch extends core_1.Client {
         this._extensions = [];
         this._hostEvents = [];
         this[_a] = types_1.THRESHOLD.WATCH_INTERVAL;
-        this[_b] = 80 /* HTTP.PORT */;
-        this[_c] = 443 /* HTTP.PORT_SECURE */;
+        this[_b] = 80;
+        this[_c] = 443;
         this[_d] = '';
         this[_e] = '';
         this[_f] = '';
@@ -239,7 +239,7 @@ class Watch extends core_1.Client {
                                 other = filegroup_1.default.cloneAsset(other);
                                 other.watch = { ...watch };
                             }
-                            other.flags &= ~1 /* ASSET_FLAG.IGNORE */;
+                            other.flags &= ~1;
                             other.invalid = undefined;
                             items.push(other);
                         }
@@ -258,10 +258,10 @@ class Watch extends core_1.Client {
                     const uri = target.value.uri;
                     map.delete(uri);
                     abortTimeout(target);
-                    this.writeFail(["Unable to watch file" /* ERR_MESSAGE.WATCH_FILE */, uri], err, 16 /* LOG_TYPE.WATCH */);
+                    this.writeFail(["Unable to watch file", uri], err, 16);
                 };
                 const watchExpired = (map, target, message = 'Expired') => {
-                    this.formatMessage(16 /* LOG_TYPE.WATCH */, 'WATCH', [message, target.startTime ? 'since ' + formatDate(target.startTime) : ''], target.uri, { titleColor: 'grey' });
+                    this.formatMessage(16, 'WATCH', [message, target.startTime ? 'since ' + formatDate(target.startTime) : ''], target.uri, { titleColor: 'grey' });
                     const data = map.get(target.uri);
                     if (!data?.size) {
                         map.delete(target.uri);
@@ -325,7 +325,7 @@ class Watch extends core_1.Client {
                             wss = Watch.createServer(port || (port = this.port));
                         }
                         if (!wss) {
-                            this.writeFail('Unable to create WebSocket server', (0, types_1.errorMessage)(secure ? 'wss' : 'ws', "Invalid parameters" /* ERR_MESSAGE.PARAMETERS */, 'port: ' + (port || "Unknown" /* ERR_MESSAGE.UNKNOWN */)), 16 /* LOG_TYPE.WATCH */);
+                            this.writeFail('Unable to create WebSocket server', (0, types_1.errorMessage)(secure ? 'wss' : 'ws', "Invalid parameters", 'port: ' + (port || "Unknown")), 16);
                             socketId = undefined;
                             port = undefined;
                             secure = undefined;
@@ -337,7 +337,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)" /* ABORT_NAME.WATCH */));
+                    const group = new filegroup_1.default(uri, main ? assets : items, startTime, this.willAbort("(watch)"));
                     group.add(expires, socketId, id);
                     if (main) {
                         group.main = main;
@@ -410,7 +410,7 @@ class Watch extends core_1.Client {
                                             wss.close();
                                         }
                                         message = 'Destination already watched @ ' + (current.secure ? 'wss' : 'ws') + '://hostname:' + current.port;
-                                        return 3 /* ERR.SERVER */;
+                                        return 3;
                                     }
                                 }
                                 const socket = socketId && current.find(socketId);
@@ -420,18 +420,18 @@ class Watch extends core_1.Client {
                                 else {
                                     current.add(expires, socketId, id);
                                 }
-                                return 0 /* ERR.NONE */;
+                                return 0;
                             }
                         }
                         data.set(dest, target);
-                        return 0 /* ERR.NONE */;
+                        return 0;
                     };
                     if (core_1.Client.isFile(uri, 'http/s')) {
                         group.url = item.url;
                         group.etag = item.etag;
                         group.lastModified = item.lastModified;
                         if (!group.etag && !group.lastModified) {
-                            return 1 /* ERR.ETAG */;
+                            return 1;
                         }
                         if ((status = checkPreceding(HTTP_MAP)) !== undefined) {
                             return status;
@@ -453,7 +453,7 @@ class Watch extends core_1.Client {
                                         return;
                                     }
                                     const statusCode = res.statusCode;
-                                    const valid = statusCode >= 200 /* HTTP_STATUS.OK */ && statusCode < 300 /* HTTP_STATUS.MULTIPLE_CHOICES */;
+                                    const valid = statusCode >= 200 && statusCode < 300;
                                     const map = HTTP_MAP.get(uri);
                                     const etag = res.headers.etag;
                                     const lastModified = res.headers['last-modified'];
@@ -509,15 +509,15 @@ class Watch extends core_1.Client {
                                     resolve();
                                 })
                                     .on('error', err => {
-                                    if (!timeout.aborted && !(isConnectionTimeout(err) && ++timeout.retries <= 10 /* HTTP.TIMEOUT_LIMIT */)) {
+                                    if (!timeout.aborted && !(isConnectionTimeout(err) && ++timeout.retries <= 10)) {
                                         reject(err);
                                         return;
                                     }
                                     resolve();
                                 })
                                     .on('timeout', () => {
-                                    if (!timeout.aborted && ++timeout.retries > 10 /* HTTP.TIMEOUT_LIMIT */) {
-                                        reject((0, types_1.errorMessage)(408 /* HTTP_STATUS.REQUEST_TIMEOUT */, 'HTTP request timeout'));
+                                    if (!timeout.aborted && ++timeout.retries > 10) {
+                                        reject((0, types_1.errorMessage)(408, 'HTTP request timeout'));
                                         return;
                                     }
                                     resolve();
@@ -585,7 +585,7 @@ class Watch extends core_1.Client {
                                             break;
                                         }
                                         catch (err) {
-                                            this.writeFail(["Unable to read file" /* ERR_MESSAGE.READ_FILE */, path.basename(uri)], err, { type: 32 /* LOG_TYPE.FILE */, fatal: false });
+                                            this.writeFail(["Unable to read file", path.basename(uri)], err, { type: 32, fatal: false });
                                         }
                                     }
                                 }
@@ -601,9 +601,9 @@ class Watch extends core_1.Client {
                         DISK_MAP.set(uri, new Map([[dest, target]]));
                     }
                     else {
-                        return 2 /* ERR.LOCAL_ACCESS */;
+                        return 2;
                     }
-                    return 0 /* ERR.NONE */;
+                    return 0;
                 };
                 if ((0, types_1.isArray)(sourceFiles) && sourceFiles.some(file => this.canRead(file, { hostPermissionOnly: !!this.host }))) {
                     let index = 0;
@@ -625,33 +625,33 @@ class Watch extends core_1.Client {
                 if (status > 0) {
                     if (!message) {
                         switch (status) {
-                            case 1 /* ERR.ETAG */:
+                            case 1:
                                 if ((0, types_1.existsFlag)(item.flags)) {
                                     continue;
                                 }
                                 message = 'ETag unavailable';
                                 break;
-                            case 2 /* ERR.LOCAL_ACCESS */:
+                            case 2:
                                 message = 'No read permission';
                                 break;
-                            case 3 /* ERR.SERVER */:
+                            case 3:
                                 message = 'Server already in use';
                                 break;
                             default:
-                                message = "Unknown" /* ERR_MESSAGE.UNKNOWN */;
+                                message = "Unknown";
                                 break;
                         }
                     }
-                    this.formatFail((16 /* LOG_TYPE.WATCH */ | (status === 2 /* ERR.LOCAL_ACCESS */ ? 8192 /* LOG_TYPE.PERMISSION */ : 0)), 'WATCH', ["Unable to watch file" /* ERR_MESSAGE.WATCH_FILE */, watched && path.basename(watched)], (0, types_1.errorValue)(message, watched));
+                    this.formatFail((16 | (status === 2 ? 8192 : 0)), 'WATCH', ["Unable to watch file", watched && path.basename(watched)], (0, types_1.errorValue)(message, watched));
                 }
                 else {
-                    this.formatMessage(16 /* LOG_TYPE.WATCH */, 'WATCH', ['Start', interval + 'ms ' + (expires ? formatDate(expires) : 'never')], watched, { titleColor: 'blue' });
+                    this.formatMessage(16, 'WATCH', ['Start', interval + 'ms ' + (expires ? formatDate(expires) : 'never')], watched, { titleColor: 'blue' });
                 }
             }
         }
     }
     async modified(watch) {
-        this.formatMessage(16 /* LOG_TYPE.WATCH */, 'WATCH', 'File modified', watch.uri, { ...core_1.Client.LOG_STYLE_WARN });
+        this.formatMessage(16, 'WATCH', 'File modified', watch.uri, { ...core_1.Client.LOG_STYLE_WARN });
         const { host, assets } = this;
         let items, sanitize = false;
         if (watch.main) {
@@ -681,7 +681,7 @@ class Watch extends core_1.Client {
             }
         }
         if (!sanitize) {
-            items.forEach(item => item.flags |= 2 /* ASSET_FLAG.CLONE */);
+            items.forEach(item => item.flags |= 2);
         }
         watch.captured = false;
         try {
@@ -729,7 +729,7 @@ class Watch extends core_1.Client {
             return await manager.start();
         }
         catch (err) {
-            this.writeFail(["Unknown" /* ERR_MESSAGE.UNKNOWN */, watch.url?.pathname || path.basename(watch.uri)], err);
+            this.writeFail(["Unknown", watch.url?.pathname || path.basename(watch.uri)], err);
         }
     }
     configureServer({ ca, key, cert, passphrase, version, config }) {
@@ -788,7 +788,7 @@ class Watch extends core_1.Client {
         return !!this[kTlsKey] && !!this[kTlsCert];
     }
     willAbort(value) {
-        return this.host ? this.host.willAbort(value) : value === "(watch)" /* ABORT_NAME.WATCH */;
+        return this.host ? this.host.willAbort(value) : value === "(watch)";
     }
     set host(value) {
         super.host = value;
@@ -836,7 +836,7 @@ 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 /* TIME.S */;
+Watch.PROCESS_TIMEOUT = 5 * 1000;
 exports.default = Watch;
 
 if (exports.default) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/watch",
-  "version": "0.8.5",
+  "version": "0.8.6",
   "description": "Watch constructor for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -17,12 +17,12 @@
     "squared-functions"
   ],
   "author": "An Pham <anpham6@gmail.com>",
-  "license": "MIT",
+  "license": "BSD 3-Clause",
   "homepage": "https://github.com/anpham6/e-mc#readme",
   "dependencies": {
-    "@e-mc/core": "0.8.5",
-    "@e-mc/request": "0.8.5",
-    "@e-mc/types": "0.8.5",
+    "@e-mc/core": "0.8.6",
+    "@e-mc/request": "0.8.6",
+    "@e-mc/types": "0.8.6",
     "picomatch": "^3.0.1",
     "ws": "^8.16.0"
   }