@modernman00/shared-js-lib 1.2.6 → 1.2.7

package/README.md

@@ -0,0 +1,74 @@
+npm Usage Guide for @modernman00/shared-js-lib
+This guide explains how to install and use the @modernman00/shared-js-lib package, now available on the npm registry, in your Node.js or JavaScript project.
+Installation
+To install the package from npm, run the following command in your project directory:
+npm install @modernman00/shared-js-lib
+
+
+This installs the latest published version from the npm registry.
+Ensure you have an internet connection and npm access to the @modernman00 scope (authentication may be required if the package is private).
+
+Usage
+The package exports various utility functions from its modules (e.g., Http.js, Utility.js). Import and use them as follows:
+Example: Using fetchData from Http.js
+Assume Http.js exports a function to fetch data using Axios:
+import { fetchData } from '@modernman00/shared-js-lib';
+
+async function getUserData() {
+    try {
+        const userData = await fetchData('/api/users/1', { method: 'GET' });
+        console.log(userData);
+    } catch (error) {
+        console.error('Error fetching data:', error.message);
+    }
+}
+
+getUserData();
+
+Example: Using sanitizeInput from Utility.js
+Assume Utility.js exports a sanitization function:
+import { sanitizeInput } from '@modernman00/shared-js-lib';
+
+const cleanInput = sanitizeInput('<script>alert("xss")</script>');
+console.log(cleanInput); // Sanitized output
+
+Configuration
+
+Ensure your project uses ES Modules by adding "type": "module" to your package.json, or use a bundler like Laravel Mix/Webpack.
+If using Laravel Mix, configure an alias in webpack.mix.js:const mix = require('laravel-mix');
+const path = require('path');
+
+mix.js('resources/js/app.js', 'public/js')
+   .webpackConfig({
+       resolve: {
+           alias: {
+               '@shared': path.resolve(__dirname, 'node_modules/@modernman00/shared-js-lib')
+           }
+       }
+   });
+
+
+
+Updating the Package
+To update to the latest version, run:
+npm update @modernman00/shared-js-lib
+
+Check the latest version on the npm website (https://www.npmjs.com/package/@modernman00/shared-js-lib) or with:
+npm info @modernman00/shared-js-lib version
+
+If a specific version is needed, install it directly:
+npm install @modernman00/shared-js-lib@1.0.3
+
+Rebuild assets if using a bundler:
+npm run dev
+
+Troubleshooting
+
+Installation Fails: Ensure you have npm access and the package is published. Use verbose mode for details:npm install @modernman00/shared-js-lib --verbose
+
+
+TypeScript Errors: Add declaration files (e.g., Http.d.ts) to the package if needed, and republish.
+Permission Issues: If the package is scoped and private, log in to npm:npm login
+
+
+

package/ShowResponse.js

@@ -1,93 +1,98 @@
 import { id } from './UtilityHtml.js';
-import axios from "axios"
-export const showError = (e) => console.error(`${e.name} at ${e.fileName}:${e.lineNumber} - ${e.message}\n${e.stack}`);
+import axios from 'axios';
+export const showError = (e) =>
+  console.error(
+    `${e.name} at ${e.fileName}:${e.lineNumber} - ${e.message}\n${e.stack}`,
+  );
 
 export const msgException = (errorMessage) => {
-  
-    throw new Error(errorMessage)
-}
-
+  throw new Error(errorMessage);
+};
 
 /**
- * 
+ *
  * @param {*} elementId - element id
  * @param {*} addClass either a success or danger class (green or red)
  * @param {*} message - html message to convey success or failure
  * @param {*} timer - timer for the message to disappear- default is 5 secs
  */
