@spreeloop/orange_money 1.0.7 → 1.0.9

package/src/payments/payments.ts

@@ -1,86 +0,0 @@
-import { TargetEnvironment } from '../utils/utils';
-import { OrangeMoneyPaymentFake } from './implementations/fake';
-import { OrangeMoneyPaymentLive } from './implementations/live';
-import { OrangeMoneyPaymentParams } from './utils/joi_schema';
-import {
-  GetAccessTokenResponse,
-  GetOrangeMoneyPaymentRequest,
-  GetOrangeMoneyPaymentResponse,
-  GetPayTokenResponse,
-  InitializeOrangeMoneyRequest,
-  InitializeOrangeMoneyResponse,
-} from './utils/request_model';
-
-export interface OrangeMoneyPaymentInterface {
-  /**
-   * Gets the pay token token.
-   * @param {String} accessToken The access token for authorize the request.
-   * @returns {Promise<GetPayTokenResponse>} The promise that resolves to the pay token response.
-   */
-  getPayToken(accessToken: string): Promise<GetPayTokenResponse>;
-
-  /**
-   * Gets the access token token.
-   */
-  getAccessToken(): Promise<GetAccessTokenResponse>;
-
-  /**
-   * Initializes the orange money payment.
-   *
-   * @param {String} mobileInitParams.description the payment description.
-   * @param {String} mobileInitParams.subscriberNumber The phone number of the user making the payment.
-   * @param {String} mobileInitParams.channelUserNumber The phone number of the user receiving the payment.
-   * @param {String} mobileInitParams.transactionId Unique identifier of the customer transaction.
-   * @param {String} mobileInitParams.amount The amount of the transaction.
-   * @param {String} mobileInitParams.pinCode The Pin code of the ChannelUser.
-   * @param {String} mobileInitParams.notifUrl An http endpoint able to receive a post request.
-   * @param {String} mobileInitParams.payToken A payToken value useful to make payment
-   * and track the status of payment.
-   * @param {String} mobileInitParams.accessToken The access token for authorize the request.
-   * @returns {Promise<InitializeOrangeMoneyResponse>} The promise that resolves to the mobile payment initialization response.
-   **/
-  initializeOrangeMoneyPayment(
-    params: InitializeOrangeMoneyRequest
-  ): Promise<InitializeOrangeMoneyResponse>;
-
-  /**
-   * Gets The orange money payment status.
-   * @param {String} checkStatusParams.payToken unique identifier used to obtain payment status.
-   * @param {String} checkStatusParams.accessToken The access token for authorize the request.
-   * @returns {Promise<GetOrangeMoneyPaymentResponse>} The promise that resolves to the mobile payment status response.
-   */
-  getOrangeMoneyPaymentStatus(
-    params: GetOrangeMoneyPaymentRequest
-  ): Promise<GetOrangeMoneyPaymentResponse>;
-}
-
-/**
- *  Creates a orange money payment.
- */
-export class OrangeMoneyPayment {
-  /**
-   * Create a new payment using the provided configuration.
-   *
-   * @param {OrangeMoneyPaymentParams} config - The payment configuration.
-   *  - {TargetEnvironment} config.targetEnvironment the target environment.
-   *  - {string} config.apiUserName channelUser api username.
-   *  - {string} config.apiPassword channelUser api password.
-   *  - {string} config.xAuthToken the x-auth-token.
-   *  - {string} [mobileInitParams.omVersion] the mobile orange money version apply for payment request.The default orange money version
-   *        is 1.0.2: for more information: https://apiw.orange.cm/omcoreapis/1.0.2/mp/pay.
-   *  - {String} config.targetEnvironment the target environment.
-   * @return {OrangeMoneyPaymentInterface} The created payment.
-   */
-  static createPayment(
-    config: OrangeMoneyPaymentParams
-  ): OrangeMoneyPaymentInterface {
-    switch (config.targetEnvironment) {
-      case TargetEnvironment.prod:
-        return new OrangeMoneyPaymentLive(config);
-      case TargetEnvironment.fake:
-        return new OrangeMoneyPaymentFake();
-      default:
-        return new OrangeMoneyPaymentLive(config);
-    }
-  }
-}

