@stacksjs/search-engine 0.56.35 → 0.57.3

package/dist/drivers/index.d.ts

@@ -0,0 +1 @@
+export * as meilisearch from './meilisearch';

package/dist/drivers/index.mjs

@@ -0,0 +1 @@
+export * as meilisearch from "./meilisearch.mjs";

package/dist/drivers/meilisearch.d.ts

@@ -0,0 +1,9 @@
+import { MeiliSearch } from 'meilisearch';
+import type { SearchResponse } from 'meilisearch';
+interface SearchEngineOptions {
+    host: string;
+    apiKey: string;
+}
+declare function client(options?: SearchEngineOptions): MeiliSearch;
+declare function search(index: string, params: any): Promise<SearchResponse<Record<string, any>>>;
+export { client, search, };

package/dist/drivers/meilisearch.mjs

@@ -0,0 +1,23 @@
+import { log } from "@stacksjs/cli";
+import { searchEngine } from "@stacksjs/config";
+import { MeiliSearch } from "meilisearch";
+function client(options) {
+  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();
+  }
+  return new MeiliSearch({ host, apiKey });
+}
+async function search(index, params) {
+  return await client().index(index).search(params.query, { limit: params.perPage, offset: params.page * params.perPage });
+}
+export {
+  client,
+  search
+};

package/dist/helpers.d.ts

