@trap_stevo/filetide 0.0.33 → 0.0.35

package/LICENSE.md

@@ -0,0 +1,36 @@
+# License Agreement for @trap_stevo/filetide
+
+**Effective Date**: September 10, 2024
+
+This License Agreement ("Agreement") is entered into by and between **Hassan Steven Compton**, the owner of the package ("Licensor"), and any individual or entity attempting to use the package ("Licensee"). By attempting to install, use, modify, or distribute the package, Licensee agrees to the following terms and conditions:
+
+## 1. **Ownership**
+**Hassan Steven Compton** is the sole owner of all rights, title, and interest in and to @trap_stevo/filetide, including all related intellectual property rights.
+
+## 2. **Grant of License**
+Licensee is **NOT** granted any rights to use, modify, distribute, or create derivative works of @trap_stevo/filetide, either in part or in whole, without prior express written consent from the Licensor. **Any granted license is non-transferable and non-sublicensable without express written consent from the Licensor.**
+
+## 3. **Prohibited Uses**
+Without the express written permission of the Licensor, Licensee shall not:
+- Use the package for any purpose, including but not limited to personal, commercial, or educational purposes.
+- Copy, modify, distribute, or sublicense the package.
+- Reverse-engineer, decompile, or disassemble the package.
+- Create derivative works or adapt the package in any form.
+
+## 4. **Request for Permission**
+Licensee may request permission to use the package by contacting the Licensor at **h.steven.compton13@gmail.com**. All requests must be made in writing, specifying the intended use of the package. Licensor reserves the right to approve, deny, or revoke any permission at its sole discretion. Any granted permission is subject to the Licensor’s terms and may be revoked at any time.
+
+## 5. **Violation of Terms**
+Any unauthorized use of @trap_stevo/filetide will result in immediate termination of any rights granted under this Agreement. The Licensor reserves the right to pursue legal action, including seeking damages and injunctive relief, for any violations of these terms.
+
+## 6. **No Warranty**
+@trap_stevo/filetide is provided "as is," without any warranty of any kind, express or implied, including but not limited to warranties of merchantability, fitness for a particular purpose, or non-infringement. Licensee assumes all risks associated with the use of the package, including but not limited to potential damage to systems or data.
+
+## 7. **Indemnification**
+Licensee agrees to indemnify and hold harmless the Licensor from any and all claims, damages, liabilities, and expenses arising out of Licensee's use of the package in violation of this Agreement.
+
+## 8. **Governing Law and Dispute Resolution**
+This Agreement shall be governed by and construed in accordance with the laws of **the state of Georgia**, without regard to its conflict of law principles. Any disputes arising out of this Agreement shall be resolved through arbitration in **the state of Georgia**.
+
+## 9. **Amendments**
+Licensor reserves the right to modify or update this Agreement at any time. Any changes to the Agreement will be effective **30 days** after being posted to **https://www.npmjs.com/package/@trap_stevo/filetide**. The Licensor will notify Licensees of any material changes by **posting a notice in the package’s release notes on NPM**. Continued use of the package after the notice period constitutes acceptance of the modified terms.

package/dist/cjs/FileMessager.js

