@aimee.shop/sdk 0.0.1

package/dist/services/core/pricing/types.d.ts

@@ -0,0 +1,782 @@
+import type { GeoRestrictionMode } from '../../../core/types/geo.js';
+export type { GeoRestrictionMode };
+export interface Pricing {
+    id: string;
+    tenantId: string;
+    storeId: string;
+    variantId: string;
+    basePrice: string;
+    currency: string;
+    region?: string;
+    cost?: string;
+    effectiveFrom: string;
+    effectiveTo?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreatePricingDto {
+    variantId: string;
+    basePrice: string;
+    currency?: string;
+    region?: string;
+    cost?: string;
+    effectiveFrom?: string;
+    effectiveTo?: string;
+}
+export interface UpdatePricingDto {
+    variantId?: string;
+    basePrice?: string;
+    currency?: string;
+    region?: string;
+    cost?: string;
+    effectiveFrom?: string;
+    effectiveTo?: string;
+}
+export interface CalculatePriceDto {
+    variantId: string;
+    quantity: number;
+    customerId?: string;
+    region?: string;
+    currency?: string;
+    customerGroup?: string;
+    promoCode?: string;
+    context?: Record<string, unknown>;
+}
+export interface AppliedRule {
+    ruleId: string;
+    ruleName: string;
+    ruleType: string;
+    discountAmount: string;
+    discountType: string;
+}
+export interface PriceBreakdown {
+    subtotal: string;
+    discounts: string;
+    taxes: string;
+    total: string;
+}
+export interface TierInfo {
+    tierId: string;
+    minQuantity: number;
+    maxQuantity?: number;
+    discountType: string;
+    discountValue?: string;
+}
+export interface CalculatePriceResult {
+    variantId: string;
+    quantity: number;
+    basePrice: string;
+    finalPrice: string;
+    totalPrice: string;
+    currency: string;
+    appliedRules: AppliedRule[];
+    priceBreakdown: PriceBreakdown;
+    calculatedAt: string;
+    tierInfo?: TierInfo;
+}
+export interface VariantPricing {
+    basePrice: string;
+    currency: string;
+    effectiveFrom: string;
+    effectiveTo?: string;
+}
+export interface BulkPricingResult {
+    [variantId: string]: VariantPricing;
+}
+export interface SyncFromErpDto {
+    variantId: string;
+    basePrice: number;
+    currency: string;
+    cost?: number;
+    effectiveFrom?: string;
+    effectiveTo?: string;
+    erpSystemId: string;
+    metadata?: Record<string, unknown>;
+}
+export type PricingRuleType = 'quantityBreak' | 'customerGroup' | 'geographic' | 'timeBased';
+export interface PricingRule {
+    id: string;
+    tenantId: string;
+    storeId: string;
+    name: string;
+    description?: string;
+    ruleType: PricingRuleType;
+    conditions: Record<string, unknown>;
+    actions: Record<string, unknown>;
+    priority: number;
+    isActive: boolean;
+    startsAt: string;
+    endsAt?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreatePricingRuleDto {
+    name: string;
+    description?: string;
+    ruleType: PricingRuleType;
+    conditions: Record<string, unknown>;
+    actions: Record<string, unknown>;
+    priority?: number;
+    isActive?: boolean;
+    startsAt?: string;
+    endsAt?: string;
+}
+export interface UpdatePricingRuleDto {
+    name?: string;
+    description?: string;
+    ruleType?: PricingRuleType;
+    conditions?: Record<string, unknown>;
+    actions?: Record<string, unknown>;
+    priority?: number;
+    isActive?: boolean;
+    startsAt?: string;
+    endsAt?: string;
+}
+export type TierDiscountType = 'percentage' | 'fixedAmount' | 'priceOverride';
+export interface PricingTier {
+    id: string;
+    pricingRuleId: string;
+    minQuantity: number;
+    maxQuantity?: number;
+    discountType: TierDiscountType;
+    discountValue?: string;
+    priceOverride?: string;
+    currency: string;
+    createdAt: string;
+}
+export interface CreatePricingTierDto {
+    pricingRuleId: string;
+    minQuantity: number;
+    maxQuantity?: number;
+    discountType: TierDiscountType;
+    discountValue?: string;
+    priceOverride?: string;
+    currency?: string;
+}
+export interface UpdatePricingTierDto {
+    minQuantity?: number;
+    maxQuantity?: number;
+    discountType?: TierDiscountType;
+    discountValue?: string;
+    priceOverride?: string;
+    currency?: string;
+}
+export interface BulkCreateTiersDto {
+    tiers: Omit<CreatePricingTierDto, 'pricingRuleId'>[];
+}
+export interface TierStructure {
+    id: string;
+    quantityRange: {
+        min: number;
+        max?: number;
+    };
+    discount: {
+        type: string;
+        value?: string;
+        priceOverride?: string;
+    };
+    currency: string;
+}
+export interface Currency {
+    id: string;
+    tenantId: string;
+    storeId: string;
+    code: string;
+    name: string;
+    symbol: string;
+    decimalPlaces: number;
+    isEnabled: boolean;
+    isDefault: boolean;
+    exchangeRate?: string;
+    rateUpdatedAt?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreateCurrencyDto {
+    code: string;
+    name: string;
+    symbol: string;
+    decimalPlaces?: number;
+    isEnabled?: boolean;
+    isDefault?: boolean;
+    exchangeRate?: string;
+}
+export interface UpdateCurrencyDto {
+    name?: string;
+    symbol?: string;
+    decimalPlaces?: number;
+    isEnabled?: boolean;
+    isDefault?: boolean;
+    exchangeRate?: string;
+}
+export interface CurrencyConversionDto {
+    amount: number;
+    fromCurrency: string;
+    toCurrency: string;
+}
+export interface CurrencyConversionResult {
+    originalAmount: number;
+    convertedAmount: number;
+    fromCurrency: string;
+    toCurrency: string;
+    exchangeRate: number;
+    convertedAt: string;
+}
+export interface ExchangeRateUpdate {
+    code: string;
+    rate: number;
+}
+export interface ExchangeRateResult {
+    fromCurrency: string;
+    toCurrency: string;
+    /** The exchange rate (1 fromCurrency = rate toCurrency) */
+    rate: string;
+    /** Rate provider: 'manual', 'frankfurter', 'ecb', 'identity', etc. */
+    provider: string;
+    retrievedAt: string;
+}
+export interface AllExchangeRatesResult {
+    baseCurrency: string;
+    /** Map of currency code to exchange rate */
+    rates: Record<string, string>;
+    provider: string;
+    retrievedAt: string;
+}
+export interface CurrencyFilters {
+    enabledOnly?: boolean;
+}
+export interface RefreshRatesResult {
+    success: boolean;
+    provider: string;
+    baseCurrency: string;
+    ratesUpdated: number;
+    ratesDate: string;
+    fromCache: boolean;
+    updatedCurrencies: string[];
+    errors?: string[];
+}
+export type ExchangeRateMode = 'auto' | 'manual';
+/**
+ * Exchange rate included with market when requested via ?include=exchangeRates
+ */
+export interface MarketExchangeRate {
+    currency: string;
+    rate: string;
+    provider: string;
+    updatedAt: string;
+}
+/**
+ * Selling region that groups countries with a default currency.
+ * Markets are tenant-scoped and can be enabled per-store via StoreMarketSettings.
+ */
+export interface Market {
+    id: string;
+    tenantId: string;
+    name: string;
+    code: string;
+    countries: string[];
+    currencies: string[];
+    defaultCurrency: string;
+    /**
+     * Exchange rate mode: "auto" fetches from provider, "manual" uses rates from ExchangeRate table.
+     * Manual rates can be set via manualExchangeRates in CreateMarketDto/UpdateMarketDto.
+     */
+    exchangeRateMode: ExchangeRateMode;
+    isActive: boolean;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+    /**
+     * Exchange rates for this market's currencies. Only included when requested via ?include=exchangeRates
+     */
+    exchangeRates?: MarketExchangeRate[];
+}
+export interface MarketList {
+    data: Market[];
+    total: number;
+    skip?: number;
+    take?: number;
+}
+export interface CreateMarketDto {
+    name: string;
+    code: string;
+    countries: string[];
+    currencies: string[];
+    defaultCurrency: string;
+    exchangeRateMode?: ExchangeRateMode;
+    /**
+     * Manual exchange rates from defaultCurrency to other currencies.
+     * Keys are ISO 4217 codes, values are decimal rate strings.
+     * These are stored in the ExchangeRate table with provider: 'manual'.
+     */
+    manualExchangeRates?: Record<string, string>;
+    isActive?: boolean;
+}
+export interface UpdateMarketDto {
+    name?: string;
+    countries?: string[];
+    currencies?: string[];
+    defaultCurrency?: string;
+    exchangeRateMode?: ExchangeRateMode;
+    /**
+     * Manual exchange rates from defaultCurrency to other currencies.
+     * Keys are ISO 4217 codes, values are decimal rate strings.
+     * These are stored in the ExchangeRate table with provider: 'manual'.
+     */
+    manualExchangeRates?: Record<string, string>;
+    isActive?: boolean;
+}
+export interface MarketFilters {
+    activeOnly?: boolean;
+    skip?: number;
+    take?: number;
+}
+export type MarketInclude = 'exchangeRates';
+export interface MarketGetOptions {
+    /** Include related data in the response */
+    include?: MarketInclude[];
+}
+export interface MarketPriceCount {
+    marketId: string;
+    priceCount: number;
+}
+export interface MarketDeletePricesResult {
+    marketId: string;
+    deletedCount: number;
+}
+/**
+ * Summary of a market for inclusion in store settings.
+ */
+export interface MarketSummary {
+    id: string;
+    name: string;
+    code: string;
+    defaultCurrency: string;
+    currencies: string[];
+    isActive: boolean;
+}
+/**
+ * Store-level market settings with embedded market details.
+ * Represents the relationship between a store and a tenant-level market.
+ */
+export interface StoreMarketSettings {
+    id: string;
+    tenantId: string;
+    storeId: string;
+    marketId: string;
+    /** Whether the market is enabled for this store */
+    isEnabled: boolean;
+    /** Price adjustment percentage for this store (-100 to 100). Positive = markup, negative = discount. */
+    priceAdjustmentPercent: string | null;
+    /** Sort order for displaying markets in this store */
+    sortOrder: number;
+    createdAt: string;
+    updatedAt: string;
+    /** Market details (included when fetching with market info) */
+    market?: MarketSummary;
+}
+export interface StoreMarketSettingsList {
+    data: StoreMarketSettings[];
+    total: number;
+    skip?: number;
+    take?: number;
+}
+export interface EnableStoreMarketDto {
+    /** Price adjustment percentage for this store (-100 to 100). Positive = markup, negative = discount. */
+    priceAdjustmentPercent?: string | null;
+    /** Sort order for displaying this market in the store (lower = higher priority) */
+    sortOrder?: number;
+}
+export interface UpdateStoreMarketSettingsDto {
+    /** Whether the market is enabled for this store */
+    isEnabled?: boolean;
+    /** Price adjustment percentage for this store (-100 to 100). Positive = markup, negative = discount. Set to null to remove. */
+    priceAdjustmentPercent?: string | null;
+    /** Sort order for displaying this market in the store (lower = higher priority) */
+    sortOrder?: number;
+}
+export interface StoreMarketFilters {
+    /** Only include enabled markets */
+    enabledOnly?: boolean;
+    skip?: number;
+    take?: number;
+}
+/**
+ * Customer segmentation for differentiated pricing.
+ */
+export interface CustomerGroup {
+    id: string;
+    tenantId: string;
+    storeId: string;
+    name: string;
+    code: string;
+    description: string | null;
+    discountPercent: string | null;
+    isActive: boolean;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+}
+export interface CustomerGroupList {
+    data: CustomerGroup[];
+    total: number;
+    skip?: number;
+    take?: number;
+}
+export interface CreateCustomerGroupDto {
+    name: string;
+    code: string;
+    description?: string;
+    discountPercent?: string;
+    isActive?: boolean;
+}
+export interface UpdateCustomerGroupDto {
+    name?: string;
+    description?: string;
+    discountPercent?: string | null;
+    isActive?: boolean;
+}
+export interface CustomerGroupFilters {
+    activeOnly?: boolean;
+    skip?: number;
+    take?: number;
+}
+/**
+ * Price tier for quantity-based pricing.
+ */
+export interface PriceTier {
+    minQuantity: number;
+    maxQuantity?: number;
+    amount: string;
+    discountPercent?: number;
+}
+/**
+ * Scoped pricing for a product variant with support for
+ * multi-currency, markets, customer groups, and quantity tiers.
+ */
+export interface VariantPrice {
+    id: string;
+    tenantId: string;
+    storeId: string;
+    variantId: string;
+    amount: string;
+    compareAtAmount: string | null;
+    cost: string | null;
+    currencyCode: string;
+    marketId: string | null;
+    customerGroupId: string | null;
+    validFrom: string | null;
+    validTo: string | null;
+    tiers: PriceTier[] | null;
+    /**
+     * Whether this price is available for purchase.
+     * When false, price resolution returns "unavailable" with no fallback to auto-convert.
+     */
+    isAvailable: boolean;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+}
+export interface VariantPriceList {
+    data: VariantPrice[];
+    total: number;
+    skip?: number;
+    take?: number;
+}
+export interface CreateVariantPriceDto {
+    variantId: string;
+    /** Selling price in cents. Required unless isAvailable is false. */
+    amount: number;
+    compareAtAmount?: number;
+    cost?: number;
+    currencyCode: string;
+    marketId?: string | null;
+    customerGroupId?: string | null;
+    validFrom?: string;
+    validTo?: string;
+    tiers?: PriceTier[];
+    /**
+     * Whether this price is available for purchase.
+     * When false, price resolution returns "unavailable" with no fallback to auto-convert.
+     * @default true
+     */
+    isAvailable?: boolean;
+}
+export interface UpdateVariantPriceDto {
+    amount?: number;
+    compareAtAmount?: number | null;
+    cost?: number | null;
+    validFrom?: string | null;
+    validTo?: string | null;
+    tiers?: PriceTier[] | null;
+    /**
+     * Whether this price is available for purchase.
+     * When false, price resolution returns "unavailable" with no fallback to auto-convert.
+     */
+    isAvailable?: boolean;
+}
+export interface VariantPriceFilters {
+    activeOnly?: boolean;
+    skip?: number;
+    take?: number;
+}
+/**
+ * A single price item in a bulk create request, one per currency.
+ */
+export interface BulkPriceItemDto {
+    /** ISO 4217 currency code */
+    currencyCode: string;
+    /** Selling price in cents */
+    amount: number;
+    /** Compare-at price in cents (strikethrough/sale display) */
+    compareAtAmount?: number;
+    /** Cost of Goods Sold (COGS) for margin calculation in cents */
+    cost?: number;
+    /**
+     * Whether this price is available for purchase.
+     * @default true
+     */
+    isAvailable?: boolean;
+}
+/**
+ * Request to create multiple prices for a single variant in one call.
+ * All prices share the same variant/market/customerGroup scope,
+ * with one entry per currency.
+ */
+export interface BulkCreateVariantPricesDto {
+    variantId: string;
+    marketId: string;
+    /** Customer group these prices apply to (omit/null = all customers) */
+    customerGroupId?: string | null;
+    /** Prices to create, one per currency (min 1) */
+    prices: BulkPriceItemDto[];
+}
+/**
+ * A price that failed to create during a bulk create request.
+ */
+export interface BulkCreateVariantPriceError {
+    currencyCode: string;
+    error: string;
+}
+/**
+ * Result of a bulk create request. Partial success is possible:
+ * check `errors` even on a successful response.
+ */
+export interface BulkCreateVariantPricesResult {
+    created: VariantPrice[];
+    errors: BulkCreateVariantPriceError[];
+}
+/**
+ * Request to resolve the best price for a variant in a given context.
+ */
+export interface ResolvePriceDto {
+    variantId: string;
+    currencyCode: string;
+    marketId?: string;
+    customerGroupId?: string;
+    quantity?: number;
+}
+/**
+ * How the resolved price was determined.
+ * - 'exact': variant + currency + market + customerGroup match
+ * - 'market': variant + currency + market (no customerGroup)
+ * - 'group': variant + currency + customerGroup (no market)
+ * - 'base': variant + currency (no market, no customerGroup)
+ * - 'converted': Auto-converted from default currency
+ * - 'unavailable': An explicit price exists with isAvailable=false
+ */
+export type PriceResolutionSource = 'exact' | 'market' | 'group' | 'base' | 'converted' | 'unavailable';
+/**
+ * The result of price resolution.
+ */
+export interface ResolvedPrice {
+    variantId: string;
+    amount: string;
+    compareAtAmount?: string;
+    cost?: string;
+    currencyCode: string;
+    source: PriceResolutionSource;
+    /**
+     * Whether this currency is available for purchase.
+     * When false, the product should not be purchasable in this currency.
+     */
+    isAvailable: boolean;
+    appliedTier?: {
+        minQuantity: number;
+        amount: string;
+    };
+    /** ID of the VariantPrice record used (if any) */
+    priceId?: string;
+    resolvedAt: string;
+}
+/**
+ * Preview of a single currency's pricing for a variant.
+ * Used in the converted prices preview endpoint.
+ */
+export interface CurrencyConversionPreview {
+    /** ISO 4217 currency code */
+    currencyCode: string;
+    /** Currency display symbol */
+    symbol: string;
+    /** Calculated or explicit price amount */
+    amount: string;
+    /** Exchange rate used for conversion (null if explicit price exists) */
+    exchangeRate: string | null;
+    /** Whether an explicit price exists for this currency */
+    hasExplicitPrice: boolean;
+    /** The explicit price amount if one exists (may differ from calculated amount) */
+    explicitAmount?: string;
+    /** Whether this currency is available for purchase. False if explicit price has isAvailable=false. */
+    isAvailable: boolean;
+}
+/**
+ * Full preview of all currency conversions for a variant in a market.
+ * Returned by the preview endpoint.
+ */
+export interface ConvertedPricesPreview {
+    /** Product variant ID */
+    variantId: string;
+    /** Market ID */
+    marketId: string;
+    /** Market name */
+    marketName: string;
+    /** Base currency code for this market */
+    baseCurrency: string;
+    /** Base price amount */
+    baseAmount: string;
+    /** Preview of all currency conversions for this market */
+    conversions: CurrencyConversionPreview[];
+}
+export type PricingMode = 'auto' | 'manual';
+/**
+ * Per-product market configuration for availability and pricing mode.
+ */
+export interface ProductMarketSettings {
+    id: string;
+    tenantId: string;
+    storeId: string;
+    productId: string;
+    marketId: string;
+    isAvailable: boolean;
+    pricingMode: PricingMode;
+    priceAdjustmentPercent: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ProductMarketSettingsList {
+    data: ProductMarketSettings[];
+    total: number;
+    skip?: number;
+    take?: number;
+}
+export interface CreateProductMarketSettingsDto {
+    productId: string;
+    marketId: string;
+    isAvailable?: boolean;
+    pricingMode?: PricingMode;
+    priceAdjustmentPercent?: string | null;
+}
+export interface UpdateProductMarketSettingsDto {
+    isAvailable?: boolean;
+    pricingMode?: PricingMode;
+    priceAdjustmentPercent?: string | null;
+}
+export interface ProductMarketSettingsFilters {
+    productId?: string;
+    marketId?: string;
+    isAvailable?: boolean;
+    pricingMode?: PricingMode;
+    skip?: number;
+    take?: number;
+}
+/**
+ * Tenant-scoped reusable geographic scope for product availability restrictions.
+ * restrictionCount is the number of restriction rows referencing this zone.
+ */
+export interface GeoZone {
+    id: string;
+    tenantId: string;
+    name: string;
+    code: string;
+    description: string | null;
+    countries: string[];
+    statesProvinces: string[];
+    postalCodes: string[];
+    isActive: boolean;
+    restrictionCount: number;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+}
+export interface GeoZoneList {
+    data: GeoZone[];
+    total: number;
+    skip?: number;
+    take?: number;
+}
+export interface CreateGeoZoneDto {
+    name: string;
+    code: string;
+    description?: string;
+    countries: string[];
+    statesProvinces?: string[];
+    postalCodes?: string[];
+    isActive?: boolean;
+}
+export interface UpdateGeoZoneDto {
+    name?: string;
+    description?: string;
+    countries?: string[];
+    statesProvinces?: string[];
+    postalCodes?: string[];
+    isActive?: boolean;
+}
+export interface GeoZoneFilters {
+    activeOnly?: boolean;
+    skip?: number;
+    take?: number;
+}
+/**
+ * Attach/detach row linking a product to a geo zone. No update surface:
+ * changing mode or market scope is delete + create.
+ */
+export interface ProductGeoRestriction {
+    id: string;
+    tenantId: string;
+    storeId: string;
+    productId: string;
+    zoneId: string;
+    marketId: string | null;
+    mode: GeoRestrictionMode;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ProductGeoRestrictionList {
+    data: ProductGeoRestriction[];
+    total: number;
+    skip?: number;
+    take?: number;
+}
+export interface CreateProductGeoRestrictionDto {
+    productId: string;
+    zoneId: string;
+    mode: GeoRestrictionMode;
+    marketId?: string;
+}
+export interface BulkCreateProductGeoRestrictionsDto {
+    productIds: string[];
+    zoneId: string;
+    mode: GeoRestrictionMode;
+    marketId?: string;
+}
+export interface BulkCreateProductGeoRestrictionsResult {
+    data: ProductGeoRestriction[];
+    count: number;
+}
+export interface ProductGeoRestrictionFilters {
+    productId?: string;
+    zoneId?: string;
+    skip?: number;
+    take?: number;
+}
+//# sourceMappingURL=types.d.ts.map