@faststore/api 1.12.32 → 1.12.36

package/dist/index.d.ts

@@ -71,26 +71,29 @@ export declare const getResolvers: (options: Options) => {
     } & {
         attachmentsValues?: import("./platforms/vtex/clients/commerce/types/OrderForm").Attachment[] | undefined;
     }, unknown, any>>;
-    StoreSearchResult: Record<string, import("./platforms/vtex").Resolver<Pick<import("./platforms/vtex/clients/search").SearchArgs, "sort" | "selectedFacets" | "hideUnavailableItems" | "query" | "page" | "count" | "fuzzy">, unknown, any>>;
+    StoreSearchResult: Record<string, import("./platforms/vtex").Resolver<{
+        searchArgs: Pick<import("./platforms/vtex/clients/search").SearchArgs, "sort" | "selectedFacets" | "hideUnavailableItems" | "query" | "page" | "count" | "fuzzy">;
+        productSearchPromise: Promise<import("./platforms/vtex/clients/search/types/ProductSearchResult").ProductSearchResult>;
+    }, unknown, any>>;
     StorePropertyValue: Record<string, import("./platforms/vtex").Resolver<import("./__generated__/schema").IStorePropertyValue, unknown, any>>;
     SkuVariants: Record<string, import("./platforms/vtex").Resolver<import("./platforms/vtex/clients/search/types/ProductSearchResult").Item & {
         isVariantOf: import("./platforms/vtex/clients/search/types/ProductSearchResult").Product;
     } & {
         attachmentsValues?: import("./platforms/vtex/clients/commerce/types/OrderForm").Attachment[] | undefined;
     }, unknown, any>>;
