@shopware-ag/acceptance-test-suite 2.8.1 → 3.1.0

package/dist/index.d.mts

@@ -89,35 +89,39 @@ declare class MailpitApiContext {
      */
     getEmailHeaders(email: string): Promise<Email>;
     /**
-     * Retrieves the body content of the latest email as an HTML string.
-     * @returns The HTML content of the latest email.
+     * Retrieves the body content of the email as an HTML string.
+     * @param email - The email address of the recipient.
+     * @returns A promise that resolves to the HTML content of the email.
      */
-    getEmailBody(): Promise<string>;
+    getEmailBody(email: string): Promise<string>;
     /**
      * Generates the full email content, combining headers and body.
      * @param email - The email address to fetch headers for.
-     * @returns The full email content as a string.
+     * @returns A promise that resolves to the full email content as a string.
      */
     generateEmailContent(email: string): Promise<string>;
     /**
-     * Retrieves the plain text content of the latest email.
-     * @returns The plain text content of the latest email.
+     * Retrieves the plain text content of the email.
+     * @param email - The email address of the recipient.
+     * @returns A promise that resolves to the plain text content of the email.
      */
-    getRenderMessageTxt(): Promise<string>;
+    getRenderMessageTxt(email: string): Promise<string>;
     /**
      * Extracts the first URL found in the plain text content of the latest email.
-     * @returns The first URL found in the email content.
+     * @param email - The email address of the recipient.
+     * @returns A promise that resolves to the first URL found in the email content.
      * @throws An error if no URL is found in the email content.
      */
-    getLinkFromMail(): Promise<string>;
+    getLinkFromMail(email: string): Promise<string>;
     /**
      * Deletes a specific email by ID if provided, or deletes all emails if no ID is provided.
      * @param emailId - The ID of the email to delete (optional).
      */
     deleteMail(emailId?: string): Promise<void>;
     /**
-     * Creates a new EmailApiContext instance with the appropriate configuration.
-     * @returns A promise that resolves to an EmailApiContext instance.
+     * Creates a new MailpitApiContext instance with the appropriate configuration.
+     * @param baseURL - The base URL for the API.
+     * @returns A promise that resolves to a MailpitApiContext instance.
      */
     static create(baseURL: string): Promise<MailpitApiContext>;
 }
@@ -281,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;
@@ -290,6 +297,7 @@ interface SimpleLineItem {
     product: Product | Promotion;
     quantity?: number;
     position?: number;
+    overrides?: Partial<OrderLineItem>;
 }
 interface SyncApiOperation {
     entity: string;
@@ -639,7 +647,7 @@ declare class TestDataService {
             isCalculated: boolean;
             referencePriceDefinition: null;
         };
-    };
+    } & Partial<OrderLineItem>;
     getBasicPromotionLineItemStruct(lineItem: SimpleLineItem): {
         payload: {
             code: string | undefined;
@@ -669,7 +677,7 @@ declare class TestDataService {
             price: number;
             percentage: number | null;
         };
-    };
+    } & Partial<OrderLineItem>;
     getBasicPromotionStruct(salesChannelId?: string, overrides?: Partial<Promotion>): Partial<Promotion>;
 }
 
@@ -1243,4 +1251,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

@@ -89,35 +89,39 @@ declare class MailpitApiContext {
      */
     getEmailHeaders(email: string): Promise<Email>;
     /**
-     * Retrieves the body content of the latest email as an HTML string.
-     * @returns The HTML content of the latest email.
+     * Retrieves the body content of the email as an HTML string.
+     * @param email - The email address of the recipient.
+     * @returns A promise that resolves to the HTML content of the email.
      */
-    getEmailBody(): Promise<string>;
+    getEmailBody(email: string): Promise<string>;
     /**
      * Generates the full email content, combining headers and body.
      * @param email - The email address to fetch headers for.
-     * @returns The full email content as a string.
+     * @returns A promise that resolves to the full email content as a string.
      */
     generateEmailContent(email: string): Promise<string>;
     /**
-     * Retrieves the plain text content of the latest email.
-     * @returns The plain text content of the latest email.
+     * Retrieves the plain text content of the email.
+     * @param email - The email address of the recipient.
+     * @returns A promise that resolves to the plain text content of the email.
      */
-    getRenderMessageTxt(): Promise<string>;
+    getRenderMessageTxt(email: string): Promise<string>;
     /**
      * Extracts the first URL found in the plain text content of the latest email.
-     * @returns The first URL found in the email content.
+     * @param email - The email address of the recipient.
+     * @returns A promise that resolves to the first URL found in the email content.
      * @throws An error if no URL is found in the email content.
      */
-    getLinkFromMail(): Promise<string>;
+    getLinkFromMail(email: string): Promise<string>;
     /**
      * Deletes a specific email by ID if provided, or deletes all emails if no ID is provided.
      * @param emailId - The ID of the email to delete (optional).
      */
     deleteMail(emailId?: string): Promise<void>;
     /**
-     * Creates a new EmailApiContext instance with the appropriate configuration.
-     * @returns A promise that resolves to an EmailApiContext instance.
+     * Creates a new MailpitApiContext instance with the appropriate configuration.
+     * @param baseURL - The base URL for the API.
+     * @returns A promise that resolves to a MailpitApiContext instance.
      */
     static create(baseURL: string): Promise<MailpitApiContext>;
 }
