@faststore/api 2.2.42 → 2.2.44

package/dist/cjs/src/typeDefs/product.graphql

@@ -0,0 +1,91 @@
+"""
+Product information. Products are variants within product groups, equivalent to VTEX [SKUs](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.
+"""
+type StoreProduct {
+  """
+  Meta tag data.
+  """
+  seo: StoreSeo!
+  """
+  List of items consisting of chain linked web pages, ending with the current page.
+  """
+  breadcrumbList: StoreBreadcrumbList!
+  """
+  Corresponding collection URL slug, with which to retrieve this entity.
+  """
+  slug: String!
+  """
+  Product name.
+  """
+  name: String!
+  """
+  Product ID, such as [ISBN](https://www.isbn-international.org/content/what-isbn) or similar global IDs.
+  """
+  productID: String!
+  """
+  Product brand.
+  """
+  brand: StoreBrand!
+  """
+  Product description.
+  """
+  description: String!
+  """
+  Array of images.
+  """
+  image: [StoreImage!]!
+  """
+  Aggregate offer information.
+  """
+  offers: StoreAggregateOffer!
+  """
+  Stock Keeping Unit. Merchant-specific ID for the product.
+  """
+  sku: String!
+  """
+  Global Trade Item Number.
+  """
+  gtin: String!
+  """
+  Array with review information.
+  """
+  review: [StoreReview!]!
+  """
+  Aggregate ratings data.
+  """
+  aggregateRating: StoreAggregateRating!
+  """
+  Indicates product group related to this product.
+  """
+  isVariantOf: StoreProductGroup!
+  """
+  Array of additional properties.
+  """
+  additionalProperty: [StorePropertyValue!]!
+  """
+  The product's release date. Formatted using https://en.wikipedia.org/wiki/ISO_8601
+  """
+  releaseDate: String!
+}
+
+"""
+Product input. Products are variants within product groups, equivalent to VTEX [SKUs](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.
+"""
+input IStoreProduct {
+  """
+  Stock Keeping Unit. Merchant-specific ID for the product.
+  """
+  sku: String!
+  """
+  Product name.
+  """
+  name: String!
+  """
+  Array of product images.
+  """
+  image: [IStoreImage!]!
+  """
+  Custom Product Additional Properties.
+  """
+  additionalProperty: [IStorePropertyValue!]
+}

package/dist/cjs/src/typeDefs/productGroup.graphql

@@ -0,0 +1,27 @@
+"""
+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.
+"""
+type StoreProductGroup {
+  """
+  Array of variants related to product group. Variants are equivalent to VTEX [SKUs](https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u#).
+  """
+  hasVariant: [StoreProduct!]!
+  """
+  Product group ID.
+  """
+  productGroupID: String!
+  """
+  Product group name.
+  """
+  name: String!
+  """
+  Array of additional properties.
+  """
+  additionalProperty: [StorePropertyValue!]!
+  """
+  Object containing data structures to facilitate handling different SKU
+  variant properties. Specially useful for implementing SKU selection 
+  components.
+  """
+  skuVariants: SkuVariants
+}

package/dist/cjs/src/typeDefs/propertyValue.graphql

@@ -0,0 +1,40 @@
+"""
+Properties that can be associated with products and products groups.
+"""
+type StorePropertyValue {
+  """
+  Property id. This propert changes according to the content of the object.
+  """
+  propertyID: String!
+  """
+  Property value. May hold a string or the string representation of an object.
+  """
+  value: ObjectOrString!
+  """
+  Property name.
+  """
+  name: String!
+  """
+  Specifies the nature of the value
+  """
+  valueReference: String!
+}
+
+input IStorePropertyValue {
+  """
+  Property id. This propert changes according to the content of the object.
+  """
+  propertyID: String
+  """
+  Property value. May hold a string or the string representation of an object.
+  """
+  value: ObjectOrString!
+  """
+  Property name.
+  """
+  name: String!
+  """
+  Specifies the nature of the value
+  """
+  valueReference: String!
+}

