@shopware-ag/acceptance-test-suite 1.4.0 → 2.0.0

package/README.md

@@ -210,9 +210,9 @@ There are several page objects to navigate the different pages of the Administra
 ```TypeScript
 import { test, expect } from './../BaseTestFile';
 
-test('Storefront cart test scenario', async ({ StorefrontCheckoutCart }) => {
+test('Storefront cart test scenario', async ({ StorefrontPage, StorefrontCheckoutCart }) => {
 
-    await StorefrontCheckoutCart.goTo();
+    await StorefrontPage.goto(StorefrontCheckoutCart.url());
     await expect(StorefrontCheckoutCart.grandTotalPrice).toHaveText('€100.00*');
 });
 ```
@@ -236,7 +236,7 @@ The actor class is just a lightweight solution to simplify the execution of reus
 * `page`: A Playwright page context the actor is navigating.
 
 **Methods**  
-* `goesTo`: Accepts a page object the actor should be navigating to.
+* `goesTo`: Accepts an url of a page the actor should navigate to.
 * `attemptsTo`: Accepts a "task" function with reusable test logic the actor should perform.
 * `expects`: A one-to-one export of the Playwright `expect` method to use it in the actor pattern.
 
@@ -257,7 +257,7 @@ test('Product detail test scenario', async ({
     ProductData 
 }) => {
 
-    await ShopCustomer.goesTo(StorefrontProductDetail);
+    await ShopCustomer.goesTo(StorefrontProductDetail.url(ProductData));
     await ShopCustomer.attemptsTo(AddProductToCart(ProductData));
     await ShopCustomer.expects(StorefrontProductDetail.offCanvasSummaryTotalPrice).toHaveText('€99.99*');
 });
