nestjs-monobank 1.2.8

package/dist/modules/wallet/wallet.service.js

@@ -0,0 +1,78 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WalletService = void 0;
+const common_1 = require("@nestjs/common");
+const monobank_http_client_1 = require("../../core/http/monobank.http-client");
+let WalletService = class WalletService {
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+    * Створює токен картки (Card Token) для збереження платіжної картки.
+    *
+    * Використовується для:
+    * - привʼязки картки клієнта
+    * - повторних платежів без повторного введення реквізитів
+    * - роботи з wallet-платежами Monobank
+    *
+    * @param {CreateCardTokenRequest} data - Дані для створення токена картки.
+    * @returns {Promise<CreateCardTokenResponse>} Дані створеного токена картки.
+    *
+    * @example
+    * const data: CreateCardTokenRequest = {
+    *   amount: 100,
+    *   ccy: 980,
+    *   redirectUrl: "https://example.com/success",
+    *   webHookUrl: "https://example.com/webhook"
+    * };
+    *
+    * const token = await this.monobankService.wallet.create(data);
+    * console.log(token.cardToken);
+    */
+    async create(data) {
+        return this.http.post("/merchant/wallet/payment", data);
+    }
+    /**
+    * Отримує інформацію про wallet за його ідентифікатором.
+    *
+    * @param {string} id - Унікальний ідентифікатор wallet.
+    * @returns {Promise<CardTokenResponse>} Дані wallet (привʼязана картка, статус тощо).
+    *
+    * @example
+    * const wallet = await this.monobankService.wallet.getById("wlt_123456");
+    * console.log(wallet);
+    */
+    async getById(id) {
+        return this.http.get(`/merchant/wallet?walletId=${id}`);
+    }
+    /**
+    * Видаляє привʼязану картку за токеном.
+    *
+    * Після видалення:
+    * - токен стає недійсним
+    * - повторні списання по цій картці неможливі
+    *
+    * @param {string} token - Токен картки (cardToken).
+    * @returns {Promise<void>} Результат операції видалення.
+    *
+    * @example
+    * await this.monobankService.wallet.deleteByToken("card_token_abc123");
+    */
+    async deleteByToken(token) {
+        return this.http.delete(`/merchant/wallet/card?cardToken=${token}`);
+    }
+};
+exports.WalletService = WalletService;
+exports.WalletService = WalletService = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [monobank_http_client_1.MonobankHttpClient])
+], WalletService);

package/dist/modules/webhook/webhook.module.d.ts

@@ -0,0 +1,2 @@
+export declare class WebhookModule {
+}

package/dist/modules/webhook/webhook.module.js

@@ -0,0 +1,24 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookModule = void 0;
+const common_1 = require("@nestjs/common");
+const webhook_service_1 = require("./webhook.service");
+const merchant_module_1 = require("../merchant/merchant.module");
+let WebhookModule = class WebhookModule {
+};
+exports.WebhookModule = WebhookModule;
+exports.WebhookModule = WebhookModule = __decorate([
+    (0, common_1.Module)({
+        imports: [
+            merchant_module_1.MerchantModule
+        ],
+        providers: [webhook_service_1.WebhookService],
+        exports: [webhook_service_1.WebhookService]
+    })
+], WebhookModule);

package/dist/modules/webhook/webhook.service.d.ts