@@ -41,6 +41,8 @@ class FileMessager {
   start() {
     this.fileNet.on("get-client-transfer-barrier-response", this.handleClientTransferBarrierResponse.bind(this));
     this.fileNet.on("notify-transfer-barrier", this.handleNotifyTransferBarrier.bind(this));
+    this.fileNet.on("send-file-list-to-client", this.handleSendFileListToClient.bind(this));
+    this.fileNet.on("list-client-files", this.handleListClientFiles.bind(this));
     this.fileNet.on("transfer-start", this.handleFileTransferStart.bind(this));
     this.fileNet.on("transfer-progress", this.handleFileTransferProgress.bind(this));
     this.fileNet.on("transfer-complete", this.handleFileTransferComplete.bind(this));
@@ -125,6 +127,41 @@ class FileMessager {
     } = transferData;
     this.requestFromClient(requesterID, senderID, filePath, destinationPath);
   }
+  handleSendFileListToClient(listData) {
+    const {
+      listedFiles,
+      recipientID,
+      senderID
+    } = listData;
+    const recipientConnectionID = FileNetClientManager.getOnlineClient(recipientID).id;
+    const senderConnectionID = FileNetClientManager.getOnlineClient(senderID).id;
+    const senderClient = this.getClientFromID(senderConnectionID);
+    const client = this.getClientFromID(recipientConnectionID);
+    if (!client || !senderClient) {
+      return;
+    }
+    this.fileNet.emitToTide(client.tideID, "client-file-list", {
+      senderID,
+      listedFiles
+    });
+  }
+  handleListClientFiles(clientData) {
+    const {
+      requesterID,
+      recipientID
+    } = clientData;
+    const recipientConnectionID = FileNetClientManager.getOnlineClient(recipientID).id;
+    const senderConnectionID = FileNetClientManager.getOnlineClient(requesterID).id;
+    const senderClient = this.getClientFromID(senderConnectionID);
+    const client = this.getClientFromID(recipientConnectionID);
+    if (!client || !senderClient) {
+      return;
+    }
+    this.fileNet.emitToTide(client.tideID, "list-files", {
+      senderID: requesterID,
+      recipientID
+    });
+  }
   handleClientToClientTransfer(transferData) {
     const {
       senderID,

package/dist/cjs/FileMessagerClient.js

@@ -53,7 +53,7 @@ class FileMessagerClient {
       });
     });
   }
