@reactionary/magento 0.10.24 → 0.10.26

package/capabilities/product-search.capability.js

@@ -19,6 +19,8 @@ import {
 } from "@reactionary/core";
 import createDebug from "debug";
 const debug = createDebug("reactionary:magento:search");
+const CATEGORY_FACET_KEY = "categories";
+const CATEGORY_FIELD = "category_id";
 class MagentoProductSearchCapability extends ProductSearchCapability {
   constructor(config, cache, context, magentoApi, factory) {
     super(cache, context);
@@ -34,38 +36,26 @@ class MagentoProductSearchCapability extends ProductSearchCapability {
     const pageSize = payload.search.paginationOptions.pageSize;
     const currentPage = payload.search.paginationOptions.pageNumber;
     const params = new URLSearchParams();
-    let filterGroupIndex = 0;
+    const filterGroups = [];
     if (finalSearch) {
-      params.set(
-        `searchCriteria[filterGroups][${filterGroupIndex}][filters][0][field]`,
-        "name"
-      );
-      params.set(
-        `searchCriteria[filterGroups][${filterGroupIndex}][filters][0][value]`,
-        `%${finalSearch}%`
-      );
-      params.set(
-        `searchCriteria[filterGroups][${filterGroupIndex}][filters][0][condition_type]`,
-        "like"
-      );
-      filterGroupIndex++;
+      filterGroups.push([{ field: "name", value: `%${finalSearch}%`, conditionType: "like" }]);
     }
     if (payload.search.categoryFilter?.key) {
       debug(`Applying category filter: ${payload.search.categoryFilter.key}`);
-      params.set(
-        `searchCriteria[filterGroups][${filterGroupIndex}][filters][0][field]`,
-        "category_id"
-      );
-      params.set(
-        `searchCriteria[filterGroups][${filterGroupIndex}][filters][0][value]`,
-        payload.search.categoryFilter.key
-      );
-      params.set(
-        `searchCriteria[filterGroups][${filterGroupIndex}][filters][0][condition_type]`,
-        "eq"
-      );
-      filterGroupIndex++;
+      filterGroups.push([
+        { field: CATEGORY_FIELD, value: payload.search.categoryFilter.key, conditionType: "eq" }
+      ]);
     }
+    filterGroups.push(...this.getFacetFilterGroups(payload.search.facets));
+    filterGroups.push(...this.getStorefrontScopeFilterGroups());
+    filterGroups.forEach((filters, groupIndex) => {
+      filters.forEach((filter, filterIndex) => {
+        const prefix = `searchCriteria[filterGroups][${groupIndex}][filters][${filterIndex}]`;
+        params.set(`${prefix}[field]`, filter.field);
+        params.set(`${prefix}[value]`, filter.value);
+        params.set(`${prefix}[condition_type]`, filter.conditionType);
+      });
+    });
     params.set("searchCriteria[pageSize]", String(pageSize));
     params.set("searchCriteria[currentPage]", String(currentPage));
     const client = await this.magentoApi.getClient();
@@ -78,9 +68,50 @@ class MagentoProductSearchCapability extends ProductSearchCapability {
     }
     return success(result);
   }
+  /**
+   * One filter group per facet code: Magento ORs the filters within a group and ANDs
+   * the groups, so values of one facet widen the result and distinct facets narrow it.
+   * The facet code is the Magento attribute code and the facet value key its (option) value.
+   *
+   * The category navigation facet created by {@link createCategoryNavigationFilter} is the
+   * exception: Magento's `category_id` filter (ProductCategoryFilter) ANDs the filters of a
+   * group, so its values are OR-ed through a single `category_id in (...)` filter instead.
+   */
+  getFacetFilterGroups(facets) {
+    const groups = /* @__PURE__ */ new Map();
+    const categoryIds = [];
+    for (const facetValue of facets) {
+      if (facetValue.facet.key === CATEGORY_FACET_KEY) {
+        categoryIds.push(facetValue.key);
+        continue;
+      }
+      const field = facetValue.facet.key;
+      const group = groups.get(field) ?? [];
+      group.push({ field, value: facetValue.key, conditionType: "eq" });
+      groups.set(field, group);
+    }
+    if (categoryIds.length > 0) {
+      groups.set(CATEGORY_FIELD, [
+        { field: CATEGORY_FIELD, value: categoryIds.join(","), conditionType: "in" }
+      ]);
+    }
+    return [...groups.values()];
+  }
+  /**
+   * Restricts results to what a storefront may show: enabled products that are visible in
+   * the catalog (visibility 2 = Catalog, 4 = Catalog, Search). The admin REST product search
+   * does not apply this itself, so without it disabled products and "Not Visible
+   * Individually" (1) configurable children would be listed.
+   */
+  getStorefrontScopeFilterGroups() {
+    return [
+      [{ field: "status", value: "1", conditionType: "eq" }],
+      [{ field: "visibility", value: "2,4", conditionType: "in" }]
+    ];
+  }
   async createCategoryNavigationFilter(payload) {
     const facetIdentifier = FacetIdentifierSchema.parse({
-      key: "categories"
+      key: CATEGORY_FACET_KEY
     });
     const facetValueIdentifier = FacetValueIdentifierSchema.parse({
       facet: facetIdentifier,

package/factories/product/product.factory.js

@@ -1,5 +1,6 @@
 import {
   CategoryIdentifierSchema,
+  ProductComplianceDataSchema,
   ProductIdentifierSchema
 } from "@reactionary/core";
 import { getProductKey, parseDamImages } from "../../utils/magento-product.js";
@@ -27,6 +28,9 @@ class MagentoProductFactory {
   }
   config;
   productSchema;
+  parseComplianceData(context, data) {
+    return ProductComplianceDataSchema.parse({});
+  }
   parseProduct(_context, data) {
     const sku = data.sku;
     const identifier = ProductIdentifierSchema.parse({ key: getProductKey(data) });
@@ -50,7 +54,8 @@ class MagentoProductFactory {
       published: true,
       sharedAttributes,
       slug,
-      variants: []
+      variants: [],
+      complianceData: this.parseComplianceData(_context, data)
     };
     return this.productSchema.parse(result);
   }

package/factories/product-search/product-search.factory.js

@@ -1,5 +1,6 @@
 import {
   ImageSchema,
+  ProductSearchResultItemComplianceDataSchema,
   ProductSearchResultItemVariantSchema,
   ProductVariantIdentifierSchema
 } from "@reactionary/core";
@@ -48,6 +49,9 @@ class MagentoProductSearchFactory {
     };
     return this.productSearchResultSchema.parse(result);
   }
+  parseComplianceData(product) {
+    return ProductSearchResultItemComplianceDataSchema.parse({});
+  }
   parseProductSearchResultItem(_context, product) {
     const idKey = product.id !== void 0 ? String(product.id) : product.sku;
     const identifier = { key: idKey };
@@ -61,7 +65,8 @@ class MagentoProductSearchFactory {
       identifier,
       name,
       slug,
-      variants
+      variants,
+      complianceData: this.parseComplianceData(product)
     };
   }
   parseVariant(variant, product) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reactionary/magento",
-  "version": "0.10.24",
+  "version": "0.10.26",
   "type": "module",
   "main": "./index.js",
   "types": "./src/index.d.ts",
@@ -9,7 +9,7 @@
     "url": "git+https://github.com/Solteq/reactionary.git"
   },
   "dependencies": {
-    "@reactionary/core": "0.10.24",
+    "@reactionary/core": "0.10.26",
     "zod": "4.1.9",
     "debug": "^4.4.3"
   },

package/src/capabilities/product-search.capability.d.ts

@@ -2,14 +2,37 @@ import { ProductSearchCapability, type Cache, type FacetIdentifier, type FacetVa
 import type { MagentoConfiguration } from '../schema/configuration.schema.js';
 import type { MagentoClient } from '../core/client.js';
 import type { MagentoProductSearchFactory } from '../factories/product-search/product-search.factory.js';
+interface MagentoSearchFilter {
+    field: string;
+    value: string;
+    conditionType: 'eq' | 'in' | 'like';
+}
 export declare class MagentoProductSearchCapability<TFactory extends ProductSearchFactory = MagentoProductSearchFactory> extends ProductSearchCapability<ProductSearchFactoryOutput<TFactory>> {
     magentoApi: MagentoClient;
     protected config: MagentoConfiguration;
     protected factory: ProductSearchFactoryWithOutput<TFactory>;
     constructor(config: MagentoConfiguration, cache: Cache, context: RequestContext, magentoApi: MagentoClient, factory: ProductSearchFactoryWithOutput<TFactory>);
     queryByTerm(payload: ProductSearchQueryByTerm): Promise<Result<ProductSearchFactoryOutput<TFactory>>>;
+    /**
+     * One filter group per facet code: Magento ORs the filters within a group and ANDs
+     * the groups, so values of one facet widen the result and distinct facets narrow it.
+     * The facet code is the Magento attribute code and the facet value key its (option) value.
+     *
+     * The category navigation facet created by {@link createCategoryNavigationFilter} is the
+     * exception: Magento's `category_id` filter (ProductCategoryFilter) ANDs the filters of a
+     * group, so its values are OR-ed through a single `category_id in (...)` filter instead.
+     */
+    protected getFacetFilterGroups(facets: FacetValueIdentifier[]): MagentoSearchFilter[][];
+    /**
+     * Restricts results to what a storefront may show: enabled products that are visible in
+     * the catalog (visibility 2 = Catalog, 4 = Catalog, Search). The admin REST product search
+     * does not apply this itself, so without it disabled products and "Not Visible
+     * Individually" (1) configurable children would be listed.
+     */
+    protected getStorefrontScopeFilterGroups(): MagentoSearchFilter[][];
     createCategoryNavigationFilter(payload: ProductSearchQueryCreateNavigationFilter): Promise<Result<FacetValueIdentifier>>;
     protected parseFacetValue(_facetValueIdentifier: FacetValueIdentifier, _label: string, _count: number): ProductSearchResultFacetValue;
     protected parseFacet(_facetIdentifier: FacetIdentifier, _facetValue: unknown): ProductSearchResultFacet;
     protected parseVariant(): never;
 }
+export {};

package/src/factories/product/product.factory.d.ts

@@ -1,4 +1,4 @@
-import { type AnyProductSchema, type Image, type ProductAttribute, type ProductFactory, type ProductSchema, type ProductVariant, type RequestContext } from '@reactionary/core';
+import { type AnyProductSchema, type Image, type ProductAttribute, type ProductComplianceData, type ProductFactory, type ProductSchema, type ProductVariant, type RequestContext } from '@reactionary/core';
 import type * as z from 'zod';
 import type { MagentoConfiguration } from '../../schema/configuration.schema.js';
 import type { MagentoProduct } from '../../schema/magento.types.js';
@@ -6,6 +6,7 @@ export declare class MagentoProductFactory<TProductSchema extends AnyProductSche
     protected config: MagentoConfiguration;
     readonly productSchema: TProductSchema;
     constructor(productSchema: TProductSchema, config: MagentoConfiguration);
+    protected parseComplianceData(context: RequestContext, data: MagentoProduct): ProductComplianceData;
     parseProduct(_context: RequestContext, data: MagentoProduct): z.output<TProductSchema>;
     protected parseVariant(product: MagentoProduct): ProductVariant;
     protected parseImages(product: MagentoProduct): Image[];

package/src/factories/product-search/product-search.factory.d.ts

@@ -1,4 +1,4 @@
-import { type AnyProductSearchResultSchema, type ProductSearchFactory, type ProductSearchQueryByTerm, type ProductSearchResultItem, type ProductSearchResultItemVariant, type ProductSearchResultSchema, type RequestContext } from '@reactionary/core';
+import { type AnyProductSearchResultSchema, type ProductSearchFactory, type ProductSearchQueryByTerm, type ProductSearchResultItem, type ProductSearchResultItemComplianceData, type ProductSearchResultItemVariant, type ProductSearchResultSchema, type RequestContext } from '@reactionary/core';
 import type * as z from 'zod';
 import type { MagentoConfiguration } from '../../schema/configuration.schema.js';
 import type { MagentoProduct, MagentoProductSearchResult } from '../../schema/magento.types.js';
@@ -7,6 +7,7 @@ export declare class MagentoProductSearchFactory<TProductSearchResultSchema exte
     readonly productSearchResultSchema: TProductSearchResultSchema;
     constructor(productSearchResultSchema: TProductSearchResultSchema, config: MagentoConfiguration);
     parseSearchResult(context: RequestContext, data: MagentoProductSearchResult, query: ProductSearchQueryByTerm): z.output<TProductSearchResultSchema>;
+    protected parseComplianceData(product: MagentoProduct): ProductSearchResultItemComplianceData;
     protected parseProductSearchResultItem(_context: RequestContext, product: MagentoProduct): ProductSearchResultItem;
     protected parseVariant(variant: MagentoProduct, product: MagentoProduct): ProductSearchResultItemVariant;
 }

package/utils/magento-product.js

@@ -1,5 +1,6 @@
 import {
   ImageSchema,
+  ProductSearchResultItemComplianceDataSchema,
   ProductSearchResultItemVariantSchema,
   ProductVariantIdentifierSchema
 } from "@reactionary/core";
@@ -96,9 +97,13 @@ function buildProductSearchResultItem(config, product) {
     identifier: { key: getProductKey(product) },
     name: product.name || product.sku,
     slug: getCustomAttribute(product, "url_key") ?? getCustomAttribute(product, "url_path") ?? "",
-    variants
+    variants,
+    complianceData: buildProductComplianceData(product)
   };
 }
+function buildProductComplianceData(product) {
+  return ProductSearchResultItemComplianceDataSchema.parse({});
+}
 export {
   buildMagentoImageUrl,
   buildProductSearchResultItem,