All files / src/collections reactiveSet.ts

100% Statements 84/84
100% Branches 49/49
100% Functions 11/11
100% Lines 82/82

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315                                                          35x                                         18x         13x 11x   11x 11x       11x 11x 11x     2x                                                               38x     38x   38x 4x 14x           8x 6x 4x   2x   6x 3x 3x 4x   3x 2x 2x 2x     6x       63x 51x 51x 51x 12x 12x 12x   51x 51x 51x   63x       21x 18x 18x 9x 9x   18x 3x 3x 3x   18x 18x   21x       3x 2x 2x 1x 2x 2x     2x 1x 2x 2x 2x     2x 2x 2x                   5x 5x 5x 13x 13x   5x 19x 6x     5x 5x 5x                                 71x 3x 3x 2x     71x                                                                                                                                                                   38x  
import { batchFlush, batchStart, type BatchTask, batchTasks } from "../batch";
import { context } from "../context";
import { type EventObject, on, type RemoveListener, send, size } from "../event";
import { type ReadableProvider, type OwnedWritable, type Readable } from "../interface";
import { writable } from "../readable";
import { onDisposeValue, type OnDisposeValue } from "./utils";
 
export interface ReactiveSetChanged<V> {
  readonly upsert: readonly V[];
  readonly delete: readonly V[];
}
 
interface OnChanged<V> extends BatchTask<EventObject<ReactiveSetChanged<V>>> {
  readonly upsert_: Set<V>;
  readonly delete_: Set<V>;
}
 
/**
 * OwnedReactiveSet extends the standard Set interface with reactive capabilities.
 *
 * @category ReactiveSet
 */
export class OwnedReactiveSet<V> extends Set<V> implements ReadableProvider<ReadonlyReactiveSet<V>> {
  /**
   * A Readable that emits the Set itself whenever it changes.
   *
   * @group Readable
   */
  public get $(): Readable<ReadonlyReactiveSet<V>> {
    return (this._$ ??= writable(this, { equal: false }));
  }
 
  /**
   * Subscribe to changes in the set.
   *
   * @group Events
   * @param fn - The function to call when the set is changed.
   * @returns A disposer function to unsubscribe from the event.
   *
   * @example
   * ```ts
   * import { reactiveSet } from "@embra/reactivity";
   *
   * const set = reactiveSet<number>();
   * const disposer = set.onChanged((changed) => {
   *   console.log("Set changed:", changed);
   * });
   * ```
   */
  public onChanged(fn: (changed: ReactiveSetChanged<V>) => void): RemoveListener {
    return on(
      (this._onChanged_ ??= {
        delete_: new Set<V>(),
        upsert_: new Set<V>(),
        batchTask_: () => {
          if (this._onChanged_ && size(this._onChanged_)) {
            const { upsert_, delete_ } = this._onChanged_;
            /** c8 ignore else -- @preserve */
            if (upsert_.size > 0 || delete_.size > 0) {
              const changedData = {
                upsert: [...upsert_],
                delete: [...delete_],
              };
              upsert_.clear();
              delete_.clear();
              send(this._onChanged_, changedData);
            }
          } else {
            this._onChanged_ = null;
          }
        },
      }),
      fn,
    );
  }
 
  /**
   * Subscribe to events when a value is needed to be disposed.
   *
   * A value is considered for disposal when:
   * - it is deleted from the set.
   * - it is replaced by another value (the old value is removed).
   * - it is cleared from the set.
   * - the set is disposed.
   *
   * @function
   * @group Events
   * @param fn - The function to call when a value is needed to be disposed.
   * @returns A disposer function to unsubscribe from the event.
   *
   * @example
   * ```ts
   * import { reactiveSet } from "@embra/reactivity";
   *
   * const set = reactiveSet<number>();
   * const disposer = set.onDisposeValue((value) => {
   *   console.log("Value disposed:", value);
   * });
   * ```
   */
  public readonly onDisposeValue = onDisposeValue;
 
  public constructor(values?: Iterable<V> | null) {
    super();
 
    if (values) {
      for (const value of values) {
        super.add(value);
      }
    }
  }
 
  public dispose(): void {
    if (this._disposed_) return;
    if (process.env.NODE_ENV !== "production") {
      this._disposed_ = new Error("[embra] ReactiveSet disposed at:");
    } else {
      this._disposed_ = true;
    }
    if (this.onDisposeValue_) {
      const { delete_ } = this.onDisposeValue_;
      for (const value of this.values()) {
        delete_.add(value);
      }
      if (delete_.size) {
        const isBatchTop = batchStart();
        batchTasks.add(this.onDisposeValue_);
        isBatchTop && batchFlush();
      }
    }
    this._$ = this._onChanged_ = this.onDisposeValue_ = null;
  }
 