-  async requestTransfer(clientID, senderID, filePath, destinationPath) {
+  async requestTransfer(clientID, senderID, filePath, destinationPath, filterContent = []) {
     const transferAllowed = await this.allowedTransfer(clientID, senderID, destinationPath, "N/A", "requestSend");
     if (!transferAllowed) {
       return;
@@ -62,10 +62,19 @@ class FileMessagerClient {
       requesterID: clientID,
       senderID,
       destinationPath,
+      filterContent,
       filePath
     });
     return;
   }
+  listFiles(clientID, recipientID, depth = 1) {
+    this.clientTide.emitEvent(clientID, "list-client-files", {
+      requesterID: clientID,
+      recipientID,
+      depth
+    });
+    return;
+  }
   async allowedTransfer(clientID, recipientID, filePath, fileSize, transferType = "send") {
     try {
       const currentDate = Date.now();

package/dist/cjs/FileTide.js

@@ -66,10 +66,14 @@ class FileTide {
    * @param {String} roomName - The name of the room to join
    * @param {String} userID - The ID of the client user
    * @param {Function} onLaunch - Callback for when a file messager launches
+   * @param {Function} onIncomingFile - Callback for incoming files in transit
    * @param {Function} onIncomingTransfer - Callback for incoming transfers
    * @param {Function} onTransferBarrier - Callback for when an incoming transfer status updates
+   * @param {Function} onTransferProgress - Callback for when an current transfers progress
+   * @param {Boolean} [enableTransferBarrier=true] - Whether to enable the transfer barrier
+   * @param {Object} [options = {}] - Additional options
    */
-  launchMessager(clientOptions = {}, connectionOptions = {}, roomName, userID, onLaunch, onIncomingFile, onIncomingTransfer, onTransferBarrier, enableTransferBarrier = true) {
+  launchMessager(clientOptions = {}, connectionOptions = {}, roomName, userID, onLaunch, onIncomingFile, onIncomingTransfer, onTransferBarrier, onTransferProgress, enableTransferBarrier = true, options = {}) {
     if (this.clients.has(userID)) {
       this.stopMessager(userID);
     }
@@ -79,7 +83,7 @@ class FileTide {
     this.clientShorePolicies.set(userID, [FileUtilityManager.getTidePath(">CurrentUser"), FileUtilityManager.getTidePath(">Downloads"), FileUtilityManager.getTidePath(">Documents")]);
     this.clients.set(userID, newClient);
     FileTide.outputGradient(`[FileTide] ~ Messager launched successfully for client ~ ${userID}!`, significantMessageColors);
-    _assertClassBrand(_FileTide_brand, this, _setupFileEventListeners).call(this, userID, newClient, onIncomingFile, onIncomingTransfer, onTransferBarrier);
+    _assertClassBrand(_FileTide_brand, this, _setupFileEventListeners).call(this, userID, newClient, onTransferProgress, onIncomingTransfer, onIncomingFile, onTransferBarrier, options);
     if (onLaunch) {
       onLaunch(newClient);
     }
@@ -104,8 +108,8 @@ class FileTide {
       }
     });
   }
-  async listFiles(directories) {
-    return await FileUtilityManager.listFiles(directories);
+  async listFiles(directories, depth = 1) {
+    return await FileUtilityManager.listFiles(directories, depth);
   }
   clearShorePolicies(clientID, shores = []) {
     let clientShorePolicies = this.clientShorePolicies.get(clientID);
@@ -218,7 +222,14 @@ class FileTide {
   }
 }
 _FileTide = FileTide;
-function _setupFileEventListeners(userID, client, onIncomingFile, onIncomingTransfer, onTransferBarrier) {
+function _setupFileEventListeners(userID, client, onTransferProgress, onIncomingTransfer, onIncomingFile, onTransferBarrier, options = {}) {
+  const {
+    onTransferStart,
+    onTransferComplete,
+    onTransferRequested,
+    onListFiles,
+    onCurrentOnlineClients
+  } = options;
   const cliTable = new ConsoleTable({
     padding: 2,
     headerAlign: "center",
@@ -259,6 +270,9 @@ function _setupFileEventListeners(userID, client, onIncomingFile, onIncomingTran
     cliTable.setTitle(`✨ Online >${Object.keys(currentClients).length}< ✨`, 1);
     cliTable.setData(currentClients);
     console.log(`\n[FileTide ~ FileNet]\n\n`, cliTable.render(), "\n");
+    if (onCurrentOnlineClients) {
+      onCurrentOnlineClients(currentClients);
+    }
   });
   client.clientTide.onEvent(userID, "queue-incoming-transfer", async data => {
     if (this.transferBarrier && onIncomingTransfer) {
@@ -279,6 +293,9 @@ function _setupFileEventListeners(userID, client, onIncomingFile, onIncomingTran
   });
   client.clientTide.onEvent(userID, "incoming-transfer", async data => {
     _FileTide.outputGradient(`[${userID}] Preparing to receive transfer : ${FileUtilityManager.getTidePath(data.path)}`, significantMessageColors);
+    if (onTransferStart) {
+      onTransferStart(data);
+    }
     this.progressBarManager.completionMessage = `Successfully received transfer from ${data.senderID}!`;
     this.progressBarManager.displayPage("Page Number:", "Press 'n' for next page, 'p' for previous page.", chalk.blue, chalk.magenta);
     this.progressBarManager.listenForInput("Page Number:", "Press 'n' for next page, 'p' for previous page.", chalk.blue, chalk.magenta, chalk.yellow);
@@ -299,6 +316,9 @@ function _setupFileEventListeners(userID, client, onIncomingFile, onIncomingTran
           size: data.fileSize
         });
       }
+      if (onIncomingFile) {
+        onIncomingFile(verifiedSender, data, activeTransfers);
+      }
       if (verifiedSender && !fs.existsSync(saveDir)) {
         fs.mkdirSync(saveDir, {
           recursive: true
@@ -332,8 +352,8 @@ function _setupFileEventListeners(userID, client, onIncomingFile, onIncomingTran
     transferState.receivedChunks[data.chunkIndex] = Buffer.from(data.fileChunk);
     const progress = (data.chunkIndex + 1) / transferState.totalChunks * 100;
     this.progressBarManager.updateTaskProgress(data.fileName, 512 * 1024);
-    if (onIncomingFile) {
-      onIncomingFile(data);
+    if (onTransferProgress) {
+      onTransferProgress(data);
     }
   });
   client.clientTide.onEvent(userID, "transfer-complete", data => {
@@ -348,17 +368,42 @@ function _setupFileEventListeners(userID, client, onIncomingFile, onIncomingTran
       fs.writeFileSync(savePath, fullFile);
       _FileTide.outputGradient(`[${userID}] File saved at : ${savePath}`, significantMessageColors);
       activeTransfers.delete(data.fileName);
+      if (onTransferComplete) {
+        onTransferComplete(data, activeTransfers, true);
+      }
     } catch (error) {
       _FileTide.outputGradient(`[${userID}] Did not save file at : ${savePath}\n${error}`, errorMessageColors);
       activeTransfers.delete(data.fileName);
+      if (onTransferComplete) {
+        onTransferComplete(data, activeTransfers, false);
+      }
     }
   });
   client.clientTide.onEvent(userID, "transfer-requested", async data => {
     _FileTide.outputGradient(`[${userID}] Transfer requested from: ${data.requesterID}`, significantMessageColors);
     this.clients.get(userID).activeTransferTypes.set(data.destinationPath, data.type);
-    await this.sendToDevice(data.requesterID, data.path, data.destinationPath);
+    if (onTransferRequested) {
+      onTransferRequested(data);
+    }
+    await this.sendToDevice(data.requesterID, data.path, data.destinationPath, data.filterContent || []);
     return;
   });
+  client.clientTide.onEvent(userID, "list-files", async data => {
+    _FileTide.outputGradient(`[${userID}] Sending file list!`, significantMessageColors);
+    const currentClientShorePolicies = this.getShorePolicies(userID);
+    const listedFiles = await this.listFiles(currentClientShorePolicies || [">Downloads"], data.depth || 1);
+    client.clientTide.emitEvent(userID, "send-file-list-to-client", {
+      senderID: data.recipientID,
+      recipientID: data.senderID,
+      listedFiles
+    });
+  });
+  client.clientTide.onEvent(userID, "client-file-list", async data => {
+    _FileTide.outputGradient(`[${userID}] Listed ${data.senderID}'s files!`, significantMessageColors);
+    if (onListFiles) {
+      onListFiles(data);
+    }
+  });
   this.currentUserID = userID;
   return;
 }

package/dist/cjs/HUDManagers/FileUtilityManager.js

@@ -66,14 +66,15 @@ class FileUtilityManager {
 
   /**
    * Function to list all paths across the system using wildcard '*'.
+   * @param {number} depth - The maximum depth limit (from the root). Defaults to 1.
    * @returns {Promise<Array>} - A promise that resolves to an array of file and directory metadata across the system.
    */
-  static async listAllPathsInOS() {
+  static async listAllPathsInOS(depth = 1) {
     const rootPaths = ["/", "C:/"];
     let allResults = [];
     const rootPromises = rootPaths.map(async rootPath => {
       if (await this.exists(rootPath)) {
-        const subResult = await this.listPaths(rootPath);
+        const subResult = await this.listPaths(rootPath, depth);
         allResults.push(...subResult.results);
       }
     });
@@ -84,10 +85,19 @@ class FileUtilityManager {
   /**
     * Function to list all paths and their metadata recursively.
     * @param {string} dir - The directory path to scan.
+    * @param {number} maxDepth - The maximum depth limit (from the root). Defaults to 1.
+    * @param {number} currentDepth - The current depth level. Starts at 0 (for the root).
     * @returns {Promise<object>} - A promise that resolves to an object containing a list of files/directories with metadata.
     */
-  static async listPaths(dir) {
+  static async listPaths(dir, maxDepth = 1, currentDepth = 0) {
     let results = [];
+    if (!maxDepth || currentDepth === undefined || currentDepth === null || currentDepth > maxDepth) {
+      return {
+        totalItems: 0,
+        totalSize: 0,
+        results
+      };
+    }
     const list = await fsAsync.readdir(dir, {
       withFileTypes: true
     });
@@ -103,23 +113,27 @@ class FileUtilityManager {
     results.push(dirMetadata);
     const promises = list.map(async file => {
       const filePath = this.getTidePath(path.join(dir, file.name));
-      if (file.isDirectory()) {
-        const subDirResult = await this.listPaths(filePath);
-        dirMetadata.totalItems += subDirResult.totalItems;
-        dirMetadata.totalSize += subDirResult.totalSize;
-        results.push(...subDirResult.results);
-      } else {
-        const fileStats = await fsAsync.stat(filePath);
-        const fileMetadata = {
-          createdTime: fileStats.birthtime,
-          lastModified: fileStats.mtime,
-          size: fileStats.size,
-          path: filePath,
-          type: "file"
-        };
-        dirMetadata.totalSize += fileStats.size;
-        dirMetadata.totalItems += 1;
-        results.push(fileMetadata);
+      try {
+        if (file.isDirectory()) {
+          const subDirResult = await this.listPaths(filePath, maxDepth, currentDepth + 1);
+          dirMetadata.totalItems += subDirResult.totalItems;
+          dirMetadata.totalSize += subDirResult.totalSize;
+          results.push(...subDirResult.results);
+        } else {
+          const fileStats = await fsAsync.stat(filePath);
+          const fileMetadata = {
+            createdTime: fileStats.birthtime,
+            lastModified: fileStats.mtime,
+            size: fileStats.size,
+            path: filePath,
+            type: "file"
+          };
+          dirMetadata.totalSize += fileStats.size;
+          dirMetadata.totalItems += 1;
+          results.push(fileMetadata);
+        }
+      } catch (error) {
+        console.log(`[FileTide] Path not found: ${filePath}`);
       }
     });
     await Promise.all(promises);
@@ -133,17 +147,18 @@ class FileUtilityManager {
   /**
    * Allows for listing files in a specific directory or all files in the system '*'.
    * @param {Array} directories - Array of directories to scan or '*' for entire system.
+   * @param {number} depth - The maximum depth limit (from the root). Defaults to 1.
    * @returns {Promise<Array>} - A promise that resolves to an array of file and directory metadata from specified directories or the entire system.
    */
-  static async listFiles(directories) {
+  static async listFiles(directories, depth = 1) {
     let fileList = [];
     if (directories.includes("*")) {
-      fileList = await this.listAllPathsInOS();
+      fileList = await this.listAllPathsInOS(depth);
     } else {
       const dirPromises = directories.map(async dir => {
         const currentDir = this.getTidePath(dir);
         if (await this.exists(currentDir)) {
-          const subResult = await this.listPaths(currentDir);
+          const subResult = await this.listPaths(currentDir, depth);
           fileList.push(...subResult.results);
         } else {
           console.warn(`Directory does not exist: ${currentDir}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trap_stevo/filetide",
-  "version": "0.0.33",
+  "version": "0.0.35",
   "description": "Revolutionizing real-time file transfer with seamless, instant communication across any device. Deliver files instantly, regardless of platform, and experience unparalleled speed and control in managing transfers. Elevate your file-sharing capabilities with a tool designed for precision, efficiency, and effortless connectivity.",
   "main": "dist/cjs/FileTide.js",
   "scripts": {
@@ -27,7 +27,7 @@
     "seamless connectivity"
   ],
   "author": "Steven Compton",
-  "license": "ISC",
+  "license": "See License in LICENSE.md",
   "dependencies": {
     "@trap_stevo/iotide": "^0.0.37",
     "@trap_stevo/iotide-client": "^0.0.20",