@mmstack/primitives 21.0.23 → 21.0.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mmstack/primitives",
-  "version": "21.0.23",
+  "version": "21.0.24",
   "keywords": [
     "angular",
     "signals",

package/types/mmstack-primitives.d.ts

@@ -564,7 +564,30 @@ declare const mapArray: typeof indexArray;
  * @param mapFn The mapping function. Receives the item and its index as a Signal.
  * @param options Optional configuration:
  *  - `onDestroy`: A callback invoked when a mapped item is removed from the array.
+ *  - `key`: A custom key extractor for identity matching (e.g. `(item) => item.id`)
+ *    when item references change but conceptual identity is preserved.
  * @returns A `Signal<U[]>` containing the mapped array.
+ *
+ * @example
+ * ```ts
+ * const users = signal([
+ *   { id: 1, name: 'Alice' },
+ *   { id: 2, name: 'Bob' },
+ * ]);
+ *
+ * const rows = keyArray(
+ *   users,
+ *   (user, index) => ({
+ *     label: computed(() => `#${index()} ${user.name}`),
+ *     id: user.id,
+ *   }),
+ *   { key: (u) => u.id },
+ * );
+ *
+ * // Reordering users() rebuilds index signals only — `rows` entries
+ * // are matched by id and reused, not re-created.
+ * users.set([users()[1], users()[0]]);
+ * ```
  */
 declare function keyArray<T, U, K>(source: Signal<T[]> | (() => T[]), mapFn: (v: T, i: Signal<number>) => U, options?: {
     onDestroy?: (value: U) => void;
@@ -579,12 +602,71 @@ declare function keyArray<T, U, K>(source: Signal<T[]> | (() => T[]), mapFn: (v:
 type MappedObject<T extends object, U> = {
     [K in keyof T]: U;
 };
+/**
+ * Reactively maps each property of an object signal into a new object,
+ * preserving the same set of keys. For each key, `mapFn` receives a stable
+ * per-key signal — outputs for keys that haven't been added or removed are
+ * reused on subsequent reads. Sibling to {@link indexArray} / {@link keyArray}
+ * but for object records.
+ *
+ * The type of per-key signal passed into `mapFn` depends on the source:
+ * - `MutableSignal<T>` source → `MutableSignal<T[K]>` (in-place mutation)
+ * - `WritableSignal<T>` source → `WritableSignal<T[K]>` (two-way binding)
+ * - read-only `Signal<T>` or `() => T` source → read-only `Signal<T[K]>`
+ *
+ * @typeParam T The object type held by the source signal.
+ * @typeParam U The type produced for each key by `mapFn`.
+ *
+ * @param source A `MutableSignal<T>` whose properties are mapped with full
+ *   in-place mutation capability via the per-key `MutableSignal`.
+ * @param mapFn Receives each key and its per-key `MutableSignal<T[K]>`.
+ * @param options Optional `onDestroy(value)` callback fired when a key is
+ *   removed from the source.
+ * @returns A read-only signal of the mapped object.
+ *
+ * @example
+ * ```ts
+ * const state = mutable({ name: 'Alice', age: 30 });
+ * const view = mapObject(state, (key, prop) => ({
+ *   label: key,
+ *   current: computed(() => prop()),
+ *   onInput: (next: any) => prop.set(next),
+ * }));
+ * view().age.onInput(31);
+ * state(); // { name: 'Alice', age: 31 }
+ * ```
+ */
 declare function mapObject<T extends object, U>(source: MutableSignal<T>, mapFn: <K extends keyof T>(key: K, value: MutableSignal<T[K]>) => U, options?: {
     onDestroy?: (value: U) => void;
 }): Signal<MappedObject<T, U>>;
+/**
+ * Reactively maps each property of a `WritableSignal<T>` into a new object.
+ * Each key's per-property signal supports `.set` / `.update` for two-way
+ * binding back into the parent object.
+ *
+ * @example
+ * ```ts
+ * const user = signal({ name: 'Alice', age: 30 });
+ * const inputs = mapObject(user, (key, prop) => ({
+ *   value: prop,
+ *   setValue: (v: any) => prop.set(v),
+ * }));
+ * ```
+ */
 declare function mapObject<T extends object, U>(source: WritableSignal<T>, mapFn: <K extends keyof T>(key: K, value: WritableSignal<T[K]>) => U, options?: {
     onDestroy?: (value: U) => void;
 }): Signal<MappedObject<T, U>>;
+/**
+ * Reactively maps each property of a read-only `Signal<T>` (or plain `() => T`
+ * accessor) into a new object. Per-key signals are read-only.
+ *
+ * @example
+ * ```ts
+ * const config = computed(() => ({ theme: 'dark', density: 'compact' }));
+ * const view = mapObject(config, (key, prop) => `${key}: ${prop()}`);
+ * view(); // { theme: 'theme: dark', density: 'density: compact' }
+ * ```
+ */
 declare function mapObject<T extends object, U>(source: (() => T) | Signal<T>, mapFn: <K extends keyof T>(key: K, value: Signal<T[K]>) => U, options?: {
     onDestroy?: (value: U) => void;
 }): Signal<MappedObject<T, U>>;
@@ -650,28 +732,136 @@ type PipeableSignal<T, TSig extends Signal<T> = Signal<T>> = TSig & {
  */
 type SignalValue<TSig extends Signal<any>> = TSig extends Signal<infer V> ? V : never;
 
-/** Project with optional equality. Pure & sync. */
+/**
+ * Synchronous projection of a signal value with optional `CreateSignalOptions`
+ * (custom `equal`, `debugName`, etc.). Equivalent to `map` plus the ability to
+ * pass signal options through to the underlying `computed()`.
+ *
+ * @example
+ * ```ts
+ * const user = piped({ id: 1, name: 'Alice' });
+ * const name = user.pipe(select((u) => u.name));
+ * name(); // 'Alice'
+ * ```
+ */
 declare const select: <I, O>(projector: (v: I) => O, opt?: CreateSignalOptions<O>) => Operator<I, O>;
-/** Combine with another signal using a projector. */
+/**
+ * Combine the piped signal with another `Signal` using a projector. The result
+ * recomputes whenever either source changes.
+ *
+ * @example
+ * ```ts
+ * const price = piped(10);
+ * const quantity = signal(3);
+ * const total = price.pipe(combineWith(quantity, (p, q) => p * q));
+ * total(); // 30
+ * ```
+ */
 declare const combineWith: <A, B, R>(other: Signal<B>, project: (a: A, b: B) => R, opt?: CreateSignalOptions<R>) => Operator<A, R>;
-/** Only re-emit when equal(prev, next) is false. */
+/**
+ * Suppress emissions while consecutive values are considered equal. The
+ * comparator defaults to `Object.is`; pass a custom one for structural or
+ * key-based equality (e.g. compare by `id` only).
+ *
+ * @example
+ * ```ts
+ * const user = piped({ id: 1, lastSeen: Date.now() });
+ * const byId = user.pipe(distinct((a, b) => a.id === b.id));
+ * // byId only re-emits when `id` changes, not on every `lastSeen` update
+ * ```
+ */
 declare const distinct: <T>(equal?: (a: T, b: T) => boolean) => Operator<T, T>;
-/** map to new value */
+/**
+ * Pure synchronous transform from input to output. Equivalent to a `computed()`
+ * that reads the source and returns `fn(value)`.
+ *
+ * @example
+ * ```ts
+ * const count = piped(2);
+ * const doubled = count.pipe(map((n) => n * 2));
+ * doubled(); // 4
+ * ```
+ */
 declare const map: <I, O>(fn: (v: I) => O) => Operator<I, O>;
-/** filter values, keeping the last value if it was ever available, if first value is filtered will return undefined */
+/**
+ * Keep only values that pass the predicate. The result holds the last passing
+ * value across emissions; before any value passes, the result is `undefined` —
+ * see {@link filterWith} when you need a non-`undefined` seed.
+ *
+ * @example
+ * ```ts
+ * const event = piped<MouseEvent | null>(null);
+ * const clicks = event.pipe(filter((e): e is MouseEvent => e?.type === 'click'));
+ * clicks(); // undefined until a click happens, then the last MouseEvent
+ * ```
+ */
 declare const filter: <T>(predicate: (v: T) => boolean) => Operator<T, T | undefined>;
-/** tap into the value */
+/**
+ * Run a side effect on every emission without altering the signal value. Wraps
+ * Angular's `effect()`, so it must run in an injection context or receive an
+ * explicit `injector`. Use for logging / analytics — not for setting other
+ * signals (that's what regular `effect()` is for).
+ *
+ * @example
+ * ```ts
+ * const count = piped(0);
+ * count.pipe(tap((n) => console.log('count:', n)));
+ * count.set(1); // logs 'count: 1'
+ * ```
+ */
 declare const tap: <T>(fn: (v: T) => void, injector?: Injector) => Operator<T, T>;
 /**
- * Like {@link filter}, but emits `initial` until a value passes the predicate
- * for the first time. Avoids the `T | undefined` return type.
+ * Like {@link filter}, but emits `initial` until a value first passes the
+ * predicate. Eliminates the `T | undefined` return type at the cost of an
+ * explicit seed value.
+ *
+ * @example
+ * ```ts
+ * const event = piped<MouseEvent | null>(null);
+ * const lastClick = event.pipe(filterWith((e) => e?.type === 'click', null));
+ * lastClick(); // null until the first click, then the most recent click event
+ * ```
  */
 declare const filterWith: <T>(predicate: (v: T) => boolean, initial: T) => Operator<T, T>;
-/** Emits `initial` first, then mirrors source. */
+/**
+ * Emit `initial` on the first read, then mirror the source on every subsequent
+ * read. Useful for giving a pipeline a sensible seed value before the source
+ * is ready (e.g. loading state).
+ *
+ * @example
+ * ```ts
+ * const data = piped<User | null>(null);
+ * const view = data.pipe(startWith<User | null, 'loading'>('loading'));
+ * view(); // 'loading' on first read, then User | null afterward
+ * ```
+ */
 declare const startWith: <T, U>(initial: U) => Operator<T, T | U>;
-/** Emits `[prev, curr]` pairs. The first emission has prev = undefined. */
+/**
+ * Emit `[prev, curr]` tuples so consumers can react to transitions instead of
+ * raw values. On the first emission `prev` is `undefined`.
+ *
+ * @example
+ * ```ts
+ * const count = piped(0);
+ * const delta = count.pipe(pairwise(), map(([prev, curr]) => curr - (prev ?? 0)));
+ * count.set(5);
+ * delta(); // 5
+ * ```
+ */
 declare const pairwise: <T>() => Operator<T, [T | undefined, T]>;
-/** Reduce-like accumulator across emissions. */
+/**
+ * Reduce-like accumulator that folds each emission into a running result.
+ * Behaves like `Array.prototype.reduce` but applied over time, with the
+ * accumulator persisted across emissions.
+ *
+ * @example
+ * ```ts
+ * const delta = piped(0);
+ * const total = delta.pipe(scan((acc, n) => acc + n, 0));
+ * delta.set(5); // total() === 5
+ * delta.set(3); // total() === 8
+ * ```
+ */
 declare const scan: <T, R>(reducer: (acc: R, curr: T) => R, seed: R) => Operator<T, R>;
 
 /**
@@ -829,6 +1019,15 @@ type BatteryStatus = {
  * Battery Status API. Returns `null` until the underlying `getBattery()`
  * promise resolves, or permanently when the API is unsupported (Firefox /
  * Safari at the time of writing). SSR-safe.
+ *
+ * @example
+ * ```ts
+ * const battery = batteryStatus();
+ * effect(() => {
+ *   const b = battery();
+ *   if (b) console.log(`${Math.round(b.level * 100)}% • charging: ${b.charging}`);
+ * });
+ * ```
  */
 declare function batteryStatus(debugName?: string): Signal<BatteryStatus | null>;
 
@@ -963,6 +1162,15 @@ type FocusWithinTarget = ElementRef<Element> | Element | Signal<ElementRef<Eleme
  * Defaults `target` to the current `ElementRef` so it can be used inline in a
  * component's `class` field. SSR-safe — returns a constant `false` signal on
  * the server.
+ *
+ * @example
+ * ```ts
+ * @Component({ ... })
+ * class MenuComponent {
+ *   // Defaults to the host element — flips true when focus is inside.
+ *   readonly hasFocus = focusWithin();
+ * }
+ * ```
  */
 declare function focusWithin(target?: FocusWithinTarget): Signal<boolean>;
 
@@ -1019,6 +1227,14 @@ type IdleSignal = Signal<boolean> & {
  * activity) resets the timer and flips the signal back to `false`.
  *
  * SSR-safe — always `false` with a frozen `since` date on the server.
+ *
+ * @example
+ * ```ts
+ * const isAway = idle({ ms: 30_000 });
+ * effect(() => {
+ *   if (isAway()) console.log('idle since', isAway.since());
+ * });
+ * ```
  */
 declare function idle(opt?: IdleOptions): IdleSignal;
 
@@ -1212,6 +1428,14 @@ type NetworkStatusSignal = Signal<boolean> & {
  *
  * @param debugName Optional debug name for the signal.
  * @returns A `NetworkStatusSignal` instance.
+ *
+ * @example
+ * ```ts
+ * const online = networkStatus();
+ * effect(() => {
+ *   if (!online()) console.log('offline since', online.since());
+ * });
+ * ```
  */
 declare function networkStatus(debugName?: string): NetworkStatusSignal;
 
@@ -1226,6 +1450,15 @@ type ScreenOrientation = {
  *
  * SSR-safe — returns a constant `portrait-primary / 0°` signal on the server
  * and in environments without `screen.orientation` support.
+ *
+ * @example
+ * ```ts
+ * const screenOrientation = orientation();
+ * effect(() => {
+ *   const { type, angle } = screenOrientation();
+ *   console.log(`${type} at ${angle}°`);
+ * });
+ * ```
  */
 declare function orientation(debugName?: string): Signal<ScreenOrientation>;
 
@@ -1641,6 +1874,27 @@ type SensorsOptions<TKey extends keyof SensorTypedOptions> = {
 type Sensors<TKey extends keyof SensorTypedOptions> = {
     [K in TKey]: SensorTypedOptions[K]['returnType'];
 };
+/**
+ * Bulk sensor factory — creates several sensor signals at once and returns
+ * them keyed by sensor type. Convenient when a single consumer needs to react
+ * to multiple browser signals; for a single sensor prefer {@link sensor}
+ * directly.
+ *
+ * @typeParam TType The union of sensor keys being requested.
+ * @param track Array of sensor type keys to create.
+ * @param opt Optional per-sensor options keyed by sensor type.
+ * @returns A record `{ [key]: <SensorReturnType> }` for each requested key.
+ *
+ * @example
+ * ```ts
+ * const { windowSize, networkStatus } = sensors(
+ *   ['windowSize', 'networkStatus'],
+ *   { windowSize: { throttle: 200 } },
+ * );
+ *
+ * effect(() => console.log(windowSize(), networkStatus()));
+ * ```
+ */
 declare function sensors<const TType extends keyof SensorTypedOptions>(track: TType[], opt?: SensorsOptions<TType>): Sensors<TType>;
 
 /**