@stacksjs/search-engine 0.57.3 → 0.58.19

package/README.md

@@ -20,7 +20,7 @@ The Stacks Search Engine is a unified driver system to easily interact with sear
 ## 🤖 Usage
 
 ```bash
-pnpm i -D @stacksjs/search-engine
+bun install -d @stacksjs/search-engine
 ```
 
 You may now use:
@@ -38,7 +38,7 @@ Learn more in the docs.
 ## 🧪 Testing
 
 ```bash
-pnpm test
+bun test
 ```
 
 ## 📈 Changelog
@@ -57,10 +57,10 @@ For help, discussion about best practices, or any other conversation that would
 
 For casual chit-chat with others using this package:
 
-[Join the Stacks Discord Server](https://discord.ow3.org)
+[Join the Stacks Discord Server](https://discord.gg/stacksjs)
 
 ## 📄 License
 
 The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
 
-Made with ❤️
+Made with 💙

package/dist/index.js

@@ -0,0 +1,89 @@
+// @bun
+// src/index.ts
+import {searchEngine} from "@stacksjs/config";
+import {useStorage} from "@stacksjs/utils";
+
+// src/helpers.ts
+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: ""
+  };
+}
+
+// src/index.ts
+function client() {
+  if (searchEngine.driver === "meilisearch")
+    return meilisearch;
+}
+function useSearchEngine() {
+  return client();
+}
+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 currentPage = table.currentPage ?? 1;
+  const lastPage = hitPages[hitPages.length - 1];
+  let from = currentPage - 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;
+}
+var table = useStorage("table", determineState()).value;
+var totalHits = table.results?.estimatedTotalHits ?? 1;
+var pages = ref([]);
+var totalPages = ref(0);
+var currentPage = computed(() => table.currentPage);
+var filterName = computed(() => table.filterName);
+var filters = computed(() => table.filters);
+var goToNextPage = computed(() => table.goToNextPage);
+var goToPage = computed(() => table.goToPage);
+var goToPrevPage = computed(() => table.goToPrevPage);
+var hits = computed(() => table.hits);
+var index = computed(() => table.index);
+var lastPageNumber = computed(() => table.lastPageNumber);
+var perPage = computed(() => table.perPage);
+var query = computed(() => table.query);
+var results = computed(() => table.results);
+var searchFilters = computed(() => table.searchFilters);
+var searchParams = computed(() => table.searchParams);
+var setTotalHits = computed(() => table.setTotalHits);
+var sort = computed(() => table.sort);
+var sorts = computed(() => table.sorts);
+export {
+  useSearchEngine,
+  totalPages,
+  sorts,
+  sort,
+  setTotalHits,
+  searchParams,
+  searchFilters,
+  results,
+  query,
+  perPage,
+  lastPageNumber,
+  index,
+  hits,
+  goToPrevPage,
+  goToPage,
+  goToNextPage,
+  filters,
+  filterName,
+  currentPage,
+  client,
+  calculatePagination
+};

package/package.json

@@ -1,17 +1,16 @@
 {
   "name": "@stacksjs/search-engine",
   "type": "module",
-  "version": "0.57.3",
-  "packageManager": "pnpm@8.6.6",
+  "version": "0.58.19",
   "description": "The Stacks search engine integrations.",
   "author": "Chris Breuer",
   "license": "MIT",
   "funding": "https://github.com/sponsors/chrisbbreuer",
-  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/core/search-engine#readme",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/storage/framework/core/src/search-engine#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/stacksjs/stacks.git",
-    "directory": "./.stacks/core/search-engine"
+    "directory": "./storage/framework/core/src/search-engine"
   },
   "bugs": {
     "url": "https://github.com/stacksjs/stacks/issues"
@@ -31,34 +30,38 @@
   ],
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs"
+      "bun": "./src/index.ts",
+      "import": "./dist/index.js"
+    },
+    "./*": {
+      "bun": "./src/*",
+      "import": "./dist/*"
     }
   },
-  "module": "dist/index.mjs",
+  "module": "dist/index.js",
   "types": "dist/index.d.ts",
   "contributors": [
-    "Chris Breuer <chris@ow3.org>"
+    "Chris Breuer <chris@stacksjs.org>"
   ],
   "files": [
-    "dist",
-    "README.md"
+    "README.md",
+    "dist"
   ],
+  "scripts": {
+    "build": "bun --bun build.ts",
+    "typecheck": "bun --bun tsc --noEmit",
+    "prepublishOnly": "bun --bun run build"
+  },
   "peerDependencies": {
-    "meilisearch": "^0.33.0"
+    "@stacksjs/cli": "workspace:*",
+    "@stacksjs/ui": "workspace:*"
   },
   "dependencies": {
-    "@stacksjs/cli": "0.57.3",
-    "@stacksjs/config": "0.57.3",
-    "@stacksjs/ui": "0.57.3"
+    "@opensearch-project/opensearch": "^2.5.0",
+    "meilisearch": "^0.36.0"
   },
   "devDependencies": {
-    "@stacksjs/development": "0.57.3",
-    "@stacksjs/types": "0.57.3"
-  },
-  "scripts": {
-    "build": "unbuild",
-    "dev": "unbuild --stub",
-    "typecheck": "tsc --noEmit"
+    "@stacksjs/config": "workspace:*",
+    "@stacksjs/development": "workspace:*"
   }
-}
+}

package/LICENSE.md

@@ -1,21 +0,0 @@
-# MIT License
-
-Copyright (c) 2022 Open Web Foundation
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/drivers/index.d.ts

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

package/dist/drivers/index.mjs

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

package/dist/drivers/meilisearch.d.ts

@@ -1,9 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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

@@ -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/helpers.mjs

@@ -1,13 +0,0 @@
-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,22 +0,0 @@
-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,49 +0,0 @@
-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([]);
-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 meilisearch;
-}
-export function useSearchEngine() {
-  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;
-}