@stacksjs/search-engine 0.42.1 → 0.43.0

package/README.md

@@ -1,29 +1,36 @@
 # Stacks Search Engine
 
-wip
+The Stacks Search Engine is a unified driver system to easily interact with search engines.
 
 ## ☘️ Features
 
-wip
+- 🔎 Advanced searching
+- 🎯 Filtering support
+- 📚 Pagination support
+- ⬇️ Sorting support
+- 🚘 Driver based
+- ⚡️ Meilisearch support
+- 💀 Headless functions & components
 
-- ⚡️
+## TODO
 
-wip
+- [ ] Driver: Algolia
+- [ ] Driver: TypeSense
 
 ## 🤖 Usage
 
-wip
-
 ```bash
 pnpm i -D @stacksjs/search-engine
 ```
 
-Now, you can use it in your project:
+You may now use:
 
-```js
-import { client } from '@stacksjs/search-engine'
+```ts
+import { useSearchEngine } from '@stacksjs/search-engine'
 
-// wip
+const client = useSearchEngine()
+const index = client.index(name)
+const results = client.search('Hello World')
 ```
 
 Learn more in the docs.

package/dist/drivers/meilisearch.d.ts

@@ -0,0 +1,8 @@
+import { MeiliSearch } from 'meilisearch';
+interface SearchEngineOptions {
+    host: string;
+    apiKey: string;
+}
+declare function client(options?: SearchEngineOptions): MeiliSearch;
+declare function search(index: string, params: any): Promise<import("meilisearch").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,47 @@
+/**
+ * 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>>;
+}
+export declare function determineState(): SearchEngineStore;

package/dist/helpers.mjs

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

package/dist/index.d.ts

@@ -1 +1,12 @@
-export declare function useSearchEngine(): string;
+import { client as meilisearch, search } from './drivers/meilisearch';
+export declare function client(): typeof meilisearch | undefined;
+export declare function useSearchEngine(): typeof meilisearch | undefined;
+export declare function calculatePagination(): void;
+declare const _default: {
+    useSearchEngine: typeof useSearchEngine;
+    client: typeof client;
+    search: typeof search;
+    calculatePagination: typeof calculatePagination;
+    currentPage: any;
+};
+export default _default;

package/dist/index.mjs

@@ -1,4 +1,40 @@
+import { searchEngine } from "@stacksjs/config";
+import { client as meilisearch, search } 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);
+export function client() {
+  if (searchEngine.driver === "meilisearch")
+    return meilisearch;
+}
 export function useSearchEngine() {
-  const searchEngine = "";
-  return searchEngine;
+  return client();
+}
+export function calculatePagination() {
+  if (table.perPage)
+    totalPages.value = Math.ceil(totalHits / table.perPage);
+  const hitPages = [...Array(totalPages.value).keys()].map((i) => i + 1);
+  const offset = 2;
+  const currentPage2 = table.currentPage ?? 1;
+  const lastPage = hitPages[hitPages.length - 1];
+  let from = currentPage2 - offset;
+  if (from < 1)
+    from = 1;
+  let to = from + offset * 2;
+  if (to >= lastPage)
+    to = lastPage;
+  const allPages = [];
+  for (let page = from; page <= to; page++)
+    allPages.push(page);
+  pages.value = allPages;
 }
+export default {
+  useSearchEngine,
+  client,
+  search,
+  calculatePagination,
+  currentPage
+};

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/search-engine",
   "type": "module",
-  "version": "0.42.1",
-  "packageManager": "pnpm@7.17.0",
+  "version": "0.43.0",
+  "packageManager": "pnpm@7.17.1",
   "description": "The Stacks search engine integrations.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -41,18 +41,19 @@
   ],
   "engines": {
     "node": ">=v18.12.1",
-    "pnpm": ">=7.17.0"
+    "pnpm": ">=7.17.1"
   },
   "peerDependencies": {
     "@vueuse/core": "^9.6.0",
-    "meilisearch": "^0.29.1",
+    "meilisearch": "^0.30.0",
     "vue": "^3.2.45",
-    "@stacksjs/drivers": "0.42.1"
+    "@stacksjs/cli": "0.43.0",
+    "@stacksjs/config": "0.43.0"
   },
   "devDependencies": {
     "mkdist": "^1.0.0",
     "typescript": "^4.9.3",
-    "@stacksjs/testing": "0.42.1"
+    "@stacksjs/testing": "0.43.0"
   },
   "scripts": {
     "build": "mkdist -d",