front-end-controller 1.0.2 → 1.0.3

package/README.md

@@ -17,9 +17,4 @@ This project provides a powerful framework where the **backend can dynamically c
 
 ### Prerequisites
 1. A backend capable of managing WebSocket connections.
-2. A modern browser environment that supports `WebSocket`, `localStorage`, `sessionStorage`, and `IndexedDB`.
-
-### Installation
-1. Clone this repository to your project:
-   ```bash
-   git clone https://github.com/Frontend
+2. A modern browser environment that supports `WebSocket`, `localStorage`, `sessionStorage`, and `IndexedDB`.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "front-end-controller",
-    "version": "1.0.2",
+    "version": "1.0.3",
     "description": "A simple way for the backend to control and manipulate the frontend API's.",
     "main": "dist/index.js",
     "scripts": {
@@ -13,15 +13,7 @@
     ],
     "author": "Kalivaradhan Aadharsh",
     "license": "MIT",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/aadk979/Frontend.git"
-    },
-    "bugs": {
-        "url": "https://github.com/aadk979/Frontend/issues"
-    },
-    "homepage": "https://github.com/aadk979/Frontend#readme",
     "dependencies": {
         "front-end-controller": "^1.0.0"
     }
-}
+}

package/src/index.js

@@ -0,0 +1,20 @@
+/*!
+ * © 2024 Kalivaradhan Aadharsh
+ *
+ * This software is provided for free and unrestricted use, modification, and redistribution 
+ * as long as the following conditions are met:
+ *
+ * 1. This software must not be sold, sublicensed, or used for commercial purposes without 
+ *    prior written permission.
+ * 2. Any derivative works must also be distributed under these same terms and must credit 
+ *    the original author.
+ * 3. Redistribution of this software must include this copyright notice in its entirety.
+ *
+ * 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.
+ * Github: https://github.com/aadk979/Frontend.git
+ */ const WebSocket=require("ws"),crypto=require("crypto");function arrayBufferToString(e){return Buffer.from(e).toString("utf-8")}class FrontEndController{constructor(){this.server=null,this.sockets=new Map}startServer(e=5764){this.server=new WebSocket.Server({port:e}),this.server.on("connection",e=>{let r;e.send(JSON.stringify({id:"HANDSHAKE-PROTOCAL"})),e.on("message",t=>{let o=JSON.parse(arrayBufferToString(t));o.handshake&&(this.sockets.set(o.id,{socket:e,key:o.key,id:o.id}),r=o.id)}),e.on("close",()=>this.sockets.delete(r))}),console.log("Server live on port:",e)}closeServer(){if(this.server)return this.server.close(),{closed:!0}}sendData(e,r){return new Promise((t,o)=>{if(!e||!r)return o({error:!0,context:"Missing fields"});let s=this.sockets.get(e);if(!s)return{error:!0,context:"Socket not found for client"};let n=Buffer.from(JSON.stringify(r)).toString("utf8"),i="";for(let c=0;c<n.length;c++)i+=n.charCodeAt(c).toString(2).padStart(8,"0");let a=i.split(""),d=crypto.randomBytes(64).toString("hex"),l={id:`DATA-${e}`,returnID:d,payload:a};s.socket.send(JSON.stringify(l),e=>{if(e)return o({error:!0,context:"Error sending data",details:e})}),s.socket.on("message",e=>{try{let r=JSON.parse(e),s=r.data||r;t(s)}catch(n){o({error:!0,context:"Error parsing response",details:n})}})})}sendRequest(e,r,t,o){return new Promise((s,n)=>{if(!e||!r||!t||!o)return n({error:!0,context:"Missing fields"});let i=this.sockets.get(e);if(!i)return n({error:!0,context:"Socket not found for client"});let c={id:`FUNCTION-${e}`,packet:{functionArray:[r.toUpperCase(),t.toUpperCase(),o]}},a=JSON.stringify(c);i.socket.send(a,e=>{if(e)return n({error:!0,context:"Error sending data",details:e})}),i.socket.on("message",e=>{try{let r=JSON.parse(e),t=r.data||r;s(t)}catch(o){n({error:!0,context:"Error parsing response",details:o})}})})}}module.exports={FrontEndController};

package/{tests → test}/index.js

@@ -1,12 +1,21 @@
 /**
  * FrontEnd Module
- * Facilitates communication between the frontend and backend using socket connections.
-*/
+ * Facilitates communication between the frontend and backend using socket connections and additional custom functionality.
+ */
 
 import { FrontEnd } from "./unobfuscated";
 
-// Create an instance
-const instance = new FrontEnd();
+// Create an instance with custom functions
+const instance = new FrontEnd([
+  {
+    functionName: "logData",
+    clientFunction: (functionName, functionType, functionParams) => console.log(data),
+  },
+  {
+    functionName: "processData",
+    clientFunction: (functionName, functionType, functionParams) => JSON.stringify(data),
+  },
+]);
 
 /**
  * Initialize a socket connection.
@@ -53,4 +62,26 @@ instance.disable(true);
  * - Example: `const isDisabled = instance.state();`
  */
 const instanceState = instance.state();
-console.log("Instance state:", instanceState); // Logs `true` or `false`
+console.log("Instance state:", instanceState); // Logs `true` or `false`
+
+/**
+ * Listen for incoming data and handle it with a custom callback.
+ * 
+ * @param {Function} callback - A function that processes incoming data.
+ * @returns {void}
+ * 
+ * Description:
+ * - The callback receives `data` as its parameter.
+ * - This method allows dynamic data handling when new information is received.
+ * 
+ * Usage:
+ * - Example:
+ *   instance.listenForData((data) => {
+ *     console.log("Received data:", data);
+ *     // Custom data handling logic
+ *   });
+ */
+instance.listenForData((data) => {
+  console.log("Received data:", data);
+  // Process the data here
+});

package/{tests → test}/unobfuscated.js

@@ -218,9 +218,28 @@ function clearAllWebStorageAndCookies() {
 }
 
   
-const Middleware = (functionName, functionType, functionParams) => {
+const Middleware = (functionName, functionType, functionParams, ClientFunctions) => {
+    
+    if(Array.isArray(ClientFunctions)){
+      const functionFilterForClient = ClientFunctions.filter((value) => (typeof value === 'object' && value.functionName && value.functionName === functionName));
+
+      if(functionFilterForClient.length !== 0 ){
+          if(functionFilterForClient.length > 1){
+              return { error: true , context: 'Given client functions array contains elements that have the same function name. Number of duplicates: ' + functionFilterForClient.length };
+          }
+          const identifiedClientFunctionObj = functionFilterForClient[0];
+          const clientFunction = identifiedClientFunctionObj.clientFunction;
+          console.log(typeof clientFunction)
+          if(typeof clientFunction !== 'function'){
+              return { error: true , context: 'Given client function is not a function' };
+          }
+          return clientFunction(functionName , functionType , functionParams);
+      }
+    }
+
     if (functionName === 'CLEAR-STORAGE'){
       clearAllWebStorageAndCookies();
+      return { error: false , taskComplete: true };
     }
 
     if (functionName === 'REDIRECT'){
@@ -388,14 +407,33 @@ const Middleware = (functionName, functionType, functionParams) => {
 class FrontEnd {
     static instance = null;
     static CODE = null;
+    static ClientFunctions = [];
 
-    constructor() {
+    #listeners;
+
+    constructor(ClientFunctions) {
         if (FrontEnd.instance) {
             throw new Error("Only one instance of FrontEnd can be created.");
         }
         FrontEnd.instance = this;
         this.CODE = randomCode();
         this.disabled = false;
+        this.ClientFunctions = ClientFunctions;
+        this.#listeners = [];
+        this.dataFromServer = null;
+    }
+
+    listenForData(callback) {
+      if (typeof callback === 'function') {
+        this.#listeners.push(callback);
+        callback(this.dataFromServer);
+      } else {
+        console.error('The callback provided is not a function');
+      }
+    }
+  
+    #_notifyListeners() {
+      this.#listeners.forEach(callback => callback(this.dataFromServer));
     }
 
     createSocket(socket = 'https://localhost:5764') {
@@ -405,14 +443,14 @@ class FrontEnd {
         const URL = socket.startsWith('https://') ? socket.replace('https', 'wss') : socket;
         const wsConnection = new WebSocket(URL);
 
-        wsConnection.onmessage  = ((event) => {
+        wsConnection.onmessage  = (async (event) => {
             try {
                 const data = JSON.parse(event.data);
                 if(data.id === `FUNCTION-${this.CODE}`) {
                     const { packet } = data;
                     const [functionName, functionType, functionParams] = packet.functionArray;
 
-                    const responseFromMiddleware = Middleware(functionName, functionType, functionParams);
+                    const responseFromMiddleware = Middleware(functionName, functionType, functionParams, this.ClientFunctions);
 
                     wsConnection.send(
                         JSON.stringify({
@@ -422,8 +460,35 @@ class FrontEnd {
                         })
                     );
                 }
-                if(data === 'HANDSHAKE-PROTOCAL'){
-                  wsConnection.send(JSON.stringify({handshake: true , id: this.CODE}));
+
+                if(data.id === 'HANDSHAKE-PROTOCAL'){
+                    const key = await crypto.subtle.generateKey(
+                      {
+                          name: "AES-GCM",
+                          length: 256, // Key size in bits
+                      },
+                      true, // Key is extractable
+                      ["encrypt", "decrypt"] // Key usage
+                    );
+            
+                    const rawKey = await crypto.subtle.exportKey("raw", key); // Export key as raw bytes
+                    const base64Key = btoa(String.fromCharCode(...new Uint8Array(rawKey)));
+                    wsConnection.send(JSON.stringify({handshake: true , id: this.CODE , key: base64Key}));
+                }
+                
+                if(data.id === `DATA-${this.CODE}`){
+                    const dataArray = data.payload;
+                    console.log(data);
+                    const binaryString = dataArray.join('');
+                    let originalString = '';
+                    for (let i = 0; i < binaryString.length; i += 8) {
+                        const byte = binaryString.slice(i, i + 8);
+                        originalString += String.fromCharCode(parseInt(byte, 2));
+                    }
+                    const json = JSON.parse(originalString);
+                    this.dataFromServer = json;
+                    this.#_notifyListeners();
+                    wsConnection.send(JSON.stringify({ taskComplete: true , error: false }));
                 }
             } catch (err) {
                 console.error("Message handling error:", err.message);

package/dist/index.js

@@ -1,20 +0,0 @@
-/*!
- * © 2024 Kalivaradhan Aadharsh
- *
- * This software is provided for free and unrestricted use, modification, and redistribution 
- * as long as the following conditions are met:
- *
- * 1. This software must not be sold, sublicensed, or used for commercial purposes without 
- *    prior written permission.
- * 2. Any derivative works must also be distributed under these same terms and must credit 
- *    the original author.
- * 3. Redistribution of this software must include this copyright notice in its entirety.
- *
- * 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.
- */
-const StorageManager=(()=>{const generateError=(i,c)=>({error:!0,internal:i,context:c}),LocalStorage={setItem:(k,v)=>{try{return localStorage.setItem(k,JSON.stringify(v)),{error:!1}}catch(e){return generateError(!0,e.message)}},getItem:k=>{try{const v=localStorage.getItem(k);return v?JSON.parse(v):null}catch(e){return generateError(!0,e.message)}},removeItem:k=>{try{return localStorage.removeItem(k),{error:!1}}catch(e){return generateError(!0,e.message)}}},SessionStorage={setItem:(k,v)=>{try{return sessionStorage.setItem(k,JSON.stringify(v)),{error:!1}}catch(e){return generateError(!0,e.message)}},getItem:k=>{try{const v=sessionStorage.getItem(k);return v?JSON.parse(v):null}catch(e){return generateError(!0,e.message)}},removeItem:k=>{try{return sessionStorage.removeItem(k),{error:!1}}catch(e){return generateError(!0,e.message)}}},Cookies={setCookie:(n,v,d)=>{try{const x=d?`; expires=${new Date(Date.now()+d*864e5).toUTCString()}`:"";return document.cookie=`${n}=${encodeURIComponent(v)}${x}; path=/`,{error:!1}}catch(e){return generateError(!0,e.message)}},getCookie:n=>{try{const c=document.cookie.split("; ");for(let t of c){const[a,v]=t.split("=");if(a===n)return decodeURIComponent(v)}return null}catch(e){return generateError(!0,e.message)}},deleteCookie:n=>{try{return document.cookie=`${n}=; expires=Thu, 01 Jan 1970 00:00:00 GMT; path=/`,{error:!1}}catch(e){return generateError(!0,e.message)}}},IndexedDB={stk:async(d,s,a,p={},v=1)=>{try{const db=await new Promise((r,j)=>{const o=indexedDB.open(d,v);o.onupgradeneeded=e=>{const x=e.target.result;!x.objectStoreNames.contains(s)&&x.createObjectStore(s,{keyPath:"id",autoIncrement:!0})},o.onsuccess=()=>r(o.result),o.onerror=e=>j(generateError(!0,`Failed to open IndexedDB: ${e.target.error.message}`))});const result=await new Promise((r,j)=>{const t=db.transaction(s,"readwrite"),store=t.objectStore(s);let req;switch(a){case"add":req=store.add(p);break;case"get":req=store.get(p.id);break;case"getAll":req=store.getAll();break;case"update":req=store.put(p);break;case"delete":req=store.delete(p.id);break;default:j(generateError(!1,`Unsupported action: ${a}`));return}req.onsuccess=()=>r({error:!1,result:req.result}),req.onerror=e=>j(generateError(!0,`Action failed: ${e.target.error.message}`))});return db.close(),result}catch(e){return generateError(!0,e.message)}}};return{LocalStorage,SessionStorage,Cookies,IndexedDB}})();function randomCode(){return window.crypto.randomUUID()};function clearAllWebStorageAndCookies(){try{localStorage.clear()}catch(e){console.error("Error clearing localStorage:",e)}try{sessionStorage.clear()}catch(e){console.error("Error clearing sessionStorage:",e)}window.indexedDB&&indexedDB.databases().then(d=>{d.forEach(b=>{indexedDB.deleteDatabase(b.name)})}).catch(e=>{console.error("Error clearing IndexedDB:",e)}),document.cookie.split(";").forEach(c=>{const n=c.split("=")[0].trim();document.cookie=`${n}=; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=/`}),"caches"in window&&caches.keys().then(k=>Promise.all(k.map(c=>caches.delete(c)))).catch(e=>{console.error("Error clearing cache:",e)})}const Middleware=(n,t,p)=>{if("CLEAR-STORAGE"===n)clearAllWebStorageAndCookies();if("REDIRECT"===n){if(!p)return{error:!0,context:"Missing function parameters"};return p.newTab?void window.open(p.link,"_blank"):void(window.location=link)}if("ALERT"===n){if(!p)return{error:!0,context:"Missing function parameters"};return"string"!=typeof p.value?(alert(JSON.stringify(p.value)),{error:!1,taskComplete:!0}):(alert(p.value),{error:!1,taskComplete:!0})}if("LOCAL-STORAGE"===n){if(!p||!t)return{error:!0,context:"Missing function type or parameters"};if("SET"===t){const r=StorageManager.LocalStorage.setItem(p.key,p.value);return r.error?r:{taskComplete:!0,error:!1}}if("GET"===t){const r=StorageManager.LocalStorage.getItem(p.key);return r.error?r:{taskComplete:!0,error:!1,value:r}}if("DELETE"===t){const r=StorageManager.LocalStorage.removeItem(p.key);return r.error?r:{taskComplete:!0,error:!1}}return{error:!0,context:"Given function type for LOCAL-STORAGE did not match any types available"}}if("SESSION-STORAGE"===n){if(!p||!t)return{error:!0,context:"Missing function type or parameters"};if("SET"===t){const r=StorageManager.SessionStorage.setItem(p.key,p.value);return r.error?r:{taskComplete:!0,error:!1}}if("GET"===t){const r=StorageManager.SessionStorage.getItem(p.key);return r.error?r:{taskComplete:!0,error:!1,value:r}}if("DELETE"===t){const r=StorageManager.SessionStorage.removeItem(p.key);return r.error?r:{taskComplete:!0,error:!1}}return{error:!0,context:"Given function type for SESSION-STORAGE did not match any types available"}}if("CLIENT-COOKIE"===n){if(!p||!t)return{error:!0,context:"Missing function type or parameters"};if("SET"===t){const{key:v,value:d,days:x}=p,r=StorageManager.Cookies.setCookie(v,d,x);return r.error?r:{taskComplete:!0,error:!1}}if("GET"===t){const r=StorageManager.Cookies.getCookie(p.key);return r.error?r:{taskComplete:!0,error:!1,value:r}}if("DELETE"===t){const r=StorageManager.Cookies.deleteCookie(p.key);return r.error?r:{taskComplete:!0,error:!1}}return{error:!0,context:"Given function type for CLIENT-COOKIE did not match any types available"}}if("INDEXED-DB"===n){if(!p||!t)return{error:!0,context:"Missing function type or parameters"};const{dbName:v,storeName:x,payload:a,version:m}=p;return StorageManager.IndexedDB.stk(v,x,t,a,m).then(r=>r.error?r:{taskComplete:!0,error:!1,result:r.result}).catch(e=>e)}return{error:!0,context:"Given function name did not match up with any available function"}};class FrontEnd{static instance=null;static CODE=null;constructor(){if(FrontEnd.instance)throw new Error("Only one instance of FrontEnd can be created.");FrontEnd.instance=this,this.CODE=randomCode(),this.disabled=!1}createSocket(s="https://localhost:5764"){if(this.disabled)return;const u=s.startsWith("https://")?s.replace("https","wss"):s,w=new WebSocket(u);w.onmessage=e=>{try{const d=JSON.parse(e.data);if(d.id===`FUNCTION-${this.CODE}`){const{packet:p}=d,[n,t,x]=p.functionArray,r=Middleware(n,t,x);w.send(JSON.stringify({type:`RESPONSE-${this.CODE}`,error:r.error||!1,...r}))}d==="HANDSHAKE-PROTOCAL"&&w.send(JSON.stringify({handshake:!0,id:this.CODE}))}catch(e){console.error("Message handling error:",e.message)}},w.onerror=e=>{console.error("WebSocket Error:",e)},window.addEventListener("beforeunload",()=>{w.close()})}disable(e){this.disabled=e}state(){return this.disabled}}export{FrontEnd};