@faststore/api 3.41.8 → 3.45.0

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

@@ -0,0 +1,205 @@
+import type { Resolver } from '..'
+import type {
+  Maybe,
+  UserOrderCustomField,
+  UserOrderDeliveryOption,
+} from '../../..'
+import type { PromiseType } from '../../../typings'
+import type { Query } from './query'
+import { getLocalizedEstimates } from './shippingSLA'
+
+type QueryUserOrder = PromiseType<ReturnType<typeof Query.userOrder>>
+
+export type Root = QueryUserOrder
+
+const deliveryChannelsMapping = {
+  ['pickup-in-point']: 'Pickup',
+  delivery: 'Delivery',
+  pickup: 'Pickup',
+  ['take-away']: 'Take away',
+  ['']: '',
+} as const
+
+export const UserOrder: Record<string, Resolver<Root>> = {
+  orderId: ({ orderId }) => orderId,
+  totals: ({ totals }) => totals,
+  items: ({ items }) => items,
+  shippingData: ({ shippingData }) => shippingData,
+  paymentData: ({ paymentData }) => paymentData,
+  deliveryOptionsData: (root) => {
+    const { shippingData, items } = root
+    const logisticsInfo = shippingData?.logisticsInfo || []
+    const addresses = shippingData?.selectedAddresses ||
+      shippingData?.availableAddresses || [shippingData?.address]
+
+    const groupedDeliveryOptions = logisticsInfo.reduce(
+      (acc, logisticsItem) => {
+        const selectedSla = logisticsItem?.selectedSla || '' // Normal / Express
+        const deliveryChannel =
+          logisticsItem?.selectedDeliveryChannel ||
+          logisticsItem?.deliveryChannel ||
+          ''
+        const deliveryCompany = logisticsItem?.deliveryCompany || '' // Correios / Fedex
+        const deliveryWindow = logisticsItem?.deliveryWindow
+        const pickupStoreInfo = logisticsItem?.pickupStoreInfo
+        const shippingEstimate = logisticsItem?.shippingEstimate || '' // 1bd
+        const friendlyShippingEstimate = logisticsItem?.shippingEstimate
+          ? getLocalizedEstimates(logisticsItem?.shippingEstimate) // e.g. transform 3bd into Up to 3 business days
+          : ''
+
+        const shippingEstimateDate = logisticsItem?.shippingEstimateDate || '' // 2023-10-02T00:00:00Z
+        const addressId = logisticsItem?.addressId || '' // 5230338247839
+
+        const itemIndex = logisticsItem?.itemIndex ?? 0
+        const item = items?.[itemIndex]
+        const seller = item?.seller || ''
+
+        const groupKey = `${selectedSla}|${deliveryChannel}|${deliveryCompany}|${seller}|${shippingEstimate}|${shippingEstimateDate}|${addressId}|${deliveryWindow?.startDateUtc}|${deliveryWindow?.endDateUtc}`
+
+        const address = addresses?.find(
+          (address) => address?.addressId === addressId
+        )
+
+        const friendlyDeliveryOptionName =
+          `${deliveryChannelsMapping[deliveryChannel as keyof typeof deliveryChannelsMapping] || ''} ${friendlyShippingEstimate} ${address?.neighborhood ? `to ${address?.neighborhood}` : ''}`.trim()
+
+        // TODO check other totals like bundleItems etc
+        const itemTotal =
+          (item?.sellingPrice ?? 0) * (item?.quantity ?? 0) + (item?.tax ?? 0)
+
+        if (!acc[groupKey]) {
+          acc[groupKey] = {
+            // static fields
+            selectedSla,
+            deliveryChannel,
+            deliveryCompany,
+            deliveryWindow,
+            shippingEstimate,
+            shippingEstimateDate,
+            seller,
+            friendlyShippingEstimate,
+            friendlyDeliveryOptionName,
+            address,
+            pickupStoreInfo,
+            // dynamic fields
+            quantityOfDifferentItems: 0,
+            total: 0,
+            items: [],
+          }
+        }
+
+        if (acc[groupKey]) {
+          acc[groupKey].items?.push({
+            id: item?.id || '',
+            name: item?.name || '',
+            quantity: item?.quantity || 0,
+            price: item?.price || 0,
+            imageUrl: item?.imageUrl || '',
+            tax: item?.tax || 0,
+            total: itemTotal,
+          })
+
+          acc[groupKey].quantityOfDifferentItems =
+            (acc[groupKey].quantityOfDifferentItems ?? 0) + 1
+          acc[groupKey].total = (acc[groupKey].total ?? 0) + itemTotal
+        }
+
+        return acc
+      },
+      {} as Record<string, UserOrderDeliveryOption>
+    )
+
+    const deliveryOptions = Object.values(groupedDeliveryOptions)
+
+    const contactInformation = shippingData?.contactInformation?.[0]
+    const contact = {
+      name:
+        `${contactInformation?.firstName ?? ''} ${contactInformation?.lastName ?? ''}`.trim() ||
+        deliveryOptions?.[0]?.address?.receiverName ||
+        '',
+      email: contactInformation?.email || '',
+      phone: contactInformation?.phone || '',
+    }
+
+    return {
+      deliveryOptions,
+      contact,
+    }
+  },
+  customFields: (root) => {
+    const customFields = root?.customData?.customFields || []
+    return Object.values(
+      customFields.reduce(
+        (
+          acc: Record<
+            string,
+            { type: string; id: string; fields: UserOrderCustomField['fields'] }
+          >,
+          entry: Maybe<UserOrderCustomField>
+        ) => {
+          const type = entry?.linkedEntity?.type || ''
+          const id = entry?.linkedEntity?.id || ''
+          const key = `${type}|${id || ''}`
+          if (!acc[key]) {
+            acc[key] = { type, id, fields: [] }
+          }
+          acc[key].fields.push(...(entry?.fields || []))
+          return acc
+        },
+        {}
+      )
+    )
+    // Example of custom fields
+    //   return [
+    //     {
+    //       type: 'item',
+    //       id: '9009169',
+    //       fields: [
+    //         {
+    //           name: 'costCenter',
+    //           value: 'CC1',
+    //           refId: 'externalId',
+    //         },
+    //       ],
+    //     },
+    //     {
+    //       type: 'item',
+    //       id: 'ECEAC03EBA2B4BBFA7E899CD4CA5121B',
+    //       fields: [
+    //         {
+    //           name: 'costCenter',
+    //           value: 'CC2',
+    //           refId: 'externalId',
+    //         },
+    //       ],
+    //     },
+    //     {
+    //       type: 'address',
+    //       id: 'work-A1',
+    //       fields: [
+    //         {
+    //           name: 'desktop',
+    //           value: 'A1',
+    //           refId: 'externalId',
+    //         },
+    //       ],
+    //     },
+    //     {
+    //       type: 'order',
+    //       id: '',
+    //       fields: [
+    //         {
+    //           name: 'poNumber',
+    //           value: '111222333',
+    //           refId: 'externalId',
+    //         },
+    //         {
+    //           name: 'release',
+    //           value: '123',
+    //           refId: 'externalId',
+    //         },
+    //       ],
+    //     },
+    //   ]
+  },
+}

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