package/src/payments/routes/routes.ts

@@ -1,61 +0,0 @@
-const apiHost = 'https://api-s1.orange.cm';
-
-/**
- * Orange Money API routes builder.
- * @class
- */
-export class Routes {
-  /**
-   * Creates a new instance of the class route.
-   *
-   * @param {string} version - The version of the instance. Optional.
-   */
-  constructor(private readonly version?: string) {
-    this.version = version ?? '1.0.2';
-  }
-
-  /**
-   * Returns the base route for the API.
-   *
-   * @return {string} The base route for the API.
-   */
-  baseRoute = (): string => `${apiHost}/omcoreapis/${this.version}`;
-
-  /**
-   * Initializes the live payment.
-   *
-   * @return {string} The endpoint URL for the live payment.
-   */
-  mobileInitPayment(): string {
-    return `${this.baseRoute()}/mp/pay`;
-  }
-
-  /**
-   * Generates the payment status URL based on the provided parameters.
-   *
-   * @param {object} params - The parameters for generating the payment status URL.
-   *  - {string} params.payToken - The pay token.
-   * @return {string} The generated payment status URL.
-   */
-  mobilePaymentStatus(params: { payToken: string }): string {
-    return `${this.baseRoute()}/mp/paymentstatus/${params.payToken}`;
-  }
-
-  /**
-   * Generates the URL for the Mobile Pay token.
-   *
-   * @return {string} The URL for the Mobile Pay token.
-   */
-  mobilePayToken(): string {
-    return `${this.baseRoute()}/mp/init`;
-  }
-
-  /**
-   * Generates the mobile access token endpoint.
-   *
-   * @return {string} The generated mobile access token endpoint.
-   */
-  mobileAccessToken(): string {
-    return `${apiHost}/token`;
-  }
-}

package/src/payments/utils/constants.ts

@@ -1,120 +0,0 @@
-export enum ApiKey {
-  keyAuthorization = 'Authorization',
-  keyGrantType = 'grant_type',
-  keyContentType = 'Content-Type',
-  keyXAuthToken = 'X-AUTH-TOKEN',
-  keyMerchantKey = 'merchant_key',
-  keyCurrency = 'currency',
-  keyOrderId = 'order_id',
-  keyReturnUrl = 'return_url',
-  keyCancelUrl = 'cancel_url',
-  keyWebNotifyUrl = 'notif_url',
-  keyLang = 'lang',
-  keyReference = 'reference',
-  keyAmount = 'amount',
-  keyPayToken = 'pay_token',
-  keySubscriberMsisdn = 'subscriberMsisdn',
-  keyChannelUserMsisdn = 'channelUserMsisdn',
-  keyDescription = 'description',
-  keyMobileOrderId = 'orderId',
-  keyPin = 'pin',
-  keyMobilePayToken = 'payToken',
-  keyMobileNotifUrl = 'notifUrl',
-}
-
-/**
- * Contains request fields.
- */
-export class ConstantRequestField {
-  //  The content type field.
-  public static readonly typeJson = 'application/json';
-
-  // The url encode form.
-  public static readonly TypeWwwFrom = 'application/x-www-form-urlencoded';
-
-  // The basic authorization field.
-  public static readonly basic = 'Basic ';
-
-  //  The authorization field.
-  public static readonly authorization = 'AUTHORIZATION';
-
-  // The bearer field.
-  public static readonly bearer = 'Bearer ';
-
-  // The grant type field.
-  public static readonly grantType = 'grant_type';
-
-  //  The client credentials field.
-  public static readonly clientCredentials = 'client_credentials';
-
-  //  The X-AUTH-TOKEN field.
-  public static readonly xAuthToken = 'X-AUTH-TOKEN';
-}
-
-/**
- * The orange money payment status.
- */
-export enum OrangeMoneyPaymentStatus {
-  /**
-   * User has clicked on “Confirmed”, transaction
-   * is in progress on Orange system.
-   */
-  PENDING_PAYMENT = 'PENDING',
-
-  /**
-   * The user canceled the payment.
-   */
-  CANCELLED_PAYMENT = 'CANCELLED',
-
-  /**
-   * Waiting for user entry.
-   * Specially for web.
-   */
-  INITIATE_PAYMENT = 'INITIATED',
-
-  /**
-   * Payment is done for mobile.
-   */
-  SUCCESSFULL_MOBILE_PAYMENT = 'SUCCESSFULL',
-
-  /**
-   * Payment is done for web.
-   */
-  SUCCESS_WEB_PAYMENT = 'SUCCESS',
-
-  /**
-   * Payment has failed.
-   * On web, the status can failed when user press to confirm payment too
-   * late or when user enter a wrong validation code.
-   * On mobile, it may fail when the user does not have a mooney orange wallet
-   * or the account balance is insufficient.
-   */
-  FAILED_PAYMENT = 'FAILED',
-
-  /**
-   * User has clicked on “Confirmed” too late (after token’s validity), or the
-   * delay token timeout has expired.
-   * Note that the minimum token expiration time is 7 min.
-   */
-  EXPIRED_PAYMENT = 'EXPIRED',
-}
-
-export enum ApiErrorType {
-  insufficientFunds = 'insufficientFunds',
-  invalidOrangeMoneyNumber = 'invalidOrangeMoneyNumber',
-  invalidData = 'invalidData',
-  failedToInitiateThePayment = 'failedToInitiateThePayment',
-  failedToGenerateAccessToken = 'failedToGenerateAccessToken',
-  failedToCheckPaymentStatus = 'failedToCheckPaymentStatus',
-  failedToGeneratePayToken = 'failedToGeneratePayToken',
-  accountLocked = 'accountLocked',
-  invalidPaymentAmount = 'invalidPaymentAmount',
-  unauthorized = 'unauthorized',
-}
-
-export enum OrangeMoneyErrorMessage {
-  beneficiaryNotFound = 'Beneficiaire introuvable',
-  insufficientFunds = 'Le solde du compte du payeur est insuffisant',
-  accountLocked = 'Utilisateur bloque',
-  invalidPaymentAmount = 'Vous avez saisi un montant superieur au montant maximum autorise',
-}