+    ShippingSLA: Record<string, import("./platforms/vtex").Resolver<{
+        name?: string | undefined;
+        friendlyName?: string | undefined;
+        price?: number | undefined;
+        shippingEstimate?: string | undefined;
+    }, unknown, any>>;
     ObjectOrString: import("graphql").GraphQLScalarType;
     Query: {
         product: (_: unknown, { locator }: import("./__generated__/schema").QueryProductArgs, ctx: import("./platforms/vtex").Context) => Promise<import("./platforms/vtex/utils/enhanceSku").EnhancedSku>;
         collection: (_: unknown, { slug }: import("./__generated__/schema").QueryCollectionArgs, ctx: import("./platforms/vtex").Context) => Promise<import("./platforms/vtex/clients/commerce/types/Portal").CollectionPageType>;
         search: (_: unknown, { first, after: maybeAfter, sort, term, selectedFacets }: import("./__generated__/schema").QuerySearchArgs, ctx: import("./platforms/vtex").Context) => Promise<{
-            page: number;
-            count: number;
-            query: string | null | undefined;
-            sort: import("./platforms/vtex/clients/search").Sort;
-            selectedFacets: {
-                key: string;
-                value: string;
-            }[];
+            searchArgs: Pick<import("./platforms/vtex/clients/search").SearchArgs, "sort" | "selectedFacets" | "hideUnavailableItems" | "query" | "page" | "count" | "fuzzy">;
+            productSearchPromise: Promise<import("./platforms/vtex/clients/search/types/ProductSearchResult").ProductSearchResult>;
         }>;
         allProducts: (_: unknown, { first, after: maybeAfter }: import("./__generated__/schema").QueryAllProductsArgs, ctx: import("./platforms/vtex").Context) => Promise<{
             pageInfo: {
@@ -128,6 +131,23 @@ export declare const getResolvers: (options: Options) => {
                 cursor: string;
             }[];
         }>;
+        shipping: (_: unknown, { country, items, postalCode }: import("./__generated__/schema").QueryShippingArgs, ctx: import("./platforms/vtex").Context) => Promise<{
+            address: import("./platforms/vtex/clients/commerce/types/Address").Address;
+            items: import("./platforms/vtex/clients/commerce/types/Simulation").Item[];
+            ratesAndBenefitsData: import("./platforms/vtex/clients/commerce/types/Simulation").RatesAndBenefitsData;
+            paymentData: import("./platforms/vtex/clients/commerce/types/Simulation").PaymentData;
+            selectableGifts: any[];
+            marketingData: import("./platforms/vtex/clients/commerce/types/Simulation").MarketingData;
+            postalCode: null;
+            country: null;
+            logisticsInfo: import("./platforms/vtex/clients/commerce/types/Simulation").LogisticsInfo[];
+            messages: any[];
+            purchaseConditions: import("./platforms/vtex/clients/commerce/types/Simulation").PurchaseConditions;
+            pickupPoints: any[];
+            subscriptionData: null;
+            totals: import("./platforms/vtex/clients/commerce/types/Simulation").Total[];
+            itemMetadata: null;
+        }>;
     };
     Mutation: {
         validateCart: (_: unknown, { cart: { order }, session }: import("./__generated__/schema").MutationValidateCartArgs, ctx: import("./platforms/vtex").Context) => Promise<{

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

@@ -11,6 +11,7 @@ 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 { Address, AddressInput } from './types/Address';
 declare type ValueOf<T> = T extends Record<string, infer K> ? K : never;
 export declare const VtexCommerce: ({ account, environment }: Options, ctx: Context) => {
     catalog: {
@@ -56,6 +57,7 @@ export declare const VtexCommerce: ({ account, environment }: Options, ctx: Cont
             value: string;
         }) => Promise<OrderForm>;
         region: ({ postalCode, country, salesChannel, }: RegionInput) => Promise<Region>;
+        address: ({ postalCode, country, }: AddressInput) => Promise<Address>;
     };
     session: (search: string) => Promise<Session>;
     subscribeToNewsletter: (data: {

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

@@ -0,0 +1,16 @@
+export interface AddressInput {
+    postalCode: string;
+    country: string;
+}
+export interface Address {
+    postalCode: string;
+    city: string;
+    state: string;
+    country: string;
+    street: string;
+    number: string;
+    neighborhood: string;
+    complement: string;
+    reference: string;
+    geoCoordinates: [number];
+}

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

@@ -1,4 +1,4 @@
-export interface PayloadItem {
+export interface ShippingItem {
     id: string;
     quantity: number;
     seller: string;
@@ -12,7 +12,7 @@ export interface ShippingData {
 }
 export interface SimulationArgs {
     country?: string;
-    items: PayloadItem[];
+    items: ShippingItem[];
     postalCode?: string;
     isCheckedIn?: boolean;
     priceTables?: string[];

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

@@ -51,6 +51,7 @@ export declare const getClients: (options: Options, ctx: Context) => {
                 value: string;
             }) => Promise<import("./commerce/types/OrderForm").OrderForm>;
             region: ({ postalCode, country, salesChannel, }: import("./commerce/types/Region").RegionInput) => Promise<import("./commerce/types/Region").Region>;
+            address: ({ postalCode, country, }: import("./commerce/types/Address").AddressInput) => Promise<import("./commerce/types/Address").Address>;
         };
         session: (search: string) => Promise<import("./commerce/types/Session").Session>;
         subscribeToNewsletter: (data: {

package/dist/platforms/vtex/clients/search/types/ProductSearchResult.d.ts

@@ -12,6 +12,7 @@ export interface ProductSearchResult {
     query: string;
     operator: 'and' | 'or';
     fuzzy: string;
+    redirect?: string;
     correction?: Correction;
 }
 interface Correction {

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

@@ -99,26 +99,29 @@ export declare const getResolvers: (_: Options) => {
     } & {
         attachmentsValues?: import("./clients/commerce/types/OrderForm").Attachment[] | undefined;
     }, unknown, any>>;
-    StoreSearchResult: Record<string, Resolver<Pick<SearchArgs, "hideUnavailableItems" | "query" | "page" | "count" | "sort" | "selectedFacets" | "fuzzy">, unknown, any>>;
+    StoreSearchResult: Record<string, Resolver<{
+        searchArgs: Pick<SearchArgs, "hideUnavailableItems" | "query" | "page" | "count" | "sort" | "selectedFacets" | "fuzzy">;
+        productSearchPromise: Promise<import("./clients/search/types/ProductSearchResult").ProductSearchResult>;
+    }, unknown, any>>;
     StorePropertyValue: Record<string, Resolver<import("../..").IStorePropertyValue, unknown, any>>;
     SkuVariants: Record<string, Resolver<import("./clients/search/types/ProductSearchResult").Item & {
         isVariantOf: import("./clients/search/types/ProductSearchResult").Product;
     } & {
         attachmentsValues?: import("./clients/commerce/types/OrderForm").Attachment[] | undefined;
     }, unknown, any>>;
+    ShippingSLA: Record<string, Resolver<{
+        name?: string | undefined;
+        friendlyName?: string | undefined;
+        price?: number | undefined;
+        shippingEstimate?: string | undefined;
+    }, unknown, any>>;
     ObjectOrString: import("graphql").GraphQLScalarType;
     Query: {
         product: (_: unknown, { locator }: import("../..").QueryProductArgs, ctx: Context) => Promise<import("./utils/enhanceSku").EnhancedSku>;
         collection: (_: unknown, { slug }: import("../..").QueryCollectionArgs, ctx: Context) => Promise<import("./clients/commerce/types/Portal").CollectionPageType>;
         search: (_: unknown, { first, after: maybeAfter, sort, term, selectedFacets }: import("../..").QuerySearchArgs, ctx: Context) => Promise<{
-            page: number;
-            count: number;
-            query: string | null | undefined;
-            sort: import("./clients/search").Sort;
-            selectedFacets: {
-                key: string;
-                value: string;
-            }[];
+            searchArgs: Pick<SearchArgs, "hideUnavailableItems" | "query" | "page" | "count" | "sort" | "selectedFacets" | "fuzzy">;
+            productSearchPromise: Promise<import("./clients/search/types/ProductSearchResult").ProductSearchResult>;
         }>;
         allProducts: (_: unknown, { first, after: maybeAfter }: import("../..").QueryAllProductsArgs, ctx: Context) => Promise<{
             pageInfo: {
@@ -156,6 +159,23 @@ export declare const getResolvers: (_: Options) => {
                 cursor: string;
             }[];
         }>;
+        shipping: (_: unknown, { country, items, postalCode }: import("../..").QueryShippingArgs, ctx: Context) => Promise<{
+            address: import("./clients/commerce/types/Address").Address;
+            items: import("./clients/commerce/types/Simulation").Item[];
+            ratesAndBenefitsData: import("./clients/commerce/types/Simulation").RatesAndBenefitsData;
+            paymentData: import("./clients/commerce/types/Simulation").PaymentData;
+            selectableGifts: any[];
+            marketingData: import("./clients/commerce/types/Simulation").MarketingData;
+            postalCode: null;
+            country: null;
+            logisticsInfo: import("./clients/commerce/types/Simulation").LogisticsInfo[];
+            messages: any[];
+            purchaseConditions: import("./clients/commerce/types/Simulation").PurchaseConditions;
+            pickupPoints: any[];
+            subscriptionData: null;
+            totals: import("./clients/commerce/types/Simulation").Total[];
+            itemMetadata: null;
+        }>;
     };
     Mutation: {
         validateCart: (_: unknown, { cart: { order }, session }: import("../..").MutationValidateCartArgs, ctx: Context) => Promise<{

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

@@ -2,7 +2,7 @@ import type { Context, Options } from '..';
 export declare type Loaders = ReturnType<typeof getLoaders>;
 export declare const getLoaders: (options: Options, { clients }: Context) => {
     skuLoader: import("dataloader")<string, import("../utils/enhanceSku").EnhancedSku, string>;
-    simulationLoader: import("dataloader")<import("../clients/commerce/types/Simulation").PayloadItem[], import("../clients/commerce/types/Simulation").Simulation, import("../clients/commerce/types/Simulation").PayloadItem[]>;
+    simulationLoader: import("dataloader")<import("../clients/commerce/types/Simulation").SimulationArgs, import("../clients/commerce/types/Simulation").Simulation, import("../clients/commerce/types/Simulation").SimulationArgs>;
     collectionLoader: import("dataloader")<string, import("../clients/commerce/types/Portal").CollectionPageType, string>;
     salesChannelLoader: import("dataloader")<string, import("../clients/commerce/types/SalesChannel").SalesChannel, string>;
 };

package/dist/platforms/vtex/loaders/simulation.d.ts

@@ -1,5 +1,5 @@
 import DataLoader from 'dataloader';
-import type { PayloadItem, Simulation } from '../clients/commerce/types/Simulation';
 import type { Options } from '..';
 import type { Clients } from '../clients';
-export declare const getSimulationLoader: (_: Options, clients: Clients) => DataLoader<PayloadItem[], Simulation, PayloadItem[]>;
+import type { Simulation, SimulationArgs } from '../clients/commerce/types/Simulation';
+export declare const getSimulationLoader: (_: Options, clients: Clients) => DataLoader<SimulationArgs, Simulation, SimulationArgs>;

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

@@ -1,18 +1,13 @@
-import type { QueryAllCollectionsArgs, QueryAllProductsArgs, QueryCollectionArgs, QueryProductArgs, QuerySearchArgs } from "../../../__generated__/schema";
+import type { QueryAllCollectionsArgs, QueryAllProductsArgs, QueryCollectionArgs, QueryProductArgs, QuerySearchArgs, QueryShippingArgs } from "../../../__generated__/schema";
 import type { CategoryTree } from "../clients/commerce/types/CategoryTree";
 import type { Context } from "../index";
+import { SearchArgs } from "../clients/search";
 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>;
     search: (_: unknown, { first, after: maybeAfter, sort, term, selectedFacets }: QuerySearchArgs, ctx: Context) => Promise<{
-        page: number;
-        count: number;
-        query: string | null | undefined;
-        sort: import("../clients/search").Sort;
-        selectedFacets: {
-            key: string;
-            value: string;
-        }[];
+        searchArgs: Pick<SearchArgs, "sort" | "selectedFacets" | "hideUnavailableItems" | "query" | "page" | "count" | "fuzzy">;
+        productSearchPromise: Promise<import("../clients/search/types/ProductSearchResult").ProductSearchResult>;
     }>;
     allProducts: (_: unknown, { first, after: maybeAfter }: QueryAllProductsArgs, ctx: Context) => Promise<{
         pageInfo: {
@@ -50,4 +45,21 @@ export declare const Query: {
             cursor: string;
         }[];
     }>;
+    shipping: (_: unknown, { country, items, postalCode }: QueryShippingArgs, ctx: Context) => Promise<{
+        address: import("../clients/commerce/types/Address").Address;
+        items: import("../clients/commerce/types/Simulation").Item[];
+        ratesAndBenefitsData: import("../clients/commerce/types/Simulation").RatesAndBenefitsData;
+        paymentData: import("../clients/commerce/types/Simulation").PaymentData;
+        selectableGifts: any[];
+        marketingData: import("../clients/commerce/types/Simulation").MarketingData;
+        postalCode: null;
+        country: null;
+        logisticsInfo: import("../clients/commerce/types/Simulation").LogisticsInfo[];
+        messages: any[];
+        purchaseConditions: import("../clients/commerce/types/Simulation").PurchaseConditions;
+        pickupPoints: any[];
+        subscriptionData: null;
+        totals: import("../clients/commerce/types/Simulation").Total[];
+        itemMetadata: null;
+    }>;
 };

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

@@ -1,5 +1,9 @@
 import type { Resolver } from '..';
 import type { SearchArgs } from '../clients/search';
-declare type Root = Omit<SearchArgs, 'type'>;
+import { ProductSearchResult } from '../clients/search/types/ProductSearchResult';
+declare type Root = {
+    searchArgs: Omit<SearchArgs, 'type'>;
+    productSearchPromise: Promise<ProductSearchResult>;
+};
 export declare const StoreSearchResult: Record<string, Resolver<Root>>;
 export {};

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

@@ -0,0 +1,14 @@
+import type { Resolver } from '..';
+/**
+ * Transforms estimate (e.g 3bd) into friendly format (e.g Up to 3 business days)
+ * based on https://github.com/vtex-apps/shipping-estimate-translator/blob/13e17055d6353dd3f3f4c31bae77ab049002809b/messages/en.json
+ */
+export declare const getLocalizedEstimates: (estimate: string) => string;
+declare type Root = {
+    name?: string;
+    friendlyName?: string;
+    price?: number;
+    shippingEstimate?: string;
+};
+export declare const ShippingSLA: Record<string, Resolver<Root>>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "1.12.32",
+  "version": "1.12.36",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -30,7 +30,7 @@
     "p-limit": "^3.1.0"
   },
   "devDependencies": {
-    "@faststore/shared": "^1.12.32",
+    "@faststore/shared": "^1.12.35",
     "@graphql-codegen/cli": "2.2.0",
     "@graphql-codegen/typescript": "2.2.2",
     "concurrently": "^6.2.1",
@@ -45,6 +45,5 @@
   },
   "peerDependencies": {
     "graphql": "^15.6.0"
-  },
-  "gitHead": "9deb68d7b10560726e2f50841d319590a7249392"
+  }
 }

package/src/__generated__/schema.ts

@@ -435,6 +435,15 @@ export type QueryShippingArgs = {
   postalCode: Scalars['String'];
 };
 
+/** Search result. */
+export type SearchMetadata = {
+  __typename?: 'SearchMetadata';
+  /** Indicates if the search term was misspelled. */
+  isTermMisspelled: Scalars['Boolean'];
+  /** Logical operator used to run the search. */
+  logicalOperator: Scalars['String'];
+};
+
 /** Shipping Simulation information. */
 export type ShippingData = {
   __typename?: 'ShippingData';
@@ -908,6 +917,8 @@ export type StoreSearchResult = {
   __typename?: 'StoreSearchResult';
   /** Array of search result facets. */
   facets: Array<StoreFacet>;
+  /** Search result metadata. Additional data can be used to send analytics events. */
+  metadata?: Maybe<SearchMetadata>;
   /** Search result products. */
   products: StoreProductConnection;
   /** Search result suggestions. */

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

@@ -12,6 +12,7 @@ export interface ProductSearchResult {
   query: string
   operator: 'and' | 'or'
   fuzzy: string
+  redirect?: string
   correction?: Correction
 }
 

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

@@ -23,6 +23,7 @@ import type {
 import type { CategoryTree } from "../clients/commerce/types/CategoryTree"
 import type { Context } from "../index"
 import { isValidSkuId, pickBestSku } from "../utils/sku"
+import { SearchArgs } from "../clients/search"
 
 export const Query = {
   product: async (_: unknown, { locator }: QueryProductArgs, ctx: Context) => {
@@ -147,15 +148,17 @@ export const Query = {
     }
 
     const after = maybeAfter ? Number(maybeAfter) : 0
-    const searchArgs = {
+    const searchArgs: Omit<SearchArgs, 'type'> = {
       page: Math.ceil(after / first),
       count: first,
-      query,
+      query: query ?? undefined,
       sort: SORT_MAP[sort ?? 'score_desc'],
       selectedFacets: selectedFacets?.flatMap(transformSelectedFacet) ?? [],
     }
 
-    return searchArgs
+    const productSearchPromise = ctx.clients.search.products(searchArgs)
+
+    return { searchArgs, productSearchPromise }
   },
   allProducts: async (
     _: unknown,

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

@@ -2,17 +2,23 @@ import { enhanceSku } from '../utils/enhanceSku'
 import type { Resolver } from '..'
 import type { SearchArgs } from '../clients/search'
 import type { Facet } from '../clients/search/types/FacetSearchResult'
+import { ProductSearchResult } from '../clients/search/types/ProductSearchResult'
 
-type Root = Omit<SearchArgs, 'type'>
+type Root = {
+  searchArgs: Omit<SearchArgs, 'type'>
+  productSearchPromise: Promise<ProductSearchResult>
+}
 
 const isRootFacet = (facet: Facet) => facet.key === 'category-1'
 
 export const StoreSearchResult: Record<string, Resolver<Root>> = {
-  suggestions: async (searchArgs, _, ctx) => {
+  suggestions: async (root, _, ctx) => {
     const {
       clients: { search },
     } = ctx
 
+    const { searchArgs } = root
+
     // If there's no search query, suggest the most popular searches.
     if (!searchArgs.query) {
       const topSearches = await search.topSearches()
@@ -26,10 +32,13 @@ export const StoreSearchResult: Record<string, Resolver<Root>> = {
       }
     }
 
-    const terms = await search.suggestedTerms(searchArgs)
-    const products = await search.products(searchArgs)
+    const { productSearchPromise } = root
+    const [terms, productSearchResult] = await Promise.all([
+      search.suggestedTerms(searchArgs),
+      productSearchPromise,
+    ])
 
-    const skus = products.products
+    const skus = productSearchResult.products
       .map((product) => {
         const [maybeSku] = product.items
 
@@ -44,27 +53,10 @@ export const StoreSearchResult: Record<string, Resolver<Root>> = {
       products: skus,
     }
   },
-  products: async (searchArgs, _, ctx) => {
-    const {
-      clients: { search, sp },
-    } = ctx
+  products: async ({ productSearchPromise }) => {
+    const productSearchResult = await productSearchPromise
 
-    const products = await search.products(searchArgs)
-
-    // Raise event on search's analytics API when performing
-    // a full text search.
-    if (searchArgs.query) {
-      sp.sendEvent({
-        type: 'search.query',
-        text: searchArgs.query,
-        misspelled: products.correction?.misspelled ?? false,
-        match: products.recordsFiltered,
-        operator: products.operator,
-        locale: ctx.storage.locale,
-      }).catch(console.error)
-    }
-
-    const skus = products.products
+    const skus = productSearchResult.products
       .map((product) => {
         const [maybeSku] = product.items
 
@@ -74,11 +66,11 @@ export const StoreSearchResult: Record<string, Resolver<Root>> = {
 
     return {
       pageInfo: {
-        hasNextPage: products.pagination.after.length > 0,
-        hasPreviousPage: products.pagination.before.length > 0,
+        hasNextPage: productSearchResult.pagination.after.length > 0,
+        hasPreviousPage: productSearchResult.pagination.before.length > 0,
         startCursor: '0',
-        endCursor: products.recordsFiltered.toString(),
-        totalCount: products.recordsFiltered,
+        endCursor: productSearchResult.recordsFiltered.toString(),
+        totalCount: productSearchResult.recordsFiltered,
       },
       edges: skus.map((sku, index) => ({
         node: sku,
@@ -86,7 +78,7 @@ export const StoreSearchResult: Record<string, Resolver<Root>> = {
       })),
     }
   },
-  facets: async (searchArgs, _, ctx) => {
+  facets: async ({ searchArgs }, _, ctx) => {
     const {
       clients: { search: is },
     } = ctx
@@ -103,4 +95,16 @@ export const StoreSearchResult: Record<string, Resolver<Root>> = {
 
     return filteredFacets
   },
+  metadata: async ({ searchArgs, productSearchPromise }) => {
+    if (!searchArgs.query) {
+      return null
+    }
+
+    const productSearchResult = await productSearchPromise
+
+    return {
+      isTermMisspelled: productSearchResult.correction?.misspelled ?? false,
+      logicalOperator: productSearchResult.operator,
+    }
+  },
 }

package/src/typeDefs/query.graphql

@@ -148,6 +148,20 @@ type StoreSuggestions {
   products: [StoreProduct!]!
 }
 
+"""
+Search result.
+"""
+type SearchMetadata {
+  """
+  Indicates if the search term was misspelled.
+  """
+  isTermMisspelled: Boolean!
+  """
+  Logical operator used to run the search.
+  """
+  logicalOperator: String!
+}
+
 """
 Search result.
 """
@@ -164,6 +178,10 @@ type StoreSearchResult {
   Search result suggestions.
   """
   suggestions: StoreSuggestions!
+  """
+  Search result metadata. Additional data can be used to send analytics events.
+  """
+  metadata: SearchMetadata
 }
 
 type Query {