@faststore/api 2.2.0-alpha.1 → 2.2.0-alpha.12

package/dist/index.d.ts

@@ -124,7 +124,7 @@ export declare const getResolvers: (options: Options) => {
                     parentAssemblyBinding: import("./__generated__/schema").Maybe<string>;
                     productCategoryIds: string;
                     priceTags: string[];
-                    manualPrice: number;
+                    manualPrice: number | null;
                     measurementUnit: string;
                     additionalInfo: {
                         brandName: string;
@@ -139,7 +139,7 @@ export declare const getResolvers: (options: Options) => {
                     sellerChain: string[];
                     availability: string;
                     unitMultiplier: number;
-                    skuSpecifications: import("./platforms/vtex/clients/commerce/types/OrderForm").SKUSpecification[];
+                    skuSpecifications?: import("./platforms/vtex/clients/commerce/types/OrderForm").SKUSpecification[] | null | undefined;
                     priceDefinition: {
                         calculatedSellingPrice: number;
                         sellingPrices: import("./platforms/vtex/clients/commerce/types/OrderForm").SellingPrice[];

package/dist/platforms/vtex/clients/commerce/types/OrderForm.d.ts

@@ -31,7 +31,7 @@ export interface OrderFormItem {
     parentAssemblyBinding: string | null;
     productCategoryIds: string;
     priceTags: string[];
-    manualPrice: number;
+    manualPrice: number | null;
     measurementUnit: string;
     additionalInfo: {
         brandName: string;
@@ -46,7 +46,7 @@ export interface OrderFormItem {
     sellerChain: string[];
     availability: string;
     unitMultiplier: number;
-    skuSpecifications: SKUSpecification[];
+    skuSpecifications?: SKUSpecification[] | null;
     priceDefinition: {
         calculatedSellingPrice: number;
         sellingPrices: SellingPrice[];
@@ -127,7 +127,7 @@ export interface OrderForm {
             currencyGroupSize: number;
             startsWithCurrencySymbol: boolean;
         };
-        currencyLocale: string;
+        currencyLocale: number;
         currencySymbol: string;
         saveUserData: boolean;
         timeZone: string;
@@ -138,7 +138,7 @@ export interface OrderForm {
     customData: OrderFormCustomData | null;
     itemMetadata: {
         items: MetadataItem[];
-    };
+    } | null;
     hooksData: any | null;
     ratesAndBenefitsData: {
         rateAndBenefitsIdentifiers: any[];
@@ -217,21 +217,21 @@ export interface PaymentData {
     availableTokens: any[];
 }
 export interface ClientProfileData {
-    email: string;
-    firstName: string;
-    lastName: string;
-    document: string;
-    documentType: string;
-    phone: string;
-    corporateName: string;
-    tradeName: string;
-    corporateDocument: string;
-    stateInscription: string;
-    corporatePhone: string;
+    email: string | null;
+    firstName: string | null;
+    lastName: string | null;
+    document: string | null;
+    documentType: string | null;
+    phone: string | null;
+    corporateName: string | null;
+    tradeName: string | null;
+    corporateDocument: string | null;
+    stateInscription: string | null;
+    corporatePhone: string | null;
     isCorporate: boolean;
     profileCompleteOnLoading: boolean;
     profileErrorOnLoading: boolean;
-    customerClass: string;
+    customerClass: string | null;
 }
 export interface ShippingData {
     address: CheckoutAddress | null;
@@ -295,7 +295,7 @@ export interface AvailableDeliveryWindows {
     startDateUtc: string;
     endDateUtc: string;
     price: number;
-    listPrice: number;
+    lisPrice?: number;
     tax: number;
 }
 export interface DeliveryId {

package/dist/platforms/vtex/index.d.ts

@@ -152,7 +152,7 @@ export declare const getResolvers: (_: Options) => {
                     parentAssemblyBinding: string | null;
                     productCategoryIds: string;
                     priceTags: string[];
-                    manualPrice: number;
+                    manualPrice: number | null;
                     measurementUnit: string;
                     additionalInfo: {
                         brandName: string;
@@ -167,7 +167,7 @@ export declare const getResolvers: (_: Options) => {
                     sellerChain: string[];
                     availability: string;
                     unitMultiplier: number;
-                    skuSpecifications: import("./clients/commerce/types/OrderForm").SKUSpecification[];
+                    skuSpecifications?: import("./clients/commerce/types/OrderForm").SKUSpecification[] | null | undefined;
                     priceDefinition: {
                         calculatedSellingPrice: number;
                         sellingPrices: import("./clients/commerce/types/OrderForm").SellingPrice[];

package/dist/platforms/vtex/resolvers/mutation.d.ts

@@ -25,7 +25,7 @@ export declare const Mutation: {
                 parentAssemblyBinding: string | null;
                 productCategoryIds: string;
                 priceTags: string[];
-                manualPrice: number;
+                manualPrice: number | null;
                 measurementUnit: string;
                 additionalInfo: {
                     brandName: string;
@@ -40,7 +40,7 @@ export declare const Mutation: {
                 sellerChain: string[];
                 availability: string;
                 unitMultiplier: number;
-                skuSpecifications: import("../clients/commerce/types/OrderForm").SKUSpecification[];
+                skuSpecifications?: import("../clients/commerce/types/OrderForm").SKUSpecification[] | null | undefined;
                 priceDefinition: {
                     calculatedSellingPrice: number;
                     sellingPrices: import("../clients/commerce/types/OrderForm").SellingPrice[];

package/dist/platforms/vtex/resolvers/validateCart.d.ts

@@ -39,7 +39,7 @@ export declare const validateCart: (_: unknown, { cart: { order }, session }: Mu
             parentAssemblyBinding: string | null;
             productCategoryIds: string;
             priceTags: string[];
-            manualPrice: number;
+            manualPrice: number | null;
             measurementUnit: string;
             additionalInfo: {
                 brandName: string;
@@ -54,7 +54,7 @@ export declare const validateCart: (_: unknown, { cart: { order }, session }: Mu
             sellerChain: string[];
             availability: string;
             unitMultiplier: number;
-            skuSpecifications: import("../clients/commerce/types/OrderForm").SKUSpecification[];
+            skuSpecifications?: import("../clients/commerce/types/OrderForm").SKUSpecification[] | null | undefined;
             priceDefinition: {
                 calculatedSellingPrice: number;
                 sellingPrices: import("../clients/commerce/types/OrderForm").SellingPrice[];

package/dist/platforms/vtex/utils/sanitizeHtml.d.ts

@@ -0,0 +1,17 @@
+import sanitizeHtmlLib from 'sanitize-html';
+/**
+ * For now, we're using sanitize-html's default set
+ * of allowed tags and attributes, which don't even include img elements
+ *
+ * It is known many client depends on pontentially vulnerable tags, such as script tags
+ * We chose to be restrictive at first, and document those restrictions later.
+ *
+ * When expanding the set of allowed tags and attributes, please consider performance, privacy and security.
+ *
+ * This possibily breaks compatibility with Portal and Store Framework,
+ * which both allows an enormous amount of tags and attributes
+ *
+ * This was a thoughtful decision that can be reviewed in the future given
+ * research was made to back up those changes.
+ */
+export declare const sanitizeHtml: (dirty: Parameters<typeof sanitizeHtmlLib>[0], options?: Parameters<typeof sanitizeHtmlLib>[1]) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "2.2.0-alpha.1",
+  "version": "2.2.0-alpha.12",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -32,15 +32,17 @@
     "dataloader": "^2.1.0",
     "fast-deep-equal": "^3.1.3",
     "isomorphic-unfetch": "^3.1.0",
-    "p-limit": "^3.1.0"
+    "p-limit": "^3.1.0",
+    "sanitize-html": "^2.11.0"
   },
   "devDependencies": {
     "@envelop/core": "^2.6.0",
-    "@faststore/eslint-config": "^2.2.0-alpha.1",
-    "@faststore/shared": "^2.2.0-alpha.1",
+    "@faststore/eslint-config": "^2.2.0-alpha.12",
+    "@faststore/shared": "^2.2.0-alpha.12",
     "@graphql-codegen/cli": "2.2.0",
     "@graphql-codegen/typescript": "2.2.2",
     "@types/express": "^4.17.16",
+    "@types/sanitize-html": "^2.9.1",
     "concurrently": "^6.2.1",
     "eslint": "7.32.0",
     "express": "^4.17.3",
@@ -56,5 +58,5 @@
     "@envelop/core": "^1 || ^2",
     "graphql": "^15.6.0"
   },
-  "gitHead": "6eff908883fa54cb72d548b12a610490df833804"
+  "gitHead": "7f27647c52ad0690389e72db639562b167a09c49"
 }

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

@@ -121,7 +121,6 @@ export const VtexCommerce = (
           selectedAddresses: selectedAddresses,
           clearAddressIfPostalCodeNotFound: incrementAddress,
         }
-
         return fetchAPI(
           `${base}/api/checkout/pub/orderForm/${id}/attachments/shippingData`,
           {
@@ -149,10 +148,19 @@ export const VtexCommerce = (
           refreshOutdatedData: refreshOutdatedData.toString(),
           sc: salesChannel,
         })
+        const requestInit: RequestInit = ctx.headers
+          ? {
+              ...BASE_INIT,
+              headers: {
+                'content-type': 'application/json',
+                cookie: ctx.headers.cookie,
+              },
+            }
+          : BASE_INIT
 
         return fetchAPI(
           `${base}/api/checkout/pub/orderForm/${id}?${params.toString()}`,
-          BASE_INIT
+          requestInit
         )
       },
       updateOrderFormItems: ({
@@ -173,16 +181,31 @@ export const VtexCommerce = (
           sc: salesChannel,
         })
 
+        const items = JSON.stringify({
+          orderItems,
+          noSplitItem: !shouldSplitItem,
+        })
+
+        const requestInit: RequestInit = ctx.headers
+          ? {
+              headers: {
+                'content-type': 'application/json',
+                cookie: ctx.headers.cookie,
+              },
+              body: items,
+              method: 'PATCH',
+            }
+          : {
+              headers: {
+                'content-type': 'application/json',
+              },
+              body: items,
+              method: 'PATCH',
+            }
+
         return fetchAPI(
           `${base}/api/checkout/pub/orderForm/${id}/items?${params}`,
-          {
-            ...BASE_INIT,
-            body: JSON.stringify({
-              orderItems,
-              noSplitItem: !shouldSplitItem,
-            }),
-            method: 'PATCH',
-          }
+          requestInit
         )
       },
       setCustomData: ({

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

@@ -33,7 +33,7 @@ export interface OrderFormItem {
   parentAssemblyBinding: string | null
   productCategoryIds: string
   priceTags: string[]
-  manualPrice: number
+  manualPrice: number | null
   measurementUnit: string
   additionalInfo: {
     brandName: string
@@ -48,7 +48,7 @@ export interface OrderFormItem {
   sellerChain: string[]
   availability: string
   unitMultiplier: number
-  skuSpecifications: SKUSpecification[]
+  skuSpecifications?: SKUSpecification[] | null
   priceDefinition: {
     calculatedSellingPrice: number
     sellingPrices: SellingPrice[]
@@ -135,7 +135,7 @@ export interface OrderForm {
       currencyGroupSize: number
       startsWithCurrencySymbol: boolean
     }
-    currencyLocale: string
+    currencyLocale: number
     currencySymbol: string
     saveUserData: boolean
     timeZone: string
@@ -146,7 +146,7 @@ export interface OrderForm {
   customData: OrderFormCustomData | null
   itemMetadata: {
     items: MetadataItem[]
-  }
+  } | null
   hooksData: any | null
   ratesAndBenefitsData: {
     rateAndBenefitsIdentifiers: any[]
@@ -229,21 +229,21 @@ export interface PaymentData {
 }
 
 export interface ClientProfileData {
-  email: string
-  firstName: string
-  lastName: string
-  document: string
-  documentType: string
-  phone: string
-  corporateName: string
-  tradeName: string
-  corporateDocument: string
-  stateInscription: string
-  corporatePhone: string
+  email: string | null
+  firstName: string | null
+  lastName: string | null
+  document: string | null
+  documentType: string | null
+  phone: string | null
+  corporateName: string | null
+  tradeName: string | null
+  corporateDocument: string | null
+  stateInscription: string | null
+  corporatePhone: string | null
   isCorporate: boolean
   profileCompleteOnLoading: boolean
   profileErrorOnLoading: boolean
-  customerClass: string
+  customerClass: string | null
 }
 
 export interface ShippingData {
@@ -314,7 +314,7 @@ export interface AvailableDeliveryWindows {
   startDateUtc: string,
   endDateUtc: string,
   price: number,
-  listPrice: number,
+  lisPrice?: number,
   tax: number,
 }
 

package/src/platforms/vtex/index.ts

@@ -35,7 +35,7 @@ export interface Options {
   channel: string
   locale: string
   hideUnavailableItems: boolean
-  incrementAddress: boolean,
+  incrementAddress: boolean
   flags?: FeatureFlags
 }
 

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

@@ -372,7 +372,6 @@ export const validateCart = async (
   if (changes.length === 0) {
     return null
   }
-
   // Step4: Apply delta changes to order form
   const updatedOrderForm = await commerce.checkout
     // update orderForm items

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

@@ -1,8 +1,18 @@
 import type { Product, Item } from '../clients/search/types/ProductSearchResult'
+import { sanitizeHtml } from './sanitizeHtml'
 
 export type EnhancedSku = Item & { isVariantOf: Product }
 
+function sanitizeProduct(product: Product): Product {
+  return {
+    ...product,
+    description: product.description
+      ? sanitizeHtml(product.description)
+      : product.description,
+  }
+}
+
 export const enhanceSku = (item: Item, product: Product): EnhancedSku => ({
   ...item,
-  isVariantOf: product,
+  isVariantOf: sanitizeProduct(product),
 })

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

@@ -0,0 +1,21 @@
+import sanitizeHtmlLib from 'sanitize-html'
+
+/**
+ * For now, we're using sanitize-html's default set
+ * of allowed tags and attributes, which don't even include img elements
+ *
+ * It is known many client depends on pontentially vulnerable tags, such as script tags
+ * We chose to be restrictive at first, and document those restrictions later.
+ *
+ * When expanding the set of allowed tags and attributes, please consider performance, privacy and security.
+ *
+ * This possibily breaks compatibility with Portal and Store Framework,
+ * which both allows an enormous amount of tags and attributes
+ *
+ * This was a thoughtful decision that can be reviewed in the future given
+ * research was made to back up those changes.
+ */
+export const sanitizeHtml = (
+  dirty: Parameters<typeof sanitizeHtmlLib>[0],
+  options?: Parameters<typeof sanitizeHtmlLib>[1]
+) => sanitizeHtmlLib(dirty, options)

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

@@ -16,42 +16,23 @@ export const shouldUpdateShippingData = (
     return { updateShipping: false, addressChanged: false }
   }
 
-  const selectedAddress = orderForm.shippingData?.selectedAddresses[0]
-
-  if (checkPostalCode(selectedAddress, session.postalCode)) {
-    return { updateShipping: true, addressChanged: true }
+  if (!hasItems(orderForm)) {
+    return { updateShipping: false, addressChanged: false }
   }
 
+  const [selectedAddress] = orderForm?.shippingData?.selectedAddresses ?? []
   if (
-    checkGeoCoordinates(
-      selectedAddress,
-      session.geoCoordinates,
-      session.postalCode
-    )
+    checkPostalCode(selectedAddress, session.postalCode) ||
+    checkGeoCoordinates(selectedAddress, session.geoCoordinates) ||
+    checkAddressType(selectedAddress, session.addressType)
   ) {
     return { updateShipping: true, addressChanged: true }
   }
 
-  if (checkAddressType(selectedAddress, session.addressType)) {
-    return { updateShipping: true, addressChanged: true }
-  }
-
-  if (!hasItems(orderForm)) {
-    return { updateShipping: false, addressChanged: false }
-  }
-
   // The logisticsInfo will always exist if there´s at least one item inside the cart
   const { logisticsInfo } = orderForm.shippingData!
 
-  if (shouldUpdateDeliveryChannel(logisticsInfo, session)) {
-    return { updateShipping: true, addressChanged: false }
-  }
-
-  if (shouldUpdateDeliveryMethod(logisticsInfo, session)) {
-    return { updateShipping: true, addressChanged: false }
-  }
-
-  if (shouldUpdateDeliveryWindow(logisticsInfo, session)) {
+  if (shouldUpdateDeliveryInfo(logisticsInfo, session)) {
     return { updateShipping: true, addressChanged: false }
   }
   return { updateShipping: false, addressChanged: false }
@@ -61,15 +42,13 @@ export const shouldUpdateShippingData = (
 const hasSessionPostalCodeOrGeoCoordinates = (session: IStoreSession) => {
   return (
     !!session.postalCode ||
-    (session.geoCoordinates &&
-      session.geoCoordinates.latitude &&
-      session.geoCoordinates.longitude)
+    (session.geoCoordinates?.latitude && session.geoCoordinates?.longitude)
   )
 }
 
 // Validate if theres a difference between the session postal code and orderForm postal code
 const checkPostalCode = (
-  address: CheckoutAddress | null | undefined,
+  address: CheckoutAddress | null,
   postalCode: string | null | undefined
 ) => {
   return typeof postalCode === 'string' && address?.postalCode !== postalCode
@@ -77,21 +56,19 @@ const checkPostalCode = (
 
 // Validate if theres a difference between the session geoCoords and orderForm geoCoords
 const checkGeoCoordinates = (
-  address: CheckoutAddress | null | undefined,
-  geoCoordinates: IStoreGeoCoordinates | null | undefined,
-  postalCode: string | null | undefined
+  address: CheckoutAddress | null,
+  geoCoordinates: IStoreGeoCoordinates | null | undefined
 ) => {
   return (
     typeof geoCoordinates?.latitude === 'number' &&
     typeof geoCoordinates?.longitude === 'number' &&
     (address?.geoCoordinates[0] !== geoCoordinates?.longitude ||
-      address?.geoCoordinates[1] !== geoCoordinates?.latitude) &&
-    address?.postalCode !== postalCode
+      address?.geoCoordinates[1] !== geoCoordinates?.latitude)
   )
 }
 
 const checkAddressType = (
-  address: CheckoutAddress | null | undefined,
+  address: CheckoutAddress | null,
   addressType: string | null | undefined
 ) => {
   return typeof addressType === 'string' && address?.addressType !== addressType
@@ -102,73 +79,43 @@ const hasItems = (orderForm: OrderForm) => {
   return orderForm.items.length !== 0
 }
 
-// Validate if the deliveryChannel from the session is different from the selected delivery channel
-// and if so needs to validate if the deliveryChannel for the session is available inside the slas for the item
-const shouldUpdateDeliveryChannel = (
+const shouldUpdateDeliveryInfo = (
   logisticsInfo: LogisticsInfo[],
-  session: IStoreSession | null | undefined
+  session: IStoreSession | null
 ) => {
-  if (!session?.deliveryMode?.deliveryChannel) {
-    return false
-  }
-  const { deliveryChannel } = session.deliveryMode
-  for (const item of logisticsInfo) {
-    if (item.selectedDeliveryChannel !== deliveryChannel) {
-      const matchingSla = item.slas.find(
-        (sla) => sla.deliveryChannel === deliveryChannel
-      )
-      if (matchingSla) {
-        return true
-      }
+  const deliveryChannel = session?.deliveryMode?.deliveryChannel
+  const deliveryMethod = session?.deliveryMode?.deliveryMethod
+  const { startDate, endDate } = session?.deliveryMode?.deliveryWindow || {}
+
+  return logisticsInfo.some(
+    ({ selectedDeliveryChannel, selectedSla, slas }) => {
+      const checkDeliveryChannel =
+        deliveryChannel && selectedDeliveryChannel !== deliveryChannel
+      const checkDeliveryMethod =
+        deliveryMethod && selectedSla !== deliveryMethod
+
+      return slas?.some((sla) => {
+        if (
+          (checkDeliveryChannel && sla.deliveryChannel === deliveryChannel) ||
+          (checkDeliveryMethod && sla.id === deliveryMethod)
+        ) {
+          return true
+        }
+        return (
+          startDate &&
+          endDate &&
+          sla.deliveryChannel === deliveryChannel &&
+          sla.id === deliveryMethod &&
+          (!sla?.deliveryWindow ||
+            sla?.deliveryWindow?.startDateUtc !== startDate ||
+            sla?.deliveryWindow?.endDateUtc !== endDate) &&
+          sla.availableDeliveryWindows?.some(
+            (window) =>
+              window?.startDateUtc === startDate &&
+              window?.endDateUtc === endDate
+          )
+        )
+      })
     }
-  }
-  return false
-}
-
-// Validate if the deliveryMethod from the session is different from the selectedSLA
-// and if so needs to validate if the deliveryMethod for the session is available inside the slas for the item
-const shouldUpdateDeliveryMethod = (
-  logisticsInfo: LogisticsInfo[],
-  session: IStoreSession
-) => {
-  if (!session?.deliveryMode?.deliveryMethod) {
-    return false
-  }
-  const { deliveryMethod } = session.deliveryMode
-  for (const item of logisticsInfo) {
-    if (item.selectedSla !== deliveryMethod) {
-      const matchingSla = item.slas.find((sla) => sla.id === deliveryMethod)
-      if (matchingSla) {
-        return true
-      }
-    }
-  }
-  return false
-}
-
-// Validate if the deliveryWindow from the session is different from the deliveryWindow of the SLA
-// and if so needs to validate if the deliveryWindow for the session is available inside the availableDeliveryWindows for the item
-const shouldUpdateDeliveryWindow = (
-  logisticsInfo: LogisticsInfo[],
-  session: IStoreSession
-) => {
-  if (
-    !session?.deliveryMode?.deliveryWindow?.startDate ||
-    !session?.deliveryMode?.deliveryWindow?.endDate
-  ) {
-    return false
-  }
-  const { startDate, endDate } = session.deliveryMode.deliveryWindow
-  for (const item of logisticsInfo) {
-    for (const sla of item.slas) {
-      const matchingWindow = sla.availableDeliveryWindows?.some(
-        (window) =>
-          window.startDateUtc === startDate && window.endDateUtc === endDate
-      )
-      if (matchingWindow) {
-        return true
-      }
-    }
-  }
-  return false
+  )
 }