@faststore/api 2.2.42 → 2.2.44

package/dist/esm/src/typeDefs/facet.graphql

@@ -0,0 +1,77 @@
+union StoreFacet = StoreFacetRange | StoreFacetBoolean
+
+"""
+Search facet range information.
+"""
+type StoreFacetRange {
+  """
+  Facet key.
+  """
+  key: String!
+  """
+  Facet label.
+  """
+  label: String!
+  """
+  Minimum facet range value.
+  """
+  min: StoreFacetValueRange!
+  """
+  Maximum facet range value.
+  """
+  max: StoreFacetValueRange!
+}
+
+"""
+Search facet boolean information.
+"""
+type StoreFacetBoolean {
+  """
+  Facet key.
+  """
+  key: String!
+  """
+  Facet label.
+  """
+  label: String!
+  """
+  Array with information on each facet value.
+  """
+  values: [StoreFacetValueBoolean!]!
+}
+
+"""
+Search facet range value information. Used for minimum and maximum range values.
+"""
+type StoreFacetValueRange {
+  """
+  Search facet range absolute value.
+  """
+  absolute: Float!
+  """
+  Search facet range selected value.
+  """
+  selected: Float!
+}
+
+"""
+Information of a specific facet value.
+"""
+type StoreFacetValueBoolean {
+  """
+  Facet value.
+  """
+  value: String!
+  """
+  Facet value label.
+  """
+  label: String!
+  """
+  Indicates whether facet is selected.
+  """
+  selected: Boolean!
+  """
+  Number of items with this facet.
+  """
+  quantity: Int!
+}

package/dist/esm/src/typeDefs/image.graphql

@@ -0,0 +1,27 @@
+"""
+Image.
+"""
+type StoreImage {
+  """
+  Image URL.
+  """
+  url: String!
+  """
+  Alias for the image.
+  """
+  alternateName: String!
+}
+
+"""
+Image input.
+"""
+input IStoreImage {
+  """
+  Image input URL.
+  """
+  url: String!
+  """
+  Alias for the input image.
+  """
+  alternateName: String!
+}

package/dist/esm/src/typeDefs/index.d.ts

@@ -0,0 +1 @@
+export declare const typeDefs: string;

package/dist/esm/src/typeDefs/index.js

@@ -0,0 +1,7 @@
+import { print } from 'graphql';
+import { loadFilesSync } from '@graphql-tools/load-files';
+// Empty string ('') is interpreted as the current dir. Referencing it as './' won't work.
+export const typeDefs = loadFilesSync('', { extensions: ['.graphql'] })
+    .map(print)
+    .join('\n');
+//# sourceMappingURL=index.js.map

package/dist/esm/src/typeDefs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/typeDefs/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAE/B,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAEzD,0FAA0F;AAC1F,MAAM,CAAC,MAAM,QAAQ,GAAG,aAAa,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC;KACpE,GAAG,CAAC,KAAK,CAAC;KACV,IAAI,CAAC,IAAI,CAAC,CAAA"}

package/dist/esm/src/typeDefs/mutation.graphql

