@faststore/api 1.8.1 → 1.8.4

package/dist/platforms/vtex/resolvers/aggregateOffer.d.ts

@@ -1,12 +1,9 @@
-import type { Item } from '../clients/search/types/ProductSearchResult';
+import type { EnhancedCommercialOffer } from '../utils/enhanceCommercialOffer';
 import type { StoreProduct } from './product';
 import type { PromiseType } from '../../../typings';
 import type { Resolver } from '..';
-import type { EnhancedSku } from '../utils/enhanceSku';
 declare type Root = PromiseType<ReturnType<typeof StoreProduct.offers>>;
 export declare const StoreAggregateOffer: Record<string, Resolver<Root>> & {
-    offers: Resolver<Root, any, Array<Item & {
-        product: EnhancedSku;
-    }>>;
+    offers: Resolver<Root, any, EnhancedCommercialOffer[]>;
 };
 export {};

package/dist/platforms/vtex/resolvers/product.d.ts

@@ -1,14 +1,10 @@
+import type { EnhancedCommercialOffer } from '../utils/enhanceCommercialOffer';
 import type { Resolver } from '..';
 import type { PromiseType } from '../../../typings';
 import type { Query } from './query';
-import type { Item } from '../clients/search/types/ProductSearchResult';
-import type { EnhancedSku } from '../utils/enhanceSku';
 declare type Root = PromiseType<ReturnType<typeof Query.product>>;
 export declare const StoreProduct: Record<string, Resolver<Root>> & {
-    offers: Resolver<Root, any, {
-        items: Item[];
-        product: EnhancedSku;
-    }>;
+    offers: Resolver<Root, any, EnhancedCommercialOffer[]>;
     isVariantOf: Resolver<Root, any, Root>;
 };
 export {};

package/dist/platforms/vtex/utils/enhanceCommercialOffer.d.ts

@@ -0,0 +1,11 @@
+import type { CommertialOffer, Seller } from '../clients/search/types/ProductSearchResult';
+import type { EnhancedSku } from './enhanceSku';
+export declare type EnhancedCommercialOffer = CommertialOffer & {
+    seller: Seller;
+    product: EnhancedSku;
+};
+export declare const enhanceCommercialOffer: ({ offer, seller, product, }: {
+    offer: CommertialOffer;
+    seller: Seller;
+    product: EnhancedSku;
+}) => EnhancedCommercialOffer;

package/dist/platforms/vtex/utils/productStock.d.ts

@@ -1,6 +1,7 @@
-import type { Item, Seller, CommertialOffer } from '../clients/search/types/ProductSearchResult';
-export declare const inStock: (item: Item) => Seller | undefined;
-export declare const getFirstSeller: (sellers: Seller[]) => Seller | undefined;
-export declare const getItemPriceByKey: (item: Item, key: keyof CommertialOffer) => number;
-export declare const sortOfferByPrice: (items: Item[]) => Item[];
-export declare const inStockOrderFormItem: (availability: string) => boolean;
+import type { CommertialOffer } from '../clients/search/types/ProductSearchResult';
+export declare const inStock: (offer: Pick<CommertialOffer, 'AvailableQuantity'>) => boolean;
+export declare const price: (offer: Pick<CommertialOffer, 'spotPrice'>) => number;
+export declare const sellingPrice: (offer: CommertialOffer) => number;
+export declare const availability: (available: boolean) => "https://schema.org/InStock" | "https://schema.org/OutOfStock";
+export declare const bestOfferFirst: (a: Pick<CommertialOffer, 'AvailableQuantity' | 'spotPrice'>, b: Pick<CommertialOffer, 'AvailableQuantity' | 'spotPrice'>) => number;
+export declare const inStockOrderFormItem: (itemAvailability: string) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "1.8.1",
+  "version": "1.8.4",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -45,5 +45,5 @@
   "peerDependencies": {
     "graphql": "^15.6.0"
   },
-  "gitHead": "1fd480adb0fa578377f67e65af9a12c717d0671e"
+  "gitHead": "9438cf7d4269b9d20180c31a3121d4c1e5d63089"
 }

