dphelper 4.2.0 → 4.2.3

package/markdown/browser.md

@@ -1,203 +0,0 @@
-# browser
-
-Complete browser navigation and state management utilities with connection monitoring and HTTP status handling.
-
-## Functions
-
-| Function | Description | Example |
-|----------|-------------|---------|
-| `state` | Pushes a new state to browser history without reload | `dphelper.browser.state(state, title, url)` |
-| `forw` | Moves forward in browser history by n steps | `dphelper.browser.forw(1)` |
-| `back` | Moves backward in browser history by n steps | `dphelper.browser.back(1)` |
-| `reload` | Reloads the current page | `dphelper.browser.reload()` |
-| `href` | Navigates to a specific URL | `dphelper.browser.href('https://example.com')` |
-| `offLine` | Displays an offline message overlay when connection is lost | `dphelper.browser.offLine('Custom offline message')` |
-| `zoom` | Returns the current browser zoom level as percentage | `dphelper.browser.zoom()` |
-| `status` | Returns human-readable description of HTTP status codes | `dphelper.browser.status(404)` |
-| `interlock` | Detects and monitors other active tabs of the same app | `dphelper.browser.interlock((count) => console.log(count))` |
-
-## Description
-
-Comprehensive browser management tool that provides:
-- **History Navigation** - Push state, go forward/back, reload
-- **URL Management** - Navigate to specific URLs
-- **Connection Monitoring** - Detect online/offline status
-- **Display Information** - Get zoom level, HTTP status descriptions
-- **Multi-tab Detection** - Monitor concurrent tab usage
-
-## Usage Examples
-
-### Changing URL Without Reload (SPA Routing)
-
-```javascript
-// Add a new history entry without page reload
-dphelper.browser.state({ page: 'dashboard', userId: 123 }, 'Dashboard', '/dashboard');
-
-// The browser's back button will now work
-window.addEventListener('popstate', (event) => {
-  console.log('Navigated to:', event.state);
-});
-```
-
-### Programmatic Navigation
-
-```javascript
-// Navigate to a specific URL
-dphelper.browser.href('/search?q=javascript');
-
-// Navigate to external site
-dphelper.browser.href('https://google.com');
-
-// Go forward 2 pages in history
-dphelper.browser.forw(2);
-
-// Go back 1 page in history
-dphelper.browser.back(1);
-
-// Reload the page
-dphelper.browser.reload();
-```
-
-### Offline Detection Overlay
-
-```javascript
-// Show default offline message
-dphelper.browser.offLine();
-
-// Show custom offline message (text is sanitized for security)
-dphelper.browser.offLine('⚠️ Connection Lost. Please check your internet.');
-
-// The overlay appears automatically when offline
-// and disappears when connection is restored
-```
-
-### Get Browser Zoom Level
-
-```javascript
-const zoom = dphelper.browser.zoom();
-console.log(zoom); // 100 (or 150, 200, etc. depending on zoom)
-
-// Responsive design based on zoom
-if (zoom > 100) {
-  document.body.classList.add('zoomed-in');
-}
-```
-
-### HTTP Status Code Descriptions
-
-```javascript
-// Get description for common status codes
-console.log(dphelper.browser.status(200)); // "200 OK"
-console.log(dphelper.browser.status(201)); // "201 Created"
-console.log(dphelper.browser.status(301)); // "301 Moved Permanently"
-console.log(dphelper.browser.status(400)); // "400 Bad Request"
-console.log(dphelper.browser.status(401)); // "401 Unauthorized"
-console.log(dphelper.browser.status(403)); // "403 Forbidden"
-console.log(dphelper.browser.status(404)); // "404 Not Found"
-console.log(dphelper.browser.status(500)); // "500 Internal Server Error"
-
-// Display user-friendly error messages
-function handleApiError(statusCode) {
-  const message = dphelper.browser.status(statusCode);
-  alert(`Error: ${message}`);
-}
-```
-
-### Multi-Tab Synchronization
-
-```javascript
-// Monitor active tabs of your application
-dphelper.browser.interlock((tabCount) => {
-  console.log(`Active tabs: ${tabCount}`);
-
-  if (tabCount > 1) {
-    // Warn user about multiple tabs
-    showNotification('This app is open in multiple tabs. Changes may conflict.');
-  }
-});
-
-// Use BroadcastChannel for real-time sync between tabs
-const channel = new BroadcastChannel('app_sync');
-channel.postMessage({ type: 'UPDATE', data: 'new value' });
-```
-
-## Advanced Usage
-
-### Complete SPA Navigation Handler
-
-```javascript
-class Router {
-  constructor() {
-    this.routes = {};
-
-    // Handle browser back/forward
-    window.addEventListener('popstate', (e) => {
-      this.navigate(window.location.pathname, false);
-    });
-  }
-
-  addRoute(path, handler) {
-    this.routes[path] = handler;
-  }
-
-  navigate(path, addToHistory = true) {
-    const handler = this.routes[path];
-    if (handler) {
-      if (addToHistory) {
-        dphelper.browser.state({ path }, 'App', path);
-      }
-      handler();
-    }
-  }
-}
-
-// Usage
-const router = new Router();
-router.addRoute('/', () => renderHome());
-router.addRoute('/about', () => renderAbout());
-router.addRoute('/dashboard', () => renderDashboard());
-```
-
-### Connection Status Manager
-
-```javascript
-class ConnectionManager {
-  constructor() {
-    this.isOnline = navigator.onLine;
-    this.listeners = [];
-
-    window.addEventListener('online', () => {
-      this.isOnline = true;
-      this.notifyListeners();
-    });
-
-    window.addEventListener('offline', () => {
-      this.isOnline = false;
-      this.notifyListeners();
-    });
-
-    // Show offline overlay
-    dphelper.browser.offLine('🔌 You are offline. Some features are disabled.');
-  }
-
-  onStatusChange(callback) {
-    this.listeners.push(callback);
-  }
-
-  notifyListeners() {
-    this.listeners.forEach(cb => cb(this.isOnline));
-  }
-}
-```
-
-## Details
-
-- **Author:** Dario Passariello
-- **Version:** 0.0.2
-- **Creation Date:** 20210101
-- **Last Modified:** 20260220
-- **Environment:** Client-side only (browser)
-
----
-
-*Automatically generated document*

