@faststore/api 1.8.33 → 1.8.36

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

@@ -6,6 +6,7 @@ export interface Options {
     account: string;
     environment: 'vtexcommercestable' | 'vtexcommercebeta';
     channel: string;
+    locale: string;
     hideUnavailableItems: boolean;
     flags?: FeatureFlags;
 }
@@ -23,6 +24,7 @@ export interface Context {
      * */
     storage: {
         channel: Required<Channel>;
+        locale: string;
         flags: FeatureFlags;
     };
     headers: Record<string, string>;
@@ -93,6 +95,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>>;
+    StorePropertyValue: Record<string, Resolver<import("../..").IStorePropertyValue, unknown, any>>;
     ObjectOrString: import("graphql").GraphQLScalarType;
     Query: {
         product: (_: unknown, { locator }: import("../..").QueryProductArgs, ctx: Context) => Promise<import("./utils/enhanceSku").EnhancedSku>;

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

@@ -0,0 +1,5 @@
+import type { Resolver } from '..';
+import type { IStorePropertyValue } from '../../../__generated__/schema';
+declare type Root = IStorePropertyValue;
+export declare const StorePropertyValue: Record<string, Resolver<Root>>;
+export {};

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

@@ -1,4 +1,3 @@
-import type { Context } from '..';
 export interface Channel {
     regionId?: string;
     salesChannel?: string;
@@ -7,4 +6,3 @@ export default class ChannelMarshal {
     static parse(channelString: string): Required<Channel>;
     static stringify(channel: Channel): string;
 }
-export declare const mutateChannelContext: (ctx: Context, channelString: string) => void;

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

@@ -0,0 +1,3 @@
+import type { Context } from '..';
+export declare const mutateChannelContext: (ctx: Context, channelString: string) => void;
+export declare const mutateLocaleContext: (ctx: Context, locale: string) => void;

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

@@ -13,3 +13,5 @@ export declare const transformSelectedFacet: ({ key, value }: SelectedFacet) =>
     key: string;
     value: string;
 };
+export declare const findLocale: (facets?: SelectedFacet[] | null | undefined) => string | null;
+export declare const findChannel: (facets?: SelectedFacet[] | null | undefined) => string | null;

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

@@ -1,5 +1,12 @@
+import type { IStorePropertyValue } from '../../../__generated__/schema';
+import type { Attachment } from '../clients/commerce/types/OrderForm';
 export declare const VALUE_REFERENCES: {
-    readonly variation: "VARIATION";
     readonly attachment: "ATTACHMENT";
     readonly specification: "SPECIFICATION";
 };
+export declare function attachmentToPropertyValue(attachment: Attachment): {
+    name: string;
+    value: Record<string, string>;
+    valueReference: "ATTACHMENT";
+};
+export declare function getPropertyId(item: IStorePropertyValue): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "1.8.33",
+  "version": "1.8.36",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -45,5 +45,5 @@
   "peerDependencies": {
     "graphql": "^15.6.0"
   },
-  "gitHead": "bc168106d3da1b1a6ca2c0aefcb21f02c7b3df44"
+  "gitHead": "5d3f39d424dc7884807d0a7d724736f35ca34f61"
 }

package/src/__generated__/schema.ts

@@ -472,6 +472,8 @@ export 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/src/platforms/vtex/clients/search/index.ts

@@ -105,6 +105,7 @@ export const IntelligentSearch = (
       query,
       sort,
       fuzzy,
+      locale: ctx.storage.locale,
     })
 
     if (hideUnavailableItems !== undefined) {
@@ -125,20 +126,39 @@ export const IntelligentSearch = (
 
   const suggestedProducts = (
     args: Omit<SearchArgs, 'type'>
-  ): Promise<ProductSearchResult> =>
-    fetchAPI(
-      `${base}/_v/api/intelligent-search/product_search?query=${args.query}`
+  ): Promise<ProductSearchResult> => {
+    const params = new URLSearchParams({
+      query: args.query?.toString() ?? '',
+      locale: ctx.storage.locale,
+    })
+
+    return fetchAPI(
+      `${base}/_v/api/intelligent-search/product_search?${params.toString()}`
     )
+  }
 
   const suggestedTerms = (
     args: Omit<SearchArgs, 'type'>
-  ): Promise<Suggestion> =>
-    fetchAPI(
-      `${base}/_v/api/intelligent-search/search_suggestions?query=${args.query}`
+  ): Promise<Suggestion> => {
+    const params = new URLSearchParams({
+      query: args.query?.toString() ?? '',
+      locale: ctx.storage.locale,
+    })
+
+    return fetchAPI(
+      `${base}/_v/api/intelligent-search/search_suggestions?${params.toString()}`
     )
+  }
+
+  const topSearches = (): Promise<Suggestion> => {
+    const params = new URLSearchParams({
+      locale: ctx.storage.locale,
+    })
 
-  const topSearches = (): Promise<Suggestion> =>
-    fetchAPI(`${base}/_v/api/intelligent-search/top_searches`)
+    return fetchAPI(
+      `${base}/_v/api/intelligent-search/top_searches?${params.toString()}`
+    )
+  }
 
   const facets = (args: Omit<SearchArgs, 'type'>) =>
     search<FacetSearchResult>({ ...args, type: 'facets' })

package/src/platforms/vtex/index.ts

@@ -14,6 +14,7 @@ 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 type { Loaders } from './loaders'
 import type { Clients } from './clients'
 import type { Channel } from './utils/channel'
@@ -25,6 +26,7 @@ export interface Options {
   environment: 'vtexcommercestable' | 'vtexcommercebeta'
   // Default sales channel to use for fetching products
   channel: string
+  locale: string
   hideUnavailableItems: boolean
   flags?: FeatureFlags
 }
@@ -44,6 +46,7 @@ export interface Context {
    * */
   storage: {
     channel: Required<Channel>
+    locale: string
     flags: FeatureFlags
   }
   headers: Record<string, string>
@@ -68,6 +71,7 @@ const Resolvers = {
   StoreReview,
   StoreProductGroup,
   StoreSearchResult,
+  StorePropertyValue,
   ObjectOrString,
   Query,
   Mutation,
@@ -77,6 +81,7 @@ 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)

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

@@ -5,7 +5,10 @@ import type { EnhancedCommercialOffer } from '../utils/enhanceCommercialOffer'
 import type { Resolver } from '..'
 import type { PromiseType } from '../../../typings'
 import type { Query } from './query'
-import { VALUE_REFERENCES } from '../utils/propertyValue'
+import {
+  attachmentToPropertyValue,
+  VALUE_REFERENCES,
+} from '../utils/propertyValue'
 import type { Attachment } from '../clients/commerce/types/OrderForm'
 
 type QueryProduct = PromiseType<ReturnType<typeof Query.product>>
@@ -91,23 +94,24 @@ export const StoreProduct: Record<string, Resolver<Root>> & {
       )
       .sort(bestOfferFirst),
   isVariantOf: (root) => root,
-  additionalProperty: ({ variations = [], attachmentsValues }) => {
-    const propertyValueVariations = variations.flatMap(({ name, values }) =>
-      values.map((value) => ({
-        name,
-        value,
-        valueReference: VALUE_REFERENCES.variation,
-      }))
+  additionalProperty: ({
+    // Search uses the name variations for specifications
+    variations: specifications = [],
+    attachmentsValues = [],
+  }) => {
+    const propertyValueSpecifications = specifications.flatMap(
+      ({ name, values }) =>
+        values.map((value) => ({
+          name,
+          value,
+          valueReference: VALUE_REFERENCES.specification,
+        }))
     )
 
-    const propertyValueAttachments = (attachmentsValues ?? []).map(
-      (attachment) => ({
-        name: attachment.name,
-        value: attachment.content,
-        valueReference: VALUE_REFERENCES.attachment,
-      })
+    const propertyValueAttachments = attachmentsValues.map(
+      attachmentToPropertyValue
     )
 
-    return [...propertyValueVariations, ...propertyValueAttachments]
+    return [...propertyValueSpecifications, ...propertyValueAttachments]
   },
 }

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

@@ -0,0 +1,12 @@
+import type { Resolver } from '..'
+import type { IStorePropertyValue } from '../../../__generated__/schema'
+import { getPropertyId } from '../utils/propertyValue'
+
+type Root = IStorePropertyValue
+
+export const StorePropertyValue: Record<string, Resolver<Root>> = {
+  propertyID: (root) => getPropertyId(root),
+  name: ({ name }) => name,
+  value: ({ value }) => value,
+  valueReference: ({ valueReference }) => valueReference,
+}

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

@@ -1,5 +1,10 @@
+import { mutateChannelContext, mutateLocaleContext } from '../utils/contex'
 import { enhanceSku } from '../utils/enhanceSku'
-import { transformSelectedFacet } from '../utils/facets'
+import {
+  findChannel,
+  findLocale,
+  transformSelectedFacet,
+} from '../utils/facets'
 import { SORT_MAP } from '../utils/sort'
 import { StoreCollection } from './collection'
 import type {
@@ -11,16 +16,19 @@ import type {
 } from '../../../__generated__/schema'
 import type { CategoryTree } from '../clients/commerce/types/CategoryTree'
 import type { Context } from '../index'
-import { mutateChannelContext } from '../utils/channel'
 
 export const Query = {
   product: async (_: unknown, { locator }: QueryProductArgs, ctx: Context) => {
     // Insert channel in context for later usage
-    const channelString = locator.find((facet) => facet.key === 'channel')
-      ?.value
+    const channel = findChannel(locator)
+    const locale = findLocale(locator)
 
-    if (channelString) {
-      mutateChannelContext(ctx, channelString)
+    if (channel) {
+      mutateChannelContext(ctx, channel)
+    }
+
+    if (locale) {
+      mutateLocaleContext(ctx, locale)
     }
 
     const {
@@ -42,12 +50,15 @@ export const Query = {
     ctx: Context
   ) => {
     // Insert channel in context for later usage
-    const channelString = selectedFacets?.find(
-      (facet) => facet.key === 'channel'
-    )?.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

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

@@ -12,7 +12,11 @@ import type {
   OrderFormItem,
 } from '../clients/commerce/types/OrderForm'
 import type { Context } from '..'
-import { VALUE_REFERENCES } from '../utils/propertyValue'
+import {
+  attachmentToPropertyValue,
+  getPropertyId,
+  VALUE_REFERENCES,
+} from '../utils/propertyValue'
 
 type Indexed<T> = T & { index?: number }
 
@@ -21,26 +25,12 @@ const getAttachments = (item: IStoreOffer) =>
     (i) => i.valueReference === VALUE_REFERENCES.attachment
   )
 
-const serializeAttachment = (item: IStoreOffer) => {
-  const attachments = getAttachments(item)
-
-  if (attachments?.length === 0) {
-    return null
-  }
-
-  return attachments
-    ?.map(
-      (attachment) => `${attachment.name}:${JSON.stringify(attachment.value)}`
-    )
-    .join('-')
-}
-
 const getId = (item: IStoreOffer) =>
   [
     item.itemOffered.sku,
     item.seller.identifier,
     item.price,
-    serializeAttachment(item),
+    item.itemOffered.additionalProperty?.map(getPropertyId).join('-'),
   ]
     .filter(Boolean)
     .join('::')
@@ -57,6 +47,7 @@ const orderFormItemToOffer = (
     sku: item.id,
     image: [],
     name: item.name,
+    additionalProperty: item.attachments.map(attachmentToPropertyValue),
   },
   index,
 })
@@ -68,7 +59,7 @@ const offerToOrderItemInput = (
   seller: offer.seller.identifier,
   id: offer.itemOffered.sku,
   index: offer.index,
-  attachments: getAttachments(offer)?.map((attachment) => ({
+  attachments: (getAttachments(offer) ?? []).map((attachment) => ({
     name: attachment.name,
     content: attachment.value,
   })),

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

@@ -1,5 +1,3 @@
-import type { Context } from '..'
-
 export interface Channel {
   regionId?: string
   salesChannel?: string
@@ -25,7 +23,3 @@ export default class ChannelMarshal {
     return JSON.stringify(channel)
   }
 }
-
-export const mutateChannelContext = (ctx: Context, channelString: string) => {
-  ctx.storage.channel = ChannelMarshal.parse(channelString)
-}

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

@@ -0,0 +1,10 @@
+import ChannelMarshal from './channel'
+import type { Context } from '..'
+
+export const mutateChannelContext = (ctx: Context, channelString: string) => {
+  ctx.storage.channel = ChannelMarshal.parse(channelString)
+}
+
+export const mutateLocaleContext = (ctx: Context, locale: string) => {
+  ctx.storage.locale = locale
+}

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

@@ -1,4 +1,5 @@
 import ChannelMarshal from './channel'
+import type { Maybe } from '../../../__generated__/schema'
 
 export interface SelectedFacet {
   key: string
@@ -24,7 +25,17 @@ export const transformSelectedFacet = ({ key, value }: SelectedFacet) => {
       return channelFacets
     }
 
+    case 'locale': {
+      return [] // remove this facet from search
+    }
+
     default:
       return { key, value }
   }
 }
+
+export const findLocale = (facets?: Maybe<SelectedFacet[]>) =>
+  facets?.find((x) => x.key === 'locale')?.value ?? null
+
+export const findChannel = (facets?: Maybe<SelectedFacet[]>) =>
+  facets?.find((facet) => facet.key === 'channel')?.value ?? null

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

@@ -1,5 +1,22 @@
+import type { IStorePropertyValue } from '../../../__generated__/schema'
+import type { Attachment } from '../clients/commerce/types/OrderForm'
+import { md5 } from './md5'
+
 export const VALUE_REFERENCES = {
-  variation: 'VARIATION',
   attachment: 'ATTACHMENT',
   specification: 'SPECIFICATION',
 } as const
+
+export function attachmentToPropertyValue(attachment: Attachment) {
+  return {
+    name: attachment.name,
+    value: attachment.content,
+    valueReference: VALUE_REFERENCES.attachment,
+  }
+}
+
+export function getPropertyId(item: IStorePropertyValue) {
+  return md5(
+    `${item.name}:${JSON.stringify(item.value)}:${item.valueReference}`
+  )
+}

package/src/typeDefs/propertyValue.graphql

@@ -2,6 +2,10 @@
 Properties that can be associated with products and products groups.
 """
 type StorePropertyValue {
+  """
+  Property id. This propert changes according to the content of the object.
+  """
+  propertyID: String!
   """
   Property value. May hold a string or the string representation of an object.
   """