-export const showNotification = (elementId, addClass, message, timer = 5000) => {
-    // display the success information for 10sec
-    id(`${elementId}`).style.display = "block" // unblock the notification
-    id(`${elementId}`).classList.add(addClass) // add the success class
-    id(`${elementId}`).innerHTML = message // error element
-    id('loader').classList.remove('loader') // remove loader
-
-    setTimeout(() => {
-        id(`${elementId}`).style.backgroundColor = ""
-        id(`${elementId}`).style.color = ""
-        id(`${elementId}`).innerHTML = ""
-    }, timer)
-}
-
-  /**
-   * 
-   * @param {*} elementId - element id 
-   * @returns {Promise<void>}
-   * @description This is a function that deletes a notification. It takes in the elementId of the delete button
-   *              and uses that to get the user ID and the notification ID. It makes a put request to the server to
-   *              mark the notification as read. If the request is successful, it removes the notification from the page
-   *              and decrements the notification count by 1. If the request is unsuccessful, it logs an error message.
-   */
+export const showNotification = (
+  elementId,
+  addClass,
+  message,
+  timer = 5000,
+) => {
+  // display the success information for 10sec
+  id(`${elementId}`).style.display = 'block'; // unblock the notification
+  id(`${elementId}`).classList.add(addClass); // add the success class
+  id(`${elementId}`).innerHTML = message; // error element
+  id('loader').classList.remove('loader'); // remove loader
+
+  setTimeout(() => {
+    id(`${elementId}`).style.backgroundColor = '';
+    id(`${elementId}`).style.color = '';
+    id(`${elementId}`).innerHTML = '';
+  }, timer);
+};
+
+/*************  ✨ Windsurf Command 🌟  *************/
+export const deleteNotification = async (elementId, yourId, famCode) => {
   export const deleteNotification = async (elementId) => {
-
-         // Extract the user ID from the target ID
-            const senderId = elementId.replace("deleteNotification", "notificationBar");
-          
-            const elementData = id(elementId)
-            const data = elementData.getAttribute("data-id");
-
-            // change the background of the clicked element 
-
-            const notificationHTML = id(senderId);
-
-            // Make sure required variables are defined before using them
-            if (
-                typeof yourId === 'undefined' ||
-                typeof famCode === 'undefined'
-            ) {
-                msgException("Required parameters (yourId or famCode) are not defined");
-            }
-
-            const url = `/removeNotification/${yourId}/${famCode}/${data}`
-
-
-            const response = await axios.put(url)
-
-
-            if (response.data.message === "Notification marked as read") {
-
-                // remove a html element with notificationBar after 2 mins 
-                notificationHTML.remove()
-
-                // reduce the notification count as you have deleted the notification
-
-                const newValues = parseInt(sessionStorage.getItem('notificationCount') - 1)
-                id('notification_count').innerHTML = newValues;
-            } else {
-                msgException("Error removing notification" + " " + response.data.message);
-            }
+    // Extract the user ID from the target ID
+    const senderId = elementId.replace('deleteNotification', 'notificationBar');
+
+    const elementData = id(elementId);
+    const data = elementData.getAttribute('data-id');
+    // change the background of the clicked element
+    const notificationHTML = id(senderId);
+    // Make sure required variables are defined before using them
+    if (typeof yourId === 'undefined' || typeof famCode === 'undefined') {
+      msgException('Required parameters (yourId or famCode) are not defined');
     }
-
-    export const showResponse = (theId, message, status) => {
-    const responseEl = id(theId)
-    const col = status ? 'green' : 'red'
-
-    responseEl.innerHTML = message
-    responseEl.style.color = 'green'
-    responseEl.style.backgroundColor = col
-    responseEl.style.color = 'white';
-    setTimeout(() => {
-        responseEl.innerHTML = '';
-    }, 5000); // Disappear after 5 seconds
-
-}
+    const url = `/removeNotification/${yourId}/${famCode}/${data}`;
+    const response = await axios.put(url);
+    if (response.data.message === 'Notification marked as read') {
+      // remove a html element with notificationBar after 2 mins
+      notificationHTML.remove();
+      // reduce the notification count as you have deleted the notification
+      const newValues = parseInt(
+        sessionStorage.getItem('notificationCount') - 1,
+      );
+      id('notification_count').innerHTML = newValues;
+    } else {
+      msgException('Error removing notification' + ' ' + response.data.message);
+    }
+  };
+  /*******  43b70b66-cdee-4764-a1e7-4f21be65d0d7  *******/
+
+  const url = `/removeNotification/${yourId}/${famCode}/${data}`;
+
+  try {
+    const response = await axios.put(url);
+
+    if (response.data.message === 'Notification marked as read') {
+      notificationHTML.remove();
+      const newValues = parseInt(
+        sessionStorage.getItem('notificationCount') - 1,
+      );
+      id('notification_count').innerHTML = newValues;
+    } else {
+      console.error('Error removing notification', response.data.message);
+    }
+  } catch (error) {
+    console.error('Error removing notification', error);
+  }
+};
+
+export const showResponse = (theId, message, status) => {
+  const responseEl = id(theId);
+  const col = status ? 'green' : 'red';
+
+  responseEl.innerHTML = message;
+  responseEl.style.color = 'green';
+  responseEl.style.backgroundColor = col;
+  responseEl.style.color = 'white';
+  setTimeout(() => {
+    responseEl.innerHTML = '';
+  }, 5000); // Disappear after 5 seconds
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modernman00/shared-js-lib",
-  "version": "1.2.6",
+  "version": "1.2.7",
   "description": "Reusable JS utilities for numerous js problems",
   "homepage": "https://github.com/modernman00/shared-js-lib#readme",
   "keywords": [