@usethrottle/discounts 0.4.1 → 0.5.0

package/README.md

@@ -68,7 +68,7 @@ await discounts.create({
 
 await discounts.create({
   code: 'FIVE-OFF',
-  name: '$5 off',
+  name: 'Spring discount',
   type: 'fixed_amount',
   value: 500,
 });
@@ -82,6 +82,15 @@ amount discounts.
 repeat customer use, or `null` for unlimited customer redemptions. Redemption
 usage is counted when a discounted cart becomes an order.
 
+## Money
+
+Amounts are integers in the currency's minor unit. `validate` and `preview`
+answer `minimum` and `shortfall` money values (`{ amount, currency, display }`)
+when the order is under a code's minimum. Show them with
+`formatMoney(amount, currency)`: this package re-exports `@usethrottle/money`
+as `money` and `formatMoney` by name, plus the `CurrencyCode` and `MoneyValue`
+types.
+
 ## API Key Safety
 
 This package sends `X-API-Key` to the Throttle API. Use it from a trusted server

package/dist/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,16 +17,35 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  CURRENCIES: () => import_money.CURRENCIES,
   DiscountsClient: () => DiscountsClient,
   ThrottleDiscountsError: () => ThrottleDiscountsError,
   ThrottleError: () => import_errors2.ThrottleError,
+  UnknownCurrencyError: () => import_money.UnknownCurrencyError,
   createDiscountsClient: () => createDiscountsClient,
-  isThrottleError: () => import_errors2.isThrottleError
+  currencySymbol: () => import_money.currencySymbol,
+  formatMoney: () => import_money.formatMoney,
+  isKnownCurrency: () => import_money.isKnownCurrency,
+  isThrottleError: () => import_errors2.isThrottleError,
+  minorUnitsOf: () => import_money.minorUnitsOf,
+  money: () => money,
+  moneyValue: () => import_money.moneyValue,
+  parseMoney: () => import_money.parseMoney,
+  toDecimalString: () => import_money.toDecimalString,
+  toMinor: () => import_money.toMinor
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -155,11 +176,26 @@ function serializeDates(input) {
   }
   return out;
 }
+
+// src/index.ts
+var money = __toESM(require("@usethrottle/money"), 1);
+var import_money = require("@usethrottle/money");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  CURRENCIES,
   DiscountsClient,
   ThrottleDiscountsError,
   ThrottleError,
+  UnknownCurrencyError,
   createDiscountsClient,
-  isThrottleError
+  currencySymbol,
+  formatMoney,
+  isKnownCurrency,
+  isThrottleError,
+  minorUnitsOf,
+  money,
+  moneyValue,
+  parseMoney,
+  toDecimalString,
+  toMinor
 });

package/dist/index.d.cts

@@ -1,7 +1,21 @@
+import { CurrencyCode, MoneyValue } from '@usethrottle/money';
+import * as money from '@usethrottle/money';
+export { money };
+export { CURRENCIES, CurrencyCode, MoneyValue, UnknownCurrencyError, currencySymbol, formatMoney, isKnownCurrency, minorUnitsOf, moneyValue, parseMoney, toDecimalString, toMinor } from '@usethrottle/money';
 import { ThrottleError, ThrottleErrorArgs } from '@usethrottle/errors';
 export { ThrottleError, isThrottleError } from '@usethrottle/errors';
 
 type DiscountType = 'percentage' | 'fixed_amount';
