chore: wip

Author: glennmichael123

app/Models/User.ts

@@ -17,8 +17,8 @@ export default {
     },
     useTimestamps: true, // defaults to true, `timestampable` used as an alias
     useSearch: {
-      // defaults to true, `searchable` used as an alias
-      displayable: ['id', 'job_title', 'name', 'email'], // the fields to become searchable (defaults to all fields)
+      
+      displayable: ['id', 'job_title', 'name', 'email'], // the fields to become d (defaults to all fields)
       searchable: ['job_title', 'name', 'email'], // the fields to become searchable (defaults to all fields)
       sortable: ['created_at', 'updated_at'], // the fields to become sortable (defaults to all fields)
       filterable: ['job_title'], // the fields to become filterable (defaults to all fields)
@@ -110,8 +110,8 @@ export default {
     },
   },
   get: {
-    formalName: (user: UserModel) => {
-      const name = user?.name as string
+    formalName: (attributes) => {
+      const name = attributes.user?.name as string
       const nameParts = name.split(' ')
 
       return `${capitalize(nameParts.pop()!)}, ${capitalize(nameParts.join(' '))}`

storage/framework/core/actions/src/search/flush.ts

@@ -0,0 +1,12 @@
+import process from 'node:process'
+import { log } from '@stacksjs/logging'
+import { flushModelDocuments } from '@stacksjs/search-engine'
+
+const result = await flushModelDocuments()
+
+if (result?.isErr()) {
+  console.error(result.error)
+  log.error('generateMigrations failed', result.error)
+}
+
+process.exit(0)

storage/framework/core/buddy/src/commands/search.ts

@@ -7,14 +7,15 @@ import { ExitCode } from '@stacksjs/types'
 
 export function search(buddy: CLI): void {
   const descriptions = {
-    search: 'Indexes database data to search engine',
+    import: 'Indexes database data to search engine',
+    flush: 'Flushes all data from search engine',
     settings: 'Update index settings',
     model: 'Target a specific model',
     verbose: 'Enable verbose output',
   }
 
   buddy
-    .command('search-engine:update', descriptions.search)
+    .command('search-engine:import', descriptions.import)
     .option('-m, --model [model]', descriptions.model, { default: false })
     .option('--verbose', descriptions.verbose, { default: false })
     .action(async (options: SearchOptions) => {
@@ -40,6 +41,33 @@ export function search(buddy: CLI): void {
       process.exit(ExitCode.Success)
     })
 
+    buddy
+    .command('search-engine:flush', descriptions.flush)
+    .option('-m, --model [model]', descriptions.model, { default: false })
+    .option('--verbose', descriptions.verbose, { default: false })
+    .action(async (options: SearchOptions) => {
+      log.debug('Running `search-engine:flush` ...', options)
+
+      const perf = await intro('search-engine:flush')
+      const result = await runAction(Action.SearchEngineFlush, options)
+
+      if (result.isErr()) {
+        await outro(
+          'While running the stripe:setup command, there was an issue',
+          { startTime: perf, useSeconds: true },
+          result.error,
+        )
+        process.exit()
+      }
+
+      await outro(`Successfully imported model data to search engine.`, {
+        startTime: perf,
+        useSeconds: true,
+      })
+
+      process.exit(ExitCode.Success)
+    })
+
     buddy
     .command('search-engine:sync-settings', descriptions.settings)
     .option('-m, --model [model]', descriptions.model, { default: false })

storage/framework/core/enums/src/index.ts

@@ -88,6 +88,7 @@ export enum Action {
   RouteList = 'route/list', // ✅
   StripeSetup = 'saas/setup',
   SearchEngineImport = 'search/import',
+  SearchEngineFlush = 'search/flush',
   SearchEngineSyncSettings = 'search/settings',
   Test = 'test/index',
   TestUi = 'test/ui',

storage/framework/core/search-engine/src/documents/flush.ts

@@ -0,0 +1,31 @@
+import type { Model } from '@stacksjs/types'
+import { type Err, ok, type Ok } from '@stacksjs/error-handling'
+import { log } from '@stacksjs/logging'
+import { getModelName, getTableName } from '@stacksjs/orm'
+import { path } from '@stacksjs/path'
+import { useSearchEngine } from '@stacksjs/search-engine'
+import { globSync } from '@stacksjs/storage'
+
+export async function flushModelDocuments(): Promise<Ok<string, never> | Err<string, any>> {
+  try {
+    const userModelFiles = globSync([path.userModelsPath('*.ts')], { absolute: true })
+    const { deleteIndex } = useSearchEngine()
+
+    for (const model of userModelFiles) {
+      const modelInstance = (await import(model)).default as Model
+      const searchable = modelInstance.traits?.useSearch
+
+      const tableName = getTableName(modelInstance, model)
+
+      if (searchable && (typeof searchable === 'boolean' || typeof searchable === 'object'))
+        await deleteIndex(tableName)
+    }
+
+    return ok('Successfully flushed all model data from search engine!')
+  }
+  catch (err: any) {
+    log.error(err)
+
+    return err(err)
+  }
+}

storage/framework/core/search-engine/src/documents/index.ts

@@ -1,2 +1,3 @@
 export * from './add'
+export * from './flush'
 export * from './settings'

storage/framework/core/search-engine/src/documents/settings.ts

@@ -1,7 +1,7 @@
 import type { Model } from '@stacksjs/types'
 import { type Err, ok, type Ok } from '@stacksjs/error-handling'
 import { log } from '@stacksjs/logging'
-import { getModelName, getTableName } from '@stacksjs/orm'
+import { getTableName } from '@stacksjs/orm'
 import { path } from '@stacksjs/path'
 import { useSearchEngine } from '@stacksjs/search-engine'
 import { globSync } from '@stacksjs/storage'