@plasius/react-state 1.0.10 → 1.0.12

package/docs/adrs/adr-template.md

@@ -1,65 +0,0 @@
-# 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

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

@@ -1,22 +0,0 @@
-# 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

@@ -1,57 +0,0 @@
-# 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

@@ -1,91 +0,0 @@
-# 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/sbom.cdx.json

@@ -1,66 +0,0 @@
-{
-  "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
-  "bomFormat": "CycloneDX",
-  "specVersion": "1.5",
-  "serialNumber": "urn:uuid:f0ed2ffb-226d-413f-a182-36e60e9b39c6",
-  "version": 1,
-  "metadata": {
-    "timestamp": "2025-09-17T16:16:53.742Z",
-    "lifecycles": [
-      {
-        "phase": "build"
-      }
-    ],
-    "tools": [
-      {
-        "vendor": "npm",
-        "name": "cli",
-        "version": "10.9.3"
-      }
-    ],
-    "component": {
-      "bom-ref": "@plasius/react-state@1.0.10",
-      "type": "library",
-      "name": "react-state",
-      "version": "1.0.10",
-      "scope": "required",
-      "author": "Plasius LTD",
-      "description": "Tiny, testable, typesafe React Scoped Store helper.",
-      "purl": "pkg:npm/%40plasius/react-state@1.0.10",
-      "properties": [
-        {
-          "name": "cdx:npm:package:path",
-          "value": ""
-        }
-      ],
-      "externalReferences": [
-        {
-          "type": "vcs",
-          "url": "git+https://github.com/Plasius-LTD/react-state.git"
-        },
-        {
-          "type": "website",
-          "url": "https://github.com/Plasius-LTD/react-state#readme"
-        },
-        {
-          "type": "issue-tracker",
-          "url": "https://github.com/Plasius-LTD/react-state/issues"
-        }
-      ],
-      "licenses": [
-        {
-          "license": {
-            "id": "Apache-2.0"
-          }
-        }
-      ]
-    }
-  },
-  "components": [],
-  "dependencies": [
-    {
-      "ref": "@plasius/react-state@1.0.10",
-      "dependsOn": []
-    }
-  ]
-}

package/src/create-scoped-store.tsx

@@ -1,87 +0,0 @@
-import { createContext, useContext, useRef, useSyncExternalStore } from "react";
-import type { IState, IAction, Store } from "./store.js";
-import { createStore } from "./store.js";
-
-function shallowEqual(a: any, b: any) {
-  if (Object.is(a, b)) return true;
-  if (
-    typeof a !== "object" ||
-    a === null ||
-    typeof b !== "object" ||
-    b === null
-  )
-    return false;
-  const ak = Object.keys(a),
-    bk = Object.keys(b);
-  if (ak.length !== bk.length) return false;
-  for (let i = 0; i < ak.length; i++) {
-    const k = ak[i] as string;
-    if (
-      !Object.prototype.hasOwnProperty.call(b, k) ||
-      !Object.is((a as any)[k], (b as any)[k])
-    )
-      return false;
-  }
-  return true;
-}
-
-export function createScopedStoreContext<S extends IState, A extends IAction>(
-  reducer: (state: S, action: A) => S,
-  initialState: S
-) {
-  const Context = createContext<Store<S, A> | null>(null);
-
-  const store = createStore(reducer, initialState);
-
-  const Provider = ({ children }: { children: React.ReactNode }) => (
-    <Context.Provider value={store}>{children}</Context.Provider>
-  );
-
-  const useStore = (): S => {
-    const ctx = useContext(Context);
-    if (!ctx) throw new Error("Store not found in context");
-    return useSyncExternalStore(ctx.subscribe, ctx.getState, ctx.getState);
-  };
-
-  const useDispatch = (): ((action: A) => void) => {
-    const ctx = useContext(Context);
-    if (!ctx) throw new Error("Dispatch not found in context");
-    return (action: A) => ctx.dispatch(action);
-  };
-
-  function useSelector<T>(
-    selector: (state: S) => T,
-    isEqual: (a: T, b: T) => boolean = shallowEqual
-  ): T {
-    const ctx = useContext(Context);
-    if (!ctx) throw new Error("Store not found in context");
-
-    // Subscribe to the raw state snapshot (stable reference until a dispatch)
-    const state = useSyncExternalStore(
-      ctx.subscribe,
-      ctx.getState,
-      ctx.getState
-    );
-
-    // Cache the selected slice per state snapshot to avoid returning fresh objects during render
-    const lastRef = useRef<{ state: S; selected: T } | null>(null);
-    const last = lastRef.current;
-    const nextSelected = selector(state);
-
-    if (last && last.state === state && isEqual(last.selected, nextSelected)) {
-      return last.selected; // return cached reference to satisfy getSnapshot caching
-    }
-
-    lastRef.current = { state, selected: nextSelected };
-    return nextSelected;
-  }
-
-  return {
-    store,
-    Context,
-    Provider,
-    useStore,
-    useDispatch,
-    useSelector,
-  };
-}

