@faststore/api 3.11.3 → 3.13.1

package/dist/esm/src/typeDefs/query.graphql

@@ -316,7 +316,6 @@ type Query {
     selectedFacets: [IStoreSelectedFacet!]
   ): StoreRedirect
 
-
   """
   Returns a list of sellers available for a specific localization.
   """

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "3.11.3",
+  "version": "3.13.1",
   "license": "MIT",
   "main": "dist/cjs/src/index.js",
   "typings": "dist/esm/src/index.d.ts",
@@ -74,5 +74,5 @@
   "volta": {
     "extends": "../../package.json"
   },
-  "gitHead": "6b9aae9d5eb648c456b313cc210fa7e90821d5fb"
+  "gitHead": "c640a78541b4970d487019aaabbf0ab20b6bf993"
 }

package/src/directives/cacheControl.ts

@@ -1,56 +1,54 @@
-import { getDirective, MapperKind, mapSchema } from "@graphql-tools/utils";
-import { GraphQLSchema } from "graphql";
+import { getDirective, MapperKind, mapSchema } from '@graphql-tools/utils'
+import type { GraphQLSchema } from 'graphql'
 
-import type { Directive } from "./index";
+import type { Directive } from './index'
 
-const NAME = "cacheControl";
+const NAME = 'cacheControl'
 
 export interface CacheControl {
-  sMaxAge?: number;
-  staleWhileRevalidate?: number;
-  scope?: string;
+  sMaxAge?: number
+  staleWhileRevalidate?: number
+  scope?: string
 }
 
-export const stringify = (
-  { scope = "private", sMaxAge = 0, staleWhileRevalidate = 0 }: CacheControl,
-) =>
-  `${scope}, s-maxage=${sMaxAge}, stale-while-revalidate=${staleWhileRevalidate}`;
+export const stringify = ({
+  scope = 'private',
+  sMaxAge = 0,
+  staleWhileRevalidate = 0,
+}: CacheControl) =>
+  `${scope}, s-maxage=${sMaxAge}, stale-while-revalidate=${staleWhileRevalidate}`
 
 const min = (a: number | undefined, b: number | undefined) => {
-  if (typeof a === "number" && typeof b === "number") {
-    return a > b ? b : a;
+  if (typeof a === 'number' && typeof b === 'number') {
+    return a > b ? b : a
   }
 
-  if (typeof a === "number") {
-    return a;
+  if (typeof a === 'number') {
+    return a
   }
 
-  return b;
-};
+  return b
+}
 
-const minScope = (
-  a: string | undefined,
-  b: string | undefined,
-) => {
-  if (typeof a === "string" && typeof b === "string") {
-    return a === "public" && b === "public" ? "public" : "private";
+const minScope = (a: string | undefined, b: string | undefined) => {
+  if (typeof a === 'string' && typeof b === 'string') {
+    return a === 'public' && b === 'public' ? 'public' : 'private'
   }
 
-  return a || b;
-};
+  return a || b
+}
 
 const directive: Directive = {
-  typeDefs:
-    `directive @cacheControl(sMaxAge: Int, staleWhileRevalidate: Int, scope: String) on FIELD_DEFINITION`,
+  typeDefs: `directive @cacheControl(sMaxAge: Int, staleWhileRevalidate: Int, scope: String) on FIELD_DEFINITION`,
   transformer: (schema: GraphQLSchema) =>
     mapSchema(schema, {
       [MapperKind.OBJECT_FIELD]: (fieldConfig) => {
         const cacheControl = getDirective(schema, fieldConfig, NAME)?.[0] as
           | CacheControl
-          | undefined;
+          | undefined
 
         if (cacheControl) {
-          const { sMaxAge, staleWhileRevalidate, scope } = cacheControl;
+          const { sMaxAge, staleWhileRevalidate, scope } = cacheControl
 
           const resolver = fieldConfig.resolve
 
@@ -59,18 +57,18 @@ const directive: Directive = {
               sMaxAge: min(ctx.cacheControl?.sMaxAge, sMaxAge),
               staleWhileRevalidate: min(
                 ctx.cacheControl?.staleWhileRevalidate,
-                staleWhileRevalidate,
+                staleWhileRevalidate
               ),
               scope: minScope(ctx.cacheControl?.scope, scope),
-            };
+            }
 
-            return resolver?.(obj, args, ctx, info);
-          };
+            return resolver?.(obj, args, ctx, info)
+          }
         }
 
-        return fieldConfig;
+        return fieldConfig
       },
     }),
-};
+}
 
-export default directive;
+export default directive

package/src/directives/index.ts

