@stacksjs/orm 0.75.38 → 0.75.40

package/dist/define-model.d.ts

@@ -50,7 +50,7 @@ export declare function withoutValidation<T>(fn: () => T | Promise<T>): Promise<
  * decides for itself how many queries that costs; without it this falls back to
  * projecting each row, which is what a column-rearranging `shape` wants anyway.
  */
-export declare function projectDocumentsFromTrait(config: SearchableTraitConfig): Promise<Record<string, unknown>[]>;
+export declare function projectDocumentsFromTrait(models: Record<string, unknown>[], config: SearchableTraitConfig): Promise<Record<string, unknown>[]>;
 export declare function defineModel<const TDef extends ModelDefinition>(definition: TDef): StacksModelStatic<TDef>;
 /**
  * Normalize a ModelInstance (or array of them, or already-plain row) into
@@ -211,7 +211,12 @@ declare type MutableModelDefinition = Omit<ModelDefinition, 'set'> & {
 }
 declare type BQBModelAttribute = BQBModelDefinition['attributes'][string];
 export type StacksModelAttribute = Omit<BQBModelAttribute, 'factory'> & {
-  factory?: (faker: Faker) => unknown
+  /**
+   * Fake value for seeding. Receives the attributes this record's factories
+   * have already produced (those declared above it, by attribute name), so a
+   * value can depend on another: `(faker, { discountType }) => ...`.
+   */
+  factory?: (faker: Faker, attributes: Readonly<Record<string, unknown>>) => unknown
 }
 declare type ModelDefinition = StacksModelDefinition;
 declare type ValidationRuleOf<TAttribute> = TAttribute extends { validation: { rule: infer TRule } } ? TRule : never;

package/dist/models/Campaign.ts

