@faststore/api 1.9.14 → 1.10.6

package/src/platforms/vtex/utils/facets.ts

@@ -1,11 +1,26 @@
 import ChannelMarshal from './channel'
 import type { Maybe } from '../../../__generated__/schema'
+import { BadRequestError } from '../../errors'
 
 export interface SelectedFacet {
   key: string
   value: string
 }
 
+export interface CrossSellingFacet {
+  key: keyof typeof FACET_CROSS_SELLING_MAP
+  value: string
+}
+
+export const FACET_CROSS_SELLING_MAP = {
+  buy: "whoboughtalsobought",
+  view: "whosawalsosaw",
+  similars: "similars",
+  viewAndBought: "whosawalsobought",
+  accessories: "accessories",
+  suggestions: "suggestions",
+} as const
+
 /**
  * Transform facets from the store to VTEX platform facets.
  * For instance, the channel in Store becomes trade-policy and regionId in VTEX's realm
@@ -33,6 +48,15 @@ export const transformSelectedFacet = ({ key, value }: SelectedFacet) => {
       return { key, value: value.replace('-to-', ':') }
     }
 
+    case "buy":
+    case "view":
+    case "similars":
+    case "viewAndBought":
+    case "accessories":
+    case "suggestions": {
+      return [] // remove this facet from search
+    }
+
     default:
       return { key, value }
   }
@@ -52,6 +76,23 @@ export const parseRange = (range: string): [number, number] | null => {
   return splitted as [number, number]
 }
 
+export const isCrossSelling = (
+  x: string,
+): x is CrossSellingFacet['key'] =>
+  typeof (FACET_CROSS_SELLING_MAP as Record<string, string>)[x] === "string"
+
+export const findCrossSelling = (facets?: Maybe<SelectedFacet[]>) => {
+  const filtered = facets?.filter((x): x is CrossSellingFacet => isCrossSelling(x.key))
+
+  if (Array.isArray(filtered) && filtered.length > 1) {
+    throw new BadRequestError(
+      `You passed ${filtered.length} cross selling facets but only one is allowed. Please leave one of the following facet: ${filtered.map(x => x.key).join(',')}`
+    )
+  }
+
+  return filtered?.[0] ?? null
+}
+
 export const findSlug = (facets?: Maybe<SelectedFacet[]>) =>
   facets?.find((x) => x.key === 'slug')?.value ?? null
 

package/src/typeDefs/facet.graphql

@@ -13,9 +13,12 @@ type StoreFacetRange {
   """
   label: String!
   """
-  Array with information on each facet value.
+  Minimum facet range value.
   """
   min: StoreFacetValueRange!
+  """
+  Maximum facet range value.
+  """
   max: StoreFacetValueRange!
 }
 
@@ -37,8 +40,17 @@ type StoreFacetBoolean {
   values: [StoreFacetValueBoolean!]!
 }
 
+"""
+Search facet range value information. Used for minimum and maximum range values.
+"""
 type StoreFacetValueRange {
+  """
+  Search facet range absolute value.
+  """
   absolute: Float!
+  """
+  Search facet range selected value.
+  """
   selected: Float!
 }