@stacksjs/types 0.68.2 → 0.69.2

package/src/model.ts

@@ -1,9 +1,41 @@
-import type { ModelNames } from '@stacksjs/types'
+import type { ModelNames, TableNames } from '@stacksjs/types'
 import type { VineBoolean, VineNumber, VineString } from '@vinejs/vine'
-import type { DeepPartial, Nullable, SearchOptions } from '.'
+import type { DeepPartial, Nullable } from '.'
+import type { SearchOptions } from './search-engine'
 
 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 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 FieldArrayElement {
   entity: string
   charValue?: string | null
@@ -21,6 +53,10 @@ export interface AuthOptions {
   useTwoFactor?: boolean
   usePasskey?: boolean
 }
+export interface LikeableOptions {
+  table?: string
+  foreignKey?: string
+}
 
 type ActionPath = string
 type ActionName = string
@@ -41,12 +77,11 @@ interface ActivityLogOption {
   logOnly: LogAttribute[]
 }
 
-interface BelongsToManyType {
-  model: ModelNames
-  firstForeignKey?: string
-  secondForeignKey?: string
-  pivotTable?: string
-  relationName?: string
+export interface Relations {
+  hasOne: HasOne<ModelNames> | ModelNames[]
+  hasMany: HasMany<ModelNames> | ModelNames[]
+  belongsTo: BelongsTo<ModelNames> | ModelNames[]
+  belongsToMany: BelongsToMany<ModelNames> | ModelNames[]
 }
 
 export interface ApiSettings {
@@ -112,40 +147,22 @@ export interface ModelOptions extends Base {
     observe?: string[] | boolean
     billable?: boolean
     useActivityLog?: boolean | ActivityLogOption
+
+    likeable?: boolean | LikeableOptions
   }
 
-  attributes?: Attributes
+  attributes?: AttributesElements
 
   // relationships
-  hasOne?:
-    | {
-      model: ModelNames
-      foreignKey?: string
-      relationName?: string
-    }[]
-    | string[]
-  hasMany?:
-    | {
-      model: ModelNames // should be typed as ModelName
-      foreignKey?: string
-      relationName?: string
-    }[]
-    | ModelNames[]
-  belongsTo?:
-    | {
-      model: ModelNames // should be typed as ModelName
-      foreignKey?: string
-      relationName?: string
-    }[]
-    | ModelNames[] // belongsTo: 'User'
-  belongsToMany?: BelongsToManyType[] | ModelNames[]
-  hasOneThrough?: {
-    model: ModelNames
-    through: ModelNames
-    foreignKey?: string
-    throughForeignKey?: string
-    relationName?: string
-  }[]
+  hasOne?: HasOne<ModelNames> | ModelNames[]
+
+  hasMany?: HasMany<ModelNames> | ModelNames[]
+
+  belongsTo?: BelongsTo<ModelNames> | ModelNames[]
+
+  belongsToMany?: BelongsToMany<ModelNames> | ModelNames[]
+
+  hasOneThrough?: HasOneThrough<ModelNames> | ModelNames[]
 
   scopes?: {
     [key: string]: (value: any) => any
@@ -167,28 +184,31 @@ export interface Attribute {
   required?: boolean
   hidden?: boolean
   fillable?: boolean
+  guarded?: boolean
   factory?: () => any
   validation?: {
     rule: VineType
-    message: ValidatorMessage
+    message?: ValidatorMessage
   }
   // validation?: String | Number | Boolean | Date
 }
 
-export interface Attributes {
+export interface AttributesElements {
   [key: string]: Attribute
 }
 
 export interface RelationConfig {
   relationship: string
   model: string
-  table: string
+  table: TableNames
   relationModel?: string
   relationTable?: string
   foreignKey: string
   modelKey: string
+  pivotKey?: string
+  pivotForeign?: string
   relationName?: string
   throughModel?: string
   throughForeignKey?: string
-  pivotTable: string
+  pivotTable: TableNames
 }

package/src/queue.ts

@@ -1,3 +1,4 @@
+import type { JobOptions } from './cron-jobs'
 import type { DeepPartial } from './utils'
 
 export interface QueueOptions {
@@ -35,4 +36,12 @@ export interface QueueOptions {
   }
 }
 
+export interface QueueOption extends JobOptions {
+  delay?: number
+  payload?: any
+  afterResponse?: any
+  context?: string
+  maxTries?: number
+}
+
 export type QueueConfig = DeepPartial<QueueOptions>

package/src/request.ts

@@ -41,6 +41,8 @@ export interface RequestInstance {
 
   getParam: (key: string) => number | string | null
 
+  route: (key: string) => number | string | null
+
   getParams: () => RouteParams
 
   getParamAsInt: (key: string) => number | null

package/src/response.ts

@@ -0,0 +1,16 @@
+export interface ResponseInstance {
+  json: (data: any, status?: number) => ResponseData
+  success: (data: any) => ResponseData
+  created: (data: any) => ResponseData
+  noContent: () => ResponseData
+  error: (message: string, status: number) => ResponseData
+  forbidden: (message: string) => ResponseData
+  unauthorized: (message: string) => ResponseData
+  notFound: (message: string) => ResponseData
+}
+
+export interface ResponseData {
+  status: number
+  headers: { [key: string]: string }
+  body: string
+}

package/src/saas.ts

@@ -5,7 +5,7 @@ export interface SaasOption {
     pricing: {
       key: string
       price: number
-      interval: 'day' | 'month' | 'week' | 'year'
+      interval?: 'day' | 'month' | 'week' | 'year' // Optional interval
       currency: string
     }[]
     metadata: {

package/src/search-engine.ts

@@ -1,28 +1,35 @@
 import type {
+  Dictionary,
+  DocumentOptions,
   EnqueuedTask,
+  Faceting,
   Hits,
   Index,
   IndexesResults,
   IndexOptions,
   MeiliSearch,
   Settings as MeilisearchOptions,
+  PaginationSettings,
   DocumentOptions as RecordOptions,
   SearchParams,
   SearchResponse,
+  Settings,
+  Synonyms,
+  TypoTolerance,
 } from 'meilisearch'
 import type { MaybePromise } from '.'
 
-type Search = any
-type Page = any
-type Pages = Page[]
-type Filter = any
-type Filters = Filter[]
-type Result = any
-type Results = Result[]
-type SearchFilter = any
-type SearchFilters = SearchFilter[]
-type Sorts = any
-type Sort = any
+// type Search = any
+// type Page = any
+// type Pages = Page[]
+// type Filter = any
+// type Filters = Filter[]
+// type Result = any
+// type Results = Result[]
+// type SearchFilter = any
+// type SearchFilters = SearchFilter[]
+// type Sorts = any
+// type Sort = any
 
 export interface SearchEngineOptions {
   /**
@@ -48,6 +55,14 @@ export interface SearchEngineOptions {
     auth: string
   }
 
+  meilisearch?: {
+    host: string
+    protocol: number
+    port: number
+    auth: string
+    apiKey: string
+  }
+
   filters?: {
     [key: string]: string
   }
@@ -63,50 +78,93 @@ export interface SearchEngineOptions {
 export type SearchEngineConfig = Partial<SearchEngineOptions>
 
 export interface SearchEngineDriver {
-  client: MeiliSearch
+  client: () => MeiliSearch
+
+  search: (index: string, params: any) => Promise<SearchResponse<Record<string, any>>>
 
   // Indexes
   createIndex: (name: string, options?: IndexOptions) => MaybePromise<EnqueuedTask>
-  getIndex: (name: string) => MaybePromise<Index>
+  getIndex: (name: string) => Promise<Index<Record<string, any>>>
+  addDocument: (indexName: string, params: any) => Promise<EnqueuedTask>
+  updateDocuments: (indexName: string, params: DocumentOptions[]) => Promise<EnqueuedTask>
+  updateDocument: (indexName: string, params: DocumentOptions) => Promise<EnqueuedTask>
+  addDocuments: (indexName: string, params: any[]) => Promise<EnqueuedTask>
+  getDocument: (indexName: string, id: number, fields: any) => Promise<EnqueuedTask>
+  deleteDocument: (indexName: string, id: number) => Promise<EnqueuedTask>
+  deleteDocuments: (indexName: string, filters: string | string[]) => Promise<EnqueuedTask>
   updateIndex: (name: string, options: IndexOptions) => MaybePromise<EnqueuedTask>
   deleteIndex: (name: string) => MaybePromise<EnqueuedTask>
-  updateIndexSettings: (name: string, settings: SearchEngineOptions) => MaybePromise<EnqueuedTask>
   listAllIndexes: () => MaybePromise<IndexesResults<Index[]>>
   listAllIndices: () => MaybePromise<IndexesResults<Index[]>> // alternatives plural spelling
 
-  // Records (MeiliSearch uses the term "documents")
-  getRecord: (key: string) => MaybePromise<any>
-  getRecords: (key: string) => MaybePromise<RecordOptions>
-  createRecord: (record: any, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>
-  createRecords: (records: any, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>
-  createOrReplaceRecord: (record: any, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>
-  createOrUpdateRecord: (record: any, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>
-  deleteRecord: (recordId: string | number, indexName: string) => MaybePromise<EnqueuedTask>
-  deleteAllRecords: (indexName: string) => MaybePromise<EnqueuedTask>
-  batchDeleteRecords: (recordIds: string[] | number[], indexName: string) => MaybePromise<EnqueuedTask>
+  getFilterableAttributes: (index: string) => Promise<string[]>
+  updateFilterableAttributes: (index: string, filterableAttributes: string[] | null) => Promise<EnqueuedTask>
+  resetFilterableAttributes: (index: string) => Promise<EnqueuedTask>
+
+  updateSearchableAttributes: (index: string, searchableAttributes: string[] | null) => Promise<EnqueuedTask>
+  resetSearchableAttributes: (index: string) => Promise<EnqueuedTask>
+  getSearchableAttributes: (index: string) => Promise<string[]>
+
+  updateSortableAttributes: (index: string, sortableAttributes: string[] | null) => Promise<EnqueuedTask>
+  resetSortableAttributes: (index: string) => Promise<EnqueuedTask>
+  getSortableAttributes: (index: string) => Promise<string[]>
+
+  updateDisplayedAttributes: (index: string, displayedAttributes: string[] | null) => Promise<EnqueuedTask>
+  getDisplayedAttributes: (index: string) => Promise<string[]>
+  resetDisplayedAttributes: (index: string) => Promise<EnqueuedTask>
+
+  getSettings: (index: string) => Promise<Settings>
+  updateSettings: (index: string, settings: Settings) => Promise<EnqueuedTask>
+  resetSettings: (index: string) => Promise<EnqueuedTask>
+  å
+  getPagination: (index: string) => Promise<PaginationSettings>
+  updatePagination: (index: string, pagination: PaginationSettings) => Promise<EnqueuedTask>
+  resetPagination: (index: string) => Promise<EnqueuedTask>
+
+  getSynonyms: (index: string) => Promise<any>
+  updateSynonyms: (index: string, synonyms: Synonyms) => Promise<EnqueuedTask>
+  resetSynonyms: (index: string) => Promise<EnqueuedTask>
+
+  getRankingRules: (index: string) => Promise<string[]>
+  updateRankingRules: (index: string, rankingRules: string[] | null) => Promise<EnqueuedTask>
+  resetRankingRules: (index: string) => Promise<EnqueuedTask>
+
+  getDistinctAttribute: (index: string) => Promise<string | null>
+  updateDistinctAttribute: (index: string, distinctAttribute: string | null) => Promise<EnqueuedTask>
+  resetDistinctAttribute: (index: string) => Promise<EnqueuedTask>
+
+  getFaceting: (index: string) => Promise<Faceting>
+  updateFaceting: (index: string, faceting: Faceting) => Promise<EnqueuedTask>
+  resetFaceting: (index: string) => Promise<EnqueuedTask>
+
+  getTypoTolerance: (index: string) => Promise<TypoTolerance>
+  updateTypoTolerance: (index: string, typoTolerance: TypoTolerance | null) => Promise<EnqueuedTask>
+  resetTypoTolerance: (index: string) => Promise<EnqueuedTask>
+
+  getDictionary: (index: string) => Promise<Dictionary>
+  updateDictionary: (index: string, dictionary: Dictionary | null) => Promise<EnqueuedTask>
+  resetDictionary: (index: string) => Promise<EnqueuedTask>
 
   // Search
-  search: (query: string, indexName: string, options: SearchParams) => MaybePromise<Search>
-
-  calculatePagination: Pages
-  currentPage: Page
-  filterName: string
-  filters: Filters
-  goToNextPage: () => Page
-  goToPage: (pageNumber: number) => Page
-  goToPrevPage: () => Page
-  hits: Hits
-  index: Index
-  lastPage: Page
-  perPage: number
-  query: string
-  results: Results // SearchResponse
-  searchFilters: SearchFilters
-  searchParams: SearchParams
-  setTotalHits: number
-  sort: Sort
-  sorts: Sorts
-  totalPages: number
+  // calculatePagination: Pages
+  // currentPage: Page
+  // filterName: string
+  // filters: Filters
+  // goToNextPage: () => Page
+  // goToPage: (pageNumber: number) => Page
+  // goToPrevPage: () => Page
+  // hits: Hits
+  // index: Index
+  // lastPage: Page
+  // perPage: number
+  // query: string
+  // results: Results // SearchResponse
+  // searchFilters: SearchFilters
+  // searchParams: SearchParams
+  // setTotalHits: number
+  // sort: Sort
+  // sorts: Sorts
+  // totalPages: number
 }
 
 /**
@@ -141,6 +199,7 @@ export interface SearchEngineStorage {
 }
 
 export interface SearchOptions {
+  displayable: string[]
   searchable: string[]
   sortable: string[]
   filterable: string[]

package/src/table-names.ts

@@ -0,0 +1 @@
+export type TableNames = 'projects' | 'subscriber_emails' | 'personal_access_tokens' | 'team_users' | 'teams' | 'activities' | 'subscribers' | 'deployments' | 'releases' | 'team_users' | 'users' | 'posts' | 'failed_jobs' | 'products' | 'payment_methods' | 'transactions' | 'jobs' | 'subscriptions' | 'errors'

package/src/ui.ts

@@ -2,7 +2,7 @@ import type { UserConfig } from '@unocss/core'
 import type { UserShortcuts } from 'unocss'
 
 export type Font = 'inter' | 'mona' | 'hubot'
-export type Icon = 'heroicons'
+export type Icon = 'heroicons' | 'hugeicons'
 export type WebFontsProviders = 'google' | 'bunny' | 'fontshare'
 export type Shortcuts = UserShortcuts
 
@@ -149,7 +149,7 @@ export interface UiOptions {
    * are displayed utilizing a technique called "icons in pure css."
    * Learn more here https://antfu.me/posts/icons-in-pure-css.
    *
-   * @see https://stacks.ow3.org/config/icons — list of available icon sets
+   * @see https://stacksjs.org/config/icons — list of available icon sets
    * @todo implement this into Vite build flow
    * @example
    * ```ts