@@ -289,7 +289,7 @@ export const Login = base.extend<{ Login: Task }, FixtureTypes>({
             return async function Login() {
                 const { customer } = DefaultSalesChannel;
 
-                await ShopCustomer.goesTo(StorefrontAccountLogin);
+                await ShopCustomer.goesTo(StorefrontAccountLogin.url());
 
                 await StorefrontAccountLogin.emailInput.fill(customer.email);
                 await StorefrontAccountLogin.passwordInput.fill(customer.password);

package/dist/index.d.mts

@@ -96,18 +96,13 @@ interface PageContextTypes {
     StorefrontPage: Page;
 }
 
-interface PageObject {
-    readonly page: Page;
-    goTo(): Promise<void>;
-}
-
 declare class Actor {
     page: Page;
     readonly name: string;
     constructor(name: string, page: Page);
     expects: _playwright_test.Expect<{}>;
     attemptsTo(task: () => Promise<void>): Promise<void>;
-    goesTo(pageObject: PageObject): Promise<void>;
+    goesTo(url: string): Promise<void>;
     private camelCaseToLowerCase;
 }
 
@@ -116,6 +111,26 @@ interface ActorFixtureTypes {
     ShopAdmin: Actor;
 }
 
+type Customer = components['schemas']['Customer'] & {
+    id: string;
+    password: string;
+};
+type Product = components['schemas']['Product'] & {
+    id: string;
+    price: {
+        gross: number;
+        net: number;
+        linked: boolean;
+        currencyId: string;
+    }[];
+};
+type Category$1 = components['schemas']['Category'] & {
+    id: string;
+};
+type Order = components['schemas']['Order'] & {
+    id: string;
+};
+
 interface StoreBaseConfig {
     storefrontTypeId: string;
     enGBLocaleId: string;
@@ -135,44 +150,45 @@ interface DefaultSalesChannelTypes {
     SalesChannelBaseConfig: StoreBaseConfig;
     DefaultSalesChannel: {
         salesChannel: components['schemas']['SalesChannel'];
-        customer: components['schemas']['Customer'] & {
-            password: string;
-        };
+        customer: Customer;
         url: string;
     };
 }
 
+interface PageObject {
+    readonly page: Page;
+    url(...args: unknown[]): string;
+}
+
 declare class Home implements PageObject {
     readonly page: Page;
     readonly productImages: Locator;
     constructor(page: Page);
-    goTo(): Promise<void>;
+    url(): string;
 }
 
 declare class ProductDetail$1 implements PageObject {
     readonly page: Page;
-    readonly productData: components['schemas']['Product'];
     readonly addToCartButton: Locator;
+    readonly quantitySelect: Locator;
+    readonly productSingleImage: Locator;
     readonly offCanvasCartTitle: Locator;
     readonly offCanvasCart: Locator;
     readonly offCanvasCartGoToCheckoutButton: Locator;
-    readonly productSingleImage: Locator;
     readonly offCanvasLineItemImages: Locator;
-    readonly quantitySelect: Locator;
     readonly offCanvasSummaryTotalPrice: Locator;
     readonly offCanvas: Locator;
-    constructor(page: Page, productData: components['schemas']['Product']);
-    goTo(productData?: components['schemas']['Product']): Promise<void>;
+    constructor(page: Page);
+    url(productData: Product): string;
 }
 
 declare class Category implements PageObject {
     readonly page: Page;
-    readonly categoryData: components['schemas']['Category'];
     readonly sortingSelect: Locator;
     readonly firstProductBuyButton: Locator;
     readonly noProductsFoundAlert: Locator;
-    constructor(page: Page, CategoryData: components['schemas']['Category']);
-    goTo(): Promise<void>;
+    constructor(page: Page);
+    url(categoryName: string): string;
 }
 
 declare class CheckoutCart implements PageObject {
@@ -186,7 +202,7 @@ declare class CheckoutCart implements PageObject {
     readonly cartLineItemImages: Locator;
     readonly unitPriceInfo: Locator;
     constructor(page: Page);
-    goTo(): Promise<void>;
+    url(): string;
 }
 
 declare class CheckoutConfirm implements PageObject {
@@ -212,7 +228,7 @@ declare class CheckoutConfirm implements PageObject {
      */
     readonly cartLineItemImages: Locator;
     constructor(page: Page);
-    goTo(): Promise<void>;
+    url(): string;
 }
 
 declare class CheckoutFinish implements PageObject {
@@ -223,7 +239,7 @@ declare class CheckoutFinish implements PageObject {
     readonly cartLineItemImages: Locator;
     private readonly orderNumberRegex;
     constructor(page: Page);
-    goTo(): Promise<void>;
+    url(): string;
     getOrderNumber(): Promise<string | null>;
     getOrderId(): string | null;
 }
@@ -232,7 +248,7 @@ declare class CheckoutRegister implements PageObject {
     readonly page: Page;
     readonly cartLineItemImages: Locator;
     constructor(page: Page);
-    goTo(): Promise<void>;
+    url(): string;
 }
 
 declare class Account implements PageObject {
@@ -245,7 +261,7 @@ declare class Account implements PageObject {
     readonly newsletterCheckbox: Locator;
     readonly newsletterRegistrationSuccessMessage: Locator;
     constructor(page: Page);
-    goTo(): Promise<void>;
+    url(): string;
 }
 
 declare class AccountLogin implements PageObject {
@@ -266,7 +282,7 @@ declare class AccountLogin implements PageObject {
     readonly countryInput: Locator;
     readonly registerButton: Locator;
     constructor(page: Page);
-    goTo(): Promise<void>;
+    url(): string;
 }
 
 declare class AccountProfile implements PageObject {
@@ -286,7 +302,7 @@ declare class AccountProfile implements PageObject {
     readonly currentPasswordInput: Locator;
     readonly saveNewPasswordButton: Locator;
     constructor(page: Page);
-    goTo(): Promise<void>;
+    url(): string;
 }
 
 declare class AccountOrder implements PageObject {
@@ -295,7 +311,7 @@ declare class AccountOrder implements PageObject {
     readonly orderExpandButton: Locator;
     readonly digitalProductDownloadButton: Locator;
     constructor(page: Page);
-    goTo(): Promise<void>;
+    url(): string;
 }
 
 declare class AccountAddresses implements PageObject {
@@ -306,7 +322,7 @@ declare class AccountAddresses implements PageObject {
     readonly useDefaultBillingAddressButton: Locator;
     readonly useDefaultShippingAddressButton: Locator;
     constructor(page: Page);
-    goTo(): Promise<void>;
+    url(): string;
 }
 
 declare class AccountPayment implements PageObject {
@@ -316,21 +332,22 @@ declare class AccountPayment implements PageObject {
     readonly invoiceOption: Locator;
     readonly changeDefaultPaymentButton: Locator;
     constructor(page: Page);
-    goTo(): Promise<void>;
+    url(): string;
 }
 
 declare class Search implements PageObject {
     readonly page: Page;
+    readonly headline: Locator;
     readonly productImages: Locator;
     constructor(page: Page);
-    goTo(): Promise<void>;
+    url(searchTerm: string): string;
 }
 
 declare class SearchSuggest implements PageObject {
     readonly page: Page;
     readonly searchSuggestLineItemImages: Locator;
     constructor(page: Page);
-    goTo(): Promise<void>;
+    url(searchTerm: string): string;
 }
 
 interface StorefrontPageTypes {
@@ -406,30 +423,26 @@ declare class ProductDetail implements PageObject {
     readonly propertyOptionSizeSmall: Locator;
     readonly propertyOptionSizeMedium: Locator;
     readonly propertyOptionSizeLarge: Locator;
-    readonly productData: components['schemas']['Product'];
-    constructor(page: Page, productData: components['schemas']['Product']);
-    goTo(): Promise<void>;
-    getProductId(): string | undefined;
+    constructor(page: Page);
+    url(productId: string): string;
 }
 
 declare class OrderDetail implements PageObject {
     readonly page: Page;
+    readonly saveButton: Locator;
     readonly dataGridContextButton: Locator;
     readonly orderTag: Locator;
-    readonly orderData: components['schemas']['Order'];
-    constructor(page: Page, orderData: components['schemas']['Order']);
-    goTo(): Promise<void>;
+    constructor(page: Page);
+    url(orderId: string): string;
 }
 
 declare class CustomerDetail implements PageObject {
     readonly page: Page;
-    readonly customerId: string | undefined;
-    readonly customer: components['schemas']['Customer'];
     readonly editButton: Locator;
     readonly generalTab: Locator;
     readonly accountCard: Locator;
-    constructor(page: Page, customer: components['schemas']['Customer']);
-    goTo(): Promise<void>;
+    constructor(page: Page);
+    url(customerId: string): string;
 }
 
 declare class FirstRunWizard implements PageObject {
@@ -473,7 +486,7 @@ declare class FirstRunWizard implements PageObject {
     readonly recommendationHeader: Locator;
     readonly toolsRecommendedPlugin: Locator;
     constructor(page: Page);
-    goTo(): Promise<void>;
+    url(): string;
 }
 
 declare class FlowBuilderCreate implements PageObject {
@@ -481,11 +494,12 @@ declare class FlowBuilderCreate implements PageObject {
     readonly saveButton: Locator;
     readonly header: Locator;
     constructor(page: Page);
-    goTo(): Promise<void>;
+    url(): string;
 }
 
 declare class FlowBuilderListing implements PageObject {
     readonly page: Page;
+    readonly createFlowButton: Locator;
     readonly firstFlowName: Locator;
     readonly firstFlowContextButton: Locator;
     readonly flowContextMenu: Locator;
@@ -495,7 +509,41 @@ declare class FlowBuilderListing implements PageObject {
     readonly successAlert: Locator;
     readonly successAlertMessage: Locator;
     constructor(page: Page);
-    goTo(): Promise<void>;
+    url(): string;
+}
+
+declare class FlowBuilderDetail implements PageObject {
+    readonly page: Page;
+    readonly saveButton: Locator;
+    readonly generalTab: Locator;
+    readonly flowTab: Locator;
+    constructor(page: Page);
+    url(flowId: string, tabName?: string): string;
+}
+
+declare class DataSharing implements PageObject {
+    readonly page: Page;
+    readonly dataConsentHeadline: Locator;
+    readonly dataSharingSuccessMessageLabel: Locator;
+    readonly dataSharingAgreeButton: Locator;
+    readonly dataSharingDisableButton: Locator;
+    readonly dataSharingTermsAgreementLabel: Locator;
+    constructor(page: Page);
+    url(): string;
+}
+
+declare class Dashboard implements PageObject {
+    readonly page: Page;
+    readonly welcomeHeadline: Locator;
+    readonly dataSharingConsentBanner: Locator;
+    readonly dataSharingAgreeButton: Locator;
+    readonly dataSharingNotAtTheMomentButton: Locator;
+    readonly dataSharingTermsAgreementLabel: Locator;
+    readonly dataSharingSettingsLink: Locator;
+    readonly dataSharingAcceptMessageText: Locator;
+    readonly dataSharingNotAtTheMomentMessageText: Locator;
+    constructor(page: Page);
+    url(): string;
 }
 
 interface AdministrationPageTypes {
@@ -505,6 +553,9 @@ interface AdministrationPageTypes {
     AdminFirstRunWizard: FirstRunWizard;
     AdminFlowBuilderCreate: FlowBuilderCreate;
     AdminFlowBuilderListing: FlowBuilderListing;
+    AdminFlowBuilderDetail: FlowBuilderDetail;
+    AdminDataSharing: DataSharing;
+    AdminDashboard: Dashboard;
 }
 declare const AdminPageObjects: {
     ProductDetail: typeof ProductDetail;
@@ -513,13 +564,16 @@ declare const AdminPageObjects: {
     FirstRunWizard: typeof FirstRunWizard;
     FlowBuilderCreate: typeof FlowBuilderCreate;
     FlowBuilderListing: typeof FlowBuilderListing;
+    FlowBuilderDetail: typeof FlowBuilderDetail;
+    Dashboard: typeof Dashboard;
+    DataSharing: typeof DataSharing;
 };
 
 interface DataFixtureTypes {
-    ProductData: components['schemas']['Product'];
-    CategoryData: components['schemas']['Category'];
+    ProductData: Product;
+    CategoryData: Category$1;
     DigitalProductData: {
-        product: components['schemas']['Product'];
+        product: Product;
         fileContent: string;
     };
     PromotionWithCodeData: components['schemas']['Promotion'];
@@ -529,7 +583,7 @@ interface DataFixtureTypes {
         propertyGroupSize: components['schemas']['PropertyGroup'];
     };
     MediaData: components['schemas']['Media'];
-    OrderData: components['schemas']['Order'];
+    OrderData: Order;
     TagData: components['schemas']['Tag'];
 }
 
@@ -556,6 +610,8 @@ declare const getOrderTransactionId: (orderId: string, adminApiContext: AdminApi
 }>;
 declare const getMediaId: (fileName: string, adminApiContext: AdminApiContext) => Promise<string>;
 declare function extractIdFromUrl(url: string): string | null;
+type OrderStatus = 'cancel' | 'complete' | 'reopen' | 'process';
+declare const setOrderStatus: (orderId: string, orderStatus: OrderStatus, adminApiContext: AdminApiContext) => Promise<APIResponse>;
 
 declare const isSaaSInstance: (adminApiContext: AdminApiContext) => Promise<boolean>;
 
@@ -597,4 +653,4 @@ declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArg
     ValidateAccessibility: (pageName: string, assertViolations?: boolean | undefined, createReport?: boolean | undefined, ruleTags?: string[] | undefined, outputDir?: string | undefined) => () => Promise<void>;
 }, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & HelperFixtureTypes & FixtureTypes>;
 
-export { AdminPageObjects, type FixtureTypes, type PageObject, StorefrontPageObjects, type Task, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlowId, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getSalutationId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, isSaaSInstance, test };
+export { AdminPageObjects, type FixtureTypes, type PageObject, StorefrontPageObjects, type Task, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlowId, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getSalutationId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, isSaaSInstance, setOrderStatus, test };