@spreeloop/orange_money 1.0.7 → 1.0.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spreeloop/orange_money",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "A orange money api integration package",
   "repository": {
     "type": "git",
@@ -16,6 +16,9 @@
     "coverage": "jest --coverage"
   },
   "main": "dist/index.js",
+  "files": [
+    "/dist"
+  ],
   "license": "MIT",
   "types": "dist/index.d.ts",
   "type": "commonjs",

package/.eslintrc.js

@@ -1,47 +0,0 @@
-module.exports = {
-  root: true,
-  env: {
-    es6: true,
-    node: true,
-  },
-  extends: [
-    'eslint:recommended',
-    'plugin:import/errors',
-    'plugin:import/warnings',
-    'plugin:import/typescript',
-    'google',
-    'plugin:@typescript-eslint/recommended',
-    'prettier',
-  ],
-  parser: '@typescript-eslint/parser',
-  parserOptions: {
-    project: ['tsconfig.json', 'tsconfig.dev.json'],
-    tsconfigRootDir: __dirname,
-    sourceType: 'module',
-  },
-  ignorePatterns: [
-    '/dist/**/*', // Ignore built files.
-    '/coverage/**/*', // Ignore built files.
-  ],
-  plugins: ['@typescript-eslint', 'import', 'prettier'],
-  rules: {
-    quotes: [
-      'error',
-      'single',
-      {
-        avoidEscape: true,
-      },
-    ],
-    'prettier/prettier': 2,
-  },
-  settings: {
-    'import/resolver': {
-      'custom-alias': {
-        extensions: ['.ts'],
-        alias: {
-          '@spreeloop-core/logging': '../logging',
-        },
-      },
-    },
-  },
-};

package/.prettierrc

@@ -1,6 +0,0 @@
-{
-  "semi": true,
-  "singleQuote": true,
-  "trailingComma": "es5",
-  "printWidth": 80
-}

package/babel.config.js

@@ -1,3 +0,0 @@
-module.exports = {
-  presets: ['@babel/preset-env', '@babel/preset-typescript'],
-};

package/index.spec.ts

@@ -1,9 +0,0 @@
-import * as index from './index';
-
-// Ensure that we import all exported functions,
-// in order to have more accurate code coverage stats.
-describe('Import all functions', () => {
-  it('ensures that the index is defined', () => {
-    expect(index).toBeDefined();
-  });
-});

package/index.ts

@@ -1 +0,0 @@
-export * from './src/index';

package/jest.before-test.ts

@@ -1,3 +0,0 @@
-afterEach(() => {
-  jest.restoreAllMocks();
-});

package/jest.config.ts

@@ -1,54 +0,0 @@
-import type { Config } from 'jest';
-
-/*
- * For a detailed explanation regarding each configuration property and type check, visit:
- * https://jestjs.io/docs/configuration
- */
-const jestConfig: Config = {
-  // An array of glob patterns indicating a set of files for which coverage information should be collected
-  collectCoverageFrom: ['src/**/*.{js,ts}', '!src/**/*.d.ts'],
-
-  // The directory where Jest should output its coverage files
-  coverageDirectory: 'coverage',
-
-  // An array of directory names to be searched recursively up from the requiring module's location
-  moduleDirectories: ['<rootDir>', 'node_modules'],
-
-  // An alternative API to setting the NODE_PATH env variable,
-  // modulePaths is an array of absolute paths to additional locations to search when resolving modules.
-  modulePaths: ['<rootDir>/node_modules'],
-
-  // An array of file extensions your modules use
-  // Module file extensions for importing
-  moduleFileExtensions: ['ts', 'js'],
-
-  // Automatically reset mock state before every test
-  resetMocks: true,
-
-  // The test environment that will be used for testing
-  testEnvironment: 'node',
-
-  moduleNameMapper: {
-    '@spreeloop-core/logging': '<rootDir>../logging',
-  },
-
-  // A list of paths to modules that run some code to configure or set up the testing framework
-  // before each test file in the suite is executed.
-  setupFilesAfterEnv: ['<rootDir>/jest.before-test.ts'],
-
-  // The glob patterns Jest uses to detect test files
-  testMatch: ['<rootDir>/**/*.spec.{js,ts}'],
-
-  // A transformer is a module that provides a synchronous function for transforming source files.
-  transform: {
-    '^.+\\.ts$': 'babel-jest',
-  },
-
-  // Those file will not be transformed
-  transformIgnorePatterns: [],
-
-  // Indicates whether each individual test should be reported during the run
-  verbose: true,
-};
-
-export default jestConfig;

