@faststore/api 1.9.6 → 1.9.7

package/dist/index.d.ts

@@ -49,6 +49,7 @@ export declare const getResolvers: (options: Options) => {
     StoreSeo: Record<string, import("./platforms/vtex").Resolver<{
         title?: string | undefined;
         description?: string | undefined;
+        canonical?: string | undefined;
     }, unknown, any>>;
     StoreFacet: Record<string, import("./platforms/vtex").Resolver<import("./platforms/vtex/clients/search/types/FacetSearchResult").Facet, unknown, any>>;
     StoreFacetValue: Record<string, import("./platforms/vtex").Resolver<import("./platforms/vtex/clients/search/types/FacetSearchResult").FacetValue, unknown, any>>;
@@ -57,7 +58,7 @@ export declare const getResolvers: (options: Options) => {
     } & {
         attachmentsValues?: import("./platforms/vtex/clients/commerce/types/OrderForm").Attachment[] | undefined;
     }> | (import("./platforms/vtex/clients/commerce/types/OrderForm").OrderFormItem & {
-        product: Promise<import("./platforms/vtex/utils/enhanceSku").EnhancedSku>;
+        product: import("./platforms/vtex/utils/enhanceSku").EnhancedSku;
     }), unknown, any>>;
     StoreAggregateRating: Record<string, import("./platforms/vtex").Resolver<unknown, unknown, any>>;
     StoreReview: Record<string, import("./platforms/vtex").Resolver<unknown, unknown, any>>;
@@ -125,8 +126,8 @@ export declare const getResolvers: (options: Options) => {
         }, ctx: import("./platforms/vtex").Context) => Promise<{
             order: {
                 orderNumber: string;
-                acceptedOffer: {
-                    product: Promise<import("./platforms/vtex/utils/enhanceSku").EnhancedSku>;
+                acceptedOffer: Promise<{
+                    product: import("./platforms/vtex/utils/enhanceSku").EnhancedSku;
                     id: string;
                     name: string;
                     detailUrl: string;
@@ -170,7 +171,7 @@ export declare const getResolvers: (options: Options) => {
                         total: number;
                     };
                     attachments: import("./platforms/vtex/clients/commerce/types/OrderForm").Attachment[];
-                }[];
+                }>[];
             };
             messages: {
                 text: any;

package/dist/platforms/vtex/clients/commerce/types/Portal.d.ts

@@ -5,7 +5,7 @@ export interface CollectionPageType {
     url: string;
     title: string;
     metaTagDescription: string;
-    pageType: 'Brand' | 'Category' | 'Department' | 'Subcategory';
+    pageType: 'Brand' | 'Category' | 'Department' | 'Subcategory' | 'Product';
 }
 export interface FallbackPageType {
     id: null;

package/dist/platforms/vtex/index.d.ts

@@ -77,6 +77,7 @@ export declare const getResolvers: (_: Options) => {
     StoreSeo: Record<string, Resolver<{
         title?: string | undefined;
         description?: string | undefined;
+        canonical?: string | undefined;
     }, unknown, any>>;
     StoreFacet: Record<string, Resolver<import("./clients/search/types/FacetSearchResult").Facet, unknown, any>>;
     StoreFacetValue: Record<string, Resolver<import("./clients/search/types/FacetSearchResult").FacetValue, unknown, any>>;
@@ -85,7 +86,7 @@ export declare const getResolvers: (_: Options) => {
     } & {
         attachmentsValues?: import("./clients/commerce/types/OrderForm").Attachment[] | undefined;
     }> | (import("./clients/commerce/types/OrderForm").OrderFormItem & {
-        product: Promise<import("./utils/enhanceSku").EnhancedSku>;
+        product: import("./utils/enhanceSku").EnhancedSku;
     }), unknown, any>>;
     StoreAggregateRating: Record<string, Resolver<unknown, unknown, any>>;
     StoreReview: Record<string, Resolver<unknown, unknown, any>>;
@@ -153,8 +154,8 @@ export declare const getResolvers: (_: Options) => {
         }, ctx: Context) => Promise<{
             order: {
                 orderNumber: string;
-                acceptedOffer: {
-                    product: Promise<import("./utils/enhanceSku").EnhancedSku>;
+                acceptedOffer: Promise<{
+                    product: import("./utils/enhanceSku").EnhancedSku;
                     id: string;
                     name: string;
                     detailUrl: string;
@@ -198,7 +199,7 @@ export declare const getResolvers: (_: Options) => {
                         total: number;
                     };
                     attachments: import("./clients/commerce/types/OrderForm").Attachment[];
-                }[];
+                }>[];
             };
             messages: {
                 text: any;

package/dist/platforms/vtex/loaders/index.d.ts

@@ -1,7 +1,7 @@
 import type { Context, Options } from '..';
 export declare type Loaders = ReturnType<typeof getLoaders>;
 export declare const getLoaders: (options: Options, { clients }: Context) => {
-    skuLoader: import("dataloader")<import("../utils/facets").SelectedFacet[], import("../utils/enhanceSku").EnhancedSku, import("../utils/facets").SelectedFacet[]>;
+    skuLoader: import("dataloader")<string, import("../utils/enhanceSku").EnhancedSku, string>;
     simulationLoader: import("dataloader")<import("../clients/commerce/types/Simulation").PayloadItem[], import("../clients/commerce/types/Simulation").Simulation, import("../clients/commerce/types/Simulation").PayloadItem[]>;
     collectionLoader: import("dataloader")<string, import("../clients/commerce/types/Portal").CollectionPageType, string>;
 };

package/dist/platforms/vtex/loaders/sku.d.ts

@@ -2,5 +2,4 @@ import DataLoader from 'dataloader';
 import type { EnhancedSku } from '../utils/enhanceSku';
 import type { Options } from '..';
 import type { Clients } from '../clients';
-import type { SelectedFacet } from '../utils/facets';
-export declare const getSkuLoader: (_: Options, clients: Clients) => DataLoader<SelectedFacet[], EnhancedSku, SelectedFacet[]>;
+export declare const getSkuLoader: (_: Options, clients: Clients) => DataLoader<string, EnhancedSku, string>;

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

@@ -4,8 +4,8 @@ export declare const Mutation: {
     }, ctx: import("..").Context) => Promise<{
         order: {
             orderNumber: string;
-            acceptedOffer: {
-                product: Promise<import("../utils/enhanceSku").EnhancedSku>;
+            acceptedOffer: Promise<{
+                product: import("../utils/enhanceSku").EnhancedSku;
                 id: string;
                 name: string;
                 detailUrl: string;
@@ -49,7 +49,7 @@ export declare const Mutation: {
                     total: number;
                 };
                 attachments: import("../clients/commerce/types/OrderForm").Attachment[];
-            }[];
+            }>[];
         };
         messages: {
             text: any;

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

@@ -4,7 +4,7 @@ import type { ArrayElementType } from '../../../typings';
 import type { EnhancedSku } from '../utils/enhanceSku';
 import type { OrderFormItem } from '../clients/commerce/types/OrderForm';
 declare type OrderFormProduct = OrderFormItem & {
-    product: Promise<EnhancedSku>;
+    product: EnhancedSku;
 };
 declare type SearchProduct = ArrayElementType<ReturnType<typeof StoreAggregateOffer.offers>>;
 declare type Root = SearchProduct | OrderFormProduct;

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

@@ -2,6 +2,7 @@ import type { Resolver } from '..';
 declare type Root = {
     title?: string;
     description?: string;
+    canonical?: string;
 };
 export declare const StoreSeo: Record<string, Resolver<Root>>;
 export {};

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

@@ -18,8 +18,8 @@ export declare const validateCart: (_: unknown, { cart: { order } }: {
 }, ctx: Context) => Promise<{
     order: {
         orderNumber: string;
-        acceptedOffer: {
-            product: Promise<import("../utils/enhanceSku").EnhancedSku>;
+        acceptedOffer: Promise<{
+            product: import("../utils/enhanceSku").EnhancedSku;
             id: string;
             name: string;
             detailUrl: string;
@@ -63,7 +63,7 @@ export declare const validateCart: (_: unknown, { cart: { order } }: {
                 total: number;
             };
             attachments: import("../clients/commerce/types/OrderForm").Attachment[];
-        }[];
+        }>[];
     };
     messages: {
         text: any;

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

@@ -0,0 +1,2 @@
+import type { Product } from '../clients/search/types/ProductSearchResult';
+export declare const canonicalFromProduct: ({ linkText }: Product) => string;

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

@@ -13,5 +13,7 @@ export declare const transformSelectedFacet: ({ key, value }: SelectedFacet) =>
     key: string;
     value: string;
 };
+export declare const findSlug: (facets?: SelectedFacet[] | null | undefined) => string | null;
+export declare const findSkuId: (facets?: SelectedFacet[] | null | undefined) => string | null;
 export declare const findLocale: (facets?: SelectedFacet[] | null | undefined) => string | null;
 export declare const findChannel: (facets?: SelectedFacet[] | null | undefined) => string | null;

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

@@ -0,0 +1,4 @@
+/**
+ * More info at: https://en.wikipedia.org/wiki/Order_statistic
+ */
+export declare const min: <T>(array: T[], cmp: (a: T, b: T) => number) => T;

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

@@ -0,0 +1,8 @@
+import type { Item } from '../clients/search/types/ProductSearchResult';
+/**
+ * This function implements Portal heuristics for returning the best sku for a product.
+ *
+ * The best sku is the one with the best (cheapest available) offer
+ * */
+export declare const pickBestSku: (skus: Item[]) => Item;
+export declare const isValidSkuId: (skuId: string) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "1.9.6",
+  "version": "1.9.7",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -44,5 +44,5 @@
   "peerDependencies": {
     "graphql": "^15.6.0"
   },
-  "gitHead": "69e237e43d8fc3940fffdd2a9fa8d5ed43f40181"
+  "gitHead": "a0c8cbd82dc0d83b4ca9f186fd974e09a2bbd768"
 }

package/src/platforms/vtex/clients/commerce/index.ts

@@ -1,5 +1,5 @@
-import type { Context, Options } from '../../index'
 import { fetchAPI } from '../fetch'
+import type { Context, Options } from '../../index'
 import type { Brand } from './types/Brand'
 import type { CategoryTree } from './types/CategoryTree'
 import type { OrderForm, OrderFormInputItem } from './types/OrderForm'

package/src/platforms/vtex/clients/commerce/types/Portal.ts

@@ -6,7 +6,7 @@ export interface CollectionPageType {
   url: string
   title: string
   metaTagDescription: string
-  pageType: 'Brand' | 'Category' | 'Department' | 'Subcategory'
+  pageType: 'Brand' | 'Category' | 'Department' | 'Subcategory' | 'Product'
 }
 
 export interface FallbackPageType {

package/src/platforms/vtex/loaders/sku.ts

@@ -1,26 +1,13 @@
 import DataLoader from 'dataloader'
 
 import { enhanceSku } from '../utils/enhanceSku'
-import { BadRequestError, NotFoundError } from '../../errors'
+import { NotFoundError } from '../../errors'
 import type { EnhancedSku } from '../utils/enhanceSku'
 import type { Options } from '..'
 import type { Clients } from '../clients'
-import type { SelectedFacet } from '../utils/facets'
 
 export const getSkuLoader = (_: Options, clients: Clients) => {
-  const loader = async (facetsList: readonly SelectedFacet[][]) => {
-    const skuIds = facetsList.map((facets) => {
-      const maybeFacet = facets.find(({ key }) => key === 'id')
-
-      if (!maybeFacet) {
-        throw new BadRequestError(
-          'Error while loading SKU. Needs to pass an id to selected facets'
-        )
-      }
-
-      return maybeFacet.value
-    })
-
+  const loader = async (skuIds: readonly string[]) => {
     const { products } = await clients.search.products({
       query: `sku:${skuIds.join(';')}`,
       page: 0,
@@ -47,7 +34,7 @@ export const getSkuLoader = (_: Options, clients: Clients) => {
     return skus
   }
 
-  return new DataLoader<SelectedFacet[], EnhancedSku>(loader, {
+  return new DataLoader<string, EnhancedSku>(loader, {
     maxBatchSize: 99, // Max allowed batch size of Search API
   })
 }

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

@@ -11,7 +11,7 @@ import type { ArrayElementType } from '../../../typings'
 import type { EnhancedSku } from '../utils/enhanceSku'
 import type { OrderFormItem } from '../clients/commerce/types/OrderForm'
 
-type OrderFormProduct = OrderFormItem & { product: Promise<EnhancedSku> }
+type OrderFormProduct = OrderFormItem & { product: EnhancedSku }
 type SearchProduct = ArrayElementType<
   ReturnType<typeof StoreAggregateOffer.offers>
 >
@@ -96,13 +96,16 @@ export const StoreOffer: Record<string, Resolver<Root>> = {
 
     return null
   },
-  itemOffered: async (root) => {
+  itemOffered: (root) => {
     if (isSearchItem(root)) {
       return root.product
     }
 
     if (isOrderFormItem(root)) {
-      return { ...(await root.product), attachmentsValues: root.attachments }
+      return {
+        ...root.product,
+        attachmentsValues: root.attachments,
+      }
     }
 
     return null

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

@@ -1,3 +1,4 @@
+import { canonicalFromProduct } from '../utils/canonical'
 import { enhanceCommercialOffer } from '../utils/enhanceCommercialOffer'
 import { bestOfferFirst } from '../utils/productStock'
 import { slugify } from '../utils/slugify'
@@ -41,9 +42,10 @@ export const StoreProduct: Record<string, Resolver<Root>> & {
   name: ({ isVariantOf, name }) => name ?? isVariantOf.productName,
   slug: ({ isVariantOf: { linkText }, itemId }) => getSlug(linkText, itemId),
   description: ({ isVariantOf: { description } }) => description,
-  seo: ({ isVariantOf: { description, productName } }) => ({
-    title: productName,
-    description,
+  seo: ({ isVariantOf }) => ({
+    title: isVariantOf.productName,
+    description: isVariantOf.description,
+    canonical: canonicalFromProduct(isVariantOf),
   }),
   brand: ({ isVariantOf: { brand } }) => ({ name: brand }),
   breadcrumbList: ({
@@ -85,7 +87,7 @@ export const StoreProduct: Record<string, Resolver<Root>> & {
   aggregateRating: () => ({}),
   offers: (root) =>
     root.sellers
-      .flatMap((seller) =>
+      .map((seller) =>
         enhanceCommercialOffer({
           offer: seller.commertialOffer,
           seller,

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

@@ -1,8 +1,11 @@
+import { NotFoundError, BadRequestError } from '../../errors'
 import { mutateChannelContext, mutateLocaleContext } from '../utils/contex'
 import { enhanceSku } from '../utils/enhanceSku'
 import {
   findChannel,
   findLocale,
+  findSkuId,
+  findSlug,
   transformSelectedFacet,
 } from '../utils/facets'
 import { SORT_MAP } from '../utils/sort'
@@ -16,12 +19,15 @@ import type {
 } from '../../../__generated__/schema'
 import type { CategoryTree } from '../clients/commerce/types/CategoryTree'
 import type { Context } from '../index'
+import { isValidSkuId, pickBestSku } from '../utils/sku'
 
 export const Query = {
   product: async (_: unknown, { locator }: QueryProductArgs, ctx: Context) => {
     // Insert channel in context for later usage
     const channel = findChannel(locator)
     const locale = findLocale(locator)
+    const id = findSkuId(locator)
+    const slug = findSlug(locator)
 
     if (channel) {
       mutateChannelContext(ctx, channel)
@@ -33,9 +39,46 @@ export const Query = {
 
     const {
       loaders: { skuLoader },
+      clients: { commerce, search },
     } = ctx
 
-    return skuLoader.load(locator)
+    try {
+      const skuId = id ?? slug?.split('-').pop() ?? ''
+
+      if (!isValidSkuId(skuId)) {
+        throw new Error('Invalid SkuId')
+      }
+
+      const sku = await skuLoader.load(skuId)
+
+      return sku
+    } catch (err) {
+      if (slug == null) {
+        throw new BadRequestError('Missing slug or id')
+      }
+
+      const route = await commerce.catalog.portal.pagetype(`${slug}/p`)
+
+      if (route.pageType !== 'Product' || !route.id) {
+        throw new NotFoundError(`No product found for slug ${slug}`)
+      }
+
+      const {
+        products: [product],
+      } = await search.products({
+        page: 0,
+        count: 1,
+        query: `product:${route.id}`,
+      })
+
+      if (!product) {
+        throw new NotFoundError(`No product found for id ${route.id}`)
+      }
+
+      const sku = pickBestSku(product.items)
+
+      return enhanceSku(sku, product)
+    }
   },
   collection: (_: unknown, { slug }: QueryCollectionArgs, ctx: Context) => {
     const {

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

@@ -1,10 +1,10 @@
 import type { Resolver } from '..'
 
-type Root = { title?: string; description?: string }
+type Root = { title?: string; description?: string; canonical?: string }
 
 export const StoreSeo: Record<string, Resolver<Root>> = {
   title: ({ title }) => title ?? '',
   description: ({ description }) => description ?? '',
+  canonical: ({ canonical }) => canonical ?? '',
   titleTemplate: () => '',
-  canonical: () => '',
 }

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

@@ -96,16 +96,16 @@ const equals = (storeOrder: IStoreOrder, orderForm: OrderForm) => {
   return isSameOrder && orderItemsAreSync
 }
 
-const orderFormToCart = (
+const orderFormToCart = async (
   form: OrderForm,
   skuLoader: Context['loaders']['skuLoader']
 ) => {
   return {
     order: {
       orderNumber: form.orderFormId,
-      acceptedOffer: form.items.map((item) => ({
+      acceptedOffer: form.items.map(async (item) => ({
         ...item,
-        product: skuLoader.load([{ key: 'id', value: item.id }]), // TODO: add channel
+        product: await skuLoader.load(item.id), // TODO: add channel
       })),
     },
     messages: form.messages.map(({ text, status }) => ({

package/src/platforms/vtex/utils/canonical.ts

@@ -0,0 +1,3 @@
+import type { Product } from '../clients/search/types/ProductSearchResult'
+
+export const canonicalFromProduct = ({ linkText }: Product) => `/${linkText}/p`

package/src/platforms/vtex/utils/facets.ts

@@ -34,6 +34,12 @@ export const transformSelectedFacet = ({ key, value }: SelectedFacet) => {
   }
 }
 
+export const findSlug = (facets?: Maybe<SelectedFacet[]>) =>
+  facets?.find((x) => x.key === 'slug')?.value ?? null
+
+export const findSkuId = (facets?: Maybe<SelectedFacet[]>) =>
+  facets?.find((x) => x.key === 'id')?.value ?? null
+
 export const findLocale = (facets?: Maybe<SelectedFacet[]>) =>
   facets?.find((x) => x.key === 'locale')?.value ?? null
 

package/src/platforms/vtex/utils/orderStatistics.ts

@@ -0,0 +1,16 @@
+/**
+ * More info at: https://en.wikipedia.org/wiki/Order_statistic
+ */
+
+// O(n) search to find the max of an array
+export const min = <T>(array: T[], cmp: (a: T, b: T) => number) => {
+  let best = 0
+
+  for (let curr = 1; curr < array.length; curr++) {
+    if (cmp(array[best], array[curr]) > 0) {
+      best = curr
+    }
+  }
+
+  return array[best]
+}

package/src/platforms/vtex/utils/sku.ts

@@ -0,0 +1,26 @@
+import { min } from './orderStatistics'
+import { bestOfferFirst } from './productStock'
+import type { Item } from '../clients/search/types/ProductSearchResult'
+
+/**
+ * This function implements Portal heuristics for returning the best sku for a product.
+ *
+ * The best sku is the one with the best (cheapest available) offer
+ * */
+export const pickBestSku = (skus: Item[]) => {
+  const offersBySku = skus.flatMap((sku) =>
+    sku.sellers.map((seller) => ({
+      offer: seller.commertialOffer,
+      sku,
+    }))
+  )
+
+  const best = min(offersBySku, ({ offer: o1 }, { offer: o2 }) =>
+    bestOfferFirst(o1, o2)
+  )
+
+  return best.sku
+}
+
+export const isValidSkuId = (skuId: string) =>
+  skuId !== '' && !Number.isNaN(Number(skuId))