@faststore/api 3.99.1 → 4.0.0-dev.4

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

@@ -1,4 +0,0 @@
-export type Platform = 'vtex';
-export type PromiseType<T> = T extends Promise<infer U> ? U : T;
-export type ArrayElementType<T> = T extends Array<infer U> ? U : T;
-//# sourceMappingURL=index.d.ts.map

package/dist/esm/src/typings/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/typings/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAA;AAE7B,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;AAE/D,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA"}

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

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/typings/index.ts"],"names":[],"mappings":""}

package/src/typeDefs/address.graphql

@@ -1,45 +0,0 @@
-"""
-Address information.
-"""
-type Address {
-  """
-  Address postal code
-  """
-  postalCode: String
-  """
-  Address city
-  """
-  city: String
-  """
-  Address state
-  """
-  state: String
-  """
-  Address country
-  """
-  country: String
-  """
-  Address street
-  """
-  street: String
-  """
-  Address number
-  """
-  number: String
-  """
-  Address neighborhood
-  """
-  neighborhood: String
-  """
-  Address complement
-  """
-  complement: String
-  """
-  Address reference
-  """
-  reference: String
-  """
-  Address geoCoordinates
-  """
-  geoCoordinates: [Float]
-}

package/src/typeDefs/advertisement.graphql

@@ -1,25 +0,0 @@
-"""
-Advertisement information about a specific product in a campaign
-"""
-type Advertisement {
-  """
-  Advertiser ID of the product.
-  """
-  adId: String!
-  """
-  Campaign ID.
-  """
-  campaignId: String!
-  """
-  Cost of the action, usually Cost Per Click.
-  """
-  actionCost: Float!
-  """
-  Advertiser Request ID.
-  """
-  adRequestId: String!
-  """
-  Advertiser Response ID.
-  """
-  adResponseId: String!
-}

package/src/typeDefs/aggregateOffer.graphql

@@ -1,29 +0,0 @@
-"""
-Aggregate offer information, for a given SKU that is available to be fulfilled by multiple sellers.
-"""
-type StoreAggregateOffer {
-  """
-  Highest price among all sellers.
-  """
-  highPrice: Float!
-  """
-  Lowest price among all sellers.
-  """
-  lowPrice: Float!
-  """
-  Lowest price among all sellers with current taxes.
-  """
-  lowPriceWithTaxes: Float!
-  """
-  Number of sellers selling this SKU.
-  """
-  offerCount: Int!
-  """
-  ISO code of the currency used for the offer prices.
-  """
-  priceCurrency: String!
-  """
-  Array with information on each available offer.
-  """
-  offers: [StoreOffer!]!
-}

package/src/typeDefs/aggregateRating.graphql

@@ -1,13 +0,0 @@
-"""
-Average rating, based on multiple ratings or reviews.
-"""
-type StoreAggregateRating {
-  """
-  Value of the aggregate rating.
-  """
-  ratingValue: Float!
-  """
-  Total number of ratings.
-  """
-  reviewCount: Int!
-}

package/src/typeDefs/author.graphql

@@ -1,9 +0,0 @@
-"""
-information about the author of a product review or rating.
-"""
-type StoreAuthor {
-  """
-  Author name.
-  """
-  name: String!
-}

package/src/typeDefs/brand.graphql

@@ -1,9 +0,0 @@
-"""
-Brand of a given product.
-"""
-type StoreBrand {
-  """
-  Brand name.
-  """
-  name: String!
-}

package/src/typeDefs/breadcrumb.graphql

@@ -1,31 +0,0 @@
-"""
-Item of a list.
-"""
-type StoreListItem {
-  """
-  List item value.
-  """
-  item: String!
-  """
-  Name of the list item.
-  """
-  name: String!
-  """
-  Position of the item in the list.
-  """
-  position: Int!
-}
-
-"""
-List of items consisting of chain linked web pages, ending with the current page.
-"""
-type StoreBreadcrumbList {
-  """
-  Array with breadcrumb elements.
-  """
-  itemListElement: [StoreListItem!]!
-  """
-  Number of breadcrumbs in the list.
-  """
-  numberOfItems: Int!
-}

package/src/typeDefs/cart.graphql

