@djust-b2b/djust-front-sdk 2.0.0 → 2.1.0

package/lib/interfaces/models/common.d.ts

@@ -54,3 +54,14 @@ export interface DjustConfig {
     storeId?: string;
     storeViewId?: string;
 }
+export interface BrowserInfo {
+    acceptHeader: string;
+    colorDepth: number;
+    javaEnabled: boolean;
+    javaScriptEnabled: boolean;
+    language: string;
+    screenHeight: number;
+    screenWidth: number;
+    timeZoneOffset: number;
+    userAgent: string;
+}

package/lib/interfaces/models/payment.d.ts

@@ -1,6 +1,7 @@
 export type PaymentType = "ON_ACCEPTANCE" | "DUE_DATE";
 export type PaymentOption = "BANK_WIRE" | "BANK_WIRE_ON_DUE_DATE" | "CREDIT_CARD" | "DIRECT_PAYMENT" | "BANK_WIRE_ON_ACCEPTANCE";
 export type PaymentStatus = "AUTHORIZED" | "WAITING_AUTHORIZATION" | "WAITING_PAYMENT" | "PAID" | "PARTIALLY_PAID" | "OVER_PAID" | "REFUSED" | "WAITING_REFUND" | "PARTIALLY_REFUNDED" | "REFUNDED";
