@thi.ng/interceptors 3.2.27 → 3.2.29

package/interceptors.js

@@ -1,226 +1,55 @@
 import { getInUnsafe } from "@thi.ng/paths/get-in";
 import { defSetterUnsafe } from "@thi.ng/paths/setter";
 import { defUpdaterUnsafe } from "@thi.ng/paths/updater";
-import { FX_CANCEL, FX_DISPATCH, FX_DISPATCH_NOW, FX_STATE, } from "./api.js";
-/**
- * Debug interceptor to log the current event to the console.
- */
-export const trace = (_, e) => console.log("event:", e);
-/**
- * Higher-order interceptor. Returns interceptor which unpacks payload
- * from event and assigns it as is to given side effect ID. Assigns
- * `true` to side effect if event has no payload.
- *
- * @param fxID - side effect ID
- */
-export const forwardSideFx = (fxID) => (_, [__, body]) => ({ [fxID]: body !== undefined ? body : true });
-/**
- * Higher-order interceptor. Returns interceptor which assigns given
- * event to `FX_DISPATCH` side effect.
- *
- * @param event -
- */
-export const dispatch = (event) => () => ({
-    [FX_DISPATCH]: event,
+import {
+  FX_CANCEL,
+  FX_DISPATCH,
+  FX_DISPATCH_NOW,
+  FX_STATE
+} from "./api.js";
+const trace = (_, e) => console.log("event:", e);
+const forwardSideFx = (fxID) => (_, [__, body]) => ({ [fxID]: body !== void 0 ? body : true });
+const dispatch = (event) => () => ({
+  [FX_DISPATCH]: event
 });
-/**
- * Higher-order interceptor. Returns interceptor which assigns given
- * event to `FX_DISPATCH_NOW` side effect.
- *
- * @param event -
- */
-export const dispatchNow = (event) => () => ({
-    [FX_DISPATCH_NOW]: event,
+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
- * [`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:
- *
- * @example
- * ```ts
- * state = new Atom({});
- * history = new History(state);
- * 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")]
- * });
- * ...
- * // trigger event
- * bus.dispatch(["foo", 23]);
- *
- * // pass history instance via interceptor context to handlers
- * bus.processQueue({ history });
- * ```
- *
- * @param id -
- */
-export const snapshot = (id = "history") => (_, __, ___, ctx) => ctx[id].record();
-/**
- * Higher-order interceptor for validation purposes. Takes a predicate
- * function and an optional interceptor function, which will only be
- * called if the predicate fails for a given event. By default the
- * `FX_CANCEL` side effect is triggered if the predicate failed, thus
- * ensuring the actual event handler for the failed event will not be
- * executed anymore. However, this can be overridden using the error
- * interceptor's result, which is merged into the result of this
- * interceptor.
- *
- * The error interceptor can return any number of other side effects and
- * so be used to dispatch alternative events instead, for example:
- *
- * ```
- * // this interceptor will cause cancellation of current event
- * // and trigger an "error" event instead
- * ensurePred(
- *   // a dummy predicate which always fails
- *   () => false
- *   // error interceptor fn
- *   () => ({[FX_DISPATCH_NOW]: ["error", "reason"]})
- * )
- * ```
- *
- * Note: For this interceptor to work as expected, it needs to be
- * provided BEFORE the main handler in the interceptor list for a given
- * event, i.e.
- *
- * ```
- * [
- *    ensurePred((state, e) => false),
- *    // actual event handler
- *    (state, e) => console.log("no one never calls me")
- * ]
- * ```
- *
- * @param pred - predicate applied to given state & event
- * @param err - interceptor triggered on predicate failure
- */
-export const ensurePred = (pred, err) => (state, e, bus, ctx) => !pred(state, e, bus, ctx)
-    ? {
-        [FX_CANCEL]: true,
-        ...(err ? err(state, e, bus, ctx) : null),
-    }
-    : undefined;
+const snapshot = (id = "history") => (_, __, ___, ctx) => ctx[id].record();
+const ensurePred = (pred, err) => (state, e, bus, ctx) => !pred(state, e, bus, ctx) ? {
+  [FX_CANCEL]: true,
+  ...err ? err(state, e, bus, ctx) : null
+} : void 0;
 const eventPathState = (state, path, e) => getInUnsafe(state, path ? path(e) : e[1]);
-/**
- * Specialization of {@link ensurePred} to ensure a state value is less than
- * given max at the time when the event is being processed. The optional
- * `path` fn is used to extract or produce the path for the state value
- * to be validated. If omitted, the event's payload item is interpreted
- * as the value path.
- *
- * For example, without a provided `path` function and for an event of
- * this form: `["event-id", "foo.bar"]`, the term `"foo.bar"` would be
- * interpreted as path.
- *
- * If the event has this shape: `["event-id", ["foo.bar", 23]]`, we must
- * provide `(e) => e[1][0]` as path function to extract `"foo.bar"` from
- * the event.
- *
- * @param max -
- * @param path - path extractor
- * @param err - error interceptor
- */
-export const ensureStateLessThan = (max, path, err) => ensurePred((state, e) => eventPathState(state, path, e) < max, err);
-/**
- * Specialization of {@link ensurePred} to ensure a state value is greater
- * than given min. See {@link ensureStateLessThan} for further details.
- *
- * @param min -
- * @param path - path extractor
- * @param err - error interceptor
- */
-export const ensureStateGreaterThan = (min, path, err) => ensurePred((state, e) => eventPathState(state, path, e) > min, err);
-/**
- * Specialization of {@link ensurePred} to ensure a state value is within
- * given `min` / `max` closed interval. See {@link ensureStateLessThan} for
- * further details.
- *
- * @param min -
- * @param max -
- * @param path - path extractor
- * @param err - error interceptor
- */
-export const ensureStateRange = (min, max, path, err) => ensurePred((state, e) => {
-    const x = eventPathState(state, path, e);
-    return x >= min && x <= max;
+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);
+  return x >= min && x <= max;
 }, err);
-/**
- * Specialization of {@link ensurePred} to ensure an event's payload value
- * is within given `min` / `max` closed interval. By default, assumes
- * event format like: `[event-id, value]`. However if `value` is given,
- * the provided function can be used to extract the value to be
- * validated from any event. If the value is outside the given interval,
- * triggers `FX_CANCEL` side effect and if `err` is given, the error
- * interceptor can return any number of other side effects and so be
- * used to dispatch alternative events instead.
- *
- * @param min -
- * @param max -
- * @param value - event value extractor
- * @param err - error interceptor
- */
-export const ensureParamRange = (min, max, value, err) => ensurePred((_, e) => {
-    const x = value ? value(e) : e[1];
-    return x >= min && x <= max;
+const ensureParamRange = (min, max, value, err) => ensurePred((_, e) => {
+  const x = value ? value(e) : e[1];
+  return x >= min && x <= max;
 }, err);
-/**
- * Higher-order interceptor. Returns new interceptor to set state value
- * at provided path. This allows for dedicated events to set state
- * values more concisely, e.g. given this event definition:
- *
- * @example
- * ```ts
- * setFoo: valueSetter("foo.bar")
- * ```
- *
- * ...the `setFoo` event then can be triggered like so to update the
- * state value at `foo.bar`:
- *
- * @example
- * ```ts
- * bus.dispatch(["setFoo", 23])
- * ```
- *
- * @param path -
- * @param tx -
- */
-export const valueSetter = (path, tx) => {
-    const $ = defSetterUnsafe(path);
-    return (state, [_, val]) => ({ [FX_STATE]: $(state, tx ? tx(val) : val) });
+const valueSetter = (path, tx) => {
+  const $ = defSetterUnsafe(path);
+  return (state, [_, val]) => ({ [FX_STATE]: $(state, tx ? tx(val) : val) });
 };
-/**
- * Higher-order interceptor. Returns new interceptor to update state
- * value at provided path with given function. This allows for dedicated
- * events to update state values more concisely, e.g. given this event
- * definition:
- *
- * @example
- * ```ts
- * incFoo: valueUpdater("foo.bar", (x, y) => x + y)
- * ```
- *
- * ...the `incFoo` event then can be triggered like so to update the
- * state value at `foo.bar` (where `1` is the extra arg provided to the
- * update fn:
- *
- * @example
- * ```ts
- * bus.dispatch(["incFoo", 1]) // results in value = value + 1
- * ```
- *
- * @param path -
- * @param fn -
- */
-export const valueUpdater = (path, fn) => {
-    const $ = defUpdaterUnsafe(path, fn);
-    return (state, [_, ...args]) => ({ [FX_STATE]: $(state, ...args) });
+const valueUpdater = (path, fn) => {
+  const $ = defUpdaterUnsafe(path, fn);
+  return (state, [_, ...args]) => ({ [FX_STATE]: $(state, ...args) });
+};
+export {
+  dispatch,
+  dispatchNow,
+  ensureParamRange,
+  ensurePred,
+  ensureStateGreaterThan,
+  ensureStateLessThan,
+  ensureStateRange,
+  forwardSideFx,
+  snapshot,
+  trace,
+  valueSetter,
+  valueUpdater
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/interceptors",
-  "version": "3.2.27",
+  "version": "3.2.29",
   "description": "Interceptor based event bus, side effect & immutable state handling",
   "type": "module",
   "module": "./index.js",
@@ -27,7 +27,9 @@
   ],
   "license": "Apache-2.0",
   "scripts": {
-    "build": "yarn clean && tsc --declaration",
+    "build": "yarn build:esbuild && yarn build:decl",
+    "build:decl": "tsc --declaration --emitDeclarationOnly",
+    "build:esbuild": "esbuild --format=esm --platform=neutral --target=es2022 --tsconfig=tsconfig.json --outdir=. src/**/*.ts",
     "clean": "rimraf --glob '*.js' '*.d.ts' '*.map' doc",
     "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
     "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
@@ -36,16 +38,16 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.10",
-    "@thi.ng/atom": "^5.2.16",
-    "@thi.ng/checks": "^3.4.10",
-    "@thi.ng/errors": "^2.4.4",
-    "@thi.ng/logger": "^2.0.1",
-    "@thi.ng/paths": "^5.1.51"
+    "@thi.ng/api": "^8.9.12",
+    "@thi.ng/atom": "^5.2.18",
+    "@thi.ng/checks": "^3.4.12",
+    "@thi.ng/errors": "^2.4.6",
+    "@thi.ng/logger": "^2.0.2",
+    "@thi.ng/paths": "^5.1.53"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.38.3",
-    "@thi.ng/testament": "^0.4.3",
+    "esbuild": "^0.19.8",
     "rimraf": "^5.0.5",
     "tools": "^0.0.1",
     "typedoc": "^0.25.4",
@@ -93,5 +95,5 @@
     "status": "completed",
     "year": 2016
   },
-  "gitHead": "04d1de79f256d7a53c6b5fd157b37f49bc88e11d\n"
+  "gitHead": "5e7bafedfc3d53bc131469a28de31dd8e5b4a3ff\n"
 }