@faststore/api 3.66.0 → 3.68.1

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

@@ -14,6 +14,7 @@ import type {
   UserOrderListResult,
 } from '../../../..'
 import type { Context, Options } from '../../index'
+import { buildFormData } from '../../utils/buildFormData'
 import type { Channel } from '../../utils/channel'
 import {
   getStoreCookie,
@@ -26,6 +27,7 @@ import type { Brand } from './types/Brand'
 import type { CategoryTree } from './types/CategoryTree'
 import type { MasterDataResponse } from './types/Newsletter'
 import type { OrderForm, OrderFormInputItem } from './types/OrderForm'
+import type { PickupPoints, PickupPointsInput } from './types/PickupPoints'
 import type { PortalPagetype } from './types/Portal'
 import type { PortalProduct } from './types/Product'
 import type { Region, RegionInput } from './types/Region'
@@ -39,7 +41,6 @@ import type {
 } from './types/Simulation'
 import type { ScopesByUnit, UnitResponse } from './types/Unit'
 import type { VtexIdResponse } from './types/VtexId'
-import { buildFormData } from '../../utils/buildFormData'
 
 type ValueOf<T> = T extends Record<string, infer K> ? K : never
 
@@ -393,13 +394,37 @@ export const VtexCommerce = (
           {}
         )
       },
