@shopware-ag/acceptance-test-suite 3.8.0 → 3.8.1

package/dist/index.d.mts

@@ -292,6 +292,9 @@ type OrderLineItem = components['schemas']['OrderLineItem'] & {
 type PropertyGroupOption = components['schemas']['PropertyGroupOption'] & {
     id: string;
 };
+type DeliveryTime = components['schemas']['DeliveryTime'] & {
+    id: string;
+};
 
 interface CreatedRecord {
     resource: string;
@@ -489,9 +492,23 @@ declare class TestDataService {
     /**
      * Creates basic variant products based on property group.
      *
+     * @param parentProduct Parent product of the variants
+     * @param propertyGroups Property group collection which contain options
      * @param overrides - Specific data overrides that will be applied to the variant data struct.
      */
     createVariantProducts(parentProduct: Product, propertyGroups: PropertyGroup[], overrides?: Partial<Product>): Promise<Product[]>;
+    /**
+     * Creates a shipping method with one randomly generated image.
+     *
+     * @param overrides - Specific data overrides that will be applied to the shipping method data struct.
+     */
+    createShippingMethodWithImage(overrides?: Partial<ShippingMethod>): Promise<ShippingMethod>;
+    /**
+     * Creates a new basic shipping method with random delivery time.
+     *
+     * @param overrides - Specific data overrides that will be applied to the shipping method data struct.
+     */
+    createBasicShippingMethod(overrides?: Partial<ShippingMethod>): Promise<ShippingMethod>;
     /**
      * Function that generates combinations from n number of arrays
      * with m number of elements in them.
@@ -565,6 +582,17 @@ declare class TestDataService {
      * @param name - The name of the shipping method. Default is "Standard".
      */
     getShippingMethod(name?: string): Promise<ShippingMethod>;
+    /**
+     * Assigns a media resource to a shipping method as a logo.
+     *
+     * @param shippingMethodId - The uuid of the shipping method.
+     * @param mediaId - The uuid of the media resource.
+     */
+    assignShippingMethodMedia(shippingMethodId: string, mediaId: string): Promise<any>;
+    /**
+     * Retrieves all delivery time resources.
+     */
+    getAllDeliveryTimeResources(): Promise<DeliveryTime[]>;
     /**
      * Retrieves a payment method by its name.
      *
@@ -661,6 +689,13 @@ declare class TestDataService {
     } & Partial<Category$1>;
     getBasicCustomerStruct(salesChannelId: string, customerGroupId: string, languageId: string, countryId: string, defaultPaymentMethodId: string, salutationId: string, overrides?: Partial<Customer>): Partial<Customer>;
     getBasicOrderDeliveryStruct(deliveryState: StateMachineState, shippingMethod: ShippingMethod, customerAddress: CustomerAddress): Partial<OrderDelivery>;
+    getBasicShippingMethodStruct(deliveryTimeId: string, overrides?: Partial<ShippingMethod>): {
+        id: string;
+        name: string;
+        technicalName: string;
+        deliveryTimeId: string;
+        active: boolean;
+    } & Partial<ShippingMethod>;
     isProduct(item: Product | Promotion): item is Product;
     isPromotion(item: Product | Promotion): item is Promotion;
     getBasicOrderStruct(lineItems: SimpleLineItem[], languageId: string, currency: Currency$1, paymentMethod: PaymentMethod, shippingMethod: ShippingMethod, orderState: StateMachineState, deliveryState: StateMachineState, transactionState: StateMachineState, customer: Customer, customerAddress: CustomerAddress, salesChannelId?: string, overrides?: Partial<Order>): Partial<Order>;
@@ -1333,4 +1368,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 OrderLineItem, type OrderStatus, type PageObject, type PaymentMethod, type Price, type Product, type ProductPrice, type Promotion, type PromotionDiscount, type PropertyGroup, type PropertyGroupOption, 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 DeliveryTime, type FixtureTypes, type Manufacturer, type Media, type Order, type OrderDelivery, type OrderLineItem, type OrderStatus, type PageObject, type PaymentMethod, type Price, type Product, type ProductPrice, type Promotion, type PromotionDiscount, type PropertyGroup, type PropertyGroupOption, 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

@@ -292,6 +292,9 @@ type OrderLineItem = components['schemas']['OrderLineItem'] & {
 type PropertyGroupOption = components['schemas']['PropertyGroupOption'] & {
     id: string;
 };
+type DeliveryTime = components['schemas']['DeliveryTime'] & {
+    id: string;
+};
 
 interface CreatedRecord {
     resource: string;
@@ -489,9 +492,23 @@ declare class TestDataService {
     /**
      * Creates basic variant products based on property group.
      *
+     * @param parentProduct Parent product of the variants
+     * @param propertyGroups Property group collection which contain options
      * @param overrides - Specific data overrides that will be applied to the variant data struct.
      */
     createVariantProducts(parentProduct: Product, propertyGroups: PropertyGroup[], overrides?: Partial<Product>): Promise<Product[]>;
+    /**
+     * Creates a shipping method with one randomly generated image.
+     *
+     * @param overrides - Specific data overrides that will be applied to the shipping method data struct.
+     */
+    createShippingMethodWithImage(overrides?: Partial<ShippingMethod>): Promise<ShippingMethod>;
+    /**
+     * Creates a new basic shipping method with random delivery time.
+     *
+     * @param overrides - Specific data overrides that will be applied to the shipping method data struct.
+     */
+    createBasicShippingMethod(overrides?: Partial<ShippingMethod>): Promise<ShippingMethod>;
     /**
      * Function that generates combinations from n number of arrays
      * with m number of elements in them.
@@ -565,6 +582,17 @@ declare class TestDataService {
      * @param name - The name of the shipping method. Default is "Standard".
      */
     getShippingMethod(name?: string): Promise<ShippingMethod>;
+    /**
+     * Assigns a media resource to a shipping method as a logo.
+     *
+     * @param shippingMethodId - The uuid of the shipping method.
+     * @param mediaId - The uuid of the media resource.
+     */
+    assignShippingMethodMedia(shippingMethodId: string, mediaId: string): Promise<any>;
+    /**
+     * Retrieves all delivery time resources.
+     */
+    getAllDeliveryTimeResources(): Promise<DeliveryTime[]>;
     /**
      * Retrieves a payment method by its name.
      *
@@ -661,6 +689,13 @@ declare class TestDataService {
     } & Partial<Category$1>;
     getBasicCustomerStruct(salesChannelId: string, customerGroupId: string, languageId: string, countryId: string, defaultPaymentMethodId: string, salutationId: string, overrides?: Partial<Customer>): Partial<Customer>;
     getBasicOrderDeliveryStruct(deliveryState: StateMachineState, shippingMethod: ShippingMethod, customerAddress: CustomerAddress): Partial<OrderDelivery>;
+    getBasicShippingMethodStruct(deliveryTimeId: string, overrides?: Partial<ShippingMethod>): {
+        id: string;
+        name: string;
+        technicalName: string;
+        deliveryTimeId: string;
+        active: boolean;
+    } & Partial<ShippingMethod>;
     isProduct(item: Product | Promotion): item is Product;
     isPromotion(item: Product | Promotion): item is Promotion;
     getBasicOrderStruct(lineItems: SimpleLineItem[], languageId: string, currency: Currency$1, paymentMethod: PaymentMethod, shippingMethod: ShippingMethod, orderState: StateMachineState, deliveryState: StateMachineState, transactionState: StateMachineState, customer: Customer, customerAddress: CustomerAddress, salesChannelId?: string, overrides?: Partial<Order>): Partial<Order>;
@@ -1333,4 +1368,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 OrderLineItem, type OrderStatus, type PageObject, type PaymentMethod, type Price, type Product, type ProductPrice, type Promotion, type PromotionDiscount, type PropertyGroup, type PropertyGroupOption, 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 DeliveryTime, type FixtureTypes, type Manufacturer, type Media, type Order, type OrderDelivery, type OrderLineItem, type OrderStatus, type PageObject, type PaymentMethod, type Price, type Product, type ProductPrice, type Promotion, type PromotionDiscount, type PropertyGroup, type PropertyGroupOption, 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

@@ -1340,6 +1340,8 @@ class TestDataService {
   /**
    * Creates basic variant products based on property group.
    *
+   * @param parentProduct Parent product of the variants
+   * @param propertyGroups Property group collection which contain options
    * @param overrides - Specific data overrides that will be applied to the variant data struct.
    */
   async createVariantProducts(parentProduct, propertyGroups, overrides = {}) {
@@ -1367,6 +1369,35 @@ class TestDataService {
     }
     return variantProducts;
   }
+  /**
+   * Creates a shipping method with one randomly generated image.
+   *
+   * @param overrides - Specific data overrides that will be applied to the shipping method data struct.
+   */
+  async createShippingMethodWithImage(overrides = {}) {
+    const shippingMethod = await this.createBasicShippingMethod(overrides);
+    const media = await this.createMediaPNG();
+    await this.assignShippingMethodMedia(shippingMethod.id, media.id);
+    return shippingMethod;
+  }
+  /**
+   * Creates a new basic shipping method with random delivery time.
+   *
+   * @param overrides - Specific data overrides that will be applied to the shipping method data struct.
+   */
+  async createBasicShippingMethod(overrides = {}) {
+    const deliveryTime = await this.getAllDeliveryTimeResources();
+    const basicShippingMethod = this.getBasicShippingMethodStruct(
+      deliveryTime[0].id,
+      overrides
+    );
+    const shippingMethodResponse = await this.AdminApiClient.post("shipping-method?_response=detail", {
+      data: basicShippingMethod
+    });
+    const { data: shippingMethod } = await shippingMethodResponse.json();
+    this.addCreatedRecord("shipping_method", shippingMethod.id);
+    return shippingMethod;
+  }
   /**
    * Assigns a media resource to a payment method as a logo.
    *
@@ -1537,6 +1568,29 @@ class TestDataService {
     const { data: result } = await response.json();
     return result[0];
   }
+  /**
+   * Assigns a media resource to a shipping method as a logo.
+   *
+   * @param shippingMethodId - The uuid of the shipping method.
+   * @param mediaId - The uuid of the media resource.
+   */
+  async assignShippingMethodMedia(shippingMethodId, mediaId) {
+    const shippingMethodResponse = await this.AdminApiClient.patch(`shipping-method/${shippingMethodId}?_response=basic`, {
+      data: {
+        mediaId
+      }
+    });
+    const { data: shippingMethodMedia } = await shippingMethodResponse.json();
+    return shippingMethodMedia;
+  }
+  /**
+   * Retrieves all delivery time resources.
+   */
+  async getAllDeliveryTimeResources() {
+    const response = await this.AdminApiClient.get("delivery-time");
+    const { data: deliveryTimeResources } = await response.json();
+    return deliveryTimeResources;
+  }
   /**
    * Retrieves a payment method by its name.
    *
@@ -1983,6 +2037,18 @@ class TestDataService {
       }
     };
   }
+  getBasicShippingMethodStruct(deliveryTimeId, overrides = {}) {
+    const { id: shippingMethodId, uuid: shippingMethodUuid } = this.IdProvider.getIdPair();
+    const shippingMethodName = `${this.namePrefix}ShippingMethod-${shippingMethodId}${this.nameSuffix}`;
+    const basicShippingMethod = {
+      id: shippingMethodUuid,
+      name: shippingMethodName,
+      technicalName: shippingMethodName.toLowerCase(),
+      deliveryTimeId,
+      active: true
+    };
+    return Object.assign({}, basicShippingMethod, overrides);
+  }
   isProduct(item) {
     return item.productNumber !== void 0;
   }

package/package.json

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