@accitdg/web-helpers 0.0.1 → 0.0.3

package/README.md

@@ -1 +1,134 @@
-WEB HELPERS
+# Web Helpers
+
+A collection of utility functions for web development, including currency conversion, Base64 encoding/decoding, and file handling.
+
+## Installation
+
+```bash
+npm install web-helpers
+```
+
+## Usage
+
+### Import the package
+
+```javascript
+import webHelpers from 'web-helpers';
+// or
+import { convertNumberToCurrency, arrayBufferToBase64, /* ... */ } from 'web-helpers';
+```
+
+## Functions
+
+### `convertNumberToCurrency(numberValue: number): string`
+
+Converts a number to Philippine Peso (PHP) currency format.
+
+**Parameters:**
+- `numberValue` (number): The number to convert
+
+**Returns:** Formatted currency string
+
+**Example:**
+```javascript
+webHelpers.convertNumberToCurrency(1000);
+// Output: "₱1,000.00"
+```
+
+---
+
+### `arrayBufferToBase64(buffer: ArrayBuffer): string`
+
+Converts an ArrayBuffer to a Base64-encoded string.
+
+**Parameters:**
+- `buffer` (ArrayBuffer): The buffer to encode
+
+**Returns:** Base64 encoded string
+
+**Example:**
+```javascript
+const buffer = new ArrayBuffer(8);
+const base64 = webHelpers.arrayBufferToBase64(buffer);
+```
+
+---
+
+### `cleanBase64(base64: string): string`
+
+Removes the data URL prefix from a Base64 string, leaving only the encoded data.
+
+**Parameters:**
+- `base64` (string): The Base64 string with or without prefix
+
+**Returns:** Cleaned Base64 string without prefix
+
+**Example:**
+```javascript
+const cleaned = webHelpers.cleanBase64('data:image/png;base64,iVBORw0KG...');
+// Output: "iVBORw0KG..."
+```
+
+---
+
+### `restoreBase64(cleanedBase64: string, imageType?: string): string`
+
+Restores a clean Base64 string to a complete data URL format.
+
+**Parameters:**
+- `cleanedBase64` (string): The Base64 string without prefix
+- `imageType` (string, optional): Image type (default: "png")
+
+**Returns:** Complete data URL string
+
+**Example:**
+```javascript
+const dataUrl = webHelpers.restoreBase64('iVBORw0KG...', 'jpeg');
+// Output: "data:image/jpeg;base64,iVBORw0KG..."
+```
+
+---
+
+### `downloadBase64File(base64Data: string, filename: string): void`
+
+Triggers a download of a file from Base64-encoded data.
+
+**Parameters:**
+- `base64Data` (string): The Base64 encoded file data
+- `filename` (string): The name of the file to download
+
+**Example:**
+```javascript
+webHelpers.downloadBase64File('data:image/png;base64,iVBORw0KG...', 'image.png');
+```
+
+---
+
+### `getFileExtensionFromBase64(base64String: string): string | null`
+
+Extracts the file extension from a Base64 data URL.
+
+**Parameters:**
+- `base64String` (string): The Base64 data URL
+
+**Returns:** File extension (e.g., "png", "pdf") or null if parsing fails
+
+**Example:**
+```javascript
+const ext = webHelpers.getFileExtensionFromBase64('data:image/png;base64,iVBORw0KG...');
+// Output: "png"
+```
+
+---
+
+## Supported File Types
+
+The `cleanBase64` function supports:
+- Images: png, jpg, jpeg, gif, webp, etc.
+- PDF documents
+- Word documents (.docx, .dotx)
+- Excel spreadsheets (.xlsx)
+
+## License
+
+See LICENSE file for details.

package/dist/index.esm.ts

@@ -5,9 +5,52 @@ const convertNumberToCurrency = numberValue => {
   });
   return formattedValue;
 };