@@ -0,0 +1,44 @@
+import { MerchantService } from '../merchant/merchant.service';
+export declare class WebhookService {
+    readonly merchant: MerchantService;
+    constructor(merchant: MerchantService);
+    /**
+    * Верифікує підпис webhook-повідомлення від Monobank.
+    *
+    * Метод:
+    * 1. Отримує публічний ключ мерчанта через Merchant API
+    * 2. Декодує підпис з Base64
+    * 3. Перевіряє цифровий підпис за алгоритмом SHA256
+    *
+    * Використовується для гарантії, що webhook:
+    * - дійсно надісланий Monobank
+    * - не був змінений під час передачі
+    *
+    * @param {Buffer} rawBody - Сире тіло HTTP-запиту (без JSON.parse).
+    * @param {string} xSignBase64 - Значення заголовка `X-Sign` у форматі Base64.
+    *
+    * @returns {Promise<boolean>}
+    * - `true` — підпис валідний
+    * - `false` — підпис невалідний
+    *
+    * @example
+    * // controller.ts
+    * @Post('/mono-webhook')
+    * async handleWebhook(
+    *   @Headers('x-sign') xSign: string,
+    *   @Req() req: RawBodyRequest<Request>
+    * ) {
+    *   const isValid = await this.webhookService.verifyWebhookSignature(
+    *     req.rawBody,
+    *     xSign
+    *   );
+    *
+    *   if (!isValid) {
+    *     throw new UnauthorizedException('Invalid webhook signature');
+    *   }
+    *
+    *   // обробка події
+    * }
+    */
+    verifyWebhookSignature(rawBody: Buffer, xSignBase64: string): Promise<boolean>;
+}

package/dist/modules/webhook/webhook.service.js

@@ -0,0 +1,72 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookService = void 0;
+const common_1 = require("@nestjs/common");
+const merchant_service_1 = require("../merchant/merchant.service");
+const crypto = require("crypto");
+let WebhookService = class WebhookService {
+    constructor(merchant) {
+        this.merchant = merchant;
+    }
+    /**
+    * Верифікує підпис webhook-повідомлення від Monobank.
+    *
+    * Метод:
+    * 1. Отримує публічний ключ мерчанта через Merchant API
+    * 2. Декодує підпис з Base64
+    * 3. Перевіряє цифровий підпис за алгоритмом SHA256
+    *
+    * Використовується для гарантії, що webhook:
+    * - дійсно надісланий Monobank
+    * - не був змінений під час передачі
+    *
+    * @param {Buffer} rawBody - Сире тіло HTTP-запиту (без JSON.parse).
+    * @param {string} xSignBase64 - Значення заголовка `X-Sign` у форматі Base64.
+    *
+    * @returns {Promise<boolean>}
+    * - `true` — підпис валідний
+    * - `false` — підпис невалідний
+    *
+    * @example
+    * // controller.ts
+    * @Post('/mono-webhook')
+    * async handleWebhook(
+    *   @Headers('x-sign') xSign: string,
+    *   @Req() req: RawBodyRequest<Request>
+    * ) {
+    *   const isValid = await this.webhookService.verifyWebhookSignature(
+    *     req.rawBody,
+    *     xSign
+    *   );
+    *
+    *   if (!isValid) {
+    *     throw new UnauthorizedException('Invalid webhook signature');
+    *   }
+    *
+    *   // обробка події
+    * }
+    */
+    async verifyWebhookSignature(rawBody, xSignBase64) {
+        const { key: publicKeyBase64 } = await this.merchant.getMerchantPubkey();
+        const sign = Buffer.from(xSignBase64, "base64");
+        const publicKey = Buffer.from(publicKeyBase64, "base64");
+        const verifier = crypto.createVerify("SHA256");
+        verifier.write(rawBody);
+        verifier.end();
+        return verifier.verify({ key: publicKey, format: "pem", type: "spki" }, sign);
+    }
+};
+exports.WebhookService = WebhookService;
+exports.WebhookService = WebhookService = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [merchant_service_1.MerchantService])
+], WebhookService);

package/dist/monobank.module.d.ts

