ccstate 2.0.0

package/index.d.cts

@@ -0,0 +1,166 @@
+import * as react from 'react';
+
+type Updater<T> = (current: T) => T;
+interface Setter {
+    <T>(state: State<T>, val: T | Updater<T>): void;
+    <T, Args extends unknown[]>(command: Command<T, Args>, ...args: Args): T;
+}
+type Getter = <T>(readable: ReadableAtom<T>) => T;
+interface GetterOptions {
+    signal: AbortSignal;
+}
+type Read<T> = (get: Getter, options: GetterOptions) => T;
+type Write<T, Args extends unknown[]> = (visitor: {
+    get: Getter;
+    set: Setter;
+}, ...args: Args) => T;
+interface State<T> {
+    init: T;
+    debugLabel?: string;
+    toString: () => string;
+}
+interface Computed<T> {
+    read: Read<T>;
+    debugLabel?: string;
+    toString: () => string;
+}
+interface Command<T, Args extends unknown[]> {
+    write: Write<T, Args>;
+    debugLabel?: string;
+    toString: () => string;
+}
+type ReadableAtom<T> = State<T> | Computed<T>;
+
+interface Options {
+    debugLabel?: string;
+}
+declare function state<T>(init: T, options?: Options): State<T>;
+declare function computed<T>(read: Read<T>, options?: Options): Computed<T>;
+declare function command<T, Args extends unknown[]>(write: Write<T, Args>, options?: Options): Command<T, Args>;
+
+interface Store {
+    get: Getter;
+    set: Setter;
+    sub: Subscribe;
+}
+interface SubscribeOptions {
+    signal?: AbortSignal;
+}
+type CallbackFunc<T> = Command<T, []>;
+type Subscribe = (atoms$: ReadableAtom<unknown>[] | ReadableAtom<unknown>, callback: CallbackFunc<unknown>, options?: SubscribeOptions) => () => void;
+type InterceptorGet = <T>(atom$: State<T> | Computed<T>, fn: () => T) => void;
+interface InterceptorSet {
+    <T, Args extends unknown[]>(func$: Command<T, Args>, fn: () => T, ...args: Args): void;
+    <T>(value$: State<T>, fn: () => void, val: T | Updater<T>): void;
+}
+type InterceptorSub = <T>(atom$: ReadableAtom<T>, callback$: CallbackFunc<T>, fn: () => void) => void;
+type InterceptorUnsub = <T>(atom$: ReadableAtom<T>, callback$: CallbackFunc<T>, fn: () => void) => void;
+type InterceptorMount = <T>(atom$: ReadableAtom<T>) => void;
+type InterceptorUnmount = <T>(atom$: ReadableAtom<T>) => void;
+type InterceptorNotify = <T>(callback$: CallbackFunc<T>, fn: () => T) => void;
+type InterceptorComputed = <T>(atom$: Computed<T>, fn: () => T) => void;
+interface StoreInterceptor {
+    get?: InterceptorGet;
+    set?: InterceptorSet;
+    sub?: InterceptorSub;
+    unsub?: InterceptorUnsub;
+    mount?: InterceptorMount;
+    unmount?: InterceptorUnmount;
+    notify?: InterceptorNotify;
+    computed?: InterceptorComputed;
+}
+
+declare function createStore(): Store;
+
+type NestedAtom = (State<unknown> | Computed<unknown> | Command<unknown, unknown[]> | NestedAtom)[];
+type NestedString = (string | NestedString)[];
+
+declare function nestedAtomToString(atoms: NestedAtom): NestedString;
+
+interface DebugStore extends Store {
+    getReadDependencies: (atom: Computed<unknown>) => NestedAtom;
+    getReadDependents: (atom: State<unknown> | Computed<unknown>) => NestedAtom;
+    isMounted: (atom: State<unknown> | Computed<unknown>) => boolean;
+    getSubscribeGraph: () => NestedAtom;
+}
+
+declare function createDebugStore(interceptor?: StoreInterceptor): DebugStore;
+
+type StoreEventType = 'set' | 'get' | 'sub' | 'unsub' | 'mount' | 'unmount' | 'notify' | 'computed';
+
+interface AtomWatch {
+    target: State<unknown> | Computed<unknown> | Command<unknown, unknown[]> | string | RegExp;
+    actions?: Set<StoreEventType>;
+}
+declare class ConsoleInterceptor implements StoreInterceptor {
+    private readonly watches;
+    constructor(watches: AtomWatch[]);
+    private shouldLog;
+    get: <T>(atom$: State<T> | Computed<T>, fn: () => T) => void;
+    computed: <T>(atom$: Computed<T>, fn: () => T) => void;
+    set: <T, Args extends unknown[]>(atom$: State<T> | Command<T, Args>, fn: () => T, ...args: Args | [T | Updater<T>]) => void;
+    sub: <T>(atom$: State<T> | Computed<T>, callback$: CallbackFunc<T>, fn: () => void) => void;
+    unsub: <T>(atom$: State<T> | Computed<T>, callback$: CallbackFunc<T>, fn: () => void) => void;
+    mount: <T>(atom$: State<T> | Computed<T>) => void;
+    unmount: <T>(atom$: State<T> | Computed<T>) => void;
+    notify: <T>(callback$: CallbackFunc<T>, fn: () => T) => void;
+}
+
+declare class StoreEvent extends Event {
+    readonly eventId: number;
+    readonly targetAtom: string;
+    readonly state: 'begin' | 'success' | 'error';
+    readonly time: DOMHighResTimeStamp;
+    readonly args: unknown[];
+    readonly result: unknown;
+    constructor(type: StoreEventType, eventId: number, targetAtom: string, state: 'begin' | 'success' | 'error', time: DOMHighResTimeStamp, args: unknown[], result: unknown);
+}
+
+declare class EventInterceptor implements StoreInterceptor {
+    private traceId;
+    private events;
+    private createEvent;
+    private wrapWithTrace;
+    addEventListener(type: StoreEventType, listener: (event: StoreEvent) => void, options?: AddEventListenerOptions | boolean): void;
+    removeEventListener(type: StoreEventType, listener: (event: StoreEvent) => void, options?: EventListenerOptions | boolean): void;
+    get: <T>(atom$: State<T> | Computed<T>, fn: () => T) => T;
+    computed: <T>(atom$: Computed<T>, fn: () => T) => T;
+    set: <T, Args extends unknown[]>(atom$: State<T> | Command<T, Args>, fn: () => T, ...args: Args | [T | Updater<T>]) => T;
+    sub: <T>(atom$: State<T> | Computed<T>, callback$: CallbackFunc<T>, fn: () => void) => void;
+    unsub: <T>(atom$: State<T> | Computed<T>, callback$: CallbackFunc<T>, fn: () => void) => void;
+    mount: <T>(atom$: State<T> | Computed<T>) => void;
+    unmount: <T>(atom$: State<T> | Computed<T>) => void;
+    notify: <T>(callback$: CallbackFunc<T>, fn: () => T) => void;
+}
+
+type PackedEventMessage = Pick<StoreEvent, 'type' | 'eventId' | 'targetAtom' | 'time' | 'state'>;
+interface DevToolsHookMessage {
+    source: 'ccstate-store';
+    payload: PackedEventMessage;
+}
+declare const GLOBAL_CCSTATE_INTERCEPED_KEY = "__CCSTATE_INTERCEPED__";
+declare function setupDevtoolsInterceptor(targetWindow: Window, signal?: AbortSignal): EventInterceptor;
+
+declare function useGet<T>(atom: State<T> | Computed<T>): T;
+
+declare function useSet<T>(atom: State<T>): (value: T | Updater<T>) => void;
+declare function useSet<T, ARGS extends unknown[]>(atom: Command<T, ARGS>): (...args: ARGS) => T;
+
+declare function useResolved<T>(atom: State<Promise<T>> | Computed<Promise<T>>): T | undefined;
+declare function useLastResolved<T>(atom: State<Promise<T>> | Computed<Promise<T>>): T | undefined;
+
+type Loadable<T> = {
+    state: 'loading';
+} | {
+    state: 'hasData';
+    data: T;
+} | {
+    state: 'hasError';
+    error: unknown;
+};
+declare function useLoadable<T>(atom: State<Promise<T>> | Computed<Promise<T>>): Loadable<T>;
+declare function useLastLoadable<T>(atom: State<Promise<T>> | Computed<Promise<T>>): Loadable<T>;
+
+declare const StoreProvider: react.Provider<Store | null>;
+
+export { type Command, type Computed, ConsoleInterceptor, type DebugStore, type DevToolsHookMessage, EventInterceptor, GLOBAL_CCSTATE_INTERCEPED_KEY, type Getter, type PackedEventMessage, type Read, type Setter, type State, type Store, StoreEvent, type StoreEventType, type StoreInterceptor, StoreProvider, type Subscribe, type Updater, type Write, command, computed, createDebugStore, createStore, nestedAtomToString, setupDevtoolsInterceptor, state, useGet, useLastLoadable, useLastResolved, useLoadable, useResolved, useSet };