package/src/disbursements/implementations/disbursement_service.ts

@@ -1,133 +0,0 @@
-import Joi from 'joi';
-import { DisbursementXTargetEnvironmentType } from '../utils/constants';
-import { LoggerInterface } from '../../utils/logging_interface';
-import { merchantPhoneNumberRegex } from '../utils/regex';
-import { CreateAccessTokenResponse } from '../operations/create_access_token';
-import { TransferRequest, TransferResponse } from '../operations/transfer';
-import {
-  GetTransferStatusRequest,
-  GetTransferStatusResponse,
-} from '../operations/get_transfer_status';
-import { DisbursementLive } from './src/live';
-import { DisbursementFake } from './src/sandbox';
-
-/**
- * Interface for DisbursementServiceConfig.
- */
-export interface DisbursementServiceConfig {
-  clientId: string;
-  clientSecret: string;
-  customerKey: string;
-  customerSecret: string;
-  channelUserMsisdn: string;
-  pin: string;
-  environment: DisbursementXTargetEnvironmentType;
-  logger: LoggerInterface;
-}
-
-/**
- * Joi schema for DisbursementServiceConfigSchema.
- */
-export const DisbursementServiceConfigSchema =
-  Joi.object<DisbursementServiceConfig>({
-    clientId: Joi.string().required().messages({
-      'string.base': '"clientId" should be a type of \'text\'',
-      'string.empty': '"clientId" cannot be an empty field',
-      'any.required': '"clientId" is a required field',
-    }),
-    clientSecret: Joi.string().required().messages({
-      'string.base': '"clientSecret" should be a type of \'text\'',
-      'string.empty': '"clientSecret" cannot be an empty field',
-      'any.required': '"clientSecret" is a required field',
-    }),
-    customerKey: Joi.string().required().messages({
-      'string.base': '"customerKey" should be a type of \'text\'',
-      'string.empty': '"customerKey" cannot be an empty field',
-      'any.required': '"customerKey" is a required field',
-    }),
-    customerSecret: Joi.string().required().messages({
-      'string.base': '"customerSecret" should be a type of \'text\'',
-      'string.empty': '"customerSecret" cannot be an empty field',
-      'any.required': '"customerSecret" is a required field',
-    }),
-    channelUserMsisdn: Joi.string()
-      .pattern(merchantPhoneNumberRegex)
-      .required()
-      .messages({
-        'string.base': '"channelUserMsisdn" should be a type of \'text\'',
-        'string.empty': '"channelUserMsisdn" cannot be an empty field',
-        'any.required': '"channelUserMsisdn" is a required field',
-      }),
-    pin: Joi.string().required().messages({
-      'string.base': '"pin" should be a type of \'text\'',
-      'string.empty': '"pin" cannot be an empty field',
-      'any.required': '"pin" is a required field',
-    }),
-    environment: Joi.string()
-      .valid(...Object.values(DisbursementXTargetEnvironmentType))
-      .required()
-      .messages({
-        'string.base': '"environment" should be a type of \'text\'',
-        'string.empty': '"environment" cannot be an empty field',
-        'any.required': '"environment" is a required field',
-      }),
-    logger: Joi.object().required().messages({
-      'string.base': '"logger" should be a type of \'object\'',
-      'string.empty': '"logger" cannot be an empty field',
-      'any.required': '"logger" is a required field',
-    }),
-  });
-
-/**
- * Orange Money API Disbursement.
- * @class
- */
-export interface DisbursementInterface {
-  /**
-   * Creates an access token.
-   *
-   * @return {Promise<CreateAccessTokenResponse>} The method response containing a string and a token.
-   */
-  createAccessToken(): Promise<CreateAccessTokenResponse>;
-
-  /**
-   * Transfers the specified amount of money from one account to another.
-   *
-   * @param {TransferRequest} params - The parameters for the transfer.
-   * @return {Promise<TransferResponse>} - The response from the transfer method.
-   */
-  transfer(params: TransferRequest): Promise<TransferResponse>;
-
-  /**
-   * Retrieves the status of a transfer.
-   *
-   * @param {GetTransferStatusRequest} params - The parameters for retrieving the transfer status.
-   * @return {Promise<GetTransferStatusResponse>} - The method response containing the status and transfer status response.
-   */
-  getTransferStatus(
-    params: GetTransferStatusRequest
-  ): Promise<GetTransferStatusResponse>;
-}
-
-/**
- * Orange Money API Disbursement.
- * @class
- */
-export class Disbursement {
-  /**
-   * Creates a new Disbursement object based on the provided configuration.
-   *
-   * @param {DisbursementServiceConfig} config - The configuration for the Disbursement object.
-   * @return {Disbursement} A new Disbursement object based on the provided configuration.
-   */
-  static createDisbursement(
-    config: DisbursementServiceConfig
-  ): DisbursementInterface {
-    switch (config.environment) {
-      case DisbursementXTargetEnvironmentType.prod:
-        return new DisbursementLive(config);
-      case DisbursementXTargetEnvironmentType.sandbox:
-        return new DisbursementFake(config);
-    }
-  }
-}