package/src/index.ts

@@ -1,5 +0,0 @@
-export * from "./types.js";
-export * from "./create-scoped-store.js";
-export * from "./store.js";
-export * from "./provider.js";
-export * from "./metadata-store.js";

package/src/metadata-store.ts

@@ -1,24 +0,0 @@
-// metadata-store.ts
-export class MetadataStore<T extends object, Meta extends object> {
-  private readonly symbol: symbol;
-
-  constructor(description: string) {
-    this.symbol = Symbol(description);
-  }
-
-  set(target: T, meta: Meta) {
-    Object.defineProperty(target, this.symbol as PropertyKey, {
-      value: meta,
-      writable: false,
-      enumerable: false,
-    });
-  }
-
-  get(target: T): Meta | undefined {
-    return (target as Record<PropertyKey, Meta>)[this.symbol as PropertyKey];
-  }
-
-  has(target: T): boolean {
-    return (this.symbol as PropertyKey) in target;
-  }
-}

package/src/provider.tsx

@@ -1,52 +0,0 @@
-import React, { createContext, useContext, useEffect, useState } from "react";
-import type { ReactNode } from "react";
-import type { Store, IState, IAction } from "./store.js";
-
-const StoreContext = createContext<Store<IState, IAction> | undefined>(undefined);
-
-function useStoreInstance<S extends IState, A extends IAction>(): Store<S, A> {
-  const store = useContext(StoreContext) as Store<S, A> | undefined;
-  if (!store) {
-    throw new Error(
-      "StoreProvider is missing in the React tree. Wrap your app with <StoreProvider store={...}>."
-    );
-  }
-  return store;
-}
-
-interface StoreProviderProps<S extends IState, A extends IAction> {
-  store: Store<S, A>;
-  children: ReactNode;
-}
-
-export function StoreProvider<S extends IState, A extends IAction>({
-  store,
-  children,
-}: StoreProviderProps<S, A>) {
-  return (
-    <StoreContext.Provider value={store as unknown as Store<IState, IAction>}>
-      {children}
-    </StoreContext.Provider>
-  );
-}
-
-export function useStore<S extends IState>(): S {
-  const store = useStoreInstance<S, IAction>();
-  const [state, setState] = useState<S>(() => store.getState());
-
-  useEffect(() => {
-    // Subscribe to store changes and update local state.
-    const unsubscribe = store.subscribe(() => {
-      setState(store.getState());
-    });
-    return unsubscribe;
-  }, [store]);
-
-  return state;
-}
-
-export function useDispatch<A extends IAction>(): Store<IState, A>["dispatch"] {
-  const store = useStoreInstance<IState, A>();
-  // Return the store's dispatch directly; consumers can call dispatch(action).
-  return store.dispatch as Store<IState, A>["dispatch"];
-}

package/src/store.ts

