@stacksjs/orm 0.72.15 → 0.72.17

package/dist/models/NotificationDelivery.ts

@@ -0,0 +1,102 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+export default defineModel({
+  name: 'NotificationDelivery',
+  table: 'notification_deliveries',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  traits: {
+    useTimestamps: true,
+    useSearch: {
+      displayable: ['id', 'channel', 'recipient', 'subject', 'status', 'sentAt'],
+      searchable: ['recipient', 'subject', 'body', 'error'],
+      sortable: ['channel', 'recipient', 'status', 'sentAt', 'createdAt'],
+      filterable: ['channel', 'status'],
+    },
+    useApi: {
+      uri: 'notification-deliveries',
+      routes: ['index', 'show', 'destroy'],
+      middleware: ['auth'],
+    },
+  },
+
+  attributes: {
+    userId: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.number(),
+      },
+    },
+
+    channel: {
+      type: 'string',
+      required: true,
+      fillable: true,
+      validation: {
+        rule: schema.enum(['email', 'sms', 'chat', 'database', 'push', 'broadcast']),
+      },
+    },
+
+    recipient: {
+      required: true,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(1000),
+      },
+    },
+
+    subject: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(255),
+      },
+    },
+
+    body: {
+      required: true,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(10000),
+      },
+    },
+
+    status: {
+      type: 'string',
+      required: true,
+      fillable: true,
+      default: 'pending',
+      validation: {
+        rule: schema.enum(['pending', 'sent', 'delivered', 'failed']),
+      },
+    },
+
+    error: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(5000),
+      },
+    },
+
+    metadata: {
+      type: 'text',
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+    },
+
+    sentAt: {
+      required: false,
+      fillable: true,
+      validation: {
+        rule: schema.timestamp(),
+      },
+    },
+  },
+} as const)

package/dist/models/PaymentMethod.ts

@@ -0,0 +1,98 @@
+import { defineModel } from '@stacksjs/orm'
+import { collect } from '@stacksjs/collections'
+
+import { schema } from '@stacksjs/validation'
+
+export default defineModel({
+  name: 'PaymentMethod', // defaults to the sanitized file name
+  table: 'payment_methods', // defaults to the lowercase, plural name of the model name (or the name of the model file)
+  primaryKey: 'id', // defaults to `id`
+  autoIncrement: true, // defaults to true
+  belongsTo: ['User'],
+  hasMany: ['PaymentTransaction'],
+  traits: {
+    useSeeder: {
+      count: 5,
+    },
+    useUuid: true,
+  },
+  attributes: {
+    type: {
+      fillable: true,
+      validation: {
+        rule: schema.string().required().max(512),
+        message: {
+          string: 'type must be a string',
+          required: 'type is required',
+          max: 'type must have a maximum of 512 characters',
+        },
+      },
+      factory: () => 'card',
+    },
+
+    lastFour: {
+      fillable: true,
+      validation: {
+        rule: schema.number().required(),
+        message: {
+          number: 'last_four must be a number',
+          required: 'last_four is required',
+        },
+      },
+      factory: faker => faker.string.numeric(4),
+    },
+
+    brand: {
+      fillable: true,
+      validation: {
+        rule: schema.string().required().max(50),
+        message: {
+          number: 'brand must be a number',
+          required: 'brand is required',
+        },
+      },
+      factory: () => collect(['visa', 'mastercard', 'amex', 'jcb']).random().first(),
+    },
+
+    expMonth: {
+      fillable: true,
+      validation: {
+        rule: schema.number().required(),
+        message: {
+          string: 'exp_month must be a number',
+          required: 'exp_month is required',
+        },
+      },
+      factory: faker => faker.number.int({ min: 1, max: 12 }),
+    },
+
+    expYear: {
+      fillable: true,
+      validation: {
+        rule: schema.number().required(),
+        message: {
+          string: 'exp_year must be a number',
+          required: 'exp_year is required',
+        },
+      },
+      factory: faker => faker.number.int({ min: 2024, max: 2050 }),
+    },
+    isDefault: {
+      fillable: true,
+      validation: {
+        rule: schema.boolean(),
+      },
+    },
+    providerId: {
+      fillable: true,
+      validation: {
+        rule: schema.string().max(255),
+        message: {
+          string: 'provider_id must be a string',
+          required: 'provider_id is required',
+        },
+      },
+      factory: faker => faker.string.alphanumeric(10),
+    },
+  },
+} as const)

package/dist/models/PaymentProduct.ts

