memorio 0.0.9 → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+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,24 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: memorio
+message: memorio by Dario Passariello
+type: software
+authors:
+  - given-names: "Dario "
+    family-names: Passariello
+    email: dariopassariello@gmail.com
+abstract: >-
+  memorio.State and Store Management are now easy, accessible
+  everywhere in your application.
+keywords:
+  - memorio
+  - development
+  - toolset
+  - state
+  - store
+  - observer
+  - dario
+  - passariello
+license: MIT

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,108 @@
+# Code of Conduct - memorio
+
+## 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 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 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 behavior include:
+
+* 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
+  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 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
+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 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.
+
+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 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
+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 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
+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 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
+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 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
+the community.

package/CONTRIBUTING.md

@@ -0,0 +1,108 @@
+# Contributing
+
+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)
+* [Style guides](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 [memorio Code of Conduct](https://github.com/a51-dev/a51.memorio.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/memorio/).
+
+Before you ask a question, it is best to search for existing [Issues](https://github.com/a51-dev/a51.memorio.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.memorio.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 license.
+
+### 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/memorio/). 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.memorio.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.memorio.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 memorio, **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/memorio/) carefully and find out if the functionality is already covered, maybe by an individual configuration.
+* Perform a [search](https://github.com/a51-dev/a51.memorio.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.memorio.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/README.md

@@ -1,3 +1,51 @@
 # Memorio
 
 Memory management for State and Store in easy way
+
+## STATE
+
+```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]
+
+```
+
+## STORE
+
+```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"
+```
+
+```js
+// Observe state changes
+observer('myData', () => {
+  console.log('myData has changed to:', state.myData);
+});
+```

package/SUMMARY.md

@@ -0,0 +1,21 @@
+# Table of contents
+
+* [README](README.md)
+
+## General
+
+* [State](/documents/STATE.md)
+* [Observer](/documents/OBSERVER.md)
+* [Store](/documents/STORE.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/documents/OBSERVER.md

@@ -0,0 +1,72 @@
+# Observer
+
+## Overview
+
+This document provides a comprehensive list of all available observer functions in the `memorio` 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/STATE.md

@@ -0,0 +1,72 @@
+# memorio State
+
+## Overview
+
+This document provides a comprehensive list of all available state functions in the `memorio` library along with their descriptions and examples.
+
+## 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,84 @@
+# memorio Store
+
+## Overview
+
+This document provides a comprehensive list of all available store functions in the `memorio` library along with their descriptions and examples.
+
+## 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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "memorio",
-  "version": "0.0.9",
+  "version": "0.1.0",
   "description": "memorio",
   "copyright": "Dario Passariello",
   "license": "MIT",