@@ -0,0 +1,95 @@
+/**
+ * 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/helpers.mjs

@@ -0,0 +1,13 @@
+export function determineState() {
+  const ls = localStorage.getItem("search-engine");
+  if (isString(ls))
+    return JSON.parse(ls);
+  return {
+    // default state
+    source: "http://127.0.0.1:7700",
+    index: "",
+    perPage: 20,
+    currentPage: 1,
+    query: ""
+  };
+}

package/dist/index.d.ts

@@ -1,33 +1,22 @@
-import * as _stacksjs_types from '@stacksjs/types';
-import { UiEngine } from '@stacksjs/ui';
-import { MeiliSearch } from 'meilisearch';
-
-interface SearchEngineOptions {
-    host: string;
-    apiKey: string;
-}
-declare function client$1(options?: SearchEngineOptions): MeiliSearch;
-
-declare const totalPages: UiEngine.Ref<number>;
-declare const currentPage: UiEngine.ComputedRef<number | undefined>;
-declare const filterName: UiEngine.ComputedRef<string | undefined>;
-declare const filters: UiEngine.ComputedRef<object | undefined>;
-declare const goToNextPage: UiEngine.ComputedRef<number | undefined>;
-declare const goToPage: UiEngine.ComputedRef<number | undefined>;
-declare const goToPrevPage: UiEngine.ComputedRef<number | undefined>;
-declare const hits: UiEngine.ComputedRef<_stacksjs_types.Hits<Record<string, any>> | undefined>;
-declare const index: UiEngine.ComputedRef<string>;
-declare const lastPageNumber: UiEngine.ComputedRef<number | undefined>;
-declare const perPage: UiEngine.ComputedRef<number | undefined>;
-declare const query: UiEngine.ComputedRef<string | undefined>;
-declare const results: UiEngine.ComputedRef<_stacksjs_types.SearchResponse<Record<string, any>> | undefined>;
-declare const searchFilters: UiEngine.ComputedRef<object | undefined>;
-declare const searchParams: UiEngine.ComputedRef<object | undefined>;
-declare const setTotalHits: UiEngine.ComputedRef<number | undefined>;
-declare const sort: UiEngine.ComputedRef<string | undefined>;
-declare const sorts: UiEngine.ComputedRef<object | undefined>;
-declare function client(): typeof client$1 | undefined;
-declare function useSearchEngine(): typeof client$1 | undefined;
-declare function calculatePagination(): void;
-
-export { calculatePagination, client, currentPage, filterName, filters, goToNextPage, goToPage, goToPrevPage, hits, index, lastPageNumber, perPage, query, results, searchFilters, searchParams, setTotalHits, sort, sorts, totalPages, useSearchEngine };
+import { client as meilisearch } from './drivers/meilisearch';
+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(): typeof meilisearch | undefined;
+export declare function useSearchEngine(): typeof meilisearch | undefined;
+export declare function calculatePagination(): void;

package/dist/index.mjs

@@ -1,64 +1,35 @@
-import { searchEngine } from '@stacksjs/config';
-import { log } from '@stacksjs/cli';
-import { MeiliSearch } from 'meilisearch';
-
-function client$1(options) {
-  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();
-  }
-  return new MeiliSearch({ host, apiKey });
-}
-
-function determineState() {
-  const ls = localStorage.getItem("search-engine");
-  if (isString(ls))
-    return JSON.parse(ls);
-  return {
-    // default state
-    source: "http://127.0.0.1:7700",
-    index: "",
-    perPage: 20,
-    currentPage: 1,
-    query: ""
-  };
-}
-
+import { searchEngine } from "@stacksjs/config";
+import { client as meilisearch } from "./drivers/meilisearch.mjs";
+import { determineState } from "./helpers.mjs";
 const table = useStorage("table", determineState()).value;
 const totalHits = table.results?.estimatedTotalHits ?? 1;
 const pages = ref([]);
-const totalPages = ref(0);
-const currentPage = computed(() => table.currentPage);
-const filterName = computed(() => table.filterName);
-const filters = computed(() => table.filters);
-const goToNextPage = computed(() => table.goToNextPage);
-const goToPage = computed(() => table.goToPage);
-const goToPrevPage = computed(() => table.goToPrevPage);
-const hits = computed(() => table.hits);
-const index = computed(() => table.index);
-const lastPageNumber = computed(() => table.lastPageNumber);
-const perPage = computed(() => table.perPage);
-const query = computed(() => table.query);
-const results = computed(() => table.results);
-const searchFilters = computed(() => table.searchFilters);
-const searchParams = computed(() => table.searchParams);
-const setTotalHits = computed(() => table.setTotalHits);
-const sort = computed(() => table.sort);
-const sorts = computed(() => table.sorts);
-function client() {
+export const totalPages = ref(0);
+export const currentPage = computed(() => table.currentPage);
+export const filterName = 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 function client() {
   if (searchEngine.driver === "meilisearch")
-    return client$1;
+    return meilisearch;
 }
-function useSearchEngine() {
+export function useSearchEngine() {
   return client();
 }
-function calculatePagination() {
+export function calculatePagination() {
   if (table.perPage)
     totalPages.value = Math.ceil(totalHits / table.perPage);
   const hitPages = [...Array(totalPages.value).keys()].map((i) => i + 1);
@@ -76,5 +47,3 @@ function calculatePagination() {
     allPages.push(page);
   pages.value = allPages;
 }
-
-export { calculatePagination, client, currentPage, filterName, filters, goToNextPage, goToPage, goToPrevPage, hits, index, lastPageNumber, perPage, query, results, searchFilters, searchParams, setTotalHits, sort, sorts, totalPages, useSearchEngine };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/search-engine",
   "type": "module",
-  "version": "0.56.35",
-  "packageManager": "pnpm@8.6.5",
+  "version": "0.57.3",
+  "packageManager": "pnpm@8.6.6",
   "description": "The Stacks search engine integrations.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -48,13 +48,13 @@
     "meilisearch": "^0.33.0"
   },
   "dependencies": {
-    "@stacksjs/cli": "0.56.35",
-    "@stacksjs/config": "0.56.35",
-    "@stacksjs/ui": "0.56.35"
+    "@stacksjs/cli": "0.57.3",
+    "@stacksjs/config": "0.57.3",
+    "@stacksjs/ui": "0.57.3"
   },
   "devDependencies": {
-    "@stacksjs/development": "0.56.35",
-    "@stacksjs/types": "0.56.35"
+    "@stacksjs/development": "0.57.3",
+    "@stacksjs/types": "0.57.3"
   },
   "scripts": {
     "build": "unbuild",