import { Cancellation } from "@implab/core-amd/Cancellation"; import { ICancellation } from "@implab/core-amd/interfaces"; import { isPromise } from "@implab/core-amd/safe"; /** * The interface for the consumer of an observable sequence */ export interface Observer { /** * Called for the next element in the sequence */ next?: (value: T) => void; /** * Called once when the error occurs in the sequence. */ error?: (e: unknown) => void; /** * Called once at the end of the sequence. */ complete?: () => void; } /** * The group of functions to feed an observable. These methods are provided to * the producer to generate a stream of events. */ export type Sink = { /** * Call to send the next element in the sequence */ next: (value: T) => void; /** * Call to notify about the error occurred in the sequence. */ error: (e: unknown) => void; /** * Call to signal the end of the sequence. */ complete: () => void; /** * Checks whether the sink is accepting new elements. It's safe to * send elements to the closed sink. */ isClosed: () => boolean; }; export type Producer = (sink: Sink) => (void | (() => void)); export interface Unsubscribable { unsubscribe(): void; } export const isUnsubscribable = (v: unknown): v is Unsubscribable => v !== null && v !== undefined && typeof (v as Unsubscribable).unsubscribe === "function"; export const isSubscribable = (v: unknown): v is Subscribable => v !== null && v !== undefined && typeof (v as Subscribable).subscribe === "function"; export interface Subscribable { subscribe(consumer: Observer): Unsubscribable; } export type AccumulatorFn = (acc: A, value: T) => A; export type OperatorFn = (source: Observable) => Producer; /** The observable source of items. */ export interface Observable extends Subscribable { /** Transforms elements of the sequence with the specified mapper * * @param mapper The mapper used to transform the values */ map(mapper: (value: T) => T2): Observable; /** Filters elements of the sequence. The resulting sequence will * contain only elements which match the specified predicate. * * @param predicate The filter predicate. */ filter(predicate: (value: T) => boolean): Observable; /** Completes the sequence once the condition is met. * @param predicate The condition which should be met to complete the sequence */ until(predicate: (value: T) => boolean): Observable; /** Keeps the sequence running while elements satisfy the condition. * * @param predicate The condition which should be met to continue. */ while(predicate: (value: T) => boolean): Observable; /** Applies accumulator to each value in the sequence and * emits the accumulated value for each source element * * @param accumulator * @param initial */ scan(accumulator: AccumulatorFn, initial: A): Observable; scan(accumulator: AccumulatorFn): Observable; /** Applies accumulator to each value in the sequence and * emits the accumulated value at the end of the sequence * * @param accumulator * @param initial */ reduce(accumulator: AccumulatorFn, initial: A): Observable; reduce(accumulator: AccumulatorFn): Observable; /** Concatenates the specified sequences with this observable * * @param seq sequences to concatenate with the current observable * * The concatenation doesn't accumulate values from the specified sequences, * The result of the concatenation is the new observable which will switch * to the next observable after the previous one completes. Values emitted * before the next observable being active are lost. */ cat(...seq: Subscribable[]): Observable; /** Pipes the specified operator to produce the new observable * @param op The operator consumes this observable and produces a new one * * The operator is a higher order function which takes a source observable * and returns a producer for the new observable. * * This function can be used to create a complex mapping between source and * resulting observables. The operator may have a state (or a side effect) * and can be connected to multiple observables. */ pipe(op: OperatorFn): Observable; /** Waits for the next event to occur and returns a promise for the next value * @param ct Cancellation token */ next(ct?: ICancellation): Promise; /** Collects items of the sequence to the array. */ collect(ct?: ICancellation): Promise; } const noop = () => { }; const sink = (consumer: Observer) => { const { next, error, complete } = consumer; return { next: next ? next.bind(consumer) : noop, error: error ? error.bind(consumer) : noop, complete: complete ? complete.bind(consumer) : noop, isClosed: () => false }; }; /** Wraps the producer to handle tear down logic and subscription management * * @param producer The producer to wrap * @returns The wrapper producer */ const fuse = (producer: Producer) => ({ next, error, complete }: Sink) => { let done = false; let cleanup = noop; const _fin = (fn: (...args: A) => void) => (...args: A) => done ? void (0) : (done = true, cleanup(), fn(...args)); const _fin0 = () => done ? void (0) : (done = true, cleanup()); const safeSink = { next: (value: T) => { !done && next(value); }, error: _fin(error), complete: _fin(complete), isClosed: () => done }; cleanup = producer(safeSink) ?? noop; return done ? cleanup() : _fin0; }; const _observe = (producer: Producer): Observable => ({ subscribe: (consumer: Observer) => ({ unsubscribe: producer(sink(consumer)) ?? noop }), map: (mapper) => _observe(({ next, ...rest }) => producer({ next: next !== noop ? (v: T) => next(mapper(v)) : noop, ...rest }) ), filter: (predicate) => _observe(({ next, ...rest }) => producer({ next: next !== noop ? (v: T) => predicate(v) ? next(v) : void (0) : noop, ...rest }) ), until: predicate => _observe(({ next, complete, ...rest }) => producer({ next: v => predicate(v) ? complete() : next(v), complete, ...rest }) ), while: predicate => _observe(({ next, complete, ...rest }) => producer({ next: v => predicate(v) ? next(v) : complete(), complete, ...rest }) ), scan: (...args: [AccumulatorFn, A] | [AccumulatorFn]) => _observe(({ next, ...rest }) => { if (args.length === 1) { const [accumulator] = args; let _acc: T; let index = 0; return producer({ next: next !== noop ? (v: T) => next(index++ === 0 ? _acc = v : _acc = accumulator(_acc, v)) : noop, ...rest }); } else { const [accumulator, initial] = args; let _acc = initial; return producer({ next: next !== noop ? (v: T) => next(_acc = accumulator(_acc, v)) : noop, ...rest }); } }), reduce: (...args: [AccumulatorFn, A] | [AccumulatorFn]) => _observe(({ next, complete, error, ...rest }) => { if (args.length === 1) { const [accumulator] = args; let _acc: T; let index = 0; return producer({ next: next !== noop ? (v: T) => { _acc = index++ === 0 ? v : accumulator(_acc, v); } : noop, complete: () => { if (index === 0) { error(new Error("The sequence can't be empty")); } else { next(_acc); complete(); } }, error, ...rest }); } else { const [accumulator, initial] = args; let _acc = initial; return producer({ next: next !== noop ? (v: T) => { _acc = accumulator(_acc, v); } : noop, complete: () => { next(_acc); complete(); }, error, ...rest }); } }), cat: (...seq) => _observe(({ next, complete: final, ...rest }) => { let cleanup: () => void; const complete = () => { const continuation = seq.shift(); if (continuation) { // if we have a next sequence, subscribe to it const subscription = continuation.subscribe({ next, complete, ...rest }); cleanup = subscription.unsubscribe.bind(subscription); } else { // otherwise notify the consumer about completion final(); } }; cleanup = producer({ next, complete, ...rest }) ?? noop; return () => cleanup(); }), pipe: (op: OperatorFn) => observe(op(_observe(producer))), next: collect( producer, ({ next, complete, error, isClosed }) => ({ next: v => (next(v), complete()), complete: () => error(new Error("The sequence is empty")), error, isClosed }) ), collect: collect( producer, ({ next, complete, ...rest }) => { const data: T[] = []; return { next: v => data.push(v), complete: () => (next(data), complete()), ...rest }; } ) }); const collect = ( producer: Producer, collector: (result: Sink) => Sink ) => (ct = Cancellation.none) => new Promise((resolve, reject) => { const fused = fuse(({ next, complete, error, isClosed }) => { const h = ct.register(error); const cleanup = !isClosed() ? producer(collector({ next, complete, error, isClosed })) ?? noop : noop; return () => { h.destroy(); cleanup(); }; }); fused({ next: resolve, error: reject, complete: noop, isClosed: () => false }); }); export const observe = (producer: Producer) => _observe(fuse(producer)); /** Converts an array to the observable sequence of its elements. */ export const ofArray = (items: T[]) => _observe( ({ next, complete }) => ( items.forEach(next), complete() ) ); /** Converts a subscribable to the observable */ export const ofSubscribable = (subscribable: Subscribable) => observe(sink => { const subscription = subscribable.subscribe(sink); return () => subscription.unsubscribe(); }); const of1 = (item: T | PromiseLike) => observe( ({ next, error, complete }) => isPromise(item) ? void item.then( v => (next(v), complete()), error ) : (next(item), complete()) ); /** Converts a list of parameter values to the observable sequence. The * order of elements in the list will be preserved in the resulting sequence. */ export const of = (...items: (T | PromiseLike)[]) => items.length === 1 ? of1(items[0]) : observe( ({ next, error, complete, isClosed }) => { const n = items.length; const _next = (start: number) => { if (start > 0 && isClosed()) // when resumed return; for (let i = start; i < n; i++) { const r = items[i]; if (isPromise(r)) { r.then(v => (next(v), _next(i + 1)), error); return; // suspend } else { next(r); } } complete(); }; _next(0); } ); export const empty = _observe(({ complete }) => complete());