@stacksjs/types 0.70.23 → 0.70.25

package/dist/src/i18n.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Vite plugin options for Vue I18n
+ */
+declare interface VitePluginVueI18nOptions {
+  forceStringify?: boolean
+  runtimeOnly?: boolean
+  compositionOnly?: boolean
+  fullInstall?: boolean
+  include?: string | string[]
+  defaultSFCLang?: 'json' | 'json5' | 'yml' | 'yaml'
+  globalSFCScope?: boolean
+  useVueI18nImportName?: boolean
+}
+/**
+ * **Internationalization Options**
+ *
+ * Configuration for the i18n system.
+ */
+export declare interface I18nOptions {
+  locale: string
+  fallbackLocale: string
+  availableLocales?: string[]
+  langDir?: string
+  messages?: Translations
+  warnMissing?: boolean
+  keySeparator?: string
+  pluralSeparator?: string
+  dateTimeFormats?: DateTimeFormats
+  numberFormats?: NumberFormats
+  vite?: VitePluginVueI18nOptions
+}
+/**
+ * Translation messages - can be nested objects or strings
+ */
+export type TranslationMessages = {
+  [key: string]: string | TranslationMessages
+}
+/**
+ * All translations keyed by locale
+ */
+export type Translations = {
+  [locale: string]: TranslationMessages
+}
+/**
+ * Date/time format configurations per locale
+ */
+export type DateTimeFormats = {
+  [locale: string]: {
+    [formatName: string]: Intl.DateTimeFormatOptions
+  }
+}
+/**
+ * Number format configurations per locale
+ */
+export type NumberFormats = {
+  [locale: string]: {
+    [formatName: string]: Intl.NumberFormatOptions
+  }
+}
+export type I18nConfig = Partial<I18nOptions>;
+/**
+ * Legacy alias
+ * @deprecated Use I18nOptions instead
+ */
+export type i18nOptions = VitePluginVueI18nOptions;

package/dist/src/index.d.ts

@@ -0,0 +1,70 @@
+export * from './ai';
+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';
+// `./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';
+export * from './cli';
+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';
+export * from './dns';
+export * from './docs';
+export * from './email';
+export * from './env';
+export * from './errors';
+export * from './events';
+export * from './exit-code';
+export * from './file-systems';
+export * from './git';
+export * from './hashing';
+export * from './helpers';
+export * from './i18n';
+export * from './library';
+export * from './logging';
+export * from './manifest';
+export * from './model';
+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 './queue';
+export * from './reactivity';
+export * from './realtime';
+export * from './request';
+export * from './response';
+export * from './router';
+export * from './saas';
+export * from './scheduler';
+export * from './search-engine';
+export * from './security';
+export * from './server';
+export * from './services';
+export * from './settings-config.ts';
+export * from './sms';
+export * from './stack-extensions';
+export * from './stacks';
+export * from './storage';
+export * from './table-names';
+export * from './tables';
+export * from './team';
+export * from './ui';
+export * from './utils';

package/dist/{library.d.ts → src/library.d.ts}

@@ -1,51 +1,47 @@
 import type { TagsOptions } from './components';
-
+/**
+ * **Library Options**
+ *
+ * This configuration defines all of your library 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 declare interface LibraryOptions {
   name: string
-
   owner: string | null
-
   packageRegistry: 'npm'
-
   repository: string
-
   license: LicenseType
-
   author: string
-
   contributors: string[]
-
   releaseable: boolean
-
   defaultLanguage: LanguageCode
-
-  vueComponents: LibraryBuildOptions
-
   webComponents: LibraryBuildOptions
-
   functions: LibraryBuildOptions
 }
-
-export type LibraryConfig = Partial<LibraryOptions>
-
-export interface LibraryBuildOptions {
+/**
+ * The list of available options to build your library.
+ */
+export declare interface LibraryBuildOptions {
   name: string
-
   description: string
-
   keywords: string[]
-
   shouldGenerateSourcemap?: boolean
-
-  files?: string[] 
-
+  files?: string[]
   tags?: TagsOptions
 }