package/src/disbursements/implementations/src/live.ts

@@ -1,79 +0,0 @@
-import {
-  TransferRequest,
-  TransferResponse,
-  transfer,
-} from '../../operations/transfer';
-import {
-  CreateAccessTokenResponse,
-  createAccessToken,
-} from '../../operations/create_access_token';
-import { Routes } from '../../routes/routes';
-import {
-  DisbursementInterface,
-  DisbursementServiceConfig,
-} from '../disbursement_service';
-import {
-  GetTransferStatusRequest,
-  GetTransferStatusResponse,
-  getTransferStatus,
-} from '../../operations/get_transfer_status';
-
-/**
- * Orange Money API Live Disbursement.
- * @class
- */
-export class DisbursementLive implements DisbursementInterface {
-  protected readonly config: DisbursementServiceConfig;
-  protected readonly routes: Routes;
-  /**
-   * Constructs a new {Disbursement}.
-   * @constructor
-   * @param {DisbursementServiceConfig} config - The required global route configuration.
-   */
-  constructor(config: DisbursementServiceConfig) {
-    this.routes = new Routes();
-    this.config = config;
-  }
-
-  /**
-   * Creates an access token.
-   *
-   * @return {Promise<CreateAccessTokenResponse>} The method response containing a string and a token.
-   */
-  async createAccessToken(): Promise<CreateAccessTokenResponse> {
-    return await createAccessToken({
-      configs: this.config,
-      endPoint: this.routes.createAccessToken(),
-    });
-  }
-
-  /**
-   * Transfers the specified amount of money from one account to another.
-   *
-   * @param {TransferRequest} params - The parameters for the transfer.
-   * @return {Promise<TransferResponse>} - The response from the transfer method.
-   */
-  async transfer(params: TransferRequest): Promise<TransferResponse> {
-    return await transfer({
-      configs: this.config,
-      params: params,
-      endPoint: this.routes.transfer(),
-    });
-  }
-
-  /**
-   * Retrieves the status of a transfer.
-   *
-   * @param {GetTransferStatusRequest} params - The parameters for retrieving the transfer status.
-   * @return {Promise<GetTransferStatusResponse>} - The method response containing the status and transfer status response.
-   */
-  async getTransferStatus(
-    params: GetTransferStatusRequest
-  ): Promise<GetTransferStatusResponse> {
-    return await getTransferStatus({
-      configs: this.config,
-      params: params,
-      endPoint: this.routes.transferStatus(params.messageId),
-    });
-  }
-}

package/src/disbursements/implementations/src/sandbox.ts

