atom.io 0.6.4 → 0.6.6

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,5 @@
 import { Hamt } from 'hamt_plus';
-import { Refinement } from 'fp-ts/lib/Refinement';
+import { Refinement } from 'fp-ts/Refinement';
 
 type ƒn = (...parameters: any[]) => any;
 
@@ -86,8 +86,9 @@ interface Store {
     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,37 +170,6 @@ 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;
 } | {
@@ -333,7 +303,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 +414,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,5 @@
 import { Hamt } from 'hamt_plus';
-import { Refinement } from 'fp-ts/lib/Refinement';
+import { Refinement } from 'fp-ts/Refinement';
 
 type ƒn = (...parameters: any[]) => any;
 
@@ -86,8 +86,9 @@ interface Store {
     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,37 +170,6 @@ 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;
 } | {
@@ -333,7 +303,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 +414,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.js

@@ -88,7 +88,6 @@ var capitalize = (str) => str[0].toUpperCase() + str.slice(1);
 var internal_exports = {};
 __export(internal_exports, {
   IMPLICIT: () => IMPLICIT,
-  META: () => meta_exports,
   Subject: () => Subject,
   TRANSACTION_PHASES: () => TRANSACTION_PHASES,
   abortTransaction: () => abortTransaction,
@@ -672,12 +671,13 @@ var createStore = (name, store = null) => {
     transactions: import_hamt_plus2.default.make(),
     timelines: import_hamt_plus2.default.make(),
     timelineAtoms: new Join({ relationType: `1:n` }).from(`timelineKey`).to(`atomKey`),
-    subject: __spreadValues({
+    subject: {
       atomCreation: new Subject(),
       selectorCreation: new Subject(),
       transactionCreation: new Subject(),
-      timelineCreation: new Subject()
-    }, store == null ? void 0 : store.subject),
+      timelineCreation: new Subject(),
+      operationStatus: new Subject()
+    },
     operation: __spreadValues({
       open: false
     }, store == null ? void 0 : store.operation),
@@ -750,6 +750,7 @@ var closeOperation = (store) => {
   const core = target(store);
   core.operation = { open: false };
   (_a = store.config.logger) == null ? void 0 : _a.info(`\u{1F534} operation done`);
+  store.subject.operationStatus.next(core.operation);
 };
 var isDone = (key, store = IMPLICIT.STORE) => {
   var _a;
@@ -982,120 +983,6 @@ function selectorFamily__INTERNAL(options, store = IMPLICIT.STORE) {
   );
 }
 
-// src/internal/meta/index.ts
-var meta_exports = {};
-__export(meta_exports, {
-  attachMetaAtoms: () => attachMetaAtoms,
-  attachMetaSelectors: () => attachMetaSelectors,
-  attachMetaState: () => attachMetaState
-});
-
-// src/internal/meta/meta-state.ts
-var attachMetaAtoms = (store = IMPLICIT.STORE) => {
-  const atomTokenIndexState__INTERNAL = atom({
-    key: `\u{1F441}\u200D\u{1F5E8}_atom_token_index__INTERNAL`,
-    default: () => [...store.atoms].reduce((acc, [key]) => {
-      acc[key] = { key, type: `atom` };
-      return acc;
-    }, {}),
-    effects: [
-      ({ setSelf }) => {
-        store.subject.atomCreation.subscribe((atomToken) => {
-          if (store.operation.open) {
-            return;
-          }
-          setSelf((state) => {
-            const { key, family } = atomToken;
-            if (family) {
-              const { key: familyKey, subKey } = family;
-              const current = state[familyKey];
-              if (current === void 0 || `familyMembers` in current) {
-                const familyKeyState = current || {
-                  key: familyKey,
-                  familyMembers: {}
-                };
-                return __spreadProps(__spreadValues({}, state), {
-                  [familyKey]: __spreadProps(__spreadValues({}, familyKeyState), {
-                    familyMembers: __spreadProps(__spreadValues({}, familyKeyState.familyMembers), {
-                      [subKey]: atomToken
-                    })
-                  })
-                });
-              }
-            }
-            return __spreadProps(__spreadValues({}, state), {
-              [key]: atomToken
-            });
-          });
-        });
-      }
-    ]
-  });
-  return selector({
-    key: `\u{1F441}\u200D\u{1F5E8}_atom_token_index`,
-    get: ({ get }) => get(atomTokenIndexState__INTERNAL)
-  });
-};
-var attachMetaSelectors = (store = IMPLICIT.STORE) => {
-  const readonlySelectorTokenIndexState__INTERNAL = atom({
-    key: `\u{1F441}\u200D\u{1F5E8}_selector_token_index__INTERNAL`,
-    default: () => Object.assign(
-      [...store.readonlySelectors].reduce((acc, [key]) => {
-        acc[key] = { key, type: `readonly_selector` };
-        return acc;
-      }, {}),
-      [...store.selectors].reduce((acc, [key]) => {
-        acc[key] = { key, type: `selector` };
-        return acc;
-      }, {})
-    ),
-    effects: [
-      ({ setSelf }) => {
-        store.subject.selectorCreation.subscribe((selectorToken) => {
-          if (store.operation.open) {
-            return;
-          }
-          setSelf((state) => {
-            const { key, family } = selectorToken;
-            if (family) {
-              const { key: familyKey, subKey } = family;
-              const current = state[familyKey];
-              if (current === void 0 || `familyMembers` in current) {
-                const familyKeyState = current || {
-                  key: familyKey,
-                  familyMembers: {}
-                };
-                return __spreadProps(__spreadValues({}, state), {
-                  [familyKey]: __spreadProps(__spreadValues({}, familyKeyState), {
-                    familyMembers: __spreadProps(__spreadValues({}, familyKeyState.familyMembers), {
-                      [subKey]: selectorToken
-                    })
-                  })
-                });
-              }
-            }
-            return __spreadProps(__spreadValues({}, state), {
-              [key]: selectorToken
-            });
-          });
-        });
-      }
-    ]
-  });
-  return selector({
-    key: `\u{1F441}\u200D\u{1F5E8}_selector_token_index`,
-    get: ({ get }) => get(readonlySelectorTokenIndexState__INTERNAL)
-  });
-};
-
-// src/internal/meta/attach-meta.ts
-var attachMetaState = (store = IMPLICIT.STORE) => {
-  return {
-    atomTokenIndexState: attachMetaAtoms(store),
-    selectorTokenIndexState: attachMetaSelectors(store)
-  };
-};
-
 // src/internal/selector-internal.ts
 var import_hamt_plus9 = __toESM(require("hamt_plus"));
 
@@ -1478,6 +1365,7 @@ var redo__INTERNAL = (token, store = IMPLICIT.STORE) => {
     }
   }
   ++timelineData.at;
+  timelineData.subject.next(`redo`);
   timelineData.timeTraveling = false;
   (_d = store.config.logger) == null ? void 0 : _d.info(
     `\u23F9\uFE0F "${token.key}" is now at ${timelineData.at} / ${timelineData.history.length}`
@@ -1517,6 +1405,7 @@ var undo__INTERNAL = (token, store = IMPLICIT.STORE) => {
       break;
     }
   }
+  timelineData.subject.next(`undo`);
   timelineData.timeTraveling = false;
   (_d = store.config.logger) == null ? void 0 : _d.info(
     `\u23F9\uFE0F "${token.key}" is now at ${timelineData.at} / ${timelineData.history.length}`
@@ -1555,9 +1444,6 @@ var addAtomToTimeline = (atomToken, atoms, tl, store = IMPLICIT.STORE) => {
             `Timeline "${tl.key}" has a selectorTime, but no history. This is most likely a bug in AtomIO.`
           );
         }
-        if (mostRecentUpdate.type === `selector_update`) {
-          tl.subject.next(mostRecentUpdate);
-        }
       }
       if (currentTransactionKey && store.transactionStatus.phase === `applying`) {
         const currentTransaction = withdraw(
@@ -1578,6 +1464,7 @@ var addAtomToTimeline = (atomToken, atoms, tl, store = IMPLICIT.STORE) => {
           tl.transactionKey = currentTransactionKey;
           const subscription = currentTransaction.subject.subscribe((update2) => {
             var _a2;
+            subscription.unsubscribe();
             if (tl.timeTraveling === false && currentTransactionTime) {
               if (tl.at !== tl.history.length) {
                 tl.history.splice(tl.at);
@@ -1591,10 +1478,9 @@ var addAtomToTimeline = (atomToken, atoms, tl, store = IMPLICIT.STORE) => {
                 )
               });
               tl.history.push(timelineTransactionUpdate);
+              tl.at = tl.history.length;
               tl.subject.next(timelineTransactionUpdate);
             }
-            tl.at = tl.history.length;
-            subscription.unsubscribe();
             tl.transactionKey = null;
             (_a2 = store.config.logger) == null ? void 0 : _a2.info(
               `\u231B timeline "${tl.key}" got a transaction_update "${update2.key}"`
@@ -1602,29 +1488,29 @@ var addAtomToTimeline = (atomToken, atoms, tl, store = IMPLICIT.STORE) => {
           });
         }
       } else if (currentSelectorKey && currentSelectorTime) {
+        let latestUpdate = tl.history.at(-1);
         if (currentSelectorTime !== tl.selectorTime) {
-          const newSelectorUpdate = {
+          latestUpdate = {
             type: `selector_update`,
             timestamp: currentSelectorTime,
             key: currentSelectorKey,
             atomUpdates: []
           };
-          newSelectorUpdate.atomUpdates.push(__spreadValues({
+          latestUpdate.atomUpdates.push(__spreadValues({
             key: atom2.key,
             type: `atom_update`
           }, update));
           if (tl.at !== tl.history.length) {
             tl.history.splice(tl.at);
           }
-          tl.history.push(newSelectorUpdate);
+          tl.history.push(latestUpdate);
           (_c = store.config.logger) == null ? void 0 : _c.info(
             `\u231B timeline "${tl.key}" got a selector_update "${currentSelectorKey}" with`,
-            newSelectorUpdate.atomUpdates.map((atomUpdate) => atomUpdate.key)
+            latestUpdate.atomUpdates.map((atomUpdate) => atomUpdate.key)
           );
           tl.at = tl.history.length;
           tl.selectorTime = currentSelectorTime;
         } else {
-          const latestUpdate = tl.history.at(-1);
           if ((latestUpdate == null ? void 0 : latestUpdate.type) === `selector_update`) {
             latestUpdate.atomUpdates.push(__spreadValues({
               key: atom2.key,
@@ -1636,6 +1522,8 @@ var addAtomToTimeline = (atomToken, atoms, tl, store = IMPLICIT.STORE) => {
             );
           }
         }
+        if (latestUpdate)
+          tl.subject.next(latestUpdate);
       } else {
         const timestamp = Date.now();
         tl.selectorTime = null;
@@ -1652,7 +1540,7 @@ var addAtomToTimeline = (atomToken, atoms, tl, store = IMPLICIT.STORE) => {
         tl.history.push(atomUpdate);
         tl.subject.next(atomUpdate);
         (_e = store.config.logger) == null ? void 0 : _e.info(
-          `\u231B timeline "${tl.key}" got a state_update to "${atom2.key}"`
+          `\u231B timeline "${tl.key}" got an atom_update to "${atom2.key}"`
         );
         tl.at = tl.history.length;
       }