memorio 1.0.0 → 1.1.0

package/.github/README.md

@@ -1,319 +0,0 @@
-# Memorio
-
-> A lightweight, type-safe state management library for modern JavaScript applications
-
-![TypeScript](https://img.shields.io/badge/TypeScript-5.9.2-blue?logo=typescript)
-![Node.js](https://img.shields.io/badge/Node.js-24.3.0-green?logo=node.js)
-![Jest](https://img.shields.io/badge/Jest-30.0.5-red?logo=jest)
-![ESLint](https://img.shields.io/badge/ESLint-9.34.0-purple?logo=eslint)
-![esbuild](https://img.shields.io/badge/esbuild-0.25.9-yellow?logo=esbuild)
-![License](https://img.shields.io/badge/license-MIT-blue.svg)
-![Version](https://img.shields.io/badge/version-0.2.15-orange)
-
-![Tests](https://img.shields.io/badge/tests-passing-brightgreen)
-![Coverage](https://img.shields.io/badge/coverage-25%20passed-success)
-
-## 📋 Table of Contents
-
-- [Features](#features)
-- [Installation](#installation)
-- [Quick Start](#quick-start)
-- [API Reference](#api-reference)
-  - [State Management](#state-management)
-  - [Observer Pattern](#observer-pattern)
-  - [Store](#store)
-  - [Session](#session)
-- [Testing](#testing)
-- [Security](#security)
-- [License](#license)
-
-## ✨ Features
-
-- 🔄 Reactive state management with observer pattern
-- 💾 Persistent storage with Store API
-- ⚡ Session management for temporary data
-- 🔒 Type-safe with full TypeScript support
-- 🧪 Comprehensive test coverage
-- 🎯 Zero dependencies
-- 🔍 Easy debugging with proxy-based state
-
-## 📦 Installation
-
-```bash
-npm install memorio
-# or
-yarn add memorio
-# or
-pnpm add memorio
-```
-
-✅ All test suites are passing:
-
-- Basic functionality tests
-- State management tests
-- Store operations tests
-- Cache operations tests
-- Observer pattern tests
-
-Total: 25 tests passed across 5 test suites
-
-## 🚀 Quick Start
-
-```javascript
-import 'memorio';
-
-// State Management
-state.counter = 0;
-state.user = { name: 'John', age: 30 };
-
-// Observer Pattern
-observer('state.counter', (newValue, oldValue) => {
-  console.log(`Counter changed from ${oldValue} to ${newValue}`);
-});
-
-// Store (Persistent Storage)
-store.set('preferences', { theme: 'dark' });
-const preferences = store.get('preferences');
-
-// Session Storage
-session.set('token', 'user-jwt-token');
-const token = session.get('token');
-```
-
-## 📖 API Reference
-
-### State Management
-
-State in Memorio is globally accessible and reactive:
-
-```javascript
-// Setting state
-state.user = { name: 'John' };
-
-// Getting state
-const userName = state.user.name;
-
-// Listing all states
-console.log(state.list);
-
-// Locking state (for Objects or Arrays)
-state.user.lock();
-
-// Removing state
-state.remove('user');
-
-// Clearing all states
-state.removeAll();
-
-```
-
-### Observer Pattern
-
-Observe state changes with React-like syntax:
-
-```javascript
-// Basic observer
-observer('state.user', (newValue, oldValue) => {
-  console.log('User updated:', newValue);
-});
-
-// With React useState
-const [user, setUser] = useState();
-observer('state.user', () => {
-  setUser(state.user);
-});
-
-// With React useEffect
-useEffect(() => {
-  console.log('User changed:', state.user);
-}, [state.user]);
-```
-
-### Another example of use of Observer
-
-```js
-import 'memorio';
-
-// 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);
-```
-
----
-
-## 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"
-```
-
-### Store
-
-Persistent storage for your application:
-
-```javascript
-// Setting values
-store.set('config', { theme: 'dark', language: 'en' });
-
-// Getting values
-const config = store.get('config');
-
-// Removing specific value
-store.remove('config');
-
-// Getting store size
-const size = store.size();
-
-// Clearing store
-store.removeAll();
-```
-
-### Session
-
-Temporary storage that persists during page sessions:
-
-```javascript
-// Setting session data
-session.set('userSession', {
-  id: 'user123',
-  lastActive: Date.now()
-});
-
-// Getting session data
-const userData = session.get('userSession');
-
-// Checking session size
-const activeItems = session.size();
-
-// Removing session data
-session.remove('userSession');
-
-// Clearing all session data
-session.removeAll();
-
-  // Remove all stored data if necessary
-  // store.removeAll();
-
-  return (
-    <div>
-      <h1 id="name">...</h1>
-    </div>
-  );
-}
-
-export default App;
-```
-
----
-
-## SESSION
-
-Session storage provides a way to store data for the duration of a page session. The data persists as long as the browser is open and survives over page reloads, but is lost when the browser tab or window is closed.
-
-```js
-// Set a session value:
-session.set("userId", "12345")
-
-// Get a session value:
-session.get("userId") // Output: "12345"
-
-// Remove a specific session value:
-session.remove("userId")
-
-// Get the number of items in session:
-session.size() // Output: number of stored items
-
-// Remove all session values:
-session.removeAll()
-```
-
-### Example use Session in React
-
-```js
-import { useEffect } from 'react';
-import 'memorio';
-
-function UserSession() {
-  useEffect(() => {
-    // Store user session data
-    session.set('userSession', {
-      id: '12345',
-      lastActive: Date.now(),
-      preferences: {
-        theme: 'dark',
-        language: 'en'
-      }
-    });
-
-    // Retrieve session data
-    const userData = session.get('userSession');
-    console.log('User session:', userData);
-
-    // Clean up on component unmount
-    return () => {
-      session.remove('userSession');
-    };
-  }, []);
-
-  return (
-    <div>
-      {/* Your component JSX */}
-    </div>
-  );
-}
-
-export default UserSession;
-```
-
----
-
-## 🧪 Testing
-
-✅ All test suites are passing:
-
-- Basic functionality tests
-- State management tests
-- Store operations tests
-- Cache operations tests
-- Observer pattern tests
-
-Total: 25 tests passed across 5 test suites
-
-## 🔒 Security
-
-Security scans and reports are available at:
-- [Socket.dev](https://socket.dev/npm/package/memorio)
-- [Snyk.io](https://security.snyk.io/package/npm/memorio)
-
-## 📄 License
-
-MIT © [Dario Passariello](https://dario.passariello.ca/)
-
----
-
-## 🤝 Contributing
-
-Contributions are welcome! Please feel free to submit a Pull Request.
-
-## 📧 Support
-
-Need help? Feel free to [open an issue](https://github.com/a51-dev/a51.memorio/issues).
-
----
-
-Created with ❤️ by [Dario Passariello](https://dario.passariello.ca/) - Copyright © 2025

package/.github/SECURITY.md

@@ -1,3 +0,0 @@
-# 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/.github/SUMMARY.md

@@ -1,21 +0,0 @@
-# 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/.github/dependabot.yml

@@ -1,11 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
-
-version: 2
-updates:
- - package-ecosystem: "npm" # See documentation for possible values
-   directory: "/" # Location of package manifests
-   schedule:
-    interval: "daily"

package/.github/documents/OBSERVER.md

@@ -1,72 +0,0 @@
-# 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/.github/documents/STATE.md

@@ -1,72 +0,0 @@
-# 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/.github/documents/STORE.md

@@ -1,84 +0,0 @@
-# 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/.github/pull_request_template.md

@@ -1,27 +0,0 @@
-## Description
-
-1. What is this PR about (link the issue and add a short description)
-
-## Steps for reproduction
-
-1. click button
-2. expect xyz
-
-## Code Review
-
-- [ ] hi, I need you to do
-  - conceptual review (architecture, feature-correctness)
-  - detailed review (read every line)
-  - test it on preview
-
-## Before requesting a review
-
-- [ ] made a self-review
-- [ ] added inline comments where things may be not obvious (the "why", not "what")
-
-## Before merging
-
-- [ ] tested locally and on preview environment (preview dev login: 0000)
-- [ ] updated [test cases] document
-- [ ] added tests
-- [ ] if any new env variables are added, added them to `.env` file

package/.private/npm

@@ -1 +0,0 @@
-npm deprecate memorio@"< 0.2.0" "critical bug fixed and improvements"

package/.vscode/extension.json

@@ -1,15 +0,0 @@
-{
-  "recommendations": [
-    "alefragnani.project-manager",
-    "donjayamanne.githistory",
-    "mhutchie.git-graph",
-    "mgmcdermott.vscode-language-babel",
-    "eamodio.gitlens",
-    "ms-vscode.vscode-typescript-next",
-    "ms-vscode.js-debug-nightly",
-    "pkief.material-icon-theme",
-    "jock.svg",
-    "simonsiefke.svg-preview",
-    "dbaeumer.vscode-eslint"
-  ]
-}