@plasius/react-state 1.0.1 → 1.0.2

package/CONTRIBUTING.md

@@ -0,0 +1,201 @@
+# Contributing to @plasius/react-state
+
+First off: thanks for taking the time to contribute!
+This document explains how to work on the project, how to propose changes, and what we expect in pull requests.
+
+> TL;DR
+>
+> - Be respectful and follow the Code of Conduct.
+> - Open an issue before large changes; small fixes can go straight to a PR.
+> - Write tests, keep coverage steady or improving.
+> - Use Conventional Commits.
+> - Don’t include real PII in code, issues, tests, or logs.
+
+---
+
+## Code of Conduct
+
+Participation in this project is governed by our **Code of Conduct** (see `CODE_OF_CONDUCT.md`). By participating, you agree to abide by it.
+
+## Licensing & CLA
+
+This project is open source (see `LICENSE`). To protect contributors and users, we require contributors to agree to our **Contributor License Agreement (CLA)** before we can merge PRs (see `legal/CLA.md`). You’ll be prompted automatically by the CLA bot on your first PR.
+
+> If your company has special legal needs, please contact the maintainers before sending large PRs.
+
+## Security
+
+**Never** report security issues in public issues or PRs. Instead, follow the process in `SECURITY.md`.
+
+---
+
+## What this project does
+
+`@plasius/react-state` provides a small, strongly-typed schema library:
+
+- A fluent field builder (e.g. `field().string().required()`),
+- Built-in validators for common standards (ISO/RFC/OWASP, etc.),
+- PII annotations + redaction utilities,
+- Type inference for safe, consistent entities across projects.
+
+Contributions typically fall into: new validators, field builder features, type improvements, docs, and tooling quality.
+
+---
+
+## Getting started (local dev)
+
+### Prerequisites
+
+- Node.js (use the version specified in `.nvmrc` if present: `nvm use`).
+- npm (we use npm scripts in this repo).
+
+### Install
+
+```bash
+npm ci
+```
+
+### Build
+
+```bash
+npm run build
+```
+
+### Test
+
+```bash
+npm test
+# or, if using Vitest in watch mode
+npm run test:watch
+```
+
+### Lint & format
+
+```bash
+npm run lint
+npm run format
+```
+
+> Tip: set up your editor to run ESLint and Prettier on save.
+
+---
+
+## How to propose a change
+
+### 1) For bugs
+
+- Search existing issues first.
+- Open a new issue with:
+  - Clear title, steps to reproduce, expected vs actual behaviour,
+  - Minimal repro (code snippet or small repo),
+  - Environment info (OS, Node, package version).
+
+### 2) For features / refactors
+
+- For anything non-trivial, open an issue first and outline the proposal.
+- If the change affects public API or architecture, add an ADR draft (see `docs/adrs/`).
+
+### 3) Good first issues
+
+We label approachable tasks as **good first issue** and **help wanted**.
+
+---
+
+## Branch, commit, PR
+
+### Branching
+
+- Fork or create a feature branch from `main`: `feat/xyz` or `fix/abc`.
+
+### **Commit messages** (Conventional Commits)
+
+- `feat: add ISO-3166 alpha-3 validator`
+- `fix: correct RFC5322 email regex edge-case`
+- `docs: expand PII redaction examples`
+- `refactor: simplify field builder pipeline`
+- `test: add cases for currency code`
+- `chore: bump dev deps`
+
+### **Pull Requests**
+
+- Keep PRs focused and small when possible.
+- Include tests for new/changed behaviour.
+- Update docs (README, JSDoc, ADRs) as needed.
+- Add a clear description of what & why, with before/after examples if useful.
+- Ensure CI is green (lint, build, tests).
+
+### **PR checklist**
+
+- [ ] Title uses Conventional Commits
+- [ ] Tests added/updated
+- [ ] Lint passes (`npm run lint`)
+- [ ] Build passes (`npm run build`)
+- [ ] Docs updated (README/ADR/CHANGELOG if needed)
+- [ ] No real PII in code, tests, or logs
+
+---
+
+## Coding standards
+
+- **Language:** TypeScript with `strict` types.
+- **Style:** ESLint + Prettier.
+- **Tests:** Prefer Vitest (or Jest) + `@testing-library/*` for React-facing bits.
+- **Public API:** Aim for backward compatibility; use SemVer and mark breaking changes clearly (`feat!:` or `fix!:`).
+- **Performance:** Avoid excessive allocations in hot paths; prefer immutable patterns but mind GC pressure.
+- **Docs:** Add TSDoc comments for exported types/functions.
+
+### Validators
+
+- Add tests covering common/edge cases.
+- Cite the source/standard (e.g., ISO/RFC) in comments.
+- Keep regexes readable (use `x`/comments where possible) and benchmark if complex.
+
+### PII handling
+
+- Never include real PII in fixtures or examples.
+- Ensure redaction/cleaning functions operate **before** logging.
+- Add tests confirming no PII leaks to logs or thrown errors.
+
+---
+
+## Adding dependencies
+
+- Minimise runtime dependencies; prefer dev dependencies.
+- Justify any new runtime dependency in the PR description (size, security, maintenance).
+- Avoid transitive heavy deps unless critical.
+
+---
+
+## Versioning & releases
+
+- We follow **SemVer**.
+- Breaking changes require a major bump and migration notes.
+- Keep the `CHANGELOG.md` (or release notes) clear about user-facing changes.
+
+---
+
+## Documentation
+
+- Update `README.md` with new features or setup steps.
+- Add or update ADRs in `docs/adrs/` for architectural decisions.
+- Keep examples minimal, copy-pasteable, and tested when feasible.
+
+---
+
+## Maintainers’ process (overview)
+
+- Triage new issues weekly; label and assign.
+- Review PRs for correctness, tests, and docs.
+- Squash-merge with Conventional Commit titles.
+- Publish from CI when applicable.
+
+---
+
+## Questions
+
+If you have questions or want feedback before building:
+
+- Open a discussion or issue with a short proposal,
+- Or draft a PR early (mark as **Draft**) to get directional feedback.
+
+Thanks again for contributing 💛

