@shopware-ag/acceptance-test-suite 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,531 @@
+import * as _playwright_test from '@playwright/test';
+import { APIRequestContext, APIResponse, Page, Locator } from '@playwright/test';
+export * from '@playwright/test';
+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: never[]) => () => Promise<void>;
+
+interface RequestOptions$1<PAYLOAD> {
+    [key: string]: unknown;
+    data?: PAYLOAD;
+}
+interface AdminApiContextOptions {
+    app_url?: string;
+    client_id?: string;
+    client_secret?: string;
+    access_token?: string;
+    admin_username?: string;
+    admin_password?: string;
+    ignoreHTTPSErrors?: boolean;
+}
+declare class AdminApiContext {
+    private context;
+    private readonly options;
+    private static readonly defaultOptions;
+    constructor(context: APIRequestContext, options: AdminApiContextOptions);
+    static create(options?: AdminApiContextOptions): Promise<AdminApiContext>;
+    private static createApiRequestContext;
+    private static authenticateWithClientCredentials;
+    private static authenticateWithUserPassword;
+    isAuthenticated(): boolean;
+    get<PAYLOAD>(url: string, options?: RequestOptions$1<PAYLOAD>): Promise<APIResponse>;
+    post<PAYLOAD>(url: string, options?: RequestOptions$1<PAYLOAD>): Promise<APIResponse>;
+    patch<PAYLOAD>(url: string, options?: RequestOptions$1<PAYLOAD>): Promise<APIResponse>;
+    delete<PAYLOAD>(url: string, options?: RequestOptions$1<PAYLOAD>): Promise<APIResponse>;
+    fetch<PAYLOAD>(url: string, options?: RequestOptions$1<PAYLOAD>): Promise<APIResponse>;
+    head<PAYLOAD>(url: string, options?: RequestOptions$1<PAYLOAD>): Promise<APIResponse>;
+}
+
+interface RequestOptions<PAYLOAD> {
+    [key: string]: unknown;
+    data?: PAYLOAD;
+}
+interface StoreUser {
+    email: string;
+    password: string;
+}
+interface StoreApiContextOptions {
+    'app_url'?: string;
+    'sw-access-key'?: string;
+    'sw-context-token'?: string;
+    ignoreHTTPSErrors?: boolean;
+}
+declare class StoreApiContext {
+    private context;
+    private readonly options;
+    private static readonly defaultOptions;
+    constructor(context: APIRequestContext, options: StoreApiContextOptions);
+    static create(options?: StoreApiContextOptions): Promise<StoreApiContext>;
+    private static createContext;
+    login(user: StoreUser): Promise<{
+        [key: string]: string;
+    }>;
+    get<PAYLOAD>(url: string, options?: RequestOptions<PAYLOAD>): Promise<APIResponse>;
+    post<PAYLOAD>(url: string, options?: RequestOptions<PAYLOAD>): Promise<APIResponse>;
+    patch<PAYLOAD>(url: string, options?: RequestOptions<PAYLOAD>): Promise<APIResponse>;
+    delete<PAYLOAD>(url: string, options?: RequestOptions<PAYLOAD>): Promise<APIResponse>;
+    fetch<PAYLOAD>(url: string, options?: RequestOptions<PAYLOAD>): Promise<APIResponse>;
+    head<PAYLOAD>(url: string, options?: RequestOptions<PAYLOAD>): Promise<APIResponse>;
+}
+
+interface ApiContextTypes {
+    AdminApiContext: AdminApiContext;
+    StoreApiContext: StoreApiContext;
+}
+
+interface PageContextTypes {
+    AdminPage: Page;
+    StorefrontPage: Page;
+}
+
+interface PageObject {
+    readonly page: Page;
+    goTo(): Promise<void>;
+}
+
+declare class Actor {
+    page: Page;
+    readonly name: string;
+    constructor(name: string, page: Page);
+    expects: _playwright_test.Expect<{}>;
+    attemptsTo(task: () => Promise<void>): Promise<void>;
+    goesTo(pageObject: PageObject): Promise<void>;
+    private camelCaseToLowerCase;
+}
+
+interface ActorFixtureTypes {
+    ShopCustomer: Actor;
+    ShopAdmin: Actor;
+}
+
+interface StoreBaseConfig {
+    storefrontTypeId: string;
+    enGBLocaleId: string;
+    enGBLanguageId: string;
+    eurCurrencyId: string;
+    invoicePaymentMethodId: string;
+    defaultShippingMethod: string;
+    taxId: string;
+    deCountryId: string;
+    enGBSnippetSetId: string;
+    defaultThemeId: string;
+    appUrl: string | undefined;
+    adminUrl: string;
+}
+interface DefaultSalesChannelTypes {
+    SalesChannelBaseConfig: StoreBaseConfig;
+    DefaultSalesChannel: {
+        salesChannel: components['schemas']['SalesChannel'];
+        customer: components['schemas']['Customer'] & {
+            password: string;
+        };
+        url: string;
+    };
+}
+
+declare class Home implements PageObject {
+    readonly page: Page;
+    readonly productImages: Locator;
+    constructor(page: Page);
+    goTo(): Promise<void>;
+}
+
+declare class ProductDetail$1 implements PageObject {
+    readonly page: Page;
+    readonly productData: components['schemas']['Product'];
+    readonly addToCartButton: Locator;
+    readonly offCanvasCartTitle: Locator;
+    readonly offCanvasCart: Locator;
+    readonly offCanvasCartGoToCheckoutButton: Locator;
+    readonly productSingleImage: Locator;
+    readonly offCanvasLineItemImages: Locator;
+    readonly quantitySelect: Locator;
+    readonly offCanvasSummaryTotalPrice: Locator;
+    readonly offCanvas: Locator;
+    constructor(page: Page, productData: components['schemas']['Product']);
+    goTo(productData?: components['schemas']['Product']): Promise<void>;
+}
+
+declare class CheckoutCart implements PageObject {
+    readonly page: Page;
+    readonly headline: Locator;
+    readonly goToCheckoutButton: Locator;
+    readonly enterDiscountInput: Locator;
+    readonly grandTotalPrice: Locator;
+    readonly emptyCartAlert: Locator;
+    readonly stockReachedAlert: Locator;
+    readonly cartLineItemImages: Locator;
+    readonly unitPriceInfo: Locator;
+    constructor(page: Page);
+    goTo(): Promise<void>;
+}
+
+declare class CheckoutConfirm implements PageObject {
+    readonly page: Page;
+    readonly headline: Locator;
+    readonly termsAndConditionsCheckbox: Locator;
+    readonly immediateAccessToDigitalProductCheckbox: Locator;
+    readonly grandTotalPrice: Locator;
+    readonly submitOrderButton: Locator;
+    /**
+     * Payment options
+     */
+    readonly paymentCashOnDelivery: Locator;
+    readonly paymentPaidInAdvance: Locator;
+    readonly paymentInvoice: Locator;
+    /**
+     * Shipping options
+     */
+    readonly shippingStandard: Locator;
+    readonly shippingExpress: Locator;
+    /**
+     * Product details
+     */
+    readonly cartLineItemImages: Locator;
+    constructor(page: Page);
+    goTo(): Promise<void>;
+}
+
+declare class CheckoutFinish implements PageObject {
+    readonly page: Page;
+    readonly headline: Locator;
+    readonly orderNumberText: Locator;
+    readonly grandTotalPrice: Locator;
+    readonly cartLineItemImages: Locator;
+    private readonly orderNumberRegex;
+    constructor(page: Page);
+    goTo(): Promise<void>;
+    getOrderNumber(): Promise<string | null>;
+    getOrderId(): string | null;
+}
+
+declare class CheckoutRegister implements PageObject {
+    readonly page: Page;
+    readonly cartLineItemImages: Locator;
+    constructor(page: Page);
+    goTo(): Promise<void>;
+}
+
+declare class Account implements PageObject {
+    readonly page: Page;
+    readonly headline: Locator;
+    readonly personalDataCardTitle: Locator;
+    constructor(page: Page);
+    goTo(): Promise<void>;
+}
+
+declare class AccountLogin implements PageObject {
+    readonly page: Page;
+    readonly emailInput: Locator;
+    readonly passwordInput: Locator;
+    readonly loginButton: Locator;
+    readonly logoutLink: Locator;
+    readonly successAlert: Locator;
+    readonly personalFormArea: Locator;
+    readonly billingAddressFormArea: Locator;
+    readonly firstNameInput: Locator;
+    readonly lastNameInput: Locator;
+    readonly registerEmailInput: Locator;
+    readonly registerPasswordInput: Locator;
+    readonly streetAddressInput: Locator;
+    readonly cityInput: Locator;
+    readonly countryInput: Locator;
+    readonly registerButton: Locator;
+    constructor(page: Page);
+    goTo(): Promise<void>;
+}
+
+declare class AccountOrder implements PageObject {
+    readonly page: Page;
+    readonly cartLineItemImages: Locator;
+    readonly orderExpandButton: Locator;
+    readonly digitalProductDownloadButton: Locator;
+    constructor(page: Page);
+    goTo(): Promise<void>;
+}
+
+declare class Search implements PageObject {
+    readonly page: Page;
+    readonly productImages: Locator;
+    constructor(page: Page);
+    goTo(): Promise<void>;
+}
+
+declare class SearchSuggest implements PageObject {
+    readonly page: Page;
+    readonly searchSuggestLineItemImages: Locator;
+    constructor(page: Page);
+    goTo(): Promise<void>;
+}
+
+interface StorefrontPageTypes {
+    StorefrontHome: Home;
+    StorefrontProductDetail: ProductDetail$1;
+    StorefrontCheckoutCart: CheckoutCart;
+    StorefrontCheckoutConfirm: CheckoutConfirm;
+    StorefrontCheckoutFinish: CheckoutFinish;
+    StorefrontCheckoutRegister: CheckoutRegister;
+    StorefrontAccount: Account;
+    StorefrontAccountLogin: AccountLogin;
+    StorefrontAccountOrder: AccountOrder;
+    StorefrontSearch: Search;
+    StorefrontSearchSuggest: SearchSuggest;
+}
+declare const StorefrontPageObjects: {
+    Home: typeof Home;
+    ProductDetail: typeof ProductDetail$1;
+    CheckoutCart: typeof CheckoutCart;
+    CheckoutConfirm: typeof CheckoutConfirm;
+    CheckoutFinish: typeof CheckoutFinish;
+    CheckoutRegister: typeof CheckoutRegister;
+    Account: typeof Account;
+    AccountLogin: typeof AccountLogin;
+    AccountOrder: typeof AccountOrder;
+    Search: typeof Search;
+    SearchSuggest: typeof SearchSuggest;
+};
+
+declare class ProductDetail implements PageObject {
+    readonly page: Page;
+    /**
+     * Save interactions
+     */
+    readonly savePhysicalProductButton: Locator;
+    readonly saveButtonLoadingSpinner: Locator;
+    readonly saveButtonCheckMark: Locator;
+    /**
+     * Media Upload interactions
+     */
+    readonly uploadMediaButton: Locator;
+    readonly coverImage: Locator;
+    readonly productImage: Locator;
+    /**
+     * Tabs
+     */
+    readonly variantsTabLink: Locator;
+    /**
+     * Variants Generation
+     */
+    readonly generateVariantsButton: Locator;
+    readonly variantsModal: Locator;
+    readonly variantsModalHeadline: Locator;
+    readonly variantsNextButton: Locator;
+    readonly variantsSaveButton: Locator;
+    /**
+     * Property Selection
+     */
+    readonly propertyGroupColor: Locator;
+    readonly propertyGroupSize: Locator;
+    readonly propertyOptionGrid: Locator;
+    readonly propertyOptionColorBlue: Locator;
+    readonly propertyOptionColorRed: Locator;
+    readonly propertyOptionColorGreen: Locator;
+    readonly propertyOptionSizeSmall: Locator;
+    readonly propertyOptionSizeMedium: Locator;
+    readonly propertyOptionSizeLarge: Locator;
+    readonly productData: components['schemas']['Product'];
+    constructor(page: Page, productData: components['schemas']['Product']);
+    goTo(): Promise<void>;
+    getProductId(): string | undefined;
+}
+
+declare class OrderDetail implements PageObject {
+    readonly page: Page;
+    readonly dataGridContextButton: Locator;
+    readonly orderTag: Locator;
+    private readonly orderData;
+    constructor(page: Page, orderData: components['schemas']['Order']);
+    goTo(): Promise<void>;
+}
+
+declare class CustomerDetail implements PageObject {
+    readonly page: Page;
+    readonly customerId: string | undefined;
+    readonly editButton: Locator;
+    readonly generalTab: Locator;
+    readonly accountCard: Locator;
+    constructor(page: Page, customer: components['schemas']['Customer']);
+    goTo(): Promise<void>;
+}
+
+declare class FirstRunWizard implements PageObject {
+    readonly page: Page;
+    readonly nextButton: Locator;
+    readonly configureLaterButton: Locator;
+    readonly skipButton: Locator;
+    readonly finishButton: Locator;
+    readonly backButton: Locator;
+    readonly smtpServerButton: Locator;
+    readonly dataImportHeader: Locator;
+    readonly installLanguagePackButton: Locator;
+    readonly installDemoDataButton: Locator;
+    readonly installMigrationAssistantButton: Locator;
+    readonly defaultValuesHeader: Locator;
+    readonly mailerConfigurationHeader: Locator;
+    readonly payPalSetupHeader: Locator;
+    readonly extensionsHeader: Locator;
+    readonly shopwareAccountHeader: Locator;
+    readonly shopwareStoreHeader: Locator;
+    readonly doneHeader: Locator;
+    readonly frwSuccessText: Locator;
+    readonly welcomeText: Locator;
+    readonly pluginCardInfo: Locator;
+    readonly dataImportCard: Locator;
+    readonly salesChannelSelectionList: Locator;
+    readonly salesChannelSelectionMultiSelect: Locator;
+    readonly smtpServerTitle: Locator;
+    readonly smtpServerFields: Locator;
+    readonly payPalPaymethods: Locator;
+    readonly payPalInfoCard: Locator;
+    readonly emailAddressInputField: Locator;
+    readonly passwordInputField: Locator;
+    readonly forgotPasswordLink: Locator;
+    readonly extensionStoreHeading: Locator;
+    readonly documentationLink: Locator;
+    readonly forumLink: Locator;
+    readonly roadmapLink: Locator;
+    readonly germanRegionSelector: Locator;
+    readonly toolsSelector: Locator;
+    readonly recommendationHeader: Locator;
+    readonly toolsRecommendedPlugin: Locator;
+    constructor(page: Page);
+    goTo(): Promise<void>;
+}
+
+declare class FlowBuilderCreate implements PageObject {
+    readonly page: Page;
+    readonly saveButton: Locator;
+    readonly header: Locator;
+    constructor(page: Page);
+    goTo(): Promise<void>;
+}
+
+declare class FlowBuilderListing implements PageObject {
+    readonly page: Page;
+    readonly firstFlowName: Locator;
+    readonly firstFlowContextButton: Locator;
+    readonly flowContextMenu: Locator;
+    readonly contextMenuDownload: Locator;
+    readonly flowDownloadModal: Locator;
+    readonly downloadFlowButton: Locator;
+    readonly successAlert: Locator;
+    readonly successAlertMessage: Locator;
+    constructor(page: Page);
+    goTo(): Promise<void>;
+}
+
+interface AdministrationPageTypes {
+    AdminProductDetail: ProductDetail;
+    AdminOrderDetail: OrderDetail;
+    AdminCustomerDetail: CustomerDetail;
+    AdminFirstRunWizard: FirstRunWizard;
+    AdminFlowBuilderCreate: FlowBuilderCreate;
+    AdminFlowBuilderListing: FlowBuilderListing;
+}
+declare const AdminPageObjects: {
+    ProductDetail: typeof ProductDetail;
+    OrderDetail: typeof OrderDetail;
+    CustomerDetail: typeof CustomerDetail;
+    FirstRunWizard: typeof FirstRunWizard;
+    FlowBuilderCreate: typeof FlowBuilderCreate;
+    FlowBuilderListing: typeof FlowBuilderListing;
+};
+
+interface DataFixtureTypes {
+    ProductData: components['schemas']['Product'];
+    DigitalProductData: {
+        product: components['schemas']['Product'];
+        fileContent: string;
+    };
+    PromotionWithCodeData: components['schemas']['Promotion'];
+    CartWithProductData: Record<string, unknown>;
+    PropertiesData: {
+        propertyGroupColor: components['schemas']['PropertyGroup'];
+        propertyGroupSize: components['schemas']['PropertyGroup'];
+    };
+    MediaData: components['schemas']['Media'];
+    OrderData: components['schemas']['Order'];
+    TagData: components['schemas']['Tag'];
+}
+
+interface FixtureTypes extends ApiContextTypes, PageContextTypes, ActorFixtureTypes, HelperFixtureTypes, DefaultSalesChannelTypes, StorefrontPageTypes, AdministrationPageTypes, DataFixtureTypes {
+}
+
+declare const getLanguageData: (languageCode: string, adminApiContext: AdminApiContext) => Promise<{
+    id: string;
+    localeId: string;
+}>;
+declare const getSnippetSetId: (languageCode: string, adminApiContext: AdminApiContext) => Promise<string>;
+declare const getCurrency: (isoCode: 'EUR', 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>;
+declare const getCountryId: (iso2: string, adminApiContext: AdminApiContext) => Promise<string>;
+declare const getThemeId: (technicalName: string, adminApiContext: AdminApiContext) => Promise<string>;
+declare const getSalutationId: (salutationKey: string, adminApiContext: AdminApiContext) => Promise<string>;
+declare const getStateMachineId: (technicalName: string, adminApiContext: AdminApiContext) => Promise<string>;
+declare const getStateMachineStateId: (stateMachineId: string, adminApiContext: AdminApiContext) => Promise<string>;
+declare const getFlowId: (eventName: string, adminApiContext: AdminApiContext) => Promise<{
+    id: string;
+}>;
+declare const getOrderTransactionId: (orderId: string, adminApiContext: AdminApiContext) => Promise<{
+    id: string;
+}>;
+declare const getMediaId: (fileName: string, adminApiContext: AdminApiContext) => Promise<string>;
+declare function extractIdFromUrl(url: string): string | null;
+
+declare function createRandomImage(width?: number, height?: number): Image;
+
+declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArgs & _playwright_test.PlaywrightTestOptions & FixtureTypes & {
+    SaveProduct: Task;
+} & {
+    Login: Task;
+} & {
+    Logout: Task;
+} & {
+    Register: Task;
+} & {
+    AddProductToCart: Task;
+} & {
+    ProceedFromProductToCheckout: Task;
+} & {
+    ProceedFromCartToCheckout: Task;
+} & {
+    ConfirmTermsAndConditions: Task;
+} & {
+    SelectInvoicePaymentOption: Task;
+} & {
+    SelectCashOnDeliveryPaymentOption: Task;
+} & {
+    SelectPaidInAdvancePaymentOption: Task;
+} & {
+    SelectStandardShippingOption: Task;
+} & {
+    SelectExpressShippingOption: Task;
+} & {
+    SubmitOrder: Task;
+} & {
+    OpenSearchResultPage: Task;
+} & {
+    OpenSearchSuggestPage: Task;
+}, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & HelperFixtureTypes & 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, test };