@shopperlabs/shopper-types 2.5.0 → 2.6.0

package/README.md

@@ -4,7 +4,7 @@
 
 # Shopper Types definitions
 
-TypeScript types derived from the OpenAPI Spec (OAS) to be used in API clients for Laravel Shopper.
+TypeScript types derived from the OpenAPI Spec (OAS) to be used in API clients for Shopper.
 
 ## Install
 

package/dist/cart.d.ts

@@ -0,0 +1,138 @@
+import type { Channel } from './channel';
+import type { DateEntity, Entity, Metadata } from './common';
+import type { Country } from './country';
+import type { Customer } from './customer';
+import type { Discount } from './discount';
+import type { TaxRate } from './tax';
+import type { Zone } from './zone';
+export declare enum CartAddressType {
+    BILLING = "billing",
+    SHIPPING = "shipping"
+}
+/**
+ * Cart model.
+ */
+export interface Cart extends Entity {
+    /** The currency code for the cart. */
+    currency_code: string;
+    /** The coupon code applied to the cart. */
+    coupon_code: string | null;
+    /** The date the cart was completed (converted to order). */
+    completed_at: DateEntity | null;
+    /** The metadata of the cart. */
+    metadata: Metadata;
+    /** The customer ID. */
+    customer_id: number | null;
+    /** The channel ID. */
+    channel_id: number | null;
+    /** The zone ID. */
+    zone_id: number | null;
+    /** The cart lines. */
+    lines?: CartLine[];
+    /** The cart addresses. */
+    addresses?: CartAddress[];
+    /** The customer. */
+    customer?: Customer | null;
+    /** The channel. */
+    channel?: Channel | null;
+    /** The zone. */
+    zone?: Zone | null;
+}
+/**
+ * CartLine model.
+ */
+export interface CartLine extends Entity {
+    /** The cart ID. */
+    cart_id: number;
+    /** The morph type of the purchasable entity. */
+    purchasable_type: string;
+    /** The morph ID of the purchasable entity. */
+    purchasable_id: number;
+    /** The quantity of the cart line. */
+    quantity: number;
+    /** The unit price amount (in cents). */
+    unit_price_amount: number;
+    /** The metadata of the cart line. */
+    metadata: Metadata;
+    /** The cart this line belongs to. */
+    cart?: Cart;
+    /** The purchasable entity (product or variant). */
+    purchasable?: Record<string, unknown>;
+    /** The price adjustments applied to this line. */
+    adjustments?: CartLineAdjustment[];
+    /** The tax lines applied to this line. */
+    taxLines?: CartLineTaxLine[];
+}
+/**
+ * CartAddress model.
+ */
+export interface CartAddress extends Entity {
+    /** The cart ID. */
+    cart_id: number;
+    /** The address type (billing or shipping). */
+    type: CartAddressType;
+    /** The country ID. */
+    country_id: number | null;
+    /** The first name. */
+    first_name: string | null;
+    /** The last name. */
+    last_name: string;
+    /** The company name. */
+    company: string | null;
+    /** The primary street address. */
+    address_1: string;
+    /** The secondary street address. */
+    address_2: string | null;
+    /** The city. */
+    city: string;
+    /** The state/province. */
+    state: string | null;
+    /** The postal code. */
+    postal_code: string;
+    /** The phone number. */
+    phone: string | null;
+    /** The computed full name. */
+    full_name: string;
+    /** The cart this address belongs to. */
+    cart?: Cart;
+    /** The country. */
+    country?: Country | null;
+}
+/**
+ * CartLineAdjustment model — price adjustments (discounts) applied to a cart line.
+ */
+export interface CartLineAdjustment extends Entity {
+    /** The cart line ID. */
+    cart_line_id: number;
+    /** The adjustment amount (in cents). */
+    amount: number;
+    /** The coupon/discount code. */
+    code: string | null;
+    /** The discount ID (if applied from a discount). */
+    discount_id: number | null;
+    /** The cart line this adjustment belongs to. */
+    cartLine?: CartLine;
+    /** The discount this adjustment comes from. */
+    discount?: Discount | null;
+}
+/**
+ * CartLineTaxLine model — tax applied to a cart line.
+ */
+export interface CartLineTaxLine extends Entity {
+    /** The cart line ID. */
+    cart_line_id: number;
+    /** The tax code (e.g., "VAT", "GST"). */
+    code: string;
+    /** The tax name (e.g., "TVA 20%"). */
+    name: string;
+    /** The tax rate percentage (e.g., 20.0 for 20%). */
+    rate: number;
+    /** The calculated tax amount (in cents). */
+    amount: number;
+    /** The source tax rate ID. */
+    tax_rate_id: number | null;
+    /** The cart line this tax line belongs to. */
+    cartLine?: CartLine;
+    /** The source tax rate. */
+    taxRate?: TaxRate | null;
+}

