ngwr 14.10.0 → 14.12.0

package/types/ngwr-platform.d.ts

@@ -1,6 +1,5 @@
-import * as i0 from '@angular/core';
-import { Signal } from '@angular/core';
-
+import * as i0 from "@angular/core";
+import { Signal } from "@angular/core";
 /**
  * SSR-safe environment probes. Use to gate browser-only code paths and
  * react to user preferences without scattering `matchMedia` calls around.
@@ -22,19 +21,18 @@ import { Signal } from '@angular/core';
  *
  * @see https://ngwr.dev/reference/services/platform
  */
-declare class WrPlatform {
-    private readonly destroyRef;
-    private readonly doc;
-    readonly isBrowser: boolean;
-    readonly isServer: boolean;
-    readonly userAgent: string | null;
-    readonly prefersDark: Signal<boolean>;
-    readonly prefersReducedMotion: Signal<boolean>;
-    private mediaSignal;
-    static ɵfac: i0.ɵɵFactoryDeclaration<WrPlatform, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+export declare class WrPlatform {
+  private readonly destroyRef;
+  private readonly doc;
+  readonly isBrowser: boolean;
+  readonly isServer: boolean;
+  readonly userAgent: string | null;
+  readonly prefersDark: Signal<boolean>;
+  readonly prefersReducedMotion: Signal<boolean>;
+  private mediaSignal;
+  static ɵfac: i0.ɵɵFactoryDeclaration<WrPlatform, never>;
+  static ɵprov: i0.ɵɵInjectableDeclaration<any>;
 }
-
 /**
  * SSR-safe view onto `window.visualViewport` — the part of the layout viewport
  * actually visible once the on-screen keyboard (or other browser chrome) is
@@ -51,21 +49,20 @@ declare class WrPlatform {
  *
  * @see https://ngwr.dev/reference/services/platform
  */
-declare class WrVisualViewport {
-    private readonly destroyRef;
-    private readonly doc;
-    private readonly isBrowser;
-    private readonly _bottomInset;
-    private readonly _offsetTop;
-    /** Height (px) the keyboard / browser chrome hides at the viewport bottom. */
-    readonly bottomInset: Signal<number>;
-    /** The visual viewport's top offset (px). */
-    readonly offsetTop: Signal<number>;
-    constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<WrVisualViewport, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+export declare class WrVisualViewport {
+  private readonly destroyRef;
+  private readonly doc;
+  private readonly isBrowser;
+  private readonly _bottomInset;
+  private readonly _offsetTop;
+  /** Height (px) the keyboard / browser chrome hides at the viewport bottom. */
+  readonly bottomInset: Signal<number>;
+  /** The visual viewport's top offset (px). */
+  readonly offsetTop: Signal<number>;
+  constructor();
+  static ɵfac: i0.ɵɵFactoryDeclaration<WrVisualViewport, never>;
+  static ɵprov: i0.ɵɵInjectableDeclaration<any>;
 }
-
 /** Impact weight for {@link WrHaptics.impact}. */
 type WrHapticImpact = 'light' | 'medium' | 'heavy';
 /**
@@ -98,32 +95,30 @@ type WrHapticImpact = 'light' | 'medium' | 'heavy';
  *
  * @see https://ngwr.dev/reference/services/platform
  */
-declare class WrHaptics {
-    private readonly isBrowser;
-    private readonly nav;
-    /** Whether the Vibration API is available (browser + `navigator.vibrate`). */
-    readonly supported: boolean;
-    /**
-     * Fire a raw vibration pattern — a single duration in ms, or an alternating
-     * `[buzz, pause, buzz, …]` array. Returns whether it was dispatched; passing
-     * `0` / `[]` cancels any ongoing vibration.
-     */
-    vibrate(pattern: number | readonly number[]): boolean;
-    /** A physical "tap" — `light`, `medium` (default), or `heavy`. */
-    impact(strength?: WrHapticImpact): boolean;
-    /** A subtle tick for a discrete change (switch, segmented, stepper). */
-    selection(): boolean;
-    /** A confirming pulse for a completed action. */
-    success(): boolean;
-    /** A cautioning pulse before a risky or destructive action. */
-    warning(): boolean;
-    /** A buzzing pulse for a failure or rejected action. */
-    error(): boolean;
-    /** Cancel any in-progress vibration. */
-    stop(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<WrHaptics, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+export declare class WrHaptics {
+  private readonly isBrowser;
+  private readonly nav;
+  /** Whether the Vibration API is available (browser + `navigator.vibrate`). */
+  readonly supported: boolean;
+  /**
+   * Fire a raw vibration pattern — a single duration in ms, or an alternating
+   * `[buzz, pause, buzz, …]` array. Returns whether it was dispatched; passing
+   * `0` / `[]` cancels any ongoing vibration.
+   */
+  vibrate(pattern: number | readonly number[]): boolean;
+  /** A physical "tap" — `light`, `medium` (default), or `heavy`. */
+  impact(strength?: WrHapticImpact): boolean;
+  /** A subtle tick for a discrete change (switch, segmented, stepper). */
+  selection(): boolean;
+  /** A confirming pulse for a completed action. */
+  success(): boolean;
+  /** A cautioning pulse before a risky or destructive action. */
+  warning(): boolean;
+  /** A buzzing pulse for a failure or rejected action. */
+  error(): boolean;
+  /** Cancel any in-progress vibration. */
+  stop(): void;
+  static ɵfac: i0.ɵɵFactoryDeclaration<WrHaptics, never>;
+  static ɵprov: i0.ɵɵInjectableDeclaration<any>;
 }
-
-export { WrHaptics, WrPlatform, WrVisualViewport };
-export type { WrHapticImpact };
+export type { WrHapticImpact };

package/types/ngwr-popconfirm-testing.d.ts

@@ -1,33 +1,17 @@
-import { BaseHarnessFilters, ContentContainerComponentHarness, HarnessPredicate, HarnessLoader } from '@angular/cdk/testing';
-import { WrPopconfirmPosition } from 'ngwr/popconfirm';
-import { WrColor } from 'ngwr/theme';
-
-/**
- * @license
- *
- * Use of this source code is governed by an MIT-style license that can be
- * found in the LICENSE file at https://github.com/thekhegay/ngwr/blob/main/LICENSE
- */
-
+import { BaseHarnessFilters, ContentContainerComponentHarness, HarnessLoader, HarnessPredicate } from "@angular/cdk/testing";
+import { WrPopconfirmPosition } from "ngwr/popconfirm";
+import { WrColor } from "ngwr/theme";
 /** Narrows which `[wrPopconfirm]` trigger a harness query matches. */
 interface WrPopconfirmHarnessFilters extends BaseHarnessFilters {
-    /**
-     * Match the trigger's own visible text — the label of the button the directive
-     * sits on, not the question in the panel. A string is an exact match, a RegExp
-     * is tested.
-     */
-    readonly triggerText?: string | RegExp;
-    /** Match only open (`true`) or only closed (`false`) popconfirms. */
-    readonly open?: boolean;
+  /**
+   * Match the trigger's own visible text — the label of the button the directive
+   * sits on, not the question in the panel. A string is an exact match, a RegExp
+   * is tested.
+   */
+  readonly triggerText?: string | RegExp;
+  /** Match only open (`true`) or only closed (`false`) popconfirms. */
+  readonly open?: boolean;
 }
-
-/**
- * @license
- *
- * Use of this source code is governed by an MIT-style license that can be
- * found in the LICENSE file at https://github.com/thekhegay/ngwr/blob/main/LICENSE
- */
-
 /**
  * Test harness for `[wrPopconfirm]` — the "are you sure?" dialog anchored to its
  * trigger.
@@ -60,176 +44,174 @@ interface WrPopconfirmHarnessFilters extends BaseHarnessFilters {
  *
  * @see https://ngwr.dev/guides/testing
  */
-declare class WrPopconfirmHarness extends ContentContainerComponentHarness {
-    /**
-     * The directive's host — whatever element the consumer put `[wrPopconfirm]` on.
-     *
-     * Matched by the marker class, not by `[wrPopconfirm]`: the question is normally
-     * BOUND (`[wrPopconfirm]="question"`), and a property binding leaves no
-     * attribute in the DOM at all. Same shape as `.wr-popover-trigger` and
-     * `.wr-dropdown-trigger`.
-     */
-    static hostSelector: string;
-    /** Build a predicate that narrows the query — pass to `getHarness` / `getAllHarnesses`. */
-    static with(options?: WrPopconfirmHarnessFilters): HarnessPredicate<WrPopconfirmHarness>;
-    /** The trigger's own visible label. The question inside the panel is `getMessage()`. */
-    getTriggerText(): Promise<string>;
-    /**
-     * Whether the dialog is showing.
-     *
-     * Read from `aria-expanded` rather than from a class, because that is the whole
-     * of what the trigger tells a screen reader — the directive puts no state class
-     * on its host at all.
-     */
-    isOpen(): Promise<boolean>;
-    /** Whether the trigger currently has keyboard focus — the state it is handed back on close. */
-    isTriggerFocused(): Promise<boolean>;
-    /**
-     * Press the trigger to open the dialog.
-     *
-     * Throws when nothing opens, because the reason is always worth failing on: a
-     * native `<button disabled>` trigger never receives the click at all. (A
-     * DISABLED `<wr-btn>` is a jsdom blind spot in the other direction — it is kept
-     * inert by `pointer-events: none`, which jsdom does not apply, so it opens here
-     * and would not in a browser.)
-     */
-    open(): Promise<void>;
-    /**
-     * Press the trigger again to take the question back.
-     *
-     * This is the ONE way out that answers nothing: the directive treats a second
-     * press as withdrawing the question, so `cancelled` does NOT fire — unlike
-     * `cancel()`, `sendEscape()` and `clickOutside()`, which all emit it. Use this
-     * when a spec needs the panel gone without recording an answer.
-     */
-    close(): Promise<void>;
-    /** The question being asked. */
-    getMessage(): Promise<string>;
-    /**
-     * The confirm button's label.
-     *
-     * Resolved, not given: `confirmText` falls back to the `popconfirm.confirm`
-     * catalog entry, so a localized app reads its own word here and a spec that
-     * asserted the English default would be asserting the wrong thing.
-     */
-    getConfirmText(): Promise<string>;
-    /** The cancel button's label — `cancelText`, or the `popconfirm.cancel` catalog entry. */
-    getCancelText(): Promise<string>;
-    /**
-     * Both action labels in the order they are rendered: cancel first, confirm
-     * second.
-     *
-     * That order is deliberate and worth reading — the destructive choice is the one
-     * being confirmed, so the safe one comes first and takes the initial focus.
-     */
-    getActionLabels(): Promise<string[]>;
-    /**
-     * The confirm button's intent colour.
-     *
-     * Checked against `WR_COLORS` rather than pattern-matched out of the class list:
-     * `wr-btn--*` also spells the size, the shape and the icon position, so only the
-     * intent list can say which of them is a colour. Today `WrButton` happens to
-     * emit the colour first, so a first-match regex would agree — but that order is
-     * not a contract, and the same regex on a button with no colour answers `sm`.
-     * Never `null` in practice — `confirmColor` defaults to `primary` — but typed
-     * for it, since the button itself allows no colour at all.
-     */
-    getConfirmColor(): Promise<WrColor | null>;
-    /** Which action holds keyboard focus, by label, or `null` when focus is elsewhere. */
-    getFocusedActionLabel(): Promise<string | null>;
-    /** Answer the question: click confirm, which emits `confirmed` and closes the dialog. */
-    confirm(): Promise<void>;
-    /** Decline: click cancel, which emits `cancelled` and closes the dialog. */
-    cancel(): Promise<void>;
-    /**
-     * Dismiss with Escape, which emits `cancelled`.
-     *
-     * Sent at the pane rather than at the focused button, because the target makes
-     * no difference: the key is picked up by the overlay's keyboard dispatcher,
-     * which keeps one listener on the document and routes to the topmost overlay.
-     * The pane is the one element guaranteed to be there.
-     */
-    sendEscape(): Promise<void>;
-    /**
-     * Dismiss by pressing outside the panel, which emits `cancelled`.
-     *
-     * The press lands on the overlay CONTAINER — an ancestor of the pane (the CDK
-     * puts a host `<div>` between the two), and so outside the panel by the only
-     * measure that matters here, since the dismissal is decided by whether the press
-     * started inside the pane. With two dialogs showing it dismisses BOTH: neither
-     * pane contains the container. jsdom has no layout
-     * and no `document.elementFromPoint`, so a harness cannot aim at "whatever is
-     * under the pointer"; to dismiss by pressing a specific element instead, click
-     * that element's own `TestElement`.
-     */
-    clickOutside(): Promise<void>;
-    /**
-     * The role the open panel announces — `'dialog'`.
-     *
-     * Worth asserting rather than assuming: the directive sets it on the OVERLAY
-     * PANE, not on the panel component a consumer can see in the template.
-     */
-    getRole(): Promise<string | null>;
-    /**
-     * The dialog's accessible name — the `ariaLabel` input, or the catalog's
-     * `popconfirm.label`.
-     *
-     * A `role="dialog"` with no name announces as a bare "dialog" and trips axe's
-     * `aria-dialog-name`, which is why there is always one.
-     */
-    getLabel(): Promise<string | null>;
-    /**
-     * Whether the dialog claims modality.
-     *
-     * `false`, deliberately, and worth pinning: focus is moved into the panel but
-     * NOT trapped, because Escape and an outside click both dismiss — trapping
-     * would only make it harder to leave.
-     */
-    isModal(): Promise<boolean>;
-    /**
-     * The text a screen reader reads as the dialog's DESCRIPTION, resolved through
-     * `aria-describedby` the way an assistive technology would.
-     *
-     * This is the question, and it is the entire content of a confirmation: without
-     * the link the dialog announces its name and then nothing at all.
-     */
-    getDescriptionText(): Promise<string | null>;
-    /**
-     * Which side of the trigger the panel is anchored to.
-     *
-     * The side that was ASKED for, read off the pane's public modifier class —
-     * `position` is an input, so a bound one never reaches the DOM, and the panel's
-     * own offset is a CDK inline style that says nothing in a layout-less jsdom.
-     * Not where the panel ended up: the position strategy is flexible and pushes,
-     * so a panel with no room on that side moves without the class changing.
-     */
-    getPosition(): Promise<WrPopconfirmPosition | null>;
-    /**
-     * Harnesses for anything inside the panel resolve within THIS instance's dialog.
-     *
-     * Scoped by the published id rather than by `.wr-popconfirm`: the overlay
-     * container is shared, so a class query would answer with whichever popconfirm
-     * opened first.
-     */
-    protected getRootHarnessLoader(): Promise<HarnessLoader>;
-    /**
-     * One of the two action buttons.
-     *
-     * By its own modifier class, never by index: both are a `<wr-btn size="sm">`, so
-     * before the modifiers existed the only thing telling them apart was document
-     * order — and a harness that clicked "the second button" would go on passing
-     * while it started confirming what a spec meant to cancel.
-     */
-    private action;
-    /** One element inside THIS instance's panel. */
-    private inPanel;
-    /** Every matching element inside THIS instance's panel, in document order. */
-    private allInPanel;
-    /** This instance's overlay pane — the element carrying the dialog semantics. */
-    private pane;
-    /** The id the trigger publishes for its dialog, which exists only while the dialog does. */
-    private panelId;
+export declare class WrPopconfirmHarness extends ContentContainerComponentHarness {
+  /**
+   * The directive's host — whatever element the consumer put `[wrPopconfirm]` on.
+   *
+   * Matched by the marker class, not by `[wrPopconfirm]`: the question is normally
+   * BOUND (`[wrPopconfirm]="question"`), and a property binding leaves no
+   * attribute in the DOM at all. Same shape as `.wr-popover-trigger` and
+   * `.wr-dropdown-trigger`.
+   */
+  static hostSelector: string;
+  /** Build a predicate that narrows the query — pass to `getHarness` / `getAllHarnesses`. */
+  static with(options?: WrPopconfirmHarnessFilters): HarnessPredicate<WrPopconfirmHarness>;
+  /** The trigger's own visible label. The question inside the panel is `getMessage()`. */
+  getTriggerText(): Promise<string>;
+  /**
+   * Whether the dialog is showing.
+   *
+   * Read from `aria-expanded` rather than from a class, because that is the whole
+   * of what the trigger tells a screen reader — the directive puts no state class
+   * on its host at all.
+   */
+  isOpen(): Promise<boolean>;
+  /** Whether the trigger currently has keyboard focus — the state it is handed back on close. */
+  isTriggerFocused(): Promise<boolean>;
+  /**
+   * Press the trigger to open the dialog.
+   *
+   * Throws when nothing opens, because the reason is always worth failing on: a
+   * native `<button disabled>` trigger never receives the click at all. (A
+   * DISABLED `<wr-btn>` is a jsdom blind spot in the other direction — it is kept
+   * inert by `pointer-events: none`, which jsdom does not apply, so it opens here
+   * and would not in a browser.)
+   */
+  open(): Promise<void>;
+  /**
+   * Press the trigger again to take the question back.
+   *
+   * This is the ONE way out that answers nothing: the directive treats a second
+   * press as withdrawing the question, so `cancelled` does NOT fire — unlike
+   * `cancel()`, `sendEscape()` and `clickOutside()`, which all emit it. Use this
+   * when a spec needs the panel gone without recording an answer.
+   */
+  close(): Promise<void>;
+  /** The question being asked. */
+  getMessage(): Promise<string>;
+  /**
+   * The confirm button's label.
+   *
+   * Resolved, not given: `confirmText` falls back to the `popconfirm.confirm`
+   * catalog entry, so a localized app reads its own word here and a spec that
+   * asserted the English default would be asserting the wrong thing.
+   */
+  getConfirmText(): Promise<string>;
+  /** The cancel button's label — `cancelText`, or the `popconfirm.cancel` catalog entry. */
+  getCancelText(): Promise<string>;
+  /**
+   * Both action labels in the order they are rendered: cancel first, confirm
+   * second.
+   *
+   * That order is deliberate and worth reading — the destructive choice is the one
+   * being confirmed, so the safe one comes first and takes the initial focus.
+   */
+  getActionLabels(): Promise<string[]>;
+  /**
+   * The confirm button's intent colour.
+   *
+   * Checked against `WR_COLORS` rather than pattern-matched out of the class list:
+   * `wr-btn--*` also spells the size, the shape and the icon position, so only the
+   * intent list can say which of them is a colour. Today `WrButton` happens to
+   * emit the colour first, so a first-match regex would agree — but that order is
+   * not a contract, and the same regex on a button with no colour answers `sm`.
+   * Never `null` in practice — `confirmColor` defaults to `primary` — but typed
+   * for it, since the button itself allows no colour at all.
+   */
+  getConfirmColor(): Promise<WrColor | null>;
+  /** Which action holds keyboard focus, by label, or `null` when focus is elsewhere. */
+  getFocusedActionLabel(): Promise<string | null>;
+  /** Answer the question: click confirm, which emits `confirmed` and closes the dialog. */
+  confirm(): Promise<void>;
+  /** Decline: click cancel, which emits `cancelled` and closes the dialog. */
+  cancel(): Promise<void>;
+  /**
+   * Dismiss with Escape, which emits `cancelled`.
+   *
+   * Sent at the pane rather than at the focused button, because the target makes
+   * no difference: the key is picked up by the overlay's keyboard dispatcher,
+   * which keeps one listener on the document and routes to the topmost overlay.
+   * The pane is the one element guaranteed to be there.
+   */
+  sendEscape(): Promise<void>;
+  /**
+   * Dismiss by pressing outside the panel, which emits `cancelled`.
+   *
+   * The press lands on the overlay CONTAINER — an ancestor of the pane (the CDK
+   * puts a host `<div>` between the two), and so outside the panel by the only
+   * measure that matters here, since the dismissal is decided by whether the press
+   * started inside the pane. With two dialogs showing it dismisses BOTH: neither
+   * pane contains the container. jsdom has no layout
+   * and no `document.elementFromPoint`, so a harness cannot aim at "whatever is
+   * under the pointer"; to dismiss by pressing a specific element instead, click
+   * that element's own `TestElement`.
+   */
+  clickOutside(): Promise<void>;
+  /**
+   * The role the open panel announces — `'dialog'`.
+   *
+   * Worth asserting rather than assuming: the directive sets it on the OVERLAY
+   * PANE, not on the panel component a consumer can see in the template.
+   */
+  getRole(): Promise<string | null>;
+  /**
+   * The dialog's accessible name — the `ariaLabel` input, or the catalog's
+   * `popconfirm.label`.
+   *
+   * A `role="dialog"` with no name announces as a bare "dialog" and trips axe's
+   * `aria-dialog-name`, which is why there is always one.
+   */
+  getLabel(): Promise<string | null>;
+  /**
+   * Whether the dialog claims modality.
+   *
+   * `false`, deliberately, and worth pinning: focus is moved into the panel but
+   * NOT trapped, because Escape and an outside click both dismiss — trapping
+   * would only make it harder to leave.
+   */
+  isModal(): Promise<boolean>;
+  /**
+   * The text a screen reader reads as the dialog's DESCRIPTION, resolved through
+   * `aria-describedby` the way an assistive technology would.
+   *
+   * This is the question, and it is the entire content of a confirmation: without
+   * the link the dialog announces its name and then nothing at all.
+   */
+  getDescriptionText(): Promise<string | null>;
+  /**
+   * Which side of the trigger the panel is anchored to.
+   *
+   * The side that was ASKED for, read off the pane's public modifier class —
+   * `position` is an input, so a bound one never reaches the DOM, and the panel's
+   * own offset is a CDK inline style that says nothing in a layout-less jsdom.
+   * Not where the panel ended up: the position strategy is flexible and pushes,
+   * so a panel with no room on that side moves without the class changing.
+   */
+  getPosition(): Promise<WrPopconfirmPosition | null>;
+  /**
+   * Harnesses for anything inside the panel resolve within THIS instance's dialog.
+   *
+   * Scoped by the published id rather than by `.wr-popconfirm`: the overlay
+   * container is shared, so a class query would answer with whichever popconfirm
+   * opened first.
+   */
+  protected getRootHarnessLoader(): Promise<HarnessLoader>;
+  /**
+   * One of the two action buttons.
+   *
+   * By its own modifier class, never by index: both are a `<wr-btn size="sm">`, so
+   * before the modifiers existed the only thing telling them apart was document
+   * order — and a harness that clicked "the second button" would go on passing
+   * while it started confirming what a spec meant to cancel.
+   */
+  private action;
+  /** One element inside THIS instance's panel. */
+  private inPanel;
+  /** Every matching element inside THIS instance's panel, in document order. */
+  private allInPanel;
+  /** This instance's overlay pane — the element carrying the dialog semantics. */
+  private pane;
+  /** The id the trigger publishes for its dialog, which exists only while the dialog does. */
+  private panelId;
 }
-
-export { WrPopconfirmHarness };
-export type { WrPopconfirmHarnessFilters };
+export type { WrPopconfirmHarnessFilters };