@stacksjs/orm 0.72.16 → 0.72.17

package/dist/models/commerce/Category.ts

@@ -0,0 +1,125 @@
+import { defineModel } from '@stacksjs/orm'
+import { slug } from '@stacksjs/strings'
+import { schema } from '@stacksjs/validation'
+
+export default defineModel({
+  name: 'Category',
+  table: 'categories',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+    useSearch: {
+      displayable: ['id', 'name', 'description', 'isActive', 'parentCategoryId', 'displayOrder'],
+      searchable: ['name', 'description'],
+      sortable: ['displayOrder', 'createdAt', 'updatedAt'],
+      filterable: ['parentCategoryId', 'isActive'],
+    },
+
+    useSeeder: {
+      count: 10,
+    },
+
+    useApi: {
+      // Public catalog: anyone may browse, only authenticated callers may
+      // write. Declared explicitly because the trait now defaults BOTH sides to
+      // `auth` — an undeclared read route is how a customer list leaks
+      // (stacksjs/stacks#2224). Behaviour here is unchanged.
+      middleware: { read: [], write: ['auth'] },
+      uri: 'product-categories',
+    },
+
+    observe: true,
+  },
+
+  hasMany: ['Product'],
+  belongsToMany: {
+    posts: {
+      model: 'Post',
+      table: 'categorizable_models',
+      foreignKey: 'category_id',
+      relatedKey: 'categorizable_id',
+      pivot: {
+        columns: {
+          categorizable_type: { default: 'posts' },
+        },
+        timestamps: true,
+        uniques: [['category_id', 'categorizable_id', 'categorizable_type']],
+      },
+    },
+  },
+
+  attributes: {
+    name: {
+      order: 1,
+      fillable: true,
+      validation: {
+        rule: schema.string().required().max(50),
+        message: {
+          max: 'Name must have a maximum of 50 characters',
+        },
+      },
+      factory: faker => faker.commerce.department(),
+    },
+
+    description: {
+      order: 2,
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+      factory: faker => faker.commerce.productDescription(),
+    },
+
+    slug: {
+      order: 3,
+      fillable: true,
+      validation: {
+        rule: schema.string().required(),
+      },
+      factory: faker => slug(faker.commerce.department()),
+    },
+
+    imageUrl: {
+      order: 3,
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+      factory: faker => faker.image.url(),
+    },
+
+    isActive: {
+      order: 4,
+      fillable: true,
+      validation: {
+        rule: schema.boolean(),
+      },
+      factory: () => true,
+    },
+
+    parentCategoryId: {
+      order: 5,
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+      factory: () => null, // Most categories won't have a parent
+    },
+
+    displayOrder: {
+      order: 6,
+      fillable: true,
+      validation: {
+        rule: schema.number().required(),
+      },
+      factory: faker => faker.number.int({ min: 1, max: 100 }),
+    },
+  },
+
+  dashboard: {
+    highlight: true,
+  },
+} as const)

package/dist/models/commerce/Coupon.ts

