@e-mc/watch 0.10.1 → 0.10.3

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,119 +1,119 @@
-# @e-mc/watch
-
-* NodeJS 16
-* ES2020
-
-## General Usage
-
-* [Read the Docs](https://e-mc.readthedocs.io)
-
-## Interface
-
-* [View Source](https://www.unpkg.com/@e-mc/types@0.10.1/lib/index.d.ts)
-
-```typescript
-import type { IFileManager, ModuleConstructor } from "./index";
-import type { ExternalAsset } from "./asset";
-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";
-
-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;
-    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, 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;
-}
-```
-
-## 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;
-        ciphers?: 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/**"] });
-```
-
-## References
-
-- https://www.unpkg.com/@e-mc/types@0.10.1/lib/asset.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.1/lib/core.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.1/lib/filemanager.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.1/lib/settings.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.1/lib/watch.d.ts
-
-* https://www.npmjs.com/package/@types/ws
-
-## LICENSE
-
+# @e-mc/watch
+
+* NodeJS 16
+* ES2020
+
+## General Usage
+
+* [Read the Docs](https://e-mc.readthedocs.io)
+
+## Interface
+
+* [View Source](https://www.unpkg.com/@e-mc/types@0.10.3/lib/index.d.ts)
+
+```typescript
+import type { IFileManager, ModuleConstructor } from "./index";
+import type { ExternalAsset } from "./asset";
+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";
+
+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;
+    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, 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;
+}
+```
+
+## 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;
+        ciphers?: 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/**"] });
+```
+
+## References
+
+- https://www.unpkg.com/@e-mc/types@0.10.3/lib/asset.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.3/lib/core.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.3/lib/filemanager.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.3/lib/settings.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.3/lib/watch.d.ts
+
+* https://www.npmjs.com/package/@types/ws
+
+## LICENSE
+
 BSD 3-Clause

package/filegroup/index.d.ts

@@ -1,5 +1,5 @@
-import type { FileGroupConstructor } from '../../types/lib/watch';
-
-declare const FileGroup: FileGroupConstructor;
-
+import type { FileGroupConstructor } from '@e-mc/types/lib/watch';
+
+declare const FileGroup: FileGroupConstructor;
+
 export = FileGroup;

package/filegroup/index.js

@@ -2,8 +2,8 @@
 var _a, _b, _c, _d, _e, _f;
 const util = require("util");
 const ws = require("ws");
-const core_1 = require("@e-mc/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');
@@ -98,7 +98,7 @@ class FileGroup extends core_1.AbortComponent {
         let result = false;
         if (server && (data.socketId = this.socketId)) {
             data.event = event;
-            data.always ?? (data.always = this.always);
+            data.always ??= this.always;
             const value = data.value;
             if (value && (util.types.isAnyArrayBuffer(value) || util.types.isArrayBufferView(value))) {
                 try {
@@ -142,7 +142,7 @@ class FileGroup extends core_1.AbortComponent {
         return this[kStartTime];
     }
     get started() {
-        return this[kStarted] || (this[kStarted] = Date.now() >= this.startTime);
+        return this[kStarted] ||= Date.now() >= this.startTime;
     }
     get assets() {
         return this[kAssets];

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 '@e-mc/types/lib';
+
+declare const Watch: WatchConstructor<IFileManager>;
+
 export = Watch;

package/index.js

@@ -5,10 +5,10 @@ const fs = require("fs");
 const https = require("https");
 const ws = require("ws");
 const pm = require("picomatch");
-const core_1 = require("@e-mc/core");
-const request_1 = require("@e-mc/request");
 const types_1 = require("@e-mc/types");
+const core_1 = require("@e-mc/core");
 const util_1 = require("@e-mc/request/util");
+const request_1 = require("@e-mc/request");
 const filegroup_1 = require("@e-mc/watch/filegroup");
 const kInterval = Symbol('interval');
 const kPort = Symbol('port');
@@ -225,7 +225,6 @@ class Watch extends core_1.Client {
         return super.init(config);
     }
     start(assets, permission) {
-        var _l;
         if (this.aborted) {
             return;
         }
@@ -238,10 +237,10 @@ class Watch extends core_1.Client {
             if (!(0, types_1.ignoreFlag)(item.flags)) {
                 const { bundleId, uri, localUri } = item;
                 if (!(0, types_1.isEmpty)(bundleId)) {
-                    (destMap[_l = ':' + bundleId] || (destMap[_l] = [])).push(item);
+                    (destMap[':' + bundleId] ||= []).push(item);
                 }
                 else if (uri && localUri) {
-                    (destMap[localUri] || (destMap[localUri] = [])).push(item);
+                    (destMap[localUri] ||= []).push(item);
                 }
             }
         }
@@ -336,12 +335,12 @@ class Watch extends core_1.Client {
                             const key = this[kTlsKey];
                             const cert = this[kTlsCert];
                             if (key && cert) {
-                                wss = Watch.createServer(port || (port = this.securePort), { ca: this[kCa], key, cert, passphrase: this[kTlsPassphrase], version: this[kTlsVersion], ciphers: this[kCiphers], config: this[kTlsConfig] });
+                                wss = Watch.createServer(port ||= this.securePort, { ca: this[kCa], key, cert, passphrase: this[kTlsPassphrase], version: this[kTlsVersion], ciphers: this[kCiphers], config: this[kTlsConfig] });
                             }
                             secure = true;
                         }
                         else {
-                            wss = Watch.createServer(port || (port = this.port));
+                            wss = Watch.createServer(port ||= this.port);
                         }
                         if (!wss) {
                             this.writeFail("Unable to create WebSocket server", (0, types_1.errorMessage)(secure ? 'wss' : 'ws', "Invalid parameters", 'port: ' + (port || "Unknown")), 16);
@@ -453,7 +452,7 @@ class Watch extends core_1.Client {
                         if ((status = checkPreceding(HTTP_MAP)) !== undefined) {
                             return status;
                         }
-                        const url = group.url || (group.url = new URL(uri));
+                        const url = group.url ||= new URL(uri);
                         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 });
@@ -643,7 +642,7 @@ class Watch extends core_1.Client {
                 if (status === 0) {
                     this.formatMessage(16, 'WATCH', ['Start', interval + 'ms ' + (expires ? formatDate(expires) : 'never')], watched, { titleColor: 'blue' });
                 }
-                else if (message || (message = getErrorMessage(item, status))) {
+                else if (message ||= getErrorMessage(item, status)) {
                     this.formatFail((16 | (status === 2 ? 8192 : 0)), 'WATCH', ["Unable to watch file", watched && path.basename(watched)], (0, types_1.errorValue)(message, watched));
                 }
             }
@@ -754,7 +753,7 @@ class Watch extends core_1.Client {
         if (!(0, types_1.isPlainObject)(config)) {
             config = undefined;
         }
-        else if (version || (version = config.minVersion)) {
+        else if (version ||= config.minVersion) {
             delete config.minVersion;
             delete config.secureProtocol;
         }

package/package.json

@@ -1,29 +1,29 @@
-{
-  "name": "@e-mc/watch",
-  "version": "0.10.1",
-  "description": "Watch constructor for E-mc.",
-  "main": "index.js",
-  "types": "index.d.ts",
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/anpham6/e-mc.git",
-    "directory": "src/watch"
-  },
-  "keywords": [
-    "squared",
-    "squared-functions"
-  ],
-  "author": "An Pham <anpham6@gmail.com>",
-  "license": "BSD 3-Clause",
-  "homepage": "https://github.com/anpham6/e-mc#readme",
-  "dependencies": {
-    "@e-mc/core": "0.10.1",
-    "@e-mc/request": "0.10.1",
-    "@e-mc/types": "0.10.1",
-    "picomatch": "^4.0.2",
-    "ws": "^8.18.0"
-  }
-}
+{
+  "name": "@e-mc/watch",
+  "version": "0.10.3",
+  "description": "Watch constructor for E-mc.",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anpham6/e-mc.git",
+    "directory": "src/watch"
+  },
+  "keywords": [
+    "squared",
+    "squared-functions"
+  ],
+  "author": "An Pham <anpham6@gmail.com>",
+  "license": "BSD-3-Clause",
+  "homepage": "https://github.com/anpham6/e-mc#readme",
+  "dependencies": {
+    "@e-mc/core": "0.10.3",
+    "@e-mc/request": "0.10.3",
+    "@e-mc/types": "0.10.3",
+    "picomatch": "^4.0.2",
+    "ws": "^8.18.0"
+  }
+}