@spreeloop/orange_money 1.0.7 → 1.0.9

package/src/disbursements/routes/routes.ts

@@ -1,54 +0,0 @@
-import { DisbursementXTargetEnvironmentType } from '../utils/constants';
-
-const apiHost = 'https://omapi.ynote.africa';
-const apiTokenHost = 'https://omapi-token.ynote.africa/oauth2/token';
-
-/**
- * Orange Money API routes builder.
- * @class
- */
-export class Routes {
-  /**
-   * Constructs a new {CommonRoutes}.
-   * @constructor
-   * @param {RoutesParams} config - The required global route configuration.
-   */
-
-  /**
-   * Returns the base route for the API.
-   *  e.g: https://docs.google.com/document/d/1h-gMj7PSGAALxRSofOvLa2g5vF3IpDkUufNrU1hX6Yk/edit?pli=1
-   * @return {string} The base route.
-   */
-  private baseRoute(): string {
-    return `${apiHost}/${DisbursementXTargetEnvironmentType.prod}`;
-  }
-
-  /**
-   * This route is used to create an access token which can then be used to authorize and authenticate towards the other end-points of the API.
-   * e.g : https://docs.google.com/document/d/1h-gMj7PSGAALxRSofOvLa2g5vF3IpDkUufNrU1hX6Yk/edit?pli=1 page 2
-   * @return {string}
-   */
-  createAccessToken(): string {
-    return apiTokenHost;
-  }
-
-  /**
-   * This route is used to transfer an amount from the owner’s account to a payee account (customer).
-   * e.g : https://docs.google.com/document/d/1h-gMj7PSGAALxRSofOvLa2g5vF3IpDkUufNrU1hX6Yk/edit?pli=1 page 4
-   * @return {string} - The transfer route.
-   */
-  transfer(): string {
-    return `${this.baseRoute()}/refund`;
-  }
-
-  /**
-   * This route is used to get the status of a transfer.
-   *
-   * @param {string} Id - The reference of the transfer.
-   * e.g : https://docs.google.com/document/d/1h-gMj7PSGAALxRSofOvLa2g5vF3IpDkUufNrU1hX6Yk/edit?pli=1  page 9
-   * @return {string} - The transfer status route.
-   */
-  transferStatus(Id: string): string {
-    return `${this.baseRoute()}/refund/status/${Id}`;
-  }
-}

package/src/disbursements/utils/constants.ts

@@ -1,4 +0,0 @@
-export enum DisbursementXTargetEnvironmentType {
-  sandbox = 'dev',
-  prod = 'prod',
-}

package/src/disbursements/utils/regex.spec.ts

@@ -1,39 +0,0 @@
-import {
-  merchantPhoneNumberRegex,
-  orangeMoneyPhoneNumberWithoutCountryCodeRegex,
-} from './regex';
-
-describe('Test regex merchant phone number', () => {
-  test('Merchant phone number regex matches valid numbers', () => {
-    const validNumbers = ['699947943', '237699947943'];
-    validNumbers.forEach((number) => {
-      expect(merchantPhoneNumberRegex.test(number)).toBe(true);
-    });
-  });
-
-  test('Merchant phone number regex does not match invalid numbers', () => {
-    const invalidNumbers = ['12345', '23712345', 'abc'];
-    invalidNumbers.forEach((number) => {
-      expect(merchantPhoneNumberRegex.test(number)).toBe(false);
-    });
-  });
-});
-describe('Test regex orange money phone number without country code', () => {
-  test('Oman phone number without country code regex matches valid numbers', () => {
-    const validNumbers = ['696512345', '696898765'];
-    validNumbers.forEach((number) => {
-      expect(orangeMoneyPhoneNumberWithoutCountryCodeRegex.test(number)).toBe(
-        true
-      );
-    });
-  });
-
-  test('Orange money phone number without country code regex does not match invalid numbers', () => {
-    const invalidNumbers = ['12345', '96812345', 'abc'];
-    invalidNumbers.forEach((number) => {
-      expect(orangeMoneyPhoneNumberWithoutCountryCodeRegex.test(number)).toBe(
-        false
-      );
-    });
-  });
-});

package/src/disbursements/utils/regex.ts

