dphelper 1.9.27 → 1.9.30

package/CODE_OF_CONDUCT.md

@@ -13,20 +13,20 @@ appearance, race, religion, or sexual identity and orientation.
 
 ## Our Standards
 
-Examples of behaviour that contributes to a positive environment for our
+Examples of behavior that contributes to a positive environment for our
 community include:
 
 * Demonstrating empathy and kindness toward other people
 * Being respectful of differing opinions, viewpoints, and experiences
 * Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologising to those affected by our mistakes,
+* Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
 * Focusing on what is best not just for us as individuals, but for the
   overall community
 
-Examples of unacceptable behaviour include:
+Examples of unacceptable behavior include:
 
-* The use of sexualised language or imagery, and sexual attention or advances
+* The use of sexualized language or imagery, and sexual attention or advances
 * Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
 * Publishing others' private information, such as a physical or email
@@ -37,8 +37,8 @@ Examples of unacceptable behaviour include:
 ## Our Responsibilities
 
 Project maintainers are responsible for clarifying and enforcing our standards of
-acceptable behaviour and will take appropriate and fair corrective action in
-response to any behaviour that they deem inappropriate,
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate,
 threatening, offensive, or harmful.
 
 Project maintainers have the right and responsibility to remove, edit, or reject
@@ -56,7 +56,7 @@ representative at an online or offline event.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behaviour may be
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at <dariopassariello@gmail.com>.
 All complaints will be reviewed and investigated promptly and fairly.
 
@@ -70,19 +70,19 @@ the consequences for any action they deem in violation of this Code of Conduct:
 
 ### 1. Correction
 
-**Community Impact**: Use of inappropriate language or other behaviour deemed
+**Community Impact**: Use of inappropriate language or other behavior deemed
 unprofessional or unwelcome in the community.
 
 **Consequence**: A private, written warning from community leaders, providing
 clarity around the nature of the violation and an explanation of why the
-behaviour was inappropriate. A public apology may be requested.
+behavior was inappropriate. A public apology may be requested.
 
 ### 2. Warning
 
 **Community Impact**: A violation through a single incident or series
 of actions.
 
-**Consequence**: A warning with consequences for continued behaviour. No
+**Consequence**: A warning with consequences for continued behavior. No
 interaction with the people involved, including unsolicited interaction with
 those enforcing the Code of Conduct, for a specified period of time. This
 includes avoiding interactions in community spaces as well as external channels
@@ -92,7 +92,7 @@ permanent ban.
 ### 3. Temporary Ban
 
 **Community Impact**: A serious violation of community standards, including
-sustained inappropriate behaviour.
+sustained inappropriate behavior.
 
 **Consequence**: A temporary ban from any sort of interaction or public
 communication with the community for a specified period of time. No public or
@@ -103,7 +103,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behaviour, harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within

package/CONTRIBUTING.md

@@ -46,8 +46,8 @@ We will then take care of the issue as soon as possible.
 
 ## I Want To Contribute
 
-> #### Legal Notice
->
+### Legal Notice
+
 > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence.
 
 ### Reporting Bugs
@@ -107,4 +107,4 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/a51-de
 
 ## Join The Project Team
 
-Please send email to dariopassariello@gmail.com
+Please send email to <dariopassariello@gmail.com>

package/HISTORY.md

@@ -1 +1 @@
-none
+# empty

package/LICENSE.md

@@ -1,9 +1,21 @@
-MIT License
+# MIT License
 
