atom.io 0.6.4 → 0.6.6

package/react-devtools/dist/index.d.ts

@@ -1,15 +1,354 @@
+import { Hamt } from 'hamt_plus';
+import { Refinement } from 'fp-ts/Refinement';
+import { AtomToken as AtomToken$1, ReadonlySelectorToken as ReadonlySelectorToken$1, SelectorToken as SelectorToken$1 } from 'atom.io';
 import { FC } from 'react';
-import * as AtomIO from 'atom.io';
 
-type Modifier<T> = (thing: T) => T;
+type PlainObject = Record<keyof any, unknown>;
 
-type StoreHooks = {
-    useI: <T>(token: AtomIO.StateToken<T>) => (next: Modifier<T> | T) => void;
-    useO: <T>(token: AtomIO.ReadonlySelectorToken<T> | AtomIO.StateToken<T>) => T;
-    useIO: <T>(token: AtomIO.StateToken<T>) => [T, (next: Modifier<T> | T) => void];
+type ƒn = (...parameters: any[]) => any;
+
+type JsonInterface<T, J extends Json = Json> = {
+    toJson: (t: T) => J;
+    fromJson: (json: J) => T;
+};
+
+type Primitive = boolean | number | string | null;
+type Serializable = Primitive | Readonly<{
+    [key: string]: Serializable;
+}> | ReadonlyArray<Serializable>;
+type JsonObj<Key extends string = string, Value extends Serializable = Serializable> = Record<Key, Value>;
+type JsonArr<Element extends Serializable = Serializable> = ReadonlyArray<Element>;
+type Json = JsonArr | JsonObj | Primitive;
+
+type Identified = {
+    id: string;
+};
+
+declare const RELATION_TYPES: readonly ["1:1", "1:n", "n:n"];
+type RelationType = typeof RELATION_TYPES[number];
+type RelationData<CONTENT extends JsonObj | null = null, A extends string = `from`, B extends string = `to`> = {
+    contents: JsonObj<string, CONTENT>;
+    relations: JsonObj<string, string[]>;
+    relationType: RelationType;
+    a: A;
+    b: B;
+};
+type IsRelationDataOptions<CONTENT extends JsonObj | null = null, A extends string = `from`, B extends string = `to`> = {
+    from?: A;
+    to?: B;
+    isContent?: (json: Json) => json is CONTENT;
+};
+
+type NullSafeUnion<Base, Extension> = Extension extends null ? Base : Base & Extension;
+type NullSafeRest<MaybeArg> = MaybeArg extends null ? [] | [undefined] : [MaybeArg];
+
+declare class Join<CONTENT extends JsonObj | null = null, A extends string = `from`, B extends string = `to`> implements RelationData<CONTENT, A, B> {
+    readonly relationType: `1:1` | `1:n` | `n:n`;
+    readonly a: A;
+    readonly b: B;
+    readonly relations: Record<string, string[]>;
+    readonly contents: Record<string, CONTENT>;
+    constructor(json?: Partial<RelationData<CONTENT, A, B>>);
+    toJSON(): RelationData<CONTENT, A, B>;
+    static fromJSON<CONTENT extends JsonObj | null, A extends string, B extends string>(json: Json, options?: IsRelationDataOptions<CONTENT, A, B>): Join<CONTENT, A, B>;
+    from<AA extends string>(newA: AA): Join<CONTENT, AA, B>;
+    to<BB extends string>(newB: BB): Join<CONTENT, A, BB>;
+    makeJsonInterface: (...params: CONTENT extends null ? [
+    ] : [Refinement<unknown, CONTENT>]) => JsonInterface<Join<CONTENT, A, B>, RelationData<CONTENT, A, B>>;
+    getRelatedId(id: string): string | undefined;
+    getRelatedIds(id: string): string[];
+    getContent(idA: string, idB: string): CONTENT | undefined;
+    getRelationEntries(id: string): [string, CONTENT][];
+    getRelationRecord(id: string): Record<string, CONTENT>;
+    getRelation(id: string): NullSafeUnion<Identified, CONTENT> | undefined;
+    getRelations(id: string): NullSafeUnion<Identified, CONTENT>[];
+    setRelations(subject: {
+        [from in A]: string;
+    } | {
+        [to in B]: string;
+    }, relations: NullSafeUnion<Identified, CONTENT>[]): Join<CONTENT, A, B>;
+    set(relation: {
+        [key in A | B]: string;
+    }, ...rest: NullSafeRest<CONTENT>): Join<CONTENT, A, B>;
+    remove(relation: Partial<Record<A | B, string>>): Join<CONTENT, A, B>;
+}
+
+type AtomFamily<T, K extends Serializable = Serializable> = ((key: K) => AtomToken<T>) & {
+    key: string;
+    type: `atom_family`;
+    subject: Subject<AtomToken<T>>;
+};
+
+type Logger = Pick<Console, `error` | `info` | `warn`>;
+
+type TransactionToken<_> = {
+    key: string;
+    type: `transaction`;
+    __brand?: _;
 };
+type TransactionUpdate<ƒ extends ƒn> = {
+    key: string;
+    atomUpdates: KeyedStateUpdate<unknown>[];
+    params: Parameters<ƒ>;
+    output: ReturnType<ƒ>;
+};
+
+type ReadonlySelectorFamily<T, K extends Serializable = Serializable> = ((key: K) => ReadonlySelectorToken<T>) & {
+    key: string;
+    type: `readonly_selector_family`;
+    subject: Subject<ReadonlySelectorToken<T>>;
+};
+
+type StateUpdate<T> = {
+    newValue: T;
+    oldValue: T;
+};
+type KeyedStateUpdate<T> = StateUpdate<T> & {
+    key: string;
+};
+
+type TimelineToken = {
+    key: string;
+    type: `timeline`;
+};
+type TimelineUpdate = TimelineAtomUpdate | TimelineSelectorUpdate | TimelineTransactionUpdate;
+
+type AtomToken<_> = {
+    key: string;
+    type: `atom`;
+    family?: FamilyMetadata;
+    __brand?: _;
+};
+type SelectorToken<_> = {
+    key: string;
+    type: `selector`;
+    family?: FamilyMetadata;
+    __brand?: _;
+};
+type StateToken<T> = AtomToken<T> | SelectorToken<T>;
+type ReadonlySelectorToken<_> = {
+    key: string;
+    type: `readonly_selector`;
+    family?: FamilyMetadata;
+    __brand?: _;
+};
+type FamilyMetadata = {
+    key: string;
+    subKey: string;
+};
+
+type StoreCore = Pick<Store, `atoms` | `atomsThatAreDefault` | `operation` | `readonlySelectors` | `selectorAtoms` | `selectorGraph` | `selectors` | `timelineAtoms` | `timelines` | `transactions` | `valueMap`>;
+interface Store {
+    atoms: Hamt<Atom<any>, string>;
+    atomsThatAreDefault: Set<string>;
+    readonlySelectors: Hamt<ReadonlySelector<any>, string>;
+    selectorAtoms: Join<null, `selectorKey`, `atomKey`>;
+    selectorGraph: Join<{
+        source: string;
+    }>;
+    selectors: Hamt<Selector<any>, string>;
+    timelineAtoms: Join<null, `timelineKey`, `atomKey`>;
+    timelines: Hamt<Timeline, string>;
+    transactions: Hamt<Transaction<any>, string>;
+    valueMap: Hamt<any, string>;
+    subject: {
+        atomCreation: Subject<AtomToken<unknown>>;
+        selectorCreation: Subject<ReadonlySelectorToken<unknown> | SelectorToken<unknown>>;
+        transactionCreation: Subject<TransactionToken<ƒn>>;
+        timelineCreation: Subject<TimelineToken>;
+        operationStatus: Subject<OperationProgress>;
+    };
+    operation: OperationProgress;
+    transactionStatus: TransactionStatus<ƒn>;
+    config: {
+        name: string;
+        logger: Logger | null;
+        logger__INTERNAL: Logger;
+    };
+}
+
+type Atom<T> = {
+    key: string;
+    type: `atom`;
+    family?: FamilyMetadata;
+    subject: Subject<{
+        newValue: T;
+        oldValue: T;
+    }>;
+    default: T;
+};
+
+type OperationProgress = {
+    open: false;
+} | {
+    open: true;
+    done: Set<string>;
+    prev: Hamt<any, string>;
+    time: number;
+    token: StateToken<any>;
+};
+
+type Selector<T> = {
+    key: string;
+    type: `selector`;
+    family?: FamilyMetadata;
+    install: (store: Store) => void;
+    subject: Subject<{
+        newValue: T;
+        oldValue: T;
+    }>;
+    get: () => T;
+    set: (newValue: T | ((oldValue: T) => T)) => void;
+};
+type ReadonlySelector<T> = {
+    key: string;
+    type: `readonly_selector`;
+    family?: FamilyMetadata;
+    install: (store: Store) => void;
+    subject: Subject<{
+        newValue: T;
+        oldValue: T;
+    }>;
+    get: () => T;
+};
+
+type Subscriber<T> = (value: T) => void;
+declare class Subject<T> {
+    subscribers: Subscriber<T>[];
+    subscribe(subscriber: Subscriber<T>): {
+        unsubscribe: () => void;
+    };
+    private unsubscribe;
+    next(value: T): void;
+}
+
+type TimelineAtomUpdate = StateUpdate<unknown> & {
+    key: string;
+    type: `atom_update`;
+    timestamp: number;
+};
+type TimelineSelectorUpdate = {
+    key: string;
+    type: `selector_update`;
+    timestamp: number;
+    atomUpdates: Omit<TimelineAtomUpdate, `timestamp`>[];
+};
+type TimelineTransactionUpdate = TransactionUpdate<ƒn> & {
+    key: string;
+    type: `transaction_update`;
+    timestamp: number;
+};
+type Timeline = {
+    key: string;
+    at: number;
+    timeTraveling: boolean;
+    history: TimelineUpdate[];
+    selectorTime: number | null;
+    transactionKey: string | null;
+    install: (store: Store) => void;
+    subject: Subject<TimelineAtomUpdate | TimelineSelectorUpdate | TimelineTransactionUpdate | `redo` | `undo`>;
+};
+
+type Transaction<ƒ extends ƒn> = {
+    key: string;
+    type: `transaction`;
+    install: (store: Store) => void;
+    subject: Subject<TransactionUpdate<ƒ>>;
+    run: (...parameters: Parameters<ƒ>) => ReturnType<ƒ>;
+};
+
+type TransactionUpdateInProgress<ƒ extends ƒn> = TransactionUpdate<ƒ> & {
+    phase: `applying` | `building`;
+    time: number;
+    core: StoreCore;
+};
+type TransactionIdle = {
+    phase: `idle`;
+};
+type TransactionStatus<ƒ extends ƒn> = TransactionIdle | TransactionUpdateInProgress<ƒ>;
+
+type AtomTokenIndex = StateTokenIndex<AtomToken$1<unknown>>;
+
+type FamilyNode<Token extends AtomToken$1<unknown> | ReadonlySelectorToken$1<unknown> | SelectorToken$1<unknown>> = {
+    key: string;
+    familyMembers: Record<string, Token>;
+};
+type StateTokenIndex<Token extends AtomToken$1<unknown> | ReadonlySelectorToken$1<unknown> | SelectorToken$1<unknown>> = Record<string, FamilyNode<Token> | Token>;
+
+type SelectorTokenIndex = StateTokenIndex<ReadonlySelectorToken$1<unknown> | SelectorToken$1<unknown>>;
+
+type ClassSignature = abstract new (...args: any) => any;
+
+type RefinementStrategy = ClassSignature | Refinement<unknown, any>;
+type Supported<Refine extends RefinementStrategy> = Refine extends Refinement<unknown, infer T> ? T : Refine extends ClassSignature ? InstanceType<Refine> : never;
+type RefinementSupport = Record<string, RefinementStrategy>;
+declare class Refinery<SupportedTypes extends RefinementSupport> {
+    supported: SupportedTypes;
+    constructor(supported: SupportedTypes);
+    refine(input: unknown): {
+        [K in keyof SupportedTypes]: {
+            type: K;
+            data: Supported<SupportedTypes[K]>;
+        };
+    }[keyof SupportedTypes] | null;
+}
+
+type Delta = {
+    summary: string;
+    added?: [path: string, addedStringifiedValue: string][];
+    removed?: [path: string, removedStringifiedValue: string][];
+    changed?: [path: string, delta: Delta][];
+};
+type Diff<T> = (a: T, b: T) => Delta;
+type DiffTree<T> = (a: T, b: T, recurse: Differ<any, any>[`diff`]) => Delta;
+declare class Differ<Leaf extends Record<string, any>, Tree extends Record<string, any>> {
+    leafRefinery: Refinery<Leaf>;
+    treeRefinery: Refinery<Tree>;
+    leafDiffers: {
+        [K in keyof Leaf]: Diff<Supported<Leaf[K]>>;
+    };
+    treeDiffers: {
+        [K in keyof Tree]: DiffTree<Supported<Tree[K]>>;
+    };
+    constructor(leafRefinery: Refinery<Leaf>, treeRefinery: Refinery<Tree>, diffFunctions: {
+        [K in keyof Tree]: DiffTree<Supported<Tree[K]>>;
+    } & {
+        [K in keyof Leaf]: Diff<Supported<Leaf[K]>>;
+    });
+    diff(a: unknown, b: unknown): Delta;
+}
 
-declare const composeDevtools: (storeHooks: StoreHooks) => FC;
 declare const AtomIODevtools: FC;
 
-export { AtomIODevtools, composeDevtools };
+declare const atomIndex: ReadonlySelectorToken<AtomTokenIndex>;
+declare const selectorIndex: ReadonlySelectorToken<SelectorTokenIndex>;
+declare const transactionIndex: ReadonlySelectorToken<TransactionToken<ƒn>[]>;
+declare const findTransactionLogState: ReadonlySelectorFamily<TransactionUpdate<ƒn>[]>;
+declare const timelineIndex: ReadonlySelectorToken<TimelineToken[]>;
+declare const findTimelineState: ReadonlySelectorFamily<Timeline>;
+declare const devtoolsAreOpenState: AtomToken<boolean>;
+type DevtoolsView = `atoms` | `selectors` | `timelines` | `transactions`;
+declare const devtoolsViewSelectionState: AtomToken<DevtoolsView>;
+declare const devtoolsViewOptionsState: AtomToken<DevtoolsView[]>;
+declare const findViewIsOpenState: AtomFamily<boolean, string>;
+declare const primitiveRefinery: Refinery<{
+    number: (input: unknown) => input is number;
+    string: (input: unknown) => input is string;
+    boolean: (input: unknown) => input is boolean;
+    null: (input: unknown) => input is null;
+}>;
+declare const jsonTreeRefinery: Refinery<{
+    object: (input: unknown) => input is PlainObject;
+    array: (input: unknown) => input is unknown[];
+}>;
+declare const prettyJson: Differ<{
+    number: (input: unknown) => input is number;
+    string: (input: unknown) => input is string;
+    boolean: (input: unknown) => input is boolean;
+    null: (input: unknown) => input is null;
+}, {
+    object: (input: unknown) => input is PlainObject;
+    array: (input: unknown) => input is unknown[];
+}>;
+
+export { AtomIODevtools, atomIndex, devtoolsAreOpenState, devtoolsViewOptionsState, devtoolsViewSelectionState, findTimelineState, findTransactionLogState, findViewIsOpenState, jsonTreeRefinery, prettyJson, primitiveRefinery, selectorIndex, timelineIndex, transactionIndex };