@shopware-ag/acceptance-test-suite 12.6.1 → 12.7.0

package/dist/index.d.mts

@@ -94,6 +94,7 @@ type CustomerAddress = components["schemas"]["CustomerAddress"] & {
     id: string;
 };
 interface Address {
+    id: string;
     salutation: string;
     firstName: string;
     lastName: string;
@@ -101,7 +102,7 @@ interface Address {
     department: string;
     street: string;
     city: string;
-    zipCode: string;
+    zipcode: string;
     country: string;
     state: string;
 }
@@ -789,6 +790,12 @@ declare class TestDataService {
      * @param overrides - Specific data overrides that will be applied to the customer group data struct.
      */
     createCustomerGroup(overrides?: Partial<CustomerGroup>): Promise<CustomerGroup>;
+    /**
+     * Creates a customer address
+     *
+     * @param overrides - Specific data overrides that will be applied to the customer address data struct.
+     */
+    createCustomerAddress(customer: Customer, overrides?: Partial<Address>): Promise<Address>;
     /**
      * Set system config for default sales channel
      *
@@ -1222,6 +1229,7 @@ declare class TestDataService {
     getBasicPromotionStruct(salesChannelId?: string, overrides?: Partial<Promotion>): Partial<Promotion>;
     getBasicCmsStruct(cmsType: string, overrides: Partial<CmsPage>): Partial<CmsPage>;
     getBasicCustomerGroupStruct(overrides?: Partial<CustomerGroup>): Partial<CustomerGroup>;
+    getBasicCustomerAddressStruct(customerId: string, overrides?: Partial<Address>): Partial<Address>;
     getSalesChannelAnalyticsStruct(overrides?: Partial<SalesChannelAnalytics>): Partial<SalesChannelAnalytics>;
     clearCaches(): Promise<void>;
     getBasicCustomFieldSetStruct(overrides?: Partial<CustomFieldSet>): Partial<CustomFieldSet>;
@@ -1982,6 +1990,11 @@ declare const BUNDLED_RESOURCES: {
                 useAsDefaultBilling: string;
                 useAsDefaultShipping: string;
                 addressOptions: string;
+                deleteAddress: string;
+            };
+            badges: {
+                defaultBilling: string;
+                defaultShipping: string;
             };
             messages: {
                 deliveryNotPossible: string;
@@ -2976,6 +2989,11 @@ declare const BUNDLED_RESOURCES: {
                 useAsDefaultBilling: string;
                 useAsDefaultShipping: string;
                 addressOptions: string;
+                deleteAddress: string;
+            };
+            badges: {
+                defaultBilling: string;
+                defaultShipping: string;
             };
             messages: {
                 deliveryNotPossible: string;
@@ -3936,6 +3954,11 @@ declare const baseNamespaces: {
                 useAsDefaultBilling: string;
                 useAsDefaultShipping: string;
                 addressOptions: string;
+                deleteAddress: string;
+            };
+            badges: {
+                defaultBilling: string;
+                defaultShipping: string;
             };
             messages: {
                 deliveryNotPossible: string;
@@ -4754,6 +4777,11 @@ declare class AccountAddresses extends BaseAccount {
     readonly instanceMeta: HelperFixtureTypes["InstanceMeta"];
     constructor(page: Page, instanceMeta: HelperFixtureTypes["InstanceMeta"]);
     url(): string;
+    private buildAddressRegex;
+    private escapeRegex;
+    getAvailableAddress(partialAddressData: Partial<Address>): Promise<Record<string, Locator>>;
+    getDefaultShippingAddress(partialAddressData?: Partial<Address>): Promise<Locator>;
+    getDefaultBillingAddress(partialAddressData?: Partial<Address>): Promise<Locator>;
 }
 
 declare class AccountPayment implements PageObject {
@@ -4828,6 +4856,9 @@ declare class CheckoutOrderEdit implements PageObject {
     getPaymentMethodButton(paymentMethodName: string): Locator;
 }
 
+/**
+ * @deprecated - Use AccountAddressDetails instead.
+ */
 declare class AccountAddressCreate extends BaseAccount {
     readonly salutationDropdown: Locator;
     readonly firstNameInput: Locator;
@@ -4844,6 +4875,26 @@ declare class AccountAddressCreate extends BaseAccount {
     url(): string;
 }
 
+declare class AccountAddressDetails extends BaseAccount {
+    readonly salutationDropdown: Locator;
+    readonly firstNameInput: Locator;
+    readonly lastNameInput: Locator;
+    readonly companyInput: Locator;
+    readonly departmentInput: Locator;
+    readonly streetInput: Locator;
+    readonly zipcodeInput: Locator;
+    readonly cityInput: Locator;
+    readonly countryDropdown: Locator;
+    readonly saveAddressButton: Locator;
+    readonly stateDropdown: Locator;
+    constructor(page: Page);
+    /**
+    * The address details page is used for both creating and editing addresses. The URL contains the address ID when editing an existing address, but not when creating a new one. Therefore, the addressId parameter is optional.
+    * @param addressId - The ID of the address being edited. This parameter is optional because the same page object is used for creating new addresses, where no address ID is present in the URL.
+    */
+    url(addressId?: string): string;
+}
+
 declare class PageNotFound implements PageObject {
     readonly pageNotFoundImage: Locator;
     readonly headline: Locator;
@@ -4945,6 +4996,7 @@ interface StorefrontPageTypes {
     StorefrontAccountOrder: AccountOrder;
     StorefrontAccountAddresses: AccountAddresses;
     StorefrontAccountAddressCreate: AccountAddressCreate;
+    StorefrontAccountAddressDetails: AccountAddressDetails;
     StorefrontAccountPayment: AccountPayment;
     StorefrontSearch: Search;
     StorefrontSearchSuggest: SearchSuggest;
@@ -4972,6 +5024,7 @@ declare const StorefrontPageObjects: {
     AccountOrder: typeof AccountOrder;
     AccountAddresses: typeof AccountAddresses;
     AccountAddressCreate: typeof AccountAddressCreate;
+    AccountAddressDetails: typeof AccountAddressDetails;
     AccountPayment: typeof AccountPayment;
     Search: typeof Search;
     SearchSuggest: typeof SearchSuggest;

package/dist/index.d.ts

@@ -94,6 +94,7 @@ type CustomerAddress = components["schemas"]["CustomerAddress"] & {
     id: string;
 };
 interface Address {
+    id: string;
     salutation: string;
     firstName: string;
     lastName: string;
@@ -101,7 +102,7 @@ interface Address {
     department: string;
     street: string;
     city: string;
-    zipCode: string;
+    zipcode: string;
     country: string;
     state: string;
 }
@@ -789,6 +790,12 @@ declare class TestDataService {
      * @param overrides - Specific data overrides that will be applied to the customer group data struct.
      */
     createCustomerGroup(overrides?: Partial<CustomerGroup>): Promise<CustomerGroup>;
+    /**
+     * Creates a customer address
+     *
+     * @param overrides - Specific data overrides that will be applied to the customer address data struct.
+     */
+    createCustomerAddress(customer: Customer, overrides?: Partial<Address>): Promise<Address>;
     /**
      * Set system config for default sales channel
      *
@@ -1222,6 +1229,7 @@ declare class TestDataService {
     getBasicPromotionStruct(salesChannelId?: string, overrides?: Partial<Promotion>): Partial<Promotion>;
     getBasicCmsStruct(cmsType: string, overrides: Partial<CmsPage>): Partial<CmsPage>;
     getBasicCustomerGroupStruct(overrides?: Partial<CustomerGroup>): Partial<CustomerGroup>;
+    getBasicCustomerAddressStruct(customerId: string, overrides?: Partial<Address>): Partial<Address>;
     getSalesChannelAnalyticsStruct(overrides?: Partial<SalesChannelAnalytics>): Partial<SalesChannelAnalytics>;
     clearCaches(): Promise<void>;
     getBasicCustomFieldSetStruct(overrides?: Partial<CustomFieldSet>): Partial<CustomFieldSet>;
@@ -1982,6 +1990,11 @@ declare const BUNDLED_RESOURCES: {
                 useAsDefaultBilling: string;
                 useAsDefaultShipping: string;
                 addressOptions: string;
+                deleteAddress: string;
+            };
+            badges: {
+                defaultBilling: string;
+                defaultShipping: string;
             };
             messages: {
                 deliveryNotPossible: string;
@@ -2976,6 +2989,11 @@ declare const BUNDLED_RESOURCES: {
                 useAsDefaultBilling: string;
                 useAsDefaultShipping: string;
                 addressOptions: string;
+                deleteAddress: string;
+            };
+            badges: {
+                defaultBilling: string;
+                defaultShipping: string;
             };
             messages: {
                 deliveryNotPossible: string;
@@ -3936,6 +3954,11 @@ declare const baseNamespaces: {
                 useAsDefaultBilling: string;
                 useAsDefaultShipping: string;
                 addressOptions: string;
+                deleteAddress: string;
+            };
+            badges: {
+                defaultBilling: string;
+                defaultShipping: string;
             };
             messages: {
                 deliveryNotPossible: string;
@@ -4754,6 +4777,11 @@ declare class AccountAddresses extends BaseAccount {
     readonly instanceMeta: HelperFixtureTypes["InstanceMeta"];
     constructor(page: Page, instanceMeta: HelperFixtureTypes["InstanceMeta"]);
     url(): string;
+    private buildAddressRegex;
+    private escapeRegex;
+    getAvailableAddress(partialAddressData: Partial<Address>): Promise<Record<string, Locator>>;
+    getDefaultShippingAddress(partialAddressData?: Partial<Address>): Promise<Locator>;
+    getDefaultBillingAddress(partialAddressData?: Partial<Address>): Promise<Locator>;
 }
 
 declare class AccountPayment implements PageObject {
@@ -4828,6 +4856,9 @@ declare class CheckoutOrderEdit implements PageObject {
     getPaymentMethodButton(paymentMethodName: string): Locator;
 }
 
+/**
+ * @deprecated - Use AccountAddressDetails instead.
+ */
 declare class AccountAddressCreate extends BaseAccount {
     readonly salutationDropdown: Locator;
     readonly firstNameInput: Locator;
@@ -4844,6 +4875,26 @@ declare class AccountAddressCreate extends BaseAccount {
     url(): string;
 }
 
+declare class AccountAddressDetails extends BaseAccount {
+    readonly salutationDropdown: Locator;
+    readonly firstNameInput: Locator;
+    readonly lastNameInput: Locator;
+    readonly companyInput: Locator;
+    readonly departmentInput: Locator;
+    readonly streetInput: Locator;
+    readonly zipcodeInput: Locator;
+    readonly cityInput: Locator;
+    readonly countryDropdown: Locator;
+    readonly saveAddressButton: Locator;
+    readonly stateDropdown: Locator;
+    constructor(page: Page);
+    /**
+    * The address details page is used for both creating and editing addresses. The URL contains the address ID when editing an existing address, but not when creating a new one. Therefore, the addressId parameter is optional.
+    * @param addressId - The ID of the address being edited. This parameter is optional because the same page object is used for creating new addresses, where no address ID is present in the URL.
+    */
+    url(addressId?: string): string;
+}
+
 declare class PageNotFound implements PageObject {
     readonly pageNotFoundImage: Locator;
     readonly headline: Locator;
@@ -4945,6 +4996,7 @@ interface StorefrontPageTypes {
     StorefrontAccountOrder: AccountOrder;
     StorefrontAccountAddresses: AccountAddresses;
     StorefrontAccountAddressCreate: AccountAddressCreate;
+    StorefrontAccountAddressDetails: AccountAddressDetails;
     StorefrontAccountPayment: AccountPayment;
     StorefrontSearch: Search;
     StorefrontSearchSuggest: SearchSuggest;
@@ -4972,6 +5024,7 @@ declare const StorefrontPageObjects: {
     AccountOrder: typeof AccountOrder;
     AccountAddresses: typeof AccountAddresses;
     AccountAddressCreate: typeof AccountAddressCreate;
+    AccountAddressDetails: typeof AccountAddressDetails;
     AccountPayment: typeof AccountPayment;
     Search: typeof Search;
     SearchSuggest: typeof SearchSuggest;

package/dist/index.mjs

@@ -1438,10 +1438,15 @@ const common$7 = {
 	postalCode: "Postal code"
 };
 const actions$b = {
-	editAddress: "Edit address",
+	editAddress: "Edit",
 	useAsDefaultBilling: "Use as default billing address",
 	useAsDefaultShipping: "Use as default shipping address",
-	addressOptions: "Address options"
+	addressOptions: "Address options",
+	deleteAddress: "Delete address"
+};
+const badges$1 = {
+	defaultBilling: "Default billing address",
+	defaultShipping: "Default shipping address"
 };
 const messages$4 = {
 	deliveryNotPossible: "A delivery to this country is not possible."
@@ -1449,6 +1454,7 @@ const messages$4 = {
 const storefrontAddress = {
 	common: common$7,
 	actions: actions$b,
+	badges: badges$1,
 	messages: messages$4
 };
 
@@ -2658,10 +2664,15 @@ const common$1 = {
 	postalCode: "Postleitzahl"
 };
 const actions$2 = {
-	editAddress: "Adresse bearbeiten",
+	editAddress: "Bearbeiten",
 	useAsDefaultBilling: "Als Standard-Rechnungsadresse verwenden",
 	useAsDefaultShipping: "Als Standard-Lieferadresse verwenden",
-	addressOptions: "Adress-Optionen"
+	addressOptions: "Adress-Optionen",
+	deleteAddress: "Adresse löschen"
+};
+const badges = {
+	defaultBilling: "Standard-Rechnungsadresse",
+	defaultShipping: "Standard-Lieferadresse"
 };
 const messages = {
 	deliveryNotPossible: "Eine Lieferung in dieses Land ist nicht möglich."
@@ -2669,6 +2680,7 @@ const messages = {
 const deStorefrontAddress = {
 	common: common$1,
 	actions: actions$2,
+	badges: badges,
 	messages: messages
 };
 
@@ -3995,6 +4007,7 @@ class TestDataService {
     "sales_channel_currency",
     "sales_channel_country",
     "sales_channel_payment_method",
+    "customer_address",
     "customer",
     "acl_user_role",
     "category"
@@ -4618,6 +4631,21 @@ class TestDataService {
     this.addCreatedRecord("customer_group", customerGroup.id);
     return customerGroup;
   }
+  /**
+   * Creates a customer address
+   *
+   * @param overrides - Specific data overrides that will be applied to the customer address data struct.
+   */
+  async createCustomerAddress(customer, overrides = {}) {
+    const basicCustomerAddress = this.getBasicCustomerAddressStruct(customer.id, overrides);
+    const response = await this.AdminApiClient.post("customer-address?_response=detail", {
+      data: basicCustomerAddress
+    });
+    expect(response.ok()).toBeTruthy();
+    const { data: customerAddress } = await response.json();
+    this.addCreatedRecord("customer_address", customerAddress.id);
+    return customerAddress;
+  }
   /**
    * Set system config for default sales channel
    *
@@ -6242,6 +6270,20 @@ class TestDataService {
     };
     return Object.assign({}, basicCustomerGroup, overrides);
   }
+  getBasicCustomerAddressStruct(customerId, overrides = {}) {
+    const customerAddressUuid = this.IdProvider.getIdPair().uuid;
+    const basicCustomerAddress = {
+      id: customerAddressUuid,
+      customerId,
+      countryId: this.defaultCountryId,
+      firstName: "Peter",
+      lastName: "Venkman",
+      zipcode: "10013",
+      street: "14 N Moore Street",
+      city: "New York"
+    };
+    return Object.assign({}, basicCustomerAddress, overrides);
+  }
   getSalesChannelAnalyticsStruct(overrides = {}) {
     const salesChannelAnalyticsUuid = this.IdProvider.getIdPair().uuid;
     const trackingId = this.IdProvider.getIdPair().id;
@@ -7442,6 +7484,61 @@ class AccountAddresses extends BaseAccount {
   url() {
     return "account/address";
   }
+  buildAddressRegex(data) {
+    const parts = [data.firstName, data.lastName, data.street, data.zipcode, data.city].filter(Boolean);
+    const pattern = parts.map((p) => this.escapeRegex(p)).join(".*");
+    return new RegExp(pattern);
+  }
+  escapeRegex(text) {
+    return text.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+  }
+  async getAvailableAddress(partialAddressData) {
+    if (satisfies(this.instanceMeta.version, "<6.7")) {
+      throw new Error("getAvailableAddress is not supported for Shopware versions below 6.7");
+    }
+    const regex = this.buildAddressRegex(partialAddressData);
+    if (!this.availableAddresses) {
+      throw new Error("Available addresses are not defined.");
+    }
+    const addressContainer = this.availableAddresses.locator(".address-manager-select-address").filter({ hasText: regex }).first();
+    const address = addressContainer.locator(".address");
+    const addressActionsButton = addressContainer.locator("[id^='address-item-dropdown']");
+    const addressActionsDropdown = addressContainer.locator(".dropdown-menu");
+    const editAddressButton = addressActionsDropdown.getByRole("link", { name: translate("storefront:address:actions.editAddress") });
+    const useAsDefaultShippingButton = addressActionsDropdown.getByRole("button", { name: translate("storefront:address:actions.useAsDefaultShipping") });
+    const useAsDefaultBillingButton = addressActionsDropdown.getByRole("button", { name: translate("storefront:address:actions.useAsDefaultBilling") });
+    const defaultShippingAddressBadge = addressContainer.locator(".address-item-default-badge", { hasText: translate("storefront:address:badges.defaultShipping") });
+    const defaultBillingAddressBadge = addressContainer.locator(".address-item-default-badge", { hasText: translate("storefront:address:badges.defaultBilling") });
+    return {
+      address,
+      addressActions: addressActionsButton,
+      editAddressButton,
+      useAsDefaultShippingButton,
+      useAsDefaultBillingButton,
+      isDefaultShippingAddress: defaultShippingAddressBadge,
+      isDefaultBillingAddress: defaultBillingAddressBadge
+    };
+  }
+  async getDefaultShippingAddress(partialAddressData) {
+    if (satisfies(this.instanceMeta.version, "<6.7")) {
+      throw new Error("getDefaultShippingAddress is not supported for Shopware versions below 6.7");
+    }
+    if (partialAddressData) {
+      const regex = this.buildAddressRegex(partialAddressData);
+      return this.page.locator(".address-manager-select-address").filter({ hasText: regex }).filter({ hasText: translate("storefront:address:badges.defaultShipping") }).first();
+    }
+    return this.page.locator(".address-manager-select-address").filter({ hasText: translate("storefront:address:badges.defaultShipping") });
+  }
+  async getDefaultBillingAddress(partialAddressData) {
+    if (satisfies(this.instanceMeta.version, "<6.7")) {
+      throw new Error("getDefaultBillingAddress is not supported for Shopware versions below 6.7");
+    }
+    if (partialAddressData) {
+      const regex = this.buildAddressRegex(partialAddressData);
+      return this.page.locator(".address-manager-select-address").filter({ hasText: regex }).filter({ hasText: translate("storefront:address:badges.defaultBilling") }).first();
+    }
+    return this.page.locator(".address-manager-select-address").filter({ hasText: translate("storefront:address:badges.defaultBilling") }).first();
+  }
 }
 
 class AccountPayment {
@@ -7601,6 +7698,44 @@ class AccountAddressCreate extends BaseAccount {
   }
 }
 
+class AccountAddressDetails extends BaseAccount {
+  salutationDropdown;
+  firstNameInput;
+  lastNameInput;
+  companyInput;
+  departmentInput;
+  streetInput;
+  zipcodeInput;
+  cityInput;
+  countryDropdown;
+  saveAddressButton;
+  stateDropdown;
+  constructor(page) {
+    super(page);
+    this.salutationDropdown = page.getByRole("combobox", { name: translate("storefront:address:common.salutation") });
+    this.firstNameInput = page.getByRole("textbox", { name: translate("storefront:address:common.firstName") });
+    this.lastNameInput = page.getByRole("textbox", { name: translate("storefront:address:common.lastName") });
+    this.companyInput = page.getByRole("textbox", { name: translate("storefront:address:common.company") });
+    this.departmentInput = page.getByRole("textbox", { name: translate("storefront:address:common.department") });
+    this.streetInput = page.getByRole("textbox", { name: translate("storefront:address:common.street") });
+    this.zipcodeInput = page.getByRole("textbox", { name: translate("storefront:address:common.postalCode") });
+    this.cityInput = page.locator("#addressAddressCity");
+    this.countryDropdown = page.locator("#addressAddressCountry");
+    this.stateDropdown = page.locator("#addressAddressCountryState");
+    this.saveAddressButton = page.locator(".address-form-submit");
+  }
+  /**
+  * The address details page is used for both creating and editing addresses. The URL contains the address ID when editing an existing address, but not when creating a new one. Therefore, the addressId parameter is optional.
+  * @param addressId - The ID of the address being edited. This parameter is optional because the same page object is used for creating new addresses, where no address ID is present in the URL.
+  */
+  url(addressId = "") {
+    if (addressId) {
+      return `account/address/${addressId}`;
+    }
+    return "account/address/create";
+  }
+}
+
 class PageNotFound {
   pageNotFoundImage;
   headline;
@@ -7784,6 +7919,7 @@ const StorefrontPageObjects = {
   AccountOrder,
   AccountAddresses,
   AccountAddressCreate,
+  AccountAddressDetails,
   AccountPayment,
   Search,
   SearchSuggest,
@@ -7838,9 +7974,15 @@ const test$7 = test$e.extend({
   StorefrontAccountAddresses: async ({ StorefrontPage, InstanceMeta }, use) => {
     await use(new AccountAddresses(StorefrontPage, InstanceMeta));
   },
+  /** 
+  * @deprecated - Use StorefrontAccountAddressDetails instead. 
+  */
   StorefrontAccountAddressCreate: async ({ StorefrontPage }, use) => {
     await use(new AccountAddressCreate(StorefrontPage));
   },
+  StorefrontAccountAddressDetails: async ({ StorefrontPage }, use) => {
+    await use(new AccountAddressDetails(StorefrontPage));
+  },
   StorefrontAccountPayment: async ({ StorefrontPage }, use) => {
     await use(new AccountPayment(StorefrontPage));
   },
@@ -11749,7 +11891,7 @@ const AddNewAddress = test$e.extend({
         await ShopCustomer.fillsIn(StorefrontAccountAddressCreate.companyInput, address.company);
         await ShopCustomer.fillsIn(StorefrontAccountAddressCreate.departmentInput, address.department);
         await ShopCustomer.fillsIn(StorefrontAccountAddressCreate.streetInput, address.street);
-        await ShopCustomer.fillsIn(StorefrontAccountAddressCreate.zipcodeInput, address.zipCode);
+        await ShopCustomer.fillsIn(StorefrontAccountAddressCreate.zipcodeInput, address.zipcode);
         await ShopCustomer.fillsIn(StorefrontAccountAddressCreate.cityInput, address.city);
         await ShopCustomer.presses(StorefrontAccountAddressCreate.countryDropdown);
         await StorefrontAccountAddressCreate.countryDropdown.selectOption({ label: address.country });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@shopware-ag/acceptance-test-suite",
-    "version": "12.6.1",
+    "version": "12.7.0",
     "description": "Shopware Acceptance Test Suite",
     "keywords": [
         "fixtures",