@plyaz/types 1.14.5 → 1.14.6

package/dist/payments/provider/adapter/types.d.ts

@@ -5,7 +5,7 @@ import type { PaymentResult, ProcessPaymentRequest } from '../../request';
 import type { FeeBreakdown, Money } from '../../transaction';
 import type { AdapterConfiguration, CreateCustomerParams, CreateSubscriptionParams, CustomerResult, FeeCalculationOptions, FeeStructure, PaymentStatusResult, PayoutParams, PayoutResult, RefundParams, RefundResult, SavedPaymentMethod, SavedPaymentMethodResult, SavePaymentMethodParams, SubscriptionResult, TransactionDetails, TransactionHistory, TransactionHistoryParams, WebhookPayload, WebhookResult } from '../core';
 import type { ProviderCapabilities, ProviderConfiguration } from '../payment-provider';
-import type { PAYMENTMETHOD, PAYMENTPROVIDERTYPE } from '../provider-capability';
+import type { PAYMENT_METHOD, PAYMENT_PROVIDER_TYPE } from '../provider-capability';
 /**
  * Core interface that all payment providers must implement.
  * This interface ensures consistent behavior across all providers
@@ -19,11 +19,11 @@ import type { PAYMENTMETHOD, PAYMENTPROVIDERTYPE } from '../provider-capability'
  */
 export interface PaymentAdapter {
     /** Unique identifier for this payment provider */
-    readonly name: PAYMENTPROVIDERTYPE;
+    readonly name: PAYMENT_PROVIDER_TYPE;
     /** Provider API version in use */
     readonly apiVersion: string;
     /** Payment methods supported by this provider */
-    readonly supportedMethods: PAYMENTMETHOD[];
+    readonly supportedMethods: PAYMENT_METHOD[];
     /** Currencies supported by this provider */
     readonly supportedCurrencies: CurrencyCode[];
     /** Detailed capabilities of this provider */
@@ -151,11 +151,11 @@ export interface PaymentAdapter {
      * @param options - Additional calculation options
      * @returns Detailed fee breakdown
      */
-    calculateFees(amount: Money, method: PAYMENTMETHOD, options?: FeeCalculationOptions): Promise<FeeBreakdown>;
+    calculateFees(amount: Money, method: PAYMENT_METHOD, options?: FeeCalculationOptions): Promise<FeeBreakdown>;
     /**
      * Get fee structure for a payment method
      */
-    getFeeStructure(method: PAYMENTMETHOD): Promise<FeeStructure>;
+    getFeeStructure(method: PAYMENT_METHOD): Promise<FeeStructure>;
     /**
      * Check provider health and availability.
      * This method should:

package/dist/payments/provider/core/types.d.ts

@@ -1,6 +1,6 @@
 import type { CurrencyCode } from '../../../locale/types';
 import type { FeeBreakdown, Money } from '../../transaction';
-import type { PAYMENTMETHOD, PAYMENTPROVIDERTYPE, PAYMENTSTATUS } from '../provider-capability';
+import type { PAYMENT_METHOD, PAYMENT_PROVIDER_TYPE, PAYMENT_STATUS } from '../provider-capability';
 /**
  * Parameters required to initiate a refund.
  * Refunds can be full or partial.
@@ -29,7 +29,7 @@ export interface RefundResult<TMetadata extends object = object> {
     /** Provider-specific refund ID (if available) */
     providerRefundId?: string;
     /** Status of the refund transaction */
-    status: PAYMENTSTATUS;
+    status: PAYMENT_STATUS;
     /** Refunded amount */
     amount: Money;
     /** Any applicable refund fees (if provider charges fees on refunds) */
@@ -46,7 +46,7 @@ export interface RefundResult<TMetadata extends object = object> {
  */
 export interface PaymentStatusResult<TMetadata extends object = object> {
     /** Current normalized payment status */
-    status: PAYMENTSTATUS;
+    status: PAYMENT_STATUS;
     /** Internal Plyaz transaction ID */
     transactionId: string;
     /** Provider transaction ID */
@@ -73,7 +73,7 @@ export interface WebhookPayload {
     /** Signature extracted from headers */
     signature?: string;
     /** Provider type (e.g., stripe, paypal, etc.) */
-    provider: PAYMENTPROVIDERTYPE;
+    provider: PAYMENT_PROVIDER_TYPE;
 }
 /**
  * Normalized webhook result returned after processing provider webhook.
@@ -86,7 +86,7 @@ export interface WebhookResult<TMetadata extends object = object> {
     /** Transaction ID this event relates to */
     transactionId?: string;
     /** Updated payment status if applicable */
-    updatedStatus?: PAYMENTSTATUS;
+    updatedStatus?: PAYMENT_STATUS;
     /** Optional message for logging or auditing */
     message?: string;
     /** Raw provider webhook payload */
@@ -156,7 +156,7 @@ export interface SavePaymentMethodParams<TMetadata extends object = object> {
     /** Provider customer ID */
     providerCustomerId: string;
     /** Type of payment method (card, bank account, wallet, etc.) */
-    method: PAYMENTMETHOD;
+    method: PAYMENT_METHOD;
     /** Token or ID returned from provider after authorization */
     paymentToken: string;
     /** Whether this should be the default method for the user */
@@ -193,7 +193,7 @@ export interface TransactionHistoryParams {
         to: Date;
     };
     /** Filter by payment status */
-    status?: PAYMENTSTATUS;
+    status?: PAYMENT_STATUS;
     /** Maximum number of records to return */
     limit?: number;
     /** Pagination cursor or token */
@@ -208,10 +208,10 @@ export interface TransactionHistory<TMetadata extends object = object> {
         transactionId: string;
         providerTransactionId?: string;
         amount: Money;
-        status: PAYMENTSTATUS;
+        status: PAYMENT_STATUS;
         createdAt: Date;
         updatedAt?: Date;
-        method: PAYMENTMETHOD;
+        method: PAYMENT_METHOD;
         metadata?: TMetadata;
     }>;
     /** Pagination cursor for next page */
@@ -223,10 +223,10 @@ export interface PaymentAdapterConfig<TExtra extends object = object> {
     /** Default region used if no specific mapping is found */
     defaultRegion?: string;
     /** Region → Provider mapping */
-    regionProviderMapping?: Record<string, PAYMENTPROVIDERTYPE>;
+    regionProviderMapping?: Record<string, PAYMENT_PROVIDER_TYPE>;
     /** Provider credentials and environment configuration */
     providers: {
-        [key in PAYMENTPROVIDERTYPE]?: {
+        [key in PAYMENT_PROVIDER_TYPE]?: {
             apiKey?: string;
             secretKey?: string;
             merchantId?: string;
@@ -241,7 +241,7 @@ export interface PaymentAdapterConfig<TExtra extends object = object> {
     fallbackRules?: {
         enabled: boolean;
         strategy: 'round_robin' | 'priority' | 'failover';
-        priorityList?: PAYMENTPROVIDERTYPE[];
+        priorityList?: PAYMENT_PROVIDER_TYPE[];
     };
     /** Global settings (timeouts, logging, etc.) */
     globalSettings?: {
@@ -254,7 +254,7 @@ export interface NormalizedPaymentRequest<TMetadata extends object = object> {
     /** Amount to charge */
     amount: Money;
     /** Payment method */
-    method: PAYMENTMETHOD;
+    method: PAYMENT_METHOD;
     /** CurrencyCode */
     CurrencyCode: CurrencyCode;
     /** User initiating the transaction */
@@ -278,7 +278,7 @@ export interface TransactionDetails<TMetadata extends object = object> {
     /** Provider transaction ID */
     providerTransactionId?: string;
     /** Current payment status */
-    status: PAYMENTSTATUS;
+    status: PAYMENT_STATUS;
     /** Total amount of the transaction */
     amount: Money;
     /** Refunded amount (if applicable) */
@@ -286,7 +286,7 @@ export interface TransactionDetails<TMetadata extends object = object> {
     /** Fees applied to this transaction */
     fees?: FeeBreakdown;
     /** Payment method used */
-    method: PAYMENTMETHOD;
+    method: PAYMENT_METHOD;
     /** CurrencyCode of the transaction */
     CurrencyCode: CurrencyCode;
     /** Timestamp when transaction was created */
@@ -328,7 +328,7 @@ export interface AdapterConfiguration<TMetadata extends object = object> {
         subscribedEvents?: string[];
     };
     /** Supported payment methods and currencies */
-    supportedMethods: PAYMENTMETHOD[];
+    supportedMethods: PAYMENT_METHOD[];
     supportedCurrencies: CurrencyCode[];
     /** Additional configuration or metadata */
     metadata?: TMetadata;
@@ -339,7 +339,7 @@ export interface SavedPaymentMethod<TMetadata extends object = object> {
     /** Provider-specific payment method ID */
     providerPaymentMethodId: string;
     /** Type of payment method (card, wallet, etc.) */
-    method: PAYMENTMETHOD;
+    method: PAYMENT_METHOD;
     /** Display-friendly label (e.g. “Visa •••• 4242”) */
     label?: string;
     /** Whether this is the default payment method */
@@ -408,7 +408,7 @@ export interface PayoutResult<TMetadata extends object = object> {
 export interface SavedPaymentMethodInfo {
     id: string;
     label: string;
-    method: PAYMENTMETHOD;
+    method: PAYMENT_METHOD;
     isDefault: boolean;
 }
 export interface ReceiptData<TMetadata extends object = object> {

package/dist/payments/provider/payment-provider/types.d.ts

@@ -3,7 +3,7 @@ import type { BaseProviderConfig } from '../../gateways';
 import type { PaymentResult, ProcessPaymentRequest } from '../../request';
 import type { FeeBreakdown, Money } from '../../transaction';
 import type { CreateCustomerParams, CustomerResult, FeeCalculationOptions, PaymentStatusResult, RefundParams, RefundResult, SavedPaymentMethodResult, SavePaymentMethodParams, TransactionHistory, TransactionHistoryParams, WebhookPayload, WebhookResult } from '../core';
-import type { PAYMENTMETHOD, PAYMENTPROVIDERTYPE } from '../provider-capability';
+import type { PAYMENT_METHOD, PAYMENT_PROVIDER_TYPE } from '../provider-capability';
 import type { CurrencyCode } from '../../../locale/types';
 /**
  * Core interface that all payment providers must implement.
@@ -18,9 +18,9 @@ import type { CurrencyCode } from '../../../locale/types';
  */
 export interface PaymentProvider {
     /** Unique identifier for this payment provider */
-    readonly name: PAYMENTPROVIDERTYPE;
+    readonly name: PAYMENT_PROVIDER_TYPE;
     /** Payment methods supported by this provider */
-    readonly supportedMethods: PAYMENTMETHOD[];
+    readonly supportedMethods: PAYMENT_METHOD[];
     /** Currencies supported by this provider */
     readonly supportedCurrencies: CurrencyCode[];
     /** Detailed capabilities of this provider */
@@ -127,7 +127,7 @@ export interface PaymentProvider {
      * @param options - Additional calculation options
      * @returns Detailed fee breakdown
      */
-    calculateFees(amount: Money, method: PAYMENTMETHOD, options?: FeeCalculationOptions): Promise<FeeBreakdown>;
+    calculateFees(amount: Money, method: PAYMENT_METHOD, options?: FeeCalculationOptions): Promise<FeeBreakdown>;
     /**
      * Check provider health and availability.
      * This method should:
@@ -208,15 +208,15 @@ export interface ProviderCapabilities {
     /** Provides dispute evidence submission */
     supportsDisputeEvidence: boolean;
     /** Minimum transaction amount per payment method */
-    minimumAmounts: Record<PAYMENTMETHOD, Money>;
+    minimumAmounts: Record<PAYMENT_METHOD, Money>;
     /** Maximum transaction amount per payment method */
-    maximumAmounts: Record<PAYMENTMETHOD, Money>;
+    maximumAmounts: Record<PAYMENT_METHOD, Money>;
     /** Supported countries/regions */
     supportedRegions: string[];
     /** Processing time estimates per payment method */
-    processingTimes: Record<PAYMENTMETHOD, ProcessingTimeEstimate>;
+    processingTimes: Record<PAYMENT_METHOD, ProcessingTimeEstimate>;
     /** Settlement time estimates per payment method */
-    settlementTimes: Record<PAYMENTMETHOD, SettlementTimeEstimate>;
+    settlementTimes: Record<PAYMENT_METHOD, SettlementTimeEstimate>;
 }
 /**
  * Provider configuration interface for initialization.

package/dist/payments/provider/provider-capability/enums.d.ts

@@ -1,7 +1,7 @@
 /**
  * Enumeration of all supported payment providers in the Plyaz ecosystem.
  */
-export declare enum PAYMENTPROVIDERTYPE {
+export declare enum PAYMENT_PROVIDER_TYPE {
     Stripe = "stripe",
     Paypal = "paypal",
     CheckoutCom = "checkout_com",
@@ -21,7 +21,7 @@ export declare enum PAYMENTPROVIDERTYPE {
 /**
  * Enumeration of payment methods supported across all providers.
  */
-export declare enum PAYMENTMETHOD {
+export declare enum PAYMENT_METHOD {
     CreditCard = "credit_card",
     DebitCard = "debit_card",
     BankTransfer = "bank_transfer",
@@ -47,7 +47,7 @@ export declare enum PAYMENTMETHOD {
 /**
  * Comprehensive payment status enumeration.
  */
-export declare enum PAYMENTSTATUS {
+export declare enum PAYMENT_STATUS {
     Initiated = "initiated",
     Pending = "pending",
     Processing = "processing",
@@ -72,7 +72,7 @@ export declare enum PAYMENTSTATUS {
 /**
  * Transaction type enumeration.
  */
-export declare enum TRANSACTIONTYPE {
+export declare enum TRANSACTION_TYPE {
     Payment = "payment",
     Refund = "refund",
     PartialRefund = "partial_refund",
@@ -90,7 +90,7 @@ export declare enum TRANSACTIONTYPE {
 /**
  * User type enumeration.
  */
-export declare enum USERTYPE {
+export declare enum USER_TYPE {
     Fan = "fan",
     Athlete = "athlete",
     Club = "club",
@@ -102,7 +102,7 @@ export declare enum USERTYPE {
 /**
  * Product type enumeration.
  */
-export declare enum PRODUCTTYPE {
+export declare enum PRODUCT_TYPE {
     Campaign = "campaign",
     Subscription = "subscription",
     Nft = "nft",

package/dist/payments/request/types.d.ts

@@ -1,4 +1,4 @@
-import type { PAYMENTMETHOD, PAYMENTPROVIDERTYPE, PAYMENTSTATUS, PRODUCTTYPE, USERTYPE } from '../provider';
+import type { PAYMENT_METHOD, PAYMENT_PROVIDER_TYPE, PAYMENT_STATUS, PRODUCT_TYPE, USER_TYPE } from '../provider';
 import type { ReceiptData, SavedPaymentMethodInfo } from '../provider/core';
 import type { FeeBreakdown, Money } from '../transaction';
 import type { REQUIREDACTIONTYPE } from './enums';
@@ -16,20 +16,20 @@ export interface ProcessPaymentRequest<TCustomMetadata extends Record<string, st
     /** Payment amount and currency information */
     amount: Money;
     /** Selected payment method from supported options */
-    paymentMethod: PAYMENTMETHOD;
+    paymentMethod: PAYMENT_METHOD;
     /**
      * Optional provider override for advanced use cases
      * If not specified, optimal provider will be auto-selected
      */
-    provider?: PAYMENTPROVIDERTYPE;
+    provider?: PAYMENT_PROVIDER_TYPE;
     /** User making the payment - must be authenticated */
     userId: string;
     /** Type of user making the payment for limit enforcement */
-    userType: USERTYPE;
+    userType: USER_TYPE;
     /** Product or service being purchased */
     productId: string;
     /** Type of product for business rule application */
-    productType: PRODUCTTYPE;
+    productType: PRODUCT_TYPE;
     /**
      * Human-readable description for receipts and statements
      * Should be descriptive but concise (max 255 characters)
@@ -136,7 +136,7 @@ export interface PaymentResult<TProviderResponse extends object = {}> {
     /** Provider's transaction identifier for reference */
     providerTransactionId?: string;
     /** Current payment status */
-    status: PAYMENTSTATUS;
+    status: PAYMENT_STATUS;
     /**
      * URL for redirect-based payment flows (Stripe Checkout, PayPal, etc.)
      * Client should redirect user to this URL to complete payment

package/dist/payments/service/types.d.ts

@@ -1,5 +1,5 @@
 import type { ValidationResult } from '../../common';
-import type { PAYMENTPROVIDERTYPE, PAYMENTSTATUS } from '../provider';
+import type { PAYMENT_PROVIDER_TYPE, PAYMENT_STATUS } from '../provider';
 import type { PaymentAdapter } from '../provider/adapter';
 import type { PaymentResult, ProcessPaymentRequest } from '../request';
 import type { Money } from '../transaction';
@@ -13,7 +13,7 @@ export interface PaymentServiceInterface {
     /** Process a new payment transaction with full business logic validation */
     processPayment(request: ProcessPaymentRequest): Promise<PaymentResult>;
     /** Get current status of any payment transaction */
-    getPaymentStatus(transactionId: string): Promise<PAYMENTSTATUS>;
+    getPaymentStatus(transactionId: string): Promise<PAYMENT_STATUS>;
     /** Process refunds with authorization and business rule validation */
     /** Validate payment limits before processing */
     validatePaymentLimits(userId: string, amount: Money): Promise<boolean>;
@@ -25,11 +25,11 @@ export interface PaymentServiceInterface {
  */
 export interface PaymentAdapterFactory {
     /** Create adapter instance for specific provider */
-    createAdapter(provider: PAYMENTPROVIDERTYPE): Promise<PaymentAdapter>;
+    createAdapter(provider: PAYMENT_PROVIDER_TYPE): Promise<PaymentAdapter>;
     /** Get list of currently available and healthy providers */
-    getAvailableProviders(): PAYMENTPROVIDERTYPE[];
+    getAvailableProviders(): PAYMENT_PROVIDER_TYPE[];
     /** Validate provider configuration before creating adapter */
-    validateProviderConfig(provider: PAYMENTPROVIDERTYPE): boolean;
+    validateProviderConfig(provider: PAYMENT_PROVIDER_TYPE): boolean;
     /** Get adapter with automatic provider selection based on routing rules */
     getOptimalAdapter(request: ProcessPaymentRequest): Promise<PaymentAdapter>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plyaz/types",
-  "version": "1.14.5",
+  "version": "1.14.6",
   "author": "Redeemer Pace",
   "license": "ISC",
   "description": "Provides shared TypeScript types and schema utilities for validation and parsing in the @playz ecosystem.",