@shopware-ag/acceptance-test-suite 11.18.0 → 11.19.1

package/dist/index.d.mts

@@ -1161,8 +1161,6 @@ interface HelperFixtureTypes {
         isSaaS: boolean;
         features: FeaturesType;
     };
-    HideElementsForScreenshot: (page: Page, selectors: string[]) => Promise<void>;
-    ReplaceElementsForScreenshot: (page: Page, selectors: string[]) => Promise<void>;
 }
 
 interface StoreBaseConfig {
@@ -1240,6 +1238,7 @@ interface PageObject {
 
 declare class Home implements PageObject {
     readonly page: Page;
+    readonly categoryTitle: Locator;
     readonly accountMenuButton: Locator;
     readonly closeGuestSessionButton: Locator;
     readonly productImages: Locator;
@@ -1830,6 +1829,8 @@ declare const StorefrontPageObjects: {
 declare class ProductDetail implements PageObject {
     readonly page: Page;
     readonly instanceMeta: HelperFixtureTypes['InstanceMeta'];
+    readonly contentView: Locator;
+    readonly productHeadline: Locator;
     /**
      * Save interactions
      */
@@ -2154,7 +2155,19 @@ declare class DataSharing implements PageObject {
 
 declare class Dashboard implements PageObject {
     readonly page: Page;
+    readonly contentView: Locator;
+    readonly adminMenuView: Locator;
+    readonly adminMenuCatalog: Locator;
+    readonly adminMenuOrder: Locator;
+    readonly adminMenuCustomer: Locator;
+    readonly adminMenuContent: Locator;
+    readonly adminMenuMarketing: Locator;
+    readonly adminMenuExtension: Locator;
+    readonly adminMenuUserChevron: Locator;
+    readonly adminMenuUserIcon: Locator;
+    readonly adminMenuUserName: Locator;
     readonly welcomeHeadline: Locator;
+    readonly welcomeMessage: Locator;
     readonly dataSharingConsentBanner: Locator;
     readonly dataSharingAgreeButton: Locator;
     readonly dataSharingNotAtTheMomentButton: Locator;
@@ -2162,6 +2175,8 @@ declare class Dashboard implements PageObject {
     readonly dataSharingSettingsLink: Locator;
     readonly dataSharingAcceptMessageText: Locator;
     readonly dataSharingNotAtTheMomentMessageText: Locator;
+    readonly statisticsDateRange: Locator;
+    readonly statisticsChart: Locator;
     constructor(page: Page);
     url(): string;
 }
@@ -2260,6 +2275,10 @@ declare class LandingPageDetail implements PageObject {
 declare class Categories implements PageObject {
     readonly page: Page;
     readonly instanceMeta: HelperFixtureTypes['InstanceMeta'];
+    /**
+     * Visual tests
+     */
+    readonly contentView: Locator;
     /**
      * Landing pages
      */
@@ -2276,6 +2295,13 @@ declare class Categories implements PageObject {
     readonly confirmCategoryCreationButton: Locator;
     readonly confirmCategoryCancelButton: Locator;
     readonly categoryItems: Locator;
+    /**
+     * Tabs
+     */
+    readonly generalTab: Locator;
+    readonly productsTab: Locator;
+    readonly layoutTab: Locator;
+    readonly seoTab: Locator;
     /**
      * General
      */
@@ -2286,6 +2312,8 @@ declare class Categories implements PageObject {
     readonly saveButton: Locator;
     readonly loadingSpinner: Locator;
     readonly fadingBar: Locator;
+    readonly configureHomePageButton: Locator;
+    readonly configureModalCancelButton: Locator;
     /**
      * Customisable link
      */
@@ -2567,6 +2595,14 @@ declare class CustomerBulkEdit implements PageObject {
     url(): string;
 }
 
+declare class SettingsListing implements PageObject {
+    readonly page: Page;
+    readonly contentView: Locator;
+    readonly header: Locator;
+    constructor(page: Page);
+    url(): string;
+}
+
 declare class DocumentListing implements PageObject {
     readonly page: Page;
     readonly addDocumentButton: Locator;
@@ -2618,6 +2654,7 @@ interface AdministrationPageTypes {
     AdminProductListing: ProductListing;
     AdminProductBulkEdit: ProductBulkEdit;
     AdminCustomerBulkEdit: CustomerBulkEdit;
+    AdminSettingsListing: SettingsListing;
     AdminDocumentListing: DocumentListing;
     AdminDocumentDetail: DocumentDetail;
 }
@@ -2655,6 +2692,7 @@ declare const AdminPageObjects: {
     ProductListing: typeof ProductListing;
     ProductBulkEdit: typeof ProductBulkEdit;
     CustomerBulkEdit: typeof CustomerBulkEdit;
+    SettingsListing: typeof SettingsListing;
     DocumentListing: typeof DocumentListing;
     DocumentDetail: typeof DocumentDetail;
 };
@@ -2747,6 +2785,62 @@ declare const isThemeCompiled: (context: AdminApiContext, storefrontUrl: string)
 
 declare function createRandomImage(width?: number, height?: number): Image;
 
+/**
+ * Hides the given page elements using `visibility: hidden`, so they become invisible
+ * without affecting the layout (no realignment occurs).
+ *
+ * @param page - Playwright page object
+ * @param selectors - CSS selectors for elements to hide
+ */
+declare function hideElements(page: Page, selectors: (string | Locator)[]): Promise<void>;
+/**
+ * Replaces the text content of selected elements with `***`.
+ *
+ * @param page - Playwright page object
+ * @param selectors - CSS selectors for elements whose content to replace
+ */
+declare function replaceElements(page: Page, selectors: (string | Locator)[]): Promise<void>;
+/**
+ * Calculates the ideal viewport dimensions for a Playwright test based on scrollable content,
+ * header visibility, and optional configuration. Useful for dynamic screenshot sizing or
+ * testing long-scrolling pages.
+ *
+ * This function:
+ * - Optionally waits for a network request (`requestURL`) before continuing.
+ * - Optionally waits for a specific locator (`waitForLocator`) to become visible.
+ * - Measures scrollable content height (`scrollableElementVertical`) and header height.
+ * - Measures scrollable content width (`scrollableElementHorizontal`).
+ * - Falls back to defaults if elements are not found or inaccessible.
+ *
+ * @param {Page} page - The Playwright `Page` object representing the current browser tab.
+ * @param {Options} [options] - Optional configuration to override default behavior.
+ * @param {string} [options.requestURL] - A URL substring to wait for via `waitForResponse`.
+ * @param {number} [options.width] - Base viewport width to use (default: 1440).
+ * @param {string | Locator} [options.scrollableElementVertical] - Selector or Locator for vertical scroll container.
+ * @param {string | Locator} [options.scrollableElementHorizontal] - Selector or Locator for horizontal scroll container.
+ * @param {number} [options.additionalHeight] - Extra height to add (e.g., to avoid cut-off).
+ * @param {string | Locator} [options.waitForSelector] - A selector or Locator to wait for visibility before measuring.
+ * @param {number} [options.contentHeight] - Default vertical height fallback if measurement fails.
+ * @param {number} [options.headerHeight] - Default header height fallback.
+ * @param {string} [options.headerElement] - Selector for a header element whose height should be added if outside scrollable container.
+ *
+ * @returns {Promise<{ contentWidth: number; totalHeight: number }>} - A Promise resolving to the measured dimensions:
+ *   - `contentWidth`: the horizontal scroll width or fallback.
+ *   - `totalHeight`: sum of content height, header height, and any additional height.
+ */
+interface Options {
+    requestURL?: string;
+    width?: number;
+    scrollableElementVertical?: string | Locator;
+    scrollableElementHorizontal?: string | Locator;
+    additionalHeight?: number;
+    waitForSelector?: string | Locator;
+    contentHeight?: number;
+    headerHeight?: number;
+    headerElement?: string;
+}
+declare function setViewport(page: Page, options?: Options): Promise<void>;
+
 declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArgs & _playwright_test.PlaywrightTestOptions & FixtureTypes & {
     SaveProduct: Task;
 } & {
@@ -2813,4 +2907,4 @@ declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArg
     SelectProductFilterOption: Task;
 }, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & FixtureTypes>;
 
-export { type AccountData, type Address, AdminPageObjects, type CalculatedTaxes, type Category$1 as Category, type CategoryCustomizableLinkData, type CategoryData, type CmsPage, type Country$1 as Country, type CreatedRecord, type Currency$2 as Currency, type CustomField, type CustomFieldData, type CustomFieldSet, type Customer, type CustomerAddress, type CustomerGroup, type DataServiceOptions, type DeliveryTime, type FixtureTypes, type Flow, type FlowTemplate, type Language$2 as Language, type Manufacturer, type Media, type Order, type OrderDelivery, type OrderLineItem, type OrderStatus, type PageObject, type PaymentMethod$1 as PaymentMethod, type Price, type Product, type ProductCrossSelling, type ProductPrice, type ProductReview, type Promotion, type PromotionDiscount, type PropertyGroup, type PropertyGroupOption, type RegistrationData, type Rule, type RuleAssignmentEntity, RuleType, type SalesChannel, type SalesChannelAnalytics, type SalesChannelDomain, type SalesChannelRecord, type Salutation, type ShippingMethod$1 as ShippingMethod, type SimpleLineItem, type StateMachine, type StateMachineState, StorefrontPageObjects, type SyncApiOperation, type SystemConfig, type Tag, type TagData, type Task, type Tax$1 as Tax, type TaxRules, TestDataService, type VariantListingConfig, compareFlowTemplateWithFlow, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlow, getFlowId, getFlowTemplate, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getPromotionWithDiscount, getSalutationId, getShippingMethodId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, isSaaSInstance, isThemeCompiled, setOrderStatus, test };
+export { type AccountData, type Address, AdminPageObjects, type CalculatedTaxes, type Category$1 as Category, type CategoryCustomizableLinkData, type CategoryData, type CmsPage, type Country$1 as Country, type CreatedRecord, type Currency$2 as Currency, type CustomField, type CustomFieldData, type CustomFieldSet, type Customer, type CustomerAddress, type CustomerGroup, type DataServiceOptions, type DeliveryTime, type FixtureTypes, type Flow, type FlowTemplate, type Language$2 as Language, type Manufacturer, type Media, type Options, type Order, type OrderDelivery, type OrderLineItem, type OrderStatus, type PageObject, type PaymentMethod$1 as PaymentMethod, type Price, type Product, type ProductCrossSelling, type ProductPrice, type ProductReview, type Promotion, type PromotionDiscount, type PropertyGroup, type PropertyGroupOption, type RegistrationData, type Rule, type RuleAssignmentEntity, RuleType, type SalesChannel, type SalesChannelAnalytics, type SalesChannelDomain, type SalesChannelRecord, type Salutation, type ShippingMethod$1 as ShippingMethod, type SimpleLineItem, type StateMachine, type StateMachineState, StorefrontPageObjects, type SyncApiOperation, type SystemConfig, type Tag, type TagData, type Task, type Tax$1 as Tax, type TaxRules, TestDataService, type VariantListingConfig, compareFlowTemplateWithFlow, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlow, getFlowId, getFlowTemplate, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getPromotionWithDiscount, getSalutationId, getShippingMethodId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, hideElements, isSaaSInstance, isThemeCompiled, replaceElements, setOrderStatus, setViewport, test };

package/dist/index.d.ts

@@ -1161,8 +1161,6 @@ interface HelperFixtureTypes {
         isSaaS: boolean;
         features: FeaturesType;
     };
-    HideElementsForScreenshot: (page: Page, selectors: string[]) => Promise<void>;
-    ReplaceElementsForScreenshot: (page: Page, selectors: string[]) => Promise<void>;
 }
 
 interface StoreBaseConfig {
@@ -1240,6 +1238,7 @@ interface PageObject {
 
 declare class Home implements PageObject {
     readonly page: Page;
+    readonly categoryTitle: Locator;
     readonly accountMenuButton: Locator;
     readonly closeGuestSessionButton: Locator;
     readonly productImages: Locator;
@@ -1830,6 +1829,8 @@ declare const StorefrontPageObjects: {
 declare class ProductDetail implements PageObject {
     readonly page: Page;
     readonly instanceMeta: HelperFixtureTypes['InstanceMeta'];
+    readonly contentView: Locator;
+    readonly productHeadline: Locator;
     /**
      * Save interactions
      */
@@ -2154,7 +2155,19 @@ declare class DataSharing implements PageObject {
 
 declare class Dashboard implements PageObject {
     readonly page: Page;
+    readonly contentView: Locator;
+    readonly adminMenuView: Locator;
+    readonly adminMenuCatalog: Locator;
+    readonly adminMenuOrder: Locator;
+    readonly adminMenuCustomer: Locator;
+    readonly adminMenuContent: Locator;
+    readonly adminMenuMarketing: Locator;
+    readonly adminMenuExtension: Locator;
+    readonly adminMenuUserChevron: Locator;
+    readonly adminMenuUserIcon: Locator;
+    readonly adminMenuUserName: Locator;
     readonly welcomeHeadline: Locator;
+    readonly welcomeMessage: Locator;
     readonly dataSharingConsentBanner: Locator;
     readonly dataSharingAgreeButton: Locator;
     readonly dataSharingNotAtTheMomentButton: Locator;
@@ -2162,6 +2175,8 @@ declare class Dashboard implements PageObject {
     readonly dataSharingSettingsLink: Locator;
     readonly dataSharingAcceptMessageText: Locator;
     readonly dataSharingNotAtTheMomentMessageText: Locator;
+    readonly statisticsDateRange: Locator;
+    readonly statisticsChart: Locator;
     constructor(page: Page);
     url(): string;
 }
@@ -2260,6 +2275,10 @@ declare class LandingPageDetail implements PageObject {
 declare class Categories implements PageObject {
     readonly page: Page;
     readonly instanceMeta: HelperFixtureTypes['InstanceMeta'];
+    /**
+     * Visual tests
+     */
+    readonly contentView: Locator;
     /**
      * Landing pages
      */
@@ -2276,6 +2295,13 @@ declare class Categories implements PageObject {
     readonly confirmCategoryCreationButton: Locator;
     readonly confirmCategoryCancelButton: Locator;
     readonly categoryItems: Locator;
+    /**
+     * Tabs
+     */
+    readonly generalTab: Locator;
+    readonly productsTab: Locator;
+    readonly layoutTab: Locator;
+    readonly seoTab: Locator;
     /**
      * General
      */
@@ -2286,6 +2312,8 @@ declare class Categories implements PageObject {
     readonly saveButton: Locator;
     readonly loadingSpinner: Locator;
     readonly fadingBar: Locator;
+    readonly configureHomePageButton: Locator;
+    readonly configureModalCancelButton: Locator;
     /**
      * Customisable link
      */
@@ -2567,6 +2595,14 @@ declare class CustomerBulkEdit implements PageObject {
     url(): string;
 }
 
+declare class SettingsListing implements PageObject {
+    readonly page: Page;
+    readonly contentView: Locator;
+    readonly header: Locator;
+    constructor(page: Page);
+    url(): string;
+}
+
 declare class DocumentListing implements PageObject {
     readonly page: Page;
     readonly addDocumentButton: Locator;
@@ -2618,6 +2654,7 @@ interface AdministrationPageTypes {
     AdminProductListing: ProductListing;
     AdminProductBulkEdit: ProductBulkEdit;
     AdminCustomerBulkEdit: CustomerBulkEdit;
+    AdminSettingsListing: SettingsListing;
     AdminDocumentListing: DocumentListing;
     AdminDocumentDetail: DocumentDetail;
 }
@@ -2655,6 +2692,7 @@ declare const AdminPageObjects: {
     ProductListing: typeof ProductListing;
     ProductBulkEdit: typeof ProductBulkEdit;
     CustomerBulkEdit: typeof CustomerBulkEdit;
+    SettingsListing: typeof SettingsListing;
     DocumentListing: typeof DocumentListing;
     DocumentDetail: typeof DocumentDetail;
 };
@@ -2747,6 +2785,62 @@ declare const isThemeCompiled: (context: AdminApiContext, storefrontUrl: string)
 
 declare function createRandomImage(width?: number, height?: number): Image;
 
+/**
+ * Hides the given page elements using `visibility: hidden`, so they become invisible
+ * without affecting the layout (no realignment occurs).
+ *
+ * @param page - Playwright page object
+ * @param selectors - CSS selectors for elements to hide
+ */
+declare function hideElements(page: Page, selectors: (string | Locator)[]): Promise<void>;
+/**
+ * Replaces the text content of selected elements with `***`.
+ *
+ * @param page - Playwright page object
+ * @param selectors - CSS selectors for elements whose content to replace
+ */
+declare function replaceElements(page: Page, selectors: (string | Locator)[]): Promise<void>;
+/**
+ * Calculates the ideal viewport dimensions for a Playwright test based on scrollable content,
+ * header visibility, and optional configuration. Useful for dynamic screenshot sizing or
+ * testing long-scrolling pages.
+ *
+ * This function:
+ * - Optionally waits for a network request (`requestURL`) before continuing.
+ * - Optionally waits for a specific locator (`waitForLocator`) to become visible.
+ * - Measures scrollable content height (`scrollableElementVertical`) and header height.
+ * - Measures scrollable content width (`scrollableElementHorizontal`).
+ * - Falls back to defaults if elements are not found or inaccessible.
+ *
+ * @param {Page} page - The Playwright `Page` object representing the current browser tab.
+ * @param {Options} [options] - Optional configuration to override default behavior.
+ * @param {string} [options.requestURL] - A URL substring to wait for via `waitForResponse`.
+ * @param {number} [options.width] - Base viewport width to use (default: 1440).
+ * @param {string | Locator} [options.scrollableElementVertical] - Selector or Locator for vertical scroll container.
+ * @param {string | Locator} [options.scrollableElementHorizontal] - Selector or Locator for horizontal scroll container.
+ * @param {number} [options.additionalHeight] - Extra height to add (e.g., to avoid cut-off).
+ * @param {string | Locator} [options.waitForSelector] - A selector or Locator to wait for visibility before measuring.
+ * @param {number} [options.contentHeight] - Default vertical height fallback if measurement fails.
+ * @param {number} [options.headerHeight] - Default header height fallback.
+ * @param {string} [options.headerElement] - Selector for a header element whose height should be added if outside scrollable container.
+ *
+ * @returns {Promise<{ contentWidth: number; totalHeight: number }>} - A Promise resolving to the measured dimensions:
+ *   - `contentWidth`: the horizontal scroll width or fallback.
+ *   - `totalHeight`: sum of content height, header height, and any additional height.
+ */
+interface Options {
+    requestURL?: string;
+    width?: number;
+    scrollableElementVertical?: string | Locator;
+    scrollableElementHorizontal?: string | Locator;
+    additionalHeight?: number;
+    waitForSelector?: string | Locator;
+    contentHeight?: number;
+    headerHeight?: number;
+    headerElement?: string;
+}
+declare function setViewport(page: Page, options?: Options): Promise<void>;
+
 declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArgs & _playwright_test.PlaywrightTestOptions & FixtureTypes & {
     SaveProduct: Task;
 } & {
@@ -2813,4 +2907,4 @@ declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArg
     SelectProductFilterOption: Task;
 }, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & FixtureTypes>;
 
-export { type AccountData, type Address, AdminPageObjects, type CalculatedTaxes, type Category$1 as Category, type CategoryCustomizableLinkData, type CategoryData, type CmsPage, type Country$1 as Country, type CreatedRecord, type Currency$2 as Currency, type CustomField, type CustomFieldData, type CustomFieldSet, type Customer, type CustomerAddress, type CustomerGroup, type DataServiceOptions, type DeliveryTime, type FixtureTypes, type Flow, type FlowTemplate, type Language$2 as Language, type Manufacturer, type Media, type Order, type OrderDelivery, type OrderLineItem, type OrderStatus, type PageObject, type PaymentMethod$1 as PaymentMethod, type Price, type Product, type ProductCrossSelling, type ProductPrice, type ProductReview, type Promotion, type PromotionDiscount, type PropertyGroup, type PropertyGroupOption, type RegistrationData, type Rule, type RuleAssignmentEntity, RuleType, type SalesChannel, type SalesChannelAnalytics, type SalesChannelDomain, type SalesChannelRecord, type Salutation, type ShippingMethod$1 as ShippingMethod, type SimpleLineItem, type StateMachine, type StateMachineState, StorefrontPageObjects, type SyncApiOperation, type SystemConfig, type Tag, type TagData, type Task, type Tax$1 as Tax, type TaxRules, TestDataService, type VariantListingConfig, compareFlowTemplateWithFlow, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlow, getFlowId, getFlowTemplate, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getPromotionWithDiscount, getSalutationId, getShippingMethodId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, isSaaSInstance, isThemeCompiled, setOrderStatus, test };
+export { type AccountData, type Address, AdminPageObjects, type CalculatedTaxes, type Category$1 as Category, type CategoryCustomizableLinkData, type CategoryData, type CmsPage, type Country$1 as Country, type CreatedRecord, type Currency$2 as Currency, type CustomField, type CustomFieldData, type CustomFieldSet, type Customer, type CustomerAddress, type CustomerGroup, type DataServiceOptions, type DeliveryTime, type FixtureTypes, type Flow, type FlowTemplate, type Language$2 as Language, type Manufacturer, type Media, type Options, type Order, type OrderDelivery, type OrderLineItem, type OrderStatus, type PageObject, type PaymentMethod$1 as PaymentMethod, type Price, type Product, type ProductCrossSelling, type ProductPrice, type ProductReview, type Promotion, type PromotionDiscount, type PropertyGroup, type PropertyGroupOption, type RegistrationData, type Rule, type RuleAssignmentEntity, RuleType, type SalesChannel, type SalesChannelAnalytics, type SalesChannelDomain, type SalesChannelRecord, type Salutation, type ShippingMethod$1 as ShippingMethod, type SimpleLineItem, type StateMachine, type StateMachineState, StorefrontPageObjects, type SyncApiOperation, type SystemConfig, type Tag, type TagData, type Task, type Tax$1 as Tax, type TaxRules, TestDataService, type VariantListingConfig, compareFlowTemplateWithFlow, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlow, getFlowId, getFlowTemplate, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getPromotionWithDiscount, getSalutationId, getShippingMethodId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, hideElements, isSaaSInstance, isThemeCompiled, replaceElements, setOrderStatus, setViewport, test };