@valentin30/signal 0.1.0 → 0.2.0

package/dist/index.d.ts

@@ -1,194 +1,287 @@
-type Callable = (...args: any[]) => any;
+type Callable<Args extends any[] = any[], ReturnType = any> = (...args: Args) => ReturnType;
 
-type Maybe<T> = T | null | undefined;
+interface Batcher {
+    batch<Value>(callback: () => Value): Value;
+    batch<Value, Args extends any[]>(callback: Callable<Args, Value>, ...args: Args): Value;
+}
+declare function batch<Value>(callback: () => Value): Value;
+declare function batch<Value, Args extends any[]>(callback: Callable<Args, Value>, ...args: Args): Value;
 
-type Factory<Fn extends Callable> = Fn & {
-    factory(factory: Maybe<Fn>): void;
-    default(factory: Maybe<Fn>): void;
-    configured(): boolean;
-};
-declare function factory<Fn extends Callable>(name: string): Factory<Fn>;
+type Write<T> = (value: T) => void | undefined | boolean;
+interface Writable<T> {
+    write(value: T): boolean;
+}
+declare function writer<T>(write: Write<T>): Writable<T>;
+
+interface Comparator<T> {
+    equals(value: T, other: T): boolean;
+}
+interface Comparable<T> extends Comparator<T> {
+    equals(other: T): boolean;
+    equals(value: T, other: T): boolean;
+}
+type Equals<T> = (value: T, other: T) => boolean;
+declare namespace Equals {
+    function strict<T>(value: T, other: T): boolean;
+}
+declare function comparator<T>(equals?: Equals<T>): Comparator<T>;
+
+interface Peekable<T> {
+    peek(): T;
+}
+
+interface Readable<T> {
+    read(): T;
+}
+declare function reader<T>(read: () => T): Readable<T>;
 
 type Callback = () => void;
 
