@stacksjs/search-engine 0.59.10 → 0.61.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/search-engine",
   "type": "module",
-  "version": "0.59.10",
+  "version": "0.61.0",
   "description": "The Stacks search engine integrations.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -58,8 +58,8 @@
     "@stacksjs/ui": "latest"
   },
   "dependencies": {
-    "@opensearch-project/opensearch": "^2.5.0",
-    "meilisearch": "^0.37.0"
+    "@opensearch-project/opensearch": "^2.8.0",
+    "meilisearch": "^0.40.0"
   },
   "devDependencies": {
     "@stacksjs/config": "latest",

package/src/drivers/meilisearch.ts

@@ -1,124 +1,124 @@
-import process from 'node:process'
-import { searchEngine } from '@stacksjs/config'
-import { log } from '@stacksjs/logging'
-import type { MeiliSearchOptions, SearchEngineDriver } from '@stacksjs/types'
-import { ExitCode } from '@stacksjs/types'
-import type { DocumentOptions, EnqueuedTask, Index, IndexOptions, IndexesResults, SearchResponse } from 'meilisearch'
-import { MeiliSearch } from 'meilisearch'
-
-function client(options?: MeiliSearchOptions) {
-  let host = searchEngine.meilisearch?.host
-  let apiKey = searchEngine.meilisearch?.apiKey
-
-  if (options?.host)
-    host = options.host
-
-  if (options?.apiKey)
-    apiKey = options.apiKey
-
-  if (!host) {
-    log.error('Please specify a search engine host.')
-    process.exit(ExitCode.FatalError)
-  }
-
-  return new MeiliSearch({ host, apiKey })
-}
-
-async function search(index: string, params: any): Promise<SearchResponse<Record<string, any>>> {
-  const offsetVal = ((params.page * params.perPage) - 20) || 0
-  const filter = convertToFilter(params.filter)
-  const sort = convertToMeilisearchSorting(params.sort)
-
-  return await client()
-    .index(index)
-    .search(params.query, { limit: params.perPage, filter, sort, offset: offsetVal })
-}
-
-async function addDocument(indexName: string, params: any): Promise<EnqueuedTask> {
-  return await client().index(indexName).addDocuments([params])
-}
-
-async function addDocuments(indexName: string, params: any[]): Promise<EnqueuedTask> {
-  return await client().index(indexName).addDocuments(params)
-}
-
-async function createIndex(name: string, options?: IndexOptions): Promise<EnqueuedTask> {
-  return await client().createIndex(name, options)
-}
-
-async function updateIndex(indexName: string, params: IndexOptions): Promise<EnqueuedTask> {
-  return await client().updateIndex(indexName, params)
-}
-
-async function updateDocument(indexName: string, params: DocumentOptions): Promise<EnqueuedTask> {
-  return await client().index(indexName).updateDocuments([params])
-}
-
-async function updateDocuments(indexName: string, params: DocumentOptions[]): Promise<EnqueuedTask> {
-  return await client().index(indexName).updateDocuments(params)
-}
-
-async function deleteDocument(indexName: string, id: number): Promise<EnqueuedTask> {
-  return await client().index(indexName).deleteDocument(id)
-}
-
-async function deleteDocuments(indexName: string, filters: string | string[]): Promise<EnqueuedTask> {
-  return await client().index(indexName).deleteDocuments({ filter: filters })
-}
-
-async function getDocument(indexName: string, id: number, fields: any): Promise<EnqueuedTask> {
-  return await client().index(indexName).getDocument(id, fields)
-}
-
-async function deleteIndex(indexName: string): Promise<EnqueuedTask> {
-  return await client().deleteIndex(indexName)
-}
-
-async function listAllIndexes(): Promise<IndexesResults<Index[]>> {
-  return await client().getIndexes()
-}
-
-function convertToFilter(jsonData: any): string[] {
-  const filters: string[] = []
-
-  for (const key in jsonData) {
-    if (Object.prototype.hasOwnProperty.call(jsonData, key)) {
-      const value = jsonData[key]
-      const filter = `${key}='${value}'`
-      filters.push(filter)
-    }
-  }
-
-  return filters
-}
-
-function convertToMeilisearchSorting(jsonData: any): string[] {
-  const filters: string[] = []
-
-  for (const key in jsonData) {
-    if (Object.prototype.hasOwnProperty.call(jsonData, key)) {
-      const value = jsonData[key]
-      const filter = `${key}='${value}'`
-      filters.push(filter)
-    }
-  }
-
-  return filters
-}
-
-export default {
-  client,
-  search,
-  createIndex,
-  deleteIndex,
-  updateIndex,
-  listAllIndexes,
-  addDocument,
-  addDocuments,
-  updateDocument,
-  listAllIndices: listAllIndexes,
-  updateDocuments,
-  deleteDocument,
-  deleteDocuments,
-  getDocument,
-} satisfies SearchEngineDriver
+// import process from 'node:process'
+// import { searchEngine } from '@stacksjs/config'
+// import { log } from '@stacksjs/logging'
+// import type { MeilisearchOptions, SearchEngineDriver } from '@stacksjs/types'
+// import { ExitCode } from '@stacksjs/types'
+// import type { DocumentOptions, EnqueuedTask, Index, IndexOptions, IndexesResults, SearchResponse } from 'meilisearch'
+// import { Meilisearch } from 'meilisearch'
+//
+// function client(options?: MeilisearchOptions) {
+//   let host = searchEngine.meilisearch?.host
+//   let apiKey = searchEngine.meilisearch?.apiKey
+//
+//   if (options?.host)
+//     host = options.host
+//
+//   if (options?.apiKey)
+//     apiKey = options.apiKey
+//
+//   if (!host) {
+//     log.error('Please specify a search engine host.')
+//     process.exit(ExitCode.FatalError)
+//   }
+//
+//   return new MeiliSearch({ host, apiKey })
+// }
+//
+// async function search(index: string, params: any): Promise<SearchResponse<Record<string, any>>> {
+//   const offsetVal = ((params.page * params.perPage) - 20) || 0
+//   const filter = convertToFilter(params.filter)
+//   const sort = convertToMeilisearchSorting(params.sort)
+//
+//   return await client()
+//     .index(index)
+//     .search(params.query, { limit: params.perPage, filter, sort, offset: offsetVal })
+// }
+//
+// async function addDocument(indexName: string, params: any): Promise<EnqueuedTask> {
+//   return await client().index(indexName).addDocuments([params])
+// }
+//
+// async function addDocuments(indexName: string, params: any[]): Promise<EnqueuedTask> {
+//   return await client().index(indexName).addDocuments(params)
+// }
+//
+// async function createIndex(name: string, options?: IndexOptions): Promise<EnqueuedTask> {
+//   return await client().createIndex(name, options)
+// }
+//
+// async function updateIndex(indexName: string, params: IndexOptions): Promise<EnqueuedTask> {
+//   return await client().updateIndex(indexName, params)
+// }
+//
+// async function updateDocument(indexName: string, params: DocumentOptions): Promise<EnqueuedTask> {
+//   return await client().index(indexName).updateDocuments([params])
+// }
+//
+// async function updateDocuments(indexName: string, params: DocumentOptions[]): Promise<EnqueuedTask> {
+//   return await client().index(indexName).updateDocuments(params)
+// }
+//
+// async function deleteDocument(indexName: string, id: number): Promise<EnqueuedTask> {
+//   return await client().index(indexName).deleteDocument(id)
+// }
+//
+// async function deleteDocuments(indexName: string, filters: string | string[]): Promise<EnqueuedTask> {
+//   return await client().index(indexName).deleteDocuments({ filter: filters })
+// }
+//
+// async function getDocument(indexName: string, id: number, fields: any): Promise<EnqueuedTask> {
+//   return await client().index(indexName).getDocument(id, fields)
+// }
+//
+// async function deleteIndex(indexName: string): Promise<EnqueuedTask> {
+//   return await client().deleteIndex(indexName)
+// }
+//
+// async function listAllIndexes(): Promise<IndexesResults<Index[]>> {
+//   return await client().getIndexes()
+// }
+//
+// function convertToFilter(jsonData: any): string[] {
+//   const filters: string[] = []
+//
+//   for (const key in jsonData) {
+//     if (Object.prototype.hasOwnProperty.call(jsonData, key)) {
+//       const value = jsonData[key]
+//       const filter = `${key}='${value}'`
+//       filters.push(filter)
+//     }
+//   }
+//
+//   return filters
+// }
+//
+// function convertToMeilisearchSorting(jsonData: any): string[] {
+//   const filters: string[] = []
+//
+//   for (const key in jsonData) {
+//     if (Object.prototype.hasOwnProperty.call(jsonData, key)) {
+//       const value = jsonData[key]
+//       const filter = `${key}='${value}'`
+//       filters.push(filter)
+//     }
+//   }
+//
+//   return filters
+// }
+//
+// export default {
+//   client,
+//   search,
+//   createIndex,
+//   deleteIndex,
+//   updateIndex,
+//   listAllIndexes,
+//   addDocument,
+//   addDocuments,
+//   updateDocument,
+//   listAllIndices: listAllIndexes,
+//   updateDocuments,
+//   deleteDocument,
+//   deleteDocuments,
+//   getDocument,
+// } satisfies SearchEngineDriver

package/src/drivers/opensearch.ts

@@ -1,59 +1,59 @@
-import { searchEngine } from '@stacksjs/config'
-import type { ApiResponse } from '@opensearch-project/opensearch'
-import { Client } from '@opensearch-project/opensearch'
-import type { SearchEngineDriver } from '@stacksjs/types'
-
-const host = searchEngine.openSearch?.host
-const protocol = searchEngine.openSearch?.protocol
-const port = searchEngine.openSearch?.port
-const auth = searchEngine.openSearch?.auth
-
-const client = new Client({
-  node: `${protocol}://${auth}@${host}:${port}`,
-})
-
-async function search(index: string, params?: any) {
-  const response = await client.search({
-    index,
-    body: params.query,
-  })
-
-  return response
-}
-
-async function createIndex(indexName: string, settings?: any): Promise<ApiResponse<any, any>> {
-  return await client.indices.create({ index: indexName, body: settings })
-}
-// async function updateIndex(indexName: string,  settings?: any): Promise<ApiResponse<any, any>> {
-//   return await client.indices.update({ index: indexName, body: settings })
+// import { searchEngine } from '@stacksjs/config'
+// import type { ApiResponse } from '@opensearch-project/opensearch'
+// import { Client } from '@opensearch-project/opensearch'
+// import type { SearchEngineDriver } from '@stacksjs/types'
+//
+// const host = searchEngine.openSearch?.host
+// const protocol = searchEngine.openSearch?.protocol
+// const port = searchEngine.openSearch?.port
+// const auth = searchEngine.openSearch?.auth
+//
+// const client = new Client({
+//   node: `${protocol}://${auth}@${host}:${port}`,
+// })
+//
+// async function search(index: string, params?: any) {
+//   const response = await client.search({
+//     index,
+//     body: params.query,
+//   })
+//
+//   return response
 // }
-
-async function deleteIndex(indexName: string): Promise<ApiResponse<any, any>> {
-  return await client.indices.delete({ index: indexName })
-}
-
-async function addDocument(indexName: string, document: any): Promise<ApiResponse<any, any>> {
-  return await client.index({
-    id: document.id,
-    index: indexName,
-    body: document,
-    refresh: true,
-  })
-}
-
-async function deleteDocument(indexName: string, document: any): Promise<ApiResponse<any, any>> {
-  return await client.delete({
-    id: document.id,
-    index: indexName,
-  })
-}
-
-export default {
-  client,
-  search,
-  createIndex,
-  deleteIndex,
-  addDocument,
-  deleteDocument,
-  // ...other methods
-} satisfies SearchEngineDriver
+//
+// async function createIndex(indexName: string, settings?: any): Promise<ApiResponse<any, any>> {
+//   return await client.indices.create({ index: indexName, body: settings })
+// }
+// // async function updateIndex(indexName: string,  settings?: any): Promise<ApiResponse<any, any>> {
+// //   return await client.indices.update({ index: indexName, body: settings })
+// // }
+//
+// async function deleteIndex(indexName: string): Promise<ApiResponse<any, any>> {
+//   return await client.indices.delete({ index: indexName })
+// }
+//
+// async function addDocument(indexName: string, document: any): Promise<ApiResponse<any, any>> {
+//   return await client.index({
+//     id: document.id,
+//     index: indexName,
+//     body: document,
+//     refresh: true,
+//   })
+// }
+//
+// async function deleteDocument(indexName: string, document: any): Promise<ApiResponse<any, any>> {
+//   return await client.delete({
+//     id: document.id,
+//     index: indexName,
+//   })
+// }
+//
+// export default {
+//   client,
+//   search,
+//   createIndex,
+//   deleteIndex,
+//   addDocument,
+//   deleteDocument,
+//   // ...other methods
+// } satisfies SearchEngineDriver

package/src/helpers.ts

@@ -4,9 +4,11 @@
 
 import type { Hits, SearchResponse } from 'meilisearch'
 
-// export function isString(val: unknown): val is string {
-//   return typeof val === 'string'
-// }
+// import { isString } from '@stacksjs/validation'
+
+export function isString(val: unknown): val is string {
+  return typeof val === 'string'
+}
 
 // this interface is primarily used to persist data to localStorage, in a unified way
 export interface SearchEngineStore {
@@ -125,10 +127,10 @@ export interface SearchEngineStore {
 export function determineState(): SearchEngineStore {
   const ls = localStorage.getItem('search-engine')
 
-  if (isString(ls))
-    return JSON.parse(ls) as SearchEngineStore
+  if (isString(ls)) return JSON.parse(ls) as SearchEngineStore
 
-  return { // default state
+  return {
+    // default state
     source: 'http://127.0.0.1:7700',
     index: '',
     perPage: 20,

package/src/index.ts

@@ -1,12 +1,13 @@
 import type { UiEngine } from '@stacksjs/ui'
 import { useStorage } from '@stacksjs/utils'
+import { computed, ref } from 'vue'
 
 // import { client as meilisearch } from './drivers/meilisearch'
 import { determineState } from './helpers'
 
 // import type { Ref } from '@stacksjs/types'
 
-const table = (useStorage('table', determineState()).value)
+const table = useStorage('table', determineState()).value
 const totalHits = table.results?.estimatedTotalHits ?? 1
 
 // state
@@ -42,25 +43,21 @@ export function useSearchEngine() {
 }
 
 export function calculatePagination() {
-  if (table.perPage)
-    totalPages.value = Math.ceil(totalHits / table.perPage)
+  if (table.perPage) totalPages.value = Math.ceil(totalHits / table.perPage)
 
-  const hitPages = [...Array(totalPages.value).keys()].map(i => i + 1)
+  const hitPages = [...Array(totalPages.value).keys()].map((i) => i + 1)
   const offset = 2
   const currentPage = table.currentPage ?? 1
   const lastPage = hitPages[hitPages.length - 1]
 
   let from = currentPage - offset
-  if (from < 1)
-    from = 1
+  if (from < 1) from = 1
 
   let to = from + offset * 2
-  if (to >= (lastPage as number))
-    to = lastPage as number
+  if (to >= (lastPage as number)) to = lastPage as number
 
   const allPages = []
-  for (let page = from; page <= to; page++)
-    allPages.push(page)
+  for (let page = from; page <= to; page++) allPages.push(page)
 
   pages.value = allPages
 }

package/dist/helpers.d.ts

@@ -1,95 +0,0 @@
-/**
- * This file is used to define the types/interfaces used in the project.
- */
-import type { Hits, SearchResponse } from 'meilisearch';
-export interface SearchEngineStore {
-    /**
-     * The search engine index.
-     */
-    index: string;
-    /**
-     * The search engine host.
-     * @default 'http://127.0.0.1:7700'
-     */
-    source?: string;
-    /**
-     * The search engine password/API key.
-     */
-    password?: string;
-    /**
-     * The search query.
-     * @default 20
-     * @type {string}
-     * @default: ''
-     */
-    query?: string;
-    /**
-     * The number of results to return.
-     * @default 20
-     * @type {number}
-     */
-    perPage?: number;
-    /**
-     * The current page number
-     * @default 1
-     * @type {number}
-     */
-    currentPage?: number;
-    /**
-     * The results object returned from the search engine.
-     */
-    results?: SearchResponse<Record<string, any>>;
-    /**
-     * The hits object returned from the search engine.
-     */
-    hits?: Hits<Record<string, any>>;
-    /**
-     * The search Filter Name
-     */
-    filterName?: string;
-    /**
-     * The search filters
-     */
-    filters?: object;
-    /**
-     * The next page value
-     */
-    goToNextPage?: number;
-    /**
-     * Set to go to a specific page
-     */
-    goToPage?: number;
-    /**
-     * Set to go to the previous page
-     */
-    goToPrevPage?: number;
-    /**
-     * The last page number value
-     */
-    lastPageNumber?: number;
-    /**
-     * The searched term to use for the search
-     */
-    search?: string;
-    /**
-     * The search params filters to use for the search
-     */
-    searchFilters?: object;
-    /**
-     * The search params to use for the search
-     */
-    searchParams?: object;
-    /**
-     * Total hits value to use for the search
-     */
-    setTotalHits?: number;
-    /**
-     * The sort value to use for the search
-     */
-    sort?: string;
-    /**
-     * The sorts value to use for the search
-     */
-    sorts?: object;
-}
-export declare function determineState(): SearchEngineStore;

package/dist/index.d.ts

@@ -1,21 +0,0 @@
-export declare const totalPages: any;
-export declare const currentPage: any;
-export declare const filterName: any;
-export declare const filters: any;
-export declare const goToNextPage: any;
-export declare const goToPage: any;
-export declare const goToPrevPage: any;
-export declare const hits: any;
-export declare const index: any;
-export declare const lastPageNumber: any;
-export declare const perPage: any;
-export declare const query: any;
-export declare const results: any;
-export declare const searchFilters: any;
-export declare const searchParams: any;
-export declare const setTotalHits: any;
-export declare const sort: any;
-export declare const sorts: any;
-export declare function client(): string;
-export declare function useSearchEngine(): string;
-export declare function calculatePagination(): void;