@faststore/api 1.7.32 → 1.7.33

package/src/platforms/vtex/clients/fetch.ts

@@ -4,7 +4,7 @@ export const fetchAPI = async (info: RequestInfo, init?: RequestInit) => {
   const response = await fetch(info, init)
 
   if (response.ok) {
-    return response.json()
+    return response.status !== 204 ? response.json() : undefined
   }
 
   console.error(info, init, response)

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

@@ -1,5 +1,6 @@
 import { VtexCommerce } from './commerce'
 import { IntelligentSearch } from './search'
+import { SP } from './sp'
 import type { Context, Options } from '..'
 
 export type Clients = ReturnType<typeof getClients>
@@ -7,9 +8,11 @@ export type Clients = ReturnType<typeof getClients>
 export const getClients = (options: Options, ctx: Context) => {
   const search = IntelligentSearch(options, ctx)
   const commerce = VtexCommerce(options, ctx)
+  const sp = SP(options, ctx)
 
   return {
     search,
     commerce,
+    sp,
   }
 }

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

@@ -2,7 +2,7 @@ import type { Context, Options } from '../../index'
 import { fetchAPI } from '../fetch'
 import type { SelectedFacet } from '../../utils/facets'
 import type { ProductSearchResult } from './types/ProductSearchResult'
-import type { AttributeSearchResult } from './types/AttributeSearchResult'
+import type { FacetSearchResult } from './types/FacetSearchResult'
 import type { IStoreSelectedFacet } from '../../../../__generated__/schema'
 
 export type Sort =
@@ -19,7 +19,7 @@ export interface SearchArgs {
   query?: string
   page: number
   count: number
-  type: 'product_search' | 'attribute_search'
+  type: 'product_search' | 'facets'
   sort?: Sort
   selectedFacets?: SelectedFacet[]
   fuzzy?: '0' | '1'
@@ -35,7 +35,7 @@ export const IntelligentSearch = (
   { account, environment, hideUnavailableItems }: Options,
   ctx: Context
 ) => {
-  const base = `http://portal.${environment}.com.br/search-api/v1/${account}`
+  const base = `https://${account}.${environment}.com.br/api/io`
   const policyFacet: IStoreSelectedFacet = {
     key: 'trade-policy',
     value: ctx.storage.channel.salesChannel,
@@ -69,7 +69,7 @@ export const IntelligentSearch = (
     })
 
     if (hideUnavailableItems !== undefined) {
-      params.append('hide-unavailable-items', hideUnavailableItems.toString())
+      params.append('hideUnavailableItems', hideUnavailableItems.toString())
     }
 
     const pathname = addDefaultFacets(selectedFacets)
@@ -77,7 +77,7 @@ export const IntelligentSearch = (
       .join('/')
 
     return fetchAPI(
-      `${base}/api/split/${type}/${pathname}?${params.toString()}`
+      `${base}/_v/api/intelligent-search/${type}/${pathname}?${params.toString()}`
     )
   }
 
@@ -85,7 +85,7 @@ export const IntelligentSearch = (
     search<ProductSearchResult>({ ...args, type: 'product_search' })
 
   const facets = (args: Omit<SearchArgs, 'type'>) =>
-    search<AttributeSearchResult>({ ...args, type: 'attribute_search' })
+    search<FacetSearchResult>({ ...args, type: 'facets' })
 
   return {
     facets,

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

@@ -1,61 +1,32 @@
-export interface AttributeSearchResult {
-  total: number
-  pagination: Pagination
-  sampling: boolean
-  translated: boolean
-  locale: string
-  query: string
-  operator: string
-  fuzzy: string
-  attributes: Attribute[] | null
+type FilterType = 'PRICERANGE' | 'TEXT' | 'NUMBER' | 'CATEGORYTREE'
+export interface FacetSearchResult {
+  facets: Facet[]
+  breadcrumb: Breadcrumb
 }
 
-export interface Attribute {
-  ids: string[]
-  visible: boolean
-  values: Value[]
-  active: boolean
-  key: string
-  originalKey: string
-  label: string
-  originalLabel: string
-  type: string
-  minValue?: number
-  maxValue?: number
-  templateURL?: string
-  proxyURL?: string
+export interface Facet {
+  type: FilterType
+  name: string
+  hidden: boolean
+  values: FacetValue[]
+  quantity?: number
 }
 
-export interface Value {
-  count: number
-  active: boolean
-  key?: string
-  label?: string
+interface FacetValue {
+  quantity: number
+  name: string
+  key: string
+  value: string
+  selected?: boolean
+  range?: {
+    from: number
+    to: number
+  }
+  children?: FacetValue[]
   id?: string
-  originalKey?: string
-  originalLabel?: string
-  proxyURL: string
-  from?: string
-  to?: string
-}
-
-export interface Pagination {
-  count: number
-  current: Current
-  before: any[]
-  after: any[]
-  perPage: number
-  next: First
-  previous: First
-  first: First
-  last: First
-}
-
-export interface Current {
-  index: number
-  proxyURL: string
 }
 
-export interface First {
-  index: number
+interface Breadcrumb {
+  href: string
+  name: string
 }

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

@@ -0,0 +1,33 @@
+type FilterType = 'PRICERANGE' | 'TEXT' | 'NUMBER' | 'CATEGORYTREE'
+export interface FacetSearchResult {
+  facets: Facet[]
+  breadcrumb: Breadcrumb
+}
+
+export interface Facet {
+  type: FilterType
+  name: string
+  hidden: boolean
+  values: FacetValue[]
+  quantity?: number
+  key?: string
+}
+
+export interface FacetValue {
+  quantity: number
+  name: string
+  key: string
+  value: string
+  selected?: boolean
+  range?: {
+    from: number
+    to: number
+  }
+  children?: FacetValue[]
+  id?: string
+}
+
+interface Breadcrumb {
+  href: string
+  name: string
+}

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

@@ -1,5 +1,8 @@
 export interface ProductSearchResult {
-  total: number
+  /**
+   * @description Total of products.
+   */
+  recordsFiltered: number
   products: Product[]
   pagination: Pagination
   sampling: boolean
@@ -7,217 +10,185 @@ export interface ProductSearchResult {
   translated: boolean
   locale: string
   query: string
-  operator: string
+  operator: 'and' | 'or'
   fuzzy: string
   correction: Correction
 }
 
-export interface Correction {
+interface Correction {
   misspelled: boolean
 }
 
-export interface Options {
+interface Options {
   sorts: Sort[]
   counts: Count[]
 }
 
-export interface Count {
+interface Count {
   count: number
   proxyURL: string
 }
 
-export interface Sort {
+interface Sort {
   field: string
   order: string
   active?: boolean
   proxyURL: string
 }
 
-export interface Pagination {
+interface Pagination {
   count: number
-  current: Current
-  before: any[]
-  after: Current[]
+  current: Page
+  before: Page[]
+  after: Page[]
   perPage: number
-  next: Current
-  previous: First
-  first: First
-  last: Current
+  next: Page
+  previous: Page
+  first: Page
+  last: Page
 }
 
-export interface Current {
+interface Page {
   index: number
   proxyURL: string
 }
 
-export interface First {
-  index: number
-}
-
 export interface Product {
-  unitMultiplier: number
-  year: number
-  extraData: ExtraDatum[]
-  release: number
-  discount: number
-  reference: string
-  split: Split
-  collections: Collection[]
-  price: number
-  customSort: number
-  stickers: Sticker[]
-  id: string
-  stock: number
+  productId: string
+  productName: string
   brand: string
-  availableTradePolicies: string[]
-  categoryTrees: CategoryTree[]
-  images: Image[]
-  locationAttributes: any[]
-  tax: number
-  productScore: number
-  storeSplitAttribute: string
-  brandID: string
-  installment: Installment
-  name: string
-  boost: Boost
-  skus: Sku[]
+  brandId: number
+  cacheId?: string
+  linkText: string
+  productReference: string
+  categoryId: string
+  clusterHighlights: Record<string, any>
+  productClusters: Record<string, string>
+  categories: string[]
+  categoriesIds: string[]
   link: string
-  wear: number
   description: string
-  showIfNotAvailable: boolean
-  clusterHighlights: ClusterHighlights
-  categories: string[]
-  timestamp: number
-  product: string
-  oldPrice: number
-  productSpecifications: string[]
-  url: string
+  /**
+   * @description Product SKUs.
+   */
+  items: Item[]
+  skuSpecifications?: SkuSpecification[]
+  priceRange: PriceRange
+  specificationGroups: SpecificationGroup
+  properties: Array<{ name: string; values: string[] }>
+  selectedProperties: Array<{ key: string; value: string }>
+}
+
+interface Image {
+  imageId: string
+  imageLabel: string | null
+  imageTag: string
+  imageUrl: string
+  imageText: string
+}
+
+interface Installment {
+  Value: number
+  InterestRate: number
+  TotalValuePlusInterestRate: number
+  NumberOfInstallments: number
+  PaymentSystemName: string
+  PaymentSystemGroupName: string
+  Name: string
+}
+
+export interface Item {
+  itemId: string
+  name: string
+  nameComplete: string
+  complementName: string
+  ean: string
+  referenceId: Array<{ Key: string; Value: string }>
   measurementUnit: string
-  categoryIDS: string[]
-  textAttributes: TextAttribute[]
-  numberAttributes: NumberAttribute[]
-  headSku: string
-  specificationGroups: string
-  extraInfo: ExtraInfo
-  oldPriceText: string
-  priceText: string
-}
-
-export interface Boost {
-  newness: number
-  image: number
-  revenue: number
-  discount: number
-  productScore: number
-  click: number
-  availableSpecsCount: number
-  promotion: number
-  order: number
-}
-
-export interface CategoryTree {
-  categoryNames: string[]
-  categoryIDS: string[]
-}
-
-export interface ClusterHighlights {
-  the140: string
-}
-
-export interface Collection {
-  id: string
-  position: number
+  unitMultiplier: number
+  modalType: any | null
+  images: Image[]
+  Videos: string[]
+  variations: string[]
+  sellers: Seller[]
+  attachments: Array<{
+    id: number
+    name: string
+    required: boolean
+    domainValues: string
+  }>
+  isKit: boolean
+  kitItems?: Array<{
+    itemId: string
+    amount: number
+  }>
+}
+
+export interface CommertialOffer {
+  DeliverySlaSamplesPerRegion: Record<
+    string,
+    { DeliverySlaPerTypes: any[]; Region: any | null }
+  >
+  Installments: Installment[]
+  DiscountHighLight: any[]
+  GiftSkuIds: string[]
+  Teasers: Array<Record<string, unknown>>
+  teasers?: Array<Record<string, unknown>>
+  BuyTogether: any[]
+  ItemMetadataAttachment: any[]
+  Price: number
+  ListPrice: number
+  spotPrice?: number
+  PriceWithoutDiscount: number
+  RewardValue: number
+  PriceValidUntil: string
+  AvailableQuantity: number
+  Tax: number
+  DeliverySlaSamples: Array<{
+    DeliverySlaPerTypes: any[]
+    Region: any | null
+  }>
+  GetInfoErrorMessage: any | null
+  CacheVersionUsedToCallCheckout: string
 }
 
-export interface ExtraDatum {
-  value: string
-  key: string
+export interface Seller {
+  sellerId: string
+  sellerName: string
+  addToCartLink: string
+  sellerDefault: boolean
+  commertialOffer: CommertialOffer
 }
 
-export interface ExtraInfo {
-  sellerID: string
+interface SkuSpecification {
+  field: SKUSpecificationField
+  values: SKUSpecificationValue[]
 }
-
-export interface Image {
+interface SKUSpecificationValue {
   name: string
-  value: string
-}
-
-export interface Installment {
-  interest: boolean
-  count: number
-  paymentGroupName: string
-  value: number
-  paymentName: string
-  valueText?: string
-}
-
-export interface NumberAttribute {
-  labelKey: string
-  value: number
-  key: string
+  id?: string
+  fieldId?: string
+  originalName?: string
 }
 
-export interface Sku {
-  images: Image[]
-  nameComplete: string
-  complementName: string
-  policies: Policy[]
-  videos: any[]
-  reference: string
-  idWithSplit: string
-  ean: string
+interface SKUSpecificationField {
   name: string
-  attributes: ExtraDatum[]
-  id: string
-  sellers: Seller[]
+  originalName?: string
+  id?: string
 }
 
-export interface Policy {
-  id: string
-  sellers: Seller[]
-}
-
-export interface Seller {
-  default: boolean
-  oldPrice?: number
-  price?: number
-  installment?: Installment
-  name: string
-  tax: number
-  teasers: any[]
-  id: string
+interface Price {
+  highPrice: number | null
+  lowPrice: number | null
 }
 
-export interface Split {
-  labelValue: string
-  labelKey: string
+interface PriceRange {
+  sellingPrice: Price
+  listPrice: Price
 }
 
-export interface Sticker {
-  image: string
+interface SpecificationGroup {
   name: string
-  location: string
-  target: string
-}
-
-export interface TextAttribute {
-  joinedValue: string
-  isSku: boolean
-  joinedKey: string
-  joinedKeyTranslations: JoinedTranslations
-  isFilter: boolean
-  labelValue: string
-  id: string[]
-  labelKey: string
-  value: string
-  key: string
-  joinedValueTranslations: JoinedTranslations
-  valueID?: string
-}
-
-export interface JoinedTranslations {
-  spanish: string
-  english: string
-  italian: string
+  originalName: string
+  specifications: { name: string; originalName: string; values: string[] }
 }

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

@@ -0,0 +1,67 @@
+/**
+ * Client for SP, Intelligent search's analytics event API
+ * More info at: https://www.notion.so/vtexhandbook/Event-API-Documentation-48eee26730cf4d7f80f8fd7262231f84
+ */
+import { fetchAPI } from '../fetch'
+import type { Options, Context } from '../../index'
+
+const THIRTY_MINUTES_S = 30 * 60
+const ONE_YEAR_S = 365 * 24 * 3600
+
+const randomUUID = () => (Math.random() * 1e6).toFixed(0)
+
+const timelapsed = (past: number) => (Date.now() - past) / 1e3
+
+const createId = (expiresSecond: number) => {
+  let payload = randomUUID()
+  let createdAt = Date.now()
+
+  return () => {
+    if (timelapsed(createdAt) > expiresSecond) {
+      payload = randomUUID()
+      createdAt = Date.now()
+    }
+
+    return payload
+  }
+}
+
+const user = {
+  anonymous: createId(ONE_YEAR_S),
+  session: createId(THIRTY_MINUTES_S),
+}
+
+export type SearchEvent = {
+  type: 'search.query'
+  text: string // 'zapatilha'
+  misspelled: boolean
+  match: number
+  operator: 'and' | 'or'
+  session?: string
+  anonymous?: string
+}
+
+export const SP = ({ account }: Options, _: Context) => {
+  const base = `https://sp.vtex.com/event-api/v1/${account}/event`
+
+  const sendEvent = (options: SearchEvent) => {
+    return fetchAPI(base, {
+      method: 'POST',
+      body: JSON.stringify({
+        ...options,
+        agent: '@faststore/api',
+        anonymous: user.anonymous(),
+        session: user.session(),
+        // session: 'zZlNhqz1vFJP6iPG5Oqtt',
+        // anonymous: 'Om1TNluGvgmSgU5OOTvkkd',
+      }),
+      headers: {
+        'content-type': 'application/json',
+      },
+    })
+  }
+
+  return {
+    sendEvent,
+  }
+}

package/src/platforms/vtex/index.ts

@@ -42,12 +42,12 @@ export interface Context {
   headers: Record<string, string>
 }
 
-export type Resolver<R = unknown, A = unknown> = (
+export type Resolver<R = unknown, A = unknown, Return = any> = (
   root: R,
   args: A,
   ctx: Context,
   info: any
-) => any
+) => Return
 
 const Resolvers = {
   StoreCollection,

package/src/platforms/vtex/loaders/sku.ts

@@ -28,8 +28,8 @@ export const getSkuLoader = (_: Options, clients: Clients) => {
     })
 
     const skuBySkuId = products.reduce((acc, product) => {
-      for (const sku of product.skus) {
-        acc[sku.id] = enhanceSku(sku, product)
+      for (const sku of product.items) {
+        acc[sku.itemId] = enhanceSku(sku, product)
       }
 
       return acc