@faststore/api 1.12.39 → 1.12.41

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

@@ -44,11 +44,12 @@ export declare const VtexCommerce: ({ account, environment }: Options, ctx: Cont
             refreshOutdatedData?: boolean | undefined;
             channel?: Required<Channel> | undefined;
         }) => Promise<OrderForm>;
-        updateOrderFormItems: ({ id, orderItems, allowOutdatedData, salesChannel, }: {
+        updateOrderFormItems: ({ id, orderItems, allowOutdatedData, salesChannel, shouldSplitItem, }: {
             id: string;
             orderItems: OrderFormInputItem[];
             allowOutdatedData?: "paymentData" | undefined;
             salesChannel?: string | undefined;
+            shouldSplitItem?: boolean | null | undefined;
         }) => Promise<OrderForm>;
         setCustomData: ({ id, appId, key, value, }: {
             id: string;

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

@@ -38,11 +38,12 @@ export declare const getClients: (options: Options, ctx: Context) => {
                 refreshOutdatedData?: boolean | undefined;
                 channel?: Required<import("../utils/channel").Channel> | undefined;
             }) => Promise<import("./commerce/types/OrderForm").OrderForm>;
-            updateOrderFormItems: ({ id, orderItems, allowOutdatedData, salesChannel, }: {
+            updateOrderFormItems: ({ id, orderItems, allowOutdatedData, salesChannel, shouldSplitItem, }: {
                 id: string;
                 orderItems: import("./commerce/types/OrderForm").OrderFormInputItem[];
                 allowOutdatedData?: "paymentData" | undefined;
                 salesChannel?: string | undefined;
+                shouldSplitItem?: boolean | null | undefined;
             }) => Promise<import("./commerce/types/OrderForm").OrderForm>;
             setCustomData: ({ id, appId, key, value, }: {
                 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.39",
+  "version": "1.12.41",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -46,5 +46,5 @@
   "peerDependencies": {
     "graphql": "^15.6.0"
   },
-  "gitHead": "872ef5ad4ff1db650a89222f96ed7073434da66c"
+  "gitHead": "bacc379647f54158cbb23b2056f892962a42af0c"
 }

package/src/__generated__/schema.ts

@@ -133,7 +133,7 @@ export type IShippingItem = {
 
 /** Shopping cart input. */
 export type IStoreCart = {
-  /** Order information, including `orderNumber` and `acceptedOffer`. */
+  /** Order information, including `orderNumber`, `acceptedOffer` and `shouldSplitItem`. */
   order: IStoreOrder;
 };
 
@@ -172,6 +172,8 @@ export type IStoreOrder = {
   acceptedOffer: Array<IStoreOffer>;
   /** ID of the order in [VTEX order management](https://help.vtex.com/en/tutorial/license-manager-resources-oms--60QcBsvWeum02cFi3GjBzg#). */
   orderNumber: Scalars['String'];
+  /** Indicates whether or not items with attachments should be split. */
+  shouldSplitItem?: Maybe<Scalars['Boolean']>;
 };
 
 /** Organization input. */
@@ -391,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. */
@@ -420,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'];
@@ -894,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

@@ -129,11 +129,13 @@ export const VtexCommerce = (
         orderItems,
         allowOutdatedData = 'paymentData',
         salesChannel = ctx.storage.channel.salesChannel,
+        shouldSplitItem = true,
       }: {
         id: string
         orderItems: OrderFormInputItem[]
         allowOutdatedData?: 'paymentData'
         salesChannel?: string
+        shouldSplitItem?: boolean | null
       }): Promise<OrderForm> => {
         const params = new URLSearchParams({
           allowOutdatedData,
@@ -144,7 +146,10 @@ export const VtexCommerce = (
           `${base}/api/checkout/pub/orderForm/${id}/items?${params}`,
           {
             ...BASE_INIT,
-            body: JSON.stringify({ orderItems }),
+            body: JSON.stringify({
+              orderItems,
+              noSplitItem: !shouldSplitItem,
+            }),
             method: 'PATCH',
           }
         )

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/platforms/vtex/resolvers/validateCart.ts

@@ -266,7 +266,7 @@ export const validateCart = async (
   { cart: { order }, session }: MutationValidateCartArgs,
   ctx: Context
 ) => {
-  const { orderNumber: orderNumberFromCart, acceptedOffer } = order
+  const { orderNumber:  orderNumberFromCart, acceptedOffer, shouldSplitItem } = order
   const {
     clients: { commerce },
     loaders: { skuLoader },
@@ -363,6 +363,7 @@ export const validateCart = async (
     .updateOrderFormItems({
       id: orderForm.orderFormId,
       orderItems: changes,
+      shouldSplitItem,
     })
     // update orderForm etag so we know last time we touched this orderForm
     .then((form) =>

package/src/typeDefs/cart.graphql

@@ -31,7 +31,7 @@ Shopping cart input.
 """
 input IStoreCart {
   """
-  Order information, including `orderNumber` and `acceptedOffer`.
+  Order information, including `orderNumber`, `acceptedOffer` and `shouldSplitItem`.
   """
   order: IStoreOrder!
 }

package/src/typeDefs/order.graphql

@@ -24,4 +24,8 @@ input IStoreOrder {
   Array with information on each accepted offer.
   """
   acceptedOffer: [IStoreOffer!]!
+  """
+  Indicates whether or not items with attachments should be split.
+  """
+  shouldSplitItem: Boolean
 }

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
 }