@stacksjs/orm 0.72.16 → 0.72.17

package/dist/models/commerce/AuctionItem.ts

@@ -0,0 +1,204 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+/**
+ * One lot in an auction.
+ *
+ * Every money column is integer cents. A benefit auction adds several hundred
+ * bids together and reports the total to a board; floats lose that argument.
+ */
+export default defineModel({
+  name: 'AuctionItem',
+  table: 'auction_items',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+
+    useSearch: {
+      displayable: ['id', 'lotNumber', 'title', 'status', 'startingBid', 'donorName'],
+      searchable: ['title', 'description', 'donorName', 'category'],
+      sortable: ['lotNumber', 'startingBid', 'closesAt'],
+      filterable: ['status', 'category'],
+    },
+
+    useApi: {
+      uri: 'auction-items',
+      middleware: { read: ['auth'], write: ['auth'] },
+    },
+
+    observe: true,
+  },
+
+  belongsTo: ['Auction'],
+  hasMany: ['Bid'],
+
+  indexes: [
+    { name: 'auction_items_auction_id_index', columns: ['auction_id'] },
+    { name: 'auction_items_status_index', columns: ['status'] },
+  ],
+
+  attributes: {
+    lotNumber: {
+      order: 1,
+      fillable: true,
+      validation: {
+        rule: schema.number().required().min(1),
+        message: {
+          required: 'Lot number is required',
+        },
+      },
+      factory: faker => faker.number.int({ min: 1, max: 120 }),
+    },
+
+    title: {
+      order: 2,
+      fillable: true,
+      validation: {
+        rule: schema.string().required().max(160),
+        message: {
+          required: 'Title is required',
+        },
+      },
+      factory: faker => faker.commerce.productName(),
+    },
+
+    description: {
+      order: 3,
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+      factory: faker => faker.lorem.paragraph(),
+    },
+
+    imageUrl: {
+      order: 4,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(500),
+      },
+      factory: () => '',
+    },
+
+    category: {
+      order: 5,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(60),
+      },
+      factory: faker => faker.helpers.arrayElement(['experiences', 'travel', 'dining', 'sports', 'art', 'services']),
+    },
+
+    /** Who donated the lot. It goes on the tax letter and the thank-you note. */
+    donorName: {
+      order: 6,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(160),
+      },
+      factory: faker => faker.company.name(),
+    },
+
+    /**
+     * What the lot is worth, in cents. Drives the sell-through report and the
+     * "paid over value" number the development office cares about.
+     */
+    fairMarketValue: {
+      order: 7,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: faker => faker.number.int({ min: 5000, max: 200000 }),
+    },
+
+    startingBid: {
+      order: 8,
+      fillable: true,
+      validation: {
+        rule: schema.number().required().min(0),
+        message: {
+          required: 'Starting bid is required',
+        },
+      },
+      factory: faker => faker.number.int({ min: 2500, max: 50000 }),
+    },
+
+    /**
+     * A fixed increment for this lot, in cents. Null - the normal case - means
+     * the auction-wide ladder applies, which steps bigger as the money gets
+     * bigger.
+     */
+    minIncrement: {
+      order: 9,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: () => null,
+    },
+
+    /** Bid at or above this and the lot sells immediately. */
+    buyNowPrice: {
+      order: 10,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: () => null,
+    },
+
+    /** Below this the lot passes rather than selling. */
+    reservePrice: {
+      order: 11,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: () => null,
+    },
+
+    status: {
+      default: 'open',
+      order: 12,
+      fillable: true,
+      validation: {
+        rule: schema.enum(['open', 'closed', 'sold', 'passed']).required(),
+      },
+      factory: () => 'open',
+    },
+
+    /**
+     * A per-lot close, so a gala can stagger its sections and the room is not
+     * asked to watch a hundred lots end at once. Null falls back to the
+     * auction's own close. Anti-snipe extensions are written here.
+     */
+    closesAt: {
+      order: 13,
+      fillable: true,
+      validation: {
+        rule: schema.date(),
+      },
+      factory: () => null,
+    },
+
+    /** How many times anti-snipe has already extended this lot. */
+    extensionCount: {
+      default: 0,
+      order: 14,
+      fillable: false,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: () => 0,
+    },
+  },
+
+  dashboard: {
+    icon: 'i-hugeicons-package',
+    label: 'Lots',
+  },
+} as const)

package/dist/models/commerce/Bid.ts

