@stacksjs/types 0.70.85 → 0.70.87

package/src/logging.ts

@@ -1,62 +0,0 @@
-/**
- * **Logging Options**
- *
- * This configuration defines all of your logging options. Because Stacks is fully-typed, you
- * may hover any of the options below and the definitions will be provided. In case you
- * have any questions, feel free to reach out via Discord or GitHub Discussions.
- */
-export interface LoggingOptions {
-  /**
-   * **Log File Path**
-   *
-   * The path to the log file. This will be used to write logs to a file. If you do not want to
-   * write logs to a file, you may set this to `null`.
-   *
-   * @default 'storage/logs/console.log'
-   */
-  logsPath: string
-
-  /**
-   * **Deployments Path**
-   *
-   * The path to the deployments folder. This will be used to write deployment logs to a file.
-   * If you do not want to write deployment logs to a file, you may set this to `null`.
-   *
-   * @default 'storage/logs/deployments.log'
-   */
-  deploymentsPath: string
-
-  /**
-   * **Minimum Log Level**
-   *
-   * Messages below this level are suppressed. The `LOG_LEVEL` env var
-   * overrides this when set (stacksjs/stacks#1935).
-   *
-   * @default 'info'
-   */
-  level?: 'debug' | 'info' | 'success' | 'warning' | 'error'
-
-  /**
-   * **Output Format**
-   *
-   * `'json'` for structured output (production), `'text'` for the
-   * human-readable dev view. The `LOG_FORMAT` env var overrides this;
-   * default is `'json'` in production, `'text'` otherwise.
-   *
-   * @default 'text'
-   */
-  format?: 'json' | 'text'
-
-  /**
-   * **Write To File**
-   *
-   * Whether logs are persisted to `logsPath`'s directory as daily
-   * files. Set `false` for console-only output (e.g. when the platform
-   * captures stdout).
-   *
-   * @default true
-   */
-  writeToFile?: boolean
-}
-
-export type LoggingConfig = Partial<LoggingOptions>

package/src/manifest.ts

@@ -1,9 +0,0 @@
-/**
- * The npm package manifest (package.json)
- */
-export interface Manifest {
-  name: string
-  version: string
-  description: string
-  [key: string]: unknown
-}

package/src/marketing.ts

@@ -1,14 +0,0 @@
-/**
- * **Marketing Options**
- *
- * Top-level feature gate for the marketing bundle (`/api/email/subscribe`,
- * `/api/contact`, Campaign / EmailList / SocialPost). Stays inert at boot
- * when `enabled` is `false`.
- */
-export interface MarketingOptions {
-  enabled?: boolean
-  /** Optional deploy-target gate, e.g. `['production']`. */
-  env?: string[]
-}
-
-export type MarketingConfig = Partial<MarketingOptions>

package/src/model-dashboard-augmentation.ts

@@ -1,51 +0,0 @@
-/**
- * Module augmentation that adds the Stacks-specific `dashboard` slot to
- * bun-query-builder's `BrowserModelDefinition`.
- *
- * Why this lives here (Stacks, not bqb):
- *
- *   The `dashboard` config is a Stacks framework concept — it influences
- *   how the model appears in `buddy dev --dashboard`'s sidebar. It has no
- *   meaning outside the dashboard surface, so adding it to bqb's core
- *   types would force every bqb consumer to carry weight they don't need.
- *
- * Declaration merging keeps the typing clean at every call site:
- *
- *   ```ts
- *   import { defineModel } from '@stacksjs/orm'
- *
- *   defineModel({
- *     name: 'AuditLog',
- *     dashboard: { section: 'management', roles: ['admin'] }, // ← typed
- *     attributes: { … },
- *   })
- *   ```
- *
- * Without this augmentation, the `dashboard` property would still pass
- * (because bqb's `defineModel<TDef extends BrowserModelDefinition>` uses
- * `extends`, which permits excess properties), but with no autocomplete
- * and no shape validation. The augmentation gives both.
- *
- * Loading note: this file only declares types — no runtime effects. It
- * must be reachable via `@stacksjs/types`' barrel so any package that
- * already imports from `@stacksjs/types` picks up the augmentation in
- * the same compilation. Re-exported from `index.ts`.
- */
-
-import type { DashboardModelOptions } from './dashboard'
-
-declare module 'bun-query-builder' {
-  interface BrowserModelDefinition {
-    /**
-     * Stacks dashboard sidebar configuration for this model.
-     * See {@link DashboardModelOptions} for the full shape.
-     *
-     * Omit to use defaults (model is shown under its auto-categorised
-     * section using `iconMap` + the model name).
-     */
-    readonly dashboard?: DashboardModelOptions
-  }
-}
-
-// Re-export for `import type { DashboardModelOptions } from '@stacksjs/types'`.
-export type { DashboardModelOptions }

