@dereekb/dbx-core 13.9.0 → 13.10.1

package/types/dereekb-dbx-core.d.ts

@@ -112,38 +112,61 @@ type DbxActionWorkOrWorkProgress = boolean | DbxActionWorkProgress;
 declare function dbxActionWorkProgress(workOrWorkProgress: Maybe<DbxActionWorkOrWorkProgress>[], progressPercent?: Maybe<DbxActionWorkProgress>): number | boolean;
 /**
  * Used by ActionContextState to denote what state the action is in.
+ *
+ * @dbxActionStateEnum
  */
 declare enum DbxActionState {
     /**
      * No action in progress. Waiting for the trigger.
+     *
+     * @dbxActionStateTransitionsFrom RESOLVED, REJECTED, DISABLED
+     * @dbxActionStateTransitionsTo TRIGGERED, DISABLED
      */
     IDLE = "idle",
     /**
      * Idle state that can be set to show that the source is not yet ready.
+     *
+     * @dbxActionStateTransitionsFrom IDLE, RESOLVED, REJECTED
+     * @dbxActionStateTransitionsTo IDLE
      */
     DISABLED = "disabled",
     /**
      * The action was triggered. We wait (and allow) the value to be updated.
+     *
+     * @dbxActionStateTransitionsFrom IDLE
+     * @dbxActionStateTransitionsTo VALUE_READY
      */
     TRIGGERED = "triggered",
     /**
      * The trigger was accepted and the value is updated. It should begin working immediately.
      *
      * ValueReady cannot be set until triggered is set.
+     *
+     * @dbxActionStateTransitionsFrom TRIGGERED
+     * @dbxActionStateTransitionsTo WORKING
      */
     VALUE_READY = "valueReady",
     /**
      * The action is in progress.
+     *
+     * @dbxActionStateTransitionsFrom VALUE_READY
+     * @dbxActionStateTransitionsTo RESOLVED, REJECTED
      */
     WORKING = "working",
     /**
      * The trigger, action, or value was rejected due to an error or other issue.
      *
      * An error may be specified optionally.
+     *
+     * @dbxActionStateTransitionsFrom WORKING
+     * @dbxActionStateTransitionsTo IDLE, DISABLED
      */
     REJECTED = "rejected",
     /**
      * The action resolved without issue.
+     *
+     * @dbxActionStateTransitionsFrom WORKING
+     * @dbxActionStateTransitionsTo IDLE, DISABLED
      */
     RESOLVED = "resolved"
 }
@@ -378,6 +401,13 @@ declare const ACTION_CONTEXT_STORE_LOCKSET_DESTROY_DELAY_TIME = 2000;
  * IDLE/DISABLED -> TRIGGERED -> VALUE_READY -> WORKING -> RESOLVED | REJECTED
  * ```
  *
+ * @dbxAction
+ * @dbxActionSlug action-context-store
+ * @dbxActionRole store
+ * @dbxActionDisabledKey dbx_action_disabled
+ * @dbxActionDisabledKey dbx_action_enforce_modified
+ * @dbxActionSkillRefs dbx__ref__dbx-component-patterns
+ *
  * @typeParam T - The input value type provided after triggering.
  * @typeParam O - The output result type produced on resolution.
  *
@@ -700,6 +730,11 @@ declare class DbxActionContextStoreSourceInstance<T = unknown, O = unknown> impl
  *
  * Can be disabled by setting `dbxActionAutoModify` to `false`.
  *
+ * @dbxAction
+ * @dbxActionSlug auto-modify
+ * @dbxActionStateInteraction IDLE
+ * @dbxActionConsumesContext
+ *
  * @example
  * ```html
  * <div dbxAction>
