@static-suite/static-suite-data-server 2.0.1 → 2.0.3

package/dist/lib/utils/fs/fsWatchUtils.d.ts

@@ -1,13 +1,8 @@
 /**
  * Watches for changes on a set of paths and attach listener to them
  *
- * @remarks
- * It handles three different events: add, change and unlink
- *
  * @param paths - An array of paths to be watched
- * @param listeners - An object with three optional event keys (add, change and unlink)
- * and a listener function as value. That function will be executed once any of
- * the event keys is dispatched.
+ * @param callback - A callback function to be executed when a file changes
  */
-export declare const watch: (paths: string[], listeners: Record<"add" | "change" | "unlink", (filePath: string) => void>) => void;
+export declare const watch: (paths: string[], callback: (filePath: string) => void) => void;
 //# sourceMappingURL=fsWatchUtils.d.ts.map

package/dist/lib/utils/fs/fsWatchUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fsWatchUtils.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/fs/fsWatchUtils.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,KAAK,GAChB,OAAO,MAAM,EAAE,EACf,WAAW,MAAM,CAAC,KAAK,GAAG,QAAQ,GAAG,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC,KACzE,IAyBF,CAAC"}
+{"version":3,"file":"fsWatchUtils.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/fs/fsWatchUtils.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,eAAO,MAAM,KAAK,GAChB,OAAO,MAAM,EAAE,EACf,UAAU,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,KACnC,IA2BF,CAAC"}

package/dist/lib/utils/fs/fsWatchUtils.js

@@ -4,42 +4,32 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.watch = void 0;
-const chokidar_1 = __importDefault(require("chokidar"));
+const node_fs_1 = __importDefault(require("node:fs"));
 const logger_1 = require("../logger");
+const debounce_1 = require("../misc/debounce");
 /**
  * Watches for changes on a set of paths and attach listener to them
  *
- * @remarks
- * It handles three different events: add, change and unlink
- *
  * @param paths - An array of paths to be watched
- * @param listeners - An object with three optional event keys (add, change and unlink)
- * and a listener function as value. That function will be executed once any of
- * the event keys is dispatched.
+ * @param callback - A callback function to be executed when a file changes
  */
