@faststore/api 4.6.0-dev.0 → 4.6.0-dev.2

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

@@ -3,39 +3,29 @@ import deepEquals from 'fast-deep-equal'
 import type { GraphqlContext } from '..'
 import type {
   MutationValidateSessionArgs,
-  StoreMarketingData,
   StoreSession,
 } from '../../../__generated__/schema'
 import ChannelMarshal from '../utils/channel'
-import { resolveActiveContractDisplayName } from '../utils/contract'
-import { getAuthCookie, parseJwt } from '../utils/cookies'
-
-async function getPreciseLocationData(
-  clients: GraphqlContext['clients'],
-  country: string,
-  postalCode: string
-) {
-  try {
-    const address = await clients.commerce.checkout.address({
-      postalCode,
-      country,
-    })
-
-    const geoCoordinates = address.geoCoordinates
-      ? {
-          latitude: address.geoCoordinates[1],
-          longitude: address.geoCoordinates[0],
-        }
-      : null
-
-    return { city: address.city, geoCoordinates }
-  } catch (err) {
-    console.error(
-      `Error while getting geo coordinates for the current postal code (${postalCode}) and country (${country}).\n`
-    )
+import { channelAfterSessionManager } from '../utils/sessionChannel'
+import {
+  buildB2bSession,
+  buildMarketingData,
+  buildPersonFromProfile,
+  buildSessionSearchParams,
+  getPreciseLocationData,
+  resolveJwtClaims,
+  resolveSellerInRegion,
+} from '../utils/validateSessionHelpers'
+
+type SessionStoreNamespace = {
+  channel?: { value?: string | null } | null
+  currencyCode?: { value?: string | null } | null
+  currencySymbol?: { value?: string | null } | null
+  countryCode?: { value?: string | null } | null
+}
 
-    throw err
-  }
+type SessionCheckoutNamespace = {
+  regionId?: { value?: string | null } | null
 }
 
 export const validateSession = async (
@@ -49,7 +39,6 @@ export const validateSession = async (
   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(
@@ -65,64 +54,20 @@ export const validateSession = async (
    * 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)
-
-  // Remove facets parameter if it exists so that it does not interfere with session data and prioritize vtex_segment
-  if (params.has('facets')) {
-    params.delete('facets')
-  }
-
-  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.longitude},${geoCoordinates.latitude}` // long,lat is the format expected
-    )
-  }
-
-  // Sending the locale to the session, the store-session app will update cultureInfo
-  params.set('locale', oldSession.locale)
-
-  const { marketingData: oldMarketingData } = oldSession
-
-  const marketingData: StoreMarketingData = {
-    utmCampaign:
-      params.get('utm_campaign') ?? oldMarketingData?.utmCampaign ?? '',
-    utmMedium: params.get('utm_medium') ?? oldMarketingData?.utmMedium ?? '',
-    utmSource: params.get('utm_source') ?? oldMarketingData?.utmSource ?? '',
-    utmiCampaign: params.get('utmi_cp') ?? oldMarketingData?.utmiCampaign ?? '',
-    utmiPage: params.get('utmi_p') ?? oldMarketingData?.utmiPage ?? '',
-    utmiPart: params.get('utmi_pc') ?? oldMarketingData?.utmiPart ?? '',
-  }
-
-  const jwt = parseJwt(getAuthCookie(headers?.cookie ?? '', account))
-
-  // Validate JWT token if it exists
-  let isValidJwt = false
-  if (jwt) {
-    try {
-      const vtexIdResponse = await clients.commerce.vtexid.validate()
-      isValidJwt = vtexIdResponse?.authStatus?.toLowerCase() === 'success'
-    } catch (error) {
-      console.warn('JWT validation failed:', error)
-      isValidJwt = false
-    }
-  }
-
-  // Only use JWT data if the token is valid
-  const isRepresentative = isValidJwt ? jwt?.isRepresentative : false
-  const customerId = isValidJwt ? jwt?.customerId : undefined
-  const unitId = isValidJwt ? jwt?.unitId : undefined
+  const params = buildSessionSearchParams(
+    search,
+    channel,
+    postalCode,
+    country,
+    geoCoordinates,
+    oldSession.locale
+  )
+  const marketingData = buildMarketingData(params, oldSession.marketingData)
+  const { isRepresentative, customerId, unitId } = await resolveJwtClaims(
+    clients,
+    headers?.cookie,
+    account
+  )
 
   const sessionData = await clients.commerce
     .session(params.toString())
@@ -130,37 +75,34 @@ export const validateSession = async (
 
   const profile = sessionData?.namespaces.profile ?? null
   const shopper = sessionData?.namespaces.shopper ?? null
-  const store = sessionData?.namespaces.store ?? null
+  const store = (sessionData?.namespaces.store ??
+    null) as SessionStoreNamespace | null
   const authentication = sessionData?.namespaces.authentication ?? null
-  const checkout = sessionData?.namespaces.checkout ?? null
+  const checkout = (sessionData?.namespaces.checkout ??
+    null) as SessionCheckoutNamespace | null
   const publicData = sessionData?.namespaces.public ?? null
 
-  // Fetch contract data for B2B representatives
   let contract = null
   if (isRepresentative && profile?.id?.value) {
     try {
       contract = await clients.commerce.masterData.getContractById({
         contractId: profile.id.value,
       })
-    } catch (err) {
+    } catch {
       console.error(
         `Error while getting contract data for profile ID (${profile.id.value}).\n`
       )
     }
   }
 
-  // Set seller only if it's inside a region
-  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 sellerId = await resolveSellerInRegion(
+    clients,
+    channel,
+    postalCode,
+    geoCoordinates,
+    country,
+    params.get('sc') ?? channel.salesChannel
+  )
 
   const newSession = {
     ...oldSession,
@@ -169,49 +111,30 @@ export const validateSession = async (
       symbol: store?.currencySymbol?.value ?? oldSession.currency.symbol,
     },
     country: store?.countryCode?.value ?? country,
-    channel: ChannelMarshal.stringify({
-      salesChannel: store?.channel?.value ?? channel.salesChannel,
-      regionId: checkout?.regionId?.value ?? channel.regionId,
-      seller: seller?.id,
-      hasOnlyDefaultSalesChannel: !store?.channel?.value,
-    }),
+    channel: channelAfterSessionManager(
+      channel,
+      store?.channel?.value,
+      checkout?.regionId?.value,
+      sellerId
+    ),
     /**
      * B2B data structure in Session:
      * - Logged user data (shopper): `shopper` namespace
      * - Unit data: `authentication` namespace
      * - Contract data: `profile` namespace (those info will be available inside Faststore's Session `person` object)
      */
-    b2b: isRepresentative
-      ? {
-          isRepresentative: isRepresentative ?? false,
-          customerId: authentication?.customerId?.value ?? customerId ?? '',
-          unitName: authentication?.unitName?.value ?? '',
-          unitId: authentication?.unitId?.value ?? unitId ?? '',
-          firstName:
-            typeof shopper?.firstName?.value === 'string'
-              ? shopper.firstName.value
-              : '',
-          lastName:
-            typeof shopper?.lastName?.value === 'string'
-              ? shopper.lastName.value
-              : '',
-          userName:
-            `${typeof shopper?.firstName?.value === 'string' ? shopper.firstName.value : ''} ${typeof shopper?.lastName?.value === 'string' ? shopper.lastName.value : ''}`.trim(),
-          userEmail: authentication?.storeUserEmail.value ?? '',
-          savedPostalCode: publicData?.postalCode?.value ?? '',
-          contractName: resolveActiveContractDisplayName(contract, profile),
-          organizationManager: shopper?.organizationManager?.value ?? false,
-        }
-      : null,
+    b2b: buildB2bSession({
+      isRepresentative,
+      authentication,
+      shopper,
+      publicData,
+      profile,
+      contract,
+      customerId,
+      unitId,
+    }),
     marketingData,
-    person: profile?.id
-      ? {
-          id: profile.id?.value ?? '',
-          email: profile.email?.value ?? '',
-          givenName: profile.firstName?.value ?? '',
-          familyName: profile.lastName?.value ?? '',
-        }
-      : null,
+    person: buildPersonFromProfile(profile),
     geoCoordinates:
       (geoCoordinates?.latitude &&
         geoCoordinates?.longitude &&

package/src/platforms/vtex/typeDefs/order.graphql

@@ -14,6 +14,12 @@ type StoreOrder {
   Indicates whether or not items with attachments should be split.
   """
   shouldSplitItem: Boolean
+  """
+  Sales channel of the underlying orderForm when FastStore adopted it because
+  the browser session was stale (e.g. after Quick Order). Clients should align
+  `session.channel` to this value. Null when no SC adoption happened.
+  """
+  salesChannel: String
 }
 
 """

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

@@ -0,0 +1,31 @@
+import type { Channel } from './channel'
+import ChannelMarshal from './channel'
+
+/**
+ * When session SC and orderForm SC diverge, keep Checkout on the orderForm
+ * trade policy. Used after external cart changes (stale etag / Quick Order) and
+ * on later validations while the browser session still lags.
+ *
+ * Forcing the session SC (refetch / item updates with `sc=session`) would drop
+ * items that exist only on the orderForm's sales channel.
+ */
+export function channelWhenSessionDivergesFromOrderForm(
+  currentChannel: Required<Channel>,
+  orderFormSalesChannel: string | null | undefined
+): string | null {
+  if (orderFormSalesChannel == null || orderFormSalesChannel === '') {
+    return null
+  }
+
+  if (
+    String(orderFormSalesChannel) === String(currentChannel.salesChannel ?? '')
+  ) {
+    return null
+  }
+
+  return ChannelMarshal.stringify({
+    ...currentChannel,
+    salesChannel: String(orderFormSalesChannel),
+    hasOnlyDefaultSalesChannel: false,
+  })
+}

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

@@ -0,0 +1,32 @@
+import type { Channel } from './channel'
+import ChannelMarshal from './channel'
+
+/**
+ * Builds the session `channel` string after Session Manager responds.
+ *
+ * When the client already pinned an explicit SC (e.g. adopted from the
+ * orderForm after Quick Order), keep it. Session Manager often still reports
+ * the default SC and would otherwise overwrite the adoption.
+ */
+export function channelAfterSessionManager(
+  channel: Required<Channel>,
+  storeChannelValue: string | null | undefined,
+  regionId: string | null | undefined,
+  sellerId: string | undefined
+): string {
+  const hasExplicitSalesChannel = channel.hasOnlyDefaultSalesChannel === false
+
+  const storeSalesChannel = storeChannelValue ?? undefined
+  const resolvedRegionId = regionId ?? channel.regionId
+
+  return ChannelMarshal.stringify({
+    salesChannel: hasExplicitSalesChannel
+      ? channel.salesChannel || storeSalesChannel
+      : (storeSalesChannel ?? channel.salesChannel),
+    regionId: resolvedRegionId ?? undefined,
+    seller: sellerId,
+    hasOnlyDefaultSalesChannel: hasExplicitSalesChannel
+      ? false
+      : !storeSalesChannel,
+  })
+}

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

@@ -0,0 +1,202 @@
+import type { GraphqlContext } from '..'
+import type {
+  StoreMarketingData,
+  StoreSession,
+} from '../../../__generated__/schema'
+import type { Channel } from './channel'
+import { resolveActiveContractDisplayName } from './contract'
+import { getAuthCookie, parseJwt } from './cookies'
+
+export async function getPreciseLocationData(
+  clients: GraphqlContext['clients'],
+  country: string,
+  postalCode: string
+) {
+  try {
+    const address = await clients.commerce.checkout.address({
+      postalCode,
+      country,
+    })
+
+    const geoCoordinates = address.geoCoordinates
+      ? {
+          latitude: address.geoCoordinates[1],
+          longitude: address.geoCoordinates[0],
+        }
+      : null
+
+    return { city: address.city, geoCoordinates }
+  } catch (err) {
+    console.error(
+      `Error while getting geo coordinates for the current postal code (${postalCode}) and country (${country}).\n`
+    )
+
+    throw err
+  }
+}
+
+export function buildSessionSearchParams(
+  search: string,
+  channel: Required<Channel>,
+  postalCode: string,
+  country: string,
+  geoCoordinates: StoreSession['geoCoordinates'],
+  locale: string
+) {
+  const params = new URLSearchParams(search)
+
+  // Remove facets so they do not interfere with session data / vtex_segment
+  if (params.has('facets')) {
+    params.delete('facets')
+  }
+
+  params.set('sc', params.get('sc') ?? channel.salesChannel)
+
+  if (postalCode) {
+    params.set('postalCode', postalCode)
+  }
+
+  if (country) {
+    params.set('country', country)
+  }
+
+  if (geoCoordinates) {
+    params.set(
+      'geoCoordinates',
+      `${geoCoordinates.longitude},${geoCoordinates.latitude}` // long,lat is the format expected
+    )
+  }
+
+  // Sending the locale to the session, the store-session app will update cultureInfo
+  params.set('locale', locale)
+
+  return params
+}
+
+export function buildMarketingData(
+  params: URLSearchParams,
+  oldMarketingData: StoreSession['marketingData']
+): StoreMarketingData {
+  return {
+    utmCampaign:
+      params.get('utm_campaign') ?? oldMarketingData?.utmCampaign ?? '',
+    utmMedium: params.get('utm_medium') ?? oldMarketingData?.utmMedium ?? '',
+    utmSource: params.get('utm_source') ?? oldMarketingData?.utmSource ?? '',
+    utmiCampaign: params.get('utmi_cp') ?? oldMarketingData?.utmiCampaign ?? '',
+    utmiPage: params.get('utmi_p') ?? oldMarketingData?.utmiPage ?? '',
+    utmiPart: params.get('utmi_pc') ?? oldMarketingData?.utmiPart ?? '',
+  }
+}
+
+export async function resolveJwtClaims(
+  clients: GraphqlContext['clients'],
+  cookie: string | undefined,
+  account: string
+) {
+  const jwt = parseJwt(getAuthCookie(cookie ?? '', account))
+  let isValidJwt = false
+
+  if (jwt) {
+    try {
+      const vtexIdResponse = await clients.commerce.vtexid.validate()
+      isValidJwt = vtexIdResponse?.authStatus?.toLowerCase() === 'success'
+    } catch (error) {
+      console.warn('JWT validation failed:', error)
+      isValidJwt = false
+    }
+  }
+
+  return {
+    isRepresentative: isValidJwt ? Boolean(jwt?.isRepresentative) : false,
+    customerId: isValidJwt ? jwt?.customerId : undefined,
+    unitId: isValidJwt ? jwt?.unitId : undefined,
+  }
+}
+
+export async function resolveSellerInRegion(
+  clients: GraphqlContext['clients'],
+  channel: Required<Channel>,
+  postalCode: string,
+  geoCoordinates: StoreSession['geoCoordinates'],
+  country: string,
+  salesChannel: string
+) {
+  if (!channel.seller || !(postalCode || geoCoordinates)) {
+    return undefined
+  }
+
+  const regionData = await clients.commerce.checkout.region({
+    postalCode,
+    geoCoordinates,
+    country,
+    salesChannel,
+  })
+  const region = regionData?.[0]
+
+  return region?.sellers.find((seller) => channel.seller === seller.id)?.id
+}
+
+function shopperString(value: { value?: unknown } | null | undefined): string {
+  return typeof value?.value === 'string' ? value.value : ''
+}
+
+export function buildB2bSession(args: {
+  isRepresentative: boolean
+  authentication: {
+    customerId?: { value?: string | null } | null
+    unitName?: { value?: string | null } | null
+    unitId?: { value?: string | null } | null
+    storeUserEmail?: { value?: string | null } | null
+  } | null
+  shopper: {
+    firstName?: { value?: unknown } | null
+    lastName?: { value?: unknown } | null
+    organizationManager?: { value?: boolean | null } | null
+  } | null
+  publicData: { postalCode?: { value?: string | null } | null } | null
+  profile: Parameters<typeof resolveActiveContractDisplayName>[1]
+  contract: Parameters<typeof resolveActiveContractDisplayName>[0]
+  customerId?: string
+  unitId?: string
+}) {
+  if (!args.isRepresentative) {
+    return null
+  }
+
+  const firstName = shopperString(args.shopper?.firstName)
+  const lastName = shopperString(args.shopper?.lastName)
+
+  return {
+    isRepresentative: true,
+    customerId: args.authentication?.customerId?.value ?? args.customerId ?? '',
+    unitName: args.authentication?.unitName?.value ?? '',
+    unitId: args.authentication?.unitId?.value ?? args.unitId ?? '',
+    firstName,
+    lastName,
+    userName: `${firstName} ${lastName}`.trim(),
+    userEmail: args.authentication?.storeUserEmail?.value ?? '',
+    savedPostalCode: args.publicData?.postalCode?.value ?? '',
+    contractName: resolveActiveContractDisplayName(args.contract, args.profile),
+    organizationManager: args.shopper?.organizationManager?.value ?? false,
+  }
+}
+
+export function buildPersonFromProfile(
+  profile: {
+    id?: { value?: string | null } | null
+    email?: { value?: string | null } | null
+    firstName?: { value?: string | null } | null
+    lastName?: { value?: string | null } | null
+  } | null
+) {
+  if (!profile?.id) {
+    return null
+  }
+
+  return {
+    id: profile.id?.value ?? '',
+    email: profile.email?.value ?? '',
+    givenName: profile.firstName?.value ?? '',
+    familyName: profile.lastName?.value ?? '',
+  }
+}