@shopware-ag/acceptance-test-suite 8.1.0 → 8.2.0

package/dist/index.d.mts

@@ -330,6 +330,9 @@ type CmsPage = components['schemas']['CmsPage'] & {
 type CustomerGroup = components['schemas']['CustomerGroup'] & {
     id: string;
 };
+type SalesChannelAnalytics = components['schemas']['SalesChannelAnalytics'] & {
+    id: string;
+};
 interface RegistrationData {
     salutation: string;
     firstName: string;
@@ -345,6 +348,10 @@ interface RegistrationData {
     vatRegNo: string;
 }
 
+interface SalesChannelRecord {
+    salesChannelId: string;
+    field: string;
+}
 interface CreatedRecord {
     resource: string;
     payload: Record<string, string>;
@@ -403,6 +410,12 @@ declare class TestDataService {
      * @private
      */
     private createdRecords;
+    /**
+     * A registry of all created sales channel records.
+     *
+     * @private
+     */
+    private createdSalesChannelRecords;
     constructor(AdminApiClient: AdminApiContext, IdProvider: IdProvider, options: DataServiceOptions);
     /**
      * Creates a basic product without images or other special configuration.
@@ -592,6 +605,12 @@ declare class TestDataService {
      * @param salesChannelId - Unique identity of sales channel.
      */
     createSystemConfigEntry(configurationKey: string, configurationValue?: {}, salesChannelId?: string): Promise<SystemConfig>;
+    /**
+     * Creates a random sales channel analytics entity
+     *
+     * @param overrides - Specific data overrides that will be applied to the sales channel analytics data struct.
+     */
+    createSalesChannelAnalytics(overrides?: Partial<SalesChannelAnalytics>): Promise<SalesChannelAnalytics>;
     /**
      * Assigns a media resource as the download of a digital product.
      *
@@ -658,6 +677,13 @@ declare class TestDataService {
      * @param currencyId - The uuid of the currency.
      */
     assignSalesChannelCurrency(salesChannelId: string, currencyId: string): Promise<any>;
+    /**
+     * Assigns a sales channel analytics entity to a sales channel.
+     *
+     * @param salesChannelId - The uuid of the sales channel.
+     * @param salesChannelAnalyticsId - The uuid of the sales channel analytics entity.
+     */
+    assignSalesChannelAnalytics(salesChannelId: string, salesChannelAnalyticsId: string): Promise<SalesChannel>;
     /**
      * Assigns a country to a sales channel.
      *
@@ -758,6 +784,14 @@ declare class TestDataService {
      * @param payload - You can pass a payload object for the delete operation or simply pass the uuid of the entity.
      */
     addCreatedRecord(resource: string, payload: string | Record<string, string>): void;
+    /**
+     * Adds a sales channel related property to the registry of created sales channel records.
+     * The property added to the registry will be overridden with null value by the cleanup call.
+     *
+     * @param salesChannelId - The sales channel id where the property pair is located
+     * @param field - The database field which has to be overridden
+     */
+    addCreatedSalesChannelRecord(salesChannelId: string, field: string): void;
     /**
      * Set the configuration of automated data clean up.
      * If set to "true" the data service will delete all entities created by it.
@@ -894,6 +928,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>;
+    getSalesChannelAnalyticsStruct(overrides?: Partial<SalesChannelAnalytics>): Partial<SalesChannelAnalytics>;
     clearCaches(): Promise<void>;
 }
 
@@ -2009,4 +2044,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 CmsPage, type Country, type CreatedRecord, type Currency$1 as Currency, type Customer, type CustomerAddress, type CustomerGroup, 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 RegistrationData, type Rule, type SalesChannel, type Salutation, type ShippingMethod, type SimpleLineItem, type StateMachine, type StateMachineState, StorefrontPageObjects, type SyncApiOperation, type SystemConfig, 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 CmsPage, type Country, type CreatedRecord, type Currency$1 as Currency, type Customer, type CustomerAddress, type CustomerGroup, 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 RegistrationData, type Rule, type SalesChannel, type SalesChannelAnalytics, type SalesChannelRecord, type Salutation, type ShippingMethod, type SimpleLineItem, type StateMachine, type StateMachineState, StorefrontPageObjects, type SyncApiOperation, type SystemConfig, 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

@@ -330,6 +330,9 @@ type CmsPage = components['schemas']['CmsPage'] & {
 type CustomerGroup = components['schemas']['CustomerGroup'] & {
     id: string;
 };
+type SalesChannelAnalytics = components['schemas']['SalesChannelAnalytics'] & {
+    id: string;
+};
 interface RegistrationData {
     salutation: string;
     firstName: string;
@@ -345,6 +348,10 @@ interface RegistrationData {
     vatRegNo: string;
 }
 
+interface SalesChannelRecord {
+    salesChannelId: string;
+    field: string;
+}
 interface CreatedRecord {
     resource: string;
     payload: Record<string, string>;
@@ -403,6 +410,12 @@ declare class TestDataService {
      * @private
      */
     private createdRecords;
+    /**
+     * A registry of all created sales channel records.
+     *
+     * @private
+     */
+    private createdSalesChannelRecords;
     constructor(AdminApiClient: AdminApiContext, IdProvider: IdProvider, options: DataServiceOptions);
     /**
      * Creates a basic product without images or other special configuration.
@@ -592,6 +605,12 @@ declare class TestDataService {
      * @param salesChannelId - Unique identity of sales channel.
      */
     createSystemConfigEntry(configurationKey: string, configurationValue?: {}, salesChannelId?: string): Promise<SystemConfig>;
+    /**
+     * Creates a random sales channel analytics entity
+     *
+     * @param overrides - Specific data overrides that will be applied to the sales channel analytics data struct.
+     */
+    createSalesChannelAnalytics(overrides?: Partial<SalesChannelAnalytics>): Promise<SalesChannelAnalytics>;
     /**
      * Assigns a media resource as the download of a digital product.
      *
@@ -658,6 +677,13 @@ declare class TestDataService {
      * @param currencyId - The uuid of the currency.
      */
     assignSalesChannelCurrency(salesChannelId: string, currencyId: string): Promise<any>;
+    /**
+     * Assigns a sales channel analytics entity to a sales channel.
+     *
+     * @param salesChannelId - The uuid of the sales channel.
+     * @param salesChannelAnalyticsId - The uuid of the sales channel analytics entity.
+     */
+    assignSalesChannelAnalytics(salesChannelId: string, salesChannelAnalyticsId: string): Promise<SalesChannel>;
     /**
      * Assigns a country to a sales channel.
      *
@@ -758,6 +784,14 @@ declare class TestDataService {
      * @param payload - You can pass a payload object for the delete operation or simply pass the uuid of the entity.
      */
     addCreatedRecord(resource: string, payload: string | Record<string, string>): void;
+    /**
+     * Adds a sales channel related property to the registry of created sales channel records.
+     * The property added to the registry will be overridden with null value by the cleanup call.
+     *
+     * @param salesChannelId - The sales channel id where the property pair is located
+     * @param field - The database field which has to be overridden
+     */
+    addCreatedSalesChannelRecord(salesChannelId: string, field: string): void;
     /**
      * Set the configuration of automated data clean up.
      * If set to "true" the data service will delete all entities created by it.
@@ -894,6 +928,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>;
+    getSalesChannelAnalyticsStruct(overrides?: Partial<SalesChannelAnalytics>): Partial<SalesChannelAnalytics>;
     clearCaches(): Promise<void>;
 }
 
@@ -2009,4 +2044,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 CmsPage, type Country, type CreatedRecord, type Currency$1 as Currency, type Customer, type CustomerAddress, type CustomerGroup, 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 RegistrationData, type Rule, type SalesChannel, type Salutation, type ShippingMethod, type SimpleLineItem, type StateMachine, type StateMachineState, StorefrontPageObjects, type SyncApiOperation, type SystemConfig, 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 CmsPage, type Country, type CreatedRecord, type Currency$1 as Currency, type Customer, type CustomerAddress, type CustomerGroup, 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 RegistrationData, type Rule, type SalesChannel, type SalesChannelAnalytics, type SalesChannelRecord, type Salutation, type ShippingMethod, type SimpleLineItem, type StateMachine, type StateMachineState, StorefrontPageObjects, type SyncApiOperation, type SystemConfig, 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

@@ -966,13 +966,19 @@ class TestDataService {
      *
      * @private
      */
-    __publicField$L(this, "highPriorityEntities", ["order", "product", "landing_page"]);
+    __publicField$L(this, "highPriorityEntities", ["order", "product", "landing_page", "sales_channel_currency", "sales_channel_country"]);
     /**
      * A registry of all created records.
      *
      * @private
      */
     __publicField$L(this, "createdRecords", []);
+    /**
+     * A registry of all created sales channel records.
+     *
+     * @private
+     */
+    __publicField$L(this, "createdSalesChannelRecords", []);
     /**
      * Function that generates combinations from n number of arrays
      * with m number of elements in them.
@@ -1542,6 +1548,21 @@ class TestDataService {
     await this.clearCaches();
     return systemConfigEntry;
   }
+  /**
+   * Creates a random sales channel analytics entity
+   *
+   * @param overrides - Specific data overrides that will be applied to the sales channel analytics data struct.
+   */
+  async createSalesChannelAnalytics(overrides = {}) {
+    const basicSalesChannelAnalyticsStruct = this.getSalesChannelAnalyticsStruct(overrides);
+    const response = await this.AdminApiClient.post("sales-channel-analytics?_response=detail", {
+      data: basicSalesChannelAnalyticsStruct
+    });
+    expect(response.ok()).toBeTruthy();
+    const { data: salesChannelAnalytics } = await response.json();
+    this.addCreatedRecord("sales_channel_analytics", salesChannelAnalytics.id);
+    return salesChannelAnalytics;
+  }
   /**
    * Assigns a media resource as the download of a digital product.
    *
@@ -1700,13 +1721,39 @@ class TestDataService {
   async assignSalesChannelCurrency(salesChannelId, currencyId) {
     const syncSalesChannelResponse = await this.AdminApiClient.post("./_action/sync", {
       data: {
-        "write-sales-channel": {
-          entity: "sales_channel",
+        "write-sales-channel-currency": {
+          entity: "sales_channel_currency",
+          action: "upsert",
+          payload: [
+            {
+              salesChannelId,
+              currencyId
+            }
+          ]
+        }
+      }
+    });
+    expect(syncSalesChannelResponse.ok()).toBeTruthy();
+    const { data: salesChannel } = await syncSalesChannelResponse.json();
+    this.addCreatedRecord("sales_channel_currency", { salesChannelId, currencyId });
+    return salesChannel;
+  }
+  /**
+   * Assigns a sales channel analytics entity to a sales channel.
+   *
+   * @param salesChannelId - The uuid of the sales channel.
+   * @param salesChannelAnalyticsId - The uuid of the sales channel analytics entity.
+   */
+  async assignSalesChannelAnalytics(salesChannelId, salesChannelAnalyticsId) {
+    const syncSalesChannelResponse = await this.AdminApiClient.post("./_action/sync", {
+      data: {
+        "write-sales-channel-analytics": {
+          entity: "sales_channel_analytics",
           action: "upsert",
           payload: [
             {
-              id: salesChannelId,
-              currencies: [{ id: currencyId }]
+              salesChannel: { id: salesChannelId },
+              id: salesChannelAnalyticsId
             }
           ]
         }
@@ -1714,6 +1761,7 @@ class TestDataService {
     });
     expect(syncSalesChannelResponse.ok()).toBeTruthy();
     const { data: salesChannel } = await syncSalesChannelResponse.json();
+    this.addCreatedSalesChannelRecord(salesChannelId, "analyticsId");
     return salesChannel;
   }
   /**
@@ -1725,13 +1773,13 @@ class TestDataService {
   async assignSalesChannelCountry(salesChannelId, countryId) {
     const syncSalesChannelResponse = await this.AdminApiClient.post("./_action/sync", {
       data: {
-        "write-sales-channel": {
-          entity: "sales_channel",
+        "write-sales-channel-country": {
+          entity: "sales_channel_country",
           action: "upsert",
           payload: [
             {
-              id: salesChannelId,
-              countries: [{ id: countryId }]
+              salesChannelId,
+              countryId
             }
           ]
         }
@@ -1739,6 +1787,7 @@ class TestDataService {
     });
     expect(syncSalesChannelResponse.ok()).toBeTruthy();
     const { data: salesChannel } = await syncSalesChannelResponse.json();
+    this.addCreatedRecord("sales_channel_country", { salesChannelId, countryId });
     return salesChannel;
   }
   /**
@@ -1994,6 +2043,16 @@ class TestDataService {
       this.createdRecords.push({ resource: res, payload });
     }
   }
+  /**
+   * Adds a sales channel related property to the registry of created sales channel records.
+   * The property added to the registry will be overridden with null value by the cleanup call.
+   *
+   * @param salesChannelId - The sales channel id where the property pair is located
+   * @param field - The database field which has to be overridden
+   */
+  addCreatedSalesChannelRecord(salesChannelId, field) {
+    this.createdSalesChannelRecords.push({ salesChannelId, field });
+  }
   /**
    * Set the configuration of automated data clean up.
    * If set to "true" the data service will delete all entities created by it.
@@ -2010,8 +2069,18 @@ class TestDataService {
     if (!this.shouldCleanUp) {
       return null;
     }
-    const priorityDeleteOperations = {};
     const deleteOperations = {};
+    const priorityDeleteOperations = {};
+    if (this.createdSalesChannelRecords) {
+      for (const salesChannelRecord of this.createdSalesChannelRecords) {
+        const salesChannelResponse = await this.AdminApiClient.patch(`sales-channel/${salesChannelRecord.salesChannelId}`, {
+          data: {
+            [salesChannelRecord.field]: null
+          }
+        });
+        expect(salesChannelResponse.ok()).toBeTruthy();
+      }
+    }
     this.createdRecords.forEach((record) => {
       if (this.highPriorityEntities.includes(record.resource)) {
         if (!priorityDeleteOperations[`delete-${record.resource}`]) {
@@ -2652,6 +2721,18 @@ class TestDataService {
     };
     return Object.assign({}, basicCustomerGroup, overrides);
   }
+  getSalesChannelAnalyticsStruct(overrides = {}) {
+    const salesChannelAnalyticsUuid = this.IdProvider.getIdPair().uuid;
+    const trackingId = this.IdProvider.getIdPair().id;
+    const basicSalesChannelAnalyticsStruct = {
+      id: salesChannelAnalyticsUuid,
+      trackingId,
+      active: true,
+      trackOrders: false,
+      anonymizeIp: true
+    };
+    return Object.assign({}, basicSalesChannelAnalyticsStruct, overrides);
+  }
   async clearCaches() {
     await this.AdminApiClient.delete("_action/cache");
   }

package/package.json

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