@@ -1,10 +0,0 @@
-/**
- * The merchant number regExp authorized for numbers by y-note.
- */
-export const merchantPhoneNumberRegex = /^(237)?(69\d{7}$|65[5-9]\d{6}$)/;
-
-/**
- * The orange money phone number regex for orange money numbers without the country code.
- */
-export const orangeMoneyPhoneNumberWithoutCountryCodeRegex =
-  /^(69\d{7}$|65[5-9]\d{6}$)/;

package/src/disbursements/utils/status.ts

@@ -1,62 +0,0 @@
-/**
- * The simplified version of transaction status.
- */
-export enum DisbursementStatus {
-  /**
-   * The transaction failed.
-   */
-  failed = 'FAILED',
-
-  /**
-   * The transaction is pending.
-   */
-  pending = 'PENDING',
-
-  /**
-   * The transaction succeeded.
-   */
-  succeeded = 'SUCCEEDED',
-
-  /**
-   * The status received from the endpoint was not recognized.
-   */
-  unknown = 'UNKNOWN',
-}
-
-export enum DisbursementApiRawStatus {
-  /**
-   * Transaction is in progress on Orange system.
-   */
-  pending = 'PENDING',
-
-  /**
-   * The user canceled the disbursement.
-   */
-  canceled = 'CANCELLED',
-
-  /**
-   * Waiting for user entry.
-   */
-  initialized = 'INITIATED',
-
-  /**
-   * Disbursement is done for mobile.
-   */
-  succeeded = 'SUCCESSFULL',
-
-  /**
-   * Disbursement is done for web.
-   */
-  succeeded2 = 'SUCCESS',
-
-  /**
-   * Disbursement failed.
-   */
-  failed = 'FAILED',
-
-  /**
-   * The token timed out.
-   * Note that the minimum token expiration time is 7 min.
-   */
-  expired = 'EXPIRED',
-}

package/src/disbursements/utils/utils.spec.ts

@@ -1,42 +0,0 @@
-import { DisbursementApiRawStatus, DisbursementStatus } from './status';
-import { getStatusFromProviderRawStatus } from './utils';
-
-describe('getStatusFromProviderRawStatus', () => {
-  test('should map raw status to disbursement status', () => {
-    const testCases = [
-      {
-        rawStatus: DisbursementApiRawStatus.pending,
-        expectedStatus: DisbursementStatus.pending,
-      },
-      {
-        rawStatus: DisbursementApiRawStatus.initialized,
-        expectedStatus: DisbursementStatus.pending,
-      },
-      {
-        rawStatus: DisbursementApiRawStatus.succeeded,
-        expectedStatus: DisbursementStatus.succeeded,
-      },
-      {
-        rawStatus: DisbursementApiRawStatus.succeeded2,
-        expectedStatus: DisbursementStatus.succeeded,
-      },
-      {
-        rawStatus: DisbursementApiRawStatus.canceled,
-        expectedStatus: DisbursementStatus.failed,
-      },
-      {
-        rawStatus: DisbursementApiRawStatus.expired,
-        expectedStatus: DisbursementStatus.failed,
-      },
-      {
-        rawStatus: DisbursementApiRawStatus.failed,
-        expectedStatus: DisbursementStatus.failed,
-      },
-    ];
-
-    testCases.forEach(({ rawStatus, expectedStatus }) => {
-      const result = getStatusFromProviderRawStatus(rawStatus);
-      expect(result).toBe(expectedStatus);
-    });
-  });
-});

package/src/disbursements/utils/utils.ts

@@ -1,24 +0,0 @@
-import { DisbursementApiRawStatus, DisbursementStatus } from './status';
-
-/**
- * Maps a raw status from the Disbursement API to a DisbursementStatus.
- *
- * @param {DisbursementApiRawStatus} rawStatus - The raw status from the Disbursement API.
- * @return {DisbursementStatus} The corresponding DisbursementStatus.
- */
-export function getStatusFromProviderRawStatus(
-  rawStatus: DisbursementApiRawStatus
-): DisbursementStatus {
-  switch (rawStatus) {
-    case DisbursementApiRawStatus.pending:
-    case DisbursementApiRawStatus.initialized:
-      return DisbursementStatus.pending;
-    case DisbursementApiRawStatus.succeeded:
-    case DisbursementApiRawStatus.succeeded2:
-      return DisbursementStatus.succeeded;
-    case DisbursementApiRawStatus.canceled:
-    case DisbursementApiRawStatus.expired:
-    case DisbursementApiRawStatus.failed:
-      return DisbursementStatus.failed;
-  }
-}

