@stacksjs/search-engine 0.64.6 → 0.65.0

package/dist/types.d.ts

@@ -0,0 +1,91 @@
+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;
+}

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@stacksjs/search-engine",
   "type": "module",
-  "version": "0.64.6",
+  "version": "0.65.0",
   "description": "The Stacks search engine integrations.",
   "author": "Chris Breuer",
+  "contributors": ["Chris Breuer <chris@stacksjs.org>"],
   "license": "MIT",
   "funding": "https://github.com/sponsors/chrisbbreuer",
   "homepage": "https://github.com/stacksjs/stacks/tree/main/storage/framework/core/search-engine#readme",
@@ -40,25 +41,18 @@
   },
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
-  "contributors": [
-    "Chris Breuer <chris@stacksjs.org>"
-  ],
-  "files": [
-    "README.md",
-    "dist",
-    "src"
-  ],
+  "files": ["README.md", "dist", "src"],
   "scripts": {
-    "build": "bun --bun build.ts",
-    "typecheck": "bun --bun tsc --noEmit",
+    "build": "bun build.ts",
+    "typecheck": "bun tsc --noEmit",
     "prepublishOnly": "bun run build"
   },
   "dependencies": {
-    "@opensearch-project/opensearch": "^2.11.0",
-    "meilisearch": "^0.42.0"
+    "@opensearch-project/opensearch": "^2.12.0",
+    "meilisearch": "^0.44.1"
   },
   "devDependencies": {
-    "@stacksjs/config": "latest",
-    "@stacksjs/development": "latest"
+    "@stacksjs/config": "0.64.6",
+    "@stacksjs/development": "0.64.6"
   }
 }

package/src/helpers.ts

@@ -2,7 +2,7 @@
  * This file is used to define the types/interfaces used in the project.
  */
 
-import type { Hits, SearchResponse } from 'meilisearch'
+import type { SearchEngineStore } from './types'
 
 // import { isString } from '@stacksjs/validation'
 
@@ -10,124 +10,11 @@ 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 {
-  /**
-   * 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>> // optional: the Meilisearch search response (defaults: {})
-  /**
-   * 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
-
-  // table related config
-  // actionable?: string | boolean // optional: determines whether the table displays any "action items" (defaults: true)
-  // actions?: string | string[] // optional: the specific type of actions to be displayed/utilized in the table (defaults: 'Edit, Delete')
-  // columns: string[] // used as table heads/column titles
-  // selectable?: string | boolean // optional: determines whether the table displays the checkboxes (defaults: true)
-  // selectedRows?: number[] | string[] // optional: holds the selected rows (defaults: [])
-  // selectedAll?: boolean // optional: determines whether all the rows are selected (defaults: false)
-  // stickyHeader?: string | boolean // optional: determines whether the table displays the sticky header (defaults: false)
-  // stickyFooter?: string | boolean // optional: determines whether the table displays the sticky footer (defaults: false)
-}
-
 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

package/src/index.ts

@@ -1,6 +1,6 @@
 import type { UiEngine } from '@stacksjs/ui'
 import { useStorage } from '@stacksjs/utils'
-import { computed, ref } from 'vue'
+import { computed, type ComputedRef, type Ref, ref } from 'vue'
 
 // import { client as meilisearch } from './drivers/meilisearch'
 import { determineState } from './helpers'
@@ -12,49 +12,52 @@ const totalHits = table.results?.estimatedTotalHits ?? 1
 
 // state
 const pages: UiEngine.Ref<number[]> = ref([])
-export const totalPages = ref(0)
-export const currentPage = computed(() => table.currentPage)
-export const filterName = computed(() => table.filterName)
+export const totalPages: Ref = ref(0)
+export const currentPage: ComputedRef = computed(() => table.currentPage)
+export const filterName: ComputedRef = computed(() => table.filterName)
 
-export const filters = computed(() => table.filters)
-export const goToNextPage = computed(() => table.goToNextPage)
-export const goToPage = computed(() => table.goToPage)
-export const goToPrevPage = computed(() => table.goToPrevPage)
-export const hits = computed(() => table.hits)
-export const index = computed(() => table.index)
-export const lastPageNumber = computed(() => table.lastPageNumber)
-export const perPage = computed(() => table.perPage)
-export const query = computed(() => table.query)
-export const results = computed(() => table.results)
-export const searchFilters = computed(() => table.searchFilters)
-export const searchParams = computed(() => table.searchParams)
-export const setTotalHits = computed(() => table.setTotalHits)
-export const sort = computed(() => table.sort)
-export const sorts = computed(() => table.sorts)
+export const filters: ComputedRef = computed(() => table.filters)
+export const goToNextPage: ComputedRef = computed(() => table.goToNextPage)
+export const goToPage: ComputedRef = computed(() => table.goToPage)
+export const goToPrevPage: ComputedRef = computed(() => table.goToPrevPage)
+export const hits: ComputedRef = computed(() => table.hits)
+export const index: ComputedRef<string> = computed(() => table.index)
+export const lastPageNumber: ComputedRef<number> = computed(() => table.lastPageNumber || 1)
+export const perPage: ComputedRef<number> = computed(() => table.perPage || 10)
+export const query: ComputedRef<string | undefined> = computed(() => table.query)
+export const results: ComputedRef = computed(() => table.results)
+export const searchFilters: ComputedRef = computed(() => table.searchFilters)
+export const searchParams: ComputedRef = computed(() => table.searchParams)
+export const setTotalHits: ComputedRef = computed(() => table.setTotalHits)
+export const sort: ComputedRef = computed(() => table.sort)
+export const sorts: ComputedRef = computed(() => table.sorts)
 
-export function client() {
+export function client(): string {
   // if (searchEngine.driver === 'meilisearch')
   //   return meilisearch
   return 'wip-search-me'
 }
 
-export function useSearchEngine() {
+export function useSearchEngine(): string {
   return client()
 }
 
-export function calculatePagination() {
-  if (table.perPage) totalPages.value = Math.ceil(totalHits / table.perPage)
+export function calculatePagination(): void {
+  if (table.perPage)
+    totalPages.value = Math.ceil(totalHits / table.perPage)
 
-  const hitPages = [...Array(totalPages.value).keys()].map((i) => i + 1)
+  const hitPages = Array.from({ length: totalPages.value }, (_, 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)

package/src/types.ts

@@ -0,0 +1,115 @@
+import type { Hits, SearchResponse } from 'meilisearch'
+
+// this interface is primarily used to persist data to localStorage, in a unified way
+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>> // optional: the Meilisearch search response (defaults: {})
+  /**
+   * 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
+
+  // table related config
+  // actionable?: string | boolean // optional: determines whether the table displays any "action items" (defaults: true)
+  // actions?: string | string[] // optional: the specific type of actions to be displayed/utilized in the table (defaults: 'Edit, Delete')
+  // columns: string[] // used as table heads/column titles
+  // selectable?: string | boolean // optional: determines whether the table displays the checkboxes (defaults: true)
+  // selectedRows?: number[] | string[] // optional: holds the selected rows (defaults: [])
+  // selectedAll?: boolean // optional: determines whether all the rows are selected (defaults: false)
+  // stickyHeader?: string | boolean // optional: determines whether the table displays the sticky header (defaults: false)
+  // stickyFooter?: string | boolean // optional: determines whether the table displays the sticky footer (defaults: false)
+}