@@ -0,0 +1,91 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+export default defineModel({
+  name: 'PaymentProduct', // defaults to the sanitized file name
+  table: 'payment_products', // defaults to the lowercase, plural name of the model name (or the name of the model file)
+  primaryKey: 'id', // defaults to `id`
+  autoIncrement: true, // defaults to true
+  traits: {
+    useSeeder: {
+      count: 10,
+    },
+    useUuid: true,
+  },
+  attributes: {
+    name: {
+      fillable: true,
+      validation: {
+        rule: schema.string().required().max(512),
+        message: {
+          string: 'type must be a string',
+          required: 'type is required',
+          max: 'type must have a maximum of 512 characters',
+        },
+      },
+      factory: faker => faker.food.dish(),
+    },
+
+    description: {
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+        message: {
+          string: 'description must be a string',
+          required: 'description is required',
+        },
+      },
+      factory: faker => faker.lorem.lines(3),
+    },
+    key: {
+      fillable: true,
+      validation: {
+        rule: schema.string().required(),
+        message: {
+          string: 'key must be a string',
+          required: 'key is required',
+        },
+      },
+      factory: faker => faker.string.alphanumeric(5),
+    },
+
+    unitPrice: {
+      fillable: true,
+      validation: {
+        rule: schema.number().required(),
+        message: {
+          string: 'expires must be a string',
+          required: 'expires is required',
+        },
+      },
+      factory: faker => faker.number.int({ min: 1000, max: 10000 }),
+    },
+    status: {
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+      factory: faker => faker.lorem.lines(1),
+    },
+    image: {
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+        message: {
+          string: 'image must be a string',
+        },
+      },
+      factory: faker => faker.image.url(),
+    },
+    providerId: {
+      fillable: true,
+      validation: {
+        rule: schema.string().max(255),
+        message: {
+          string: 'provider_id must be a string',
+        },
+      },
+      factory: faker => faker.string.alphanumeric(10),
+    },
+  },
+} as const)

package/dist/models/PaymentTransaction.ts

@@ -0,0 +1,78 @@
+import { defineModel } from '@stacksjs/orm'
+import { collect } from '@stacksjs/collections'
+
+import { schema } from '@stacksjs/validation'
+
+export default defineModel({
+  name: 'PaymentTransaction', // defaults to the sanitized file name
+  table: 'payment_transactions', // defaults to the lowercase, plural name of the model name (or the name of the model file)
+  primaryKey: 'id', // defaults to `id`
+  autoIncrement: true, // defaults to true
+  belongsTo: ['User', 'PaymentMethod'],
+  traits: {
+    useUuid: true,
+    useSeeder: {
+      count: 5,
+    },
+  },
+  attributes: {
+    name: {
+      fillable: true,
+      validation: {
+        rule: schema.string().required().max(255),
+        message: {
+          string: 'name must be a string',
+          required: 'name is required',
+          max: 'name must have a maximum of 255 characters',
+        },
+      },
+      factory: () => 'Dashboard Subscription',
+    },
+
+    description: {
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+        message: {
+          string: 'description must be a string',
+        },
+      },
+      factory: faker => faker.lorem.lines(2),
+    },
+
+    amount: {
+      fillable: true,
+      validation: {
+        rule: schema.number().required(),
+        message: {
+          number: 'amount must be a number',
+          required: 'amount is required',
+        },
+      },
+      factory: faker => faker.number.int({ min: 1000, max: 10000 }),
+    },
+
+    type: {
+      fillable: true,
+      validation: {
+        rule: schema.string().required().max(50),
+        message: {
+          string: 'type must be a string',
+          max: 'type must have a maximum of 512 characters',
+        },
+      },
+      factory: () => collect(['one-time', 'subscription']).random().first(),
+    },
+    providerId: {
+      fillable: true,
+      validation: {
+        rule: schema.string().max(255),
+        message: {
+          string: 'provider_id must be a number',
+          required: 'provider_id is required',
+        },
+      },
+      factory: faker => faker.string.alphanumeric(10),
+    },
+  },
+} as const)

package/dist/models/QueryLog.ts