@@ -0,0 +1,186 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+export default defineModel({
+  name: 'Coupon',
+  table: 'coupons',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+    useSearch: {
+      displayable: ['id', 'code', 'discountType', 'discountValue', 'startDate', 'endDate'],
+      searchable: ['code', 'description', 'discountType'],
+      sortable: ['createdAt', 'startDate', 'endDate', 'discountValue', 'usageCount'],
+      filterable: ['discountType'],
+    },
+
+    useSeeder: {
+      count: 15,
+    },
+
+    useApi: {
+      uri: 'coupons',
+      middleware: ['auth'],
+    },
+
+    observe: true,
+  },
+
+  belongsTo: ['Product'],
+  hasMany: ['Order'],
+
+  attributes: {
+    code: {
+      unique: true,
+      order: 1,
+      fillable: true,
+      validation: {
+        rule: schema.string().required().max(50),
+        message: {
+          max: 'Code must have a maximum of 50 characters',
+        },
+      },
+      factory: faker => faker.string.alphanumeric(8).toUpperCase(),
+    },
+
+    description: {
+      order: 2,
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+      factory: faker => faker.commerce.productDescription(),
+    },
+
+    status: {
+      default: 'Active',
+      order: 3,
+      fillable: true,
+      validation: {
+        rule: schema.enum(['Active', 'Scheduled', 'Expired']).required(),
+        message: {
+          required: 'Status is required',
+        },
+      },
+      factory: faker => faker.helpers.arrayElement(['Active', 'Scheduled', 'Expired']),
+    },
+
+    isActive: {
+      order: 4,
+      fillable: true,
+      default: true,
+      validation: {
+        rule: schema.boolean().required(),
+      },
+      factory: () => true,
+    },
+
+    discountType: {
+      order: 5,
+      fillable: true,
+      validation: {
+        rule: schema.enum(['fixed_amount', 'percentage']).required(),
+        message: {
+          required: 'Discount type is required',
+        },
+      },
+      factory: faker => faker.helpers.arrayElement(['fixed_amount', 'percentage']),
+    },
+
+    discountValue: {
+      order: 6,
+      fillable: true,
+      validation: {
+        rule: schema.number().required().min(0.01),
+        message: {
+          required: 'Discount value is required',
+          min: 'Discount value must be greater than 0.01',
+        },
+      },
+      factory: faker => faker.number.int({ min: 5, max: 50 }),
+    },
+
+    minOrderAmount: {
+      order: 7,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+        message: {
+          min: 'Min order amount must be greater than 0',
+        },
+      },
+      factory: faker => faker.number.int({ min: 0, max: 50 }),
+    },
+
+    maxDiscountAmount: {
+      order: 8,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+        message: {
+          min: 'Max discount amount must be greater than 0',
+        },
+      },
+      factory: faker => faker.number.int({ min: 5, max: 100 }),
+    },
+
+    freeProductId: {
+      order: 9,
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+      factory: faker => faker.string.uuid(),
+    },
+
+    usageLimit: {
+      order: 10,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(1),
+        message: {
+          min: 'Usage limit must be greater than 1',
+        },
+      },
+      factory: faker => faker.number.int({ min: 1, max: 100 }),
+    },
+
+    usageCount: {
+      default: 0,
+      order: 11,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+        message: {
+          min: 'Usage count must be greater than 0',
+        },
+      },
+      factory: faker => faker.number.int({ min: 0, max: 50 }),
+    },
+
+    startDate: {
+      order: 12,
+      fillable: true,
+      validation: {
+        rule: schema.date(),
+      },
+      factory: faker => faker.date.recent().toISOString().slice(0, 10),
+    },
+
+    endDate: {
+      order: 13,
+      fillable: true,
+      validation: {
+        rule: schema.date(),
+      },
+      factory: faker => faker.date.future().toISOString().slice(0, 10),
+    },
+  },
+
+  dashboard: {
+    highlight: true,
+  },
+} as const)

package/dist/models/commerce/Customer.ts

@@ -0,0 +1,132 @@
+import type { Attributes } from '@stacksjs/types'
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+export default defineModel({
+  name: 'Customer',
+  table: 'customers',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+    useSearch: {
+      displayable: ['id', 'name', 'email', 'phone', 'status'],
+      searchable: ['name', 'email', 'phone'],
+      sortable: ['name', 'totalSpent', 'lastOrder', 'created_at', 'updated_at'],
+      filterable: ['status'],
+    },
+
+    useSeeder: {
+      count: 20,
+    },
+
+    useApi: {
+      uri: 'customers',
+      middleware: ['auth'],
+    },
+
+    observe: true,
+  },
+
+  hasMany: ['Order', 'GiftCard', 'Review', 'Payment', 'LicenseKey', 'WaitlistProduct', 'WaitlistRestaurant'],
+  belongsTo: ['User'],
+
+  attributes: {
+    name: {
+      order: 1,
+      fillable: true,
+      validation: {
+        rule: schema.string().required().min(2).max(255),
+        message: {
+          min: 'Name must have a minimum of 2 characters',
+          max: 'Name must have a maximum of 255 characters',
+        },
+      },
+      factory: faker => faker.person.fullName(),
+    },
+
+    email: {
+      unique: true,
+      order: 2,
+      fillable: true,
+      validation: {
+        rule: schema.string().required().email(),
+        message: {
+          email: 'Email must be a valid email address',
+        },
+      },
+      factory: faker => faker.internet.email(),
+    },
+
+    phone: {
+      order: 3,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(50),
+        message: {
+          max: 'Phone number must have a maximum of 50 characters',
+        },
+      },
+      factory: faker => faker.phone.number(),
+    },
+
+    totalSpent: {
+      default: 0,
+      order: 5,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+        message: {
+          min: 'Total spent cannot be negative',
+        },
+      },
+      factory: faker => faker.number.int({ min: 0, max: 2000 }),
+    },
+
+    lastOrder: {
+      order: 6,
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+      factory: faker => faker.date.recent({ days: 60 }).toISOString().split('T')[0],
+    },
+
+    status: {
+      default: 'Active',
+      order: 7,
+      fillable: true,
+      validation: {
+        rule: schema.enum(['Active', 'Inactive']).required(),
+        message: {
+          enum: 'Status must be either Active or Inactive',
+        },
+      },
+      factory: faker => faker.helpers.arrayElement(['Active', 'Inactive']),
+    },
+
+    avatar: {
+      order: 8,
+      fillable: true,
+      validation: {
+        rule: schema.string().required().url(),
+        message: {
+          url: 'Avatar must be a valid URL',
+        },
+      },
+      factory: faker => faker.image.avatar(),
+    },
+  },
+
+  get: {
+    fullContactInfo: (attributes: Attributes) => {
+      return `${attributes.name} (${attributes.email}, ${attributes.phone})`
+    },
+  },
+
+  dashboard: {
+    highlight: true,
+  },
+} as const)