package/src/model-names.ts

@@ -1 +0,0 @@
-export type ModelNames = 'Tag' | 'PaymentProduct' | 'FailedJob' | 'SocialPost' | 'PaymentMethod' | 'Campaign' | 'PaymentTransaction' | 'Request' | 'Activity' | 'EmailList' | 'Notification' | 'Job' | 'Log' | 'Subscription' | 'Error' | 'Comment' | 'User' | 'Websocket' | 'Page' | 'Author' | 'Post' | 'PrintDevice' | 'Category' | 'Payment' | 'Driver' | 'WaitlistProduct' | 'DigitalDelivery' | 'Manufacturer' | 'OrderItem' | 'ShippingZone' | 'Customer' | 'Product' | 'Receipt' | 'ProductVariant' | 'LicenseKey' | 'WaitlistRestaurant' | 'Review' | 'ProductUnit' | 'GiftCard' | 'Order' | 'Coupon' | 'TaxRate' | 'Transaction' | 'LoyaltyPoint' | 'LoyaltyReward' | 'ShippingMethod' | 'ShippingRate' | 'Cart' | 'DeliveryRoute' | 'CartItem'

package/src/model.ts

@@ -1,353 +0,0 @@
-import type { Faker } from '@stacksjs/faker'
-import type { ValidationType } from '@stacksjs/ts-validation'
-import type { ModelNames, TableNames } from '@stacksjs/types'
-import type { DeepPartial } from '.'
-import type { SearchOptions } from './search-engine'
-
-/**
- * Model definition type - compatible with bun-query-builder
- *
- * Models can be defined in app/Models/ (userland; overrides defaults by name)
- * or storage/framework/defaults/app/Models/ (framework defaults), and are used
- * to generate the ORM classes, migrations, and API routes.
- */
-export type Model = Partial<ModelOptions>
-
-export interface BaseRelation {
-  foreignKey?: string
-  relationName?: string
-}
-
-export interface Relation<T = string> extends BaseRelation {
-  model: T
-}
-
-export interface HasOne<T = string> extends Array<Relation<T>> {}
-
-export interface MorphTo {
-  name: string
-}
-
-export interface MorphOne<T = string> extends BaseRelation {
-  model: T
-  morphName?: string
-  type?: string
-  id?: string
-}
-
-export interface MorphMany<T = string> extends MorphOne<T> {}
-
-export interface HasMany<T = string> extends Array<Relation<T>> {}
-export interface BelongsTo<T = string> extends Array<Relation<T>> {}
-
-export interface BelongsToMany<T = string> extends Array<BaseBelongsToMany<T> | T> {}
-export interface HasOneThrough<T = string> extends Array<BaseHasOneThrough<T> | T> {}
-
-export interface BaseBelongsToMany<T = string> {
-  model: T
-  firstForeignKey?: string
-  secondForeignKey?: string
-  pivotTable?: string
-}
-
-export interface BaseHasOneThrough<T = string> {
-  model: T
-  through: T
-  foreignKey?: string
-  throughForeignKey?: string
-  relationName?: string
-}
-
-export interface BaseHasManyThrough<T = string> {
-  model: T
-  through: T
-  foreignKey?: string
-  throughForeignKey?: string
-  relationName?: string
-}
-
-export interface HasManyThrough<T = string> extends Array<BaseHasManyThrough<T> | T> {}
-
-export interface MorphToMany<T = string> extends Array<T> {}
-
-export interface MorphedByMany<T = string> extends Array<T> {}
-
-export interface FieldArrayElement {
-  entity: string
-  charValue?: string | null
-  // Add other properties as needed
-}
-
-export interface ModelElement {
-  field: string
-  default: string | number | boolean | Date | undefined | null
-  unique: boolean
-  fillable: boolean
-  hidden: boolean
-  required: boolean
-  fieldArray: FieldArrayElement | null
-}
-
-export interface UserAuthOptions {
-  useTwoFactor?: boolean
-  usePasskey?: boolean
-}
-export interface LikeableOptions {
-  table?: string
-  foreignKey?: string
-}
-
-type ActionPath = string
-type ActionName = string
-type Action = ActionPath | ActionName | undefined
-
-export type ApiRoutes = 'index' | 'show' | 'store' | 'update' | 'destroy'
-
-export type SocialProviders = 'google' | 'github' | 'apple' | 'twitter' | 'facebook'
-
-export interface SeedOptions {
-  count: number
-  /**
-   * Fixed rows merged over factory output for the first N entries (N = fixtures.length).
-   * Keys use model attribute names (camelCase); stored as snake_case columns.
-   */
-  fixtures?: Array<Record<string, unknown>>
-}
-
-type LogAttribute = string
-
-interface ActivityLogOption {
-  exclude: LogAttribute[]
-  include: LogAttribute[] // default to "*"
-  logOnly: LogAttribute[]
-}
-
-export interface Relations {
-  hasOne: HasOne<ModelNames> | ModelNames[]
-  hasMany: HasMany<ModelNames> | ModelNames[]
-  belongsTo: BelongsTo<ModelNames> | ModelNames[]
-  belongsToMany: BelongsToMany<ModelNames> | ModelNames[]
-}
-
-export type SocialOptions = SocialProviders[]
-
-export interface ApiSettings {
-  uri: string
-  middleware: string[]
-  routes:
-    | {
-      [key in ApiRoutes]: Action
-    }
-    | string[]
-  openApi: boolean
-}
-
-type ApiOptions = DeepPartial<ApiSettings>
-
-export interface TimestampOptions {
-  createdAt?: string // defaults to 'created_at'
-  updatedAt?: string
-  deletedAt?: string
-}
-
-interface ValidatorMessage {
-  [key: string]: string
-}
-
-export interface SoftDeleteOptions {
-  deletedAt?: string // defaults to 'deleted_at' & can be used for localized tables
-}
-
-interface Base {}
-
-/**
- * Model.
- */
-export interface ModelOptions extends Base {
-  /**
-   * The name of the model.
-   *
-   * @default string - The file name of the model.
-   */
-  name: string // defaults to the file name of the model
-  description?: string // defaults to the file name of the model
-  table?: string // defaults to the lowercase, plural name of the model name (or the name of the model file)
-  primaryKey?: string // defaults to `id`
-  autoIncrement?: boolean // defaults to true
-  indexes?: CompositeIndex[]
-  dashboard?: {
-    highlight?: boolean | number // defaults to undefined
-  }
-
-  traits?: {
-    useUuid?: boolean // defaults to false
-    useTimestamps?: boolean | TimestampOptions // defaults to true
-    timestampable?: boolean | TimestampOptions // useTimestamps alias
-    useSoftDeletes?: boolean | SoftDeleteOptions // defaults to false
-    softDeletable?: boolean | SoftDeleteOptions // useSoftDeletes alias
-    categorizable?: boolean // defaults to false
-    taggable?: boolean // defaults to false
-    commentables?: boolean // defaults to false
-    useAuth?: boolean | UserAuthOptions // defaults to false
-    authenticatable?: boolean | UserAuthOptions // useAuth alias
-    /**
-     * @deprecated stacksjs/stacks#1929 — the `useSeeder` trait only
-     * existed to drive the auto-walker, which is removed from
-     * `./buddy seed` (stacksjs/stacks#1919). Seeding is now owned by
-     * class seeders: a `database/seeders/<Model>Seeder.ts` file calling
-     * `factory.generate(Model, { count })`. Run `./buddy seed:scaffold`
-     * to codemod existing traits into seeder files (and strip the
-     * trait). This field is scheduled for removal in the next major.
-     */
-    useSeeder?: boolean | SeedOptions // defaults to a count of 10
-    /** @deprecated alias of {@link useSeeder} — see stacksjs/stacks#1929. */
-    seedable?: boolean | SeedOptions // useSeeder alias
-    useSearch?: boolean | SearchOptions // defaults to false
-    useSocials?: SocialOptions // defaults to false
-    searchable?: boolean | SearchOptions // useSearch alias
-    useApi?: ApiOptions | boolean
-    observe?: string[] | boolean
-    billable?: boolean
-    useActivityLog?: boolean | ActivityLogOption
-
-    likeable?: boolean | LikeableOptions
-  }
-
-  attributes?: AttributesElements
-
-  // relationships
-  hasOne?: HasOne<ModelNames> | ModelNames[]
-
-  hasMany?: HasMany<ModelNames> | ModelNames[]
-
-  belongsTo?: BelongsTo<ModelNames> | ModelNames[]
-
-  belongsToMany?: BelongsToMany<ModelNames> | ModelNames[]
-
-  hasOneThrough?: HasOneThrough<ModelNames> | ModelNames[]
-
-  hasManyThrough?: HasManyThrough<ModelNames> | ModelNames[]
-
-  morphOne?: MorphOne<ModelNames> | ModelNames
-
-  morphMany?: MorphMany<ModelNames>[] | ModelNames[]
-
-  morphTo?: MorphTo
-
-  morphToMany?: MorphToMany<ModelNames> | ModelNames[]
-
-  morphedByMany?: MorphedByMany<ModelNames> | ModelNames[]
-
-  scopes?: {
-    [key: string]: (value: any) => any
-  }
-
-  get?: {
-    [key: string]: (value: any) => any
-  }
-
-  set?: {
-    [key: string]: (value: any) => any
-  }
-}
-
-export interface Attribute {
-  type?: string
-  nullable?: boolean
-  default?: string | number | boolean | Date
-  unique?: boolean
-  order?: number
-  hidden?: boolean
-  fillable?: boolean
-  guarded?: boolean
-  factory?: (faker: Faker) => any
-  validation: {
-    rule: ValidationType
-    message?: ValidatorMessage
-  }
-}
-
-export interface CompositeIndex {
-  name: string
-  columns: string[]
-  /**
-   * Emit `UNIQUE` on the index — turns a multi-column index into a
-   * multi-column unique constraint. Combine with `where:` for a
-   * partial unique index (stacksjs/stacks#1943).
-   *
-   * @default false
-   */
-  unique?: boolean
-  /**
-   * Partial-index `WHERE` clause as a raw SQL expression — e.g.
-   * `'user_id IS NOT NULL'`. Lets the constraint apply to a subset of
-   * rows; the canonical case is "prevent a logged-in user from flagging
-   * the same review twice, but allow anonymous flags (user_id NULL) to
-   * repeat" (stacksjs/stacks#1943). Emitted verbatim, so don't
-   * interpolate untrusted input.
-   */
-  where?: string
-}
-
-export interface AttributesElements {
-  [key: string]: Attribute
-}
-
-export interface RelationConfig {
-  relationship: string
-  model: string
-  table: TableNames
-  relationModel?: string
-  relationTable?: string
-  foreignKey: string
-  modelKey: string
-  pivotKey?: string
-  pivotForeign?: string
-  relationName?: string
-  throughModel?: string
-  throughForeignKey?: string
-  pivotTable: TableNames
-}
-
-/**
- * Helper to define a model with proper type inference.
- * Compatible with bun-query-builder's defineModel pattern.
- *
- * @example
- * ```ts
- * export default defineModel({
- *   name: 'User',
- *   table: 'users',
- *   primaryKey: 'id',
- *   attributes: {
- *     name: { validation: { rule: schema.string() } },
- *     email: { validation: { rule: schema.string().email() }, unique: true },
- *   },
- *   traits: {
- *     useTimestamps: true,
- *     useApi: true,
- *   },
- * })
- * ```
- */
-export function defineModel<const T extends Model>(model: T): T {
-  return model
-}
-
-/**
- * Helper to define multiple models with proper type inference.
- * Useful for building a typed database schema.
- *
- * @example
- * ```ts
- * const models = defineModels({ User, Post, Comment })
- * ```
- */
-export function defineModels<const T extends Record<string, Model>>(models: T): T {
-  return models
-}
-
-/**
- * Type alias for a collection of models
- */
-export type ModelRecord = Record<string, Model>