package/src/__generated__/schema.ts

@@ -11,52 +11,79 @@ export type Scalars = {
   Float: number;
 };
 
+/** Shopping cart identification input. */
 export type IStoreCart = {
+  /** Order information, including `orderNumber` and `acceptedOffer`. */
   order: IStoreOrder;
 };
 
+/** Image input. */
 export type IStoreImage = {
+  /** Alias for the input image. */
   alternateName: Scalars['String'];
+  /** Image input URL. */
   url: Scalars['String'];
 };
 
+/** Offer input. */
 export type IStoreOffer = {
+  /** Information on the item being offered. */
   itemOffered: IStoreProduct;
+  /** This is displayed as the "from" price in the context of promotions' price comparison. This may change before it reaches the shelf. */
   listPrice: Scalars['Float'];
+  /** Also known as spot price. */
   price: Scalars['Float'];
+  /** Number of items offered. */
   quantity: Scalars['Int'];
+  /** Seller responsible for the offer. */
   seller: IStoreOrganization;
 };
 
+/** Offer input. */
 export type IStoreOrder = {
+  /** Array with information on each accepted offer. */
   acceptedOffer: Array<IStoreOffer>;
+  /** Order shopping cart ID, also known as `orderFormId`. */
   orderNumber: Scalars['String'];
 };
 
+/** Organization input. */
 export type IStoreOrganization = {
+  /** Organization ID. */
   identifier: Scalars['String'];
 };
 
+/** Product input. */
 export type IStoreProduct = {
+  /** Array of product images. */
   image: Array<IStoreImage>;
+  /** Product name. */
   name: Scalars['String'];
+  /** Stock Keeping Unit ID. */
   sku: Scalars['String'];
 };
 
+/** Selected facet input. */
 export type IStoreSelectedFacet = {
   key: Scalars['String'];
   value: Scalars['String'];
 };
 
+/** Session input. */
 export type IStoreSession = {
+  /** Session input channel. */
   channel?: Maybe<Scalars['String']>;
+  /** Session input country. */
   country?: Maybe<Scalars['String']>;
+  /** Session input postal code. */
   postalCode?: Maybe<Scalars['String']>;
 };
 
 export type Mutation = {
   __typename?: 'Mutation';
+  /** Update session information. */
   updateSession: StoreSession;
+  /** Returns the order if anything has changed in it, or `null` if the order is valid. */
   validateCart?: Maybe<StoreCart>;
 };
 
@@ -111,82 +138,123 @@ export type QuerySearchArgs = {
   term?: Maybe<Scalars['String']>;
 };
 
+/** Aggregate offer information, for a given SKU that is available to be fulfilled by multiple sellers. */
 export type StoreAggregateOffer = {
   __typename?: 'StoreAggregateOffer';
+  /** Highest price among all sellers. */
   highPrice: Scalars['Float'];
+  /** Lowest price among all sellers. */
   lowPrice: Scalars['Float'];
+  /** Number of sellers selling this SKU. */
   offerCount: Scalars['Int'];
+  /** Array with information on each available offer. */
   offers: Array<StoreOffer>;
+  /** ISO code of the currency used for the offer prices. */
   priceCurrency: Scalars['String'];
 };
 
+/** Average rating, based on multiple ratings or reviews. */
 export type StoreAggregateRating = {
   __typename?: 'StoreAggregateRating';
+  /** Value of the aggregate rating. */
   ratingValue: Scalars['Float'];
+  /** Total number of ratings. */
   reviewCount: Scalars['Int'];
 };
 
+/** information about the author of a product review or rating. */
 export type StoreAuthor = {
   __typename?: 'StoreAuthor';
+  /** Author name. */
   name: Scalars['String'];
 };
 
+/** Brand of a given product. */
 export type StoreBrand = {
   __typename?: 'StoreBrand';
+  /** Brand name. */
   name: Scalars['String'];
 };
 
+/** List of items consisting of chain linked web pages, ending with the current page. */
 export type StoreBreadcrumbList = {
   __typename?: 'StoreBreadcrumbList';
+  /** Array with breadcrumb elements. */
   itemListElement: Array<StoreListItem>;
+  /** Number of breadcrumbs in the list. */
   numberOfItems: Scalars['Int'];
 };
 
