Merge pull request #85 from teacoder-team/dev

Dev

Author: TeaCoder52

README.md

@@ -1,17 +1,32 @@
-# NestJS YooKassa Monorepo
+# NestJS YooKassa
+
+![npm](https://img.shields.io/npm/v/nestjs-yookassa)
+![npm downloads](https://img.shields.io/npm/dm/nestjs-yookassa)
+![license](https://img.shields.io/github/license/teacoder-team/nestjs-yookassa)
+![stars](https://img.shields.io/github/stars/teacoder-team/nestjs-yookassa?style=social)
 
 Этот репозиторий представляет собой монорепозиторий, в котором объединены как библиотека для интеграции с YooKassa API для NestJS, так и различные приложения, связанные с этим проектом.
 
 ## Документация
 
 Основная документация по использованию библиотеки находится в (https://nestjs-yookassa.ru).
 
+## Контрибьюторы
+
+<a href="https://github.com/TeaCoder52">
+  <img src="https://avatars.githubusercontent.com/TeaCoder52" width="100" alt="TeaCoder" />
+</a>
+<a href="https://github.com/rtatarinov">
+  <img src="https://avatars.githubusercontent.com/rtatarinov" width="100" alt="Roman Tatarinov" />
+</a>
+<a href="https://github.com/Color-Kat">
+  <img src="https://avatars.githubusercontent.com/Color-Kat" width="100" alt="Rogov Vladislav" />
+</a>
+
 ## Поддержка
 
 Если у вас возникли вопросы или проблемы, не стесняйтесь обращаться к автору или создавать issues в репозитории.
 
-- Автор: [TeaCoder](https://github.com/TeaCoder52)
-
 ## Лицензия
 
 Этот проект лицензирован под [MIT License](LICENSE).

apps/web/package.json

@@ -3,11 +3,11 @@
 	"version": "0.0.0",
 	"private": true,
 	"scripts": {
-		"build": "next build",
+		"build": "pnpm prepare:docs && next build",
 		"dev": "next dev",
 		"start": "next start -p 5000",
 		"types:check": "fumadocs-mdx && next typegen && tsc --noEmit",
-		"postinstall": "fumadocs-mdx"
+		"prepare:docs": "fumadocs-mdx"
 	},
 	"dependencies": {
 		"fumadocs-core": "16.2.4",

packages/nestjs-yookassa/README.md

@@ -3,3 +3,15 @@
 С помощью этого модуля вы сможете легко создавать и управлять платежами, получать подробную информацию о транзакциях и многое другое.
 
 Документация со всеми подробностями и примерами доступна на [nestjs-yookassa.ru](https://nestjs-yookassa.ru)
+
+## Участники
+
+<a href="https://github.com/TeaCoder52">
+	<img src="https://avatars.githubusercontent.com/TeaCoder52" width="60" />
+</a>
+<a href="https://github.com/rtatarinov">
+	<img src="https://avatars.githubusercontent.com/rtatarinov" width="60" />
+</a>
+<a href="https://github.com/Color-Kat">
+	<img src="https://avatars.githubusercontent.com/Color-Kat" width="60" />
+</a>

packages/nestjs-yookassa/dist/common/types/metadata.type.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Тип для метаданных ЮКасса.
+ *
+ * Ограничения ЮКасса:
+ * - Максимум 16 ключей
+ * - Имя ключа не больше 32 символов
+ * - Значение ключа не больше 512 символов
+ * - Тип данных — строка в формате UTF-8
+ */
+export type YookassaMetadata<T extends Record<string, string> = Record<string, string>> = T;

packages/nestjs-yookassa/dist/common/types/metadata.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

packages/nestjs-yookassa/dist/index.d.ts

@@ -2,6 +2,7 @@ export * from './yookassa.module';
 export * from './yookassa.service';
 export * from './common/enums';
 export * from './common/interfaces';
+export * from './common/types/metadata.type';
 export * from './modules/invoice/interfaces';
 export * from './modules/invoice/enums';
 export * from './modules/payment/interfaces';
@@ -12,4 +13,7 @@ export * from './modules/receipt/interfaces';
 export * from './modules/receipt/enums';
 export * from './modules/refund/interfaces';
 export * from './modules/refund/enums';
-export * from './webhook';
+export * from './webhook/enums';
+export * from './webhook/interfaces';
+export * from './webhook/decorators';
+export * from './webhook/guards/yookassa-webhook.guard';

packages/nestjs-yookassa/dist/index.js

@@ -20,6 +20,7 @@ __exportStar(require("./yookassa.service"), exports);
 // Common
 __exportStar(require("./common/enums"), exports);
 __exportStar(require("./common/interfaces"), exports);
+__exportStar(require("./common/types/metadata.type"), exports);
 // Invoice domain
 __exportStar(require("./modules/invoice/interfaces"), exports);
 __exportStar(require("./modules/invoice/enums"), exports);
@@ -35,5 +36,8 @@ __exportStar(require("./modules/receipt/enums"), exports);
 // Refund domain
 __exportStar(require("./modules/refund/interfaces"), exports);
 __exportStar(require("./modules/refund/enums"), exports);
-// Webhook
-__exportStar(require("./webhook"), exports);
+// Webhook domain
+__exportStar(require("./webhook/enums"), exports);
+__exportStar(require("./webhook/interfaces"), exports);
+__exportStar(require("./webhook/decorators"), exports);
+__exportStar(require("./webhook/guards/yookassa-webhook.guard"), exports);

packages/nestjs-yookassa/dist/modules/invoice/interfaces/requests/create-invoice.request.d.ts

@@ -2,6 +2,7 @@ import type { LocaleEnum } from '../../../../common/enums';
 import type { Amount } from '../../../../common/interfaces';
 import type { Receipt, Recipient } from '../../../payment/interfaces';
 import type { DeliveryMethodEnum } from '../../enums';
+import type { YookassaMetadata } from '../../../../common/types/metadata.type';
 /**
  * Элемент корзины
  */
@@ -25,7 +26,7 @@ export interface DeliveryMethodData {
 /**
  * Основной объект для создания счета
  */
-export interface CreateInvoiceRequest {
+export interface CreateInvoiceRequest<T extends YookassaMetadata = YookassaMetadata> {
     /**
      * Данные для проведения платежа по выставленному счету.
      */
@@ -45,7 +46,7 @@ export interface CreateInvoiceRequest {
         /** Описание счета */
         description?: string;
         /** Дополнительные метаданные */
-        metadata?: Record<string, string>;
+        metadata?: T;
     };
     /** Корзина заказа */
     cart: CartItem[];

packages/nestjs-yookassa/dist/modules/invoice/interfaces/responses/create-invoice.response.d.ts

@@ -1,3 +1,4 @@
 import type { Invoice } from './invoice.response';
-export interface CreateInvoiceResponse extends Invoice {
+import type { YookassaMetadata } from '../../../../common/types/metadata.type';
+export interface CreateInvoiceResponse<T extends YookassaMetadata = YookassaMetadata> extends Invoice<T> {
 }

packages/nestjs-yookassa/dist/modules/invoice/interfaces/responses/invoice.response.d.ts

@@ -1,6 +1,7 @@
 import type { Payment } from '../../../payment/interfaces';
 import type { InvoiceCancellationPartyEnum, InvoiceCancellationReasonEnum, InvoiceStatusEnum } from '../../enums';
 import type { CartItem } from '../requests';
+import type { YookassaMetadata } from '../../../../common/types/metadata.type';
 /**
  * Способ доставки счета
  */
@@ -22,7 +23,7 @@ export interface InvoiceCancellationDetails {
 /**
  * Детали счета
  */
-export interface Invoice {
+export interface Invoice<T extends YookassaMetadata = YookassaMetadata> {
     /** Идентификатор счета в ЮKassa */
     id: string;
     /** Статус счета */
@@ -32,7 +33,7 @@ export interface Invoice {
     /** Данные о выбранном способе доставки счета */
     delivery_method?: DeliveryMethod;
     /** Данные о платеже по счету (если успешно оплачен) */
-    payment_details?: Payment;
+    payment_details?: Payment<T>;
     /** Дата и время создания счета (ISO 8601) */
     created_at: string;
     /** Срок действия счета (ISO 8601), для счетов pending */
@@ -42,5 +43,5 @@ export interface Invoice {
     /** Детали отмены счета */
     cancellation_details?: InvoiceCancellationDetails;
     /** Дополнительные метаданные (ключ-значение) */
-    metadata?: Record<string, string>;
+    metadata?: T;
 }