@faststore/api 3.9.2 → 3.11.4

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

@@ -1,199 +1,196 @@
 export interface PortalProduct {
-  productId: string;
-  productName: string;
-  brand: string;
-  brandId: number;
-  brandImageUrl: null | string;
-  linkText: string;
-  productReference: string;
-  productReferenceCode: string;
-  categoryId: string;
-  productTitle: string;
-  metaTagDescription: string;
-  releaseDate: Date;
-  clusterHighlights: unknown;
-  productClusters: unknown;
-  searchableClusters: unknown;
-  categories: Category[];
-  categoriesIds: CategoriesId[];
-  link: string;
-  description: string;
-  items: Item[];
+  productId: string
+  productName: string
+  brand: string
+  brandId: number
+  brandImageUrl: null | string
+  linkText: string
+  productReference: string
+  productReferenceCode: string
+  categoryId: string
+  productTitle: string
+  metaTagDescription: string
+  releaseDate: Date
+  clusterHighlights: unknown
+  productClusters: unknown
+  searchableClusters: unknown
+  categories: Category[]
+  categoriesIds: CategoriesId[]
+  link: string
+  description: string
+  items: Item[]
 }
 
 enum Category {
-  Office = "/Office/",
-  OfficeChairs = "/Office/Chairs/",
+  Office = '/Office/',
+  OfficeChairs = '/Office/Chairs/',
 }
 
 enum CategoriesId {
-  The9282 = "/9282/",
-  The92829296 = "/9282/9296/",
+  The9282 = '/9282/',
+  The92829296 = '/9282/9296/',
 }
 
