@faststore/api 1.9.7 → 1.9.11

package/README.md

@@ -28,9 +28,11 @@ From the command line in your project directory, run yarn add `@faststore/api`.
 ```cmd
 yarn add @faststore/api
 ```
+
 ## Usage
 
-With servers like express: 
+With servers like express:
+
 ```ts
 import { execute } from 'graphql'
 import { getSchema } from '@faststore/api'
@@ -45,7 +47,7 @@ app.get('/graphql', async (req, res) => {
   const result = await execute({
     schema: await getSchema(),
     variableValues: variables,
-    operationName
+    operationName,
   })
 
   res.status(200)
@@ -54,4 +56,5 @@ app.get('/graphql', async (req, res) => {
 ```
 
 ## Docs
+
 For more information, please refer to our documentation: https://faststore.dev/reference/api/faststore-api

package/dist/__generated__/schema.d.ts

@@ -25,9 +25,9 @@ export declare type IStoreCart = {
     order: IStoreOrder;
 };
 export declare type IStoreCurrency = {
-    /** Currency code, e.g: USD */
+    /** Currency code (e.g: USD). */
     code: Scalars['String'];
-    /** Currency symbol, e.g: $ */
+    /** Currency symbol (e.g: $). */
     symbol: Scalars['String'];
 };
 /** Image input. */
@@ -50,7 +50,7 @@ export declare type IStoreOffer = {
     /** Seller responsible for the offer. */
     seller: IStoreOrganization;
 };