package/src/index.ts

@@ -1,12 +0,0 @@
-export { Disbursement } from './disbursements/implementations/disbursement_service';
-export { DisbursementXTargetEnvironmentType } from './disbursements/utils/constants';
-export { DisbursementInterface } from './disbursements/implementations/disbursement_service';
-export { DisbursementStatus } from './disbursements/utils/status';
-export {
-  OrangeMoneyPayment,
-  OrangeMoneyPaymentInterface,
-} from './payments/payments';
-export {
-  ApiErrorType,
-  OrangeMoneyPaymentStatus,
-} from './payments/utils/constants';

package/src/payments/implementations/fake.ts

@@ -1,133 +0,0 @@
-import { OrangeMoneyPaymentStatus } from '../utils/constants';
-import {
-  AccessTokenRequestResponse,
-  PayTokenRequestResponse,
-} from '../utils/joi_schema';
-import {
-  GetAccessTokenResponse,
-  GetOrangeMoneyPaymentRequest,
-  GetOrangeMoneyPaymentResponse,
-  InitializeOrangeMoneyRequest,
-  InitializeOrangeMoneyResponse,
-  GetPayTokenResponse,
-} from '../utils/request_model';
-import { OrangeMoneyPaymentInterface } from '../payments';
-
-const payTokenResponse: PayTokenRequestResponse = {
-  message: 'success',
-  data: {
-    payToken: 'MP220807558VEF7A9C4F09AED',
-  },
-};
-
-const mobileAccessTokenResponse: AccessTokenRequestResponse = {
-  access_token: '1e23bee1-37dc-3015-a7d6-cb70e566bd64',
-  token_type: 'bearer',
-  expires_in: 3600,
-  scope: 'read write',
-};
-
-/**
- * Implement the orange money fake payment.
- */
-export class OrangeMoneyPaymentFake implements OrangeMoneyPaymentInterface {
-  /**
-   * Generates a pay token using the provided access token.
-   *
-   * @return {Promise<GetPayTokenResponse>} A promise that resolves to the pay token response.
-   */
-  async getPayToken(): Promise<GetPayTokenResponse> {
-    return Promise.resolve({
-      raw: payTokenResponse,
-      data: 'MP220806C74C8F5787A9C4F79AED',
-    });
-  }
-
-  /**
-   * Generates an access token.
-   *
-   * @return {Promise<GetAccessTokenResponse>} the access token response
-   */
-  async getAccessToken(): Promise<GetAccessTokenResponse> {
-    return Promise.resolve({
-      raw: mobileAccessTokenResponse,
-      data: '1e23bee1-37dc-3015-a7d6-cb70e566bd64',
-    });
-  }
-  /**
-   * Retrieves The orange money payment status.
-   * @param {MobileParamsForCheckStatus} checkStatusParams the necessary parameters to get the mobile payment status.
-   * @return {GetOrangeMoneyPaymentResponse} the response who contains the payment state.
-   */
-  async getOrangeMoneyPaymentStatus(
-    checkStatusParams: GetOrangeMoneyPaymentRequest
-  ): Promise<GetOrangeMoneyPaymentResponse> {
-    return Promise.resolve({
-      raw: {
-        message: 'Transaction retrieved successfully',
-        data: {
-          id: 74581010,
-          createtime: '1682001669',
-          subscriberMsisdn: '655637944',
-          amount: 1100,
-          payToken: checkStatusParams.payToken,
-          txnid: 'MP230420.1541.C39196',
-          txnmode: 'zSapffVPWccheVZQRtvG',
-          inittxnmessage:
-            'Paiement e la clientele done.The devrez confirmer le paiement en saisissant son code PIN et vous recevrez alors un SMS. Merci dutiliser des services Orange Money.',
-          inittxnstatus: '200',
-          confirmtxnstatus: '200',
-          confirmtxnmessage:
-            'Paiement de SPREELOOP reussi par 655637944 PEKE. ID transaction:MP230420.1541.C39196, Montant:1100 FCFA. Solde: 55.81 FCFA.',
-          status: OrangeMoneyPaymentStatus.SUCCESSFULL_MOBILE_PAYMENT,
-          notifUrl:
-            'https://europe-west1-place-prod.cloudfunctions.net/api-1/payment/orange_money/live/zSapffVPWccheVZQRtvG',
-          description: 'Commande',
-          channelUserMsisdn: '696431937',
-        },
-      },
-      data: {
-        status: OrangeMoneyPaymentStatus.SUCCESSFULL_MOBILE_PAYMENT,
-      },
-    });
-  }
-
-  /**
-   * Initiates the orange money payment.
-   * @param {InitializeOrangeMoneyRequest} mobileInitParams the necessary parameters to initialize the mobile payment.
-   * @return {InitializeOrangeMoneyResponse} the response of initialization.
-   *
-   **/
-  async initializeOrangeMoneyPayment(
-    mobileInitParams: InitializeOrangeMoneyRequest
-  ): Promise<InitializeOrangeMoneyResponse> {
-    return Promise.resolve({
-      raw: {
-        message: 'Transaction retrieved successfully',
-        data: {
-          id: 74581010,
-          createtime: '1682001669',
-          subscriberMsisdn: '655637944',
-          amount: 1100,
-          payToken: mobileInitParams.payToken,
-          txnid: 'MP230420.1541.C39196',
-          txnmode: 'zSapffVPWccheVZQRtvG',
-          inittxnmessage:
-            'Paiement e la clientele done.The devrez confirmer le paiement en saisissant son code PIN et vous recevrez alors un SMS. Merci dutiliser des services Orange Money.',
-          inittxnstatus: '200',
-          confirmtxnstatus: '200',
-          confirmtxnmessage:
-            'Paiement de SPREELOOP reussi par 655637944 PEKE. ID transaction:MP230420.1541.C39196, Montant:1100 FCFA. Solde: 55.81 FCFA.',
-          status: OrangeMoneyPaymentStatus.PENDING_PAYMENT,
-          notifUrl:
-            'https://europe-west1-place-prod.cloudfunctions.net/api-1/payment/orange_money/live/zSapffVPWccheVZQRtvG',
-          description: 'Commande',
-          channelUserMsisdn: '696431937',
-        },
-      },
-      data: {
-        payToken: mobileInitParams.payToken,
-      },
-    });
-  }
-}