@@ -1,29 +1,83 @@
 import deepEquals from 'fast-deep-equal'
 
-import ChannelMarshal from '../utils/channel'
+import { parse } from 'cookie'
 import type { Context } from '..'
 import type {
   MutationValidateSessionArgs,
   StoreMarketingData,
   StoreSession,
 } from '../../../__generated__/schema'
+import ChannelMarshal from '../utils/channel'
+import { parseJwt } from '../utils/cookies'
+
+async function getPreciseLocationData(
+  clients: Context['clients'],
+  country: string,
+  postalCode: string
+) {
+  try {
+    const address = await clients.commerce.checkout.address({
+      postalCode,
+      country,
+    })
+
+    const [longitude, latitude] = address.geoCoordinates
+    return { city: address.city, geoCoordinates: { latitude, longitude } }
+  } catch (err) {
+    console.error(
+      `Error while getting geo coordinates for the current postal code (${postalCode}) and country (${country}).\n`
+    )
+
+    throw err
+  }
+}
 
 export const validateSession = async (
   _: any,
   { session: oldSession, search }: MutationValidateSessionArgs,
-  { clients }: Context
+  { clients, headers, account }: Context
 ): Promise<StoreSession | null> => {
   const channel = ChannelMarshal.parse(oldSession.channel ?? '')
   const postalCode = String(oldSession.postalCode ?? '')
-  const geoCoordinates = oldSession.geoCoordinates ?? null
-
   const country = oldSession.country ?? ''
+  let city = oldSession.city ?? null
+  let geoCoordinates = oldSession.geoCoordinates ?? null
 
+  // Update location data if postal code and country are provided
+  const shouldGetPreciseLocation = !city || !geoCoordinates
+  if (shouldGetPreciseLocation && postalCode !== '' && country !== '') {
+    const preciseLocation = await getPreciseLocationData(
+      clients,
+      country,
+      postalCode
+    )
+    city = preciseLocation.city
+    geoCoordinates = preciseLocation.geoCoordinates
+  }
+
+  /**
+   * The Session Manager API (https://developers.vtex.com/docs/api-reference/session-manager-api#patch-/api/sessions) adds the query params to the session public namespace.
+   * This is used by Checkout (checkout-session) and Intelligent Search (search-session)
+   */
   const params = new URLSearchParams(search)
   const salesChannel = params.get('sc') ?? channel.salesChannel
-
   params.set('sc', salesChannel)
 
+  if (!!postalCode) {
+    params.set('postalCode', postalCode)
+  }
+
+  if (!!country) {
+    params.set('country', country)
+  }
+
+  if (!!geoCoordinates) {
+    params.set(
+      'geoCoordinates',
+      `${geoCoordinates.latitude},${geoCoordinates.longitude}`
+    )
+  }
+
   const { marketingData: oldMarketingData } = oldSession
 
   const marketingData: StoreMarketingData = {
@@ -36,24 +90,56 @@ export const validateSession = async (
     utmiPart: params.get('utmi_pc') ?? oldMarketingData?.utmiPart ?? '',
   }
 
-  const [regionData, sessionData] = await Promise.all([
-    postalCode || geoCoordinates
-      ? clients.commerce.checkout.region({
-          postalCode,
-          geoCoordinates,
-          country,
-          salesChannel,
-        })
-      : Promise.resolve(null),
+  const authCookie = parse(headers?.cookie ?? '')?.[
+    'VtexIdclientAutCookie_' + account
+  ]
+  const jwt = parseJwt(authCookie)
+
+  const isRepresentative = jwt?.isRepresentative
+  const userId = jwt?.userId
+  const customerId = jwt?.customerId
+
+  const [sessionData, vtexid, unit, contract, user] = await Promise.all([
     clients.commerce.session(params.toString()).catch(() => null),
+
+    isRepresentative
+      ? clients.commerce.vtexid.validate().catch(() => null)
+      : Promise.resolve(null),
+
+    isRepresentative
+      ? clients.commerce.units.getUnitByUserId({ userId }).catch(() => null)
+      : Promise.resolve(null),
+
+    isRepresentative
+      ? clients.commerce.masterData
+          .getContractById({ contractId: customerId })
+          .catch(() => null)
+      : Promise.resolve(null),
+
+    isRepresentative
+      ? clients.commerce.licenseManager
+          .getUserById({ userId })
+          .catch(() => null)
+      : Promise.resolve(null),
   ])
 
   const profile = sessionData?.namespaces.profile ?? null
   const store = sessionData?.namespaces.store ?? null
   const authentication = sessionData?.namespaces.authentication ?? null
-  const region = regionData?.[0]
+  const checkout = sessionData?.namespaces.checkout ?? null
+
   // Set seller only if it's inside a region
-  const seller = region?.sellers.find((seller) => channel.seller === seller.id)
+  let seller
+  if (!!channel.seller && (postalCode || geoCoordinates)) {
+    const regionData = await clients.commerce.checkout.region({
+      postalCode,
+      geoCoordinates,
+      country,
+      salesChannel,
+    })
+    const region = regionData?.[0]
+    seller = region?.sellers.find((seller) => channel.seller === seller.id)
+  }
 
   const newSession = {
     ...oldSession,
@@ -64,13 +150,28 @@ export const validateSession = async (
     country: store?.countryCode?.value ?? oldSession.country,
     channel: ChannelMarshal.stringify({
       salesChannel: store?.channel?.value ?? channel.salesChannel,
-      regionId: region?.id ?? channel.regionId,
+      regionId: checkout?.regionId?.value ?? channel.regionId,
       seller: seller?.id,
       hasOnlyDefaultSalesChannel: !store?.channel?.value,
     }),
-    b2b: {
-      customerId: authentication?.customerId?.value ?? '',
-    },
+    b2b: isRepresentative
+      ? {
+          customerId:
+            authentication?.customerId?.value ??
+            vtexid?.customerId ??
+            customerId ??
+            '',
+          isRepresentative:
+            vtexid?.isRepresentative ?? isRepresentative ?? false,
+          unitName: unit?.name ?? vtexid?.unitName ?? '',
+          unitId: unit?.id ?? '',
+          isCorporate: contract?.isCorporate ?? false,
+          corporateName: contract?.corporateName ?? '',
+          firstName: contract?.firstName ?? '',
+          lastName: contract?.lastName ?? '',
+          userName: user?.name ?? '',
+        }
+      : null,
     marketingData,
     person: profile?.id
       ? {
@@ -80,6 +181,8 @@ export const validateSession = async (
           familyName: profile.lastName?.value ?? '',
         }
       : null,
+    geoCoordinates,
+    city,
   }
 
   if (deepEquals(oldSession, newSession)) {

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

@@ -1,3 +1,4 @@
+import { parse } from 'cookie'
 import type { Context } from '../index'
 
 export interface ContextForCookies {
@@ -96,6 +97,23 @@ export const getWithCookie = (ctx: ContextForCookies) =>
     }
   }
 
+export const getWithAutCookie = (ctx: ContextForCookies) => {
+  const withCookie = getWithCookie(ctx)
+
+  return function withAutCookie(forwardedHost: string, account: string) {
+    const headers: HeadersInit = withCookie({
+      'content-type': 'application/json',
+      'X-FORWARDED-HOST': forwardedHost,
+    })
+
+    const cookies = parse(ctx?.headers?.cookie ?? '')
+    const VtexIdclientAutCookie = cookies[`VtexIdclientAutCookie_${account}`]
+    headers['VtexIdclientAutCookie'] = VtexIdclientAutCookie
+
+    return headers
+  }
+}
+
 /**
  * This function updates the cookie value based on its key
  *
@@ -124,3 +142,10 @@ export const updatesCookieValueByKey = (
   // add new storage cookie to the original list of cookies
   return `${existingCookies};${storageCookieKey}=${storageCookieValue}`
 }
+
+export function parseJwt(token: string) {
+  if (!token) {
+    return null
+  }
+  return JSON.parse(Buffer.from(token.split('.')[1], 'base64').toString())
+}

package/src/typeDefs/mutation.graphql

@@ -11,4 +11,8 @@ type Mutation {
   Subscribes a new person to the newsletter list.
   """
   subscribeToNewsletter(data: IPersonNewsletter!): PersonNewsletter
+  """
+  Cancels user order
+  """
+  cancelOrder(data: IUserOrderCancel!): UserOrderCancel
 }

package/src/typeDefs/query.graphql

@@ -199,6 +199,13 @@ input IGeoCoordinates {
   longitude: Float!
 }
 
+type ProductCountResult {
+  """
+  Total product count.
+  """
+  total: Int!
+}
+
 type Query {
   """
   Returns the details of a product based on the specified locator.
@@ -349,6 +356,63 @@ type Query {
     id: String!
   ): Profile
     @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
+
+  """
+  Returns the total product count information based on a specific location accessible through the VTEX segment cookie.
+  """
+  productCount(
+    """
+    Search term.
+    """
+    term: String
+  ): ProductCountResult
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
+
+  """
+  Returns information about the Details of an User Order.
+  """
+  userOrder(
+    """
+    Identifier for the order.
+    """
+    orderId: String!
+  ): UserOrder
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
+
+  """
+  Returns information about the list of Orders that the User can view.
+  """
+  listUserOrders(
+    """
+    Page number of the list of orders.
+    """
+    page: Int
+    """
+    Quantity of items per page of the list of orders.
+    """
+    perPage: Int
+    """
+    Status of the list of orders.
+    """
+    status: [String]
+    """
+    Initial date of the list of orders.
+    """
+    dateInitial: String
+    """
+    Final date of the list of orders.
+    """
+    dateFinal: String
+    """
+    Text used to full text filter of the list of orders.
+    """
+    text: String
+    """
+    Client email used to filter of the list of orders.
+    """
+    clientEmail: String
+  ): UserOrderListResult
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
 }
 
 """

package/src/typeDefs/session.graphql

@@ -159,6 +159,10 @@ type StoreSession {
   """
   addressType: String
   """
+  Session city.
+  """
+  city: String
+  """
   Session postal code.
   """
   postalCode: String
@@ -182,10 +186,26 @@ type StoreSession {
 
 type StoreB2B {
   customerId: String!
+  isRepresentative: Boolean
+  unitName: String
+  unitId: String
+  isCorporate: Boolean
+  corporateName: String
+  firstName: String
+  lastName: String
+  userName: String
 }
 
 input IStoreB2B {
   customerId: String!
+  isRepresentative: Boolean
+  unitName: String
+  unitId: String
+  isCorporate: Boolean
+  corporateName: String
+  firstName: String
+  lastName: String
+  userName: String
 }
 
 """
@@ -217,6 +237,10 @@ input IStoreSession {
   """
   addressType: String
   """
+  Session input city.
+  """
+  city: String
+  """
   Session input postal code.
   """
   postalCode: String