moosyl 0.0.1 → 0.0.3

package/README.md

@@ -2,7 +2,7 @@
 
 [![npm version](https://img.shields.io/npm/v/moosyl.svg)](https://www.npmjs.com/package/moosyl)
 
-The **Moosyl JavaScript SDK** helps you integrate payment solutions with Mauritania's popular banking apps—such as **Bankily**, **Sedad**, and **Masrivi**—in Node.js or the browser. Use it to fetch available payment methods and payment request details from the Moosyl API.
+The **Moosyl JavaScript SDK** helps you integrate payment solutions with Mauritania's popular banking apps—such as **Bankily**, **Sedad**, and **Masrivi**—in Node.js or the browser. Use it to fetch available payment methods, payment request details, and process payments (auto or manual) via the Moosyl API.
 
 ---
 
@@ -10,6 +10,7 @@ The **Moosyl JavaScript SDK** helps you integrate payment solutions with Maurita
 
 - **Payment methods**: Fetch available payment methods (including testing mode).
 - **Payment request**: Get payment request details by transaction ID.
+- **Pay**: Process automatic payments (e.g. Bankily) or manual payments with a screenshot.
 - **Lightweight**: No UI; use your own front end or backend flows.
 - **ESM**: Native ES modules (`import`).
 
@@ -25,30 +26,31 @@ Install the package:
 npm install moosyl
 ```
 
-### Import the package
+### Create a Moosyl instance
+
+Create a single client with your publishable API key. All operations use this instance:
 
 ```javascript
-import {
-  GetPaymentMethodsService,
-  GetPaymentRequestService,
-  PaymentRequestModel,
-  PaymentMethodTitles,
-} from "moosyl";
+import { Moosyl, PaymentMethodTitles } from "moosyl";
+
+const moosyl = new Moosyl("YOUR_PUBLISHABLE_API_KEY");
 ```
 
 ---
 
 ## Usage
 
+All functionality is available on the **Moosyl** instance: `moosyl.getPaymentMethods()`, `moosyl.getPaymentRequest()`, `moosyl.pay()`, and `moosyl.manualPay()`.
+
 ### Fetch payment methods
 
 Get the list of payment methods (e.g. to show options to the user):
 
 ```javascript
-import { GetPaymentMethodsService } from "moosyl";
+import { Moosyl, PaymentMethodTitles } from "moosyl";
 
-const service = new GetPaymentMethodsService("YOUR_PUBLISHABLE_API_KEY");
-const methods = await service.get(true); // true = testing mode
+const moosyl = new Moosyl("YOUR_PUBLISHABLE_API_KEY");
+const methods = await moosyl.getPaymentMethods(true); // true = testing mode
 
 methods.forEach((m) => {
   const title = PaymentMethodTitles[m.method] ?? m.method;
@@ -62,10 +64,10 @@ methods.forEach((m) => {
 Get details for a given transaction (after creating a payment request from your backend):
 
 ```javascript
-import { GetPaymentRequestService } from "moosyl";
+import { Moosyl } from "moosyl";
 
-const service = new GetPaymentRequestService("YOUR_PUBLISHABLE_API_KEY");
-const request = await service.get("TRANSACTION_ID");
+const moosyl = new Moosyl("YOUR_PUBLISHABLE_API_KEY");
+const request = await moosyl.getPaymentRequest("TRANSACTION_ID");
 
 console.log(request.id, request.amount, request.phoneNumber);
 ```
@@ -85,29 +87,55 @@ curl -X POST https://api.moosyl.com/payment-request \
   }'
 ```
 
-Once created, use the returned **transactionId** with `GetPaymentRequestService` and your payment flow.
+Once created, use the returned **transactionId** with `moosyl.getPaymentRequest()` and your payment flow.
 
----
+### Process payment (auto)
+
+For automatic payment methods (e.g. Bankily):
+
+```javascript
+import { Moosyl } from "moosyl";
 
-## API overview
+const moosyl = new Moosyl("YOUR_PUBLISHABLE_API_KEY");
 
-| Export                                                     | Description                                            |
-| ---------------------------------------------------------- | ------------------------------------------------------ |
-| `GetPaymentMethodsService`                                 | Fetches available payment methods.                     |
-| `GetPaymentRequestService`                                 | Fetches payment request by transaction ID.             |
-| `PaymentRequestModel`                                      | Model for payment request (id, amount, phoneNumber).   |
-| `PaymentMethod`, `BankilyConfigModel`, `ManualConfigModel` | Payment method models.                                 |
-| `PaymentMethodTitles`                                      | Display names for payment method types.                |
-| `PaymentType`, `PaymentMethodTypes`                        | Enums/constants for method and type.                   |
-| `Fetcher`, `Endpoints`                                     | Low-level HTTP client and API URLs (for advanced use). |
-| `AppException`                                             | Error type thrown on failed API calls.                 |
+await moosyl.pay(
+  "TRANSACTION_ID",
+  "+22212345678",
+  "PASSCODE",
+  "PAYMENT_METHOD_ID" // configuration ID from getPaymentMethods()
+);
+```
+
+### Process manual payment
+
+For manual payment methods, send a screenshot (File in the browser, or `{ name, data, type? }` in Node):
+
+```javascript
+import { Moosyl } from "moosyl";
+
+const moosyl = new Moosyl("YOUR_PUBLISHABLE_API_KEY");
+
+// Browser: pass a File from an input
+await moosyl.manualPay(
+  "TRANSACTION_ID",
+  "PAYMENT_METHOD_ID",
+  fileInput.files[0]
+);
+
+// Node: pass { name, data (Buffer), type? }
+await moosyl.manualPay("TRANSACTION_ID", "PAYMENT_METHOD_ID", {
+  name: "proof.png",
+  data: imageBuffer,
+  type: "image/png",
+});
+```
 
 ---
 
 ## Configuration
 
-- **API key**: Use your **publishable** API key for `GetPaymentMethodsService` and `GetPaymentRequestService`. Get keys at [moosyl.com](https://moosyl.com).
-- **Testing mode**: Pass `true` to `GetPaymentMethodsService#get(isTestingMode)` for test configuration.
+- **API key**: Use your **publishable** API key when creating `new Moosyl(apiKey)`. Get keys at [moosyl.com](https://moosyl.com).
+- **Testing mode**: Pass `true` to `moosyl.getPaymentMethods(true)` for test configuration.
 
 ---
 

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 /**
  * Moosyl JS – integrating payment solutions with Mauritania's popular banking apps.
  */
+export { Moosyl } from './src/moosyl.js';
 export { Fetcher, FetcherResponse, Endpoints } from './src/helpers/fetcher.js';
 export { AppException, AppExceptionCode } from './src/helpers/exceptions.js';
 export { PaymentType, PaymentMethodTypes, PaymentMethodTitles, paymentTypeFromString, paymentMethodTypesFromString, PaymentMethod, BankilyConfigModel, ManualConfigModel, } from './src/models/payment-method-model.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAE7E,OAAO,EACL,WAAW,EACX,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,sCAAsC,CAAC;AAC9C,YAAY,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AAEtG,OAAO,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAC;AAE5E,OAAO,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAC;AACzF,OAAO,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAC;AACzF,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,YAAY,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAEzC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAE7E,OAAO,EACL,WAAW,EACX,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,sCAAsC,CAAC;AAC9C,YAAY,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AAEtG,OAAO,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAC;AAE5E,OAAO,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAC;AACzF,OAAO,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAC;AACzF,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,YAAY,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC"}

package/dist/index.js

@@ -1,6 +1,7 @@
 /**
  * Moosyl JS – integrating payment solutions with Mauritania's popular banking apps.
  */
+export { Moosyl } from './src/moosyl.js';
 export { Fetcher, FetcherResponse, Endpoints } from './src/helpers/fetcher.js';
 export { AppException, AppExceptionCode } from './src/helpers/exceptions.js';
 export { PaymentType, PaymentMethodTypes, PaymentMethodTitles, paymentTypeFromString, paymentMethodTypesFromString, PaymentMethod, BankilyConfigModel, ManualConfigModel, } from './src/models/payment-method-model.js';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAE7E,OAAO,EACL,WAAW,EACX,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,sCAAsC,CAAC;AAG9C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAC;AAE5E,OAAO,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAC;AACzF,OAAO,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAC;AACzF,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAEzC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAE7E,OAAO,EACL,WAAW,EACX,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,sCAAsC,CAAC;AAG9C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAC;AAE5E,OAAO,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAC;AACzF,OAAO,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAC;AACzF,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC"}

package/dist/src/moosyl.d.ts

@@ -0,0 +1,47 @@
+import type { PaymentMethod } from './models/payment-method-model.js';
+import type { PaymentRequestModel } from './models/payment-request-model.js';
+import type { FetcherResponse } from './helpers/fetcher.js';
+import type { ManualPayImageInput } from './services/pay-service.js';
+/**
+ * Main Moosyl SDK client. Create an instance with your publishable API key,
+ * then use the methods to fetch payment methods, payment requests, and process payments.
+ */
+export declare class Moosyl {
+    private readonly getPaymentMethodsService;
+    private readonly getPaymentRequestService;
+    private readonly payService;
+    /**
+     * @param apiKey - Your Moosyl publishable API key
+     */
+    constructor(apiKey: string);
+    /**
+     * Fetches available payment methods (e.g. Bankily, Sedad, Masrivi).
+     * @param isTestingMode - Pass `true` for test configuration
+     * @returns List of payment methods
+     */
+    getPaymentMethods(isTestingMode: boolean): Promise<PaymentMethod[]>;
+    /**
+     * Fetches payment request details for a transaction.
+     * @param transactionId - The transaction ID from your backend
+     * @returns Payment request (id, amount, phoneNumber)
+     */
+    getPaymentRequest(transactionId: string): Promise<PaymentRequestModel>;
+    /**
+     * Processes an automatic payment (e.g. Bankily).
+     * @param transactionId - Transaction ID
+     * @param phoneNumber - Customer phone number
+     * @param passCode - Customer passcode
+     * @param paymentMethodId - Configuration ID from getPaymentMethods()
+     * @returns API response
+     */
+    pay(transactionId: string, phoneNumber: string, passCode: string, paymentMethodId: string): Promise<FetcherResponse>;
+    /**
+     * Processes a manual payment with a screenshot.
+     * @param transactionId - Transaction ID
+     * @param paymentMethodId - Configuration ID from getPaymentMethods()
+     * @param selectedImage - File (browser) or { name, data, type? } (Node)
+     * @returns API response
+     */
+    manualPay(transactionId: string, paymentMethodId: string, selectedImage: ManualPayImageInput): Promise<FetcherResponse>;
+}
+//# sourceMappingURL=moosyl.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"moosyl.d.ts","sourceRoot":"","sources":["../../src/moosyl.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAC7E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAErE;;;GAGG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAA2B;IACpE,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAA2B;IACpE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IAExC;;OAEG;gBACS,MAAM,EAAE,MAAM;IAM1B;;;;OAIG;IACH,iBAAiB,CAAC,aAAa,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAInE;;;;OAIG;IACH,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAItE;;;;;;;OAOG;IACH,GAAG,CACD,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,eAAe,CAAC;IAI3B;;;;;;OAMG;IACH,SAAS,CACP,aAAa,EAAE,MAAM,EACrB,eAAe,EAAE,MAAM,EACvB,aAAa,EAAE,mBAAmB,GACjC,OAAO,CAAC,eAAe,CAAC;CAG5B"}

package/dist/src/moosyl.js

@@ -0,0 +1,58 @@
+import { GetPaymentMethodsService } from './services/get-payment-methods-service.js';
+import { GetPaymentRequestService } from './services/get-payment-request-service.js';
+import { PayService } from './services/pay-service.js';
+/**
+ * Main Moosyl SDK client. Create an instance with your publishable API key,
+ * then use the methods to fetch payment methods, payment requests, and process payments.
+ */
+export class Moosyl {
+    getPaymentMethodsService;
+    getPaymentRequestService;
+    payService;
+    /**
+     * @param apiKey - Your Moosyl publishable API key
+     */
+    constructor(apiKey) {
+        this.getPaymentMethodsService = new GetPaymentMethodsService(apiKey);
+        this.getPaymentRequestService = new GetPaymentRequestService(apiKey);
+        this.payService = new PayService(apiKey);
+    }
+    /**
+     * Fetches available payment methods (e.g. Bankily, Sedad, Masrivi).
+     * @param isTestingMode - Pass `true` for test configuration
+     * @returns List of payment methods
+     */
+    getPaymentMethods(isTestingMode) {
+        return this.getPaymentMethodsService.get(isTestingMode);
+    }
+    /**
+     * Fetches payment request details for a transaction.
+     * @param transactionId - The transaction ID from your backend
+     * @returns Payment request (id, amount, phoneNumber)
+     */
+    getPaymentRequest(transactionId) {
+        return this.getPaymentRequestService.get(transactionId);
+    }
+    /**
+     * Processes an automatic payment (e.g. Bankily).
+     * @param transactionId - Transaction ID
+     * @param phoneNumber - Customer phone number
+     * @param passCode - Customer passcode
+     * @param paymentMethodId - Configuration ID from getPaymentMethods()
+     * @returns API response
+     */
+    pay(transactionId, phoneNumber, passCode, paymentMethodId) {
+        return this.payService.pay(transactionId, phoneNumber, passCode, paymentMethodId);
+    }
+    /**
+     * Processes a manual payment with a screenshot.
+     * @param transactionId - Transaction ID
+     * @param paymentMethodId - Configuration ID from getPaymentMethods()
+     * @param selectedImage - File (browser) or { name, data, type? } (Node)
+     * @returns API response
+     */
+    manualPay(transactionId, paymentMethodId, selectedImage) {
+        return this.payService.manualPay(transactionId, paymentMethodId, selectedImage);
+    }
+}
+//# sourceMappingURL=moosyl.js.map

package/dist/src/moosyl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"moosyl.js","sourceRoot":"","sources":["../../src/moosyl.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,2CAA2C,CAAC;AACrF,OAAO,EAAE,wBAAwB,EAAE,MAAM,2CAA2C,CAAC;AACrF,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAMvD;;;GAGG;AACH,MAAM,OAAO,MAAM;IACA,wBAAwB,CAA2B;IACnD,wBAAwB,CAA2B;IACnD,UAAU,CAAa;IAExC;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,wBAAwB,GAAG,IAAI,wBAAwB,CAAC,MAAM,CAAC,CAAC;QACrE,IAAI,CAAC,wBAAwB,GAAG,IAAI,wBAAwB,CAAC,MAAM,CAAC,CAAC;QACrE,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,aAAsB;QACtC,OAAO,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,aAAqB;QACrC,OAAO,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CACD,aAAqB,EACrB,WAAmB,EACnB,QAAgB,EAChB,eAAuB;QAEvB,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,aAAa,EAAE,WAAW,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;OAMG;IACH,SAAS,CACP,aAAqB,EACrB,eAAuB,EACvB,aAAkC;QAElC,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,aAAa,EAAE,eAAe,EAAE,aAAa,CAAC,CAAC;IAClF,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "moosyl",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "integrating payment solutions with Mauritania's popular banking apps",
   "type": "module",
   "main": "dist/index.js",
@@ -34,5 +34,8 @@
     "url": "https://github.com/SoftwareSavants/moosyl_js/issues"
   },
   "homepage": "https://github.com/SoftwareSavants/moosyl_js#readme",
-  "files": ["dist", "README.md"]
+  "files": [
+    "dist",
+    "README.md"
+  ]
 }