@stacksjs/commerce 0.75.89 → 0.75.90

package/README.md

@@ -26,6 +26,28 @@ import * as commerce from '@stacksjs/commerce'
 // wip
 ```
 
+### Shop rules in the browser
+
+Four modules are pure and import nothing, so a page bundles them on its own
+instead of the barrel (which imports the database):
+
+```ts
+import { formatCurrency, parseMoneyInput } from '@stacksjs/commerce/money'
+import { addToBasket, basketTotal, stockLabel, CENTS_FIELDS } from '@stacksjs/commerce/register'
+import { compareCatalog, matchesSearch, isLowStock } from '@stacksjs/commerce/catalog'
+import { releaseSchedule, rolloutFromProduct, describeRollout } from '@stacksjs/commerce/releases'
+
+// A front desk's basket, held to the stock on the shelf
+let basket = addToBasket([], gatorade, CENTS_FIELDS)
+basketTotal(basket, catalog, CENTS_FIELDS)
+
+// A catalog by category, then name, sizes small to large
+products.sort(compareCatalog(['Drinks', 'Apparel']))
+
+// When each video or week of a digital product opens for a buyer
+releaseSchedule(rolloutFromProduct(product), weeks, purchasedAt, new Date())
+```
+
 Learn more in the docs.
 
 ## 🧪 Testing

package/dist/catalog.d.ts

@@ -0,0 +1,43 @@
+/**
+ * A name's trailing size split off and ranked: `"Logo Tee — M"` is the base
+ * `"Logo Tee"` at rank 3. A dash, en dash, em dash or slash may separate it.
+ * A name with no size has rank -1.
+ */
+export declare function sizeOf(name: string): { base: string, size: string | null, rank: number };
+/**
+ * Where a category sits in a chosen order. Named ones come in that order, any
+ * other after them, and none at all last.
+ */
+export declare function categoryRank(category: string | null | undefined, order?: readonly string[]): number;
+/**
+ * A comparator for a catalog: by category in `order` (then alphabetically),
+ * then by name, with sizes of the same garment small to large.
+ *
+ * ```ts
+ * products.sort(compareCatalog(['Drinks', 'Apparel']))
+ * ```
+ */
+export declare function compareCatalog(order?: readonly string[]): (a: Orderable, b: Orderable) => number;
+/**
+ * Whether something matches a search: every word of the query somewhere in
+ * the given fields, ignoring case. An empty query matches everything.
+ *
+ * ```ts
+ * matchesSearch([product.name, product.sku, product.category], 'gat lemon')
+ * ```
+ */
+export declare function matchesSearch(fields: unknown[], query: string): boolean;
+/**
+ * Whether counted stock is at or under the level to reorder at (`defaultLow`
+ * when the product sets none). Uncounted stock is never low.
+ */
+export declare function isLowStock(stock: number | null | undefined, reorderAt?: number | null, defaultLow?: number): boolean;
+/**
+ * How a catalog is shown: its order (by category, then name, with a
+ * garment's sizes small to large), its search, and when stock is low. Pure
+ * and dependency-free, so the browser bundles it
+ * (`@stacksjs/commerce/catalog`) and a server sorts the same way.
+ */
+/** Garment sizes, smallest first. */
+export declare const SIZES: readonly ['XXS', 'XS', 'S', 'M', 'L', 'XL', 'XXL', '2XL', '3XL', '4XL'];
+export declare interface Orderable { name?: string | null, category?: string | null }

package/dist/catalog.js

@@ -0,0 +1,2 @@
+// @bun
+var u=Object.defineProperty;var g=(e)=>e;function c(e,n){this[e]=g.bind(null,n)}var f=(e,n)=>{for(var r in n)u(e,r,{get:n[r],enumerable:!0,configurable:!0,set:c.bind(n,r)})};var L=(e,n,r)=>()=>{if(e)try{n=e(e=0)}catch(t){r=[t]}if(r)throw r[0];return n};var m={};f(m,{SIZES:()=>l,categoryRank:()=>o,compareCatalog:()=>S,isLowStock:()=>b,matchesSearch:()=>X,sizeOf:()=>a});var l=["XXS","XS","S","M","L","XL","XXL","2XL","3XL","4XL"];function a(e){let n=/^(.*?)\s*[\u2014\u2013\-/]\s*(XXS|XS|S|M|L|XL|XXL|2XL|3XL|4XL)$/i.exec(String(e).trim());if(!n)return{base:String(e).trim(),size:null,rank:-1};let r=n[2].toUpperCase();return{base:n[1],size:r,rank:l.indexOf(r)}}function o(e,n=[]){let r=n.indexOf(String(e||""));if(r!==-1)return r;return e?n.length:n.length+1}function S(e=[]){return(n,r)=>{let t=o(n.category,e)-o(r.category,e)||String(n.category||"").localeCompare(String(r.category||""));if(t)return t;let i=a(String(n.name||"")),s=a(String(r.name||""));return i.base.localeCompare(s.base)||i.rank-s.rank}}function X(e,n){let r=String(n||"").toLowerCase().split(/\s+/).filter(Boolean);if(!r.length)return!0;let t=e.map((i)=>String(i??"")).join(" ").toLowerCase();return r.every((i)=>t.includes(i))}function b(e,n,r=5){if(e===null||e===void 0)return!1;return Number(e)<=(n===null||n===void 0?r:Number(n))}export{l as SIZES,o as categoryRank,S as compareCatalog,b as isLowStock,X as matchesSearch,a as sizeOf};

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import * as auctions from './auctions/index';
 import * as carts from './carts/index';
+import * as catalog from './catalog';
 import * as catalogImport from './imports/index';
 import * as coupons from './coupons/index';
 import * as customers from './customers/index';
@@ -11,6 +12,8 @@ import * as orders from './orders/index';
 import * as payments from './payments/index';
 import * as products from './products/index';
 import * as receipts from './receipts/index';
+import * as register from './register';
+import * as releases from './releases';
 import * as restaurant from './waitlists/restaurant/index';
 import * as shippings from './shippings/index';
 import * as tax from './tax/index';
@@ -20,6 +23,7 @@ export declare const commerce: CommerceNamespace;
 export declare interface CommerceNamespace {
   auctions: AuctionsModule
   carts: CartsModule
+  catalog: CatalogModule
   coupons: CouponsModule
   customers: CustomersModule
   errors: ErrorsModule
@@ -27,6 +31,8 @@ export declare interface CommerceNamespace {
   orders: OrdersModule
   payments: PaymentsModule
   products: ProductsModule
+  register: RegisterModule
+  releases: ReleasesModule
   restaurant: RestaurantModule
   shippings: ShippingsModule
   tax: TaxModule
@@ -36,6 +42,9 @@ export declare interface CommerceNamespace {
 }
 declare type AuctionsModule = typeof auctions;
 declare type CartsModule = typeof carts;
+declare type CatalogModule = typeof catalog;
+declare type RegisterModule = typeof register;
+declare type ReleasesModule = typeof releases;
 declare type CouponsModule = typeof coupons;
 declare type CustomersModule = typeof customers;
 declare type ErrorsModule = typeof errors;
@@ -54,6 +63,7 @@ declare type ReceiptsModule = typeof receipts;
 export {
   auctions,
   carts,
+  catalog,
   catalogImport,
   coupons,
   customers,
@@ -65,6 +75,8 @@ export {
   payments,
   products,
   receipts,
+  register,
+  releases,
   restaurant,
   shippings,
   tax,