-
-
 interface Item {
-  itemId: string;
-  name: string;
-  nameComplete: string;
-  complementName: string;
-  ean: string;
-  referenceId: ReferenceId[];
-  measurementUnit: MeasurementUnit;
-  unitMultiplier: number;
-  modalType: null;
-  isKit: boolean;
-  images: Image[];
-  sellers: Seller[];
-  videos: unknown[];
-  estimatedDateArrival: null;
+  itemId: string
+  name: string
+  nameComplete: string
+  complementName: string
+  ean: string
+  referenceId: ReferenceId[]
+  measurementUnit: MeasurementUnit
+  unitMultiplier: number
+  modalType: null
+  isKit: boolean
+  images: Image[]
+  sellers: Seller[]
+  videos: unknown[]
+  estimatedDateArrival: null
 }
 
 interface Image {
-  imageId: string;
-  imageLabel: string;
-  imageTag: string;
-  imageUrl: string;
-  imageText: string;
-  imageLastModified: Date;
+  imageId: string
+  imageLabel: string
+  imageTag: string
+  imageUrl: string
+  imageText: string
+  imageLastModified: Date
 }
 
 enum MeasurementUnit {
-  Un = "un",
+  Un = 'un',
 }
 
 interface ReferenceId {
-  key: Key;
-  value: string;
+  key: Key
+  value: string
 }
 
 enum Key {
-  RefId = "RefId",
+  RefId = 'RefId',
 }
 
 interface Seller {
-  sellerId: string;
-  sellerName: SellerName;
-  addToCartLink: string;
-  sellerDefault: boolean;
-  commertialOffer: CommertialOffer;
+  sellerId: string
+  sellerName: SellerName
+  addToCartLink: string
+  sellerDefault: boolean
+  commertialOffer: CommertialOffer
 }
 
 interface CommertialOffer {
-  deliverySlaSamplesPerRegion: DeliverySlaSamplesPerRegion;
-  installments: Installment[];
-  discountHighLight: unknown[];
-  giftSkuIds: unknown[];
-  teasers: unknown[];
-  buyTogether: unknown[];
-  itemMetadataAttachment: unknown[];
-  price: number;
-  listPrice: number;
-  priceWithoutDiscount: number;
-  rewardValue: number;
-  priceValidUntil: Date;
-  availableQuantity: number;
-  isAvailable: boolean;
-  tax: number;
-  deliverySlaSamples: DeliverySlaSample[];
-  getInfoErrorMessage: null;
-  cacheVersionUsedToCallCheckout: string;
-  paymentOptions: PaymentOptions;
+  deliverySlaSamplesPerRegion: DeliverySlaSamplesPerRegion
+  installments: Installment[]
+  discountHighLight: unknown[]
+  giftSkuIds: unknown[]
+  teasers: unknown[]
+  buyTogether: unknown[]
+  itemMetadataAttachment: unknown[]
+  price: number
+  listPrice: number
+  priceWithoutDiscount: number
+  rewardValue: number
+  priceValidUntil: Date
+  availableQuantity: number
+  isAvailable: boolean
+  tax: number
+  deliverySlaSamples: DeliverySlaSample[]
+  getInfoErrorMessage: null
+  cacheVersionUsedToCallCheckout: string
+  paymentOptions: PaymentOptions
 }
 
 interface DeliverySlaSample {
-  deliverySlaPerTypes: unknown[];
-  region: null;
+  deliverySlaPerTypes: unknown[]
+  region: null
 }
 
 interface DeliverySlaSamplesPerRegion {
-  the0: DeliverySlaSample;
+  the0: DeliverySlaSample
 }
 
 interface Installment {
-  value: number;
-  interestRate: number;
-  totalValuePlusInterestRate: number;
-  numberOfInstallments: number;
-  paymentSystemName: PaymentSystemNameEnum;
-  paymentSystemGroupName: GroupName;
-  name: Name;
+  value: number
+  interestRate: number
+  totalValuePlusInterestRate: number
+  numberOfInstallments: number
+  paymentSystemName: PaymentSystemNameEnum
+  paymentSystemGroupName: GroupName
+  name: Name
 }
 
 enum Name {
-  BoletoBancárioÀVista = "Boleto Bancário à vista",
-  FreeÀVista = "Free à vista",
+  BoletoBancárioÀVista = 'Boleto Bancário à vista',
+  FreeÀVista = 'Free à vista',
 }
 
 enum GroupName {
-  BankInvoicePaymentGroup = "bankInvoicePaymentGroup",
-  Custom201PaymentGroupPaymentGroup = "custom201PaymentGroupPaymentGroup",
+  BankInvoicePaymentGroup = 'bankInvoicePaymentGroup',
+  Custom201PaymentGroupPaymentGroup = 'custom201PaymentGroupPaymentGroup',
 }
 
 enum PaymentSystemNameEnum {
-  BoletoBancário = "Boleto Bancário",
-  Free = "Free",
+  BoletoBancário = 'Boleto Bancário',
+  Free = 'Free',
 }
 
 interface PaymentOptions {
-  installmentOptions: InstallmentOption[];
-  paymentSystems: PaymentSystem[];
-  payments: unknown[];
-  giftCards: unknown[];
-  giftCardMessages: unknown[];
-  availableAccounts: unknown[];
-  availableTokens: unknown[];
+  installmentOptions: InstallmentOption[]
+  paymentSystems: PaymentSystem[]
+  payments: unknown[]
+  giftCards: unknown[]
+  giftCardMessages: unknown[]
+  availableAccounts: unknown[]
+  availableTokens: unknown[]
 }
 
 interface InstallmentOption {
-  paymentSystem: string;
-  bin: null;
-  paymentName: PaymentSystemNameEnum;
-  paymentGroupName: GroupName;
-  value: number;
-  installments: InstallmentElement[];
+  paymentSystem: string
+  bin: null
+  paymentName: PaymentSystemNameEnum
+  paymentGroupName: GroupName
+  value: number
+  installments: InstallmentElement[]
 }
 
 interface InstallmentElement {
-  count: number;
-  hasInterestRate: boolean;
-  interestRate: number;
-  value: number;
-  total: number;
-  sellerMerchantInstallments?: InstallmentElement[];
-  id?: Id;
+  count: number
+  hasInterestRate: boolean
+  interestRate: number
+  value: number
+  total: number
+  sellerMerchantInstallments?: InstallmentElement[]
+  id?: Id
 }
 
 enum Id {
-  Storeframework = "STOREFRAMEWORK",
+  Storeframework = 'STOREFRAMEWORK',
 }
 
 interface PaymentSystem {
-  id: number;
-  name: PaymentSystemNameEnum;
-  groupName: GroupName;
-  validator: null;
-  stringId: string;
-  template: Template;
-  requiresDocument: boolean;
-  isCustom: boolean;
-  description: Description | null;
-  requiresAuthentication: boolean;
-  dueDate: Date;
-  availablePayments: null;
+  id: number
+  name: PaymentSystemNameEnum
+  groupName: GroupName
+  validator: null
+  stringId: string
+  template: Template
+  requiresDocument: boolean
+  isCustom: boolean
+  description: Description | null
+  requiresAuthentication: boolean
+  dueDate: Date
+  availablePayments: null
 }
 
 enum Description {
-  FreePayToTestCheckoutPayments = "Free pay to test checkout payments",
+  FreePayToTestCheckoutPayments = 'Free pay to test checkout payments',
 }
 
 enum Template {
-  BankInvoicePaymentGroupTemplate = "bankInvoicePaymentGroup-template",
-  Custom201PaymentGroupPaymentGroupTemplate =
-    "custom201PaymentGroupPaymentGroup-template",
+  BankInvoicePaymentGroupTemplate = 'bankInvoicePaymentGroup-template',
+  Custom201PaymentGroupPaymentGroupTemplate = 'custom201PaymentGroupPaymentGroup-template',
 }
 
 enum SellerName {
-  Vtex = "VTEX",
+  Vtex = 'VTEX',
 }

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

