@stacksjs/defaults 0.70.380 → 0.71.2

package/app/Models/Content/MenuItem.ts

@@ -0,0 +1,91 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+/**
+ * One entry in a Menu: either a link to a Page (`pageId`) or a raw `url` -
+ * exactly one of the two. Nests one level via `parentId` for dropdowns.
+ */
+export default defineModel({
+  name: 'MenuItem',
+  table: 'menu_items',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  traits: {
+    useTimestamps: true,
+    useApi: {
+      middleware: ['auth'],
+      uri: 'menu-items',
+      routes: ['index', 'store', 'show', 'update', 'destroy'],
+    },
+  },
+
+  belongsTo: ['Menu', 'Page'],
+
+  attributes: {
+    label: {
+      required: true,
+      order: 1,
+      fillable: true,
+      validation: {
+        rule: schema.string().min(1).max(120),
+      },
+      factory: faker => faker.lorem.words(2),
+    },
+
+    /** External or hand-written link. Null when the item points at a Page. */
+    url: {
+      required: false,
+      order: 2,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(2048),
+      },
+      factory: () => null,
+    },
+
+    target: {
+      required: false,
+      order: 3,
+      fillable: true,
+      default: '_self',
+      validation: {
+        rule: schema.enum(['_self', '_blank'] as const),
+      },
+      factory: () => '_self',
+    },
+
+    /** Dropdown parent within the same menu. */
+    parentId: {
+      required: false,
+      order: 4,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(1),
+      },
+      factory: () => null,
+    },
+
+    position: {
+      required: false,
+      order: 5,
+      fillable: true,
+      default: 0,
+      validation: {
+        rule: schema.number().min(0),
+      },
+    },
+
+    /** `auth` items render only for signed-in visitors (portal links). */
+    visibility: {
+      required: false,
+      order: 6,
+      fillable: true,
+      default: 'public',
+      validation: {
+        rule: schema.enum(['public', 'auth'] as const),
+      },
+      factory: () => 'public',
+    },
+  },
+} as const)

package/app/Models/Content/Page.ts

@@ -1,27 +1,44 @@
 import { defineModel } from '@stacksjs/orm'
 import { schema } from '@stacksjs/validation'
 
