@faststore/api 4.10.1 → 4.10.2-dev.0

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

@@ -44,6 +44,7 @@ import {
   resolveActiveContractIdFromSession,
   resolveDefaultContractId,
 } from '../utils/contract'
+import { assertProductInContractAssortment } from '../utils/contractAssortment'
 import { mutateChannelContext, mutateLocaleContext } from '../utils/contex'
 import { getAuthCookie, parseJwt } from '../utils/cookies'
 import { enhanceSku, type EnhancedSku } from '../utils/enhanceSku'
@@ -59,6 +60,10 @@ import { getCatalogLocale, isLocalizationEnabled } from '../utils/localization'
 import { isValidSkuId, pickBestSku } from '../utils/sku'
 import { slugify } from '../utils/slugify'
 import { resolveSort } from '../utils/sort'
+import {
+  firstNonBlank,
+  resolveB2bUnitId,
+} from '../utils/validateSessionHelpers'
 import { FACET_CROSS_SELLING_MAP } from './../utils/facets'
 import { StoreCollection } from './collection'
 import { getOrderEntryOperation } from './getOrderEntryOperation'
@@ -202,25 +207,35 @@ export const Query = {
       loaders: { skuLoader },
     } = ctx
 
-    try {
-      const skuId = id ?? slug?.split('-').pop() ?? ''
+    const loadSku = async () => {
+      try {
+        const skuId = id ?? slug?.split('-').pop() ?? ''
 
-      if (!isValidSkuId(skuId)) {
-        throw new Error(INVALID_SKU_ID_ERROR)
-      }
+        if (!isValidSkuId(skuId)) {
+          throw new Error(INVALID_SKU_ID_ERROR)
+        }
 
-      const sku = await skuLoader.load(skuId)
+        const sku = await skuLoader.load(skuId)
 
-      await assertSkuMatchesSlug(ctx, sku, slug, locale)
+        await assertSkuMatchesSlug(ctx, sku, slug, locale)
 
-      return sku
-    } catch (err) {
-      if (!shouldFallbackToProductRoute(err)) {
-        throw err
-      }
+        return sku
+      } catch (err) {
+        if (!shouldFallbackToProductRoute(err)) {
+          throw err
+        }
 
-      return fetchProductBySlugFallback(ctx, slug)
+        return fetchProductBySlugFallback(ctx, slug)
+      }
     }
+
+    const sku = await loadSku()
+
+    // Runs outside `loadSku` so its NotFoundError is not swallowed by the
+    // slug fallback, which would refetch and return the same product.
+    assertProductInContractAssortment(ctx, sku)
+
+    return sku
   },
   collection: (
     _: unknown,
@@ -871,8 +886,8 @@ export const Query = {
       orgUnit: authentication?.unitName?.value ?? '',
     }
   },
