@alwatr/action 9.25.0 → 9.27.0

package/dist/delegate.d.ts

@@ -1,126 +0,0 @@
-/**
- * @file delegate.ts
- *
- * Global Event Delegation engine for `@alwatr/action`.
- *
- * ## Why delegation instead of per-element listeners?
- *
- * The classic directive approach attaches one `addEventListener` per element.
- * With 100 buttons on a page, that means 100 listener registrations at boot
- * time — O(N) initialization cost, O(N) memory for listener references, and
- * zero support for elements added after bootstrap.
- *
- * This module implements the global delegation pattern:
- * - A single listener per event type is attached to `document.body` with
- *   `capture: true` (so it fires even for non-bubbling events).
- * - When an event fires, the handler walks up the DOM from `event.target`
- *   using `closest()` to find the nearest element with an `on-<eventType>`
- *   attribute (e.g. `on-click`, `on-submit`).
- * - The nearest `[action-context]` ancestor is also resolved and attached to
- *   the `Action` object as `context` — enabling the same action type to be
- *   scoped to different UI regions.
- * - Modifiers run with access to the mutable `Action` object so they can
- *   enrich `meta` before the action reaches subscribers.
- * - `dispatchAction` is called with the fully assembled `Action` object.
- *
- * ## Complexity
- *
- * | Metric          | Per-element listeners | Global delegation |
- * | --------------- | --------------------- | ----------------- |
- * | Boot time       | O(N elements)         | O(1) — 1 loop     |
- * | Memory          | O(N listeners)        | O(1) — 1 handler  |
- * | Dynamic content | Requires re-bootstrap | Works out-of-box  |
- * | `once` modifier | Native option         | Manual tracking   |
- *
- * ## Trade-offs vs. the directive approach
- *
- * - `passive` is not supported as a per-element option (all delegated listeners
- *   are non-passive so that `prevent` can call `preventDefault()`).
- * - `stop` stops further bubbling but the delegation handler has already
- *   captured the event at `body` level — it does not prevent other delegation
- *   handlers from running on the same element.
- * - `once` is emulated by removing the attribute after first fire.
- */
-/**
- * Default DOM event types that cover the vast majority of interactive elements.
- *
- * - `click` — buttons, links, checkboxes, custom interactive elements
- * - `submit` — form submission
- * - `input` — live text input, range sliders
- * - `change` — select boxes, checkboxes, radio buttons (fires on commit)
- *
- * Pass additional types to `setupActionDelegation` when your app uses other
- * events (e.g. `'keydown'`, `'pointerup'`).
- */
-export declare const DEFAULT_DELEGATED_EVENTS: readonly string[];
-/**
- * Registers global event delegation for `on-<eventType>` attributes.
- *
- * Attaches a single `capture`-phase listener on `document.body` for each
- * event type in `eventTypes`. All processing — context resolution, modifier
- * execution, payload resolution, and `dispatchAction` — happens inside that
- * one handler.
- *
- * **Call this once at application bootstrap**, before any user interaction.
- * Subsequent calls with the same event types are no-ops (idempotent).
- *
- * ### Why `capture: true`?
- *
- * Capture-phase listeners fire before bubble-phase listeners and also catch
- * events that do not bubble (e.g. `focus`, `blur`). This ensures the delegation
- * handler always runs, even when a child element calls `stopPropagation()`.
- *
- * ### Dynamic content
- *
- * Because the listener lives on `document.body`, any element added to the DOM
- * after this call — via `innerHTML`, `lit-html`, a framework renderer, or
- * server-sent HTML — is automatically covered. No re-bootstrap is needed.
- *
- * ### Context scoping
- *
- * Wrap a group of elements in a `[action-context]` container to scope their
- * actions. The delegation handler automatically resolves the nearest ancestor
- * and attaches its value to `action.context`:
- *
- * ```html
- * <section action-context="product-list">
- *   <button on-click="ui_add_to_cart:42">Add</button>
- * </section>
- * ```
- *
- * ```ts
- * onAction('ui_add_to_cart', (action) => {
- *   console.log(action.context); // 'product-list'
- * });
- * ```
- *
- * @param eventTypes - Event types to delegate. Defaults to `DEFAULT_DELEGATED_EVENTS`.
- *
- * @example — minimal bootstrap
- * ```ts
- * import {setupActionDelegation, onAction} from '@alwatr/action';
- *
- * // One call activates the entire page.
- * setupActionDelegation();
- *
- * onAction('ui_open_drawer', (action) => openDrawer(action.payload));
- * ```
- *
- * @example — with extra event types
- * ```ts
- * import {setupActionDelegation, DEFAULT_DELEGATED_EVENTS} from '@alwatr/action';
- *
- * setupActionDelegation([...DEFAULT_DELEGATED_EVENTS, 'keydown', 'pointerup']);
- * ```
- */
-export declare function setupActionDelegation(eventTypes?: readonly string[]): void;
-/**
- * Removes all global delegation listeners registered by `setupActionDelegation`.
- *
- * Useful in test environments where each test needs a clean slate, or in
- * micro-frontend setups where a sub-app is unmounted.
- *
- * After calling this, `setupActionDelegation` can be called again to re-register.
- */
-export declare function teardownActionDelegation(): void;
-//# sourceMappingURL=delegate.d.ts.map

