@aepstore-dev/contracts 1.11.0 → 1.13.0

package/dist/proto/paths.d.ts

@@ -2,6 +2,7 @@ export declare const PROTO_PATHS: {
     readonly ACTIVITY: string;
     readonly AUTH: string;
     readonly MAIL: string;
+    readonly PAYMENTS: string;
     readonly PRODUCTS: string;
     readonly SUPPORT: string;
     readonly TAXONOMY: string;
@@ -12,6 +13,7 @@ export declare const PROTO_PACKAGES: {
     readonly ACTIVITY: "activity.v1";
     readonly AUTH: "auth.v1";
     readonly MAIL: "mail.v1";
+    readonly PAYMENTS: "payments.v1";
     readonly PRODUCTS: "products.v1";
     readonly SUPPORT: "support.v1";
     readonly TAXONOMY: "taxonomy.v1";

package/dist/proto/paths.js

@@ -7,6 +7,7 @@ exports.PROTO_PATHS = {
     ACTIVITY: (0, path_1.join)(PROTO_DIR, "activity.proto"),
     AUTH: (0, path_1.join)(PROTO_DIR, "auth.proto"),
     MAIL: (0, path_1.join)(PROTO_DIR, "mail.proto"),
+    PAYMENTS: (0, path_1.join)(PROTO_DIR, "payments.proto"),
     PRODUCTS: (0, path_1.join)(PROTO_DIR, "products.proto"),
     SUPPORT: (0, path_1.join)(PROTO_DIR, "support.proto"),
     TAXONOMY: (0, path_1.join)(PROTO_DIR, "taxonomy.proto"),
@@ -17,6 +18,7 @@ exports.PROTO_PACKAGES = {
     ACTIVITY: "activity.v1",
     AUTH: "auth.v1",
     MAIL: "mail.v1",
+    PAYMENTS: "payments.v1",
     PRODUCTS: "products.v1",
     SUPPORT: "support.v1",
     TAXONOMY: "taxonomy.v1",

package/gen/payments.ts

@@ -0,0 +1,466 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.10.1
+//   protoc               v7.35.0
+// source: payments.proto
+
+/* eslint-disable */
+import { GrpcMethod, GrpcStreamMethod } from "@nestjs/microservices";
+import { Observable } from "rxjs";
+
+export const protobufPackage = "payments.v1";
+
+export interface Ok {
+  ok: boolean;
+}
+
+/**
+ * ---------------------------------------------------------------------------
+ * Purchase / checkout / topup
+ * ---------------------------------------------------------------------------
+ */
+export interface Purchase {
+  id: string;
+  productId: string;
+  productName: string;
+  userId: string;
+  price: string;
+  /** PENDING | COMPLETED | FAILED | REFUNDED */
+  status: string;
+  paymentId: string;
+  /** BALANCE | YOOKASSA */
+  paymentMethod: string;
+  commissionPercent: string;
+  sellerAmount: string;
+  createdAt: string;
+  completedAt: string;
+}
+
+export interface TopupRequest {
+  userId: string;
+  /** >= 10.00 */
+  amount: string;
+  returnUrl: string;
+}
+
+export interface CreateCheckoutRequest {
+  userId: string;
+  productId: string;
+  /** BALANCE | YOOKASSA (default YOOKASSA) */
+  paymentMethod: string;
+  returnUrl: string;
+}
+
+export interface CheckoutResponse {
+  purchaseId: string;
+  paymentId: string;
+  /** empty when paid from balance (instant) */
+  confirmationUrl: string;
+  /** PENDING (redirect) | COMPLETED (balance) */
+  status: string;
+}
+
+export interface GetMyPurchasesRequest {
+  userId: string;
+  page: number;
+  limit: number;
+}
+
+export interface PurchasesListResponse {
+  items: Purchase[];
+  total: number;
+  page: number;
+  limit: number;
+}
+
+export interface GetPurchaseRequest {
+  id: string;
+  userId: string;
+}
+
+export interface RefundPurchaseRequest {
+  purchaseId: string;
+  actorUserId: string;
+  isAdmin: boolean;
+  reason: string;
+}
+
+/**
+ * ---------------------------------------------------------------------------
+ * Wallet & statement
+ * ---------------------------------------------------------------------------
+ */
+export interface GetWalletRequest {
+  userId: string;
+}
+
+export interface WalletResponse {
+  spending: string;
+  pending: string;
+  payout: string;
+  /** spending + payout */
+  spendable: string;
+  /** payout */
+  withdrawable: string;
+  currency: string;
+  lifetimeSales: number;
+  currentCommissionPercent: string;
+}
+
+export interface ListTransactionsRequest {
+  userId: string;
+  /** optional filter (TOPUP|PURCHASE|SALE_CLEAR|WITHDRAWAL|REFUND|ADJUSTMENT) */
+  type: string;
+  page: number;
+  limit: number;
+}
+
+export interface StatementEntry {
+  /** ledger entry id */
+  id: string;
+  txId: string;
+  /** tx type */
+  type: string;
+  /** which of the user's accounts */
+  accountKind: string;
+  /** DEBIT | CREDIT */
+  direction: string;
+  amount: string;
+  description: string;
+  createdAt: string;
+}
+
+export interface TransactionsListResponse {
+  items: StatementEntry[];
+  total: number;
+  page: number;
+  limit: number;
+}
+
+/**
+ * ---------------------------------------------------------------------------
+ * Withdrawals
+ * ---------------------------------------------------------------------------
+ */
+export interface Withdrawal {
+  id: string;
+  sellerId: string;
+  amount: string;
+  /** PENDING | PROCESSING | COMPLETED | REJECTED */
+  status: string;
+  method: string;
+  details: string;
+  comment: string;
+  processedBy: string;
+  processedAt: string;
+  createdAt: string;
+}
+
+export interface RequestWithdrawalRequest {
+  sellerId: string;
+  amount: string;
+  method: string;
+  details: string;
+}
+
+export interface ListWithdrawalsRequest {
+  sellerId: string;
+  status: string;
+  page: number;
+  limit: number;
+}
+
+export interface WithdrawalsListResponse {
+  items: Withdrawal[];
+  total: number;
+  page: number;
+  limit: number;
+}
+
+export interface ProcessWithdrawalRequest {
+  withdrawalId: string;
+  adminId: string;
+  action: string;
+  comment: string;
+}
+
+/**
+ * ---------------------------------------------------------------------------
+ * Webhook
+ * ---------------------------------------------------------------------------
+ */
+export interface PaymentEventRequest {
+  event: string;
+  paymentId: string;
+}
+
+/**
+ * ---------------------------------------------------------------------------
+ * Admin
+ * ---------------------------------------------------------------------------
+ */
+export interface AdminOverviewRequest {
+  from: string;
+  to: string;
+}
+
+export interface AdminOverviewResponse {
+  /** platform commission earned (period) */
+  revenue: string;
+  /** gross merchandise value (period) */
+  gmv: string;
+  /** Σ all users' (pending+payout+spending) — what we owe */
+  liabilities: string;
+  /** money in transit at PSP */
+  pspClearing: string;
+  /** reserved for approved withdrawals */
+  payoutsPayable: string;
+  refundsTotal: string;
+  topupsTotal: string;
+  withdrawalsTotal: string;
+  salesCount: number;
+  currency: string;
+}
+
+export interface AdminListTransactionsRequest {
+  type: string;
+  userId: string;
+  accountKind: string;
+  from: string;
+  to: string;
+  page: number;
+  limit: number;
+}
+
+export interface AdminEntry {
+  accountId: string;
+  accountKind: string;
+  ownerId: string;
+  direction: string;
+  amount: string;
+}
+
+export interface AdminLedgerTx {
+  id: string;
+  type: string;
+  status: string;
+  refType: string;
+  refId: string;
+  description: string;
+  createdBy: string;
+  createdAt: string;
+  entries: AdminEntry[];
+}
+
+export interface AdminTransactionsListResponse {
+  items: AdminLedgerTx[];
+  total: number;
+  page: number;
+  limit: number;
+}
+
+export interface GetUserFinanceRequest {
+  userId: string;
+}
+
+export interface AccountBalance {
+  kind: string;
+  balance: string;
+  currency: string;
+}
+
+export interface UserFinanceResponse {
+  wallet: WalletResponse | undefined;
+  accounts: AccountBalance[];
+  recent: StatementEntry[];
+}
+
+export interface CreateAdjustmentRequest {
+  adminId: string;
+  userId: string;
+  /** USER_SPENDING | USER_PAYOUT | USER_PENDING */
+  accountKind: string;
+  /** CREDIT (give) | DEBIT (take) */
+  direction: string;
+  amount: string;
+  reason: string;
+}
+
+export interface SalesAnalyticsRequest {
+  from: string;
+  to: string;
+  granularity: string;
+}
+
+export interface SalesPoint {
+  date: string;
+  salesCount: number;
+  gmv: string;
+  revenue: string;
+}
+
+export interface SellerStat {
+  sellerId: string;
+  username: string;
+  sales: number;
+  gmv: string;
+}
+
+export interface SalesAnalyticsResponse {
+  points: SalesPoint[];
+  topSellers: SellerStat[];
+  /** % refunded purchases */
+  refundRate: string;
+}
+
+export const PAYMENTS_V1_PACKAGE_NAME = "payments.v1";
+
+/**
+ * Commerce + double-entry wallet/ledger (D9 / D9.2). See payments-service/docs/FINANCE.md.
+ * Money = Decimal-as-string (D7). Statuses/enums as strings (avoid proto enum
+ * value-name clashes within one package).
+ */
+
+export interface PaymentsServiceClient {
+  /** ----- buyer ----- */
+
+  topup(request: TopupRequest): Observable<CheckoutResponse>;
+
+  createCheckout(request: CreateCheckoutRequest): Observable<CheckoutResponse>;
+
+  getMyPurchases(request: GetMyPurchasesRequest): Observable<PurchasesListResponse>;
+
+  getPurchase(request: GetPurchaseRequest): Observable<Purchase>;
+
+  refundPurchase(request: RefundPurchaseRequest): Observable<Purchase>;
+
+  /** ----- wallet ----- */
+
+  getWallet(request: GetWalletRequest): Observable<WalletResponse>;
+
+  listTransactions(request: ListTransactionsRequest): Observable<TransactionsListResponse>;
+
+  /** ----- withdrawals ----- */
+
+  requestWithdrawal(request: RequestWithdrawalRequest): Observable<Withdrawal>;
+
+  listWithdrawals(request: ListWithdrawalsRequest): Observable<WithdrawalsListResponse>;
+
+  processWithdrawal(request: ProcessWithdrawalRequest): Observable<Withdrawal>;
+
+  /** ----- provider webhook (gateway forwards a verified event) ----- */
+
+  handlePaymentEvent(request: PaymentEventRequest): Observable<Ok>;
+
+  /** ----- admin ----- */
+
+  getAdminOverview(request: AdminOverviewRequest): Observable<AdminOverviewResponse>;
+
+  adminListTransactions(request: AdminListTransactionsRequest): Observable<AdminTransactionsListResponse>;
+
+  getUserFinance(request: GetUserFinanceRequest): Observable<UserFinanceResponse>;
+
+  createAdjustment(request: CreateAdjustmentRequest): Observable<Ok>;
+
+  getSalesAnalytics(request: SalesAnalyticsRequest): Observable<SalesAnalyticsResponse>;
+}
+
+/**
+ * Commerce + double-entry wallet/ledger (D9 / D9.2). See payments-service/docs/FINANCE.md.
+ * Money = Decimal-as-string (D7). Statuses/enums as strings (avoid proto enum
+ * value-name clashes within one package).
+ */
+
+export interface PaymentsServiceController {
+  /** ----- buyer ----- */
+
+  topup(request: TopupRequest): Promise<CheckoutResponse> | Observable<CheckoutResponse> | CheckoutResponse;
+
+  createCheckout(
+    request: CreateCheckoutRequest,
+  ): Promise<CheckoutResponse> | Observable<CheckoutResponse> | CheckoutResponse;
+
+  getMyPurchases(
+    request: GetMyPurchasesRequest,
+  ): Promise<PurchasesListResponse> | Observable<PurchasesListResponse> | PurchasesListResponse;
+
+  getPurchase(request: GetPurchaseRequest): Promise<Purchase> | Observable<Purchase> | Purchase;
+
+  refundPurchase(request: RefundPurchaseRequest): Promise<Purchase> | Observable<Purchase> | Purchase;
+
+  /** ----- wallet ----- */
+
+  getWallet(request: GetWalletRequest): Promise<WalletResponse> | Observable<WalletResponse> | WalletResponse;
+
+  listTransactions(
+    request: ListTransactionsRequest,
+  ): Promise<TransactionsListResponse> | Observable<TransactionsListResponse> | TransactionsListResponse;
+
+  /** ----- withdrawals ----- */
+
+  requestWithdrawal(request: RequestWithdrawalRequest): Promise<Withdrawal> | Observable<Withdrawal> | Withdrawal;
+
+  listWithdrawals(
+    request: ListWithdrawalsRequest,
+  ): Promise<WithdrawalsListResponse> | Observable<WithdrawalsListResponse> | WithdrawalsListResponse;
+
+  processWithdrawal(request: ProcessWithdrawalRequest): Promise<Withdrawal> | Observable<Withdrawal> | Withdrawal;
+
+  /** ----- provider webhook (gateway forwards a verified event) ----- */
+
+  handlePaymentEvent(request: PaymentEventRequest): Promise<Ok> | Observable<Ok> | Ok;
+
+  /** ----- admin ----- */
+
+  getAdminOverview(
+    request: AdminOverviewRequest,
+  ): Promise<AdminOverviewResponse> | Observable<AdminOverviewResponse> | AdminOverviewResponse;
+
+  adminListTransactions(
+    request: AdminListTransactionsRequest,
+  ): Promise<AdminTransactionsListResponse> | Observable<AdminTransactionsListResponse> | AdminTransactionsListResponse;
+
+  getUserFinance(
+    request: GetUserFinanceRequest,
+  ): Promise<UserFinanceResponse> | Observable<UserFinanceResponse> | UserFinanceResponse;
+
+  createAdjustment(request: CreateAdjustmentRequest): Promise<Ok> | Observable<Ok> | Ok;
+
+  getSalesAnalytics(
+    request: SalesAnalyticsRequest,
+  ): Promise<SalesAnalyticsResponse> | Observable<SalesAnalyticsResponse> | SalesAnalyticsResponse;
+}
+
+export function PaymentsServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = [
+      "topup",
+      "createCheckout",
+      "getMyPurchases",
+      "getPurchase",
+      "refundPurchase",
+      "getWallet",
+      "listTransactions",
+      "requestWithdrawal",
+      "listWithdrawals",
+      "processWithdrawal",
+      "handlePaymentEvent",
+      "getAdminOverview",
+      "adminListTransactions",
+      "getUserFinance",
+      "createAdjustment",
+      "getSalesAnalytics",
+    ];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+      GrpcMethod("PaymentsService", method)(constructor.prototype[method], method, descriptor);
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+      GrpcStreamMethod("PaymentsService", method)(constructor.prototype[method], method, descriptor);
+    }
+  };
+}
+
+export const PAYMENTS_SERVICE_NAME = "PaymentsService";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aepstore-dev/contracts",
-  "version": "1.11.0",
+  "version": "1.13.0",
   "description": "Protobuf definitions for aepstore microservices",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/proto/payments.proto

@@ -0,0 +1,203 @@
+syntax = "proto3";
+
+package payments.v1;
+
+// Commerce + double-entry wallet/ledger (D9 / D9.2). See payments-service/docs/FINANCE.md.
+// Money = Decimal-as-string (D7). Statuses/enums as strings (avoid proto enum
+// value-name clashes within one package).
+service PaymentsService {
+    // ----- buyer -----
+    rpc Topup(TopupRequest) returns (CheckoutResponse);
+    rpc CreateCheckout(CreateCheckoutRequest) returns (CheckoutResponse);
+    rpc GetMyPurchases(GetMyPurchasesRequest) returns (PurchasesListResponse);
+    rpc GetPurchase(GetPurchaseRequest) returns (Purchase);
+    rpc RefundPurchase(RefundPurchaseRequest) returns (Purchase);
+
+    // ----- wallet -----
+    rpc GetWallet(GetWalletRequest) returns (WalletResponse);
+    rpc ListTransactions(ListTransactionsRequest) returns (TransactionsListResponse);
+
+    // ----- withdrawals -----
+    rpc RequestWithdrawal(RequestWithdrawalRequest) returns (Withdrawal);
+    rpc ListWithdrawals(ListWithdrawalsRequest) returns (WithdrawalsListResponse);
+    rpc ProcessWithdrawal(ProcessWithdrawalRequest) returns (Withdrawal);
+
+    // ----- provider webhook (gateway forwards a verified event) -----
+    rpc HandlePaymentEvent(PaymentEventRequest) returns (Ok);
+
+    // ----- admin -----
+    rpc GetAdminOverview(AdminOverviewRequest) returns (AdminOverviewResponse);
+    rpc AdminListTransactions(AdminListTransactionsRequest) returns (AdminTransactionsListResponse);
+    rpc GetUserFinance(GetUserFinanceRequest) returns (UserFinanceResponse);
+    rpc CreateAdjustment(CreateAdjustmentRequest) returns (Ok);
+    rpc GetSalesAnalytics(SalesAnalyticsRequest) returns (SalesAnalyticsResponse);
+}
+
+message Ok { bool ok = 1; }
+
+// ---------------------------------------------------------------------------
+// Purchase / checkout / topup
+// ---------------------------------------------------------------------------
+message Purchase {
+    string id = 1;
+    string product_id = 2;
+    string product_name = 3;
+    string user_id = 4;
+    string price = 5;
+    string status = 6;             // PENDING | COMPLETED | FAILED | REFUNDED
+    string payment_id = 7;
+    string payment_method = 8;     // BALANCE | YOOKASSA
+    string commission_percent = 9;
+    string seller_amount = 10;
+    string created_at = 11;
+    string completed_at = 12;
+}
+
+message TopupRequest {
+    string user_id = 1;
+    string amount = 2;       // >= 10.00
+    string return_url = 3;
+}
+
+message CreateCheckoutRequest {
+    string user_id = 1;
+    string product_id = 2;
+    string payment_method = 3; // BALANCE | YOOKASSA (default YOOKASSA)
+    string return_url = 4;
+}
+
+message CheckoutResponse {
+    string purchase_id = 1;
+    string payment_id = 2;
+    string confirmation_url = 3; // empty when paid from balance (instant)
+    string status = 4;           // PENDING (redirect) | COMPLETED (balance)
+}
+
+message GetMyPurchasesRequest { string user_id = 1; int32 page = 2; int32 limit = 3; }
+message PurchasesListResponse { repeated Purchase items = 1; int32 total = 2; int32 page = 3; int32 limit = 4; }
+message GetPurchaseRequest { string id = 1; string user_id = 2; }
+message RefundPurchaseRequest { string purchase_id = 1; string actor_user_id = 2; bool is_admin = 3; string reason = 4; }
+
+// ---------------------------------------------------------------------------
+// Wallet & statement
+// ---------------------------------------------------------------------------
+message GetWalletRequest { string user_id = 1; }
+message WalletResponse {
+    string spending = 1;
+    string pending = 2;
+    string payout = 3;
+    string spendable = 4;   // spending + payout
+    string withdrawable = 5; // payout
+    string currency = 6;
+    int32 lifetime_sales = 7;
+    string current_commission_percent = 8;
+}
+
+message ListTransactionsRequest {
+    string user_id = 1;
+    string type = 2;  // optional filter (TOPUP|PURCHASE|SALE_CLEAR|WITHDRAWAL|REFUND|ADJUSTMENT)
+    int32 page = 3;
+    int32 limit = 4;
+}
+message StatementEntry {
+    string id = 1;            // ledger entry id
+    string tx_id = 2;
+    string type = 3;          // tx type
+    string account_kind = 4;  // which of the user's accounts
+    string direction = 5;     // DEBIT | CREDIT
+    string amount = 6;
+    string description = 7;
+    string created_at = 8;
+}
+message TransactionsListResponse { repeated StatementEntry items = 1; int32 total = 2; int32 page = 3; int32 limit = 4; }
+
+// ---------------------------------------------------------------------------
+// Withdrawals
+// ---------------------------------------------------------------------------
+message Withdrawal {
+    string id = 1;
+    string seller_id = 2;
+    string amount = 3;
+    string status = 4;     // PENDING | PROCESSING | COMPLETED | REJECTED
+    string method = 5;
+    string details = 6;
+    string comment = 7;
+    string processed_by = 8;
+    string processed_at = 9;
+    string created_at = 10;
+}
+message RequestWithdrawalRequest { string seller_id = 1; string amount = 2; string method = 3; string details = 4; }
+message ListWithdrawalsRequest { string seller_id = 1; string status = 2; int32 page = 3; int32 limit = 4; }
+message WithdrawalsListResponse { repeated Withdrawal items = 1; int32 total = 2; int32 page = 3; int32 limit = 4; }
+message ProcessWithdrawalRequest { string withdrawal_id = 1; string admin_id = 2; string action = 3; string comment = 4; }
+
+// ---------------------------------------------------------------------------
+// Webhook
+// ---------------------------------------------------------------------------
+message PaymentEventRequest { string event = 1; string payment_id = 2; }
+
+// ---------------------------------------------------------------------------
+// Admin
+// ---------------------------------------------------------------------------
+message AdminOverviewRequest { string from = 1; string to = 2; }
+message AdminOverviewResponse {
+    string revenue = 1;          // platform commission earned (period)
+    string gmv = 2;              // gross merchandise value (period)
+    string liabilities = 3;      // Σ all users' (pending+payout+spending) — what we owe
+    string psp_clearing = 4;     // money in transit at PSP
+    string payouts_payable = 5;  // reserved for approved withdrawals
+    string refunds_total = 6;
+    string topups_total = 7;
+    string withdrawals_total = 8;
+    int32 sales_count = 9;
+    string currency = 10;
+}
+
+message AdminListTransactionsRequest {
+    string type = 1;
+    string user_id = 2;
+    string account_kind = 3;
+    string from = 4;
+    string to = 5;
+    int32 page = 6;
+    int32 limit = 7;
+}
+message AdminEntry { string account_id = 1; string account_kind = 2; string owner_id = 3; string direction = 4; string amount = 5; }
+message AdminLedgerTx {
+    string id = 1;
+    string type = 2;
+    string status = 3;
+    string ref_type = 4;
+    string ref_id = 5;
+    string description = 6;
+    string created_by = 7;
+    string created_at = 8;
+    repeated AdminEntry entries = 9;
+}
+message AdminTransactionsListResponse { repeated AdminLedgerTx items = 1; int32 total = 2; int32 page = 3; int32 limit = 4; }
+
+message GetUserFinanceRequest { string user_id = 1; }
+message AccountBalance { string kind = 1; string balance = 2; string currency = 3; }
+message UserFinanceResponse {
+    WalletResponse wallet = 1;
+    repeated AccountBalance accounts = 2;
+    repeated StatementEntry recent = 3;
+}
+
+message CreateAdjustmentRequest {
+    string admin_id = 1;
+    string user_id = 2;
+    string account_kind = 3; // USER_SPENDING | USER_PAYOUT | USER_PENDING
+    string direction = 4;    // CREDIT (give) | DEBIT (take)
+    string amount = 5;
+    string reason = 6;
+}
+
+message SalesAnalyticsRequest { string from = 1; string to = 2; string granularity = 3; } // day|week|month
+message SalesPoint { string date = 1; int32 sales_count = 2; string gmv = 3; string revenue = 4; }
+message SellerStat { string seller_id = 1; string username = 2; int32 sales = 3; string gmv = 4; }
+message SalesAnalyticsResponse {
+    repeated SalesPoint points = 1;
+    repeated SellerStat top_sellers = 2;
+    string refund_rate = 3; // % refunded purchases
+}