@stacksjs/orm 0.72.16 → 0.72.18

package/dist/models/Campaign.ts

@@ -0,0 +1,321 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+export default defineModel({
+  name: 'Campaign',
+  table: 'campaigns',
+  primaryKey: 'id',
+  autoIncrement: true,
+  belongsTo: ['Team', 'EmailList'],
+  hasMany: ['CampaignSend', 'CampaignVariant'],
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+    useSeeder: {
+      count: 10,
+    },
+    useApi: {
+      uri: 'campaigns',
+      routes: ['index', 'store', 'show', 'update', 'destroy'],
+      middleware: ['auth', 'team'],
+    },
+    useSearch: {
+      displayable: ['id', 'name', 'type', 'status', 'subject', 'scheduledAt', 'sentAt'],
+      searchable: ['name', 'description', 'subject'],
+      sortable: ['name', 'type', 'status', 'scheduledAt', 'sentAt', 'createdAt', 'updatedAt'],
+      filterable: ['teamId', 'type', 'status', 'emailListId', 'currency'],
+    },
+    observe: true,
+  },
+
+  attributes: {
+    name: {
+      required: true,
+      fillable: true,
+      validation: {
+        rule: schema.string().min(3).max(255),
+      },
+      factory: faker => faker.helpers.arrayElement([
+        'Summer Sale 2024', 'Black Friday Deals', 'Holiday Special',
+        'New Product Launch', 'Customer Appreciation', 'Flash Sale',
+        'Welcome Series', 'Re-engagement', 'Newsletter Weekly',
+        'Product Updates',
+      ]),
+    },
+
+    description: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(1000),
+      },
+      factory: faker => faker.lorem.paragraph(),
+    },
+
+    type: {
+      required: true,
+      fillable: true,
+      validation: {
+        rule: schema.enum(['email', 'sms', 'push', 'social', 'multi-channel']),
+      },
+      factory: faker => faker.helpers.arrayElement(['email', 'sms', 'push', 'social', 'multi-channel']),
+    },
+
+    status: {
+      required: true,
+      fillable: true,
+      default: 'draft',
+      // Newsletter sends use 'sending' / 'sent' / 'cancelled' / 'failed'.
+      // The legacy multi-channel statuses (active / completed / archived)
+      // are kept for compatibility with non-email campaign types.
+      validation: {
+        rule: schema.enum([
+          'draft', 'scheduled', 'sending', 'sent', 'paused', 'cancelled', 'failed',
+          'active', 'completed', 'archived',
+        ]),
+      },
+      factory: faker => faker.helpers.arrayElement(['draft', 'scheduled', 'sent', 'sending', 'completed']),
+    },
+
+    // ── Email-specific fields (used when type === 'email') ────────────
+    // The newsletter pipeline writes these. Other campaign types
+    // (sms/push/social) leave them null.
+
+    subject: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(255),
+      },
+      factory: faker => faker.lorem.sentence(6),
+    },
+
+    template: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+      factory: faker => faker.helpers.arrayElement(['newsletter-default', 'product-update', 'promo']),
+    },
+
+    text: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+      factory: faker => faker.lorem.paragraphs(2),
+    },
+
+    content: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.json(),
+      },
+      factory: () => JSON.stringify([]),
+    },
+
+    channelSettings: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.json(),
+      },
+      factory: () => JSON.stringify({}),
+    },
+
+    segmentDefinition: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.json(),
+      },
+      factory: () => JSON.stringify({ operator: 'and', rules: [] }),
+    },
+
+    fromName: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(100),
+      },
+      factory: faker => faker.company.name(),
+    },
+
+    fromAddress: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.string().email().max(255),
+      },
+      factory: faker => faker.internet.email(),
+    },
+
+    replyTo: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.string().email().max(255),
+      },
+      factory: faker => faker.internet.email(),
+    },
+
+    timezone: {
+      required: true,
+      fillable: true,
+      default: 'UTC',
+      validation: {
+        rule: schema.string().max(100),
+      },
+      factory: () => 'UTC',
+    },
+
+    recurrence: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(255),
+      },
+      factory: () => null,
+    },
+
+    experimentMetric: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.enum(['open_rate', 'click_rate', 'conversion_rate']),
+      },
+      factory: () => null,
+    },
+
+    emailListId: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.number(),
+      },
+      factory: faker => faker.number.int({ min: 1, max: 8 }),
+    },
+
+    scheduledAt: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.timestamp(),
+      },
+      factory: (faker) => {
+        return faker.date.soon({ days: 14 }).toISOString().slice(0, 19).replace('T', ' ')
+      },
+    },
+
+    sentAt: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.timestamp(),
+      },
+      factory: () => null,
+    },
+
+    audienceSize: {
+      required: false,
+      fillable: true,
+      default: 0,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: faker => faker.number.int({ min: 100, max: 50000 }),
+    },
+
+    sentCount: {
+      required: false,
+      fillable: true,
+      default: 0,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: faker => faker.number.int({ min: 0, max: 10000 }),
+    },
+
+    openRate: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0).max(100),
+      },
+      factory: faker => faker.number.float({ min: 15, max: 45, fractionDigits: 1 }),
+    },
+
+    clickRate: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0).max(100),
+      },
+      factory: faker => faker.number.float({ min: 2, max: 15, fractionDigits: 1 }),
+    },
+
+    conversionRate: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0).max(100),
+      },
+      factory: faker => faker.number.float({ min: 0.5, max: 8, fractionDigits: 1 }),
+    },
+
+    budget: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: faker => faker.number.float({ min: 100, max: 10000, fractionDigits: 2 }),
+    },
+
+    spent: {
+      required: false,
+      fillable: true,
+      default: 0,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: faker => faker.number.float({ min: 0, max: 5000, fractionDigits: 2 }),
+    },
+
+    currency: {
+      required: true,
+      fillable: true,
+      default: 'USD',
+      validation: {
+        rule: schema.string().required().max(3),
+      },
+      factory: faker => faker.helpers.arrayElement(['USD', 'EUR', 'GBP', 'CAD', 'AUD']),
+    },
+
+    startDate: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.timestamp(),
+      },
+      factory: (faker) => {
+        return faker.date.recent({ days: 30 }).toISOString().slice(0, 19).replace('T', ' ')
+      },
+    },
+
+    endDate: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.timestamp(),
+      },
+      factory: (faker) => {
+        return faker.date.soon({ days: 30 }).toISOString().slice(0, 19).replace('T', ' ')
+      },
+    },
+  },
+} as const)