package/src/payments/implementations/live.ts

@@ -1,87 +0,0 @@
-import { getAccessToken } from '../operations/get_access_token';
-import { getPayToken } from '../operations/get_pay_token';
-import { getPaymentStatus } from '../operations/get_payment_status';
-import { OrangeMoneyPaymentParams } from '../utils/joi_schema';
-
-import { initializeOmPayment } from '../operations/initialize_om_payment';
-import { OrangeMoneyPaymentInterface } from '../payments';
-import { Routes } from '../routes/routes';
-import {
-  GetAccessTokenResponse,
-  GetOrangeMoneyPaymentRequest,
-  GetOrangeMoneyPaymentResponse,
-  GetPayTokenResponse,
-  InitializeOrangeMoneyRequest,
-  InitializeOrangeMoneyResponse,
-} from '../utils/request_model';
-
-/**
- * Implements the orange money live payment.
- */
-export class OrangeMoneyPaymentLive implements OrangeMoneyPaymentInterface {
-  protected readonly config: OrangeMoneyPaymentParams;
-  protected readonly route: Routes;
-
-  /**
-   * Creates a new instance of the PaymentConfig class.
-   *
-   * @param {PaymentConfig} config - The configuration for the PaymentConfig instance.
-   */
-  constructor(config: OrangeMoneyPaymentParams) {
-    this.config = config;
-    this.route = new Routes(config.orangeMoneyVersion);
-  }
-
-  /**
-   * Gets a pay token using the provided access token.
-   *
-   * @param {string} accessToken - The access token used to create the pay token.
-   * @return {Promise<GetPayTokenResponse>} A promise that resolves to the pay token response.
-   */
-  async getPayToken(accessToken: string): Promise<GetPayTokenResponse> {
-    return getPayToken(this.config, accessToken, this.route.mobilePayToken());
-  }
-
-  /**
-   * Gets an access token.
-   *
-   * @return {Promise<GetAccessTokenResponse>} the access token response
-   */
-  async getAccessToken(): Promise<GetAccessTokenResponse> {
-    return getAccessToken(this.config, this.route.mobileAccessToken());
-  }
-
-  /**
-   * Initializes the orange money payment.
-   *
-   * @param {InitializeOrangeMoneyRequest} mobileInitParams - Parameters for mobile initialization
-   * @return {Promise<InitializeOrangeMoneyResponse>} A promise that resolves with the mobile payment initialization response
-   */
-  async initializeOrangeMoneyPayment(
-    mobileInitParams: InitializeOrangeMoneyRequest
-  ): Promise<InitializeOrangeMoneyResponse> {
-    return initializeOmPayment({
-      paymentConfig: this.config,
-      mobileInitParams: mobileInitParams,
-      endPoint: this.route.mobileInitPayment(),
-    });
-  }
-
-  /**
-   * Gets the status of a payment.
-   *
-   * @param {GetOrangeMoneyPaymentRequest} checkStatusParams - The parameters for checking the status.
-   * @return {Promise<GetOrangeMoneyPaymentResponse>} The response containing the payment status.
-   */
-  async getOrangeMoneyPaymentStatus(
-    checkStatusParams: GetOrangeMoneyPaymentRequest
-  ): Promise<GetOrangeMoneyPaymentResponse> {
-    return getPaymentStatus({
-      paymentServiceConfig: this.config,
-      mobileStatusVerificationParams: checkStatusParams,
-      endPoint: this.route.mobilePaymentStatus({
-        payToken: checkStatusParams.payToken,
-      }),
-    });
-  }
-}

