@faststore/api 1.12.20 → 1.12.29

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

@@ -0,0 +1,64 @@
+import type { Resolver } from '..'
+
+type Unit = 'bd' | 'd' | 'h' | 'm'
+const units = ['bd', 'd', 'h', 'm'] as const
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const isUnit = (x: any): x is Unit => units.includes(x)
+
+const localizedEstimates: Record<string, Record<string, string>> = {
+  bd: {
+    0: 'Today',
+    1: 'In 1 business day',
+    other: `Up to # business days`,
+  },
+  d: {
+    0: 'Today',
+    1: 'In 1 day',
+    other: 'Up to # days',
+  },
+  h: {
+    0: 'Now',
+    1: 'In 1 hour',
+    other: 'Up to # hours',
+  },
+  m: {
+    0: 'Now',
+    1: 'In 1 minute',
+    other: 'Up to # minutes',
+  },
+}
+
+/**
+ * Transforms estimate (e.g 3bd) into friendly format (e.g Up to 3 business days)
+ * based on https://github.com/vtex-apps/shipping-estimate-translator/blob/13e17055d6353dd3f3f4c31bae77ab049002809b/messages/en.json
+ */
+
+export const getLocalizedEstimates = (estimate: string): string => {
+  const [amount, unit] = [estimate.split(/\D+/)[0], estimate.split(/[0-9]+/)[1]]
+
+  const isAmountNumber = amount !== '' && !Number.isNaN(Number(amount))
+  const isUnitValid = isUnit(unit)
+
+  if (!isAmountNumber || !isUnitValid) {
+    return ''
+  }
+
+  const amountKey = Number(amount) < 2 ? Number(amount) : 'other'
+
+  return localizedEstimates[unit][amountKey].replace('#', amount) ?? ''
+}
+
+type Root = {
+  name?: string
+  friendlyName?: string
+  price?: number
+  shippingEstimate?: string
+}
+
+export const ShippingSLA: Record<string, Resolver<Root>> = {
+  carrier: (root) => root?.friendlyName ?? root?.name ?? '',
+  price: (root) => (root?.price ? root.price / 100 : root?.price),
+  localizedEstimates: (root) =>
+    root?.shippingEstimate ? getLocalizedEstimates(root.shippingEstimate) : '',
+}

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