@@ -1,6 +1,6 @@
-import { GraphQLSchema } from "graphql"
+import type { GraphQLSchema } from 'graphql'
 
 export type Directive = {
   typeDefs: string
   transformer: (schema: GraphQLSchema) => GraphQLSchema
-}
+}

package/src/index.ts

@@ -24,11 +24,12 @@ const platforms = {
   },
 }
 
-const directives: Directive[] = [
-  cacheControlDirective
-]
+const directives: Directive[] = [cacheControlDirective]
 
-export const getTypeDefs = () => [typeDefs, ...directives.map(d => d.typeDefs)]
+export const getTypeDefs = () => [
+  typeDefs,
+  ...directives.map((d) => d.typeDefs),
+]
 
 export const getResolvers = (options: Options) =>
   platforms[options.platform].getResolvers(options)

package/src/platforms/errors.ts

@@ -6,7 +6,10 @@ interface Extension {
 }
 
 class FastStoreError<T extends Extension = Extension> extends Error {
-  constructor(public extensions: T, message?: string) {
+  constructor(
+    public extensions: T,
+    message?: string
+  ) {
     super(message)
     this.name = 'FastStoreError'
   }

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

@@ -1,4 +1,4 @@
-import { FACET_CROSS_SELLING_MAP } from '../../utils/facets'
+import type { FACET_CROSS_SELLING_MAP } from '../../utils/facets'
 import { fetchAPI } from '../fetch'
 
 import type { PortalProduct } from './types/Product'
@@ -16,9 +16,9 @@ import type {
 import type { Session } from './types/Session'
 import type { Channel } from '../../utils/channel'
 import type { SalesChannel } from './types/SalesChannel'
-import { MasterDataResponse } from './types/Newsletter'
+import type { MasterDataResponse } from './types/Newsletter'
 import type { Address, AddressInput } from './types/Address'
-import { DeliveryMode, SelectedAddress } from './types/ShippingData'
+import type { DeliveryMode, SelectedAddress } from './types/ShippingData'
 import { getStoreCookie, getWithCookie } from '../../utils/cookies'
 
 type ValueOf<T> = T extends Record<string, infer K> ? K : never
@@ -41,10 +41,10 @@ export const VtexCommerce = (
   const host =
     new Headers(ctx.headers).get('x-forwarded-host') ?? ctx.headers?.host ?? ''
 
-  const selectedPrefix = subDomainPrefix ?
-    subDomainPrefix
-      .map((prefix) => prefix + '.')
-      .find((prefix) => host.includes(prefix)) || ''
+  const selectedPrefix = subDomainPrefix
+    ? subDomainPrefix
+        .map((prefix) => prefix + '.')
+        .find((prefix) => host.includes(prefix)) || ''
     : ''
 
   const forwardedHost = host.replace(selectedPrefix, '')
@@ -142,9 +142,9 @@ export const VtexCommerce = (
       ): Promise<OrderForm> => {
         const deliveryWindow = setDeliveryWindow
           ? {
-            startDateUtc: deliveryMode?.deliveryWindow?.startDate,
-            endDateUtc: deliveryMode?.deliveryWindow?.endDate,
-          }
+              startDateUtc: deliveryMode?.deliveryWindow?.startDate,
+              endDateUtc: deliveryMode?.deliveryWindow?.endDate,
+            }
           : null
 
         const mappedBody = {
@@ -292,9 +292,9 @@ export const VtexCommerce = (
         postalCode
           ? params.append('postalCode', postalCode)
           : params.append(
-            'geoCoordinates',
-            `${geoCoordinates?.longitude};${geoCoordinates?.latitude}`
-          )
+              'geoCoordinates',
+              `${geoCoordinates?.longitude};${geoCoordinates?.latitude}`
+            )
 
         const url = `${base}/api/checkout/pub/regions/?${params.toString()}`
         const headers: HeadersInit = withCookie({

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

@@ -288,7 +288,7 @@ export interface SLA {
   shippingEstimateDate: string | null
   lockTTL: string | null
   availableDeliveryWindows: AvailableDeliveryWindows[]
-  deliveryWindow: DeliveryWindow  | null
+  deliveryWindow: DeliveryWindow | null
   price: number
   listPrice: number
   tax: number
@@ -311,11 +311,11 @@ export interface DeliveryWindow {
 }
 
 export interface AvailableDeliveryWindows {
-  startDateUtc: string,
-  endDateUtc: string,
-  price: number,
-  lisPrice?: number,
-  tax: number,
+  startDateUtc: string
+  endDateUtc: string
+  price: number
+  lisPrice?: number
+  tax: number
 }
 
 export interface DeliveryId {

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
-}
+}