@@ -1,25 +1,25 @@
 export interface SalesChannel {
-  Id:                    number;
-  Name:                  string;
-  IsActive:              boolean;
-  ProductClusterId:      null;
-  CountryCode:           string;
-  CultureInfo:           string;
-  TimeZone:              string;
-  CurrencyCode:          string;
-  CurrencySymbol:        string;
-  CurrencyLocale:        number;
-  CurrencyFormatInfo:    CurrencyFormatInfo;
-  Origin:                null;
-  Position:              number;
-  ConditionRule:         null;
-  CurrencyDecimalDigits: null;
+  Id: number
+  Name: string
+  IsActive: boolean
+  ProductClusterId: null
+  CountryCode: string
+  CultureInfo: string
+  TimeZone: string
+  CurrencyCode: string
+  CurrencySymbol: string
+  CurrencyLocale: number
+  CurrencyFormatInfo: CurrencyFormatInfo
+  Origin: null
+  Position: number
+  ConditionRule: null
+  CurrencyDecimalDigits: null
 }
 
 export interface CurrencyFormatInfo {
-  CurrencyDecimalDigits:    number;
-  CurrencyDecimalSeparator: string;
-  CurrencyGroupSeparator:   string;
-  CurrencyGroupSize:        number;
-  StartsWithCurrencySymbol: boolean;
+  CurrencyDecimalDigits: number
+  CurrencyDecimalSeparator: string
+  CurrencyGroupSeparator: string
+  CurrencyGroupSize: number
+  StartsWithCurrencySymbol: boolean
 }

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

@@ -1,7 +1,11 @@
 import type { Context, Options } from '../../'
 import type { IStoreSelectedFacet } from '../../../../__generated__/schema'
 import { getStoreCookie } from '../../utils/cookies'