package/src/payments/operations/get_access_token.spec.ts

@@ -1,60 +0,0 @@
-import * as requests from '../../utils/https';
-import { TargetEnvironment } from '../../utils/utils';
-import { AccessTokenRequestResponse } from '../utils/joi_schema';
-
-import { getAccessToken } from './get_access_token';
-
-const mobileAccessTokenResponse: AccessTokenRequestResponse = {
-  access_token: '1e23bee1-37dc-3015-a7d6-cb70e566bd64',
-  token_type: 'bearer',
-  expires_in: 3600,
-  scope: 'read write',
-};
-
-const logger = console;
-describe('Test the generation of access-token', () => {
-  it('Generates the access token failed', async () => {
-    jest.spyOn(requests, 'postRequest').mockResolvedValue({
-      error: {
-        responseError: {
-          data: [Object],
-          status: 401,
-          statusText: 'Unauthorized',
-          headers: null,
-        },
-      },
-    });
-    const result = await getAccessToken(
-      {
-        targetEnvironment: TargetEnvironment.fake,
-        xAuthToken: 'ABCDEGHIJKLMNOPQRSTUVW',
-        apiUserName: 'secret',
-        apiPassword: 'secret',
-        logger: logger,
-      },
-      'https://api.paytoken.co'
-    );
-    expect(result.error).toBeDefined();
-  });
-
-  it('Successful generate access token', async () => {
-    jest.spyOn(requests, 'postRequest').mockResolvedValue({
-      response: {
-        data: mobileAccessTokenResponse,
-        status: 202,
-      },
-    });
-
-    const result = await getAccessToken(
-      {
-        targetEnvironment: TargetEnvironment.fake,
-        xAuthToken: 'ABCDEGHIJKLMNOPQRSTUVW',
-        apiUserName: 'secret',
-        apiPassword: 'secret',
-        logger: logger,
-      },
-      'https://api.paytoken.co'
-    );
-    expect(result.data).toBe('1e23bee1-37dc-3015-a7d6-cb70e566bd64');
-  });
-});

package/src/payments/operations/get_access_token.ts

