@skyux/lists 12.0.0-alpha.8 → 12.0.0-beta.0

package/fesm2022/skyux-lists-testing.mjs

@@ -2,12 +2,13 @@ import { SkyAppTestUtility } from '@skyux-sdk/testing';
 import * as i0 from '@angular/core';
 import { NgModule } from '@angular/core';
 import { SkyFilterModule, SkyPagingModule, SkySortModule, SkyInfiniteScrollModule } from '@skyux/lists';
+import { SkyComponentHarness, SkyQueryableComponentHarness } from '@skyux/core/testing';
+import { SkyTokenHarness, SkyChevronHarness } from '@skyux/indicators/testing';
 import { By } from '@angular/platform-browser';
-import { SkyQueryableComponentHarness, SkyComponentHarness } from '@skyux/core/testing';
-import { HarnessPredicate } from '@angular/cdk/testing';
+import { ComponentHarness, HarnessPredicate } from '@angular/cdk/testing';
 import { SkyCheckboxHarness } from '@skyux/forms/testing';
-import { SkyChevronHarness } from '@skyux/indicators/testing';
 import { NoopAnimationsModule } from '@angular/platform-browser/animations';
+import { SkyDropdownItemHarness, SkyDropdownHarness } from '@skyux/popovers/testing';
 
 /**
  * Provides information for and interaction with a SKY UX filter button component.
@@ -96,17 +97,212 @@ class SkyFilterFixtureSummary {
  * @internal
  */
 class SkyFilterTestingModule {
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.0.5", ngImport: i0, type: SkyFilterTestingModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
-    static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "19.0.5", ngImport: i0, type: SkyFilterTestingModule, exports: [SkyFilterModule] }); }
-    static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "19.0.5", ngImport: i0, type: SkyFilterTestingModule, imports: [SkyFilterModule] }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.2.1", ngImport: i0, type: SkyFilterTestingModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
+    static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "19.2.1", ngImport: i0, type: SkyFilterTestingModule, exports: [SkyFilterModule] }); }
+    static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "19.2.1", ngImport: i0, type: SkyFilterTestingModule, imports: [SkyFilterModule] }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.0.5", ngImport: i0, type: SkyFilterTestingModule, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.1", ngImport: i0, type: SkyFilterTestingModule, decorators: [{
             type: NgModule,
             args: [{
                     exports: [SkyFilterModule],
                 }]
         }] });
 
