@faststore/api 1.2.23

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

@@ -0,0 +1,371 @@
+export interface OrderFormInputItem {
+  id: string
+  quantity: number
+  seller: string
+  index?: number
+}
+
+export interface OrderFormItem {
+  id: string
+  name: string
+  detailUrl: string
+  imageUrl: string
+  skuName: string
+  quantity: number
+  uniqueId: string
+  productId: string
+  refId: string
+  ean: string
+  priceValidUntil: string
+  price: number
+  tax: number
+  listPrice: number
+  sellingPrice: number
+  rewardValue: number
+  isGift: boolean
+  parentItemIndex: number | null
+  parentAssemblyBinding: string | null
+  productCategoryIds: string
+  priceTags: string[]
+  manualPrice: number
+  measurementUnit: string
+  additionalInfo: {
+    brandName: string
+    brandId: string
+    offeringInfo: any | null
+    offeringType: any | null
+    offeringTypeId: any | null
+  }
+  productCategories: Record<string, string>
+  productRefId: string
+  seller: string
+  sellerChain: string[]
+  availability: string
+  unitMultiplier: number
+  skuSpecifications: SKUSpecification[]
+  priceDefinition: {
+    calculatedSellingPrice: number
+    sellingPrices: SellingPrice[]
+    total: number
+  }
+}
+
+export interface SKUSpecification {
+  fieldName: string
+  fieldValues: string[]
+}
+
+export interface AdditionalInfo {
+  dimension: null
+  brandName: string
+  brandId: string
+  offeringInfo: null
+  offeringType: null
+  offeringTypeId: null
+}
+
+export interface PriceDefinition {
+  calculatedSellingPrice: number
+  total: number
+  sellingPrices: SellingPrice[]
+}
+
+export interface SellingPrice {
+  value: number
+  quantity: number
+}
+
+export interface PriceTag {
+  name: string
+  value: number
+  rawValue: number
+  isPercentual: boolean
+  identifier: string
+}
+
+export interface OrderForm {
+  orderFormId: string
+  salesChannel: string
+  loggedIn: boolean
+  isCheckedIn: boolean
+  storeId: string | null
+  checkedInPickupPointId: string | null
+  allowManualPrice: boolean
+  canEditData: boolean
+  userProfileId: string | null
+  userType: string | null
+  ignoreProfileData: boolean
+  value: number
+  messages: any[]
+  items: OrderFormItem[]
+  selectableGifts: any[]
+  totalizers: Array<{
+    id: string
+    name: string
+    value: number
+  }>
+  shippingData: ShippingData | null
+  clientProfileData: ClientProfileData | null
+  paymentData: PaymentData
+  marketingData: OrderFormMarketingData | null
+  sellers: Array<{
+    id: string
+    name: string
+    logo: string
+  }>
+  clientPreferencesData: {
+    locale: string
+    optinNewsLetter: any | null
+  }
+  commercialConditionData: any | null
+  storePreferencesData: {
+    countryCode: string
+    currencyCode: string
+    currencyFormatInfo: {
+      currencyDecimalDigits: number
+      currencyDecimalSeparator: string
+      currencyGroupSeparator: string
+      currencyGroupSize: number
+      startsWithCurrencySymbol: boolean
+    }
+    currencyLocale: string
+    currencySymbol: string
+    saveUserData: boolean
+    timeZone: string
+  }
+  giftRegistryData: any | null
+  openTextField: any | null
+  invoiceData: any | null
+  customData: any | null
+  itemMetadata: {
+    items: MetadataItem[]
+  }
+  hooksData: any | null
+  ratesAndBenefitsData: {
+    rateAndBenefitsIdentifiers: any[]
+    teaser: any[]
+  }
+  subscriptionData: SubscriptionData | null
+  itemsOrdination: any | null
+}
+
+export interface OrderFormMarketingData {
+  utmCampaign?: string
+  utmMedium?: string
+  utmSource?: string
+  utmiCampaign?: string
+  utmiPart?: string
+  utmipage?: string
+  marketingTags?: string
+  coupon?: string
+}
+
+export interface PaymentData {
+  installmentOptions: Array<{
+    paymentSystem: string
+    bin: string | null
+    paymentName: string | null
+    paymentGroupName: string | null
+    value: number
+    installments: Array<{
+      count: number
+      hasInterestRate: false
+      interestRate: number
+      value: number
+      total: number
+      sellerMerchantInstallments: Array<{
+        count: number
+        hasInterestRate: false
+        interestRate: number
+        value: number
+        total: number
+      }>
+    }>
+  }>
+  paymentSystems: Array<{
+    id: string
+    name: string
+    groupName: string
+    validator: {
+      regex: string
+      mask: string
+      cardCodeRegex: string
+      cardCodeMask: string
+      weights: number[]
+      useCvv: boolean
+      useExpirationDate: boolean
+      useCardHolderName: boolean
+      useBillingAddress: boolean
+    }
+    stringId: string
+    template: string
+    requiresDocument: boolean
+    isCustom: boolean
+    description: string | null
+    requiresAuthentication: boolean
+    dueDate: string
+    availablePayments: any | null
+  }>
+  payments: any[]
+  giftCards: any[]
+  giftCardMessages: any[]
+  availableAccounts: any[]
+  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
+  isCorporate: boolean
+  profileCompleteOnLoading: boolean
+  profileErrorOnLoading: boolean
+  customerClass: string
+}
+
+export interface ShippingData {
+  address: CheckoutAddress | null
+  logisticsInfo: LogisticsInfo[]
+  selectedAddresses: CheckoutAddress[]
+  availableAddresses: CheckoutAddress[]
+  pickupPoints: PickupPoint[]
+}
+
+export interface PickupPoint {
+  friendlyName: string
+  address: CheckoutAddress
+  additionalInfo: string
+  id: string
+  businessHours: BusinessHour[]
+}
+
+export interface BusinessHour {
+  DayOfWeek: number
+  ClosingTime: string
+  OpeningTime: string
+}
+
+export interface LogisticsInfo {
+  addressId: string | null
+  deliveryChannels: DeliveryChannel[]
+  itemId: string
+  itemIndex: number
+  shipsTo: string[]
+  slas: SLA[]
+  selectedDeliveryChannel: string | null
+  selectedSla: string | null
+}
+
+export interface SLA {
+  id: string
+  deliveryChannel: string
+  name: string
+  deliveryIds: DeliveryId[]
+  shippingEstimate: string
+  shippingEstimateDate: string | null
+  lockTTL: string | null
+  availableDeliveryWindows: any[]
+  deliveryWindow: string | null
+  price: number
+  listPrice: number
+  tax: number
+  pickupStoreInfo: {
+    isPickupStore: boolean
+    friendlyName: string | null
+    address: CheckoutAddress | null
+    additionalInfo: any | null
+    dockId: string | null
+  }
+  pickupPointId: string | null
+  pickupDistance: number | null
+  polygonName: string | null
+  transitTime: string | null
+}
+
+export interface DeliveryId {
+  courierId: string
+  warehouseId: string
+  dockId: string
+  courierName: string
+  quantity: number
+}
+
+export interface DeliveryChannel {
+  id: string
+}
+
+export interface CheckoutAddress {
+  addressId: string
+  addressType: string
+  city: string | null
+  complement: string | null
+  country: string
+  geoCoordinates: number[]
+  neighborhood: string | null
+  number: string | null
+  postalCode: string | null
+  receiverName: string | null
+  reference: string | null
+  state: string | null
+  street: string | null
+  isDisposable: boolean
+}
+
+export interface MetadataItem {
+  id: string
+  name: string
+  imageUrl: string
+  detailUrl: string
+  seller: string
+  assemblyOptions: AssemblyOption[]
+  skuName: string
+  productId: string
+  refId: string
+  ean: string | null
+}
+
+export interface AssemblyOption {
+  id: string
+  name: string
+  composition: Composition | null
+}
+
+export interface SubscriptionDataEntry {
+  executionCount: number
+  itemIndex: number
+  plan: {
+    frequency: {
+      interval: number
+      periodicity: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY'
+    }
+    type: string
+    validity: unknown
+  }
+}
+
+export interface CompositionItem {
+  id: string
+  minQuantity: number
+  maxQuantity: number
+  initialQuantity: number
+  priceTable: string
+  seller: string
+}
+
+export interface Composition {
+  minQuantity: number
+  maxQuantity: number
+  items: CompositionItem[]
+}
+
+export interface SubscriptionData {
+  subscriptions: SubscriptionDataEntry[]
+}

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

