dphelper 1.9.20 → 1.9.23

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+![dphelper](https://raw.githubusercontent.com/passariello/container/refs/heads/main/dphelper/assets/logos/logo.svg)
+
+New minor (feature) releases of this app/software are released every six months and
+patch (bugfix) releases are released every month. More information on the
+release cycle: see package.json
+
+## Previous
+
+Please see the git history for the details of previous versions.
+You can see HISTORY.md for all information.

package/CITATION.cff

@@ -0,0 +1,43 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: dpHelper
+message: dphelper devtools | tools, store and state management for developers by Dario Passariello
+type: software
+authors:
+  - given-names: "Dario "
+    family-names: Passariello
+    email: dariopassariello@gmail.com
+abstract: >-
+  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.
+keywords:
+  - dphelper
+  - development
+  - toolset
+  - state
+  - store
+  - observer
+  - helper
+  - utils
+  - tools
+  - uuid
+  - random
+  - window
+  - easy
+  - pro
+  - powerful
+  - status
+  - dp helper
+  - local
+  - storage
+  - indexeddb
+  - idb
+  - devtool
+  - dario
+  - passariello
+license: MIT

package/CODEOWNERS

@@ -0,0 +1 @@
+* @passariello

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,110 @@
+# Code of Conduct - dphelper
+
+![dphelper](https://raw.githubusercontent.com/passariello/container/refs/heads/main/dphelper/assets/logos/logo.svg)
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behaviour 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,
+  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:
+
+* The use of sexualised 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
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## 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,
+threatening, offensive, or harmful.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will
+communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behaviour may be
+reported to the community leaders responsible for enforcement at <dariopassariello@gmail.com>.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+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
+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.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behaviour. 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
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behaviour.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+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
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.

package/CONTRIBUTING.md

@@ -0,0 +1,110 @@
+# Contributing
+
+![dphelper](https://raw.githubusercontent.com/passariello/container/refs/heads/main/dphelper/assets/logos/logo.svg)
+
+First off, thanks for taking the time to contribute! ❤️
+
+All types of contributions are encouraged and valued. See the [Table of Contents](contributing.md#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
+
+> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
+>
+> * Star the project
+> * Tweet about it
+> * Refer this project in your project's readme
+> * Mention the project at local meetups and tell your friends/colleagues
+
+## Table of Contents
+
+* [Code of Conduct](contributing.md#code-of-conduct)
+* [I Have a Question](contributing.md#i-have-a-question)
+  * [I Want To Contribute](contributing.md#i-want-to-contribute)
+  * [Reporting Bugs](contributing.md#reporting-bugs)
+  * [Suggesting Enhancements](contributing.md#suggesting-enhancements)
+  * [Your First Code Contribution](contributing.md#your-first-code-contribution)
+  * [Improving The Documentation](contributing.md#improving-the-documentation)
+* [Styleguides](contributing.md#styleguides)
+  * [Commit Messages](contributing.md#commit-messages)
+* [Join The Project Team](contributing.md#join-the-project-team)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [dphelper Code of Conduct](https://github.com/a51-dev/a51.dphelper.public/blob/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [dariopassariello@gmail.com](mailto:dariopassariello@gmail.com).
+
+## I Have a Question
+
+> If you want to ask a question, we assume that you have read the available [Documentation](https://a51.gitbook.io/dphelper/).
+
+Before you ask a question, it is best to search for existing [Issues](https://github.com/a51-dev/a51.dphelper.public/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
+
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+
+* Open an [Issue](https://github.com/a51-dev/a51.dphelper.public/issues/new).
+* Provide as much context as you can about what you're running into.
+* Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
+
+We will then take care of the issue as soon as possible.
+
+## I Want To Contribute
+
+> #### 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
+
+#### Before Submitting a Bug Report
+
+A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+
+* Make sure that you are using the latest version.
+* Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://a51.gitbook.io/dphelper/). If you are looking for support, you might want to check [this section](contributing.md#i-have-a-question)).
+* To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/a51-dev/a51.dphelper.public/issues?q=label%3Abug).
+* Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
+* Collect information about the bug:
+  * Stack trace (Traceback)
+  * OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+  * Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
+  * Possibly your input and the output
+  * Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+
+#### How Do I Submit a Good Bug Report?
+
+> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to [dariopassariello@gmail.com](mailto:dariopassariello@gmail.com).
+
+We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+
+* Open an [Issue](https://github.com/a51-dev/a51.dphelper.public/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
+* Explain the behavior you would expect and the actual behavior.
+* Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
+* Provide the information you collected in the previous section.
+
+Once it's filed:
+
+* The project team will label the issue accordingly.
+* A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
+* If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](contributing.md#your-first-code-contribution).
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for dphelper, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
+
+#### Before Submitting an Enhancement
+
+* Make sure that you are using the latest version.
+* Read the [documentation](https://a51.gitbook.io/dphelper/) carefully and find out if the functionality is already covered, maybe by an individual configuration.
+* Perform a [search](https://github.com/a51-dev/a51.dphelper.public/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+* Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
+
+#### How Do I Submit a Good Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](https://github.com/a51-dev/a51.dphelper.public/issues).
+
+* Use a **clear and descriptive title** for the issue to identify the suggestion.
+* Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
+* **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
+* You may want to **include screenshots or screen recordings** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [screentogif](https://www.screentogif.com/) to record GIFs on macOS and Windows, and the built-in [screen recorder in GNOME](https://help.gnome.org/users/gnome-help/stable/screen-shot-record.html.en) or [SimpleScreenRecorder](https://github.com/MaartenBaert/ssr) on Linux.
+* **Explain why this enhancement would be useful** to most boilerplate users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
+
+## Join The Project Team
+
+Please send email to dariopassariello@gmail.com

package/FUNDING.yml

@@ -0,0 +1,16 @@
+# These are supported funding model platforms
+
+github: passariello
+patreon: passariello
+open_collective: # Replace with a single Open Collective username
+ko_fi: passariello
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: passariello
+issuehunt: passariello
+otechie: # Replace with a single Otechie username
+custom:
+  [
+    "https://dario.passariello.ca",
+    "https://www.indiegogo.com/individuals/28513718",
+  ]

package/HISTORY.md

@@ -0,0 +1 @@
+none

package/SECURITY.md

@@ -0,0 +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.

package/SUMMARY.md

@@ -0,0 +1,22 @@
+# Table of contents
+
+* [dpHelper](README.md)
+
+## General
+
+* [State](/documents/STATE.md)
+* [Observer](/documents/OBSERVER.md)
+* [Store](/documents/STORE.md)
+* [All Functions](/documents/TOOLS.md)
+
+## documents
+
+* [License](LICENSE.md)
+* [Contributing](CONTRIBUTING.md)
+* [Code of Conduct](CODE_OF_CONDUCT.md)
+* [Security](SECURITY.md)
+
+## changes
+
+* [Changelog](CAHNGELOG.md)
+* [History](HISTORY.md)

package/docs/_config.yml

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

package/docs/index.md

@@ -0,0 +1,315 @@
+# 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)
+![TypeScript](https://img.shields.io/badge/TypeScript-006b98?logo=TypeScript&logoColor=white)
+
+![dphelper](https://img.shields.io/badge/dphelper-npm-green?logo=dphelper&logoColor=white)
+![browser extension](https://img.shields.io/badge/browser%20extension-beta-orange.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)
+
+<!--
+[![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)
+-->
+
+## 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.
+
+### 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;
+```
+
+## 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)
+* [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).
+
+## Usage
+
+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>
+```
+
+## The Best Way To Use 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 for States
+
+**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);
+```
+
+#### 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';
+```
+
+## The Best Way To Use 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;
+```
+
+## Console It
+
+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.
+
+## Check
+
+[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 - 2024