package/src/payments/utils/joi_schema.ts

@@ -1,117 +0,0 @@
-import Joi from 'joi';
-import { LoggerInterface } from '../../utils/logging_interface';
-import { TargetEnvironment } from '../../utils/utils';
-import { OrangeMoneyPaymentStatus } from './constants';
-
-/**
- * The provider generic response data of payment request of status verification request.
- */
-export type GenericRequestResponseData = {
-  message: string;
-  data: {
-    id: number;
-    createtime: string | null;
-    subscriberMsisdn: string;
-    amount: number;
-    payToken: string;
-    txnid: string | null;
-    txnmode: string | null;
-    inittxnmessage: string;
-    inittxnstatus: string;
-    confirmtxnstatus: string | null;
-    confirmtxnmessage: string | null;
-    status: OrangeMoneyPaymentStatus;
-    notifUrl: string | null;
-    description: string | null;
-    channelUserMsisdn: string;
-  };
-};
-
-/**
- * The provider generic response data of payment request of status verification request.
- * We only make validation off fields that are required.
- */
-export const genericRequestResponseSchema =
-  Joi.object<GenericRequestResponseData>({
-    message: Joi.string().required(),
-    data: Joi.object({
-      subscriberMsisdn: Joi.string().required(),
-      amount: Joi.number().required(),
-      inittxnmessage: Joi.string().allow(null).allow('').required(),
-      status: Joi.string()
-        .valid(
-          OrangeMoneyPaymentStatus.FAILED_PAYMENT,
-          OrangeMoneyPaymentStatus.PENDING_PAYMENT,
-          OrangeMoneyPaymentStatus.CANCELLED_PAYMENT,
-          OrangeMoneyPaymentStatus.EXPIRED_PAYMENT,
-          OrangeMoneyPaymentStatus.SUCCESSFULL_MOBILE_PAYMENT
-        )
-        .required(),
-      channelUserMsisdn: Joi.string().required(),
-    })
-      .required()
-      .unknown(true),
-  });
-
-export type InitPaymentBodySchema = {
-  orderId: string;
-  description: string;
-  orangeMoneyVersion?: string;
-  notifUrl: string;
-  pin: string;
-  payToken: string;
-  amount: number;
-  channelUserMsisdn: string;
-  subscriberMsisdn: string;
-};
-
-export const initPaymentBodySchema = Joi.object<InitPaymentBodySchema>({
-  subscriberMsisdn: Joi.string()
-    .required()
-    .pattern(/^(69\d{7}$|65[5-9]\d{6}$)/)
-    .message(
-      '[subscriberMsisdn] Invalid orange number. Format of valid number: 69******* or 65[5-9]******'
-    ),
-  channelUserMsisdn: Joi.string()
-    .required()
-    .pattern(/^(69\d{7}$|65[5-9]\d{6}$)/)
-    .message(
-      '[channelUserMsisdn] Invalid orange number. Format of valid number: 69******* or 65[5-9]******'
-    ),
-  amount: Joi.string().required(),
-  payToken: Joi.string().required(),
-  pin: Joi.string().max(4).required(),
-  notifUrl: Joi.string().allow('').default(''),
-  orangeMoneyVersion: Joi.string().optional(),
-  description: Joi.string().allow('').max(125).default('payment'),
-  orderId: Joi.string().max(20).required(),
-});
-
-export interface OrangeMoneyPaymentParams {
-  targetEnvironment: TargetEnvironment;
-  logger: LoggerInterface;
-  apiUserName: string;
-  apiPassword: string;
-  xAuthToken: string;
-  orangeMoneyVersion?: string;
-}
-
-/**
- * The provider access token request response from the OM server.
- */
-export type AccessTokenRequestResponse = {
-  access_token: string;
-  scope: string;
-  token_type: string;
-  expires_in: number;
-};
-
-/**
- * The provider payToken request response from the OM server.
- */
-export type PayTokenRequestResponse = {
-  message: string;
-  data: {
-    payToken: string;
-  };
-};

