memorio 2.5.2 → 2.6.0

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/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/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/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/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/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/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/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/COPYRIGHT.md

@@ -1,6 +1,6 @@
 # Copyright
 
-Copyright (c) 2026, Dario Passariello. All rights reserved.
+Copyright (c) 2025, Dario Passariello. All rights reserved.
 <https://dario.passariello.ca>
 
 This 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

@@ -3,17 +3,26 @@
 > A lightweight, type-safe state management library for JavaScript applications
 
 [![version](https://img.shields.io/npm/v/memorio.svg)](https://npmjs.org/package/memorio)
+[![install size](https://img.shields.io/badge/dynamic/json?url=https://packagephobia.com/v2/api.json?p=memorio&query=$.install.pretty&label=install%20size&style=flat-square)](https://packagephobia.now.sh/result?p=memorio)
 [![downloads](https://img.shields.io/npm/dm/memorio.svg)](https://npmjs.org/package/memorio)
 
-![TypeScript](https://img.shields.io/badge/TypeScript-gray?logo=typescript)
+![Snyk](https://img.shields.io/badge/Snyk-gray?logo=Snyk)
+[![Known Vulnerabilities](https://snyk.io/test/npm/memorio/badge.svg)](https://snyk.io/test/npm/memorio)
+[![Socket Badge](https://socket.dev/api/badge/npm/package/memorio)](https://socket.dev/npm/package/memorio)
+
 ![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)
+![React](https://img.shields.io/badge/React-gray?logo=React)
+![Javascript](https://img.shields.io/badge/Javascript-gray?logo=Javascript)
+![TypeScript](https://img.shields.io/badge/TypeScript-gray?logo=typescript)
 ![esbuild](https://img.shields.io/badge/esbuild-gray?logo=esbuild)
 
-![License](https://img.shields.io/badge/license-MIT-blue.svg)
+![Jest](https://img.shields.io/badge/Jest-gray?logo=jest)
+![ESLint](https://img.shields.io/badge/Eslint-gray?logo=eslint)
+![Playwright](https://img.shields.io/badge/Playwright-gray?logo=playwright)
+
+[![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/memorio)
 
-License is MIT - free to use, modify, and distribute
+---
 
 ## Table of Contents
 

package/examples/basic.ts

@@ -0,0 +1,75 @@
+/**
+ * Memorio Basic Example
+ *
+ * This example shows the fundamental features of Memorio:
+ * - State management
+ * - Store (localStorage)
+ * - Session storage
+ *
+ * Run: npx ts-node examples/basic.ts
+ */
+
+import '../index'
+
+// ============================================
+// STATE - In-memory reactive state
+// ============================================
+
+// Set some state values
+state.name = 'Mario'
+state.age = 30
+state.isActive = true
+state.profile = {
+  email: 'mario@example.com',
+  avatar: 'https://example.com/mario.png'
+}
+
+// Get state values
+console.log('Name:', state.name)
+console.log('Age:', state.age)
+console.log('Profile:', state.profile)
+
+// List all states
+console.log('All states:', state.list)
+
+// ============================================
+// STORE - Persistent localStorage
+// ============================================
+
+// Save to localStorage
+store.set('username', 'mario')
+store.set('preferences', { theme: 'dark', language: 'en' })
+store.set('lastLogin', Date.now())
+
+// Read from localStorage
+console.log('Username:', store.get('username'))
+console.log('Preferences:', store.get('preferences'))
+
+// Get storage size
+console.log('Storage size:', store.size(), 'bytes')
+
+// ============================================
+// SESSION - Temporary session storage
+// ============================================
+
+// Save session data (cleared when tab closes)
+session.set('token', 'abc123xyz')
+session.set('userId', 42)
+
+// Read session data
+console.log('Token:', session.get('token'))
+console.log('User ID:', session.get('userId'))
+
+// ============================================
+// CLEANUP
+// ============================================
+
+// Clear specific items
+store.remove('username')
+session.remove('token')
+
+// Clear all
+store.removeAll()
+session.removeAll()
+
+console.log('Example complete!')

package/examples/cache.ts

@@ -0,0 +1,72 @@
+/**
+ * Memorio Cache Example
+ *
+ * This example demonstrates the cache module for in-memory storage.
+ * Cache is perfect for temporary data that doesn't need persistence.
+ *
+ * Run: npx ts-node examples/cache.ts
+ */
+
+import '../index'
+
+// ============================================
+// BASIC CACHE OPERATIONS
+// ============================================
+
+// Set values
+cache.set('username', 'Mario')
+cache.set('score', 1500)
+cache.set('player', { name: 'Mario', level: 5 })
+
+// Get values
+console.log('Username:', cache.get('username'))
+console.log('Score:', cache.get('score'))
+console.log('Player:', cache.get('player'))
+
+// Direct property access
+cache.tempData = 'Hello'
+console.log('Temp data:', cache.tempData)
+
+// ============================================
+// CACHE WITH OBJECTS
+// ============================================
+
+// Store complex objects
+cache.set('gameState', {
+  level: 3,
+  score: 2500,
+  inventory: ['sword', 'shield', 'potion'],
+  position: { x: 100, y: 200 }
+})
+
+const gameState = cache.get('gameState')
+console.log('Game level:', gameState?.level)
+console.log('Inventory:', gameState?.inventory)
+
+// ============================================
+// CACHE SIZE
+// ============================================
+
+// Add multiple items
+for (let i = 0; i < 10; i++) {
+  cache.set(`item_${i}`, { id: i, data: `item-${i}` })
+}
+
+console.log('Cache keys:', Object.keys(cache))
+
+// ============================================
+// CLEANUP
+// ============================================
+
+// Remove single item
+cache.remove('username')
+
+// Clear all cache
+cache.removeAll()
+
+// Or use clearAll alias
+// cache.clearAll()
+
+console.log('Cache after clear:', cache.get('score'))
+
+console.log('Cache example complete!')

package/examples/idb.ts

@@ -0,0 +1,109 @@
+/**
+ * Memorio IDB Example
+ *
+ * This example shows how to use IndexedDB for large data storage.
+ * IDB is perfect for caching, offline data, and large datasets.
+ *
+ * Run: npx ts-node examples/idb.ts
+ */
+
+import '../index'
+
+// ============================================
+// CHECK SUPPORT
+// ============================================
+
+if (!idb.db.support()) {
+  console.log('IndexedDB not supported')
+  process.exit(0)
+}
+
+// ============================================
+// CREATE DATABASE
+// ============================================
+
+// Create a new database
+idb.db.create('myApp')
+
+// Create tables (stores)
+idb.table.create('myApp', 'users')
+idb.table.create('myApp', 'products')
+
+// ============================================
+// ADD DATA
+// ============================================
+
+// Add user records
+idb.data.set('myApp', 'users', {
+  id: 1,
+  name: 'Mario',
+  email: 'mario@example.com',
+  role: 'admin'
+})
+
+idb.data.set('myApp', 'users', {
+  id: 2,
+  name: 'Luigi',
+  email: 'luigi@example.com',
+  role: 'user'
+})
+
+// Add product records
+idb.data.set('myApp', 'products', {
+  id: 1,
+  name: 'Super Mushroom',
+  price: 99,
+  inStock: true
+})
+
+idb.data.set('myApp', 'products', {
+  id: 2,
+  name: 'Fire Flower',
+  price: 199,
+  inStock: true
+})
+
+// ============================================
+// READ DATA
+// ============================================
+
+const user1 = idb.data.get('myApp', 'users', 1)
+console.log('User 1:', user1)
+
+const product1 = idb.data.get('myApp', 'products', 1)
+console.log('Product 1:', product1)
+
+// ============================================
+// DATABASE INFO
+// ============================================
+
+// List all databases
+const databases = idb.db.list()
+console.log('Databases:', databases)
+
+// Check if database exists
+const exists = idb.db.exist('myApp')
+console.log('myApp exists:', exists)
+
+// Get database version
+const version = idb.db.version('myApp')
+console.log('myApp version:', version)
+
+// Get database size
+const size = idb.db.size('myApp')
+console.log('myApp size:', size, 'bytes')
+
+// ============================================
+// DELETE DATA
+// ============================================
+
+// Delete a record
+idb.data.delete('myApp', 'users', 1)
+
+// Delete entire table
+// idb.table.delete('myApp', 'users');
+
+// Delete entire database
+// idb.db.delete('myApp');
+
+console.log('IDB example complete!')

package/examples/observer.ts

@@ -0,0 +1,60 @@
+/**
+ * Memorio Observer Example
+ *
+ * This example demonstrates the observer pattern for reactive state changes.
+ * Perfect for logging, analytics, auto-save, and UI updates.
+ *
+ * Run: npx ts-node examples/observer.ts
+ */
+
+import '../index'
+
+// ============================================
+// SIMPLE OBSERVER
+// ============================================
+
+// Watch a single value
+observer('state.counter', (newValue, oldValue) => {
+  console.log(`Counter: ${oldValue} → ${newValue}`)
+})
+
+state.counter = 0
+state.counter = 1
+state.counter = 2
+
+// ============================================
+// OBJECT OBSERVER
+// ============================================
+
+// Watch entire objects
+observer('state.user', (newUser, oldUser) => {
+  console.log(`User changed: ${oldUser?.name} → ${newUser?.name}`)
+})
+
+state.user = { name: 'Mario', level: 1 }
+state.user = { name: 'Luigi', level: 2 }
+
+// ============================================
+// MULTIPLE OBSERVERS
+// ============================================
+
+// Multiple observers on same path
+observer('state.notifications', (count) => {
+  console.log(`New notification count: ${count}`)
+})
+
+// List all observers
+console.log('Active observers:', observer.list)
+
+// ============================================
+// CLEANUP
+// ============================================
+
+// Remove specific observer
+observer.remove('state.counter')
+
+// Remove all observers - call remove for each path
+// observer.remove('state.counter')
+// observer.remove('state.notifications')
+
+console.log('Observer example complete!')

package/examples/session-advanced.ts

@@ -0,0 +1,78 @@
+/**
+ * Memorio Session Advanced Example
+ *
+ * This example shows advanced session (sessionStorage) operations.
+ * Session data is cleared when the browser tab closes.
+ *
+ * Run: npx ts-node examples/session-advanced.ts
+ */
+
+import '../index'
+
+// ============================================
+// AUTHENTICATION
+// ============================================
+
+// Store auth token (temporary - cleared when tab closes)
+session.set('authToken', 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...')
+session.set('userId', 12345)
+
+// Check if user is logged in
+const token = session.get('authToken')
+if (token) {
+  console.log('User is logged in, token:', token.substring(0, 20) + '...')
+}
+
+// ============================================
+// FORM PROGRESS
+// ============================================
+
+// Save form draft
+session.set('formDraft', {
+  name: 'Mario',
+  email: 'mario@example.com',
+  message: 'Hello world!'
+})
+
+// Restore on page refresh
+const draft = session.get('formDraft')
+if (draft) {
+  console.log('Restored draft:', draft)
+}
+
+// ============================================
+// SHOPPING CART
+// ============================================
+
+// Store cart items (temporary)
+session.set('cart', [
+  { id: 1, name: 'Super Mushroom', price: 99, qty: 2 },
+  { id: 2, name: 'Fire Flower', price: 199, qty: 1 }
+])
+
+// Calculate total
+const cart = session.get('cart') || []
+const total = cart.reduce((sum, item) => sum + (item.price * item.qty), 0)
+console.log('Cart total:', total)
+
+// ============================================
+// SESSION SIZE
+// ============================================
+
+// Get session storage size
+console.log('Session size:', session.size(), 'bytes')
+
+// ============================================
+// CLEANUP
+// ============================================
+
+// Remove specific item
+session.remove('formDraft')
+
+// Clear all session data (logout)
+// session.removeAll()
+
+// Or use alias
+// session.clearAll()
+
+console.log('Session advanced example complete!')