@@ -1,124 +0,0 @@
-import { TransferResponse } from '../../operations/transfer';
-import { CreateAccessTokenResponse } from '../../operations/create_access_token';
-import { Routes } from '../../routes/routes';
-import {
-  DisbursementInterface,
-  DisbursementServiceConfig,
-} from '../disbursement_service';
-import {
-  DisbursementStep,
-  GetTransferStatusResponse,
-} from '../../operations/get_transfer_status';
-import {
-  DisbursementApiRawStatus,
-  DisbursementStatus,
-} from '../../utils/status';
-
-/**
- * Orange Money API Fake Disbursement.
- * @class
- */
-export class DisbursementFake implements DisbursementInterface {
-  protected readonly config: DisbursementServiceConfig;
-  protected readonly routes: Routes;
-  /**
-   * Constructs a new {Disbursement}.
-   * @constructor
-   * @param {DisbursementServiceConfig} config - The required global route configuration.
-   */
-  constructor(config: DisbursementServiceConfig) {
-    this.routes = new Routes();
-    this.config = config;
-  }
-
-  /**
-   * Creates an access token.
-   *
-   * @return {Promise<CreateAccessTokenResponse>} The method response containing a string and a token.
-   */
-  async createAccessToken(): Promise<CreateAccessTokenResponse> {
-    return {
-      data: 'accessToken',
-      raw: {
-        access_token: 'accessToken',
-        token_type: 'Bearer',
-        expires_in: '300',
-      },
-    };
-  }
-
-  /**
-   * Transfers the specified amount of money from one account to another.
-   *
-   * @param {TransferRequest} params - The parameters for the transfer.
-   * @return {Promise<TransferResponse>} - The response from the transfer method.
-   */
-  async transfer(): Promise<TransferResponse> {
-    return {
-      data: 'f7ec5a39-b1ad-4fa5-a734-60ab4217ba75',
-      raw: {
-        MD5OfMessageBody: '4b55cf6629b5f0ee3c8ac91435a2eb35',
-        MD5OfMessageAttributes: '50e3084aee2bf840dd63b6bbf0a62fa9',
-        MessageId: 'f7ec5a39-b1ad-4fa5-a734-60ab4217ba75',
-        ResponseMetadata: {
-          RequestId: 'bbb43d42-95d1-5a6b-92a7-60c0d420e103',
-          HTTPStatusCode: 200,
-          HTTPHeaders: {
-            'x-amzn-requestid': 'bbb43d42-95d1-5a6b-92a7-60c0d420e103',
-            'x-amzn-trace-id':
-              'Root=1-65083fb1-37fbf881380338ed3b5fcd2b;Parent=6bfc3c24556c9b27;Sampled=0;Lineage=79e6faf7:0',
-            date: 'Mon, 18 Sep 2023 12:16:49 GMT',
-            'content-type': 'text/xml',
-            'content-length': '459',
-          },
-          RetryAttempts: 0,
-        },
-      },
-    };
-  }
-
-  /**
-   * Retrieves the status of a transfer.
-   *
-   * @param {GetTransferStatusRequest} params - The parameters for retrieving the transfer status.
-   * @return {Promise<GetTransferStatusResponse>} - The method response containing the status and transfer status response.
-   */
-  async getTransferStatus(): Promise<GetTransferStatusResponse> {
-    return {
-      data: {
-        status: DisbursementStatus.succeeded,
-        refundStep: DisbursementStep.TransferSent,
-      },
-      raw: {
-        result: {
-          message: 'Cash in performed successfully',
-          data: {
-            subscriberMsisdn: 'subscriberMsisdn',
-            channelUserMsisdn: 'channelUserMsisdn',
-            createtime: '1695039280',
-            amount: 100,
-            payToken: 'C2C2309183CB702A1CBB39ECE32C',
-            txnid: 'PP230918.1314.B57973',
-            txnmode: 'refundYNote',
-            txnstatus: '00068',
-            orderId: 'refundYNote',
-            status: DisbursementApiRawStatus.succeeded,
-            description: 'Remboursement Fond',
-          },
-        },
-        parameters: {
-          amount: '100',
-          xauth: 'WU5PVEVIRUFEOllOT1RFSEVBRDIwMjA=',
-          channel_user_msisdn: 'channel_user_msisdn',
-          customer_key: 'customer_key',
-          customer_secret: 'customer_secret',
-          final_customer_name: 'Steve',
-          final_customer_phone: '692232239',
-        },
-        CreateAt: '09-18-2023 12:14:43',
-        MessageId: 'caee8310-02fa-45da-9b22-a1effcada25c',
-        RefundStep: DisbursementStep.TransferSent,
-      },
-    };
-  }
-}

package/src/disbursements/operations/create_access_token.spec.ts

