@plyaz/types 1.25.1 → 1.25.2

package/dist/payments/gateways/provider/fee/types.d.ts

@@ -0,0 +1,56 @@
+import type { CurrencyCode } from '../../../../locale/types';
+import type { PAYMENT_METHOD, PAYMENT_PROVIDER_TYPE } from '../../../provider';
+import type { Money } from '../../../transaction';
+export declare enum FEE_CONTEXT {
+    Payment = "payment",
+    Subscription = "subscription",
+    Withdrawal = "withdrawal",
+    Refund = "refund",
+    Dispute = "dispute"
+}
+export interface CalculateFeeParams {
+    amount: Money;
+    paymentMethod: PAYMENT_METHOD;
+    provider: PAYMENT_PROVIDER_TYPE;
+    context: FEE_CONTEXT;
+    accountCurrency: string;
+    expedite?: boolean;
+    highRisk?: boolean;
+}
+export declare enum FEE_TYPE {
+    Platform = "platform",
+    CrossBorder = "crossBorder",
+    Conversion = "currencyConversion",
+    Network = "network",
+    Gas = "gas",
+    Expedite = "expedite",
+    Risk = "risk",
+    Compliance = "compliance",
+    Chargeback = "chargeback",
+    Refund = "refund"
+}
+export interface FeeMetadata {
+    processingRate?: number;
+    platformRate?: number;
+    crossBorderRate?: number;
+    conversionRate?: number;
+    calculatedAt: Date;
+    ruleVersion?: string;
+}
+/**
+ * Unified Fee Rule
+ */
+export interface FeeRule<TMetadata extends object = {}> {
+    type: FEE_TYPE;
+    context: FEE_CONTEXT[];
+    enabled: boolean;
+    percentage?: number;
+    fixed?: number;
+    minimumFee?: number;
+    amount?: number;
+    currency?: CurrencyCode;
+    riskScoreThreshold?: number;
+    estimated?: number;
+    maxLimit?: number;
+    metadata?: TMetadata;
+}

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

@@ -1,5 +1,7 @@
 import type { CurrencyCode } from '../../../locale/types';
-import type { PAYMENT_METHOD, PAYMENT_PROVIDER_TYPE } from '../../provider';
+import type { PAYMENT_METHOD, PAYMENT_PROVIDER_TYPE, USER_TYPE } from '../../provider';
+import type { Money } from '../../transaction';
+import type { FEE_CONTEXT } from './fee/types';
 /**
  * Base configuration interface that all payment providers must implement.
  * This ensures consistent configuration structure across all providers.
@@ -258,23 +260,69 @@ export interface ProviderFeeConfiguration {
     additionalFees: {
         /** Cross-border transaction fees */
         crossBorder?: {
+            context: FEE_CONTEXT[];
             percentage: number;
             fixed?: number;
+            enabled: boolean;
         };
         /** Currency conversion fees */
         currencyConversion?: {
+            context: FEE_CONTEXT[];
             percentage: number;
             minimumFee?: number;
+            enabled: boolean;
         };
         /** Chargeback fees */
         chargeback?: {
+            context: FEE_CONTEXT[];
             amount: number;
             currency: CurrencyCode;
+            enabled: boolean;
         };
         /** Refund processing fees */
         refund?: {
+            context: FEE_CONTEXT[];
             percentage: number;
             fixed?: number;
+            enabled: boolean;
+        };
+        platform?: {
+            context: FEE_CONTEXT[];
+            percentage?: number;
+            fixed?: number;
+            minimumFee?: number;
+            enabled: boolean;
+        };
+        expedite?: {
+            context: FEE_CONTEXT[];
+            fixed: number;
+            enabled: boolean;
+        };
+        risk?: {
+            context: FEE_CONTEXT[];
+            percentage?: number;
+            riskScoreThreshold?: number;
+            enabled: boolean;
+        };
+        compliance?: {
+            context: FEE_CONTEXT[];
+            fixed?: number;
+            perCheck?: number;
+            currency: CurrencyCode;
+            enabled: boolean;
+        };
+        network?: {
+            context: FEE_CONTEXT[];
+            amount?: number;
+            currency: CurrencyCode;
+            enabled: boolean;
+        };
+        gas?: {
+            context: FEE_CONTEXT[];
+            estimated?: number;
+            maxLimit?: number;
+            currency: CurrencyCode;
+            enabled: boolean;
         };
     };
     /** Fee calculation configuration */
@@ -433,3 +481,41 @@ export interface ProviderPerformanceConfiguration {
         evictionStrategy: 'lru' | 'lfu' | 'ttl';
     };
 }
+export interface WithdrawalEligibilityRequest {
+    amount: Money;
+    paymentMethod: PAYMENT_METHOD;
+    userType?: USER_TYPE;
+    accountCurrency: CurrencyCode;
+    expedite: true;
+    highRisk: true;
+    metadata?: {
+        geoInfo?: {
+            country: string;
+            region?: string;
+            city?: string;
+            timezone?: string;
+        };
+    };
+}
+export interface WithdrawalFeeStructure {
+    percentage?: number;
+    fixed?: number;
+}
+export interface WithdrawalFeeDetail {
+    provider: PAYMENT_PROVIDER_TYPE;
+    fees: WithdrawalFeeStructure;
+    estimatedFee: number;
+}
+export interface RoutingContext {
+    amount: Money;
+    paymentMethod: PAYMENT_METHOD;
+    userType?: USER_TYPE;
+    provider?: PAYMENT_PROVIDER_TYPE;
+    metadata?: {
+        geoInfo?: {
+            region?: string;
+            country?: string;
+            city?: string;
+        };
+    };
+}

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