+/** Shopping cart information. */
 export type StoreCart = {
   __typename?: 'StoreCart';
+  /** List of shopping cart messages. */
   messages: Array<StoreCartMessage>;
+  /** Order information, including `orderNumber` and `acceptedOffer`. */
   order: StoreOrder;
 };
 
+/** Shopping cart message. */
 export type StoreCartMessage = {
   __typename?: 'StoreCartMessage';
+  /** Shopping cart message status, which can be `INFO`, `WARNING` OR `ERROR`. */
   status: StoreStatus;
+  /** Shopping cart message text. */
   text: Scalars['String'];
 };
 
+/** Product collection information. */
 export type StoreCollection = {
   __typename?: 'StoreCollection';
+  /** List of items consisting of chain linked web pages, ending with the current page. */
   breadcrumbList: StoreBreadcrumbList;
+  /** Collection ID. */
   id: Scalars['ID'];
+  /** Collection meta information. Used for search. */
   meta: StoreCollectionMeta;
+  /** Meta tag data. */
   seo: StoreSeo;
+  /** Corresponding collection URL slug, with which to retrieve this entity. */
   slug: Scalars['String'];
+  /** Collection type. */
   type: StoreCollectionType;
 };
 
+/** Collection connection pagination information. */
 export type StoreCollectionConnection = {
   __typename?: 'StoreCollectionConnection';
+  /** Array with collection connection page edges. */
   edges: Array<StoreCollectionEdge>;
+  /** Collection connection page information. */
   pageInfo: StorePageInfo;
 };
 
+/** Collection pagination edge. */
 export type StoreCollectionEdge = {
   __typename?: 'StoreCollectionEdge';
+  /** Collection pagination cursor. */
   cursor: Scalars['String'];
+  /** Collection pagination node. */
   node: StoreCollection;
 };
 
+/** Product collection facet, used for search. */
 export type StoreCollectionFacet = {
   __typename?: 'StoreCollectionFacet';
+  /** Facet key. */
   key: Scalars['String'];
+  /** Facet value. */
   value: Scalars['String'];
 };
 
+/** Collection meta information. Used for search. */
 export type StoreCollectionMeta = {
   __typename?: 'StoreCollectionMeta';
+  /** List of selected collection facets. */
   selectedFacets: Array<StoreCollectionFacet>;
 };
 
