@thi.ng/rstream 8.3.20 → 8.4.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-04-08T14:59:30Z
+- **Last updated**: 2024-04-20T14:42:45Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,18 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+### [8.4.1](https://github.com/thi-ng/umbrella/tree/@thi.ng/rstream@8.4.1) (2024-04-20)
+
+#### ♻️ Refactoring
+
+- update type usage ([86be8b7](https://github.com/thi-ng/umbrella/commit/86be8b7))
+
+## [8.4.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/rstream@8.4.0) (2024-04-11)
+
+#### 🚀 Features
+
+- add fromAsync() / asAsync() converters & tests ([df57056](https://github.com/thi-ng/umbrella/commit/df57056))
+
 ### [8.3.20](https://github.com/thi-ng/umbrella/tree/@thi.ng/rstream@8.3.20) (2024-04-08)
 
 #### ♻️ Refactoring

package/README.md

@@ -7,7 +7,7 @@
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 > [!NOTE]
-> This is one of 191 standalone projects, maintained as part
+> This is one of 192 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >
@@ -203,10 +203,10 @@ import * as rs from "@thi.ng/rstream";
 Browser ESM import:
 
 ```html
-<script type="module" src="https://cdn.skypack.dev/@thi.ng/rstream"></script>
+<script type="module" src="https://esm.run/@thi.ng/rstream"></script>
 ```
 
-[Skypack documentation](https://docs.skypack.dev/)
+[JSDelivr documentation](https://www.jsdelivr.com/)
 
 For Node.js REPL:
 
@@ -214,7 +214,7 @@ For Node.js REPL:
 const rs = await import("@thi.ng/rstream");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 6.16 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 6.32 KB
 
 ## Dependencies
 

package/api.d.ts

@@ -1,4 +1,4 @@
-import type { Fn, Fn0, IDeref, IID } from "@thi.ng/api";
+import type { Fn, Fn0, IDeref, IID, Maybe } from "@thi.ng/api";
 import type { Transducer } from "@thi.ng/transducers";
 import type { Stream } from "./stream.js";
 export declare enum State {
@@ -75,7 +75,7 @@ export interface TransformableOpts<A, B> extends CommonOpts, WithTransform<A, B>
 export type ErrorHandler = Fn<any, boolean>;
 export interface WithErrorHandler {
     /**
-     * Optional error handler to use for this
+     * Optional error handler to use for this stream/subscription
      */
     error: ErrorHandler;
 }
@@ -127,7 +127,7 @@ export interface ISubscriber<T> {
     __owner?: ISubscription<any, any>;
     [id: string]: any;
 }
-export interface ISubscribable<A> extends IDeref<A | undefined>, IID<string> {
+export interface ISubscribable<A> extends IDeref<Maybe<A>>, IID<string> {
     /**
      * Adds given `sub` as child subscription.
      *
@@ -174,7 +174,7 @@ export interface ITransformable<B> {
     transform<C>(opts: WithTransform<B, C> & Partial<WithErrorHandlerOpts>): ISubscription<B, C>;
     map<C>(fn: Fn<B, C>, opts?: Partial<WithErrorHandlerOpts>): ISubscription<B, C>;
 }
-export interface ISubscription<A, B> extends IDeref<B | undefined>, ISubscriber<A>, ISubscribable<B>, ITransformable<B> {
+export interface ISubscription<A, B> extends IDeref<Maybe<B>>, ISubscriber<A>, ISubscribable<B>, ITransformable<B> {
     parent?: ISubscription<any, A>;
     getState(): State;
 }

package/async.d.ts

@@ -0,0 +1,17 @@
+import { type ISubscription, type WithErrorHandlerOpts } from "./api.js";
+/**
+ * Creates a new {@link stream} from given async iterable `src` and `opts`.
+ *
+ * @param src
+ * @param opts
+ */
+export declare const fromAsync: <T>(src: AsyncIterable<T>, opts?: Partial<WithErrorHandlerOpts>) => import("./stream.js").Stream<T>;
+/**
+ * Reverse operation of {@link fromAsync}. Returns an async iterator which
+ * subscribes to given `src` sub and yields values as long as the `src` is
+ * intact.
+ *
+ * @param src
+ */
+export declare function asAsync<T>(src: ISubscription<any, T>): AsyncGenerator<Awaited<T>, void, unknown>;
+//# sourceMappingURL=async.d.ts.map

package/async.js

@@ -0,0 +1,57 @@
+import { SEMAPHORE } from "@thi.ng/api/api";
+import { State } from "./api.js";
+import { stream } from "./stream.js";
+const fromAsync = (src, opts) => stream(($stream) => {
+  let active = true;
+  (async () => {
+    try {
+      for await (let x of src) {
+        if (!active)
+          return;
+        $stream.next(x);
+      }
+      $stream.done();
+    } catch (e) {
+      $stream.error(e);
+    }
+  })();
+  return () => active = false;
+}, opts);
+async function* asAsync(src) {
+  let resolve;
+  let initial;
+  const $newInitial = () => {
+    return initial = new Promise(($resolve) => {
+      resolve = $resolve;
+    });
+  };
+  const promises = [$newInitial()];
+  src.subscribe({
+    next(x) {
+      if (initial) {
+        resolve(x);
+        initial = void 0;
+      } else
+        promises.push(Promise.resolve(x));
+    },
+    done() {
+      if (initial) {
+        resolve(SEMAPHORE);
+        initial = void 0;
+      } else
+        promises.push(Promise.resolve(SEMAPHORE));
+    }
+  });
+  while (promises.length && src.getState() < State.ERROR) {
+    const res = await promises.shift();
+    if (res === SEMAPHORE)
+      break;
+    if (!promises.length)
+      promises[0] = $newInitial();
+    yield res;
+  }
+}
+export {
+  asAsync,
+  fromAsync
+};

package/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./api.js";
 export * from "./asidechain.js";
+export * from "./async.js";
 export * from "./atom.js";
 export * from "./bisect.js";
 export * from "./checks.js";

package/index.js

@@ -1,5 +1,6 @@
 export * from "./api.js";
 export * from "./asidechain.js";
+export * from "./async.js";
 export * from "./atom.js";
 export * from "./bisect.js";
 export * from "./checks.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/rstream",
-  "version": "8.3.20",
+  "version": "8.4.1",
   "description": "Reactive streams & subscription primitives for constructing dataflow graphs / pipelines",
   "type": "module",
   "module": "./index.js",
@@ -40,14 +40,14 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.10.0",
-    "@thi.ng/arrays": "^2.9.2",
-    "@thi.ng/associative": "^6.3.55",
-    "@thi.ng/atom": "^5.2.42",
-    "@thi.ng/checks": "^3.6.0",
-    "@thi.ng/errors": "^2.5.3",
-    "@thi.ng/logger": "^3.0.8",
-    "@thi.ng/transducers": "^9.0.0"
+    "@thi.ng/api": "^8.11.0",
+    "@thi.ng/arrays": "^2.9.4",
+    "@thi.ng/associative": "^6.3.57",
+    "@thi.ng/atom": "^5.2.44",
+    "@thi.ng/checks": "^3.6.2",
+    "@thi.ng/errors": "^2.5.5",
+    "@thi.ng/logger": "^3.0.10",
+    "@thi.ng/transducers": "^9.0.2"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.43.0",
@@ -94,6 +94,9 @@
     "./asidechain": {
       "default": "./asidechain.js"
     },
+    "./async": {
+      "default": "./async.js"
+    },
     "./atom": {
       "default": "./atom.js"
     },
@@ -216,5 +219,5 @@
     ],
     "year": 2017
   },
-  "gitHead": "85ac4bd4d6d89f8e3689e2863d5bea0cecdb371c\n"
+  "gitHead": "8339d05ecc857e529c7325a9839c0063b89e728d\n"
 }

package/stream.d.ts

@@ -1,3 +1,4 @@
+import type { Maybe } from "@thi.ng/api";
 import { type CommonOpts, type IStream, type ISubscriber, type ISubscription, type StreamCancel, type StreamSource, type TransformableOpts, type WithErrorHandlerOpts } from "./api.js";
 import { Subscription } from "./subscription.js";
 /**
@@ -71,7 +72,7 @@ export declare const reactive: <T>(val: T, opts?: Partial<CommonOpts>) => Stream
  */
 export declare class Stream<T> extends Subscription<T, T> implements IStream<T> {
     src?: StreamSource<T>;
-    protected _cancel: StreamCancel | undefined;
+    protected _cancel: Maybe<StreamCancel>;
     protected _inited: boolean;
     constructor(opts?: Partial<WithErrorHandlerOpts>);
     constructor(src: StreamSource<T>, opts?: Partial<WithErrorHandlerOpts>);

package/subscription.d.ts

@@ -1,4 +1,4 @@
-import type { Fn } from "@thi.ng/api";
+import type { Fn, Maybe } from "@thi.ng/api";
 import type { Reduced, Reducer, Transducer } from "@thi.ng/transducers";
 import { CloseMode, State, type CommonOpts, type ISubscriber, type ISubscription, type SubscriptionOpts, type TransformableOpts, type WithErrorHandlerOpts, type WithTransform } from "./api.js";
 /**
@@ -66,7 +66,7 @@ export declare class Subscription<A, B> implements ISubscription<A, B> {
     protected state: State;
     protected subs: Partial<ISubscriber<B>>[];
     constructor(wrapped?: Partial<ISubscriber<B>> | undefined, opts?: Partial<SubscriptionOpts<A, B>>);
-    deref(): B | undefined;
+    deref(): Maybe<B>;
     getState(): State;
     protected setState(state: State): void;
     /**