@faststore/api 2.2.38 → 2.2.43

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

@@ -0,0 +1,331 @@
+"""
+Shipping Simulation item input.
+"""
+input IShippingItem {
+  """
+  ShippingItem ID / Sku.
+  """
+  id: String!
+  """
+  Number of items.
+  """
+  quantity: Int!
+  """
+  Seller responsible for the ShippingItem.
+  """
+  seller: String!
+}
+
+"""
+Shipping Simulation information.
+"""
+type ShippingData {
+  """
+  List of LogisticsItem.
+  """
+  items: [LogisticsItem]
+  """
+  List of LogisticsInfo.
+  """
+  logisticsInfo: [LogisticsInfo]
+  """
+  List of MessageInfo.
+  """
+  messages: [MessageInfo]
+  """
+  Address information.
+  """
+  address: Address
+}
+
+"""
+Shipping Simulation Logistic Item.
+"""
+type LogisticsItem {
+  """
+  LogisticsItem ID / Sku.
+  """
+  id: String
+  requestIndex: Int
+  """
+  Number of items.
+  """
+  quantity: Int
+  """
+  Seller responsible for the ShippingItem.
+  """
+  seller: String
+  """
+  List of Sellers.
+  """
+  sellerChain: [String]
+  """
+  LogisticsItem tax.
+  """
+  tax: Int
+  """
+  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
+  """
+  LogisticsItem price.
+  """
+  price: Int
+  """
+  LogisticsItem listPrice.
+  """
+  listPrice: Int
+  """
+  LogisticsItem rewardValue.
+  """
+  rewardValue: Int
+  """
+  LogisticsItem sellingPrice.
+  """
+  sellingPrice: Int
+  """
+  LogisticsItem measurementUnit.
+  """
+  measurementUnit: String
+  """
+  LogisticsItem unitMultiplier.
+  """
+  unitMultiplier: Int
+  """
+  LogisticsItem availability.
+  """
+  availability: String
+}
+
+type LogisticsInfo {
+  """
+  LogisticsInfo itemIndex.
+  """
+  itemIndex: String
+  """
+  LogisticsInfo selectedSla.
+  """
+  selectedSla: String
+  """
+  List of LogisticsInfo ShippingSLA.
+  """
+  slas: [ShippingSLA]
+}
+
+type ShippingSLA {
+  """
+  ShippingSLA id.
+  """
+  id: String
+  """
+  ShippingSLA name.
+  """
+  name: String
+  """
+  ShippingSLA price.
+  """
+  price: Float
+  """
+  ShippingSLA shipping estimate.
+  """
+  shippingEstimate: String
+  """
+  ShippingSLA localized shipping estimate.
+  Note: this will always return a localized string for locale `en-US`.
+  """
+  localizedEstimates: String
+  """
+  ShippingSLA available delivery windows.
+  """
+  availableDeliveryWindows: [AvailableDeliveryWindows]
+  """
+  ShippingSLA shipping estimate date.
+  """
+  shippingEstimateDate: String
+  """
+  List of ShippingSLA delivery ids.
+  """
+  deliveryIds: [DeliveryIds]
+  """
+  ShippingSLA delivery channel.
+  """
+  deliveryChannel: String
+  """
+  ShippingSLA friendly name.
+  """
+  friendlyName: String
+  """
+  ShippingSLA carrier.
+  """
+  carrier: String
+  """
+  ShippingSLA pickup point id.
+  """
+  pickupPointId: String
+  """
+  ShippingSLA pickup store info.
+  """
+  pickupStoreInfo: PickupStoreInfo
+  """
+  ShippingSLA pickup distance.
+  """
+  pickupDistance: Float
+}
+
+type AvailableDeliveryWindows {
+  """
+  Available delivery window start date in UTC
+  """
+  startDateUtc: String
+  """
+  Available delivery window end date in UTC
+  """
+  endDateUtc: String
+  """
+  Available delivery window price
+  """
+  price: Int
+  """
+  Available delivery window list price
+  """
+  listPrice: Int
+  """
+  Available delivery window tax
+  """
+  tax: Int
+}
+
+type DeliveryIds {
+  """
+  DeliveryIds courier id
+  """
+  courierId: String
+  """
+  DeliveryIds warehouse id
+  """
+  warehouseId: String
+  """
+  DeliveryIds dock id
+  """
+  dockId: String
+  """
+  DeliveryIds courier name
+  """
+  courierName: String
+  """
+  DeliveryIds quantity
+  """
+  quantity: Int
+}
+
+type PickupStoreInfo {
+  """
+  PickupStoreInfo friendly name.
+  """
+  friendlyName: String
+  """
+  PickupStoreInfo address.
+  """
+  address: PickupAddress
+  """
+  PickupStoreInfo additional information.
+  """
+  additionalInfo: String
+  """
+  PickupStoreInfo dock id.
+  """
+  dockId: String
+  """
+  Information if the store has pickup enable.
+  """
+  isPickupStore: Boolean
+}
+
+type PickupAddress {
+  """
+  PickupAddress address type.
+  """
+  addressType: String
+  """
+  PickupAddress receiver name.
+  """
+  receiverName: String
+  """
+  PickupAddress address id.
+  """
+  addressId: String
+  """
+  PickupAddress postal code.
+  """
+  postalCode: String
+  """
+  PickupAddress city.
+  """
+  city: String
+  """
+  PickupAddress state.
+  """
+  state: String
+  """
+  PickupAddress country.
+  """
+  country: String
+  """
+  PickupAddress street.
+  """
+  street: String
+  """
+  PickupAddress number.
+  """
+  number: String
+  """
+  PickupAddress neighborhood.
+  """
+  neighborhood: String
+  """
+  PickupAddress complement.
+  """
+  complement: String
+  """
+  PickupAddress reference.
+  """
+  reference: String
+  """
+  PickupAddress geo coordinates.
+  """
+  geoCoordinates: [Float]
+}
+
+type MessageInfo {
+  """
+  MessageInfo code.
+  """
+  code: String
+  """
+  MessageInfo text.
+  """
+  text: String
+  """
+  MessageInfo status.
+  """
+  status: String
+  """
+  MessageInfo fields.
+  """
+  fields: MessageFields
+}
+
+type MessageFields {
+  """
+  MessageFields item index.
+  """
+  itemIndex: String
+  """
+  MessageFields ean.
+  """
+  ean: String
+  """
+  MessageFields sku name.
+  """
+  skuName: String
+}

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

@@ -0,0 +1,90 @@
+type SkuVariants {
+  """
+  SKU property values for the current SKU.
+  """
+  activeVariations: ActiveVariations
+  """
+  All available options for each SKU variant property, indexed by their name.
+  """
+  allVariantsByName: VariantsByName
+  """
+  Maps property value combinations to their respective SKU's slug. Enables
+  us to retrieve the slug for the SKU that matches the currently selected
+  variations in O(1) time.
+  If `dominantVariantName` is not present, the first variant will be 
+  considered the dominant one.
+  """
+  slugsMap(dominantVariantName: String): SlugsMap
+  """
+  Available options for each varying SKU property, taking into account the
+  `dominantVariantName` property. Returns all available options for the
+  dominant property, and only options that can be combined with its current
+  value for other properties.
+  If `dominantVariantName` is not present, the first variant will be 
+  considered the dominant one.
+  """
+  availableVariations(dominantVariantName: String): FormattedVariants
+}
+
+"""
+Example:
+
+```json
+{
+  'Color-Red-Size-40': 'classic-shoes-37'
+}
+```
+"""
+scalar SlugsMap
+"""
+Example:
+
+```json
+{
+  Color: 'Red', Size: '42'
+}
+```
+"""
+scalar ActiveVariations
+"""
+Example:
+
+```json
+{
+  Color: [ "Red", "Blue", "Green" ],
+  Size: [ "40", "41" ]
+}
+```
+"""
+scalar VariantsByName
+"""
+Example:
+
+```json
+{
+  Color: [
+    {
+      src: "https://storecomponents.vtexassets.com/...",
+      alt: "...",
+      label: "...",
+      value: "..."
+    },
+    {
+      src: "https://storecomponents.vtexassets.com/...",
+      alt: "...",
+      label: "...",
+      value: "..."
+    }
+  ],
+  Size: [
+    {
+      src: "https://storecomponents.vtexassets.com/...",
+      alt: "...",
+      label: "...",
+      value: "..."
+    }
+  ]
+}
+```
+"""
+scalar FormattedVariants

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

@@ -0,0 +1,8 @@
+"""
+Status used to indicate a message type. For instance, a shopping cart informative or error message.
+"""
+enum StoreStatus {
+  INFO
+  WARNING
+  ERROR
+}

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

@@ -0,0 +1,3 @@
+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;

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

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

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

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

package/package.json

@@ -1,29 +1,41 @@
 {
   "name": "@faststore/api",
-  "version": "2.2.38",
+  "version": "2.2.43",
   "license": "MIT",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
-  "module": "dist/api.esm.js",
+  "main": "dist/cjs/src/index.js",
+  "typings": "dist/esm/src/index.d.ts",
+  "module": "dist/esm/src/index.js",
   "repository": "vtex/faststore",
   "files": [
     "dist",
     "src"
   ],
-  "browserslist": "node 12",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/src/index.js",
+      "require": "./dist/cjs/src/index.js",
+      "types": "./dist/esm/src/index.d.ts",
+      "default": "./dist/esm/src/index.js"
+    }
+  },
+  "browserslist": "node 18",
   "engines": {
-    "node": ">=12"
+    "node": ">=18"
   },
   "scripts": {
-    "dev": "concurrently \"yarn generate -w\" \"tsdx watch\"",
-    "dev:server": "tsdx watch --entry ./local/server.ts --target node --onSuccess \"node ./dist\"",
-    "build": "graphql-codegen --config codegen.yml && tsdx build",
+    "dev": "concurrently \"yarn generate -w\" \"tsc --watch\" \"yarn dev:graphql\"",
+    "dev:graphql": "nodemon --watch src --ext graphql --exec \"copyfiles \"src/**/*.graphql\" dist/esm\"",
+    "dev:server": "tsx --no-cache ./local/server.ts",
+    "build": "graphql-codegen --config codegen.yml && (yarn build:cjs & yarn build:esm)",
+    "build:cjs": "tsc --module commonjs --moduleResolution node10 --outDir dist/cjs && copyfiles \"src/**/*.graphql\" dist/cjs",
+    "build:esm": "tsc && copyfiles \"src/**/*.graphql\" dist/esm",
     "lint": "eslint src/**/*.ts",
-    "test": "tsdx test",
+    "test": "jest",
     "generate": "graphql-codegen --config codegen.yml"
   },
   "dependencies": {
     "@envelop/on-resolve": "^2.0.6",
+    "@graphql-tools/load-files": "^7.0.0",
     "@graphql-tools/schema": "^9.0.0",
     "@opentelemetry/exporter-logs-otlp-grpc": "^0.39.1",
     "@opentelemetry/exporter-trace-otlp-grpc": "^0.39.1",
@@ -38,26 +50,31 @@
   },
   "devDependencies": {
     "@envelop/core": "^2.6.0",
-    "@faststore/eslint-config": "^2.2.38",
-    "@faststore/shared": "^2.2.38",
+    "@faststore/eslint-config": "^2.2.43",
+    "@faststore/shared": "^2.2.43",
     "@graphql-codegen/cli": "2.2.0",
     "@graphql-codegen/typescript": "2.2.2",
     "@types/express": "^4.17.16",
     "@types/sanitize-html": "^2.9.1",
     "concurrently": "^6.2.1",
+    "copyfiles": "^2.4.1",
     "eslint": "7.32.0",
     "express": "^4.17.3",
     "express-graphql": "^0.12.0",
     "graphql": "^15.6.0",
-    "jest-transform-graphql": "^2.1.0",
-    "ts-jest": "25.5.1",
-    "tsdx": "^0.14.1",
+    "jest": "^29.7.0",
+    "nodemon": "^3.0.2",
+    "ts-jest": "29.1.1",
     "tslib": "^2.3.1",
-    "typescript": "^4.4.2"
+    "tsx": "^4.6.2",
+    "typescript": "^5.3.2"
   },
   "peerDependencies": {
     "@envelop/core": "^1 || ^2",
     "graphql": "^15.6.0"
   },
-  "gitHead": "d766a3a32d882476d6234abd41ae7eb3818ea3b7"
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "gitHead": "e29fb81077b919ae41bea77de10794fbf49cdad5"
 }

package/src/index.ts

@@ -46,4 +46,4 @@ export const getSchema = async (options: Options) => {
 }
 
 export * from './platforms/vtex/resolvers/root'
-export { Resolver } from './platforms/vtex'
+export type { Resolver } from './platforms/vtex'

package/src/platforms/vtex/resolvers/searchResult.ts

@@ -3,6 +3,7 @@ import type { Resolver } from '..'
 import type { SearchArgs } from '../clients/search'
 import type { Facet } from '../clients/search/types/FacetSearchResult'
 import { ProductSearchResult } from '../clients/search/types/ProductSearchResult'
+import { pickBestSku } from '../utils/sku'
 
 export type Root = {
   searchArgs: Omit<SearchArgs, 'type'>
@@ -45,7 +46,9 @@ export const StoreSearchResult: Record<string, Resolver<Root>> = {
 
     const skus = productSearchResult.products
       .map((product) => {
-        const [maybeSku] = product.items
+        // What determines the presentation of the SKU is the price order
+        // https://help.vtex.com/pt/tutorial/ordenando-imagens-na-vitrine-e-na-pagina-de-produto--tutorials_278
+        const maybeSku = pickBestSku(product.items)
 
         return maybeSku && enhanceSku(maybeSku, product)
       })
@@ -63,7 +66,9 @@ export const StoreSearchResult: Record<string, Resolver<Root>> = {
 
     const skus = productSearchResult.products
       .map((product) => {
-        const [maybeSku] = product.items
+        // What determines the presentation of the SKU is the price order
+        // https://help.vtex.com/pt/tutorial/ordenando-imagens-na-vitrine-e-na-pagina-de-produto--tutorials_278
+        const maybeSku = pickBestSku(product.items)
 
         return maybeSku && enhanceSku(maybeSku, product)
       })

package/src/typeDefs/index.ts

@@ -1,63 +1,8 @@
 import { print } from 'graphql'
 
-import Address from './address.graphql'
-import AggregateOffer from './aggregateOffer.graphql'
-import AggregateRating from './aggregateRating.graphql'
-import Author from './author.graphql'
-import Brand from './brand.graphql'
-import Breadcrumb from './breadcrumb.graphql'
-import Cart from './cart.graphql'
-import Collection from './collection.graphql'
-import Facet from './facet.graphql'
-import Image from './image.graphql'
-import Mutation from './mutation.graphql'
-import Newsletter from './newsletter.graphql'
-import ObjectOrString from './objectOrString.graphql'
-import Offer from './offer.graphql'
-import Order from './order.graphql'
-import Organization from './organization.graphql'
-import PageInfo from './pageInfo.graphql'
-import Person from './person.graphql'
-import Product from './product.graphql'
-import ProductGroup from './productGroup.graphql'
-import PropertyValue from './propertyValue.graphql'
-import Query from './query.graphql'
-import Review from './review.graphql'
-import Seo from './seo.graphql'
-import Session from './session.graphql'
-import ShippingSimulation from './shipping.graphql'
-import SkuVariants from './skuVariants.graphql'
-import Status from './status.graphql'
+import { loadFilesSync } from '@graphql-tools/load-files'
 
-export const typeDefs = [
-  Query,
-  Mutation,
-  Address,
-  Brand,
-  Breadcrumb,
-  Collection,
-  Facet,
-  Image,
-  PageInfo,
-  Product,
-  Seo,
-  Offer,
-  AggregateRating,
-  Review,
-  Author,
-  ProductGroup,
-  Organization,
-  AggregateOffer,
-  Order,
-  Cart,
-  Status,
-  PropertyValue,
-  Person,
-  ObjectOrString,
-  Session,
-  Newsletter,
-  SkuVariants,
-  ShippingSimulation,
-]
+// Empty string ('') is interpreted as the current dir. Referencing it as './' won't work.
+export const typeDefs = loadFilesSync('', { extensions: ['.graphql'] })
   .map(print)
   .join('\n')