  public override add(value: V): this {
    if (!this.has(value)) {
      const isBatchTop = batchStart();
      this.onDisposeValue_?.delete_.delete(value);
      if (this._onChanged_) {
        this._onChanged_.upsert_.add(value);
        this._onChanged_.delete_.delete(value);
        batchTasks.add(this._onChanged_);
      }
      super.add(value);
      this._notify_();
      isBatchTop && batchFlush();
    }
    return this;
  }
 
  public override delete(value: V): boolean {
    if (this.has(value)) {
      const isBatchTop = batchStart();
      if (this.onDisposeValue_) {
        this.onDisposeValue_.delete_.add(value);
        batchTasks.add(this.onDisposeValue_);
      }
      if (this._onChanged_) {
        this._onChanged_.delete_.add(value);
        this._onChanged_.upsert_.delete(value);
        batchTasks.add(this._onChanged_);
      }
      this._notify_();
      isBatchTop && batchFlush();
    }
    return super.delete(value);
  }
 
  public override clear(): void {
    if (this.size) {
      const isBatchTop = batchStart();
      if (this.onDisposeValue_) {
        for (const value of this) {
          this.onDisposeValue_.delete_.add(value);
          batchTasks.add(this.onDisposeValue_);
        }
      }
      if (this._onChanged_) {
        for (const value of this) {
          this._onChanged_.delete_.add(value);
          this._onChanged_.upsert_.delete(value);
          batchTasks.add(this._onChanged_);
        }
      }
      super.clear();
      this._notify_();
      isBatchTop && batchFlush();
    }
  }
 
  /**
   * Replace the contents of the set with the given values.
   * @param values - The new values to replace the set with.
   * @returns The set itself.
   */
  public replace(values: Iterable<V>): this {
    const isBatchTop = batchStart();
    const newValues: Set<V> = (context.replaceMarkers_ ??= new Set());
    for (const value of values) {
      newValues.add(value);
      this.add(value);
    }
    for (const value of this) {
      if (!newValues.has(value)) {
        this.delete(value);
      }
    }
    newValues.clear();
    isBatchTop && batchFlush();
    return this;
  }
 
  /** @internal */
  private _disposed_?: Error | true;
 
  /** @internal */
  private _$?: OwnedWritable<this> | null;
 
  /** @internal */
  private _onChanged_?: null | OnChanged<V>;
 
  /** @internal */
  public onDisposeValue_?: null | OnDisposeValue<V>;
 
  /** @internal */
  private _notify_() {
    if (this._disposed_) {
      console.error(this, new Error("disposed"));
      if (process.env.NODE_ENV !== "production") {
        console.error(this._disposed_);
      }
    }
    this._$?.set(this);
  }
}
 
/**
 * ReactiveSet is {@link OwnedReactiveSet} without the `dispose` method.
 *
 * @category ReactiveSet
 */
export type ReactiveSet<V> = Omit<OwnedReactiveSet<V>, "dispose">;
 
/**
 * ReadonlyReactiveSet is a readonly interface for {@link ReactiveSet}.
 *
 * @category ReactiveSet
 */
export interface ReadonlyReactiveSet<V> extends ReadonlySet<V> {
  /**
   * A Readable that emits the Set itself whenever it changes.
   *
   * @group Readable
   */
  readonly $: Readable<ReadonlySet<V>>;
  /**
   * Subscribe to changes in the set.
   *
   * @group Events
   * @param fn - The function to call when the set is changed.
   * @returns A disposer function to unsubscribe from the event.
   *
   * @example
   * ```ts
   * import { reactiveSet } from "@embra/reactivity";
   *
   * const set = reactiveSet<number>();
   * const disposer = set.onChanged((changed) => {
   *   console.log("Set changed:", changed);
   * });
   * ```
   */
  onChanged(fn: (changed: ReactiveSetChanged<V>) => void): RemoveListener;
  /**
   * Subscribe to events when a value is needed to be disposed.
   *
   * A value is considered for disposal when:
   * - it is deleted from the set.
   * - it is replaced by another value (the old value is removed).
   * - it is cleared from the set.
   * - the set is disposed.
   *
   * @function
   * @group Events
   * @param fn - The function to call when a value is needed to be disposed.
   * @returns A disposer function to unsubscribe from the event.
   *
   * @example
   * ```ts
   * import { reactiveSet } from "@embra/reactivity";
   *
   * const set = reactiveSet<number>();
   * const disposer = set.onDisposeValue((value) => {
   *   console.log("Value disposed:", value);
   * });
   * ```
   */
  readonly onDisposeValue: (fn: (value: V) => void) => RemoveListener;
}
 
/**
 * Creates a new {@link OwnedReactiveSet}.
 *
 * @category ReactiveSet
 * @param values - Initial values for the reactive set.
 * @returns A new instance of {@link OwnedReactiveSet}.
 *
 * @example
 * ```ts
 * import { reactiveSet } from "@embra/reactivity";
 *
 * const set$ = reactiveSet([1, 2, 3]);
 * ```
 */
export const reactiveSet = <V>(values?: Iterable<V> | null): OwnedReactiveSet<V> => new OwnedReactiveSet(values);