package/src/monitoring.ts

@@ -1,14 +0,0 @@
-/**
- * **Monitoring Options**
- *
- * Top-level feature gate for the monitoring bundle (Error model +
- * error-tracking views and actions). Stays inert at boot when `enabled`
- * is `false`.
- */
-export interface MonitoringOptions {
-  enabled?: boolean
-  /** Optional deploy-target gate, e.g. `['production']`. */
-  env?: string[]
-}
-
-export type MonitoringConfig = Partial<MonitoringOptions>

package/src/notifications.ts

@@ -1,153 +0,0 @@
-export interface NotificationOptions {
-  default: 'email' | 'sms' | 'chat' | string
-
-  email: {
-    default:
-      | 'emailjs'
-      | 'mailgun'
-      | 'mailjet'
-      | 'mandrill'
-      | 'netcore'
-      | 'nodemailer'
-      | 'postmark'
-      | 'sendgrid'
-      | 'ses'
-      | string
-
-    from: {
-      name: string
-      address: string
-    }
-
-    drivers: {
-      smtp: {
-        host: string
-        port: number
-        secure: boolean
-        auth: {
-          user: string
-          pass: string
-        }
-      }
-
-      sendgrid: {
-        key: string
-        senderName: string
-      }
-
-      emailjs: {
-        host: string
-        user: string
-        password: string
-        port: number
-        secure: boolean
-      }
-
-      mailgun: {
-        key: string
-        domain: string
-        username: string
-      }
-
-      mailjet: {
-        key: string
-        secret: string
-      }
-
-      mandrill: {
-        key: string
-      }
-
-      netcore: {
-        key: string
-      }
-
-      nodemailer: {
-        host: string
-        user: string
-        password: string
-        port: number
-        secure: boolean
-      }
-
-      postmark: {
-        key: string
-      }
-
-      ses: {
-        region: string
-        key: string
-        secret: string
-      }
-    }
-  }
-
-  sms: {
-    default: 'twilio' | 'nexmo' | 'gupshup' | 'plivo' | 'sms77' | 'sns' | 'telnyx' | 'termii' | string
-    from: string
-
-    drivers: {
-      twilio: {
-        sid: string
-        authToken: string
-      }
-
-      nexmo: {
-        key: string
-        secret: string
-      }
-
-      gupshup: {
-        user: string
-        password: string
-      }
-
-      plivo: {
-        sid: string
-        authToken: string
-      }
-
-      sms77: {
-        key: string
-      }
-
-      sns: {
-        region: string
-        key: string
-        secret: string
-      }
-
-      telnyx: {
-        key: string
-        messageProfileId: string
-      }
-
-      termii: {
-        key: string
-      }
-    }
-  }
-
-  chat: {
-    default: 'slack' | 'msTeams' | 'discord' | string
-    from: string
-
-    drivers: {
-      slack?: {
-        appId: string
-        clientId: string
-        secret: string
-      }
-
-      msTeams?: {
-        appId: string
-        clientId: string
-        secret: string
-      }
-
-      // discord?: {}
-    }
-  }
-}
-
-export type NotificationConfig = Partial<NotificationOptions>