package/dist/cjs/src/typeDefs/query.graphql

@@ -0,0 +1,377 @@
+"""
+Each product edge contains a `node`, with product information, and a `cursor`, that can be used as a reference for pagination.
+"""
+type StoreProductEdge {
+  """
+  Each product node contains the information of a product returned by the query.
+  """
+  node: StoreProduct!
+  """
+  Product cursor. Used as pagination reference.
+  """
+  cursor: String!
+}
+
+"""
+Product connections, including pagination information and products returned by the query.
+"""
+type StoreProductConnection {
+  """
+  Product pagination information.
+  """
+  pageInfo: StorePageInfo!
+  """
+  Array with product connection edges, each containing a product and a corresponding cursor.
+  """
+  edges: [StoreProductEdge!]!
+}
+
+"""
+Each collection edge contains a `node`, with product collection information, and a `cursor`, that can be used as a reference for pagination.
+"""
+type StoreCollectionEdge {
+  """
+  Each collection node contains the information of a product collection returned by the query.
+  """
+  node: StoreCollection!
+  """
+  Collection cursor. Used as pagination reference.
+  """
+  cursor: String!
+}
+
+"""
+Collection connections, including pagination information and collections returned by the query.
+"""
+type StoreCollectionConnection {
+  """
+  Collection pagination information.
+  """
+  pageInfo: StorePageInfo!
+  """
+  Array with collection connection page edges, each containing a collection and a corresponding cursor..
+  """
+  edges: [StoreCollectionEdge!]!
+}
+
+"""
+Product search results sorting options.
+"""
+enum StoreSort {
+  """
+  Sort by price, from highest to lowest.
+  """
+  price_desc
+  """
+  Sort by price, from lowest to highest.
+  """
+  price_asc
+  """
+  Sort by orders, from highest to lowest.
+  """
+  orders_desc
+  """
+  Sort by name, in reverse alphabetical order.
+  """
+  name_desc
+  """
+  Sort by name, in alphabetical order.
+  """
+  name_asc
+  """
+  Sort by release date, from  highest to lowest.
+  """
+  release_desc
+  """
+  Sort by discount value, from highest to lowest.
+  """
+  discount_desc
+  """
+  Sort by product score, from highest to lowest.
+  """
+  score_desc
+}
+
+"""
+Selected search facet input.
+"""
+input IStoreSelectedFacet {
+  """
+  Selected search facet key.
+  """
+  key: String!
+  """
+  Selected search facet value.
+  """
+  value: String!
+}
+
+"""
+Search facet type.
+"""
+enum StoreFacetType {
+  """
+  Indicates boolean search facet.
+  """
+  BOOLEAN
+  """
+  Indicates range type search facet.
+  """
+  RANGE
+}
+
+"""
+Suggestion term.
+"""
+type StoreSuggestionTerm {
+  """
+  The term.
+  """
+  value: String!
+  """
+  Its occurrences count.
+  """
+  count: Int!
+}
+
+"""
+Suggestions information.
+"""
+type StoreSuggestions {
+  """
+  Array with suggestion terms.
+  """
+  terms: [StoreSuggestionTerm!]!
+  """
+  Array with suggestion products' information.
+  """
+  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.
+"""
+type StoreSearchResult {
+  """
+  Search result products.
+  """
+  products: StoreProductConnection!
+  """
+  Array of search result facets.
+  """
+  facets: [StoreFacet!]!
+  """
+  Search result suggestions.
+  """
+  suggestions: StoreSuggestions!
+  """
+  Search result metadata. Additional data can be used to send analytics events.
+  """
+  metadata: SearchMetadata
+}
+
+input IGeoCoordinates {
+  """
+  The latitude of the geographic coordinates.
+  """
+  latitude: Float!
+  """
+  The longitude of the geographic coordinates.
+  """
+  longitude: Float!
+}
+
+type Query {
+  """
+  Returns the details of a product based on the specified locator.
+  """
+  product(
+    """
+    An array of selected search facets.
+    """
+    locator: [IStoreSelectedFacet!]!
+  ): StoreProduct!
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
+
+  """
+  Returns the details of a collection based on the collection slug.
+  """
+  collection(
+    """
+    Collection slug.
+    """
+    slug: String!
+  ): StoreCollection!
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
+
+  """
+  Returns the result of a product, facet, or suggestion search.
+  """
+  search(
+    """
+    Search pagination argument, indicating how many results should be returned from the complete result list.
+    """
+    first: Int!
+    """
+    Search pagination argument, indicating the cursor corresponding with the item after which the results should be fetched.
+    """
+    after: String
+    """
+    Search results sorting mode.
+    """
+    sort: StoreSort = score_desc
+    """
+    Search term.
+    """
+    term: String = ""
+    """
+    Array of selected search facets.
+    """
+    selectedFacets: [IStoreSelectedFacet!]
+  ): StoreSearchResult!
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
+
+  """
+  Returns information about all products.
+  """
+  allProducts(
+    """
+    Product pagination argument, indicating how many items should be returned from the complete result list.
+    """
+    first: Int!
+    """
+    Product pagination argument, indicating the cursor corresponding with the item after which the items should be fetched.
+    """
+    after: String
+  ): StoreProductConnection!
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
+
+  """
+  Returns information about all collections.
+  """
+  allCollections(
+    """
+    Collection pagination argument, indicating how many items should be returned from the complete result list.
+    """
+    first: Int!
+    """
+    Collection pagination argument, indicating the cursor corresponding with the item after which the items should be fetched.
+    """
+    after: String
+  ): StoreCollectionConnection!
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
+
+  """
+  Returns information about shipping simulation.
+  """
+  shipping(
+    """
+    List of SKU products
+    """
+    items: [IShippingItem!]!
+    """
+    Postal code to freight calculator
+    """
+    postalCode: String!
+    """
+    Country of postal code
+    """
+    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
+
+
+  """
+  Returns a list of sellers available for a specific localization.
+  """
+  sellers(
+    """
+    Postal code input to calculate sellers
+    """
+    postalCode: String
+    """
+    Geocoordinates input to calculate sellers
+    """
+    geoCoordinates: IGeoCoordinates
+    """
+    Country of localization
+    """
+    country: String!
+    """
+    Sales channel of the navigation
+    """
+    salesChannel: String
+  ): SellersData
+    @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
+}
+
+"""
+Regionalization with sellers information.
+"""
+type SellersData {
+  """
+  Identification of region.
+  """
+  id: String
+  """
+  List of sellers.
+  """
+  sellers: [SellerInfo]
+}
+
+"""
+Information of sellers.
+"""
+type SellerInfo {
+  """
+  Identification of the seller
+  """
+  id: String
+  """
+  Name of the seller
+  """
+  name: String
+  """
+  Logo of the seller
+  """
+  logo: String
+}

package/dist/cjs/src/typeDefs/review.graphql

@@ -0,0 +1,27 @@
+"""
+Information of a given review rating.
+"""
+type StoreReviewRating {
+  """
+  Rating value.
+  """
+  ratingValue: Float!
+  """
+  Best rating value.
+  """
+  bestRating: Float!
+}
+
+"""
+Information of a given review.
+"""
+type StoreReview {
+  """
+  Review rating information.
+  """
+  reviewRating: StoreReviewRating!
+  """
+  Review author.
+  """
+  author: StoreAuthor!
+}

package/dist/cjs/src/typeDefs/seo.graphql

@@ -0,0 +1,21 @@
+"""
+Search Engine Optimization (SEO) tags data.
+"""
+type StoreSeo {
+  """
+  Title tag.
+  """
+  title: String!
+  """
+  Title template tag.
+  """
+  titleTemplate: String!
+  """
+  Description tag.
+  """
+  description: String!
+  """
+  Canonical tag.
+  """
+  canonical: String!
+}