@accitdg/web-helpers 0.0.2 → 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/package.json

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