@faststore/api 1.10.34 → 1.11.7

package/dist/index.d.ts

@@ -128,9 +128,7 @@ export declare const getResolvers: (options: Options) => {
         }>;
     };
     Mutation: {
-        validateCart: (_: unknown, { cart: { order } }: {
-            cart: import("./__generated__/schema").IStoreCart;
-        }, ctx: import("./platforms/vtex").Context) => Promise<{
+        validateCart: (_: unknown, { cart: { order }, session }: import("./__generated__/schema").MutationValidateCartArgs, ctx: import("./platforms/vtex").Context) => Promise<{
             order: {
                 orderNumber: string;
                 acceptedOffer: Promise<{

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

@@ -34,6 +34,10 @@ export declare const VtexCommerce: ({ account, environment }: Options, ctx: Cont
     };
     checkout: {
         simulation: (args: SimulationArgs, { salesChannel }?: SimulationOptions) => Promise<Simulation>;
+        shippingData: ({ id, body }: {
+            id: string;
+            body: unknown;
+        }) => Promise<OrderForm>;
         orderForm: ({ id, refreshOutdatedData, channel, }: {
             id: string;
             refreshOutdatedData?: boolean | undefined;

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

@@ -29,6 +29,10 @@ export declare const getClients: (options: Options, ctx: Context) => {
         };
         checkout: {
             simulation: (args: import("./commerce/types/Simulation").SimulationArgs, { salesChannel }?: import("./commerce/types/Simulation").SimulationOptions) => Promise<import("./commerce/types/Simulation").Simulation>;
+            shippingData: ({ id, body }: {
+                id: string;
+                body: unknown;
+            }) => Promise<import("./commerce/types/OrderForm").OrderForm>;
             orderForm: ({ id, refreshOutdatedData, channel, }: {
                 id: string;
                 refreshOutdatedData?: boolean | undefined;

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

@@ -86,6 +86,7 @@ export interface Product {
         key: string;
         value: string;
     }>;
+    releaseDate: string;
 }
 interface Image {
     imageId: string;

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

@@ -158,9 +158,7 @@ export declare const getResolvers: (_: Options) => {
         }>;
     };
     Mutation: {
-        validateCart: (_: unknown, { cart: { order } }: {
-            cart: import("../..").IStoreCart;
-        }, ctx: Context) => Promise<{
+        validateCart: (_: unknown, { cart: { order }, session }: import("../..").MutationValidateCartArgs, ctx: Context) => Promise<{
             order: {
                 orderNumber: string;
                 acceptedOffer: Promise<{

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

@@ -1,7 +1,5 @@
 export declare const Mutation: {
-    validateCart: (_: unknown, { cart: { order } }: {
-        cart: import("../../..").IStoreCart;
-    }, ctx: import("..").Context) => Promise<{
+    validateCart: (_: unknown, { cart: { order }, session }: import("../../..").MutationValidateCartArgs, ctx: import("..").Context) => Promise<{
         order: {
             orderNumber: string;
             acceptedOffer: Promise<{

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

@@ -1,4 +1,4 @@
-import type { IStoreCart } from '../../../__generated__/schema';
+import type { MutationValidateCartArgs } from '../../../__generated__/schema';
 import type { Context } from '..';
 /**
  * This resolver implements the optimistic cart behavior. The main idea in here
@@ -13,9 +13,7 @@ import type { Context } from '..';
  * 3. Update the orderForm in VTEX platform accordingly
  * 4. If any changes were made, send to the UI the new cart. Null otherwise
  */
-export declare const validateCart: (_: unknown, { cart: { order } }: {
-    cart: IStoreCart;
-}, ctx: Context) => Promise<{
+export declare const validateCart: (_: unknown, { cart: { order }, session }: MutationValidateCartArgs, ctx: Context) => Promise<{
     order: {
         orderNumber: string;
         acceptedOffer: Promise<{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "1.10.34",
+  "version": "1.11.7",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -46,5 +46,5 @@
   "peerDependencies": {
     "graphql": "^15.6.0"
   },
-  "gitHead": "5d59e28c724e389b596e2bb13b1464314eab275f"
+  "gitHead": "0cd611b59da838e4939992888ce60ea768e5e32e"
 }

package/src/__generated__/schema.ts

@@ -208,6 +208,7 @@ export type MutationSubscribeToNewsletterArgs = {
 
 export type MutationValidateCartArgs = {
   cart: IStoreCart;
+  session?: Maybe<IStoreSession>;
 };
 
 
@@ -610,6 +611,8 @@ export type StoreProduct = {
   offers: StoreAggregateOffer;
   /** Product ID, such as [ISBN](https://www.isbn-international.org/content/what-isbn) or similar global IDs. */
   productID: Scalars['String'];
+  /** The product's release date. Formatted using https://en.wikipedia.org/wiki/ISO_8601 */
+  releaseDate: Scalars['String'];
   /** Array with review information. */
   review: Array<StoreReview>;
   /** Meta tag data. */

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

@@ -85,6 +85,17 @@ export const VtexCommerce = (
           }
         )
       },
+      shippingData: (
+        { id, body }: { id: string; body: unknown },
+      ): Promise<OrderForm> => {
+        return fetchAPI(
+          `${base}/api/checkout/pub/orderForm/${id}/attachments/shippingData`,
+          {
+            ...BASE_INIT,
+            body: JSON.stringify(body),
+          },
+        );
+      },
       orderForm: ({
         id,
         refreshOutdatedData = true,

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

@@ -90,6 +90,7 @@ export interface Product {
   specificationGroups: SpecificationGroup[]
   properties: Array<{ name: string; values: string[] }>
   selectedProperties: Array<{ key: string; value: string }>
+  releaseDate: string
 }
 
 interface Image {

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

@@ -116,4 +116,5 @@ export const StoreProduct: Record<string, Resolver<Root>> & {
 
     return [...propertyValueSpecifications, ...propertyValueAttachments]
   },
+  releaseDate: ({ isVariantOf: { releaseDate } }) => releaseDate ?? ''
 }

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

@@ -1,11 +1,15 @@
 import deepEquals from 'fast-deep-equal'
 
 import { md5 } from '../utils/md5'
+import { attachmentToPropertyValue, getPropertyId, VALUE_REFERENCES } from '../utils/propertyValue'
+
 import type {
-  IStoreCart,
+  IStoreSession, 
   IStoreOffer,
   IStoreOrder,
   IStorePropertyValue,
+  Maybe,
+  MutationValidateCartArgs,
 } from '../../../__generated__/schema'
 import type {
   OrderForm,
@@ -13,12 +17,6 @@ import type {
   OrderFormItem,
 } from '../clients/commerce/types/OrderForm'
 import type { Context } from '..'
-import {
-  attachmentToPropertyValue,
-  getPropertyId,
-  VALUE_REFERENCES,
-} from '../utils/propertyValue'
-
 type Indexed<T> = T & { index?: number }
 
 const isAttachment = (value: IStorePropertyValue) =>
@@ -28,7 +26,7 @@ const getId = (item: IStoreOffer) =>
   [
     item.itemOffered.sku,
     item.seller.identifier,
-    item.price,
+    item.price < 0.01 ? 'Gift' : undefined,
     item.itemOffered.additionalProperty
       ?.filter(isAttachment)
       .map(getPropertyId)
@@ -39,7 +37,7 @@ const getId = (item: IStoreOffer) =>
 
 const orderFormItemToOffer = (
   item: OrderFormItem,
-  index?: number
+  index?: number,
 ): Indexed<IStoreOffer> => ({
   listPrice: item.listPrice / 100,
   price: item.sellingPrice / 100,
@@ -55,7 +53,7 @@ const orderFormItemToOffer = (
 })
 
 const offerToOrderItemInput = (
-  offer: Indexed<IStoreOffer>
+  offer: Indexed<IStoreOffer>,
 ): OrderFormInputItem => ({
   quantity: offer.quantity,
   seller: offer.seller.identifier,
@@ -69,14 +67,18 @@ const offerToOrderItemInput = (
   })),
 })
 
-const groupById = (offers: IStoreOffer[]): Map<string, IStoreOffer> =>
+const groupById = (offers: IStoreOffer[]): Map<string, IStoreOffer[]> =>
   offers.reduce((acc, item) => {
     const id = getId(item)
 
-    acc.set(id, acc.get(id) ?? item)
+    if (!acc.has(id)) {
+      acc.set(id, [])
+    }
+
+    acc.get(id)?.push(item)
 
     return acc
-  }, new Map<string, IStoreOffer>())
+  }, new Map<string, IStoreOffer[]>())
 
 const equals = (storeOrder: IStoreOrder, orderForm: OrderForm) => {
   const pick = (item: Indexed<IStoreOffer>, index: number) => ({
@@ -96,9 +98,42 @@ const equals = (storeOrder: IStoreOrder, orderForm: OrderForm) => {
   return isSameOrder && orderItemsAreSync
 }
 
+const joinItems = (form: OrderForm) => {
+  const itemsById = form.items
+    .reduce((acc, item) => {
+      const id = getId(orderFormItemToOffer(item))
+
+      if (!acc[id]) {
+        acc[id] = []
+      }
+
+      acc[id].push(item)
+
+      return acc
+    }, {} as Record<string, OrderFormItem[]>)
+
+  return {
+    ...form,
+    items: Object.values(itemsById).map((items) => {
+      const [item] = items
+      const quantity = items.reduce((acc, i) => acc + i.quantity, 0)
+      const totalPrice = items.reduce(
+        (acc, i) => acc + i.quantity * i.sellingPrice,
+        0,
+      )
+
+      return {
+        ...item,
+        quantity,
+        sellingPrice: totalPrice / quantity,
+      }
+    }),
+  }
+}
+
 const orderFormToCart = async (
   form: OrderForm,
-  skuLoader: Context['loaders']['skuLoader']
+  skuLoader: Context['loaders']['skuLoader'],
 ) => {
   return {
     order: {
@@ -119,7 +154,7 @@ const getOrderFormEtag = ({ items }: OrderForm) => md5(JSON.stringify(items))
 
 const setOrderFormEtag = async (
   form: OrderForm,
-  commerce: Context['clients']['commerce']
+  commerce: Context['clients']['commerce'],
 ) => {
   try {
     const orderForm = await commerce.checkout.setCustomData({
@@ -132,7 +167,7 @@ const setOrderFormEtag = async (
     return orderForm
   } catch (err) {
     console.error(
-      'Error while setting custom data to orderForm.\n Make sure to add the following custom app to the orderForm: \n{"fields":["cartEtag"],"id":"faststore","major":1}.\n More info at: https://developers.vtex.com/vtex-rest-api/docs/customizable-fields-with-checkout-api'
+      'Error while setting custom data to orderForm.\n Make sure to add the following custom app to the orderForm: \n{"fields":["cartEtag"],"id":"faststore","major":1}.\n More info at: https://developers.vtex.com/vtex-rest-api/docs/customizable-fields-with-checkout-api',
     )
 
     throw err
@@ -146,7 +181,7 @@ const setOrderFormEtag = async (
  */
 const isOrderFormStale = (form: OrderForm) => {
   const faststoreData = form.customData?.customApps.find(
-    (app) => app.id === 'faststore'
+    (app) => app.id === 'faststore',
   )
 
   const oldEtag = faststoreData?.fields?.cartEtag
@@ -160,6 +195,31 @@ const isOrderFormStale = (form: OrderForm) => {
   return newEtag !== oldEtag
 }
 
+// Returns the regionalized orderForm
+const getOrderForm = async (
+  id: string,
+  session: Maybe<IStoreSession> | undefined,
+  { clients: { commerce } }: Context,
+) => {
+  const orderForm = await commerce.checkout.orderForm({
+    id,
+  });
+
+  const shouldUpdateShippingData =
+    orderForm.shippingData?.address?.postalCode != session?.postalCode;
+
+  if (shouldUpdateShippingData) {
+    return commerce.checkout.shippingData({
+      id: orderForm.orderFormId,
+      body: {
+        selectedAddresses: [session],
+      },
+    });
+  }
+
+  return orderForm;
+};
+
 /**
  * This resolver implements the optimistic cart behavior. The main idea in here
  * is that we receive a cart from the UI (as query params) and we validate it with
@@ -175,8 +235,8 @@ const isOrderFormStale = (form: OrderForm) => {
  */
 export const validateCart = async (
   _: unknown,
-  { cart: { order } }: { cart: IStoreCart },
-  ctx: Context
+  { cart: { order }, session }: MutationValidateCartArgs,
+  ctx: Context,
 ) => {
   const { enableOrderFormSync } = ctx.storage.flags
   const { orderNumber, acceptedOffer } = order
@@ -186,9 +246,7 @@ export const validateCart = async (
   } = ctx
 
   // Step1: Get OrderForm from VTEX Commerce
-  const orderForm = await commerce.checkout.orderForm({
-    id: orderNumber,
-  })
+  const orderForm = await getOrderForm(orderNumber, session, ctx)
 
   // Step1.5: Check if another system changed the orderForm with this orderNumber
   // If so, this means the user interacted with this cart elsewhere and expects
@@ -197,7 +255,9 @@ export const validateCart = async (
     const isStale = isOrderFormStale(orderForm)
 
     if (isStale === true && orderNumber) {
-      const newOrderForm = await setOrderFormEtag(orderForm, commerce)
+      const newOrderForm = await setOrderFormEtag(orderForm, commerce).then(
+        joinItems,
+      )
 
       return orderFormToCart(newOrderForm, skuLoader)
     }
@@ -206,37 +266,54 @@ export const validateCart = async (
   // Step2: Process items from both browser and checkout so they have the same shape
   const browserItemsById = groupById(acceptedOffer)
   const originItemsById = groupById(orderForm.items.map(orderFormItemToOffer))
-  const browserItems = Array.from(browserItemsById.values()) // items on the user's browser
-  const originItems = Array.from(originItemsById.values()) // items on the VTEX platform backend
+  const originItems = Array.from(originItemsById.entries()); // items on the VTEX platform backend
+  const browserItems = Array.from(browserItemsById.entries()); // items on the user's browser
 
   // Step3: Compute delta changes
-  const { itemsToAdd, itemsToUpdate } = browserItems.reduce(
-    (acc, item) => {
-      const maybeOriginItem = originItemsById.get(getId(item))
-
-      if (!maybeOriginItem) {
-        acc.itemsToAdd.push(item)
-      } else {
+  const { itemsToAdd, itemsToUpdate } = browserItems
+    .reduce(
+      (acc, [id, items]) => {
+        const maybeOriginItem = originItemsById.get(id)
+
+        // Adding new items to cart
+        if (!maybeOriginItem) {
+          items.forEach((item) => acc.itemsToAdd.push(item))
+
+          return acc
+        }
+
+        // Update existing items
+        const [head, ...tail] = maybeOriginItem
+        const totalQuantity = items.reduce(
+          (acc, curr) => acc + curr.quantity,
+          0,
+        )
+
+        // set total quantity to first item
         acc.itemsToUpdate.push({
-          ...maybeOriginItem,
-          quantity: item.quantity,
+          ...head,
+          quantity: totalQuantity,
         })
-      }
 
-      return acc
-    },
-    {
-      itemsToAdd: [] as IStoreOffer[],
-      itemsToUpdate: [] as IStoreOffer[],
-    }
-  )
+        // Remove all the rest
+        tail.forEach((item) =>
+          acc.itemsToUpdate.push({ ...item, quantity: 0 })
+        )
+
+        return acc
+      },
+      {
+        itemsToAdd: [] as IStoreOffer[],
+        itemsToUpdate: [] as IStoreOffer[],
+      },
+    )
 
   const itemsToDelete = originItems
-    .filter((item) => !browserItemsById.has(getId(item)))
-    .map((item) => ({ ...item, quantity: 0 }))
+    .filter(([id]) => !browserItemsById.has(id))
+    .flatMap(([, items]) => items.map((item) => ({ ...item, quantity: 0 })))
 
   const changes = [...itemsToAdd, ...itemsToUpdate, ...itemsToDelete].map(
-    offerToOrderItemInput
+    offerToOrderItemInput,
   )
 
   if (changes.length === 0) {
@@ -254,6 +331,7 @@ export const validateCart = async (
     .then((form) =>
       enableOrderFormSync ? setOrderFormEtag(form, commerce) : form
     )
+    .then(joinItems)
 
   // Step5: If no changes detected before/after updating orderForm, the order is validated
   if (equals(order, updatedOrderForm)) {

package/src/typeDefs/mutation.graphql

@@ -2,7 +2,7 @@ type Mutation {
   """
   Checks for changes between the cart presented in the UI and the cart stored in the ecommerce platform. If changes are detected, it returns the cart stored on the platform. Otherwise, it returns `null`.
   """
-  validateCart(cart: IStoreCart!): StoreCart
+  validateCart(cart: IStoreCart!, session: IStoreSession): StoreCart
   """
   Updates a web session with the specified values.
   """

package/src/typeDefs/product.graphql

@@ -62,6 +62,10 @@ type StoreProduct {
   Array of additional properties.
   """
   additionalProperty: [StorePropertyValue!]!
+  """
+  The product's release date. Formatted using https://en.wikipedia.org/wiki/ISO_8601
+  """
+  releaseDate: String!
 }
 
 """