@faststore/api 1.9.8 → 1.9.14

package/dist/index.d.ts

@@ -51,8 +51,10 @@ export declare const getResolvers: (options: Options) => {
         description?: string | undefined;
         canonical?: string | undefined;
     }, unknown, any>>;
-    StoreFacet: Record<string, import("./platforms/vtex").Resolver<import("./platforms/vtex/clients/search/types/FacetSearchResult").Facet, unknown, any>>;
-    StoreFacetValue: Record<string, import("./platforms/vtex").Resolver<import("./platforms/vtex/clients/search/types/FacetSearchResult").FacetValue, unknown, any>>;
+    StoreFacet: Record<string, import("./platforms/vtex").Resolver<import("./platforms/vtex/clients/search/types/FacetSearchResult").Facet<import("./platforms/vtex/clients/search/types/FacetSearchResult").FacetValueBoolean | import("./platforms/vtex/clients/search/types/FacetSearchResult").FacetValueRange>, unknown, any>>;
+    StoreFacetBoolean: Record<string, import("./platforms/vtex").Resolver<import("./platforms/vtex/clients/search/types/FacetSearchResult").Facet<import("./platforms/vtex/clients/search/types/FacetSearchResult").FacetValueBoolean>, unknown, any>>;
+    StoreFacetRange: Record<string, import("./platforms/vtex").Resolver<import("./platforms/vtex/clients/search/types/FacetSearchResult").Facet<import("./platforms/vtex/clients/search/types/FacetSearchResult").FacetValueRange>, unknown, any>>;
+    StoreFacetValueBoolean: Record<string, import("./platforms/vtex").Resolver<import("./platforms/vtex/clients/search/types/FacetSearchResult").FacetValueBoolean, unknown, any>>;
     StoreOffer: Record<string, import("./platforms/vtex").Resolver<import("./platforms/vtex/utils/enhanceCommercialOffer").EnhancedCommercialOffer<import("./platforms/vtex/clients/search/types/ProductSearchResult").Seller, import("./platforms/vtex/clients/search/types/ProductSearchResult").Item & {
         isVariantOf: import("./platforms/vtex/clients/search/types/ProductSearchResult").Product;
     } & {

package/dist/platforms/vtex/clients/search/index.d.ts

@@ -1,6 +1,6 @@
 import type { Context, Options } from '../../index';
 import type { SelectedFacet } from '../../utils/facets';
-import type { FacetSearchResult } from './types/FacetSearchResult';
+import type { Facet, FacetValueBoolean, FacetSearchResult } from './types/FacetSearchResult';
 import type { ProductSearchResult, Suggestion } from './types/ProductSearchResult';
 export declare type Sort = 'price:desc' | 'price:asc' | 'orders:desc' | 'name:desc' | 'name:asc' | 'release:desc' | 'discount:desc' | '';
 export interface SearchArgs {
@@ -17,6 +17,7 @@ export interface ProductLocator {
     field: 'id' | 'slug';
     value: string;
 }
+export declare const isFacetBoolean: (facet: Facet) => facet is Facet<FacetValueBoolean>;
 export declare const IntelligentSearch: ({ account, environment, hideUnavailableItems }: Options, ctx: Context) => {
     facets: (args: Omit<SearchArgs, 'type'>) => Promise<FacetSearchResult>;
     products: (args: Omit<SearchArgs, 'type'>) => Promise<ProductSearchResult>;

package/dist/platforms/vtex/clients/search/types/FacetSearchResult.d.ts

@@ -3,26 +3,26 @@ export interface FacetSearchResult {
     facets: Facet[];
     breadcrumb: Breadcrumb;
 }
-export interface Facet {
+export interface Facet<T = FacetValueBoolean | FacetValueRange> {
     type: FilterType;
     name: string;
     hidden: boolean;
-    values: FacetValue[];
+    values: T[];
     quantity?: number;
-    key?: string;
+    key: string;
 }
-export interface FacetValue {
+export interface FacetValueBoolean {
     quantity: number;
     name: string;
     key: string;
     value: string;
-    selected?: boolean;
-    range?: {
+    selected: boolean;
+}
+export interface FacetValueRange {
+    range: {
         from: number;
         to: number;
     };
-    children?: FacetValue[];
-    id?: string;
 }
 interface Breadcrumb {
     href: string;

package/dist/platforms/vtex/index.d.ts

@@ -1,3 +1,4 @@
+import type { SearchArgs } from './clients/search';
 import type { Loaders } from './loaders';
 import type { Clients } from './clients';
 import type { Channel } from './utils/channel';
@@ -26,6 +27,7 @@ export interface Context {
         channel: Required<Channel>;
         locale: string;
         flags: FeatureFlags;
+        searchArgs?: Omit<SearchArgs, 'type'>;
     };
     headers: Record<string, string>;
 }
@@ -79,8 +81,10 @@ export declare const getResolvers: (_: Options) => {
         description?: string | undefined;
         canonical?: string | undefined;
     }, unknown, any>>;
-    StoreFacet: Record<string, Resolver<import("./clients/search/types/FacetSearchResult").Facet, unknown, any>>;
-    StoreFacetValue: Record<string, Resolver<import("./clients/search/types/FacetSearchResult").FacetValue, unknown, any>>;
+    StoreFacet: Record<string, Resolver<import("./clients/search/types/FacetSearchResult").Facet<import("./clients/search/types/FacetSearchResult").FacetValueBoolean | import("./clients/search/types/FacetSearchResult").FacetValueRange>, unknown, any>>;
+    StoreFacetBoolean: Record<string, Resolver<import("./clients/search/types/FacetSearchResult").Facet<import("./clients/search/types/FacetSearchResult").FacetValueBoolean>, unknown, any>>;
+    StoreFacetRange: Record<string, Resolver<import("./clients/search/types/FacetSearchResult").Facet<import("./clients/search/types/FacetSearchResult").FacetValueRange>, unknown, any>>;
+    StoreFacetValueBoolean: Record<string, Resolver<import("./clients/search/types/FacetSearchResult").FacetValueBoolean, unknown, any>>;
     StoreOffer: Record<string, Resolver<import("./utils/enhanceCommercialOffer").EnhancedCommercialOffer<import("./clients/search/types/ProductSearchResult").Seller, import("./clients/search/types/ProductSearchResult").Item & {
         isVariantOf: import("./clients/search/types/ProductSearchResult").Product;
     } & {
@@ -95,7 +99,7 @@ export declare const getResolvers: (_: Options) => {
     } & {
         attachmentsValues?: import("./clients/commerce/types/OrderForm").Attachment[] | undefined;
     }, unknown, any>>;
-    StoreSearchResult: Record<string, Resolver<Pick<import("./clients/search").SearchArgs, "hideUnavailableItems" | "query" | "page" | "count" | "sort" | "selectedFacets" | "fuzzy">, unknown, any>>;
+    StoreSearchResult: Record<string, Resolver<Pick<SearchArgs, "hideUnavailableItems" | "query" | "page" | "count" | "sort" | "selectedFacets" | "fuzzy">, unknown, any>>;
     StorePropertyValue: Record<string, Resolver<import("../..").IStorePropertyValue, unknown, any>>;
     ObjectOrString: import("graphql").GraphQLScalarType;
     Query: {

package/dist/platforms/vtex/resolvers/faceValue.d.ts

@@ -0,0 +1,3 @@
+import type { Resolver } from '..';
+import type { FacetValueBoolean } from '../clients/search/types/FacetSearchResult';
+export declare const StoreFacetValueBoolean: Record<string, Resolver<FacetValueBoolean>>;

package/dist/platforms/vtex/resolvers/facet.d.ts

@@ -1,5 +1,7 @@
+import type { FacetValueBoolean, Facet, FacetValueRange } from '../clients/search/types/FacetSearchResult';
 import type { Resolver } from '..';
-import type { Facet } from '../clients/search/types/FacetSearchResult';
 declare type Root = Facet;
 export declare const StoreFacet: Record<string, Resolver<Root>>;
+export declare const StoreFacetBoolean: Record<string, Resolver<Facet<FacetValueBoolean>>>;
+export declare const StoreFacetRange: Record<string, Resolver<Facet<FacetValueRange>>>;
 export {};

package/dist/platforms/vtex/utils/facets.d.ts

@@ -13,6 +13,7 @@ export declare const transformSelectedFacet: ({ key, value }: SelectedFacet) =>
     key: string;
     value: string;
 };
+export declare const parseRange: (range: string) => [number, number] | null;
 export declare const findSlug: (facets?: SelectedFacet[] | null | undefined) => string | null;
 export declare const findSkuId: (facets?: SelectedFacet[] | null | undefined) => string | null;
 export declare const findLocale: (facets?: SelectedFacet[] | null | undefined) => string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "1.9.8",
+  "version": "1.9.14",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -37,6 +37,7 @@
     "express-graphql": "^0.12.0",
     "graphql": "^15.6.0",
     "jest-transform-graphql": "^2.1.0",
+    "shared": "^1.9.14",
     "ts-jest": "25.5.1",
     "tsdx": "^0.14.1",
     "tslib": "^2.3.1",
@@ -45,5 +46,5 @@
   "peerDependencies": {
     "graphql": "^15.6.0"
   },
-  "gitHead": "f8e0cb3d43978426228addcc28055e537eaf7752"
+  "gitHead": "d37facb5b238781bb18ce48afb1b245e5c53038b"
 }

package/src/__generated__/schema.ts

@@ -321,17 +321,29 @@ export type StoreCurrency = {
   symbol: Scalars['String'];
 };
 
-/** Search facet information. */
-export type StoreFacet = {
-  __typename?: 'StoreFacet';
+export type StoreFacet = StoreFacetBoolean | StoreFacetRange;
+
+/** Search facet boolean information. */
+export type StoreFacetBoolean = {
+  __typename?: 'StoreFacetBoolean';
+  /** Facet key. */
+  key: Scalars['String'];
+  /** Facet label. */
+  label: Scalars['String'];
+  /** Array with information on each facet value. */
+  values: Array<StoreFacetValueBoolean>;
+};
+
+/** Search facet range information. */
+export type StoreFacetRange = {
+  __typename?: 'StoreFacetRange';
   /** Facet key. */
   key: Scalars['String'];
   /** Facet label. */
   label: Scalars['String'];
-  /** Facet type. Possible values are `BOOLEAN` and `RANGE`. */
-  type: StoreFacetType;
+  max: StoreFacetValueRange;
   /** Array with information on each facet value. */
-  values: Array<StoreFacetValue>;
+  min: StoreFacetValueRange;
 };
 
 /** Search facet type. */
@@ -343,8 +355,8 @@ export const enum StoreFacetType {
 };
 
 /** Information of a specific facet value. */
-export type StoreFacetValue = {
-  __typename?: 'StoreFacetValue';
+export type StoreFacetValueBoolean = {
+  __typename?: 'StoreFacetValueBoolean';
   /** Facet value label. */
   label: Scalars['String'];
   /** Number of items with this facet. */
@@ -355,6 +367,12 @@ export type StoreFacetValue = {
   value: Scalars['String'];
 };
 
+export type StoreFacetValueRange = {
+  __typename?: 'StoreFacetValueRange';
+  absolute: Scalars['Float'];
+  selected: Scalars['Float'];
+};
+
 /** Image. */
 export type StoreImage = {
   __typename?: 'StoreImage';

package/src/platforms/vtex/clients/search/index.ts

@@ -2,7 +2,11 @@ import { fetchAPI } from '../fetch'
 import type { IStoreSelectedFacet } from '../../../../__generated__/schema'
 import type { Context, Options } from '../../index'
 import type { SelectedFacet } from '../../utils/facets'
-import type { FacetSearchResult } from './types/FacetSearchResult'
+import type {
+  Facet,
+  FacetValueBoolean,
+  FacetSearchResult,
+} from './types/FacetSearchResult'
 import type {
   ProductSearchResult,
   Suggestion,
@@ -38,6 +42,10 @@ const POLICY_KEY = 'trade-policy'
 const REGION_KEY = 'region-id'
 const CHANNEL_KEYS = new Set([POLICY_KEY, REGION_KEY])
 
+export const isFacetBoolean = (
+  facet: Facet
+): facet is Facet<FacetValueBoolean> => facet.type === 'TEXT'
+
 export const IntelligentSearch = (
   { account, environment, hideUnavailableItems }: Options,
   ctx: Context

package/src/platforms/vtex/clients/search/types/FacetSearchResult.ts

@@ -4,27 +4,28 @@ export interface FacetSearchResult {
   breadcrumb: Breadcrumb
 }
 
-export interface Facet {
+export interface Facet<T = FacetValueBoolean | FacetValueRange> {
   type: FilterType
   name: string
   hidden: boolean
-  values: FacetValue[]
+  values: T[]
   quantity?: number
-  key?: string
+  key: string
 }
 
-export interface FacetValue {
+export interface FacetValueBoolean {
   quantity: number
   name: string
   key: string
   value: string
-  selected?: boolean
-  range?: {
+  selected: boolean
+}
+
+export interface FacetValueRange {
+  range: {
     from: number
     to: number
   }
-  children?: FacetValue[]
-  id?: string
 }
 
 interface Breadcrumb {

package/src/platforms/vtex/index.ts

@@ -1,24 +1,29 @@
 import { getClients } from './clients'
+import type { SearchArgs } from './clients/search'
 import { getLoaders } from './loaders'
 import { StoreAggregateOffer } from './resolvers/aggregateOffer'
 import { StoreAggregateRating } from './resolvers/aggregateRating'
 import { StoreCollection } from './resolvers/collection'
-import { StoreFacet } from './resolvers/facet'
-import { StoreFacetValue } from './resolvers/facetValue'
+import {
+  StoreFacet,
+  StoreFacetBoolean,
+  StoreFacetRange,
+} from './resolvers/facet'
+import { StoreFacetValueBoolean } from './resolvers/faceValue'
 import { Mutation } from './resolvers/mutation'
+import { ObjectOrString } from './resolvers/objectOrString'
 import { StoreOffer } from './resolvers/offer'
 import { StoreProduct } from './resolvers/product'
 import { StoreProductGroup } from './resolvers/productGroup'
+import { StorePropertyValue } from './resolvers/propertyValue'
 import { Query } from './resolvers/query'
 import { StoreReview } from './resolvers/review'
 import { StoreSearchResult } from './resolvers/searchResult'
 import { StoreSeo } from './resolvers/seo'
-import { ObjectOrString } from './resolvers/objectOrString'
-import { StorePropertyValue } from './resolvers/propertyValue'
+import ChannelMarshal from './utils/channel'
 import type { Loaders } from './loaders'
 import type { Clients } from './clients'
 import type { Channel } from './utils/channel'
-import ChannelMarshal from './utils/channel'
 
 export interface Options {
   platform: 'vtex'
@@ -48,6 +53,7 @@ export interface Context {
     channel: Required<Channel>
     locale: string
     flags: FeatureFlags
+    searchArgs?: Omit<SearchArgs, 'type'>
   }
   headers: Record<string, string>
 }
@@ -65,7 +71,9 @@ const Resolvers = {
   StoreProduct,
   StoreSeo,
   StoreFacet,
-  StoreFacetValue,
+  StoreFacetBoolean,
+  StoreFacetRange,
+  StoreFacetValueBoolean,
   StoreOffer,
   StoreAggregateRating,
   StoreReview,
@@ -77,16 +85,18 @@ const Resolvers = {
   Mutation,
 }
 
-export const getContextFactory = (options: Options) => (ctx: any): Context => {
-  ctx.storage = {
-    channel: ChannelMarshal.parse(options.channel),
-    flags: options.flags ?? {},
-    locale: options.locale,
-  }
-  ctx.clients = getClients(options, ctx)
-  ctx.loaders = getLoaders(options, ctx)
+export const getContextFactory =
+  (options: Options) =>
+  (ctx: any): Context => {
+    ctx.storage = {
+      channel: ChannelMarshal.parse(options.channel),
+      flags: options.flags ?? {},
+      locale: options.locale,
+    }
+    ctx.clients = getClients(options, ctx)
+    ctx.loaders = getLoaders(options, ctx)
 
-  return ctx
-}
+    return ctx
+  }
 
 export const getResolvers = (_: Options) => Resolvers

package/src/platforms/vtex/resolvers/faceValue.ts

@@ -0,0 +1,12 @@
+import type { Resolver } from '..'
+import type { FacetValueBoolean } from '../clients/search/types/FacetSearchResult'
+
+export const StoreFacetValueBoolean: Record<
+  string,
+  Resolver<FacetValueBoolean>
+> = {
+  value: ({ value }) => value,
+  label: ({ name }) => name || 'unknown',
+  selected: ({ selected }) => selected,
+  quantity: ({ quantity }) => quantity,
+}

package/src/platforms/vtex/resolvers/facet.ts

@@ -1,11 +1,72 @@
+import { parseRange } from '../utils/facets'
+import { min } from '../utils/orderStatistics'
+import type {
+  FacetValueBoolean,
+  Facet,
+  FacetValueRange,
+} from '../clients/search/types/FacetSearchResult'
 import type { Resolver } from '..'
-import type { Facet } from '../clients/search/types/FacetSearchResult'
 
 type Root = Facet
 
 export const StoreFacet: Record<string, Resolver<Root>> = {
-  key: ({ key }) => key ?? '',
-  label: ({ name }) => name ?? 'unknown',
-  values: ({ values }) => values,
-  type: ({ type }) => (type === 'TEXT' ? 'BOOLEAN' : 'RANGE'),
+  __resolveType: ({ type }) =>
+    type === 'TEXT' ? 'StoreFacetBoolean' : 'StoreFacetRange',
+}
+
+export const StoreFacetBoolean: Record<
+  string,
+  Resolver<Facet<FacetValueBoolean>>
+> = {
+  key: ({ key }) => key,
+  label: ({ name }) => name,
+  values: ({ values }) => values.sort((a, b) => a.name.localeCompare(b.name)),
+}
+
+export const StoreFacetRange: Record<
+  string,
+  Resolver<Facet<FacetValueRange>>
+> = {
+  key: ({ key }) => key,
+  label: ({ name }) => name,
+  min: ({ values, key }, _, { storage: { searchArgs } }) => {
+    /**
+     * Fetch the selected range the user queried.
+     *
+     * This is necessary because, differently from boolean facets, Search API does
+     * not return the selected values, making us have to implement it in here
+     */
+    const selectedRange = parseRange(
+      searchArgs?.selectedFacets?.find((facet) => facet.key === key)?.value ??
+        ''
+    )
+
+    const facet = min(values, (a, b) => a.range.from - b.range.from)
+    const globalMin = facet?.range.from ?? 0
+
+    return {
+      selected: selectedRange?.[0] ?? globalMin,
+      absolute: globalMin,
+    }
+  },
+  max: ({ values, key }, _, { storage: { searchArgs } }) => {
+    /**
+     * Fetch the selected range the user queried.
+     *
+     * This is necessary because, differently from boolean facets, Search API does
+     * not return the selected values, making us have to implement it in here
+     */
+    const selectedRange = parseRange(
+      searchArgs?.selectedFacets?.find((facet) => facet.key === key)?.value ??
+        ''
+    )
+
+    const facet = min(values, (a, b) => b.range.to - a.range.to)
+    const globalMax = facet?.range.to ?? 0
+
+    return {
+      selected: selectedRange?.[1] ?? globalMax,
+      absolute: globalMax,
+    }
+  },
 }

package/src/platforms/vtex/resolvers/offer.ts

@@ -87,7 +87,7 @@ export const StoreOffer: Record<string, Resolver<Root>> = {
   },
   listPrice: (root) => {
     if (isSearchItem(root)) {
-      return root.ListPrice
+      return root.ListPrice ?? 0
     }
 
     if (isOrderFormItem(root)) {

package/src/platforms/vtex/resolvers/searchResult.ts

@@ -1,11 +1,11 @@
+import { enhanceSku } from '../utils/enhanceSku'
 import type { Resolver } from '..'
 import type { SearchArgs } from '../clients/search'
 import type { Facet } from '../clients/search/types/FacetSearchResult'
-import { enhanceSku } from '../utils/enhanceSku'
 
 type Root = Omit<SearchArgs, 'type'>
 
-const REMOVED_FACETS_FROM_COLLECTION_PAGE = ['departamento', 'Departamento']
+const isRootFacet = (facet: Facet) => facet.key === 'category-1'
 
 export const StoreSearchResult: Record<string, Resolver<Root>> = {
   suggestions: async (searchArgs, _, ctx) => {
@@ -90,33 +90,16 @@ export const StoreSearchResult: Record<string, Resolver<Root>> = {
       clients: { search: is },
     } = ctx
 
-    const { facets } = await is.facets(searchArgs)
-
-    const isCollectionPage = !searchArgs.query
-    const filteredFacets = facets?.reduce((acc, currentFacet) => {
-      const shouldFilterFacet = REMOVED_FACETS_FROM_COLLECTION_PAGE.includes(
-        currentFacet.name
-      )
-
-      const shouldRemoveFacetFromCollectionPage =
-        isCollectionPage && shouldFilterFacet
+    ctx.storage.searchArgs = searchArgs
 
-      if (shouldRemoveFacetFromCollectionPage) {
-        return acc
-      }
-
-      currentFacet.values.sort((a, b) => {
-        const firstItemLabel = a.name ?? ''
-        const secondItemLabel = b.name ?? ''
+    const { facets = [] } = await is.facets(searchArgs)
 
-        return firstItemLabel.localeCompare(secondItemLabel)
-      })
-
-      acc.push(currentFacet)
+    const isCollectionPage = !searchArgs.query
 
-      return acc
-    }, [] as Facet[])
+    const filteredFacets = facets
+      // Remove root facet on category pages
+      .filter((facet) => !isCollectionPage || !isRootFacet(facet))
 
-    return filteredFacets ?? []
+    return filteredFacets
   },
 }

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

@@ -29,11 +29,29 @@ export const transformSelectedFacet = ({ key, value }: SelectedFacet) => {
       return [] // remove this facet from search
     }
 
+    case 'price': {
+      return { key, value: value.replace('-to-', ':') }
+    }
+
     default:
       return { key, value }
   }
 }
 
+export const parseRange = (range: string): [number, number] | null => {
+  const splitted = range.split(':').map(Number)
+
+  if (
+    splitted.length !== 2 ||
+    Number.isNaN(splitted[0]) ||
+    Number.isNaN(splitted[1])
+  ) {
+    return null
+  }
+
+  return splitted as [number, number]
+}
+
 export const findSlug = (facets?: Maybe<SelectedFacet[]>) =>
   facets?.find((x) => x.key === 'slug')?.value ?? null
 

package/src/typeDefs/facet.graphql

@@ -1,7 +1,9 @@
+union StoreFacet = StoreFacetRange | StoreFacetBoolean
+
 """
-Search facet information.
+Search facet range information.
 """
-type StoreFacet {
+type StoreFacetRange {
   """
   Facet key.
   """
@@ -13,17 +15,37 @@ type StoreFacet {
   """
   Array with information on each facet value.
   """
-  values: [StoreFacetValue!]!
+  min: StoreFacetValueRange!
+  max: StoreFacetValueRange!
+}
+
+"""
+Search facet boolean information.
+"""
+type StoreFacetBoolean {
+  """
+  Facet key.
+  """
+  key: String!
+  """
+  Facet label.
+  """
+  label: String!
   """
-  Facet type. Possible values are `BOOLEAN` and `RANGE`.
+  Array with information on each facet value.
   """
-  type: StoreFacetType!
+  values: [StoreFacetValueBoolean!]!
+}
+
+type StoreFacetValueRange {
+  absolute: Float!
+  selected: Float!
 }
 
 """
 Information of a specific facet value.
 """
-type StoreFacetValue {
+type StoreFacetValueBoolean {
   """
   Facet value.
   """

package/dist/platforms/vtex/resolvers/facetValue.d.ts

@@ -1,5 +0,0 @@
-import type { Resolver } from '..';
-import type { FacetValue } from '../clients/search/types/FacetSearchResult';
-declare type Root = FacetValue;
-export declare const StoreFacetValue: Record<string, Resolver<Root>>;
-export {};

package/src/platforms/vtex/resolvers/facetValue.ts

@@ -1,12 +0,0 @@
-import type { Resolver } from '..'
-import type { FacetValue } from '../clients/search/types/FacetSearchResult'
-
-type Root = FacetValue
-
-export const StoreFacetValue: Record<string, Resolver<Root>> = {
-  value: ({ value, range }) =>
-    value ?? `${range?.from ?? ''}-to-${range?.to ?? ''}`,
-  label: ({ name }) => name || 'unknown',
-  selected: ({ selected }) => selected,
-  quantity: ({ quantity }) => quantity,
-}