package/markdown/check.md

@@ -1,65 +0,0 @@
-# check
-
-Validation utilities for version comparison and other checks.
-
-## Functions
-
-| Function | Description | Example |
-|----------|-------------|---------|
-| `version` | Compare two version strings | `dphelper.check.version('1.2.0', '1.1.0')` |
-
-## Description
-
-Version comparison utilities:
-- **Semantic Versioning** - Compare version numbers
-- **Custom Options** - Lexicographic and zero-pad support
-
-## Usage Examples
-
-### Version Comparison
-
-```javascript
-// Compare versions
-console.log(dphelper.check.version('1.2.0', '1.1.0'));  // 1 (v1 > v2)
-console.log(dphelper.check.version('1.1.0', '1.2.0'));  // -1 (v1 < v2)
-console.log(dphelper.check.version('1.0.0', '1.0.0'));  // 0 (equal)
-
-// With zero padding
-console.log(dphelper.check.version('1.2', '1.2.0', { zero: true })); // 0
-
-// With lexicographic comparison
-console.log(dphelper.check.version('1.0.0a', '1.0.0b', { lex: true })); // -1
-```
-
-### Software Update Checker
-
-```javascript
-function checkForUpdate(currentVersion, latestVersion) {
-  const result = dphelper.check.version(currentVersion, latestVersion);
-
-  if (result === 1) {
-    console.log('Update available!');
-    return 'Update available';
-  } else if (result === 0) {
-    console.log('You have the latest version.');
-    return 'Up to date';
-  } else {
-    console.log('You are on a newer version.');
-    return 'Ahead';
-  }
-}
-
-checkForUpdate('1.0.0', '1.1.0'); // "Update available!"
-```
-
-## Details
-
-- **Author:** Dario Passariello
-- **Version:** 0.0.2
-- **Creation Date:** 20240829
-- **Last Modified:** 20240829
-- **Environment:** Works in both client and server environments
-
----
-
-*Automatically generated document*

package/markdown/color.md