package/dist/models/commerce/DeliveryRoute.ts

@@ -0,0 +1,127 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+export default defineModel({
+  name: 'DeliveryRoute',
+  table: 'delivery_routes',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+    useSearch: {
+      displayable: ['id', 'driver', 'vehicle', 'stops', 'deliveryTime', 'totalDistance', 'lastActive'],
+      searchable: ['driver', 'vehicle'],
+      sortable: ['stops', 'deliveryTime', 'totalDistance', 'lastActive', 'createdAt', 'updatedAt'],
+      filterable: ['driver', 'vehicle'],
+    },
+
+    useSeeder: {
+      count: 5,
+    },
+
+    useApi: {
+      uri: 'delivery-routes',
+      middleware: ['auth'],
+    },
+
+    observe: true,
+  },
+
+  belongsTo: ['Driver'],
+  hasMany: ['DeliveryStop', 'DriverPing'],
+
+  attributes: {
+    driver: {
+      order: 1,
+      fillable: true,
+      validation: {
+        rule: schema.string().required().max(255),
+      },
+      factory: faker => faker.person.fullName(),
+    },
+
+    vehicle: {
+      order: 2,
+      fillable: true,
+      validation: {
+        rule: schema.string().required().max(255),
+      },
+      factory: faker => faker.vehicle.vehicle(),
+    },
+
+    stops: {
+      order: 3,
+      fillable: true,
+      validation: {
+        rule: schema.number().required().min(0),
+      },
+      factory: faker => faker.number.int({ min: 1, max: 20 }),
+    },
+
+    deliveryTime: {
+      order: 4,
+      fillable: true,
+      validation: {
+        rule: schema.number().required().min(0),
+      },
+      factory: faker => faker.number.int({ min: 30, max: 480 }), // 30 minutes to 8 hours
+    },
+
+    totalDistance: {
+      order: 5,
+      fillable: true,
+      validation: {
+        rule: schema.number().required().min(0),
+      },
+      factory: faker => faker.number.int({ min: 5, max: 200 }), // 5 to 200 miles
+    },
+
+    lastActive: {
+      order: 6,
+      fillable: true,
+      validation: {
+        rule: schema.unix().required(),
+      },
+      factory: faker => faker.date.recent().getTime(),
+    },
+
+    /*
+     * Route lifecycle. `stops` and `totalDistance` describe a route that has
+     * already run; a route being followed right now needs to say so, because
+     * that is the difference between a tracking map that draws a moving
+     * vehicle and one that draws yesterday's.
+     */
+    status: {
+      order: 7,
+      fillable: true,
+      default: 'planned',
+      validation: {
+        rule: schema.enum(['planned', 'active', 'completed', 'cancelled']),
+        message: {
+          enum: 'Status must be one of: planned, active, completed, cancelled',
+        },
+      },
+      factory: faker => faker.helpers.arrayElement(['planned', 'active', 'completed']),
+    },
+
+    startedAt: {
+      order: 8,
+      fillable: true,
+      validation: { rule: schema.timestamp() },
+      factory: () => null,
+    },
+
+    completedAt: {
+      order: 9,
+      fillable: true,
+      validation: { rule: schema.timestamp() },
+      factory: () => null,
+    },
+  },
+
+  dashboard: {
+    highlight: true,
+  },
+} as const)