package/README.md

@@ -1,20 +1,20 @@
 # @plasius/react-store
 
-[![npm version](https://img.shields.io/npm/v/@plasius/react-store.svg)](https://www.npmjs.com/package/@plasius/react-store)
-[![Build Status](https://img.shields.io/github/actions/workflow/status/Plasius-LTD/react-store/ci.yml?branch=main&label=build&style=flat)](https://github.com/plasius/react-store/actions/workflows/ci.yml)
-[![License](https://img.shields.io/github/license/Plasius-LTD/react-store)](./LICENSE)
+[![npm version](https://img.shields.io/npm/v/@plasius/react-state.svg)](https://www.npmjs.com/package/@plasius/react-state)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/Plasius-LTD/react-state/ci.yml?branch=main&label=build&style=flat)](https://github.com/plasius/react-state/actions/workflows/ci.yml)
+[![License](https://img.shields.io/github/license/Plasius-LTD/react-state)](./LICENSE)
 [![Code of Conduct](https://img.shields.io/badge/code%20of%20conduct-yes-blue.svg)](./CODE_OF_CONDUCT.md)
 [![Security Policy](https://img.shields.io/badge/security%20policy-yes-orange.svg)](./SECURITY.md)
 [![Changelog](https://img.shields.io/badge/changelog-md-blue.svg)](./CHANGELOG.md)
 
 ## Overview
 
-`@plasius/react-store` provides a scoped state management solution for React applications. It allows developers to create isolated, testable, and composable stores without introducing heavy dependencies.
+`@plasius/react-state` provides a scoped state management solution for React applications. It allows developers to create isolated, testable, and composable stores without introducing heavy dependencies.
 
 ## Installation
 
 ```bash
-npm install @plasius/react-store
+npm install @plasius/react-state
 ```
 
 ## Usage Example

package/docs/adrs/adr-template.md

@@ -0,0 +1,65 @@
+# Architectural Decision Record (ADR)
+
+## Title
+
+> _Concise, descriptive title of the decision (e.g., “Use Azure Container Apps for n8n Deployment”)_
+
+---
+
+## Status
+
+- Proposed | Accepted | Rejected | Superseded | Deprecated
+- Date: YYYY-MM-DD
+- Version: 1.0
+- Supersedes: ADR-XXXX (if applicable)
+- Superseded by: ADR-YYYY (if applicable)
+
+---
+
+## Tags
+
+> _Short keywords to help search and group ADRs (e.g., infra, frontend, security, devops, ai, database)._
+
+---
+
+## Context
+
+> _Describe the problem we are solving, relevant background, and constraints.  
+> Why are we making this decision? What triggered it?_
+
+---
+
+## Decision
+
+> _What is the decision we have made? Clear, affirmative statement of the chosen path._
+
+---
+
+## Alternatives Considered
+
+- **Option A**: Description (pros/cons)
+- **Option B**: Description (pros/cons)
+- **Option C**: Description (pros/cons)
+
+> _Why were these alternatives not chosen?_
+
+---
+
+## Consequences
+
+- Positive outcomes (benefits, opportunities)
+- Negative outcomes (risks, trade-offs)
+- Any technical debt created or avoided
+- Impact on future decisions
+
+---
+
+## Related Decisions
+
+> _Link to related ADRs (if any)_
+
+---
+
+## References
+
+> _Links to docs, benchmarks, discussions, or external resources that influenced this decision_

package/legal/CLA-REGISTRY.csv

@@ -0,0 +1,2 @@
+type,github_handle,full_name,company,email,date,approver
+corporate,Zephod111r,Phillip Hounslow,Plasius LTD,zephod@plasius.co.uk,2025-09-12,Phillip Hounslow (Maintainer)

package/legal/CLA.md

@@ -0,0 +1,22 @@
+# Contributor License Agreements (CLA)
+
+To protect the intellectual property of this project and ensure clarity of rights, all contributors must sign a Contributor License Agreement (CLA) before their first contribution.
+
+## Which CLA should I sign?
+
+- **Individual CLA**: If you are contributing personally and not on behalf of an employer, sign the [Individual CLA](INDIVIDUAL_CLA.md).
+- **Corporate CLA**: If you are contributing as part of your work for a company, the company should sign the [Corporate CLA](CORPORATE_CLA.md).
+
+## How to sign
+
+1. Download the appropriate CLA file (Individual or Corporate).
+2. Fill in the required details, sign, and date it.
+3. Email a PDF copy of the signed document to **[contributors@plasius.co.uk](mailto:contributors@plasius.co.uk)** with subject: `CLA – Individual` or `CLA – Corporate`.
+
+## Registry
+
+All signed CLAs are logged internally in the CLA registry (`CLA-REGISTRY.csv`).
+
+## Questions?
+
+If you have any questions about which CLA to sign or how the process works, please email **[contributors@plasius.co.uk](mailtocontributors@plasius.co.uk)**.

package/legal/CORPORATE_CLA.md

@@ -0,0 +1,57 @@
+# Corporate Contributor License Agreement (CLA)
+
+## Purpose
+
+This Corporate Contributor License Agreement ("Agreement") is intended to protect the intellectual property rights of the contributors and the project, ensure clear licensing terms for contributions, and maintain trust within the community. By signing this Agreement, the corporation agrees to the terms that facilitate the use, distribution, and modification of contributions under the project's licensing framework.
+
+## Agreement
+
+1. **Representation of Authority**  
+   The undersigned individual represents and warrants that they have the full legal authority to enter into this Agreement on behalf of the corporation named below ("Corporation") and to grant the rights contained herein.
+
+2. **Grant of Copyright License**  
+   The Corporation hereby grants to the project maintainers and users a perpetual, worldwide, non-exclusive, royalty-free, irrevocable copyright license to use, reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute the contributions submitted to the project.
+
+3. **Grant of Patent License**  
+   The Corporation hereby grants to the project maintainers and users a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under any patent claims that are necessarily infringed by the contributions to make, use, sell, offer for sale, import, and otherwise dispose of the contributions or derivative works thereof.
+
+4. **Warranties and Representations**  
+   The Corporation represents and warrants that:
+
+- The contributions are the original work of the Corporation or that the Corporation has sufficient rights to grant the licenses herein.
+- The submission of the contributions does not violate any agreements or rights of third parties.
+
+5. **No Revocation**  
+   This license is granted on a perpetual basis and cannot be revoked, provided that the terms of this Agreement are met.
+
+6. **Governing Law**
+   This Agreement shall be governed by and construed in accordance with the laws of the United Kingdom, without regard to its conflict of laws principles.
+
+7. **Execution**
+
+This Agreement is effective upon signature by the authorized representative of the Corporation. Please sign and date this document, then email a scanned PDF copy to [contributors@plasius.co.uk](mailto:contributors@plasius.co.uk).
+
+---
+
+**@plasius/react-state**
+
+**Corporation Legal Name:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Authorized Representative:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Title:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Email:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Date:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Signature:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+---
+
+## How to Sign
+
+- Download this file as a template.
+- Fill in the Corporation’s legal name, authorized representative, title, email, date, and provide a signature.
+- Sign and date the document.
+- Send a scanned copy of the signed Agreement to [contributors@plasius.co.uk](mailto:contributors@plasius.co.uk).

package/legal/INDIVIDUAL_CLA.md

@@ -0,0 +1,91 @@
+# Individual Contributor License Agreement (CLA)
+
+**Project:** @plasius/react-state (Plasius LTD)  
+**Version:** 1.0 — 2025‑09‑12  
+**Contact:** [contributors@plasius.co.uk](mailto:contributors@plasius.co.uk)
+
+---
+
+## 1. Definitions
+
+- **"You"** (or **"Contributor"**) means the individual signing this CLA and submitting Contributions to the Project.
+- **"Contribution"** means any original work of authorship, including code, documentation, data, designs, or feedback that You submit to the Project in any form (e.g., pull request, issue comment, email, file upload).
+- **"Project"** means the Intuitive Purchases repositories and related materials owned or managed by **Plasius LTD**.
+
+## 2. Copyright License Grant
+
+You hereby grant to Plasius LTD a **perpetual, worldwide, non‑exclusive, transferable, sublicensable, royalty‑free, irrevocable** copyright license to:
+
+- use, reproduce, publicly display, publicly perform, modify, create derivative works of, and
+- distribute Contributions in source and object form,
+- and to **sublicense** these rights under any terms Plasius LTD chooses, including proprietary or open‑source licenses.
+
+## 3. Patent License Grant
+
+You hereby grant to Plasius LTD and its sublicensees a **perpetual, worldwide, non‑exclusive, transferable, royalty‑free, irrevocable** patent license to **make, have made, use, offer to sell, sell, import, and otherwise transfer** the Contribution and derivative works thereof, where such license applies only to patent claims that You **own or control** and that would be infringed by Your Contribution or its combination with the Project.
+
+## 4. Moral Rights & Attribution
+
+To the maximum extent permitted by applicable law, You **waive** and agree not to assert any moral rights (e.g., rights of attribution or integrity) in or to the Contribution against Plasius LTD. Plasius LTD may, but is not required to, credit You.
+
+## 5. Representations & Warranties
+
+You represent that:
+
+1. **Originality / Rights:** Each Contribution is Your original creation, or You have sufficient rights to submit it and grant the licenses above.
+2. **No Confidential Info:** Contributions **do not** include confidential information or trade secrets of any third party.
+3. **No Infringement:** To the best of Your knowledge, Contributions do not infringe any third‑party IP rights.
+4. **Employment / Contractor Status:** If Your employer or a third party might claim rights in Your Contribution, You have obtained **written permission** to make the Contribution and grant these licenses (attach or reference below), or Your Contribution is made **outside the scope** of your employment and without using your employer’s confidential information or resources.
+5. **Compliance:** You will follow the Project’s policies (e.g., Code of Conduct, Security Policy) and applicable laws.
+
+## 6. Third‑Party Code
+
+If Your Contribution includes code, data, or other material from a third party, You will **identify the material and its license** in the pull request or submission, and ensure it is **compatible** with the Project’s licensing model. You will not submit material subject to terms that require the Project to disclose proprietary source code (e.g., certain copyleft obligations) unless the Project has **pre‑approved** such inclusion in writing.
+
+## 7. Scope & Duration
+
+- This CLA covers **all past and future** Contributions You submit to the Project, unless and until You provide written notice to **revoke** it.
+- Revocation is **not retroactive**: rights granted for prior Contributions remain in effect.
+
+## 8. Disclaimer
+
+THE CONTRIBUTION IS PROVIDED “AS IS” WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON‑INFRINGEMENT.
+
+## 9. Governing Law & Jurisdiction
+
+This CLA is governed by the **laws of England and Wales**, and the courts of England and Wales shall have **exclusive jurisdiction** over any dispute arising out of or relating to it.
+
+## 10. Entire Agreement
+
+This CLA is the entire agreement between You and Plasius LTD regarding Contributions. It supersedes any prior discussions relating to Contributions. If any provision is held unenforceable, the remaining provisions remain in full force.
+
+---
+
+## 11. Contributor Information & Signature
+
+By signing below, You agree to the terms of this CLA for Your Contributions to the Project.
+
+**Full Name:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Email:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**GitHub Handle:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Address (optional):** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Employer (if applicable):** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**If employed:** ☐ I confirm Contributions are made outside the scope of employment **or** ☐ I have attached my employer’s written permission.
+
+**Signature:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Date (YYYY‑MM‑DD):** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+_Electronic signatures are accepted. You may type your name in the Signature field and email a PDF copy._
+
+**Submission:** Please email the signed CLA to **[contributors@plasius.co.uk](mailto:contributors@plasius.co.uk)** with subject line: `CLA – Individual – <GitHubHandle>`.
+
+**(Optional) Attachments / Notes:**
+
+- Employer permission letter (if required)
+- Third‑party license disclosures (if any)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plasius/react-state",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Tiny, testable, typesafe React Scoped Store helper.",
   "keywords": [
     "react",