@stacksjs/defaults 0.70.58 → 0.70.59

package/app/Models/Board.ts

@@ -0,0 +1,103 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+/**
+ * Kanban board (stacksjs/stacks#1846).
+ *
+ * A board owns columns, columns own cards, cards carry labels +
+ * assignees. The full hierarchy is exposed under the dashboard's
+ * Management section as a dev-mode surface — admins and devs see
+ * project-management boards; clients don't.
+ *
+ * Phase 1 scope: this model + read-only API + an index page listing
+ * boards. Phase 2 adds the drag-and-drop kanban view + write API.
+ */
+export default defineModel({
+  name: 'Board',
+  table: 'boards',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+    useSearch: {
+      displayable: ['id', 'name', 'description', 'createdAt'],
+      searchable: ['name', 'description'],
+      sortable: ['name', 'createdAt', 'updatedAt', 'position'],
+      filterable: ['archived'],
+    },
+
+    useSeeder: { count: 0 },
+
+    useApi: {
+      uri: 'boards',
+      routes: ['index', 'store', 'show', 'update', 'destroy'],
+    },
+  },
+
+  hasMany: ['BoardColumn', 'Label'],
+
+  attributes: {
+    name: {
+      order: 1,
+      fillable: true,
+      validation: {
+        rule: schema.string().required().min(1).max(120),
+      },
+      factory: faker => faker.commerce.productName(),
+    },
+
+    description: {
+      order: 2,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(2000),
+      },
+      factory: faker => faker.lorem.sentence(),
+    },
+
+    icon: {
+      order: 3,
+      fillable: true,
+      // SF Symbol name for the native sidebar; web sidebar falls back to a generic table icon.
+      validation: { rule: schema.string().max(80) },
+      factory: () => 'rectangle.stack.fill',
+    },
+
+    color: {
+      order: 4,
+      fillable: true,
+      // Tailwind-style hue token: stx-blue, stx-violet, etc. Free-form
+      // string; the UI maps unknown values to the default theme.
+      validation: { rule: schema.string().max(40) },
+      factory: faker => faker.helpers.arrayElement(['violet', 'blue', 'emerald', 'amber', 'rose']),
+    },
+
+    position: {
+      order: 5,
+      fillable: true,
+      // Sort order in the "Boards" index. Lower = appears first.
+      // Reflowed in bulk on reorder; defaults to "append at end" via
+      // server-side max() + 1 on create.
+      validation: { rule: schema.number().min(0) },
+      factory: faker => faker.number.int({ min: 0, max: 100 }),
+    },
+
+    archived: {
+      order: 6,
+      fillable: true,
+      // Soft-archived boards stay in the DB but drop out of the
+      // dashboard's default list view. They're recoverable via the
+      // /kanban/archived sub-page (Phase 3).
+      validation: { rule: schema.boolean() },
+      factory: () => false,
+    },
+  },
+
+  // The kanban surface has a dedicated dashboard page (`/kanban`),
+  // not the auto-derived `/models/board` viewer — the sidebar entry is
+  // hand-added in `dashboard-utils.ts` / `sidebar.ts` and points at
+  // the real page. Hiding the auto-row keeps it from double-listing.
+  dashboard: { enabled: false },
+} as const)

package/app/Models/BoardColumn.ts