@@ -732,6 +767,11 @@ declare class DbxActionAutoModifyDirective<T, O> {
  * Useful for auto-save scenarios where data changes should automatically submit without
  * requiring an explicit user action. Use with care to avoid triggering loops.
  *
+ * @dbxAction
+ * @dbxActionSlug auto-trigger
+ * @dbxActionStateInteraction IDLE, TRIGGERED
+ * @dbxActionConsumesContext
+ *
  * @example
  * ```html
  * <div dbxAction>
@@ -840,6 +880,11 @@ declare abstract class DbxActionContextBaseSource<T = unknown, O = unknown> impl
  * On destruction, the directive coordinates cleanup through a {@link LockSet} to ensure
  * in-flight operations complete before the store is torn down.
  *
+ * @dbxAction
+ * @dbxActionSlug action
+ * @dbxActionStateInteraction IDLE
+ * @dbxActionProducesContext
+ *
  * @example
  * ```html
  * <div dbxAction>
@@ -877,6 +922,9 @@ declare class DbxActionDirective<T = unknown, O = unknown> extends DbxActionCont
  * This is useful when an action context is created programmatically (e.g., via
  * {@link DbxActionContextMachine}) and needs to be shared with template-based directives.
  *
+ * @dbxAction
+ * @dbxActionSlug source
+ *
  * @example
  * ```html
  * <!-- Forward a programmatic action source to template directives -->
@@ -903,6 +951,11 @@ declare class DbxActionSourceDirective implements SecondaryActionContextStoreSou
  * Subscribes to the parent action's full state stream and prints each state snapshot
  * via `console.log`. Useful during development to inspect the action lifecycle transitions.
  *
+ * @dbxAction
+ * @dbxActionSlug logger
+ * @dbxActionStateInteraction IDLE, TRIGGERED, VALUE_READY, WORKING, RESOLVED, REJECTED, DISABLED
+ * @dbxActionConsumesContext
+ *
  * @example
  * ```html
  * <div dbxAction>
@@ -982,6 +1035,9 @@ declare function actionContextStoreSourceMap<T = unknown, O = unknown>(): Action
  *
  * The map is exported as `actionMap` for template reference access.
  *
+ * @dbxAction
+ * @dbxActionSlug context-map
+ *
  * @example
  * ```html
  * <div dbxActionContextMap>
@@ -1169,6 +1225,11 @@ declare const APP_ACTION_DISABLED_DIRECTIVE_KEY = "dbx_action_disabled";
  *
  * The disable key is automatically cleaned up on directive destruction.
  *
+ * @dbxAction
+ * @dbxActionSlug disabled
+ * @dbxActionStateInteraction DISABLED
+ * @dbxActionConsumesContext
+ *
  * @example
  * ```html
  * <div dbxAction>
@@ -1207,6 +1268,11 @@ declare const APP_ACTION_DISABLED_ON_SUCCESS_DIRECTIVE_KEY = "dbx_action_disable
  *
  * The disable key is automatically cleaned up on directive destruction.
  *
+ * @dbxAction
+ * @dbxActionSlug disabled-on-success
+ * @dbxActionStateInteraction RESOLVED, DISABLED
+ * @dbxActionConsumesContext
+ *
  * @example
  * ```html
  * <div dbxAction>
@@ -1298,6 +1364,12 @@ declare abstract class AbstractDbxActionHandlerDirective<T = unknown, O = unknow
  * called with the value and a work context. The work function is responsible for performing
  * the async operation and signaling success or failure through the context.
  *
+ * @dbxAction
+ * @dbxActionSlug handler
+ * @dbxActionStateInteraction VALUE_READY, WORKING, RESOLVED, REJECTED
+ * @dbxActionConsumesContext
+ * @dbxActionSkillRefs dbx__ref__dbx-component-patterns, dbx__guide__action-analytics
+ *
  * @example
  * ```html
  * <div dbxAction>
@@ -1324,6 +1396,11 @@ declare class DbxActionHandlerDirective<T = unknown, O = unknown> extends Abstra
  * The provided value (or the result of calling the getter/factory) is used directly as the
  * action's result, with the working/success lifecycle handled automatically.
  *
+ * @dbxAction
+ * @dbxActionSlug handler-value
+ * @dbxActionStateInteraction VALUE_READY, WORKING, RESOLVED
+ * @dbxActionConsumesContext
+ *
  * @example
  * ```html
  * <div dbxAction>
@@ -1525,6 +1602,11 @@ type DbxActionErrorHandlerFunction = (error?: Maybe<ReadableError>) => void;
  * This is useful for performing side effects like logging, showing error toasts, or
  * handling specific error conditions programmatically.
  *
+ * @dbxAction
+ * @dbxActionSlug error-handler
+ * @dbxActionStateInteraction REJECTED
+ * @dbxActionConsumesContext
+ *
  * @example
  * ```html
  * <div dbxAction>
@@ -1557,6 +1639,11 @@ declare class DbxActionErrorHandlerDirective<T, O> {
  * The input filters out null/undefined values, waiting until a non-null value is provided.
  * If you need to pass null/undefined as valid action values, use {@link DbxActionValueTriggerDirective} instead.
  *
+ * @dbxAction
+ * @dbxActionSlug value
+ * @dbxActionStateInteraction TRIGGERED, VALUE_READY
+ * @dbxActionConsumesContext
+ *
  * @example
  * ```html
  * <div dbxAction>
@@ -1641,6 +1728,11 @@ declare const APP_ACTION_ENFORCE_MODIFIED_DIRECTIVE_KEY = "dbx_action_enforce_mo
  *
  * The disable key is automatically cleaned up on directive destruction.
  *
+ * @dbxAction
+ * @dbxActionSlug enforce-modified
+ * @dbxActionStateInteraction IDLE, DISABLED
+ * @dbxActionConsumesContext
+ *
  * @example
  * ```html
  * <div dbxAction>
@@ -1790,6 +1882,11 @@ declare abstract class AbstractDbxActionValueGetterDirective<T> {
  * Supports optional `isModified` and `isEqual` functions to control whether the retrieved
  * value should proceed to `readyValue` or be rejected.
  *
+ * @dbxAction
+ * @dbxActionSlug value-getter
+ * @dbxActionStateInteraction TRIGGERED, VALUE_READY
+ * @dbxActionConsumesContext
+ *
  * @example
  * ```html
  * <div dbxAction>
@@ -2773,6 +2870,15 @@ declare namespace index_d$3 {
   export type { index_d$3_DbxAppContextFeatureState as DbxAppContextFeatureState, State$1 as State };
 }
 
+/**
+ * Type that contains the dbx-core contextual ngrx state information about an app's context.
+ *
+ * This is the "full state" of our DbxAppContext. It is the sum of the fromDbxContext.State interface.
+ *
+ * Sub-state types that need to be aware of this typeing may extend (via union) this type.
+ */
+type DbxAppContextFullState = State$1;
+
 /**
  * Action to set the current DbxAppContextState value.
  */
@@ -2795,21 +2901,16 @@ declare namespace data_action_d {
   };
 }
 
+/**
+ * Accessor for the DbxAppContextStateData in our DbxAppContextFeatureState.
+ */
+
 declare namespace index_d$2 {
   export {
     data_action_d as DbxAppContextActions,
   };
 }
 
-/**
- * Type that contains the dbx-core contextual ngrx state information about an app's context.
- *
- * This is the "full state" of our DbxAppContext. It is the sum of the fromDbxContext.State interface.
- *
- * Sub-state types that need to be aware of this typeing may extend (via union) this type.
- */
-type DbxAppContextFullState = State$1;
-
 /**
  * Service for dispatching and selecting the application's {@link DbxAppContextState} from the NgRx store.
  *
@@ -3033,6 +3134,18 @@ declare namespace index_d$1 {
   export type { index_d$1_DbxAppAuthFeatureState as DbxAppAuthFeatureState, index_d$1_State as State };
 }
 
+/**
+ * Top-level NgRx state interface that includes the dbx-core auth feature state.
+ *
+ * This type extends the root NgRx store state with the auth feature slice keyed by
+ * the `'app.auth'` feature key. Use this type when injecting the NgRx `Store` in services
+ * or effects that need access to the auth state selectors.
+ *
+ * @see {@link fromDbxAppAuth.DbxAppAuthFeatureState} for the shape of the auth feature slice.
+ * @see {@link DbxAppAuthStateService} for a convenience service wrapping store access.
+ */
+type DbxAppAuthFullState = State;
+
 /**
  * NgRx action dispatched when the user has successfully logged in.
  *
@@ -3146,6 +3259,10 @@ declare namespace user_action_d {
   };
 }
 
+/**
+ * Actions related to the auth state.
+ */
+
 declare namespace index_d {
   export {
     auth_action_d as DbxAppAuthActions,
@@ -3153,18 +3270,6 @@ declare namespace index_d {
   };
 }
 
-/**
- * Top-level NgRx state interface that includes the dbx-core auth feature state.
- *
- * This type extends the root NgRx store state with the auth feature slice keyed by
- * the `'app.auth'` feature key. Use this type when injecting the NgRx `Store` in services
- * or effects that need access to the auth state selectors.
- *
- * @see {@link fromDbxAppAuth.DbxAppAuthFeatureState} for the shape of the auth feature slice.
- * @see {@link DbxAppAuthStateService} for a convenience service wrapping store access.
- */
-type DbxAppAuthFullState = State;
-
 /**
  * Enum describing the type of a router transition event.
  *
@@ -5849,6 +5954,9 @@ declare class DbxRouteModelKeyDirective {
  * Useful for normalizing values that may be plain values, getter functions, or Observables
  * into a consistent Observable stream for use with the `async` pipe.
  *
+ * @dbxPipe
+ * @dbxPipeSlug as-observable
+ * @dbxPipeCategory async
  * @example
  * ```html
  * <span>{{ valueOrGetter | asObservable | async }}</span>
@@ -5865,6 +5973,10 @@ declare class AsObservablePipe implements PipeTransform {
  *
  * Displays only the date portion (no times). Returns a fallback string when the input is `null` or `undefined`.
  *
+ * @dbxPipe
+ * @dbxPipeSlug date-day-range
+ * @dbxPipeCategory date
+ * @dbxPipeRelated date-time-range, date-day-time-range
  * @example
  * ```html
  * <span>{{ dateRange | dateDayRange }}</span>
@@ -5885,6 +5997,10 @@ declare class DateDayRangePipe implements PipeTransform {
  *
  * Accepts an optional comparison date (defaults to now) and a fallback string for `null`/`undefined` input.
  *
+ * @dbxPipe
+ * @dbxPipeSlug date-distance
+ * @dbxPipeCategory date
+ * @dbxPipeRelated date-range-distance, date-format-distance, time-distance
  * @example
  * ```html
  * <span>{{ someDate | dateDistance }}</span>
@@ -5908,6 +6024,10 @@ declare class DateDistancePipe implements PipeTransform {
  *
  * Returns `undefined` if the input is falsy or not a valid date.
  *
+ * @dbxPipe
+ * @dbxPipeSlug date-format-distance
+ * @dbxPipeCategory date
+ * @dbxPipeRelated date-distance, date-format-from-to
  * @example
  * ```html
  * <span>{{ someDate | dateFormatDistance:'MMM d, y' }}</span>
@@ -5930,6 +6050,10 @@ declare class DateFormatDistancePipe implements PipeTransform {
  * The start date is formatted using the Angular locale-aware {@link formatDate}, and the end time
  * is computed by adding the given minutes and formatted as a time-only string.
  *
+ * @dbxPipe
+ * @dbxPipeSlug date-format-from-to
+ * @dbxPipeCategory date
+ * @dbxPipeRelated date-time-range, date-format-distance
  * @example
  * ```html
  * <span>{{ eventStart | dateFormatFromTo:'MMM d, h:mm a':90 }}</span>
@@ -5949,6 +6073,10 @@ declare class DateFormatFromToPipe implements PipeTransform {
  *
  * Includes both the date and time portions. Returns a fallback string when the input is `null` or `undefined`.
  *
+ * @dbxPipe
+ * @dbxPipeSlug date-day-time-range
+ * @dbxPipeCategory date
+ * @dbxPipeRelated date-time-range, date-day-range
  * @example
  * ```html
  * <span>{{ dateRange | dateDayTimeRange }}</span>
@@ -5969,6 +6097,10 @@ declare class DateDayTimeRangePipe implements PipeTransform {
  *
  * Displays the date and time of both the start and end. Returns a fallback string when the input is `null` or `undefined`.
  *
+ * @dbxPipe
+ * @dbxPipeSlug date-time-range
+ * @dbxPipeCategory date
+ * @dbxPipeRelated date-time-range-only, date-day-range, date-day-time-range
  * @example
  * ```html
  * <span>{{ dateRange | dateTimeRange }}</span>
@@ -5990,6 +6122,10 @@ declare class DateTimeRangePipe implements PipeTransform {
  * This is an impure pipe that recalculates on every change detection cycle to keep the distance up to date.
  * Returns a fallback string when the input is `null` or `undefined`.
  *
+ * @dbxPipe
+ * @dbxPipeSlug date-range-distance
+ * @dbxPipeCategory date
+ * @dbxPipeRelated date-distance
  * @example
  * ```html
  * <span>{{ someDate | dateRangeDistance }}</span>
@@ -6010,6 +6146,10 @@ declare class DateRangeDistancePipe implements PipeTransform {
  *
  * Displays only the time portion (no date). Returns a fallback string when the input is `null` or `undefined`.
  *
+ * @dbxPipe
+ * @dbxPipeSlug date-time-range-only
+ * @dbxPipeCategory date
+ * @dbxPipeRelated date-time-range
  * @example
  * ```html
  * <span>{{ dateRange | dateTimeRangeOnly }}</span>
@@ -6032,6 +6172,10 @@ declare class DateTimeRangeOnlyPipe implements PipeTransform {
  * local time in a target timezone and need to convert it back to the system timezone.
  * Returns `undefined` if either the input date or timezone is falsy.
  *
+ * @dbxPipe
+ * @dbxPipeSlug target-date-to-system-date
+ * @dbxPipeCategory date
+ * @dbxPipeRelated system-date-to-target-date, timezone-abbreviation
  * @example
  * ```html
  * <span>{{ targetDate | targetDateToSystemDate:'America/New_York' | date:'short' }}</span>
@@ -6050,6 +6194,10 @@ declare class TargetDateToSystemDatePipe implements PipeTransform {
  * Accepts an optional {@link FormatDateRangeDistanceFunctionConfig} to customize the output format.
  * Returns a fallback string when the input is `null` or `undefined`.
  *
+ * @dbxPipe
+ * @dbxPipeSlug date-time-range-only-distance
+ * @dbxPipeCategory date
+ * @dbxPipeRelated date-time-range, date-range-distance
  * @example
  * ```html
  * <span>{{ dateRange | dateTimeRangeOnlyDistance }}</span>
@@ -6075,6 +6223,10 @@ declare class DateTimeRangeOnlyDistancePipe implements PipeTransform {
  * Defaults to the current date if no reference date is provided.
  * Returns `undefined` if the timezone is falsy.
  *
+ * @dbxPipe
+ * @dbxPipeSlug timezone-abbreviation
+ * @dbxPipeCategory date
+ * @dbxPipeRelated system-date-to-target-date, target-date-to-system-date
  * @example
  * ```html
  * <span>{{ 'America/New_York' | timezoneAbbreviation }}</span>
@@ -6096,6 +6248,10 @@ declare class TimezoneAbbreviationPipe implements PipeTransform {
  * This is useful when you have a date in the system's timezone and need to display it as if it were in the target timezone.
  * Returns `undefined` if either the input date or timezone is falsy.
  *
+ * @dbxPipe
+ * @dbxPipeSlug system-date-to-target-date
+ * @dbxPipeCategory date
+ * @dbxPipeRelated target-date-to-system-date, timezone-abbreviation
  * @example
  * ```html
  * <span>{{ systemDate | systemDateToTargetDate:'America/New_York' | date:'short' }}</span>
@@ -6117,6 +6273,10 @@ declare class SystemDateToTargetDatePipe implements PipeTransform {
  *
  * A `~` prefix is added when the value is rounded up. Returns `undefined` for `null` or non-numeric input.
  *
+ * @dbxPipe
+ * @dbxPipeSlug minutes-string
+ * @dbxPipeCategory date
+ * @dbxPipeRelated to-minutes
  * @example
  * ```html
  * <span>{{ 90 | minutesString }}</span>
@@ -6142,6 +6302,10 @@ declare class MinutesStringPipe implements PipeTransform {
  * Otherwise, returns a human-readable distance string with suffix (e.g., "in 3 hours").
  * Returns the `unavailable` string when the input is falsy.
  *
+ * @dbxPipe
+ * @dbxPipeSlug time-countdown-distance
+ * @dbxPipeCategory date
+ * @dbxPipeRelated time-distance
  * @example
  * ```html
  * <span>{{ futureDate | timeCountdownDistance }}</span>
@@ -6162,6 +6326,10 @@ declare class TimeDistanceCountdownPipe implements PipeTransform {
  * Uses date-fns {@link formatDistance} to produce output like "3 hours ago" or "in 2 days".
  * Returns the `unavailable` string when the input is falsy.
  *
+ * @dbxPipe
+ * @dbxPipeSlug time-distance
+ * @dbxPipeCategory date
+ * @dbxPipeRelated date-distance, time-countdown-distance
  * @example
  * ```html
  * <span>{{ someDate | timeDistance }}</span>
@@ -6186,6 +6354,10 @@ declare class TimeDistancePipe implements PipeTransform {
  * Returns `undefined` if the input is `null`, `undefined`, or results in an invalid date.
  * Also provides a static `toJsDate()` method used by other pipes in this package.
  *
+ * @dbxPipe
+ * @dbxPipeSlug to-js-date
+ * @dbxPipeCategory date
+ * @dbxPipeRelated date-distance, date-format-distance
  * @example
  * ```html
  * <span>{{ '2024-01-05T12:00:00Z' | toJsDate | date:'short' }}</span>
@@ -6207,6 +6379,10 @@ declare class ToJsDatePipe implements PipeTransform {
  *
  * Returns the original value (0 or falsy) if the input is falsy.
  *
+ * @dbxPipe
+ * @dbxPipeSlug to-minutes
+ * @dbxPipeCategory date
+ * @dbxPipeRelated minutes-string
  * @example
  * ```html
  * <span>{{ 180000 | toMinutes }}</span>
@@ -6227,6 +6403,9 @@ declare class ToMinutesPipe implements PipeTransform {
  *
  * Returns `undefined` for falsy input. If serialization fails, returns `'ERROR'` and logs the error to the console.
  *
+ * @dbxPipe
+ * @dbxPipeSlug prettyjson
+ * @dbxPipeCategory misc
  * @example
  * ```html
  * <pre>{{ myObject | prettyjson }}</pre>
@@ -6235,6 +6414,7 @@ declare class ToMinutesPipe implements PipeTransform {
  * <pre>{{ myObject | prettyjson:4 }}</pre>
  * <!-- Output: formatted JSON with 4-space indentation -->
  * ```
+ * @param spacing Indent spaces; defaults to `2`.
  */
 declare class PrettyJsonPipe implements PipeTransform {
     static toPrettyJson(input: Maybe<unknown>, spacing?: number): Maybe<string>;
@@ -6248,6 +6428,10 @@ declare class PrettyJsonPipe implements PipeTransform {
  *
  * Returns the original value if the input is `null` or `undefined`.
  *
+ * @dbxPipe
+ * @dbxPipeSlug cut-text
+ * @dbxPipeCategory value
+ * @dbxPipeSkillRefs dbx-value-pipes
  * @example
  * ```html
  * <span>{{ 'Hello World' | cutText:5 }}</span>
@@ -6256,6 +6440,8 @@ declare class PrettyJsonPipe implements PipeTransform {
  * <span>{{ longText | cutText:20:'--' }}</span>
  * <!-- Output: "Some long text here--" -->
  * ```
+ * @param maxLength Maximum allowed length before truncation.
+ * @param endText Suffix appended when truncation occurs.
  */
 declare class CutTextPipe implements PipeTransform {
     transform(input: Maybe<string>, maxLength: number, endText?: Maybe<string>): Maybe<string>;
@@ -6270,11 +6456,17 @@ declare class CutTextPipe implements PipeTransform {
  * for getter functions whose return value may change over time.
  * Use {@link GetValueOncePipe} (`getValueOnce`) for a pure alternative when the value is static.
  *
+ * @dbxPipe
+ * @dbxPipeSlug get-value
+ * @dbxPipeCategory value
+ * @dbxPipeRelated get-value-once
+ * @dbxPipeSkillRefs dbx-value-pipes
  * @example
  * ```html
  * <span>{{ myGetterOrValue | getValue }}</span>
  * <span>{{ myGetterFn | getValue:someArg }}</span>
  * ```
+ * @param args Optional argument forwarded to the getter function.
  */
 declare class GetValuePipe implements PipeTransform {
     transform<T, A = any>(input: GetterOrValue<T>, args?: A): T;
@@ -6287,10 +6479,16 @@ declare class GetValuePipe implements PipeTransform {
  * This is a pure pipe that only re-evaluates when the input reference changes.
  * Use {@link GetValuePipe} (`getValue`) if the getter function's return value may change between cycles.
  *
+ * @dbxPipe
+ * @dbxPipeSlug get-value-once
+ * @dbxPipeCategory value
+ * @dbxPipeRelated get-value
+ * @dbxPipeSkillRefs dbx-value-pipes
  * @example
  * ```html
  * <span>{{ myGetterOrValue | getValueOnce }}</span>
  * ```
+ * @param args Optional argument forwarded to the getter function.
  */
 declare class GetValueOncePipe implements PipeTransform {
     transform<T, A = any>(input: GetterOrValue<T>, args?: A): T;
@@ -6303,6 +6501,10 @@ declare class GetValueOncePipe implements PipeTransform {
  *
  * Optionally accepts a default string to display when the input is `null` or `undefined`.
  *
+ * @dbxPipe
+ * @dbxPipeSlug dollar-amount
+ * @dbxPipeCategory value
+ * @dbxPipeSkillRefs dbx-value-pipes
  * @example
  * ```html
  * <span>{{ 19.5 | dollarAmount }}</span>
@@ -6311,6 +6513,7 @@ declare class GetValueOncePipe implements PipeTransform {
  * <span>{{ nullValue | dollarAmount:'N/A' }}</span>
  * <!-- Output: "N/A" -->
  * ```
+ * @param defaultIfNull String to display when the input is `null` or `undefined`. Defaults to formatting `null` through `dollarAmountString`.
  */
 declare class DollarAmountPipe implements PipeTransform {
     transform(input: Maybe<number>, defaultIfNull?: Maybe<string>): Maybe<string>;
@@ -6403,10 +6606,12 @@ declare abstract class AbstractFilterSourceDirective<F = unknown> implements Fil
 }
 
 /**
- * Connects the host element's {@link FilterSource} to an ancestor {@link FilterSourceConnector} on initialization.
+ * Connects the host element's {@link FilterSource} to an ancestor {@link FilterSourceConnector} on init. Place on an element whose own directive contributes a `FilterSource` (via `host: true`) so it auto-wires to the parent connector.
  *
- * Place on an element that has a `FilterSource` (via `host: true`) to automatically
- * wire it up to a parent `FilterSourceConnector`.
+ * @dbxFilter
+ * @dbxFilterSlug connect-source
+ * @dbxFilterRelated source, source-connector
+ * @dbxFilterSkillRefs dbx__ref__dbx-component-patterns
  *
  * @example
  * ```html
@@ -6424,14 +6629,18 @@ declare class DbxFilterConnectSourceDirective<F = unknown> implements OnInit {
 }
 
 /**
- * Concrete directive that acts as both a {@link FilterSource} and {@link FilterSourceConnector}.
+ * Acts as both {@link FilterSource} and {@link FilterSourceConnector} — bridges a filter from one part of the template to another. Pair with `[dbxFilterConnectSource]` on the inner element that owns the source.
  *
- * Place on an element to bridge a filter source from one part of the template to another.
+ * @dbxFilter
+ * @dbxFilterSlug source-connector
+ * @dbxFilterRelated source, connect-source
+ * @dbxFilterSkillRefs dbx__ref__dbx-component-patterns
  *
  * @example
  * ```html
  * <div dbxFilterSourceConnector>
- *   <my-list-component></my-list-component>
+ *   <my-filter-form dbxFilterSource dbxFilterConnectSource></my-filter-form>
+ *   <my-list></my-list>
  * </div>
  * ```
  */
@@ -6495,18 +6704,26 @@ declare abstract class AbstractDbxFilterMapSourceDirective<F> extends AbstractDb
     static ɵdir: i0.ɵɵDirectiveDeclaration<AbstractDbxFilterMapSourceDirective<any>, never, never, {}, {}, never, never, true, never>;
 }
 /**
- * Concrete directive that provides a {@link FilterSource} from a keyed entry in a parent {@link FilterMap}.
+ * Provides a {@link FilterSource} for a keyed entry in an ancestor {@link FilterMap}. Children can inject the source as if it were the only filter on the page; the map dispatches by key.
+ *
+ * @dbxFilter
+ * @dbxFilterSlug map-source
+ * @dbxFilterRelated map, map-source-connector
+ * @dbxFilterSkillRefs dbx__ref__dbx-component-patterns
  *
  * @example
  * ```html
  * <div dbxFilterMap>
- *   <div [dbxFilterMapSource]="'listFilter'">
+ *   <div [dbxFilterMapSource]="'profileList'">
  *     <my-filtered-list></my-filtered-list>
  *   </div>
  * </div>
  * ```
  */
 declare class DbxFilterMapSourceDirective<F> extends AbstractDbxFilterMapSourceDirective<F> implements FilterSource<F> {
+    /**
+     * The map key this source binds to.
+     */
     readonly dbxFilterMapSource: i0.InputSignal<Maybe<string>>;
     protected readonly _dbxFilterMapSourceEffect: i0.EffectRef;
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxFilterMapSourceDirective<any>, never>;
@@ -6514,20 +6731,26 @@ declare class DbxFilterMapSourceDirective<F> extends AbstractDbxFilterMapSourceD
 }
 
 /**
- * Directive that acts as both a {@link FilterSourceConnector} and {@link FilterSource} for a keyed entry in a parent {@link FilterMap}.
+ * Both {@link FilterSource} and {@link FilterSourceConnector} for a keyed entry in an ancestor {@link FilterMap}. Connects an external filter source to one map slot and re-emits that slot's filter.
  *
- * Connects an external filter source to a specific filter map entry and re-emits that entry's filter.
+ * @dbxFilter
+ * @dbxFilterSlug map-source-connector
+ * @dbxFilterRelated map, map-source
+ * @dbxFilterSkillRefs dbx__ref__dbx-component-patterns
  *
  * @example
  * ```html
  * <div dbxFilterMap>
- *   <div [dbxFilterMapSourceConnector]="'myList'">
- *     <my-list-component></my-list-component>
+ *   <div [dbxFilterMapSourceConnector]="'profileList'">
+ *     <my-list></my-list>
  *   </div>
  * </div>
  * ```
  */
 declare class DbxFilterMapSourceConnectorDirective<F> extends AbstractDbxFilterMapSourceDirective<F> implements FilterSourceConnector<F> {
+    /**
+     * The map key this connector binds to.
+     */
     readonly dbxFilterMapSourceConnector: i0.InputSignal<Maybe<string>>;
     protected readonly _dbxFilterMapSourceConnectorEffect: i0.EffectRef;
     connectWithSource(filterSource: FilterSource<F>): void;
@@ -6536,10 +6759,12 @@ declare class DbxFilterMapSourceConnectorDirective<F> extends AbstractDbxFilterM
 }
 
 /**
- * Directive that provides a {@link FilterMap} instance for managing multiple named filter sources.
+ * Provides a {@link FilterMap} instance in DI so multiple child sources can register / look up filters by string key. Use when one screen needs several independent filter contexts.
  *
- * Child directives like `dbxFilterMapSource` and `dbxFilterMapSourceConnector` look up this
- * map via DI to register and retrieve filter instances by key.
+ * @dbxFilter
+ * @dbxFilterSlug map
+ * @dbxFilterRelated map-source, map-source-connector
+ * @dbxFilterSkillRefs dbx__ref__dbx-component-patterns
  *
  * @example
  * ```html
@@ -6556,21 +6781,23 @@ declare class DbxFilterMapDirective<F> {
 }
 
 /**
- * A clickable preset that applies a predefined filter value when selected.
+ * Pattern for declaring a preset filter chip — combines an anchor display (title, icon, disabled) with a preset string identifier and a `presetValue` getter. A `null` or empty preset value resets the filter.
  *
- * Combines display properties (title, icon, disabled) with a filter preset value.
- * A `null` or empty `presetValue` resets the filter.
+ * @dbxFilter
+ * @dbxFilterSlug clickable-preset
+ * @dbxFilterRelated source
+ * @dbxFilterSkillRefs dbx__ref__dbx-component-patterns
  *
  * @typeParam F - The filter type, which must include a preset field.
  * @typeParam P - The preset string identifier type.
  *
  * @example
  * ```typescript
- * const preset: ClickableFilterPreset<MyFilter> = {
+ * const activePreset: ClickableFilterPreset<ProfileFilter> = {
  *   preset: 'active',
- *   title: 'Active Items',
+ *   title: 'Active',
  *   icon: 'check',
- *   presetValue: { status: 'active', preset: 'active' },
+ *   presetValue: { status: 'active', preset: 'active' }
  * };
  * ```
  */
@@ -6622,12 +6849,17 @@ declare function isClickablePartialFilterPreset<F>(preset: object): preset is Cl
 type ClickableFilterPresetOrPartialPreset<F extends FilterWithPreset<P>, P extends string = string> = ClickableFilterPreset<F, P> | ClickablePartialFilterPreset<F>;
 
 /**
- * Provides a {@link FilterSource} in the DI tree, allowing child components to inject and consume filter state.
+ * Provides a {@link FilterSource} in DI so child components can inject and consume the current filter value. Use this on a wrapper element when the child is the canonical owner of the filter (a filter form, a chip group).
+ *
+ * @dbxFilter
+ * @dbxFilterSlug source
+ * @dbxFilterRelated connect-source, source-connector, map-source
+ * @dbxFilterSkillRefs dbx__ref__dbx-component-patterns
  *
  * @example
  * ```html
  * <div dbxFilterSource>
- *   <my-list-component></my-list-component>
+ *   <my-filter-form></my-filter-form>
  * </div>
  * ```
  */