@@ -1,131 +0,0 @@
-import type { Reducer, Listener } from "./types.js";
-
-// Allow narrower parameter types for callbacks without fighting variance
-type BivariantListener<T> = {
-  bivarianceHack(value: T): void;
-}["bivarianceHack"];
-
-// eslint-disable-next-line @typescript-eslint/no-empty-object-type
-export interface IState {}
-export interface IAction {
-  type: string;
-}
-
-export interface Store<S extends IState, A extends IAction> {
-  getState(): S;
-  dispatch(action: A): void;
-  /**
-   * Subscribe to all state changes.
-   */
-  subscribe(listener: Listener): () => void;
-  /**
-   * Subscribe to changes of a specific key in the state.
-   */
-  subscribeToKey<K extends keyof S>(
-    key: K,
-    listener: (value: S[K]) => void
-  ): () => void;
-  /**
-   * Subscribe to changes in a selected value from the state.
-   */
-  subscribeWithSelector<T>(
-    selector: (state: S) => T,
-    listener: (selected: T) => void
-  ): () => void;
-}
-
-export function createStore<S extends IState, A extends IAction>(
-  reducer: Reducer<S, A>,
-  initialState: S
-): Store<S, A> {
-  let state = initialState;
-  const listeners = new Set<Listener>();
-  const keyListeners = new Map<keyof S, Set<BivariantListener<S[keyof S]>>>();
-
-  interface SelectorEntry<T> {
-    selector: (state: S) => T;
-    listener: BivariantListener<T>;
-    lastValue: T;
-  }
-  const selectorListeners = new Set<SelectorEntry<unknown>>();
-
-  const getState = () => state;
-
-  const dispatch = (action: A) => {
-    const prevState = state;
-    const nextState = reducer(state, action);
-
-    // Distinct-until-changed: if the reducer returns the same reference,
-    // skip all notifications (prevents unnecessary re-renders).
-    if (Object.is(prevState, nextState)) {
-      state = nextState; // keep any identity guarantees from reducer
-      return;
-    }
-
-    state = nextState;
-
-    // Notify global listeners (iterate over a snapshot so unsubscribe during
-    // notify does not skip the next listener)
-    for (const listener of [...listeners]) listener();
-
-    // Notify key listeners only when that key actually changed (Object.is)
-    for (const [key, set] of keyListeners.entries()) {
-      if (!Object.is(prevState[key], state[key])) {
-        for (const listener of [...set]) listener(state[key]);
-      }
-    }
-
-    // Notify selector listeners only when selected value changed (Object.is)
-    selectorListeners.forEach((entry) => {
-      const nextValue = (entry.selector as (s: S) => unknown)(state);
-      if (!Object.is(entry.lastValue, nextValue)) {
-        entry.lastValue = nextValue as unknown;
-        (entry.listener as (v: unknown) => void)(nextValue);
-      }
-    });
-  };
-
-  const subscribe = (listener: Listener) => {
-    listeners.add(listener);
-    return () => {
-      listeners.delete(listener);
-    };
-  };
-
-  const subscribeToKey = <K extends keyof S>(
-    key: K,
-    listener: (value: S[K]) => void
-  ) => {
-    const set =
-      keyListeners.get(key) ?? new Set<BivariantListener<S[keyof S]>>();
-    set.add(listener as unknown as BivariantListener<S[keyof S]>);
-    keyListeners.set(key, set);
-    return () => {
-      set.delete(listener as unknown as BivariantListener<S[keyof S]>);
-      if (set.size === 0) keyListeners.delete(key);
-    };
-  };
-
-  const subscribeWithSelector = <T>(
-    selector: (state: S) => T,
-    listener: (selected: T) => void
-  ) => {
-    const entry: SelectorEntry<T> = {
-      selector,
-      listener: listener as BivariantListener<T>,
-      lastValue: selector(state),
-    };
-    selectorListeners.add(entry as unknown as SelectorEntry<unknown>);
-    return () => {
-      selectorListeners.delete(entry as unknown as SelectorEntry<unknown>);
-    };
-  };
-
-  return {
-    getState,
-    dispatch,
-    subscribe,
-    subscribeToKey,
-    subscribeWithSelector,
-  };
-}

package/src/types.ts

@@ -1,3 +0,0 @@
-export type Reducer<S, A> = (state: S, action: A) => S;
-export type Listener = () => void;
-export type Unsubscribe = () => void;