package/dist/cart.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CartAddressType = void 0;
+var CartAddressType;
+(function (CartAddressType) {
+    CartAddressType["BILLING"] = "billing";
+    CartAddressType["SHIPPING"] = "shipping";
+})(CartAddressType || (exports.CartAddressType = CartAddressType = {}));

package/dist/currency.d.ts

@@ -1,4 +1,8 @@
 import type { Zone } from './zone';
+/**
+ * Check if a currency code does not use subunits (e.g., JPY, KRW).
+ */
+export declare function isNoDivisionCurrency(currency: string): boolean;
 /**
  * Currency model.
  */

package/dist/currency.js

@@ -1,2 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNoDivisionCurrency = isNoDivisionCurrency;
+/**
+ * Check if a currency code does not use subunits (e.g., JPY, KRW).
+ */
+function isNoDivisionCurrency(currency) {
+    return [
+        'BIF', 'CLP', 'DJF', 'GNF', 'HTG', 'JPY', 'KMF', 'KRW', 'MGA',
+        'PYG', 'RWF', 'VND', 'VUV', 'XAF', 'XAG', 'XAU', 'XDR', 'XOF', 'XPF',
+    ].includes(currency);
+}

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export * from './address';
 export * from './attribute';
 export * from './brand';
 export * from './carrier';
+export * from './cart';
 export * from './category';
 export * from './channel';
 export * from './collection';
@@ -20,4 +21,5 @@ export * from './product_tag';
 export * from './product';
 export * from './review';
 export * from './supplier';
+export * from './tax';
 export * from './zone';

package/dist/index.js

@@ -18,6 +18,7 @@ __exportStar(require("./address"), exports);
 __exportStar(require("./attribute"), exports);
 __exportStar(require("./brand"), exports);
 __exportStar(require("./carrier"), exports);
+__exportStar(require("./cart"), exports);
 __exportStar(require("./category"), exports);
 __exportStar(require("./channel"), exports);
 __exportStar(require("./collection"), exports);
@@ -36,4 +37,5 @@ __exportStar(require("./product_tag"), exports);
 __exportStar(require("./product"), exports);
 __exportStar(require("./review"), exports);
 __exportStar(require("./supplier"), exports);
+__exportStar(require("./tax"), exports);
 __exportStar(require("./zone"), exports);

package/dist/order.d.ts

@@ -3,6 +3,7 @@ import type { Channel } from './channel';
 import type { DateEntity, Entity, Metadata } from './common';
 import type { Customer } from './customer';
 import type { PaymentMethod } from './payment_method';
