@blocklet/payment-types 1.21.13 → 1.21.14

package/lib/index.d.ts

@@ -33,6 +33,7 @@ import { Meter, TMeter } from './meter';
 import { MeterEvent, TMeterEvent } from './meter-event';
 import { AutoRechargeConfig } from './auto-recharge-config';
 import { ProductVendor } from './product-vendor';
+import { TaxRate } from './tax-rate';
 declare const models: {
     CheckoutSession: typeof CheckoutSession;
     Coupon: typeof Coupon;
@@ -68,6 +69,7 @@ declare const models: {
     MeterEvent: typeof MeterEvent;
     AutoRechargeConfig: typeof AutoRechargeConfig;
     ProductVendor: typeof ProductVendor;
+    TaxRate: typeof TaxRate;
 };
 export declare function initialize(sequelize: any): void;
 export default models;
@@ -106,6 +108,7 @@ export * from './meter';
 export * from './meter-event';
 export * from './auto-recharge-config';
 export * from './product-vendor';
+export * from './tax-rate';
 export type TPriceExpanded = TPrice & {
     object: 'price';
     product: TProduct;

package/lib/invoice-item.d.ts

@@ -21,6 +21,7 @@ export declare class InvoiceItem extends Model<InferAttributes<InvoiceItem>, Inf
     subscription_id?: string;
     subscription_item_id?: string;
     test_clock_id?: string;
+    tax_rate_id?: string;
     discountable: boolean;
     discount_amounts: DiscountAmount[];
     discounts: string[];
@@ -85,6 +86,10 @@ export declare class InvoiceItem extends Model<InferAttributes<InvoiceItem>, Inf
             type: DataTypes.StringDataType;
             allowNull: boolean;
         };
+        tax_rate_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
         discountable: {
             type: DataTypes.AbstractDataTypeConstructor;
             allowNull: boolean;

package/lib/price.d.ts

@@ -46,6 +46,7 @@ export declare class Price extends Model<InferAttributes<Price>, InferCreationAt
     quantity_available: number;
     quantity_sold: number;
     quantity_limit_per_checkout: number;
+    tax_behavior?: LiteralUnion<'inclusive' | 'exclusive', string>;
     static readonly GENESIS_ATTRIBUTES: {
         id: {
             type: DataTypes.StringDataType;

package/lib/product.d.ts

@@ -19,6 +19,7 @@ export declare class Product extends Model<InferAttributes<Product>, InferCreati
     metadata?: Record<string, any>;
     statement_descriptor?: string;
     nft_factory?: string;
+    tax_code?: string;
     cross_sell?: {
         cross_sells_to_id: string;
     };
@@ -93,6 +94,10 @@ export declare class Product extends Model<InferAttributes<Product>, InferCreati
             type: DataTypes.StringDataType;
             allowNull: boolean;
         };
+        tax_code: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
         created_at: {
             type: DataTypes.DateDataTypeConstructor;
             defaultValue: DataTypes.AbstractDataTypeConstructor;

package/lib/tax-rate.d.ts

@@ -0,0 +1,124 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+export declare class TaxRate extends Model<InferAttributes<TaxRate>, InferCreationAttributes<TaxRate>> {
+    id: CreationOptional<string>;
+    livemode: boolean;
+    active: boolean;
+    country: string;
+    state?: string;
+    postal_code?: string;
+    tax_code?: string;
+    percentage: number;
+    display_name: string;
+    description?: string;
+    metadata?: Record<string, any>;
+    created_at: CreationOptional<Date>;
+    updated_at: CreationOptional<Date>;
+    static readonly GENESIS_ATTRIBUTES: {
+        id: {
+            type: DataTypes.StringDataType;
+            primaryKey: boolean;
+            allowNull: boolean;
+            defaultValue: (size?: number) => string;
+        };
+        livemode: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        active: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            defaultValue: boolean;
+        };
+        country: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        state: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        postal_code: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        tax_code: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        percentage: {
+            type: DataTypes.DecimalDataType;
+            allowNull: boolean;
+        };
+        display_name: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        description: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        metadata: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        created_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            defaultValue: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        updated_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            defaultValue: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+    };
+    static initialize(sequelize: any): void;
+    static associate(): void;
+    /**
+     * Find matching tax rate for given location and tax code
+     *
+     * Uses hierarchical scoring (lexicographic ordering) to match tax rates.
+     * Priority: postal_code > state > tax_code
+     *
+     * Note: Country is pre-filtered to ensure postal codes are compared within
+     * the correct national context (e.g., prevents US 90210 from matching CA 90210).
+     *
+     * Score ranges per dimension (0-100):
+     *   - 100: Exact match
+     *   - 50-95: Wildcard match (e.g., "902*" prefix matching)
+     *   - 10: General fallback (rate has no restriction)
+     *   - 5: Both empty
+     */
+    static findMatchingRate({ country, state, postalCode, taxCode, livemode, }: {
+        country: string;
+        state?: string;
+        postalCode?: string;
+        taxCode?: string;
+        livemode?: boolean;
+    }): Promise<TaxRate | null>;
+    /**
+     * Calculate tax amount from tax-inclusive total
+     * Formula: tax = total × (rate / (100 + rate))
+     */
+    static calculateTaxFromInclusive(total: string, percentage: number): string;
+    /**
+     * Calculate subtotal from tax-inclusive total
+     * Formula: subtotal = total - tax
+     */
+    static calculateSubtotalFromInclusive(total: string, percentage: number): string;
+    /**
+     * Calculate tax amount for a single invoice item
+     * Formula: tax = amount × (rate / 100)
+     */
+    static calculateTaxForItem(amount: string, percentage: number): string;
+    /**
+     * Calculate total tax for multiple invoice items
+     */
+    static calculateTotalTax(items: Array<{
+        amount: string;
+        tax_rate_id?: string;
+        tax_rate?: {
+            percentage: number;
+        };
+    }>): string;
+}
+export type TTaxRate = InferAttributes<TaxRate>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blocklet/payment-types",
-  "version": "1.21.13",
+  "version": "1.21.14",
   "description": "Typings for Payment Kit SDK",
   "keywords": [
     "types",
@@ -48,5 +48,5 @@
     "sequelize": "^6.37.7",
     "type-fest": "^4.41.0"
   },
-  "gitHead": "b101cbdeded522328ac7c5ccd2ba44930467fe25"
+  "gitHead": "31f93a8310fe5184be8dd4ff23b362906c8a66cf"
 }