@faststore/api 1.12.40 → 1.12.42

package/dist/index.d.ts

@@ -148,6 +148,9 @@ export declare const getResolvers: (options: Options) => {
             totals: import("./platforms/vtex/clients/commerce/types/Simulation").Total[];
             itemMetadata: null;
         }>;
+        redirect: (_: unknown, { term, selectedFacets }: import("./__generated__/schema").QueryRedirectArgs, ctx: import("./platforms/vtex").Context) => Promise<{
+            url: string | undefined;
+        } | 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

@@ -12,6 +12,7 @@ import type { Channel } from '../../utils/channel';
 import type { SalesChannel } from './types/SalesChannel';
 import { MasterDataResponse } from './types/Newsletter';
 import type { Address, AddressInput } from './types/Address';
+import { ShippingDataBody } from './types/ShippingData';
 declare type ValueOf<T> = T extends Record<string, infer K> ? K : never;
 export declare const VtexCommerce: ({ account, environment }: Options, ctx: Context) => {
     catalog: {
@@ -37,7 +38,7 @@ export declare const VtexCommerce: ({ account, environment }: Options, ctx: Cont
         simulation: (args: SimulationArgs, { salesChannel }?: SimulationOptions) => Promise<Simulation>;
         shippingData: ({ id, body, }: {
             id: string;
-            body: unknown;
+            body: ShippingDataBody;
         }) => Promise<OrderForm>;
         orderForm: ({ id, refreshOutdatedData, channel, }: {
             id: string;

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

@@ -0,0 +1,28 @@
+export interface ShippingDataBody {
+    clearAddressIfPostalCodeNotFound?: boolean;
+    selectedAddresses?: SelectedAddress[];
+    logisticsInfo?: LogisticsInfo[];
+}
+export interface SelectedAddress {
+    addressType?: string;
+    receiverName?: string;
+    postalCode?: string | null;
+    city?: string;
+    state?: string;
+    country?: string;
+    street?: string;
+    number?: string;
+    neighborhood?: string;
+    complement?: string;
+    reference?: string;
+    geoCoordinates?: GeoCoordinates | null | [];
+}
+export interface GeoCoordinates {
+    latitude: GLfloat;
+    longitude: GLfloat;
+}
+export interface LogisticsInfo {
+    itemIndex?: number;
+    selectedDeliveryChannel?: string;
+    selectedSla?: string;
+}

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

@@ -31,7 +31,7 @@ export declare const getClients: (options: Options, ctx: Context) => {
             simulation: (args: import("./commerce/types/Simulation").SimulationArgs, { salesChannel }?: import("./commerce/types/Simulation").SimulationOptions) => Promise<import("./commerce/types/Simulation").Simulation>;
             shippingData: ({ id, body, }: {
                 id: string;
-                body: unknown;
+                body: import("./commerce/types/ShippingData").ShippingDataBody;
             }) => Promise<import("./commerce/types/OrderForm").OrderForm>;
             orderForm: ({ id, refreshOutdatedData, channel, }: {
                 id: string;

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

@@ -176,6 +176,9 @@ export declare const getResolvers: (_: Options) => {
             totals: import("./clients/commerce/types/Simulation").Total[];
             itemMetadata: null;
         }>;
+        redirect: (_: unknown, { term, selectedFacets }: import("../..").QueryRedirectArgs, ctx: Context) => Promise<{
+            url: string | undefined;
+        } | null>;
     };
     Mutation: {
         validateCart: (_: unknown, { cart: { order }, session }: import("../..").MutationValidateCartArgs, ctx: Context) => Promise<{

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

@@ -1,4 +1,4 @@
-import type { QueryAllCollectionsArgs, QueryAllProductsArgs, QueryCollectionArgs, QueryProductArgs, QuerySearchArgs, QueryShippingArgs } from "../../../__generated__/schema";
+import type { QueryAllCollectionsArgs, QueryAllProductsArgs, QueryCollectionArgs, QueryProductArgs, QuerySearchArgs, QueryShippingArgs, QueryRedirectArgs } from "../../../__generated__/schema";
 import type { CategoryTree } from "../clients/commerce/types/CategoryTree";
 import type { Context } from "../index";
 import { SearchArgs } from "../clients/search";
@@ -62,4 +62,7 @@ export declare const Query: {
         totals: import("../clients/commerce/types/Simulation").Total[];
         itemMetadata: null;
     }>;
+    redirect: (_: unknown, { term, selectedFacets }: QueryRedirectArgs, ctx: Context) => Promise<{
+        url: string | undefined;
+    } | null>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "1.12.40",
+  "version": "1.12.42",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -46,5 +46,5 @@
   "peerDependencies": {
     "graphql": "^15.6.0"
   },
-  "gitHead": "950ce98d6df648dba88bf714286798208ac2bf7c"
+  "gitHead": "65e4e781d2b4864373e4b50b37511a095c674382"
 }

package/src/__generated__/schema.ts

@@ -393,6 +393,8 @@ export type Query = {
   collection: StoreCollection;
   /** Returns the details of a product based on the specified locator. */
   product: StoreProduct;
+  /** Returns if there's a redirect for a search. */
+  redirect?: Maybe<StoreRedirect>;
   /** Returns the result of a product, facet, or suggestion search. */
   search: StoreSearchResult;
   /** Returns information about shipping simulation. */
@@ -422,6 +424,12 @@ export type QueryProductArgs = {
 };
 
 
+export type QueryRedirectArgs = {
+  selectedFacets?: Maybe<Array<IStoreSelectedFacet>>;
+  term?: Maybe<Scalars['String']>;
+};
+
+
 export type QuerySearchArgs = {
   after?: Maybe<Scalars['String']>;
   first: Scalars['Int'];
@@ -896,6 +904,16 @@ export type StorePropertyValue = {
   valueReference: Scalars['String'];
 };
 
+/**
+ * Redirect informations, including url returned by the query.
+ * https://schema.org/Thing
+ */
+export type StoreRedirect = {
+  __typename?: 'StoreRedirect';
+  /** URL to redirect */
+  url?: Maybe<Scalars['String']>;
+};
+
 /** Information of a given review. */
 export type StoreReview = {
   __typename?: 'StoreReview';

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

@@ -19,6 +19,7 @@ import { getCookie } from '../../utils/getCookies'
 import type { SalesChannel } from './types/SalesChannel'
 import { MasterDataResponse } from './types/Newsletter'
 import type { Address, AddressInput } from './types/Address'
+import { ShippingDataBody } from './types/ShippingData'
 
 type ValueOf<T> = T extends Record<string, infer K> ? K : never
 
@@ -94,8 +95,15 @@ export const VtexCommerce = (
         body,
       }: {
         id: string
-        body: unknown
+        body: ShippingDataBody
       }): Promise<OrderForm> => {
+        if (body.selectedAddresses) {
+          body.selectedAddresses.forEach((address) => {
+            if (address.geoCoordinates === null) {
+              address.geoCoordinates = [];
+            }
+          });
+        }
         return fetchAPI(
           `${base}/api/checkout/pub/orderForm/${id}/attachments/shippingData`,
           {
@@ -180,8 +188,7 @@ export const VtexCommerce = (
         salesChannel,
       }: RegionInput): Promise<Region> => {
         return fetchAPI(
-          `${base}/api/checkout/pub/regions/?postalCode=${postalCode}&country=${country}&sc=${
-            salesChannel ?? ''
+          `${base}/api/checkout/pub/regions/?postalCode=${postalCode}&country=${country}&sc=${salesChannel ?? ''
           }`
         )
       },

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

@@ -0,0 +1,31 @@
+export interface ShippingDataBody {
+    clearAddressIfPostalCodeNotFound?: boolean;
+    selectedAddresses?: SelectedAddress[];
+    logisticsInfo?: LogisticsInfo[];
+}
+
+export interface SelectedAddress {
+    addressType?: string;
+    receiverName?: string;
+    postalCode?: string | null;
+    city?: string;
+    state?: string;
+    country?: string;
+    street?: string;
+    number?: string;
+    neighborhood?: string;
+    complement?: string;
+    reference?: string;
+    geoCoordinates?: GeoCoordinates | null | [];
+}
+
+export interface GeoCoordinates {
+    latitude: GLfloat;
+    longitude: GLfloat;
+}
+
+export interface LogisticsInfo {
+    itemIndex?: number;
+    selectedDeliveryChannel?: string;
+    selectedSla?: string;
+}

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

@@ -19,6 +19,7 @@ import type {
   QueryProductArgs,
   QuerySearchArgs,
   QueryShippingArgs,
+  QueryRedirectArgs
 } from "../../../__generated__/schema"
 import type { CategoryTree } from "../clients/commerce/types/CategoryTree"
 import type { Context } from "../index"
@@ -142,9 +143,8 @@ export const Query = {
         productId: crossSelling.value,
       })
 
-      query = `product:${
-        products.map((x) => x.productId).slice(0, first).join(";")
-      }`
+      query = `product:${products.map((x) => x.productId).slice(0, first).join(";")
+        }`
     }
 
     const after = maybeAfter ? Number(maybeAfter) : 0
@@ -273,4 +273,26 @@ export const Query = {
       address,
     }
   },
+  redirect: async (
+    _: unknown,
+    { term, selectedFacets }: QueryRedirectArgs,
+    ctx: Context
+  ) => {
+    // Currently the search redirection can be done through a search term or filter (facet) so we limit the redirect query to always have one of these values otherwise we do not execute it.
+    // https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4Gd2wLQFbCwTsh8RUDwSoL?&utm_source=autocomplete
+    if (!term && (!selectedFacets || !selectedFacets.length)) {
+      return null
+    }
+
+    const { redirect } = await ctx.clients.search.products({
+      page: 1,
+      count: 1,
+      query: term ?? undefined,
+      selectedFacets: selectedFacets?.flatMap(transformSelectedFacet) ?? [],
+    })
+
+    return {
+      url: redirect
+    }
+  },
 }

package/src/typeDefs/query.graphql

@@ -282,4 +282,30 @@ type Query {
     country: String!
   ): ShippingData
     @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
+
+  """
+  Returns if there's a redirect for a search.
+  """
+  redirect(
+    """
+    Search term.
+    """
+    term: String
+    """
+    Array of selected search facets.
+    """
+    selectedFacets: [IStoreSelectedFacet!]
+  ): StoreRedirect
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
+}
+
+"""
+Redirect informations, including url returned by the query.
+https://schema.org/Thing
+"""
+type StoreRedirect {
+  """
+  URL to redirect
+  """
+  url: String
 }