atom.io 0.6.5 → 0.6.7

package/README.md

@@ -1,78 +1,32 @@
-## features
-- [x] atoms and selectors
-- [x] implicit store
-- [x] readonly selectors
-- [x] settable selectors
-- [x] "tokens" safely expose atoms and selectors
-- [x] give atoms and selectors separate types with a common base
-- [x] utility function to pass logger to your store
-- [x] selector memoization
-- [x] atom and selector families
-- [x] atom effects
-- [x] transactions
-- [x] async effects
-- [x] atom default as function
-- [x] check whether an atom is "default" (never set)
-- [x] customizable logging
-- [x] subscribe to transactions
-- [x] timelines
-- [x] subscribe to families
-
-# atom.io
-## upcoming features
-- [ ] suppressor: ({oldValue, newValue}) => boolean
-- [ ] resettable atoms
-- [ ] resettable selectors
-
-## documentation
-- [ ] document atom and selector families
-- [ ] document atom and selector
-- [ ] document transactions
-
-# src/internal/meta
-- [x] subscribe to creation of atom tokens
-- [x] subscribe to creation of selector tokens
-- [x] subscribe to creation of readonly selector tokens
-- [ ] reimplement state indices as selectors
-- [ ] subscribe to creation of transaction tokens
-- [ ] subscribe to creation of timeline tokens
-- [ ] subscribe to changes in store configuration
-
-# /react-devtools
-- [ ] 
-
-# /react
-## features
-- [x] useStore
-- [x] useI, useO, useIO
-- [ ] useTimeline
-- [ ] useStoreIndex
-- [ ] useTransactionIO 
-
-# /realtime
-- [x] expose single atom and selector
-- [x] expose atom family and selector family
-- [ ] receive single atom and selector
-- [ ] receive atom family and selector family
-- [x] receive transaction params, run transaction
-- [ ] assess transaction impact (active subscriptions influenced by transaction)
-- [ ] return transaction impact as timeline event
-- [ ] identity-based exposure and receipt
-- [ ] expose selector as atom
-
-# /react-realtime
-example: what's in the box? (options: green apple, green banana, red apple, red banana)
-- no player gets to see what's in the box
-- player 1 can see the color of the item in the box
-  - a register must be kept allocating "subscription permissions" per player
-  - sometimes permissions may refer to "true" or "global" state; sometimes to state that is "virtual" or "local" to the player
-- player 2 can see the type of the item in the box
-- atom<`${string}____${string}`> boxItem
-  - selector boxItemColor
-  - selector boxItemType
-- 
-- 
-
-# /web-fx
-## features
-- [ ] localStorage and sessionStorage effects
+<hr>
+
+<div align="center">
+  <img alt="corners logo" src="https://raw.githubusercontent.com/jeremybanka/wayforge/main/packages/atom.io/assets/logo.png"/>
+</div>
+
+<br>
+
+<p align="center">
+  <a href="https://bundlephobia.com/result?p=atom.io">
+    <img alt="Bundlephobia" src="https://img.shields.io/bundlephobia/minzip/atom.io?style=for-the-badge&labelColor=333">
+  </a>
+  <a aria-label="Types" href="https://www.npmjs.com/package/atom.io">
+    <img alt="Types" src="https://img.shields.io/npm/types/atom.io?style=for-the-badge&labelColor=333">
+  </a>
+  <a aria-label="Build status" href="https://github.com/jeremybanka/wayforge/actions/workflows/integration.yml">
+    <img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/jeremybanka/wayforge/integration.yml?branch=main&style=for-the-badge&labelColor=333">
+  </a>
+  <a aria-label="NPM version" href="https://www.npmjs.com/package/atom.io">
+    <img alt="NPM Version" src="https://img.shields.io/npm/v/atom.io?style=for-the-badge&labelColor=333">
+  </a>
+</p>
+
+```shell
+npm i atom.io
+```
+```shell
+pnpm add atom.io
+```
+<hr>
+
+Reactive state graph for node and the browser inspired by [Recoil](https://recoiljs.org/).

package/dist/index.d.mts

@@ -1,5 +1,4 @@
-import { Hamt } from 'hamt_plus';
-import { Refinement } from 'fp-ts/lib/Refinement';
+import { Refinement } from 'fp-ts/Refinement';
 
 type ƒn = (...parameters: any[]) => any;
 
@@ -71,23 +70,24 @@ declare class Join<CONTENT extends JsonObj | null = null, A extends string = `fr
 
 type StoreCore = Pick<Store, `atoms` | `atomsThatAreDefault` | `operation` | `readonlySelectors` | `selectorAtoms` | `selectorGraph` | `selectors` | `timelineAtoms` | `timelines` | `transactions` | `valueMap`>;
 interface Store {
-    atoms: Hamt<Atom<any>, string>;
+    atoms: Map<string, Atom<any>>;
     atomsThatAreDefault: Set<string>;
-    readonlySelectors: Hamt<ReadonlySelector<any>, string>;
+    readonlySelectors: Map<string, ReadonlySelector<any>>;
     selectorAtoms: Join<null, `selectorKey`, `atomKey`>;
     selectorGraph: Join<{
         source: string;
     }>;
-    selectors: Hamt<Selector<any>, string>;
+    selectors: Map<string, Selector<any>>;
     timelineAtoms: Join<null, `timelineKey`, `atomKey`>;
-    timelines: Hamt<Timeline, string>;
-    transactions: Hamt<Transaction<any>, string>;
-    valueMap: Hamt<any, string>;
+    timelines: Map<string, Timeline>;
+    transactions: Map<string, Transaction<any>>;
+    valueMap: Map<string, any>;
     subject: {
         atomCreation: Subject<AtomToken<unknown>>;
         selectorCreation: Subject<ReadonlySelectorToken<unknown> | SelectorToken<unknown>>;
-        transactionCreation: Subject<TransactionToken<unknown>>;
+        transactionCreation: Subject<TransactionToken<ƒn>>;
         timelineCreation: Subject<TimelineToken>;
+        operationStatus: Subject<OperationProgress>;
     };
     operation: OperationProgress;
     transactionStatus: TransactionStatus<ƒn>;
@@ -169,43 +169,12 @@ declare const markAtomAsDefault: (key: string, store?: Store) => void;
 declare const markAtomAsNotDefault: (key: string, store?: Store) => void;
 declare const isSelectorDefault: (key: string, store?: Store) => boolean;
 
-type StateTokenIndex<Token extends AtomToken<unknown> | ReadonlySelectorToken<unknown> | SelectorToken<unknown>> = Record<string, Token | {
-    key: string;
-    familyMembers: Record<string, Token>;
-}>;
-type AtomTokenIndex = StateTokenIndex<AtomToken<unknown>>;
-type SelectorTokenIndex = StateTokenIndex<ReadonlySelectorToken<unknown> | SelectorToken<unknown>>;
-declare const attachMetaAtoms: (store?: Store) => ReadonlySelectorToken<AtomTokenIndex>;
-declare const attachMetaSelectors: (store?: Store) => ReadonlySelectorToken<SelectorTokenIndex>;
-
-declare const attachMetaState: (store?: Store) => {
-    atomTokenIndexState: ReadonlySelectorToken<AtomTokenIndex>;
-    selectorTokenIndexState: ReadonlySelectorToken<SelectorTokenIndex>;
-};
-
-type index$1_AtomTokenIndex = AtomTokenIndex;
-type index$1_SelectorTokenIndex = SelectorTokenIndex;
-type index$1_StateTokenIndex<Token extends AtomToken<unknown> | ReadonlySelectorToken<unknown> | SelectorToken<unknown>> = StateTokenIndex<Token>;
-declare const index$1_attachMetaAtoms: typeof attachMetaAtoms;
-declare const index$1_attachMetaSelectors: typeof attachMetaSelectors;
-declare const index$1_attachMetaState: typeof attachMetaState;
-declare namespace index$1 {
-  export {
-    index$1_AtomTokenIndex as AtomTokenIndex,
-    index$1_SelectorTokenIndex as SelectorTokenIndex,
-    index$1_StateTokenIndex as StateTokenIndex,
-    index$1_attachMetaAtoms as attachMetaAtoms,
-    index$1_attachMetaSelectors as attachMetaSelectors,
-    index$1_attachMetaState as attachMetaState,
-  };
-}
-
 type OperationProgress = {
     open: false;
 } | {
     open: true;
     done: Set<string>;
-    prev: Hamt<any, string>;
+    prev: Map<string, any>;
     time: number;
     token: StateToken<any>;
 };
@@ -333,7 +302,7 @@ type Timeline = {
     selectorTime: number | null;
     transactionKey: string | null;
     install: (store: Store) => void;
-    subject: Subject<TimelineAtomUpdate | TimelineSelectorUpdate | TimelineTransactionUpdate>;
+    subject: Subject<TimelineAtomUpdate | TimelineSelectorUpdate | TimelineTransactionUpdate | `redo` | `undo`>;
 };
 declare function timeline__INTERNAL(options: TimelineOptions, store?: Store, data?: Timeline | null): TimelineToken;
 
@@ -444,7 +413,6 @@ declare namespace index {
   export {
     index_Atom as Atom,
     index_IMPLICIT as IMPLICIT,
-    index$1 as META,
     index_OperationProgress as OperationProgress,
     index_ReadonlySelector as ReadonlySelector,
     index_Selector as Selector,

package/dist/index.d.ts

@@ -1,5 +1,4 @@
-import { Hamt } from 'hamt_plus';
-import { Refinement } from 'fp-ts/lib/Refinement';
+import { Refinement } from 'fp-ts/Refinement';
 
 type ƒn = (...parameters: any[]) => any;
 
@@ -71,23 +70,24 @@ declare class Join<CONTENT extends JsonObj | null = null, A extends string = `fr
 
 type StoreCore = Pick<Store, `atoms` | `atomsThatAreDefault` | `operation` | `readonlySelectors` | `selectorAtoms` | `selectorGraph` | `selectors` | `timelineAtoms` | `timelines` | `transactions` | `valueMap`>;
 interface Store {
-    atoms: Hamt<Atom<any>, string>;
+    atoms: Map<string, Atom<any>>;
     atomsThatAreDefault: Set<string>;
-    readonlySelectors: Hamt<ReadonlySelector<any>, string>;
+    readonlySelectors: Map<string, ReadonlySelector<any>>;
     selectorAtoms: Join<null, `selectorKey`, `atomKey`>;
     selectorGraph: Join<{
         source: string;
     }>;
-    selectors: Hamt<Selector<any>, string>;
+    selectors: Map<string, Selector<any>>;
     timelineAtoms: Join<null, `timelineKey`, `atomKey`>;
-    timelines: Hamt<Timeline, string>;
-    transactions: Hamt<Transaction<any>, string>;
-    valueMap: Hamt<any, string>;
+    timelines: Map<string, Timeline>;
+    transactions: Map<string, Transaction<any>>;
+    valueMap: Map<string, any>;
     subject: {
         atomCreation: Subject<AtomToken<unknown>>;
         selectorCreation: Subject<ReadonlySelectorToken<unknown> | SelectorToken<unknown>>;
-        transactionCreation: Subject<TransactionToken<unknown>>;
+        transactionCreation: Subject<TransactionToken<ƒn>>;
         timelineCreation: Subject<TimelineToken>;
+        operationStatus: Subject<OperationProgress>;
     };
     operation: OperationProgress;
     transactionStatus: TransactionStatus<ƒn>;
@@ -169,43 +169,12 @@ declare const markAtomAsDefault: (key: string, store?: Store) => void;
 declare const markAtomAsNotDefault: (key: string, store?: Store) => void;
 declare const isSelectorDefault: (key: string, store?: Store) => boolean;
 
-type StateTokenIndex<Token extends AtomToken<unknown> | ReadonlySelectorToken<unknown> | SelectorToken<unknown>> = Record<string, Token | {
-    key: string;
-    familyMembers: Record<string, Token>;
-}>;
-type AtomTokenIndex = StateTokenIndex<AtomToken<unknown>>;
-type SelectorTokenIndex = StateTokenIndex<ReadonlySelectorToken<unknown> | SelectorToken<unknown>>;
-declare const attachMetaAtoms: (store?: Store) => ReadonlySelectorToken<AtomTokenIndex>;
-declare const attachMetaSelectors: (store?: Store) => ReadonlySelectorToken<SelectorTokenIndex>;
-
-declare const attachMetaState: (store?: Store) => {
-    atomTokenIndexState: ReadonlySelectorToken<AtomTokenIndex>;
-    selectorTokenIndexState: ReadonlySelectorToken<SelectorTokenIndex>;
-};
-
-type index$1_AtomTokenIndex = AtomTokenIndex;
-type index$1_SelectorTokenIndex = SelectorTokenIndex;
-type index$1_StateTokenIndex<Token extends AtomToken<unknown> | ReadonlySelectorToken<unknown> | SelectorToken<unknown>> = StateTokenIndex<Token>;
-declare const index$1_attachMetaAtoms: typeof attachMetaAtoms;
-declare const index$1_attachMetaSelectors: typeof attachMetaSelectors;
-declare const index$1_attachMetaState: typeof attachMetaState;
-declare namespace index$1 {
-  export {
-    index$1_AtomTokenIndex as AtomTokenIndex,
-    index$1_SelectorTokenIndex as SelectorTokenIndex,
-    index$1_StateTokenIndex as StateTokenIndex,
-    index$1_attachMetaAtoms as attachMetaAtoms,
-    index$1_attachMetaSelectors as attachMetaSelectors,
-    index$1_attachMetaState as attachMetaState,
-  };
-}
-
 type OperationProgress = {
     open: false;
 } | {
     open: true;
     done: Set<string>;
-    prev: Hamt<any, string>;
+    prev: Map<string, any>;
     time: number;
     token: StateToken<any>;
 };
@@ -333,7 +302,7 @@ type Timeline = {
     selectorTime: number | null;
     transactionKey: string | null;
     install: (store: Store) => void;
-    subject: Subject<TimelineAtomUpdate | TimelineSelectorUpdate | TimelineTransactionUpdate>;
+    subject: Subject<TimelineAtomUpdate | TimelineSelectorUpdate | TimelineTransactionUpdate | `redo` | `undo`>;
 };
 declare function timeline__INTERNAL(options: TimelineOptions, store?: Store, data?: Timeline | null): TimelineToken;
 
@@ -444,7 +413,6 @@ declare namespace index {
   export {
     index_Atom as Atom,
     index_IMPLICIT as IMPLICIT,
-    index$1 as META,
     index_OperationProgress as OperationProgress,
     index_ReadonlySelector as ReadonlySelector,
     index_Selector as Selector,