@skyux/data-manager 12.1.0 → 12.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/data-manager",
-  "version": "12.1.0",
+  "version": "12.3.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -16,18 +16,19 @@
   },
   "homepage": "https://github.com/blackbaud/skyux#readme",
   "peerDependencies": {
+    "@angular/cdk": "^19.2.2",
     "@angular/common": "^19.2.1",
     "@angular/core": "^19.2.1",
     "@angular/forms": "^19.2.1",
-    "@skyux/core": "12.1.0",
-    "@skyux/forms": "12.1.0",
-    "@skyux/i18n": "12.1.0",
-    "@skyux/icon": "12.1.0",
-    "@skyux/indicators": "12.1.0",
-    "@skyux/layout": "12.1.0",
-    "@skyux/lists": "12.1.0",
-    "@skyux/lookup": "12.1.0",
-    "@skyux/modals": "12.1.0"
+    "@skyux/core": "12.3.0",
+    "@skyux/forms": "12.3.0",
+    "@skyux/i18n": "12.3.0",
+    "@skyux/icon": "12.3.0",
+    "@skyux/indicators": "12.3.0",
+    "@skyux/layout": "12.3.0",
+    "@skyux/lists": "12.3.0",
+    "@skyux/lookup": "12.3.0",
+    "@skyux/modals": "12.3.0"
   },
   "dependencies": {
     "tslib": "^2.8.1"
@@ -41,6 +42,10 @@
     ".": {
       "types": "./index.d.ts",
       "default": "./fesm2022/skyux-data-manager.mjs"
+    },
+    "./testing": {
+      "types": "./testing/index.d.ts",
+      "default": "./fesm2022/skyux-data-manager-testing.mjs"
     }
   },
   "sideEffects": false

package/testing/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
+/// <amd-module name="@skyux/data-manager/testing" />
+export * from './public-api';

package/testing/modules/data-manager/data-manager-column-picker-column-harness-filters.d.ts

@@ -0,0 +1,6 @@
+import { SkyRepeaterItemHarnessFilters } from '@skyux/lists/testing';
+/**
+ * A set of criteria that can be used to filter a list of `SkyDataManagerColumnPickerSearchResultHarness` instances.
+ */
+export interface SkyDataManagerColumnPickerColumnHarnessFilters extends Omit<SkyRepeaterItemHarnessFilters, 'ancestor'> {
+}

package/testing/modules/data-manager/data-manager-column-picker-column-harness.d.ts