+/**
+ * Harness for interacting with a filter button component in tests.
+ */
+class SkyFilterButtonHarness extends SkyComponentHarness {
+    /**
+     * @internal
+     */
+    static { this.hostSelector = 'sky-filter-button'; }
+    #getFilterButton = this.locatorFor('button.sky-filter-btn');
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyFilterButtonHarness` that meets certain criteria.
+     */
+    static with(filters) {
+        return this.getDataSkyIdPredicate(filters);
+    }
+    /**
+     * Clicks the filter button.
+     */
+    async clickFilterButton() {
+        return await (await this.#getFilterButton()).click();
+    }
+    /**
+     * Gets the filter button's aria-controls attribute.
+     */
+    async getAriaControls() {
+        return await (await this.#getFilterButton()).getAttribute('aria-controls');
+    }
+    /**
+     * Gets the filter button's aria-expanded attribute.
+     */
+    async getAriaExpanded() {
+        const expanded = await (await this.#getFilterButton()).getAttribute('aria-expanded');
+        return !!expanded && expanded === 'true';
+    }
+    /**
+     * Gets the filter button's aria-label.
+     */
+    async getAriaLabel() {
+        return await (await this.#getFilterButton()).getAttribute('aria-label');
+    }
+    /**
+     * Gets the filter button's id.
+     */
+    async getButtonId() {
+        return await (await this.#getFilterButton()).getAttribute('id');
+    }
+    /**
+     * Gets the text that appears on the filter button.
+     */
+    async getButtonText() {
+        const text = await (await this.locatorForOptional('.sky-filter-btn-text')())?.text();
+        return text ?? '';
+    }
+    /**
+     * Whether the filter button is active.
+     */
+    async isActive() {
+        return await (await this.#getFilterButton()).hasClass('sky-filter-btn-active');
+    }
+    /**
+     * Whether the filter button is disabled.
+     */
+    async isDisabled() {
+        const disabled = await (await this.#getFilterButton()).getAttribute('disabled');
+        return disabled !== null;
+    }
+}
+
+/**
+ * Harness to interact with a filter inline item component in tests.
+ */
+class SkyFilterInlineItemHarness extends SkyQueryableComponentHarness {
+    /**
+     * @internal
+     */
+    static { this.hostSelector = 'sky-filter-inline-item'; }
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyFilterInlineItemHarness` that meets certain criteria.
+     */
+    static with(filters) {
+        return SkyFilterInlineItemHarness.getDataSkyIdPredicate(filters);
+    }
+}
+
+/**
+ * Harness to interact with a filter inline component in tests.
+ */
+class SkyFilterInlineHarness extends SkyComponentHarness {
+    /**
+     * @internal
+     */
+    static { this.hostSelector = 'sky-filter-inline'; }
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyFilterInlineHarness` that meets certain criteria.
+     */
+    static with(filters) {
+        return SkyFilterInlineHarness.getDataSkyIdPredicate(filters);
+    }
+    /**
+     * Gets a harness for a specific toolbar item that meets certain criteria.
+     */
+    async getItem(filter) {
+        return await this.locatorFor(SkyFilterInlineItemHarness.with(filter))();
+    }
+    /**
+     * Gets an array of all toolbar items.
+     */
+    async getItems(filters) {
+        const items = await this.locatorForAll(SkyFilterInlineItemHarness.with(filters || {}))();
+        if (items.length === 0) {
+            if (filters) {
+                throw new Error(`Unable to find any filter inline items with filter(s): ${JSON.stringify(filters)}`);
+            }
+            throw new Error('Unable to find any filter inline items.');
+        }
+        return items;
+    }
+}
+
+/**
+ * Harness to interact with a filter summary item component in tests.
+ */
+class SkyFilterSummaryItemHarness extends SkyComponentHarness {
+    /**
+     * @internal
+     */
+    static { this.hostSelector = 'sky-filter-summary-item'; }
+    #getSummaryItem = this.locatorFor('.sky-filter-summary-item');
+    #getToken = this.locatorFor(SkyTokenHarness);
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyFilterSummaryItemHarness` that meets certain criteria.
+     */
+    static with(filters) {
+        return SkyFilterSummaryItemHarness.getDataSkyIdPredicate(filters);
+    }
+    /**
+     * Clicks the filter summary item.
+     */
+    async clickItem() {
+        await (await this.#getSummaryItem()).click();
+    }
+    /**
+     * Dismisses the filter summary item.
+     */
+    async dismiss() {
+        await (await this.#getToken()).dismiss();
+    }
+    /**
+     * Whether the filter summary item is dismissible.
+     */
+    async isDismissible() {
+        return await (await this.#getToken()).isDismissible();
+    }
+}
+
+/**
+ * Harness to interact with a filter summary component in tests.
+ */
+class SkyFilterSummaryHarness extends SkyComponentHarness {
+    /**
+     * @internal
+     */
+    static { this.hostSelector = 'sky-filter-summary'; }
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyFilterSummaryHarness` that meets certain criteria.
+     */
+    static with(filters) {
+        return SkyFilterSummaryHarness.getDataSkyIdPredicate(filters);
+    }
+    /**
+     * Gets a harness for a specific toolbar item that meets certain criteria.
+     */
+    async getItem(filter) {
+        return await this.locatorFor(SkyFilterSummaryItemHarness.with(filter))();
+    }
+    /**
+     * Gets an array of all toolbar items.
+     */
+    async getItems(filters) {
+        const items = await this.locatorForAll(SkyFilterSummaryItemHarness.with(filters || {}))();
+        if (items.length === 0) {
+            if (filters) {
+                throw new Error(`Unable to find any filter summary items with filter(s): ${JSON.stringify(filters)}`);
+            }
+            throw new Error('Unable to find any filter summary items.');
+        }
+        return items;
+    }
+}
+
 /**
  * Provides information for and interaction with a SKY UX paging component.
  * By using the fixture API, a test insulates itself against updates to the internals
@@ -204,17 +400,139 @@ class SkyPagingFixture {
  * @internal
  */
 class SkyPagingTestingModule {
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.0.5", ngImport: i0, type: SkyPagingTestingModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
-    static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "19.0.5", ngImport: i0, type: SkyPagingTestingModule, exports: [SkyPagingModule] }); }
-    static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "19.0.5", ngImport: i0, type: SkyPagingTestingModule, imports: [SkyPagingModule] }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.2.1", ngImport: i0, type: SkyPagingTestingModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
+    static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "19.2.1", ngImport: i0, type: SkyPagingTestingModule, exports: [SkyPagingModule] }); }
+    static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "19.2.1", ngImport: i0, type: SkyPagingTestingModule, imports: [SkyPagingModule] }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.0.5", ngImport: i0, type: SkyPagingTestingModule, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.1", ngImport: i0, type: SkyPagingTestingModule, decorators: [{
             type: NgModule,
             args: [{
                     exports: [SkyPagingModule],
                 }]
         }] });
 
+/**
+ * Harness to interact with a paging content component in tests.
+ */
+class SkyPagingContentHarness extends SkyQueryableComponentHarness {
+    /**
+     * @internal
+     */
+    static { this.hostSelector = 'sky-paging-content'; }
+}
+
+/**
+ * Harness to interact with a page control element in tests.
+ * @internal
+ */
+class SkyPageControlHarness extends ComponentHarness {
+    /**
+     * @internal
+     */
+    static { this.hostSelector = 'li.sky-list-paging-link'; }
+    #getButton = this.locatorFor('button.sky-paging-btn');
+    static with(filters) {
+        return new HarnessPredicate(SkyPageControlHarness, filters).addOption('pageNumber', filters.pageNumber, (harness, pageNumber) => harness
+            .getText()
+            .then((actualPageNumber) => parseInt(actualPageNumber) === pageNumber));
+    }
+    /**
+     * Clicks the page button.
+     */
+    async clickButton() {
+        await (await this.#getButton()).click();
+    }
+    /**
+     * Gets the page button text.
+     */
+    async getText() {
+        const button = await this.#getButton();
+        return await button.text();
+    }
+}
+
+/**
+ * Harness for interacting with a paging component in tests.
+ */
+class SkyPagingHarness extends SkyComponentHarness {
+    /**
+     * @internal
+     */
+    static { this.hostSelector = 'sky-paging'; }
+    #getNextButton = this.locatorForOptional('li button.sky-paging-btn-next');
+    #getPreviousButton = this.locatorForOptional('li button.sky-paging-btn-previous');
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyPagingHarness` that meets certain criteria.
+     */
+    static with(filters) {
+        return SkyPagingHarness.getDataSkyIdPredicate(filters);
+    }
+    /**
+     * Clicks the next button.
+     */
+    async clickNextButton() {
+        const button = await this.#getNextButton();
+        if (button === null) {
+            throw new Error('Could not find the next button.');
+        }
+        if (await this.#buttonIsDisabled(button)) {
+            throw new Error('Could not click the next button because it is disabled.');
+        }
+        await button.click();
+    }
+    /**
+     * Clicks the page button with the requested number. Throws an error if that button is not present.
+     */
+    async clickPageButton(pageNumber) {
+        const button = await this.locatorForOptional(SkyPageControlHarness.with({ pageNumber: pageNumber }))();
+        if (button === null) {
+            throw new Error(`Could not find page button ${pageNumber}.`);
+        }
+        await button.clickButton();
+    }
+    /**
+     * Clicks the previous button.
+     */
+    async clickPreviousButton() {
+        const button = await this.#getPreviousButton();
+        if (button === null) {
+            throw new Error('Could not find the previous button.');
+        }
+        if (await this.#buttonIsDisabled(button)) {
+            throw new Error('Could not click the previous button because it is disabled.');
+        }
+        await button.click();
+    }
+    /**
+     * Gets the current page number.
+     */
+    async getCurrentPage() {
+        const currentPage = await this.locatorForOptional('button.sky-paging-current')();
+        if (currentPage === null) {
+            throw new Error('Could not find current page.');
+        }
+        return parseInt(await currentPage.text());
+    }
+    /**
+     * Gets the paging content.
+     */
+    async getPagingContent() {
+        return await this.locatorFor(SkyPagingContentHarness)();
+    }
+    async getPagingLabel() {
+        const pageNav = await this.locatorForOptional('nav.sky-paging')();
+        if (pageNav === null) {
+            throw new Error('Could not find paging label.');
+        }
+        return (await pageNav.getAttribute('aria-label'));
+    }
+    async #buttonIsDisabled(button) {
+        const disabled = await button.getAttribute('disabled');
+        return disabled !== null;
+    }
+}
+
 /**
  * Harness for interacting with a repeater item component in tests.
  */
@@ -534,11 +852,11 @@ class SkySortFixture {
  * @internal
  */
 class SkySortTestingModule {
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.0.5", ngImport: i0, type: SkySortTestingModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
-    static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "19.0.5", ngImport: i0, type: SkySortTestingModule, imports: [NoopAnimationsModule], exports: [SkySortModule] }); }
-    static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "19.0.5", ngImport: i0, type: SkySortTestingModule, imports: [NoopAnimationsModule, SkySortModule] }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.2.1", ngImport: i0, type: SkySortTestingModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
+    static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "19.2.1", ngImport: i0, type: SkySortTestingModule, imports: [NoopAnimationsModule], exports: [SkySortModule] }); }
+    static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "19.2.1", ngImport: i0, type: SkySortTestingModule, imports: [NoopAnimationsModule, SkySortModule] }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.0.5", ngImport: i0, type: SkySortTestingModule, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.1", ngImport: i0, type: SkySortTestingModule, decorators: [{
             type: NgModule,
             args: [{
                     imports: [NoopAnimationsModule],
@@ -546,6 +864,115 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.0.5", ngImpor
                 }]
         }] });
 