@@ -0,0 +1,36 @@
+import { type DynamicModule } from "@nestjs/common";
+import { type MonobankModuleAsyncOptions, type MonobankModuleOptions } from './common/interfaces';
+export declare class MonobankModule {
+    /**
+     * Метод для реєстрації модуля з синхронними параметрами.
+     * Цей метод використовується для конфігурації модуля з наперед заданими параметрами.
+     * @param {MonobankModuleOptions} options - Налаштування для конфігурації Monobank API.
+     * @returns {DynamicModule} Повертає динамічний модуль з необхідними провайдерами та імпортами.
+     *
+     * @example
+     * ```ts
+     * MonobankModule.forRoot({
+     *   apiKey: configService.getOrThrow('MONOBANK_API_KEY')
+     * });
+     * ```
+     */
+    static forRoot(options: MonobankModuleOptions): DynamicModule;
+    /**
+     * Метод для реєстрації модуля з асинхронною конфігурацією.
+     * Цей метод використовується для конфігурації модуля з параметрами, які будуть передані через фабричну функцію.
+     * @param {MonobankModuleAsyncOptions} options - Асинхронні параметри для конфігурації Monobank API.
+     * @returns {DynamicModule} Повертає динамічний модуль з необхідними провайдерами та імпортами.
+     *
+     * @example
+     * ```ts
+     * MonobankModule.forRootAsync({
+     *   imports: [ConfigModule],
+     *   useFactory: async (configService: ConfigService) => ({
+     *     apiKey: configService.getOrThrow('MONOBANK_API_KEY')
+     *   }),
+     *   inject: [ConfigService]
+     * });
+     * ```
+     */
+    static forRootAsync(options: MonobankModuleAsyncOptions): DynamicModule;
+}

package/dist/monobank.module.js

@@ -0,0 +1,117 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var MonobankModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MonobankModule = void 0;
+const common_1 = require("@nestjs/common");
+const interfaces_1 = require("./common/interfaces");
+const monobank_service_1 = require("./monobank.service");
+const invoice_module_1 = require("./modules/invoice/invoice.module");
+const merchant_module_1 = require("./modules/merchant/merchant.module");
+const statement_module_1 = require("./modules/statement/statement.module");
+const wallet_module_1 = require("./modules/wallet/wallet.module");
+const webhook_module_1 = require("./modules/webhook/webhook.module");
+const monobank_http_client_1 = require("./core/http/monobank.http-client");
+const subscription_module_1 = require("./modules/subscription/subscription.module");
+const qr_module_1 = require("./modules/qr/qr.module");
+let MonobankModule = MonobankModule_1 = class MonobankModule {
+    /**
+     * Метод для реєстрації модуля з синхронними параметрами.
+     * Цей метод використовується для конфігурації модуля з наперед заданими параметрами.
+     * @param {MonobankModuleOptions} options - Налаштування для конфігурації Monobank API.
+     * @returns {DynamicModule} Повертає динамічний модуль з необхідними провайдерами та імпортами.
+     *
+     * @example
+     * ```ts
+     * MonobankModule.forRoot({
+     *   apiKey: configService.getOrThrow('MONOBANK_API_KEY')
+     * });
+     * ```
+     */
+    static forRoot(options) {
+        return {
+            module: MonobankModule_1,
+            imports: [
+                invoice_module_1.InvoiceModule,
+                merchant_module_1.MerchantModule,
+                statement_module_1.StatementModule,
+                wallet_module_1.WalletModule,
+                qr_module_1.QrModule,
+                subscription_module_1.SubscriptionModule,
+                webhook_module_1.WebhookModule
+            ],
+            providers: [
+                {
+                    provide: interfaces_1.MonobankOptionsSymbol,
+                    useValue: options,
+                },
+                {
+                    provide: monobank_http_client_1.MonobankHttpClient,
+                    useFactory: (cfg) => new monobank_http_client_1.MonobankHttpClient(cfg),
+                    inject: [interfaces_1.MonobankOptionsSymbol]
+                },
+                monobank_service_1.MonobankService,
+            ],
+            exports: [monobank_service_1.MonobankService, monobank_http_client_1.MonobankHttpClient],
+            global: true,
+        };
+    }
+    /**
+     * Метод для реєстрації модуля з асинхронною конфігурацією.
+     * Цей метод використовується для конфігурації модуля з параметрами, які будуть передані через фабричну функцію.
+     * @param {MonobankModuleAsyncOptions} options - Асинхронні параметри для конфігурації Monobank API.
+     * @returns {DynamicModule} Повертає динамічний модуль з необхідними провайдерами та імпортами.
+     *
+     * @example
+     * ```ts
+     * MonobankModule.forRootAsync({
+     *   imports: [ConfigModule],
+     *   useFactory: async (configService: ConfigService) => ({
+     *     apiKey: configService.getOrThrow('MONOBANK_API_KEY')
+     *   }),
+     *   inject: [ConfigService]
+     * });
+     * ```
+     */
+    static forRootAsync(options) {
+        return {
+            module: MonobankModule_1,
+            imports: [
+                ...(options.imports || []),
+                invoice_module_1.InvoiceModule,
+                merchant_module_1.MerchantModule,
+                statement_module_1.StatementModule,
+                wallet_module_1.WalletModule,
+                webhook_module_1.WebhookModule,
+                qr_module_1.QrModule,
+                subscription_module_1.SubscriptionModule,
+                invoice_module_1.InvoiceModule
+            ],
+            providers: [
+                {
+                    provide: interfaces_1.MonobankOptionsSymbol,
+                    useFactory: options.useFactory,
+                    inject: options.inject || []
+                },
+                {
+                    provide: monobank_http_client_1.MonobankHttpClient,
+                    useFactory: (cfg) => new monobank_http_client_1.MonobankHttpClient(cfg),
+                    inject: [interfaces_1.MonobankOptionsSymbol]
+                },
+                monobank_service_1.MonobankService
+            ],
+            exports: [monobank_service_1.MonobankService, monobank_http_client_1.MonobankHttpClient],
+            global: true
+        };
+    }
+};
+exports.MonobankModule = MonobankModule;
+exports.MonobankModule = MonobankModule = MonobankModule_1 = __decorate([
+    (0, common_1.Global)(),
+    (0, common_1.Module)({})
+], MonobankModule);