+export type PaymentReferenceType = "LOGISTIC" | "COMMERCIAL";
 type PaymentDueDateMode = "SIMPLE" | "END_OF_MONTH";
 export type PaymentProvider = "MANGOPAY" | "THUNES" | "LEMONWAY";
 export interface PaymentDueDate {

package/lib/services/payment/definitions.d.ts

@@ -0,0 +1,61 @@
+import { BrowserInfo } from "../../interfaces/models/common";
+import { PaymentReferenceType } from "../../interfaces/models/payment";
+/**
+ * Request parameters type definitions
+ */
+export interface GetCommercialOrdersParameters {
+    locale: string;
+    nbPreviewLines?: number;
+    page?: number;
+    size?: number;
+    sort?: string[];
+    connectedUserOnly?: boolean;
+    customerAccountIds?: string[];
+    isValidated?: boolean;
+}
+export interface InitPaymentRequest {
+    bankTransfer?: boolean;
+    browserInfo: BrowserInfo;
+    commercialOrder?: boolean;
+    countryCode: string;
+    customerUserIP: string;
+    paymentMethodData: object;
+    reference: string;
+    referenceType?: PaymentReferenceType;
+    returnPath: string;
+    storePaymentMethod?: boolean;
+}
+export interface InitPaymentResponse {
+    action: {
+        type: string;
+        beneficiary: string;
+        bic: string;
+        iban: string;
+        paymentMethodType: string;
+        totalAmountCurrency: string;
+        totalAmountValue: number;
+        url: string;
+    };
+    pspReference: string;
+    resultCode: string;
+}
+export interface AddPaymentDetailsRequest {
+    details: string;
+}
+export interface AddPaymentDetailsResponse {
+    pspReference: string;
+    resultCode: string;
+}
+export interface GetPaymentMethodsRequest {
+    reference: string;
+    countryCode?: string;
+    referenceType?: PaymentReferenceType;
+    locale?: string;
+}
+export interface GetPaymentMethodsResponse {
+    adyenPaymentMethods: string;
+    enableCreditCardStorage: boolean;
+}
+export interface DeleteStoredPaymentMethodByIdRequest {
+    storedPaymentMethodId: string;
+}

package/lib/services/payment/definitions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/services/payment/index.d.ts

@@ -0,0 +1,132 @@
+import { AddPaymentDetailsRequest, AddPaymentDetailsResponse, DeleteStoredPaymentMethodByIdRequest, GetPaymentMethodsRequest, GetPaymentMethodsResponse, InitPaymentRequest, InitPaymentResponse } from "./definitions";
+/**
+ * 💳 Initializes a payment transaction.
+ *
+ * This endpoint initializes a payment transaction.
+ * It supports:
+ * - Card authorizations with or without 3D Secure (3DS).
+ * - 3DS authentication flows, including redirection steps if required.
+ * - Bank transfer payment initialization using virtual IBAN feature.
+ *
+ * The response indicates the result of the transaction attempt and may contain an action
+ * (such as a redirection or bank transfer instructions) that must be followed to complete the payment.
+ *
+ * 🛠 **Endpoint**: `POST /v1/shop/payments` [PAY-101]
+ *
+ * | Parameter           | Type                | Required | Description                                    |
+ * |---------------------|---------------------|----------|------------------------------------------------|
+ * | `bankTransfer`      | `BankTransfer`      | ✅       | Bank transfer configuration.                  |
+ * | `browserInfo`       | `BrowserInfo`       | ✅       | Browser information for 3DS authentication.   |
+ * | `commercialOrder`   | `CommercialOrder`   | ❌       | Commercial order details.                     |
+ * | `countryCode`       | `string`            | ✅       | Country code for payment processing.          |
+ * | `customerUserIP`    | `string`            | ✅       | Customer's IP address.                        |
+ * | `paymentMethodData` | `PaymentMethodData` | ✅       | Payment method configuration.                 |
+ * | `reference`         | `string`            | ✅       | Payment reference identifier.                 |
+ * | `referenceType`     | `string`            | ❌       | Type of reference.                            |
+ * | `returnPath`        | `string`            | ✅       | Return URL after payment completion.          |
+ * | `storePaymentMethod`| `boolean`           | ❌       | Whether to store the payment method.          |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to an `InitPaymentResponse` containing the payment initialization result.
+ *
+ *  🛠 **Example usage**:
+ * ```ts
+ * const response = await initPayment({
+ *   bankTransfer: false,
+ *   browserInfo: {
+ *     acceptHeader: "......",
+ *     colorDepth: 24,
+ *     javaEnabled: true,
+ *     javaScriptEnabled: true,
+ *     language: "en-US",
+ *     screenHeight: 1080,
+ *     screenWidth: 1920,
+ *     timeZoneOffset: 0,
+ *     userAgent: "......",
+ *   },
+ *   commercialOrder: false,
+ *   countryCode: "FR",
+ *   customerUserIP: "127.0.0.1",
+ *   paymentMethodData: {
+ *     description: "......",
+ *   },
+ *   reference: "......",
+ *   referenceType: "......",
+ *   returnPath: "......",
+ *   storePaymentMethod: true,
+ * });
+ * console.log(response);
+ *
+ * ```
+ *
+ * @param {InitPaymentRequest} params - The parameters for the payment initialization
+ * @throws {Error} If required parameters are missing
+ * @returns {Promise<InitPaymentResponse>} A promise resolving to the payment initialization response
+ */
+export declare function initPayment({ bankTransfer, browserInfo, commercialOrder, countryCode, customerUserIP, paymentMethodData, reference, referenceType, returnPath, storePaymentMethod, }: InitPaymentRequest): Promise<InitPaymentResponse>;
+/**
+ * 💳 Adds payment details.
+ *
+ * This function adds additional details to an existing payment transaction.
+ * The `details` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `POST /v1/shop/payments/details` [PAY-102]
+ *
+ * | Parameter | Type     | Required | Description                    |
+ * |-----------|----------|----------|--------------------------------|
+ * | `details` | `object` | ✅       | The payment details to add.    |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to an `AddPaymentDetailsResponse` containing the result of adding payment details.
+ *
+ * @param {AddPaymentDetailsRequest} params - The parameters for adding payment details
+ * @throws {Error} If `details` is missing
+ * @returns {Promise<AddPaymentDetailsResponse>} A promise resolving to the response containing the result
+ */
+export declare function addPaymentDetails({ details, }: AddPaymentDetailsRequest): Promise<AddPaymentDetailsResponse>;
+/**
+ * 💳 Gets available payment methods.
+ *
+ * This endpoint retrieves the available payment methods based on the country, locale, amount, and currency.
+ * It provides a list of payment methods that can be used for checkout based on the merchant's Adyen configuration.
+ * The `reference` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/payments/methods` [PAY-501]
+ *
+ * | Parameter      | Type     | Required | Description                                    |
+ * |----------------|----------|----------|------------------------------------------------|
+ * | `reference`    | `string` | ✅       | The payment reference identifier.             |
+ * | `countryCode`  | `string` | ❌       | The country code for payment method filtering.|
+ * | `referenceType`| `string` | ❌       | The type of reference.                        |
+ * | `locale`       | `string` | ❌       | The locale for payment method localization.   |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetPaymentMethodsResponse` containing the available payment methods.
+ *
+ * @param {GetPaymentMethodsRequest} params - The parameters for retrieving payment methods
+ * @throws {Error} If `reference` is missing
+ * @returns {Promise<GetPaymentMethodsResponse>} A promise resolving to the response containing available payment methods
+ */
+export declare function getPaymentMethods({ reference, countryCode, referenceType, locale, }: GetPaymentMethodsRequest): Promise<GetPaymentMethodsResponse>;
+/**
+ * 💳 Deletes a stored payment method.
+ *
+ * This endpoint deletes a stored payment method (e.g., saved card) associated with the current shopper.
+ * It is intended for use on the storefront. If the specified ID does not exist or does not belong
+ * to the authenticated user, a 404 will be returned.
+ * The `storedPaymentMethodId` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `DELETE /v1/shop/payments/stored-payment-methods/{storedPaymentMethodId}` [PAY-300]
+ *
+ * | Parameter              | Type     | Required | Description                                    |
+ * |------------------------|----------|----------|------------------------------------------------|
+ * | `storedPaymentMethodId`| `string` | ✅       | The ID of the stored payment method to delete.|
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to `void` when the stored payment method is successfully deleted.
+ *
+ * @param {DeleteStoredPaymentMethodByIdRequest} params - The parameters for deleting the stored payment method
+ * @throws {Error} If `storedPaymentMethodId` is missing
+ * @returns {Promise<void>} A promise resolving when the stored payment method is successfully deleted
+ */
+export declare function deleteStoredPaymentMethodById({ storedPaymentMethodId, }: DeleteStoredPaymentMethodByIdRequest): Promise<void>;

package/lib/services/payment/index.js

@@ -0,0 +1,195 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initPayment = initPayment;
+exports.addPaymentDetails = addPaymentDetails;
+exports.getPaymentMethods = getPaymentMethods;
+exports.deleteStoredPaymentMethodById = deleteStoredPaymentMethodById;
+const parameters_validation_1 = require("../../helpers/parameters-validation");
+const fetch_instance_1 = require("../../settings/fetch-instance");
+/**
+ * 💳 Initializes a payment transaction.
+ *
+ * This endpoint initializes a payment transaction.
+ * It supports:
+ * - Card authorizations with or without 3D Secure (3DS).
+ * - 3DS authentication flows, including redirection steps if required.
+ * - Bank transfer payment initialization using virtual IBAN feature.
+ *
+ * The response indicates the result of the transaction attempt and may contain an action
+ * (such as a redirection or bank transfer instructions) that must be followed to complete the payment.
+ *
+ * 🛠 **Endpoint**: `POST /v1/shop/payments` [PAY-101]
+ *
+ * | Parameter           | Type                | Required | Description                                    |
+ * |---------------------|---------------------|----------|------------------------------------------------|
+ * | `bankTransfer`      | `BankTransfer`      | ✅       | Bank transfer configuration.                  |
+ * | `browserInfo`       | `BrowserInfo`       | ✅       | Browser information for 3DS authentication.   |
+ * | `commercialOrder`   | `CommercialOrder`   | ❌       | Commercial order details.                     |
+ * | `countryCode`       | `string`            | ✅       | Country code for payment processing.          |
+ * | `customerUserIP`    | `string`            | ✅       | Customer's IP address.                        |
+ * | `paymentMethodData` | `PaymentMethodData` | ✅       | Payment method configuration.                 |
+ * | `reference`         | `string`            | ✅       | Payment reference identifier.                 |
+ * | `referenceType`     | `string`            | ❌       | Type of reference.                            |
+ * | `returnPath`        | `string`            | ✅       | Return URL after payment completion.          |
+ * | `storePaymentMethod`| `boolean`           | ❌       | Whether to store the payment method.          |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to an `InitPaymentResponse` containing the payment initialization result.
+ *
+ *  🛠 **Example usage**:
+ * ```ts
+ * const response = await initPayment({
+ *   bankTransfer: false,
+ *   browserInfo: {
+ *     acceptHeader: "......",
+ *     colorDepth: 24,
+ *     javaEnabled: true,
+ *     javaScriptEnabled: true,
+ *     language: "en-US",
+ *     screenHeight: 1080,
+ *     screenWidth: 1920,
+ *     timeZoneOffset: 0,
+ *     userAgent: "......",
+ *   },
+ *   commercialOrder: false,
+ *   countryCode: "FR",
+ *   customerUserIP: "127.0.0.1",
+ *   paymentMethodData: {
+ *     description: "......",
+ *   },
+ *   reference: "......",
+ *   referenceType: "......",
+ *   returnPath: "......",
+ *   storePaymentMethod: true,
+ * });
+ * console.log(response);
+ *
+ * ```
+ *
+ * @param {InitPaymentRequest} params - The parameters for the payment initialization
+ * @throws {Error} If required parameters are missing
+ * @returns {Promise<InitPaymentResponse>} A promise resolving to the payment initialization response
+ */
+async function initPayment({ bankTransfer, browserInfo, commercialOrder, countryCode, customerUserIP, paymentMethodData, reference, referenceType, returnPath, storePaymentMethod, }) {
+    (0, parameters_validation_1.required)({
+        bankTransfer,
+        browserInfo,
+        countryCode,
+        customerUserIP,
+        paymentMethodData,
+        reference,
+        returnPath,
+    });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "POST",
+        path: `/v1/shop/payments`,
+        body: JSON.stringify({
+            bankTransfer,
+            browserInfo,
+            commercialOrder,
+            countryCode,
+            customerUserIP,
+            paymentMethodData,
+            reference,
+            referenceType,
+            returnPath,
+            storePaymentMethod,
+        }),
+    });
+    return data;
+}
+/**
+ * 💳 Adds payment details.
+ *
+ * This function adds additional details to an existing payment transaction.
+ * The `details` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `POST /v1/shop/payments/details` [PAY-102]
+ *
+ * | Parameter | Type     | Required | Description                    |
+ * |-----------|----------|----------|--------------------------------|
+ * | `details` | `object` | ✅       | The payment details to add.    |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to an `AddPaymentDetailsResponse` containing the result of adding payment details.
+ *
+ * @param {AddPaymentDetailsRequest} params - The parameters for adding payment details
+ * @throws {Error} If `details` is missing
+ * @returns {Promise<AddPaymentDetailsResponse>} A promise resolving to the response containing the result
+ */
+async function addPaymentDetails({ details, }) {
+    (0, parameters_validation_1.required)({ details });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "POST",
+        path: `/v1/shop/payments/details`,
+        body: JSON.stringify({
+            details,
+        }),
+    });
+    return data;
+}
+/**
+ * 💳 Gets available payment methods.
+ *
+ * This endpoint retrieves the available payment methods based on the country, locale, amount, and currency.
+ * It provides a list of payment methods that can be used for checkout based on the merchant's Adyen configuration.
+ * The `reference` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/payments/methods` [PAY-501]
+ *
+ * | Parameter      | Type     | Required | Description                                    |
+ * |----------------|----------|----------|------------------------------------------------|
+ * | `reference`    | `string` | ✅       | The payment reference identifier.             |
+ * | `countryCode`  | `string` | ❌       | The country code for payment method filtering.|
+ * | `referenceType`| `string` | ❌       | The type of reference.                        |
+ * | `locale`       | `string` | ❌       | The locale for payment method localization.   |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetPaymentMethodsResponse` containing the available payment methods.
+ *
+ * @param {GetPaymentMethodsRequest} params - The parameters for retrieving payment methods
+ * @throws {Error} If `reference` is missing
+ * @returns {Promise<GetPaymentMethodsResponse>} A promise resolving to the response containing available payment methods
+ */
+async function getPaymentMethods({ reference, countryCode, referenceType, locale, }) {
+    (0, parameters_validation_1.required)({ reference });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v1/shop/payments/methods`,
+        params: {
+            reference,
+            countryCode,
+            referenceType,
+            locale,
+        },
+    });
+    return data;
+}
+/**
+ * 💳 Deletes a stored payment method.
+ *
+ * This endpoint deletes a stored payment method (e.g., saved card) associated with the current shopper.
+ * It is intended for use on the storefront. If the specified ID does not exist or does not belong
+ * to the authenticated user, a 404 will be returned.
+ * The `storedPaymentMethodId` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `DELETE /v1/shop/payments/stored-payment-methods/{storedPaymentMethodId}` [PAY-300]
+ *
+ * | Parameter              | Type     | Required | Description                                    |
+ * |------------------------|----------|----------|------------------------------------------------|
+ * | `storedPaymentMethodId`| `string` | ✅       | The ID of the stored payment method to delete.|
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to `void` when the stored payment method is successfully deleted.
+ *
+ * @param {DeleteStoredPaymentMethodByIdRequest} params - The parameters for deleting the stored payment method
+ * @throws {Error} If `storedPaymentMethodId` is missing
+ * @returns {Promise<void>} A promise resolving when the stored payment method is successfully deleted
+ */
+async function deleteStoredPaymentMethodById({ storedPaymentMethodId, }) {
+    (0, parameters_validation_1.required)({ storedPaymentMethodId });
+    await (0, fetch_instance_1.enhancedFetch)({
+        method: "DELETE",
+        path: `/v1/shop/payments/stored-payment-methods/${storedPaymentMethodId}`,
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@djust-b2b/djust-front-sdk",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "DJUST Front SDK is a versatile JavaScript Software Development Kit (SDK)",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",