@@ -1,77 +0,0 @@
-import {
-  encodeTheBodyOfRequest,
-  encodeToBase64,
-  postRequest,
-} from '../../utils/https';
-import { ApiErrorType, ApiKey, ConstantRequestField } from '../utils/constants';
-import {
-  AccessTokenRequestResponse,
-  OrangeMoneyPaymentParams,
-} from '../utils/joi_schema';
-import { GetAccessTokenResponse } from '../utils/request_model';
-
-/**
- * Gets the access token for the API.
- *
- * @param {OrangeMoneyPaymentParams} paymentConfig - The payment configuration.
- * @param {string} endPoint - The end point route.
- * @return {Promise<GetAccessTokenResponse>} The access token response.
- */
-export const getAccessToken = async (
-  paymentConfig: OrangeMoneyPaymentParams,
-  endPoint: string
-): Promise<GetAccessTokenResponse> => {
-  const logger = paymentConfig.logger;
-
-  const encodeToBase64UserAndPassword = encodeToBase64(
-    paymentConfig.apiUserName,
-    paymentConfig.apiPassword
-  );
-  const authorization = `Basic ${encodeToBase64UserAndPassword}`;
-  const bodyRequest: Record<string, string> = {
-    [ApiKey.keyGrantType]: 'client_credentials',
-  };
-  const options = {
-    [ApiKey.keyAuthorization]: authorization,
-    [ApiKey.keyContentType]: ConstantRequestField.TypeWwwFrom,
-  };
-
-  logger.info(
-    `Generates the access token with data: \nheaders: ${JSON.stringify(
-      options
-    )}\ndata: ${JSON.stringify(
-      encodeTheBodyOfRequest(bodyRequest)
-    )}\nroute: ${endPoint}`
-  );
-
-  const result = await postRequest<AccessTokenRequestResponse>({
-    headers: options,
-    data: encodeTheBodyOfRequest(bodyRequest),
-    route: endPoint,
-    logger: logger,
-  });
-  const accessToken = result.response?.data?.access_token;
-
-  if (result.error || !accessToken) {
-    logger.warn(
-      `Request failed to generate the access token. Error retrieved: ${JSON.stringify(
-        result.error
-      )}`
-    );
-    return {
-      raw: result.error,
-      error: ApiErrorType.failedToGenerateAccessToken,
-    };
-  }
-
-  logger.info(
-    `Access token successfully generated with data ${JSON.stringify(
-      result.response?.data
-    )}`
-  );
-
-  return {
-    data: accessToken,
-    raw: result.response?.data,
-  };
-};

package/src/payments/operations/get_pay_token.spec.ts

@@ -1,65 +0,0 @@
-import * as requests from '../../utils/https';
-
-import { TargetEnvironment } from '../../utils/utils';
-import { PayTokenRequestResponse } from '../utils/joi_schema';
-import { getPayToken } from './get_pay_token';
-
-const payTokenResponse: PayTokenRequestResponse = {
-  message: 'success',
-  data: {
-    payToken: 'MP220807558VEF7A9C4F09AED',
-  },
-};
-
-const logger = console;
-
-describe('Test the generation of payToken', () => {
-  it('Generate the payToken failed due to invalid credential.', async () => {
-    jest.spyOn(requests, 'postRequest').mockImplementationOnce(() =>
-      Promise.resolve({
-        error: {
-          responseError: {
-            data: [Object],
-            status: 401,
-            statusText: 'Unauthorized',
-            headers: null,
-          },
-        },
-      })
-    );
-    const result = await getPayToken(
-      {
-        logger: logger,
-        apiPassword: 'secret',
-        apiUserName: 'secret',
-        targetEnvironment: TargetEnvironment.fake,
-        xAuthToken: 'ABCDEGHIJKLMNOPQRSTUVW',
-      },
-      '1e23bee1-37dc-3015-a7d6-cb70e566bd64',
-      'https://api.paytoken.co'
-    );
-    expect(result.error).toBeDefined();
-  });
-  it('Generate the payToken successfully', async () => {
-    jest.spyOn(requests, 'postRequest').mockImplementationOnce(() =>
-      Promise.resolve({
-        response: {
-          data: payTokenResponse,
-          status: 202,
-        },
-      })
-    );
-    const result = await getPayToken(
-      {
-        logger: logger,
-        apiPassword: 'secret',
-        apiUserName: 'secret',
-        targetEnvironment: TargetEnvironment.fake,
-        xAuthToken: 'ABCDEGHIJKLMNOPQRSTUVW',
-      },
-      '1e23bee1-37dc-3015-a7d6-cb70e566bd64',
-      'https://api.paytoken.co'
-    );
-    expect(result.data).toBe('MP220807558VEF7A9C4F09AED');
-  });
-});