+/**
+ * Harness for interacting with a sort item component in tests.
+ */
+class SkySortItemHarness extends SkyDropdownItemHarness {
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkySortItemHarness` that meets certain criteria.
+     */
+    static with(filters) {
+        return new HarnessPredicate(this, filters).addOption('text', filters.text, async (harness, text) => {
+            const menuItemText = await harness.getText();
+            return await HarnessPredicate.stringMatches(menuItemText, text);
+        });
+    }
+    /**
+     * Clicks the sort item.
+     */
+    async click() {
+        await super.click();
+    }
+    /**
+     * Gets the sort item role.
+     * This can't be set on sort items and should not be exposed.
+     * @internal
+     */
+    async getAriaRole() {
+        return await super.getAriaRole();
+    }
+    /**
+     * Gets the sort item text.
+     */
+    async getText() {
+        return await super.getText();
+    }
+    /**
+     * Whether the sort item is active.
+     */
+    async isActive() {
+        return await (await this.locatorFor('.sky-sort-item')()).hasClass('sky-sort-item-selected');
+    }
+}
+
+/**
+ * Harness for interacting with a sort component in tests.
+ */
+class SkySortHarness extends SkyComponentHarness {
+    /**
+     * @internal
+     */
+    static { this.hostSelector = 'sky-sort'; }
+    #getDropdown = this.locatorFor(SkyDropdownHarness);
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkySortHarness` that meets certain criteria.
+     */
+    static with(filters) {
+        return SkySortHarness.getDataSkyIdPredicate(filters);
+    }
+    /**
+     * Clicks the sort component.
+     */
+    async click() {
+        await (await this.#getDropdown()).clickDropdownButton();
+    }
+    /**
+     * Gets the aria-label value.
+     */
+    async getAriaLabel() {
+        return await (await this.#getDropdown()).getAriaLabel();
+    }
+    /**
+     * Gets the text that appears on the sort button.
+     */
+    async getButtonText() {
+        const text = await (await this.locatorForOptional('.sky-sort-btn-text')())?.text();
+        return text ?? '';
+    }
+    /**
+     * Gets a harness for a specific sort item that meets certain criteria.
+     */
+    async getItem(filters) {
+        const menuHarness = await this.#getMenuHarness();
+        return await menuHarness.queryHarness(SkySortItemHarness.with(filters));
+    }
+    /**
+     * Gets an array of all sort items.
+     */
+    async getItems(filters) {
+        const menuHarness = await this.#getMenuHarness();
+        const items = await (filters
+            ? menuHarness.queryHarnesses(SkySortItemHarness.with(filters))
+            : menuHarness.queryHarnesses(SkySortItemHarness));
+        if (filters && !items.length) {
+            throw new Error(`Unable to find any sort items with filter(s): ${JSON.stringify(filters)}`);
+        }
+        return items;
+    }
+    async #getMenuHarness() {
+        try {
+            // eslint-disable-next-line no-var
+            var menuHarness = await (await this.#getDropdown()).getDropdownMenu();
+        }
+        catch {
+            throw new Error('Unable to locate any sort items because the sort menu is not open.');
+        }
+        return menuHarness;
+    }
+}
+
 /**
  * Provides information for and interaction with a SKY UX infinite scroll component.
  * By using the fixture API, a test insulates itself against updates to the internals
@@ -580,11 +1007,11 @@ class SkyInfiniteScrollFixture {
  * @internal
  */
 class SkyInfiniteScrollTestingModule {
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.0.5", ngImport: i0, type: SkyInfiniteScrollTestingModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
-    static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "19.0.5", ngImport: i0, type: SkyInfiniteScrollTestingModule, exports: [SkyInfiniteScrollModule] }); }
-    static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "19.0.5", ngImport: i0, type: SkyInfiniteScrollTestingModule, imports: [SkyInfiniteScrollModule] }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.2.1", ngImport: i0, type: SkyInfiniteScrollTestingModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
+    static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "19.2.1", ngImport: i0, type: SkyInfiniteScrollTestingModule, exports: [SkyInfiniteScrollModule] }); }
+    static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "19.2.1", ngImport: i0, type: SkyInfiniteScrollTestingModule, imports: [SkyInfiniteScrollModule] }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.0.5", ngImport: i0, type: SkyInfiniteScrollTestingModule, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.1", ngImport: i0, type: SkyInfiniteScrollTestingModule, decorators: [{
             type: NgModule,
             args: [{
                     exports: [SkyInfiniteScrollModule],
@@ -593,7 +1020,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.0.5", ngImpor
 
 /**
  * Harness for interacting with an infinite scroll component in tests.
- * @internal
  */
 class SkyInfiniteScrollHarness extends SkyComponentHarness {
     /**
@@ -643,5 +1069,5 @@ class SkyInfiniteScrollHarness extends SkyComponentHarness {
  * Generated bundle index. Do not edit.
  */
 
-export { SkyFilterFixtureButton, SkyFilterFixtureSummary, SkyFilterTestingModule, SkyInfiniteScrollFixture, SkyInfiniteScrollHarness, SkyInfiniteScrollTestingModule, SkyPagingFixture, SkyPagingTestingModule, SkyRepeaterHarness, SkyRepeaterItemHarness, SkySortFixture, SkySortTestingModule };
+export { SkyFilterButtonHarness, SkyFilterFixtureButton, SkyFilterFixtureSummary, SkyFilterInlineHarness, SkyFilterInlineItemHarness, SkyFilterSummaryHarness, SkyFilterSummaryItemHarness, SkyFilterTestingModule, SkyInfiniteScrollFixture, SkyInfiniteScrollHarness, SkyInfiniteScrollTestingModule, SkyPagingContentHarness, SkyPagingFixture, SkyPagingHarness, SkyPagingTestingModule, SkyRepeaterHarness, SkyRepeaterItemHarness, SkySortFixture, SkySortHarness, SkySortItemHarness, SkySortTestingModule };
 //# sourceMappingURL=skyux-lists-testing.mjs.map