package/dist/models/CampaignSend.ts

@@ -0,0 +1,191 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+export default defineModel({
+  name: 'CampaignSend',
+  table: 'campaign_sends',
+  primaryKey: 'id',
+  autoIncrement: true,
+  belongsTo: ['Team', 'Campaign', 'Subscriber', 'EmailList', 'CampaignVariant'],
+
+  indexes: [
+    {
+      name: 'campaign_sends_idempotency_unique',
+      columns: ['idempotency_key'],
+      unique: true,
+    },
+  ],
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+    useApi: {
+      uri: 'campaign-sends',
+      routes: ['index', 'show'],
+      // Per-recipient send records carry email + delivery status. Treat
+      // as PII and require auth on all read paths. The transactional
+      // owner-only views in the dashboard are gated separately.
+      middleware: ['auth', 'team'],
+    },
+  },
+
+  attributes: {
+    campaignId: {
+      required: true,
+      fillable: true,
+      validation: {
+        rule: schema.number(),
+      },
+      factory: faker => faker.number.int({ min: 1, max: 10 }),
+    },
+
+    subscriberId: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.number(),
+      },
+      factory: () => null,
+    },
+
+    emailListId: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.number(),
+      },
+      factory: () => null,
+    },
+
+    status: {
+      required: true,
+      fillable: true,
+      default: 'queued',
+      validation: {
+        rule: schema.enum([
+          'queued', 'deferred', 'sending', 'sent', 'delivered', 'failed',
+          'undelivered', 'bounced', 'complained', 'suppressed', 'cancelled',
+        ]),
+      },
+      factory: faker => faker.helpers.arrayElement(['sent', 'sent', 'sent', 'queued', 'failed', 'bounced']),
+    },
+
+    channel: {
+      required: true,
+      fillable: true,
+      default: 'email',
+      validation: {
+        rule: schema.enum(['email', 'sms', 'push']),
+      },
+      factory: faker => faker.helpers.arrayElement(['email', 'sms']),
+    },
+
+    recipient: {
+      required: true,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(255),
+      },
+      factory: faker => faker.internet.email(),
+    },
+
+    idempotencyKey: {
+      required: true,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(255),
+      },
+      factory: faker => faker.string.uuid(),
+    },
+
+    providerMessageId: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(255),
+      },
+      factory: faker => faker.string.uuid(),
+    },
+
+    error: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+      factory: () => null,
+    },
+
+    sentAt: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.timestamp(),
+      },
+      factory: faker => faker.date.recent({ days: 7 }).toISOString().slice(0, 19).replace('T', ' '),
+    },
+
+    openedAt: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.timestamp(),
+      },
+      factory: () => null,
+    },
+
+    clickedAt: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.timestamp(),
+      },
+      factory: () => null,
+    },
+
+    deliveredAt: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.timestamp(),
+      },
+      factory: () => null,
+    },
+
+    failedAt: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.timestamp(),
+      },
+      factory: () => null,
+    },
+
+    segments: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(1),
+      },
+      factory: () => 1,
+    },
+
+    cost: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: () => 0,
+    },
+
+    metadata: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.json(),
+      },
+      factory: () => JSON.stringify({}),
+    },
+  },
+} as const)

package/dist/models/CampaignVariant.ts