package/dist/delegate.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"delegate.d.ts","sourceRoot":"","sources":["../src/delegate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AAyNH;;;;;;;;;;GAUG;AACH,eAAO,MAAM,wBAAwB,EAAE,SAAS,MAAM,EAA2C,CAAC;AAElG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,GAAE,SAAS,MAAM,EAA6B,GAAG,IAAI,CASpG;AAED;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,IAAI,IAAI,CAO/C"}

package/dist/lib_.d.ts

@@ -1,24 +0,0 @@
-import type { Action } from './type.js';
-/**
- * Module-scoped logger for `@alwatr/action`.
- * Scoped to `'alwatr-action'` so log lines are easy to filter in the console.
- *
- * @internal
- */
-export declare const logger_: import("@alwatr/logger").AlwatrLogger;
-/**
- * The internal action channel — a `ChannelSignal` keyed by action `type`.
- *
- * Each message on this channel is a full `Action` object (AFSA), not just a
- * raw payload. Subscribers registered via `onAction('foo', handler)` receive
- * the entire `Action<'foo'>` so they have access to `context`, `meta`, and
- * `payload` in one place.
- *
- * Uses `ChannelSignal` for O(1) routing: dispatching action `'A'` performs a
- * single `Map.get('A')` lookup and invokes only the handlers registered for
- * that specific type — never handlers for `'B'`, `'C'`, etc.
- *
- * @internal — not part of the public API; use `onAction` / `dispatchAction` instead.
- */
-export declare const internalChannel_: import("@alwatr/signal").ChannelSignal<Record<string, Action<never>>>;
-//# sourceMappingURL=lib_.d.ts.map

package/dist/lib_.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"lib_.d.ts","sourceRoot":"","sources":["../src/lib_.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,WAAW,CAAC;AAEtC;;;;;GAKG;AACH,eAAO,MAAM,OAAO,uCAAgC,CAAC;AAErD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,gBAAgB,uEAAuE,CAAC"}

package/dist/method.d.ts