@@ -0,0 +1,81 @@
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { SkyRepeaterItemHarness } from '@skyux/lists/testing';
+import { SkyDataManagerColumnPickerColumnHarnessFilters } from './data-manager-column-picker-column-harness-filters';
+/**
+ * Harness for interacting with a data manager column picker column result in tests.
+ */
+export declare class SkyDataManagerColumnPickerColumnHarness extends SkyRepeaterItemHarness {
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyDataManagerColumnPickerColumnHarness` that meets certain criteria.
+     */
+    static with(filters: SkyDataManagerColumnPickerColumnHarnessFilters): HarnessPredicate<SkyDataManagerColumnPickerColumnHarness>;
+    /**
+     * Clicks on the column.
+     * This has no effect in the data manager column picker.
+     * @internal
+     */
+    click(): Promise<void>;
+    /**
+     * Collapses the search, or does nothing if already collapsed.
+     * The data manager column picker does not use an expandable repeater.
+     * @internal
+     */
+    collapse(): Promise<void>;
+    /**
+     * Deselects the column.
+     */
+    deselect(): Promise<void>;
+    /**
+     * Expands the search, or does nothing if already expanded.
+     * The data manager column picker does not use an expandable repeater.
+     * @internal
+     */
+    expand(): Promise<void>;
+    /**
+     * Gets the text of the column content.
+     */
+    getContentText(): Promise<string>;
+    /**
+     * Gets the text of the column title.
+     */
+    getTitleText(): Promise<string>;
+    /**
+     * Whether the column is collapsible.
+     * This is always false for data manager column picker and not documented.
+     * @internal
+     */
+    isCollapsible(): Promise<boolean>;
+    /**
+     * Whether the column is expanded, or throws an error informing of the lack of collapsibility.
+     * This is always true for data manager column picker and not documented.
+     * @internal
+     */
+    isExpanded(): Promise<boolean>;
+    /**
+     * Whether the repeater item is reorderable.
+     * This is always false for data manager column picker and not documented.
+     * @internal
+     */
+    isReorderable(): Promise<boolean>;
+    /**
+     * Whether the column is selectable.
+     * This is always true for data manager column picker and not documented.
+     * @internal
+     */
+    isSelectable(): Promise<boolean>;
+    /**
+     * Whether the column is selected.
+     */
+    isSelected(): Promise<boolean>;
+    /**
+     * Selects the column.
+     */
+    select(): Promise<void>;
+    /**
+     * Moves the column to the top of the list.
+     * The data manager column picker does not use a reorderable repeater.
+     * @internal
+     */
+    sendToTop(): Promise<void>;
+}

package/testing/modules/data-manager/data-manager-column-picker-harness.d.ts

@@ -0,0 +1,45 @@
+import { ComponentHarness } from '@angular/cdk/testing';
+import { SkyDataManagerColumnPickerColumnHarness } from './data-manager-column-picker-column-harness';
+import { SkyDataManagerColumnPickerColumnHarnessFilters } from './data-manager-column-picker-column-harness-filters';
+/**
+ * Harness for interacting with a data manager column picker modal in tests.
+ */
+export declare class SkyDataManagerColumnPickerHarness extends ComponentHarness {
+    #private;
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Clears the text of the search input.
+     */
+    clearSearchText(): Promise<void>;
+    /**
+     * Enters text into the search input and performs a search.
+     */
+    enterSearchText(value: string): Promise<void>;
+    /**
+     * Selects multiple columns based on a set of criteria.
+     */
+    selectColumns(filters?: SkyDataManagerColumnPickerColumnHarnessFilters): Promise<void>;
+    /**
+     * Saves any selections made and closes the modal.
+     */
+    saveAndClose(): Promise<void>;
+    /**
+     * Closes the picker without saving any selections made.
+     */
+    cancel(): Promise<void>;
+    /**
+     * Gets a list of columns.
+     */
+    getColumns(filters?: SkyDataManagerColumnPickerColumnHarnessFilters): Promise<SkyDataManagerColumnPickerColumnHarness[]>;
+    /**
+     * Clears all selections made.
+     */
+    clearAll(): Promise<void>;
+    /**
+     * Selects all search results.
+     */
+    selectAll(): Promise<void>;
+}

package/testing/modules/data-manager/data-manager-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 `SkyDataManagerHarness` instances.
+ */
+export interface SkyDataManagerHarnessFilters extends SkyHarnessFilters {
+}

package/testing/modules/data-manager/data-manager-harness.d.ts

@@ -0,0 +1,33 @@
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { SkyComponentHarness } from '@skyux/core/testing';
+import { SkyDataManagerHarnessFilters } from './data-manager-harness-filters';
+import { SkyDataManagerToolbarHarness } from './data-manager-toolbar-harness';
+import { SkyDataManagerToolbarHarnessFilters } from './data-manager-toolbar-harness-filters';
+import { SkyDataViewHarness } from './data-view-harness';
+import { SkyDataViewHarnessFilters } from './data-view-harness-filters';
+/**
+ * Harness to interact with a data manager toolbar section component in tests.
+ */
+export declare class SkyDataManagerHarness extends SkyComponentHarness {
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyDataManagerHarness` that meets certain criteria.
+     */
+    static with(filters: SkyDataManagerHarnessFilters): HarnessPredicate<SkyDataManagerHarness>;
+    /**
+     * Gets a harness for a data manager toolbar that meets certain criteria.
+     */
+    getToolbar(filter?: SkyDataManagerToolbarHarnessFilters): Promise<SkyDataManagerToolbarHarness>;
+    /**
+     * Gets a harness for a specific data view that meets certain criteria.
+     */
+    getView(filter: SkyDataViewHarnessFilters): Promise<SkyDataViewHarness>;
+    /**
+     * Gets an array of all data views.
+     */
+    getViews(filters?: SkyDataViewHarnessFilters): Promise<SkyDataViewHarness[]>;
+}