@@ -267,13 +267,17 @@ export default defineModel({
       factory: faker => faker.number.float({ min: 0.5, max: 8, fractionDigits: 1 }),
     },
 
+    // Integer minor units of `currency`, like every money column (1999 is
+    // $19.99). The columns are INTEGER; a decimal here was stored as a REAL by
+    // SQLite and truncated by MySQL and Postgres.
     budget: {
       required: false,
       fillable: true,
       validation: {
-        rule: schema.number().min(0),
+        rule: schema.number().integer().min(0),
       },
-      factory: faker => faker.number.float({ min: 100, max: 10000, fractionDigits: 2 }),
+      // $100 to $10,000.
+      factory: faker => faker.number.int({ min: 10000, max: 1000000 }),
     },
 
     spent: {
@@ -281,9 +285,10 @@ export default defineModel({
       fillable: true,
       default: 0,
       validation: {
-        rule: schema.number().min(0),
+        rule: schema.number().integer().min(0),
       },
-      factory: faker => faker.number.float({ min: 0, max: 5000, fractionDigits: 2 }),
+      // Within the budget drawn above, so a seeded campaign is never over it.
+      factory: (faker, { budget }) => faker.number.int({ min: 0, max: Number(budget) || 0 }),
     },
 
     currency: {

package/dist/models/commerce/Cart.ts

@@ -65,7 +65,8 @@ export default defineModel({
       validation: {
         rule: schema.number().min(0),
       },
-      factory: faker => faker.number.int({ min: 0, max: 1000 }),
+      // Integer minor units, like every commerce amount: 1999 is $19.99.
+      factory: faker => faker.number.int({ min: 1000, max: 20000 }),
     },
 
     taxAmount: {
@@ -75,7 +76,7 @@ export default defineModel({
       validation: {
         rule: schema.number().min(0),
       },
-      factory: faker => faker.number.int({ min: 0, max: 200 }),
+      factory: faker => faker.number.int({ min: 0, max: 1500 }),
     },
 
     discountAmount: {
@@ -85,7 +86,7 @@ export default defineModel({
       validation: {
         rule: schema.number().min(0),
       },
-      factory: faker => faker.number.int({ min: 0, max: 100 }),
+      factory: faker => faker.number.int({ min: 0, max: 1000 }),
     },
 
     total: {
@@ -95,7 +96,7 @@ export default defineModel({
       validation: {
         rule: schema.number().min(0),
       },
-      factory: faker => faker.number.int({ min: 0, max: 1200 }),
+      factory: faker => faker.number.int({ min: 1000, max: 21500 }),
     },
 
     expiresAt: {

package/dist/models/commerce/CartItem.ts

@@ -52,7 +52,8 @@ export default defineModel({
       validation: {
         rule: schema.number().required().min(0),
       },
-      factory: faker => faker.number.int({ min: 1, max: 1000 }),
+      // Integer minor units, in the same range as Product.price.
+      factory: faker => faker.number.int({ min: 100, max: 10000 }),
     },
 
     totalPrice: {
@@ -61,7 +62,7 @@ export default defineModel({
       validation: {
         rule: schema.number().required().min(0),
       },
-      factory: faker => faker.number.int({ min: 1, max: 1000 }),
+      factory: faker => faker.number.int({ min: 100, max: 50000 }),
     },
 
     taxRate: {
@@ -79,7 +80,7 @@ export default defineModel({
       validation: {
         rule: schema.number().min(0),
       },
-      factory: faker => faker.number.int({ min: 0, max: 50 }),
+      factory: faker => faker.number.int({ min: 0, max: 1000 }),
     },
 
     discountPercentage: {
@@ -97,7 +98,8 @@ export default defineModel({
       validation: {
         rule: schema.number().min(0),
       },
-      factory: faker => faker.number.int({ min: 0, max: 25 }),
+      // At most $1.00, so it never exceeds the smallest unit price above.
+      factory: faker => faker.number.int({ min: 0, max: 100 }),
     },
 
     productName: {

package/dist/models/commerce/Coupon.ts

@@ -106,7 +106,11 @@ export default defineModel({
           min: 'Discount value must be greater than 0.01',
         },
       },
-      factory: faker => faker.number.int({ min: 5, max: 50 }),
+      // A percentage stays a plain number; a fixed amount is integer minor units
+      // ($5 to $50). discountType is declared above, so the seeder has drawn it.
+      factory: (faker, { discountType }) => discountType === 'fixed_amount'
+        ? faker.helpers.arrayElement([500, 1000, 1500, 2000, 2500, 5000])
+        : faker.number.int({ min: 5, max: 50 }),
     },
 
     minOrderAmount: {
@@ -118,7 +122,8 @@ export default defineModel({
           min: 'Min order amount must be greater than 0',
         },
       },
-      factory: faker => faker.number.int({ min: 0, max: 50 }),
+      // Integer minor units: no minimum, or $25 to $100.
+      factory: faker => faker.helpers.arrayElement([0, 2500, 5000, 7500, 10000]),
     },
 
     maxDiscountAmount: {
@@ -130,7 +135,8 @@ export default defineModel({
           min: 'Max discount amount must be greater than 0',
         },
       },
-      factory: faker => faker.number.int({ min: 5, max: 100 }),
+      // Integer minor units: $10 to $100.
+      factory: faker => faker.number.int({ min: 1000, max: 10000 }),
     },
 
     freeProductId: {

package/dist/models/commerce/Customer.ts

@@ -82,7 +82,8 @@ export default defineModel({
           min: 'Total spent cannot be negative',
         },
       },
-      factory: faker => faker.number.int({ min: 0, max: 2000 }),
+      // Integer minor units: $0 to $5,000.
+      factory: faker => faker.number.int({ min: 0, max: 500000 }),
     },
 
     lastOrder: {

package/dist/models/commerce/GiftCard.ts

@@ -57,7 +57,8 @@ export default defineModel({
       validation: {
         rule: schema.number().required().min(1),
       },
-      factory: faker => faker.number.int({ min: 100, max: 2000 }),
+      // Integer minor units, in the denominations cards are actually sold in: $25 to $250.
+      factory: faker => faker.helpers.arrayElement([2500, 5000, 10000, 15000, 20000, 25000]),
     },
 
     currentBalance: {
@@ -66,7 +67,9 @@ export default defineModel({
       validation: {
         rule: schema.number().required().min(0),
       },
-      factory: () => 1,
+      // Drawn below the smallest initial balance above, so a seeded card never
+      // holds more than it was issued with.
+      factory: faker => faker.number.int({ min: 0, max: 2500 }),
     },
 
     currency: {

package/dist/models/commerce/Order.ts

@@ -64,7 +64,8 @@ export default defineModel({
       validation: {
         rule: schema.number().required().min(0),
       },
-      factory: faker => faker.number.int({ min: 100, max: 2000 }),
+      // Integer minor units, like every commerce amount: 1999 is $19.99.
+      factory: faker => faker.number.int({ min: 1000, max: 50000 }),
     },
 
     currency: {
@@ -84,7 +85,7 @@ export default defineModel({
       validation: {
         rule: schema.number().min(0),
       },
-      factory: faker => faker.number.int({ min: 10, max: 200 }),
+      factory: faker => faker.number.int({ min: 0, max: 4000 }),
     },
 
     discountAmount: {
@@ -94,7 +95,7 @@ export default defineModel({
       validation: {
         rule: schema.number().min(0),
       },
-      factory: faker => faker.number.int({ min: 0, max: 150 }),
+      factory: faker => faker.number.int({ min: 0, max: 2000 }),
     },
 
     deliveryFee: {
@@ -104,7 +105,7 @@ export default defineModel({
       validation: {
         rule: schema.number().min(0),
       },
-      factory: faker => faker.number.int({ min: 0, max: 100 }),
+      factory: faker => faker.helpers.arrayElement([0, 299, 499, 799]),
     },
 
     tipAmount: {
@@ -114,7 +115,7 @@ export default defineModel({
       validation: {
         rule: schema.number().min(0),
       },
-      factory: faker => faker.number.int({ min: 0, max: 200 }),
+      factory: faker => faker.number.int({ min: 0, max: 1500 }),
     },
 
     orderType: {

package/dist/models/commerce/OrderItem.ts

@@ -36,7 +36,8 @@ export default defineModel({
           min: 'Price cannot be negative',
         },
       },
-      factory: faker => faker.number.int({ min: 5, max: 50 }),
+      // Integer minor units, in the same range as Product.price.
+      factory: faker => faker.number.int({ min: 100, max: 10000 }),
     },
 
     special_instructions: {

package/dist/models/commerce/ProductVariant.ts

@@ -13,14 +13,22 @@ export default defineModel({
   // tell "considered" from "nobody thought about it" (stacksjs/stacks#2375).
   ownership: false,
 
+  // A SKU identifies a variant within its product. Unique per product rather
+  // than globally, because two imported stores (or two products of one) can
+  // legitimately reuse a code. NULLs never collide, so variants without a SKU
+  // are unconstrained on every dialect.
+  indexes: [
+    { name: 'product_variants_product_sku_unique', columns: ['product_id', 'sku'], unique: true },
+  ],
+
   traits: {
     useUuid: true,
     useTimestamps: true,
     useSearch: {
-      displayable: ['id', 'productId', 'variant', 'type', 'description', 'options', 'status'],
-      searchable: ['variant', 'type', 'description', 'options'],
-      sortable: ['createdAt', 'updatedAt', 'variant', 'type', 'status'],
-      filterable: ['productId', 'type', 'status'],
+      displayable: ['id', 'productId', 'variant', 'type', 'sku', 'price', 'compareAtPrice', 'inventoryCount', 'description', 'options', 'status'],
+      searchable: ['variant', 'type', 'sku', 'description', 'options'],
+      sortable: ['createdAt', 'updatedAt', 'variant', 'type', 'status', 'price', 'inventoryCount'],
+      filterable: ['productId', 'type', 'status', 'sku'],
     },
 
     useSeeder: {
@@ -109,6 +117,65 @@ export default defineModel({
       },
       factory: faker => faker.helpers.arrayElement(['active', 'inactive', 'draft']),
     },
+
+    sku: {
+      order: 8,
+      fillable: true,
+      nullable: true,
+      validation: {
+        rule: schema.string().max(100),
+        message: {
+          max: 'SKU must have a maximum of 100 characters',
+        },
+      },
+      factory: faker => faker.string.alphanumeric(10).toUpperCase(),
+    },
+
+    // Money is integer minor units (cents), never a float. NULL means the
+    // variant has no price of its own and inherits `products.price`.
+    price: {
+      order: 9,
+      fillable: true,
+      nullable: true,
+      validation: {
+        rule: schema.number().integer().min(0),
+        message: {
+          min: 'Price must be at least 0',
+        },
+      },
+      factory: faker => faker.number.int({ min: 100, max: 10000 }),
+    },
+
+    // The "was" price shown struck through, in minor units. NULL when the
+    // variant is not on sale.
+    compareAtPrice: {
+      order: 10,
+      fillable: true,
+      nullable: true,
+      validation: {
+        rule: schema.number().integer().min(0),
+        message: {
+          min: 'Compare-at price must be at least 0',
+        },
+      },
+      // Above the factory's highest `price`, so a seeded sale is always a discount.
+      factory: faker => faker.datatype.boolean() ? faker.number.int({ min: 10001, max: 20000 }) : null,
+    },
+
+    // Units in stock. NULL means stock is not tracked for this variant,
+    // which is different from 0 (tracked and sold out).
+    inventoryCount: {
+      order: 11,
+      fillable: true,
+      nullable: true,
+      validation: {
+        rule: schema.number().integer().min(0),
+        message: {
+          min: 'Inventory count must be at least 0',
+        },
+      },
+      factory: faker => faker.number.int({ min: 0, max: 100 }),
+    },
   },
 
   dashboard: {

package/dist/models/commerce/Transaction.ts

@@ -41,9 +41,10 @@ export default defineModel({
       order: 2,
       fillable: true,
       validation: {
-        rule: schema.number().required().min(0.01),
+        // Integer minor units: the smallest amount is one cent, not 0.01 of one.
+        rule: schema.number().integer().required().min(1),
       },
-      factory: faker => faker.number.int({ min: 5, max: 500 }),
+      factory: faker => faker.number.int({ min: 500, max: 50000 }),
     },
 
     status: {

package/package.json

@@ -2,7 +2,7 @@
   "name": "@stacksjs/orm",
   "type": "module",
   "sideEffects": false,
-  "version": "0.75.38",
+  "version": "0.75.40",
   "description": "The Stacks ORM integration",
   "author": "Chris Breuer",
   "contributors": [
@@ -63,31 +63,31 @@
     "prepublishOnly": "bun run build"
   },
   "dependencies": {
-    "@stacksjs/cache": "0.75.38",
-    "@stacksjs/cli": "0.75.38",
-    "@stacksjs/config": "0.75.38",
-    "@stacksjs/database": "0.75.38",
-    "@stacksjs/env": "0.75.38",
-    "@stacksjs/error-handling": "0.75.38",
-    "@stacksjs/events": "0.75.38",
-    "@stacksjs/logging": "0.75.38",
-    "@stacksjs/model-meta": "0.75.38",
-    "@stacksjs/pagination": "0.75.38",
-    "@stacksjs/path": "0.75.38",
-    "@stacksjs/query-builder": "0.75.38",
-    "@stacksjs/realtime": "0.75.38",
-    "@stacksjs/router": "0.75.38",
-    "@stacksjs/storage": "0.75.38",
-    "@stacksjs/strings": "0.75.38",
+    "@stacksjs/cache": "0.75.40",
+    "@stacksjs/cli": "0.75.40",
+    "@stacksjs/config": "0.75.40",
+    "@stacksjs/database": "0.75.40",
+    "@stacksjs/env": "0.75.40",
+    "@stacksjs/error-handling": "0.75.40",
+    "@stacksjs/events": "0.75.40",
+    "@stacksjs/logging": "0.75.40",
+    "@stacksjs/model-meta": "0.75.40",
+    "@stacksjs/pagination": "0.75.40",
+    "@stacksjs/path": "0.75.40",
+    "@stacksjs/query-builder": "0.75.40",
+    "@stacksjs/realtime": "0.75.40",
+    "@stacksjs/router": "0.75.40",
+    "@stacksjs/storage": "0.75.40",
+    "@stacksjs/strings": "0.75.40",
     "@stacksjs/ts-validation": "^0.5.6",
-    "@stacksjs/validation": "0.75.38",
+    "@stacksjs/validation": "0.75.40",
     "bun-query-builder": "^0.3.4"
   },
   "peerDependencies": {
-    "@stacksjs/auth": "0.75.38",
-    "@stacksjs/payments": "0.75.38",
-    "@stacksjs/queue": "0.75.38",
-    "@stacksjs/search-engine": "0.75.38",
+    "@stacksjs/auth": "0.75.40",
+    "@stacksjs/payments": "0.75.40",
+    "@stacksjs/queue": "0.75.40",
+    "@stacksjs/search-engine": "0.75.40",
     "stripe": "22.3.2"
   },
   "peerDependenciesMeta": {
@@ -108,7 +108,7 @@
     }
   },
   "devDependencies": {
-    "@stacksjs/types": "0.75.38",
+    "@stacksjs/types": "0.75.40",
     "better-dx": "^0.2.24",
     "stripe": "22.3.2"
   }