-
-export type StackName = string
-
-export type LicenseType =
-  | 'CC-BY-NC-ND-2.0'
+export type LibraryConfig = Partial<LibraryOptions>;
+/**
+ * The name of your "Stack" which generally is your library name
+ * or a concatenation of your organization & library name.
+ */
+export type StackName = string;
+/**
+ * The list of accepted SPDX licenses.
+ * When developing OS packages, you may want to utilize an OSI approved license.
+ * @see https://opensource.org/licenses
+ */
+export type LicenseType = | 'CC-BY-NC-ND-2.0'
   | 'SGI-B-2.0'
   | 'LPPL-1.3c'
   | 'NIST-PD-fallback'
@@ -533,10 +529,12 @@ export type LicenseType =
   | 'Artistic-1.0-Perl'
   | 'BSD-2-Clause-Views'
   | 'Interbase-1.0'
-  | 'NPOSL-3.0'
-
-export type LanguageCode =
-  | 'aa'
+  | 'NPOSL-3.0';
+/**
+ * The list of accepted language codes.
+ * @see https://meta.wikimedia.org/wiki/Template:List_of_language_names_ordered_by_code
+ */
+export type LanguageCode = | 'aa'
   | 'ab'
   | 'af'
   | 'ak'
@@ -798,4 +796,4 @@ export type LanguageCode =
   | 'zh-classical'
   | 'zh-min-nan'
   | 'zh-yue'
-  | 'zu'
+  | 'zu';

package/dist/src/logging.d.ts