@@ -0,0 +1,182 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+export default defineModel({
+  name: 'QueryLog',
+  table: 'query_logs',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  indexes: [
+    {
+      name: 'query_logs_executed_at_index',
+      columns: ['executed_at'],
+    },
+    {
+      name: 'query_logs_status_index',
+      columns: ['status'],
+    },
+    {
+      name: 'query_logs_duration_index',
+      columns: ['duration'],
+    },
+  ],
+
+  traits: {
+    useTimestamps: true,
+    useApi: {
+      uri: 'query-logs',
+      routes: ['index', 'show'],
+      middleware: ['auth'],
+    },
+  },
+
+  attributes: {
+    query: {
+      required: true,
+      fillable: true,
+      type: 'text',
+      validation: {
+        rule: schema.string().required(),
+      },
+    },
+    normalized_query: {
+      fillable: true,
+      type: 'text',
+      validation: {
+        rule: schema.string(),
+      },
+    },
+    duration: {
+      fillable: true,
+      default: 0,
+      validation: {
+        rule: schema.number().min(0),
+      },
+    },
+    connection: {
+      fillable: true,
+      default: 'unknown',
+      validation: {
+        rule: schema.string().max(255),
+      },
+    },
+    status: {
+      fillable: true,
+      default: 'completed',
+      validation: {
+        rule: schema.enum(['completed', 'failed', 'slow']),
+      },
+    },
+    error: {
+      fillable: true,
+      type: 'text',
+      validation: {
+        rule: schema.string(),
+      },
+    },
+    executed_at: {
+      required: true,
+      fillable: true,
+      validation: {
+        rule: schema.string().required(),
+      },
+    },
+    bindings: {
+      hidden: true,
+      fillable: true,
+      type: 'text',
+      validation: {
+        rule: schema.string(),
+      },
+    },
+    trace: {
+      hidden: true,
+      fillable: true,
+      type: 'text',
+      validation: {
+        rule: schema.string(),
+      },
+    },
+    model: {
+      fillable: true,
+      validation: {
+        rule: schema.string().max(255),
+      },
+    },
+    method: {
+      fillable: true,
+      validation: {
+        rule: schema.string().max(255),
+      },
+    },
+    file: {
+      hidden: true,
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+    },
+    line: {
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+      },
+    },
+    memory_usage: {
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+      },
+    },
+    rows_affected: {
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+      },
+    },
+    transaction_id: {
+      fillable: true,
+      foreignKey: false,
+      validation: {
+        rule: schema.string().max(255),
+      },
+    },
+    tags: {
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+    },
+    affected_tables: {
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+    },
+    indexes_used: {
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+    },
+    missing_indexes: {
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+    },
+    explain_plan: {
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+    },
+    optimization_suggestions: {
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+    },
+  },
+} as const)

package/dist/models/README.md

@@ -0,0 +1,31 @@
+# What are Models
+
+Models are a way to define the structure of your data. They are used to interact with your database, and can be used to define relationships between different types of data.
+
+## Get Started
+
+The following command will bootstrap a new model in the `app/Models` directory.
+
+```sh
+buddy make:model User
+```
+
+## 🚜 Contributing
+
+Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
+
+## 🏝 Community
+
+For help, discussion about best practices, or any other conversation that would benefit from being searchable:
+
+[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
+
+For casual chit-chat with others using this package:
+
+[Join the Stacks Discord Server](https://stacksjs.com/discord)
+
+## 📄 License
+
+The MIT License (MIT). Please see [LICENSE](../../LICENSE.md) for more information.
+
+Made with 💙

package/dist/models/Release.ts

@@ -0,0 +1,90 @@
+import { defineModel } from '@stacksjs/orm'
+import { schema } from '@stacksjs/validation'
+
+export default defineModel({
+  name: 'Release',
+  table: 'releases',
+  primaryKey: 'id',
+  autoIncrement: true,
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+    useSearch: {
+      displayable: ['id', 'version', 'type', 'status', 'createdAt'],
+      searchable: ['version', 'type', 'notes'],
+      sortable: ['createdAt', 'version'],
+      filterable: ['type', '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'] },
+      uri: 'releases',
+      routes: ['index', 'show'],
+    },
+  },
+
+  attributes: {
+    version: {
+      order: 1,
+      fillable: true,
+      validation: {
+        rule: schema.string().required().max(50),
+      },
+      factory: faker => faker.system.semver(),
+    },
+
+    type: {
+      order: 2,
+      fillable: true,
+      validation: {
+        rule: schema.string().required(),
+      },
+      factory: faker => faker.helpers.arrayElement(['major', 'minor', 'patch']),
+    },
+
+    status: {
+      order: 3,
+      fillable: true,
+      validation: {
+        rule: schema.string().required(),
+      },
+      factory: faker => faker.helpers.arrayElement(['published', 'draft', 'scheduled']),
+    },
+
+    notes: {
+      order: 4,
+      fillable: true,
+      validation: {
+        rule: schema.string(),
+      },
+      factory: faker => faker.lorem.paragraph(),
+    },
+
+    downloads: {
+      order: 5,
+      fillable: true,
+      validation: {
+        rule: schema.number().min(0),
+      },
+      factory: faker => faker.number.int({ min: 0, max: 50000 }),
+    },
+
+    author: {
+      order: 6,
+      fillable: true,
+      validation: {
+        rule: schema.string().max(255),
+      },
+      factory: faker => faker.person.fullName(),
+    },
+  },
+
+  dashboard: {
+    highlight: true,
+  },
+} as const)