@porulle/adapter-meilisearch 0.10.8 → 0.11.0

package/dist/src/index.d.ts

@@ -16,6 +16,7 @@ interface MeiliIndexLike {
         facetDistribution?: Record<string, Record<string, number>>;
     }>;
     updateFilterableAttributes(attributes: string[]): Promise<unknown>;
+    getFilterableAttributes?(): Promise<unknown>;
 }
 interface MeiliClientLike {
     index(uid: string): MeiliIndexLike;

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

@@ -1 +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"}
+{"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;IACnE,uBAAuB,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;CAC9C;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;AAgFD,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,aAAa,CAmHpF"}

package/dist/src/index.js

@@ -1,5 +1,6 @@
 import { MeiliSearch } from "meilisearch";
 import { Err, Ok } from "@porulle/core";
+const SAFE_ATTRIBUTE_NAME = /^[A-Za-z0-9_-]+$/;
 function toFilter(params) {
     const filters = [];
     if (params.filters?.type) {
@@ -14,8 +15,33 @@ function toFilter(params) {
     if (params.filters?.brand) {
         filters.push(`brands = \"${params.filters.brand}\"`);
     }
+    for (const [name, requested] of Object.entries(params.filters?.attributes ?? {})) {
+        const values = Array.isArray(requested) ? requested : [requested];
+        if (values.length === 0 || !SAFE_ATTRIBUTE_NAME.test(name)) {
+            filters.push('id = ""');
+            continue;
+        }
+        const expressions = values.map((value) => `attributes.${name} = ${JSON.stringify(value)}`);
+        if (expressions.length > 1) {
+            filters.push(`(${expressions.join(" OR ")})`);
+        }
+        else if (expressions.length === 1) {
+            filters.push(expressions[0]);
+        }
+    }
     return filters;
 }
+function normalizeFacets(facets) {
+    return Object.fromEntries(Object.entries(facets).map(([name, values]) => [
+        name.startsWith("attributes.") ? name.slice("attributes.".length) : name,
+        values,
+    ]));
+}
+function toFacetName(name) {
+    if (["type", "status", "category", "categories", "brand", "brands"].includes(name))
+        return name;
+    return name.startsWith("attributes.") ? name : `attributes.${name}`;
+}
 function normalizeSearchResult(params, result) {
     const page = params.page ?? 1;
     const limit = params.limit ?? 20;
@@ -28,19 +54,37 @@ function normalizeSearchResult(params, result) {
         total: result.estimatedTotalHits ?? result.hits.length,
         page,
         limit,
-        facets: result.facetDistribution ?? {},
+        facets: normalizeFacets(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)
+    const attributeNames = new Set();
+    let configuredFilterable;
+    async function ensureFilterable(index, documents) {
+        for (const document of documents) {
+            for (const name of Object.keys(document.attributes ?? {})) {
+                if (SAFE_ATTRIBUTE_NAME.test(name))
+                    attributeNames.add(name);
+            }
+        }
+        if (configuredFilterable === undefined && index.getFilterableAttributes) {
+            const stored = await index.getFilterableAttributes();
+            configuredFilterable = Array.isArray(stored)
+                ? stored.filter((name) => typeof name === "string")
+                : [];
+        }
+        const nextFilterable = [
+            ...(configuredFilterable ?? []),
+            ...filterable,
+            ...[...attributeNames].map((name) => `attributes.${name}`),
+        ].filter((name, position, list) => list.indexOf(name) === position);
+        if (configuredFilterable?.length === nextFilterable.length && configuredFilterable.every((name, index) => name === nextFilterable[index]))
             return;
-        await index.updateFilterableAttributes(filterable);
-        filterableConfigured = true;
+        await index.updateFilterableAttributes(nextFilterable);
+        configuredFilterable = nextFilterable;
     }
     return {
         providerId: "meilisearch",
@@ -49,7 +93,7 @@ export function meilisearchAdapter(options) {
                 if (documents.length === 0)
                     return Ok(undefined);
                 const index = client.index(indexName);
-                await ensureFilterable(index);
+                await ensureFilterable(index, documents);
                 await index.addDocuments(documents);
                 return Ok(undefined);
             }
@@ -82,9 +126,11 @@ export function meilisearchAdapter(options) {
                 const offset = (page - 1) * limit;
                 const filters = toFilter(params);
                 const index = client.index(indexName);
+                const requestedFacets = (params.facets ?? ["type", "status", "categories", "brands"]).map(toFacetName);
+                const facets = requestedFacets.filter((name, position, list) => list.indexOf(name) === position);
                 const result = await index.search(params.query, {
                     ...(filters.length > 0 ? { filter: filters } : {}),
-                    facets: params.facets ?? ["type", "status", "categories", "brands"],
+                    facets,
                     limit,
                     offset,
                 });