@shopware-ag/acceptance-test-suite 3.0.0 → 3.2.0

package/dist/index.d.mts

@@ -285,6 +285,9 @@ type Promotion = Omit<components['schemas']['Promotion'], 'discounts'> & {
 type PromotionDiscount = components['schemas']['PromotionDiscount'] & {
     id: string;
 };
+type OrderLineItem = components['schemas']['OrderLineItem'] & {
+    id: string;
+};
 
 interface CreatedRecord {
     resource: string;
@@ -294,6 +297,7 @@ interface SimpleLineItem {
     product: Product | Promotion;
     quantity?: number;
     position?: number;
+    overrides?: Partial<OrderLineItem>;
 }
 interface SyncApiOperation {
     entity: string;
@@ -460,6 +464,25 @@ declare class TestDataService {
      * @param salesChannelId - The uuid of the sales channel in which the promotion should be active.
      */
     createPromotionWithCode(overrides?: Partial<Promotion>, salesChannelId?: string): Promise<Promotion>;
+    /**
+     * Creates a new basic payment method.
+     *
+     * @param overrides - Specific data overrides that will be applied to the payment method data struct.
+     */
+    createBasicPaymentMethod(overrides?: Partial<PaymentMethod>): Promise<PaymentMethod>;
+    /**
+     * Creates a payment method with one randomly generated image.
+     *
+     * @param overrides - Specific data overrides that will be applied to the payment method data struct.
+     */
+    createPaymentMethodWithImage(overrides?: Partial<PaymentMethod>): Promise<PaymentMethod>;
+    /**
+     * Assigns a media resource to a payment method as a logo.
+     *
+     * @param paymentMethodId - The uuid of the payment method.
+     * @param mediaId - The uuid of the media resource.
+     */
+    assignPaymentMethodMedia(paymentMethodId: string, mediaId: string): Promise<any>;
     /**
      * Assigns a media resource as the download of a digital product.
      *
@@ -591,6 +614,12 @@ declare class TestDataService {
     getBasicProductStruct(taxId?: string, currencyId?: string, overrides?: Partial<Product>): Partial<Product>;
     getProductPriceRangeStruct(currencyId: string, ruleId: string): Partial<Product>;
     getBasicManufacturerStruct(overrides?: Partial<Manufacturer>): Partial<Manufacturer>;
+    getBasicPaymentMethodStruct(overrides?: Partial<PaymentMethod>): {
+        id: string;
+        name: string;
+        technicalName: string;
+        active: boolean;
+    } & Partial<PaymentMethod>;
     getBasicCategoryStruct(overrides?: Partial<Category$1>, parentId?: string): {
         id: string;
         name: string;
@@ -643,8 +672,10 @@ declare class TestDataService {
             isCalculated: boolean;
             referencePriceDefinition: null;
         };
-    };
+    } & Partial<OrderLineItem>;
     getBasicPromotionLineItemStruct(lineItem: SimpleLineItem): {
+        promotionId: string;
+        referencedId: string | undefined;
         payload: {
             code: string | undefined;
         };
@@ -673,7 +704,7 @@ declare class TestDataService {
             price: number;
             percentage: number | null;
         };
-    };
+    } & Partial<OrderLineItem>;
     getBasicPromotionStruct(salesChannelId?: string, overrides?: Partial<Promotion>): Partial<Promotion>;
 }
 
@@ -1247,4 +1278,4 @@ declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArg
     ValidateAccessibility: (pageName: string, assertViolations?: number | boolean | undefined, createReport?: boolean | undefined, ruleTags?: string[] | undefined, outputDir?: string | undefined) => () => Promise<axe_core.Result[]>;
 }, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & FixtureTypes>;
 
-export { AdminPageObjects, type CalculatedTaxes, type Category$1 as Category, type CreatedRecord, type Currency$1 as Currency, type Customer, type CustomerAddress, type DataServiceOptions, type FixtureTypes, type Manufacturer, type Media, type Order, type OrderDelivery, type PageObject, type PaymentMethod, type Price, type Product, type ProductPrice, type Promotion, type PromotionDiscount, type PropertyGroup, type Rule, type SalesChannel, type Salutation, type ShippingMethod, type SimpleLineItem, type StateMachine, type StateMachineState, StorefrontPageObjects, type SyncApiOperation, type Tag, type Task, type TaxRules, TestDataService, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlowId, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getPromotionWithDiscount, getSalutationId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, isSaaSInstance, isThemeCompiled, setOrderStatus, test };
+export { AdminPageObjects, type CalculatedTaxes, type Category$1 as Category, type CreatedRecord, type Currency$1 as Currency, type Customer, type CustomerAddress, type DataServiceOptions, type FixtureTypes, type Manufacturer, type Media, type Order, type OrderDelivery, type OrderLineItem, type PageObject, type PaymentMethod, type Price, type Product, type ProductPrice, type Promotion, type PromotionDiscount, type PropertyGroup, type Rule, type SalesChannel, type Salutation, type ShippingMethod, type SimpleLineItem, type StateMachine, type StateMachineState, StorefrontPageObjects, type SyncApiOperation, type Tag, type Task, type TaxRules, TestDataService, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlowId, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getPromotionWithDiscount, getSalutationId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, isSaaSInstance, isThemeCompiled, setOrderStatus, test };

package/dist/index.d.ts

@@ -285,6 +285,9 @@ type Promotion = Omit<components['schemas']['Promotion'], 'discounts'> & {
 type PromotionDiscount = components['schemas']['PromotionDiscount'] & {
     id: string;
 };
+type OrderLineItem = components['schemas']['OrderLineItem'] & {
+    id: string;
+};
 
 interface CreatedRecord {
     resource: string;
@@ -294,6 +297,7 @@ interface SimpleLineItem {
     product: Product | Promotion;
     quantity?: number;
     position?: number;
+    overrides?: Partial<OrderLineItem>;
 }
 interface SyncApiOperation {
     entity: string;
@@ -460,6 +464,25 @@ declare class TestDataService {
      * @param salesChannelId - The uuid of the sales channel in which the promotion should be active.
      */
     createPromotionWithCode(overrides?: Partial<Promotion>, salesChannelId?: string): Promise<Promotion>;
+    /**
+     * Creates a new basic payment method.
+     *
+     * @param overrides - Specific data overrides that will be applied to the payment method data struct.
+     */
+    createBasicPaymentMethod(overrides?: Partial<PaymentMethod>): Promise<PaymentMethod>;
+    /**
+     * Creates a payment method with one randomly generated image.
+     *
+     * @param overrides - Specific data overrides that will be applied to the payment method data struct.
+     */
+    createPaymentMethodWithImage(overrides?: Partial<PaymentMethod>): Promise<PaymentMethod>;
+    /**
+     * Assigns a media resource to a payment method as a logo.
+     *
+     * @param paymentMethodId - The uuid of the payment method.
+     * @param mediaId - The uuid of the media resource.
+     */
+    assignPaymentMethodMedia(paymentMethodId: string, mediaId: string): Promise<any>;
     /**
      * Assigns a media resource as the download of a digital product.
      *
@@ -591,6 +614,12 @@ declare class TestDataService {
     getBasicProductStruct(taxId?: string, currencyId?: string, overrides?: Partial<Product>): Partial<Product>;
     getProductPriceRangeStruct(currencyId: string, ruleId: string): Partial<Product>;
     getBasicManufacturerStruct(overrides?: Partial<Manufacturer>): Partial<Manufacturer>;
+    getBasicPaymentMethodStruct(overrides?: Partial<PaymentMethod>): {
+        id: string;
+        name: string;
+        technicalName: string;
+        active: boolean;
+    } & Partial<PaymentMethod>;
     getBasicCategoryStruct(overrides?: Partial<Category$1>, parentId?: string): {
         id: string;
         name: string;
@@ -643,8 +672,10 @@ declare class TestDataService {
             isCalculated: boolean;
             referencePriceDefinition: null;
         };
-    };
+    } & Partial<OrderLineItem>;
     getBasicPromotionLineItemStruct(lineItem: SimpleLineItem): {
+        promotionId: string;
+        referencedId: string | undefined;
         payload: {
             code: string | undefined;
         };
@@ -673,7 +704,7 @@ declare class TestDataService {
             price: number;
             percentage: number | null;
         };
-    };
+    } & Partial<OrderLineItem>;
     getBasicPromotionStruct(salesChannelId?: string, overrides?: Partial<Promotion>): Partial<Promotion>;
 }
 
@@ -1247,4 +1278,4 @@ declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArg
     ValidateAccessibility: (pageName: string, assertViolations?: number | boolean | undefined, createReport?: boolean | undefined, ruleTags?: string[] | undefined, outputDir?: string | undefined) => () => Promise<axe_core.Result[]>;
 }, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & FixtureTypes>;
 
-export { AdminPageObjects, type CalculatedTaxes, type Category$1 as Category, type CreatedRecord, type Currency$1 as Currency, type Customer, type CustomerAddress, type DataServiceOptions, type FixtureTypes, type Manufacturer, type Media, type Order, type OrderDelivery, type PageObject, type PaymentMethod, type Price, type Product, type ProductPrice, type Promotion, type PromotionDiscount, type PropertyGroup, type Rule, type SalesChannel, type Salutation, type ShippingMethod, type SimpleLineItem, type StateMachine, type StateMachineState, StorefrontPageObjects, type SyncApiOperation, type Tag, type Task, type TaxRules, TestDataService, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlowId, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getPromotionWithDiscount, getSalutationId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, isSaaSInstance, isThemeCompiled, setOrderStatus, test };
+export { AdminPageObjects, type CalculatedTaxes, type Category$1 as Category, type CreatedRecord, type Currency$1 as Currency, type Customer, type CustomerAddress, type DataServiceOptions, type FixtureTypes, type Manufacturer, type Media, type Order, type OrderDelivery, type OrderLineItem, type PageObject, type PaymentMethod, type Price, type Product, type ProductPrice, type Promotion, type PromotionDiscount, type PropertyGroup, type Rule, type SalesChannel, type Salutation, type ShippingMethod, type SimpleLineItem, type StateMachine, type StateMachineState, StorefrontPageObjects, type SyncApiOperation, type Tag, type Task, type TaxRules, TestDataService, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlowId, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getPromotionWithDiscount, getSalutationId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, isSaaSInstance, isThemeCompiled, setOrderStatus, test };

package/dist/index.mjs

@@ -1039,7 +1039,7 @@ class TestDataService {
       data: basicManufacturer
     });
     const { data: manufacturer } = await manufacturerResponse.json();
-    this.addCreatedRecord("product-manufacturer", manufacturer.id);
+    this.addCreatedRecord("product_manufacturer", manufacturer.id);
     return manufacturer;
   }
   /**
@@ -1210,7 +1210,13 @@ class TestDataService {
     const response = await this.AdminApiClient.post("customer?_response=detail", {
       data: basicCustomerStruct
     });
-    const { data: customer } = await response.json();
+    const customerData = await response.json();
+    let customer;
+    if (typeof basicCustomerStruct.password !== "string") {
+      customer = { ...customerData.data };
+    } else {
+      customer = { ...customerData.data, password: basicCustomerStruct.password };
+    }
     this.addCreatedRecord("customer", customer.id);
     return customer;
   }
@@ -1271,6 +1277,46 @@ class TestDataService {
     this.addCreatedRecord("promotion", promotion.id);
     return promotionWithDiscount;
   }
+  /**
+   * Creates a new basic payment method.
+   *
+   * @param overrides - Specific data overrides that will be applied to the payment method data struct.
+   */
+  async createBasicPaymentMethod(overrides = {}) {
+    const basicPaymentMethod = this.getBasicPaymentMethodStruct(overrides);
+    const paymentMethodResponse = await this.AdminApiClient.post("payment-method?_response=detail", {
+      data: basicPaymentMethod
+    });
+    const { data: paymentMethod } = await paymentMethodResponse.json();
+    this.addCreatedRecord("payment_method", paymentMethod.id);
+    return paymentMethod;
+  }
+  /**
+   * Creates a payment method with one randomly generated image.
+   *
+   * @param overrides - Specific data overrides that will be applied to the payment method data struct.
+   */
+  async createPaymentMethodWithImage(overrides = {}) {
+    const paymentMethod = await this.createBasicPaymentMethod(overrides);
+    const media = await this.createMediaPNG();
+    await this.assignPaymentMethodMedia(paymentMethod.id, media.id);
+    return paymentMethod;
+  }
+  /**
+   * Assigns a media resource to a payment method as a logo.
+   *
+   * @param paymentMethodId - The uuid of the payment method.
+   * @param mediaId - The uuid of the media resource.
+   */
+  async assignPaymentMethodMedia(paymentMethodId, mediaId) {
+    const paymentMethodResponse = await this.AdminApiClient.patch(`payment-method/${paymentMethodId}?_response=basic`, {
+      data: {
+        mediaId
+      }
+    });
+    const { data: paymentMethodMedia } = await paymentMethodResponse.json();
+    return paymentMethodMedia;
+  }
   /**
    * Assigns a media resource as the download of a digital product.
    *
@@ -1708,6 +1754,17 @@ class TestDataService {
     };
     return Object.assign({}, basicManufacturer, overrides);
   }
+  getBasicPaymentMethodStruct(overrides = {}) {
+    const { id: paymentMethodId, uuid: paymentMethodUuid } = this.IdProvider.getIdPair();
+    const paymentMethodName = `${this.namePrefix}PaymentMethod-${paymentMethodId}${this.nameSuffix}`;
+    const basicPaymentMethod = {
+      id: paymentMethodUuid,
+      name: paymentMethodName,
+      technicalName: paymentMethodName.toLowerCase(),
+      active: true
+    };
+    return Object.assign({}, basicPaymentMethod, overrides);
+  }
   getBasicCategoryStruct(overrides = {}, parentId = this.defaultCategoryId) {
     const { id: categoryId, uuid: categoryUuid } = this.IdProvider.getIdPair();
     const categoryName = `${this.namePrefix}Category-${categoryId}${this.nameSuffix}`;
@@ -1834,10 +1891,7 @@ class TestDataService {
       }
     });
     const orderDelivery = this.getBasicOrderDeliveryStruct(deliveryState, shippingMethod, customerAddress);
-    let shippingCosts = 0;
-    if (orderDelivery.shippingCosts != null) {
-      shippingCosts = orderDelivery.shippingCosts.totalPrice;
-    }
+    const shippingCosts = orderDelivery.shippingCosts?.totalPrice ?? 0;
     totalPrice += shippingCosts;
     const basicOrder = {
       orderNumber: this.IdProvider.getIdPair().id,
@@ -1931,7 +1985,7 @@ class TestDataService {
     const product = lineItem.product;
     const unitPrice = product.price[0].gross || 10;
     const totalPrice = unitPrice * (lineItem.quantity || 1);
-    return {
+    const basicProductLineItemStruct = {
       productId: product.id,
       referencedId: product.id,
       payload: {
@@ -1969,6 +2023,7 @@ class TestDataService {
         referencePriceDefinition: null
       }
     };
+    return Object.assign({}, basicProductLineItemStruct, lineItem.overrides);
   }
   getBasicPromotionLineItemStruct(lineItem) {
     if (!this.isPromotion(lineItem.product)) {
@@ -1980,7 +2035,9 @@ class TestDataService {
     const promotionDiscountId = promotion.discounts[0].id;
     const unitPrice = -Math.abs(promotionDiscountValue || 10);
     const totalPrice = unitPrice * (lineItem.quantity || 1);
-    return {
+    const basicPromotionLineItemStruct = {
+      promotionId: promotion.id,
+      referencedId: promotion.code,
       payload: {
         code: promotion.code
       },
@@ -2010,6 +2067,7 @@ class TestDataService {
         percentage: promotionDiscountType === "percentage" ? promotionDiscountValue : null
       }
     };
+    return Object.assign({}, basicPromotionLineItemStruct, lineItem.overrides);
   }
   getBasicPromotionStruct(salesChannelId = this.defaultSalesChannel.id, overrides = {}) {
     const promotionCode = `${this.IdProvider.getIdPair().id}`;
@@ -3590,9 +3648,9 @@ const test$3 = mergeTests(
 
 const Login = test$e.extend({
   Login: async ({ ShopCustomer, DefaultSalesChannel, StorefrontAccountLogin, StorefrontAccount }, use) => {
-    const task = () => {
+    const task = (customCustomer) => {
       return async function Login2() {
-        const { customer } = DefaultSalesChannel;
+        const customer = customCustomer ? customCustomer : DefaultSalesChannel.customer;
         await ShopCustomer.goesTo(StorefrontAccountLogin.url());
         await StorefrontAccountLogin.emailInput.fill(customer.email);
         await StorefrontAccountLogin.passwordInput.fill(customer.password);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopware-ag/acceptance-test-suite",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "Shopware Acceptance Test Suite",
   "author": "shopware AG",
   "license": "MIT",