@truenas/ui-components 0.1.27 → 0.1.29

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truenas/ui-components",
-  "version": "0.1.27",
+  "version": "0.1.29",
   "publishConfig": {
     "registry": "https://registry.npmjs.org",
     "access": "public"

package/types/truenas-ui-components.d.ts

@@ -2134,6 +2134,140 @@ declare class TnFormFieldComponent implements AfterContentInit {
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<TnFormFieldComponent, "tn-form-field", never, { "label": { "alias": "label"; "required": false; "isSignal": true; }; "hint": { "alias": "hint"; "required": false; "isSignal": true; }; "required": { "alias": "required"; "required": false; "isSignal": true; }; "testId": { "alias": "testId"; "required": false; "isSignal": true; }; }, {}, ["control"], ["*"], true, never>;
 }
 
+/**
+ * Harness for interacting with `tn-form-field` in tests.
+ * Provides methods for querying label, hint, error state, and accessing
+ * the projected form control.
+ *
+ * @example
+ * ```typescript
+ * // Find a form field by label
+ * const field = await loader.getHarness(TnFormFieldHarness.with({ label: 'Email' }));
+ * expect(await field.getLabel()).toBe('Email');
+ *
+ * // Check for validation errors
+ * expect(await field.hasError()).toBe(true);
+ * expect(await field.getErrorMessage()).toBe('This field is required');
+ *
+ * // Check hint text
+ * const hinted = await loader.getHarness(TnFormFieldHarness.with({ label: 'Port' }));
+ * expect(await hinted.getHint()).toBe('Default port is 443');
+ *
+ * // Find by testId
+ * const field = await loader.getHarness(TnFormFieldHarness.with({ testId: 'email-field' }));
+ * ```
+ */
+declare class TnFormFieldHarness extends ComponentHarness {
+    /**
+     * The selector for the host element of a `TnFormFieldComponent` instance.
+     */
+    static hostSelector: string;
+    private _label;
+    private _error;
+    private _hint;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a form field
+     * with specific attributes.
+     *
+     * @param options Options for filtering which form field instances are considered a match.
+     * @returns A `HarnessPredicate` configured with the given options.
+     *
+     * @example
+     * ```typescript
+     * // Find by label text
+     * const field = await loader.getHarness(TnFormFieldHarness.with({ label: 'Name' }));
+     *
+     * // Find by label regex
+     * const field = await loader.getHarness(TnFormFieldHarness.with({ label: /email/i }));
+     *
+     * // Find by testId
+     * const field = await loader.getHarness(TnFormFieldHarness.with({ testId: 'name-field' }));
+     * ```
+     */
+    static with(options?: FormFieldHarnessFilters): HarnessPredicate<TnFormFieldHarness>;
+    /**
+     * Gets the form field label text.
+     *
+     * @returns Promise resolving to the label text, or empty string if no label.
+     *
+     * @example
+     * ```typescript
+     * const field = await loader.getHarness(TnFormFieldHarness.with({ label: 'Name' }));
+     * expect(await field.getLabel()).toBe('Name');
+     * ```
+     */
+    getLabel(): Promise<string>;
+    /**
+     * Gets the error message text, if visible.
+     *
+     * @returns Promise resolving to the error message, or null if no error is shown.
+     *
+     * @example
+     * ```typescript
+     * const field = await loader.getHarness(TnFormFieldHarness.with({ label: 'Email' }));
+     * expect(await field.getErrorMessage()).toBe('Please enter a valid email address');
+     * ```
+     */
+    getErrorMessage(): Promise<string | null>;
+    /**
+     * Checks whether the form field is currently showing an error.
+     *
+     * @returns Promise resolving to true if an error message is visible.
+     *
+     * @example
+     * ```typescript
+     * const field = await loader.getHarness(TnFormFieldHarness.with({ label: 'Email' }));
+     * expect(await field.hasError()).toBe(true);
+     * ```
+     */
+    hasError(): Promise<boolean>;
+    /**
+     * Gets the hint text, if visible.
+     *
+     * @returns Promise resolving to the hint text, or null if no hint is shown.
+     *
+     * @example
+     * ```typescript
+     * const field = await loader.getHarness(TnFormFieldHarness.with({ label: 'Port' }));
+     * expect(await field.getHint()).toBe('Default port is 443');
+     * ```
+     */
+    getHint(): Promise<string | null>;
+    /**
+     * Checks whether the form field is marked as required.
+     *
+     * @returns Promise resolving to true if the required asterisk is present.
+     *
+     * @example
+     * ```typescript
+     * const field = await loader.getHarness(TnFormFieldHarness.with({ label: 'Name' }));
+     * expect(await field.isRequired()).toBe(true);
+     * ```
+     */
+    isRequired(): Promise<boolean>;
+    /**
+     * Gets the test ID attribute value.
+     *
+     * @returns Promise resolving to the data-testid string, or null.
+     *
+     * @example
+     * ```typescript
+     * const field = await loader.getHarness(TnFormFieldHarness);
+     * expect(await field.getTestId()).toBe('email-field');
+     * ```
+     */
+    getTestId(): Promise<string | null>;
+}
+/**
+ * A set of criteria that can be used to filter a list of `TnFormFieldHarness` instances.
+ */
+interface FormFieldHarnessFilters extends BaseHarnessFilters {
+    /** Filters by label text. Supports string or regex matching. */
+    label?: string | RegExp;
+    /** Filters by data-testid attribute. */
+    testId?: string;
+}
+
 interface TnSelectOption<T = unknown> {
     value: T;
     label: string;
@@ -4745,5 +4879,5 @@ declare const TN_THEME_DEFINITIONS: readonly TnThemeDefinition[];
  */
 declare const THEME_MAP: Map<TnTheme, TnThemeDefinition>;
 
-export { CommonShortcuts, DEFAULT_THEME, DiskIconComponent, DiskType, FileSizePipe, InputType, LIGHT_THEME, LinuxModifierKeys, LinuxShortcuts, ModifierKeys, QuickShortcuts, ShortcutBuilder, StripMntPrefixPipe, THEME_MAP, THEME_STORAGE_KEY, TN_THEME_DEFINITIONS, TnAutocompleteComponent, TnAutocompleteHarness, TnBannerActionDirective, TnBannerComponent, TnBannerHarness, TnBrandedSpinnerComponent, TnButtonComponent, TnButtonHarness, TnButtonToggleComponent, TnButtonToggleGroupComponent, TnCalendarComponent, TnCalendarHeaderComponent, TnCardComponent, TnCellDefDirective, TnCheckboxComponent, TnCheckboxHarness, TnCheckboxLabelDirective, TnChipComponent, TnConfirmDialogComponent, TnDateInputComponent, TnDateRangeInputComponent, TnDialog, TnDialogHarness, TnDialogShellComponent, TnDialogTesting, TnDividerComponent, TnDividerDirective, TnDrawerComponent, TnDrawerContainerComponent, TnDrawerContainerHarness, TnDrawerContentComponent, TnDrawerHarness, TnEmptyComponent, TnEmptyHarness, TnExpansionPanelComponent, TnFilePickerComponent, TnFilePickerPopupComponent, TnFormFieldComponent, TnHeaderCellDefDirective, TnIconButtonComponent, TnIconButtonHarness, TnIconComponent, TnIconHarness, TnIconRegistryService, TnIconTesting, TnInputComponent, TnInputDirective, TnInputHarness, TnKeyboardShortcutComponent, TnKeyboardShortcutService, TnListAvatarDirective, TnListComponent, TnListIconDirective, TnListItemComponent, TnListItemLineDirective, TnListItemPrimaryDirective, TnListItemSecondaryDirective, TnListItemTitleDirective, TnListItemTrailingDirective, TnListOptionComponent, TnListSubheaderComponent, TnMenuActivateHoverDirective, TnMenuComponent, TnMenuTriggerDirective, TnMonthViewComponent, TnMultiYearViewComponent, TnNestedTreeNodeComponent, TnParticleProgressBarComponent, TnProgressBarComponent, TnRadioComponent, TnSelectComponent, TnSelectHarness, TnSelectionListComponent, TnSidePanelActionDirective, TnSidePanelComponent, TnSidePanelHarness, TnSidePanelHeaderActionDirective, TnSlideToggleComponent, TnSliderComponent, TnSliderThumbDirective, TnSliderWithLabelDirective, TnSpinnerComponent, TnSpriteLoaderService, TnStepComponent, TnStepperComponent, TnTabComponent, TnTabHarness, TnTabPanelComponent, TnTabPanelHarness, TnTableColumnDirective, TnTableComponent, TnTabsComponent, TnTabsHarness, TnTheme, TnThemeService, TnTimeInputComponent, TnTooltipComponent, TnTooltipDirective, TnTreeComponent, TnTreeFlatDataSource, TnTreeFlattener, TnTreeNodeComponent, TnTreeNodeOutletDirective, TruncatePathPipe, WindowsModifierKeys, WindowsShortcuts, createLucideLibrary, createShortcut, defaultSpriteBasePath, defaultSpriteConfigPath, libIconMarker, registerLucideIcons, setupLucideIntegration, tnIconMarker };
-export type { AutocompleteHarnessFilters, BannerHarnessFilters, ButtonHarnessFilters, CalendarCell, CheckboxHarnessFilters, ChipColor, CreateFolderEvent, DateRange, DialogHarnessFilters, EmptyHarnessFilters, FilePickerCallbacks, FilePickerError, FilePickerMode, FileSystemItem, IconButtonHarnessFilters, IconHarnessFilters, IconLibrary, IconLibraryType, IconResult, IconSize, IconSource, IconTestingMockOverrides, InputHarnessFilters, KeyCombination, LabelType, LucideIconOptions, MockIconRegistry, MockSpriteLoader, PathSegment, PlatformType, ProgressBarMode, ResolvedIcon, SelectHarnessFilters, ShortcutHandler, SidePanelHarnessFilters, SlideToggleColor, SpinnerMode, SpriteConfig, TabChangeEvent, TabHarnessFilters, TabPanelHarnessFilters, TabsHarnessFilters, TnBannerType, TnButtonToggleType, TnCardAction, TnCardControl, TnCardFooterLink, TnCardHeaderStatus, TnConfirmDialogData, TnDialogDefaults, TnDialogOpenTarget, TnDrawerMode, TnDrawerPosition, TnEmptySize, TnFlatTreeNode, TnMenuItem, TnSelectOption, TnSelectOptionGroup, TnSelectionChange, TnTableDataSource, TnThemeDefinition, TooltipPosition, YearCell };
+export { CommonShortcuts, DEFAULT_THEME, DiskIconComponent, DiskType, FileSizePipe, InputType, LIGHT_THEME, LinuxModifierKeys, LinuxShortcuts, ModifierKeys, QuickShortcuts, ShortcutBuilder, StripMntPrefixPipe, THEME_MAP, THEME_STORAGE_KEY, TN_THEME_DEFINITIONS, TnAutocompleteComponent, TnAutocompleteHarness, TnBannerActionDirective, TnBannerComponent, TnBannerHarness, TnBrandedSpinnerComponent, TnButtonComponent, TnButtonHarness, TnButtonToggleComponent, TnButtonToggleGroupComponent, TnCalendarComponent, TnCalendarHeaderComponent, TnCardComponent, TnCellDefDirective, TnCheckboxComponent, TnCheckboxHarness, TnCheckboxLabelDirective, TnChipComponent, TnConfirmDialogComponent, TnDateInputComponent, TnDateRangeInputComponent, TnDialog, TnDialogHarness, TnDialogShellComponent, TnDialogTesting, TnDividerComponent, TnDividerDirective, TnDrawerComponent, TnDrawerContainerComponent, TnDrawerContainerHarness, TnDrawerContentComponent, TnDrawerHarness, TnEmptyComponent, TnEmptyHarness, TnExpansionPanelComponent, TnFilePickerComponent, TnFilePickerPopupComponent, TnFormFieldComponent, TnFormFieldHarness, TnHeaderCellDefDirective, TnIconButtonComponent, TnIconButtonHarness, TnIconComponent, TnIconHarness, TnIconRegistryService, TnIconTesting, TnInputComponent, TnInputDirective, TnInputHarness, TnKeyboardShortcutComponent, TnKeyboardShortcutService, TnListAvatarDirective, TnListComponent, TnListIconDirective, TnListItemComponent, TnListItemLineDirective, TnListItemPrimaryDirective, TnListItemSecondaryDirective, TnListItemTitleDirective, TnListItemTrailingDirective, TnListOptionComponent, TnListSubheaderComponent, TnMenuActivateHoverDirective, TnMenuComponent, TnMenuTriggerDirective, TnMonthViewComponent, TnMultiYearViewComponent, TnNestedTreeNodeComponent, TnParticleProgressBarComponent, TnProgressBarComponent, TnRadioComponent, TnSelectComponent, TnSelectHarness, TnSelectionListComponent, TnSidePanelActionDirective, TnSidePanelComponent, TnSidePanelHarness, TnSidePanelHeaderActionDirective, TnSlideToggleComponent, TnSliderComponent, TnSliderThumbDirective, TnSliderWithLabelDirective, TnSpinnerComponent, TnSpriteLoaderService, TnStepComponent, TnStepperComponent, TnTabComponent, TnTabHarness, TnTabPanelComponent, TnTabPanelHarness, TnTableColumnDirective, TnTableComponent, TnTabsComponent, TnTabsHarness, TnTheme, TnThemeService, TnTimeInputComponent, TnTooltipComponent, TnTooltipDirective, TnTreeComponent, TnTreeFlatDataSource, TnTreeFlattener, TnTreeNodeComponent, TnTreeNodeOutletDirective, TruncatePathPipe, WindowsModifierKeys, WindowsShortcuts, createLucideLibrary, createShortcut, defaultSpriteBasePath, defaultSpriteConfigPath, libIconMarker, registerLucideIcons, setupLucideIntegration, tnIconMarker };
+export type { AutocompleteHarnessFilters, BannerHarnessFilters, ButtonHarnessFilters, CalendarCell, CheckboxHarnessFilters, ChipColor, CreateFolderEvent, DateRange, DialogHarnessFilters, EmptyHarnessFilters, FilePickerCallbacks, FilePickerError, FilePickerMode, FileSystemItem, FormFieldHarnessFilters, IconButtonHarnessFilters, IconHarnessFilters, IconLibrary, IconLibraryType, IconResult, IconSize, IconSource, IconTestingMockOverrides, InputHarnessFilters, KeyCombination, LabelType, LucideIconOptions, MockIconRegistry, MockSpriteLoader, PathSegment, PlatformType, ProgressBarMode, ResolvedIcon, SelectHarnessFilters, ShortcutHandler, SidePanelHarnessFilters, SlideToggleColor, SpinnerMode, SpriteConfig, TabChangeEvent, TabHarnessFilters, TabPanelHarnessFilters, TabsHarnessFilters, TnBannerType, TnButtonToggleType, TnCardAction, TnCardControl, TnCardFooterLink, TnCardHeaderStatus, TnConfirmDialogData, TnDialogDefaults, TnDialogOpenTarget, TnDrawerMode, TnDrawerPosition, TnEmptySize, TnFlatTreeNode, TnMenuItem, TnSelectOption, TnSelectOptionGroup, TnSelectionChange, TnTableDataSource, TnThemeDefinition, TooltipPosition, YearCell };