+/**
+ * A real CMS page: a block document served publicly at `path` on its site.
+ *
+ * `blocks` is the content - an ordered JSON array validated against the block
+ * registry (`@stacksjs/cms` `validateBlocks`). One JSON column rather than
+ * Section/Block rows so a page edit is one atomic write and a revision is a
+ * row copy, not a snapshot-of-a-join.
+ *
+ * The `useApi` surface is the ADMIN surface (auth'd on both sides - the table
+ * now carries draft content, and a public read route is how drafts leak).
+ * Public visitors get pages through the stx servers' CMS fallback, which only
+ * ever serves `status = 'published'` rows for the request's site.
+ */
 export default defineModel({
   name: 'Page',
   table: 'pages',
   primaryKey: 'id',
   autoIncrement: true,
 
+  indexes: [
+    {
+      name: 'pages_site_path_unique',
+      columns: ['site_id', 'path'],
+      unique: true,
+    },
+  ],
+
   traits: {
     useUuid: true,
     useTimestamps: true,
     useSearch: {
-      displayable: ['id', 'title', 'author', 'template', 'views', 'conversions'],
-      searchable: ['title', 'author', 'template'],
-      sortable: ['views', 'conversions'],
-      filterable: ['template'],
+      displayable: ['id', 'title', 'slug', 'path', 'template', 'status', 'views'],
+      searchable: ['title', 'slug', 'path'],
+      sortable: ['views', 'conversions', 'publishedAt'],
+      filterable: ['template', 'status'],
     },
     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'] },
+      middleware: ['auth'],
       uri: 'pages',
       routes: ['index', 'store', 'show', 'update', 'destroy'],
     },
@@ -31,7 +48,7 @@ export default defineModel({
     },
   },
 
-  belongsTo: ['Author'],
+  belongsTo: ['Author', 'Site'],
 
   attributes: {
     title: {
@@ -48,9 +65,46 @@ export default defineModel({
       factory: faker => faker.lorem.sentence(),
     },
 
+    /** Last path segment, unique among siblings. */
+    slug: {
+      required: false,
+      order: 2,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(255),
+      },
+      factory: faker => faker.lorem.slug(),
+    },
+
+    /**
+     * Materialized full path (`/admissions/visit`), unique per site. Derived
+     * from the parent chain + slug on save; a slug change rewrites descendant
+     * paths and leaves Redirect rows behind.
+     */
+    path: {
+      required: false,
+      order: 3,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(2048),
+      },
+      factory: faker => `/${faker.lorem.slug()}`,
+    },
+
+    /** Page-tree parent. Null for top-level pages. */
+    parentId: {
+      required: false,
+      order: 4,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(1),
+      },
+      factory: () => null,
+    },
+
     template: {
       required: true,
-      order: 3,
+      order: 5,
       fillable: true,
       validation: {
         rule: schema.string().min(3),
@@ -61,9 +115,52 @@ export default defineModel({
       factory: faker => faker.helpers.arrayElement(['default', 'landing', 'blog', 'contact']),
     },
 
+    /** The block document. Ordered array of { id, type, props }. */
+    blocks: {
+      required: false,
+      order: 6,
+      fillable: true,
+      validation: {
+        rule: schema.json(),
+      },
+      factory: () => JSON.stringify([]),
+    },
+
+    metaDescription: {
+      required: false,
+      order: 7,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(320),
+      },
+      factory: faker => faker.lorem.sentence(),
+    },
+
+    status: {
+      required: false,
+      order: 8,
+      fillable: true,
+      default: 'draft',
+      validation: {
+        rule: schema.enum(['draft', 'published', 'scheduled', 'archived'] as const),
+      },
+      factory: faker => faker.helpers.arrayElement(['draft', 'published']),
+    },
+
+    /** When a `scheduled` page goes live - enforced by the publish job. */
+    scheduledAt: {
+      required: false,
+      order: 9,
+      fillable: true,
+      validation: {
+        rule: schema.timestamp(),
+      },
+      factory: () => null,
+    },
+
     views: {
       required: false,
-      order: 4,
+      order: 10,
       fillable: true,
       default: 0,
       validation: {
@@ -77,7 +174,7 @@ export default defineModel({
 
     publishedAt: {
       required: false,
-      order: 6,
+      order: 11,
       fillable: true,
       validation: {
         rule: schema.timestamp(),
@@ -93,7 +190,7 @@ export default defineModel({
 
     conversions: {
       required: false,
-      order: 5,
+      order: 12,
       fillable: true,
       default: 0,
       validation: {

package/app/Models/Content/PageRevision.ts

@@ -0,0 +1,86 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+/**
+ * A snapshot of a Page's document taken just before an overwrite - restoring
+ * is copying the snapshot back and recording a new revision of what it
+ * replaced. One row per save (the previous state), pruned to the newest N per
+ * page (`config.cms.revisions.keep`).
+ *
+ * No `useApi`: revisions are read and restored through the CMS actions, never
+ * CRUD'd directly.
+ */
+export default defineModel({
+  name: 'PageRevision',
+  table: 'page_revisions',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  indexes: [
+    {
+      name: 'page_revisions_page_revision_unique',
+      columns: ['page_id', 'revision'],
+      unique: true,
+    },
+  ],
+
+  traits: {
+    useTimestamps: true,
+  },
+
+  belongsTo: ['Page', 'Author'],
+
+  attributes: {
+    /** Monotonic per page, starting at 1. */
+    revision: {
+      required: true,
+      order: 1,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(1),
+      },
+      factory: faker => faker.number.int({ min: 1, max: 20 }),
+    },
+
+    title: {
+      required: true,
+      order: 2,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(255),
+      },
+      factory: faker => faker.lorem.sentence(),
+    },
+
+    blocks: {
+      required: false,
+      order: 3,
+      fillable: true,
+      validation: {
+        rule: schema.json(),
+      },
+      factory: () => JSON.stringify([]),
+    },
+
+    metaDescription: {
+      required: false,
+      order: 4,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(320),
+      },
+      factory: () => null,
+    },
+
+    /** Editor-supplied note ("reworded hero for spring"), optional. */
+    note: {
+      required: false,
+      order: 5,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(500),
+      },
+      factory: () => null,
+    },
+  },
+} as const)

package/app/Models/Content/Post.ts

@@ -11,9 +11,11 @@ export default defineModel({
     useUuid: true,
     useTimestamps: true,
     useSearch: {
-      displayable: ['id', 'title', 'author', 'views', 'status', 'poster', 'focusKeyword', 'metaDescription', 'canonicalUrl'],
-      searchable: ['title', 'author', 'body', 'excerpt', 'focusKeyword', 'metaDescription'],
-      sortable: ['published_at', 'views', 'comments'],
+      displayable: ['id', 'title', 'slug', 'author', 'views', 'status', 'poster', 'focusKeyword', 'metaDescription', 'canonicalUrl'],
+      // `content`, not `body` - the column is `content`, and the old spelling
+      // silently indexed nothing. `comments` likewise was never a column.
+      searchable: ['title', 'slug', 'author', 'content', 'excerpt', 'focusKeyword', 'metaDescription'],
+      sortable: ['published_at', 'views'],
       filterable: ['status'],
     },
 
@@ -24,17 +26,16 @@ export default defineModel({
     // trait targets the real `commentables` table, activating it is correct.
     commentable: true,
     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'] },
+      // Admin surface now: the table carries drafts, and a public read route
+      // is how drafts leak. Public visitors get published posts through the
+      // site's own routes/pages, which filter by status themselves.
+      middleware: ['auth'],
       uri: 'posts',
       routes: ['index', 'store', 'show', 'update', 'destroy'],
     },
   },
 
-  belongsTo: ['Author'],
+  belongsTo: ['Author', 'Site'],
   belongsToMany: {
     categories: {
       model: 'Category',
@@ -78,6 +79,20 @@ export default defineModel({
       },
       factory: faker => faker.lorem.sentence(),
     },
+
+    /**
+     * URL identity: `/news/{slug}` beats `/blog/{id}` for a public site.
+     * Nullable for pre-slug rows; the RSS/sitemap actions fall back to id.
+     */
+    slug: {
+      required: false,
+      order: 2,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(255),
+      },
+      factory: faker => faker.lorem.slug(),
+    },
     poster: {
       required: false,
       order: 4,

package/app/Models/Content/Redirect.ts

@@ -0,0 +1,80 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+/**
+ * A path-level redirect on a site. Written automatically when a page's slug
+ * or ancestry changes (`source: 'slug-change'`) so old links keep working,
+ * and manually from the dashboard (`source: 'manual'`). Resolved by the CMS
+ * fallback after page lookup misses.
+ */
+export default defineModel({
+  name: 'Redirect',
+  table: 'redirects',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  indexes: [
+    {
+      name: 'redirects_site_from_unique',
+      columns: ['site_id', 'from_path'],
+      unique: true,
+    },
+  ],
+
+  traits: {
+    useTimestamps: true,
+    useApi: {
+      middleware: ['auth'],
+      uri: 'redirects',
+      routes: ['index', 'store', 'show', 'update', 'destroy'],
+    },
+  },
+
+  belongsTo: ['Site'],
+
+  attributes: {
+    fromPath: {
+      required: true,
+      order: 1,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(2048),
+      },
+      factory: faker => `/${faker.lorem.slug()}`,
+    },
+
+    toPath: {
+      required: true,
+      order: 2,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(2048),
+      },
+      factory: faker => `/${faker.lorem.slug()}`,
+    },
+
+    statusCode: {
+      required: false,
+      order: 3,
+      fillable: true,
+      default: 301,
+      validation: {
+        // schema.enum is string-typed; the numeric range pins 301/302 (the
+        // read path coerces anything else to 301 anyway).
+        rule: schema.number().min(301).max(302),
+      },
+      factory: () => 301,
+    },
+
+    source: {
+      required: false,
+      order: 4,
+      fillable: true,
+      default: 'manual',
+      validation: {
+        rule: schema.enum(['slug-change', 'manual'] as const),
+      },
+      factory: () => 'manual',
+    },
+  },
+} as const)

package/app/Models/Forms/Form.ts

@@ -0,0 +1,91 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+/**
+ * A user-defined form: inquiry, permission slip, event registration,
+ * donation. Fields are FormField rows; submissions are FormSubmission rows.
+ *
+ * The `useApi` surface is the ADMIN builder surface. The public render and
+ * submit endpoints live in `@stacksjs/forms` routes, keyed by uuid, and only
+ * ever serve `status: 'active'` forms.
+ */
+export default defineModel({
+  name: 'Form',
+  table: 'forms',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  indexes: [
+    {
+      name: 'forms_site_handle_unique',
+      columns: ['site_id', 'handle'],
+      unique: true,
+    },
+  ],
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+    useApi: {
+      middleware: ['auth'],
+      uri: 'forms',
+      routes: ['index', 'store', 'show', 'update', 'destroy'],
+    },
+    useSearch: {
+      displayable: ['id', 'name', 'handle', 'status'],
+      searchable: ['name', 'handle'],
+      filterable: ['status'],
+    },
+  },
+
+  belongsTo: ['Site'],
+  hasMany: ['FormField', 'FormSubmission'],
+
+  attributes: {
+    name: {
+      required: true,
+      order: 1,
+      fillable: true,
+      validation: {
+        rule: schema.string().min(2).max(255),
+      },
+      factory: faker => `${faker.lorem.words(2)} form`,
+    },
+
+    handle: {
+      required: true,
+      order: 2,
+      fillable: true,
+      validation: {
+        rule: schema.string().min(2).max(64).matches(/^[a-z0-9-]+$/),
+      },
+      factory: faker => faker.lorem.slug(),
+    },
+
+    status: {
+      required: false,
+      order: 3,
+      fillable: true,
+      default: 'draft',
+      validation: {
+        rule: schema.enum(['draft', 'active', 'closed'] as const),
+      },
+      factory: () => 'active',
+    },
+
+    /**
+     * JSON settings: { submitLabel?, confirmation: { type: 'message'|'redirect',
+     * value }, notifyEmails: string[], emailField?, nameField?,
+     * payment?: { mode: 'fixed'|'user_amount'|'field_sum', amountCents?, currency? } }
+     */
+    settings: {
+      required: false,
+      order: 4,
+      fillable: true,
+      validation: {
+        rule: schema.json(),
+      },
+      factory: () => JSON.stringify({}),
+    },
+  },
+} as const)