+/**
+ * Per-currency amounts in minor units, keyed by currency code:
+ * `{ EUR: { value: 900, minOrder: 4500 } }`. A currency with no entry is not
+ * offered; amounts are never converted. `Partial` because `CurrencyCode` lists
+ * every ISO code as a literal: a plain `Record` would require all of them.
+ */
+type DiscountAmounts = Partial<Record<CurrencyCode, {
+    value?: number;
+    minOrder?: number;
+}>>;
 interface Discount {
     id: string;
     code: string | null;
@@ -17,6 +31,8 @@ interface Discount {
     endsAt?: string | null;
     metadata: Record<string, unknown>;
     createdAt: string;
+    /** Per-currency amounts; the main-currency entry mirrors `value`. */
+    amounts?: DiscountAmounts;
 }
 interface CreateDiscountInput {
     code?: string;
@@ -54,6 +70,11 @@ interface DiscountValidationResult {
     valid: boolean;
     discount?: Discount;
     error?: string;
+    currency?: CurrencyCode;
+    /** The code's minimum order total, when the order is under it. */
+    minimum?: MoneyValue;
+    /** How much more the order needs to reach the minimum. */
+    shortfall?: MoneyValue;
 }
 interface DiscountPreviewInput {
     code: string;
@@ -71,16 +92,20 @@ interface DiscountPreviewResult {
     code: string;
     type?: DiscountType;
     value?: number;
-    currency: string;
+    currency: CurrencyCode;
     subtotal: number;
     discountTotal: number;
     total: number;
     discount?: Discount;
     message: string | null;
+    /** The code's minimum order total, when the subtotal is under it. */
+    minimum?: MoneyValue;
+    /** How much more the subtotal needs to reach the minimum. */
+    shortfall?: MoneyValue;
 }
 interface Cart {
     id: string;
-    currency: string;
+    currency: CurrencyCode;
     subtotal: number;
     discountTotal: number;
     shippingTotal: number;
@@ -92,7 +117,7 @@ interface Cart {
         code: string;
         type: DiscountType;
         amount: number;
-        currency: string;
+        currency: CurrencyCode;
         freeShipping: boolean;
         validUntil: string | null;
         snapshotHash: string;
@@ -150,4 +175,4 @@ declare class ThrottleDiscountsError extends ThrottleError {
     });
 }
 
-export { type Cart, type CreateDiscountInput, type Discount, type DiscountListParams, type DiscountPreviewInput, type DiscountPreviewResult, type DiscountType, type DiscountValidationResult, DiscountsClient, type DiscountsClientOptions, type PaginatedDiscounts, ThrottleDiscountsError, type UpdateDiscountInput, createDiscountsClient };
+export { type Cart, type CreateDiscountInput, type Discount, type DiscountAmounts, type DiscountListParams, type DiscountPreviewInput, type DiscountPreviewResult, type DiscountType, type DiscountValidationResult, DiscountsClient, type DiscountsClientOptions, type PaginatedDiscounts, ThrottleDiscountsError, type UpdateDiscountInput, createDiscountsClient };

package/dist/index.d.ts

@@ -1,7 +1,21 @@
+import { CurrencyCode, MoneyValue } from '@usethrottle/money';
+import * as money from '@usethrottle/money';
+export { money };
+export { CURRENCIES, CurrencyCode, MoneyValue, UnknownCurrencyError, currencySymbol, formatMoney, isKnownCurrency, minorUnitsOf, moneyValue, parseMoney, toDecimalString, toMinor } from '@usethrottle/money';
 import { ThrottleError, ThrottleErrorArgs } from '@usethrottle/errors';
 export { ThrottleError, isThrottleError } from '@usethrottle/errors';
 
 type DiscountType = 'percentage' | 'fixed_amount';
+/**
+ * Per-currency amounts in minor units, keyed by currency code:
+ * `{ EUR: { value: 900, minOrder: 4500 } }`. A currency with no entry is not
+ * offered; amounts are never converted. `Partial` because `CurrencyCode` lists
+ * every ISO code as a literal: a plain `Record` would require all of them.
+ */
+type DiscountAmounts = Partial<Record<CurrencyCode, {
+    value?: number;
+    minOrder?: number;
+}>>;
 interface Discount {
     id: string;
     code: string | null;
@@ -17,6 +31,8 @@ interface Discount {
     endsAt?: string | null;
     metadata: Record<string, unknown>;
     createdAt: string;
+    /** Per-currency amounts; the main-currency entry mirrors `value`. */
+    amounts?: DiscountAmounts;
 }
 interface CreateDiscountInput {
     code?: string;
@@ -54,6 +70,11 @@ interface DiscountValidationResult {
     valid: boolean;
     discount?: Discount;
     error?: string;
+    currency?: CurrencyCode;
+    /** The code's minimum order total, when the order is under it. */
+    minimum?: MoneyValue;
+    /** How much more the order needs to reach the minimum. */
+    shortfall?: MoneyValue;
 }
 interface DiscountPreviewInput {
     code: string;
@@ -71,16 +92,20 @@ interface DiscountPreviewResult {
     code: string;
     type?: DiscountType;
     value?: number;
-    currency: string;
+    currency: CurrencyCode;
     subtotal: number;
     discountTotal: number;
     total: number;
     discount?: Discount;
     message: string | null;
+    /** The code's minimum order total, when the subtotal is under it. */
+    minimum?: MoneyValue;
+    /** How much more the subtotal needs to reach the minimum. */
+    shortfall?: MoneyValue;
 }
 interface Cart {
     id: string;
-    currency: string;
+    currency: CurrencyCode;
     subtotal: number;
     discountTotal: number;
     shippingTotal: number;
@@ -92,7 +117,7 @@ interface Cart {
         code: string;
         type: DiscountType;
         amount: number;
-        currency: string;
+        currency: CurrencyCode;
         freeShipping: boolean;
         validUntil: string | null;
         snapshotHash: string;
@@ -150,4 +175,4 @@ declare class ThrottleDiscountsError extends ThrottleError {
     });
 }
 
-export { type Cart, type CreateDiscountInput, type Discount, type DiscountListParams, type DiscountPreviewInput, type DiscountPreviewResult, type DiscountType, type DiscountValidationResult, DiscountsClient, type DiscountsClientOptions, type PaginatedDiscounts, ThrottleDiscountsError, type UpdateDiscountInput, createDiscountsClient };
+export { type Cart, type CreateDiscountInput, type Discount, type DiscountAmounts, type DiscountListParams, type DiscountPreviewInput, type DiscountPreviewResult, type DiscountType, type DiscountValidationResult, DiscountsClient, type DiscountsClientOptions, type PaginatedDiscounts, ThrottleDiscountsError, type UpdateDiscountInput, createDiscountsClient };

package/dist/index.js

@@ -125,10 +125,36 @@ function serializeDates(input) {
   }
   return out;
 }
+
+// src/index.ts
+import * as money from "@usethrottle/money";
+import {
+  formatMoney,
+  currencySymbol,
+  minorUnitsOf,
+  toDecimalString,
+  toMinor,
+  parseMoney,
+  moneyValue,
+  CURRENCIES,
+  isKnownCurrency,
+  UnknownCurrencyError
+} from "@usethrottle/money";
 export {
+  CURRENCIES,
   DiscountsClient,
   ThrottleDiscountsError,
   ThrottleError2 as ThrottleError,
+  UnknownCurrencyError,
   createDiscountsClient,
-  isThrottleError
+  currencySymbol,
+  formatMoney,
+  isKnownCurrency,
+  isThrottleError,
+  minorUnitsOf,
+  money,
+  moneyValue,
+  parseMoney,
+  toDecimalString,
+  toMinor
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usethrottle/discounts",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "Headless TypeScript client for Throttle discount and promotion code APIs.",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -19,7 +19,8 @@
     "CLAUDE.md"
   ],
   "dependencies": {
-    "@usethrottle/errors": "^1.1.0"
+    "@usethrottle/errors": "^1.1.0",
+    "@usethrottle/money": "^1.0.0"
   },
   "devDependencies": {
     "tsup": "^8.0.0",
@@ -34,7 +35,7 @@
   },
   "scripts": {
     "build": "tsup",
-    "test": "vitest run",
+    "test": "tsc --noEmit --strict --skipLibCheck --target es2022 --lib es2022,dom --module esnext --moduleResolution bundler __tests__/currency-types.check.ts && vitest run",
     "typecheck": "tsc --noEmit"
   }
 }