-interface Collector<T> {
+interface Subscribable {
+    subscribe(callback: Callback): Callback;
+    unsubscribe(callback: Callback): void;
+}
+
+interface Signal<T> extends Readable<T>, Writable<T>, Comparable<T>, Peekable<T>, Subscribable {
+}
+interface ReadonlySignal<T> extends Readable<T>, Comparable<T>, Peekable<T>, Subscribable {
+}
+interface SignalFactory {
+    <T>(value: T, equals?: Equals<T>): Signal<T>;
+}
+declare function signal<T>(value: T, equals?: Equals<T>): Signal<T>;
+
+interface ComposedFactory {
+    <T>(value: ReadonlySignal<T>, write: Write<T>): Signal<T>;
+}
+declare function composed<T>(value: ReadonlySignal<T>, write: Write<T>): Signal<T>;
+
+interface ComputedFactory {
+    <T>(compute: () => T, equals?: Equals<T>): ReadonlySignal<T>;
+}
+declare function computed<T>(compute: () => T, equals?: Equals<T>): ReadonlySignal<T>;
+
+interface Ignore {
+    ignore<Value>(callback: () => Value): Value;
+    ignore<Value, Args extends any[]>(callback: Callable<Args, Value>, ...args: Args): Value;
+}
+declare function ignore<Value>(callback: () => Value): Value;
+declare function ignore<Value, Args extends any[]>(callback: Callable<Args, Value>, ...args: Args): Value;
+
+interface CollectorState {
+    collecting(): boolean;
+}
+interface CollectorTarget<T> extends CollectorState {
     add(value: T): void;
+}
+interface Collector<T> extends CollectorState {
+    collect<Value>(callback: () => Value): [Value, Readonly<Set<T>>];
+    collect<Value, Args extends any[]>(callback: Callable<Args, Value>, ...args: Args): [Value, Readonly<Set<T>>];
+}
+
+interface Tracker<T> {
+    track(value: T): void;
+}
+
+interface DependencyState {
+    changed(): boolean;
+}
+interface DependencyObserver extends DependencyState, Tracker<Callback> {
+}
+interface DependencyTracker extends DependencyObserver, Subscribable {
+}
+
+interface Scheduler<T> {
+    schedule(...value: T[]): void;
+}
+
+declare class CollectorBasedBatcher implements Batcher {
+    private readonly collector;
+    constructor(collector: Collector<Callback>);
+    batch<Value>(callback: () => Value): Value;
+    batch<Value, Args extends any[]>(callback: Callable<Args, Value>, ...args: Args): Value;
+}
+
+type Maybe<T> = T | null | undefined;
+
+declare class CollectorController<T> implements Collector<T>, CollectorTarget<T>, CollectorState, Ignore, Tracker<T> {
+    private values;
+    constructor(values?: Maybe<Set<T>>);
     collecting(): boolean;
-    collect(callback: Callback): Readonly<Set<T>>;
-    ignore(callback: Callback): void;
-}
-type CollectorFactory = <T>() => Collector<T>;
-declare const collector: Factory<CollectorFactory>;
-
-declare function internal_batch(callback: Callback): void;
-declare function internal_batch(callback: Callback, collector: Collector<Callback>): void;
-declare function internal_batch(callback: Callback, collector?: Collector<Callback>): void;
-declare namespace internal_batch {
-    const collector: Factory<collector.Factory>;
-    namespace collector {
-        type Factory = () => Collector<Callback>;
-    }
-}
-
-declare function internal_collector<T>(): Collector<T>;
-declare namespace internal_collector {
-    class Constructor<T> implements Collector<T> {
-        #private;
-        constructor(values: Set<T> | null);
-        collecting(): boolean;
-        add(value: T): void;
-        collect(callback: Callback): Set<T>;
-        ignore(callback: Callback): void;
-    }
-}
-
-interface Comparable<T> {
-    equals(other: T): boolean;
+    add(value: T): void;
+    track(value: T): void;
+    collect<Value>(callback: () => Value): [Value, Readonly<Set<T>>];
+    collect<Value, Args extends any[]>(callback: Callable<Args, Value>, ...args: Args): [Value, Readonly<Set<T>>];
+    ignore<Value>(callback: () => Value): Value;
+    ignore<Value, Args extends any[]>(callback: Callable<Args, Value>, ...args: Args): Value;
 }
 
-interface Readable<T> {
+declare class Composed<T> implements Signal<T> {
+    private readonly value;
+    private readonly writer;
+    constructor(value: ReadonlySignal<T>, writer: Writable<T>);
     read(): T;
+    peek(): T;
+    write(value: T): boolean;
+    equals(other: T): boolean;
+    equals(value: T, other: T): boolean;
+    subscribe(callback: Callback): Callback;
+    unsubscribe(callback: Callback): void;
 }
 
-interface Subscribable {
+type Snapshot = [ReadonlySignal<unknown>, unknown];
+declare namespace Snapshot {
+    function changed([value, snapshot]: Snapshot): boolean;
+    function from(values: Set<ReadonlySignal<unknown>>): Snapshot[];
+}
+declare class DependencyManager implements DependencyTracker {
+    private snapshot;
+    private dependencies;
+    private readonly collector;
+    private readonly listeners;
+    constructor(collector: Collector<ReadonlySignal<unknown>>, listeners?: Set<Callback>, dependencies?: Set<ReadonlySignal<unknown>>, snapshot?: Maybe<Snapshot[]>);
+    changed(): boolean;
+    track(callback: Callback): void;
     subscribe(callback: Callback): Callback;
     unsubscribe(callback: Callback): void;
+    private equals;
 }
 
-interface Writable<T> {
-    write(value: T): void;
+interface Emitter {
+    emit(): void;
 }
 
-type Equals<T> = (value: T, other: T) => boolean;
+declare class ScheduledEmitter implements Emitter, Subscribable {
+    private readonly listeners;
+    private readonly scheduler;
+    constructor(scheduler: Scheduler<Callback>, listeners?: Set<Callback>);
+    emit(): void;
+    subscribe(callback: Callback): Callback;
+    unsubscribe(callback: Callback): void;
+}
 
-interface Peekable<T> {
+interface Value<T> extends Readable<T>, Writable<T>, Comparable<T> {
+}
+
+declare class Reactive<T> implements Signal<T> {
+    private readonly value;
+    private readonly tracker;
+    private readonly subscription;
+    constructor(value: Value<T>, tracker: Tracker<ReadonlySignal<unknown>>, subscription: Subscribable);
+    read(): T;
     peek(): T;
+    write(value: T): boolean;
+    equals(other: T): boolean;
+    equals(value: T, other: T): boolean;
+    subscribe(callback: Callback): Callback;
+    unsubscribe(callback: Callback): void;
 }
 
-interface Signal<T> extends Readable<T>, Writable<T>, Peekable<T>, Comparable<T>, Subscribable {
-}
-interface ReadonlySignal<T> extends Readable<T>, Peekable<T>, Comparable<T>, Subscribable {
-}
-type SignalFactory = <T>(value: T, equals?: Equals<T>) => Signal<T>;
-declare const signal: Factory<SignalFactory>;
-
-declare function internal_computed<T>(compute: () => T, equals?: Equals<T>): internal_computed.Constructor<T>;
-declare namespace internal_computed {
-    const collector: Factory<collector.Factory>;
-    namespace collector {
-        type Factory = () => Collector<ReadonlySignal<unknown>>;
-    }
-    class Constructor<T> implements ReadonlySignal<T> {
-        #private;
-        constructor(empty: boolean, value: T | undefined, values: [ReadonlySignal<unknown>, unknown][], dependencies: Set<ReadonlySignal<unknown>>, listeners: Set<Callback>, collector: Collector<ReadonlySignal<unknown>>, compute: () => T, equals: Maybe<Equals<T>>);
-        read(): T;
-        peek(): T;
-        equals(other: T): boolean;
-        subscribe(callback: Callback): Callback;
-        unsubscribe(callback: Callback): void;
-    }
-}
-
-declare function internal_composed<T>(compute: () => T, write: (value: T) => void, equals?: Equals<T>): internal_composed.Constructor<T>;
-declare namespace internal_composed {
-    const batcher: Factory<batcher.Factory>;
-    namespace batcher {
-        type Factory = () => Collector<Callback>;
-    }
-    const collector: Factory<collector.Factory>;
-    namespace collector {
-        type Factory = () => Collector<ReadonlySignal<unknown>>;
-    }
-    class Constructor<T> extends internal_computed.Constructor<T> implements Signal<T> {
-        #private;
-        constructor(empty: boolean, value: T | undefined, values: [ReadonlySignal<unknown>, unknown][], dependencies: Set<ReadonlySignal<unknown>>, listeners: Set<Callback>, batcher: Collector<Callback>, collector: Collector<ReadonlySignal<unknown>>, compute: () => T, write: (value: T) => void, equals: Maybe<Equals<T>>);
-        write(value: T): void;
-    }
-}
-
-type Effect = (callback: EffectCallback) => Callback;
-type EffectCallback = (init: boolean) => EffectCleanup | void;
-type EffectCleanup = (destroy: boolean) => void;
-declare const effect: Factory<Effect>;
-
-declare function internal_effect(cb: EffectCallback): Callback;
-declare namespace internal_effect {
-    const collector: Factory<collector.Factory>;
-    namespace collector {
-        type Factory = () => Collector<ReadonlySignal<unknown>>;
-    }
-}
-
-declare function internal_ignore<Value>(value: ReadonlySignal<Value>): Value;
-declare function internal_ignore<Value>(callback: () => Value): Value;
-declare function internal_ignore<Value, Args extends any[]>(callback: (...args: Args) => Value, ...args: Args): Value;
-declare namespace internal_ignore {
-    const collector: Factory<collector.Factory>;
-    namespace collector {
-        type Factory = () => Collector<ReadonlySignal<unknown>>;
-    }
-}
-
-declare namespace internal_shared {
-    function batcher(): Collector<Callback>;
-    function collector(): Collector<ReadonlySignal<unknown>>;
-}
-
-declare function internal_signal<T>(value: T, equals?: Equals<T>): Signal<T>;
-declare namespace internal_signal {
-    const batcher: Factory<batcher.Factory>;
-    namespace batcher {
-        type Factory = () => Collector<Callback>;
-    }
-    const collector: Factory<collector.Factory>;
-    namespace collector {
-        type Factory = () => Collector<ReadonlySignal<unknown>>;
-    }
-    class Constructor<T> implements Signal<T> {
-        #private;
-        constructor(value: T, equals: Maybe<Equals<T>>, listeners: Set<Callback>, batcher: Collector<Callback>, collector: Collector<ReadonlySignal<unknown>>);
-        read(): T;
-        peek(): T;
-        write(value: T): void;
-        equals(other: T): boolean;
-        subscribe(callback: Callback): Callback;
-        unsubscribe(callback: Callback): void;
-    }
-}
-
-declare namespace index {
-  export { internal_batch as batch, internal_collector as collector, internal_composed as composed, internal_computed as computed, internal_effect as effect, internal_ignore as ignore, internal_shared as shared, internal_signal as signal };
-}
-
-interface Batch {
-    (callback: Callback): void;
-    (callback: Callback, collector: Collector<Callback>): void;
-    (callback: Callback, collector?: Collector<Callback>): void;
-}
-declare const batch: Factory<Batch>;
-
-type ComposedFactory = <T>(read: () => T, write: (value: T) => void, equals?: Equals<T>) => Signal<T>;
-declare const composed: Factory<ComposedFactory>;
-
-type ComputedFactory = <T>(read: () => T, equals?: Equals<T>) => ReadonlySignal<T>;
-declare const computed: Factory<ComputedFactory>;
+declare class CallbackScheduler implements Scheduler<Callback> {
+    private readonly collector;
+    private readonly add;
+    constructor(collector: CollectorTarget<Callback>);
+    schedule(...args: Callback[]): void;
+}
 
-interface Ignore {
-    <Value>(value: ReadonlySignal<Value>): Value;
-    <Value>(callback: () => Value): Value;
-    <Value, Args extends any[]>(callback: (...args: Args) => Value, ...args: Args): Value;
+declare class BasicValue<T> implements Value<T> {
+    private value;
+    private readonly comparator;
+    constructor(value: T, comparator: Comparator<T>);
+    read(): T;
+    write(value: T): boolean;
+    equals(other: T): boolean;
+    equals(value: T, other: T): boolean;
+}
+declare class EmittingValue<T> {
+    private readonly value;
+    private readonly emitter;
+    constructor(value: Value<T>, emitter: Emitter);
+    read(): T;
+    write(value: T): boolean;
+    equals(other: T): boolean;
+    equals(value: T, other: T): boolean;
+}
+declare class ComputedValue<T> implements Value<T> {
+    private readonly cache;
+    private readonly computation;
+    private readonly dependencies;
+    constructor(cache: Value<T>, computation: Readable<T>, dependencies: DependencyObserver);
+    read(): T;
+    private recompute;
+    write(_: T): boolean;
+    equals(other: T): boolean;
+    equals(value: T, other: T): boolean;
 }
-declare const ignore: Factory<Ignore>;
 
-interface Config {
-    collector?: Maybe<CollectorFactory>;
-    signal?: Maybe<SignalFactory>;
-    computed?: Maybe<ComputedFactory>;
-    composed?: Maybe<ComposedFactory>;
-    effect?: Maybe<Effect>;
-    batch?: Maybe<Batch>;
-    ignore?: Maybe<Ignore>;
+declare class BatchWriter<T> implements Writable<T> {
+    private readonly writer;
+    private readonly batcher;
+    constructor(writer: Writable<T>, batcher: Batcher);
+    write(value: T): boolean;
 }
-declare function config(config?: Config): void;
 
-export { type Batch, type Callable, type Callback, type Collector, type CollectorFactory, type Comparable, type ComposedFactory, type ComputedFactory, type Config, type Effect, type EffectCallback, type EffectCleanup, type Equals, type Factory, type Ignore, type Maybe, type Peekable, type Readable, type ReadonlySignal, type Signal, type SignalFactory, type Subscribable, type Writable, batch, collector, composed, computed, config, effect, factory, ignore, index as internal, signal };
+type internal_BasicValue<T> = BasicValue<T>;
+declare const internal_BasicValue: typeof BasicValue;
+type internal_BatchWriter<T> = BatchWriter<T>;
+declare const internal_BatchWriter: typeof BatchWriter;
+type internal_CallbackScheduler = CallbackScheduler;
+declare const internal_CallbackScheduler: typeof CallbackScheduler;
+type internal_CollectorBasedBatcher = CollectorBasedBatcher;
+declare const internal_CollectorBasedBatcher: typeof CollectorBasedBatcher;
+type internal_CollectorController<T> = CollectorController<T>;
+declare const internal_CollectorController: typeof CollectorController;
+type internal_Composed<T> = Composed<T>;
+declare const internal_Composed: typeof Composed;
+type internal_ComputedValue<T> = ComputedValue<T>;
+declare const internal_ComputedValue: typeof ComputedValue;
+type internal_DependencyManager = DependencyManager;
+declare const internal_DependencyManager: typeof DependencyManager;
+type internal_EmittingValue<T> = EmittingValue<T>;
+declare const internal_EmittingValue: typeof EmittingValue;
+type internal_Reactive<T> = Reactive<T>;
+declare const internal_Reactive: typeof Reactive;
+type internal_ScheduledEmitter = ScheduledEmitter;
+declare const internal_ScheduledEmitter: typeof ScheduledEmitter;
+declare const internal_Snapshot: typeof Snapshot;
+declare namespace internal {
+  export { internal_BasicValue as BasicValue, internal_BatchWriter as BatchWriter, internal_CallbackScheduler as CallbackScheduler, internal_CollectorBasedBatcher as CollectorBasedBatcher, internal_CollectorController as CollectorController, internal_Composed as Composed, internal_ComputedValue as ComputedValue, internal_DependencyManager as DependencyManager, internal_EmittingValue as EmittingValue, internal_Reactive as Reactive, internal_ScheduledEmitter as ScheduledEmitter, internal_Snapshot as Snapshot };
+}
+
+declare function call(callback: Callback): void;
+
+type Factory<FactoryFunction extends Callable> = FactoryFunction & {
+    factory(factory: Maybe<FactoryFunction>): void;
+    default(factory: Maybe<FactoryFunction>): void;
+    configured(): boolean;
+};
+declare function factory<FactoryFunction extends Callable>(name: string): Factory<FactoryFunction>;
+
+declare function singleton<T>(factory: () => T): {
+    (): T;
+    instance: T | undefined;
+};
+
+type utils_Factory<FactoryFunction extends Callable> = Factory<FactoryFunction>;
+declare const utils_call: typeof call;
+declare const utils_factory: typeof factory;
+declare const utils_singleton: typeof singleton;
+declare namespace utils {
+  export { type utils_Factory as Factory, utils_call as call, utils_factory as factory, utils_singleton as singleton };
+}
+
+declare function configuration(): {
+    signal: Factory<SignalFactory>;
+    computed: Factory<ComputedFactory>;
+    composed: Factory<ComposedFactory>;
+    batcher: Factory<() => Batcher>;
+    ignorer: Factory<() => Ignore>;
+    scheduler: Factory<() => Scheduler<Callback>>;
+    tracker: Factory<() => Tracker<ReadonlySignal<unknown>>>;
+    collector: Factory<() => Collector<ReadonlySignal<unknown>>>;
+    dependency_tracker: Factory<() => DependencyTracker>;
+    dependency_collector: Factory<() => CollectorController<ReadonlySignal<unknown>>>;
+    callback_collector: Factory<() => CollectorController<Callback>>;
+};
+
+export { type Batcher, type Callable, type Callback, type Collector, type CollectorState, type CollectorTarget, type Comparable, type Comparator, type ComposedFactory, type ComputedFactory, type DependencyObserver, type DependencyState, type DependencyTracker, type Emitter, Equals, type Ignore, internal as Internal, type Maybe, type Peekable, type Readable, type ReadonlySignal, type Scheduler, type Signal, type SignalFactory, type Subscribable, type Tracker, type Value, type Writable, type Write, batch, comparator, composed, computed, configuration, ignore, reader, signal, utils, writer };