+      pickupPoints: ({
+        geoCoordinates,
+      }: PickupPointsInput): Promise<PickupPoints> => {
+        if (!geoCoordinates) {
+          throw new Error(
+            'Missing required parameter for listing pickup points.'
+          )
+        }
+
+        const headers: HeadersInit = withCookie({
+          'content-type': 'application/json',
+          'X-FORWARDED-HOST': forwardedHost,
+        })
+
+        return fetchAPI(
+          `${base}/api/logistics-shipping/pickuppoints/_search`,
+          {
+            method: 'POST',
+            headers,
+            body: JSON.stringify({ coordinate: geoCoordinates }),
+          },
+          { storeCookies }
+        )
+      },
     },
     session: (search: string): Promise<Session> => {
       const params = new URLSearchParams(search)
 
       params.set(
         'items',
-        'profile.id,profile.email,profile.firstName,profile.lastName,shopper.firstName,store.channel,store.countryCode,store.cultureInfo,store.currencyCode,store.currencySymbol,authentication.customerId,authentication.storeUserId,authentication.storeUserEmail,authentication.unitId,authentication.unitName,checkout.regionId,public.postalCode'
+        'profile.id,profile.email,profile.firstName,profile.lastName,shopper.firstName,shopper.lastName,store.channel,store.countryCode,store.cultureInfo,store.currencyCode,store.currencySymbol,authentication.customerId,authentication.storeUserId,authentication.storeUserEmail,authentication.unitId,authentication.unitName,checkout.regionId,public.postalCode'
       )
 
       const headers: HeadersInit = withCookie({

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

@@ -0,0 +1,40 @@
+interface GeoCoordinates {
+  latitude: number
+  longitude: number
+}
+
+export interface PickupPointsInput {
+  country?: string | null
+  geoCoordinates?: GeoCoordinates | null
+  postalCode?: string | null
+}
+
+interface Address {
+  city: string
+  geoCoordinates: [number, number] // [longitude, latitude]
+  neighborhood: string
+  number: string
+  postalCode: string
+  street: string
+  state: string
+}
+
+interface BusinessHour {
+  dayOfWeek: number
+  openingTime: string
+  closingTime: string
+}
+
+interface PickupPointDistance {
+  pickupId: string
+  distance: number
+  pickupName: string
+  isActive: boolean
+  address: Address
+  businessHours: BusinessHour[]
+}
+
+export interface PickupPoints {
+  pickupPointDistances: PickupPointDistance[]
+  pickupPointsHash: string
+}

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

@@ -41,6 +41,7 @@ export interface Profile {
 
 export interface Shopper {
   firstName?: Value
+  lastName?: Value
 }
 
 export interface Checkout {

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

@@ -52,12 +52,16 @@ const POLICY_KEY = 'trade-policy'
 const REGION_KEY = 'region-id'
 const FUZZY_KEY = 'fuzzy'
 const OPERATOR_KEY = 'operator'
+const PICKUP_POINT_KEY = 'pickupPoint'
+const SHIPPING_KEY = 'shipping'
 
 const EXTRA_FACETS_KEYS = new Set([
   POLICY_KEY,
   REGION_KEY,
   FUZZY_KEY,
   OPERATOR_KEY,
+  PICKUP_POINT_KEY,
+  SHIPPING_KEY,
 ])
 
 export const isFacetBoolean = (
@@ -142,12 +146,22 @@ export const IntelligentSearch = (
       ({ key }) => !EXTRA_FACETS_KEYS.has(key)
     )
 
+    const shippingFacet =
+      facets.find(
+        ({ key, value }) =>
+          key === SHIPPING_KEY && value !== 'all-delivery-methods'
+      ) ?? null
+
     const policyFacet =
       facets.find(({ key }) => key === POLICY_KEY) ?? getPolicyFacet()
 
     const regionFacet =
       facets.find(({ key }) => key === REGION_KEY) ?? getRegionFacet()
 
+    if (shippingFacet !== null) {
+      withDefaultFacets.push(shippingFacet)
+    }
+
     if (policyFacet !== null) {
       withDefaultFacets.push(policyFacet)
     }
@@ -165,6 +179,8 @@ export const IntelligentSearch = (
   ) => {
     const fuzzyFacet = facets.find(({ key }) => key === FUZZY_KEY) ?? null
     const operatorFacet = facets.find(({ key }) => key === OPERATOR_KEY) ?? null
+    const pickupPointFacet =
+      facets.find(({ key }) => key === PICKUP_POINT_KEY) ?? null
 
     if (fuzzyFacet && isFuzzyFacet(fuzzyFacet)) {
       params.append(FUZZY_KEY, fuzzyFacet.value)
@@ -173,6 +189,10 @@ export const IntelligentSearch = (
     if (operatorFacet && isOperatorFacet(operatorFacet)) {
       params.append(OPERATOR_KEY, operatorFacet.value)
     }
+
+    if (pickupPointFacet) {
+      params.append(PICKUP_POINT_KEY, pickupPointFacet.value)
+    }
   }
 
   const search = <T>({

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

@@ -1,11 +1,11 @@
-import { parseRange } from '../utils/facets'
-import { min } from '../utils/orderStatistics'
+import type { Resolver } from '..'
 import type {
-  FacetValueBoolean,
   Facet,
+  FacetValueBoolean,
   FacetValueRange,
 } from '../clients/search/types/FacetSearchResult'
-import type { Resolver } from '..'
+import { parseRange } from '../utils/facets'
+import { min } from '../utils/orderStatistics'
 
 export type Root = Facet
 

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

@@ -4,6 +4,7 @@ import type {
   QueryAllProductsArgs,
   QueryCollectionArgs,
   QueryListUserOrdersArgs,
+  QueryPickupPointsArgs,
   QueryProductArgs,
   QueryProductCountArgs,
   QueryProfileArgs,
@@ -19,6 +20,7 @@ import type { CategoryTree } from '../clients/commerce/types/CategoryTree'
 import type { ProfileAddress } from '../clients/commerce/types/Profile'
 import type { SearchArgs } from '../clients/search'
 import type { Context } from '../index'
+import { extractRuleForAuthorization } from '../utils/commercialAuth'
 import { mutateChannelContext, mutateLocaleContext } from '../utils/contex'
 import { getAuthCookie, parseJwt } from '../utils/cookies'
 import { enhanceSku } from '../utils/enhanceSku'
@@ -33,7 +35,6 @@ import {
 import { isValidSkuId, pickBestSku } from '../utils/sku'
 import { SORT_MAP } from '../utils/sort'
 import { FACET_CROSS_SELLING_MAP } from './../utils/facets'
-import { extractRuleForAuthorization } from '../utils/commercialAuth'
 import { StoreCollection } from './collection'
 
 export const Query = {
@@ -601,4 +602,19 @@ export const Query = {
       // createdAt: '',
     }
   },
+  pickupPoints: async (
+    _: unknown,
+    { geoCoordinates }: QueryPickupPointsArgs,
+    ctx: Context
+  ) => {
+    const {
+      clients: { commerce },
+    } = ctx
+
+    const result = await commerce.checkout.pickupPoints({
+      geoCoordinates,
+    })
+
+    return result
+  },
 }

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

@@ -132,15 +132,22 @@ export const validateSession = async (
       seller: seller?.id,
       hasOnlyDefaultSalesChannel: !store?.channel?.value,
     }),
+    /**
+     * 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 ?? '', //contract
-          unitName: authentication?.unitName?.value ?? '', // organization name
-          unitId: authentication?.unitId?.value ?? unitId ?? '', // organization id
-          firstName: profile?.firstName?.value ?? '', // contract name for b2b
-          lastName: profile?.lastName?.value ?? '',
-          userName: shopper?.firstName?.value ?? '', // shopper
+          customerId: authentication?.customerId?.value ?? customerId ?? '',
+          unitName: authentication?.unitName?.value ?? '',
+          unitId: authentication?.unitId?.value ?? unitId ?? '',
+          firstName: shopper?.firstName?.value ?? '',
+          lastName: shopper?.lastName?.value ?? '',
+          userName:
+            `${shopper?.firstName?.value ?? ''} ${shopper?.lastName?.value ?? ''}`.trim(),
           userEmail: authentication?.storeUserEmail.value ?? '',
           savedPostalCode: publicData?.postalCode?.value ?? '',
         }

package/src/typeDefs/pickupPoints.graphql

@@ -0,0 +1,79 @@
+type PickupPointAddress {
+  """
+  Address city.
+  """
+  city: String
+  """
+  Address neighborhood.
+  """
+  neighborhood: String
+  """
+  Address number.
+  """
+  number: String
+  """
+  Address postal code.
+  """
+  postalCode: String
+  """
+  Address street.
+  """
+  street: String
+  """
+  Address state.
+  """
+  state: String
+}
+
+type BusinessHour {
+  """
+  Number that represents the day of the week.
+  """
+  dayOfWeek: Int
+  """
+  Business hour opening time.
+  """
+  openingTime: String
+  """
+  Business hour closing time.
+  """
+  closingTime: String
+}
+
+type PickupPointDistance {
+  """
+  Pickup point ID.
+  """
+  pickupId: String
+  """
+  Pickup point distance.
+  """
+  distance: Float
+  """
+  Pickup point name.
+  """
+  pickupName: String
+  """
+  Whether the pickup point is active.
+  """
+  isActive: Boolean
+  """
+  Pickup point address.
+  """
+  address: PickupPointAddress
+  """
+  Pickup point business hours.
+  """
+  businessHours: [BusinessHour]
+}
+
+type PickupPoints {
+  """
+  List of pickup point distances for the given location.
+  """
+  pickupPointDistances: [PickupPointDistance]
+  """
+  Hash of the pickup points data.
+  """
+  pickupPointsHash: String
+}

package/src/typeDefs/query.graphql

@@ -437,6 +437,17 @@ type Query {
   """
   validateUser: ValidateUserData
     @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
+
+  """
+  Returns a list of pickup points near to the given geo coordinates.
+  """
+  pickupPoints(
+    """
+    Geo coordinates input.
+    """
+    geoCoordinates: IStoreGeoCoordinates
+  ): PickupPoints
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
 }
 
 type ValidateUserData {