@shopware-ag/acceptance-test-suite 2.0.1 → 2.1.0

package/dist/index.d.mts

@@ -1,26 +1,10 @@
 import * as _playwright_test from '@playwright/test';
 import { APIRequestContext, APIResponse, Page, Locator } from '@playwright/test';
 export * from '@playwright/test';
+import * as playwright_core from 'playwright-core';
 import { components } from '@shopware/api-client/admin-api-types';
 import { Image } from 'image-js';
 
-interface IdPair {
-    id: string;
-    uuid: string;
-}
-declare class IdProvider {
-    private readonly workerIndex;
-    private readonly seed;
-    constructor(workerIndex: number, seed: string);
-    getIdPair(): IdPair;
-    getUniqueName(): string;
-    getWorkerDerivedStableId(key: string): IdPair;
-}
-
-interface HelperFixtureTypes {
-    IdProvider: IdProvider;
-}
-
 type Task = (...args: any[]) => () => Promise<void>;
 
 interface RequestOptions$1<PAYLOAD> {
@@ -37,8 +21,8 @@ interface AdminApiContextOptions {
     ignoreHTTPSErrors?: boolean;
 }
 declare class AdminApiContext {
-    private context;
-    private readonly options;
+    context: APIRequestContext;
+    readonly options: AdminApiContextOptions;
     private static readonly defaultOptions;
     constructor(context: APIRequestContext, options: AdminApiContextOptions);
     static create(options?: AdminApiContextOptions): Promise<AdminApiContext>;
@@ -86,9 +70,412 @@ declare class StoreApiContext {
     head<PAYLOAD>(url: string, options?: RequestOptions<PAYLOAD>): Promise<APIResponse>;
 }
 
+interface IdPair {
+    id: string;
+    uuid: string;
+}
+declare class IdProvider {
+    private readonly workerIndex;
+    private readonly seed;
+    constructor(workerIndex: number, seed: string);
+    getIdPair(): IdPair;
+    getUniqueName(): string;
+    getWorkerDerivedStableId(key: string): IdPair;
+}
+
+type SalesChannel = components['schemas']['SalesChannel'] & {
+    id: string;
+};
+type Customer = components['schemas']['Customer'] & {
+    id: string;
+    password: string;
+};
+type CustomerAddress = components['schemas']['CustomerAddress'] & {
+    id: string;
+};
+type Salutation = components['schemas']['Salutation'] & {
+    id: string;
+};
+interface Price {
+    gross: number;
+    net: number;
+    linked: boolean;
+    currencyId: string;
+}
+interface ProductPrice {
+    productId?: string;
+    ruleId: string;
+    price: Price[];
+    quantityStart: number;
+    quantityEnd: number;
+}
+type Product = Omit<components['schemas']['Product'], 'price' | 'prices'> & {
+    id: string;
+    price: Price[];
+    prices?: ProductPrice[];
+    translated: {
+        name: string;
+    };
+};
+type PropertyGroup = components['schemas']['PropertyGroup'] & {
+    id: string;
+};
+type Category$1 = components['schemas']['Category'] & {
+    id: string;
+};
+type Media = components['schemas']['Media'] & {
+    id: string;
+};
+type Tag = components['schemas']['Tag'] & {
+    id: string;
+};
+type Rule = components['schemas']['Rule'] & {
+    id: string;
+};
+type Currency = components['schemas']['Currency'] & {
+    id: string;
+};
+type Order = components['schemas']['Order'] & {
+    id: string;
+    orderCustomer: {
+        firstName: string;
+        lastName: string;
+        email: string;
+    };
+};
+type ShippingMethod = components['schemas']['ShippingMethod'] & {
+    id: string;
+};
+type PaymentMethod = components['schemas']['PaymentMethod'] & {
+    id: string;
+};
+type StateMachine = components['schemas']['StateMachine'] & {
+    id: string;
+};
+type StateMachineState = components['schemas']['StateMachineState'] & {
+    id: string;
+};
+type Promotion = components['schemas']['Promotion'] & {
+    id: string;
+};
+
+interface CreatedRecord {
+    resource: string;
+    id: string;
+}
+interface SimpleLineItem {
+    product: Product;
+    quantity?: number;
+    position?: number;
+}
+interface SyncApiOperation {
+    entity: string;
+    action: 'upsert' | 'delete';
+    payload: Record<string, unknown>[];
+}
+interface DataServiceOptions {
+    namePrefix?: string;
+    nameSuffix?: string;
+    defaultSalesChannel: SalesChannel;
+    defaultTaxId: string;
+    defaultCurrencyId: string;
+    defaultCategoryId: string;
+    defaultLanguageId: string;
+    defaultCountryId: string;
+    defaultCustomerGroupId: string;
+}
+declare class TestDataService {
+    readonly AdminApiClient: AdminApiContext;
+    readonly IdProvider: IdProvider;
+    readonly namePrefix: string;
+    readonly nameSuffix: string;
+    readonly defaultSalesChannel: SalesChannel;
+    readonly defaultTaxId: string;
+    readonly defaultCurrencyId: string;
+    readonly defaultCategoryId: string;
+    readonly defaultLanguageId: string;
+    readonly defaultCountryId: string;
+    readonly defaultCustomerGroupId: string;
+    private shouldCleanUp;
+    private createdRecords;
+    constructor(AdminApiClient: AdminApiContext, IdProvider: IdProvider, options: DataServiceOptions);
+    /**
+     * Creates a basic product without images or other special configuration.
+     * The product will be added to the default sales channel category if configured.
+     *
+     * @param overrides - Specific data overrides that will be applied to the product data struct.
+     * @param taxId - The uuid of the tax rule to use for the product pricing.
+     * @param currencyId - The uuid of the currency to use for the product pricing.
+     */
+    createBasicProduct(overrides?: Partial<Product>, taxId?: string, currencyId?: string): Promise<Product>;
+    /**
+     * Creates a basic product with one randomly generated image.
+     * The product will be added to the default sales channel category if configured.
+     *
+     * @param overrides - Specific data overrides that will be applied to the product data struct.
+     * @param taxId - The uuid of the tax rule to use for the product pricing.
+     * @param currencyId - The uuid of the currency to use for the product pricing.
+     */
+    createProductWithImage(overrides?: Partial<Product>, taxId?: string, currencyId?: string): Promise<Product>;
+    /**
+     * Creates a digital product with a text file as its download.
+     * The product will be added to the default sales channel category if configured.
+     *
+     * @param content - The content of the text file for the product download.
+     * @param overrides - Specific data overrides that will be applied to the product data struct.
+     * @param taxId - The uuid of the tax rule to use for the product pricing.
+     * @param currencyId - The uuid of the currency to use for the product pricing.
+     */
+    createDigitalProduct(content?: string, overrides?: Partial<Product>, taxId?: string, currencyId?: string): Promise<Product>;
+    /**
+     * Creates a basic product with a price range matrix.
+     * The product will be added to the default sales channel category if configured.
+     *
+     * @param overrides - Specific data overrides that will be applied to the product data struct.
+     * @param taxId - The uuid of the tax rule to use for the product pricing.
+     * @param currencyId - The uuid of the currency to use for the product pricing.
+     */
+    createProductWithPriceRange(overrides?: Partial<Product>, taxId?: string, currencyId?: string): Promise<Product>;
+    /**
+     * Creates a basic product category to assign products to.
+     *
+     * @param parentId - The uuid of the parent category.
+     * @param overrides - Specific data overrides that will be applied to the category data struct.
+     */
+    createCategory(overrides?: Partial<Category$1>, parentId?: string): Promise<Category$1>;
+    /**
+     * Creates a new media resource containing a random generated PNG image.
+     *
+     * @param width - The width of the image in pixel. Default is 800.
+     * @param height - The height of the image in pixel. Default is 600.
+     */
+    createMediaPNG(width?: number, height?: number): Promise<Media>;
+    /**
+     * Creates a new media resource containing a text file.
+     *
+     * @param content - The content of the text file.
+     */
+    createMediaTXT(content?: string): Promise<Media>;
+    /**
+     * Creates a new empty media resource.
+     * This method is mostly used to combine it with a certain file upload.
+     */
+    createMediaResource(): Promise<Media>;
+    /**
+     * Creates a new property group with color type options.
+     *
+     * @param overrides - Specific data overrides that will be applied to the property group data struct.
+     */
+    createColorPropertyGroup(overrides?: Partial<PropertyGroup>): Promise<PropertyGroup>;
+    /**
+     * Creates a new property group with text type options.
+     *
+     * @param overrides - Specific data overrides that will be applied to the property group data struct.
+     */
+    createTextPropertyGroup(overrides?: Partial<PropertyGroup>): Promise<PropertyGroup>;
+    /**
+     * Creates a new tag which can be assigned to other entities.
+     *
+     * @param tagName - The name of the tag.
+     */
+    createTag(tagName: string): Promise<Tag>;
+    /**
+     * Creates a new shop customer.
+     *
+     * @param overrides - Specific data overrides that will be applied to the customer data struct.
+     * @param salutationKey - The key of the salutation that should be used for the customer. Default is "mr".
+     * @param salesChannel - The sales channel for which the customer should be registered.
+     */
+    createCustomer(overrides?: Partial<Customer>, salutationKey?: string, salesChannel?: SalesChannel): Promise<Customer>;
+    /**
+     * Creates a new order. This order is created on pure data and prices are not guaranteed to be calculated correctly.
+     *
+     * @param lineItems - Products that should be added to the order.
+     * @param customer - The customer to which the order should be assigned.
+     * @param salesChannel - The sales channel in which the order should be created.
+     * @param overrides - Specific data overrides that will be applied to the order data struct.
+     */
+    createOrder(lineItems: SimpleLineItem[], customer: Customer, overrides?: Partial<Order>, salesChannel?: SalesChannel): Promise<Order>;
+    /**
+     * Creates a new promotion with a promotion code.
+     *
+     * @param overrides - Specific data overrides that will be applied to the promotion data struct.
+     * @param salesChannelId - The uuid of the sales channel in which the promotion should be active.
+     */
+    createPromotionWithCode(overrides?: Partial<Promotion>, salesChannelId?: string): Promise<Promotion>;
+    /**
+     * Assigns a media resource as the download of a digital product.
+     *
+     * @param productId - The uuid of the product.
+     * @param mediaId - The uuid of the media resource.
+     */
+    assignProductDownload(productId: string, mediaId: string): Promise<any>;
+    /**
+     * Assigns a media resource to a product as the product image.
+     *
+     * @param productId - The uuid of the product.
+     * @param mediaId - The uuid of the media resource.
+     */
+    assignProductMedia(productId: string, mediaId: string): Promise<any>;
+    /**
+     * Assigns a product to a category.
+     *
+     * @param productId - The uuid of the product.
+     * @param categoryId - The uuid of the category.
+     */
+    assignProductCategory(productId: string, categoryId: string): Promise<playwright_core.APIResponse>;
+    /**
+     * Assigns a tag to a product.
+     *
+     * @param productId - The uuid of the product.
+     * @param tagId - The uuid of the tag.
+     */
+    assignProductTag(productId: string, tagId: string): Promise<playwright_core.APIResponse>;
+    /**
+     * Retrieves a currency based on its ISO code.
+     *
+     * @param isoCode - The ISO code of the currency, for example "EUR".
+     */
+    getCurrency(isoCode: string): Promise<Currency>;
+    /**
+     * Retrieves a rule based on its name.
+     *
+     * @param name - The name of the rule.
+     */
+    getRule(name: string): Promise<Rule>;
+    /**
+     * Retrieves a shipping method by its name.
+     *
+     * @param name - The name of the shipping method. Default is "Standard".
+     */
+    getShippingMethod(name?: string): Promise<ShippingMethod>;
+    /**
+     * Retrieves a payment method by its name.
+     *
+     * @param name - The name of the payment method. Default is "Invoice".
+     */
+    getPaymentMethod(name?: string): Promise<PaymentMethod>;
+    /**
+     * Retrieves the address of a customer by its uuid.
+     *
+     * @param addressId - The uuid of the customer address.
+     */
+    getCustomerAddress(addressId: string): Promise<CustomerAddress>;
+    /**
+     * Retrieves a customer salutations by its key.
+     *
+     * @param key - The key of the salutation. Default is "mr".
+     */
+    getSalutation(key?: string): Promise<any>;
+    /**
+     * Retrieves the state machine for order states.
+     */
+    getOrderStateMachine(): Promise<StateMachine>;
+    /**
+     * Retrieves the state machine for delivery states.
+     */
+    getDeliveryStateMachine(): Promise<StateMachine>;
+    /**
+     * Retrieves the state machine for transaction states.
+     */
+    getTransactionStateMachine(): Promise<StateMachine>;
+    /**
+     * Retrieves a state machine by its name.
+     *
+     * @param name - The name of the state machine.
+     */
+    getStateMachine(name: string): Promise<StateMachine>;
+    /**
+     * Retrieves the state of a state machine.
+     *
+     * @param stateMachineId - The uuid of the state machine.
+     * @param stateName - The name of the state. Default is "open".
+     */
+    getStateMachineState(stateMachineId: string, stateName?: 'open' | 'completed' | 'in_progress' | 'cancelled'): Promise<StateMachineState>;
+    /**
+     * Adds an entity reference to the registry of created records.
+     * All entities added to the registry will be deleted by the cleanup call.
+     *
+     * @param resource - The resource name of the entity.
+     * @param id - The uuid of the entity.
+     */
+    addCreatedRecord(resource: string, id: string): void;
+    /**
+     * Set the configuration of automated data clean up.
+     * If set to "true" the data service will delete all entities created by it.
+     *
+     * @param shouldCleanUp - The config setting for the automated data clean up. Default is "true".
+     */
+    setCleanUp(shouldCleanUp?: boolean): void;
+    /**
+     * Will delete all entities created by the data service via sync API.
+     */
+    cleanUp(): Promise<playwright_core.APIResponse>;
+    /**
+     * Convert a JS date object into a date-time compatible string.
+     *
+     * @param date - The JS date object from which the date-time should be retrieved.
+     */
+    convertDateTime(date: Date): string;
+    getBasicProductStruct(taxId?: string, currencyId?: string, overrides?: Partial<Product>): Partial<Product>;
+    getProductPriceRangeStruct(currencyId: string, ruleId: string): Partial<Product>;
+    getBasicCategoryStruct(overrides?: Partial<Category$1>, parentId?: string): {
+        id: string;
+        name: string;
+        parentId: string | null;
+        displayNestedProducts: boolean;
+        type: string;
+        productAssignmentType: string;
+        visible: boolean;
+        active: boolean;
+    } & Partial<Category$1>;
+    getBasicCustomerStruct(salesChannelId: string, customerGroupId: string, languageId: string, countryId: string, defaultPaymentMethodId: string, salutationId: string, overrides?: Partial<Customer>): Partial<Customer>;
+    getBasicOrderStruct(lineItems: SimpleLineItem[], languageId: string, currency: Currency, paymentMethod: PaymentMethod, shippingMethod: ShippingMethod, orderState: StateMachineState, deliveryState: StateMachineState, transactionState: StateMachineState, customer: Customer, customerAddress: CustomerAddress, salesChannelId?: string, overrides?: Partial<Order>): Partial<Order>;
+    getBasicProductLineItemStruct(lineItem: SimpleLineItem): {
+        productId: string;
+        referencedId: string;
+        payload: {
+            productNumber: string;
+        };
+        identifier: string;
+        type: string;
+        label: string;
+        quantity: number;
+        position: number;
+        price: {
+            unitPrice: number;
+            totalPrice: number;
+            quantity: number | undefined;
+            calculatedTaxes: {
+                tax: number;
+                taxRate: number;
+                price: number;
+            }[];
+            taxRules: {
+                taxRate: number;
+                percentage: number;
+            }[];
+        };
+        priceDefinition: {
+            type: string;
+            price: number;
+            quantity: number;
+            taxRules: {
+                taxRate: number;
+                percentage: number;
+            }[];
+            listPrice: number;
+            isCalculated: boolean;
+            referencePriceDefinition: null;
+        };
+    };
+    getBasicPromotionStruct(salesChannelId?: string, overrides?: Partial<Promotion>): Partial<Promotion>;
+}
+
 interface ApiContextTypes {
     AdminApiContext: AdminApiContext;
     StoreApiContext: StoreApiContext;
+    TestDataService: TestDataService;
 }
 
 interface PageContextTypes {
@@ -111,25 +498,10 @@ interface ActorFixtureTypes {
     ShopAdmin: Actor;
 }
 
-type Customer = components['schemas']['Customer'] & {
-    id: string;
-    password: string;
-};
-type Product = components['schemas']['Product'] & {
-    id: string;
-    price: {
-        gross: number;
-        net: number;
-        linked: boolean;
-        currencyId: string;
-    }[];
-};
-type Category$1 = components['schemas']['Category'] & {
-    id: string;
-};
-type Order = components['schemas']['Order'] & {
-    id: string;
-};
+interface HelperFixtureTypes {
+    IdProvider: IdProvider;
+    SaaSInstanceSetup: () => Promise<void>;
+}
 
 interface StoreBaseConfig {
     storefrontTypeId: string;
@@ -149,6 +521,12 @@ interface StoreBaseConfig {
 interface DefaultSalesChannelTypes {
     SalesChannelBaseConfig: StoreBaseConfig;
     DefaultSalesChannel: {
+        salesChannel: SalesChannel;
+        customer: Customer;
+        url: string;
+        themeSeed: string | null;
+    };
+    DefaultStorefront: {
         salesChannel: components['schemas']['SalesChannel'];
         customer: Customer;
         url: string;
@@ -595,7 +973,7 @@ declare const getLanguageData: (languageCode: string, adminApiContext: AdminApiC
     localeId: string;
 }>;
 declare const getSnippetSetId: (languageCode: string, adminApiContext: AdminApiContext) => Promise<string>;
-declare const getCurrency: (isoCode: 'EUR', adminApiContext: AdminApiContext) => Promise<any>;
+declare const getCurrency: (isoCode: string, adminApiContext: AdminApiContext) => Promise<any>;
 declare const getTaxId: (adminApiContext: AdminApiContext) => Promise<string>;
 declare const getPaymentMethodId: (adminApiContext: AdminApiContext, handlerId?: string) => Promise<string>;
 declare const getDefaultShippingMethodId: (adminApiContext: AdminApiContext) => Promise<string>;
@@ -651,6 +1029,6 @@ declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArg
     OpenSearchSuggestPage: Task;
 } & {
     ValidateAccessibility: (pageName: string, assertViolations?: boolean | undefined, createReport?: boolean | undefined, ruleTags?: string[] | undefined, outputDir?: string | undefined) => () => Promise<void>;
-}, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & HelperFixtureTypes & FixtureTypes>;
+}, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & FixtureTypes>;
 
-export { AdminPageObjects, type FixtureTypes, type PageObject, StorefrontPageObjects, type Task, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlowId, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getSalutationId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, isSaaSInstance, setOrderStatus, test };
+export { AdminPageObjects, type Category$1 as Category, type CreatedRecord, type Currency, type Customer, type CustomerAddress, type DataServiceOptions, type FixtureTypes, type Media, type Order, type PageObject, type PaymentMethod, type Price, type Product, type ProductPrice, type Promotion, type PropertyGroup, type Rule, type SalesChannel, type Salutation, type ShippingMethod, type SimpleLineItem, type StateMachine, type StateMachineState, StorefrontPageObjects, type SyncApiOperation, type Tag, type Task, TestDataService, createRandomImage, extractIdFromUrl, getCountryId, getCurrency, getDefaultShippingMethodId, getFlowId, getLanguageData, getMediaId, getOrderTransactionId, getPaymentMethodId, getSalutationId, getSnippetSetId, getStateMachineId, getStateMachineStateId, getTaxId, getThemeId, isSaaSInstance, setOrderStatus, test };