Migrate @pages/BO/orders/view/paymentsBlock from Core

src/index.ts

@@ -248,6 +248,7 @@ export {default as boOrdersCreatePage} from '@pages/BO/orders/create';
 export {default as boOrdersViewBasePage} from '@pages/BO/orders/view/viewOrderBasePage';
 export {default as boOrdersViewBlockCustomersPage} from '@pages/BO/orders/view/blockCustomers';
 export {default as boOrdersViewBlockMessagesPage} from '@pages/BO/orders/view/blockMessages';
+export {default as boOrdersViewBlockPaymentsPage} from '@pages/BO/orders/view/blockPayments';
 export {default as boOrdersViewBlockProductsPage} from '@pages/BO/orders/view/blockProducts';
 export {default as boOrdersViewBlockTabListPage} from '@pages/BO/orders/view/blockTabList';
 export {default as boOrderSettingsPage} from '@pages/BO/shopParameters/orderSettings';

src/interfaces/BO/orders/view/blockPayments.ts

@@ -0,0 +1,20 @@
+import {type OrderPayment} from '@data/types/order';
+import {BOViewOrderBasePageInterface} from '@interfaces/BO/orders/view/viewOrderBasePage';
+import {type Frame, type Page} from '@playwright/test';
+
+export interface BOProductBlockPaymentsPageInterface extends BOViewOrderBasePageInterface {
+  addPayment(page: Page, paymentData: OrderPayment, invoice?: string): Promise<string>;
+  displayPaymentDetail(page: Page, row?: number): Promise<string>;
+  getCurrencySelectOptions(page: Page): Promise<string>;
+  getInvoiceID(page: Page, row?: number): Promise<number>;
+  getPaymentAmountInputValue(page: Page): Promise<string>;
+  getPaymentsDetails(page: Page, row?: number): Promise<{
+    date: string,
+    amount: string,
+    paymentMethod: string,
+    invoice: string,
+    transactionID: string,
+  }>;
+  getPaymentsNumber(page: Page): Promise<number>;
+  getPaymentWarning(page: Page): Promise<string>;
+}

src/pages/BO/orders/view/blockPayments.ts

@@ -0,0 +1,9 @@
+import {type BOProductBlockPaymentsPageInterface} from '@interfaces/BO/orders/view/blockPayments';
+
+/* eslint-disable global-require, @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires */
+function requirePage(): BOProductBlockPaymentsPageInterface {
+  return require('@versions/develop/pages/BO/orders/view/blockPayments');
+}
+/* eslint-enable global-require, @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires */
+
+export default requirePage();

src/versions/develop/pages/BO/orders/view/blockPayments.ts