@@ -0,0 +1,12 @@
+/**
+ * **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 declare interface LoggingOptions {
+  logsPath: string
+  deploymentsPath: string
+}
+export type LoggingConfig = Partial<LoggingOptions>;

package/dist/{manifest.d.ts → src/manifest.d.ts}

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

package/dist/src/model-names.d.ts

@@ -0,0 +1 @@
+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/dist/src/model.d.ts

@@ -0,0 +1,251 @@
+import type { DeepPartial } from '.';
+import type { Faker } from '@stacksjs/faker';
+import type { ModelNames, TableNames } from '@stacksjs/types';
+import type { SearchOptions } from './search-engine';
+import type { ValidationType } from '@stacksjs/ts-validation';
+/**
+ * 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 declare function defineModel<const T extends Model>(model: T): T;
+/**
+ * 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 declare function defineModels<const T extends Record<string, Model>>(models: T): T;
+export declare interface BaseRelation {
+  foreignKey?: string
+  relationName?: string
+}
+export declare interface Relation<T = string> extends BaseRelation {
+  model: T
+}
+export declare interface HasOne<T = string> extends Array<Relation<T>> {}
+export declare interface MorphTo {
+  name: string
+}
+export declare interface MorphOne<T = string> extends BaseRelation {
+  model: T
+  morphName?: string
+  type?: string
+  id?: string
+}
+export declare interface MorphMany<T = string> extends MorphOne<T> {}
+export declare interface HasMany<T = string> extends Array<Relation<T>> {}
+export declare interface BelongsTo<T = string> extends Array<Relation<T>> {}
+export declare interface BelongsToMany<T = string> extends Array<BaseBelongsToMany<T> | T> {}
+export declare interface HasOneThrough<T = string> extends Array<BaseHasOneThrough<T> | T> {}
+export declare interface BaseBelongsToMany<T = string> {
+  model: T
+  firstForeignKey?: string
+  secondForeignKey?: string
+  pivotTable?: string
+}
+export declare interface BaseHasOneThrough<T = string> {
+  model: T
+  through: T
+  foreignKey?: string
+  throughForeignKey?: string
+  relationName?: string
+}
+export declare interface BaseHasManyThrough<T = string> {
+  model: T
+  through: T
+  foreignKey?: string
+  throughForeignKey?: string
+  relationName?: string
+}
+export declare interface HasManyThrough<T = string> extends Array<BaseHasManyThrough<T> | T> {}
+export declare interface MorphToMany<T = string> extends Array<T> {}
+export declare interface MorphedByMany<T = string> extends Array<T> {}
+export declare interface FieldArrayElement {
+  entity: string
+  charValue?: string | null
+}
+export declare interface ModelElement {
+  field: string
+  default: string | number | boolean | Date | undefined | null
+  unique: boolean
+  fillable: boolean
+  hidden: boolean
+  required: boolean
+  fieldArray: FieldArrayElement | null
+}
+export declare interface UserAuthOptions {
+  useTwoFactor?: boolean
+  usePasskey?: boolean
+}
+export declare interface LikeableOptions {
+  table?: string
+  foreignKey?: string
+}
+export declare interface SeedOptions {
+  count: number
+}
+declare interface ActivityLogOption {
+  exclude: LogAttribute[]
+  include: LogAttribute[]
+  logOnly: LogAttribute[]
+}
+export declare interface Relations {
+  hasOne: HasOne<ModelNames> | ModelNames[]
+  hasMany: HasMany<ModelNames> | ModelNames[]
+  belongsTo: BelongsTo<ModelNames> | ModelNames[]
+  belongsToMany: BelongsToMany<ModelNames> | ModelNames[]
+}
+export declare interface ApiSettings {
+  uri: string
+  middleware: string[]
+  routes:
+    | {
+      [key in ApiRoutes]: Action
+    }
+    | string[]
+  openApi: boolean
+}
+export declare interface TimestampOptions {
+  createdAt?: string
+  updatedAt?: string
+  deletedAt?: string
+}
+declare interface ValidatorMessage {
+  [key: string]: string
+}
+export declare interface SoftDeleteOptions {
+  deletedAt?: string
+}
+declare interface Base {}
+/**
+ * Model.
+ */
+export declare interface ModelOptions extends Base {
+  name: string
+  description?: string
+  table?: string
+  primaryKey?: string
+  autoIncrement?: boolean
+  indexes?: CompositeIndex[]
+  dashboard?: {
+    highlight?: boolean | number
+  }
+  traits?: {
+    useUuid?: boolean
+    useTimestamps?: boolean | TimestampOptions
+    timestampable?: boolean | TimestampOptions
+    useSoftDeletes?: boolean | SoftDeleteOptions
+    softDeletable?: boolean | SoftDeleteOptions
+    categorizable?: boolean
+    taggable?: boolean
+    commentables?: boolean
+    useAuth?: boolean | UserAuthOptions
+    authenticatable?: boolean | UserAuthOptions
+    useSeeder?: boolean | SeedOptions
+    seedable?: boolean | SeedOptions
+    useSearch?: boolean | SearchOptions
+    useSocials?: SocialOptions
+    searchable?: boolean | SearchOptions
+    useApi?: ApiOptions | boolean
+    observe?: string[] | boolean
+    billable?: boolean
+    useActivityLog?: boolean | ActivityLogOption
+    likeable?: boolean | LikeableOptions
+  }
+  attributes?: AttributesElements
+  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 declare interface Attribute {
+  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 declare interface CompositeIndex {
+  name: string
+  columns: string[]
+}
+export declare interface AttributesElements {
+  [key: string]: Attribute
+}
+export declare 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
+}
+/**
+ * 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>;
+declare type ActionPath = string;
+declare type ActionName = string;
+declare type Action = ActionPath | ActionName | undefined;
+export type ApiRoutes = 'index' | 'show' | 'store' | 'update' | 'destroy';
+export type SocialProviders = 'google' | 'github' | 'twitter' | 'facebook';
+declare type LogAttribute = string;
+export type SocialOptions = SocialProviders[];
+declare type ApiOptions = DeepPartial<ApiSettings>;
+/**
+ * Type alias for a collection of models
+ */
+export type ModelRecord = Record<string, Model>;

package/dist/{notifications.d.ts → src/notifications.d.ts}

@@ -1,6 +1,5 @@
 export declare interface NotificationOptions {
   default: 'email' | 'sms' | 'chat' | string
-
   email: {
     default:
       | 'emailjs'
@@ -13,12 +12,10 @@ export declare interface NotificationOptions {
       | 'sendgrid'
       | 'ses'
       | string
-
     from: {
       name: string
       address: string
     }
-
     drivers: {
       smtp: {
         host: string
@@ -29,12 +26,10 @@ export declare interface NotificationOptions {
           pass: string
         }
       }
-
       sendgrid: {
         key: string
         senderName: string
       }
-
       emailjs: {
         host: string
         user: string
@@ -42,26 +37,21 @@ export declare interface NotificationOptions {
         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
@@ -69,11 +59,9 @@ export declare interface NotificationOptions {
         port: number
         secure: boolean
       }
-
       postmark: {
         key: string
       }
-
       ses: {
         region: string
         key: string
@@ -81,71 +69,58 @@ export declare interface NotificationOptions {
       }
     }
   }
-
   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
       }
-
     }
   }
 }
-export declare type NotificationConfig = Partial<NotificationOptions>
+export type NotificationConfig = Partial<NotificationOptions>;