@shopware-ag/acceptance-test-suite 12.23.2 → 12.24.1

package/dist/index.d.mts

@@ -368,6 +368,9 @@ type DeliveryTime = components["schemas"]["DeliveryTime"] & {
 type CmsPage = components["schemas"]["CmsPage"] & {
     id: string;
 };
+type LandingPage = components["schemas"]["LandingPage"] & {
+    id: string;
+};
 type CustomerGroup = components["schemas"]["CustomerGroup"] & {
     id: string;
 };
@@ -842,6 +845,20 @@ declare class TestDataService {
      * @param overrides - Specific data overrides that will be applied to the cms page layout data struct.
      */
     createBasicPageLayout(cmsPageType: string, overrides?: Partial<CmsPage>): Promise<CmsPage>;
+    /**
+     * Creates a landing page category
+     *
+     * @param salesChannelId - The uuid of the sales channel in which the landing page should be active.
+     * @param overrides - Specific data overrides applied to the landing page payload.
+     */
+    createLandingPage(overrides?: Partial<LandingPage>, salesChannelId?: string): Promise<LandingPage>;
+    /**
+     * Assigns a CMS landing page layout to a landing page category
+     *
+     * @param landingPageId - The uuid of the landing page category.
+     * @param cmsPageId - The uuid of the CMS landing page layout.
+     */
+    assignLandingPageLayout(landingPageId: string, cmsPageId: string): Promise<LandingPage>;
     /**
      * Creates a random country
      *
@@ -1170,6 +1187,14 @@ declare class TestDataService {
      * Will delete all entities created by the data service via sync API.
      */
     cleanUp(): Promise<playwright_core.APIResponse | null>;
+    /**
+     * Deletes all documents of the given orders.
+     * Documents restrict the deletion of their order, so the cleanup calls this before deleting created orders.
+     * Dependent documents (e.g. credit notes, cancellation invoices) are deleted before the documents they reference.
+     *
+     * @param orderIds - The ids of the orders whose documents should be deleted.
+     */
+    deleteOrderDocuments(orderIds: string[]): Promise<void>;
     isProduct(item: Product | Promotion): item is Product;
     isPromotion(item: Product | Promotion): item is Promotion;
     /**
@@ -1311,6 +1336,15 @@ declare class TestDataService {
     } & Partial<OrderLineItem>;
     getBasicPromotionStruct(salesChannelId?: string, overrides?: Partial<Promotion>): Partial<Promotion>;
     getBasicCmsStruct(cmsType: string, overrides: Partial<CmsPage>): Partial<CmsPage>;
+    getBasicLandingPageStruct(salesChannelId: string, overrides?: Partial<LandingPage>): {
+        id: string;
+        name: string;
+        url: string;
+        active: boolean;
+        salesChannels: {
+            id: string;
+        }[];
+    } & Partial<LandingPage>;
     getBasicCustomerGroupStruct(overrides?: Partial<CustomerGroup>): Partial<CustomerGroup>;
     getBasicCustomerAddressStruct(customerId: string, overrides?: Partial<Address>): Partial<Address>;
     getSalesChannelAnalyticsStruct(overrides?: Partial<SalesChannelAnalytics>): Partial<SalesChannelAnalytics>;
@@ -5488,6 +5522,7 @@ declare class CustomerDetail implements PageObject {
     readonly customFieldCard: Locator;
     readonly customFieldSetTabs: Locator;
     readonly customFieldSetTabCustomContent: Locator;
+    readonly customerGroupRegistrationAlert: Locator;
     readonly customerGroupRequestMessage: Locator;
     readonly customerGroupAcceptButton: Locator;
     readonly customerGroupDeclineButton: Locator;
@@ -7097,4 +7132,4 @@ declare const test: playwright_test.TestType<playwright_test.PlaywrightTestArgs
 }>;
 
 export { Actor, AdminPageObjects, BUNDLED_RESOURCES, COUNTRY_ADDRESS_DATA, FeatureService, IdProvider, LanguageHelper, RuleType, StorefrontPageObjects, TestDataService, assertScreenshot, baseNamespaces, clearDelayedCache, compareFlowTemplateWithFlow, createNewAdminPageContext, createRandomImage, createSolidColorImage, encodeImage, expandAdminMenu, extractIdFromUrl, formatPrice, getCountryAddressData, getCountryCodeFromLocale, getCountryId, getCurrency, getCurrencyCodeFromLocale, getCurrencySymbolFromLocale, getCurrentContext, getDefaultShippingMethodId, getFlow, getFlowId, getFlowTemplate, getLanguageCode, getLanguageData, getLocale, getMediaId, getOrderTransactionId, getPaymentMethodId, getPromotionWithDiscount, getSalutationId, getShippingMethodId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, hideElements, hideSymfonyToolbarOnReload, isPaaSInstance, isSaaSInstance, isThemeCompiled, loginToAdministration, mockApiCalls, replaceElements, replaceElementsIndividually, setCurrentContext, setOrderStatus, setViewport, test, translate, updateAdminUser, uploadRandomPngMedia };
-export type { AccountData, AclRole, Address, BasicRuleCondition, CalculatedTaxes, Category$1 as Category, CategoryCustomizableLinkData, CategoryData, CmsPage, Country$1 as Country, CreatedRecord, Currency$2 as Currency, CustomField, CustomFieldData, CustomFieldSet, Customer, CustomerAddress, CustomerGroup, DataServiceOptions, DeliveryTime, FixtureTypes, Flow, FlowConfig, FlowTemplate, Image, Language$2 as Language, Manufacturer, Media$1 as Media, NewsletterRecipient, Options, Order, OrderDelivery, OrderLineItem, OrderStatus, PageObject, PaymentMethod$1 as PaymentMethod, Price, Product, ProductCreationType, ProductCrossSelling, ProductFormData, ProductPrice, ProductReview, Promotion, PromotionDiscount, PromotionWithConditionRuleOptions, PropertyGroup, PropertyGroupOption, RegistrationData, ReplaceTarget, Rule, RuleAssignmentEntity, SalesChannel, SalesChannelAnalytics, SalesChannelDomain, SalesChannelRecord, Salutation, ShippingMethod$1 as ShippingMethod, SimpleLineItem, StateMachine, StateMachineState, SyncApiOperation, SystemConfig, Tag, TagData, Task, Tax$1 as Tax, TaxRules, TranslateFn, TranslationKey, UploadMediaTarget, User, VariantListingConfig };
+export type { AccountData, AclRole, Address, BasicRuleCondition, CalculatedTaxes, Category$1 as Category, CategoryCustomizableLinkData, CategoryData, CmsPage, Country$1 as Country, CreatedRecord, Currency$2 as Currency, CustomField, CustomFieldData, CustomFieldSet, Customer, CustomerAddress, CustomerGroup, DataServiceOptions, DeliveryTime, FixtureTypes, Flow, FlowConfig, FlowTemplate, Image, LandingPage, Language$2 as Language, Manufacturer, Media$1 as Media, NewsletterRecipient, Options, Order, OrderDelivery, OrderLineItem, OrderStatus, PageObject, PaymentMethod$1 as PaymentMethod, Price, Product, ProductCreationType, ProductCrossSelling, ProductFormData, ProductPrice, ProductReview, Promotion, PromotionDiscount, PromotionWithConditionRuleOptions, PropertyGroup, PropertyGroupOption, RegistrationData, ReplaceTarget, Rule, RuleAssignmentEntity, SalesChannel, SalesChannelAnalytics, SalesChannelDomain, SalesChannelRecord, Salutation, ShippingMethod$1 as ShippingMethod, SimpleLineItem, StateMachine, StateMachineState, SyncApiOperation, SystemConfig, Tag, TagData, Task, Tax$1 as Tax, TaxRules, TranslateFn, TranslationKey, UploadMediaTarget, User, VariantListingConfig };

package/dist/index.d.ts

@@ -368,6 +368,9 @@ type DeliveryTime = components["schemas"]["DeliveryTime"] & {
 type CmsPage = components["schemas"]["CmsPage"] & {
     id: string;
 };
+type LandingPage = components["schemas"]["LandingPage"] & {
+    id: string;
+};
 type CustomerGroup = components["schemas"]["CustomerGroup"] & {
     id: string;
 };
@@ -842,6 +845,20 @@ declare class TestDataService {
      * @param overrides - Specific data overrides that will be applied to the cms page layout data struct.
      */
     createBasicPageLayout(cmsPageType: string, overrides?: Partial<CmsPage>): Promise<CmsPage>;
+    /**
+     * Creates a landing page category
+     *
+     * @param salesChannelId - The uuid of the sales channel in which the landing page should be active.
+     * @param overrides - Specific data overrides applied to the landing page payload.
+     */
+    createLandingPage(overrides?: Partial<LandingPage>, salesChannelId?: string): Promise<LandingPage>;
+    /**
+     * Assigns a CMS landing page layout to a landing page category
+     *
+     * @param landingPageId - The uuid of the landing page category.
+     * @param cmsPageId - The uuid of the CMS landing page layout.
+     */
+    assignLandingPageLayout(landingPageId: string, cmsPageId: string): Promise<LandingPage>;
     /**
      * Creates a random country
      *
@@ -1170,6 +1187,14 @@ declare class TestDataService {
      * Will delete all entities created by the data service via sync API.
      */
     cleanUp(): Promise<playwright_core.APIResponse | null>;
+    /**
+     * Deletes all documents of the given orders.
+     * Documents restrict the deletion of their order, so the cleanup calls this before deleting created orders.
+     * Dependent documents (e.g. credit notes, cancellation invoices) are deleted before the documents they reference.
+     *
+     * @param orderIds - The ids of the orders whose documents should be deleted.
+     */
+    deleteOrderDocuments(orderIds: string[]): Promise<void>;
     isProduct(item: Product | Promotion): item is Product;
     isPromotion(item: Product | Promotion): item is Promotion;
     /**
@@ -1311,6 +1336,15 @@ declare class TestDataService {
     } & Partial<OrderLineItem>;
     getBasicPromotionStruct(salesChannelId?: string, overrides?: Partial<Promotion>): Partial<Promotion>;
     getBasicCmsStruct(cmsType: string, overrides: Partial<CmsPage>): Partial<CmsPage>;
+    getBasicLandingPageStruct(salesChannelId: string, overrides?: Partial<LandingPage>): {
+        id: string;
+        name: string;
+        url: string;
+        active: boolean;
+        salesChannels: {
+            id: string;
+        }[];
+    } & Partial<LandingPage>;
     getBasicCustomerGroupStruct(overrides?: Partial<CustomerGroup>): Partial<CustomerGroup>;
     getBasicCustomerAddressStruct(customerId: string, overrides?: Partial<Address>): Partial<Address>;
     getSalesChannelAnalyticsStruct(overrides?: Partial<SalesChannelAnalytics>): Partial<SalesChannelAnalytics>;
@@ -5488,6 +5522,7 @@ declare class CustomerDetail implements PageObject {
     readonly customFieldCard: Locator;
     readonly customFieldSetTabs: Locator;
     readonly customFieldSetTabCustomContent: Locator;
+    readonly customerGroupRegistrationAlert: Locator;
     readonly customerGroupRequestMessage: Locator;
     readonly customerGroupAcceptButton: Locator;
     readonly customerGroupDeclineButton: Locator;
@@ -7097,4 +7132,4 @@ declare const test: playwright_test.TestType<playwright_test.PlaywrightTestArgs
 }>;
 
 export { Actor, AdminPageObjects, BUNDLED_RESOURCES, COUNTRY_ADDRESS_DATA, FeatureService, IdProvider, LanguageHelper, RuleType, StorefrontPageObjects, TestDataService, assertScreenshot, baseNamespaces, clearDelayedCache, compareFlowTemplateWithFlow, createNewAdminPageContext, createRandomImage, createSolidColorImage, encodeImage, expandAdminMenu, extractIdFromUrl, formatPrice, getCountryAddressData, getCountryCodeFromLocale, getCountryId, getCurrency, getCurrencyCodeFromLocale, getCurrencySymbolFromLocale, getCurrentContext, getDefaultShippingMethodId, getFlow, getFlowId, getFlowTemplate, getLanguageCode, getLanguageData, getLocale, getMediaId, getOrderTransactionId, getPaymentMethodId, getPromotionWithDiscount, getSalutationId, getShippingMethodId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, hideElements, hideSymfonyToolbarOnReload, isPaaSInstance, isSaaSInstance, isThemeCompiled, loginToAdministration, mockApiCalls, replaceElements, replaceElementsIndividually, setCurrentContext, setOrderStatus, setViewport, test, translate, updateAdminUser, uploadRandomPngMedia };
-export type { AccountData, AclRole, Address, BasicRuleCondition, CalculatedTaxes, Category$1 as Category, CategoryCustomizableLinkData, CategoryData, CmsPage, Country$1 as Country, CreatedRecord, Currency$2 as Currency, CustomField, CustomFieldData, CustomFieldSet, Customer, CustomerAddress, CustomerGroup, DataServiceOptions, DeliveryTime, FixtureTypes, Flow, FlowConfig, FlowTemplate, Image, Language$2 as Language, Manufacturer, Media$1 as Media, NewsletterRecipient, Options, Order, OrderDelivery, OrderLineItem, OrderStatus, PageObject, PaymentMethod$1 as PaymentMethod, Price, Product, ProductCreationType, ProductCrossSelling, ProductFormData, ProductPrice, ProductReview, Promotion, PromotionDiscount, PromotionWithConditionRuleOptions, PropertyGroup, PropertyGroupOption, RegistrationData, ReplaceTarget, Rule, RuleAssignmentEntity, SalesChannel, SalesChannelAnalytics, SalesChannelDomain, SalesChannelRecord, Salutation, ShippingMethod$1 as ShippingMethod, SimpleLineItem, StateMachine, StateMachineState, SyncApiOperation, SystemConfig, Tag, TagData, Task, Tax$1 as Tax, TaxRules, TranslateFn, TranslationKey, UploadMediaTarget, User, VariantListingConfig };
+export type { AccountData, AclRole, Address, BasicRuleCondition, CalculatedTaxes, Category$1 as Category, CategoryCustomizableLinkData, CategoryData, CmsPage, Country$1 as Country, CreatedRecord, Currency$2 as Currency, CustomField, CustomFieldData, CustomFieldSet, Customer, CustomerAddress, CustomerGroup, DataServiceOptions, DeliveryTime, FixtureTypes, Flow, FlowConfig, FlowTemplate, Image, LandingPage, Language$2 as Language, Manufacturer, Media$1 as Media, NewsletterRecipient, Options, Order, OrderDelivery, OrderLineItem, OrderStatus, PageObject, PaymentMethod$1 as PaymentMethod, Price, Product, ProductCreationType, ProductCrossSelling, ProductFormData, ProductPrice, ProductReview, Promotion, PromotionDiscount, PromotionWithConditionRuleOptions, PropertyGroup, PropertyGroupOption, RegistrationData, ReplaceTarget, Rule, RuleAssignmentEntity, SalesChannel, SalesChannelAnalytics, SalesChannelDomain, SalesChannelRecord, Salutation, ShippingMethod$1 as ShippingMethod, SimpleLineItem, StateMachine, StateMachineState, SyncApiOperation, SystemConfig, Tag, TagData, Task, Tax$1 as Tax, TaxRules, TranslateFn, TranslationKey, UploadMediaTarget, User, VariantListingConfig };

package/dist/index.mjs

@@ -3982,6 +3982,8 @@ async function loginToAdministration(adminLoginPage, merchant, AdminApiContext)
   return adminLoginPage;
 }
 
+const THEME_SETUP_SAFETY_MARGIN = 15e3;
+const THEME_ASSIGN_MAX_ATTEMPTS = 5;
 const test$b = test$e.extend({
   AdminSession: [
     async ({ IdProvider, AdminApiContext, SalesChannelBaseConfig, browser }, use) => {
@@ -4025,7 +4027,7 @@ const test$b = test$e.extend({
     await page.close();
     setCurrentContext(null);
   },
-  StorefrontPage: async ({ DefaultSalesChannel, SalesChannelBaseConfig, browser, AdminApiContext, StoreApiContext, InstanceMeta, CustomTranslationResources }, use) => {
+  StorefrontPage: async ({ DefaultSalesChannel, SalesChannelBaseConfig, browser, AdminApiContext, StoreApiContext, CustomTranslationResources }, use) => {
     const { url, salesChannel } = DefaultSalesChannel;
     const locale = getLocale();
     const languageHelper = await LanguageHelper.createInstance(locale, CustomTranslationResources);
@@ -4039,14 +4041,27 @@ const test$b = test$e.extend({
     let page;
     if (!await isThemeCompiled(StoreApiContext, DefaultSalesChannel.url)) {
       test$e.slow();
-      await AdminApiContext.post(`./_action/theme/${SalesChannelBaseConfig.defaultThemeId}/assign/${salesChannel.id}`);
+      const deadline = Date.now() + (test$e.info().timeout || 18e4) - THEME_SETUP_SAFETY_MARGIN;
+      const assignUrl = `./_action/theme/${SalesChannelBaseConfig.defaultThemeId}/assign/${salesChannel.id}`;
+      let response = await AdminApiContext.post(assignUrl);
+      for (let attempt = 1; attempt < THEME_ASSIGN_MAX_ATTEMPTS && response.status() >= 500 && Date.now() < deadline; attempt++) {
+        console.warn(
+          `[Warning] Theme assign for sales channel ${salesChannel.id} failed with HTTP ${response.status()} (attempt ${attempt}), retrying: ${(await response.text()).slice(0, 500)}`
+        );
+        await new Promise((resolve) => setTimeout(resolve, 2e3 * attempt));
+        response = await AdminApiContext.post(assignUrl);
+      }
+      if (!response.ok()) {
+        throw new Error(`Theme assign for sales channel ${salesChannel.id} failed with HTTP ${response.status()}: ${(await response.text()).slice(0, 500)}`);
+      }
       await clearDelayedCache(AdminApiContext);
       page = await context.newPage();
-      if (InstanceMeta.isSaaS) {
-        while (!await isThemeCompiled(StoreApiContext, DefaultSalesChannel.url)) {
-          await clearDelayedCache(AdminApiContext);
-          await page.waitForTimeout(4e3);
+      while (!await isThemeCompiled(StoreApiContext, DefaultSalesChannel.url)) {
+        if (Date.now() > deadline) {
+          throw new Error(`Theme for sales channel ${salesChannel.id} is still not compiled within the test timeout (${DefaultSalesChannel.url}).`);
         }
+        await clearDelayedCache(AdminApiContext);
+        await page.waitForTimeout(4e3);
       }
     } else {
       page = await context.newPage();
@@ -4994,6 +5009,38 @@ class TestDataService {
     this.addCreatedRecord("cms_page", layout.id);
     return layout;
   }
+  /**
+   * Creates a landing page category
+   *
+   * @param salesChannelId - The uuid of the sales channel in which the landing page should be active.
+   * @param overrides - Specific data overrides applied to the landing page payload.
+   */
+  async createLandingPage(overrides = {}, salesChannelId = this.defaultSalesChannel.id) {
+    const basicLandingPage = this.getBasicLandingPageStruct(salesChannelId, overrides);
+    const response = await this.AdminApiClient.post("landing-page?_response=detail", {
+      data: basicLandingPage
+    });
+    expect(response.ok()).toBeTruthy();
+    const { data: landingPage } = await response.json();
+    this.addCreatedRecord("landing_page", landingPage.id);
+    return landingPage;
+  }
+  /**
+   * Assigns a CMS landing page layout to a landing page category
+   *
+   * @param landingPageId - The uuid of the landing page category.
+   * @param cmsPageId - The uuid of the CMS landing page layout.
+   */
+  async assignLandingPageLayout(landingPageId, cmsPageId) {
+    const response = await this.AdminApiClient.patch(`landing-page/${landingPageId}?_response=detail`, {
+      data: {
+        cmsPageId
+      }
+    });
+    expect(response.ok()).toBeTruthy();
+    const { data: landingPage } = await response.json();
+    return landingPage;
+  }
   /**
    * Creates a random country
    *
@@ -5928,6 +5975,8 @@ class TestDataService {
         expect(salesChannelResponse.ok()).toBeTruthy();
       }
     }
+    const createdOrderIds = this.createdRecords.filter((record) => record.resource === "order").map((record) => record.payload.id);
+    await this.deleteOrderDocuments(createdOrderIds);
     this.createdRecords.forEach((record) => {
       if (record.resource === "user") {
         if (!deleteUserIds.includes(record.payload.id)) {
@@ -5988,6 +6037,43 @@ class TestDataService {
       data: deleteOperations
     });
   }
+  /**
+   * Deletes all documents of the given orders.
+   * Documents restrict the deletion of their order, so the cleanup calls this before deleting created orders.
+   * Dependent documents (e.g. credit notes, cancellation invoices) are deleted before the documents they reference.
+   *
+   * @param orderIds - The ids of the orders whose documents should be deleted.
+   */
+  async deleteOrderDocuments(orderIds) {
+    if (orderIds.length === 0) {
+      return;
+    }
+    const documentResponse = await this.AdminApiClient.post("search/document", {
+      data: {
+        filter: [{ type: "equalsAny", field: "orderId", value: orderIds }],
+        includes: { document: ["id", "referencedDocumentId"] }
+      }
+    });
+    expect(documentResponse.ok()).toBeTruthy();
+    const { data: documents } = await documentResponse.json();
+    const dependentDocuments = documents.filter((document) => document.referencedDocumentId);
+    const referencedDocuments = documents.filter((document) => !document.referencedDocumentId);
+    for (const batch of [dependentDocuments, referencedDocuments]) {
+      if (batch.length === 0) {
+        continue;
+      }
+      const deleteResponse = await this.AdminApiClient.post("_action/sync", {
+        data: {
+          "delete-document": {
+            entity: "document",
+            action: "delete",
+            payload: batch.map(({ id }) => ({ id }))
+          }
+        }
+      });
+      expect(deleteResponse.ok()).toBeTruthy();
+    }
+  }
   isProduct(item) {
     return item.productNumber !== void 0;
   }
@@ -6707,6 +6793,18 @@ class TestDataService {
     };
     return Object.assign({}, basicCmsPage, overrides);
   }
+  getBasicLandingPageStruct(salesChannelId, overrides = {}) {
+    const landingPageUuid = this.IdProvider.getIdPair().uuid;
+    const landingPageName = `${this.namePrefix}LandingPage-${landingPageUuid}${this.nameSuffix}`;
+    const basicLandingPage = {
+      id: landingPageUuid,
+      name: landingPageName,
+      url: `${this.namePrefix}landing-page-${landingPageUuid}${this.nameSuffix}`,
+      active: true,
+      salesChannels: [{ id: salesChannelId }]
+    };
+    return Object.assign({}, basicLandingPage, overrides);
+  }
   getBasicCustomerGroupStruct(overrides = {}) {
     const customerGroupUuid = this.IdProvider.getIdPair().uuid;
     const customerGroupName = `${this.namePrefix}CustomerGroup-${customerGroupUuid}${this.nameSuffix}`;
@@ -9094,6 +9192,7 @@ class CustomerDetail {
   customFieldCard;
   customFieldSetTabs;
   customFieldSetTabCustomContent;
+  customerGroupRegistrationAlert;
   customerGroupRequestMessage;
   customerGroupAcceptButton;
   customerGroupDeclineButton;
@@ -9118,10 +9217,11 @@ class CustomerDetail {
     }
     this.customFieldSetTabs = this.customFieldCard.locator(".sw-tabs-item");
     this.customFieldSetTabCustomContent = this.customFieldCard.locator(".sw-tabs__custom-content");
+    this.customerGroupRegistrationAlert = page.locator(".sw-customer-detail__customer-registration-alert");
     if (satisfies(instanceMeta.version, "<6.7")) {
-      this.customerGroupRequestMessage = page.locator(".sw-alert__message");
+      this.customerGroupRequestMessage = this.customerGroupRegistrationAlert.locator(".sw-alert__message");
     } else {
-      this.customerGroupRequestMessage = page.locator(".mt-banner__message");
+      this.customerGroupRequestMessage = this.customerGroupRegistrationAlert.locator(".mt-banner__message");
     }
     this.customerGroupAcceptButton = page.getByRole("button", { name: translate("administration:customer:detail.accept") });
     this.customerGroupDeclineButton = page.getByRole("button", { name: translate("administration:customer:detail.decline") });

package/package.json

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