@@ -1,37 +0,0 @@
-"""
-Shopping cart message.
-"""
-type StoreCartMessage {
-  """
-  Shopping cart message text.
-  """
-  text: String!
-  """
-  Shopping cart message status, which can be `INFO`, `WARNING` or `ERROR`.
-  """
-  status: StoreStatus!
-}
-
-"""
-Shopping cart information.
-"""
-type StoreCart {
-  """
-  Order information, including `orderNumber`, `acceptedOffer` and `shouldSplitItem`.
-  """
-  order: StoreOrder!
-  """
-  List of shopping cart messages.
-  """
-  messages: [StoreCartMessage!]!
-}
-
-"""
-Shopping cart input.
-"""
-input IStoreCart {
-  """
-  Order information, including `orderNumber`, `acceptedOffer` and `shouldSplitItem`.
-  """
-  order: IStoreOrder!
-}

package/src/typeDefs/collection.graphql

@@ -1,83 +0,0 @@
-"""
-Product collection type. Possible values are `Department`, `Category`, `Brand`, `Cluster`, `SubCategory` or `Collection`.
-"""
-enum StoreCollectionType {
-  """
-  First level of product categorization.
-  """
-  Department
-  """
-  Second level of product categorization.
-  """
-  Category
-  """
-  Third level of product categorization.
-  """
-  SubCategory
-  """
-  Product brand.
-  """
-  Brand
-  """
-  Product cluster.
-  """
-  Cluster
-  """
-  Product collection.
-  """
-  Collection
-}
-
-"""
-Product collection facet, used for search.
-"""
-type StoreCollectionFacet {
-  """
-  Facet key.
-  """
-  key: String!
-  """
-  Facet value.
-  """
-  value: String!
-}
-
-"""
-Collection meta information. Used for search.
-"""
-type StoreCollectionMeta {
-  """
-  List of selected collection facets.
-  """
-  selectedFacets: [StoreCollectionFacet!]!
-}
-
-"""
-Product collection information.
-"""
-type StoreCollection {
-  """
-  Meta tag data.
-  """
-  seo: StoreSeo!
-  """
-  List of items consisting of chain linked web pages, ending with the current page.
-  """
-  breadcrumbList: StoreBreadcrumbList!
-  """
-  Collection meta information. Used for search.
-  """
-  meta: StoreCollectionMeta!
-  """
-  Collection ID.
-  """
-  id: ID!
-  """
-  Corresponding collection URL slug, with which to retrieve this entity.
-  """
-  slug: String!
-  """
-  Collection type.
-  """
-  type: StoreCollectionType!
-}

package/src/typeDefs/deliveryPromisesBadge.graphql

@@ -1,9 +0,0 @@
-"""
-Delivery Promise badge.
-"""
-type DeliveryPromiseBadge {
-  """
-  Badge type.
-  """
-  typeName: String
-}

package/src/typeDefs/facet.graphql

@@ -1,77 +0,0 @@
-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/src/typeDefs/image.graphql

@@ -1,27 +0,0 @@
-"""
-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/src/typeDefs/index.ts

@@ -1,7 +0,0 @@
-import { print } from 'graphql'
-
-import { loadFilesSync } from '@graphql-tools/load-files'
-
-export const typeDefs = loadFilesSync(__dirname, { extensions: ['.graphql'] })
-  .map(print)
-  .join('\n')

package/src/typeDefs/mutation.graphql

@@ -1,24 +0,0 @@
-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
-  """
-  Cancels user order
-  """
-  cancelOrder(data: IUserOrderCancel!): UserOrderCancel
-  """
-  Process Order Authorization
-  """
-  processOrderAuthorization(
-    data: IProcessOrderAuthorization!
-  ): ProcessOrderAuthorizationResponse
-}

package/src/typeDefs/newsletter.graphql

@@ -1,23 +0,0 @@
-"""
-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/src/typeDefs/objectOrString.graphql

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

package/src/typeDefs/offer.graphql

@@ -1,83 +0,0 @@
-"""
-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!
-  """
-  List price among with current taxes.
-  """
-  listPriceWithTaxes: 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!
-  """
-  Also known as spot price with taxes.
-  """
-  priceWithTaxes: 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!
-  """
-  Whether this offer is a gift (e.g. free promotional item).
-  """
-  isGift: Boolean
-}
-
-"""
-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/src/typeDefs/order.graphql

@@ -1,35 +0,0 @@
-"""
-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!]!
-  """
-  Indicates whether or not items with attachments should be split.
-  """
-  shouldSplitItem: Boolean
-}
-
-"""
-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
-}