package/src/payments/utils/request_model.ts

@@ -1,103 +0,0 @@
-import { OperationResponse } from '../../utils/operation_response';
-import { ApiErrorType, OrangeMoneyPaymentStatus } from './constants';
-import {
-  AccessTokenRequestResponse,
-  GenericRequestResponseData,
-  PayTokenRequestResponse,
-} from './joi_schema';
-
-export type InitializeOrangeMoneyRequest = {
-  /**
-   * The phone number of the user making the payment.
-   */
-  subscriberNumber: string;
-  /**
-   * The phone number of the user receiving the payment.
-   */
-  channelUserNumber: string;
-  /**
-   * Unique identifier of the customer transaction.
-   */
-  transactionId: string;
-  /**
-   * The amount of the transaction.
-   */
-  amount: number;
-  /**
-   * The Pin code of the ChannelUser.
-   */
-  pinCode: string;
-  /**
-   * An http endpoint able to receive a post request with the following json body.
-   * {
-   *  ”payToken” : ”payToken”,
-   *     ”status” : status”,
-   *    ”message” : ”message”
-   *  }
-   */
-  notifUrl?: string;
-  /**
-   * The payment description.
-   */
-  description?: string;
-
-  /**
-   * The payToken value useful to make payment
-   * and track the status of payment.
-   */
-  payToken: string;
-
-  /**
-   * The access token for authorize the request.
-   */
-  accessToken: string;
-};
-
-export type GetOrangeMoneyPaymentRequest = {
-  /**
-   * The access token for authorize the request.
-   */
-  accessToken: string;
-
-  /**
-   * unique identifier used to obtain payment status.
-   */
-  payToken: string;
-};
-
-/**
- * This response is obtained when we initiate a mobile payment request,
- * the request would generate a payToken useful to make payment
- * and track the status of payment.
- */
-export type InitializeOrangeMoneyResponse = OperationResponse<
-  {
-    /**
-     * The payToken value useful to make payment
-     * and track the status of payment.
-     */
-    payToken: string;
-  },
-  GenericRequestResponseData,
-  ApiErrorType
->;
-
-export type GetOrangeMoneyPaymentResponse = OperationResponse<
-  {
-    status: OrangeMoneyPaymentStatus;
-  },
-  GenericRequestResponseData,
-  ApiErrorType
->;
-
-export type GetAccessTokenResponse = OperationResponse<
-  string,
-  AccessTokenRequestResponse | undefined,
-  ApiErrorType
->;
-
-export type GetPayTokenResponse = OperationResponse<
-  string,
-  PayTokenRequestResponse | undefined,
-  ApiErrorType
->;