@@ -1,87 +0,0 @@
-import { AxiosError, AxiosResponse } from 'axios';
-import { Logger } from '../../../../logging/src/logging';
-import * as requests from '../../utils/https';
-import { DisbursementXTargetEnvironmentType } from '../utils/constants';
-import { Token, createAccessToken } from './create_access_token';
-
-describe('createAccessToken', () => {
-  it('Should fail on invalid parameter', async () => {
-    const result = await createAccessToken({
-      endPoint: '',
-      configs: {
-        channelUserMsisdn: '',
-        clientId: '',
-        clientSecret: '',
-        customerKey: '',
-        customerSecret: '',
-        pin: '',
-        environment: DisbursementXTargetEnvironmentType.sandbox,
-        logger: new Logger(),
-      },
-    });
-    expect(result.data).toBeUndefined();
-  });
-
-  it('Should fail on request rejection', async () => {
-    const errorMessage = 'mock reject the request';
-    const postSpy = jest
-      .spyOn(requests, 'postRequest')
-      .mockImplementation()
-      .mockResolvedValue({ error: new AxiosError(errorMessage) });
-
-    const result = await createAccessToken({
-      endPoint: 'https://route.com/link',
-      configs: {
-        channelUserMsisdn: '237699947943',
-        clientId: 'clientId',
-        clientSecret: 'clientSecret',
-        customerKey: 'customerKey',
-        customerSecret: 'customerSecret',
-        pin: 'pin',
-        environment: DisbursementXTargetEnvironmentType.sandbox,
-        logger: new Logger(),
-      },
-    });
-
-    expect(postSpy).toHaveBeenCalledTimes(1);
-    expect(result.data).toBeUndefined();
-    expect(result.error).toBeDefined();
-    postSpy.mockRestore();
-  });
-
-  it('Should successfully retrieve token', async () => {
-    const accessToken = 'THEaCCESStOKEN';
-    const postSpy = jest
-      .spyOn(requests, 'postRequest')
-      .mockImplementation()
-      .mockResolvedValue({
-        response: <AxiosResponse<Token>>{
-          data: {
-            access_token: accessToken,
-          },
-        },
-      });
-
-    const result = await createAccessToken({
-      endPoint: 'https://route.com/link',
-      configs: {
-        channelUserMsisdn: '237699947943',
-        clientId: 'clientId',
-        clientSecret: 'clientSecret',
-        customerKey: 'customerKey',
-        customerSecret: 'customerSecret',
-        pin: 'pin',
-        environment: DisbursementXTargetEnvironmentType.sandbox,
-        logger: new Logger(),
-      },
-    });
-
-    expect(postSpy).toHaveBeenCalledTimes(1);
-    expect(result.error).toBeUndefined();
-    expect(result.raw).toEqual({
-      access_token: accessToken,
-    });
-    expect(result.data).toBe(accessToken);
-    postSpy.mockRestore();
-  });
-});

package/src/disbursements/operations/create_access_token.ts

@@ -1,83 +0,0 @@
-import {
-  RequestResponse,
-  encodeDataToXFormUrl,
-  hash,
-  postRequest,
-} from '../../utils/https';
-import { OperationResponse } from '../../utils/operation_response';
-import {
-  DisbursementServiceConfig,
-  DisbursementServiceConfigSchema,
-} from '../implementations/disbursement_service';
-
-export type Token = {
-  /**
-   * The requested token.
-   */
-  access_token: string;
-
-  scope?: string;
-
-  /**
-   * The type of the requested token.
-   */
-  token_type: string;
-
-  /** The time to live in seconds. */
-  expires_in: string;
-};
-
-export type CreateAccessTokenResponse = OperationResponse<string, Token>;
-
-/**
- * Creates an access token.
- *
- * @param {CreateAccessTokenRequest} configs - The disbursement service config.
- * @param {string} endPoint - The end point.
- * @return {CreateAccessTokenResponse} The method response containing the access token and raw response.
- */
-export async function createAccessToken({
-  configs,
-  endPoint,
-}: {
-  configs: DisbursementServiceConfig;
-  endPoint: string;
-}): Promise<CreateAccessTokenResponse> {
-  const logger = configs.logger;
-  logger.info('createAccessToken is running ...');
-  const { error: configsValidationError, value: configValues } =
-    DisbursementServiceConfigSchema.validate(configs);
-
-  if (configsValidationError) {
-    logger.error(
-      `Invalid DisbursementServiceConfig request parameters. params : ${JSON.stringify(
-        configsValidationError.details
-      )}`
-    );
-    return { error: configsValidationError.details };
-  }
-  const authorization = hash(configValues.clientId, configValues.clientSecret);
-  const headers = {
-    'Content-Type': 'application/x-www-form-urlencoded',
-    Authorization: `Basic ${authorization}`,
-  };
-  const body = encodeDataToXFormUrl({
-    grant_type: 'client_credentials',
-  });
-  const response: RequestResponse<Token> = await postRequest<Token>({
-    logger: logger,
-    route: endPoint,
-    data: body,
-    headers: headers,
-    rejectUnauthorized: false,
-  });
-
-  if (!response.response) {
-    return { error: response.error };
-  }
-
-  return {
-    data: response.response.data.access_token,
-    raw: response.response.data,
-  };
-}