+import type { OrderTaxLine } from './tax';
 import type { Zone } from './zone';
 export declare enum OrderStatus {
     NEW = "new",
@@ -63,12 +64,12 @@ export interface Order extends Entity {
     number: string;
     /** The total price amount (in cents). */
     price_amount: number;
+    /** The tax amount (in cents). */
+    tax_amount: number | null;
     /** The notes for the order. */
     notes: string | null;
     /** The currency code for the order. */
     currency_code: string;
-    /** The computed total amount. */
-    total_amount?: number;
     /** The order status. */
     status: OrderStatus;
     /** The payment status. */
@@ -132,6 +133,8 @@ export interface OrderItem extends Entity {
     quantity: number;
     /** The unit price amount. */
     unit_price_amount: number | null;
+    /** The tax amount (in cents). */
+    tax_amount: number;
     /** The computed total (unit_price_amount * quantity). */
     total: number;
     /** The SKU of the order item. */
@@ -148,6 +151,8 @@ export interface OrderItem extends Entity {
     fulfillment_status: FulfillmentStatus | null;
     /** The order. */
     order?: Order;
+    /** The tax lines. */
+    taxLines?: OrderTaxLine[];
     /** The shipment. */
     shipment?: OrderShipping;
 }
@@ -212,6 +217,8 @@ export interface OrderShipping extends Entity {
     items?: OrderItem[];
     /** The shipment tracking events. */
     events?: OrderShippingEvent[];
+    /** The tax lines. */
+    taxLines?: OrderTaxLine[];
 }
 /**
  * OrderShippingEvent model.

package/dist/tax.d.ts

@@ -0,0 +1,101 @@
+import type { Country } from './country';
+import type { Entity, Metadata } from './common';
+/**
+ * TaxProvider model.
+ */
+export interface TaxProvider extends Entity {
+    /** The provider identifier (e.g., "system", "stripe_tax"). */
+    identifier: string;
+    /** Whether the provider is enabled. */
+    is_enabled: boolean;
+    /** The tax zones using this provider. */
+    taxZones?: TaxZone[];
+}
+/**
+ * TaxZone model.
+ */
+export interface TaxZone extends Entity {
+    /** The zone name. */
+    name: string | null;
+    /** The country ID. */
+    country_id: number;
+    /** The province code (for sub-country zones). */
+    province_code: string | null;
+    /** Whether prices in this zone include tax. */
+    is_tax_inclusive: boolean;
+    /** The parent zone ID. */
+    parent_id: number | null;
+    /** The tax provider ID. */
+    provider_id: number | null;
+    /** The metadata. */
+    metadata: Metadata;
+    /** The computed display name (country — name). */
+    display_name: string;
+    /** The country. */
+    country?: Country;
+    /** The parent zone. */
+    parent?: TaxZone | null;
+    /** The child zones. */
+    children?: TaxZone[];
+    /** The tax rates for this zone. */
+    rates?: TaxRate[];
+    /** The tax provider. */
+    provider?: TaxProvider | null;
+}
+/**
+ * TaxRate model.
+ */
+export interface TaxRate extends Entity {
+    /** The rate name (e.g., "TVA", "Sales Tax"). */
+    name: string;
+    /** The rate code (e.g., "CM-TVA-20"). */
+    code: string | null;
+    /** The tax rate percentage (e.g., 20.0 for 20%). */
+    rate: number;
+    /** Whether this is the default rate for the zone. */
+    is_default: boolean;
+    /** Whether this rate can be combined with others. */
+    is_combinable: boolean;
+    /** The tax zone ID. */
+    tax_zone_id: number;
+    /** The metadata. */
+    metadata: Metadata;
+    /** The tax zone. */
+    taxZone?: TaxZone;
+    /** The rules for this rate. */
+    rules?: TaxRateRule[];
+}
+/**
+ * TaxRateRule model.
+ */
+export interface TaxRateRule extends Entity {
+    /** The morph type of the reference (e.g., product type, category). */
+    reference_type: string;
+    /** The morph ID of the reference. */
+    reference_id: string;
+    /** The tax rate ID. */
+    tax_rate_id: number;
+    /** The tax rate. */
+    taxRate?: TaxRate;
+}
+/**
+ * OrderTaxLine model — snapshot tax applied to an order item or shipping.
+ */
+export interface OrderTaxLine extends Entity {
+    /** The morph type (OrderItem or OrderShipping). */
+    taxable_type: string;
+    /** The morph ID. */
+    taxable_id: number;
+    /** The snapshot tax code (e.g., "VAT", "GST"). */
+    code: string;
+    /** The snapshot tax name (e.g., "TVA 20%"). */
+    name: string;
+    /** The snapshot tax rate percentage. */
+    rate: number;
+    /** The calculated tax amount (in cents). */
+    amount: number;
+    /** Optional reference to the source tax rate. */
+    tax_rate_id: number | null;
+    /** The source tax rate (if still exists). */
+    taxRate?: TaxRate | null;
+}

package/dist/tax.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shopperlabs/shopper-types",
-  "version": "2.5.0",
-  "description": "TypeScript types for Laravel Shopper",
+  "version": "2.6.0",
+  "description": "TypeScript types for Shopper",
   "author": "Arthur Monney <monneylobe@gmail.com> (https://arthurmonney.me)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",