@@ -17,12 +17,13 @@ export const validateSession = async (
   const country = oldSession.country ?? ''
 
   const params = new URLSearchParams(search)
+  const salesChannel = params.get('sc') ?? channel.salesChannel
 
-  params.set('sc', params.get('sc') ?? channel.salesChannel)
+  params.set('sc', salesChannel)
 
   const [regionData, sessionData] = await Promise.all([
     postalCode
-      ? clients.commerce.checkout.region({ postalCode, country })
+      ? clients.commerce.checkout.region({ postalCode, country, salesChannel })
       : Promise.resolve(null),
     clients.commerce.session(params.toString()).catch(() => null),
   ])

package/src/typeDefs/address.graphql

@@ -0,0 +1,45 @@
+"""
+Address information.
+"""
+type Address {
+  """
+  Address postal code
+  """
+  postalCode: String
+  """
+  Address city
+  """
+  city: String
+  """
+  Address state
+  """
+  state: String
+  """
+  Address country
+  """
+  country: String
+  """
+  Address street
+  """
+  street: String
+  """
+  Address number
+  """
+  number: String
+  """
+  Address neighborhood
+  """
+  neighborhood: String
+  """
+  Address complement
+  """
+  complement: String
+  """
+  Address reference
+  """
+  reference: String
+  """
+  Address geoCoordinates
+  """
+  geoCoordinates: [Float]
+}

package/src/typeDefs/index.ts

@@ -1,35 +1,38 @@
 import { print } from 'graphql'
 
+import Address from './address.graphql'
 import AggregateOffer from './aggregateOffer.graphql'
 import AggregateRating from './aggregateRating.graphql'
 import Author from './author.graphql'
 import Brand from './brand.graphql'
 import Breadcrumb from './breadcrumb.graphql'
+import Cart from './cart.graphql'
 import Collection from './collection.graphql'
 import Facet from './facet.graphql'
 import Image from './image.graphql'
 import Mutation from './mutation.graphql'
+import Newsletter from './newsletter.graphql'
+import ObjectOrString from './objectOrString.graphql'
 import Offer from './offer.graphql'
 import Order from './order.graphql'
 import Organization from './organization.graphql'
 import PageInfo from './pageInfo.graphql'
+import Person from './person.graphql'
 import Product from './product.graphql'
 import ProductGroup from './productGroup.graphql'
+import PropertyValue from './propertyValue.graphql'
 import Query from './query.graphql'
 import Review from './review.graphql'
 import Seo from './seo.graphql'
-import Cart from './cart.graphql'
-import Status from './status.graphql'
-import PropertyValue from './propertyValue.graphql'
-import Person from './person.graphql'
-import ObjectOrString from './objectOrString.graphql'
 import Session from './session.graphql'
-import Newsletter from './newsletter.graphql'
+import ShippingSimulation from './shipping.graphql'
 import SkuVariants from './skuVariants.graphql'
+import Status from './status.graphql'
 
 export const typeDefs = [
   Query,
   Mutation,
+  Address,
   Brand,
   Breadcrumb,
   Collection,
@@ -54,6 +57,7 @@ export const typeDefs = [
   Session,
   Newsletter,
   SkuVariants,
+  ShippingSimulation,
 ]
   .map(print)
   .join('\n')

package/src/typeDefs/query.graphql

@@ -245,4 +245,23 @@ type Query {
     after: String
   ): StoreCollectionConnection!
     @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
+
+  """
+  Returns information about shipping simulation.
+  """
+  shipping(
+    """
+    List of SKU products
+    """
+    items: [IShippingItem!]!
+    """
+    Postal code to freight calculator
+    """
+    postalCode: String!
+    """
+    Country of postal code
+    """
+    country: String!
+  ): ShippingData
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
 }

package/src/typeDefs/shipping.graphql

@@ -0,0 +1,304 @@
+"""
+Shipping Simulation item input.
+"""
+input IShippingItem {
+  """
+  ShippingItem ID / Sku.
+  """
+  id: String!
+  """
+  Number of items.
+  """
+  quantity: Int!
+  """
+  Seller responsible for the ShippingItem.
+  """
+  seller: String!
+}
+
+"""
+Shipping Simulation information.
+"""
+type ShippingData {
+  """
+  List of LogisticsItem.
+  """
+  items: [LogisticsItem]
+  """
+  List of LogisticsInfo.
+  """
+  logisticsInfo: [LogisticsInfo]
+  """
+  List of MessageInfo.
+  """
+  messages: [MessageInfo]
+  """
+  Address information.
+  """
+  address: Address
+}
+
+"""
+Shipping Simulation Logistic Item.
+"""
+type LogisticsItem {
+  """
+  LogisticsItem ID / Sku.
+  """
+  id: String
+  requestIndex: Int
+  """
+  Number of items.
+  """
+  quantity: Int
+  """
+  Seller responsible for the ShippingItem.
+  """
+  seller: String
+  """
+  List of Sellers.
+  """
+  sellerChain: [String]
+  """
+  LogisticsItem tax.
+  """
+  tax: Int
+  """
+  Next date in which price is scheduled to change. If there is no scheduled change, this will be set a year in the future from current time.
+  """
+  priceValidUntil: String
+  """
+  LogisticsItem price.
+  """
+  price: Int
+  """
+  LogisticsItem listPrice.
+  """
+  listPrice: Int
+  """
+  LogisticsItem rewardValue.
+  """
+  rewardValue: Int
+  """
+  LogisticsItem sellingPrice.
+  """
+  sellingPrice: Int
+  """
+  LogisticsItem measurementUnit.
+  """
+  measurementUnit: String
+  """
+  LogisticsItem unitMultiplier.
+  """
+  unitMultiplier: Int
+  """
+  LogisticsItem availability.
+  """
+  availability: String
+}
+
+type LogisticsInfo {
+  """
+  LogisticsInfo itemIndex.
+  """
+  itemIndex: String
+  """
+  LogisticsInfo selectedSla.
+  """
+  selectedSla: String
+  """
+  List of LogisticsInfo ShippingSLA.
+  """
+  slas: [ShippingSLA]
+}
+
+type ShippingSLA {
+  """
+  ShippingSLA id.
+  """
+  id: String
+  """
+  ShippingSLA name.
+  """
+  name: String
+  """
+  ShippingSLA price.
+  """
+  price: Float
+  """
+  ShippingSLA shipping estimate.
+  """
+  shippingEstimate: String
+  """
+  ShippingSLA localized shipping estimate.
+  Note: this will always return a localized string for locale `en-US`.
+  """
+  localizedEstimates: String
+  """
+  ShippingSLA shipping estimate date.
+  """
+  shippingEstimateDate: String
+  """
+  List of ShippingSLA delivery ids.
+  """
+  deliveryIds: [DeliveryIds]
+  """
+  ShippingSLA delivery channel.
+  """
+  deliveryChannel: String
+  """
+  ShippingSLA friendly name.
+  """
+  friendlyName: String
+  """
+  ShippingSLA carrier.
+  """
+  carrier: String
+  """
+  ShippingSLA pickup point id.
+  """
+  pickupPointId: String
+  """
+  ShippingSLA pickup store info.
+  """
+  pickupStoreInfo: PickupStoreInfo
+  """
+  ShippingSLA pickup distance.
+  """
+  pickupDistance: Float
+}
+
+type DeliveryIds {
+  """
+  DeliveryIds courier id
+  """
+  courierId: String
+  """
+  DeliveryIds warehouse id
+  """
+  warehouseId: String
+  """
+  DeliveryIds dock id
+  """
+  dockId: String
+  """
+  DeliveryIds courier name
+  """
+  courierName: String
+  """
+  DeliveryIds quantity
+  """
+  quantity: Int
+}
+
+type PickupStoreInfo {
+  """
+  PickupStoreInfo friendly name.
+  """
+  friendlyName: String
+  """
+  PickupStoreInfo address.
+  """
+  address: PickupAddress
+  """
+  PickupStoreInfo additional information.
+  """
+  additionalInfo: String
+  """
+  PickupStoreInfo dock id.
+  """
+  dockId: String
+  """
+  Information if the store has pickup enable.
+  """
+  isPickupStore: Boolean
+}
+
+type PickupAddress {
+  """
+  PickupAddress address type.
+  """
+  addressType: String
+  """
+  PickupAddress receiver name.
+  """
+  receiverName: String
+  """
+  PickupAddress address id.
+  """
+  addressId: String
+  """
+  PickupAddress postal code.
+  """
+  postalCode: String
+  """
+  PickupAddress city.
+  """
+  city: String
+  """
+  PickupAddress state.
+  """
+  state: String
+  """
+  PickupAddress country.
+  """
+  country: String
+  """
+  PickupAddress street.
+  """
+  street: String
+  """
+  PickupAddress number.
+  """
+  number: String
+  """
+  PickupAddress neighborhood.
+  """
+  neighborhood: String
+  """
+  PickupAddress complement.
+  """
+  complement: String
+  """
+  PickupAddress reference.
+  """
+  reference: String
+  """
+  PickupAddress geo coordinates.
+  """
+  geoCoordinates: [Float]
+}
+
+type MessageInfo {
+  """
+  MessageInfo code.
+  """
+  code: String
+  """
+  MessageInfo text.
+  """
+  text: String
+  """
+  MessageInfo status.
+  """
+  status: String
+  """
+  MessageInfo fields.
+  """
+  fields: MessageFields
+}
+
+type MessageFields {
+  """
+  MessageFields item index.
+  """
+  itemIndex: String
+  """
+  MessageFields ean.
+  """
+  ean: String
+  """
+  MessageFields sku name.
+  """
+  skuName: String
+}