@@ -1,169 +0,0 @@
-import type { Awaitable } from '@alwatr/type-helper';
-import type { SubscribeResult } from '@alwatr/signal';
-import type { Action, ActionRecord, DispatchParam, ModifierHandler, PayloadResolver } from './type.js';
-/**
- * Subscribes to a named action dispatched anywhere in the application.
- *
- * `type` must be a key of `ActionRecord`. The handler receives the full
- * `Action<K>` object — giving access to `payload`, `context`, and `meta`
- * in one place. No manual generic annotation is needed; the compiler infers
- * the correct `payload` type from `ActionRecord`:
- *
- * ```ts
- * // ActionRecord declares: 'ui_add_to_cart': {productId: number; qty: number}
- * onAction('ui_add_to_cart', (action) => {
- *   cartService.add(action.payload.productId, action.payload.qty); // fully typed
- *   console.log(action.context); // e.g. 'product-list' (from DOM) or undefined
- * });
- * ```
- *
- * Passing an action name not declared in `ActionRecord` is a **compile error**.
- * Register new actions by extending `ActionRecord` via declaration merging:
- *
- * ```ts
- * // src/action-record.ts
- * declare module '@alwatr/action' {
- *   interface ActionRecord {
- *     'ui_open_drawer': string;
- *   }
- * }
- * ```
- *
- * Internally delegates to `ChannelSignal.on()` for **O(1) routing** — dispatching
- * action `'A'` never invokes handlers registered for action `'B'`.
- *
- * @param type    - A key of `ActionRecord`.
- * @param handler - Callback invoked with the full `Action<K>` on each dispatch.
- * @returns A `SubscribeResult` with an `unsubscribe()` method for cleanup.
- *
- * @example
- * ```ts
- * import {onAction} from '@alwatr/action';
- *
- * const sub = onAction('ui_page_ready', (action) => {
- *   router.setPage(action.payload); // payload: string — inferred from ActionRecord
- * });
- *
- * sub.unsubscribe(); // stop listening when no longer needed
- * ```
- */
-export declare function onAction<K extends keyof ActionRecord>(type: K | K[], handler: (action: Action<K>) => Awaitable<void>): SubscribeResult;
-/**
- * Dispatches an action to all `onAction` subscribers with a matching `type`.
- *
- * Accepts a full `Action<K>` object. The `payload` field is automatically
- * typed from `ActionRecord[K]` — passing the wrong shape is a **compile error**:
- *
- * ```ts
- * // ActionRecord declares: 'ui_add_to_cart': {productId: number; qty: number}
- * dispatchAction({type: 'ui_add_to_cart', payload: {productId: 42, qty: 1}}); // ✅
- * dispatchAction({type: 'ui_add_to_cart', payload: 'wrong'});                  // ❌ compile error
- * dispatchAction({type: 'unknown_action', payload: 'x'});                   // ❌ compile error
- * ```
- *
- * The `context` and `meta` fields are optional. When dispatching from code
- * (not from the DOM), omit `context` — it is only meaningful for DOM-originated
- * actions where an `[action-context]` ancestor exists.
- *
- * Use `dispatchAction` when triggering an action from code — e.g. after an
- * async operation, from a service layer, or in tests. For DOM-driven actions,
- * use the `on-<eventType>` HTML attribute with `setupActionDelegation`.
- *
- * @param action - A full `Action<K>` object with at minimum `type` and `payload`.
- *
- * @example — with payload (code-originated action — no 'ui_' prefix)
- * ```ts
- * import {dispatchAction} from '@alwatr/action';
- *
- * dispatchAction({type: 'navigate', payload: '/dashboard'});
- * dispatchAction({type: 'upload_complete', payload: fileId});
- * ```
- *
- * @example — void payload (payload field is optional and can be omitted entirely)
- * ```ts
- * dispatchAction({type: 'auth_expired'});
- * // or explicitly:
- * dispatchAction({type: 'auth_expired', payload: undefined});
- * ```
- *
- * @example — with context and meta
- * ```ts
- * dispatchAction({
- *   type: 'slider_change',
- *   payload: 75,
- *   context: 'volume_slider',
- *   meta: {traceId: 'abc-123'},
- * });
- * ```
- */
-export declare function dispatchAction<K extends keyof ActionRecord>(action: DispatchParam<K>): void;
-/**
- * Registers a custom modifier that can be used in `on-<eventType>` attribute syntax.
- *
- * A modifier is a comma-separated token placed after the `;` separator
- * (e.g. `on-click="action-id; mymod"`). Its handler runs before the payload is
- * resolved and the action is dispatched. Returning `false` cancels the dispatch.
- *
- * The handler also receives the **mutable** `action` object being built, so it
- * can attach data to `action.meta` before the action reaches subscribers.
- *
- * Built-in modifiers (`prevent`, `validate`, `once`) are always available.
- * This function lets you add domain-specific ones.
- *
- * Registering the same name twice logs an accident and overwrites the previous
- * handler — avoid duplicate registrations in production code.
- *
- * @param name    - The modifier token (lowercase, no special characters).
- * @param handler - A `ModifierHandler` receiving `(event, element, action)`.
- *
- * @example — a `confirm` modifier that shows a browser dialog
- * ```ts
- * import {registerModifier} from '@alwatr/action';
- *
- * registerModifier('confirm', () => window.confirm('Are you sure?'));
- * ```
- * ```html
- * <button on-click="ui_delete_item:42; confirm">Delete</button>
- * ```
- *
- * @example — a `trace` modifier that stamps a trace ID into meta
- * ```ts
- * registerModifier('trace', (_event, _element, action) => {
- *   action.meta ??= {};
- *   action.meta['traceId'] = crypto.randomUUID();
- *   return true;
- * });
- * ```
- */
-export declare function registerModifier(name: string, handler: ModifierHandler): void;
-/**
- * Registers a custom payload resolver that can be used in `on-<eventType>` attribute syntax.
- *
- * A payload resolver is a colon-prefixed token in the attribute value
- * (e.g. `on-click="action-id:$mytoken"`). Its function is called at dispatch time
- * with the DOM event and the element. The return value becomes the `payload`
- * field of the `Action` object passed to `onAction` subscribers.
- *
- * Built-in resolvers (`$value`, `$formdata`, `$checked`) are always available.
- * This function lets you add domain-specific ones.
- *
- * Registering the same name twice logs an accident and overwrites the previous
- * resolver — avoid duplicate registrations in production code.
- *
- * @param name     - The resolver token (should start with `$` by convention).
- * @param resolver - A `PayloadResolver` receiving `(event, element)`.
- *
- * @example — a `$data-id` resolver that reads a data attribute
- * ```ts
- * import {registerPayloadResolver} from '@alwatr/action';
- *
- * registerPayloadResolver('$data-id', (_event, element) => {
- *   return (element as HTMLElement).dataset.id ?? null;
- * });
- * ```
- * ```html
- * <button on-click="ui_select_item:$data-id" data-id="42">Select</button>
- * ```
- */
-export declare function registerPayloadResolver(name: string, resolver: PayloadResolver): void;
-//# sourceMappingURL=method.d.ts.map

