@meeovi/search 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,55 @@
+
+---
+
+# 📦 `@meeovi/search` — README.md
+
+```md
+# @meeovi/search
+
+A backend‑agnostic search abstraction for Meeovi.  
+Supports Searchkit, Meilisearch, Typesense, Algolia, and custom search engines.
+
+## ✨ Features
+
+- Unified `useSearch()` composable  
+- Pluggable search providers  
+- Runtime configuration  
+- Works with any search backend  
+
+## 📦 Installation
+
+```sh
+npm install @meeovi/search
+
+⚙️ Configuration
+
+import { setSearchConfig } from '@meeovi/search'
+
+setSearchConfig({
+  searchProvider: 'searchkit',
+  searchUrl: 'https://api.meeovi.com/search'
+})
+🧩 Usage
+
+import { useSearch } from '@meeovi/search'
+
+const { query, fetch } = useSearch()
+
+const results = await fetch(query('laptops'))
+🔌 Providers
+
+export interface SearchProvider {
+  query(input: string): any
+  fetch(query: any): Promise<any>
+}
+Register:
+
+
+registerSearchProvider('searchkit', { query, fetch })
+🧱 Folder Structure
+Code
+src/
+  providers/
+  config.
+  registry.
+  useSearch.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@meeovi/search",
-  "version": "1.0.0",
-  "description": "",
+  "version": "1.0.2",
+  "description": "Powerful search module for the M Framework.",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/src/types/api/global-search.ts

@@ -0,0 +1,8 @@
+export interface GlobalSearchResult {
+	id?: string;
+	title?: string;
+	type?: string;
+	description?: string;
+	image?: string;
+	url?: string;
+}

package/src/utils/search/analytics.ts

@@ -0,0 +1,21 @@
+import { getAdminClient } from './client'
+
+const TELEMETRY_INDEX = 'search_telemetry'
+
+export async function logSearchEvent(event: Record<string, any>) {
+	const client = getAdminClient()
+	const idx = client.index(TELEMETRY_INDEX)
+	const payload = Object.assign({}, event, { ts: new Date().toISOString() })
+	return idx.addDocuments([payload])
+}
+
+export async function getTelemetryStats() {
+	const client = getAdminClient()
+	try {
+		return client.index(TELEMETRY_INDEX).getStats()
+	} catch (e) {
+		return null
+	}
+}
+
+export default { logSearchEvent, getTelemetryStats }

package/src/utils/search/client.ts

@@ -0,0 +1,43 @@
+// Instantiate a Searchkit SDK client. The SDK is expected to be installed.
+import Client from '@searchkit/instantsearch-client'
+import { useRuntimeConfig } from '#imports'
+
+function getRuntimeConfig(): any {
+  try {
+    return useRuntimeConfig()
+  } catch (e) {
+    return undefined
+  }
+}
+
+export function getAdminClient(): any {
+  const cfg = getRuntimeConfig()
+  const host = cfg?.public?.searchkit?.host || process.env.SEARCHKIT_HOST || process.env.ELASTICSEARCH_HOST || cfg?.public?.meilisearch?.host || process.env.MEILISEARCH_HOST
+  const apiKey = cfg?.searchkit?.adminApiKey || process.env.SEARCHKIT_ADMIN_API_KEY || cfg?.meilisearch?.adminApiKey || process.env.MEILISEARCH_ADMIN_API_KEY
+  if (!host) throw new Error('Search host not configured')
+  try {
+    return new (Client as any)({ host, apiKey })
+  } catch (e) {
+    // Fallback to a minimal placeholder if SDK instantiation fails
+    return { host, apiKey, _client: 'searchkit-fallback' } as any
+  }
+}
+
+export function getSearchClient(): any {
+  const cfg = getRuntimeConfig()
+  const host = cfg?.public?.searchkit?.host || process.env.SEARCHKIT_HOST || process.env.ELASTICSEARCH_HOST || cfg?.public?.meilisearch?.host || process.env.MEILISEARCH_HOST
+  const apiKey = cfg?.public?.searchkit?.searchApiKey || process.env.SEARCHKIT_SEARCH_API_KEY || cfg?.public?.meilisearch?.searchApiKey || process.env.MEILISEARCH_SEARCH_API_KEY
+  if (!host) throw new Error('Search host not configured')
+  try {
+    return new (Client as any)({ host, apiKey })
+  } catch (e) {
+    return { host, apiKey, _client: 'searchkit-fallback' } as any
+  }
+}
+
+export function getIndexName(): string {
+  const cfg = getRuntimeConfig()
+  return cfg?.public?.searchkit?.indexName || process.env.SEARCHKIT_INDEX_NAME || cfg?.public?.meilisearch?.indexName || process.env.MEILISEARCH_INDEX_NAME || 'default'
+}
+
+export type TaskInfo = any