@@ -3,9 +3,10 @@ import type { ProviderHealthStatus } from '../../../features';
 import type { BaseProviderConfig, CreatePricingParams, CreatePricingResult, CreateProductParams, CreateProductResult, UpdateProductStatusParams, UpdateProductStatusResult, FetchProductParams, FetchProductResult, UpdatePricingParams, UpdatePricingResult, UpdateProductParams, UpdateProductResult } from '../../gateways';
 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, WithdrawalParams, WithdrawalResult } from '../core';
+import type { AdapterConfiguration, CreateCustomerParams, CreateSubscriptionParams, CustomerResult, FeeStructure, PaymentStatusResult, PayoutParams, PayoutResult, RefundParams, RefundResult, SavedPaymentMethod, SavedPaymentMethodResult, SavePaymentMethodParams, SubscriptionResult, TransactionDetails, TransactionHistory, TransactionHistoryParams, WebhookPayload, WebhookResult, WithdrawalParams, WithdrawalResult } from '../core';
 import type { ProviderCapabilities, ProviderConfiguration } from '../payment-provider';
 import type { PAYMENT_METHOD, PAYMENT_PROVIDER_TYPE } from '../provider-capability';
+import type { CalculateFeeParams } from '../../gateways/provider/fee/types';
 /**
  * Core interface that all payment providers must implement.
  * This interface ensures consistent behavior across all providers
@@ -151,7 +152,7 @@ export interface PaymentAdapter {
      * @param options - Additional calculation options
      * @returns Detailed fee breakdown
      */
-    calculateFees(amount: Money, method: PAYMENT_METHOD, options?: FeeCalculationOptions): Promise<FeeBreakdown>;
+    calculateFees(feeParams: CalculateFeeParams): Promise<FeeBreakdown>;
     /**
      * Get fee structure for a payment method
      */

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

@@ -2,9 +2,10 @@ import type { ProviderHealthStatus } from '../../../features';
 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 { CreateCustomerParams, CustomerResult, PaymentStatusResult, RefundParams, RefundResult, SavedPaymentMethodResult, SavePaymentMethodParams, TransactionHistory, TransactionHistoryParams, WebhookPayload, WebhookResult } from '../core';
 import type { PAYMENT_METHOD, PAYMENT_PROVIDER_TYPE } from '../provider-capability';
 import type { CurrencyCode } from '../../../locale/types';
+import type { CalculateFeeParams } from '../../gateways/provider/fee/types';
 /**
  * Core interface that all payment providers must implement.
  * This interface ensures consistent behavior across all providers
@@ -127,7 +128,7 @@ export interface PaymentProvider {
      * @param options - Additional calculation options
      * @returns Detailed fee breakdown
      */
-    calculateFees(amount: Money, method: PAYMENT_METHOD, options?: FeeCalculationOptions): Promise<FeeBreakdown>;
+    calculateFees(feeParams: CalculateFeeParams): Promise<FeeBreakdown>;
     /**
      * Check provider health and availability.
      * This method should:

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

@@ -70,6 +70,10 @@ export interface FeeBreakdown {
     riskFee?: Money;
     /** Regulatory compliance fee (where applicable) */
     complianceFee?: Money;
+    /** Fee charged when a payment is disputed */
+    chargebackFee?: Money;
+    /** Fee retained or applied when a refund is processed */
+    refundFee?: Money;
     /** Total of all fees combined */
     total: Money;
     /**

package/dist/storage/interfaces.d.ts

@@ -1375,6 +1375,43 @@ export interface StorageTemplateFrontmatter {
     };
     /** Custom CSS */
     css?: string;
+    /**
+     * Styling options for CSS variables in layouts
+     * Used in layout templates via Handlebars conditionals:
+     * `{{#if styling.primaryColor}}{{styling.primaryColor}}{{else}}#2563eb{{/if}}`
+     */
+    styling?: {
+        /** Primary brand color - headers, links, buttons */
+        primaryColor?: string;
+        /** Secondary/supporting color - subtle backgrounds */
+        secondaryColor?: string;
+        /** Accent/highlight color - CTAs, emphasis */
+        accentColor?: string;
+        /** Page background color */
+        backgroundColor?: string;
+        /** Main body text color */
+        textColor?: string;
+        /** Subtle text color - captions, footers */
+        mutedColor?: string;
+        /** Border/divider color */
+        borderColor?: string;
+        /** Success state color - paid, approved */
+        successColor?: string;
+        /** Warning state color - pending, overdue */
+        warningColor?: string;
+        /** Error state color - failed, declined */
+        errorColor?: string;
+        /** Primary font family */
+        fontFamily?: string;
+        /** Heading font family */
+        fontFamilyHeading?: string;
+        /** Base font size (e.g., '11pt') */
+        fontSize?: string;
+        /** Line height (e.g., '1.5') */
+        lineHeight?: string;
+        /** Base spacing unit (e.g., '4mm') */
+        spacingUnit?: string;
+    };
     /** Additional custom fields */
     [key: string]: unknown;
 }

package/package.json

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