-const watch = (paths, listeners) => {
+const watch = (paths, callback) => {
     if (paths.length > 0) {
-        const watcher = chokidar_1.default.watch(paths, {
-            ignored: /(^|[/\\])\../,
-            persistent: true,
-        });
-        // Add event listeners.
-        watcher.on('ready', () => {
-            logger_1.logger.debug(`Watcher listening for changes on ${paths.join(',')}`);
-            watcher
-                .on('add', filePath => {
-                logger_1.logger.debug(`File ${filePath} added`);
-                listeners.add(filePath);
-            })
-                .on('change', filePath => {
-                logger_1.logger.debug(`File ${filePath} changed`);
-                listeners.change(filePath);
-            })
-                .on('unlink', filePath => {
-                logger_1.logger.debug(`File ${filePath} removed`);
-                listeners.unlink(filePath);
-            });
+        const listener = (eventType, filename) => {
+            if (filename) {
+                logger_1.logger.debug(`File ${filename} ${eventType}`);
+                callback(filename);
+            }
+        };
+        paths.forEach(path => {
+            node_fs_1.default.watch(path, {
+                ignore: /(^|[/\\])\../,
+                recursive: true,
+            }, 
+            // Ensure filenames are absolute
+            (0, debounce_1.debounce)((eventType, filename) => filename ? listener(eventType, `${path}/${filename}`) : null, 300));
         });
+        logger_1.logger.debug(`Watcher listening for changes on ${paths.join(',')}`);
     }
 };
 exports.watch = watch;

package/dist/lib/utils/misc/debounce.d.ts

@@ -0,0 +1,2 @@
+export declare const debounce: <T extends unknown[]>(callback: (...args: T) => void, delay: number) => (...args: T) => void;
+//# sourceMappingURL=debounce.d.ts.map

package/dist/lib/utils/misc/debounce.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debounce.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/misc/debounce.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,OAAO,EAAE,EAC1C,UAAU,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,IAAI,EAC9B,OAAO,MAAM,MAIL,GAAG,MAAM,CAAC,SAOnB,CAAC"}

package/dist/lib/utils/misc/debounce.js

@@ -0,0 +1,22 @@
+"use strict";
+// export const debounce = (func: any, wait = 100) => {
+//   let timeout: ;
+//   return (...args) => {
+//     clearTimeout(timeout);
+//     timeout = setTimeout(() => {
+//       func.apply(this, args);
+//     }, wait);
+//   };
+// };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.debounce = void 0;
+const debounce = (callback, delay) => {
+    let timeoutTimer;
+    return (...args) => {
+        clearTimeout(timeoutTimer);
+        timeoutTimer = setTimeout(() => {
+            callback(...args);
+        }, delay);
+    };
+};
+exports.debounce = debounce;

package/dist/lib/watcher/watcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"watcher.d.ts","sourceRoot":"","sources":["../../../src/lib/watcher/watcher.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,WAAW,QAAO,IAyC9B,CAAC"}
+{"version":3,"file":"watcher.d.ts","sourceRoot":"","sources":["../../../src/lib/watcher/watcher.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,WAAW,QAAO,IAqC9B,CAAC"}

package/dist/lib/watcher/watcher.js

@@ -35,7 +35,7 @@ const initWatcher = () => {
     if (config_1.config.taskDir) {
         paths.push(config_1.config.taskDir);
     }
-    const listener = (filePath) => {
+    const callback = (filePath) => {
         // Remove all modules inside the query directory.
         if (config_1.config.queryDir && filePath.startsWith(config_1.config.queryDir)) {
             query_1.queryManager.reset();
@@ -56,10 +56,6 @@ const initWatcher = () => {
             task_1.taskManager.reset();
         }
     };
-    (0, fsWatchUtils_1.watch)(paths, {
-        add: listener,
-        change: listener,
-        unlink: listener,
-    });
+    (0, fsWatchUtils_1.watch)(paths, callback);
 };
 exports.initWatcher = initWatcher;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@static-suite/static-suite-data-server",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "description": "A flexible, fast and developer friendly Data Server for Static Suite",
   "main": "./dist/lib/index.js",
   "typings": "./dist/lib/index.d.ts",
@@ -12,9 +12,7 @@
   },
   "dependencies": {
     "@creativebulma/bulma-tooltip": "^1.2.0",
-    "@microsoft/api-extractor": "^7.34.4",
     "bulma": "^1.0.4",
-    "chokidar": "4.0.3",
     "clear-module": "^4.1.2",
     "clipboard": "^2.0.11",
     "cors": "^2.8.5",
@@ -26,8 +24,6 @@
     "mime-types": "^3.0.1",
     "pug": "^3.0.3",
     "simple-datatables": "^10.0.0",
-    "tsc-watch": "^7.1.1",
-    "typescript": "^6.0.3",
     "winston": "^3.8.2",
     "yargs": "^18.0.0"
   },
@@ -49,6 +45,7 @@
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
+    "@microsoft/api-extractor": "^7.34.4",
     "@types/cors": "^2.8.13",
     "@types/express": "^5.0.3",
     "@types/jest": "^30.0.0",
@@ -69,7 +66,9 @@
     "jest": "^30.1.3",
     "prettier": "^3.6.2",
     "ts-jest": "^29.4.1",
+    "tsc-watch": "^7.1.1",
     "typedoc": "^0.28.12",
+    "typescript": "^6",
     "typescript-eslint": "^8.43.0"
   },
   "jest": {

package/src/lib/utils/fs/fsWatchUtils.ts

@@ -1,43 +1,41 @@
-import chokidar from 'chokidar';
+import fs from 'node:fs';
 import { logger } from '../logger';
+import { debounce } from '../misc/debounce';
 
 /**
  * Watches for changes on a set of paths and attach listener to them
  *
- * @remarks
- * It handles three different events: add, change and unlink
- *
  * @param paths - An array of paths to be watched
- * @param listeners - An object with three optional event keys (add, change and unlink)
- * and a listener function as value. That function will be executed once any of
- * the event keys is dispatched.
+ * @param callback - A callback function to be executed when a file changes
  */
 export const watch = (
   paths: string[],
-  listeners: Record<'add' | 'change' | 'unlink', (filePath: string) => void>,
+  callback: (filePath: string) => void,
 ): void => {
   if (paths.length > 0) {
-    const watcher = chokidar.watch(paths, {
-      ignored: /(^|[/\\])\../,
-      persistent: true,
-    });
+    const listener = (eventType: string, filename: string): void => {
+      if (filename) {
+        logger.debug(`File ${filename} ${eventType}`);
+        callback(filename);
+      }
+    };
 
-    // Add event listeners.
-    watcher.on('ready', () => {
-      logger.debug(`Watcher listening for changes on ${paths.join(',')}`);
-      watcher
-        .on('add', filePath => {
-          logger.debug(`File ${filePath} added`);
-          listeners.add(filePath);
-        })
-        .on('change', filePath => {
-          logger.debug(`File ${filePath} changed`);
-          listeners.change(filePath);
-        })
-        .on('unlink', filePath => {
-          logger.debug(`File ${filePath} removed`);
-          listeners.unlink(filePath);
-        });
+    paths.forEach(path => {
+      fs.watch(
+        path,
+        {
+          ignore: /(^|[/\\])\../,
+          recursive: true,
+        },
+        // Ensure filenames are absolute
+        debounce(
+          (eventType, filename) =>
+            filename ? listener(eventType, `${path}/${filename}`) : null,
+          300,
+        ),
+      );
     });
+
+    logger.debug(`Watcher listening for changes on ${paths.join(',')}`);
   }
 };

package/src/lib/utils/misc/debounce.ts

@@ -0,0 +1,24 @@
+// export const debounce = (func: any, wait = 100) => {
+//   let timeout: ;
+//   return (...args) => {
+//     clearTimeout(timeout);
+//     timeout = setTimeout(() => {
+//       func.apply(this, args);
+//     }, wait);
+//   };
+// };
+
+export const debounce = <T extends unknown[]>(
+  callback: (...args: T) => void,
+  delay: number,
+) => {
+  let timeoutTimer: ReturnType<typeof setTimeout>;
+
+  return (...args: T) => {
+    clearTimeout(timeoutTimer);
+
+    timeoutTimer = setTimeout(() => {
+      callback(...args);
+    }, delay);
+  };
+};

package/src/lib/watcher/watcher.ts

@@ -34,7 +34,7 @@ export const initWatcher = (): void => {
     paths.push(config.taskDir);
   }
 
-  const listener = (filePath: string) => {
+  const callback = (filePath: string) => {
     // Remove all modules inside the query directory.
     if (config.queryDir && filePath.startsWith(config.queryDir)) {
       queryManager.reset();
@@ -58,9 +58,5 @@ export const initWatcher = (): void => {
     }
   };
 
-  watch(paths, {
-    add: listener,
-    change: listener,
-    unlink: listener,
-  });
+  watch(paths, callback);
 };