chore: wip

Author: chrisbbreuer

.stacks/core/types/src/model.ts

@@ -3,7 +3,7 @@ import type {
   VineNumber as Number,
   VineString as String,
 } from '@vinejs/vine'
-import type { Nullable, SearchIndexSettings } from './'
+import type { Nullable, SearchEngineSettings } from './'
 
 export interface AuthOptions {}
 
@@ -36,10 +36,10 @@ export interface Model extends Base {
   }
   authenticatable?: boolean | AuthOptions
   seedable?: boolean | SeedOptions
-  searchable?: boolean | SearchIndexSettings
+  searchable?: boolean | SearchEngineSettings
   useSeed?: boolean | SeedOptions
-  useSearch?: boolean | SearchIndexSettings
-  useSearchEngine?: boolean | SearchIndexSettings
+  useSearch?: boolean | SearchEngineSettings
+  useSearchEngine?: boolean | SearchEngineSettings
   useTimestamps?: boolean | TimestampOptions
   // useSoftDeletes?: boolean | SoftDeleteOptions
 }

.stacks/core/types/src/search-engine.ts

@@ -1,4 +1,4 @@
-import type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, DocumentOptions as RecordOptions, Settings as SearchIndexSettings, SearchParams, SearchResponse } from 'meilisearch'
+import type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, DocumentOptions as RecordOptions, Settings as SearchEngineSettings, SearchParams, SearchResponse } from 'meilisearch'
 import type { MaybePromise } from '.'
 
 type Search = any
@@ -91,7 +91,7 @@ export interface SearchEngineDriver {
   getIndex: (name: string) => MaybePromise<Index>
   updateIndex?: (name: string, options: IndexOptions) => MaybePromise<EnqueuedTask>
   deleteIndex?: (name: string) => MaybePromise<EnqueuedTask>
-  updateIndexSettings: (name: string, settings: SearchIndexSettings) => MaybePromise<EnqueuedTask>
+  updateIndexSettings: (name: string, settings: SearchEngineSettings) => MaybePromise<EnqueuedTask>
   listAllIndexes: () => MaybePromise<IndexesResults<Index[]>>
   listAllIndices: () => MaybePromise<IndexesResults<Index[]>> // alternatives plural spelling
 
@@ -163,4 +163,4 @@ export interface SearchEngineStorage {
   currentPage: number
 }
 
-export type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, RecordOptions, SearchIndexSettings, SearchParams, SearchResponse }
+export type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, RecordOptions, SearchEngineSettings, SearchParams, SearchResponse }

app/models/User.ts

@@ -4,11 +4,11 @@ import { defineModel } from '@stacksjs/utils'
 
 export default defineModel({
   name: 'User', // defaults to the sanitized file name
-  table: 'users',
+  table: 'users', // defaults to the lowercase, plural name of the model
 
-  authenticatable: true, // boolean | AuthSettings (including TokenSettings)
-  searchable: true, // boolean | IndexSettings,
-  seedable: { // boolean | SeedSettings,
+  authenticatable: true, // defaults to false, also accepts AuthSettings or TokenSettings
+  searchable: true, // defaults to false, also accepts SearchEngineSettings
+  seedable: { // defaults to true & count of ten
     count: 10,
   },