@porulle/adapter-meilisearch 0.1.0

package/README.md

@@ -0,0 +1,44 @@
+# @porulle/adapter-meilisearch
+
+`SearchAdapter` for [Meilisearch](https://www.meilisearch.com). Indexes catalog entities and answers `/api/search` and `/api/search/suggest` queries.
+
+## Usage
+
+```ts
+import { defineConfig } from "@porulle/core";
+import { meilisearchAdapter } from "@porulle/adapter-meilisearch";
+import { MeiliSearch } from "meilisearch";
+
+const meili = new MeiliSearch({
+  host: process.env.MEILI_HOST!,
+  apiKey: process.env.MEILI_KEY!,
+});
+
+export default defineConfig({
+  search: {
+    adapter: meilisearchAdapter({
+      client: meili,
+      indexName: "porulle_catalog",
+    }),
+  },
+  // …
+});
+```
+
+## What it does
+
+- Adds documents on catalog create/update via the kernel's `catalog.afterCreate` / `afterUpdate` hooks
+- Removes documents on `catalog.afterDelete`
+- Configures filterable attributes per the indexed schema
+- Maps Meili's hits + facetDistribution into Porulle's `SearchQueryResult` shape
+
+## Notes
+
+- Bring your own Meilisearch instance — local Docker, Meilisearch Cloud, or self-hosted.
+- The adapter assumes one index per organization or per tenant; configure the `indexName` accordingly.
+- For Postgres-only deployments without a separate search service, use `@porulle/adapter-pg-search`.
+
+## See also
+
+- [Meilisearch docs](https://www.meilisearch.com/docs)
+- `@porulle/adapter-pg-search` — Postgres FTS alternative (no extra service)

package/dist/src/index.d.ts

@@ -0,0 +1,32 @@
+import { type SearchAdapter, type SearchDocument } from "@porulle/core";
+interface MeiliIndexLike {
+    addDocuments(documents: SearchDocument[]): Promise<unknown>;
+    deleteDocuments(ids: string[]): Promise<unknown>;
+    search(query: string, options?: {
+        filter?: string | string[];
+        facets?: string[];
+        limit?: number;
+        offset?: number;
+        attributesToRetrieve?: string[];
+    }): Promise<{
+        hits: Array<SearchDocument & {
+            _rankingScore?: number;
+        }>;
+        estimatedTotalHits?: number;
+        facetDistribution?: Record<string, Record<string, number>>;
+    }>;
+    updateFilterableAttributes(attributes: string[]): Promise<unknown>;
+}
+interface MeiliClientLike {
+    index(uid: string): MeiliIndexLike;
+}
+export interface MeilisearchAdapterOptions {
+    host: string;
+    apiKey?: string;
+    indexName?: string;
+    filterableAttributes?: string[];
+    client?: MeiliClientLike;
+}
+export declare function meilisearchAdapter(options: MeilisearchAdapterOptions): SearchAdapter;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAwB,KAAK,aAAa,EAAE,KAAK,cAAc,EAA4E,MAAM,eAAe,CAAC;AAExK,UAAU,cAAc;IACtB,YAAY,CAAC,SAAS,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5D,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACjD,MAAM,CACJ,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QAC3B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;KACjC,GACA,OAAO,CAAC;QACT,IAAI,EAAE,KAAK,CAAC,cAAc,GAAG;YAAE,aAAa,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QACzD,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;KAC5D,CAAC,CAAC;IACH,0BAA0B,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACpE;AAED,UAAU,eAAe;IACvB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAC;CACpC;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B;AAgDD,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,aAAa,CAgGpF"}

package/dist/src/index.js

@@ -0,0 +1,125 @@
+import { MeiliSearch } from "meilisearch";
+import { Err, Ok } from "@porulle/core";
+function toFilter(params) {
+    const filters = [];
+    if (params.filters?.type) {
+        filters.push(`type = \"${params.filters.type}\"`);
+    }
+    if (params.filters?.status) {
+        filters.push(`status = \"${params.filters.status}\"`);
+    }
+    if (params.filters?.category) {
+        filters.push(`categories = \"${params.filters.category}\"`);
+    }
+    if (params.filters?.brand) {
+        filters.push(`brands = \"${params.filters.brand}\"`);
+    }
+    return filters;
+}
+function normalizeSearchResult(params, result) {
+    const page = params.page ?? 1;
+    const limit = params.limit ?? 20;
+    return {
+        hits: result.hits.map((document) => ({
+            id: document.id,
+            ...(document._rankingScore !== undefined ? { score: document._rankingScore } : {}),
+            document,
+        })),
+        total: result.estimatedTotalHits ?? result.hits.length,
+        page,
+        limit,
+        facets: result.facetDistribution ?? {},
+    };
+}
+export function meilisearchAdapter(options) {
+    const client = options.client ?? new MeiliSearch({ host: options.host, ...(options.apiKey ? { apiKey: options.apiKey } : {}) });
+    const indexName = options.indexName ?? "catalog";
+    const filterable = options.filterableAttributes ?? ["type", "status", "categories", "brands"];
+    let filterableConfigured = false;
+    async function ensureFilterable(index) {
+        if (filterableConfigured)
+            return;
+        await index.updateFilterableAttributes(filterable);
+        filterableConfigured = true;
+    }
+    return {
+        providerId: "meilisearch",
+        async index(documents) {
+            try {
+                if (documents.length === 0)
+                    return Ok(undefined);
+                const index = client.index(indexName);
+                await ensureFilterable(index);
+                await index.addDocuments(documents);
+                return Ok(undefined);
+            }
+            catch (error) {
+                return Err({
+                    code: "MEILISEARCH_INDEX_FAILED",
+                    message: error instanceof Error ? error.message : "Failed to index Meilisearch documents.",
+                });
+            }
+        },
+        async remove(ids) {
+            try {
+                if (ids.length === 0)
+                    return Ok(undefined);
+                const index = client.index(indexName);
+                await index.deleteDocuments(ids);
+                return Ok(undefined);
+            }
+            catch (error) {
+                return Err({
+                    code: "MEILISEARCH_DELETE_FAILED",
+                    message: error instanceof Error ? error.message : "Failed to delete Meilisearch documents.",
+                });
+            }
+        },
+        async search(params) {
+            try {
+                const page = params.page ?? 1;
+                const limit = params.limit ?? 20;
+                const offset = (page - 1) * limit;
+                const filters = toFilter(params);
+                const index = client.index(indexName);
+                const result = await index.search(params.query, {
+                    ...(filters.length > 0 ? { filter: filters } : {}),
+                    facets: params.facets ?? ["type", "status", "categories", "brands"],
+                    limit,
+                    offset,
+                });
+                return Ok(normalizeSearchResult({ ...params, page, limit }, result));
+            }
+            catch (error) {
+                return Err({
+                    code: "MEILISEARCH_QUERY_FAILED",
+                    message: error instanceof Error ? error.message : "Meilisearch query failed.",
+                });
+            }
+        },
+        async suggest(params) {
+            try {
+                const index = client.index(indexName);
+                const result = await index.search(params.prefix, {
+                    ...(params.type ? { filter: [`type = \"${params.type}\"`] } : {}),
+                    attributesToRetrieve: ["title"],
+                    limit: params.limit ?? 10,
+                });
+                const prefix = params.prefix.toLowerCase();
+                const suggestions = result.hits
+                    .map((hit) => hit.title)
+                    .filter((title) => typeof title === "string")
+                    .filter((title, index, list) => list.indexOf(title) === index)
+                    .filter((title) => title.toLowerCase().startsWith(prefix))
+                    .slice(0, params.limit ?? 10);
+                return Ok(suggestions);
+            }
+            catch (error) {
+                return Err({
+                    code: "MEILISEARCH_SUGGEST_FAILED",
+                    message: error instanceof Error ? error.message : "Meilisearch suggest failed.",
+                });
+            }
+        },
+    };
+}