package/testing/modules/data-manager/data-manager-toolbar-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 `SkyDataManagerToolbarHarness` instances.
+ */
+export interface SkyDataManagerToolbarHarnessFilters extends SkyHarnessFilters {
+}

package/testing/modules/data-manager/data-manager-toolbar-harness.d.ts

@@ -0,0 +1,94 @@
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { SkyComponentHarness } from '@skyux/core/testing';
+import { SkyCheckboxHarness, SkyRadioGroupHarness } from '@skyux/forms/testing';
+import { SkyFilterButtonHarness, SkySortHarness } from '@skyux/lists/testing';
+import { SkySearchHarness } from '@skyux/lookup/testing';
+import { SkyDataManagerColumnPickerHarness } from './data-manager-column-picker-harness';
+import { SkyDataManagerToolbarHarnessFilters } from './data-manager-toolbar-harness-filters';
+import { SkyDataManagerToolbarLeftItemHarness } from './data-manager-toolbar-left-item-harness';
+import { SkyDataManagerToolbarLeftItemHarnessFilters } from './data-manager-toolbar-left-item-harness-filters';
+import { SkyDataManagerToolbarPrimaryItemHarness } from './data-manager-toolbar-primary-item-harness';
+import { SkyDataManagerToolbarPrimaryItemHarnessFilters } from './data-manager-toolbar-primary-item-harness-filters';
+import { SkyDataManagerToolbarRightItemHarness } from './data-manager-toolbar-right-item-harness';
+import { SkyDataManagerToolbarRightItemHarnessFilters } from './data-manager-toolbar-right-item-harness-filters';
+import { SkyDataManagerToolbarSectionHarness } from './data-manager-toolbar-section-harness';
+import { SkyDataManagerToolbarSectionHarnessFilters } from './data-manager-toolbar-section-harness-filters';
+/**
+ * Harness for interacting with a data manager toolbar component in tests.
+ */
+export declare class SkyDataManagerToolbarHarness extends SkyComponentHarness {
+    #private;
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyDataManagerToolbarHarness` that meets certain criteria.
+     */
+    static with(filters: SkyDataManagerToolbarHarnessFilters): HarnessPredicate<SkyDataManagerToolbarHarness>;
+    /**
+     * Clicks the data manager clear all button. Throws an error if the multiselect toolbar is turned off.
+     */
+    clickClearAll(): Promise<void>;
+    /**
+     * Clicks the data manager select all button. Throws an error if the multiselect toolbar is turned off.
+     */
+    clickSelectAll(): Promise<void>;
+    /**
+     * Gets a harness for the data manager filter button.
+     */
+    getFilterButton(): Promise<SkyFilterButtonHarness | null>;
+    /**
+     * Gets a harness for a specific data manager toolbar left item that meets certain criteria.
+     */
+    getLeftItem(filter: SkyDataManagerToolbarLeftItemHarnessFilters): Promise<SkyDataManagerToolbarLeftItemHarness>;
+    /**
+     * Gets an array of all data manager toolbar left items.
+     */
+    getLeftItems(filters?: SkyDataManagerToolbarLeftItemHarnessFilters): Promise<SkyDataManagerToolbarLeftItemHarness[]>;
+    /**
+     * Gets a harness for the only show selected checkbox.
+     */
+    getOnlyShowSelected(): Promise<SkyCheckboxHarness | null>;
+    /**
+     * Gets a harness for a specific data manager toolbar primary item that meets certain criteria.
+     */
+    getPrimaryItem(filter: SkyDataManagerToolbarPrimaryItemHarnessFilters): Promise<SkyDataManagerToolbarPrimaryItemHarness>;
+    /**
+     * Gets an array of all data manager toolbar primary items.
+     */
+    getPrimaryItems(filters?: SkyDataManagerToolbarPrimaryItemHarnessFilters): Promise<SkyDataManagerToolbarPrimaryItemHarness[]>;
+    /**
+     * Gets a harness for a specific data manager toolbar right item that meets certain criteria.
+     */
+    getRightItem(filter: SkyDataManagerToolbarRightItemHarnessFilters): Promise<SkyDataManagerToolbarRightItemHarness>;
+    /**
+     * Gets an array of all data manager toolbar right items.
+     */
+    getRightItems(filters?: SkyDataManagerToolbarRightItemHarnessFilters): Promise<SkyDataManagerToolbarRightItemHarness[]>;
+    /**
+     * Gets the data manager search harness.
+     */
+    getSearch(): Promise<SkySearchHarness | null>;
+    /**
+     * Gets a harness for a specific toolbar section that meets certain criteria.
+     */
+    getSection(filter: SkyDataManagerToolbarSectionHarnessFilters): Promise<SkyDataManagerToolbarSectionHarness>;
+    /**
+     * Gets an array of all toolbar sections.
+     */
+    getSections(filters?: SkyDataManagerToolbarSectionHarnessFilters): Promise<SkyDataManagerToolbarSectionHarness[]>;
+    /**
+     * Gets a harness for the data manager sort button.
+     */
+    getSortButton(): Promise<SkySortHarness | null>;
+    /**
+     * Gets the harness to interact with the data manager toolbar's view actions.
+     */
+    getViewActions(): Promise<SkyRadioGroupHarness | null>;
+    /**
+     * Opens the data manager column picker and returns the harness. Throws an error if the column picker is turned off.
+     */
+    openColumnPicker(): Promise<SkyDataManagerColumnPickerHarness>;
+}

package/testing/modules/data-manager/data-manager-toolbar-left-item-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 `SkyDataManagerToolbarLeftItemHarness` instances.
+ */
+export interface SkyDataManagerToolbarLeftItemHarnessFilters extends SkyHarnessFilters {
+}

package/testing/modules/data-manager/data-manager-toolbar-left-item-harness.d.ts

@@ -0,0 +1,17 @@
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { SkyQueryableComponentHarness } from '@skyux/core/testing';
+import { SkyDataManagerToolbarLeftItemHarnessFilters } from './data-manager-toolbar-left-item-harness-filters';
+/**
+ * Harness to interact with a data manager toolbar left item component in tests.
+ */
+export declare class SkyDataManagerToolbarLeftItemHarness extends SkyQueryableComponentHarness {
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyDataManagerToolbarLeftItemHarness` that meets certain criteria.
+     */
+    static with(filters: SkyDataManagerToolbarLeftItemHarnessFilters): HarnessPredicate<SkyDataManagerToolbarLeftItemHarness>;
+}

