@faststore/api 1.7.31 → 1.7.34

package/dist/api.esm.js

@@ -9,7 +9,7 @@ const fetchAPI = async (info, init) => {
   const response = await fetch(info, init);
 
   if (response.ok) {
-    return response.json();
+    return response.status !== 204 ? response.json() : undefined;
   }
 
   console.error(info, init, response);
@@ -106,7 +106,7 @@ const IntelligentSearch = ({
   environment,
   hideUnavailableItems
 }, ctx) => {
-  const base = `http://portal.${environment}.com.br/search-api/v1/${account}`;
+  const base = `https://${account}.${environment}.com.br/api/io`;
   const policyFacet = {
     key: 'trade-policy',
     value: ctx.storage.channel.salesChannel
@@ -142,14 +142,14 @@ const IntelligentSearch = ({
     });
 
     if (hideUnavailableItems !== undefined) {
-      params.append('hide-unavailable-items', hideUnavailableItems.toString());
+      params.append('hideUnavailableItems', hideUnavailableItems.toString());
     }
 
     const pathname = addDefaultFacets(selectedFacets).map(({
       key,
       value
     }) => `${key}/${value}`).join('/');
-    return fetchAPI(`${base}/api/split/${type}/${pathname}?${params.toString()}`);
+    return fetchAPI(`${base}/_v/api/intelligent-search/${type}/${pathname}?${params.toString()}`);
   };
 
   const products = args => search({ ...args,
@@ -157,7 +157,7 @@ const IntelligentSearch = ({
   });
 
   const facets = args => search({ ...args,
-    type: 'attribute_search'
+    type: 'facets'
   });
 
   return {
@@ -166,12 +166,66 @@ const IntelligentSearch = ({
   };
 };
 
+/**
+ * Client for SP, Intelligent search's analytics event API
+ * More info at: https://www.notion.so/vtexhandbook/Event-API-Documentation-48eee26730cf4d7f80f8fd7262231f84
+ */
+const THIRTY_MINUTES_S = 30 * 60;
+const ONE_YEAR_S = 365 * 24 * 3600;
+
+const randomUUID = () => (Math.random() * 1e6).toFixed(0);
+
+const timelapsed = past => (Date.now() - past) / 1e3;
+
+const createId = expiresSecond => {
+  let payload = randomUUID();
+  let createdAt = Date.now();
+  return () => {
+    if (timelapsed(createdAt) > expiresSecond) {
+      payload = randomUUID();
+      createdAt = Date.now();
+    }
+
+    return payload;
+  };
+};
+
+const user = {
+  anonymous: /*#__PURE__*/createId(ONE_YEAR_S),
+  session: /*#__PURE__*/createId(THIRTY_MINUTES_S)
+};
+const SP = ({
+  account
+}, _) => {
+  const base = `https://sp.vtex.com/event-api/v1/${account}/event`;
+
+  const sendEvent = options => {
+    return fetchAPI(base, {
+      method: 'POST',
+      body: JSON.stringify({ ...options,
+        agent: '@faststore/api',
+        anonymous: user.anonymous(),
+        session: user.session()
+      }),
+      headers: {
+        'content-type': 'application/json'
+      }
+    });
+  };
+
+  return {
+    sendEvent
+  };
+};
+
 const getClients = (options, ctx) => {
   const search = IntelligentSearch(options, ctx);
   const commerce = VtexCommerce(options, ctx);
+  const sp = SP(options);
   return {
     search,
-    commerce
+    commerce,
+    sp
   };
 };
 
@@ -223,7 +277,7 @@ class NotFoundError extends Error {
 
 }
 
-const enhanceSku = (sku, product) => ({ ...sku,
+const enhanceSku = (item, product) => ({ ...item,
   isVariantOf: product
 });
 
@@ -248,8 +302,8 @@ const getSkuLoader = (_, clients) => {
       count: skuIds.length
     });
     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;
@@ -306,38 +360,18 @@ const getLoaders = (options, {
   };
 };
 
-const inStock = item => item.availability === 'available'; // Smallest Available Selling Price First
-
-
-const sortOfferByPrice = items => items.sort((a, b) => {
-  if (inStock(a) && !inStock(b)) {
-    return -1;
-  }
-
-  if (!inStock(a) && inStock(b)) {
-    return 1;
-  }
-
-  return a.sellingPrice - b.sellingPrice;
-});
 const StoreAggregateOffer = {
   highPrice: ({
-    items
+    product
   }) => {
-    var _availableItems$pop;
+    var _product$isVariantOf$;
 
-    const availableItems = items.filter(inStock);
-    const highPrice = (_availableItems$pop = availableItems.pop()) == null ? void 0 : _availableItems$pop.sellingPrice;
-    return (highPrice != null ? highPrice : 0) / 1e2;
+    return (_product$isVariantOf$ = product.isVariantOf.priceRange.sellingPrice.highPrice) != null ? _product$isVariantOf$ : 0;
   },
-  lowPrice: ({
-    items
-  }) => {
-    var _availableItems$;
+  lowPrice: root => {
+    var _root$product$isVaria;
 
-    const availableItems = items.filter(inStock);
-    const lowPrice = (_availableItems$ = availableItems[0]) == null ? void 0 : _availableItems$.sellingPrice;
-    return (lowPrice != null ? lowPrice : 0) / 1e2;
+    return (_root$product$isVaria = root.product.isVariantOf.priceRange.sellingPrice.lowPrice) != null ? _root$product$isVaria : 0;
   },
   offerCount: ({
     items
@@ -475,33 +509,36 @@ const StoreCollection = {
 const StoreFacet = {
   key: ({
     key
-  }) => key,
+  }) => key != null ? key : '',
   label: ({
-    label
-  }) => label,
+    name
+  }) => name != null ? name : 'unknown',
   values: ({
     values
   }) => values,
   type: ({
     type
-  }) => type === 'text' ? 'BOOLEAN' : 'RANGE'
+  }) => type === 'TEXT' ? 'BOOLEAN' : 'RANGE'
 };
 
 const StoreFacetValue = {
   value: ({
-    key,
-    from,
-    to
-  }) => key != null ? key : `${from}-to-${to}`,
+    value,
+    range
+  }) => {
+    var _range$from, _range$to;
+
+    return value != null ? value : `${(_range$from = range == null ? void 0 : range.from) != null ? _range$from : ''}-to-${(_range$to = range == null ? void 0 : range.to) != null ? _range$to : ''}`;
+  },
   label: ({
-    label
-  }) => label != null ? label : 'unknown',
+    name
+  }) => name || 'unknown',
   selected: ({
-    active
-  }) => active,
+    selected
+  }) => selected,
   quantity: ({
-    count
-  }) => count
+    quantity
+  }) => quantity
 };
 
 const getId = item => [item.itemOffered.sku, item.seller.identifier, item.price].join('::');