@@ -1,159 +0,0 @@
-# color
-
-Color manipulation utilities for converting between color formats and generating color gradients.
-
-## Functions
-
-| Function | Description | Example |
-|----------|-------------|---------|
-| `hex` | Converts a number (0-255) to hexadecimal | `dphelper.color.hex(255)` |
-| `toHex` | Converts RGB array to hex string | `dphelper.color.toHex([255, 128, 0])` |
-| `toRGB` | Converts hex string to RGB array | `dphelper.color.toRGB('#ff8000')` |
-| `oleColor` | Converts hex to OLE color format | `dphelper.color.oleColor('#ffffff')` |
-| `gradient` | Generates gradient between two colors | `dphelper.color.gradient('#ff0000', '#0000ff', 10)` |
-
-## Description
-
-Comprehensive color manipulation tools:
-- **Format Conversion** - RGB ↔ Hex, OLE color format
-- **Gradient Generation** - Create smooth color transitions
-- **Number Formatting** - Convert color values to hex
-
-## Usage Examples
-
-### Number to Hex
-
-```javascript
-// Convert a number to 2-digit hex
-console.log(dphelper.color.hex(0));   // "00"
-console.log(dphelper.color.hex(255)); // "ff"
-console.log(dphelper.color.hex(128)); // "80"
-
-// Clamps values outside 0-255
-console.log(dphelper.color.hex(300)); // "ff"
-console.log(dphelper.color.hex(-10)); // "00"
-```
-
-### RGB to Hex Conversion
-
-```javascript
-// Convert RGB array to hex
-console.log(dphelper.color.toHex([255, 255, 255])); // "ffffff"
-console.log(dphelper.color.toHex([255, 0, 0]));     // "ff0000"
-console.log(dphelper.color.toHex([0, 255, 0]));     // "00ff00"
-console.log(dphelper.color.toHex([0, 0, 255]));     // "0000ff"
-console.log(dphelper.color.toHex([255, 128, 0]));   // "ff8000"
-
-// Common colors
-const orange = [255, 165, 0];
-console.log('#' + dphelper.color.toHex(orange)); // "#ffa500"
-```
-
-### Hex to RGB Conversion
-
-```javascript
-// Convert hex to RGB array
-console.log(dphelper.color.toRGB('#ffffff')); // [255, 255, 255]
-console.log(dphelper.color.toRGB('#ff0000')); // [255, 0, 0]
-console.log(dphelper.color.toRGB('#00ff00')); // [0, 255, 0]
-console.log(dphelper.color.toRGB('#0000ff')); // [0, 0, 255]
-
-// Without hash
-console.log(dphelper.color.toRGB('ff8000')); // [255, 128, 0]
-```
-
-### OLE Color Conversion
-
-```javascript
-// Convert to OLE color (used in older Windows APIs)
-console.log(dphelper.color.oleColor('#000000')); // "0"
-console.log(dphelper.color.oleColor('#ffffff')); // "16777215"
-console.log(dphelper.color.oleColor('#ff0000')); // "255"
-console.log(dphelper.color.oleColor('#00ff00')); // "65280"
-console.log(dphelper.color.oleColor('#0000ff')); // "16711680"
-```
-
-### Gradient Generation
-
-```javascript
-// Generate gradient from red to blue
-const gradient = dphelper.color.gradient('#ff0000', '#0000ff', 10);
-console.log(gradient);
-// ["ff0000", "e61b1b", "cc3636", "b35151", "996c6c", "808080", "669696", "4dabab", "33c0c0", "1ad6d6", "0000ff"]
-
-// Useful for creating color scales
-const heatmapColors = dphelper.color.gradient('#0000ff', '#ff0000', 20);
-
-// Cool to warm gradient
-const sunrise = dphelper.color.gradient('#ff9a9e', '#fecfef', 15);
-```
-
-## Advanced Usage
-
-### Color Utilities Class
-
-```javascript
-class ColorUtils {
-  static random() {
-    const r = Math.floor(Math.random() * 256);
-    const g = Math.floor(Math.random() * 256);
-    const b = Math.floor(Math.random() * 256);
-    return '#' + dphelper.color.toHex([r, g, b]);
-  }
-
-  static invert(hex) {
-    const [r, g, b] = dphelper.color.toRGB(hex);
-    return '#' + dphelper.color.toHex([255 - r, 255 - g, 255 - b]);
-  }
-
-  static lighten(hex, percent) {
-    const [r, g, b] = dphelper.color.toRGB(hex);
-    return '#' + dphelper.color.toHex([
-      Math.min(255, Math.floor(r + (255 - r) * percent)),
-      Math.min(255, Math.floor(g + (255 - g) * percent)),
-      Math.min(255, Math.floor(b + (255 - b) * percent))
-    ]);
-  }
-
-  static darken(hex, percent) {
-    const [r, g, b] = dphelper.color.toRGB(hex);
-    return '#' + dphelper.color.toHex([
-      Math.max(0, Math.floor(r * (1 - percent))),
-      Math.max(0, Math.floor(g * (1 - percent))),
-      Math.max(0, Math.floor(b * (1 - percent)))
-    ]);
-  }
-}
-
-// Usage
-console.log(ColorUtils.random());      // "#a3b21c"
-console.log(ColorUtils.invert('#ff0000')); // "#00ffff"
-console.log(ColorUtils.lighten('#888888', 0.2)); // "#adadad"
-console.log(ColorUtils.darken('#888888', 0.2)); // "#636363"
-```
-
-### Dynamic Chart Colors
-
-```javascript
-function generateChartColors(count) {
-  const colors = [];
-  for (let i = 0; i < count; i++) {
-    const hue = (i * 360 / count) % 360;
-    const rgb = this.hslToRgb(hue, 70, 50);
-    colors.push('#' + dphelper.color.toHex(rgb));
-  }
-  return colors;
-}
-```
-
-## Details
-
-- **Author:** Dario Passariello
-- **Version:** 0.0.2
-- **Creation Date:** 20210101
-- **Last Modified:** 20260220
-- **Environment:** Client-side only (browser)
-
----
-
-*Automatically generated document*