atom.io 0.31.0 → 0.31.1

package/dist/index.d.ts

@@ -1,47 +1,71 @@
-import { Transceiver, Func, EnvironmentData, Store, Each, Flat, Timeline, TimelineAtomUpdate, TimelineMoleculeCreation, TimelineMoleculeDisposal, TimelineSelectorUpdate, TimelineStateCreation, TimelineStateDisposal, TimelineTransactionUpdate } from 'atom.io/internal';
+import { Transceiver, Func, EnvironmentData, Timeline, TimelineAtomUpdate, TimelineMoleculeCreation, TimelineMoleculeDisposal, TimelineSelectorUpdate, TimelineStateCreation, TimelineStateDisposal, TimelineTransactionUpdate, Store, Each, Flat } from 'atom.io/internal';
 import { Json, JsonInterface, Canonical, stringified } from 'atom.io/json';
 import { getState as getState$1, setState as setState$1, ReadableFamilyToken as ReadableFamilyToken$1, ReadableToken as ReadableToken$1, RegularAtomToken as RegularAtomToken$1, MutableAtomToken as MutableAtomToken$1, WritableSelectorToken as WritableSelectorToken$1, ReadonlySelectorToken as ReadonlySelectorToken$1, WritableToken as WritableToken$1, RegularAtomFamilyToken as RegularAtomFamilyToken$1, MutableAtomFamilyToken as MutableAtomFamilyToken$1, WritableSelectorFamilyToken as WritableSelectorFamilyToken$1, ReadonlySelectorFamilyToken as ReadonlySelectorFamilyToken$1, WritableFamilyToken as WritableFamilyToken$1 } from 'atom.io';
 import { findState } from 'atom.io/ephemeral';
 import { seekState } from 'atom.io/immortal';
 
+/**
+ * @public
+ * Create a mutable atom, a global reactive variable in the implicit store
+ *
+ * The value of a mutable atom must be some kind of {@link Transceiver}.
+ *
+ * @param options - {@link MutableAtomOptions}.
+ * @returns
+ * A reference to the atom created: a {@link MutableAtomToken}
+ * @overload Mutable
+ */
+declare function atom<T extends Transceiver<any>, J extends Json.Serializable>(options: MutableAtomOptions<T, J>): MutableAtomToken<T, J>;
+/**
+ * @public
+ * Create a regular atom, a global reactive variable in the implicit store
+ * @param options - {@link RegularAtomOptions}.
+ * @returns
+ * A reference to the atom created: a {@link RegularAtomToken}
+ * @overload Regular
+ */
+declare function atom<T>(options: RegularAtomOptions<T>): RegularAtomToken<T>;
+/** @public */
 type Effectors<T> = {
-    setSelf: <V extends T>(next: V | ((oldValue: T) => V)) => void;
+    /**
+     * Set the value of the atom
+     * @param next - The new value of the atom, or a setter function
+     */
+    setSelf: <New extends T>(next: New | Setter<T, New>) => void;
+    /** Subscribe to changes to the atom */
     onSet: (callback: (options: {
         newValue: T;
         oldValue: T;
     }) => void) => void;
 };
+/**
+ * @public
+ * A function that runs side effects when the atom is set
+ * @param tools - {@link Effectors} that can be used to run side effects
+ * @returns
+ * Optionally, a cleanup function that will be called when the atom is disposed
+ */
 type AtomEffect<T> = (tools: Effectors<T>) => (() => void) | void;
+/** @public */
 type RegularAtomOptions<T> = {
+    /** The unique identifier of the atom */
     key: string;
+    /** The starting value of the atom */
     default: T | (() => T);
+    /** Hooks used to run side effects when the atom is set */
     effects?: AtomEffect<T>[];
 };
 type MutableAtomOptions<T extends Transceiver<any>, J extends Json.Serializable> = JsonInterface<T, J> & Omit<RegularAtomOptions<T>, `default`> & {
     default: () => T;
     mutable: true;
 };