package/testing/modules/data-manager/data-manager-toolbar-primary-item-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 `SkyDataManagerToolbarPrimaryItemHarness` instances.
+ */
+export interface SkyDataManagerToolbarPrimaryItemHarnessFilters extends SkyHarnessFilters {
+}

package/testing/modules/data-manager/data-manager-toolbar-primary-item-harness.d.ts

@@ -0,0 +1,17 @@
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { SkyQueryableComponentHarness } from '@skyux/core/testing';
+import { SkyDataManagerToolbarPrimaryItemHarnessFilters } from './data-manager-toolbar-primary-item-harness-filters';
+/**
+ * Harness to interact with a data manager toolbar primary item component in tests.
+ */
+export declare class SkyDataManagerToolbarPrimaryItemHarness extends SkyQueryableComponentHarness {
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyDataManagerToolbarPrimaryItemHarness` that meets certain criteria.
+     */
+    static with(filters: SkyDataManagerToolbarPrimaryItemHarnessFilters): HarnessPredicate<SkyDataManagerToolbarPrimaryItemHarness>;
+}

package/testing/modules/data-manager/data-manager-toolbar-right-item-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 `SkyDataManagerToolbarRightItemHarness` instances.
+ */
+export interface SkyDataManagerToolbarRightItemHarnessFilters extends SkyHarnessFilters {
+}

package/testing/modules/data-manager/data-manager-toolbar-right-item-harness.d.ts

@@ -0,0 +1,17 @@
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { SkyQueryableComponentHarness } from '@skyux/core/testing';
+import { SkyDataManagerToolbarRightItemHarnessFilters } from './data-manager-toolbar-right-item-harness-filters';
+/**
+ * Harness to interact with a data manager toolbar right item component in tests.
+ */
+export declare class SkyDataManagerToolbarRightItemHarness extends SkyQueryableComponentHarness {
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyDataManagerToolbarRightItemHarness` that meets certain criteria.
+     */
+    static with(filters: SkyDataManagerToolbarRightItemHarnessFilters): HarnessPredicate<SkyDataManagerToolbarRightItemHarness>;
+}