@@ -0,0 +1,179 @@
+import {type OrderPayment} from '@data/types/order';
+import {type BOProductBlockPaymentsPageInterface} from '@interfaces/BO/orders/view/blockPayments';
+import {type Page} from '@playwright/test';
+import {ViewOrderBasePage} from '@versions/develop/pages/BO/orders/view/viewOrderBasePage';
+
+/**
+ * Payment block, contains functions that can be used on view/edit payment block on view order page
+ * @class
+ * @extends ViewOrderBasePage
+ */
+class BOProductBlockPaymentsPage extends ViewOrderBasePage implements BOProductBlockPaymentsPageInterface {
+  private readonly orderPaymentsBlock: string;
+
+  private readonly orderPaymentsTitle: string;
+
+  private readonly paymentDateInput: string;
+
+  private readonly paymentMethodInput: string;
+
+  private readonly transactionIDInput: string;
+
+  private readonly paymentAmountInput: string;
+
+  private readonly paymentCurrencySelect: string;
+
+  private readonly paymentInvoiceSelect: string;
+
+  private readonly paymentAddButton: string;
+
+  private readonly paymentWarning: string;
+
+  private readonly paymentsGridTable: string;
+
+  private readonly paymentsTableBody: string;
+
+  private readonly paymentsTableRow: (row: number) => string;
+
+  private readonly paymentsTableColumn: (row: number, column: string) => string;
+
+  private readonly paymentsTableDetailsButton: (row: number) => string;
+
+  private readonly paymentTableRowDetails: (row: number) => string;
+
+  /**
+   * @constructs
+   * Setting up texts and selectors to use on payment block
+   */
+  constructor() {
+    super();
+
+    // Payment block
+    this.orderPaymentsBlock = '#view_order_payments_block';
+    this.orderPaymentsTitle = `${this.orderPaymentsBlock} .card-header-title`;
+    this.paymentDateInput = '#order_payment_date';
+    this.paymentMethodInput = '#order_payment_payment_method';
+    this.transactionIDInput = '#order_payment_transaction_id';
+    this.paymentAmountInput = '#order_payment_amount_currency_amount';
+    this.paymentCurrencySelect = '#order_payment_amount_currency_id_currency';
+    this.paymentInvoiceSelect = '#order_payment_id_invoice';
+    this.paymentAddButton = `${this.orderPaymentsBlock} .btn.btn-primary.btn-sm`;
+    this.paymentWarning = `${this.orderPaymentsBlock} .alert-danger`;
+    this.paymentsGridTable = 'table[data-role=\'payments-grid-table\']';
+    this.paymentsTableBody = `${this.paymentsGridTable} tbody`;
+    this.paymentsTableRow = (row: number) => `${this.paymentsTableBody} tr:nth-child(${row})`;
+    this.paymentsTableColumn = (row: number, column: string) => `${this.paymentsTableRow(row)} td[data-role='${column}-column']`;
+    this.paymentsTableDetailsButton = (row: number) => `${this.paymentsTableRow(row)} button.js-payment-details-btn`;
+    this.paymentTableRowDetails = (row: number) => `${this.paymentsTableRow(row)}[data-role='payment-details']`;
+  }
+
+  /*
+  Methods
+   */
+  /**
+   * Get payments number
+   * @param page {Page} Browser tab
+   * @returns {Promise<number>}
+   */
+  async getPaymentsNumber(page: Page): Promise<number> {
+    return this.getNumberFromText(page, this.orderPaymentsTitle);
+  }
+
+  /**
+   * Get payment input value
+   * @param page {Page} Browser tab
+   * @returns {*}
+   */
+  async getPaymentAmountInputValue(page: Page): Promise<string> {
+    return page.locator(this.paymentAmountInput).evaluate((el: HTMLInputElement) => el.value);
+  }
+
+  /**
+   * Add payment
+   * @param page {Page} Browser tab
+   * @param paymentData {OrderPayment} Data to set on payment line
+   * @param invoice {string} Invoice number to select
+   * @returns {Promise<string>}
+   */
+  async addPayment(page: Page, paymentData: OrderPayment, invoice: string = ''): Promise<string> {
+    await this.setValue(page, this.paymentDateInput, paymentData.date);
+    await this.setValue(page, this.paymentMethodInput, paymentData.paymentMethod);
+    await this.setValue(page, this.transactionIDInput, paymentData.transactionID.toString());
+    await this.setValue(page, this.paymentAmountInput, paymentData.amount.toString());
+    if (paymentData.currency !== '€') {
+      await this.selectByVisibleText(page, this.paymentCurrencySelect, paymentData.currency);
+    }
+
+    if (invoice !== '') {
+      await this.selectByVisibleText(page, this.paymentInvoiceSelect, invoice);
+    }
+
+    await page.locator(this.paymentAddButton).click();
+
+    return this.getAlertSuccessBlockParagraphContent(page);
+  }
+
+  /**
+   * Get invoice ID
+   * @param page {Page} Browser tab
+   * @param row {number} Row on table
+   * @returns {Promise<number>}
+   */
+  async getInvoiceID(page: Page, row: number = 1): Promise<number> {
+    return this.getNumberFromText(page, this.paymentsTableColumn(row, 'invoice'));
+  }
+
+  /**
+   * Get payment warning
+   * @param page {Page} Browser tab
+   * @returns {Promise<string>}
+   */
+  async getPaymentWarning(page: Page): Promise<string> {
+    return this.getTextContent(page, this.paymentWarning);
+  }
+
+  /**
+   * Get payment details
+   * @param page {Page} Browser tab
+   * @param row {number} Row on table
+   * @returns {Promise<{date: string, amount: string, paymentMethod: string, invoice: string, transactionID: string}>}
+   */
+  async getPaymentsDetails(page: Page, row: number = 1): Promise<{
+    date: string,
+    amount: string,
+    paymentMethod: string,
+    invoice: string,
+    transactionID: string,
+  }> {
+    return {
+      date: await this.getTextContent(page, this.paymentsTableColumn(row, 'date')),
+      paymentMethod: await this.getTextContent(page, this.paymentsTableColumn(row, 'payment-method')),
+      transactionID: await this.getTextContent(page, this.paymentsTableColumn(row, 'transaction-id')),
+      amount: await this.getTextContent(page, this.paymentsTableColumn(row, 'amount')),
+      invoice: await this.getTextContent(page, this.paymentsTableColumn(row, 'invoice')),
+    };
+  }
+
+  /**
+   * Display payment details
+   * @param page {Page} Browser tab
+   * @param row {number} Row on table - Start by 2
+   * @returns {Promise<string>}
+   */
+  async displayPaymentDetail(page: Page, row: number = 2): Promise<string> {
+    await this.waitForSelectorAndClick(page, this.paymentsTableDetailsButton(row - 1));
+
+    return this.getTextContent(page, this.paymentTableRowDetails(row));
+  }
+
+  /**
+   * Get currency select options
+   * @param page {Page} Browser tab
+   * @returns {Promise<string>}
+   */
+  async getCurrencySelectOptions(page: Page): Promise<string> {
+    return this.getTextContent(page, this.paymentCurrencySelect);
+  }
+}
+
+module.exports = new BOProductBlockPaymentsPage();