@@ -704,40 +741,132 @@ const Mutation = {
   updateSession
 };
 
+const getItemPriceByKey = (item, key) => {
+  var _getFirstSeller$comme, _getFirstSeller;
+
+  return (_getFirstSeller$comme = (_getFirstSeller = getFirstSeller(item.sellers)) == null ? void 0 : _getFirstSeller.commertialOffer[key]) != null ? _getFirstSeller$comme : 0;
+};
+
+const inStock = item => item.sellers.find(seller => seller.commertialOffer.AvailableQuantity > 0);
+const getFirstSeller = sellers => sellers[0]; // Smallest Available Selling Price First
+
+const sortOfferByPrice = items => items.sort((a, b) => {
+  if (inStock(a) && !inStock(b)) {
+    return -1;
+  }
+
+  if (!inStock(a) && inStock(b)) {
+    return 1;
+  }
+
+  return getItemPriceByKey(a, 'Price') - getItemPriceByKey(b, 'Price');
+});
+const inStockOrderFormItem = availability => availability === 'available';
+
+const isSearchItem = item => 'sellers' in item;
+
+const isOrderFormItem = item => 'skuName' in item;
+
+const getAvailability = available => available ? 'https://schema.org/InStock' : 'https://schema.org/OutOfStock';
+
 const StoreOffer = {
   priceCurrency: () => '',
-  priceValidUntil: ({
-    priceValidUntil
-  }) => priceValidUntil != null ? priceValidUntil : '',
+  priceValidUntil: item => {
+    if (isSearchItem(item)) {
+      var _getFirstSeller$comme, _getFirstSeller;
+
+      return (_getFirstSeller$comme = (_getFirstSeller = getFirstSeller(item.sellers)) == null ? void 0 : _getFirstSeller.commertialOffer.PriceValidUntil) != null ? _getFirstSeller$comme : '';
+    }
+
+    if (isOrderFormItem(item)) {
+      var _item$priceValidUntil;
+
+      return (_item$priceValidUntil = item.priceValidUntil) != null ? _item$priceValidUntil : '';
+    }
+
+    return null;
+  },
   itemCondition: () => 'https://schema.org/NewCondition',
-  availability: ({
-    availability
-  }) => availability === 'available' ? 'https://schema.org/InStock' : 'https://schema.org/OutOfStock',
-  seller: ({
-    seller
-  }) => ({
-    identifier: seller
-  }),
-  price: ({
-    sellingPrice
-  }) => sellingPrice / 1e2,
-  sellingPrice: ({
-    sellingPrice
-  }) => sellingPrice / 1e2,
-  listPrice: ({
-    listPrice
-  }) => listPrice / 1e2,
+  availability: async item => {
+    if (isSearchItem(item)) {
+      return getAvailability(!!inStock(item));
+    }
+
+    if (isOrderFormItem(item)) {
+      return getAvailability(inStockOrderFormItem(item.availability));
+    }
+
+    return null;
+  },
+  seller: item => {
+    if (isSearchItem(item)) {
+      var _getFirstSeller$selle, _getFirstSeller2;
+
+      return {
+        identifier: (_getFirstSeller$selle = (_getFirstSeller2 = getFirstSeller(item.sellers)) == null ? void 0 : _getFirstSeller2.sellerId) != null ? _getFirstSeller$selle : ''
+      };
+    }
+
+    if (isOrderFormItem(item)) {
+      return {
+        identifier: item.seller
+      };
+    }
+
+    return null;
+  },
+  price: item => {
+    if (isSearchItem(item)) {
+      return getItemPriceByKey(item, 'spotPrice');
+    }
+
+    if (isOrderFormItem(item)) {
+      return item.price / 1e2;
+    }
+
+    return null;
+  },
+  sellingPrice: item => {
+    if (isSearchItem(item)) {
+      return getItemPriceByKey(item, 'Price');
+    }
+
+    if (isOrderFormItem(item)) {
+      return item.sellingPrice / 1e2;
+    }
+
+    return null;
+  },
+  listPrice: item => {
+    if (isSearchItem(item)) {
+      return getItemPriceByKey(item, 'ListPrice');
+    }
+
+    if (isOrderFormItem(item)) {
+      return item.listPrice / 1e2;
+    }
+
+    return null;
+  },
   itemOffered: ({
     product
   }) => product,
-  quantity: ({
-    quantity
-  }) => quantity
+  quantity: item => {
+    if (isSearchItem(item)) {
+      return item.sellers.reduce((quantity, seller) => quantity + seller.commertialOffer.AvailableQuantity, 0);
+    }
+
+    if (isOrderFormItem(item)) {
+      return item.quantity;
+    }
+
+    return null;
+  }
 };
 
 const DEFAULT_IMAGE = {
-  name: 'image',
-  value: 'https://storecomponents.vtexassets.com/assets/faststore/images/image___117a6d3e229a96ad0e0d0876352566e2.svg'
+  imageText: 'image',
+  imageUrl: 'https://storecomponents.vtexassets.com/assets/faststore/images/image___117a6d3e229a96ad0e0d0876352566e2.svg'
 };
 
 const getSlug = (link, id) => `${link}-${id}`;