@@ -281,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;
@@ -290,6 +297,7 @@ interface SimpleLineItem {
     product: Product | Promotion;
     quantity?: number;
     position?: number;
+    overrides?: Partial<OrderLineItem>;
 }
 interface SyncApiOperation {
     entity: string;
@@ -639,7 +647,7 @@ declare class TestDataService {
             isCalculated: boolean;
             referencePriceDefinition: null;
         };
-    };
+    } & Partial<OrderLineItem>;
     getBasicPromotionLineItemStruct(lineItem: SimpleLineItem): {
         payload: {
             code: string | undefined;
@@ -669,7 +677,7 @@ declare class TestDataService {
             price: number;
             percentage: number | null;
         };
-    };
+    } & Partial<OrderLineItem>;
     getBasicPromotionStruct(salesChannelId?: string, overrides?: Partial<Promotion>): Partial<Promotion>;
 }
 
@@ -1243,4 +1251,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

@@ -579,33 +579,35 @@ class MailpitApiContext {
       }
     });
     const responseJson = await response.json();
+    const message = responseJson.messages[0];
     return {
-      fromName: responseJson.messages[0].From.Name,
-      fromAddress: responseJson.messages[0].From.Address,
-      toName: responseJson.messages[0].To[0].Name,
-      toAddress: responseJson.messages[0].To[0].Address,
-      subject: responseJson.messages[0].Subject,
-      emailId: responseJson.messages[0].ID
+      fromName: message.From.Name,
+      fromAddress: message.From.Address,
+      toName: message.To[0].Name,
+      toAddress: message.To[0].Address,
+      subject: message.Subject,
+      emailId: message.ID
     };
   }
   /**
-   * Retrieves the body content of the latest email as an HTML string.
-   * @returns The HTML content of the latest email.
+   * Retrieves the body content of the email as an HTML string.
+   * @param email - The email address of the recipient.
+   * @returns A promise that resolves to the HTML content of the email.
    */
-  async getEmailBody() {
-    const response = await this.context.get("view/latest.html");
+  async getEmailBody(email) {
+    const emailId = (await this.getEmailHeaders(email)).emailId;
+    const response = await this.context.get(`view/${emailId}.html`);
     const buffer = await response.body();
-    const htmlString = buffer.toString("utf-8");
-    return htmlString;
+    return buffer.toString("utf-8");
   }
   /**
    * Generates the full email content, combining headers and body.
    * @param email - The email address to fetch headers for.
-   * @returns The full email content as a string.
+   * @returns A promise that resolves to the full email content as a string.
    */
   async generateEmailContent(email) {
     const headers = await this.getEmailHeaders(email);
-    const htmlTemplate = await this.getEmailBody();
+    const htmlTemplate = await this.getEmailBody(email);
     const headerSection = `
        <div style="font-family:arial; font-size:16px;" id="email-container">
         <p id="from"><strong>From:</strong> ${headers.fromName} &lt;${headers.fromAddress}&gt;</p>
@@ -613,28 +615,29 @@ class MailpitApiContext {
         <p id="subject"><strong>Subject:</strong> ${headers.subject}</p>
       </div> 
     `;
-    const emailContent = headerSection + htmlTemplate;
-    return emailContent;
+    return headerSection + htmlTemplate;
   }
   /**
-   * Retrieves the plain text content of the latest email.
-   * @returns The plain text content of the latest email.
+   * Retrieves the plain text content of the email.
+   * @param email - The email address of the recipient.
+   * @returns A promise that resolves to the plain text content of the email.
    */
-  async getRenderMessageTxt() {
-    const response = await this.context.get("view/latest.txt");
+  async getRenderMessageTxt(email) {
+    const emailId = (await this.getEmailHeaders(email)).emailId;
+    const response = await this.context.get(`view/${emailId}.txt`);
     const buffer = await response.body();
-    const text = buffer.toString("utf-8");
-    return text;
+    return buffer.toString("utf-8");
   }
   /**
    * Extracts the first URL found in the plain text content of the latest email.
-   * @returns The first URL found in the email content.
+   * @param email - The email address of the recipient.
+   * @returns A promise that resolves to the first URL found in the email content.
    * @throws An error if no URL is found in the email content.
    */
-  async getLinkFromMail() {
-    const textContent = await this.getRenderMessageTxt();
+  async getLinkFromMail(email) {
+    const textContent = await this.getRenderMessageTxt(email);
     const urlMatch = textContent.match(/https?:\/\/[^\s]+/);
-    if (urlMatch && urlMatch.length > 0) {
+    if (urlMatch) {
       return urlMatch[0];
     }
     throw new Error("No URL found in the email content");
@@ -648,8 +651,9 @@ class MailpitApiContext {
     await this.context.delete(`api/v1/messages`, { data });
   }
   /**
-   * Creates a new EmailApiContext instance with the appropriate configuration.
-   * @returns A promise that resolves to an EmailApiContext instance.
+   * Creates a new MailpitApiContext instance with the appropriate configuration.
+   * @param baseURL - The base URL for the API.
+   * @returns A promise that resolves to a MailpitApiContext instance.
    */
   static async create(baseURL) {
     const extraHTTPHeaders = {
@@ -1927,7 +1931,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: {
@@ -1965,6 +1969,7 @@ class TestDataService {
         referencePriceDefinition: null
       }
     };
+    return Object.assign({}, basicProductLineItemStruct, lineItem.overrides);
   }
   getBasicPromotionLineItemStruct(lineItem) {
     if (!this.isPromotion(lineItem.product)) {
@@ -1976,7 +1981,7 @@ class TestDataService {
     const promotionDiscountId = promotion.discounts[0].id;
     const unitPrice = -Math.abs(promotionDiscountValue || 10);
     const totalPrice = unitPrice * (lineItem.quantity || 1);
-    return {
+    const basicPromotionLineItemStruct = {
       payload: {
         code: promotion.code
       },
@@ -2006,6 +2011,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}`;

package/package.json

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