-/**
- * @public
- * Declare a mutable global reactive variable.
- * @param options - Configuration for this mutable atom.
- * @returns
- * The token for your mutable atom.
- * @overload Mutable
- */
-declare function atom<T extends Transceiver<any>, J extends Json.Serializable>(options: MutableAtomOptions<T, J>): MutableAtomToken<T, J>;
-/**
- * @public
- * Declare a regular global reactive variable.
- * @param options - Configuration for this regular atom.
- * @returns
- * The token for your regular atom.
- * @overload Regular
- */
-declare function atom<T>(options: RegularAtomOptions<T>): RegularAtomToken<T>;
+/** @public */
 type RegularAtomFamilyOptions<T, K extends Canonical> = {
+    /** The unique identifier of the atom family */
     key: string;
+    /** The starting value of the atom family */
     default: T | ((key: K) => T);
+    /** Hooks used to run side effects when an atom in the family is set  */
     effects?: (key: K) => AtomEffect<T>[];
 };
 type RegularAtomFamilyToken<T, K extends Canonical> = {
@@ -153,7 +177,26 @@ type ReadonlySelectorOptions<T> = {
     key: string;
     get: Read<() => T>;
 };
+/**
+ * @public
+ * Declare a selector. The value of a selector should depend
+ * on the value of atoms or other selectors in the store.
+ *
+ * A writable selector can be "set" to a new value.
+ * It is advised to set its dependencies to values
+ * that would produce the new value of the selector.
+ * @param options - {@link WritableSelectorOptions}.
+ * @returns
+ * The token for your selector.
+ * @overload Writable
+ */
 declare function selector<T>(options: WritableSelectorOptions<T>): WritableSelectorToken<T>;
+/**
+ * @public
+ * Declare a selector. The value of a selector should depend
+ * on the value of atoms or other selectors in the store.
+ * @param options - {@link ReadonlySelectorOptions}.
+ */
 declare function selector<T>(options: ReadonlySelectorOptions<T>): ReadonlySelectorToken<T>;
 type WritableSelectorFamilyOptions<T, K extends Canonical> = {
     key: string;
@@ -180,73 +223,55 @@ type SelectorFamilyToken<T, K extends Canonical> = ReadonlySelectorFamilyToken<T
 declare function selectorFamily<T, K extends Canonical>(options: WritableSelectorFamilyOptions<T, K>): WritableSelectorFamilyToken<T, K>;
 declare function selectorFamily<T, K extends Canonical>(options: ReadonlySelectorFamilyOptions<T, K>): ReadonlySelectorFamilyToken<T, K>;
 
-declare const $claim: unique symbol;
-type Claim<K extends Canonical> = K & {
-    [$claim]?: true;
-};
-declare function allocateIntoStore<H extends Hierarchy, V extends Vassal<H>, A extends Above<V, H>>(store: Store, provenance: A, key: V, dependsOn?: `all` | `any`): Claim<V>;
-declare function fuseWithinStore<H extends Hierarchy, C extends CompoundFrom<H>, T extends C extends CompoundTypedKey<infer t, any, any> ? t : never, A extends C extends CompoundTypedKey<any, infer a, any> ? a : never, B extends C extends CompoundTypedKey<any, any, infer b> ? b : never>(store: Store, type: T, sideA: SingularTypedKey<A>, sideB: SingularTypedKey<B>): Claim<CompoundTypedKey<T, A, B>>;
-declare function deallocateFromStore<H extends Hierarchy, V extends Vassal<H>>(store: Store, claim: Claim<V>): void;
-declare function claimWithinStore<H extends Hierarchy, V extends Exclude<Vassal<H>, CompoundTypedKey>, A extends Above<V, H>>(store: Store, newProvenance: A, claim: Claim<V>, exclusive?: `exclusive`): Claim<V>;
-declare class Realm<H extends Hierarchy> {
-    store: Store;
-    constructor(store?: Store);
-    allocate<V extends Vassal<H>, A extends Above<V, H>>(provenance: A, key: V, attachmentStyle?: `all` | `any`): Claim<V>;
-    fuse<C extends CompoundFrom<H>, T extends C extends CompoundTypedKey<infer t, any, any> ? t : never, A extends C extends CompoundTypedKey<any, infer v, any> ? v : never, B extends C extends CompoundTypedKey<any, any, infer m> ? m : never>(type: T, reagentA: SingularTypedKey<A>, reagentB: SingularTypedKey<B>): Claim<CompoundTypedKey<T, A, B>>;
-    deallocate<V extends Vassal<H>>(claim: Claim<V>): void;
-    claim<V extends Exclude<Vassal<H>, CompoundTypedKey>, A extends Above<V, H>>(newProvenance: A, claim: Claim<V>, exclusive?: `exclusive`): Claim<V>;
-}
-declare const T$ = "T$";
-type T$ = typeof T$;
-type TypeTag<T extends string> = `${T$}--${T}`;
-type SingularTypedKey<T extends string = string> = `${T}::${string}`;
-type CompoundTypedKey<A extends string = string, B extends string = string, C extends string = string> = `${TypeTag<A>}==${SingularTypedKey<B>}++${SingularTypedKey<C>}`;
-type TypedKey<A extends string = string, B extends string = string, C extends string = string> = CompoundTypedKey<A, B, C> | SingularTypedKey<A>;
-type Scope = SingularTypedKey[];
-type MutualFealty = {
-    above: Scope;
-    below: CompoundTypedKey;
+type TimelineManageable = AtomFamilyToken<any, any> | AtomToken<any>;
+type AtomOnly<M extends TimelineManageable> = M extends AtomFamilyToken<any, any> ? AtomToken<any> : M extends AtomToken<any> ? M : never;
+type TimelineToken<M> = {
+    key: string;
+    type: `timeline`;
+    __M?: M;
 };
-type ExclusiveFealty = {
-    above: TypedKey | `root`;
-    below: Scope;
+type TimelineOptions<ManagedAtom extends TimelineManageable> = {
+    key: string;
+    scope: ManagedAtom[];
+    shouldCapture?: (update: TimelineUpdate<ManagedAtom>, timeline: Timeline<TimelineManageable>) => boolean;
 };
-type Fealty = ExclusiveFealty | MutualFealty;
-type Hierarchy<F extends Fealty[] = Fealty[]> = Each<F>;
-type Vassal<H extends Hierarchy> = {
-    [K in keyof H]: H[K] extends MutualFealty ? H[K][`below`] : H[K] extends {
-        below: Array<infer V>;
-    } ? V extends TypedKey ? V : never : never;
-}[keyof H];
-type Above<TK extends TypedKey, H extends Hierarchy> = {
-    [K in keyof H]: H[K] extends MutualFealty ? TK extends H[K][`below`] ? H[K][`above`] : never : H[K] extends {
-        below: Array<infer V>;
-    } ? TK extends V ? H[K] extends ExclusiveFealty ? H[K][`above`] : never : never : never;
-}[keyof H];
-type Below<TK extends TypedKey | TypedKey[], H extends Hierarchy> = {
-    [K in keyof H]: H[K] extends MutualFealty ? TK extends H[K][`above`] ? H[K][`below`] : TK extends H[K][`above`][number] ? H[K][`below`] : never : H[K] extends {
-        above: infer V;
-    } ? TK extends V ? H[K] extends ExclusiveFealty ? H[K][`below`][number] : never : never : never;
-}[keyof H];
-type Mutuals<TK extends TypedKey | TypedKey[], H extends Hierarchy> = {
-    [K in keyof H]: H[K] extends MutualFealty ? TK extends H[K][`above`][number] ? [mutual: Exclude<H[K][`above`][number], TK>, below: H[K][`below`]] : never : never;
-}[keyof H];
-type CompoundFrom<H extends Hierarchy> = {
-    [K in keyof H]: H[K] extends MutualFealty ? H[K][`below`] : never;
-}[keyof H];
-declare class Anarchy {
-    store: Store;
-    realm: Realm<any>;
-    constructor(store?: Store);
-    allocate(provenance: Canonical, key: Canonical, attachmentStyle?: `all` | `any`): void;
-    deallocate(key: Canonical): void;
-    claim(newProvenance: Canonical, key: Canonical, exclusive?: `exclusive`): void;
-}
+type TimelineUpdate<ManagedAtom extends TimelineManageable> = TimelineAtomUpdate<ManagedAtom> | TimelineMoleculeCreation | TimelineMoleculeDisposal | TimelineSelectorUpdate<ManagedAtom> | TimelineStateCreation<AtomOnly<ManagedAtom>> | TimelineStateDisposal<AtomOnly<ManagedAtom>> | TimelineTransactionUpdate;
+declare const timeline: <ManagedAtom extends TimelineManageable>(options: TimelineOptions<ManagedAtom>) => TimelineToken<ManagedAtom>;
+declare const redo: (tl: TimelineToken<any>) => void;
+declare const undo: (tl: TimelineToken<any>) => void;
 
+/**
+ * @public
+ * Disposes of a state in the implicit store
+ * @param token - The token of the state to dispose
+ * @overload Default
+ */
 declare function disposeState(token: ReadableToken<any>): void;
+/**
+ * @public
+ * Disposes of a state family in the implicit store
+ * @param token - The token of the state family to dispose
+ * @param key - The unique key of the state to dispose
+ */
 declare function disposeState<K extends Canonical>(token: ReadableFamilyToken<any, K>, key: K): void;
 
+/**
+ * @public
+ * Get the current value of a state
+ * @param token - The token of the state to get
+ * @return The current value of the state
+ * @overload Default
+ * @default
+ */
 declare function getState<T>(token: ReadableToken<T>): T;
+/**
+ * @public
+ * Get the current value of a state family
+ * @param token - The token of a state family
+ * @param key - The unique key of the state to get
+ * @return The current value of the state
+ * @overload Streamlined
+ */
 declare function getState<T, K extends Canonical, Key extends K>(token: ReadableFamilyToken<T, K>, key: Key): T;
 
 declare const LoggerIconDictionary: {
@@ -319,26 +344,91 @@ declare class AtomIOLogger implements Logger {
     warn: LogFn;
 }
 
-declare function makeRootMoleculeInStore<S extends string>(key: S, store?: Store): S;
+declare const $claim: unique symbol;
+type Claim<K extends Canonical> = K & {
+    [$claim]?: true;
+};
+declare class Realm<H extends Hierarchy> {
+    store: Store;
+    constructor(store?: Store);
+    allocate<V extends Vassal<H>, A extends Above<V, H>>(provenance: A, key: V, attachmentStyle?: `all` | `any`): Claim<V>;
+    fuse<C extends CompoundFrom<H>, T extends C extends CompoundTypedKey<infer t, any, any> ? t : never, A extends C extends CompoundTypedKey<any, infer v, any> ? v : never, B extends C extends CompoundTypedKey<any, any, infer m> ? m : never>(type: T, reagentA: SingularTypedKey<A>, reagentB: SingularTypedKey<B>): Claim<CompoundTypedKey<T, A, B>>;
+    deallocate<V extends Vassal<H>>(claim: Claim<V>): void;
+    claim<V extends Exclude<Vassal<H>, CompoundTypedKey>, A extends Above<V, H>>(newProvenance: A, claim: Claim<V>, exclusive?: `exclusive`): Claim<V>;
+}
+declare class Anarchy {
+    store: Store;
+    realm: Realm<any>;
+    constructor(store?: Store);
+    allocate(provenance: Canonical, key: Canonical, attachmentStyle?: `all` | `any`): void;
+    deallocate(key: Canonical): void;
+    claim(newProvenance: Canonical, key: Canonical, exclusive?: `exclusive`): void;
+}
+declare const T$ = "T$";
+type T$ = typeof T$;
+type TypeTag<T extends string> = `${T$}--${T}`;
+type SingularTypedKey<T extends string = string> = `${T}::${string}`;
+type CompoundTypedKey<A extends string = string, B extends string = string, C extends string = string> = `${TypeTag<A>}==${SingularTypedKey<B>}++${SingularTypedKey<C>}`;
+type TypedKey<A extends string = string, B extends string = string, C extends string = string> = CompoundTypedKey<A, B, C> | SingularTypedKey<A>;
+type Scope = SingularTypedKey[];
+type MutualFealty = {
+    above: Scope;
+    below: CompoundTypedKey;
+};
+type ExclusiveFealty = {
+    above: TypedKey | `root`;
+    below: Scope;
+};
+type Fealty = ExclusiveFealty | MutualFealty;
+type Hierarchy<F extends Fealty[] = Fealty[]> = Each<F>;
+type Vassal<H extends Hierarchy> = {
+    [K in keyof H]: H[K] extends MutualFealty ? H[K][`below`] : H[K] extends {
+        below: Array<infer V>;
+    } ? V extends TypedKey ? V : never : never;
+}[keyof H];
+type Above<TK extends TypedKey, H extends Hierarchy> = {
+    [K in keyof H]: H[K] extends MutualFealty ? TK extends H[K][`below`] ? H[K][`above`] : never : H[K] extends {
+        below: Array<infer V>;
+    } ? TK extends V ? H[K] extends ExclusiveFealty ? H[K][`above`] : never : never : never;
+}[keyof H];
+type Below<TK extends TypedKey | TypedKey[], H extends Hierarchy> = {
+    [K in keyof H]: H[K] extends MutualFealty ? TK extends H[K][`above`] ? H[K][`below`] : TK extends H[K][`above`][number] ? H[K][`below`] : never : H[K] extends {
+        above: infer V;
+    } ? TK extends V ? H[K] extends ExclusiveFealty ? H[K][`below`][number] : never : never : never;
+}[keyof H];
+type Mutuals<TK extends TypedKey | TypedKey[], H extends Hierarchy> = {
+    [K in keyof H]: H[K] extends MutualFealty ? TK extends H[K][`above`][number] ? [mutual: Exclude<H[K][`above`][number], TK>, below: H[K][`below`]] : never : never;
+}[keyof H];
+type CompoundFrom<H extends Hierarchy> = {
+    [K in keyof H]: H[K] extends MutualFealty ? H[K][`below`] : never;
+}[keyof H];
 
+/**
+ * @public
+ * A function that sets the value of a state.
+ * @param oldValue - The current value of the state.
+ * @returns
+ * The new value of the state.
+ */
+type Setter<T, New extends T> = (oldValue: T) => New;
 /**
  * @public
  * Set the value of a state into the implicit store.
- * @param token - The unique identifier of the state to set.
+ * @param token - An atom or writable selector token.
  * @param value - The new value of the state.
  * @overload Default
  * @default
  */
-declare function setState<T, New extends T>(token: WritableToken<T>, value: New | ((oldValue: T) => New)): void;
+declare function setState<T, New extends T>(token: WritableToken<T>, value: New | Setter<T, New>): void;
 /**
  * @public
  * Set the value of a state into the implicit store.
- * @param token - The unique identifier of a state family.
- * @param key - The key of the state to set.
+ * @param token - An atom family or writable selector family token.
+ * @param key - The unique key of the state to set.
  * @param value - The new value of the state.
  * @overload Streamlined
  */
-declare function setState<T, K extends Canonical, New extends T, Key extends K>(token: WritableFamilyToken<T, K>, key: Key, value: New | ((oldValue: T) => New)): void;
+declare function setState<T, K extends Canonical, New extends T, Key extends K>(token: WritableFamilyToken<T, K>, key: Key, value: New | Setter<T, New>): void;
 
 declare class Silo {
     store: Store;
@@ -356,6 +446,7 @@ declare class Silo {
     undo: typeof undo;
     redo: typeof redo;
     runTransaction: typeof runTransaction;
+    install: (tokens: AtomIOToken[], store?: Store) => void;
     constructor(config: Store[`config`], fromStore?: Store | null);
 }
 
@@ -374,23 +465,6 @@ declare function subscribe<T>(token: ReadableToken<T>, handleUpdate: UpdateHandl
 declare function subscribe<F extends Func>(token: TransactionToken<F>, handleUpdate: TransactionUpdateHandler<F>, key?: string): () => void;
 declare function subscribe<M extends TimelineManageable>(token: TimelineToken<M>, handleUpdate: (update: TimelineUpdate<M> | `redo` | `undo`) => void, key?: string): () => void;
 
-type TimelineManageable = AtomFamilyToken<any, any> | AtomToken<any>;
-type AtomOnly<M extends TimelineManageable> = M extends AtomFamilyToken<any, any> ? AtomToken<any> : M extends AtomToken<any> ? M : never;
-type TimelineToken<M> = {
-    key: string;
-    type: `timeline`;
-    __M?: M;
-};
-type TimelineOptions<ManagedAtom extends TimelineManageable> = {
-    key: string;
-    scope: ManagedAtom[];
-    shouldCapture?: (update: TimelineUpdate<ManagedAtom>, timeline: Timeline<TimelineManageable>) => boolean;
-};
-type TimelineUpdate<ManagedAtom extends TimelineManageable> = TimelineAtomUpdate<ManagedAtom> | TimelineMoleculeCreation | TimelineMoleculeDisposal | TimelineSelectorUpdate<ManagedAtom> | TimelineStateCreation<AtomOnly<ManagedAtom>> | TimelineStateDisposal<AtomOnly<ManagedAtom>> | TimelineTransactionUpdate;
-declare const timeline: <ManagedAtom extends TimelineManageable>(options: TimelineOptions<ManagedAtom>) => TimelineToken<ManagedAtom>;
-declare const redo: (tl: TimelineToken<any>) => void;
-declare const undo: (tl: TimelineToken<any>) => void;
-
 type TokenType<Comparison extends ReadableFamilyToken$1<any, any> | ReadableToken$1<any>> = Comparison extends ReadableToken$1<infer RepresentedValue> ? RepresentedValue : Comparison extends ReadableFamilyToken$1<infer RepresentedValue, any> ? RepresentedValue : never;
 declare function isToken<KnownToken extends RegularAtomToken$1<any>>(knownToken: KnownToken, unknownToken: ReadableToken$1<any>): unknownToken is RegularAtomToken$1<TokenType<KnownToken>>;
 declare function isToken<KnownToken extends MutableAtomToken$1<any, any>>(knownToken: KnownToken, unknownToken: ReadableToken$1<any>): unknownToken is MutableAtomToken$1<TokenType<KnownToken>, any>;
@@ -405,40 +479,98 @@ declare function belongsTo<Family extends ReadonlySelectorFamilyToken$1<any, any
 declare function belongsTo<Family extends WritableFamilyToken$1<any, any>>(family: Family, unknownToken: ReadableToken$1<any>): unknownToken is WritableToken$1<TokenType<Family>>;
 declare function belongsTo<Family extends ReadableFamilyToken$1<any, any>>(family: Family, unknownToken: ReadableToken$1<any>): unknownToken is ReadableToken$1<TokenType<Family>>;
 
+/**
+ * @public
+ * A token is an object that uniquely identifies a particular state, family, timeline, or transaction.
+ *
+ * While they represent one of these resources, they are not the resource itself. Think of them like paper currency representing money in the bank.
+ *
+ * Tokens are returned from resource creation functions, such as {@link atom} and {@link transaction}.
+ *
+ * Tokens can be used as parameters to functions that take a token, such as {@link getState}, {@link setState}, or {@link runTransaction}.
+ *
+ * Tokens are fully serializable, so they can be passed between processes.
+ */
+type AtomIOToken = ReadableFamilyToken<any, any> | ReadableToken<any> | TimelineToken<any> | TransactionToken<any>;
+/** @public */
 type RegularAtomToken<T, K extends Canonical = any> = {
+    /** The unique identifier of the atom. */
     key: string;
+    /** Discriminator. */
     type: `atom`;
+    /** Present if the atom belongs to a family. */
     family?: FamilyMetadata<K>;
+    /** Never present. This is a marker that preserves the type of the atom's value. */
     __T?: T;
 };
+/** @public */
 type MutableAtomToken<T extends Transceiver<any>, J extends Json.Serializable, K extends Canonical = any> = {
+    /** The unique identifier of the atom. */
     key: string;
+    /** Discriminator. */
     type: `mutable_atom`;
+    /** Present if the atom belongs to a family. */
     family?: FamilyMetadata<K>;
+    /** Never present. This is a marker that preserves the JSON form of the atom's transceiver value. */
     __J?: J;
+    /** Never present. This is a marker that preserves the type of the atom's transceiver value. */
     __U?: T extends Transceiver<infer Update> ? Update : never;
 };
+/** @public */
 type AtomToken<T, K extends Canonical = any> = MutableAtomToken<T extends Transceiver<any> ? T : never, any, K> | RegularAtomToken<T, K>;
+/** @public */
 type WritableSelectorToken<T, K extends Canonical = any> = {
+    /** The unique identifier of the selector. */
     key: string;
+    /** Discriminator. */
     type: `selector`;
+    /** Present if the selector belongs to a family. */
     family?: FamilyMetadata<K>;
+    /** Never present. This is a marker that preserves the type of the selector's value. */
     __T?: T;
 };
+/** @public */
 type ReadonlySelectorToken<T, K extends Canonical = any> = {
+    /** The unique identifier of the selector. */
     key: string;
+    /** Discriminator. */
     type: `readonly_selector`;
+    /** Present if the selector belongs to a family. */
     family?: FamilyMetadata<K>;
+    /** Never present. This is a marker that preserves the type of the selector's value. */
     __T?: T;
 };
+/** @public */
 type SelectorToken<T, K extends Canonical = any> = ReadonlySelectorToken<T, K> | WritableSelectorToken<T, K>;
+/**
+ * @public
+ * These states can be set.
+ */
 type WritableToken<T, K extends Canonical = any> = AtomToken<T, K> | WritableSelectorToken<T, K>;
+/**
+ * @public
+ * These states cannot be set.
+ */
 type ReadableToken<T, K extends Canonical = any> = AtomToken<T, K> | SelectorToken<T, K>;
+/**
+ * @public
+ * States belonging to this family can be set.
+ */
 type WritableFamilyToken<T, K extends Canonical> = AtomFamilyToken<T, K> | WritableSelectorFamilyToken<T, K>;
+/**
+ * @public
+ * States belonging to this family cannot be set.
+ */
 type ReadableFamilyToken<T, K extends Canonical> = AtomFamilyToken<T, K> | SelectorFamilyToken<T, K>;
+/**
+ * @public
+ * Identifies a state's connection to its family.
+ */
 type FamilyMetadata<K extends Canonical = any> = {
+    /** The family's unique key. */
     key: string;
+    /** The family member's unique identifier, in the form of a string. */
     subKey: stringified<K>;
 };
 
-export { $claim, type Above, type ActorToolkit, Anarchy, type AtomDisposal, type AtomEffect, type AtomFamilyToken, AtomIOLogger, type AtomOnly, type AtomToken, type Below, type Claim, type CompoundFrom, type CompoundTypedKey, type Effectors, type FamilyMetadata, type GetterToolkit, type Hierarchy, type KeyedStateUpdate, LOG_LEVELS, type LogFilter, type LogFn, type LogLevel, type Logger, type LoggerIcon, type MoleculeCreation, type MoleculeDisposal, type MoleculeTransfer, type MutableAtomFamilyOptions, type MutableAtomFamilyToken, type MutableAtomOptions, type MutableAtomToken, type Mutuals, type Read, type ReadableFamilyToken, type ReadableToken, type ReadonlySelectorFamilyOptions, type ReadonlySelectorFamilyToken, type ReadonlySelectorOptions, type ReadonlySelectorToken, Realm, type RegularAtomFamilyOptions, type RegularAtomFamilyToken, type RegularAtomOptions, type RegularAtomToken, type SelectorDisposal, type SelectorFamilyToken, type SelectorToken, type SetterToolkit, Silo, type SingularTypedKey, type StateCreation, type StateDisposal, type StateUpdate, T$, type TimelineManageable, type TimelineOptions, type TimelineToken, type TimelineUpdate, type TokenDenomination, type TokenType, type Transact, type TransactionIO, type TransactionOptions, type TransactionToken, type TransactionUpdate, type TransactionUpdateContent, type TransactionUpdateHandler, type TypeTag, type TypedKey, type UpdateHandler, type Vassal, type WritableFamilyToken, type WritableSelectorFamilyOptions, type WritableSelectorFamilyToken, type WritableSelectorOptions, type WritableSelectorToken, type WritableToken, type Write, allocateIntoStore, atom, atomFamily, belongsTo, claimWithinStore, deallocateFromStore, disposeState, fuseWithinStore, getState, isToken, makeRootMoleculeInStore, redo, runTransaction, selector, selectorFamily, setState, simpleLog, simpleLogger, subscribe, timeline, transaction, undo };
+export { $claim, type Above, type ActorToolkit, Anarchy, type AtomDisposal, type AtomEffect, type AtomFamilyToken, AtomIOLogger, type AtomIOToken, type AtomOnly, type AtomToken, type Below, type Claim, type CompoundFrom, type CompoundTypedKey, type Effectors, type FamilyMetadata, type GetterToolkit, type Hierarchy, type KeyedStateUpdate, LOG_LEVELS, type LogFilter, type LogFn, type LogLevel, type Logger, type LoggerIcon, type MoleculeCreation, type MoleculeDisposal, type MoleculeTransfer, type MutableAtomFamilyOptions, type MutableAtomFamilyToken, type MutableAtomOptions, type MutableAtomToken, type Mutuals, type Read, type ReadableFamilyToken, type ReadableToken, type ReadonlySelectorFamilyOptions, type ReadonlySelectorFamilyToken, type ReadonlySelectorOptions, type ReadonlySelectorToken, Realm, type RegularAtomFamilyOptions, type RegularAtomFamilyToken, type RegularAtomOptions, type RegularAtomToken, type SelectorDisposal, type SelectorFamilyToken, type SelectorToken, type Setter, type SetterToolkit, Silo, type SingularTypedKey, type StateCreation, type StateDisposal, type StateUpdate, T$, type TimelineManageable, type TimelineOptions, type TimelineToken, type TimelineUpdate, type TokenDenomination, type TokenType, type Transact, type TransactionIO, type TransactionOptions, type TransactionToken, type TransactionUpdate, type TransactionUpdateContent, type TransactionUpdateHandler, type TypeTag, type TypedKey, type UpdateHandler, type Vassal, type WritableFamilyToken, type WritableSelectorFamilyOptions, type WritableSelectorFamilyToken, type WritableSelectorOptions, type WritableSelectorToken, type WritableToken, type Write, atom, atomFamily, belongsTo, disposeState, getState, isToken, redo, runTransaction, selector, selectorFamily, setState, simpleLog, simpleLogger, subscribe, timeline, transaction, undo };

package/dist/index.js

@@ -1,7 +1,7 @@
-export { $claim, Anarchy, Realm, T$, allocateIntoStore, claimWithinStore, deallocateFromStore, fuseWithinStore, makeRootMoleculeInStore } from './chunk-ICGFFQ3H.js';
+import { newest, isChildStore, withdraw } from './chunk-Y5MBNTVU.js';
 import './chunk-XWL6SNVU.js';
 import * as Internal from 'atom.io/internal';
-import { createStandaloneAtom, IMPLICIT, createAtomFamily, createStandaloneSelector, createSelectorFamily, Store, createTransaction, createTimeline, findInStore, getFromStore, setIntoStore, disposeFromStore, subscribeInStore, timeTravel, actUponStore, arbitrary } from 'atom.io/internal';
+import { createStandaloneAtom, IMPLICIT, createAtomFamily, makeRootMoleculeInStore, allocateIntoStore, fuseWithinStore, deallocateFromStore, claimWithinStore, createStandaloneSelector, createSelectorFamily, Store, createTransaction, createTimeline, findInStore, getFromStore, setIntoStore, disposeFromStore, subscribeInStore, timeTravel, actUponStore, arbitrary } from 'atom.io/internal';
 
 function atom(options) {
   return createStandaloneAtom(IMPLICIT.STORE, options);
@@ -58,6 +58,54 @@ var AtomIOLogger = class {
     }
   };
 };
+var $claim = Symbol(`claim`);
+var Realm = class {
+  store;
+  constructor(store = IMPLICIT.STORE) {
+    this.store = store;
+    makeRootMoleculeInStore(`root`, store);
+  }
+  allocate(provenance, key, attachmentStyle) {
+    return allocateIntoStore(
+      this.store,
+      provenance,
+      key,
+      attachmentStyle
+    );
+  }
+  fuse(type, reagentA, reagentB) {
+    return fuseWithinStore(this.store, type, reagentA, reagentB);
+  }
+  deallocate(claim) {
+    deallocateFromStore(this.store, claim);
+  }
+  claim(newProvenance, claim, exclusive) {
+    return claimWithinStore(this.store, newProvenance, claim, exclusive);
+  }
+};
+var Anarchy = class {
+  store;
+  realm;
+  constructor(store = IMPLICIT.STORE) {
+    this.store = store;
+    this.realm = new Realm(store);
+  }
+  allocate(provenance, key, attachmentStyle) {
+    allocateIntoStore(
+      this.store,
+      provenance,
+      key,
+      attachmentStyle
+    );
+  }
+  deallocate(key) {
+    deallocateFromStore(this.store, key);
+  }
+  claim(newProvenance, key, exclusive) {
+    claimWithinStore(this.store, newProvenance, key, exclusive);
+  }
+};
+var T$ = `T$`;
 function selector(options) {
   return createStandaloneSelector(IMPLICIT.STORE, options);
 }
@@ -71,6 +119,40 @@ function setState(...params) {
     Internal.setIntoStore(Internal.IMPLICIT.STORE, ...params);
   }
 }
+
+// internal/src/install-into-store.ts
+function installIntoStore(tokens, target, source) {
+  const sourceNewest = newest(source);
+  if (isChildStore(sourceNewest)) {
+    source.logger.error(
+      `\u274C`,
+      `transaction`,
+      sourceNewest.transactionMeta.update.key,
+      `could not install the following tokens into store "${target.config.name} from "${source.config.name}":`,
+      tokens,
+      `${sourceNewest.config.name} is undergoing a transaction.`
+    );
+    return;
+  }
+  const targetNewest = newest(target);
+  if (isChildStore(targetNewest)) {
+    target.logger.error(
+      `\u274C`,
+      `transaction`,
+      targetNewest.transactionMeta.update.key,
+      `could not install the following tokens into store "${target.config.name} from "${source.config.name}":`,
+      tokens,
+      `${targetNewest.config.name} is undergoing a transaction.`
+    );
+    return;
+  }
+  for (const token of tokens) {
+    const resource = withdraw(token, source);
+    resource.install(target);
+  }
+}
+
+// src/silo.ts
 var Silo = class {
   store;
   atom;
@@ -87,9 +169,9 @@ var Silo = class {
   undo;
   redo;
   runTransaction;
+  install;
   constructor(config, fromStore = null) {
-    const s = new Store(config, fromStore);
-    this.store = s;
+    const s = this.store = new Store(config, fromStore);
     this.atom = (options) => createStandaloneAtom(s, options);
     this.atomFamily = (options) => createAtomFamily(s, options);
     this.selector = (options) => createStandaloneSelector(s, options);
@@ -112,6 +194,9 @@ var Silo = class {
       timeTravel(s, `redo`, token);
     };
     this.runTransaction = (token, id = arbitrary()) => actUponStore(token, id, s);
+    this.install = (tokens, source = IMPLICIT.STORE) => {
+      installIntoStore(tokens, s, source);
+    };
   }
 };
 function subscribe(token, handleUpdate, key = arbitrary()) {
@@ -141,4 +226,4 @@ function belongsTo(family, unknownToken) {
   return family.key === unknownToken.family?.key;
 }
 
-export { AtomIOLogger, LOG_LEVELS, Silo, atom, atomFamily, belongsTo, disposeState, getState, isToken, redo, runTransaction, selector, selectorFamily, setState, simpleLog, simpleLogger, subscribe, timeline, transaction, undo };
+export { $claim, Anarchy, AtomIOLogger, LOG_LEVELS, Realm, Silo, T$, atom, atomFamily, belongsTo, disposeState, getState, isToken, redo, runTransaction, selector, selectorFamily, setState, simpleLog, simpleLogger, subscribe, timeline, transaction, undo };