@jscutlery/operators 0.2.2 → 1.0.1

package/CHANGELOG.md

@@ -2,7 +2,11 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
-## [0.2.2](https://github.com/jscutlery/devkit/compare/operators-0.2.1...operators-0.2.2) (2023-01-16)
+## [1.0.1](https://github.com/jscutlery/devkit/compare/operators-1.0.0...operators-1.0.1) (2023-04-18)
+
+
+
+# [1.0.0](https://github.com/jscutlery/devkit/compare/operators-0.2.1...operators-1.0.0) (2023-04-18)
 
 
 ### Bug Fixes
@@ -10,6 +14,16 @@ This file was generated using [@jscutlery/semver](https://github.com/jscutlery/s
 * **operators:** 🏷️ fix typing errors ([91c084c](https://github.com/jscutlery/devkit/commit/91c084c29c6ad760376c10bc17004a2bfcd3a306))
 
 
+### Features
+
+* **operators:** ✨ drop support for suspensify's projector ([f4bf6dc](https://github.com/jscutlery/devkit/commit/f4bf6dc413e866b5c047578162c1c1cbcb3c73f9)), closes [#236](https://github.com/jscutlery/devkit/issues/236)
+
+
+### BREAKING CHANGES
+
+* **operators:** suspensify's operator "projector" function is not supported anymore
+
+
 
 ## [0.2.1](https://github.com/jscutlery/devkit/compare/operators-0.2.0...operators-0.2.1) (2022-12-26)
 

package/index.cjs

@@ -1076,9 +1076,11 @@ $({ target: 'Object', stat: true, arity: 2, forced: Object.assign !== assign },
   assign: assign
 });
 
-function suspensify(projector) {
+function suspensify(
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+options) {
   return source$ => {
-    return source$.pipe(_suspensify(projector), _coalesceFirstEmittedValue());
+    return source$.pipe(_suspensify(), _coalesceFirstEmittedValue());
   };
 }
 function _coalesceFirstEmittedValue() {
@@ -1094,7 +1096,7 @@ function _coalesceFirstEmittedValue() {
     });
   };
 }
-function _suspensify(projector) {
+function _suspensify() {
   return source$ => {
     const initialState = {
       value: undefined,
@@ -1102,7 +1104,7 @@ function _suspensify(projector) {
       finalized: false,
       pending: true
     };
-    const result$ = source$.pipe(operators.materialize(), operators.scan((state = initialState, notification) => {
+    return source$.pipe(operators.materialize(), operators.scan((state = initialState, notification) => {
       /* On complete, merge `finalized: true & pending: false`
        * with the current state. */
       if (notification.kind === 'C') {
@@ -1120,7 +1122,6 @@ function _suspensify(projector) {
         pending: false
       };
     }, initialState), operators.startWith(initialState));
-    return projector != null ? result$.pipe(operators.map(projector)) : result$;
   };
 }
 

package/index.js

@@ -1,5 +1,5 @@
 import { Observable, ReplaySubject } from 'rxjs';
-import { debounce, materialize, scan, startWith, map } from 'rxjs/operators';
+import { debounce, materialize, scan, startWith } from 'rxjs/operators';
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
@@ -1072,9 +1072,11 @@ $({ target: 'Object', stat: true, arity: 2, forced: Object.assign !== assign },
   assign: assign
 });
 
-function suspensify(projector) {
+function suspensify(
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+options) {
   return source$ => {
-    return source$.pipe(_suspensify(projector), _coalesceFirstEmittedValue());
+    return source$.pipe(_suspensify(), _coalesceFirstEmittedValue());
   };
 }
 function _coalesceFirstEmittedValue() {
@@ -1090,7 +1092,7 @@ function _coalesceFirstEmittedValue() {
     });
   };
 }
-function _suspensify(projector) {
+function _suspensify() {
   return source$ => {
     const initialState = {
       value: undefined,
@@ -1098,7 +1100,7 @@ function _suspensify(projector) {
       finalized: false,
       pending: true
     };
-    const result$ = source$.pipe(materialize(), scan((state = initialState, notification) => {
+    return source$.pipe(materialize(), scan((state = initialState, notification) => {
       /* On complete, merge `finalized: true & pending: false`
        * with the current state. */
       if (notification.kind === 'C') {
@@ -1116,7 +1118,6 @@ function _suspensify(projector) {
         pending: false
       };
     }, initialState), startWith(initialState));
-    return projector != null ? result$.pipe(map(projector)) : result$;
   };
 }
 

package/package.json

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

package/src/lib/suspensify.d.ts

@@ -1,17 +1,51 @@
 import { OperatorFunction } from 'rxjs';
-export interface Suspense<T> {
+export interface SuspenseLax<T> {
     value: undefined | T;
     error: undefined | any;
     finalized: boolean;
     pending: boolean;
 }
+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 declare type SuspenseStrict<T> = SuspensePending | SuspenseWithValue<T> | SuspenseWithError;
+/**
+ * @todo 3.0.0: Make `Suspense` an alias for `SuspenseStrict`.
+ */
+export declare type Suspense<T> = SuspenseLax<T>;
+export interface SuspensifyOptions {
+    /**
+     * @deprecated 🚧 Work in progress.
+     */
+    strict?: boolean;
+}
 /**
  * @description creates a derivated state from the source observable.
  *
  * @example source$.pipe(suspensify())
  *
- * @returns Observable<Suspense<T>>
+ * @returns Observable<SuspenseLax<T> | SuspenseStrict<T>>
  */
-export declare function suspensify<T, R = Suspense<T>>(): OperatorFunction<T, R>;
-export declare function suspensify<T, R>(projector: (data: Suspense<T>) => R): OperatorFunction<T, R>;
-export declare function suspensify<T, R = Suspense<T>>(projector?: (data: Suspense<T>) => R): OperatorFunction<T, R | Suspense<T>>;
+export declare function suspensify<T>(options?: {
+    strict: false;
+}): OperatorFunction<T, SuspenseLax<T>>;
+export declare function suspensify<T>(options: {
+    strict: true;
+}): OperatorFunction<T, SuspenseStrict<T>>;

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

@@ -0,0 +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);
+    };
+};