@cimplify/sdk 0.9.10 → 0.10.0

package/dist/index-Cd0shhZU.d.mts

@@ -1,320 +0,0 @@
-import { av as ChosenPrice, C as CurrencyCode, as as TaxPathComponent, at as PricePathTaxInfo, M as Money, bd as PaymentErrorDetails, bb as PaymentResponse, bc as PaymentStatusResponse } from './payment-CTalZM5l.mjs';
-
-/**
- * Price Types
- *
- * Types for price parsing, formatting, and display utilities.
- */
-
-/**
- * Individual tax component (e.g., VAT, NHIL, GETFund)
- * @deprecated Use `TaxPathComponent` from `types/cart` instead.
- */
-type TaxComponent = TaxPathComponent;
-/**
- * Complete tax information from a pricing response
- * @deprecated Use `PricePathTaxInfo` from `types/cart` instead.
- */
-type TaxInfo = PricePathTaxInfo;
-/**
- * Price information in snake_case format (as returned from backend)
- * Used by components that work with raw API responses
- * @deprecated Use `ChosenPrice` from `types/cart` instead.
- */
-type PriceInfo = ChosenPrice;
-/**
- * Minimal product shape for price utilities.
- * Uses quote-aware `price_info` and plain numeric fallback fields.
- */
-interface ProductWithPrice {
-    /** Pre-parsed price info from backend */
-    price_info?: ChosenPrice;
-    /** Final computed price in plain field form (if provided by API) */
-    final_price?: number | string | null;
-    /** Base/original price in plain field form */
-    base_price?: number | string | null;
-    /** Default/indicative price in plain field form */
-    default_price?: number | string | null;
-    /** Currency in plain field form */
-    currency?: CurrencyCode | null;
-}
-/**
- * Options for price formatting functions
- */
-interface FormatPriceOptions {
-    /** Currency code (default: "GHS") */
-    currency?: CurrencyCode;
-    /** Locale for Intl.NumberFormat (default: "en-US") */
-    locale?: string;
-    /** Minimum fraction digits (default: 2) */
-    minimumFractionDigits?: number;
-    /** Maximum fraction digits (default: 2) */
-    maximumFractionDigits?: number;
-}
-/**
- * Options for compact price formatting
- */
-interface FormatCompactOptions {
-    /** Currency code (default: "GHS") */
-    currency?: CurrencyCode;
-    /** Number of decimal places for compact notation (default: 1) */
-    decimals?: number;
-}
-
-/**
- * Price Utilities
- *
- * Comprehensive utilities for parsing, formatting, and displaying prices.
- * Handles quote-aware pricing fields, currency formatting, and product price helpers.
- *
- * @example
- * ```typescript
- * import {
- *   formatPrice,
- *   formatPriceCompact,
- *   isOnSale,
- *   getDiscountPercentage
- * } from '@cimplify/sdk';
- *
- * // Format prices
- * formatPrice(29.99, 'USD');        // "$29.99"
- * formatPrice(29.99, 'GHS');        // "GH₵29.99"
- * formatPriceCompact(1500000, 'USD'); // "$1.5M"
- *
- * // Check for discounts
- * if (isOnSale(product)) {
- *   console.log(`${getDiscountPercentage(product)}% off!`);
- * }
- * ```
- */
-
-/**
- * Currency code to symbol mapping
- * Includes major world currencies and African currencies
- */
-declare const CURRENCY_SYMBOLS: Record<string, string>;
-/**
- * Get currency symbol for a currency code
- * @param currencyCode - ISO 4217 currency code (e.g., "USD", "GHS")
- * @returns Currency symbol or the code itself if not found
- *
- * @example
- * getCurrencySymbol('USD') // "$"
- * getCurrencySymbol('GHS') // "GH₵"
- * getCurrencySymbol('XYZ') // "XYZ"
- */
-declare function getCurrencySymbol(currencyCode: CurrencyCode): string;
-/**
- * Format a number compactly with K/M/B suffixes
- * @param value - Number to format
- * @param decimals - Decimal places (default: 1)
- * @returns Compact string representation
- *
- * @example
- * formatNumberCompact(1234)      // "1.2K"
- * formatNumberCompact(1500000)   // "1.5M"
- * formatNumberCompact(2500000000) // "2.5B"
- */
-declare function formatNumberCompact(value: number, decimals?: number): string;
-/**
- * Format a price with locale-aware currency formatting
- * Uses Intl.NumberFormat for proper localization
- *
- * @param amount - Price amount (number or string)
- * @param currency - ISO 4217 currency code (default: "GHS")
- * @param locale - BCP 47 locale string (default: "en-US")
- * @returns Formatted price string
- *
- * @example
- * formatPrice(29.99, 'USD')      // "$29.99"
- * formatPrice(29.99, 'GHS')      // "GH₵29.99"
- * formatPrice('29.99', 'EUR')    // "€29.99"
- * formatPrice(1234.56, 'USD', 'de-DE') // "1.234,56 $"
- */
-declare function formatPrice(amount: number | Money, currency?: CurrencyCode, locale?: string): string;
-/**
- * Format a price with +/- sign for adjustments
- * Useful for showing price changes, modifiers, or discounts
- *
- * @param amount - Adjustment amount (positive or negative)
- * @param currency - ISO 4217 currency code (default: "GHS")
- * @param locale - BCP 47 locale string (default: "en-US")
- * @returns Formatted adjustment string with sign
- *
- * @example
- * formatPriceAdjustment(5.00, 'USD')  // "+$5.00"
- * formatPriceAdjustment(-3.50, 'GHS') // "-GH₵3.50"
- * formatPriceAdjustment(0, 'EUR')     // "€0.00"
- */
-declare function formatPriceAdjustment(amount: number, currency?: CurrencyCode, locale?: string): string;
-/**
- * Format a price compactly for large numbers
- * Uses K/M/B suffixes for thousands, millions, billions
- *
- * @param amount - Price amount (number or string)
- * @param currency - ISO 4217 currency code (default: "GHS")
- * @param decimals - Decimal places for compact notation (default: 1)
- * @returns Compact formatted price
- *
- * @example
- * formatPriceCompact(999, 'USD')       // "$999.00"
- * formatPriceCompact(1500, 'GHS')      // "GH₵1.5K"
- * formatPriceCompact(2500000, 'USD')   // "$2.5M"
- * formatPriceCompact(1200000000, 'EUR') // "€1.2B"
- */
-declare function formatPriceCompact(amount: number | Money, currency?: CurrencyCode, decimals?: number): string;
-/**
- * Simple currency symbol + amount format
- * Lighter alternative to formatPrice without Intl
- *
- * @param amount - Price amount (number or string)
- * @param currency - ISO 4217 currency code (default: "GHS")
- * @returns Simple formatted price
- *
- * @example
- * formatMoney(29.99, 'USD') // "$29.99"
- * formatMoney('15.00', 'GHS') // "GH₵15.00"
- */
-declare function formatMoney(amount: Money | number, currency?: CurrencyCode): string;
-/**
- * Parse a price string or number to a numeric value
- * Handles various input formats gracefully
- *
- * @param value - Value to parse (string, number, or undefined)
- * @returns Parsed numeric value, or 0 if invalid
- *
- * @example
- * parsePrice('29.99')   // 29.99
- * parsePrice(29.99)     // 29.99
- * parsePrice('$29.99')  // 29.99 (strips non-numeric prefix)
- * parsePrice(undefined) // 0
- * parsePrice('invalid') // 0
- */
-declare function parsePrice(value: Money | string | number | undefined | null): number;
-/** Check whether tax info exists on the selected price payload. */
-declare function hasTaxInfo(priceInfo: {
-    tax_info?: PricePathTaxInfo;
-}): boolean;
-/** Get tax amount from a selected price payload, defaulting to 0 when tax info is absent. */
-declare function getTaxAmount(priceInfo: {
-    tax_info?: PricePathTaxInfo;
-}): number;
-/** Check whether the selected price is tax-inclusive. */
-declare function isTaxInclusive(priceInfo: {
-    tax_info?: PricePathTaxInfo;
-}): boolean;
-/**
- * Format a final price with tax annotation.
- * Examples: "$10.50 (incl. tax)" or "$10.50 + $1.05 tax"
- */
-declare function formatPriceWithTax(priceInfo: {
-    final_price: Money;
-    tax_info?: PricePathTaxInfo;
-}, currency?: CurrencyCode): string;
-/**
- * Get the display price from a product.
- * Prefers quote-aware price_info, then plain price fields.
- *
- * @param product - Product with price data
- * @returns The final price to display
- *
- * @example
- * const price = getDisplayPrice(product);
- * console.log(formatPrice(price, 'GHS')); // "GH₵29.99"
- */
-declare function getDisplayPrice(product: ProductWithPrice): number;
-/**
- * Get the base price from a product (before markup/discount)
- *
- * @param product - Product with price data
- * @returns The base price before adjustments
- */
-declare function getBasePrice(product: ProductWithPrice): number;
-/**
- * Check if a product is on sale (discounted)
- *
- * @param product - Product with price data
- * @returns True if the final price is less than the base price
- *
- * @example
- * if (isOnSale(product)) {
- *   return <Badge>Sale!</Badge>;
- * }
- */
-declare function isOnSale(product: ProductWithPrice): boolean;
-/**
- * Get the discount percentage for a product on sale
- *
- * @param product - Product with price data
- * @returns Discount percentage (0-100), or 0 if not on sale
- *
- * @example
- * const discount = getDiscountPercentage(product);
- * if (discount > 0) {
- *   return <Badge>{discount}% OFF</Badge>;
- * }
- */
-declare function getDiscountPercentage(product: ProductWithPrice): number;
-/**
- * Get the markup percentage for a product
- *
- * @param product - Product with price data
- * @returns Markup percentage, or 0 if no markup
- */
-declare function getMarkupPercentage(product: ProductWithPrice): number;
-/**
- * Get the currency for a product
- *
- * @param product - Product with price data
- * @returns Currency code (default: "GHS")
- */
-declare function getProductCurrency(product: ProductWithPrice): CurrencyCode;
-/**
- * Format a product's display price
- * Convenience function combining getDisplayPrice and formatPrice
- *
- * @param product - Product with price data
- * @param locale - BCP 47 locale string (default: "en-US")
- * @returns Formatted price string
- *
- * @example
- * <span>{formatProductPrice(product)}</span> // "GH₵29.99"
- */
-declare function formatProductPrice(product: ProductWithPrice, locale?: string): string;
-
-/**
- * Categorize payment errors into user-friendly messages
- */
-declare function categorizePaymentError(error: Error, errorCode?: string): PaymentErrorDetails;
-/**
- * Normalize payment response from different formats into a standard PaymentResponse
- */
-declare function normalizePaymentResponse(response: unknown): PaymentResponse;
-declare function isPaymentStatusSuccess(status: string | undefined): boolean;
-declare function isPaymentStatusFailure(status: string | undefined): boolean;
-declare function isPaymentStatusRequiresAction(status: string | undefined): boolean;
-/**
- * Normalize payment status response into a standard format
- */
-declare function normalizeStatusResponse(response: unknown): PaymentStatusResponse;
-/** Mobile money provider display names */
-declare const MOBILE_MONEY_PROVIDERS: {
-    readonly mtn: {
-        readonly name: "MTN Mobile Money";
-        readonly prefix: readonly ["024", "054", "055", "059"];
-    };
-    readonly vodafone: {
-        readonly name: "Vodafone Cash";
-        readonly prefix: readonly ["020", "050"];
-    };
-    readonly airtel: {
-        readonly name: "AirtelTigo Money";
-        readonly prefix: readonly ["027", "057", "026", "056"];
-    };
-};
-/**
- * Detect mobile money provider from phone number
- */
-declare function detectMobileMoneyProvider(phoneNumber: string): "mtn" | "vodafone" | "airtel" | null;
-
-export { type ProductWithPrice as A, type FormatCompactOptions as B, CURRENCY_SYMBOLS as C, type FormatPriceOptions as F, MOBILE_MONEY_PROVIDERS as M, type PriceInfo as P, type TaxComponent as T, formatPriceAdjustment as a, formatPriceCompact as b, formatMoney as c, formatNumberCompact as d, formatProductPrice as e, formatPrice as f, getTaxAmount as g, hasTaxInfo as h, isTaxInclusive as i, formatPriceWithTax as j, getCurrencySymbol as k, getDisplayPrice as l, getBasePrice as m, isOnSale as n, getDiscountPercentage as o, parsePrice as p, getMarkupPercentage as q, getProductCurrency as r, categorizePaymentError as s, normalizePaymentResponse as t, normalizeStatusResponse as u, isPaymentStatusFailure as v, isPaymentStatusRequiresAction as w, isPaymentStatusSuccess as x, detectMobileMoneyProvider as y, type TaxInfo as z };