@@ -0,0 +1,129 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+/**
+ * One bid on one lot.
+ *
+ * Bidders are identified by name and email rather than by a user account: a
+ * benefit auction is bid on by grandparents on borrowed phones, and requiring
+ * a signup between them and their paddle costs the school real money.
+ *
+ * `maxAmount` is the private proxy ceiling. It must never be selected into a
+ * template or an API response - the whole mechanism depends on nobody being
+ * able to see how far the other side is willing to go. `hidden` keeps it out of
+ * the generated CRUD responses; the queries in `@stacksjs/auctions` that feed
+ * the public catalogue select columns explicitly for the same reason.
+ */
+export default defineModel({
+  name: 'Bid',
+  table: 'bids',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+
+    useSearch: {
+      displayable: ['id', 'bidderName', 'amount', 'status', 'placedAt'],
+      searchable: ['bidderName', 'bidderEmail'],
+      sortable: ['placedAt', 'amount'],
+      filterable: ['status'],
+    },
+
+    // Read is authenticated: the bid history of a lot is staff information
+    // while the auction is live. Writes never come through generated CRUD -
+    // a bid has to go through the engine, so the app owns that route.
+    useApi: {
+      uri: 'bids',
+      routes: ['index', 'show'],
+      middleware: ['auth'],
+    },
+
+    observe: true,
+  },
+
+  belongsTo: ['Auction', 'AuctionItem'],
+
+  indexes: [
+    { name: 'bids_auction_item_id_index', columns: ['auction_item_id'] },
+    { name: 'bids_auction_id_index', columns: ['auction_id'] },
+    { name: 'bids_bidder_email_index', columns: ['bidder_email'] },
+    { name: 'bids_status_index', columns: ['status'] },
+  ],
+
+  attributes: {
+    bidderName: {
+      order: 1,
+      fillable: true,
+      validation: {
+        rule: schema.string().required().max(160),
+        message: {
+          required: 'Your name is required',
+        },
+      },
+      factory: faker => faker.person.fullName(),
+    },
+
+    bidderEmail: {
+      order: 2,
+      fillable: true,
+      validation: {
+        rule: schema.string().email().required(),
+        message: {
+          required: 'Your email is required',
+          email: 'That does not look like an email address',
+        },
+      },
+      factory: faker => faker.internet.email().toLowerCase(),
+    },
+
+    /** The public number: what this bidder is currently committed to, in cents. */
+    amount: {
+      order: 3,
+      fillable: true,
+      validation: {
+        rule: schema.number().required().min(1),
+        message: {
+          required: 'A bid amount is required',
+        },
+      },
+      factory: faker => faker.number.int({ min: 5000, max: 200000 }),
+    },
+
+    /** The private ceiling, in cents. Null means "this amount only". */
+    maxAmount: {
+      order: 4,
+      fillable: true,
+      hidden: true,
+      validation: {
+        rule: schema.number().min(1),
+      },
+      factory: () => null,
+    },
+
+    status: {
+      default: 'leading',
+      order: 5,
+      fillable: true,
+      validation: {
+        rule: schema.enum(['leading', 'outbid', 'won', 'lost', 'invalid']).required(),
+      },
+      factory: () => 'outbid',
+    },
+
+    placedAt: {
+      order: 6,
+      fillable: true,
+      validation: {
+        rule: schema.date().required(),
+      },
+      factory: faker => faker.date.recent().toISOString(),
+    },
+  },
+
+  dashboard: {
+    icon: 'i-hugeicons-hand-pointing-right-01',
+    label: 'Bids',
+  },
+} as const)

package/dist/models/commerce/Cart.ts

