@accitdg/web-helpers 0.0.2 → 0.0.4

package/README.md

@@ -1 +1,254 @@
-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"
+```
+
+---
+
+## Configuration
+
+createPayload and createPayload2 read applicationId and notificationId from a global config object. Call configureHelpers once during app initialization to set global defaults:
+
+```ts
+configureHelpers({
+  applicationId: "app-123",
+  notificationId: "notif-abc",
+});
+```
+
+- These global values are stored on globalThis.\_\_WEB_HELPERS_CONFIG.
+- Individual calls to createPayload / createPayload2 can override these values by passing notifId / applicationId in the arguments.
+
+## Payload factories
+
+### createPayload(args?)
+
+Returns a full, readable payload shape suitable for APIs that expect verbose keys.
+
+Signature (TypeScript):
+
+```ts
+createPayload(args?: {
+  pagination?: { count: number; page: number };
+  payload?: Record<string, any>;
+  notifId?: string | null;
+})
+```
+
+Returns:
+
+```ts
+{
+  isLazyLoading: boolean;
+  notificationId: string | null;
+  applicationId: string | null;
+  geoLocation: {
+    latitude: string;
+    longitude: string;
+    dateTime: string;
+  }
+  pagination: {
+    count: number;
+    page: number;
+  }
+  payload: Record<string, any>;
+}
+```
+
+Example:
+
+```ts
+const result = createPayload({ payload: { foo: "bar" } });
+// uses configured notificationId/applicationId unless notifId is provided
+```
+
+### createPayload2(options?)
+
+Returns a compact payload shape (short keys) for services that use abbreviated keys.
+
+Signature (TypeScript):
+
+```ts
+createPayload2({
+  pagination?: { c: number; p: number },
+  payload?: Record<string, any>,
+  notifId?: string | null,
+  applicationId?: string | null,
+} = {})
+```
+
+Returns:
+
+```ts
+{
+  isLl: boolean;
+  nId: string | null;
+  aId: string | null;
+  gL: {
+    lt: string;
+    long: string;
+    date: string;
+  }
+  pg: {
+    c: number;
+    p: number;
+  }
+  p: Record<string, any>;
+}
+```
+
+Example:
+
+```ts
+const short = createPayload2({ payload: { x: 1 } });
+// uses configured applicationId/notificationId unless overridden in the call
+```
+
+## Supported File Types
+
+The `cleanBase64` function supports:
+
+- Images: png, jpg, jpeg, gif, webp, etc.
+- PDF documents
+- Word documents (.docx, .dotx)
+- Excel spreadsheets (.xlsx)
+
+## License
+
+@allcardtech2025

package/dist/index.esm.ts

@@ -43,6 +43,60 @@ const getFileExtensionFromBase64 = base64String => {
     return null;
   }
 };
+const createPayload = args => {
+  // ...existing code...
+  let param = typeof globalThis.objTrim === "function" ? globalThis.objTrim(args.payload ?? {}) : args.payload ?? {};
+  var data = {
+    isLazyLoading: false,
+    notificationId: args.notifId ?? globalThis.__WEB_HELPERS_CONFIG?.notificationId ?? null,
+    applicationId: globalThis.__WEB_HELPERS_CONFIG?.applicationId ?? null,
+    geoLocation: {
+      latitude: "0",
+      longitude: "0",
+      dateTime: new Date().toISOString()
+    },
+    pagination: args.pagination ?? {
+      count: 0,
+      page: 0
+    },
+    payload: param
+  };
+  return data;
+};
+const createPayload2 = ({
+  pagination = {
+    c: 0,
+    p: 0
+  },
+  payload = {},
+  notifId,
+  applicationId
+} = {}) => {
+  const cfg = globalThis.__WEB_HELPERS_CONFIG || {};
+  const nId = notifId ?? cfg.notificationId ?? null;
+  const aId = applicationId ?? cfg.applicationId ?? null;
+  const objTrimFn = typeof globalThis.objTrim === "function" ? globalThis.objTrim : o => o;
+  const param = objTrimFn(payload);
+  return {
+    isLl: false,
+    nId,
+    aId,
+    gL: {
+      lt: "0",
+      long: "0",
+      date: new Date().toISOString()
+    },
+    pg: pagination,
+    p: param
+  };
+};
+// Add this helper to configure global values (call once during app init)
+const configureHelpers = config => {
+  globalThis.__WEB_HELPERS_CONFIG = {
+    ...(globalThis.__WEB_HELPERS_CONFIG || {}),
+    ...config
+  };
+};
 
 const webHelpers = {
   convertNumberToCurrency,
@@ -50,7 +104,10 @@ const webHelpers = {
   cleanBase64,
   downloadBase64File,
   restoreBase64,
-  getFileExtensionFromBase64
+  getFileExtensionFromBase64,
+  configureHelpers,
+  createPayload,
+  createPayload2
 };
 
 export { webHelpers as default, webHelpers };

package/dist/index.ts

@@ -47,6 +47,60 @@ const getFileExtensionFromBase64 = base64String => {
     return null;
   }
 };
+const createPayload = args => {
+  // ...existing code...
+  let param = typeof globalThis.objTrim === "function" ? globalThis.objTrim(args.payload ?? {}) : args.payload ?? {};
+  var data = {
+    isLazyLoading: false,
+    notificationId: args.notifId ?? globalThis.__WEB_HELPERS_CONFIG?.notificationId ?? null,
+    applicationId: globalThis.__WEB_HELPERS_CONFIG?.applicationId ?? null,
+    geoLocation: {
+      latitude: "0",
+      longitude: "0",
+      dateTime: new Date().toISOString()
+    },
+    pagination: args.pagination ?? {
+      count: 0,
+      page: 0
+    },
+    payload: param
+  };
+  return data;
+};
+const createPayload2 = ({
+  pagination = {
+    c: 0,
+    p: 0
+  },
+  payload = {},
+  notifId,
+  applicationId
+} = {}) => {
+  const cfg = globalThis.__WEB_HELPERS_CONFIG || {};
+  const nId = notifId ?? cfg.notificationId ?? null;
+  const aId = applicationId ?? cfg.applicationId ?? null;
+  const objTrimFn = typeof globalThis.objTrim === "function" ? globalThis.objTrim : o => o;
+  const param = objTrimFn(payload);
+  return {
+    isLl: false,
+    nId,
+    aId,
+    gL: {
+      lt: "0",
+      long: "0",
+      date: new Date().toISOString()
+    },
+    pg: pagination,
+    p: param
+  };
+};
+// Add this helper to configure global values (call once during app init)
+const configureHelpers = config => {
+  globalThis.__WEB_HELPERS_CONFIG = {
+    ...(globalThis.__WEB_HELPERS_CONFIG || {}),
+    ...config
+  };
+};
 
 const webHelpers = {
   convertNumberToCurrency,
@@ -54,7 +108,10 @@ const webHelpers = {
   cleanBase64,
   downloadBase64File,
   restoreBase64,
-  getFileExtensionFromBase64
+  getFileExtensionFromBase64,
+  configureHelpers,
+  createPayload,
+  createPayload2
 };
 
 exports["default"] = webHelpers;

package/package.json

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