@stacksjs/defaults 0.75.41 → 0.75.43

package/app/Models/CampaignSend.ts

@@ -17,6 +17,7 @@ export default defineModel({
   ],
 
   traits: {
+    gdpr: { subject: { via: 'Subscriber' }, erasure: 'anonymize', basis: 'legitimate_interests', purpose: 'Campaign delivery statistics' },
     useUuid: true,
     useTimestamps: true,
     useApi: {
@@ -81,6 +82,7 @@ export default defineModel({
     },
 
     recipient: {
+      personal: true,
       required: true,
       fillable: true,
       validation: {

package/app/Models/Card.ts

@@ -21,6 +21,7 @@ export default defineModel({
   autoIncrement: true,
 
   traits: {
+    gdpr: { erasure: 'keep', basis: 'legitimate_interests', purpose: 'Shared board content, attributed to the (anonymized) author' },
     useUuid: true,
     useTimestamps: true,
     useSearch: {

package/app/Models/CardComment.ts

@@ -21,6 +21,7 @@ export default defineModel({
   autoIncrement: true,
 
   traits: {
+    gdpr: { erasure: 'keep', basis: 'legitimate_interests', purpose: 'Shared board discussion, attributed to the (anonymized) author' },
     useUuid: true,
     useTimestamps: true,
     useSearch: {

package/app/Models/Comment.ts

@@ -8,6 +8,7 @@ export default defineModel({
   autoIncrement: true,
 
   traits: {
+    gdpr: { erasure: 'anonymize', basis: 'legitimate_interests', purpose: 'Comments on posts' },
     useUuid: true,
     useTimestamps: true,
     useSeeder: {
@@ -24,6 +25,7 @@ export default defineModel({
 
   attributes: {
     authorName: {
+      personal: true,
       required: true,
       fillable: true,
       validation: {
@@ -33,6 +35,7 @@ export default defineModel({
     },
 
     authorEmail: {
+      personal: true,
       required: true,
       fillable: true,
       validation: {
@@ -79,6 +82,7 @@ export default defineModel({
     },
 
     ipAddress: {
+      personal: true,
       required: false,
       fillable: true,
       validation: {
@@ -88,6 +92,7 @@ export default defineModel({
     },
 
     userAgent: {
+      personal: true,
       required: false,
       fillable: true,
       validation: {

package/app/Models/CommunicationSuppression.ts

@@ -6,13 +6,14 @@ export default defineModel({
   table: 'communication_suppressions',
   belongsTo: ['Team'],
   traits: {
+    gdpr: { subject: { email: 'recipient' }, erasure: 'keep', basis: 'legal_obligation', purpose: 'Honouring opt-outs, which needs the address it suppresses' },
     useUuid: true,
     useTimestamps: true,
     useApi: { uri: 'communication-suppressions', routes: ['index', 'store', 'show', 'destroy'], middleware: ['auth', 'team'] },
   },
   indexes: [{ name: 'communication_suppressions_unique', columns: ['team_id', 'channel', 'recipient'], unique: true }],
   attributes: {
-    recipient: { required: true, fillable: true, validation: { rule: schema.string().max(255) }, factory: faker => faker.internet.email() },
+    recipient: { personal: true, required: true, fillable: true, validation: { rule: schema.string().max(255) }, factory: faker => faker.internet.email() },
     channel: { required: true, fillable: true, validation: { rule: schema.enum(['email', 'sms', 'push']) }, factory: () => 'email' },
     reason: { required: true, fillable: true, validation: { rule: schema.enum(['unsubscribe', 'bounce', 'complaint', 'carrier', 'manual', 'legal']) }, factory: () => 'unsubscribe' },
     source: { required: true, fillable: true, validation: { rule: schema.string().max(120) }, factory: () => 'preference_center' },

package/app/Models/ConsentEvent.ts

@@ -6,6 +6,7 @@ export default defineModel({
   table: 'consent_events',
   belongsTo: ['Team'],
   traits: {
+    gdpr: { subject: { email: 'recipient' }, erasure: 'keep', basis: 'legal_obligation', purpose: 'Proof of consent and its withdrawal (Article 7(1))' },
     useUuid: true,
     useTimestamps: true,
     useApi: { uri: 'consent-events', routes: ['index', 'show'], middleware: ['auth', 'team'] },
@@ -15,7 +16,7 @@ export default defineModel({
     { name: 'consent_events_lookup', columns: ['team_id', 'channel', 'recipient', 'occurred_at'] },
   ],
   attributes: {
-    recipient: { required: true, fillable: true, validation: { rule: schema.string().max(255) }, factory: faker => faker.internet.email() },
+    recipient: { personal: true, required: true, fillable: true, validation: { rule: schema.string().max(255) }, factory: faker => faker.internet.email() },
     channel: { required: true, fillable: true, validation: { rule: schema.enum(['email', 'sms', 'push']) }, factory: () => 'email' },
     action: { required: true, fillable: true, validation: { rule: schema.enum(['requested', 'granted', 'revoked', 'confirmed', 'suppressed']) }, factory: () => 'granted' },
     purpose: { required: true, fillable: true, validation: { rule: schema.string().max(120) }, factory: () => 'marketing' },
@@ -23,8 +24,8 @@ export default defineModel({
     jurisdiction: { required: false, fillable: true, validation: { rule: schema.string().max(80) }, factory: () => null },
     policyVersion: { required: true, fillable: true, validation: { rule: schema.string().max(40) }, factory: () => '1.0' },
     idempotencyKey: { required: false, fillable: true, validation: { rule: schema.string().max(255) }, factory: faker => faker.string.uuid() },
-    proof: { required: false, fillable: true, validation: { rule: schema.json() }, factory: () => JSON.stringify({}) },
-    ipAddress: { required: false, fillable: true, validation: { rule: schema.string().max(45) }, factory: faker => faker.internet.ip() },
+    proof: { personal: true, required: false, fillable: true, validation: { rule: schema.json() }, factory: () => JSON.stringify({}) },
+    ipAddress: { personal: true, required: false, fillable: true, validation: { rule: schema.string().max(45) }, factory: faker => faker.internet.ip() },
     occurredAt: { required: true, fillable: true, validation: { rule: schema.timestamp() }, factory: () => new Date().toISOString() },
   },
 } as const)

package/app/Models/Content/Author.ts

@@ -16,6 +16,7 @@ export default defineModel({
   ],
 
   traits: {
+    gdpr: { erasure: 'anonymize', basis: 'legitimate_interests', purpose: 'Byline on published content' },
     useAuth: {
       usePasskey: true,
     },
@@ -51,6 +52,7 @@ export default defineModel({
 
   attributes: {
     name: {
+      personal: true,
       order: 1,
       fillable: true,
       validation: {
@@ -65,6 +67,7 @@ export default defineModel({
     },
 
     email: {
+      personal: true,
       unique: true,
       order: 2,
       fillable: true,
@@ -79,6 +82,7 @@ export default defineModel({
     },
 
     bio: {
+      personal: true,
       required: false,
       order: 3,
       fillable: true,
@@ -92,6 +96,7 @@ export default defineModel({
     },
 
     avatar: {
+      personal: true,
       required: false,
       order: 4,
       fillable: true,

package/app/Models/EmailListSubscriber.ts

@@ -18,6 +18,7 @@ export default defineModel({
   belongsTo: ['EmailList', 'Subscriber'],
 
   traits: {
+    gdpr: { subject: { via: 'Subscriber' }, erasure: 'delete', basis: 'consent', purpose: 'Mailing list membership' },
     useUuid: true,
     useTimestamps: true,
     useApi: {

package/app/Models/EmailSuppression.ts

@@ -21,6 +21,7 @@ export default defineModel({
   ownership: false,
 
   traits: {
+    gdpr: { subject: { email: 'email' }, erasure: 'keep', basis: 'legal_obligation', purpose: 'Honouring bounces and complaints, which needs the address it suppresses' },
     useTimestamps: true,
     useApi: {
       uri: 'email-suppressions',
@@ -34,6 +35,7 @@ export default defineModel({
 
   attributes: {
     email: {
+      personal: true,
       required: true,
       fillable: true,
       validation: {

package/app/Models/Forms/FormSubmission.ts

@@ -18,6 +18,7 @@ export default defineModel({
   autoIncrement: true,
 
   traits: {
+    gdpr: { subject: { email: 'email' }, erasure: 'anonymize', basis: 'consent', purpose: 'Form submissions' },
     useUuid: true,
     useTimestamps: true,
   },
@@ -27,6 +28,7 @@ export default defineModel({
   attributes: {
     /** Validated { [fieldName]: value } JSON. Named data, not values - values is a SQL keyword. */
     data: {
+      personal: true,
       required: true,
       order: 1,
       fillable: true,
@@ -37,6 +39,7 @@ export default defineModel({
     },
 
     email: {
+      personal: true,
       required: false,
       order: 2,
       fillable: true,
@@ -47,6 +50,7 @@ export default defineModel({
     },
 
     name: {
+      personal: true,
       required: false,
       order: 3,
       fillable: true,
@@ -89,6 +93,7 @@ export default defineModel({
     },
 
     ip: {
+      personal: true,
       required: false,
       order: 7,
       fillable: true,

package/app/Models/GdprRequest.ts

@@ -0,0 +1,77 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+/**
+ * The ledger of data-subject requests (stacksjs/stacks#365).
+ *
+ * One row per access export, per erasure, and per retention run that changed
+ * something - written by `exportSubjectData`, `eraseSubject` and
+ * `pruneRetainedData`, inside the erasure's own transaction, so an erasure is
+ * recorded exactly when it happened. It is the answer to "when did we act on
+ * this request, and what did we do", which a regulator can ask and which the
+ * data itself can no longer answer once it is erased.
+ *
+ * It holds no personal data of its own: `summary` carries per-model counts,
+ * never values. `subject_id` has no foreign key on purpose - the user row it
+ * names may be anonymized or gone, and the record of having erased it must
+ * outlive it.
+ */
+export default defineModel({
+  name: 'GdprRequest',
+  table: 'gdpr_requests',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  indexes: [
+    { name: 'gdpr_requests_subject_lookup', columns: ['subject_id', 'type', 'occurred_at'] },
+  ],
+
+  // System-written; there is no caller whose rows these are, and no API.
+  ownership: false,
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+    gdpr: { subject: 'subject_id', erasure: 'keep', basis: 'legal_obligation', purpose: 'Record of the data-subject requests acted on' },
+  },
+
+  attributes: {
+    type: {
+      required: true,
+      fillable: true,
+      validation: { rule: schema.enum(['access', 'erasure', 'retention']) },
+      factory: () => 'access',
+    },
+    subjectId: {
+      required: false,
+      fillable: true,
+      validation: { rule: schema.number().integer().min(1) },
+      factory: () => 1,
+    },
+    actor: {
+      required: false,
+      fillable: true,
+      validation: { rule: schema.string().max(120) },
+      factory: () => 'cli',
+    },
+    status: {
+      required: true,
+      fillable: true,
+      default: 'completed',
+      validation: { rule: schema.enum(['completed', 'failed']) },
+      factory: () => 'completed',
+    },
+    summary: {
+      required: false,
+      fillable: true,
+      validation: { rule: schema.json() },
+      factory: () => JSON.stringify({}),
+    },
+    occurredAt: {
+      required: true,
+      fillable: true,
+      validation: { rule: schema.timestamp() },
+      factory: () => new Date().toISOString(),
+    },
+  },
+} as const)

package/app/Models/MagicLinkToken.ts

@@ -24,6 +24,7 @@ export default defineModel({
   ],
 
   traits: {
+    gdpr: { erasure: 'delete', basis: 'contract', purpose: 'Passwordless sign-in links' },
     useTimestamps: true,
   },
 
@@ -31,6 +32,7 @@ export default defineModel({
 
   attributes: {
     email: {
+      personal: true,
       required: true,
       order: 1,
       fillable: true,

package/app/Models/Notification.ts

@@ -8,6 +8,7 @@ export default defineModel({
   autoIncrement: true,
 
   traits: {
+    gdpr: { erasure: 'delete', basis: 'contract', purpose: 'In-app notifications' },
     useUuid: true,
     useTimestamps: true,
     useSeeder: {
@@ -38,6 +39,7 @@ export default defineModel({
     },
 
     data: {
+      personal: true,
       type: 'text',
       required: true,
       fillable: true,

package/app/Models/NotificationDelivery.ts

@@ -8,6 +8,7 @@ export default defineModel({
   autoIncrement: true,
 
   traits: {
+    gdpr: { subject: 'user_id', erasure: 'delete', basis: 'contract', purpose: 'Notification delivery log' },
     useTimestamps: true,
     useSearch: {
       displayable: ['id', 'channel', 'recipient', 'subject', 'status', 'sentAt'],
@@ -41,6 +42,7 @@ export default defineModel({
     },
 
     recipient: {
+      personal: true,
       required: true,
       fillable: true,
       validation: {
@@ -49,6 +51,7 @@ export default defineModel({
     },
 
     subject: {
+      personal: true,
       required: false,
       fillable: true,
       validation: {
@@ -57,6 +60,7 @@ export default defineModel({
     },
 
     body: {
+      personal: true,
       required: true,
       fillable: true,
       validation: {

package/app/Models/PaymentMethod.ts

@@ -11,6 +11,7 @@ export default defineModel({
   belongsTo: ['User'],
   hasMany: ['PaymentTransaction'],
   traits: {
+    gdpr: { erasure: 'anonymize', basis: 'contract', purpose: 'Saved payment methods' },
     useSeeder: {
       count: 5,
     },
@@ -31,6 +32,7 @@ export default defineModel({
     },
 
     lastFour: {
+      personal: true,
       fillable: true,
       validation: {
         rule: schema.number().required(),
@@ -43,6 +45,7 @@ export default defineModel({
     },
 
     brand: {
+      personal: true,
       fillable: true,
       validation: {
         rule: schema.string().required().max(50),
@@ -55,6 +58,7 @@ export default defineModel({
     },
 
     expMonth: {
+      personal: true,
       fillable: true,
       validation: {
         rule: schema.number().required(),
@@ -67,6 +71,7 @@ export default defineModel({
     },
 
     expYear: {
+      personal: true,
       fillable: true,
       validation: {
         rule: schema.number().required(),

package/app/Models/PaymentTransaction.ts

@@ -10,6 +10,7 @@ export default defineModel({
   autoIncrement: true, // defaults to true
   belongsTo: ['User', 'PaymentMethod'],
   traits: {
+    gdpr: { erasure: 'keep', basis: 'legal_obligation', purpose: 'Billing records' },
     useUuid: true,
     useSeeder: {
       count: 5,

package/app/Models/PersonalAccessToken.ts

@@ -27,6 +27,7 @@ export default defineModel({
   autoIncrement: true,
 
   traits: {
+    gdpr: { subject: { column: 'tokenable_id', where: { tokenable_type: 'users' } }, erasure: 'anonymize', basis: 'contract', purpose: 'API tokens, revoked on erasure' },
     useTimestamps: true,
     // Deliberately no `useApi`.
     //
@@ -136,6 +137,7 @@ export default defineModel({
      * nothing authorises on either.
      */
     userAgent: {
+      personal: true,
       order: 8,
       fillable: true,
       validation: {
@@ -144,6 +146,7 @@ export default defineModel({
     },
 
     ipAddress: {
+      personal: true,
       order: 9,
       fillable: true,
       validation: {

package/app/Models/Referral.ts

@@ -4,7 +4,10 @@ import { schema } from '@stacksjs/validation'
 export default defineModel({
   name: 'Referral',
   table: 'referrals',
-  traits: { useTimestamps: true },
+  traits: {
+    useTimestamps: true,
+    gdpr: { subject: ['referrer_id', 'referred_user_id'], erasure: 'keep', basis: 'contract', purpose: 'Referral rewards owed' },
+  },
   indexes: [{ name: 'referrals_referrer_status', columns: ['referrer_id', 'status'] }],
   attributes: {
     referrerId: { required: true, validation: { rule: schema.number().integer().min(1) } },

package/app/Models/ReferralCode.ts

@@ -4,7 +4,10 @@ import { schema } from '@stacksjs/validation'
 export default defineModel({
   name: 'ReferralCode',
   table: 'referral_codes',
-  traits: { useTimestamps: true },
+  traits: {
+    useTimestamps: true,
+    gdpr: { subject: 'user_id', erasure: 'delete', basis: 'contract', purpose: 'Referral codes' },
+  },
   attributes: {
     userId: { required: true, unique: true, validation: { rule: schema.number().integer().min(1) } },
     code: { required: true, unique: true, validation: { rule: schema.string().max(24) } },

package/app/Models/Request.ts

@@ -28,6 +28,7 @@ export default defineModel({
   ownership: false,
 
   traits: {
+    gdpr: { basis: 'legitimate_interests', purpose: 'Request log for debugging and abuse prevention' },
     useTimestamps: true,
     useSoftDeletes: true,
     useSeeder: {
@@ -93,6 +94,7 @@ export default defineModel({
     },
 
     ip_address: {
+      personal: true,
       fillable: true,
       validation: {
         rule: schema.string(),
@@ -117,6 +119,7 @@ export default defineModel({
     },
 
     user_agent: {
+      personal: true,
       fillable: true,
       validation: {
         rule: schema.string(),

package/app/Models/SmsOptOut.ts

@@ -22,12 +22,14 @@ export default defineModel({
   ],
 
   traits: {
+    gdpr: { erasure: 'keep', basis: 'legal_obligation', purpose: 'Honouring SMS STOP replies, keyed by phone number' },
     useTimestamps: true,
   },
 
   attributes: {
     /** E.164 where derivable (`+13105550199`). */
     phone: {
+      personal: true,
       required: true,
       order: 1,
       fillable: true,

package/app/Models/SocialAccount.ts

@@ -33,6 +33,7 @@ export default defineModel({
   ],
 
   traits: {
+    gdpr: { erasure: 'delete', basis: 'contract', purpose: 'Linked sign-in providers' },
     useTimestamps: true,
   },
 
@@ -49,6 +50,7 @@ export default defineModel({
     },
 
     providerUserId: {
+      personal: true,
       required: true,
       fillable: true,
       validation: {
@@ -60,6 +62,7 @@ export default defineModel({
     // The address the provider reported at link time. Informational — sign-in
     // resolves through (provider, provider_user_id), never through this.
     providerEmail: {
+      personal: true,
       fillable: true,
       validation: {
         rule: schema.string().max(255),

package/app/Models/SocialPost.ts

@@ -8,6 +8,7 @@ export default defineModel({
   autoIncrement: true,
 
   traits: {
+    gdpr: { erasure: 'delete', basis: 'contract', purpose: 'Social posts the user scheduled' },
     useUuid: true,
     useTimestamps: true,
     useSeeder: {
@@ -31,6 +32,7 @@ export default defineModel({
 
   attributes: {
     content: {
+      personal: true,
       required: true,
       fillable: true,
       validation: {

package/app/Models/StorageItemTask.ts

@@ -5,7 +5,8 @@ import { schema } from '@stacksjs/validation'
  * One unit of background processing for one file (stacksjs/stacks#2578).
  *
  * The three things #245 asked for that could not happen inside a request -
- * image optimization, video transcode, AI tagging - share the same shape:
+ * image optimization, video transcode, AI tagging - and the preview #308 asked
+ * for share the same shape:
  * dispatch work and show what happened to it. Transcoding is minutes, not
  * milliseconds; a vision call is a round trip to a third party. An upload
  * handler that waits for either is an upload handler that times out.
@@ -81,10 +82,11 @@ export default defineModel({
     kind: {
       order: 3,
       fillable: true,
-      // `optimize` (images), `transcode` (video), `tag` (AI). An enum rather
-      // than free text so a typo in a dispatch is a validation error instead of
-      // a task nothing will ever run.
-      validation: { rule: schema.enum(['optimize', 'transcode', 'tag']) },
+      // `optimize` (images), `transcode` (video), `tag` (AI), `preview` (the
+      // file manager's thumbnail, stacksjs/stacks#308). An enum rather than
+      // free text so a typo in a dispatch is a validation error instead of a
+      // task nothing will ever run.
+      validation: { rule: schema.enum(['optimize', 'transcode', 'tag', 'preview']) },
       factory: () => 'optimize',
     },
 
@@ -92,7 +94,10 @@ export default defineModel({
       order: 4,
       fillable: true,
       default: 'queued',
-      validation: { rule: schema.enum(['queued', 'running', 'done', 'failed']) },
+      // `skipped` is terminal and not a failure: the work does not apply to
+      // this file here - a PDF with no renderer to draw it - and `error`
+      // carries the reason, so the dashboard can say why.
+      validation: { rule: schema.enum(['queued', 'running', 'done', 'failed', 'skipped']) },
       factory: () => 'queued',
     },
 
@@ -109,8 +114,9 @@ export default defineModel({
     error: {
       order: 6,
       fillable: true,
-      // The failure as the worker saw it. Truncated by the writer rather than
-      // by the column, so a stack trace does not silently lose its first line.
+      // The failure as the worker saw it, or why a skipped task did not apply.
+      // Truncated by the writer rather than by the column, so a stack trace
+      // does not silently lose its first line.
       validation: { rule: schema.string().max(2000) },
       factory: () => '',
     },

package/app/Models/Subscriber.ts

@@ -10,6 +10,7 @@ export default defineModel({
   hasMany: ['SubscriberEmail', 'EmailListSubscriber', 'CampaignSend'],
 
   traits: {
+    gdpr: { subject: { email: 'email' }, erasure: 'anonymize', basis: 'consent', purpose: 'Newsletter subscription' },
     useUuid: true,
     useTimestamps: true,
     useSeeder: {
@@ -31,6 +32,7 @@ export default defineModel({
 
   attributes: {
     email: {
+      personal: true,
       unique: true,
       required: true,
       fillable: true,

package/app/Models/SubscriberEmail.ts

@@ -9,6 +9,7 @@ export default defineModel({
   belongsTo: ['Subscriber'],
 
   traits: {
+    gdpr: { subject: { via: 'Subscriber' }, erasure: 'delete', basis: 'consent', purpose: 'Newsletter subscription addresses' },
     useUuid: true,
     useTimestamps: true,
     useApi: {
@@ -24,6 +25,7 @@ export default defineModel({
 
   attributes: {
     email: {
+      personal: true,
       required: true,
       fillable: true,
       validation: {

package/app/Models/Subscription.ts

@@ -8,6 +8,7 @@ export default defineModel({
   autoIncrement: true, // defaults to true
   belongsTo: ['User'],
   traits: {
+    gdpr: { erasure: 'keep', basis: 'legal_obligation', purpose: 'Billing records' },
     useUuid: true,
   },
   attributes: {

package/app/Models/TeamInvitation.ts

@@ -34,6 +34,7 @@ export default defineModel({
   belongsTo: ['Team'],
 
   traits: {
+    gdpr: { subject: { email: 'email' }, erasure: 'delete', basis: 'contract', purpose: 'Team invitations' },
     useUuid: true,
     useTimestamps: true,
     useSeeder: { count: 0 },
@@ -60,6 +61,7 @@ export default defineModel({
     },
 
     email: {
+      personal: true,
       required: true,
       fillable: true,
       validation: {

package/app/Models/TeamMember.ts

@@ -30,6 +30,7 @@ export default defineModel({
   belongsTo: ['Team', 'User'],
 
   traits: {
+    gdpr: { erasure: 'delete', basis: 'contract', purpose: 'Team membership' },
     useUuid: true,
     useTimestamps: true,
     useSeeder: { count: 0 },