@jscutlery/operators 2.1.1 → 2.1.3

package/CHANGELOG.md

@@ -2,6 +2,42 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [2.1.3](https://github.com/jscutlery/devkit/compare/operators-2.1.2...operators-2.1.3) (2023-10-25)
+
+
+
+## [2.1.3](https://github.com/jscutlery/devkit/compare/operators-2.1.2...operators-2.1.3) (2023-10-25)
+
+
+
+## [2.1.3](https://github.com/jscutlery/devkit/compare/operators-2.1.2...operators-2.1.3) (2023-10-25)
+
+
+
+## [2.1.3](https://github.com/jscutlery/devkit/compare/operators-2.1.2...operators-2.1.3) (2023-10-25)
+
+
+
+## [2.1.3](https://github.com/jscutlery/devkit/compare/operators-2.1.2...operators-2.1.3) (2023-10-25)
+
+
+
+## [2.1.3](https://github.com/jscutlery/devkit/compare/operators-2.1.2...operators-2.1.3) (2023-10-25)
+
+
+
+## [2.1.3](https://github.com/jscutlery/devkit/compare/operators-2.1.2...operators-2.1.3) (2023-10-25)
+
+
+
+## [2.1.3](https://github.com/jscutlery/devkit/compare/operators-2.1.2...operators-2.1.3) (2023-10-25)
+
+
+
+## [2.1.2](https://github.com/jscutlery/devkit/compare/operators-2.1.1...operators-2.1.2) (2023-05-22)
+
+
+
 ## [2.1.1](https://github.com/jscutlery/devkit/compare/operators-2.1.0...operators-2.1.1) (2023-04-28)
 
 

package/index.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/index.cjs.js

@@ -0,0 +1,85 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var rxjs = require('rxjs');
+var operators = require('rxjs/operators');
+
+function suspensify({
+  strict = true
+} = {}) {
+  return source$ => {
+    const strictSuspense$ = source$.pipe(_suspensify(), _coalesceFirstEmittedValue());
+    return strict ? strictSuspense$ : strictSuspense$.pipe(operators.map(strictSuspense => ({
+      error: undefined,
+      value: undefined,
+      ...strictSuspense
+    }))
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    );
+  };
+}
+/**
+ * This is the initial state of the Suspense.
+ * It is exposed for convenience and edge cases where the initial state must be set initially.
+ * e.g. when using {@link suspensify} on inner observables.
+ * @example toSignal(source$.pipe(switchMap(() => fetchData().pipe(suspensify()))), {initialValue: pending});
+ */
+const pending = {
+  finalized: false,
+  hasError: false,
+  hasValue: false,
+  pending: true
+};
+function _coalesceFirstEmittedValue() {
+  return source$ => {
+    return new rxjs.Observable(observer => {
+      const isReadySubject = new rxjs.ReplaySubject(1);
+      const subscription = source$.pipe( /* Wait for all synchronous processing to be done. */
+      operators.debounce(() => isReadySubject)).subscribe(observer);
+      /* Sync emitted values have been processed now.
+       * Mark source as ready and emit last computed state. */
+      isReadySubject.next(undefined);
+      return () => subscription.unsubscribe();
+    });
+  };
+}
+/* Use values as types for better type checking. */
+const TRUE = true;
+const FALSE = false;
+function _suspensify() {
+  return source$ => {
+    return source$.pipe(operators.materialize(), operators.scan((state, notification) => {
+      switch (notification.kind) {
+        /* Value. */
+        case 'N':
+          return {
+            finalized: FALSE,
+            hasError: FALSE,
+            hasValue: TRUE,
+            value: notification.value,
+            pending: FALSE
+          };
+        /* Error. */
+        case 'E':
+          return {
+            finalized: TRUE,
+            hasError: TRUE,
+            hasValue: FALSE,
+            pending: FALSE,
+            error: notification.error
+          };
+        /* Complete. */
+        case 'C':
+          return {
+            ...state,
+            finalized: TRUE,
+            pending: FALSE
+          };
+      }
+    }, pending), operators.startWith(pending));
+  };
+}
+
+exports.pending = pending;
+exports.suspensify = suspensify;

package/index.esm.js

@@ -0,0 +1,91 @@
+import { Observable, ReplaySubject } from 'rxjs';
+import { map, debounce, materialize, scan, startWith } from 'rxjs/operators';
+
+/**
+ * @description creates a derivated state from the source observable.
+ *
+ * @example source$.pipe(suspensify())
+ *
+ * @returns Observable<SuspenseLax<T> | SuspenseStrict<T>>
+ */
+
+function suspensify({
+  strict = true
+} = {}) {
+  return source$ => {
+    const strictSuspense$ = source$.pipe(_suspensify(), _coalesceFirstEmittedValue());
+    return strict ? strictSuspense$ : strictSuspense$.pipe(map(strictSuspense => ({
+      error: undefined,
+      value: undefined,
+      ...strictSuspense
+    }))
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    );
+  };
+}
+
+/**
+ * This is the initial state of the Suspense.
+ * It is exposed for convenience and edge cases where the initial state must be set initially.
+ * e.g. when using {@link suspensify} on inner observables.
+ * @example toSignal(source$.pipe(switchMap(() => fetchData().pipe(suspensify()))), {initialValue: pending});
+ */
+const pending = {
+  finalized: false,
+  hasError: false,
+  hasValue: false,
+  pending: true
+};
+function _coalesceFirstEmittedValue() {
+  return source$ => {
+    return new Observable(observer => {
+      const isReadySubject = new ReplaySubject(1);
+      const subscription = source$.pipe( /* Wait for all synchronous processing to be done. */
+      debounce(() => isReadySubject)).subscribe(observer);
+
+      /* Sync emitted values have been processed now.
+       * Mark source as ready and emit last computed state. */
+      isReadySubject.next(undefined);
+      return () => subscription.unsubscribe();
+    });
+  };
+}
+
+/* Use values as types for better type checking. */
+const TRUE = true;
+const FALSE = false;
+function _suspensify() {
+  return source$ => {
+    return source$.pipe(materialize(), scan((state, notification) => {
+      switch (notification.kind) {
+        /* Value. */
+        case 'N':
+          return {
+            finalized: FALSE,
+            hasError: FALSE,
+            hasValue: TRUE,
+            value: notification.value,
+            pending: FALSE
+          };
+        /* Error. */
+        case 'E':
+          return {
+            finalized: TRUE,
+            hasError: TRUE,
+            hasValue: FALSE,
+            pending: FALSE,
+            error: notification.error
+          };
+        /* Complete. */
+        case 'C':
+          return {
+            ...state,
+            finalized: TRUE,
+            pending: FALSE
+          };
+      }
+    }, pending), startWith(pending));
+  };
+}
+
+export { pending, suspensify };

package/package.json

@@ -1,16 +1,12 @@
 {
   "name": "@jscutlery/operators",
-  "version": "2.1.1",
+  "version": "2.1.3",
   "repository": {
     "url": "https://github.com/jscutlery/devkit"
   },
   "peerDependencies": {
-    "rxjs": ">=6.0.0",
-    "@jest/globals": "28.1.3"
+    "rxjs": ">=6.0.0"
   },
-  "module": "./index.js",
-  "main": "./index.cjs",
-  "type": "module",
-  "types": "./src/index.d.ts",
-  "dependencies": {}
+  "module": "./index.esm.js",
+  "main": "./index.cjs.js"
 }

package/src/index.d.ts

@@ -1,2 +1,2 @@
-export { pending, suspensify } from './lib/suspensify';
-export type { SuspenseLax, Suspense, SuspenseEmpty, SuspensePending, SuspenseWithError, SuspenseWithValue, SuspensifyOptions, } from './lib/suspensify';
+export { pending, suspensify } from './lib/suspensify';
+export type { SuspenseLax, Suspense, SuspenseEmpty, SuspensePending, SuspenseWithError, SuspenseWithValue, SuspensifyOptions, } from './lib/suspensify';

package/src/lib/suspensify.d.ts

@@ -1,59 +1,59 @@
-import { OperatorFunction } from 'rxjs';
-export interface SuspenseLax<T> {
-    finalized: boolean;
-    hasError: boolean;
-    hasValue: boolean;
-    pending: boolean;
-    error: undefined | any;
-    value: undefined | T;
-}
-export interface SuspensePending {
-    finalized: false;
-    hasError: false;
-    hasValue: false;
-    pending: true;
-}
-export interface SuspenseWithValue<T> {
-    finalized: boolean;
-    hasError: false;
-    hasValue: true;
-    pending: false;
-    value: T;
-}
-export interface SuspenseWithError {
-    finalized: true;
-    hasError: true;
-    hasValue: false;
-    pending: false;
-    error: unknown;
-}
-export interface SuspenseEmpty {
-    finalized: true;
-    hasError: false;
-    hasValue: false;
-    pending: false;
-}
-export declare type Suspense<T> = SuspensePending | SuspenseWithValue<T> | SuspenseWithError | SuspenseEmpty;
-export interface SuspensifyOptions {
-    strict?: boolean;
-}
-/**
- * @description creates a derivated state from the source observable.
- *
- * @example source$.pipe(suspensify())
- *
- * @returns Observable<SuspenseLax<T> | SuspenseStrict<T>>
- */
-export declare function suspensify<T>(options: {
-    strict: false;
-}): OperatorFunction<T, SuspenseLax<T>>;
-export declare function suspensify<T>(options?: {
-    strict: true;
-}): OperatorFunction<T, Suspense<T>>;
-/**
- * This is the initial state of the Suspense.
- * It is exposed for convenience and edge cases where the initial state must be set initially.
- * e.g. when using {@link suspensify} on inner observables.
- * @example toSignal(source$.pipe(switchMap(() => fetchData().pipe(suspensify()))), {initialValue: pending});
- */
-export declare const pending: SuspensePending;
+import { OperatorFunction } from 'rxjs';
+export interface SuspenseLax<T> {
+    finalized: boolean;
+    hasError: boolean;
+    hasValue: boolean;
+    pending: boolean;
+    error: undefined | any;
+    value: undefined | T;
+}
+export interface SuspensePending {
+    finalized: false;
+    hasError: false;
+    hasValue: false;
+    pending: true;
+}
+export interface SuspenseWithValue<T> {
+    finalized: boolean;
+    hasError: false;
+    hasValue: true;
+    pending: false;
+    value: T;
+}
+export interface SuspenseWithError {
+    finalized: true;
+    hasError: true;
+    hasValue: false;
+    pending: false;
+    error: unknown;
+}
+export interface SuspenseEmpty {
+    finalized: true;
+    hasError: false;
+    hasValue: false;
+    pending: false;
+}
+export type Suspense<T> = SuspensePending | SuspenseWithValue<T> | SuspenseWithError | SuspenseEmpty;
+export interface SuspensifyOptions {
+    strict?: boolean;
+}
+/**
+ * @description creates a derivated state from the source observable.
+ *
+ * @example source$.pipe(suspensify())
+ *
+ * @returns Observable<SuspenseLax<T> | SuspenseStrict<T>>
+ */
+export declare function suspensify<T>(options: {
+    strict: false;
+}): OperatorFunction<T, SuspenseLax<T>>;
+export declare function suspensify<T>(options?: {
+    strict: true;
+}): OperatorFunction<T, Suspense<T>>;
+/**
+ * This is the initial state of the Suspense.
+ * It is exposed for convenience and edge cases where the initial state must be set initially.
+ * e.g. when using {@link suspensify} on inner observables.
+ * @example toSignal(source$.pipe(switchMap(() => fetchData().pipe(suspensify()))), {initialValue: pending});
+ */
+export declare const pending: SuspensePending;

package/src/lib/testing/observer.d.ts

@@ -1,11 +1,11 @@
-/// <reference types="jest" />
-import { Observable } from 'rxjs';
-export declare function createObserver(): {
-    observe<T>(observable: Observable<T>): {
-        mockClear(): void;
-        mockReset(): void;
-        next: jest.MockInstance<void, [value: T]> & ((value: T) => void);
-        error: jest.MockInstance<void, [err: any]> & ((err: any) => void);
-        complete: jest.MockInstance<void, []> & (() => void);
-    };
-};
+/// <reference types="jest" />
+import { Observable } from 'rxjs';
+export declare function createObserver(): {
+    observe<T>(observable: Observable<T>): {
+        mockClear(): void;
+        mockReset(): void;
+        next: jest.MockInstance<void, [value: T], unknown> & ((value: T) => void);
+        error: jest.MockInstance<void, [err: any], unknown> & ((err: any) => void);
+        complete: jest.MockInstance<void, [], unknown> & (() => void);
+    };
+};