@skyux/core 15.0.0-alpha.9 → 15.0.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/core",
-  "version": "15.0.0-alpha.9",
+  "version": "15.0.0-beta.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -21,7 +21,7 @@
     "@angular/core": "^22.1.2",
     "@angular/platform-browser": "^22.1.2",
     "@angular/router": "^22.1.2",
-    "@skyux/i18n": "15.0.0-alpha.9"
+    "@skyux/i18n": "15.0.0-beta.0"
   },
   "dependencies": {
     "tslib": "^2.8.1"

package/types/skyux-core-testing.d.ts

@@ -1,6 +1,6 @@
 import * as i0 from '@angular/core';
-import { Provider, Predicate, DebugElement } from '@angular/core';
-import { SkyMediaQueryService, SkyMediaBreakpoints, SkyMediaQueryListener, SkyUIConfigService, SkyBreakpoint } from '@skyux/core';
+import { Provider, EnvironmentProviders, Predicate, DebugElement } from '@angular/core';
+import { SkyMediaQueryService, SkyMediaBreakpoints, SkyMediaQueryListener, SkyUIConfigService, SkyInstrumentationEvent, SkyBreakpoint } from '@skyux/core';
 import { BehaviorSubject, Subscription, Observable } from 'rxjs';
 import { BaseHarnessFilters, ComponentHarness, ComponentHarnessConstructor, HarnessPredicate, HarnessQuery, TestElement } from '@angular/cdk/testing';
 import { ComponentFixture } from '@angular/core/testing';
@@ -97,6 +97,30 @@ declare class SkyHelpTestingModule {
     static ɵinj: i0.ɵɵInjectorDeclaration<SkyHelpTestingModule>;
 }
 
+/**
+ * Registers a listener that records the instrumentation events emitted during a
+ * unit test. Inject `SkyInstrumentationTestingController` to validate them.
+ */
+declare function provideSkyInstrumentationTesting(): EnvironmentProviders;
+
+/**
+ * Validates the instrumentation events emitted during a unit test.
+ */
+declare abstract class SkyInstrumentationTestingController {
+    /**
+     * Throws an error if the expected event was not emitted.
+     * @param evt The expected event. All properties must match an emitted event.
+     */
+    abstract expectEvent(evt: SkyInstrumentationEvent): void;
+    /**
+     * Throws an error if the expected event was not emitted a specific number of
+     * times.
+     * @param evt The expected event. All properties must match an emitted event.
+     * @param count The expected number of times the event was emitted.
+     */
+    abstract expectEventCount(evt: SkyInstrumentationEvent, count: number): void;
+}
+
 /**
  * A controller to be injected into tests, which mocks the
  * `SkyMediaQueryService` and handles interactions with breakpoints.
@@ -280,5 +304,5 @@ declare class SkyInputHarness extends ComponentHarness {
     setValue(value: string): Promise<void>;
 }
 
-export { MockSkyMediaQueryService, MockSkyUIConfigService, SkyAppTestUtility, SkyBy, SkyComponentHarness, SkyCoreTestingModule, SkyHarnessUtility, SkyHelpTestingController, SkyHelpTestingModule, SkyInputHarness, SkyMediaQueryTestingController, SkyOverlayHarness, SkyQueryableComponentHarness, mockResizeObserver, mockResizeObserverEntry, mockResizeObserverHandle, provideSkyFileReaderTesting, provideSkyMediaQueryTesting };
+export { MockSkyMediaQueryService, MockSkyUIConfigService, SkyAppTestUtility, SkyBy, SkyComponentHarness, SkyCoreTestingModule, SkyHarnessUtility, SkyHelpTestingController, SkyHelpTestingModule, SkyInputHarness, SkyInstrumentationTestingController, SkyMediaQueryTestingController, SkyOverlayHarness, SkyQueryableComponentHarness, mockResizeObserver, mockResizeObserverEntry, mockResizeObserverHandle, provideSkyFileReaderTesting, provideSkyInstrumentationTesting, provideSkyMediaQueryTesting };
 export type { SkyAppTestUtilityDomEventOptions, SkyHarnessFilters, SkyOverlayHarnessFilters };

package/types/skyux-core.d.ts

@@ -1,5 +1,5 @@
 import * as i0 from '@angular/core';
-import { RendererFactory2, ElementRef, OnInit, OnChanges, OnDestroy, EventEmitter, SimpleChanges, Renderer2, NgZone, EnvironmentProviders, StaticProvider, Type, ViewContainerRef, EnvironmentInjector, ApplicationRef, ComponentRef, InjectionToken, Provider, Injector, PipeTransform, ChangeDetectorRef, TemplateRef, EmbeddedViewRef, AfterViewInit } from '@angular/core';
+import { RendererFactory2, ElementRef, OnInit, OnChanges, OnDestroy, EventEmitter, SimpleChanges, Renderer2, NgZone, EnvironmentProviders, StaticProvider, Type, ViewContainerRef, EnvironmentInjector, ApplicationRef, ComponentRef, InjectionToken, Injector, Provider, PipeTransform, ChangeDetectorRef, TemplateRef, EmbeddedViewRef, AfterViewInit } from '@angular/core';
 import { ViewportRuler } from '@angular/cdk/overlay';
 import { Observable, ReplaySubject, Subscription } from 'rxjs';
 import * as i1 from '@skyux/i18n';
@@ -846,6 +846,93 @@ declare class SkyIdService {
     static ɵprov: i0.ɵɵInjectableDeclaration<SkyIdService>;
 }
 
+/**
+ * Describes the region of the page that an instrumentation event came from.
+ */
+interface SkyInstrumentationContextValue {
+    /**
+     * Identifies the context. Listeners filter on this value.
+     */
+    name: string;
+    /**
+     * Values describing the context, such as record identifiers.
+     */
+    detail?: Record<string, unknown>;
+    /**
+     * The context that encloses this one, when contexts are nested. Walk this
+     * chain to read the name and detail of each enclosing context.
+     */
+    parent?: SkyInstrumentationContextValue;
+}
+/**
+ * An interaction reported by a SKY UX component, delivered to every registered
+ * `SkyInstrumentationListener`.
+ */
+interface SkyInstrumentationEvent {
+    /**
+     * The context resolved from the nearest `skyInstrumentationContext`, or
+     * `undefined` when the component is not within one.
+     */
+    context?: SkyInstrumentationContextValue;
+    /**
+     * The name of the event, such as `sky.help-inline.help-requested`.
+     */
+    eventName: string;
+    /**
+     * Values describing the interaction, such as the help key that was requested.
+     */
+    eventDetail?: Record<string, unknown>;
+}
+
+/**
+ * Describes the region of the page that the instrumentation events emitted
+ * within this element came from. Nest contexts to add more specific
+ * information.
+ */
+declare class SkyInstrumentationContext {
+    /**
+     * The context to attach to instrumentation events emitted within this
+     * element.
+     */
+    readonly skyInstrumentationContext: i0.InputSignal<SkyInstrumentationContextValue>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SkyInstrumentationContext, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<SkyInstrumentationContext, "[skyInstrumentationContext]", never, { "skyInstrumentationContext": { "alias": "skyInstrumentationContext"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+/**
+ * Forwards the instrumentation context resolved from the given injector to a
+ * dynamically created component, such as a modal or flyout, which would
+ * otherwise render outside of the launching element.
+ */
+declare function provideSkyInstrumentationContextFrom(injector: Injector): StaticProvider[];
+
+/**
+ * @internal
+ */
+interface _SkyInstrumentationEmitter {
+    emit(eventName: string, eventDetail?: Record<string, unknown>): void;
+}
+/**
+ * @internal
+ */
+declare function _injectSkyInstrumentationEmitter(): _SkyInstrumentationEmitter;
+
+/**
+ * Receives the instrumentation events emitted by SKY UX components.
+ */
+interface SkyInstrumentationListener {
+    /**
+     * Called once for each event, in the order the events are emitted.
+     */
+    handleEvent(evt: SkyInstrumentationEvent): void;
+}
+/**
+ * Registers a listener to receive instrumentation events. Provide this in your
+ * application config so that components in lazy-loaded routes can reach the
+ * listener.
+ */
+declare function provideSkyInstrumentationListener(listener: Type<SkyInstrumentationListener>): EnvironmentProviders;
+
 interface SkyLayoutHostForChildArgs {
     layout: string;
 }
@@ -1768,5 +1855,5 @@ declare class Version {
  */
 declare const VERSION: Version;
 
-export { NumericOptions, SKY_BREAKPOINTS, SKY_BREAKPOINT_OBSERVER, SKY_HELP_GLOBAL_OPTIONS, SKY_ICON_SVG_URL, SKY_LOG_LEVEL, SKY_STACKING_CONTEXT, SkyAffixAutoFitContext, SkyAffixModule, SkyAffixService, SkyAffixer, SkyAppFormat, SkyAppTitleService, SkyAppWindowRef, SkyContainerBreakpointObserver, SkyContentInfoProvider, SkyCoreAdapterModule, SkyCoreAdapterService, SkyDefaultInputProvider, SkyDockItem, SkyDockLocation, SkyDockModule, SkyDockService, SkyDynamicComponentLegacyService, SkyDynamicComponentLocation, SkyDynamicComponentModule, SkyDynamicComponentService, SkyFileReaderService, SkyHelpService, SkyIdModule, SkyIdService, SkyLayoutHostDirective, SkyLayoutHostService, SkyLiveAnnouncerService, SkyLogLevel, SkyLogModule, SkyLogService, SkyMediaBreakpointObserver, SkyMediaBreakpoints, SkyMediaQueryModule, SkyMediaQueryService, SkyMutationObserverService, SkyNumericModule, SkyNumericPipe, SkyNumericService, SkyOverlayInstance, SkyOverlayLegacyService, SkyOverlayModule, SkyOverlayService, SkyPercentPipe, SkyPercentPipeModule, SkyResizeObserverMediaQueryService, SkyResizeObserverService, SkyResponsiveHostDirective, SkyScreenReaderLabelDirective, SkyScrollShadowDirective, SkyScrollableHostService, SkyTrimModule, SkyUIConfigService, SkyViewkeeper, SkyViewkeeperHostOptions, SkyViewkeeperModule, SkyViewkeeperService, VERSION, _SkyAnimationEndHandlerDirective, _SkyAnimationSlideComponent, _SkyTransitionEndHandlerDirective, provideNoopSkyAnimations, provideSkyBreakpointObserver, SkyAffixDirective as λ1, SkyIdDirective as λ2, SkyViewkeeperDirective as λ3, SkyTrimDirective as λ4 };
-export type { SkyAffixConfig, SkyAffixHorizontalAlignment, SkyAffixOffset, SkyAffixOffsetChange, SkyAffixPlacement, SkyAffixPlacementChange, SkyAffixPosition, SkyAffixVerticalAlignment, SkyAppSetTitleArgs, SkyBreakpoint, SkyBreakpointObserver, SkyContentInfo, SkyContentInfoDescriptor, SkyDockInsertComponentConfig, SkyDockItemConfig, SkyDockOptions, SkyDynamicComponentOptions, SkyFocusableChildrenOptions, SkyHelpGlobalOptions, SkyHelpOpenArgs, SkyHelpUpdateArgs, SkyLayoutHostForChildArgs, SkyLiveAnnouncerArgs, SkyLiveAnnouncerPoliteness, SkyMediaQueryListener, SkyNumericOptions, SkyNumericSymbol, SkyOverlayConfig, SkyOverlayPosition, SkyScrollShadowEventArgs, SkyStackingContext, SkyViewkeeperOptions };
+export { NumericOptions, SKY_BREAKPOINTS, SKY_BREAKPOINT_OBSERVER, SKY_HELP_GLOBAL_OPTIONS, SKY_ICON_SVG_URL, SKY_LOG_LEVEL, SKY_STACKING_CONTEXT, SkyAffixAutoFitContext, SkyAffixModule, SkyAffixService, SkyAffixer, SkyAppFormat, SkyAppTitleService, SkyAppWindowRef, SkyContainerBreakpointObserver, SkyContentInfoProvider, SkyCoreAdapterModule, SkyCoreAdapterService, SkyDefaultInputProvider, SkyDockItem, SkyDockLocation, SkyDockModule, SkyDockService, SkyDynamicComponentLegacyService, SkyDynamicComponentLocation, SkyDynamicComponentModule, SkyDynamicComponentService, SkyFileReaderService, SkyHelpService, SkyIdModule, SkyIdService, SkyInstrumentationContext, SkyLayoutHostDirective, SkyLayoutHostService, SkyLiveAnnouncerService, SkyLogLevel, SkyLogModule, SkyLogService, SkyMediaBreakpointObserver, SkyMediaBreakpoints, SkyMediaQueryModule, SkyMediaQueryService, SkyMutationObserverService, SkyNumericModule, SkyNumericPipe, SkyNumericService, SkyOverlayInstance, SkyOverlayLegacyService, SkyOverlayModule, SkyOverlayService, SkyPercentPipe, SkyPercentPipeModule, SkyResizeObserverMediaQueryService, SkyResizeObserverService, SkyResponsiveHostDirective, SkyScreenReaderLabelDirective, SkyScrollShadowDirective, SkyScrollableHostService, SkyTrimModule, SkyUIConfigService, SkyViewkeeper, SkyViewkeeperHostOptions, SkyViewkeeperModule, SkyViewkeeperService, VERSION, _SkyAnimationEndHandlerDirective, _SkyAnimationSlideComponent, _SkyTransitionEndHandlerDirective, _injectSkyInstrumentationEmitter, provideNoopSkyAnimations, provideSkyBreakpointObserver, provideSkyInstrumentationContextFrom, provideSkyInstrumentationListener, SkyAffixDirective as λ1, SkyIdDirective as λ2, SkyViewkeeperDirective as λ3, SkyTrimDirective as λ4 };
+export type { SkyAffixConfig, SkyAffixHorizontalAlignment, SkyAffixOffset, SkyAffixOffsetChange, SkyAffixPlacement, SkyAffixPlacementChange, SkyAffixPosition, SkyAffixVerticalAlignment, SkyAppSetTitleArgs, SkyBreakpoint, SkyBreakpointObserver, SkyContentInfo, SkyContentInfoDescriptor, SkyDockInsertComponentConfig, SkyDockItemConfig, SkyDockOptions, SkyDynamicComponentOptions, SkyFocusableChildrenOptions, SkyHelpGlobalOptions, SkyHelpOpenArgs, SkyHelpUpdateArgs, SkyInstrumentationContextValue, SkyInstrumentationEvent, SkyInstrumentationListener, SkyLayoutHostForChildArgs, SkyLiveAnnouncerArgs, SkyLiveAnnouncerPoliteness, SkyMediaQueryListener, SkyNumericOptions, SkyNumericSymbol, SkyOverlayConfig, SkyOverlayPosition, SkyScrollShadowEventArgs, SkyStackingContext, SkyViewkeeperOptions, _SkyInstrumentationEmitter };