package/src/utils/search/configurations.ts

@@ -0,0 +1,16 @@
+import { getAdminClient, getIndexName } from './client'
+
+export async function updateSettings(indexName: string | undefined, settings: Record<string, any>) {
+	const client = getAdminClient()
+	const idx = client.index(indexName || getIndexName())
+	return idx.updateSettings(settings)
+}
+
+export async function getSettings(indexName?: string) {
+	const client = getAdminClient()
+	const idx = client.index(indexName || getIndexName())
+	return idx.getSettings()
+}
+
+export default { updateSettings, getSettings }
+

package/src/utils/search/filters.ts

@@ -0,0 +1,25 @@
+export type FilterValue = string | number | boolean
+
+function fmt(v: FilterValue) {
+	if (typeof v === 'string') return `"${v.replace(/"/g, '\\"')}"`
+	if (typeof v === 'boolean') return v ? 'true' : 'false'
+	return String(v)
+}
+
+export function toFilterString(filters: Record<string, FilterValue | FilterValue[]>): string | undefined {
+	const parts: string[] = []
+	for (const key of Object.keys(filters)) {
+		const val = filters[key]
+		if (val === undefined) continue
+		if (Array.isArray(val)) {
+			const orParts = val.map(v => `${key} = ${fmt(v)}`)
+			parts.push(`(${orParts.join(' OR ')})`)
+		} else {
+			parts.push(`${key} = ${fmt(val)}`)
+		}
+	}
+	if (parts.length === 0) return undefined
+	return parts.join(' AND ')
+}
+
+export default toFilterString

package/src/utils/search/indexing.ts

@@ -0,0 +1,40 @@
+import { getAdminClient, getIndexName } from './client'
+
+export async function addDocuments(indexName: string | undefined, docs: any[], primaryKey?: string) {
+	const client = getAdminClient()
+	const idx = client.index(indexName || getIndexName())
+	return idx.addDocuments(docs, { primaryKey })
+}
+
+export async function updateDocuments(indexName: string | undefined, docs: any[]) {
+	const client = getAdminClient()
+	const idx = client.index(indexName || getIndexName())
+	return idx.updateDocuments(docs)
+}
+
+export async function deleteDocuments(indexName: string | undefined, ids: Array<string | number>) {
+	const client = getAdminClient()
+	const idx = client.index(indexName || getIndexName())
+	const stringIds = ids.map(id => String(id)) as string[]
+	return idx.deleteDocuments(stringIds)
+}
+
+export async function clearIndex(indexName?: string) {
+	const client = getAdminClient()
+	const idx = client.index(indexName || getIndexName())
+	return idx.deleteAllDocuments()
+}
+
+export async function getDocument(indexName: string | undefined, id: string | number) {
+	const client = getAdminClient()
+	const idx = client.index(indexName || getIndexName())
+	return idx.getDocument(id)
+}
+
+export default {
+	addDocuments,
+	updateDocuments,
+	deleteDocuments,
+	clearIndex,
+	getDocument,
+}

package/src/utils/search/migrations.ts

@@ -0,0 +1,21 @@
+import { getAdminClient, getIndexName } from './client'
+
+export async function ensureIndex(indexName?: string, options?: { primaryKey?: string }) {
+	const client = getAdminClient()
+	const name = indexName || getIndexName()
+	try {
+		await client.getIndex(name)
+		return { existed: true }
+	} catch (err) {
+		const created = await client.createIndex(name, options)
+		return { existed: false, created }
+	}
+}
+
+export async function deleteIndex(indexName?: string) {
+	const client = getAdminClient()
+	const name = indexName || getIndexName()
+	return client.deleteIndex(name)
+}
+
+export default { ensureIndex, deleteIndex }