@@ -748,18 +877,18 @@ const nonEmptyArray = array => Array.isArray(array) && array.length > 0 ? array
 
 const StoreProduct = {
   productID: ({
-    id
-  }) => id,
+    itemId
+  }) => itemId,
   name: ({
     isVariantOf,
     name
-  }) => name != null ? name : isVariantOf.name,
+  }) => name != null ? name : isVariantOf.productName,
   slug: ({
     isVariantOf: {
-      link
+      linkText
     },
-    id
-  }) => getSlug(link, id),
+    itemId
+  }) => getSlug(linkText, itemId),
   description: ({
     isVariantOf: {
       description
@@ -767,11 +896,11 @@ const StoreProduct = {
   }) => description,
   seo: ({
     isVariantOf: {
-      name,
-      description
+      description,
+      productName
     }
   }) => ({
-    title: name,
+    title: productName,
     description
   }),
   brand: ({
@@ -783,86 +912,61 @@ const StoreProduct = {
   }),
   breadcrumbList: ({
     isVariantOf: {
-      categoryTrees,
-      name,
-      link
+      categories,
+      productName,
+      linkText
     },
-    id
-  }) => ({
-    itemListElement: [...categoryTrees.reverse().map(({
-      categoryNames
-    }, index) => ({
-      name: categoryNames[categoryNames.length - 1],
-      item: `/${categoryNames.map(categoryName => slugify(categoryName)).join('/')}`,
-      position: index + 1
-    })), {
-      name,
-      item: getPath(link, id),
-      position: categoryTrees.length + 1
-    }],
-    numberOfItems: categoryTrees.length
-  }),
+    itemId
+  }) => {
+    return {
+      itemListElement: [...categories.reverse().map((categoryPath, index) => {
+        const categoryNames = categoryPath.split('/');
+        return {
+          name: categoryNames[categoryNames.length - 2],
+          item: categoryPath.toLowerCase(),
+          position: index + 1
+        };
+      }), {
+        name: productName,
+        item: getPath(linkText, itemId),
+        position: categories.length + 1
+      }],
+      numberOfItems: categories.length
+    };
+  },
   image: ({
-    isVariantOf,
     images
   }) => {
-    var _ref, _nonEmptyArray;
+    var _nonEmptyArray;
 
-    return ((_ref = (_nonEmptyArray = nonEmptyArray(images)) != null ? _nonEmptyArray : nonEmptyArray(isVariantOf.images)) != null ? _ref : [DEFAULT_IMAGE]).map(({
-      name,
-      value
+    return ((_nonEmptyArray = nonEmptyArray(images)) != null ? _nonEmptyArray : [DEFAULT_IMAGE]).map(({
+      imageUrl,
+      imageText
     }) => ({
-      alternateName: name != null ? name : '',
-      url: value.replace('vteximg.com.br', 'vtexassets.com')
+      alternateName: imageText != null ? imageText : '',
+      url: imageUrl.replace('vteximg.com.br', 'vtexassets.com')
     }));
   },
   sku: ({
-    id
-  }) => id,
+    itemId
+  }) => itemId,
   gtin: ({
-    reference
-  }) => reference != null ? reference : '',
+    referenceId
+  }) => {
+    var _referenceId$0$Value, _referenceId$;
+
+    return (_referenceId$0$Value = (_referenceId$ = referenceId[0]) == null ? void 0 : _referenceId$.Value) != null ? _referenceId$0$Value : '';
+  },
   review: () => [],
   aggregateRating: () => ({}),