package/index.d.ts

@@ -0,0 +1,166 @@
+import * as react from 'react';
+
+type Updater<T> = (current: T) => T;
+interface Setter {
+    <T>(state: State<T>, val: T | Updater<T>): void;
+    <T, Args extends unknown[]>(command: Command<T, Args>, ...args: Args): T;
+}
+type Getter = <T>(readable: ReadableAtom<T>) => T;
+interface GetterOptions {
+    signal: AbortSignal;
+}
+type Read<T> = (get: Getter, options: GetterOptions) => T;
+type Write<T, Args extends unknown[]> = (visitor: {
+    get: Getter;
+    set: Setter;
+}, ...args: Args) => T;
+interface State<T> {
+    init: T;
+    debugLabel?: string;
+    toString: () => string;
+}
+interface Computed<T> {
+    read: Read<T>;
+    debugLabel?: string;
+    toString: () => string;
+}
+interface Command<T, Args extends unknown[]> {
+    write: Write<T, Args>;
+    debugLabel?: string;
+    toString: () => string;
+}
+type ReadableAtom<T> = State<T> | Computed<T>;
+
+interface Options {
+    debugLabel?: string;
+}
+declare function state<T>(init: T, options?: Options): State<T>;
+declare function computed<T>(read: Read<T>, options?: Options): Computed<T>;
+declare function command<T, Args extends unknown[]>(write: Write<T, Args>, options?: Options): Command<T, Args>;
+
+interface Store {
+    get: Getter;
+    set: Setter;
+    sub: Subscribe;
+}
+interface SubscribeOptions {
+    signal?: AbortSignal;
+}
+type CallbackFunc<T> = Command<T, []>;
+type Subscribe = (atoms$: ReadableAtom<unknown>[] | ReadableAtom<unknown>, callback: CallbackFunc<unknown>, options?: SubscribeOptions) => () => void;
+type InterceptorGet = <T>(atom$: State<T> | Computed<T>, fn: () => T) => void;
+interface InterceptorSet {
+    <T, Args extends unknown[]>(func$: Command<T, Args>, fn: () => T, ...args: Args): void;
+    <T>(value$: State<T>, fn: () => void, val: T | Updater<T>): void;
+}
+type InterceptorSub = <T>(atom$: ReadableAtom<T>, callback$: CallbackFunc<T>, fn: () => void) => void;
+type InterceptorUnsub = <T>(atom$: ReadableAtom<T>, callback$: CallbackFunc<T>, fn: () => void) => void;
+type InterceptorMount = <T>(atom$: ReadableAtom<T>) => void;
+type InterceptorUnmount = <T>(atom$: ReadableAtom<T>) => void;
+type InterceptorNotify = <T>(callback$: CallbackFunc<T>, fn: () => T) => void;
+type InterceptorComputed = <T>(atom$: Computed<T>, fn: () => T) => void;
+interface StoreInterceptor {
+    get?: InterceptorGet;
+    set?: InterceptorSet;
+    sub?: InterceptorSub;
+    unsub?: InterceptorUnsub;
+    mount?: InterceptorMount;
+    unmount?: InterceptorUnmount;
+    notify?: InterceptorNotify;
+    computed?: InterceptorComputed;
+}
+
+declare function createStore(): Store;
+
+type NestedAtom = (State<unknown> | Computed<unknown> | Command<unknown, unknown[]> | NestedAtom)[];
+type NestedString = (string | NestedString)[];
+
+declare function nestedAtomToString(atoms: NestedAtom): NestedString;
+
+interface DebugStore extends Store {
+    getReadDependencies: (atom: Computed<unknown>) => NestedAtom;
+    getReadDependents: (atom: State<unknown> | Computed<unknown>) => NestedAtom;
+    isMounted: (atom: State<unknown> | Computed<unknown>) => boolean;
+    getSubscribeGraph: () => NestedAtom;
+}
+
+declare function createDebugStore(interceptor?: StoreInterceptor): DebugStore;
+
+type StoreEventType = 'set' | 'get' | 'sub' | 'unsub' | 'mount' | 'unmount' | 'notify' | 'computed';
+
+interface AtomWatch {
+    target: State<unknown> | Computed<unknown> | Command<unknown, unknown[]> | string | RegExp;
+    actions?: Set<StoreEventType>;
+}
+declare class ConsoleInterceptor implements StoreInterceptor {
+    private readonly watches;
+    constructor(watches: AtomWatch[]);
+    private shouldLog;
+    get: <T>(atom$: State<T> | Computed<T>, fn: () => T) => void;
+    computed: <T>(atom$: Computed<T>, fn: () => T) => void;
+    set: <T, Args extends unknown[]>(atom$: State<T> | Command<T, Args>, fn: () => T, ...args: Args | [T | Updater<T>]) => void;
+    sub: <T>(atom$: State<T> | Computed<T>, callback$: CallbackFunc<T>, fn: () => void) => void;
+    unsub: <T>(atom$: State<T> | Computed<T>, callback$: CallbackFunc<T>, fn: () => void) => void;
+    mount: <T>(atom$: State<T> | Computed<T>) => void;
+    unmount: <T>(atom$: State<T> | Computed<T>) => void;
+    notify: <T>(callback$: CallbackFunc<T>, fn: () => T) => void;
+}
+
+declare class StoreEvent extends Event {
+    readonly eventId: number;
+    readonly targetAtom: string;
+    readonly state: 'begin' | 'success' | 'error';
+    readonly time: DOMHighResTimeStamp;
+    readonly args: unknown[];
+    readonly result: unknown;
+    constructor(type: StoreEventType, eventId: number, targetAtom: string, state: 'begin' | 'success' | 'error', time: DOMHighResTimeStamp, args: unknown[], result: unknown);
+}
+
+declare class EventInterceptor implements StoreInterceptor {
+    private traceId;
+    private events;
+    private createEvent;
+    private wrapWithTrace;
+    addEventListener(type: StoreEventType, listener: (event: StoreEvent) => void, options?: AddEventListenerOptions | boolean): void;
+    removeEventListener(type: StoreEventType, listener: (event: StoreEvent) => void, options?: EventListenerOptions | boolean): void;
+    get: <T>(atom$: State<T> | Computed<T>, fn: () => T) => T;
+    computed: <T>(atom$: Computed<T>, fn: () => T) => T;
+    set: <T, Args extends unknown[]>(atom$: State<T> | Command<T, Args>, fn: () => T, ...args: Args | [T | Updater<T>]) => T;
+    sub: <T>(atom$: State<T> | Computed<T>, callback$: CallbackFunc<T>, fn: () => void) => void;
+    unsub: <T>(atom$: State<T> | Computed<T>, callback$: CallbackFunc<T>, fn: () => void) => void;
+    mount: <T>(atom$: State<T> | Computed<T>) => void;
+    unmount: <T>(atom$: State<T> | Computed<T>) => void;
+    notify: <T>(callback$: CallbackFunc<T>, fn: () => T) => void;
+}
+
+type PackedEventMessage = Pick<StoreEvent, 'type' | 'eventId' | 'targetAtom' | 'time' | 'state'>;
+interface DevToolsHookMessage {
+    source: 'ccstate-store';
+    payload: PackedEventMessage;
+}
+declare const GLOBAL_CCSTATE_INTERCEPED_KEY = "__CCSTATE_INTERCEPED__";
+declare function setupDevtoolsInterceptor(targetWindow: Window, signal?: AbortSignal): EventInterceptor;
+
+declare function useGet<T>(atom: State<T> | Computed<T>): T;
+
+declare function useSet<T>(atom: State<T>): (value: T | Updater<T>) => void;
+declare function useSet<T, ARGS extends unknown[]>(atom: Command<T, ARGS>): (...args: ARGS) => T;
+
+declare function useResolved<T>(atom: State<Promise<T>> | Computed<Promise<T>>): T | undefined;
+declare function useLastResolved<T>(atom: State<Promise<T>> | Computed<Promise<T>>): T | undefined;
+
+type Loadable<T> = {
+    state: 'loading';
+} | {
+    state: 'hasData';
+    data: T;
+} | {
+    state: 'hasError';
+    error: unknown;
+};
+declare function useLoadable<T>(atom: State<Promise<T>> | Computed<Promise<T>>): Loadable<T>;
+declare function useLastLoadable<T>(atom: State<Promise<T>> | Computed<Promise<T>>): Loadable<T>;
+
+declare const StoreProvider: react.Provider<Store | null>;
+
+export { type Command, type Computed, ConsoleInterceptor, type DebugStore, type DevToolsHookMessage, EventInterceptor, GLOBAL_CCSTATE_INTERCEPED_KEY, type Getter, type PackedEventMessage, type Read, type Setter, type State, type Store, StoreEvent, type StoreEventType, type StoreInterceptor, StoreProvider, type Subscribe, type Updater, type Write, command, computed, createDebugStore, createStore, nestedAtomToString, setupDevtoolsInterceptor, state, useGet, useLastLoadable, useLastResolved, useLoadable, useResolved, useSet };