@@ -0,0 +1,87 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+/**
+ * Column on a kanban board (stacksjs/stacks#1846).
+ *
+ * Each board owns an ordered list of columns ("Todo", "In Progress",
+ * "Review", "Done", …). Cards live inside columns. Column ordering
+ * within a board is driven by the `position` integer — Phase 2's drag
+ * handler reorders by setting a new `position` and reflowing siblings.
+ *
+ * Hidden from the sidebar as a standalone model row (`dashboard.enabled:
+ * false`) because columns only make sense inside a board. The dashboard
+ * surfaces them indirectly through `/kanban/[boardId]`. Direct ORM
+ * viewer access via `/models/board-column` still works for ops.
+ */
+export default defineModel({
+  name: 'BoardColumn',
+  table: 'board_columns',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+    useSearch: {
+      displayable: ['id', 'name', 'boardId', 'position'],
+      searchable: ['name'],
+      sortable: ['position', 'createdAt'],
+      filterable: ['boardId'],
+    },
+
+    useSeeder: { count: 0 },
+
+    useApi: {
+      uri: 'board-columns',
+      routes: ['index', 'store', 'show', 'update', 'destroy'],
+    },
+  },
+
+  belongsTo: ['Board'],
+  hasMany: ['Card'],
+
+  attributes: {
+    boardId: {
+      order: 1,
+      fillable: true,
+      validation: { rule: schema.number().required() },
+      factory: () => 1,
+    },
+
+    name: {
+      order: 2,
+      fillable: true,
+      validation: { rule: schema.string().required().min(1).max(80) },
+      factory: faker => faker.helpers.arrayElement(['Todo', 'In Progress', 'Review', 'Done']),
+    },
+
+    position: {
+      order: 3,
+      fillable: true,
+      // Sort order within the parent board. Drag-reorder rewrites
+      // adjacent rows in a single transaction (Phase 2).
+      validation: { rule: schema.number().min(0) },
+      factory: faker => faker.number.int({ min: 0, max: 10 }),
+    },
+
+    cardLimit: {
+      order: 4,
+      fillable: true,
+      // WIP limit — nullable. The UI shows a warning badge when a
+      // column hits its limit but doesn't reject new cards
+      // (Phase 2/3 will decide whether the limit is hard or soft).
+      validation: { rule: schema.number().min(0) },
+      factory: () => null,
+    },
+
+    color: {
+      order: 5,
+      fillable: true,
+      validation: { rule: schema.string().max(40) },
+      factory: faker => faker.helpers.arrayElement(['slate', 'amber', 'blue', 'emerald']),
+    },
+  },
+
+  dashboard: { enabled: false },
+} as const)

package/app/Models/Campaign.ts

@@ -0,0 +1,239 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+export default defineModel({
+  name: 'Campaign',
+  table: 'campaigns',
+  primaryKey: 'id',
+  autoIncrement: true,
+  belongsTo: ['EmailList'],
+  hasMany: ['CampaignSend'],
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+    useSeeder: {
+      count: 10,
+    },
+    useApi: {
+      uri: 'campaigns',
+      routes: ['index', 'store', 'show', 'update', 'destroy'],
+    },
+  },
+
+  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().max(255),
+      },
+      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),
+    },
+
+    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(),
+    },
+
+    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 }),
+    },
+
+    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/app/Models/CampaignSend.ts

@@ -0,0 +1,107 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+export default defineModel({
+  name: 'CampaignSend',
+  table: 'campaign_sends',
+  primaryKey: 'id',
+  autoIncrement: true,
+  belongsTo: ['Campaign', 'Subscriber', 'EmailList'],
+
+  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'],
+    },
+  },
+
+  attributes: {
+    campaignId: {
+      required: true,
+      fillable: true,
+      validation: {
+        rule: schema.number(),
+      },
+      factory: faker => faker.number.int({ min: 1, max: 10 }),
+    },
+
+    subscriberId: {
+      required: true,
+      fillable: true,
+      validation: {
+        rule: schema.number(),
+      },
+      factory: faker => faker.number.int({ min: 1, max: 100 }),
+    },
+
+    emailListId: {
+      required: true,
+      fillable: true,
+      validation: {
+        rule: schema.number(),
+      },
+      factory: faker => faker.number.int({ min: 1, max: 8 }),
+    },
+
+    status: {
+      required: true,
+      fillable: true,
+      default: 'queued',
+      validation: {
+        rule: schema.enum(['queued', 'sent', 'failed', 'bounced', 'complained']),
+      },
+      factory: faker => faker.helpers.arrayElement(['sent', 'sent', 'sent', 'queued', 'failed', 'bounced']),
+    },
+
+    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,
+    },
+  },
+} as const)

package/app/Models/Card.ts

@@ -0,0 +1,117 @@
+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'],
+    },
+  },
+
+  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)