-  offers: async (product, _, ctx) => {
-    var _policies$find;
-
-    const {
-      loaders: {
-        simulationLoader
-      },
-      storage: {
-        channel
-      }
-    } = ctx;
-    const {
-      id,
-      policies
-    } = product;
-    const sellers = (_policies$find = policies.find(policy => policy.id === channel.salesChannel)) == null ? void 0 : _policies$find.sellers;
-
-    if (sellers === null || sellers === undefined) {
-      // This error will likely happen when you forget to forward the channel somewhere in your code.
-      // Make sure all queries that lead to a product are forwarding the channel in context corectly
-      throw new Error(`Product with id ${id} has no sellers for sales channel ${channel.salesChannel}.`);
-    } // Unique seller ids
-
-
-    const sellerIds = sellers.map(seller => seller.id);
-    const items = Array.from(new Set(sellerIds)).map(seller => ({
-      quantity: 1,
-      seller,
-      id
-    }));
-    const simulation = await simulationLoader.load(items);
-    return { ...simulation,
-      items: sortOfferByPrice(simulation.items),
+  offers: product => {
+    return {
+      items: sortOfferByPrice(product.isVariantOf.items),
       product
     };
   },
-  isVariantOf: ({
-    isVariantOf
-  }) => isVariantOf,
+  isVariantOf: root => root,
+  // TODO: get this value. Fix any type
   additionalProperty: ({
     attributes = []
   }) => attributes.map(attribute => ({
@@ -871,24 +975,31 @@ const StoreProduct = {
   }))
 };
 
+const BLOCKED_PROPERTIES = {
+  sellerId: true
+};
 const StoreProductGroup = {
-  hasVariant: root => root.skus.map(sku => enhanceSku(sku, root)),
+  hasVariant: root => root.isVariantOf.items.map(item => enhanceSku(item, root.isVariantOf)),
   productGroupID: ({
-    product
-  }) => product,
+    isVariantOf
+  }) => isVariantOf.productId,
   name: ({
-    name
-  }) => name,
+    isVariantOf
+  }) => isVariantOf.productName,
   additionalProperty: ({
-    textAttributes = [],
-    productSpecifications = []
-  }) => {
-    const specs = new Set(productSpecifications);
-    return textAttributes.filter(attribute => specs.has(attribute.labelKey)).map(attribute => ({
-      name: attribute.labelKey,
-      value: attribute.labelValue
+    isVariantOf: {
+      properties
+    }
+  }) => properties.flatMap(property => {
+    if (BLOCKED_PROPERTIES[property.name]) {
+      return [];
+    }
+
+    return property.values.map(propertyValue => ({
+      name: property.name,
+      value: propertyValue
     }));
-  }
+  })
 };
 
 /**
@@ -903,12 +1014,20 @@ const transformSelectedFacet = ({
   switch (key) {
     case 'channel':
       {
-        const channel = ChannelMarshal.parse(value); // This array should have all values from channel string
-
-        return [{
+        const channel = ChannelMarshal.parse(value);
+        const channelFacets = [{
           key: 'trade-policy',
           value: channel.salesChannel
         }];
+
+        if (channel.regionId) {
+          channelFacets.push({
+            key: 'region-id',
+            value: channel.regionId
+          });
+        }
+
+        return channelFacets;
       }
 
     default:
@@ -1000,14 +1119,14 @@ const Query = {
       page: Math.ceil(after / first),
       count: first
     });
-    const skus = products.products.map(product => product.skus.map(sku => enhanceSku(sku, product))).flat().filter(sku => sku.sellers.length > 0);
+    const skus = products.products.map(product => product.items.map(sku => enhanceSku(sku, product))).flat().filter(sku => sku.sellers.length > 0);
     return {
       pageInfo: {
         hasNextPage: products.pagination.after.length > 0,
         hasPreviousPage: products.pagination.before.length > 0,
         startCursor: '0',
-        endCursor: products.total.toString(),
-        totalCount: products.total
+        endCursor: products.recordsFiltered.toString(),
+        totalCount: products.recordsFiltered
       },
       // after + index is bigger than after+first itself because of the array flat() above
       edges: skus.map((sku, index) => ({
@@ -1094,17 +1213,30 @@ const StoreReview = {
   })
 };
 
-const REMOVED_FACETS_FROM_COLLECTION_PAGE = ['departamento'];
+const REMOVED_FACETS_FROM_COLLECTION_PAGE = ['departamento', 'Departamento'];
 const StoreSearchResult = {
   products: async (searchArgs, _, ctx) => {
     const {
       clients: {
-        search
+        search,
+        sp
       }
     } = ctx;
-    const products = await search.products(searchArgs);
+    const products = await search.products(searchArgs); // Raise event on search's analytics API when performing
+    // a full text search.
+
+    if (searchArgs.query) {
+      sp.sendEvent({
+        type: 'search.query',
+        text: searchArgs.query,
+        misspelled: products.correction.misspelled,
+        match: products.recordsFiltered,
+        operator: products.operator
+      }).catch(console.error);
+    }
+
     const skus = products.products.map(product => {
-      const [maybeSku] = product.skus;
+      const [maybeSku] = product.items;
       return maybeSku && enhanceSku(maybeSku, product);
     }).filter(sku => !!sku);
     return {
@@ -1112,8 +1244,8 @@ const StoreSearchResult = {
         hasNextPage: products.pagination.after.length > 0,
         hasPreviousPage: products.pagination.before.length > 0,
         startCursor: '0',
-        endCursor: products.total.toString(),
-        totalCount: products.total
+        endCursor: products.recordsFiltered.toString(),
+        totalCount: products.recordsFiltered
       },
       edges: skus.map((sku, index) => ({
         node: sku,
@@ -1122,17 +1254,17 @@ const StoreSearchResult = {
     };
   },
   facets: async (searchArgs, _, ctx) => {
-    var _facets$attributes;
-
     const {
       clients: {
         search: is
       }
     } = ctx;
-    const facets = await is.facets(searchArgs);
+    const {
+      facets
+    } = await is.facets(searchArgs);
     const isCollectionPage = !searchArgs.query;
-    const filteredFacets = facets == null ? void 0 : (_facets$attributes = facets.attributes) == null ? void 0 : _facets$attributes.reduce((acc, currentFacet) => {
-      const shouldFilterFacet = REMOVED_FACETS_FROM_COLLECTION_PAGE.includes(currentFacet.key);
+    const filteredFacets = facets == null ? void 0 : facets.reduce((acc, currentFacet) => {
+      const shouldFilterFacet = REMOVED_FACETS_FROM_COLLECTION_PAGE.includes(currentFacet.name);
       const shouldRemoveFacetFromCollectionPage = isCollectionPage && shouldFilterFacet;
 
       if (shouldRemoveFacetFromCollectionPage) {
@@ -1140,10 +1272,10 @@ const StoreSearchResult = {
       }
 
       currentFacet.values.sort((a, b) => {
-        var _a$label, _b$label;
+        var _a$name, _b$name;
 
-        const firstItemLabel = (_a$label = a.label) != null ? _a$label : '';
-        const secondItemLabel = (_b$label = b.label) != null ? _b$label : '';
+        const firstItemLabel = (_a$name = a.name) != null ? _a$name : '';
+        const secondItemLabel = (_b$name = b.name) != null ? _b$name : '';
         return firstItemLabel.localeCompare(secondItemLabel);
       });
       acc.push(currentFacet);