@faststore/api 1.8.33 → 1.8.36

package/CHANGELOG.md

@@ -3,6 +3,36 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 1.8.36 (2022-05-26)
+
+
+### Bug Fixes
+
+* Top searches ([#1321](https://github.com/vtex/faststore/issues/1321)) ([e2ab99d](https://github.com/vtex/faststore/commit/e2ab99d4f443e013f3fd024fc83bb612fcb27f41))
+
+
+
+
+
+## 1.8.35 (2022-05-26)
+
+
+### Features
+
+* Add OutOfStock component ([#1314](https://github.com/vtex/faststore/issues/1314)) ([37eac86](https://github.com/vtex/faststore/commit/37eac86ede448ef68aef426f65f2d224694b2cfc))
+
+
+
+
+
+## 1.8.34 (2022-05-25)
+
+**Note:** Version bump only for package @faststore/api
+
+
+
+
+
 ## 1.8.33 (2022-05-24)
 
 

package/dist/__generated__/schema.d.ts

@@ -427,6 +427,8 @@ export declare type StorePropertyValue = {
     __typename?: 'StorePropertyValue';
     /** Property name. */
     name: Scalars['String'];
+    /** Property id. This propert changes according to the content of the object. */
+    propertyID: Scalars['String'];
     /** Property value. May hold a string or the string representation of an object. */
     value: Scalars['ObjectOrString'];
     /** Specifies the nature of the value */

package/dist/api.cjs.development.js

@@ -200,7 +200,8 @@ const IntelligentSearch = ({
       count: count.toString(),
       query,
       sort,
-      fuzzy
+      fuzzy,
+      locale: ctx.storage.locale
     });
 
     if (hideUnavailableItems !== undefined) {
@@ -218,11 +219,32 @@ const IntelligentSearch = ({
     type: 'product_search'
   });
 
-  const suggestedProducts = args => fetchAPI(`${base}/_v/api/intelligent-search/product_search?query=${args.query}`);
+  const suggestedProducts = args => {
+    var _args$query$toString, _args$query;
 
-  const suggestedTerms = args => fetchAPI(`${base}/_v/api/intelligent-search/search_suggestions?query=${args.query}`);
+    const params = new URLSearchParams({
+      query: (_args$query$toString = (_args$query = args.query) == null ? void 0 : _args$query.toString()) != null ? _args$query$toString : '',
+      locale: ctx.storage.locale
+    });
+    return fetchAPI(`${base}/_v/api/intelligent-search/product_search?${params.toString()}`);
+  };
+
+  const suggestedTerms = args => {
+    var _args$query$toString2, _args$query2;
+
+    const params = new URLSearchParams({
+      query: (_args$query$toString2 = (_args$query2 = args.query) == null ? void 0 : _args$query2.toString()) != null ? _args$query$toString2 : '',
+      locale: ctx.storage.locale
+    });
+    return fetchAPI(`${base}/_v/api/intelligent-search/search_suggestions?${params.toString()}`);
+  };
 
-  const topSearches = () => fetchAPI(`${base}/_v/api/intelligent-search/top_searches`);
+  const topSearches = () => {
+    const params = new URLSearchParams({
+      locale: ctx.storage.locale
+    });
+    return fetchAPI(`${base}/_v/api/intelligent-search/top_searches?${params.toString()}`);
+  };
 
   const facets = args => search({ ...args,
     type: 'facets'
@@ -634,10 +656,19 @@ const StoreFacetValue = {
 const md5 = payload => crypto.createHash('md5').update(payload).digest('hex');
 
 const VALUE_REFERENCES = {
-  variation: 'VARIATION',
   attachment: 'ATTACHMENT',
   specification: 'SPECIFICATION'
 };
+function attachmentToPropertyValue(attachment) {
+  return {
+    name: attachment.name,
+    value: attachment.content,
+    valueReference: VALUE_REFERENCES.attachment
+  };
+}
+function getPropertyId(item) {
+  return md5(`${item.name}:${JSON.stringify(item.value)}:${item.valueReference}`);
+}
 
 const getAttachments = item => {
   var _item$itemOffered$add;
@@ -645,18 +676,12 @@ const getAttachments = item => {
   return (_item$itemOffered$add = item.itemOffered.additionalProperty) == null ? void 0 : _item$itemOffered$add.filter(i => i.valueReference === VALUE_REFERENCES.attachment);
 };
 
-const serializeAttachment = item => {
-  const attachments = getAttachments(item);
-
-  if ((attachments == null ? void 0 : attachments.length) === 0) {
-    return null;
-  }
+const getId = item => {
+  var _item$itemOffered$add2;
 
-  return attachments == null ? void 0 : attachments.map(attachment => `${attachment.name}:${JSON.stringify(attachment.value)}`).join('-');
+  return [item.itemOffered.sku, item.seller.identifier, item.price, (_item$itemOffered$add2 = item.itemOffered.additionalProperty) == null ? void 0 : _item$itemOffered$add2.map(getPropertyId).join('-')].filter(Boolean).join('::');
 };
 
-const getId = item => [item.itemOffered.sku, item.seller.identifier, item.price, serializeAttachment(item)].filter(Boolean).join('::');
-
 const orderFormItemToOffer = (item, index) => ({
   listPrice: item.listPrice / 100,
   price: item.sellingPrice / 100,
@@ -667,7 +692,8 @@ const orderFormItemToOffer = (item, index) => ({
   itemOffered: {
     sku: item.id,
     image: [],
-    name: item.name
+    name: item.name,
+    additionalProperty: item.attachments.map(attachmentToPropertyValue)
   },
   index
 });
@@ -680,7 +706,7 @@ const offerToOrderItemInput = offer => {
     seller: offer.seller.identifier,
     id: offer.itemOffered.sku,
     index: offer.index,
-    attachments: (_getAttachments = getAttachments(offer)) == null ? void 0 : _getAttachments.map(attachment => ({
+    attachments: ((_getAttachments = getAttachments(offer)) != null ? _getAttachments : []).map(attachment => ({
       name: attachment.name,
       content: attachment.value
     }))
@@ -893,9 +919,6 @@ class ChannelMarshal {
   }
 
 }
-const mutateChannelContext = (ctx, channelString) => {
-  ctx.storage.channel = ChannelMarshal.parse(channelString);
-};
 
 const updateSession = async (_, {
   session
@@ -1145,23 +1168,20 @@ const StoreProduct = {
   })).sort(bestOfferFirst),
   isVariantOf: root => root,
   additionalProperty: ({
-    variations = [],
-    attachmentsValues
+    // Search uses the name variations for specifications
+    variations: specifications = [],
+    attachmentsValues = []
   }) => {
-    const propertyValueVariations = variations.flatMap(({
+    const propertyValueSpecifications = specifications.flatMap(({
       name,
       values
     }) => values.map(value => ({
       name,
       value,
-      valueReference: VALUE_REFERENCES.variation
+      valueReference: VALUE_REFERENCES.specification
     })));
-    const propertyValueAttachments = (attachmentsValues != null ? attachmentsValues : []).map(attachment => ({
-      name: attachment.name,
-      value: attachment.content,
-      valueReference: VALUE_REFERENCES.attachment
-    }));
-    return [...propertyValueVariations, ...propertyValueAttachments];
+    const propertyValueAttachments = attachmentsValues.map(attachmentToPropertyValue);
+    return [...propertyValueSpecifications, ...propertyValueAttachments];
   }
 };
 
@@ -1192,6 +1212,13 @@ const StoreProductGroup = {
   }))))
 };
 
+const mutateChannelContext = (ctx, channelString) => {
+  ctx.storage.channel = ChannelMarshal.parse(channelString);
+};
+const mutateLocaleContext = (ctx, locale) => {
+  ctx.storage.locale = locale;
+};
+
 /**
  * Transform facets from the store to VTEX platform facets.
  * For instance, the channel in Store becomes trade-policy and regionId in VTEX's realm
@@ -1220,6 +1247,11 @@ const transformSelectedFacet = ({
         return channelFacets;
       }
 
+    case 'locale':
+      {
+        return []; // remove this facet from search
+      }
+
     default:
       return {
         key,
@@ -1227,6 +1259,16 @@ const transformSelectedFacet = ({
       };
   }
 };
+const findLocale = facets => {
+  var _facets$find$value, _facets$find;
+
+  return (_facets$find$value = facets == null ? void 0 : (_facets$find = facets.find(x => x.key === 'locale')) == null ? void 0 : _facets$find.value) != null ? _facets$find$value : null;
+};
+const findChannel = facets => {
+  var _facets$find$value2, _facets$find2;
+
+  return (_facets$find$value2 = facets == null ? void 0 : (_facets$find2 = facets.find(facet => facet.key === 'channel')) == null ? void 0 : _facets$find2.value) != null ? _facets$find$value2 : null;
+};
 
 const SORT_MAP = {
   price_desc: 'price:desc',
@@ -1243,13 +1285,16 @@ const Query = {
   product: async (_, {
     locator
   }, ctx) => {
-    var _locator$find;
-
     // Insert channel in context for later usage
-    const channelString = (_locator$find = locator.find(facet => facet.key === 'channel')) == null ? void 0 : _locator$find.value;
+    const channel = findChannel(locator);
+    const locale = findLocale(locator);
+
+    if (channel) {
+      mutateChannelContext(ctx, channel);
+    }
 
-    if (channelString) {
-      mutateChannelContext(ctx, channelString);
+    if (locale) {
+      mutateLocaleContext(ctx, locale);
     }
 
     const {
@@ -1276,13 +1321,18 @@ const Query = {
     term,
     selectedFacets
   }, ctx) => {
-    var _selectedFacets$find, _selectedFacets$flatM;
+    var _selectedFacets$flatM;
 
     // Insert channel in context for later usage
-    const channelString = selectedFacets == null ? void 0 : (_selectedFacets$find = selectedFacets.find(facet => facet.key === 'channel')) == null ? void 0 : _selectedFacets$find.value;
+    const channel = findChannel(selectedFacets);
+    const locale = findLocale(selectedFacets);
+
+    if (channel) {
+      mutateChannelContext(ctx, channel);
+    }
 
-    if (channelString) {
-      mutateChannelContext(ctx, channelString);
+    if (locale) {
+      mutateLocaleContext(ctx, locale);
     }
 
     const after = maybeAfter ? Number(maybeAfter) : 0;
@@ -1559,6 +1609,19 @@ function stringify(value) {
   return null;
 }
 
+const StorePropertyValue = {
+  propertyID: root => getPropertyId(root),
+  name: ({
+    name
+  }) => name,
+  value: ({
+    value
+  }) => value,
+  valueReference: ({
+    valueReference
+  }) => valueReference
+};
+
 const Resolvers = {
   StoreCollection,
   StoreAggregateOffer,
@@ -1571,6 +1634,7 @@ const Resolvers = {
   StoreReview,
   StoreProductGroup,
   StoreSearchResult,
+  StorePropertyValue,
   ObjectOrString,
   Query,
   Mutation
@@ -1580,7 +1644,8 @@ const getContextFactory = options => ctx => {
 
   ctx.storage = {
     channel: ChannelMarshal.parse(options.channel),
-    flags: (_options$flags = options.flags) != null ? _options$flags : {}
+    flags: (_options$flags = options.flags) != null ? _options$flags : {},
+    locale: options.locale
   };
   ctx.clients = getClients(options, ctx);
   ctx.loaders = getLoaders(options, ctx);
@@ -1648,8 +1713,8 @@ var doc$i = {"kind":"Document","definitions":[{"kind":"ObjectTypeDefinition","de
 var doc$j = {"kind":"Document","definitions":[{"kind":"EnumTypeDefinition","description":{"kind":"StringValue","value":"Status used to indicate type of message. For instance, in shopping cart messages.","block":true},"name":{"kind":"Name","value":"StoreStatus"},"directives":[],"values":[{"kind":"EnumValueDefinition","name":{"kind":"Name","value":"INFO"},"directives":[]},{"kind":"EnumValueDefinition","name":{"kind":"Name","value":"WARNING"},"directives":[]},{"kind":"EnumValueDefinition","name":{"kind":"Name","value":"ERROR"},"directives":[]}]}],"loc":{"start":0,"end":136}};
     doc$j.loc.source = {"body":"\"\"\"\nStatus used to indicate type of message. For instance, in shopping cart messages.\n\"\"\"\nenum StoreStatus {\n  INFO\n  WARNING\n  ERROR\n}\n","name":"GraphQL request","locationOffset":{"line":1,"column":1}};
 
-var doc$k = {"kind":"Document","definitions":[{"kind":"ObjectTypeDefinition","description":{"kind":"StringValue","value":"Properties that can be associated with products and products groups.","block":true},"name":{"kind":"Name","value":"StorePropertyValue"},"interfaces":[],"directives":[],"fields":[{"kind":"FieldDefinition","description":{"kind":"StringValue","value":"Property value. May hold a string or the string representation of an object.","block":true},"name":{"kind":"Name","value":"value"},"arguments":[],"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"ObjectOrString"}}},"directives":[]},{"kind":"FieldDefinition","description":{"kind":"StringValue","value":"Property name.","block":true},"name":{"kind":"Name","value":"name"},"arguments":[],"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"String"}}},"directives":[]},{"kind":"FieldDefinition","description":{"kind":"StringValue","value":"Specifies the nature of the value","block":true},"name":{"kind":"Name","value":"valueReference"},"arguments":[],"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"String"}}},"directives":[]}]},{"kind":"InputObjectTypeDefinition","name":{"kind":"Name","value":"IStorePropertyValue"},"directives":[],"fields":[{"kind":"InputValueDefinition","description":{"kind":"StringValue","value":"Property value. May hold a string or the string representation of an object.","block":true},"name":{"kind":"Name","value":"value"},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"ObjectOrString"}}},"directives":[]},{"kind":"InputValueDefinition","description":{"kind":"StringValue","value":"Property name.","block":true},"name":{"kind":"Name","value":"name"},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"String"}}},"directives":[]},{"kind":"InputValueDefinition","description":{"kind":"StringValue","value":"Specifies the nature of the value","block":true},"name":{"kind":"Name","value":"valueReference"},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"String"}}},"directives":[]}]}],"loc":{"start":0,"end":606}};
-    doc$k.loc.source = {"body":"\"\"\"\nProperties that can be associated with products and products groups.\n\"\"\"\ntype StorePropertyValue {\n  \"\"\"\n  Property value. May hold a string or the string representation of an object.\n  \"\"\"\n  value: ObjectOrString!\n  \"\"\"\n  Property name.\n  \"\"\"\n  name: String!\n  \"\"\"\n  Specifies the nature of the value\n  \"\"\"\n  valueReference: String!\n}\n\ninput IStorePropertyValue {\n  \"\"\"\n  Property value. May hold a string or the string representation of an object.\n  \"\"\"\n  value: ObjectOrString!\n  \"\"\"\n  Property name.\n  \"\"\"\n  name: String!\n  \"\"\"\n  Specifies the nature of the value\n  \"\"\"\n  valueReference: String!\n}\n","name":"GraphQL request","locationOffset":{"line":1,"column":1}};
+var doc$k = {"kind":"Document","definitions":[{"kind":"ObjectTypeDefinition","description":{"kind":"StringValue","value":"Properties that can be associated with products and products groups.","block":true},"name":{"kind":"Name","value":"StorePropertyValue"},"interfaces":[],"directives":[],"fields":[{"kind":"FieldDefinition","description":{"kind":"StringValue","value":"Property id. This propert changes according to the content of the object.","block":true},"name":{"kind":"Name","value":"propertyID"},"arguments":[],"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"String"}}},"directives":[]},{"kind":"FieldDefinition","description":{"kind":"StringValue","value":"Property value. May hold a string or the string representation of an object.","block":true},"name":{"kind":"Name","value":"value"},"arguments":[],"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"ObjectOrString"}}},"directives":[]},{"kind":"FieldDefinition","description":{"kind":"StringValue","value":"Property name.","block":true},"name":{"kind":"Name","value":"name"},"arguments":[],"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"String"}}},"directives":[]},{"kind":"FieldDefinition","description":{"kind":"StringValue","value":"Specifies the nature of the value","block":true},"name":{"kind":"Name","value":"valueReference"},"arguments":[],"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"String"}}},"directives":[]}]},{"kind":"InputObjectTypeDefinition","name":{"kind":"Name","value":"IStorePropertyValue"},"directives":[],"fields":[{"kind":"InputValueDefinition","description":{"kind":"StringValue","value":"Property value. May hold a string or the string representation of an object.","block":true},"name":{"kind":"Name","value":"value"},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"ObjectOrString"}}},"directives":[]},{"kind":"InputValueDefinition","description":{"kind":"StringValue","value":"Property name.","block":true},"name":{"kind":"Name","value":"name"},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"String"}}},"directives":[]},{"kind":"InputValueDefinition","description":{"kind":"StringValue","value":"Specifies the nature of the value","block":true},"name":{"kind":"Name","value":"valueReference"},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"String"}}},"directives":[]}]}],"loc":{"start":0,"end":716}};
+    doc$k.loc.source = {"body":"\"\"\"\nProperties that can be associated with products and products groups.\n\"\"\"\ntype StorePropertyValue {\n  \"\"\"\n  Property id. This propert changes according to the content of the object.\n  \"\"\"\n  propertyID: String!\n  \"\"\"\n  Property value. May hold a string or the string representation of an object.\n  \"\"\"\n  value: ObjectOrString!\n  \"\"\"\n  Property name.\n  \"\"\"\n  name: String!\n  \"\"\"\n  Specifies the nature of the value\n  \"\"\"\n  valueReference: String!\n}\n\ninput IStorePropertyValue {\n  \"\"\"\n  Property value. May hold a string or the string representation of an object.\n  \"\"\"\n  value: ObjectOrString!\n  \"\"\"\n  Property name.\n  \"\"\"\n  name: String!\n  \"\"\"\n  Specifies the nature of the value\n  \"\"\"\n  valueReference: String!\n}\n","name":"GraphQL request","locationOffset":{"line":1,"column":1}};
 
 var doc$l = {"kind":"Document","definitions":[{"kind":"ObjectTypeDefinition","description":{"kind":"StringValue","value":"Client profile data.","block":true},"name":{"kind":"Name","value":"StorePerson"},"interfaces":[],"directives":[],"fields":[{"kind":"FieldDefinition","description":{"kind":"StringValue","value":"Client ID.","block":true},"name":{"kind":"Name","value":"id"},"arguments":[],"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"String"}}},"directives":[]},{"kind":"FieldDefinition","description":{"kind":"StringValue","value":"Client email.","block":true},"name":{"kind":"Name","value":"email"},"arguments":[],"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"String"}}},"directives":[]},{"kind":"FieldDefinition","description":{"kind":"StringValue","value":"Client first name.","block":true},"name":{"kind":"Name","value":"givenName"},"arguments":[],"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"String"}}},"directives":[]},{"kind":"FieldDefinition","description":{"kind":"StringValue","value":"Client last name.","block":true},"name":{"kind":"Name","value":"familyName"},"arguments":[],"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"String"}}},"directives":[]}]}],"loc":{"start":0,"end":242}};
     doc$l.loc.source = {"body":"\"\"\"\nClient profile data.\n\"\"\"\ntype StorePerson {\n  \"\"\"\n  Client ID.\n  \"\"\"\n  id: String!\n  \"\"\"\n  Client email.\n  \"\"\"\n  email: String!\n  \"\"\"\n  Client first name.\n  \"\"\"\n  givenName: String!\n  \"\"\"\n  Client last name.\n  \"\"\"\n  familyName: String!\n}\n","name":"GraphQL request","locationOffset":{"line":1,"column":1}};