@thi.ng/interceptors 3.2.0 → 3.2.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-12-16T12:52:25Z
+- **Last updated**: 2022-12-20T16:33:11Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/event-bus.d.ts

@@ -81,9 +81,8 @@ export declare class StatelessEventBus implements IDispatch {
      * Adds built-in event & side effect handlers.
      *
      * @remarks
-     * Also see additional built-ins defined by the stateful
-     * {@link EventBus} extension of this class, as well as comments for
-     * these class methods:
+     * Also see additional built-ins defined by the stateful {@link EventBus}
+     * extension of this class, as well as comments for these class methods:
      *
      * - {@link StatelessEventBus.mergeEffects}
      * - {@link StatelessEventBus.processEvent}
@@ -96,8 +95,8 @@ export declare class StatelessEventBus implements IDispatch {
      *
      * #### `FX_CANCEL`
      *
-     * If assigned `true`, cancels processing of current event, though
-     * still applies any side effects already accumulated.
+     * If assigned `true`, cancels processing of current event, though still
+     * applies any side effects already accumulated.
      *
      * #### `FX_DISPATCH`
      *
@@ -109,8 +108,8 @@ export declare class StatelessEventBus implements IDispatch {
      *
      * #### `FX_DISPATCH_NOW`
      *
-     * Dispatches assigned events as part of currently processed event
-     * queue (no delay).
+     * Dispatches assigned events as part of currently processed event queue (no
+     * delay).
      *
      * #### `FX_DELAY`
      *
@@ -125,13 +124,13 @@ export declare class StatelessEventBus implements IDispatch {
      * #### `FX_FETCH`
      *
      * Async side effect. Only to be used in conjunction with
-     * `FX_DISPATCH_ASYNC`. Performs `fetch()` HTTP request and triggers
-     * success with received response, or if there was an error with
-     * response's `statusText`. The error event is only triggered if the
-     * fetched response's `ok` field is non-truthy.
+     * `FX_DISPATCH_ASYNC`. Performs `fetch()` HTTP request and triggers success
+     * with received response, or if there was an error with response's
+     * `statusText`. The error event is only triggered if the fetched response's
+     * `ok` field is non-truthy.
      *
-     * - {@link https://developer.mozilla.org/en-US/docs/Web/API/Response/ok}
-     * - {@link https://developer.mozilla.org/en-US/docs/Web/API/Response/statusText}
+     * - https://developer.mozilla.org/en-US/docs/Web/API/Response/ok
+     * - https://developer.mozilla.org/en-US/docs/Web/API/Response/statusText
      *
      * ```
      * // fetches "foo.json" and then dispatches EV_SUCCESS or EV_ERROR event
@@ -301,25 +300,25 @@ export declare class StatelessEventBus implements IDispatch {
  * Stateful version of {@link StatelessEventBus}.
  *
  * @remarks
- * Wraps an {@link @thi.ng/atom#IAtom} state container (i.e.
- * `Atom`/`Cursor`/`History`) and provides additional pre-defined event
- * handlers and side effects to manipulate wrapped state. Prefer this as
- * the default implementation for most use cases.
+ * Wraps an [`IAtom`](https://docs.thi.ng/umbrella/atom/interfaces/IAtom.html)
+ * state container (i.e. `Atom`/`Cursor`/`History`) and provides additional
+ * pre-defined event handlers and side effects to manipulate wrapped state.
+ * Prefer this as the default implementation for most use cases.
  */
 export declare class EventBus extends StatelessEventBus implements IDeref<any>, IDispatch {
     readonly state: IAtom<any>;
     /**
-     * Creates a new event bus instance with given parent state, handler
-     * and effect definitions (all optional).
+     * Creates a new event bus instance with given parent state, handler and
+     * effect definitions (all optional).
      *
      * @remarks
      * If no state is given, automatically creates an
-     * {@link @thi.ng/atom#Atom} with empty state object.
+     * [`Atom`](https://docs.thi.ng/umbrella/atom/classes/Atom.html) with empty
+     * state object.
      *
      * In addition to the user provided handlers & effects, a number of
-     * built-ins are added automatically. See
-     * {@link EventBus.addBuiltIns}. User handlers can override
-     * built-ins.
+     * built-ins are added automatically. See {@link EventBus.addBuiltIns}. User
+     * handlers can override built-ins.
      *
      * @param state -
      * @param handlers -
@@ -340,7 +339,7 @@ export declare class EventBus extends StatelessEventBus implements IDeref<any>,
      * #### `EV_SET_VALUE`
      *
      * Resets state path to provided value. See
-     * {@link @thi.ng/paths#setIn}.
+     * [`setIn()`](https://docs.thi.ng/umbrella/paths/functions/setIn.html).
      *
      * Example event definition:
      * ```
@@ -349,8 +348,9 @@ export declare class EventBus extends StatelessEventBus implements IDeref<any>,
      *
      * #### `EV_UPDATE_VALUE`
      *
-     * Updates a state path's value with provided function and optional
-     * extra arguments. See {@link @thi.ng/paths#updateIn}.
+     * Updates a state path's value with provided function and optional extra
+     * arguments. See
+     * [`updateIn()`](https://docs.thi.ng/umbrella/paths/functions/updateIn.html).
      *
      * Example event definition:
      * ```
@@ -368,18 +368,19 @@ export declare class EventBus extends StatelessEventBus implements IDeref<any>,
      *
      * #### `EV_UNDO`
      *
-     * Calls `ctx[id].undo()` and uses return value as new state.
-     * Assumes `ctx[id]` is a {@link @thi.ng/atom#History} instance,
-     * provided via e.g. `processQueue({ history })`. The event can be
-     * triggered with or without ID. By default `"history"` is used as
-     * default key to lookup the `History` instance. Furthermore, an
-     * additional event can be triggered based on if a previous state
-     * has been restored or not (basically, if the undo was successful).
-     * This is useful for resetting/re-initializing stateful resources
-     * after a successful undo action or to notify the user that no more
-     * undo's are possible. The new event will be processed in the same
-     * frame and has access to the (possibly) restored state. The event
-     * structure for these options is shown below:
+     * Calls `ctx[id].undo()` and uses return value as new state. Assumes
+     * `ctx[id]` is a
+     * [`History`](https://docs.thi.ng/umbrella/atom/classes/History.html)
+     * instance, provided via e.g. `processQueue({ history })`. The event can be
+     * triggered with or without ID. By default `"history"` is used as default
+     * key to lookup the `History` instance. Furthermore, an additional event
+     * can be triggered based on if a previous state has been restored or not
+     * (basically, if the undo was successful). This is useful for
+     * resetting/re-initializing stateful resources after a successful undo
+     * action or to notify the user that no more undo's are possible. The new
+     * event will be processed in the same frame and has access to the
+     * (possibly) restored state. The event structure for these options is shown
+     * below:
      *
      * ```
      * // using default ID
@@ -400,26 +401,27 @@ export declare class EventBus extends StatelessEventBus implements IDeref<any>,
      *
      * #### `FX_STATE`
      *
-     * Resets state atom to provided value (only a single update per
-     * processing frame).
+     * Resets state atom to provided value (only a single update per processing
+     * frame).
      */
     addBuiltIns(): any;
     /**
-     * Triggers processing of current event queue and returns `true` if
-     * the any of the processed events caused a state change.
+     * Triggers processing of current event queue and returns `true` if the any
+     * of the processed events caused a state change.
      *
-     * If an event handler triggers the `FX_DISPATCH_NOW` side effect,
-     * the new event will be added to the currently processed batch and
-     * therefore executed in the same frame. Also see {@link dispatchNow}.
+     * If an event handler triggers the `FX_DISPATCH_NOW` side effect, the new
+     * event will be added to the currently processed batch and therefore
+     * executed in the same frame. Also see {@link dispatchNow}.
      *
      * If the optional `ctx` arg is provided it will be merged into the
      * {@link InterceptorContext} object passed to each interceptor. Since the
-     * merged object is also used to collect triggered side effects,
-     * care must be taken that there're no key name clashes.
+     * merged object is also used to collect triggered side effects, care must
+     * be taken that there're no key name clashes.
      *
-     * In order to use the built-in `EV_UNDO`, `EV_REDO` events, users
-     * MUST provide a {@link @thi.ng/atom#History} (or compatible undo
-     * history instance) via the `ctx` arg, e.g.
+     * In order to use the built-in `EV_UNDO`, `EV_REDO` events, users MUST
+     * provide a
+     * [`History`](https://docs.thi.ng/umbrella/atom/classes/History.html) (or
+     * compatible undo history instance) via the `ctx` arg, e.g.
      *
      * ```
      * bus.processQueue({ history });

package/event-bus.js

@@ -92,9 +92,8 @@ export class StatelessEventBus {
      * Adds built-in event & side effect handlers.
      *
      * @remarks
-     * Also see additional built-ins defined by the stateful
-     * {@link EventBus} extension of this class, as well as comments for
-     * these class methods:
+     * Also see additional built-ins defined by the stateful {@link EventBus}
+     * extension of this class, as well as comments for these class methods:
      *
      * - {@link StatelessEventBus.mergeEffects}
      * - {@link StatelessEventBus.processEvent}
@@ -107,8 +106,8 @@ export class StatelessEventBus {
      *
      * #### `FX_CANCEL`
      *
-     * If assigned `true`, cancels processing of current event, though
-     * still applies any side effects already accumulated.
+     * If assigned `true`, cancels processing of current event, though still
+     * applies any side effects already accumulated.
      *
      * #### `FX_DISPATCH`
      *
@@ -120,8 +119,8 @@ export class StatelessEventBus {
      *
      * #### `FX_DISPATCH_NOW`
      *
-     * Dispatches assigned events as part of currently processed event
-     * queue (no delay).
+     * Dispatches assigned events as part of currently processed event queue (no
+     * delay).
      *
      * #### `FX_DELAY`
      *
@@ -136,13 +135,13 @@ export class StatelessEventBus {
      * #### `FX_FETCH`
      *
      * Async side effect. Only to be used in conjunction with
-     * `FX_DISPATCH_ASYNC`. Performs `fetch()` HTTP request and triggers
-     * success with received response, or if there was an error with
-     * response's `statusText`. The error event is only triggered if the
-     * fetched response's `ok` field is non-truthy.
+     * `FX_DISPATCH_ASYNC`. Performs `fetch()` HTTP request and triggers success
+     * with received response, or if there was an error with response's
+     * `statusText`. The error event is only triggered if the fetched response's
+     * `ok` field is non-truthy.
      *
-     * - {@link https://developer.mozilla.org/en-US/docs/Web/API/Response/ok}
-     * - {@link https://developer.mozilla.org/en-US/docs/Web/API/Response/statusText}
+     * - https://developer.mozilla.org/en-US/docs/Web/API/Response/ok
+     * - https://developer.mozilla.org/en-US/docs/Web/API/Response/statusText
      *
      * ```
      * // fetches "foo.json" and then dispatches EV_SUCCESS or EV_ERROR event
@@ -521,24 +520,24 @@ export class StatelessEventBus {
  * Stateful version of {@link StatelessEventBus}.
  *
  * @remarks
- * Wraps an {@link @thi.ng/atom#IAtom} state container (i.e.
- * `Atom`/`Cursor`/`History`) and provides additional pre-defined event
- * handlers and side effects to manipulate wrapped state. Prefer this as
- * the default implementation for most use cases.
+ * Wraps an [`IAtom`](https://docs.thi.ng/umbrella/atom/interfaces/IAtom.html)
+ * state container (i.e. `Atom`/`Cursor`/`History`) and provides additional
+ * pre-defined event handlers and side effects to manipulate wrapped state.
+ * Prefer this as the default implementation for most use cases.
  */
 export class EventBus extends StatelessEventBus {
     /**
-     * Creates a new event bus instance with given parent state, handler
-     * and effect definitions (all optional).
+     * Creates a new event bus instance with given parent state, handler and
+     * effect definitions (all optional).
      *
      * @remarks
      * If no state is given, automatically creates an
-     * {@link @thi.ng/atom#Atom} with empty state object.
+     * [`Atom`](https://docs.thi.ng/umbrella/atom/classes/Atom.html) with empty
+     * state object.
      *
      * In addition to the user provided handlers & effects, a number of
-     * built-ins are added automatically. See
-     * {@link EventBus.addBuiltIns}. User handlers can override
-     * built-ins.
+     * built-ins are added automatically. See {@link EventBus.addBuiltIns}. User
+     * handlers can override built-ins.
      *
      * @param state -
      * @param handlers -
@@ -564,7 +563,7 @@ export class EventBus extends StatelessEventBus {
      * #### `EV_SET_VALUE`
      *
      * Resets state path to provided value. See
-     * {@link @thi.ng/paths#setIn}.
+     * [`setIn()`](https://docs.thi.ng/umbrella/paths/functions/setIn.html).
      *
      * Example event definition:
      * ```
@@ -573,8 +572,9 @@ export class EventBus extends StatelessEventBus {
      *
      * #### `EV_UPDATE_VALUE`
      *
-     * Updates a state path's value with provided function and optional
-     * extra arguments. See {@link @thi.ng/paths#updateIn}.
+     * Updates a state path's value with provided function and optional extra
+     * arguments. See
+     * [`updateIn()`](https://docs.thi.ng/umbrella/paths/functions/updateIn.html).
      *
      * Example event definition:
      * ```
@@ -592,18 +592,19 @@ export class EventBus extends StatelessEventBus {
      *
      * #### `EV_UNDO`
      *
-     * Calls `ctx[id].undo()` and uses return value as new state.
-     * Assumes `ctx[id]` is a {@link @thi.ng/atom#History} instance,
-     * provided via e.g. `processQueue({ history })`. The event can be
-     * triggered with or without ID. By default `"history"` is used as
-     * default key to lookup the `History` instance. Furthermore, an
-     * additional event can be triggered based on if a previous state
-     * has been restored or not (basically, if the undo was successful).
-     * This is useful for resetting/re-initializing stateful resources
-     * after a successful undo action or to notify the user that no more
-     * undo's are possible. The new event will be processed in the same
-     * frame and has access to the (possibly) restored state. The event
-     * structure for these options is shown below:
+     * Calls `ctx[id].undo()` and uses return value as new state. Assumes
+     * `ctx[id]` is a
+     * [`History`](https://docs.thi.ng/umbrella/atom/classes/History.html)
+     * instance, provided via e.g. `processQueue({ history })`. The event can be
+     * triggered with or without ID. By default `"history"` is used as default
+     * key to lookup the `History` instance. Furthermore, an additional event
+     * can be triggered based on if a previous state has been restored or not
+     * (basically, if the undo was successful). This is useful for
+     * resetting/re-initializing stateful resources after a successful undo
+     * action or to notify the user that no more undo's are possible. The new
+     * event will be processed in the same frame and has access to the
+     * (possibly) restored state. The event structure for these options is shown
+     * below:
      *
      * ```
      * // using default ID
@@ -624,8 +625,8 @@ export class EventBus extends StatelessEventBus {
      *
      * #### `FX_STATE`
      *
-     * Resets state atom to provided value (only a single update per
-     * processing frame).
+     * Resets state atom to provided value (only a single update per processing
+     * frame).
      */
     addBuiltIns() {
         super.addBuiltIns();
@@ -649,21 +650,22 @@ export class EventBus extends StatelessEventBus {
         });
     }
     /**
-     * Triggers processing of current event queue and returns `true` if
-     * the any of the processed events caused a state change.
+     * Triggers processing of current event queue and returns `true` if the any
+     * of the processed events caused a state change.
      *
-     * If an event handler triggers the `FX_DISPATCH_NOW` side effect,
-     * the new event will be added to the currently processed batch and
-     * therefore executed in the same frame. Also see {@link dispatchNow}.
+     * If an event handler triggers the `FX_DISPATCH_NOW` side effect, the new
+     * event will be added to the currently processed batch and therefore
+     * executed in the same frame. Also see {@link dispatchNow}.
      *
      * If the optional `ctx` arg is provided it will be merged into the
      * {@link InterceptorContext} object passed to each interceptor. Since the
-     * merged object is also used to collect triggered side effects,
-     * care must be taken that there're no key name clashes.
+     * merged object is also used to collect triggered side effects, care must
+     * be taken that there're no key name clashes.
      *
-     * In order to use the built-in `EV_UNDO`, `EV_REDO` events, users
-     * MUST provide a {@link @thi.ng/atom#History} (or compatible undo
-     * history instance) via the `ctx` arg, e.g.
+     * In order to use the built-in `EV_UNDO`, `EV_REDO` events, users MUST
+     * provide a
+     * [`History`](https://docs.thi.ng/umbrella/atom/classes/History.html) (or
+     * compatible undo history instance) via the `ctx` arg, e.g.
      *
      * ```
      * bus.processQueue({ history });

package/interceptors.d.ts

@@ -27,11 +27,11 @@ export declare const dispatch: (event: Event) => InterceptorFn;
  */
 export declare const dispatchNow: (event: Event) => InterceptorFn;
 /**
- * Higher-order interceptor. Returns interceptor which calls
- * `ctx[id].record()`, where `ctx` is the currently active
- * {@link InterceptorContext} passed to all event handlers and `ctx[id]`
- * is assumed to be a {@link @thi.ng/atom#History} instance, passed to
- * {@link EventBus.processQueue}. The default ID for the history
+ * Higher-order interceptor. Returns interceptor which calls `ctx[id].record()`,
+ * where `ctx` is the currently active {@link InterceptorContext} passed to all
+ * event handlers and `ctx[id]` is assumed to be a
+ * [`History`](https://docs.thi.ng/umbrella/atom/classes/History.html) instance,
+ * passed to {@link EventBus.processQueue}. The default ID for the history
  * instance is `"history"`.
  *
  * Example usage:

package/interceptors.js

@@ -33,11 +33,11 @@ export const dispatchNow = (event) => () => ({
     [FX_DISPATCH_NOW]: event,
 });
 /**
- * Higher-order interceptor. Returns interceptor which calls
- * `ctx[id].record()`, where `ctx` is the currently active
- * {@link InterceptorContext} passed to all event handlers and `ctx[id]`
- * is assumed to be a {@link @thi.ng/atom#History} instance, passed to
- * {@link EventBus.processQueue}. The default ID for the history
+ * Higher-order interceptor. Returns interceptor which calls `ctx[id].record()`,
+ * where `ctx` is the currently active {@link InterceptorContext} passed to all
+ * event handlers and `ctx[id]` is assumed to be a
+ * [`History`](https://docs.thi.ng/umbrella/atom/classes/History.html) instance,
+ * passed to {@link EventBus.processQueue}. The default ID for the history
  * instance is `"history"`.
  *
  * Example usage:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/interceptors",
-  "version": "3.2.0",
+  "version": "3.2.1",
   "description": "Interceptor based event bus, side effect & immutable state handling",
   "type": "module",
   "module": "./index.js",
@@ -37,12 +37,12 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.6.0",
-    "@thi.ng/atom": "^5.1.25",
+    "@thi.ng/api": "^8.6.1",
+    "@thi.ng/atom": "^5.1.26",
     "@thi.ng/checks": "^3.3.5",
     "@thi.ng/errors": "^2.2.6",
     "@thi.ng/logger": "^1.4.5",
-    "@thi.ng/paths": "^5.1.25"
+    "@thi.ng/paths": "^5.1.26"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.7",
@@ -94,5 +94,5 @@
     "status": "completed",
     "year": 2016
   },
-  "gitHead": "f445a9cc8022bcdebbf6ff91fd66ced016d72f01\n"
+  "gitHead": "7b2af448da8a63fb21704a79cc4cdf1f3d7d7a64\n"
 }