@@ -0,0 +1,25 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+export default defineModel({
+  name: 'CampaignVariant',
+  table: 'campaign_variants',
+  belongsTo: ['Team', 'Campaign'],
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+    useApi: { uri: 'campaign-variants', routes: ['index', 'store', 'show', 'update', 'destroy'], middleware: ['auth', 'team'] },
+  },
+  indexes: [{ name: 'campaign_variants_name_unique', columns: ['campaign_id', 'name'], unique: true }],
+  attributes: {
+    name: { required: true, fillable: true, validation: { rule: schema.string().max(80) }, factory: faker => faker.helpers.arrayElement(['Control', 'Variant B']) },
+    subject: { required: false, fillable: true, validation: { rule: schema.string().max(255) }, factory: faker => faker.lorem.sentence(6) },
+    content: { required: true, fillable: true, validation: { rule: schema.json() }, factory: () => JSON.stringify([]) },
+    allocation: { required: true, fillable: true, default: 50, validation: { rule: schema.number().min(0).max(100) }, factory: () => 50 },
+    sentCount: { required: true, fillable: true, default: 0, validation: { rule: schema.number().min(0) }, factory: () => 0 },
+    openCount: { required: true, fillable: true, default: 0, validation: { rule: schema.number().min(0) }, factory: () => 0 },
+    clickCount: { required: true, fillable: true, default: 0, validation: { rule: schema.number().min(0) }, factory: () => 0 },
+    conversionCount: { required: true, fillable: true, default: 0, validation: { rule: schema.number().min(0) }, factory: () => 0 },
+    isWinner: { required: true, fillable: true, default: false, validation: { rule: schema.boolean() }, factory: () => false },
+  },
+} as const)

package/dist/models/Card.ts

@@ -0,0 +1,118 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+/**
+ * Kanban card (stacksjs/stacks#1846).
+ *
+ * A card belongs to a column (and, via denormalisation, to a board) so
+ * board-wide queries don't need a two-hop join. Cards carry labels +
+ * assignees via pivot tables (`card_labels`, `card_assignees`) — those
+ * relations land in Phase 3 alongside the card-detail modal.
+ *
+ * Hidden from the sidebar as a standalone model row — cards are seen
+ * through `/kanban/[boardId]` (Phase 2), not as a top-level model
+ * viewer. The dashboard's modular config from #1843 carries that
+ * `enabled: false` to both sidebars.
+ */
+export default defineModel({
+  name: 'Card',
+  table: 'cards',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+    useSearch: {
+      displayable: ['id', 'title', 'columnId', 'boardId', 'position', 'dueDate'],
+      searchable: ['title', 'description'],
+      sortable: ['position', 'createdAt', 'updatedAt', 'dueDate'],
+      filterable: ['boardId', 'columnId', 'archived'],
+    },
+
+    useSeeder: { count: 0 },
+
+    useApi: {
+      uri: 'cards',
+      routes: ['index', 'store', 'show', 'update', 'destroy'],
+      middleware: ['auth'],
+    },
+  },
+
+  belongsTo: ['BoardColumn', 'Board', 'User'],
+  // Pivot relations land in Phase 3 (labels + assignees).
+  // belongsToMany: {
+  //   labels:    { model: 'Label', table: 'card_labels', foreignKey: 'card_id', relatedKey: 'label_id' },
+  //   assignees: { model: 'User',  table: 'card_assignees', foreignKey: 'card_id', relatedKey: 'user_id' },
+  // },
+
+  attributes: {
+    columnId: {
+      order: 1,
+      fillable: true,
+      validation: { rule: schema.number().required() },
+      factory: () => 1,
+    },
+
+    boardId: {
+      order: 2,
+      fillable: true,
+      // Denormalised from `column.board_id` so a "all cards on board X"
+      // query stays single-table. The kanban API keeps it in sync on
+      // card create/move (Phase 2).
+      validation: { rule: schema.number().required() },
+      factory: () => 1,
+    },
+
+    title: {
+      order: 3,
+      fillable: true,
+      validation: { rule: schema.string().required().min(1).max(300) },
+      factory: faker => faker.lorem.sentence({ min: 3, max: 8 }),
+    },
+
+    description: {
+      order: 4,
+      fillable: true,
+      // Markdown-formatted long description. Rendered in the card detail
+      // modal (Phase 3); the kanban board view shows the first line only.
+      validation: { rule: schema.string().max(10000) },
+      factory: faker => faker.lorem.paragraph(),
+    },
+
+    position: {
+      order: 5,
+      fillable: true,
+      // Sort order within the parent column. Drag-reorder reflows
+      // adjacent rows in a single transaction (Phase 2). Moving across
+      // columns updates both `columnId` and `position`.
+      validation: { rule: schema.number().min(0) },
+      factory: faker => faker.number.int({ min: 0, max: 100 }),
+    },
+
+    createdByUserId: {
+      order: 6,
+      fillable: true,
+      // The user who created the card. Set server-side from
+      // `request.user.id` on store; surfaced in the card detail.
+      validation: { rule: schema.number() },
+      factory: () => null,
+    },
+
+    dueDate: {
+      order: 7,
+      fillable: true,
+      validation: { rule: schema.string() },
+      factory: () => null,
+    },
+
+    archived: {
+      order: 8,
+      fillable: true,
+      validation: { rule: schema.boolean() },
+      factory: () => false,
+    },
+  },
+
+  dashboard: { enabled: false },
+} as const)