@faststore/api 1.9.14 → 1.10.6

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

@@ -1,3 +1,5 @@
+import { FACET_CROSS_SELLING_MAP } from "../../utils/facets";
+import type { PortalProduct } from "./types/Product";
 import type { Context, Options } from '../../index';
 import type { Brand } from './types/Brand';
 import type { CategoryTree } from './types/CategoryTree';
@@ -7,6 +9,7 @@ import type { Region, RegionInput } from './types/Region';
 import type { Simulation, SimulationArgs, SimulationOptions } from './types/Simulation';
 import type { Session } from './types/Session';
 import type { Channel } from '../../utils/channel';
+declare type ValueOf<T> = T extends Record<string, infer K> ? K : never;
 export declare const VtexCommerce: ({ account, environment }: Options, ctx: Context) => {
     catalog: {
         brand: {
@@ -18,6 +21,13 @@ export declare const VtexCommerce: ({ account, environment }: Options, ctx: Cont
         portal: {
             pagetype: (slug: string) => Promise<PortalPagetype>;
         };
+        products: {
+            crossselling: ({ type, productId, groupByProduct }: {
+                type: ValueOf<typeof FACET_CROSS_SELLING_MAP>;
+                productId: string;
+                groupByProduct?: boolean | undefined;
+            }) => Promise<PortalProduct[]>;
+        };
     };
     checkout: {
         simulation: (args: SimulationArgs, { salesChannel }?: SimulationOptions) => Promise<Simulation>;
@@ -42,3 +52,4 @@ export declare const VtexCommerce: ({ account, environment }: Options, ctx: Cont
     };
     session: (search: string) => Promise<Session>;
 };
+export {};

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

@@ -0,0 +1,174 @@
+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[];
+}
+declare enum Category {
+    Office = "/Office/",
+    OfficeChairs = "/Office/Chairs/"
+}
+declare enum CategoriesId {
+    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;
+}
+interface Image {
+    imageId: string;
+    imageLabel: string;
+    imageTag: string;
+    imageUrl: string;
+    imageText: string;
+    imageLastModified: Date;
+}
+declare enum MeasurementUnit {
+    Un = "un"
+}
+interface ReferenceId {
+    key: Key;
+    value: string;
+}
+declare enum Key {
+    RefId = "RefId"
+}
+interface Seller {
+    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;
+}
+interface DeliverySlaSample {
+    deliverySlaPerTypes: unknown[];
+    region: null;
+}
+interface DeliverySlaSamplesPerRegion {
+    the0: DeliverySlaSample;
+}
+interface Installment {
+    value: number;
+    interestRate: number;
+    totalValuePlusInterestRate: number;
+    numberOfInstallments: number;
+    paymentSystemName: PaymentSystemNameEnum;
+    paymentSystemGroupName: GroupName;
+    name: Name;
+}
+declare enum Name {
+    BoletoBancárioÀVista = "Boleto Banc\u00E1rio \u00E0 vista",
+    FreeÀVista = "Free \u00E0 vista"
+}
+declare enum GroupName {
+    BankInvoicePaymentGroup = "bankInvoicePaymentGroup",
+    Custom201PaymentGroupPaymentGroup = "custom201PaymentGroupPaymentGroup"
+}
+declare enum PaymentSystemNameEnum {
+    BoletoBancário = "Boleto Banc\u00E1rio",
+    Free = "Free"
+}
+interface PaymentOptions {
+    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[];
+}
+interface InstallmentElement {
+    count: number;
+    hasInterestRate: boolean;
+    interestRate: number;
+    value: number;
+    total: number;
+    sellerMerchantInstallments?: InstallmentElement[];
+    id?: Id;
+}
+declare enum Id {
+    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;
+}
+declare enum Description {
+    FreePayToTestCheckoutPayments = "Free pay to test checkout payments"
+}
+declare enum Template {
+    BankInvoicePaymentGroupTemplate = "bankInvoicePaymentGroup-template",
+    Custom201PaymentGroupPaymentGroupTemplate = "custom201PaymentGroupPaymentGroup-template"
+}
+declare enum SellerName {
+    Vtex = "VTEX"
+}
+export {};

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

@@ -18,6 +18,13 @@ export declare const getClients: (options: Options, ctx: Context) => {
             portal: {
                 pagetype: (slug: string) => Promise<import("./commerce/types/Portal").PortalPagetype>;
             };
+            products: {
+                crossselling: ({ type, productId, groupByProduct }: {
+                    type: "whoboughtalsobought" | "whosawalsosaw" | "similars" | "whosawalsobought" | "accessories" | "suggestions";
+                    productId: string;
+                    groupByProduct?: boolean | undefined;
+                }) => Promise<import("./commerce/types/Product").PortalProduct[]>;
+            };
         };
         checkout: {
             simulation: (args: import("./commerce/types/Simulation").SimulationArgs, { salesChannel }?: import("./commerce/types/Simulation").SimulationOptions) => Promise<import("./commerce/types/Simulation").Simulation>;

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

@@ -1,6 +1,6 @@
-import type { QueryProductArgs, QueryAllCollectionsArgs, QueryAllProductsArgs, QuerySearchArgs, QueryCollectionArgs } from '../../../__generated__/schema';
-import type { CategoryTree } from '../clients/commerce/types/CategoryTree';
-import type { Context } from '../index';
+import type { QueryAllCollectionsArgs, QueryAllProductsArgs, QueryCollectionArgs, QueryProductArgs, QuerySearchArgs } from "../../../__generated__/schema";
+import type { CategoryTree } from "../clients/commerce/types/CategoryTree";
+import type { Context } from "../index";
 export declare const Query: {
     product: (_: unknown, { locator }: QueryProductArgs, ctx: Context) => Promise<import("../utils/enhanceSku").EnhancedSku>;
     collection: (_: unknown, { slug }: QueryCollectionArgs, ctx: Context) => Promise<import("../clients/commerce/types/Portal").CollectionPageType>;

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

@@ -2,6 +2,18 @@ export interface SelectedFacet {
     key: string;
     value: string;
 }
+export interface CrossSellingFacet {
+    key: keyof typeof FACET_CROSS_SELLING_MAP;
+    value: string;
+}
+export declare const FACET_CROSS_SELLING_MAP: {
+    readonly buy: "whoboughtalsobought";
+    readonly view: "whosawalsosaw";
+    readonly similars: "similars";
+    readonly viewAndBought: "whosawalsobought";
+    readonly accessories: "accessories";
+    readonly suggestions: "suggestions";
+};
 /**
  * Transform facets from the store to VTEX platform facets.
  * For instance, the channel in Store becomes trade-policy and regionId in VTEX's realm
@@ -14,6 +26,8 @@ export declare const transformSelectedFacet: ({ key, value }: SelectedFacet) =>
     value: string;
 };
 export declare const parseRange: (range: string) => [number, number] | null;
+export declare const isCrossSelling: (x: string) => x is "similars" | "accessories" | "suggestions" | "buy" | "view" | "viewAndBought";
+export declare const findCrossSelling: (facets?: SelectedFacet[] | null | undefined) => CrossSellingFacet | null;
 export declare const findSlug: (facets?: SelectedFacet[] | null | undefined) => string | null;
 export declare const findSkuId: (facets?: SelectedFacet[] | null | undefined) => string | null;
 export declare const findLocale: (facets?: SelectedFacet[] | null | undefined) => string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "1.9.14",
+  "version": "1.10.6",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -37,7 +37,7 @@
     "express-graphql": "^0.12.0",
     "graphql": "^15.6.0",
     "jest-transform-graphql": "^2.1.0",
-    "shared": "^1.9.14",
+    "shared": "^1.10.6",
     "ts-jest": "25.5.1",
     "tsdx": "^0.14.1",
     "tslib": "^2.3.1",
@@ -46,5 +46,5 @@
   "peerDependencies": {
     "graphql": "^15.6.0"
   },
-  "gitHead": "d37facb5b238781bb18ce48afb1b245e5c53038b"
+  "gitHead": "654744a6c3b29afacbd83c4d9ebefe4270d1ae2a"
 }

package/src/__generated__/schema.ts

@@ -341,8 +341,9 @@ export type StoreFacetRange = {
   key: Scalars['String'];
   /** Facet label. */
   label: Scalars['String'];
+  /** Maximum facet range value. */
   max: StoreFacetValueRange;
-  /** Array with information on each facet value. */
+  /** Minimum facet range value. */
   min: StoreFacetValueRange;
 };
 
@@ -367,9 +368,12 @@ export type StoreFacetValueBoolean = {
   value: Scalars['String'];
 };
 
+/** Search facet range value information. Used for minimum and maximum range values. */
 export type StoreFacetValueRange = {
   __typename?: 'StoreFacetValueRange';
+  /** Search facet range absolute value. */
   absolute: Scalars['Float'];
+  /** Search facet range selected value. */
   selected: Scalars['Float'];
 };
 

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

@@ -1,4 +1,6 @@
-import { fetchAPI } from '../fetch'
+import { FACET_CROSS_SELLING_MAP } from "../../utils/facets"
+import { fetchAPI } from "../fetch"
+import type { PortalProduct } from "./types/Product"
 import type { Context, Options } from '../../index'
 import type { Brand } from './types/Brand'
 import type { CategoryTree } from './types/CategoryTree'
@@ -13,6 +15,8 @@ import type {
 import type { Session } from './types/Session'
 import type { Channel } from '../../utils/channel'
 
+type ValueOf<T> = T extends Record<string, infer K> ? K : never;
+
 const BASE_INIT = {
   method: 'POST',
   headers: {
@@ -40,6 +44,24 @@ export const VtexCommerce = (
         pagetype: (slug: string): Promise<PortalPagetype> =>
           fetchAPI(`${base}/api/catalog_system/pub/portal/pagetype/${slug}`),
       },
+      products: {
+        crossselling: (
+          { type, productId, groupByProduct = true }: {
+            type: ValueOf<typeof FACET_CROSS_SELLING_MAP>;
+            productId: string;
+            groupByProduct?: boolean;
+          },
+        ): Promise<PortalProduct[]> => {
+          const params = new URLSearchParams({
+            sc: ctx.storage.channel.salesChannel,
+            groupByProduct: groupByProduct.toString(),
+          })
+
+          return fetchAPI(
+            `${base}/api/catalog_system/pub/products/crossselling/${type}/${productId}?${params}`,
+          )
+        },
+      },
     },
     checkout: {
       simulation: (
@@ -120,7 +142,7 @@ export const VtexCommerce = (
             ...BASE_INIT,
             body: JSON.stringify({ value }),
             method: 'PUT',
-          }
+          },
         )
       },
       region: async ({

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

@@ -0,0 +1,199 @@
+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[];
+}
+
+enum Category {
+  Office = "/Office/",
+  OfficeChairs = "/Office/Chairs/",
+}
+
+enum CategoriesId {
+  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;
+}
+
+interface Image {
+  imageId: string;
+  imageLabel: string;
+  imageTag: string;
+  imageUrl: string;
+  imageText: string;
+  imageLastModified: Date;
+}
+
+enum MeasurementUnit {
+  Un = "un",
+}
+
+interface ReferenceId {
+  key: Key;
+  value: string;
+}
+
+enum Key {
+  RefId = "RefId",
+}
+
+interface Seller {
+  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;
+}
+
+interface DeliverySlaSample {
+  deliverySlaPerTypes: unknown[];
+  region: null;
+}
+
+interface DeliverySlaSamplesPerRegion {
+  the0: DeliverySlaSample;
+}
+
+interface Installment {
+  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",
+}
+
+enum GroupName {
+  BankInvoicePaymentGroup = "bankInvoicePaymentGroup",
+  Custom201PaymentGroupPaymentGroup = "custom201PaymentGroupPaymentGroup",
+}
+
+enum PaymentSystemNameEnum {
+  BoletoBancário = "Boleto Bancário",
+  Free = "Free",
+}
+
+interface PaymentOptions {
+  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[];
+}
+
+interface InstallmentElement {
+  count: number;
+  hasInterestRate: boolean;
+  interestRate: number;
+  value: number;
+  total: number;
+  sellerMerchantInstallments?: InstallmentElement[];
+  id?: Id;
+}
+
+enum Id {
+  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;
+}
+
+enum Description {
+  FreePayToTestCheckoutPayments = "Free pay to test checkout payments",
+}
+
+enum Template {
+  BankInvoicePaymentGroupTemplate = "bankInvoicePaymentGroup-template",
+  Custom201PaymentGroupPaymentGroupTemplate =
+    "custom201PaymentGroupPaymentGroup-template",
+}
+
+enum SellerName {
+  Vtex = "VTEX",
+}

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

@@ -1,25 +1,27 @@
-import { NotFoundError, BadRequestError } from '../../errors'
-import { mutateChannelContext, mutateLocaleContext } from '../utils/contex'
-import { enhanceSku } from '../utils/enhanceSku'
+import { FACET_CROSS_SELLING_MAP } from "./../utils/facets"
+import { BadRequestError, NotFoundError } from "../../errors"
+import { mutateChannelContext, mutateLocaleContext } from "../utils/contex"
+import { enhanceSku } from "../utils/enhanceSku"
 import {
   findChannel,
+  findCrossSelling,
   findLocale,
   findSkuId,
   findSlug,
   transformSelectedFacet,
-} from '../utils/facets'
-import { SORT_MAP } from '../utils/sort'
-import { StoreCollection } from './collection'
+} from "../utils/facets"
+import { SORT_MAP } from "../utils/sort"
+import { StoreCollection } from "./collection"
 import type {
-  QueryProductArgs,
   QueryAllCollectionsArgs,
   QueryAllProductsArgs,
-  QuerySearchArgs,
   QueryCollectionArgs,
-} from '../../../__generated__/schema'
-import type { CategoryTree } from '../clients/commerce/types/CategoryTree'
-import type { Context } from '../index'
-import { isValidSkuId, pickBestSku } from '../utils/sku'
+  QueryProductArgs,
+  QuerySearchArgs,
+} from "../../../__generated__/schema"
+import type { CategoryTree } from "../clients/commerce/types/CategoryTree"
+import type { Context } from "../index"
+import { isValidSkuId, pickBestSku } from "../utils/sku"
 
 export const Query = {
   product: async (_: unknown, { locator }: QueryProductArgs, ctx: Context) => {
@@ -95,6 +97,7 @@ export const Query = {
     // Insert channel in context for later usage
     const channel = findChannel(selectedFacets)
     const locale = findLocale(selectedFacets)
+    const crossSelling = findCrossSelling(selectedFacets)
 
     if (channel) {
       mutateChannelContext(ctx, channel)
@@ -104,11 +107,33 @@ export const Query = {
       mutateLocaleContext(ctx, locale)
     }
 
+    let query = term
+
+    /**
+     * In case we are using crossSelling, we need to modify the search
+     * we will be performing on our search engine. The idea in here
+     * is to use the cross selling API for fetching the productIds our
+     * search will return for us.
+     * Doing this two request workflow makes it possible to have cross
+     * selling with Search features, like pagination, internationalization
+     * etc
+     */
+    if (crossSelling) {
+      const products = await ctx.clients.commerce.catalog.products.crossselling({
+        type: FACET_CROSS_SELLING_MAP[crossSelling.key],
+        productId: crossSelling.value,
+      })
+
+      query = `product:${
+        products.map((x) => x.productId).slice(0, first).join(";")
+      }`
+    }
+
     const after = maybeAfter ? Number(maybeAfter) : 0
     const searchArgs = {
-      page: Math.ceil(after / first!),
+      page: Math.ceil(after / first),
       count: first,
-      query: term,
+      query,
       sort: SORT_MAP[sort ?? 'score_desc'],
       selectedFacets: selectedFacets?.flatMap(transformSelectedFacet) ?? [],
     }