@@ -0,0 +1,14 @@
+type Mutation {
+  """
+  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(cart: IStoreCart!, session: IStoreSession): StoreCart
+  """
+  Updates a web session with the specified values.
+  """
+  validateSession(session: IStoreSession!, search: String!): StoreSession
+  """
+  Subscribes a new person to the newsletter list.
+  """
+  subscribeToNewsletter(data: IPersonNewsletter!): PersonNewsletter
+}

package/dist/esm/src/typeDefs/newsletter.graphql

@@ -0,0 +1,24 @@
+"""
+Newsletter information.
+"""
+
+type PersonNewsletter {
+  """
+  Person's ID in the newsletter list.
+  """
+  id: String!
+}
+
+"""
+Person data input to the newsletter.
+"""
+input IPersonNewsletter {
+  """
+  Person's name.
+  """
+  name: String!
+  """
+  Person's email.
+  """
+  email: String!
+}

package/dist/esm/src/typeDefs/objectOrString.graphql

@@ -0,0 +1 @@
+scalar ObjectOrString

package/dist/esm/src/typeDefs/offer.graphql

@@ -0,0 +1,71 @@
+"""
+Offer information.
+"""
+type StoreOffer {
+  """
+  This is displayed as the "from" price in the context of promotions' price comparison. This may change before it reaches the shelf.
+  """
+  listPrice: Float!
+  """
+  Computed price before applying coupons, taxes or benefits. This may change before it reaches the shelf.
+  """
+  sellingPrice: Float!
+  """
+  ISO code of the currency used for the offer prices.
+  """
+  priceCurrency: String!
+  """
+  Also known as spot price.
+  """
+  price: Float!
+  """
+  Next date in which price is scheduled to change. If there is no scheduled change, this will be set a year in the future from current time.
+  """
+  priceValidUntil: String!
+  """
+  Offer item condition.
+  """
+  itemCondition: String!
+  """
+  Offer item availability.
+  """
+  availability: String!
+  """
+  Seller responsible for the offer.
+  """
+  seller: StoreOrganization!
+  """
+  Information on the item being offered.
+  """
+  itemOffered: StoreProduct!
+  """
+  Number of items offered.
+  """
+  quantity: Int!
+}
+
+"""
+Offer input.
+"""
+input IStoreOffer {
+  """
+  Also known as spot price.
+  """
+  price: Float!
+  """
+  This is displayed as the "from" price in the context of promotions' price comparison. This may change before it reaches the shelf.
+  """
+  listPrice: Float!
+  """
+  Seller responsible for the offer.
+  """
+  seller: IStoreOrganization!
+  """
+  Information on the item being offered.
+  """
+  itemOffered: IStoreProduct!
+  """
+  Number of items offered.
+  """
+  quantity: Int!
+}

package/dist/esm/src/typeDefs/order.graphql

@@ -0,0 +1,31 @@
+"""
+Information of a specific order.
+"""
+type StoreOrder {
+  """
+  ID of the order in [VTEX order management](https://help.vtex.com/en/tutorial/license-manager-resources-oms--60QcBsvWeum02cFi3GjBzg#).
+  """
+  orderNumber: String!
+  """
+  Array with information on each accepted offer.
+  """
+  acceptedOffer: [StoreOffer!]!
+}
+
+"""
+Order input.
+"""
+input IStoreOrder {
+  """
+  ID of the order in [VTEX order management](https://help.vtex.com/en/tutorial/license-manager-resources-oms--60QcBsvWeum02cFi3GjBzg#).
+  """
+  orderNumber: String!
+  """
+  Array with information on each accepted offer.
+  """
+  acceptedOffer: [IStoreOffer!]!
+  """
+  Indicates whether or not items with attachments should be split.
+  """
+  shouldSplitItem: Boolean
+}

package/dist/esm/src/typeDefs/organization.graphql

@@ -0,0 +1,19 @@
+"""
+Organization.
+"""
+type StoreOrganization {
+  """
+  Organization ID.
+  """
+  identifier: String!
+}
+
+"""
+Organization input.
+"""
+input IStoreOrganization {
+  """
+  Organization ID.
+  """
+  identifier: String!
+}

package/dist/esm/src/typeDefs/pageInfo.graphql

@@ -0,0 +1,25 @@
+"""
+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.
+"""
+type StorePageInfo {
+  """
+  Indicates whether there is at least one more page with items after the ones returned in the current query.
+  """
+  hasNextPage: Boolean!
+  """
+  Indicates whether there is at least one more page with items before the ones returned in the current query.
+  """
+  hasPreviousPage: Boolean!
+  """
+  Cursor corresponding to the first possible item.
+  """
+  startCursor: String!
+  """
+  Cursor corresponding to the last possible item.
+  """
+  endCursor: String!
+  """
+  Total number of items (products or collections), not pages.
+  """
+  totalCount: Int!
+}

package/dist/esm/src/typeDefs/person.graphql

@@ -0,0 +1,43 @@
+"""
+Client profile data.
+"""
+type StorePerson {
+  """
+  Client ID.
+  """
+  id: String!
+  """
+  Client email.
+  """
+  email: String!
+  """
+  Client first name.
+  """
+  givenName: String!
+  """
+  Client last name.
+  """
+  familyName: String!
+}
+
+"""
+Client profile data.
+"""
+input IStorePerson {
+  """
+  Client ID.
+  """
+  id: String!
+  """
+  Client email.
+  """
+  email: String!
+  """
+  Client first name.
+  """
+  givenName: String!
+  """
+  Client last name.
+  """
+  familyName: String!
+}

package/dist/esm/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/esm/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/esm/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!
+}