@thi.ng/interceptors 3.2.57 → 3.2.59

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-04-23T07:02:18Z
+- **Last updated**: 2024-06-21T19:34:38Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ 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.
 
+### [3.2.59](https://github.com/thi-ng/umbrella/tree/@thi.ng/interceptors@3.2.59) (2024-06-21)
+
+#### ♻️ Refactoring
+
+- enforce uniform naming convention of internal functions ([56992b2](https://github.com/thi-ng/umbrella/commit/56992b2))
+
 ### [3.2.56](https://github.com/thi-ng/umbrella/tree/@thi.ng/interceptors@3.2.56) (2024-04-20)
 
 #### ♻️ 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 192 standalone projects, maintained as part
+> This is one of 193 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >

package/event-bus.js

@@ -207,7 +207,7 @@ class StatelessEventBus {
    * @param ids -
    */
   instrumentWith(inject, ids) {
-    const iceps = inject.map(asInterceptor);
+    const iceps = inject.map(__asInterceptor);
     const handlers = this.handlers;
     for (let id of ids || Object.keys(handlers)) {
       const h = handlers[id];
@@ -475,7 +475,7 @@ class StatelessEventBus {
     }
   }
   interceptorsFromSpec(spec) {
-    return isArray(spec) ? spec.map(asInterceptor) : isFunction(spec) ? [{ pre: spec }] : [spec];
+    return isArray(spec) ? spec.map(__asInterceptor) : isFunction(spec) ? [{ pre: spec }] : [spec];
   }
 }
 class EventBus extends StatelessEventBus {
@@ -602,8 +602,8 @@ class EventBus extends StatelessEventBus {
       [EV_TOGGLE_VALUE]: (state, [_, path]) => ({
         [FX_STATE]: updateInUnsafe(state, path, (x) => !x)
       }),
-      [EV_UNDO]: undoHandler("undo"),
-      [EV_REDO]: undoHandler("redo")
+      [EV_UNDO]: __undoHandler("undo"),
+      [EV_REDO]: __undoHandler("redo")
     });
     this.addEffects({
       [FX_STATE]: [(state) => this.state.reset(state), -1e3]
@@ -647,8 +647,8 @@ class EventBus extends StatelessEventBus {
     return false;
   }
 }
-const asInterceptor = (i) => isFunction(i) ? { pre: i } : i;
-const undoHandler = (action) => (_, [__, ev], bus, ctx) => {
+const __asInterceptor = (i) => isFunction(i) ? { pre: i } : i;
+const __undoHandler = (action) => (_, [__, ev], bus, ctx) => {
   const id = ev ? ev[0] : "history";
   if (implementsFunction(ctx[id], action)) {
     const ok = ctx[id][action]();

package/interceptors.d.ts

@@ -37,25 +37,35 @@ export declare const dispatchNow: (event: Event) => InterceptorFn;
  * Example usage:
  *
  * @example
- * ```ts
- * import { Atom } from "@thi.ng/atom";
- * import { EvenBus, snapshot, valueSetter } from "@thi.ng/interceptors";
+ * ```ts tangle:../export/snapshot.ts
+ * import { defAtom, defHistory } from "@thi.ng/atom";
+ * import { EventBus, snapshot, valueSetter, EV_UNDO } from "@thi.ng/interceptors";
  *
- * state = new Atom({});
- * history = new History(state);
- * bus = new EventBus(state);
+ * const state = defAtom({ foo: 42 });
+ * const history = defHistory(state);
+ * const bus = new EventBus(state);
  * // register event handler
  * // each time the `foo` event is triggered, a snapshot of
  * // current app state is recorded first
  * bus.addHandlers({
- *  foo: [snapshot(), valueSetter("foo")]
+ *   foo: [snapshot(), valueSetter("foo")]
  * });
- * ...
+ *
  * // trigger event
  * bus.dispatch(["foo", 23]);
  *
  * // pass history instance via interceptor context to handlers
  * bus.processQueue({ history });
+ *
+ * // show updated state
+ * console.log(state.deref());
+ *
+ * // trigger & process built-in undo event
+ * bus.dispatch([EV_UNDO]);
+ * bus.processQueue({ history });
+ *
+ * // show restored state
+ * console.log(state.deref());
  * ```
  *
  * @param id -

package/interceptors.js

@@ -20,11 +20,11 @@ const ensurePred = (pred, err) => (state, e, bus, ctx) => !pred(state, e, bus, c
   [FX_CANCEL]: true,
   ...err ? err(state, e, bus, ctx) : null
 } : void 0;
-const eventPathState = (state, path, e) => getInUnsafe(state, path ? path(e) : e[1]);
-const ensureStateLessThan = (max, path, err) => ensurePred((state, e) => eventPathState(state, path, e) < max, err);
-const ensureStateGreaterThan = (min, path, err) => ensurePred((state, e) => eventPathState(state, path, e) > min, err);
+const __eventPathState = (state, path, e) => getInUnsafe(state, path ? path(e) : e[1]);
+const ensureStateLessThan = (max, path, err) => ensurePred((state, e) => __eventPathState(state, path, e) < max, err);
+const ensureStateGreaterThan = (min, path, err) => ensurePred((state, e) => __eventPathState(state, path, e) > min, err);
 const ensureStateRange = (min, max, path, err) => ensurePred((state, e) => {
-  const x = eventPathState(state, path, e);
+  const x = __eventPathState(state, path, e);
   return x >= min && x <= max;
 }, err);
 const ensureParamRange = (min, max, value, err) => ensurePred((_, e) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/interceptors",
-  "version": "3.2.57",
+  "version": "3.2.59",
   "description": "Interceptor based event bus, side effect & immutable state handling",
   "type": "module",
   "module": "./index.js",
@@ -10,7 +10,7 @@
     "type": "git",
     "url": "https://github.com/thi-ng/umbrella.git"
   },
-  "homepage": "https://github.com/thi-ng/umbrella/tree/develop/packages/interceptors#readme",
+  "homepage": "https://thi.ng/interceptors",
   "funding": [
     {
       "type": "github",
@@ -39,18 +39,18 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.1",
-    "@thi.ng/atom": "^5.2.45",
-    "@thi.ng/checks": "^3.6.3",
-    "@thi.ng/errors": "^2.5.6",
-    "@thi.ng/logger": "^3.0.11",
-    "@thi.ng/paths": "^5.1.80"
+    "@thi.ng/api": "^8.11.3",
+    "@thi.ng/atom": "^5.3.1",
+    "@thi.ng/checks": "^3.6.5",
+    "@thi.ng/errors": "^2.5.8",
+    "@thi.ng/logger": "^3.0.13",
+    "@thi.ng/paths": "^5.1.82"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.43.0",
-    "esbuild": "^0.20.2",
-    "typedoc": "^0.25.12",
-    "typescript": "^5.4.3"
+    "@microsoft/api-extractor": "^7.47.0",
+    "esbuild": "^0.21.5",
+    "typedoc": "^0.25.13",
+    "typescript": "^5.5.2"
   },
   "keywords": [
     "async",
@@ -95,5 +95,5 @@
     "status": "completed",
     "year": 2016
   },
-  "gitHead": "5dd66c18a3862a3af69a5b2f49563f7cbdd960c2\n"
+  "gitHead": "154c95cf9d6bab32174498ec3b5b5d87e42be7f9\n"
 }