package/testing/modules/data-manager/data-manager-toolbar-section-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 `SkyDataManagerToolbarSectionHarness` instances.
+ */
+export interface SkyDataManagerToolbarSectionHarnessFilters extends SkyHarnessFilters {
+}

package/testing/modules/data-manager/data-manager-toolbar-section-harness.d.ts

@@ -0,0 +1,17 @@
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { SkyQueryableComponentHarness } from '@skyux/core/testing';
+import { SkyDataManagerToolbarSectionHarnessFilters } from './data-manager-toolbar-section-harness-filters';
+/**
+ * Harness to interact with a data manager toolbar section component in tests.
+ */
+export declare class SkyDataManagerToolbarSectionHarness extends SkyQueryableComponentHarness {
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyDataManagerToolbarSectionHarness` that meets certain criteria.
+     */
+    static with(filters: SkyDataManagerToolbarSectionHarnessFilters): HarnessPredicate<SkyDataManagerToolbarSectionHarness>;
+}

package/testing/modules/data-manager/data-view-harness-filters.d.ts

@@ -0,0 +1,7 @@
+import { SkyHarnessFilters } from '@skyux/core/testing';
+/**
+ * A set of criteria that can be used to filter a list of `SkyDataViewHarness` instances.
+ */
+export interface SkyDataViewHarnessFilters extends SkyHarnessFilters {
+    viewId?: string;
+}

package/testing/modules/data-manager/data-view-harness.d.ts

@@ -0,0 +1,17 @@
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { SkyQueryableComponentHarness } from '@skyux/core/testing';
+import { SkyDataViewHarnessFilters } from './data-view-harness-filters';
+/**
+ * Harness to interact with a data manager view component in tests.
+ */
+export declare class SkyDataViewHarness extends SkyQueryableComponentHarness {
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyDataViewHarness` that meets certain criteria.
+     */
+    static with(filters: SkyDataViewHarnessFilters): HarnessPredicate<SkyDataViewHarness>;
+}

package/testing/public-api.d.ts

@@ -0,0 +1,17 @@
+export { SkyDataManagerColumnPickerColumnHarness } from './modules/data-manager/data-manager-column-picker-column-harness';
+export { SkyDataManagerColumnPickerColumnHarnessFilters } from './modules/data-manager/data-manager-column-picker-column-harness-filters';
+export { SkyDataManagerColumnPickerHarness } from './modules/data-manager/data-manager-column-picker-harness';
+export { SkyDataManagerHarness } from './modules/data-manager/data-manager-harness';
+export { SkyDataManagerHarnessFilters } from './modules/data-manager/data-manager-harness-filters';
+export { SkyDataManagerToolbarHarness } from './modules/data-manager/data-manager-toolbar-harness';
+export { SkyDataManagerToolbarHarnessFilters } from './modules/data-manager/data-manager-toolbar-harness-filters';
+export { SkyDataManagerToolbarLeftItemHarness } from './modules/data-manager/data-manager-toolbar-left-item-harness';
+export { SkyDataManagerToolbarLeftItemHarnessFilters } from './modules/data-manager/data-manager-toolbar-left-item-harness-filters';
+export { SkyDataManagerToolbarPrimaryItemHarness } from './modules/data-manager/data-manager-toolbar-primary-item-harness';
+export { SkyDataManagerToolbarPrimaryItemHarnessFilters } from './modules/data-manager/data-manager-toolbar-primary-item-harness-filters';
+export { SkyDataManagerToolbarRightItemHarness } from './modules/data-manager/data-manager-toolbar-right-item-harness';
+export { SkyDataManagerToolbarRightItemHarnessFilters } from './modules/data-manager/data-manager-toolbar-right-item-harness-filters';
+export { SkyDataManagerToolbarSectionHarness } from './modules/data-manager/data-manager-toolbar-section-harness';
+export { SkyDataManagerToolbarSectionHarnessFilters } from './modules/data-manager/data-manager-toolbar-section-harness-filters';
+export { SkyDataViewHarness } from './modules/data-manager/data-view-harness';
+export { SkyDataViewHarnessFilters } from './modules/data-manager/data-view-harness-filters';