@stacksjs/types 0.64.6 → 0.65.0

package/src/errors.ts

@@ -7,55 +7,54 @@
 //   toString(): string
 // }
 
-// export type StacksError = Error
 export type CommandError = Error
 
 export interface ErrorOptions {
   messages: {
-    string: string
-    email: string
-    regex: string
-    url: string
-    activeUrl: string
-    alpha: string
-    alphaNumeric: string
-    minLength: string
-    maxLength: string
-    fixedLength: string
-    confirmed: string
-    endsWith: string
-    startsWith: string
-    sameAs: string
-    notSameAs: string
-    in: string
-    notIn: string
-    ipAddress: string
-    uuid: string
-    ascii: string
-    creditCard: string
-    hexCode: string
-    iban: string
-    jwt: string
-    coordinates: string
-    mobile: string
-    passport: string
-    postalCode: string
+    'string': string
+    'email': string
+    'regex': string
+    'url': string
+    'activeUrl': string
+    'alpha': string
+    'alphaNumeric': string
+    'minLength': string
+    'maxLength': string
+    'fixedLength': string
+    'confirmed': string
+    'endsWith': string
+    'startsWith': string
+    'sameAs': string
+    'notSameAs': string
+    'in': string
+    'notIn': string
+    'ipAddress': string
+    'uuid': string
+    'ascii': string
+    'creditCard': string
+    'hexCode': string
+    'iban': string
+    'jwt': string
+    'coordinates': string
+    'mobile': string
+    'passport': string
+    'postalCode': string
 
     // boolean
-    boolean: string
+    'boolean': string
 
     // number
-    number: string
-    min: string
-    max: string
-    range: string
-    positive: string
-    negative: string
-    decimal: string
-    withoutDecimals: string
+    'number': string
+    'min': string
+    'max': string
+    'range': string
+    'positive': string
+    'negative': string
+    'decimal': string
+    'withoutDecimals': string
 
     // date
-    date: string
+    'date': string
     'date.equals': string
     'date.after': string
     'date.before': string
@@ -66,38 +65,38 @@ export interface ErrorOptions {
     'date.afterField': string
 
     // accepted
-    accepted: string
+    'accepted': string
 
     // enum
-    enum: string
+    'enum': string
 
     // literal
-    literal: string
+    'literal': string
 
     // object
-    object: string
+    'object': string
 
     // record
-    record: string
+    'record': string
     'record.minLength': string
     'record.maxLength': string
     'record.fixedLength': string
 
     // array
-    array: string
+    'array': string
     'array.minLength': string
     'array.maxLength': string
     'array.fixedLength': string
-    notEmpty: string
-    distinct: string
+    'notEmpty': string
+    'distinct': string
 
     // tuple
-    tuple: string
+    'tuple': string
 
     // union
-    union: string
-    unionGroup: string
-    unionOfTypes: string
+    'union': string
+    'unionGroup': string
+    'unionOfTypes': string
   }
 }
 

package/src/git.ts

@@ -111,7 +111,7 @@ interface Hooks {
   'post-merge'?: string
   'pre-push'?: string
   'pre-receive'?: string
-  update?: string
+  'update'?: string
   'proc-receive'?: string
   'post-receive'?: string
   'post-update'?: string

package/src/helpers.ts

@@ -1,7 +1,8 @@
 import { toString } from '@stacksjs/strings'
 
-export function getTypeName(v: any) {
-  if (v === null) return 'null'
+export function getTypeName(v: any): string {
+  if (v === null)
+    return 'null'
   const type = toString(v).slice(8, -1).toLowerCase()
 
   return typeof v === 'object' || typeof v === 'function' ? type : typeof v

package/src/index.ts

@@ -18,14 +18,15 @@ export * from './dependencies'
 export * from './deploy'
 export * from './dns'
 export * from './docs'
-export * from './errors'
 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 './inspect'
 // export * from './layout'
@@ -39,24 +40,24 @@ export * from './pages'
 export * from './payments'
 export * from './ports'
 export * from './promise'
-export * from './pwa'
 export * from './push'
+export * from './pwa'
 export * from './queue'
-export * from './request'
 export * from './reactivity'
+export * from './request'
 export * from './router'
 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 './ssg'
-export * from './storage'
 export * from './stacks'
-export * from './team'
+export * from './storage'
 export * from './tables'
+export * from './team'
 export * from './ui'
-export * from './utils'
 
-export * from './helpers'
+export * from './utils'

package/src/model-names.ts

@@ -1,10 +1 @@
-export type ModelNames =
-  | 'Project'
-  | 'SubscriberEmail'
-  | 'AccessToken'
-  | 'Team'
-  | 'Subscriber'
-  | 'Deployment'
-  | 'Release'
-  | 'User'
-  | 'Post'
+export type ModelNames = 'Project' | 'SubscriberEmail' | 'AccessToken' | 'Team' | 'Subscriber' | 'Deployment' | 'Release' | 'User' | 'Post'

package/src/model.ts

@@ -4,13 +4,27 @@ import type { DeepPartial, Nullable, SearchOptions } from '.'
 
 export type Model = Partial<ModelOptions>
 
-export type AuthOptions = {
+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
+  fieldArray: FieldArrayElement | null
+}
+
+export interface AuthOptions {
   useTwoFactor?: boolean
+  usePasskey?: boolean
 }
 
 type ActionPath = string
 type ActionName = string
-type Action = ActionPath | ActionName
+type Action = ActionPath | ActionName | undefined
 
 export type ApiRoutes = 'index' | 'show' | 'store' | 'update' | 'destroy'
 
@@ -21,7 +35,7 @@ export interface SeedOptions {
 
 type LogAttribute = string
 
-type ActivityLogOption = {
+interface ActivityLogOption {
   exclude: LogAttribute[]
   include: LogAttribute[] // default to “*”
   logOnly: LogAttribute[]
@@ -38,9 +52,11 @@ interface BelongsToManyType {
 export interface ApiSettings {
   uri: string
   middleware: string[]
-  routes: {
-    [key in ApiRoutes]: Action
-  }
+  routes:
+    | {
+      [key in ApiRoutes]: Action
+    }
+    | string[]
   openApi: boolean
 }
 
@@ -60,7 +76,7 @@ export interface SoftDeleteOptions {
   deletedAt?: string // defaults to 'deleted_at' & can be used for localized tables
 }
 
-type Base = {}
+interface Base {}
 
 /**
  * Model.
@@ -102,24 +118,24 @@ export interface ModelOptions extends Base {
   // relationships
   hasOne?:
     | {
-        model: ModelNames
-        foreignKey?: string
-        relationName?: string
-      }[]
+      model: ModelNames
+      foreignKey?: string
+      relationName?: string
+    }[]
     | string[]
   hasMany?:
     | {
-        model: ModelNames // should be typed as ModelName
-        foreignKey?: string
-        relationName?: string
-      }[]
+      model: ModelNames // should be typed as ModelName
+      foreignKey?: string
+      relationName?: string
+    }[]
     | ModelNames[]
   belongsTo?:
     | {
-        model: ModelNames // should be typed as ModelName
-        foreignKey?: string
-        relationName?: string
-      }[]
+      model: ModelNames // should be typed as ModelName
+      foreignKey?: string
+      relationName?: string
+    }[]
     | ModelNames[] // belongsTo: 'User'
   belongsToMany?: BelongsToManyType[] | ModelNames[]
   hasOneThrough?: {

package/src/notifications.ts

@@ -145,11 +145,7 @@ export interface NotificationOptions {
         secret: string
       }
 
-      discord?: {
-        // appId: string
-        // clientId: string
-        // secret: string
-      }
+      // discord?: {}
     }
   }
 }

package/src/request.ts

@@ -1,7 +1,8 @@
 import type { VineType } from '@stacksjs/types'
 
+export type * from '../../../types/requests'
 interface RequestData {
-  [key: string]: string
+  [key: string]: any
 }
 
 type RouteParams = { [key: string]: string | number } | null
@@ -16,31 +17,31 @@ interface CustomAttributes {
 }
 
 export interface RequestInstance {
-  addQuery(url: URL): void
+  addQuery: (url: URL) => void
 
-  addBodies(params: any): void
+  addBodies: (params: any) => void
 
-  addParam(param: RouteParams): void
+  addParam: (param: RouteParams) => void
 
-  get(element: string): string | number | undefined
+  get: <T>(element: T) => string | undefined
 
-  header(element: string): string | number | boolean | null
+  header: (element: string) => string | number | boolean | null
 
-  Header(element: string): string | number | boolean | null
+  Header: (element: string) => string | number | boolean | null
 
-  all(): RequestData
+  all: () => RequestData
 
-  validate(attributes: CustomAttributes): void
+  validate: (attributes: CustomAttributes) => void
 
-  has(element: string): boolean
+  has: (element: string) => boolean
 
-  isEmpty(): boolean
+  isEmpty: () => boolean
 
-  extractParamsFromRoute(routePattern: string, pathname: string): void
+  extractParamsFromRoute: (routePattern: string, pathname: string) => void
 
-  getParam(key: string): number | string | null
+  getParam: (key: string) => number | string | null
 
-  getParams(): RouteParams
+  getParams: () => RouteParams
 
-  getParamAsInt(key: string): number | null
+  getParamAsInt: (key: string) => number | null
 }

package/src/router.ts

@@ -25,6 +25,7 @@ export interface MiddlewareOptions {
   name: string
   description?: string
   priority: number
+  // eslint-disable-next-line ts/no-unsafe-function-type
   handle: Function
 }
 

package/src/search-engine.ts

@@ -2,8 +2,8 @@ import type {
   EnqueuedTask,
   Hits,
   Index,
-  IndexOptions,
   IndexesResults,
+  IndexOptions,
   MeiliSearch,
   Settings as MeilisearchOptions,
   DocumentOptions as RecordOptions,
@@ -151,11 +151,11 @@ export type {
   EnqueuedTask,
   Hits,
   Index,
-  IndexOptions,
   IndexesResults,
+  IndexOptions,
   MeiliSearch,
-  RecordOptions,
   MeilisearchOptions,
+  RecordOptions,
   SearchParams,
   SearchResponse,
 }

package/src/server.ts

@@ -0,0 +1,16 @@
+export interface ServerOptions {
+  type?:
+    | 'frontend'
+    | 'backend'
+    | 'api'
+    | 'library'
+    | 'desktop'
+    | 'docs'
+    | 'email'
+    | 'admin'
+    | 'system-tray'
+    | 'database'
+  host?: string
+  port?: number
+  open?: boolean
+}

package/src/settings-config.ts

@@ -1,10 +1,10 @@
-export type SettingsMenuOption = {
+export interface SettingsMenuOption {
   label: string
   path: string
   icon?: MenuIcon
 }
 
-export type MenuIcon = {
+export interface MenuIcon {
   name?: string
   source?: string
 }

package/src/stacks.ts

@@ -1,7 +1,6 @@
 import type {
   AiConfig,
   AnalyticsConfig,
-  ApiConfig,
   AppConfig,
   BinaryConfig,
   CacheConfig,