@skyux/lookup 11.11.2 → 11.13.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/lookup",
-  "version": "11.11.2",
+  "version": "11.13.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -42,16 +42,16 @@
     "@angular/core": "^18.2.8",
     "@angular/forms": "^18.2.8",
     "@angular/platform-browser": "^18.2.8",
-    "@skyux-sdk/testing": "11.11.2",
-    "@skyux/core": "11.11.2",
-    "@skyux/forms": "11.11.2",
-    "@skyux/i18n": "11.11.2",
-    "@skyux/icon": "11.11.2",
-    "@skyux/indicators": "11.11.2",
-    "@skyux/layout": "11.11.2",
-    "@skyux/lists": "11.11.2",
-    "@skyux/modals": "11.11.2",
-    "@skyux/theme": "11.11.2"
+    "@skyux-sdk/testing": "11.13.0",
+    "@skyux/core": "11.13.0",
+    "@skyux/forms": "11.13.0",
+    "@skyux/i18n": "11.13.0",
+    "@skyux/icon": "11.13.0",
+    "@skyux/indicators": "11.13.0",
+    "@skyux/layout": "11.13.0",
+    "@skyux/lists": "11.13.0",
+    "@skyux/modals": "11.13.0",
+    "@skyux/theme": "11.13.0"
   },
   "dependencies": {
     "intl-tel-input": "24.4.0",

package/testing/country-field/country-field-harness-filters.d.ts

@@ -0,0 +1,6 @@
+import { SkyHarnessFilters } from '@skyux/core/testing';
+/**
+ * A set of criteria that can be used to filter a list of `SkyCountryFieldHarness` instances.
+ */
+export interface SkyCountryFieldHarnessFilters extends SkyHarnessFilters {
+}

package/testing/country-field/country-field-harness.d.ts

@@ -0,0 +1,85 @@
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { SkyAutocompleteHarness } from '../autocomplete/autocomplete-harness';
+import { SkyCountryFieldHarnessFilters } from './country-field-harness-filters';
+import { SkyCountryFieldSearchResultHarness } from './country-field-search-result-harness';
+import { SkyCountryFieldSearchResultHarnessFilters } from './country-field-search-result-harness-filters';
+/**
+ * Harness for interacting with a country field component in tests.
+ */
+export declare class SkyCountryFieldHarness extends SkyAutocompleteHarness {
+    #private;
+    /**
+     * Finds a standard country field component, or a country field component that is wrapped by an input box component.
+     * For input box implementations, we need to use the `.sky-input-box` selector since the `sky-country-field`
+     * element is removed from the DOM.
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyCountryFieldHarness` that meets certain criteria.
+     * These filters only work for standalone country fields.
+     * For country fields wrapped inside `sky-input-box`, place filters
+     * on the input box instead, and query the country field using a `SkyInputBoxHarness`.
+     * For the input box implementation, see the code example.
+     */
+    static with(filters: SkyCountryFieldHarnessFilters): HarnessPredicate<SkyCountryFieldHarness>;
+    /**
+     * Blurs the country field input.
+     */
+    blur(): Promise<void>;
+    /**
+     * Clears the country field input value.
+     */
+    clear(): Promise<void>;
+    /**
+     * Enters text into the country field input.
+     */
+    enterText(value: string): Promise<void>;
+    /**
+     * Focuses the country field input.
+     */
+    focus(): Promise<void>;
+    /**
+     * Gets the country field  `aria-labelledby` value.
+     * This is not needed for country field because the id is generated internally,
+     * and the method is marked internal to prevent it from being documented publicly.
+     * @internal
+     */
+    getAriaLabelledby(): Promise<string | null>;
+    /**
+     * Returns country field search result harnesses.
+     */
+    getSearchResults(filters?: SkyCountryFieldSearchResultHarnessFilters): Promise<SkyCountryFieldSearchResultHarness[]>;
+    /**
+     * Returns the text content for each country field search result.
+     */
+    getSearchResultsText(filters?: SkyCountryFieldSearchResultHarnessFilters): Promise<string[]>;
+    /**
+     * Gets the value of the country field input.
+     */
+    getValue(): Promise<string>;
+    /**
+     * Gets the text displayed when no search results are found.
+     * For a country field, this is always the default text and the method
+     * is marked internal to prevent it from being documented publicly.
+     * @internal
+     */
+    getNoResultsFoundText(): Promise<string | undefined>;
+    /**
+     * Whether the country field input is disabled.
+     */
+    isDisabled(): Promise<boolean>;
+    /**
+     * Whether the country field input is focused.
+     */
+    isFocused(): Promise<boolean>;
+    /**
+     * Whether the country field is open.
+     */
+    isOpen(): Promise<boolean>;
+    /**
+     * Selects a search result.
+     */
+    selectSearchResult(filters: SkyCountryFieldSearchResultHarnessFilters): Promise<void>;
+}

package/testing/country-field/country-field-search-result-harness-filters.d.ts

@@ -0,0 +1,7 @@
+import { SkyAutocompleteSearchResultHarnessFilters } from '../public-api';
+/**
+ * A set of criteria that can be used to filter a list of `SkyCountryFieldSearchResultHarness` instances.
+ * @internal
+ */
+export interface SkyCountryFieldSearchResultHarnessFilters extends SkyAutocompleteSearchResultHarnessFilters {
+}

package/testing/country-field/country-field-search-result-harness.d.ts

@@ -0,0 +1,20 @@
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { SkyAutocompleteSearchResultHarness } from '../autocomplete/autocomplete-search-result-harness';
+import { SkyCountryFieldSearchResultHarnessFilters } from './country-field-search-result-harness-filters';
+/**
+ * Harness for interacting with an autocomplete search result in tests.
+ */
+export declare class SkyCountryFieldSearchResultHarness extends SkyAutocompleteSearchResultHarness {
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyCountryFieldSearchResultHarness` that meets certain criteria.
+     */
+    static with(filters: SkyCountryFieldSearchResultHarnessFilters): HarnessPredicate<SkyCountryFieldSearchResultHarness>;
+    /**
+     * Returns the value of the search result's descriptor property.
+     * This is not needed by country field because it is always set to the country name,
+     * and the method is marked internal to prevent it from being documented publicly.
+     * @internal
+     */
+    getDescriptorValue(): Promise<string>;
+}

package/testing/public-api.d.ts

@@ -3,6 +3,10 @@ export { SkyAutocompleteHarnessFilters } from './autocomplete/autocomplete-harne
 export { SkyAutocompleteSearchResultHarness } from './autocomplete/autocomplete-search-result-harness';
 export { SkyAutocompleteSearchResultHarnessFilters } from './autocomplete/autocomplete-search-result-harness-filters';
 export { SkyCountryFieldFixture } from './country-field/country-field-fixture';
+export { SkyCountryFieldHarness } from './country-field/country-field-harness';
+export { SkyCountryFieldHarnessFilters } from './country-field/country-field-harness-filters';
+export { SkyCountryFieldSearchResultHarness } from './country-field/country-field-search-result-harness';
+export { SkyCountryFieldSearchResultHarnessFilters } from './country-field/country-field-search-result-harness-filters';
 export { SkyCountryFieldTestingModule } from './country-field/country-field-testing.module';
 export { SkyLookupHarness } from './lookup/lookup-harness';
 export { SkyLookupHarnessFilters } from './lookup/lookup-harness-filters';