@@ -0,0 +1,140 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+export default defineModel({
+  name: 'Cart',
+  table: 'carts',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+    useSearch: {
+      displayable: ['id', 'customerId', 'status', 'totalItems', 'subtotal', 'total', 'expiresAt'],
+      searchable: ['id', 'customerId', 'status'],
+      sortable: ['createdAt', 'updatedAt', 'expiresAt', 'total'],
+      filterable: ['status', 'customerId'],
+    },
+
+    useSeeder: {
+      count: 10,
+    },
+
+    useApi: {
+      uri: 'carts',
+      middleware: ['auth'],
+    },
+
+    observe: true,
+  },
+
+  hasMany: ['CartItem'],
+  belongsTo: ['Customer', 'Coupon'],
+
+  attributes: {
+    status: {
+      default: 'active',
+      order: 1,
+      fillable: true,
+      validation: {
+        rule: schema.enum(['active', 'abandoned', 'converted', 'expired']),
+      },
+      factory: faker => faker.helpers.arrayElement(['active', 'abandoned', 'converted', 'expired']),
+    },
+
+    totalItems: {
+      default: 0,
+      order: 2,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: faker => faker.number.int({ min: 0, max: 20 }),
+    },
+
+    subtotal: {
+      default: 0,
+      order: 3,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: faker => faker.number.int({ min: 0, max: 1000 }),
+    },
+
+    taxAmount: {
+      default: 0,
+      order: 4,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: faker => faker.number.int({ min: 0, max: 200 }),
+    },
+
+    discountAmount: {
+      default: 0,
+      order: 5,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: faker => faker.number.int({ min: 0, max: 100 }),
+    },
+
+    total: {
+      default: 0,
+      order: 6,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: faker => faker.number.int({ min: 0, max: 1200 }),
+    },
+
+    expiresAt: {
+      order: 7,
+      fillable: true,
+      validation: {
+        rule: schema.timestamp().required(),
+      },
+      factory: (faker) => {
+        const date = faker.date.past()
+        return date.toISOString().slice(0, 19).replace('T', ' ')
+      },
+    },
+
+    currency: {
+      default: 'USD',
+      order: 8,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(3),
+      },
+      factory: faker => faker.helpers.arrayElement(['USD', 'EUR', 'GBP', 'JPY', 'AUD']),
+    },
+
+    notes: {
+      order: 9,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(1000),
+      },
+      factory: faker => faker.lorem.sentence(),
+    },
+
+    appliedCouponId: {
+      order: 10,
+      fillable: true,
+      validation: {
+        rule: schema.string().required(),
+      },
+      factory: () => 'test-coupon-id',
+    },
+  },
+
+  dashboard: {
+    highlight: true,
+  },
+} as const)

package/dist/models/commerce/CartItem.ts

@@ -0,0 +1,138 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+export default defineModel({
+  name: 'CartItem',
+  table: 'cart_items',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+    useSearch: {
+      displayable: ['id', 'cartId', 'productId', 'quantity', 'unitPrice', 'totalPrice'],
+      searchable: ['id', 'cartId', 'productId'],
+      sortable: ['createdAt', 'updatedAt', 'quantity', 'unitPrice'],
+      filterable: ['cartId', 'productId'],
+    },
+
+    useSeeder: {
+      count: 50,
+    },
+
+    useApi: {
+      uri: 'cart-items',
+      middleware: ['auth'],
+    },
+
+    observe: true,
+  },
+
+  belongsTo: ['Cart'],
+
+  attributes: {
+    quantity: {
+      order: 1,
+      fillable: true,
+      validation: {
+        rule: schema.number().required().min(1),
+      },
+      factory: faker => faker.number.int({ min: 1, max: 10 }),
+    },
+
+    unitPrice: {
+      order: 2,
+      fillable: true,
+      validation: {
+        rule: schema.number().required().min(0),
+      },
+      factory: faker => faker.number.int({ min: 1, max: 1000 }),
+    },
+
+    totalPrice: {
+      order: 3,
+      fillable: true,
+      validation: {
+        rule: schema.number().required().min(0),
+      },
+      factory: faker => faker.number.int({ min: 1, max: 1000 }),
+    },
+
+    taxRate: {
+      order: 4,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0).max(100),
+      },
+      factory: faker => faker.number.int({ min: 0, max: 20 }),
+    },
+
+    taxAmount: {
+      order: 5,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: faker => faker.number.int({ min: 0, max: 50 }),
+    },
+
+    discountPercentage: {
+      order: 6,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0).max(100),
+      },
+      factory: faker => faker.number.int({ min: 0, max: 50 }),
+    },
+
+    discountAmount: {
+      order: 7,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: faker => faker.number.int({ min: 0, max: 25 }),
+    },
+
+    productName: {
+      order: 8,
+      fillable: true,
+      validation: {
+        rule: schema.string().required().max(255),
+      },
+      factory: faker => faker.commerce.productName(),
+    },
+
+    productSku: {
+      order: 9,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(100),
+      },
+      factory: faker => faker.string.alphanumeric(10),
+    },
+
+    productImage: {
+      order: 10,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(255),
+      },
+      factory: faker => faker.image.url(),
+    },
+
+    notes: {
+      order: 11,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(500),
+      },
+      factory: faker => faker.lorem.sentence(),
+    },
+  },
+
+  dashboard: {
+    highlight: true,
+  },
+} as const)