dphelper 1.9.84 → 1.9.86

package/docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-modernist

package/docs/index.md

@@ -0,0 +1,374 @@
+# [dphelper](https://npmjs.com/package/dphelper)
+
+![dpHelper](https://raw.githubusercontent.com/passariello/container/refs/heads/main/dphelper/assets/images/banner.svg)
+
+**Manager | DevTools** by [Dario Passariello](https://dario.passariello.ca) (c)
+
+[![version](https://img.shields.io/npm/v/dphelper.svg)](https://npmjs.org/package/dphelper)
+[![downloads](https://img.shields.io/npm/dm/dphelper.svg)](https://npmjs.org/package/dphelper)
+
+![jQuery](https://img.shields.io/badge/jQuery-gray?logo=jQuery)
+![Javascript](https://img.shields.io/badge/Javascript-gray?logo=Javascript)
+![React](https://img.shields.io/badge/React-gray?logo=React)
+![TypeScript](https://img.shields.io/badge/TypeScript-gray?logo=typescript)
+
+![Node.js](https://img.shields.io/badge/Node.js-gray?logo=node.js)
+![Jest](https://img.shields.io/badge/Jest-gray?logo=jest)
+![ESLint](https://img.shields.io/badge/ESLint-gray?logo=eslint)
+![webpack](https://img.shields.io/badge/webpack-gray?logo=webpack)
+
+![License](https://img.shields.io/badge/license-MIT-blue.svg)
+
+[![GitBook](https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1)](https://a51.gitbook.io/dphelper)
+
+[![NPM](https://nodei.co/npm/dphelper.png?stars=true&downloads=true)](https://www.npmjs.com/package/dphelper?activeTab=readme)
+
+## Table of Contents
+
+1. [About](#about)
+2. [Installation](#install)
+3. [Live Demo](#live-demo)
+4. [Documentation](#documentation)
+   1. [State](#state)
+   2. [Store](#store)
+   3. [Session](#session)
+   4. [Observer](#observer)
+   5. [useObserver](#useobserver)
+5. [Extension](#extension)
+6. [Security](#security)
+7. [License](#license)
+
+## About
+
+dpHelper is a precise and complete collection of 190+ tools ready to use in all web/SaaS applications. State and Store Management are now easy, accessible everywhere in your application, including Ajax or React apps, without the need for extra files.
+
+1. **Single Source of Truth**: The application's entire state is held within a single object in one store, ensuring consistent and accessible state management throughout the app.
+
+2. **State is flexible**: State changes are facilitated exclusively through actions. These actions, which are straightforward JavaScript objects, delineate what has occurred. This methodology ensures that state changes remain predictable.
+
+3. **Changes are made with proxy handle function**: To define state changes, dpHelper employs pure functions as intermediaries. These functions accept the current state as input and produce a new state as output, ensuring predictability and ease of testing in the system.
+
+4. **Based on [Memorio](https://www.npmjs.com/package/memorio) by Dario Passariello** to manage STATE, STORE, SESSION and OBSERVER. You can use Memorio is you need only state management. DpHelper is indicate when you use a complete suite of tools.
+
+### 1. Example in React
+
+```js
+import { useEffect } from 'react';
+import 'dphelper';
+
+  function App() {
+    // Store a value in the state
+    state.test = 'Hello, World!';
+
+    // Use the stored value in a React component
+    useEffect(() => {
+      console.log("You can recall from all pages: " + state.test); // Output: "Hello, World!"
+    }, []);
+
+    return (
+      <div>
+        <h1>{state.test}</h1>
+      </div>
+    );
+  }
+
+export default App;
+```
+
+## Install
+
+Install dpHelper.
+
+```shell
+npm i dphelper --save-dev
+```
+
+or update:
+
+```shell
+npm i dphelper@latest --save-dev
+```
+
+Use it in the main root file (and only there):
+
+```js
+import "dphelper";
+```
+
+or
+
+```js
+require("dphelper");
+```
+
+## Install for EJS or Other Types of Projects (like HTML)
+
+Note: You don't need to use npm install in this case, or you will get an error.
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/dphelper"></script>
+```
+
+## Live Demo
+
+[https://tests.a51.dev/](https://tests.a51.dev/)
+
+You can see an HTML version where dpHelper and LayerPro work together seamlessly. dpHelper is compatible with a variety of frontend libraries, including:
+
+* HTML
+* React
+* Vue
+* And any other frontend library
+
+## Documentation
+
+You can see:
+
+* [State](https://a51.gitbook.io/dphelper/general/state)
+* [Store](https://a51.gitbook.io/dphelper/general/store)
+* [Observer](https://a51.gitbook.io/dphelper/general/observer)
+* [useObserver](https://a51.gitbook.io/dphelper/general/useobserver)
+* [List of functions](https://a51.gitbook.io/dphelper/general/tools)
+
+You can see more tutorials, information, and examples about **dpHelper** [clicking here](https://a51.gitbook.io/dphelper).
+
+## State
+
+### Using the "state" Function
+
+You can use the state function to store and reuse data throughout your application. Similar to other state managers, you can save state information in JSON format and access it easily in various contexts, including React useEffect and/or dispatch.
+
+For example, you can store a value like this: _state.test = 'I am ready'_ and then retrieve it later using state.test.
+
+_example:_
+
+You can use the browser's devtools console and type " **state.test = 'I am ready'** ". Every time you want to use '**test**' values, you need just recall **state.test**.
+
+```js
+// Set a state
+state.test = "I am ready" *
+
+// Get the state
+state.test *
+
+// List all states
+state.list // or just "state" to see the proxy
+
+// Lock a state from edit (Only for Objects or Array)
+state.test.lock() *
+
+// Remove a state
+state.remove("test")
+
+// Remove all states
+state.removeAll()
+
+*["test" is only an example]
+
+```
+
+### Observer
+
+**Note**: _Observer works only with states. Stores are excluded at the moment._
+
+If you want to run a function every time a state changes, you can use:
+
+```js
+/**
+* Observer is a non-cumulative listener,
+* triggered from customEvent / dispatch from state
+* @parameters
+* [ state | store, function ]
+*/
+observer( "state.test", () => alert("Test Changes to: " + state.test) )
+          |__________|  |___________________________________________|
+          State: string                   Function
+
+PS: you need to use the name of state | store as string
+```
+
+You can use it everywhere. Works like "useState" in React but with more flexibility (use one observer for each state!).
+
+### Example
+
+```js
+import 'dphelper';
+
+// Use the observer to log the changing state value
+observer(
+  'state.count',
+  () => console.log("State changed: ", state.count)
+);
+
+// Store a value in the state that changes every 5 seconds
+setInterval(() => state.count = Date.now(), 5000);
+```
+
+> NOTE: In some cases you need to wrap inside and useEffect in React to avoid multiple observers
+
+#### Another Simple Example
+
+```js
+import 'dphelper';
+
+// Set a state
+state.myData = 'Hello, world!';
+
+// Retrieve the state
+console.log(state.myData); // Output: Hello, world!
+
+// Observe state changes
+observer('myData', () => {
+  console.log('myData has changed to:', state.myData);
+});
+
+// Change the state
+state.myData = 'New value';
+```
+
+## useObserver
+
+```js
+import 'dphelper';
+
+// Use the useObserver to log the changing state value
+useObserver(
+  () => console.log("State changed: ", state.count)
+  , 'state.count'
+);
+
+// Store a value in the state that changes every 5 seconds
+setInterval(() => state.count = Date.now(), 5000);
+```
+
+## Store
+
+### Persistent Storage with dpHelper
+
+When using dpHelper for permanent storage, you should use the **store**, which stores data persistently across sessions.
+
+#### Important Security Note
+
+1. **Use store for persistent storage:** If you want to store data permanently, use store to ensure it is saved in localStorage.
+
+2. **Remove data when necessary:** To maintain security, remove stored data when it is no longer needed, such as during logout.
+
+3. **Remove all stored data:** Use store.removeAll() to securely remove all stored data from your application.
+
+```js
+// Set a store:
+store.set("test", { test: "test" })
+
+// Get a store:
+store.get("test") // Output: { test: "test" }
+
+// Remove a store:
+store.remove("test") // Output: "ok"
+
+// Remove all stores:
+store.removeAll() // Output: "ok"
+```
+
+### 2. Example in React
+
+```js
+import { useEffect } from 'react';
+import 'dphelper';
+
+function App() {
+
+  // Store a value in the store (persistent storage)
+  store.set(
+    'user',
+    {
+      name: 'John Doe',
+      age: 30
+    }
+  );
+
+  // Use the stored value in a React component
+  useEffect(
+    () => {
+      console.log(store.get("user")); // Output: { name: "John Doe", age: 30 }
+      $("#name").text(store.get("user").name)
+    }, []
+  );
+
+  // Remove all stored data if necessary
+  // store.removeAll();
+
+  return (
+    <div>
+      <h1 id="name">...</h1>
+    </div>
+  );
+}
+
+export default App;
+```
+
+## session
+
+Similar to store but it's removed when you close the browser.
+For more performance it's better to use state over session. State is global and access to data is more faster and not require the time to resolve promises.
+
+```js
+// Set a store:
+store.set("test", { test: "test" })
+
+// Get a store:
+store.get("test") // Output: { test: "test" }
+
+// Remove a store:
+store.remove("test") // Output: "ok"
+
+// Remove all stores:
+store.removeAll() // Output: "ok"
+```
+
+## Extension
+
+Type **dphelper** in the devtool console of your browser to have a look at all available tools that you can use! You can call these from everywhere without import (just one time in the main/root page).
+
+## Browser Extension (Chrome/Edge) ♥️
+
+![browser extension](https://img.shields.io/badge/browser%20extension-beta-orange.svg)
+
+![dphelper Banner](https://raw.githubusercontent.com/passariello/container/refs/heads/main/dphelper/assets/images/banner.png)
+
+![dphelper Banner](https://raw.githubusercontent.com/passariello/container/refs/heads/main/dphelper/assets/images/screenshot.png)
+
+Chrome: [Download from Google Web Store](https://chrome.google.com/webstore/detail/dphelper-manager-dev-tool/oppppldaoknfddeikfloonnialijngbk)
+
+Edge: [Download from Microsoft Addons](https://microsoftedge.microsoft.com/addons/detail/dphelper-manager-dev-to/kphabkbdpaljlfagldhojilhfammepnk)
+
+PS: **dpHelper** is compatible with all Chromium-based browsers like **Edge or Brave**!
+
+## dpHelper Browser Extension
+
+The dpHelper browser extension allows you to manage your application's dpHelper NPM. Key features include:
+
+1. Simplified API operations: Easily manage and manipulate data with dpHelper's collection of scripts.
+2. Real-time monitoring: Track memory usage and localStorage to optimize your application's performance.
+3. Stay up-to-date: Receive updates and tips to improve your daily workflow.
+4. Easy installation: Simply import 'dphelper' in your project index to get started.
+5. Global accessibility: All scripts are available globally and can be accessed from anywhere in your application.
+
+## Security
+
+[Socket.dev](https://socket.dev/npm/package/dphelper)
+
+[Snyk.io](https://security.snyk.io/package/npm/dphelper)
+
+## License
+
+[MIT - https://en.wikipedia.org/wiki/MIT_License](https://en.wikipedia.org/wiki/MIT_License)
+
+* [LICENSE](https://a51.gitbook.io/dphelper/documents/license)
+* [CODE OF CONDUCT](https://a51.gitbook.io/dphelper/documents/code_of_conduct)
+* [SECURITY](https://a51.gitbook.io/dphelper/documents/security)
+* [CONTRIBUTING](https://a51.gitbook.io/dphelper/documents/contributing)
+
+---
+
+Dario Passariello - <dariopassariello@gmail.com>, All rights reserved - Copyright (c) 2019 - 2025

package/documents/OBSERVER.md

@@ -0,0 +1,67 @@
+# Observer
+
+## Overview
+
+This document provides a comprehensive list of all available observer functions in the `dphelper` library along with their descriptions and examples.
+
+## Functions
+
+### observer([state.name], [function])
+
+- **Description:** Sets up an observer to monitor state changes and trigger a callback.
+- **Parameters:**
+  - `stateName` (string): The name of the state to monitor.
+  - `callBack` (Function): The callback function to run when the state changes.
+  - `option` (object): Additional options for the observer.
+- **Example:**
+
+  ```javascript
+  observer('state.test', (newValue) => {
+    console.log('State changed:', newValue);
+  });
+  ```
+
+### observer([state.name])
+
+- **Description:** Recall the observer previously generated.
+- **Returns:** Console log with a note
+- **Example:**
+
+  ```javascript
+  observer('state.test');
+  ```
+
+### observer.list
+
+- **Description:** See the list of all your observer (eventListener) actually installed.
+- **Returns:** The list of all installed observers.
+- **Example:**
+
+  ```javascript
+  observer.list;
+  ```
+
+### remove
+
+- **Description:** Remove an observer.
+- **Parameters:**
+  - `name` (string): The name of the observer to remove.
+- **Example:**
+
+  ```javascript
+  observer.remove('state.test');
+  ```
+
+### removeAll
+
+- **Description:** Remove all observers.
+- **Returns:** void
+- **Example:**
+
+  ```javascript
+  observer.removeAll();
+  ```
+
+## License
+
+This project is licensed under the MIT License.

package/documents/SESSION.md

@@ -0,0 +1,58 @@
+# dpHelper Session
+
+## Overview
+
+This document provides a comprehensive list of all available session functions in the `dphelper` library along with their descriptions and examples.
+
+**Based on [Memorio](https://www.npmjs.com/package/memorio) by Dario Passariello** to manage STATE, STORE, SESSION and OBSERVER. You can use Memorio is you need only state management. DpHelper is indicate when you use a complete suite of tools.
+
+## Functions
+
+### session.get([session.name])
+
+- **Description:** Retrieve an item from session storage.
+- **Parameters:**
+  - `name` (string): The name of the item to retrieve.
+- **Example:**
+
+  ```javascript
+  const value = session.get('itemName');
+  console.log(value);
+  ```
+
+### session.set([name, value])
+
+- **Description:** Set an item in session storage.
+- **Parameters:**
+  - `name` (string): The name of the item to set.
+  - `value` (any): The value of the item to set.
+- **Example:**
+
+  ```javascript
+  session.set('itemName', value);
+  ```
+
+### session.remove([session.name])
+
+- **Description:** Delete an item from session storage.
+- **Parameters:**
+  - `name` (string): The name of the item to delete.
+- **Example:**
+
+  ```javascript
+  session.remove('itemName');
+  ```
+
+### session.removeAll()
+
+- **Description:** Remove all items from session storage.
+- **Parameters:** None
+- **Example:**
+
+  ```javascript
+  session.removeAll();
+  ```
+
+## License
+
+This project is licensed under the MIT License.

package/documents/STATE.md

@@ -0,0 +1,69 @@
+# dpHelper State
+
+## Overview
+
+This document provides a comprehensive list of all available state functions in the `dphelper` library along with their descriptions and examples.
+
+**Based on [Memorio](https://www.npmjs.com/package/memorio) by Dario Passariello** to manage STATE, STORE, SESSION and OBSERVER. You can use Memorio is you need only state management. DpHelper is indicate when you use a complete suite of tools.
+
+## Functions
+
+### state.[state.name] ex: _state.test_
+
+- **Description:** Set and get state values.
+- **Example:**
+
+  ```javascript
+  // To set a state value
+  state.name = 'value';
+
+  // To get a state value
+  const value = state.name;
+  ```
+
+### state.list
+
+- **Description:** Show all states out of proxy.
+- **Example:**
+
+  ```javascript
+  state.list;
+  ```
+
+### state.remove([state.name])
+
+- **Description:** Remove a state.
+- **Parameters:**
+  - `name` (string): The name of the state to remove.
+- **Example:**
+
+  ```javascript
+  state.remove('stateName');
+  ```
+
+### state.name.lock()
+
+- **Description:** Lock a state (only for types: Array, Object).
+- **Example:**
+
+  ```javascript
+  state.name = {test:"test"}
+  state.name.lock();
+  "Now you can't add more data or remove it"
+  ```
+
+### state.removeAll()
+
+- **Description:** Remove all states.
+- **Example:**
+
+  ```javascript
+  state.name = {test:"test"}
+  state.removeAll();
+  "Now you can't see state.name (all states are removed)"
+  "Use for Log-out / Sign-out operation"
+  ```
+
+## License
+
+This project is licensed under the MIT License.

package/documents/STORE.md

@@ -0,0 +1,80 @@
+# dpHelper Store
+
+## Overview
+
+This document provides a comprehensive list of all available store functions in the `dphelper` library along with their descriptions and examples.
+
+**Based on [Memorio](https://www.npmjs.com/package/memorio) by Dario Passariello** to manage STATE, STORE, SESSION and OBSERVER. You can use Memorio is you need only state management. DpHelper is indicate when you use a complete suite of tools.
+
+## Functions
+
+### store.get([store.name])
+
+- **Description:** Retrieve an item from local storage.
+- **Parameters:**
+  - `name` (string): The name of the item to retrieve.
+- **Example:**
+
+  ```javascript
+  const value = store.get('itemName');
+  console.log(value);
+  ```
+
+### store.set([name, value])
+
+- **Description:** Set an item in local storage.
+- **Parameters:**
+  - `name` (string): The name of the item to set.
+  - `value` (any): The value of the item to set.
+- **Example:**
+
+  ```javascript
+  store.set('itemName', value);
+  ```
+
+### store.remove([store.name])
+
+- **Description:** Delete an item from local storage.
+- **Parameters:**
+  - `name` (string): The name of the item to delete.
+- **Example:**
+
+  ```javascript
+  store.remove('itemName');
+  ```
+
+### store.removeAll()
+
+- **Description:** Remove all items from local storage.
+- **Parameters:** None
+- **Example:**
+
+  ```javascript
+  store.removeAll();
+  ```
+
+### store.quota()
+
+- **Description:** Estimate the storage quota and usage.
+- **Parameters:** None
+- **Example:**
+
+  ```javascript
+  const quota = store.quota();
+  console.log(quota);
+  ```
+
+### store.size()
+
+- **Description:** Calculate the total size of all items in local storage.
+- **Parameters:** None
+- **Example:**
+
+  ```javascript
+  const totalSize = store.size();
+  console.log(totalSize);
+  ```
+
+## License
+
+This project is licensed under the MIT License.