package/src/utils/search/multiSearch.ts

@@ -0,0 +1,17 @@
+import { getSearchClient } from './client'
+
+export type MultiQuery = {
+	indexName: string
+	query?: string
+	params?: Record<string, any>
+}
+
+export async function multiSearch(queries: MultiQuery[]) {
+	const client = getSearchClient()
+	const ms = queries.map(q => ({ indexUid: q.indexName, query: q.query || '', params: q.params || {} }))
+	// MeiliSearch SDK expects: { queries: [{ indexUid, query, params }] }
+	return client.multiSearch({ queries: ms })
+}
+
+export default multiSearch
+

package/src/utils/search/permissions.ts

@@ -0,0 +1,23 @@
+import { getAdminClient } from './client'
+
+export async function createKey(params: {
+	description?: string
+	actions: string[]
+	indexes?: string[]
+	expiresAt?: string
+}) {
+	const client = getAdminClient()
+	return client.createKey(params)
+}
+
+export async function listKeys() {
+	const client = getAdminClient()
+	return client.getKeys()
+}
+
+export async function deleteKey(key: string) {
+	const client = getAdminClient()
+	return client.deleteKey(key)
+}
+
+export default { createKey, listKeys, deleteKey }

package/src/utils/search/relevancy.ts

@@ -0,0 +1,16 @@
+import { getAdminClient, getIndexName } from './client'
+
+export async function updateRankingRules(indexName: string | undefined, rankingRules: string[]) {
+	const client = getAdminClient()
+	const idx = client.index(indexName || getIndexName())
+	return idx.updateSettings({ rankingRules })
+}
+
+export async function updateSearchableAttributes(indexName: string | undefined, attrs: string[]) {
+	const client = getAdminClient()
+	const idx = client.index(indexName || getIndexName())
+	return idx.updateSettings({ searchableAttributes: attrs })
+}
+
+export default { updateRankingRules, updateSearchableAttributes }
+

package/src/utils/search/security.ts

@@ -0,0 +1,17 @@
+import toFilterString from './filters'
+
+export function sanitizeQuery(q?: string) {
+	if (!q) return ''
+	// basic sanitize to avoid control sequences
+	return q.replace(/[\u0000-\u001F\u007F]/g, '').trim()
+}
+
+export function buildUserFilter(user?: { id?: string | number; roles?: string[] }, extra?: Record<string, any>) {
+	const filters: Record<string, any> = {}
+	if (user?.id) filters['owner_id'] = user.id
+	if (user?.roles && user.roles.length > 0) filters['role'] = user.roles
+	if (extra) Object.assign(filters, extra)
+	return toFilterString(filters)
+}
+
+export default { sanitizeQuery, buildUserFilter }

package/src/utils/search/sorting.ts

@@ -0,0 +1,9 @@
+export type SortSpec = { field: string; direction?: 'asc' | 'desc' }
+
+export function buildSortClauses(specs: SortSpec[] | undefined) {
+	if (!specs || specs.length === 0) return undefined
+	return specs.map(s => `${s.field}:${s.direction || 'asc'}`)
+}
+
+export default buildSortClauses
+

package/src/utils/search/tasks.ts

@@ -0,0 +1,14 @@
+import { getAdminClient, getIndexName } from './client'
+
+export async function batchIndexDocuments(docs: any[], indexName?: string, batchSize = 1000) {
+	const client = getAdminClient()
+	const idx = client.index(indexName || getIndexName())
+	const tasks = [] as Promise<any>[]
+	for (let i = 0; i < docs.length; i += batchSize) {
+		const chunk = docs.slice(i, i + batchSize)
+		tasks.push(idx.addDocuments(chunk))
+	}
+	return Promise.all(tasks)
+}
+
+export default { batchIndexDocuments }

package/src/utils/search/telemetry.ts

@@ -0,0 +1,5 @@
+import { logSearchEvent } from './analytics'
+
+export { logSearchEvent, getTelemetryStats } from './analytics'
+
+export default { logSearchEvent: (event: any) => logSearchEvent(event) }