@@ -0,0 +1,170 @@
+export interface PayloadItem {
+  id: string
+  quantity: number
+  seller: string
+  parentItemIndex?: number | null
+  parentAssemblyBinding?: string | null
+}
+
+export interface ShippingData {
+  logisticsInfo?: Array<{ regionId?: string | null }>
+}
+
+export interface SimulationArgs {
+  country?: string
+  items: PayloadItem[]
+  postalCode?: string
+  isCheckedIn?: boolean
+  priceTables?: string[]
+  marketingData?: Record<string, string>
+  shippingData?: ShippingData
+}
+
+export interface SimulationOptions {
+  salesChannel: string
+}
+
+export interface Simulation {
+  items: Item[]
+  ratesAndBenefitsData: RatesAndBenefitsData
+  paymentData: PaymentData
+  selectableGifts: any[]
+  marketingData: MarketingData
+  postalCode: null
+  country: null
+  logisticsInfo: LogisticsInfo[]
+  messages: any[]
+  purchaseConditions: PurchaseConditions
+  pickupPoints: any[]
+  subscriptionData: null
+  totals: Total[]
+  itemMetadata: null
+}
+
+export interface Item {
+  id: string
+  requestIndex: number
+  quantity: number
+  seller: string
+  sellerChain: string[]
+  tax: number
+  priceValidUntil: Date
+  price: number
+  listPrice: number
+  rewardValue: number
+  sellingPrice: number
+  offerings: any[]
+  priceTags: any[]
+  measurementUnit: string
+  unitMultiplier: number
+  parentItemIndex: null
+  parentAssemblyBinding: null
+  availability: string
+  catalogProvider: string
+  priceDefinition: PriceDefinition
+}
+
+export interface PriceDefinition {
+  calculatedSellingPrice: number
+  total: number
+  sellingPrices: SellingPrice[]
+}
+
+export interface SellingPrice {
+  value: number
+  quantity: number
+}
+
+export interface LogisticsInfo {
+  itemIndex: number
+  addressId: null
+  selectedSla: null
+  selectedDeliveryChannel: null
+  quantity: number
+  shipsTo: string[]
+  slas: any[]
+  deliveryChannels: DeliveryChannel[]
+}
+
+export interface DeliveryChannel {
+  id: string
+}
+
+export interface MarketingData {
+  utmSource: null
+  utmMedium: null
+  utmCampaign: null
+  utmipage: null
+  utmiPart: null
+  utmiCampaign: null
+  coupon: null
+  marketingTags: string[]
+}
+
+export interface PaymentData {
+  installmentOptions: InstallmentOption[]
+  paymentSystems: PaymentSystem[]
+  payments: any[]
+  giftCards: any[]
+  giftCardMessages: any[]
+  availableAccounts: any[]
+  availableTokens: any[]
+}
+
+export interface InstallmentOption {
+  paymentSystem: string
+  bin: null
+  paymentName: string
+  paymentGroupName: string
+  value: number
+  installments: Installment[]
+}
+
+export interface Installment {
+  count: number
+  hasInterestRate: boolean
+  interestRate: number
+  value: number
+  total: number
+  sellerMerchantInstallments?: Installment[]
+  id?: string
+}
+
+export interface PaymentSystem {
+  id: number
+  name: string
+  groupName: string
+  validator: null
+  stringId: string
+  template: string
+  requiresDocument: boolean
+  isCustom: boolean
+  description: null | string
+  requiresAuthentication: boolean
+  dueDate: Date
+  availablePayments: null
+}
+
+export interface PurchaseConditions {
+  itemPurchaseConditions: ItemPurchaseCondition[]
+}
+
+export interface ItemPurchaseCondition {
+  id: string
+  seller: string
+  sellerChain: string[]
+  slas: any[]
+  price: number
+  listPrice: number
+}
+
+export interface RatesAndBenefitsData {
+  rateAndBenefitsIdentifiers: any[]
+  teaser: any[]
+}
+
+export interface Total {
+  id: string
+  name: string
+  value: number
+}

