@stacksjs/types 0.70.22 → 0.70.25

package/src/index.ts

@@ -3,9 +3,13 @@ export * from './analytics'
 export * from './api'
 export * from './app'
 export * from './attributes'
+export * from './auth'
+export * from './oauth'
 export * from './auto-imports'
 export * from './binary'
-export * from './build'
+// `./build` removed — exposed `vite` / `vite-ssg` types we no longer use
+// (Stacks builds with Bun). The same applies to `./inspect`, `./pwa`,
+// `./ssg`, and `./layout` which all wrapped vite-* plugins.
 export * from './cache'
 export * from './cdn'
 export * from './chat'
@@ -14,6 +18,7 @@ export * from './cloud'
 export * from './components'
 export * from './configure'
 export * from './cron-jobs'
+export * from './dashboard'
 export * from './database'
 export * from './dependencies'
 export * from './deploy'
@@ -29,8 +34,6 @@ export * from './git'
 export * from './hashing'
 export * from './helpers'
 export * from './i18n'
-export * from './inspect'
-// export * from './layout'
 export * from './library'
 export * from './logging'
 export * from './manifest'
@@ -39,12 +42,13 @@ export * from './model-names'
 export * from './notifications'
 export * from './pages'
 export * from './payments'
+export * from './phone'
 export * from './ports'
 export * from './promise'
 export * from './push'
-export * from './pwa'
 export * from './queue'
 export * from './reactivity'
+export * from './realtime'
 export * from './request'
 export * from './response'
 export * from './router'
@@ -56,7 +60,7 @@ export * from './server'
 export * from './services'
 export * from './settings-config.ts'
 export * from './sms'
-export * from './ssg'
+export * from './stack-extensions'
 export * from './stacks'
 export * from './storage'
 export * from './table-names'

package/src/library.ts

@@ -64,11 +64,6 @@ export interface LibraryOptions {
    */
   defaultLanguage: LanguageCode
 
-  /**
-   * The Vue component library options.
-   */
-  vueComponents: LibraryBuildOptions
-
   /**
    * The Web Component library options.
    */

package/src/model-names.ts

@@ -1 +1 @@
-export type ModelNames = 'Project' | 'SubscriberEmail' | 'AccessToken' | 'Team' | 'Subscriber' | 'Deployment' | 'Release' | 'User' | 'Post' | 'Category' | 'Payment' | 'Driver' | 'WaitlistProduct' | 'DigitalDelivery' | 'Manufacturer' | 'OrderItem' | 'ShippingZone' | 'Customer' | 'Product' | 'ProductVariant' | 'LicenseKey' | 'WaitlistRestaurant' | 'Review' | 'ProductUnit' | 'GiftCard' | 'Order' | 'Coupon' | 'TaxRate' | 'Transaction' | 'LoyaltyPoint' | 'ProductItem' | 'LoyaltyReward' | 'ShippingMethod' | 'ShippingRate' | 'DeliveryRoute' | 'FailedJob' | 'PaymentMethod' | 'PaymentTransaction' | 'Request' | 'Job' | 'Subscription' | 'PaymentProduct' | 'Error'
+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,9 +1,16 @@
 import type { Faker } from '@stacksjs/faker'
+import type { ValidationType } from '@stacksjs/ts-validation'
 import type { ModelNames, TableNames } from '@stacksjs/types'
-import type { VineBoolean, VineNumber, VineString } from '@vinejs/vine'
-import type { DeepPartial, Nullable } from '.'
+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 {
@@ -51,6 +58,20 @@ export interface BaseHasOneThrough<T = 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
@@ -61,11 +82,13 @@ 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 AuthOptions {
+export interface UserAuthOptions {
   useTwoFactor?: boolean
   usePasskey?: boolean
 }
@@ -80,7 +103,8 @@ type Action = ActionPath | ActionName | undefined
 
 export type ApiRoutes = 'index' | 'show' | 'store' | 'update' | 'destroy'
 
-export type VineType = VineString | VineNumber | VineBoolean | Date | Nullable<any>
+export type SocialProviders = 'google' | 'github' | 'twitter' | 'facebook'
+
 export interface SeedOptions {
   count: number
 }
@@ -89,7 +113,7 @@ type LogAttribute = string
 
 interface ActivityLogOption {
   exclude: LogAttribute[]
-  include: LogAttribute[] // default to “*”
+  include: LogAttribute[] // default to "*"
   logOnly: LogAttribute[]
 }
 
@@ -100,6 +124,8 @@ export interface Relations {
   belongsToMany: BelongsToMany<ModelNames> | ModelNames[]
 }
 
+export type SocialOptions = SocialProviders[]
+
 export interface ApiSettings {
   uri: string
   middleware: string[]
@@ -143,6 +169,7 @@ export interface ModelOptions extends Base {
   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
   }
@@ -153,12 +180,15 @@ export interface ModelOptions extends Base {
     timestampable?: boolean | TimestampOptions // useTimestamps alias
     useSoftDeletes?: boolean | SoftDeleteOptions // defaults to false
     softDeletable?: boolean | SoftDeleteOptions // useSoftDeletes alias
-
-    useAuth?: boolean | AuthOptions // defaults to false
-    authenticatable?: boolean | AuthOptions // useAuth 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
     useSeeder?: boolean | SeedOptions // defaults to a count of 10
     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
@@ -181,12 +211,18 @@ export interface ModelOptions extends Base {
 
   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
   }
@@ -204,17 +240,21 @@ export interface Attribute {
   default?: string | number | boolean | Date
   unique?: boolean
   order?: number
-  required?: boolean
   hidden?: boolean
   fillable?: boolean
   guarded?: boolean
   factory?: (faker: Faker) => any
-  validation?: {
-    rule: VineType
+  validation: {
+    rule: ValidationType
     message?: ValidatorMessage
   }
 }
 
+export interface CompositeIndex {
+  name: string
+  columns: string[]
+}
+
 export interface AttributesElements {
   [key: string]: Attribute
 }
@@ -234,3 +274,46 @@ export interface RelationConfig {
   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>