+/** Product collection type. Possible values are `Department`, `Category`, `Brand` or `Cluster`. */
 export const enum StoreCollectionType {
   Brand = 'Brand',
   Category = 'Category',
@@ -194,124 +262,199 @@ export const enum StoreCollectionType {
   Department = 'Department'
 };
 
+/** Search facet information. */
 export type StoreFacet = {
   __typename?: 'StoreFacet';
+  /** 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>;
 };
 
+/** Search facet type. */
 export const enum StoreFacetType {
   Boolean = 'BOOLEAN',
   Range = 'RANGE'
 };
 
+/** Information of a specific facet value. */
 export type StoreFacetValue = {
   __typename?: 'StoreFacetValue';
+  /** Facet value label. */
   label: Scalars['String'];
+  /** Number of items with this facet. */
   quantity: Scalars['Int'];
+  /** Indicates whether facet is selected. */
   selected: Scalars['Boolean'];
+  /** Facet value. */
   value: Scalars['String'];
 };
 
+/** Image. */
 export type StoreImage = {
   __typename?: 'StoreImage';
+  /** Alias for the image. */
   alternateName: Scalars['String'];
+  /** Image URL. */
   url: Scalars['String'];
 };
 
+/** Item of a list. */
 export type StoreListItem = {
   __typename?: 'StoreListItem';
+  /** List item value. */
   item: Scalars['String'];
+  /** Name of the list item. */
   name: Scalars['String'];
+  /** Position of the item in the list. */
   position: Scalars['Int'];
 };
 
+/** Offer information. */
 export type StoreOffer = {
   __typename?: 'StoreOffer';
+  /** Offer item availability. */
   availability: Scalars['String'];
+  /** Offer item condition. */
   itemCondition: Scalars['String'];
+  /** Information on the item being offered. */
   itemOffered: StoreProduct;
+  /** This is displayed as the "from" price in the context of promotions' price comparison. This may change before it reaches the shelf. */
   listPrice: Scalars['Float'];
+  /** Also known as spot price. */
   price: Scalars['Float'];
+  /** ISO code of the currency used for the offer prices. */
   priceCurrency: Scalars['String'];
+  /** 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: Scalars['String'];
+  /** Number of items offered. */
   quantity: Scalars['Int'];
+  /** Seller responsible for the offer. */
   seller: StoreOrganization;
+  /** Computed price before applying coupons, taxes or benefits. This may change before it reaches the shelf. */
   sellingPrice: Scalars['Float'];
 };
 
+/** Information of a specific order. */
 export type StoreOrder = {
   __typename?: 'StoreOrder';
+  /** Array with information on each accepted offer. */
   acceptedOffer: Array<StoreOffer>;
+  /** Order shopping cart ID, also known as `orderFormId`. */
   orderNumber: Scalars['String'];
 };
 
+/** Organization. */
 export type StoreOrganization = {
   __typename?: 'StoreOrganization';
+  /** Organization ID. */
   identifier: Scalars['String'];
 };
 
+/** Page information. */
 export type StorePageInfo = {
   __typename?: 'StorePageInfo';
+  /** Page cursor end. */
   endCursor: Scalars['String'];
+  /** Indicates whether next page exists. */
   hasNextPage: Scalars['Boolean'];
+  /** Indicates whether previous page exists. */
   hasPreviousPage: Scalars['Boolean'];
+  /** Page cursor start. */
   startCursor: Scalars['String'];
+  /** Total number of items (products or collections), not pages. */
   totalCount: Scalars['Int'];
 };
 
+/** Client profile data. */
 export type StorePerson = {
   __typename?: 'StorePerson';
+  /** Client email. */
   email: Scalars['String'];
+  /** Client last name. */
   familyName: Scalars['String'];
+  /** Client first name. */
   givenName: Scalars['String'];
+  /** Client ID. */
   id: Scalars['String'];
 };
 
+/** Product information. */
 export type StoreProduct = {
   __typename?: 'StoreProduct';
+  /** Array of additional properties. */
   additionalProperty: Array<StorePropertyValue>;
+  /** Aggregate ratings data. */
   aggregateRating: StoreAggregateRating;
+  /** Product brand. */
   brand: StoreBrand;
+  /** List of items consisting of chain linked web pages, ending with the current page. */
   breadcrumbList: StoreBreadcrumbList;
+  /** Product description. */
   description: Scalars['String'];
+  /** Global Trade Item Number. */
   gtin: Scalars['String'];
+  /** Array of images. */
   image: Array<StoreImage>;
+  /** Indicates product group related to this product. */
   isVariantOf: StoreProductGroup;
+  /** Product name. */
   name: Scalars['String'];
+  /** Aggregate offer information. */
   offers: StoreAggregateOffer;
+  /** Product ID. */
   productID: Scalars['String'];
+  /** Array with review information. */
   review: Array<StoreReview>;
+  /** Meta tag data. */
   seo: StoreSeo;
+  /** Stock Keeping Unit ID. */
   sku: Scalars['String'];
+  /** Corresponding collection URL slug, with which to retrieve this entity. */
   slug: Scalars['String'];
 };
 
+/** Product connection pagination information. */
 export type StoreProductConnection = {
   __typename?: 'StoreProductConnection';
+  /** Array with product connection page edges. */
   edges: Array<StoreProductEdge>;
+  /** Product connection page information. */
   pageInfo: StorePageInfo;
 };
 
+/** Product pagination edge. */
 export type StoreProductEdge = {
   __typename?: 'StoreProductEdge';
+  /** Product pagination cursor. */
   cursor: Scalars['String'];
+  /** Product pagination node. */
   node: StoreProduct;
 };
 
+/** Product group information. */
 export type StoreProductGroup = {
   __typename?: 'StoreProductGroup';
+  /** Array of additional properties. */
   additionalProperty: Array<StorePropertyValue>;
+  /** Array of variants related to product group. */
   hasVariant: Array<StoreProduct>;
+  /** Product group name. */
   name: Scalars['String'];
+  /** Product group ID. */
   productGroupID: Scalars['String'];
 };
 
+/** Properties that can be associated with products and products groups. */
 export type StorePropertyValue = {
   __typename?: 'StorePropertyValue';
+  /** Property name. */
   name: Scalars['String'];
+  /** Property value. */
   value: Scalars['String'];
 };
 
@@ -327,10 +470,14 @@ export type StoreReviewRating = {
   ratingValue: Scalars['Float'];
 };
 
+/** Search result. */
 export type StoreSearchResult = {
   __typename?: 'StoreSearchResult';
+  /** Array of search result facets. */
   facets: Array<StoreFacet>;
+  /** Search result products. */
   products: StoreProductConnection;
+  /** Search result suggestions. */
   suggestions: StoreSuggestions;
 };
 
@@ -342,13 +489,18 @@ export type StoreSeo = {
   titleTemplate: Scalars['String'];
 };
 
+/** Session information. */
 export type StoreSession = {
   __typename?: 'StoreSession';
+  /** Session channel. */
   channel?: Maybe<Scalars['String']>;
+  /** Session country. */
   country?: Maybe<Scalars['String']>;
+  /** Session postal code. */
   postalCode?: Maybe<Scalars['String']>;
 };
 
+/** Product sorting options used in search. */
 export const enum StoreSort {
   DiscountDesc = 'discount_desc',
   NameAsc = 'name_asc',
@@ -366,8 +518,11 @@ export const enum StoreStatus {
   Warning = 'WARNING'
 };
 
+/** Suggestions information. */
 export type StoreSuggestions = {
   __typename?: 'StoreSuggestions';
+  /** Array with suggestion products' information. */
   products?: Maybe<Array<StoreProduct>>;
+  /** Array with suggestion terms. */
   terms?: Maybe<Array<Scalars['String']>>;
 };

package/src/platforms/vtex/clients/search/types/ProductSearchResult.ts

@@ -154,7 +154,7 @@ export interface CommertialOffer {
   ItemMetadataAttachment: any[]
   Price: number
   ListPrice: number
-  spotPrice?: number
+  spotPrice: number
   PriceWithoutDiscount: number
   RewardValue: number
   PriceValidUntil: string

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

@@ -1,23 +1,25 @@
-import type { Item } from '../clients/search/types/ProductSearchResult'
+import { inStock } from '../utils/productStock'
+import type { EnhancedCommercialOffer } from '../utils/enhanceCommercialOffer'
 import type { StoreProduct } from './product'
 import type { PromiseType } from '../../../typings'
 import type { Resolver } from '..'
-import type { EnhancedSku } from '../utils/enhanceSku'
 
 type Root = PromiseType<ReturnType<typeof StoreProduct.offers>>
 
 export const StoreAggregateOffer: Record<string, Resolver<Root>> & {
-  offers: Resolver<Root, any, Array<Item & { product: EnhancedSku }>>
+  offers: Resolver<Root, any, EnhancedCommercialOffer[]>
 } = {
-  highPrice: ({ product }) =>
-    product.isVariantOf.priceRange.sellingPrice.highPrice ?? 0,
-  lowPrice: (root) =>
-    root.product.isVariantOf.priceRange.sellingPrice.lowPrice ?? 0,
-  offerCount: ({ items }) => items.length,
+  highPrice: (offers) => {
+    const availableOffers = offers.filter(inStock)
+
+    return availableOffers[availableOffers.length - 1]?.Price ?? 0
+  },
+  lowPrice: (offers) => {
+    const availableOffers = offers.filter(inStock)
+
+    return availableOffers[0]?.Price ?? 0
+  },
+  offerCount: (offers) => offers.length,
   priceCurrency: () => '',
-  offers: ({ items, product }) =>
-    items.map((item) => ({
-      ...item,
-      product,
-    })),
+  offers: (offers) => offers,
 }