@spreeloop/orange_money 1.0.0

package/.eslintrc.js

@@ -0,0 +1,47 @@
+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

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

package/README.md

@@ -0,0 +1,192 @@
+
+# Welcome to @spreeloop/orange_money 👋
+
+<p>
+  <a href="https://www.npmjs.com/package/@spreeloop/orange_money" target="_blank">
+    <img alt="Version" src="https://img.shields.io/npm/v/@spreeloop/orange_money.svg">
+  </a>
+  <a href="#" target="_blank">
+    <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
+  </a>
+</p>
+
+The Y-note Orange Money Node.js Integration Module is a powerful toolkit
+designed to simplify the integration of Orange Money's payment capabilities
+into Node.js applications. This module provides developers with a convenient
+interface to interact with Orange Money APIs, enabling seamless payment
+processing and transaction management.
+
+## Features
+
+- **Easy Integration**: Simplifies the integration of Orange Money payment
+ functionality into Node.js applications.
+- **Flexible Configuration**: Allows developers to customize payment
+configurations based on specific requirements.
+- **Comprehensive Documentation**: Provides comprehensive documentation and
+ examples for easy integration and usage.
+- **Supports Multiple Environments**: Supports multiple target environments,
+ including production and testing environments.
+
+## Installation
+
+To install the Orange Money Node.js Integration Module, simply add it to
+your Node.js project using npm:
+
+```bash
+npm install @spreeloop/orange_money
+```
+
+## Run tests
+
+```sh
+npm run test
+```
+
+## Table content
+
+- [Merchant payment](README.md#merchant-payment)
+  1. [Generate access-token](README.md#generate-access-token)
+  2. [Generate pay-token](README.md#generate-pay-token)
+  3. [Initiate Payment](README.md#initiate-payment)
+  4. [Get Orange Money Payment Status](README.md#get-orange-money-payment-status)
+
+- ## Merchant payment
+
+  Before calling any payment function, we need to create the orange money
+  Payment instance.
+
+```typescript
+import {OrangeMoneyPaymentV2} from  @spreeloop/orange_money;
+
+// Creates payment configuration
+const config = {
+  /** In test mode use the TargetEnvironment.fake that return static data since
+    the y-note payment don't have the sandbox environment.
+  */
+  targetEnvironment: TargetEnvironment.prod,
+  apiUserName: 'your_api_username',
+  apiPassword: 'your_api_password',
+  xAuthToken: 'your_x_auth_token',
+
+// By default we use the 'console' to display the log but you can decide to 
+// use your own custom log.
+  logger: console;
+};
+
+const payment = OrangeMoneyPaymentV2.createPayment(config);
+```
+
+- ### Generate access-token
+
+```typescript
+const accessTokenResponse = await payment.getAccessToken();
+```
+
+- ### Generate pay-token
+
+```typescript
+const payTokenResponse = await payment.getPayToken('your_access_token');
+```
+
+- ### Initiate Payment
+
+The payment initialization depends on the platform on which the application
+runs. This package only support USSD payment.
+
+```typescript
+// Initialize Orange Money Payment
+const initializationResponse = await payment.initializeOrangeMoneyPayment({
+  description: 'Payment for goods',
+  subscriberNumber: '696600011',
+  channelUserNumber: '696600011',
+  transactionId: '1234567890',
+  amount: '1000',
+  pinCode: '1234',
+  notifUrl: 'https://yourdomain.com/payment/notify',
+  payToken: 'your_pay_token',
+  accessToken: 'your_access_token',
+});
+```
+
+If you want to receive an answer immediately, always set a correct `notifUrl`
+endpoint link. The service notifies the url immediately or 1 minutes after
+receiving the client validation.  
+The response received is of the form:
+
+```typescript
+{
+    "payToken": "payToken",
+    "status" : "status",
+    "message" : "message"
+}
+```
+
+**Note**: After initiating the payment, the request goes to status
+`EXPIRED` if the user doesn't validate or cancel the payment within 7 minutes.
+
+[Express](https://expressjs.com/en/guide/routing.html) is one of the most popular npm
+ package to manage your endpoint.
+
+Example:
+
+```typescript
+import * as express from 'express';
+
+const app = express();
+const expressRouter = express.Router;
+const router = expressRouter();
+
+appV1.use('/', router);
+
+router.post('/orange_money/payment/:paymentId', (req, res) => {
+  const body = req.body;
+  ...
+  /** 
+   * Your code.......
+    Before updating the payment in your system, retrieve the payment status
+    by using getOrangeMoneyPaymentStatus function and compare the status 
+    received with that sent to your endpoint. This is to ensure the consistency
+    of your system.
+  */
+  ...
+
+  return res.sendStatus(HttpStatusCode.Ok);
+});
+```
+
+### Get Orange Money Payment Status
+
+```typescript
+// Get Orange Money Payment Status
+const paymentStatusResponse = await payment.getOrangeMoneyPaymentStatus({
+  payToken: 'your_pay_token',
+  accessToken: 'your_access_token',
+});
+```
+
+Sometimes Orange Money API will not notify your endpoint url, so we recommend to
+set up a system that will run `getOrangeMoneyPaymentStatus` every 2 min
+depending on your choice.
+
+---
+For more information and detailed API documentation, please refer to the
+official [Y-Note Merchant payment documentation](<https://mega.nz/folder/83dCDKSK#LqI2j3Wgt6s9xJjtH5K9lA>)
+
+---
+
+## Author
+
+👤 **Spreeloop**
+
+- Website: spreeloop.com
+- Github: [@spreeloop](https://github.com/spreeloop)
+
+## 🤝 Contributing
+
+Contributions to the Orange Money Node.js Integration Module are welcome!
+ Please feel free to open [issues](https://github.com/spreeloop/core-ts/issues) or submit pull requests to contribute to the
+  development of this module.
+
+## Show your support
+
+Give a ⭐️ if this project helped you!

package/babel.config.js

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

package/dist/logging/index.d.ts

@@ -0,0 +1,2 @@
+export * from './src/logging';
+//# sourceMappingURL=index.d.ts.map

package/dist/logging/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../logging/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC"}

package/dist/logging/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/logging"), exports);
+//# sourceMappingURL=index.js.map

package/dist/logging/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../logging/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B"}

package/dist/logging/src/log_level.d.ts

@@ -0,0 +1,24 @@
+export declare enum LogLevel {
+    /**
+     * Development verbose information.
+     */
+    DEBUG = 0,
+    /**
+     * Significant messages.
+     */
+    INFO = 1,
+    /**
+     * Really important stuff.
+     */
+    WARN = 2,
+    /**
+     * General purpose error.
+     */
+    ERROR = 3,
+    /**
+     * Disable the logging system.
+     */
+    SILENT = 4
+}
+export declare const LevelName: Record<LogLevel, string>;
+//# sourceMappingURL=log_level.d.ts.map

package/dist/logging/src/log_level.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"log_level.d.ts","sourceRoot":"","sources":["../../../../logging/src/log_level.ts"],"names":[],"mappings":"AAAA,oBAAY,QAAQ;IAClB;;OAEG;IACH,KAAK,IAAA;IACL;;OAEG;IACH,IAAI,IAAA;IACJ;;OAEG;IACH,IAAI,IAAA;IACJ;;OAEG;IACH,KAAK,IAAA;IACL;;OAEG;IACH,MAAM,IAAA;CACP;AAED,eAAO,MAAM,SAAS,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAM9C,CAAC"}

package/dist/logging/src/log_level.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LevelName = exports.LogLevel = void 0;
+var LogLevel;
+(function (LogLevel) {
+    /**
+     * Development verbose information.
+     */
+    LogLevel[LogLevel["DEBUG"] = 0] = "DEBUG";
+    /**
+     * Significant messages.
+     */
+    LogLevel[LogLevel["INFO"] = 1] = "INFO";
+    /**
+     * Really important stuff.
+     */
+    LogLevel[LogLevel["WARN"] = 2] = "WARN";
+    /**
+     * General purpose error.
+     */
+    LogLevel[LogLevel["ERROR"] = 3] = "ERROR";
+    /**
+     * Disable the logging system.
+     */
+    LogLevel[LogLevel["SILENT"] = 4] = "SILENT";
+})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
+exports.LevelName = {
+    [LogLevel.DEBUG]: 'DEBUG',
+    [LogLevel.INFO]: 'INFO',
+    [LogLevel.WARN]: 'WARN',
+    [LogLevel.ERROR]: 'ERROR',
+    [LogLevel.SILENT]: 'SILENT',
+};
+//# sourceMappingURL=log_level.js.map

package/dist/logging/src/log_level.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log_level.js","sourceRoot":"","sources":["../../../../logging/src/log_level.ts"],"names":[],"mappings":";;;AAAA,IAAY,QAqBX;AArBD,WAAY,QAAQ;IAClB;;OAEG;IACH,yCAAK,CAAA;IACL;;OAEG;IACH,uCAAI,CAAA;IACJ;;OAEG;IACH,uCAAI,CAAA;IACJ;;OAEG;IACH,yCAAK,CAAA;IACL;;OAEG;IACH,2CAAM,CAAA;AACR,CAAC,EArBW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAqBnB;AAEY,QAAA,SAAS,GAA6B;IACjD,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO;IACzB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM;IACvB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM;IACvB,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO;IACzB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ;CAC5B,CAAC"}

package/dist/logging/src/logging.d.ts

@@ -0,0 +1,50 @@
+import { LogLevel } from './log_level';
+import { LogPrinter } from './printer';
+/**
+ * The main class of our logging system.
+ */
+export declare class Logger {
+    private name;
+    /**
+     * The lowest log level to use.
+     * Use LogLevel.SILENT to disable printing.
+     */
+    static level: LogLevel;
+    /**
+     * A variable that contains a printer configuration that will be
+     * called for debugging some message to the output.
+     */
+    static printer: LogPrinter;
+    /**
+     * Constructs a new [Logger] implementation.
+     * @param {string} name
+     */
+    constructor(name?: string);
+    /**
+     * Sends a print message to a registered printer.
+     * @param {Object} props
+     * @return {void}
+     */
+    private print;
+    /**
+     * Log a debug level message.
+     * @param {string[]} args
+     */
+    log(...args: string[]): void;
+    /**
+     * Log an info level message.
+     * @param {string[]} args
+     */
+    info(...args: string[]): void;
+    /**
+     * Log a waning level message.
+     * @param {string[]} args
+     */
+    warn(...args: string[]): void;
+    /**
+     * Log an error level message.
+     * @param {string[]} args
+     */
+    error(...args: string[]): void;
+}
+//# sourceMappingURL=logging.d.ts.map

package/dist/logging/src/logging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.d.ts","sourceRoot":"","sources":["../../../../logging/src/logging.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEvC;;GAEG;AACH,qBAAa,MAAM;IAmBL,OAAO,CAAC,IAAI;IAlBxB;;;OAGG;IACH,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAkB;IAExC;;;OAGG;IACH,MAAM,CAAC,OAAO,EAAE,UAAU,CAExB;IAEF;;;OAGG;gBACiB,IAAI,GAAE,MAAW;IAErC;;;;OAIG;IACH,OAAO,CAAC,KAAK;IA0Bb;;;OAGG;IACH,GAAG,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;IAG5B;;;OAGG;IACH,IAAI,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;IAG7B;;;OAGG;IACH,IAAI,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;IAG7B;;;OAGG;IACH,KAAK,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;CAG/B"}

package/dist/logging/src/logging.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = void 0;
+const log_level_1 = require("./log_level");
+/**
+ * The main class of our logging system.
+ */
+class Logger {
+    /**
+     * Constructs a new [Logger] implementation.
+     * @param {string} name
+     */
+    constructor(name = '') {
+        this.name = name;
+    }
+    /**
+     * Sends a print message to a registered printer.
+     * @param {Object} props
+     * @return {void}
+     */
+    print(props) {
+        if (props.level < Logger.level) {
+            return;
+        }
+        Logger.printer({
+            name: this.name,
+            level: props.level,
+            message: props.message,
+        });
+        switch (props.level) {
+            case log_level_1.LogLevel.DEBUG:
+                console.log(props.message);
+                break;
+            case log_level_1.LogLevel.INFO:
+                console.info(props.message);
+                break;
+            case log_level_1.LogLevel.ERROR:
+                console.error(props.message);
+                break;
+            case log_level_1.LogLevel.WARN:
+                console.warn(props.message);
+                break;
+        }
+    }
+    /**
+     * Log a debug level message.
+     * @param {string[]} args
+     */
+    log(...args) {
+        this.print({ level: log_level_1.LogLevel.DEBUG, message: args.join('\n') });
+    }
+    /**
+     * Log an info level message.
+     * @param {string[]} args
+     */
+    info(...args) {
+        this.print({ level: log_level_1.LogLevel.INFO, message: args.join('\n') });
+    }
+    /**
+     * Log a waning level message.
+     * @param {string[]} args
+     */
+    warn(...args) {
+        this.print({ level: log_level_1.LogLevel.WARN, message: args.join('\n') });
+    }
+    /**
+     * Log an error level message.
+     * @param {string[]} args
+     */
+    error(...args) {
+        this.print({ level: log_level_1.LogLevel.ERROR, message: args.join('\n') });
+    }
+}
+exports.Logger = Logger;
+/**
+ * The lowest log level to use.
+ * Use LogLevel.SILENT to disable printing.
+ */
+Logger.level = log_level_1.LogLevel.DEBUG;
+/**
+ * A variable that contains a printer configuration that will be
+ * called for debugging some message to the output.
+ */
+Logger.printer = () => {
+    return;
+};
+//# sourceMappingURL=logging.js.map

package/dist/logging/src/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","sourceRoot":"","sources":["../../../../logging/src/logging.ts"],"names":[],"mappings":";;;AAAA,2CAAuC;AAGvC;;GAEG;AACH,MAAa,MAAM;IAejB;;;OAGG;IACH,YAAoB,OAAe,EAAE;QAAjB,SAAI,GAAJ,IAAI,CAAa;IAAG,CAAC;IAEzC;;;;OAIG;IACK,KAAK,CAAC,KAA2C;QACvD,IAAI,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE;YAC9B,OAAO;SACR;QAED,MAAM,CAAC,OAAO,CAAC;YACb,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,OAAO,EAAE,KAAK,CAAC,OAAO;SACvB,CAAC,CAAC;QACH,QAAQ,KAAK,CAAC,KAAK,EAAE;YACnB,KAAK,oBAAQ,CAAC,KAAK;gBACjB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC3B,MAAM;YACR,KAAK,oBAAQ,CAAC,IAAI;gBAChB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC5B,MAAM;YACR,KAAK,oBAAQ,CAAC,KAAK;gBACjB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC7B,MAAM;YACR,KAAK,oBAAQ,CAAC,IAAI;gBAChB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC5B,MAAM;SACT;IACH,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,GAAG,IAAc;QACnB,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,oBAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClE,CAAC;IACD;;;OAGG;IACH,IAAI,CAAC,GAAG,IAAc;QACpB,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,oBAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjE,CAAC;IACD;;;OAGG;IACH,IAAI,CAAC,GAAG,IAAc;QACpB,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,oBAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjE,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,GAAG,IAAc;QACrB,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,oBAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClE,CAAC;;AA/EH,wBAgFC;AA/EC;;;GAGG;AACI,YAAK,GAAa,oBAAQ,CAAC,KAAK,CAAC;AAExC;;;GAGG;AACI,cAAO,GAAe,GAAG,EAAE;IAChC,OAAO;AACT,CAAC,CAAC"}

package/dist/logging/src/printer.d.ts

@@ -0,0 +1,10 @@
+import { LogLevel } from './log_level';
+export declare type LogPrinterArgs = {
+    name: string;
+    level: LogLevel;
+    message: string;
+    errorObject?: object;
+    stackTrace?: string;
+};
+export declare type LogPrinter = (param: LogPrinterArgs) => void;
+//# sourceMappingURL=printer.d.ts.map

package/dist/logging/src/printer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"printer.d.ts","sourceRoot":"","sources":["../../../../logging/src/printer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,oBAAY,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,QAAQ,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,oBAAY,UAAU,GAAG,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC"}

package/dist/logging/src/printer.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=printer.js.map

package/dist/logging/src/printer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"printer.js","sourceRoot":"","sources":["../../../../logging/src/printer.ts"],"names":[],"mappings":""}