package/dist/method.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"method.d.ts","sourceRoot":"","sources":["../src/method.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAW,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,gBAAgB,CAAC;AAIpD,OAAO,KAAK,EAAC,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,eAAe,EAAC,MAAM,WAAW,CAAC;AAIrG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,MAAM,YAAY,EACnD,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,EACb,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,IAAI,CAAC,GAC9C,eAAe,CAsBjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,YAAY,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI,CAG3F;AAID;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,GAAG,IAAI,CAM7E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,GAAG,IAAI,CAMrF"}

package/dist/registry_.d.ts

@@ -1,24 +0,0 @@
-import type { ModifierHandler, PayloadResolver } from './type.js';
-/**
- * Registry of all named modifier handlers.
- *
- * Keys are modifier names used in the `on-<eventType>` attribute syntax
- * (e.g. `on-click="action-id; prevent"`). Values are `ModifierHandler` functions.
- * Populated at module load with built-in modifiers; extended at runtime via
- * `registerModifier`.
- *
- * @internal
- */
-export declare const modifierRegistry: Map<string, ModifierHandler>;
-/**
- * Registry of all named payload resolvers.
- *
- * Keys are resolver tokens used in the `on-<eventType>` attribute syntax
- * (e.g. `on-input="ui_search_query:$value"`). Values are `PayloadResolver` functions.
- * Populated at module load with built-in resolvers; extended at runtime via
- * `registerPayloadResolver`.
- *
- * @internal
- */
-export declare const payloadRegistry: Map<string, PayloadResolver>;
-//# sourceMappingURL=registry_.d.ts.map

package/dist/registry_.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"registry_.d.ts","sourceRoot":"","sources":["../src/registry_.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,eAAe,EAAE,eAAe,EAAC,MAAM,WAAW,CAAC;AAEhE;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB,8BAAqC,CAAC;AAEnE;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,8BAAqC,CAAC"}