+const restoreBase64 = (cleanedBase64, imageType = "png") => `data:image/${imageType};base64,${cleanedBase64}`;
+const cleanBase64 = base64 => {
+  return base64.replace(/^data:[a-zA-Z0-9\\/\\+\\-]+;base64,/, "").replace(/^data:(application\/pdf|application\/vnd.openxmlformats-officedocument.wordprocessingml.document|application\/vnd.openxmlformats-officedocument.spreadsheetml.sheet|image\/[a-z]+);base64,/, "").replace("data:application/vnd.openxmlformats-officedocument.wordprocessingml.template;base64,", "");
+};
+const downloadBase64File = (base64Data, filename) => {
+  const byteCharacters = atob(restoreBase64(cleanBase64(base64Data)).split(",")[1]);
+  const byteArray = new Uint8Array(byteCharacters.length);
+  for (let i = 0; i < byteCharacters.length; i++) {
+    byteArray[i] = byteCharacters.charCodeAt(i);
+  }
+  const blob = new Blob([byteArray], {
+    type: "application/octet-stream"
+  });
+  const link = document.createElement("a");
+  link.href = URL.createObjectURL(blob);
+  link.download = filename;
+  document.body.appendChild(link);
+  link.click();
+  document.body.removeChild(link);
+};
+const arrayBufferToBase64 = buffer => {
+  let binary = "";
+  const bytes = new Uint8Array(buffer);
+  const len = bytes.byteLength;
+  for (let i = 0; i < len; i++) {
+    binary += String.fromCharCode(bytes[i]);
+  }
+  return window.btoa(binary);
+};
+const getFileExtensionFromBase64 = base64String => {
+  try {
+    const contentType = base64String.split(";")[0].split(":")[1];
+    const extension = contentType.split("/")[1];
+    return extension;
+  } catch (error) {
+    return null;
+  }
+};
 
 const webHelpers = {
-  convertNumberToCurrency
+  convertNumberToCurrency,
+  arrayBufferToBase64,
+  cleanBase64,
+  downloadBase64File,
+  restoreBase64,
+  getFileExtensionFromBase64
 };
 
 export { webHelpers as default, webHelpers };

package/dist/index.ts

@@ -9,9 +9,52 @@ const convertNumberToCurrency = numberValue => {
   });
   return formattedValue;
 };
+const restoreBase64 = (cleanedBase64, imageType = "png") => `data:image/${imageType};base64,${cleanedBase64}`;
+const cleanBase64 = base64 => {
+  return base64.replace(/^data:[a-zA-Z0-9\\/\\+\\-]+;base64,/, "").replace(/^data:(application\/pdf|application\/vnd.openxmlformats-officedocument.wordprocessingml.document|application\/vnd.openxmlformats-officedocument.spreadsheetml.sheet|image\/[a-z]+);base64,/, "").replace("data:application/vnd.openxmlformats-officedocument.wordprocessingml.template;base64,", "");
+};
+const downloadBase64File = (base64Data, filename) => {
+  const byteCharacters = atob(restoreBase64(cleanBase64(base64Data)).split(",")[1]);
+  const byteArray = new Uint8Array(byteCharacters.length);
+  for (let i = 0; i < byteCharacters.length; i++) {
+    byteArray[i] = byteCharacters.charCodeAt(i);
+  }
+  const blob = new Blob([byteArray], {
+    type: "application/octet-stream"
+  });
+  const link = document.createElement("a");
+  link.href = URL.createObjectURL(blob);
+  link.download = filename;
+  document.body.appendChild(link);
+  link.click();
+  document.body.removeChild(link);
+};
+const arrayBufferToBase64 = buffer => {
+  let binary = "";
+  const bytes = new Uint8Array(buffer);
+  const len = bytes.byteLength;
+  for (let i = 0; i < len; i++) {
+    binary += String.fromCharCode(bytes[i]);
+  }
+  return window.btoa(binary);
+};
+const getFileExtensionFromBase64 = base64String => {
+  try {
+    const contentType = base64String.split(";")[0].split(":")[1];
+    const extension = contentType.split("/")[1];
+    return extension;
+  } catch (error) {
+    return null;
+  }
+};
 
 const webHelpers = {
-  convertNumberToCurrency
+  convertNumberToCurrency,
+  arrayBufferToBase64,
+  cleanBase64,
+  downloadBase64File,
+  restoreBase64,
+  getFileExtensionFromBase64
 };
 
 exports["default"] = webHelpers;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@accitdg/web-helpers",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "type": "module",
   "scripts": {
     "build": "rollup -c",