-Copyright (c) 2019 Dario Passariello
+Copyright (c) 2019 Dario Passariello - <dariopassariello@gmail.com>
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -6,9 +6,12 @@
 
 [![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)
-[![dphelper](https://snyk.io/advisor/npm-package/dphelper/badge.svg)](https://snyk.io/advisor/npm-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)
@@ -18,10 +21,19 @@
 
 [![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)
 
-<!--
-[![dphelper](https://snyk.io/advisor/npm-package/dphelper/badge.svg)](https://snyk.io/advisor/npm-package/dphelper)
-[![Socket Badge](https://socket.dev/api/badge/npm/package/dphelper)](https://socket.dev/npm/package/dphelper)
--->
+## Table of Contents
+
+1. [About](#about)
+2. [Live Demo](#live-demo)
+3. [Installation](#install)
+4. [Documentation](#documentation)
+   1. [State](#state)
+   2. [Store](#store)
+   3. [Session](#session)
+   4. [Observer](#observer)
+5. [Extension](#extension)
+6. [Security](#security)
+7. [License](#license)
 
 ## About
 
@@ -33,6 +45,8 @@ dpHelper is a precise and complete collection of 190+ tools ready to use in all
 
 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
@@ -80,7 +94,7 @@ You can see:
 
 You can see more tutorials, information, and examples about **dpHelper** [clicking here](https://a51.gitbook.io/dphelper).
 
-## Usage
+## Install
 
 Install dpHelper.
 
@@ -114,7 +128,7 @@ Note: You don't need to use npm install in this case, or you will get an error.
 <script src="https://cdn.jsdelivr.net/npm/dphelper"></script>
 ```
 
-## The Best Way To Use State
+## State
 
 ### Using the "state" Function
 
@@ -149,7 +163,7 @@ state.removeAll()
 
 ```
 
-### Observer for States
+### Observer
 
 **Note**: _Observer works only with states. Stores are excluded at the moment._
 
@@ -186,6 +200,8 @@ observer(
 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
@@ -206,7 +222,7 @@ observer('myData', () => {
 state.myData = 'New value';
 ```
 
-## The Best Way To Use Store 🫙
+## Store
 
 ### Persistent Storage with dpHelper
 
@@ -272,7 +288,26 @@ function App() {
 export default App;
 ```
 
-## Console It
+## 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).
 
@@ -300,7 +335,7 @@ The dpHelper browser extension allows you to manage your application's dpHelper
 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.
 
-## Check
+## Security
 
 [Socket.dev](https://socket.dev/npm/package/dphelper)
 

package/SECURITY.md

@@ -1,3 +1,3 @@
 # Security
 
-Please email [@passariello](https://github.com/passariello) or see https://dario.passariello.ca/contact/ if you have a potential security vulnerability to report.
+Please email [@passariello](https://github.com/passariello) or see <https://dario.passariello.ca/contact/> if you have a potential security vulnerability to report.

package/SUMMARY.md

@@ -7,6 +7,7 @@
 * [State](/documents/STATE.md)
 * [Observer](/documents/OBSERVER.md)
 * [Store](/documents/STORE.md)
+* [Session](/documents/SESSION.md)
 * [All Functions](/documents/TOOLS.md)
 
 ## documents

package/docs/index.md

@@ -6,9 +6,12 @@
 
 [![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)
-[![dphelper](https://snyk.io/advisor/npm-package/dphelper/badge.svg)](https://snyk.io/advisor/npm-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)
@@ -18,10 +21,19 @@
 
 [![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)
 
-<!--
-[![dphelper](https://snyk.io/advisor/npm-package/dphelper/badge.svg)](https://snyk.io/advisor/npm-package/dphelper)
-[![Socket Badge](https://socket.dev/api/badge/npm/package/dphelper)](https://socket.dev/npm/package/dphelper)
--->
+## Table of Contents
+
+1. [About](#about)
+2. [Live Demo](#live-demo)
+3. [Installation](#install)
+4. [Documentation](#documentation)
+   1. [State](#state)
+   2. [Store](#store)
+   3. [Session](#session)
+   4. [Observer](#observer)
+5. [Extension](#extension)
+6. [Security](#security)
+7. [License](#license)
 
 ## About
 
@@ -33,6 +45,8 @@ dpHelper is a precise and complete collection of 190+ tools ready to use in all
 
 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
@@ -80,7 +94,7 @@ You can see:
 
 You can see more tutorials, information, and examples about **dpHelper** [clicking here](https://a51.gitbook.io/dphelper).
 
-## Usage
+## Install
 
 Install dpHelper.
 
@@ -114,7 +128,7 @@ Note: You don't need to use npm install in this case, or you will get an error.
 <script src="https://cdn.jsdelivr.net/npm/dphelper"></script>
 ```
 
-## The Best Way To Use State
+## State
 
 ### Using the "state" Function
 
@@ -149,7 +163,7 @@ state.removeAll()
 
 ```
 
-### Observer for States
+### Observer
 
 **Note**: _Observer works only with states. Stores are excluded at the moment._
 
@@ -186,6 +200,8 @@ observer(
 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
@@ -206,7 +222,7 @@ observer('myData', () => {
 state.myData = 'New value';
 ```
 
-## The Best Way To Use Store 🫙
+## Store
 
 ### Persistent Storage with dpHelper
 
@@ -272,7 +288,26 @@ function App() {
 export default App;
 ```
 
-## Console It
+## 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).
 
@@ -300,7 +335,7 @@ The dpHelper browser extension allows you to manage your application's dpHelper
 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.
 
-## Check
+## Security
 
 [Socket.dev](https://socket.dev/npm/package/dphelper)
 

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

@@ -4,6 +4,8 @@
 
 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_

package/documents/STORE.md

@@ -4,6 +4,8 @@
 
 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])