package/dist/monobank.service.d.ts

@@ -0,0 +1,17 @@
+import { InvoiceService } from './modules/invoice/invoice.service';
+import { MerchantService } from './modules/merchant/merchant.service';
+import { StatementService } from './modules/statement/statement.service';
+import { WalletService } from './modules/wallet/wallet.service';
+import { SubscriptionService } from "./modules/subscription/subscription.service";
+import { WebhookService } from "./modules/webhook/webhook.service";
+import { QrService } from "./modules/qr/qr.service";
+export declare class MonobankService {
+    invoices: InvoiceService;
+    merchants: MerchantService;
+    statements: StatementService;
+    wallets: WalletService;
+    qr: QrService;
+    subscriptions: SubscriptionService;
+    webhook: WebhookService;
+    constructor(invoices: InvoiceService, merchants: MerchantService, statements: StatementService, wallets: WalletService, qr: QrService, subscriptions: SubscriptionService, webhook: WebhookService);
+}

package/dist/monobank.service.js

@@ -0,0 +1,42 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MonobankService = void 0;
+const common_1 = require("@nestjs/common");
+const invoice_service_1 = require("./modules/invoice/invoice.service");
+const merchant_service_1 = require("./modules/merchant/merchant.service");
+const statement_service_1 = require("./modules/statement/statement.service");
+const wallet_service_1 = require("./modules/wallet/wallet.service");
+const subscription_service_1 = require("./modules/subscription/subscription.service");
+const webhook_service_1 = require("./modules/webhook/webhook.service");
+const qr_service_1 = require("./modules/qr/qr.service");
+let MonobankService = class MonobankService {
+    constructor(invoices, merchants, statements, wallets, qr, subscriptions, webhook) {
+        this.invoices = invoices;
+        this.merchants = merchants;
+        this.statements = statements;
+        this.wallets = wallets;
+        this.qr = qr;
+        this.subscriptions = subscriptions;
+        this.webhook = webhook;
+    }
+};
+exports.MonobankService = MonobankService;
+exports.MonobankService = MonobankService = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [invoice_service_1.InvoiceService,
+        merchant_service_1.MerchantService,
+        statement_service_1.StatementService,
+        wallet_service_1.WalletService,
+        qr_service_1.QrService,
+        subscription_service_1.SubscriptionService,
+        webhook_service_1.WebhookService])
+], MonobankService);

