@valentin30/signal 0.0.9 → 0.2.0

package/dist/index.d.mts

@@ -1,201 +1,287 @@
-type Callable = (...args: any[]) => any;
+type Callable<Args extends any[] = any[], ReturnType = any> = (...args: Args) => ReturnType;
 
-type Maybe<T> = T | null | undefined;
-
-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 Callback = () => void;
-
-interface Collector$1<T> {
-    add(value: T): void;
-    collecting(): boolean;
-    collect(callback: Callback): Readonly<Set<T>>;
-    ignore(callback: Callback): void;
+interface Batcher {
+    batch<Value>(callback: () => Value): Value;
+    batch<Value, Args extends any[]>(callback: Callable<Args, Value>, ...args: Args): Value;
 }
-type CollectorFactory = <T>() => Collector$1<T>;
-declare const collector$1: Factory<CollectorFactory>;
+declare function batch<Value>(callback: () => Value): Value;
+declare function batch<Value, Args extends any[]>(callback: Callable<Args, Value>, ...args: Args): Value;
 
-declare function batch$1(callback: Callback): void;
-declare function batch$1(callback: Callback, collector: Collector$1<Callback>): void;
-declare function batch$1(callback: Callback, collector?: Collector$1<Callback>): void;
-declare namespace batch$1 {
-    var collector: Factory<BatchCollectorFactory>;
+type Write<T> = (value: T) => void | undefined | boolean;
+interface Writable<T> {
+    write(value: T): boolean;
 }
-type BatchCollectorFactory = () => Collector$1<Callback>;
+declare function writer<T>(write: Write<T>): Writable<T>;
 
-declare function collector<T>(): Collector$1<T>;
-declare class Collector<T> implements Collector$1<T> {
-    #private;
-    constructor(values: Set<T> | null);
-    collecting(): boolean;
-    add(value: T): void;
-    collect(callback: Callback): Set<T>;
-    ignore(callback: Callback): void;
+interface Comparator<T> {
+    equals(value: T, other: T): boolean;
 }
-
-interface Comparable<T> {
+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 Subscribable {
     subscribe(callback: Callback): Callback;
     unsubscribe(callback: Callback): void;
 }
 
-interface Writable<T> {
-    write(value: T): 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>;
 
-type Equals<T> = (value: T, other: T) => boolean;
+interface ComposedFactory {
+    <T>(value: ReadonlySignal<T>, write: Write<T>): Signal<T>;
+}
+declare function composed<T>(value: ReadonlySignal<T>, write: Write<T>): Signal<T>;
 
-interface Peekable<T> {
-    peek(): 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 Signal$1<T> extends Readable<T>, Writable<T>, Peekable<T>, Comparable<T>, Subscribable {
+interface Scheduler<T> {
+    schedule(...value: T[]): void;
 }
-interface ReadonlySignal<T> extends Readable<T>, Peekable<T>, Comparable<T>, Subscribable {
+
+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 SignalFactory = <T>(value: T, equals?: Equals<T>) => Signal$1<T>;
-declare const signal$1: Factory<SignalFactory>;
 
-declare function computed$1<T>(compute: () => T, equals?: Equals<T>): Computed<T>;
-declare namespace computed$1 {
-    var collector: Factory<ComputedCollectorFactory>;
+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;
+    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;
 }
-type ComputedCollectorFactory = () => Collector$1<ReadonlySignal<unknown>>;
-declare class Computed<T> implements ReadonlySignal<T> {
-    #private;
-    constructor(empty: boolean, value: T | undefined, values: [ReadonlySignal<unknown>, unknown][], dependencies: Set<ReadonlySignal<unknown>>, listeners: Set<Callback>, collector: Collector$1<ReadonlySignal<unknown>>, compute: () => T, equals: Maybe<Equals<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;
 }
 
-type ComposedBatcherFactory = () => Collector$1<Callback>;
-type ComposedCollectorFactory = () => Collector$1<ReadonlySignal<unknown>>;
-declare function composed$1<T>(compute: () => T, write: (value: T) => void, equals?: Equals<T>): Composed<T>;
-declare namespace composed$1 {
-    var batcher: Factory<ComposedBatcherFactory>;
-    var collector: Factory<ComposedCollectorFactory>;
+type Snapshot = [ReadonlySignal<unknown>, unknown];
+declare namespace Snapshot {
+    function changed([value, snapshot]: Snapshot): boolean;
+    function from(values: Set<ReadonlySignal<unknown>>): Snapshot[];
 }
-declare class Composed<T> extends Computed<T> implements Signal$1<T> {
-    #private;
-    constructor(empty: boolean, value: T | undefined, values: [ReadonlySignal<unknown>, unknown][], dependencies: Set<ReadonlySignal<unknown>>, listeners: Set<Callback>, batcher: Collector$1<Callback>, collector: Collector$1<ReadonlySignal<unknown>>, compute: () => T, write: (value: T) => void, equals: Maybe<Equals<T>>);
-    write(value: T): void;
+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;
 }
 
-type Effect = (callback: EffectCallback) => Callback;
-type EffectCallback = (init: boolean) => EffectCleanup | void;
-type EffectCleanup = (destroy: boolean) => void;
-declare const effect$1: Factory<Effect>;
-
-declare function effect(cb: EffectCallback): Callback;
-declare namespace effect {
-    var collector: Factory<EffectCollectorFactory>;
+interface Emitter {
+    emit(): void;
 }
-type EffectCollectorFactory = () => Collector$1<ReadonlySignal<unknown>>;
 
-interface Ignore$1 {
-    <Value>(value: ReadonlySignal<Value>): Value;
-    <Value>(callback: () => Value): Value;
-    <Value, Args extends any[]>(callback: (...args: Args) => Value, ...args: Args): Value;
-}
-declare function ignore$1<Value>(value: ReadonlySignal<Value>): Value;
-declare function ignore$1<Value>(callback: () => Value): Value;
-declare function ignore$1<Value, Args extends any[]>(callback: (...args: Args) => Value, ...args: Args): Value;
-declare namespace ignore$1 {
-    var collector: Factory<IgnoreCollectorFactory>;
+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;
 }
-type IgnoreCollectorFactory = () => Collector$1<ReadonlySignal<unknown>>;
 
-declare const shared: {
-    batcher(): Collector$1<Callback>;
-    collector(): Collector$1<ReadonlySignal<unknown>>;
-};
-
-type SignalBatcherFactory = () => Collector$1<Callback>;
-type SignalCollectorFactory = () => Collector$1<ReadonlySignal<unknown>>;
-declare function signal<T>(value: T, equals?: Equals<T>): Signal$1<T>;
-declare namespace signal {
-    var batcher: Factory<SignalBatcherFactory>;
-    var collector: Factory<SignalCollectorFactory>;
+interface Value<T> extends Readable<T>, Writable<T>, Comparable<T> {
 }
-declare class Signal<T> implements Signal$1<T> {
-    #private;
-    constructor(value: T, equals: Maybe<Equals<T>>, listeners: Set<Callback>, batcher: Collector$1<Callback>, collector: Collector$1<ReadonlySignal<unknown>>);
+
+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): void;
+    write(value: T): boolean;
     equals(other: T): boolean;
+    equals(value: T, other: T): boolean;
     subscribe(callback: Callback): Callback;
     unsubscribe(callback: Callback): void;
 }
 
-type index_BatchCollectorFactory = BatchCollectorFactory;
-type index_Collector<T> = Collector<T>;
-declare const index_Collector: typeof Collector;
-type index_Composed<T> = Composed<T>;
-declare const index_Composed: typeof Composed;
-type index_ComposedBatcherFactory = ComposedBatcherFactory;
-type index_ComposedCollectorFactory = ComposedCollectorFactory;
-type index_Computed<T> = Computed<T>;
-declare const index_Computed: typeof Computed;
-type index_ComputedCollectorFactory = ComputedCollectorFactory;
-type index_EffectCollectorFactory = EffectCollectorFactory;
-type index_IgnoreCollectorFactory = IgnoreCollectorFactory;
-type index_Signal<T> = Signal<T>;
-declare const index_Signal: typeof Signal;
-type index_SignalBatcherFactory = SignalBatcherFactory;
-type index_SignalCollectorFactory = SignalCollectorFactory;
-declare const index_collector: typeof collector;
-declare const index_effect: typeof effect;
-declare const index_shared: typeof shared;
-declare const index_signal: typeof signal;
-declare namespace index {
-  export { type index_BatchCollectorFactory as BatchCollectorFactory, index_Collector as Collector, index_Composed as Composed, type index_ComposedBatcherFactory as ComposedBatcherFactory, type index_ComposedCollectorFactory as ComposedCollectorFactory, index_Computed as Computed, type index_ComputedCollectorFactory as ComputedCollectorFactory, type index_EffectCollectorFactory as EffectCollectorFactory, type Ignore$1 as Ignore, type index_IgnoreCollectorFactory as IgnoreCollectorFactory, index_Signal as Signal, type index_SignalBatcherFactory as SignalBatcherFactory, type index_SignalCollectorFactory as SignalCollectorFactory, batch$1 as batch, index_collector as collector, composed$1 as composed, computed$1 as computed, index_effect as effect, ignore$1 as ignore, index_shared as shared, index_signal as signal };
-}
-
-interface Batch {
-    (callback: Callback): void;
-    (callback: Callback, collector: Collector$1<Callback>): void;
-    (callback: Callback, collector?: Collector$1<Callback>): void;
-}
-declare const batch: Factory<Batch>;
-
-type ComposedFactory = <T>(read: () => T, write: (value: T) => void, equals?: Equals<T>) => Signal$1<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 class BatchWriter<T> implements Writable<T> {
+    private readonly writer;
+    private readonly batcher;
+    constructor(writer: Writable<T>, batcher: Batcher);
+    write(value: 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$1>;
+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 config(config?: Config): void;
 
-export { type Batch, type Callable, type Callback, type Collector$1 as 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$1 as Signal, type SignalFactory, type Subscribable, type Writable, batch, collector$1 as collector, composed, computed, config, effect$1 as effect, factory, ignore, index as internal, signal$1 as signal };
+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 };