-import type { FuzzyFacet, OperatorFacet, SelectedFacet } from '../../utils/facets'
+import type {
+  FuzzyFacet,
+  OperatorFacet,
+  SelectedFacet,
+} from '../../utils/facets'
 import { fetchAPI } from '../fetch'
 import type {
   Facet,
@@ -72,7 +76,13 @@ const isOperatorFacet = (facet: SelectedFacet): facet is OperatorFacet => {
 }
 
 export const IntelligentSearch = (
-  { account, environment, hideUnavailableItems, simulationBehavior, showSponsored }: Options,
+  {
+    account,
+    environment,
+    hideUnavailableItems,
+    simulationBehavior,
+    showSponsored,
+  }: Options,
   ctx: Context
 ) => {
   const base = `https://${account}.${environment}.com.br/api/io`
@@ -154,7 +164,7 @@ export const IntelligentSearch = (
     selectedFacets = [],
     type,
     showInvisibleItems,
-    sponsoredCount
+    sponsoredCount,
   }: SearchArgs): Promise<T> => {
     const params = new URLSearchParams({
       page: (page + 1).toString(),

package/src/platforms/vtex/clients/search/types/ProductSearchResult.ts

@@ -230,4 +230,4 @@ export interface Attribute {
   name: string
   value: string
   visible: boolean
-}
+}

package/src/platforms/vtex/index.ts

@@ -9,7 +9,7 @@ import { StoreCollection } from './resolvers/collection'
 import {
   StoreFacet,
   StoreFacetBoolean,
-  StoreFacetRange
+  StoreFacetRange,
 } from './resolvers/facet'
 import { StoreFacetValueBoolean } from './resolvers/faceValue'
 import { Mutation } from './resolvers/mutation'

package/src/platforms/vtex/loaders/index.ts

@@ -1,4 +1,4 @@
-import { getSalesChannelLoader } from './salesChannel';
+import { getSalesChannelLoader } from './salesChannel'
 import { getSimulationLoader } from './simulation'
 import { getSkuLoader } from './sku'
 import { getCollectionLoader } from './collection'
@@ -16,6 +16,6 @@ export const getLoaders = (options: Options, { clients }: Context) => {
     skuLoader,
     simulationLoader,
     collectionLoader,
-    salesChannelLoader
+    salesChannelLoader,
   }
 }

package/src/platforms/vtex/loaders/salesChannel.ts

@@ -1,15 +1,13 @@
-import DataLoader from "dataloader";
+import DataLoader from 'dataloader'
 
-import { Options } from "..";
-import { Clients } from "../clients";
+import type { Options } from '..'
+import type { Clients } from '../clients'
 
-import type { SalesChannel } from "./../clients/commerce/types/SalesChannel";
+import type { SalesChannel } from './../clients/commerce/types/SalesChannel'
 
 export const getSalesChannelLoader = (_: Options, clients: Clients) => {
   const loader = async (channels: readonly string[]) =>
-    Promise.all(
-      channels.map((sc) => clients.commerce.catalog.salesChannel(sc)),
-    );
+    Promise.all(channels.map((sc) => clients.commerce.catalog.salesChannel(sc)))
 
-  return new DataLoader<string, SalesChannel>(loader);
-};
+  return new DataLoader<string, SalesChannel>(loader)
+}

package/src/platforms/vtex/loaders/simulation.ts

@@ -29,15 +29,18 @@ export const getSimulationLoader = (_: Options, clients: Clients) => {
 
     // Sort and filter simulation since Checkout API may return
     // items that we didn't ask for
-    const simulated = simulation.items.reduce((acc, item) => {
-      const index = item.requestIndex
+    const simulated = simulation.items.reduce(
+      (acc, item) => {
+        const index = item.requestIndex
 
-      if (typeof index === 'number' && index < acc.length) {
-        acc[index] = item
-      }
+        if (typeof index === 'number' && index < acc.length) {
+          acc[index] = item
+        }
 
-      return acc
-    }, Array(items.length).fill(null) as Simulation['items'])
+        return acc
+      },
+      Array(items.length).fill(null) as Simulation['items']
+    )
 
     const itemsIndices = allItems.reduce(
       (acc, curr) => [...acc, curr.length + acc[acc.length - 1]],

package/src/platforms/vtex/loaders/sku.ts

@@ -8,23 +8,28 @@ import type { Clients } from '../clients'
 
 export const getSkuLoader = (_: Options, clients: Clients) => {
   const loader = async (keys: readonly string[]) => {
-    const skuIds = keys.map((key) => key.split('-')[0]);
-    const showInvisibleItems = keys.some((key) => key.split('-')[1] === 'invisibleItems')
+    const skuIds = keys.map((key) => key.split('-')[0])
+    const showInvisibleItems = keys.some(
+      (key) => key.split('-')[1] === 'invisibleItems'
+    )
 
     const { products } = await clients.search.products({
       query: `sku:${skuIds.join(';')}`,
       page: 0,
       count: skuIds.length,
-      showInvisibleItems
+      showInvisibleItems,
     })
 
-    const skuBySkuId = products.reduce((acc, product) => {
-      for (const sku of product.items) {
-        acc[sku.itemId] = enhanceSku(sku, product)
-      }
+    const skuBySkuId = products.reduce(
+      (acc, product) => {
+        for (const sku of product.items) {
+          acc[sku.itemId] = enhanceSku(sku, product)
+        }
 
-      return acc
-    }, {} as Record<string, EnhancedSku>)
+        return acc
+      },
+      {} as Record<string, EnhancedSku>
+    )
 
     const skus = skuIds.map((skuId) => skuBySkuId[skuId])
     const missingSkus = skuIds.filter((skuId) => !skuBySkuId[skuId])

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

@@ -45,12 +45,12 @@ export const StoreAggregateOffer: Record<string, Resolver<Root>> & {
   priceCurrency: async (_, __, ctx) => {
     const {
       loaders: { salesChannelLoader },
-      storage: { channel }
+      storage: { channel },
     } = ctx
 
-    const sc = await salesChannelLoader.load(channel.salesChannel);
+    const sc = await salesChannelLoader.load(channel.salesChannel)
 
-    return sc.CurrencyCode ?? '';
+    return sc.CurrencyCode ?? ''
   },
   offers: (offers) => offers,
 }

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

@@ -10,18 +10,17 @@ import type { Resolver } from '..'
 export type Root = Facet
 
 export const StoreFacet: Record<string, Resolver<Root>> = {
-  __resolveType: ({ type, values }) =>
-    {
-      if (type !== 'TEXT') {
-        return 'StoreFacetRange'
-      }
+  __resolveType: ({ type, values }) => {
+    if (type !== 'TEXT') {
+      return 'StoreFacetRange'
+    }
 
-      if (values.every((value) => (value as FacetValueRange).range)) {
-        return 'StoreFacetRange'
-      }
+    if (values.every((value) => (value as FacetValueRange).range)) {
+      return 'StoreFacetRange'
+    }
 
-      return 'StoreFacetBoolean'
-    },
+    return 'StoreFacetBoolean'
+  },
 }
 
 export const StoreFacetBoolean: Record<

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

@@ -26,14 +26,14 @@ const isOrderFormItem = (item: Root): item is OrderFormProduct =>
 
 export const StoreOffer: Record<string, Resolver<Root>> = {
   priceCurrency: async (_, __, ctx) => {
-    const { 
-      loaders: { salesChannelLoader }, 
-      storage: { channel } 
+    const {
+      loaders: { salesChannelLoader },
+      storage: { channel },
     } = ctx
 
-    const sc = await salesChannelLoader.load(channel.salesChannel);
-    
-    return sc.CurrencyCode ?? '';
+    const sc = await salesChannelLoader.load(channel.salesChannel)
+
+    return sc.CurrencyCode ?? ''
   },
   priceValidUntil: (root) => {
     if (isSearchItem(root)) {
@@ -90,7 +90,11 @@ export const StoreOffer: Record<string, Resolver<Root>> = {
     }
 
     if (isOrderFormItem(root)) {
-      return withTax(root.sellingPrice / 1e2, root.tax / 1e2, root.unitMultiplier)
+      return withTax(
+        root.sellingPrice / 1e2,
+        root.tax / 1e2,
+        root.unitMultiplier
+      )
     }
 
     return null
@@ -119,7 +123,11 @@ export const StoreOffer: Record<string, Resolver<Root>> = {
   },
   listPriceWithTaxes: (root) => {
     if (isSearchItem(root)) {
-      return withTax(root.ListPrice ?? 0, root?.Tax, root.product.unitMultiplier)
+      return withTax(
+        root.ListPrice ?? 0,
+        root?.Tax,
+        root.product.unitMultiplier
+      )
     }
 
     if (isOrderFormItem(root)) {

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

@@ -1,9 +1,9 @@
 import type { Resolver } from '..'
-import { PromiseType } from '../../../typings'
-import { StoreOffer } from './offer'
+import type { PromiseType } from '../../../typings'
+import type { StoreOffer } from './offer'
 
 export type Root = PromiseType<ReturnType<typeof StoreOffer.seller>>
 
-export const StoreOrganization: Record<string,  Resolver<Root>> = {
+export const StoreOrganization: Record<string, Resolver<Root>> = {
   identifier: () => '',
 }

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

@@ -12,7 +12,7 @@ import {
   VALUE_REFERENCES,
 } from '../utils/propertyValue'
 import type { Attachment } from '../clients/commerce/types/OrderForm'
-import { StoreImage, StoreProductImageArgs } from '../../..'
+import type { StoreImage, StoreProductImageArgs } from '../../..'
 
 type QueryProduct = PromiseType<ReturnType<typeof Query.product>>
 
@@ -54,7 +54,7 @@ export const StoreProduct: Record<string, Resolver<Root>> & {
     canonical: canonicalFromProduct(isVariantOf),
   }),
   brand: ({ isVariantOf: { brand } }) => ({ name: brand }),
-  unitMultiplier: ({unitMultiplier}) => unitMultiplier,
+  unitMultiplier: ({ unitMultiplier }) => unitMultiplier,
   breadcrumbList: ({
     isVariantOf: { categories, productName, linkText },
     itemId,
@@ -90,13 +90,13 @@ export const StoreProduct: Record<string, Resolver<Root>> & {
       })
     )
 
-    if(typeof args !== 'object') {
-      return resolvedImages;
+    if (typeof args !== 'object') {
+      return resolvedImages
     }
 
     let { context, limit } = args as StoreProductImageArgs
 
-    const shouldFilter = context !== "generic"
+    const shouldFilter = context !== 'generic'
 
     // Normalize count to undefined as we want any negative value to always return the full list of images
     limit = limit || -1