@stacksjs/commerce 0.75.90 → 0.75.91

package/dist/register.d.ts

@@ -10,6 +10,12 @@ export declare function setQuantity(basket: BasketLine[], product: Product, quan
 export declare function basketLines<T extends Product>(basket: BasketLine[], products: T[], fields?: RegisterFields): Array<BasketLine & { product: T }>;
 /** The basket's total, in minor units. */
 export declare function basketTotal(basket: BasketLine[], products: Product[], fields?: RegisterFields): number;
+/**
+ * The part of the basket's total that sales tax applies to: every line whose
+ * product is not marked `taxable: false` (a food product, an admission).
+ * Feed it to `breakdownFor` from `@stacksjs/commerce/sales-tax`.
+ */
+export declare function basketTaxable(basket: BasketLine[], products: Product[], fields?: RegisterFields): number;
 /** How many units are in the basket. */
 export declare function basketCount(basket: BasketLine[]): number;
 /**
@@ -51,6 +57,7 @@ export declare interface RegisterFields {
   price: string
   inventory: string
   lowStock: string
+  taxable: string
 }
 export declare interface StockLabel { text: string, tone: 'out' | 'low' | 'ok' }
 declare type Product = Record<string, any>;

package/dist/register.js

@@ -1,2 +1,2 @@
 // @bun
-var k=Object.defineProperty;var m=(t)=>t;function g(t,n){this[t]=m.bind(null,n)}var L=(t,n)=>{for(var e in n)k(t,e,{get:n[e],enumerable:!0,configurable:!0,set:g.bind(n,e)})};var T=(t,n,e)=>()=>{if(t)try{n=t(t=0)}catch(o){e=[o]}if(e)throw e[0];return n};var S={};L(S,{CENTS_FIELDS:()=>x,DEFAULT_FIELDS:()=>u,addToBasket:()=>y,basketCount:()=>B,basketLines:()=>f,basketTotal:()=>F,canAdd:()=>p,groupsOf:()=>R,setQuantity:()=>I,shelfLeft:()=>l,stockLabel:()=>b});var u={id:"id",price:"price",inventory:"inventory",lowStock:"low_stock_threshold"},x={id:"id",price:"price_cents",inventory:"inventory_quantity",lowStock:"low_stock_threshold"};function s(t,n){return Number(t[n.id])}function a(t,n){let e=t[n.inventory];return e===null||e===void 0||e===""?null:Number(e)}function l(t,n,e=u){let o=a(t,e);if(o===null)return null;let r=n.find((c)=>c.productId===s(t,e))?.quantity||0;return Math.max(0,o-r)}function p(t,n,e=u){let o=l(t,n,e);return o===null||o>0}function y(t,n,e=u){if(!p(n,t,e))return t;let o=s(n,e);return t.some((r)=>r.productId===o)?t.map((r)=>r.productId===o?{...r,quantity:r.quantity+1}:r):[...t,{productId:o,quantity:1}]}function I(t,n,e,o=u){let r=s(n,o),c=a(n,o),d=Math.min(Math.max(0,Math.floor(Number(e)||0)),c===null?Number.POSITIVE_INFINITY:c);if(d===0)return t.filter((i)=>i.productId!==r);return t.some((i)=>i.productId===r)?t.map((i)=>i.productId===r?{...i,quantity:d}:i):[...t,{productId:r,quantity:d}]}function f(t,n,e=u){return t.map((o)=>({...o,product:n.find((r)=>s(r,e)===o.productId)})).filter((o)=>!!o.product)}function F(t,n,e=u){return f(t,n,e).reduce((o,r)=>o+Number(r.product[e.price]||0)*r.quantity,0)}function B(t){return t.reduce((n,e)=>n+e.quantity,0)}function b(t,n=[],e=u,o=5){let r=l(t,n,e);if(r===null)return null;if(r===0)return{text:"Sold out",tone:"out"};let c=t[e.lowStock]===null||t[e.lowStock]===void 0?o:Number(t[e.lowStock]);return{text:`${r} left`,tone:r<=c?"low":"ok"}}function R(t,n){let e=[];for(let o of t){let r=n(o);if(!e.includes(r))e.push(r)}return e}export{x as CENTS_FIELDS,u as DEFAULT_FIELDS,y as addToBasket,B as basketCount,f as basketLines,F as basketTotal,p as canAdd,R as groupsOf,I as setQuantity,l as shelfLeft,b as stockLabel};
+var k=Object.defineProperty;var x=(t)=>t;function m(t,n){this[t]=x.bind(null,n)}var b=(t,n)=>{for(var e in n)k(t,e,{get:n[e],enumerable:!0,configurable:!0,set:m.bind(n,e)})};var h=(t,n,e)=>()=>{if(t)try{n=t(t=0)}catch(r){e=[r]}if(e)throw e[0];return n};var S={};b(S,{CENTS_FIELDS:()=>g,DEFAULT_FIELDS:()=>u,addToBasket:()=>L,basketCount:()=>B,basketLines:()=>l,basketTaxable:()=>I,basketTotal:()=>F,canAdd:()=>f,groupsOf:()=>T,setQuantity:()=>y,shelfLeft:()=>a,stockLabel:()=>R});var u={id:"id",price:"price",inventory:"inventory",lowStock:"low_stock_threshold",taxable:"taxable"},g={id:"id",price:"price_cents",inventory:"inventory_quantity",lowStock:"low_stock_threshold",taxable:"taxable"};function s(t,n){return Number(t[n.id])}function p(t,n){let e=t[n.inventory];return e===null||e===void 0||e===""?null:Number(e)}function a(t,n,e=u){let r=p(t,e);if(r===null)return null;let o=n.find((c)=>c.productId===s(t,e))?.quantity||0;return Math.max(0,r-o)}function f(t,n,e=u){let r=a(t,n,e);return r===null||r>0}function L(t,n,e=u){if(!f(n,t,e))return t;let r=s(n,e);return t.some((o)=>o.productId===r)?t.map((o)=>o.productId===r?{...o,quantity:o.quantity+1}:o):[...t,{productId:r,quantity:1}]}function y(t,n,e,r=u){let o=s(n,r),c=p(n,r),d=Math.min(Math.max(0,Math.floor(Number(e)||0)),c===null?Number.POSITIVE_INFINITY:c);if(d===0)return t.filter((i)=>i.productId!==o);return t.some((i)=>i.productId===o)?t.map((i)=>i.productId===o?{...i,quantity:d}:i):[...t,{productId:o,quantity:d}]}function l(t,n,e=u){return t.map((r)=>({...r,product:n.find((o)=>s(o,e)===r.productId)})).filter((r)=>!!r.product)}function F(t,n,e=u){return l(t,n,e).reduce((r,o)=>r+Number(o.product[e.price]||0)*o.quantity,0)}function I(t,n,e=u){return l(t,n,e).filter((r)=>r.product[e.taxable]!==!1).reduce((r,o)=>r+Number(o.product[e.price]||0)*o.quantity,0)}function B(t){return t.reduce((n,e)=>n+e.quantity,0)}function R(t,n=[],e=u,r=5){let o=a(t,n,e);if(o===null)return null;if(o===0)return{text:"Sold out",tone:"out"};let c=t[e.lowStock]===null||t[e.lowStock]===void 0?r:Number(t[e.lowStock]);return{text:`${o} left`,tone:o<=c?"low":"ok"}}function T(t,n){let e=[];for(let r of t){let o=n(r);if(!e.includes(o))e.push(o)}return e}export{g as CENTS_FIELDS,u as DEFAULT_FIELDS,L as addToBasket,B as basketCount,l as basketLines,I as basketTaxable,F as basketTotal,f as canAdd,T as groupsOf,y as setQuantity,a as shelfLeft,R as stockLabel};

package/dist/sales-tax.d.ts

@@ -0,0 +1,73 @@
+/**
+ * A stored rate as a decimal multiplier.
+ *
+ * Rates are entered as percentages, because that is how tax is written down
+ * and how the dashboard asks for it. Multiplying by a percentage would charge
+ * a hundred times too much, which is the kind of error that reaches a
+ * customer's card before anyone notices.
+ */
+export declare function multiplierOf(rate: unknown): number;
+export declare function breakdownFor(taxable: number, rates: readonly TaxRateRow[], options?: BreakdownOptions): TaxBreakdown;
+/**
+ * What tax is owed on an amount, component by component.
+ *
+ * The tax rates a dashboard manages did not price anything. `recomputeOrderTotals`
+ * takes a single `taxRateId`, multiplies once, and returns one number — so a
+ * business whose tax is a sum of parts had to blend them into one rate before
+ * storing it, and a blended rate cannot answer the question that matters when
+ * a customer is exempt: exempt from *which part*?
+ *
+ * Most jurisdictions tax in parts and lift some of them for some buyers.
+ * Groceries escape VAT but not a deposit levy. A Californian medical cannabis
+ * patient is exempt from sales tax and still pays excise and the city's
+ * business tax. Blending those into one number leaves an application choosing
+ * between over-charging the exempt customer and under-collecting tax it owes.
+ *
+ * So: rates are rows, an exemption lifts the ones marked `exemptible`, and the
+ * result itemises what was charged and what was not.
+ *
+ * The calculation is pure and imports nothing, so a register in the browser
+ * shows the tax before it charges (`@stacksjs/commerce/sales-tax`); the rates
+ * a dashboard manages are read by `taxFor` in the tax module.
+ */
+/** One component, as it applied to this sale. */
+export declare interface TaxComponent {
+  id: number
+  code: string
+  name: string
+  rate: number
+  amount: number
+  exempted: boolean
+}
+export declare interface TaxBreakdown {
+  taxable: number
+  components: TaxComponent[]
+  tax: number
+  exempted: number
+}
+export declare interface BreakdownOptions {
+  exempt?: boolean
+  codes?: string[]
+  country?: string
+}
+/**
+ * Tax on `taxable` cents, itemised.
+ *
+ * Each component is rounded on its own rather than the total being rounded
+ * once. That is what a receipt has to show — the parts have to add up to the
+ * figure charged, and a single rounding at the end leaves a line that is a
+ * cent out from the sum above it.
+ *
+ * Every component is applied to `taxable` directly. Jurisdictions that compound
+ * — where one tax forms part of the base for another — need an explicit order,
+ * and that is a bigger claim than this should make quietly; an app that needs
+ * it should compose two calls.
+ */
+/** One tax rate row, in the terms the breakdown reads it. */
+export declare interface TaxRateRow {
+  id?: number | string
+  name?: string
+  code?: string
+  rate?: number | string
+  exemptible?: boolean
+}

package/dist/sales-tax.js

@@ -0,0 +1,2 @@
+// @bun
+function s(t){let n=Number(t);return Number.isFinite(n)?n/100:0}function b(t,n,p={}){let a=Math.max(0,Math.round(t)),m=[],i=0,u=0;for(let e of n){let x=s(e.rate),o=Math.round(a*x),r=Boolean(p.exempt&&e.exemptible);if(r)u+=o;else i+=o;m.push({id:Number(e.id),code:String(e.code??""),name:String(e.name??""),rate:x,amount:r?0:o,exempted:r})}return{taxable:a,components:m,tax:i,exempted:u}}export{b as breakdownFor,s as multiplierOf};

package/dist/tax/breakdown.d.ts

@@ -1,6 +1,8 @@
+import { breakdownFor } from '../sales-tax';
+import type { BreakdownOptions, TaxBreakdown } from '../sales-tax';
+export type { BreakdownOptions, TaxBreakdown, TaxComponent, TaxRateRow } from '../sales-tax';
 /** Every active rate, in the order they should be listed. */
 export declare function activeTaxRates(options?: BreakdownOptions): Promise<any[]>;
-export declare function breakdownFor(taxable: number, rates: readonly TaxRateRow[], options?: BreakdownOptions): TaxBreakdown;
 /**
  * Read the active rates and apply them.
  *
@@ -9,44 +11,4 @@ export declare function breakdownFor(taxable: number, rates: readonly TaxRateRow
  * per bag rather than querying each time.
  */
 export declare function taxFor(taxable: number, options?: BreakdownOptions): Promise<TaxBreakdown>;
-/** One component, as it applied to this sale. */
-export declare interface TaxComponent {
-  id: number
-  code: string
-  name: string
-  rate: number
-  amount: number
-  exempted: boolean
-}
-export declare interface TaxBreakdown {
-  taxable: number
-  components: TaxComponent[]
-  tax: number
-  exempted: number
-}
-export declare interface BreakdownOptions {
-  exempt?: boolean
-  codes?: string[]
-  country?: string
-}
-/**
- * Tax on `taxable` cents, itemised.
- *
- * Each component is rounded on its own rather than the total being rounded
- * once. That is what a receipt has to show — the parts have to add up to the
- * figure charged, and a single rounding at the end leaves a line that is a
- * cent out from the sum above it.
- *
- * Every component is applied to `taxable` directly. Jurisdictions that compound
- * — where one tax forms part of the base for another — need an explicit order,
- * and that is a bigger claim than this should make quietly; an app that needs
- * it should compose two calls.
- */
-/** One tax rate row, in the terms the breakdown reads it. */
-export declare interface TaxRateRow {
-  id?: number | string
-  name?: string
-  code?: string
-  rate?: number | string
-  exemptible?: boolean
-}
+export { breakdownFor } from '../sales-tax';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/commerce",
   "type": "module",
-  "version": "0.75.90",
+  "version": "0.75.91",
   "description": "Stacks commerce utilities.",
   "author": "Chris Breuer",
   "contributors": [
@@ -57,17 +57,17 @@
     "prepublishOnly": "bun run build"
   },
   "dependencies": {
-    "@stacksjs/cache": "0.75.90",
-    "@stacksjs/config": "0.75.90",
-    "@stacksjs/database": "0.75.90",
-    "@stacksjs/env": "0.75.90",
-    "@stacksjs/error-handling": "0.75.90",
-    "@stacksjs/events": "0.75.90",
-    "@stacksjs/logging": "0.75.90",
-    "@stacksjs/orm": "0.75.90",
-    "@stacksjs/payments": "0.75.90",
-    "@stacksjs/realtime": "0.75.90",
-    "@stacksjs/strings": "0.75.90",
+    "@stacksjs/cache": "0.75.91",
+    "@stacksjs/config": "0.75.91",
+    "@stacksjs/database": "0.75.91",
+    "@stacksjs/env": "0.75.91",
+    "@stacksjs/error-handling": "0.75.91",
+    "@stacksjs/events": "0.75.91",
+    "@stacksjs/logging": "0.75.91",
+    "@stacksjs/orm": "0.75.91",
+    "@stacksjs/payments": "0.75.91",
+    "@stacksjs/realtime": "0.75.91",
+    "@stacksjs/strings": "0.75.91",
     "ts-spreadsheets": "^0.2.0"
   },
   "devDependencies": {