package/package.json

@@ -0,0 +1,68 @@
+{
+       "name": "nestjs-monobank",
+       "version": "1.2.8",
+       "description": "A NestJS library for integrating with Monobank API",
+       "author": {
+              "name": "MikroTik_3",
+              "url": "https://docenko.vercel.app"
+       },
+       "contributors": [
+              {
+                     "name": "Artur Docenko",
+                     "email": "dotsenk20034@gmail.com"
+              }
+       ],
+       "keywords": [
+              "nest",
+              "nestjs",
+              "nestjs-module",
+              "monobank",
+              "invoice",
+              "payment"
+       ],
+       "license": "AGPL-3.0-only",
+       "homepage": "https://nestjs-monobank.vercel.app",
+       "repository": "git@github.com:MikroTik3/nestjs-monobank.git",
+       "main": "./dist/index.js",
+       "types": "./dist/index.d.ts",
+       "scripts": {
+              "build": "tsc -p tsconfig.json",
+              "precommit": "lint-staged",
+              "prepublish:npm": "npm run build",
+              "publish:npm": "npm publish --access public",
+              "format": "prettier --write \"src/**/*.ts\"",
+              "lint": "eslint \"{src,apps,libs}/**/*.ts\" --fix"
+       },
+       "dependencies": {
+              "axios": "^1.13.5",
+              "rxjs": "^7.8.1",
+              "undici": "^6.22.0"
+       },
+       "devDependencies": {
+              "@eslint/eslintrc": "^3.2.0",
+              "@eslint/js": "^9.18.0",
+              "@nestjs/cli": "^11.0.0",
+              "@nestjs/common": "^11.0.17",
+              "@nestjs/core": "^11.0.17",
+              "@nestjs/schematics": "^11.0.0",
+              "@nestjs/testing": "^11.0.1",
+              "@types/express": "^5.0.0",
+              "@types/jest": "^29.5.14",
+              "@types/node": "^22.10.7",
+              "@types/supertest": "^6.0.2",
+              "eslint": "^9.18.0",
+              "eslint-config-prettier": "^10.1.2",
+              "eslint-plugin-prettier": "^5.2.2",
+              "globals": "^16.0.0",
+              "jest": "^29.7.0",
+              "prettier": "^3.4.2",
+              "source-map-support": "^0.5.21",
+              "supertest": "^7.0.0",
+              "ts-jest": "^29.2.5",
+              "ts-loader": "^9.5.2",
+              "ts-node": "^10.9.2",
+              "tsconfig-paths": "^4.2.0",
+              "typescript": "^5.7.3",
+              "typescript-eslint": "^8.20.0"
+       }
+}

package/src/common/enums/discount.enum.ts

@@ -0,0 +1,26 @@
+/**
+ * Тип знижки або надбавки.
+ */
+export interface Discount {
+	/**
+	 * Тип:
+	 * - DISCOUNT — знижка
+	 * - EXTRA_CHARGE — надбавка
+	 * Обов’язкове поле.
+	 */
+	type: "DISCOUNT" | "EXTRA_CHARGE";
+
+	/**
+	 * Режим:
+	 * - PERCENT — у відсотках
+	 * - VALUE — фіксоване значення
+	 * Обов’язкове поле.
+	 */
+	mode: "PERCENT" | "VALUE";
+
+	/**
+	 * Значення знижки або надбавки.
+	 * Обов’язкове поле.
+	 */
+	value: number;
+}

package/src/common/enums/index.ts

@@ -0,0 +1 @@
+export * from './discount.enum'