@faststore/api 1.12.36 → 1.12.38

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

@@ -26,7 +26,7 @@ export declare const VtexCommerce: ({ account, environment }: Options, ctx: Cont
             pagetype: (slug: string) => Promise<PortalPagetype>;
         };
         products: {
-            crossselling: ({ type, productId, groupByProduct }: {
+            crossselling: ({ type, productId, groupByProduct, }: {
                 type: ValueOf<typeof FACET_CROSS_SELLING_MAP>;
                 productId: string;
                 groupByProduct?: boolean | undefined;
@@ -35,7 +35,7 @@ export declare const VtexCommerce: ({ account, environment }: Options, ctx: Cont
     };
     checkout: {
         simulation: (args: SimulationArgs, { salesChannel }?: SimulationOptions) => Promise<Simulation>;
-        shippingData: ({ id, body }: {
+        shippingData: ({ id, body, }: {
             id: string;
             body: unknown;
         }) => Promise<OrderForm>;
@@ -60,6 +60,7 @@ export declare const VtexCommerce: ({ account, environment }: Options, ctx: Cont
         address: ({ postalCode, country, }: AddressInput) => Promise<Address>;
     };
     session: (search: string) => Promise<Session>;
+    getSessionOrder: () => Promise<Session>;
     subscribeToNewsletter: (data: {
         name: string;
         email: string;

package/dist/platforms/vtex/clients/commerce/types/Session.d.ts

@@ -5,6 +5,7 @@ export interface Session {
 export interface Namespaces {
     profile?: Profile;
     store?: Store;
+    checkout?: Checkout;
 }
 export interface Value {
     value: string;
@@ -22,3 +23,6 @@ export interface Profile {
     firstName?: Value;
     lastName?: Value;
 }
+export interface Checkout {
+    orderFormId?: Value;
+}

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

@@ -20,7 +20,7 @@ export declare const getClients: (options: Options, ctx: Context) => {
                 pagetype: (slug: string) => Promise<import("./commerce/types/Portal").PortalPagetype>;
             };
             products: {
-                crossselling: ({ type, productId, groupByProduct }: {
+                crossselling: ({ type, productId, groupByProduct, }: {
                     type: "whoboughtalsobought" | "whosawalsosaw" | "similars" | "whosawalsobought" | "accessories" | "suggestions";
                     productId: string;
                     groupByProduct?: boolean | undefined;
@@ -29,7 +29,7 @@ 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 }: {
+            shippingData: ({ id, body, }: {
                 id: string;
                 body: unknown;
             }) => Promise<import("./commerce/types/OrderForm").OrderForm>;
@@ -54,6 +54,7 @@ export declare const getClients: (options: Options, ctx: Context) => {
             address: ({ postalCode, country, }: import("./commerce/types/Address").AddressInput) => Promise<import("./commerce/types/Address").Address>;
         };
         session: (search: string) => Promise<import("./commerce/types/Session").Session>;
+        getSessionOrder: () => Promise<import("./commerce/types/Session").Session>;
         subscribeToNewsletter: (data: {
             name: string;
             email: string;

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

@@ -1,5 +1,5 @@
-import type { MutationValidateCartArgs } from '../../../__generated__/schema';
 import type { Context } from '..';
+import type { MutationValidateCartArgs } from '../../../__generated__/schema';
 /**
  * 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

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

@@ -0,0 +1 @@
+export declare const getCookie: (name: string, cookie: string) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "1.12.36",
+  "version": "1.12.38",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -30,7 +30,7 @@
     "p-limit": "^3.1.0"
   },
   "devDependencies": {
-    "@faststore/shared": "^1.12.35",
+    "@faststore/shared": "^1.12.37",
     "@graphql-codegen/cli": "2.2.0",
     "@graphql-codegen/typescript": "2.2.2",
     "concurrently": "^6.2.1",
@@ -45,5 +45,6 @@
   },
   "peerDependencies": {
     "graphql": "^15.6.0"
-  }
+  },
+  "gitHead": "659eb1ff4c96f85004b3edd1f924f5753fc7a275"
 }

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

@@ -15,6 +15,7 @@ import type {
 } from './types/Simulation'
 import type { Session } from './types/Session'
 import type { Channel } from '../../utils/channel'
+import { getCookie } from '../../utils/getCookies'
 import type { SalesChannel } from './types/SalesChannel'
 import { MasterDataResponse } from './types/Newsletter'
 import type { Address, AddressInput } from './types/Address'
@@ -51,20 +52,22 @@ export const VtexCommerce = (
           fetchAPI(`${base}/api/catalog_system/pub/portal/pagetype/${slug}`),
       },
       products: {
-        crossselling: (
-          { type, productId, groupByProduct = true }: {
-            type: ValueOf<typeof FACET_CROSS_SELLING_MAP>;
-            productId: string;
-            groupByProduct?: boolean;
-          },
-        ): Promise<PortalProduct[]> => {
+        crossselling: ({
+          type,
+          productId,
+          groupByProduct = true,
+        }: {
+          type: ValueOf<typeof FACET_CROSS_SELLING_MAP>
+          productId: string
+          groupByProduct?: boolean
+        }): Promise<PortalProduct[]> => {
           const params = new URLSearchParams({
             sc: ctx.storage.channel.salesChannel,
             groupByProduct: groupByProduct.toString(),
           })
 
           return fetchAPI(
-            `${base}/api/catalog_system/pub/products/crossselling/${type}/${productId}?${params}`,
+            `${base}/api/catalog_system/pub/products/crossselling/${type}/${productId}?${params}`
           )
         },
       },
@@ -86,16 +89,20 @@ export const VtexCommerce = (
           }
         )
       },
-      shippingData: (
-        { id, body }: { id: string; body: unknown },
-      ): Promise<OrderForm> => {
+      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,
@@ -159,7 +166,7 @@ export const VtexCommerce = (
             ...BASE_INIT,
             body: JSON.stringify({ value }),
             method: 'PUT',
-          },
+          }
         )
       },
       region: async ({
@@ -189,14 +196,34 @@ export const VtexCommerce = (
         'items',
         'profile.id,profile.email,profile.firstName,profile.lastName,store.channel,store.countryCode,store.cultureInfo,store.currencyCode,store.currencySymbol'
       )
-
-      return fetchAPI(`${base}/api/sessions?${params.toString()}`, {
-        method: 'POST',
+      if (getCookie('vtex_session', ctx.headers.cookie)) {
+        // cookie set
+        return fetchAPI(`${base}/api/sessions?${params.toString()}`, {
+          method: 'GET',
+          headers: {
+            'content-type': 'application/json',
+            cookie: ctx.headers.cookie,
+          },
+        })
+      } else {
+        // cookie unset -> create session
+        return fetchAPI(`${base}/api/sessions?${params.toString()}`, {
+          method: 'POST',
+          headers: {
+            'content-type': 'application/json',
+            cookie: ctx.headers.cookie,
+          },
+          body: '{}',
+        })
+      }
+    },
+    getSessionOrder: (): Promise<Session> => {
+      return fetchAPI(`${base}/api/sessions?items=checkout.orderFormId`, {
+        method: 'GET',
         headers: {
           'content-type': 'application/json',
           cookie: ctx.headers.cookie,
         },
-        body: '{}',
       })
     },
     subscribeToNewsletter: (data: {

package/src/platforms/vtex/clients/commerce/types/Session.ts

@@ -6,6 +6,7 @@ export interface Session {
 export interface Namespaces {
   profile?: Profile
   store?: Store
+  checkout?: Checkout
 }
 
 export interface Value {
@@ -26,3 +27,7 @@ export interface Profile {
   firstName?: Value
   lastName?: Value
 }
+
+export interface Checkout {
+  orderFormId?: Value
+}

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

@@ -1,22 +1,27 @@
 import deepEquals from 'fast-deep-equal'
 
+import { mutateChannelContext, mutateLocaleContext } from '../utils/contex'
+import { getCookie } from '../utils/getCookies'
 import { md5 } from '../utils/md5'
-import { attachmentToPropertyValue, getPropertyId, VALUE_REFERENCES } from '../utils/propertyValue'
+import {
+  attachmentToPropertyValue,
+  getPropertyId,
+  VALUE_REFERENCES
+} from '../utils/propertyValue'
 
+import type { Context } from '..'
 import type {
-  IStoreSession, 
   IStoreOffer,
   IStoreOrder,
-  IStorePropertyValue,
-  Maybe,
-  MutationValidateCartArgs,
+  IStorePropertyValue, IStoreSession, Maybe,
+  MutationValidateCartArgs
 } from '../../../__generated__/schema'
 import type {
   OrderForm,
   OrderFormInputItem,
-  OrderFormItem,
+  OrderFormItem
 } from '../clients/commerce/types/OrderForm'
-import type { Context } from '..'
+
 type Indexed<T> = T & { index?: number }
 
 const isAttachment = (value: IStorePropertyValue) =>
@@ -37,7 +42,7 @@ const getId = (item: IStoreOffer) =>
 
 const orderFormItemToOffer = (
   item: OrderFormItem,
-  index?: number,
+  index?: number
 ): Indexed<IStoreOffer> => ({
   listPrice: item.listPrice / 100,
   price: item.sellingPrice / 100,
@@ -53,7 +58,7 @@ const orderFormItemToOffer = (
 })
 
 const offerToOrderItemInput = (
-  offer: Indexed<IStoreOffer>,
+  offer: Indexed<IStoreOffer>
 ): OrderFormInputItem => ({
   quantity: offer.quantity,
   seller: offer.seller.identifier,
@@ -99,18 +104,17 @@ const equals = (storeOrder: IStoreOrder, orderForm: OrderForm) => {
 }
 
 const joinItems = (form: OrderForm) => {
-  const itemsById = form.items
-    .reduce((acc, item) => {
-      const id = getId(orderFormItemToOffer(item))
+  const itemsById = form.items.reduce((acc, item) => {
+    const id = getId(orderFormItemToOffer(item))
 
-      if (!acc[id]) {
-        acc[id] = []
-      }
+    if (!acc[id]) {
+      acc[id] = []
+    }
 
-      acc[id].push(item)
+    acc[id].push(item)
 
-      return acc
-    }, {} as Record<string, OrderFormItem[]>)
+    return acc
+  }, {} as Record<string, OrderFormItem[]>)
 
   return {
     ...form,
@@ -119,7 +123,7 @@ const joinItems = (form: OrderForm) => {
       const quantity = items.reduce((acc, i) => acc + i.quantity, 0)
       const totalPrice = items.reduce(
         (acc, i) => acc + i.quantity * i.sellingPrice,
-        0,
+        0
       )
 
       return {
@@ -133,14 +137,14 @@ const joinItems = (form: OrderForm) => {
 
 const orderFormToCart = async (
   form: OrderForm,
-  skuLoader: Context['loaders']['skuLoader'],
+  skuLoader: Context['loaders']['skuLoader']
 ) => {
   return {
     order: {
       orderNumber: form.orderFormId,
       acceptedOffer: form.items.map(async (item) => ({
         ...item,
-        product: await skuLoader.load(item.id), // TODO: add channel
+        product: await skuLoader.load(item.id),
       })),
     },
     messages: form.messages.map(({ text, status }) => ({
@@ -154,7 +158,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({
@@ -167,7 +171,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
@@ -181,7 +185,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
@@ -195,28 +199,42 @@ const isOrderFormStale = (form: OrderForm) => {
   return newEtag !== oldEtag
 }
 
+async function getOrderNumberFromSession(
+  headers: Record<string, string> = {},
+  commerce: Context['clients']['commerce']
+) {
+
+  const cookieSession = getCookie('vtex_session', headers.cookie)
+
+  if (cookieSession) {
+    const { namespaces } = await commerce.getSessionOrder()
+    return namespaces.checkout?.orderFormId?.value
+  }
+  return ;
+}
+
 // Returns the regionalized orderForm
 const getOrderForm = async (
   id: string,
   session: Maybe<IStoreSession> | undefined,
-  { clients: { commerce } }: Context,
+  { clients: { commerce } }: Context
 ) => {
   const orderForm = await commerce.checkout.orderForm({
     id,
-  });
+  })
 
   // Stores that are not yet providing the session while validating the cart
   // should not be able to update the shipping data
   //
   // This was causing errors while validating regionalizated carts
   // because the following code was trying to change the shippingData to an undefined address/session
-  if(!session) {
+  if (!session) {
     return orderForm
   }
 
   const shouldUpdateShippingData =
     typeof session.postalCode === 'string' &&
-    orderForm.shippingData?.address?.postalCode != session.postalCode;
+    orderForm.shippingData?.address?.postalCode != session.postalCode
 
   if (shouldUpdateShippingData) {
     return commerce.checkout.shippingData({
@@ -224,11 +242,11 @@ const getOrderForm = async (
       body: {
         selectedAddresses: [session],
       },
-    });
+    })
   }
 
-  return orderForm;
-};
+  return orderForm
+}
 
 /**
  * This resolver implements the optimistic cart behavior. The main idea in here
@@ -246,84 +264,93 @@ const getOrderForm = async (
 export const validateCart = async (
   _: unknown,
   { cart: { order }, session }: MutationValidateCartArgs,
-  ctx: Context,
+  ctx: Context
 ) => {
-  const { enableOrderFormSync } = ctx.storage.flags
-  const { orderNumber, acceptedOffer } = order
+  const { orderNumber: orderNumberFromCart, acceptedOffer } = order
   const {
     clients: { commerce },
     loaders: { skuLoader },
+    headers,
   } = ctx
 
+  const channel = session?.channel
+  const locale = session?.locale
+
+  if (channel) {
+    mutateChannelContext(ctx, channel)
+  }
+
+  if (locale) {
+    mutateLocaleContext(ctx, locale)
+  }
+
+  const orderNumberFromSession = await getOrderNumberFromSession(
+    headers,
+    commerce
+  )
+
+  const orderNumber = orderNumberFromSession ?? orderNumberFromCart ?? ''
+
   // Step1: Get OrderForm from VTEX Commerce
   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
   // to see this new cart state instead of what's stored on the user's browser.
-  if (enableOrderFormSync === true) {
-    const isStale = isOrderFormStale(orderForm)
-
-    if (isStale === true && orderNumber) {
-      const newOrderForm = await setOrderFormEtag(orderForm, commerce).then(
-        joinItems,
+  const isStale = isOrderFormStale(orderForm)
+  
+  if (isStale && orderNumber) {
+    const newOrderForm = await setOrderFormEtag(orderForm, commerce).then(
+      joinItems
       )
-
-      return orderFormToCart(newOrderForm, skuLoader)
-    }
+    return orderFormToCart(newOrderForm, skuLoader)
   }
 
   // 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 originItems = Array.from(originItemsById.entries()); // items on the VTEX platform backend
-  const browserItems = Array.from(browserItemsById.entries()); // items on the user's browser
+  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, [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({
-          ...head,
-          quantity: totalQuantity,
-        })
-
-        // Remove all the rest
-        tail.forEach((item) =>
-          acc.itemsToUpdate.push({ ...item, quantity: 0 })
-        )
+  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
-      },
-      {
-        itemsToAdd: [] as IStoreOffer[],
-        itemsToUpdate: [] as IStoreOffer[],
-      },
-    )
+      }
+
+      // 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({
+        ...head,
+        quantity: totalQuantity,
+      })
+
+      // 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(([id]) => !browserItemsById.has(id))
     .flatMap(([, items]) => items.map((item) => ({ ...item, quantity: 0 })))
 
   const changes = [...itemsToAdd, ...itemsToUpdate, ...itemsToDelete].map(
-    offerToOrderItemInput,
+    offerToOrderItemInput
   )
 
   if (changes.length === 0) {
@@ -339,7 +366,7 @@ export const validateCart = async (
     })
     // update orderForm etag so we know last time we touched this orderForm
     .then((form) =>
-      enableOrderFormSync ? setOrderFormEtag(form, commerce) : form
+      setOrderFormEtag(form, commerce)
     )
     .then(joinItems)
 

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

@@ -0,0 +1,8 @@
+export const getCookie = (name: string, cookie: string): string => {
+  const value = `; ${cookie}`
+  const parts = value.split(`; ${name}=`)
+  if (parts.length === 2) {
+    return parts?.pop()?.split(';').shift() ?? ''
+  }
+  return ''
+}