@thi.ng/fibers 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Change Log
+
+- **Last updated**: 2023-08-04T10:58:19Z
+- **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org/) for commit guidelines.
+
+**Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
+and/or version bumps of transitive dependencies.
+
+## [0.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/fibers@0.1.0) (2023-08-04)
+
+#### 🚀 Features
+
+- import as new pkg ([7f8c6dc](https://github.com/thi-ng/umbrella/commit/7f8c6dc))
+- add/update operators, add Fiber.isActive() ([a1099c5](https://github.com/thi-ng/umbrella/commit/a1099c5))
+- update Fiber.catch(), childForID(), add docs ([aa8d8d0](https://github.com/thi-ng/umbrella/commit/aa8d8d0))
+
+#### 🩹 Bug fixes
+
+- fix typo in waitFrames() ([5700b3e](https://github.com/thi-ng/umbrella/commit/5700b3e))

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,246 @@
+<!-- This file is generated - DO NOT EDIT! -->
+
+# ![@thi.ng/fibers](https://media.thi.ng/umbrella/banners-20220914/thing-fibers.svg?d08288cb)
+
+[![npm version](https://img.shields.io/npm/v/@thi.ng/fibers.svg)](https://www.npmjs.com/package/@thi.ng/fibers)
+![npm downloads](https://img.shields.io/npm/dm/@thi.ng/fibers.svg)
+[![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
+
+This project is part of the
+[@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
+
+- [About](#about)
+  - [Basic usage](#basic-usage)
+  - [Fiber operators](#fiber-operators)
+  - [Composition via transducers](#composition-via-transducers)
+- [Status](#status)
+- [Installation](#installation)
+- [Dependencies](#dependencies)
+- [Usage examples](#usage-examples)
+- [API](#api)
+- [Authors](#authors)
+- [License](#license)
+
+## About
+
+Process hierarchies & operators for cooperative multitasking.
+
+This package provides a
+[`Fiber`](https://docs.thi.ng/umbrella/fibers/classes/Fiber.html) primitive
+acting as wrapper around ES6 generators (co-routines) and supplements them with
+nested child processes, cancellation, error & event handling and (optional)
+logging features. Additionally, there're a number of fiber-related utilities and
+higher order operators to construct and compose fibers.
+
+### Basic usage
+
+```ts tangle:export/readme-1.ts
+import { fiber, wait } from "@thi.ng/fibers";
+import { ConsoleLogger } from "@thi.ng/logger";
+
+// wrap an endless generator as fiber
+const app = fiber(
+    function* () {
+        while(true) {
+            console.log("hello");
+            // wait 0.25s
+            yield* wait(250);
+            console.log("fiber");
+            // wait 1s
+            yield* wait(1000);
+        }
+    }
+);
+
+// start processing it with default handlers
+// see: https://docs.thi.ng/umbrella/fibers/classes/Fiber.html#run
+app.run();
+
+// create a child process which runs semi-independently
+// (only executes if parent is still active)
+// child fibers are auto-removed from parent when they terminate
+const child = app.fork(
+    // the `ctx` arg is the fiber wrapping this generator
+    function* (ctx) {
+        for(let i = 0; i < 3; i++) {
+            ctx.logger?.debug("count", i);
+            yield* wait(100);
+        }
+        // return value will be stored in fiber for future reference
+        return 42;
+    },
+    // fiber options
+    {
+        // custom fiber ID (else autogenerated)
+        id: "child-demo",
+        // custom logger (default: none)
+        logger: new ConsoleLogger("child")
+    }
+);
+
+// hello
+// [DEBUG] child: init child-demo
+// [DEBUG] child: count 0
+// [DEBUG] child: count 1
+// [DEBUG] child: count 2
+// fiber
+// [DEBUG] child: done child-demo 42
+// [DEBUG] child: deinit child-demo
+// hello
+// fiber
+// hello
+// ...
+
+// once a fiber has completed, its value can be obtained
+// e.g. here we create another fiber, which first waits for `child` to complete
+app.fork(function* () {
+    // wait for other fiber
+    const result = yield* child;
+    console.log("result", result);
+    // alt way to obtain value
+    console.log("deref", child.deref());
+});
+// result 42
+// deref 42
+```
+
+### Fiber operators
+
+The following operators act as basic composition helpers to construct more elaborate fiber setups:
+
+- [`all`](https://docs.thi.ng/umbrella/fibers/functions/all.html): wait for all given fibers to complete
+- [`first`](https://docs.thi.ng/umbrella/fibers/functions/first.html): wait for one of the given fibers to complete
+- [`fork`](https://docs.thi.ng/umbrella/fibers/classes/Fiber.html#fork): create & attach a new child process
+- [`forkAll`](https://docs.thi.ng/umbrella/fibers/classes/Fiber.html#forkAll): create & attach multiple child processes
+- [`join`](https://docs.thi.ng/umbrella/fibers/classes/Fiber.html#join): wait for all child processes to complete
+- [`sequence`](https://docs.thi.ng/umbrella/fibers/functions/sequence.html): execute fibers in sequence
+- [`timeSlice`](https://docs.thi.ng/umbrella/fibers/functions/timeSlice.html): execute fiber in batches of N milliseconds
+- [`until`](https://docs.thi.ng/umbrella/fibers/functions/until.html): wait until predicate is truthy
+- [`untilEvent`](https://docs.thi.ng/umbrella/fibers/functions/untilEvent.html): wait until event occurs
+- [`untilPromise`](https://docs.thi.ng/umbrella/fibers/functions/untilPromise.html): wait until promise resolves/rejects
+- [`untilState`](https://docs.thi.ng/umbrella/fibers/functions/untilState.html): stateful version of `until`
+- [`wait`](https://docs.thi.ng/umbrella/fibers/functions/wait.html): wait for N milliseconds or indefinitely
+- [`waitFrames`](https://docs.thi.ng/umbrella/fibers/functions/waitFrames.html): wait for N frames/ticks
+- [`withTimeout`](https://docs.thi.ng/umbrella/fibers/functions/withTimeout.html): wait for given fiber, but only max N milliseconds
+
+### Composition via transducers
+
+The [@thi.ng/transducers
+package](https://github.com/thi-ng/umbrella/tree/develop/packages/transducers)
+can be very helpful to create complex fiber setups, for example:
+
+```ts tangle:export/readme-2.ts
+import { sequence, wait, type MaybeFiber } from "@thi.ng/fibers";
+import {
+    cycle,
+    interpose,
+    map,
+    partition,
+    repeatedly,
+} from "@thi.ng/transducers";
+
+const defWorkItem = (id: number) =>
+    function* () {
+        console.log("part", id);
+    };
+
+const defWorkGroup = (items: MaybeFiber[]) =>
+    function* () {
+        // interject a short pause between given work items
+        // then execute in order and wait until all done
+        yield* sequence(interpose(() => wait(100), items));
+        console.log("---");
+        yield* wait(1000);
+    };
+
+// create fiber which executes given sub-processes in order
+sequence(
+    // generate 25 work items
+    // partition into groups of 5
+    // transform into iterable of work groups
+    // repeat indefinitely
+    cycle(map(defWorkGroup, partition(5, repeatedly(defWorkItem, 25))))
+).run();
+
+// part 0
+// part 1
+// part 2
+// part 3
+// part 4
+// ---
+// part 5
+// part 6
+// part 7
+```
+
+## Status
+
+**ALPHA** - bleeding edge / work-in-progress
+
+[Search or submit any issues for this package](https://github.com/thi-ng/umbrella/issues?q=%5Bfibers%5D+in%3Atitle)
+
+## Installation
+
+```bash
+yarn add @thi.ng/fibers
+```
+
+ES module import:
+
+```html
+<script type="module" src="https://cdn.skypack.dev/@thi.ng/fibers"></script>
+```
+
+[Skypack documentation](https://docs.skypack.dev/)
+
+For Node.js REPL:
+
+```js
+const fibers = await import("@thi.ng/fibers");
+```
+
+Package sizes (brotli'd, pre-treeshake): ESM: 1.88 KB
+
+## Dependencies
+
+- [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api)
+- [@thi.ng/bench](https://github.com/thi-ng/umbrella/tree/develop/packages/bench)
+- [@thi.ng/checks](https://github.com/thi-ng/umbrella/tree/develop/packages/checks)
+- [@thi.ng/logger](https://github.com/thi-ng/umbrella/tree/develop/packages/logger)
+
+## Usage examples
+
+Several demos in this repo's
+[/examples](https://github.com/thi-ng/umbrella/tree/develop/examples)
+directory are using this package.
+
+A selection:
+
+| Screenshot                                                                                                          | Description                                 | Live demo                                          | Source                                                                          |
+|:--------------------------------------------------------------------------------------------------------------------|:--------------------------------------------|:---------------------------------------------------|:--------------------------------------------------------------------------------|
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/fiber-basics.png" width="240"/> | Fiber-based cooperative multitasking basics | [Demo](https://demo.thi.ng/umbrella/fiber-basics/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/fiber-basics) |
+
+## API
+
+[Generated API docs](https://docs.thi.ng/umbrella/fibers/)
+
+TODO
+
+## Authors
+
+- [Karsten Schmidt](https://thi.ng)
+
+If this project contributes to an academic publication, please cite it as:
+
+```bibtex
+@misc{thing-fibers,
+  title = "@thi.ng/fibers",
+  author = "Karsten Schmidt",
+  note = "https://thi.ng/fibers",
+  year = 2023
+}
+```
+
+## License
+
+&copy; 2023 Karsten Schmidt // Apache License 2.0

package/api.d.ts

@@ -0,0 +1,62 @@
+import type { Fn, Fn2, IIDGen } from "@thi.ng/api";
+import type { ILogger } from "@thi.ng/logger";
+import type { Fiber } from "./fiber.js";
+export type FiberFactory<T = any> = (f: Fiber<T>) => Generator<unknown, T, unknown>;
+export type MaybeFiber<T = any> = Fiber<T> | FiberFactory<T> | Generator<unknown, T>;
+export interface FiberOpts {
+    /**
+     * Custom ID assigned to this fiber.
+     */
+    id: string;
+    /**
+     * ID generator instance for fiber ID (instead of {@link FiberOpts.id})
+     */
+    idgen: IIDGen<string>;
+    /**
+     * Logger instance.
+     */
+    logger: ILogger;
+    /**
+     * Parent {@link Fiber}.
+     *
+     * @internal
+     */
+    parent: Fiber;
+    /**
+     * User init handler
+     */
+    init: Fn<Fiber, void>;
+    /**
+     * User deinit handler.
+     */
+    deinit: Fn<Fiber, void>;
+    /**
+     * User error handler. If this function returns true, the error is
+     * considered caught and will **NOT** put the fiber into an error state.
+     * Otherwise, the fiber will stop further processing and cancel all child
+     * fibers (if any).
+     */
+    catch: Fn2<Fiber, Error, boolean>;
+}
+export declare const STATE_NEW = 0;
+export declare const STATE_ACTIVE = 1;
+export declare const STATE_DONE = 2;
+export declare const STATE_CANCELED = 3;
+export declare const STATE_ERROR = 4;
+export type State = typeof STATE_NEW | typeof STATE_ACTIVE | typeof STATE_DONE | typeof STATE_CANCELED | typeof STATE_ERROR;
+/**
+ * Event ID for completed fiber. The event `value` will be the one given to
+ * {@link Fiber.done} (if any).
+ */
+export declare const EVENT_FIBER_DONE = "fiber-done";
+/**
+ * Event ID for fiber cancellation.
+ */
+export declare const EVENT_FIBER_CANCELED = "fiber-canceled";
+/**
+ * Event ID for notifying about an error which occurred whilst executing a
+ * fiber. The event `value` will be the error passed to {@link Fiber.catch}.
+ */
+export declare const EVENT_FIBER_ERROR = "fiber-error";
+export type FiberEventType = typeof EVENT_FIBER_DONE | typeof EVENT_FIBER_CANCELED | typeof EVENT_FIBER_ERROR | "*";
+//# sourceMappingURL=api.d.ts.map

package/api.js

@@ -0,0 +1,19 @@
+export const STATE_NEW = 0;
+export const STATE_ACTIVE = 1;
+export const STATE_DONE = 2;
+export const STATE_CANCELED = 3;
+export const STATE_ERROR = 4;
+/**
+ * Event ID for completed fiber. The event `value` will be the one given to
+ * {@link Fiber.done} (if any).
+ */
+export const EVENT_FIBER_DONE = "fiber-done";
+/**
+ * Event ID for fiber cancellation.
+ */
+export const EVENT_FIBER_CANCELED = "fiber-canceled";
+/**
+ * Event ID for notifying about an error which occurred whilst executing a
+ * fiber. The event `value` will be the error passed to {@link Fiber.catch}.
+ */
+export const EVENT_FIBER_ERROR = "fiber-error";