package/src/platforms/vtex/clients/fetch.ts

@@ -0,0 +1,13 @@
+import fetch from 'isomorphic-unfetch'
+
+export const fetchAPI = async (info: RequestInfo, init?: RequestInit) => {
+  const response = await fetch(info, init)
+
+  if (response.ok) {
+    return response.json()
+  }
+
+  const text = await response.text()
+
+  throw new Error(text)
+}

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

@@ -0,0 +1,15 @@
+import { VtexCommerce } from './commerce'
+import { IntelligentSearch } from './search'
+import type { Options } from '..'
+
+export type Clients = ReturnType<typeof getClients>
+
+export const getClients = (options: Options) => {
+  const search = IntelligentSearch(options)
+  const commerce = VtexCommerce(options)
+
+  return {
+    search,
+    commerce,
+  }
+}

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

@@ -0,0 +1,83 @@
+import { fetchAPI } from '../fetch'
+import type { SelectedFacet } from '../../utils/facets'
+import type { Options } from '../..'
+import type { ProductSearchResult } from './types/ProductSearchResult'
+import type { AttributeSearchResult } from './types/AttributeSearchResult'
+
+export type Sort =
+  | 'price:desc'
+  | 'price:asc'
+  | 'orders:desc'
+  | 'name:desc'
+  | 'name:asc'
+  | 'release:desc'
+  | 'discount:desc'
+  | ''
+
+export interface SearchArgs {
+  query?: string
+  page: number
+  count: number
+  type: 'product_search' | 'attribute_search'
+  sort?: Sort
+  selectedFacets?: SelectedFacet[]
+  fuzzy?: '0' | '1'
+}
+
+export interface ProductLocator {
+  field: 'id' | 'slug'
+  value: string
+}
+
+export const IntelligentSearch = (opts: Options) => {
+  const { channel } = opts
+  const base = `http://search.biggylabs.com.br/search-api/v1/${opts.account}`
+
+  const addDefaultFacets = (facets: SelectedFacet[]) => {
+    const facetsObj = Object.fromEntries(
+      facets.map(({ key, value }) => [key, value])
+    )
+
+    return Object.entries({
+      'trade-policy': channel,
+      ...facetsObj,
+    }).map(([key, value]) => ({ key, value }))
+  }
+
+  const search = <T>({
+    query = '',
+    page,
+    count,
+    sort = '',
+    selectedFacets = [],
+    type,
+    fuzzy = '0',
+  }: SearchArgs): Promise<T> => {
+    const params = new URLSearchParams({
+      page: (page + 1).toString(),
+      count: count.toString(),
+      query,
+      sort,
+      fuzzy,
+    })
+
+    const pathname = addDefaultFacets(selectedFacets)
+      .map(({ key, value }) => `${key}/${value}`)
+      .join('/')
+
+    return fetchAPI(
+      `${base}/api/split/${type}/${pathname}?${params.toString()}`
+    )
+  }
+
+  const products = (args: Omit<SearchArgs, 'type'>) =>
+    search<ProductSearchResult>({ ...args, type: 'product_search' })
+
+  const facets = (args: Omit<SearchArgs, 'type'>) =>
+    search<AttributeSearchResult>({ ...args, type: 'attribute_search' })
+
+  return {
+    facets,
+    products,
+  }
+}

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

@@ -0,0 +1,61 @@
+export interface AttributeSearchResult {
+  total: number
+  pagination: Pagination
+  sampling: boolean
+  translated: boolean
+  locale: string
+  query: string
+  operator: string
+  fuzzy: string
+  attributes: Attribute[]
+}
+
+export interface Attribute {
+  ids: string[]
+  visible: boolean
+  values: Value[]
+  active: boolean
+  key: string
+  originalKey: string
+  label: string
+  originalLabel: string
+  type: string
+  minValue?: number
+  maxValue?: number
+  templateURL?: string
+  proxyURL?: string
+}
+
+export interface Value {
+  count: number
+  active: boolean
+  key?: string
+  label?: string
+  id?: string
+  originalKey?: string
+  originalLabel?: string
+  proxyURL: string
+  from?: string
+  to?: string
+}
+
+export interface Pagination {
+  count: number
+  current: Current
+  before: any[]
+  after: any[]
+  perPage: number
+  next: First
+  previous: First
+  first: First
+  last: First
+}
+
+export interface Current {
+  index: number
+  proxyURL: string
+}
+
+export interface First {
+  index: number
+}