-/** Offer input. */
+/** Order input. */
 export declare type IStoreOrder = {
     /** Array with information on each accepted offer. */
     acceptedOffer: Array<IStoreOffer>;
@@ -94,9 +94,11 @@ export declare type IStorePropertyValue = {
     /** Specifies the nature of the value */
     valueReference: Scalars['String'];
 };
-/** Selected facet input. */
+/** Selected search facet input. */
 export declare type IStoreSelectedFacet = {
+    /** Selected search facet key. */
     key: Scalars['String'];
+    /** Selected search facet value. */
     value: Scalars['String'];
 };
 /** Session input. */
@@ -116,9 +118,9 @@ export declare type IStoreSession = {
 };
 export declare type Mutation = {
     __typename?: 'Mutation';
-    /** Returns the order if anything has changed in it, or `null` if the order is valid. */
+    /** Checks for changes between the cart presented in the UI and the cart stored in the ecommerce platform. If changes are detected, it returns the cart stored on the platform. Otherwise, it returns `null`. */
     validateCart?: Maybe<StoreCart>;
-    /** Validate session information. */
+    /** Updates a web session with the specified values. */
     validateSession?: Maybe<StoreSession>;
 };
 export declare type MutationValidateCartArgs = {
@@ -130,15 +132,15 @@ export declare type MutationValidateSessionArgs = {
 };
 export declare type Query = {
     __typename?: 'Query';
-    /** All collections query. */
+    /** Returns information about all collections. */
     allCollections: StoreCollectionConnection;
-    /** All products query. */
+    /** Returns information about all products. */
     allProducts: StoreProductConnection;
-    /** Collection query. */
+    /** Returns the details of a collection based on the collection slug. */
     collection: StoreCollection;
-    /** Product query. */
+    /** Returns the details of a product based on the specified locator. */
     product: StoreProduct;
-    /** Search query. */
+    /** Returns the result of a product, facet, or suggestion search. */
     search: StoreSearchResult;
 };
 export declare type QueryAllCollectionsArgs = {
@@ -215,7 +217,7 @@ export declare type StoreCart = {
 /** Shopping cart message. */
 export declare type StoreCartMessage = {
     __typename?: 'StoreCartMessage';
-    /** Shopping cart message status, which can be `INFO`, `WARNING` OR `ERROR`. */
+    /** Shopping cart message status, which can be `INFO`, `WARNING` or `ERROR`. */
     status: StoreStatus;
     /** Shopping cart message text. */
     text: Scalars['String'];
@@ -236,20 +238,20 @@ export declare type StoreCollection = {
     /** Collection type. */
     type: StoreCollectionType;
 };
-/** Collection connection pagination information. */
+/** Collection connections, including pagination information and collections returned by the query. */
 export declare type StoreCollectionConnection = {
     __typename?: 'StoreCollectionConnection';
-    /** Array with collection connection page edges. */
+    /** Array with collection connection page edges, each containing a collection and a corresponding cursor.. */
     edges: Array<StoreCollectionEdge>;
-    /** Collection connection page information. */
+    /** Collection pagination information. */
     pageInfo: StorePageInfo;
 };
-/** Collection pagination edge. */
+/** Each collection edge contains a `node`, with product collection information, and a `cursor`, that can be used as a reference for pagination. */
 export declare type StoreCollectionEdge = {
     __typename?: 'StoreCollectionEdge';
-    /** Collection pagination cursor. */
+    /** Collection cursor. Used as pagination reference. */
     cursor: Scalars['String'];
-    /** Collection pagination node. */
+    /** Each collection node contains the information of a product collection returned by the query. */
     node: StoreCollection;
 };
 /** Product collection facet, used for search. */
@@ -268,39 +270,55 @@ export declare type StoreCollectionMeta = {
 };
 /** Product collection type. Possible values are `Department`, `Category`, `Brand` or `Cluster`. */
 export declare const enum StoreCollectionType {
+    /** Product brand. */
     Brand = "Brand",
+    /** Second level of product categorization. */
     Category = "Category",
+    /** Product cluster. */
     Cluster = "Cluster",
+    /** First level of product categorization. */
     Department = "Department"
 }
 /** Currency information. */
 export declare type StoreCurrency = {
     __typename?: 'StoreCurrency';
-    /** Currency code, e.g: USD */
+    /** Currency code (e.g: USD). */
     code: Scalars['String'];
-    /** Currency symbol, e.g: $ */
+    /** Currency symbol (e.g: $). */
     symbol: Scalars['String'];
 };
-/** Search facet information. */
-export declare type StoreFacet = {
-    __typename?: 'StoreFacet';
+export declare type StoreFacet = StoreFacetBoolean | StoreFacetRange;
+/** Search facet boolean information. */
+export declare type StoreFacetBoolean = {
+    __typename?: 'StoreFacetBoolean';
     /** Facet key. */
     key: Scalars['String'];
     /** Facet label. */
     label: Scalars['String'];
-    /** Facet type. Possible values are `BOOLEAN` and `RANGE`. */
-    type: StoreFacetType;
     /** Array with information on each facet value. */
-    values: Array<StoreFacetValue>;
+    values: Array<StoreFacetValueBoolean>;
+};
+/** Search facet range information. */
+export declare type StoreFacetRange = {
+    __typename?: 'StoreFacetRange';
+    /** Facet key. */
+    key: Scalars['String'];
+    /** Facet label. */
+    label: Scalars['String'];
+    max: StoreFacetValueRange;
+    /** Array with information on each facet value. */
+    min: StoreFacetValueRange;
 };
 /** Search facet type. */
 export declare const enum StoreFacetType {
+    /** Indicates boolean search facet. */
     Boolean = "BOOLEAN",
+    /** Indicates range type search facet. */
     Range = "RANGE"
 }
 /** Information of a specific facet value. */
-export declare type StoreFacetValue = {
-    __typename?: 'StoreFacetValue';
+export declare type StoreFacetValueBoolean = {
+    __typename?: 'StoreFacetValueBoolean';
     /** Facet value label. */
     label: Scalars['String'];
     /** Number of items with this facet. */
@@ -310,6 +328,11 @@ export declare type StoreFacetValue = {
     /** Facet value. */
     value: Scalars['String'];
 };
+export declare type StoreFacetValueRange = {
+    __typename?: 'StoreFacetValueRange';
+    absolute: Scalars['Float'];
+    selected: Scalars['Float'];
+};
 /** Image. */
 export declare type StoreImage = {
     __typename?: 'StoreImage';
@@ -366,16 +389,16 @@ export declare type StoreOrganization = {
     /** Organization ID. */
     identifier: Scalars['String'];
 };
-/** Page information. */
+/** Whenever you make a query that allows for pagination, such as `allProducts` or `allCollections`, you can check `StorePageInfo` to learn more about the complete set of items and use it to paginate your queries. */
 export declare type StorePageInfo = {
     __typename?: 'StorePageInfo';
-    /** Page cursor end. */
+    /** Cursor corresponding to the last possible item. */
     endCursor: Scalars['String'];
-    /** Indicates whether next page exists. */
+    /** Indicates whether there is at least one more page with items after the ones returned in the current query. */
     hasNextPage: Scalars['Boolean'];
-    /** Indicates whether previous page exists. */
+    /** Indicates whether there is at least one more page with items before the ones returned in the current query. */
     hasPreviousPage: Scalars['Boolean'];
-    /** Page cursor start. */
+    /** Cursor corresponding to the first possible item. */
     startCursor: Scalars['String'];
     /** Total number of items (products or collections), not pages. */
     totalCount: Scalars['Int'];
@@ -426,20 +449,20 @@ export declare type StoreProduct = {
     /** Corresponding collection URL slug, with which to retrieve this entity. */
     slug: Scalars['String'];
 };
-/** Product connection pagination information. */
+/** Product connections, including pagination information and products returned by the query. */
 export declare type StoreProductConnection = {
     __typename?: 'StoreProductConnection';
-    /** Array with product connection page edges. */
+    /** Array with product connection edges, each containing a product and a corresponding cursor. */
     edges: Array<StoreProductEdge>;
-    /** Product connection page information. */
+    /** Product pagination information. */
     pageInfo: StorePageInfo;
 };
-/** Product pagination edge. */
+/** Each product edge contains a `node`, with product information, and a `cursor`, that can be used as a reference for pagination. */
 export declare type StoreProductEdge = {
     __typename?: 'StoreProductEdge';
-    /** Product pagination cursor. */
+    /** Product cursor. Used as pagination reference. */
     cursor: Scalars['String'];
-    /** Product pagination node. */
+    /** Each product node contains the information of a product returned by the query. */
     node: StoreProduct;
 };
 /** Product group information. Product groups are catalog entities that may contain variants. They are equivalent to VTEX [Products](https://help.vtex.com/en/tutorial/what-is-a-product--2zrB2gFCHyQokCKKE8kuAw#), whereas each variant is equivalent to a VTEX [SKU](https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u#). For example, you may have a **Shirt** product group with associated products such as **Blue shirt size L**, **Green shirt size XL** and so on. */
@@ -520,18 +543,26 @@ export declare type StoreSession = {
     /** Session postal code. */
     postalCode?: Maybe<Scalars['String']>;
 };
-/** Product sorting options used in search. */
+/** Product search results sorting options. */
 export declare const enum StoreSort {
+    /** Sort by discount value, from highest to lowest. */
     DiscountDesc = "discount_desc",
+    /** Sort by name, in alphabetical order. */
     NameAsc = "name_asc",
+    /** Sort by name, in reverse alphabetical order. */
     NameDesc = "name_desc",
+    /** Sort by orders, from highest to lowest. */
     OrdersDesc = "orders_desc",
+    /** Sort by price, from lowest to highest. */
     PriceAsc = "price_asc",
+    /** Sort by price, from highest to lowest. */
     PriceDesc = "price_desc",
+    /** Sort by release date, from  highest to lowest. */
     ReleaseDesc = "release_desc",
+    /** Sort by product score, from highest to lowest. */
     ScoreDesc = "score_desc"
 }
-/** Status used to indicate type of message. For instance, in shopping cart messages. */
+/** Status used to indicate a message type. For instance, a shopping cart informative or error message. */
 export declare const enum StoreStatus {
     Error = "ERROR",
     Info = "INFO",