-  // If isRepresentative, return b2b information.
-  // If not, return b2c user information
+  // Buyers with an organizational unit and a contract get the contract
+  // information. Everyone else gets the b2c user information.
   accountProfile: async (_: unknown, __: unknown, ctx: GraphqlContext) => {
     const {
       account,
@@ -886,7 +901,7 @@ export const Query = {
       return null
     }
 
-    if (jwt?.isRepresentative) {
+    if (resolveB2bUnitId(null, jwt.unitId)) {
       const sessionData = await commerce.session('').catch(() => null)
 
       if (!sessionData) {
@@ -897,13 +912,14 @@ export const Query = {
       const shopper = sessionData.namespaces.shopper ?? null
       const authentication = sessionData.namespaces.authentication ?? null
 
-      const contractId =
-        resolveActiveContractIdFromSession(sessionData) ||
-        jwt?.customerId?.trim() ||
-        ''
+      const contractId = firstNonBlank(
+        shopper?.activeContractId?.value,
+        authentication?.customerId?.value,
+        jwt.customerId
+      )
 
-      let contract = null
       if (contractId) {
+        let contract = null
         try {
           contract = await commerce.masterData.getContractById({ contractId })
         } catch (err) {
@@ -912,23 +928,21 @@ export const Query = {
             err
           )
         }
-      }
-
-      const shopperName =
-        `${(shopper?.firstName?.value ?? '').trim()} ${(shopper?.lastName?.value ?? '').trim()}`.trim()
-      const name =
-        resolveActiveContractDisplayName(contract, profile) || shopperName
 
-      return {
-        name: name || '',
-        email:
-          profile?.email?.value || authentication?.storeUserEmail?.value || '',
-        id:
-          profile?.id?.value ||
-          authentication?.customerId?.value ||
-          jwt?.customerId?.trim() ||
-          '',
-        // createdAt: '',
+        const shopperName =
+          `${(shopper?.firstName?.value ?? '').trim()} ${(shopper?.lastName?.value ?? '').trim()}`.trim()
+        const name =
+          resolveActiveContractDisplayName(contract, profile) || shopperName
+
+        return {
+          name: name || '',
+          email:
+            profile?.email?.value ||
+            authentication?.storeUserEmail?.value ||
+            '',
+          id: profile?.id?.value || contractId,
+          // createdAt: '',
+        }
       }
     }
 

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

@@ -3,12 +3,39 @@ import type {
   MutationSubscribeToNewsletterArgs,
   PersonNewsletter,
 } from '../../../__generated__/schema'
+import { BadRequestError } from '../../errors'
+
+const EMAIL_MAX_LENGTH = 254
+const NAME_MAX_LENGTH = 100
+// Character classes exclude `.`, so each domain label is matched once and the
+// pattern stays linear on long inputs.
+const EMAIL_PATTERN = /^[^\s@]+@[^\s@.]+(\.[^\s@.]+)+$/
 
 export const subscribeToNewsletter = async (
   _: any,
   { data }: MutationSubscribeToNewsletterArgs,
   { clients: { commerce } }: GraphqlContext
 ): Promise<PersonNewsletter | null> => {
-  const response = await commerce.subscribeToNewsletter(data)
+  // The subscription is written with a store credential, so only validated
+  // values reach Master Data. See "Create-only writes from anonymous visitors"
+  // in https://developers.vtex.com/docs/guides/faststore/api-extensions-authentication-in-api-extensions
+  const email = data.email?.trim().toLowerCase() ?? ''
+  const name = data.name?.trim() ?? ''
+
+  if (email.length > EMAIL_MAX_LENGTH || !EMAIL_PATTERN.test(email)) {
+    throw new BadRequestError('Invalid email')
+  }
+
+  if (name.length > NAME_MAX_LENGTH) {
+    throw new BadRequestError(
+      `Invalid name: must have at most ${NAME_MAX_LENGTH} characters`
+    )
+  }
+
+  const response = await commerce.subscribeToNewsletter({
+    email,
+    name: name || undefined,
+  })
+
   return { id: response?.Id }
 }

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

@@ -22,6 +22,7 @@ import {
   buildPersonFromProfile,
   buildSessionSearchParams,
   getPreciseLocationData,
+  resolveB2bUnitId,
   resolveJwtClaims,
   resolveSellerInRegion,
 } from '../utils/validateSessionHelpers'
@@ -187,7 +188,7 @@ export const validateSession = async (
     oldSession.locale
   )
   const marketingData = buildMarketingData(params, oldSession.marketingData)
-  const { isRepresentative, customerId, unitId } = await resolveJwtClaims(
+  const { customerId, unitId } = await resolveJwtClaims(
     clients,
     headers?.cookie,
     account
@@ -211,7 +212,7 @@ export const validateSession = async (
   const publicData = sessionData?.namespaces.public ?? null
 
   let contract = null
-  if (isRepresentative && profile?.id?.value) {
+  if (resolveB2bUnitId(authentication, unitId) && profile?.id?.value) {
     try {
       contract = await clients.commerce.masterData.getContractById({
         contractId: profile.id.value,
@@ -262,7 +263,6 @@ export const validateSession = async (
      * - Contract data: `profile` namespace (those info will be available inside Faststore's Session `person` object)
      */
     b2b: buildB2bSession({
-      isRepresentative,
       authentication,
       shopper,
       publicData,

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

@@ -191,6 +191,9 @@ type StoreSession {
 type StoreB2B {
   customerId: String!
   isRepresentative: Boolean
+    @deprecated(
+      reason: "Always true when `b2b` is set: a B2B session is identified by `unitId` and `customerId`. Check that `b2b` is not null instead. Scheduled for removal in the next major."
+    )
   unitName: String
   unitId: String
   firstName: String

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

@@ -0,0 +1,87 @@
+import { NotFoundError } from '../../errors'
+import type { ProductCluster } from '../clients/search/types/ProductSearchResult'
+import type { GraphqlContext } from '../index'
+import type { EnhancedSku } from './enhanceSku'
+import {
+  getSegmentExtraFacets,
+  parseSegmentCookie,
+} from './intelligentSearchRequest'
+
+const PRODUCT_CLUSTER_IDS_KEY = 'productClusterIds'
+const EXCLUDED_PREFIX = 'not:'
+
+export interface ProductClusterRestriction {
+  allowed: Set<string>
+  excluded: Set<string>
+}
+
+/**
+ * Collections the shopper's assortment is restricted to, as carried by the
+ * `vtex_segment` cookie (`productClusterIds=X` allows, `productClusterIds=not:Y`
+ * excludes). Returns `null` when the segment carries no restriction.
+ */
+export function getProductClusterRestriction(
+  segment: Record<string, unknown>
+): ProductClusterRestriction | null {
+  const allowed = new Set<string>()
+  const excluded = new Set<string>()
+
+  for (const { key, value } of getSegmentExtraFacets(segment)) {
+    if (key !== PRODUCT_CLUSTER_IDS_KEY) continue
+
+    for (const rawId of value.split(',')) {
+      const id = rawId.trim()
+
+      if (id.startsWith(EXCLUDED_PREFIX)) {
+        const excludedId = id.slice(EXCLUDED_PREFIX.length)
+        if (excludedId) excluded.add(excludedId)
+      } else if (id) {
+        allowed.add(id)
+      }
+    }
+  }
+
+  if (allowed.size === 0 && excluded.size === 0) {
+    return null
+  }
+
+  return { allowed, excluded }
+}
+
+export function isProductInAssortment(
+  productClusters: ProductCluster[] | undefined,
+  { allowed, excluded }: ProductClusterRestriction
+): boolean {
+  const clusterIds = (productClusters ?? []).map(({ id }) => String(id))
+
+  if (clusterIds.some((id) => excluded.has(id))) {
+    return false
+  }
+
+  return allowed.size === 0 || clusterIds.some((id) => allowed.has(id))
+}
+
+/**
+ * Listing endpoints get the assortment applied by Intelligent Search through
+ * the segment facets, but the `products` endpoint used to fetch a single
+ * product does not, so a product outside the shopper's assortment must be
+ * rejected here.
+ */
+export function assertProductInContractAssortment(
+  ctx: GraphqlContext,
+  sku: EnhancedSku
+): void {
+  const restriction = getProductClusterRestriction(
+    parseSegmentCookie(ctx.headers?.cookie)
+  )
+
+  if (!restriction) {
+    return
+  }
+
+  if (!isProductInAssortment(sku.isVariantOf.productClusters, restriction)) {
+    throw new NotFoundError(
+      `Product ${sku.isVariantOf.productId} is not in the shopper's assortment`
+    )
+  }
+}

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

@@ -225,6 +225,16 @@ function extractSegmentData(segment: Record<string, unknown>): {
   }
 }
 
+/**
+ * Non-shipping facets carried by the `vtex_segment` cookie (e.g. the B2B
+ * contract's `productClusterIds`), in the order they appear in the cookie.
+ */
+export function getSegmentExtraFacets(
+  segment: Record<string, unknown>
+): IntelligentSearchFacet[] {
+  return extractSegmentData(segment).extraFacets
+}
+
 function appendSegmentParams(
   params: URLSearchParams,
   segmentParams: SegmentParams

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

@@ -107,7 +107,6 @@ export async function resolveJwtClaims(
   }
 
   return {
-    isRepresentative: isValidJwt ? Boolean(jwt?.isRepresentative) : false,
     customerId: isValidJwt ? jwt?.customerId : undefined,
     unitId: isValidJwt ? jwt?.unitId : undefined,
   }
@@ -140,8 +139,43 @@ function shopperString(value: { value?: unknown } | null | undefined): string {
   return typeof value?.value === 'string' ? value.value : ''
 }
 
+/**
+ * First value that is a non-blank string, trimmed. Session values and JWT
+ * claims are only nominally typed, so anything else is skipped.
+ */
+export function firstNonBlank(...values: unknown[]): string {
+  for (const value of values) {
+    const trimmed = typeof value === 'string' ? value.trim() : ''
+    if (trimmed) return trimmed
+  }
+
+  return ''
+}
+
+/**
+ * Organizational unit of the shopper, from the session or the JWT claim.
+ * Buyer Portal identifies its buyers by the unit; `isRepresentative` alone is
+ * not enough, since it can be true outside B2B.
+ */
+export function resolveB2bUnitId(
+  authentication: { unitId?: { value?: string | null } | null } | null,
+  jwtUnitId?: unknown
+): string {
+  return firstNonBlank(authentication?.unitId?.value, jwtUnitId)
+}
+
+/**
+ * Returns `null` unless the shopper has both an organizational unit and a
+ * contract, the rule Buyer Portal uses for a B2B session.
+ *
+ * The contract falls back from the session's active contract to the session's
+ * authentication namespace and then to the JWT claim. Blank values fall
+ * through, so an empty session value never hides the claim.
+ *
+ * The deprecated `isRepresentative` field stays `true` whenever `b2b` is
+ * returned, so consumers that still read it keep working.
+ */
 export function buildB2bSession(args: {
-  isRepresentative: boolean
   authentication: {
     customerId?: { value?: string | null } | null
     unitName?: { value?: string | null } | null
@@ -152,6 +186,7 @@ export function buildB2bSession(args: {
     firstName?: { value?: unknown } | null
     lastName?: { value?: unknown } | null
     organizationManager?: { value?: boolean | null } | null
+    activeContractId?: { value?: string | null } | null
   } | null
   publicData: { postalCode?: { value?: string | null } | null } | null
   profile: Parameters<typeof resolveActiveContractDisplayName>[1]
@@ -159,7 +194,14 @@ export function buildB2bSession(args: {
   customerId?: string
   unitId?: string
 }) {
-  if (!args.isRepresentative) {
+  const unitId = resolveB2bUnitId(args.authentication, args.unitId)
+  const customerId = firstNonBlank(
+    args.shopper?.activeContractId?.value,
+    args.authentication?.customerId?.value,
+    args.customerId
+  )
+
+  if (!unitId || !customerId) {
     return null
   }
 
@@ -168,9 +210,9 @@ export function buildB2bSession(args: {
 
   return {
     isRepresentative: true,
-    customerId: args.authentication?.customerId?.value ?? args.customerId ?? '',
+    customerId,
     unitName: args.authentication?.unitName?.value ?? '',
-    unitId: args.authentication?.unitId?.value ?? args.unitId ?? '',
+    unitId,
     firstName,
     lastName,
     userName: `${firstName} ${lastName}`.trim(),