package/src/payments/utils/utils.ts

@@ -1,31 +0,0 @@
-import Joi from 'joi';
-
-/**
- * Checks if the data is valid type.
- * @param {Record<string, unknown>} data .
- * @param {Joi.PartialSchemaMap<T>} schema .
- * @return {Record<string, unknown>}
- */
-export function validateData<T>(
-  data: unknown,
-  schema: Joi.ObjectSchema<T>
-): { isValidData: true; data: T } | { isValidData: false; message: string } {
-  const { error, value } = schema.unknown(true).validate(data, {
-    abortEarly: false,
-    convert: false,
-  });
-  if (error) {
-    return {
-      isValidData: false,
-      message: JSON.stringify(
-        error.details.map((e) => e.message),
-        null,
-        ' '
-      ),
-    };
-  }
-  return {
-    isValidData: true,
-    data: value,
-  };
-}

package/src/utils/https.spec.ts

@@ -1,101 +0,0 @@
-import {
-  encodeTheBodyOfRequest,
-  encodeToBase64,
-  hash,
-  parseAxiosError,
-} from './https';
-import { AxiosError, AxiosResponse } from 'axios';
-
-describe('hash', () => {
-  const btoaRef = global.btoa;
-  it('should still Hash if the btao function is not available', () => {
-    global.btoa = undefined as unknown as typeof btoaRef;
-    const hashResponse = hash('key', 'secret');
-    expect(hashResponse).toBe('a2V5OnNlY3JldA==');
-    global.btoa = btoaRef;
-  });
-});
-
-describe('parseAxiosError', () => {
-  it('should return initial obj if not instance of axios error', () => {
-    const initialObj = { key: 'ERROR_100' };
-    const parsedResponse = parseAxiosError(initialObj);
-    expect(parsedResponse).toBe(initialObj);
-  });
-
-  it('should have the configuration failed message when config failed', () => {
-    const message = 'configuration failed';
-    const parsedResponse = parseAxiosError(
-      new AxiosError(message) as unknown as Record<string, unknown>
-    );
-    expect(parsedResponse).toEqual({
-      configFailed: message,
-    });
-  });
-
-  it('should return request failed when axios is unable to send the request.', () => {
-    const request = {
-      headers: {
-        'Content-Type': 'application/json',
-      },
-    };
-    const parsedResponse = parseAxiosError(
-      new AxiosError('message', '400', undefined, request) as unknown as Record<
-        string,
-        unknown
-      >
-    );
-    expect(parsedResponse).toEqual({
-      requestFailed: { data: undefined, headers: undefined },
-    });
-  });
-
-  it('should return response error when the request response fail to be retrieve.', () => {
-    const request = {
-      headers: {
-        'Content-Type': 'application/json',
-      },
-      body: '',
-    };
-    const response = <AxiosResponse>{
-      data: '',
-      status: 201,
-      statusText: 'created',
-      headers: {},
-      request: request,
-    };
-
-    const parsedResponse = parseAxiosError(
-      new AxiosError(
-        'message',
-        '400',
-        undefined,
-        request,
-        response
-      ) as unknown as Record<string, unknown>
-    );
-    expect(parsedResponse).toEqual({
-      responseError: {
-        data: response.data,
-        status: response.status,
-        statusText: response.statusText,
-        headers: response.headers,
-      },
-      requestBody: request.body,
-    });
-  });
-});
-
-describe('Test the utils function', () => {
-  it('Generate the base 64 encoding', async () => {
-    const value = encodeToBase64('123', '123');
-    expect(value).toEqual('MTIzOjEyMw');
-  });
-  it('encode the body request', async () => {
-    const body = {
-      amount: '123',
-    };
-    const value = encodeTheBodyOfRequest(body);
-    expect(value).toEqual('amount=123');
-  });
-});