@rimbu/common 0.9.2 → 0.10.0

package/src/async-reducer.ts

@@ -4,6 +4,7 @@ import {
   CollectFun,
   MaybePromise,
   Reducer,
+  Eq,
 } from './internal';
 
 /**
@@ -372,4 +373,666 @@ export namespace AsyncReducer {
       reducer.stateToResult
     );
   }
+
+  /**
+   * A `Reducer` that sums all given numeric input values.
+   * @example
+   * ```ts
+   * console.log(Stream.range({ amount: 5 }).reduce(Reducer.sum))
+   * // => 10
+   * ```
+   */
+  export const sum = createMono(0, (state, next): number => state + next);
+
+  /**
+   * A `Reducer` that calculates the product of all given numeric input values.
+   * @example
+   * ```ts
+   * console.log(Stream.range({ start: 1, amount: 5 }).reduce(product))
+   * // => 120
+   * ```
+   */
+  export const product = createMono(1, (state, next, _, halt): number => {
+    if (0 === next) halt();
+    return state * next;
+  });
+
+  /**
+   * A `Reducer` that calculates the average of all given numberic input values.
+   * @example
+   * ```ts
+   * console.log(Stream.range({ amount: 5 }).reduce(Reducer.average));
+   * // => 2
+   * ```
+   */
+  export const average = createMono(
+    0,
+    (avg, value, index): number => avg + (value - avg) / (index + 1)
+  );
+
+  /**
+   * Returns a `Reducer` that remembers the minimum value of the inputs using the given `compFun` to compare input values
+   * @param compFun - a comparison function for two input values, returning 0 when equal, positive when greater, negetive when smaller
+   * @param otherwise - (default: undefineds) a fallback value when there were no input values given
+   * @example
+   * ```ts
+   * const stream = Stream.of('abc', 'a', 'abcde', 'ab')
+   * console.log(stream.minBy((s1, s2) => s1.length - s2.length))
+   * // 'a'
+   * ```
+   */
+  export const minBy: {
+    <T>(compFun: (v1: T, v2: T) => MaybePromise<number>): AsyncReducer<
+      T,
+      T | undefined
+    >;
+    <T, O>(
+      compFun: (v1: T, v2: T) => MaybePromise<number>,
+      otherwise: AsyncOptLazy<O>
+    ): AsyncReducer<T, T | O>;
+  } = <T, O>(
+    compFun: (v1: T, v2: T) => MaybePromise<number>,
+    otherwise?: AsyncOptLazy<O>
+  ) => {
+    const token = Symbol();
+    return create<T, T | O, T | typeof token>(
+      token,
+      async (state, next): Promise<T> => {
+        if (token === state) return next;
+        return (await compFun(state, next)) < 0 ? state : next;
+      },
+      (state): MaybePromise<T | O> =>
+        token === state ? AsyncOptLazy.toMaybePromise(otherwise!) : state
+    );
+  };
+
+  /**
+   * Returns a `Reducer` that remembers the minimum value of the numberic inputs.
+   * @param otherwise - (default: undefined) a fallback value when there were no input values given
+   * @example
+   * ```ts
+   * console.log(Stream.of(5, 3, 7, 4).reduce(Reducer.min()))
+   * // => 3
+   * ```
+   */
+  export const min: {
+    (): AsyncReducer<number, number | undefined>;
+    <O>(otherwise: AsyncOptLazy<O>): AsyncReducer<number, number | O>;
+  } = <O>(otherwise?: AsyncOptLazy<O>) => {
+    return create<number, number | O, number | undefined>(
+      undefined,
+      (state, next): number =>
+        undefined !== state && state < next ? state : next,
+      (state): MaybePromise<number | O> =>
+        state ?? AsyncOptLazy.toMaybePromise(otherwise!)
+    );
+  };
+
+  /**
+   * Returns a `Reducer` that remembers the maximum value of the inputs using the given `compFun` to compare input values
+   * @param compFun - a comparison function for two input values, returning 0 when equal, positive when greater, negetive when smaller
+   * @param otherwise - (default: undefined) a fallback value when there were no input values given
+   * @example
+   * ```ts
+   * const stream = Stream.of('abc', 'a', 'abcde', 'ab')
+   * console.log(stream.maxBy((s1, s2) => s1.length - s2.length))
+   * // 'abcde'
+   * ```
+   */
+  export const maxBy: {
+    <T>(compFun: (v1: T, v2: T) => MaybePromise<number>): AsyncReducer<
+      T,
+      T | undefined
+    >;
+    <T, O>(
+      compFun: (v1: T, v2: T) => MaybePromise<number>,
+      otherwise: AsyncOptLazy<O>
+    ): AsyncReducer<T, T | O>;
+  } = <T, O>(
+    compFun: (v1: T, v2: T) => MaybePromise<number>,
+    otherwise?: AsyncOptLazy<O>
+  ): AsyncReducer<T, T | O> => {
+    const token = Symbol();
+    return create<T, T | O, T | typeof token>(
+      token,
+      async (state, next): Promise<T> => {
+        if (token === state) return next;
+        return (await compFun(state, next)) > 0 ? state : next;
+      },
+      (state): MaybePromise<T | O> =>
+        token === state ? AsyncOptLazy.toMaybePromise(otherwise!) : state
+    );
+  };
+
+  /**
+   * Returns a `Reducer` that remembers the maximum value of the numberic inputs.
+   * @param otherwise - (default: undefined) a fallback value when there were no input values given
+   * @example
+   * ```ts
+   * console.log(Stream.of(5, 3, 7, 4).reduce(Reducer.max()))
+   * // => 7
+   * ```
+   */
+  export const max: {
+    (): AsyncReducer<number, number | undefined>;
+    <O>(otherwise: AsyncOptLazy<O>): AsyncReducer<number, number | O>;
+  } = <O>(otherwise?: AsyncOptLazy<O>): AsyncReducer<number, number | O> => {
+    return create<number, number | O, number | undefined>(
+      undefined,
+      (state, next): number =>
+        undefined !== state && state > next ? state : next,
+      (state): MaybePromise<number | O> =>
+        state ?? AsyncOptLazy.toMaybePromise(otherwise!)
+    );
+  };
+
+  /**
+   * Returns a `Reducer` that joins the given input values into a string using the given options.
+   * @param options - an object containing:<br/>
+   * - sep: (optional) a seperator string value between values in the output<br/>
+   * - start: (optional) a start string to prepend to the output<br/>
+   * - end: (optional) an end string to append to the output<br/>
+   * @example
+   * ```ts
+   * console.log(Stream.of(1, 2, 3).reduce(Reducer.join({ sep: '-' })))
+   * // => '1-2-3'
+   * ```
+   */
+  export function join<T>({
+    sep = '',
+    start = '',
+    end = '',
+    valueToString = String as (value: T) => string,
+  } = {}): AsyncReducer<T, string> {
+    let curSep = '';
+    let curStart = start;
+    return create(
+      '',
+      (state, next): string => {
+        const result = curStart.concat(state, curSep, valueToString(next));
+        curSep = sep;
+        curStart = '';
+        return result;
+      },
+      (state): string => state.concat(end)
+    );
+  }
+
+  /**
+   * Returns an `AsyncReducer` that remembers the amount of input items provided.
+   * @param pred - (optional) a predicate that returns false if the item should not be counted given:<br/>
+   * - value: the current input value<br/>
+   * - index: the input value index
+   * @example
+   * ```ts
+   * const stream = AsyncStream.from(Stream.range({ amount: 10 }))
+   * console.log(await stream.reduce(AsyncReducer.count()))
+   * // => 10
+   * console.log(await stream.reduce(AsyncReducer.count(async v => v < 5)))
+   * // => 5
+   * ```
+   */
+  export const count: {
+    (): AsyncReducer<any, number>;
+    <T>(pred: (value: T, index: number) => MaybePromise<boolean>): AsyncReducer<
+      T,
+      number
+    >;
+  } = (
+    pred?: (value: any, index: number) => MaybePromise<boolean>
+  ): AsyncReducer<any, number> => {
+    if (undefined === pred) return createMono(0, (_, __, i): number => i + 1);
+
+    return createOutput(0, async (state, next, i): Promise<number> => {
+      if (await pred?.(next, i)) return state + 1;
+      return state;
+    });
+  };
+
+  /**
+   * Returns an `AsyncReducer` that remembers the first input value for which the given `pred` function returns true.
+   * @param pred - a function taking an input value and its index, and returning true if the value should be remembered
+   * @param otherwise - (default: undefined) a fallback value to output if no input value yet has satisfied the given predicate
+   * @typeparam T - the input value type
+   * @typeparam O - the fallback value type
+   * @example
+   * ```ts
+   * await AsyncStream.from(Stream.range({ amount: 10 })).reduce(AsyncReducer.firstWhere(async v => v > 5)))
+   * // => 6
+   * ```
+   */
+  export const firstWhere: {
+    <T>(pred: (value: T, index: number) => MaybePromise<boolean>): AsyncReducer<
+      T,
+      T | undefined
+    >;
+    <T, O>(
+      pred: (value: T, index: number) => MaybePromise<boolean>,
+      otherwise: AsyncOptLazy<O>
+    ): AsyncReducer<T, T | O>;
+  } = <T, O>(
+    pred: (value: T, index: number) => MaybePromise<boolean>,
+    otherwise?: AsyncOptLazy<O>
+  ) => {
+    const token = Symbol();
+
+    return create<T, T | O, T | typeof token>(
+      token,
+      async (state, next, i, halt): Promise<T | typeof token> => {
+        if (token === state && (await pred(next, i))) {
+          halt();
+          return next;
+        }
+        return state;
+      },
+      (state): MaybePromise<T | O> =>
+        token === state ? AsyncOptLazy.toMaybePromise(otherwise!) : state
+    );
+  };
+
+  /**
+   * Returns an `AsyncReducer` that remembers the first input value.
+   * @param otherwise - (default: undefined) a fallback value to output if no input value has been provided
+   * @typeparam T - the input value type
+   * @typeparam O - the fallback value type
+   * @example
+   * ```ts
+   * await AsyncStream.from(Stream.range{ amount: 10 })).reduce(AsyncReducer.first())
+   * // => 0
+   * ```
+   */
+  export const first: {
+    <T>(): AsyncReducer<T, T | undefined>;
+    <T, O>(otherwise: AsyncOptLazy<O>): AsyncReducer<T, T | O>;
+  } = <T, O>(otherwise?: AsyncOptLazy<O>): AsyncReducer<T, T | O> => {
+    const token = Symbol();
+
+    return create<T, T | O, T | typeof token>(
+      token,
+      (state, next, _, halt): T => {
+        halt();
+        if (token === state) return next;
+        return state;
+      },
+      (state): MaybePromise<T | O> =>
+        token === state ? AsyncOptLazy.toMaybePromise(otherwise!) : state
+    );
+  };
+
+  /**
+   * Returns an `AsyncReducer` that remembers the last input value for which the given `pred` function returns true.
+   * @param pred - a function taking an input value and its index, and returning true if the value should be remembered
+   * @param otherwise - (default: undefined) a fallback value to output if no input value yet has satisfied the given predicate
+   * @typeparam T - the input value type
+   * @typeparam O - the fallback value type
+   * @example
+   * ```ts
+   * await AsyncStream.from(Stream.range({ amount: 10 })).reduce(AsyncReducer.lastWhere(async v => v > 5)))
+   * // => 9
+   * ```
+   */
+  export const lastWhere: {
+    <T>(pred: (value: T, index: number) => MaybePromise<boolean>): AsyncReducer<
+      T,
+      T | undefined
+    >;
+    <T, O>(
+      pred: (value: T, index: number) => MaybePromise<boolean>,
+      otherwise: AsyncOptLazy<O>
+    ): AsyncReducer<T, T | O>;
+  } = <T, O>(
+    pred: (value: T, index: number) => MaybePromise<boolean>,
+    otherwise?: AsyncOptLazy<O>
+  ) => {
+    const token = Symbol();
+
+    return create<T, T | O, T | typeof token>(
+      token,
+      async (state, next, i): Promise<T | typeof token> => {
+        if (await pred(next, i)) return next;
+        return state;
+      },
+      (state): MaybePromise<T | O> =>
+        token === state ? AsyncOptLazy.toMaybePromise(otherwise!) : state
+    );
+  };
+
+  /**
+   * Returns an `AsyncReducer` that remembers the last input value.
+   * @param otherwise - (default: undefined) a fallback value to output if no input value has been provided
+   * @typeparam T - the input value type
+   * @typeparam O - the fallback value type
+   * @example
+   * ```ts
+   * await AsyncStream.from(Stream.range{ amount: 10 })).reduce(AsyncReducer.last())
+   * // => 9
+   * ```
+   */
+  export const last: {
+    <T>(): AsyncReducer<T, T | undefined>;
+    <T, O>(otherwise: AsyncOptLazy<O>): AsyncReducer<T, T | O>;
+  } = <T, O>(otherwise?: AsyncOptLazy<O>): AsyncReducer<T, T | O> => {
+    const token = Symbol();
+
+    return create<T, T | O, T | typeof token>(
+      () => token,
+      (_, next): T => next,
+      (state): MaybePromise<T | O> =>
+        token === state ? AsyncOptLazy.toMaybePromise(otherwise!) : state
+    );
+  };
+
+  /**
+   * Returns a `Reducer` that ouputs false as long as no input value satisfies given `pred`, true otherwise.
+   * @typeparam T - the element type
+   * @param pred - a function taking an input value and its index, and returning true if the value satisfies the predicate
+   * @example
+   * ```ts
+   * await AsyncStream.from(Stream.range{ amount: 10 })).reduce(AsyncReducer.some(async v => v > 5))
+   * // => true
+   * ```
+   */
+  export function some<T>(
+    pred: (value: T, index: number) => MaybePromise<boolean>
+  ): AsyncReducer<T, boolean> {
+    return createOutput<T, boolean>(
+      false,
+      async (state, next, i, halt): Promise<boolean> => {
+        if (state) return state;
+        const satisfies = await pred(next, i);
+
+        if (satisfies) {
+          halt();
+        }
+
+        return satisfies;
+      }
+    );
+  }
+
+  /**
+   * Returns an `AsyncReducer` that ouputs true as long as all input values satisfy the given `pred`, false otherwise.
+   * @typeparam T - the element type
+   * @param pred - a function taking an input value and its index, and returning true if the value satisfies the predicate
+   * @example
+   * ```ts
+   * await AsyncStream.from(Stream.range{ amount: 10 })).reduce(AsyncReducer.every(async v => v < 5))
+   * // => false
+   * ```
+   */
+  export function every<T>(
+    pred: (value: T, index: number) => MaybePromise<boolean>
+  ): AsyncReducer<T, boolean> {
+    return createOutput<T, boolean>(
+      true,
+      async (state, next, i, halt): Promise<boolean> => {
+        if (!state) return state;
+
+        const satisfies = await pred(next, i);
+
+        if (!satisfies) {
+          halt();
+        }
+
+        return satisfies;
+      }
+    );
+  }
+
+  /**
+   * Returns an `AsyncReducer` that outputs false as long as the given `elem` has not been encountered in the input values, true otherwise.
+   * @typeparam T - the element type
+   * @param elem - the element to search for
+   * @param eq - (optional) a comparison function that returns true if te two given input values are considered equal
+   * @example
+   * ```ts
+   * await AsyncStream.from(Stream.range({ amount: 10 })).reduce(AsyncReducer.contains(5)))
+   * // => true
+   * ```
+   */
+  export function contains<T>(
+    elem: T,
+    eq: Eq<T> = Object.is
+  ): AsyncReducer<T, boolean> {
+    return createOutput<T, boolean>(false, (state, next, _, halt): boolean => {
+      if (state) return state;
+      const satisfies = eq(next, elem);
+
+      if (satisfies) {
+        halt();
+      }
+
+      return satisfies;
+    });
+  }
+
+  /**
+   * Returns an `AsyncReducer` that takes boolean values and outputs true if all input values are true, and false otherwise.
+   * @example
+   * ```ts
+   * await AsyncStream.of(true, false, true)).reduce(AsyncReducer.and))
+   * // => false
+   * ```
+   */
+  export const and = createMono(true, (state, next, _, halt): boolean => {
+    if (!state) return state;
+    if (!next) halt();
+    return next;
+  });
+
+  /**
+   * Returns an `AsyncReducer` that takes boolean values and outputs true if one or more input values are true, and false otherwise.
+   * @example
+   * ```ts
+   * await AsyncStream.of(true, false, true)).reduce(AsyncReducer.or))
+   * // => true
+   * ```
+   */
+  export const or = createMono(false, (state, next, _, halt): boolean => {
+    if (state) return state;
+    if (next) halt();
+    return next;
+  });
+
+  /**
+   * Returns an `AsyncReducer` that outputs true if no input values are received, false otherwise.
+   * @example
+   * ```ts
+   * await AsyncStream.of(1, 2, 3).reduce(AsyncReducer.isEmpty))
+   * // => false
+   * ```
+   */
+  export const isEmpty = createOutput<any, boolean>(
+    true,
+    (_, __, ___, halt): false => {
+      halt();
+      return false;
+    }
+  );
+
+  /**
+   * Returns an `AsyncReducer` that outputs true if one or more input values are received, false otherwise.
+   * @example
+   * ```ts
+   * await AsyncStream.of(1, 2, 3).reduce(AsyncReducer.nonEmpty))
+   * // => true
+   * ```
+   */
+  export const nonEmpty = createOutput<any, boolean>(
+    false,
+    (_, __, ___, halt): true => {
+      halt();
+      return true;
+    }
+  );
+
+  /**
+   * Returns an `AsyncReducer` that collects received input values in an array, and returns a copy of that array as an output value when requested.
+   * @typeparam T - the element type
+   * @example
+   * ```ts
+   * await AsyncStream.of(1, 2, 3).reduce(AsyncReducer.toArray()))
+   * // => [1, 2, 3]
+   * ```
+   */
+  export function toArray<T>(): AsyncReducer<T, T[]> {
+    return create(
+      (): T[] => [],
+      (state, next): T[] => {
+        state.push(next);
+        return state;
+      },
+      (state): T[] => state.slice()
+    );
+  }
+
+  /**
+   * Returns a `AsyncReducer` that collects received input tuples into a mutable JS Map, and returns
+   * a copy of that map when output is requested.
+   * @typeparam K - the map key type
+   * @typeparam V - the map value type
+   * @example
+   * ```ts
+   * await AsyncStream.of([1, 'a'], [2, 'b']).reduce(AsyncReducer.toJSMap()))
+   * // Map { 1 => 'a', 2 => 'b' }
+   * ```
+   */
+  export function toJSMap<K, V>(): AsyncReducer<[K, V], Map<K, V>> {
+    return create(
+      (): Map<K, V> => new Map(),
+      (state, next): Map<K, V> => {
+        state.set(next[0], next[1]);
+        return state;
+      },
+      (s): Map<K, V> => new Map(s)
+    );
+  }
+
+  /**
+   * Returns an `AsyncReducer` that collects received input values into a mutable JS Set, and returns
+   * a copy of that map when output is requested.
+   * @typeparam T - the element type
+   * @example
+   * ```ts
+   * await AsyncStream.of(1, 2, 3).reduce(AsyncReducer.toJSSet()))
+   * // Set {1, 2, 3}
+   * ```
+   */
+  export function toJSSet<T>(): AsyncReducer<T, Set<T>> {
+    return create(
+      (): Set<T> => new Set<T>(),
+      (state, next): Set<T> => {
+        state.add(next);
+        return state;
+      },
+      (s): Set<T> => new Set(s)
+    );
+  }
+
+  /**
+   * Returns an `AsyncReducer` that collects 2-tuples containing keys and values into a plain JS object, and
+   * returns a copy of that object when output is requested.
+   * @typeparam K - the result object key type
+   * @typeparam V - the result object value type
+   * @example
+   * ```ts
+   * await AsyncStream.of(['a', 1], ['b', true]).reduce(AsyncReducer.toJSObject()))
+   * // { a: 1, b: true }
+   * ```
+   */
+  export function toJSObject<
+    K extends string | number | symbol,
+    V
+  >(): AsyncReducer<[K, V], Record<K, V>> {
+    return create(
+      () => ({} as Record<K, V>),
+      (state, entry) => {
+        state[entry[0]] = entry[1];
+        return state;
+      },
+      (s) => ({ ...s })
+    );
+  }
+
+  /**
+   * Returns a `Reducer` that combines multiple input `reducers` by providing input values to all of them and collecting the outputs in an array.
+   * @param reducers - 2 or more reducers to combine
+   * @example
+   * ```ts
+   * const red = Reducer.combine(Reducer.sum, Reducer.average)
+   * console.log(Stream.range({amount: 9 }).reduce(red))
+   * // => [36, 4]
+   * ```
+   */
+  export function combine<
+    T,
+    R extends readonly [unknown, unknown, ...unknown[]]
+  >(
+    ...reducers: { [K in keyof R]: AsyncReducer<T, R[K]> } & AsyncReducer<
+      T,
+      unknown
+    >[]
+  ): AsyncReducer<T, R> {
+    const createState = (): Promise<
+      {
+        reducer: AsyncReducer<T, unknown>;
+        halted: boolean;
+        halt(): void;
+        state: unknown;
+      }[]
+    > => {
+      return Promise.all(
+        reducers.map(async (reducer) => {
+          const result = {
+            reducer,
+            halted: false,
+            halt(): void {
+              result.halted = true;
+            },
+            state: await AsyncOptLazy.toMaybePromise(reducer.init),
+          };
+
+          return result;
+        })
+      );
+    };
+
+    return create<
+      T,
+      R,
+      {
+        reducer: AsyncReducer<T, unknown>;
+        halted: boolean;
+        halt(): void;
+        state: unknown;
+      }[]
+    >(
+      createState,
+      async (allState, next, index, halt) => {
+        let anyNotHalted = false;
+
+        await Promise.all(
+          allState.map(async (red) => {
+            if (red.halted) return;
+
+            red.state = await red.reducer.next(
+              red.state,
+              next,
+              index,
+              red.halt
+            );
+            if (!red.halted) anyNotHalted = true;
+          })
+        );
+
+        if (!anyNotHalted) halt();
+
+        return allState;
+      },
+      (allState) =>
+        Promise.all(
+          allState.map((st) => st.reducer.stateToResult(st.state))
+        ) as any
+    );
+  }
 }