@faststore/api 3.73.0 → 3.78.0

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

@@ -74,6 +74,48 @@ type StoreProduct {
   Advertisement information about the product.
   """
   advertisement: Advertisement
+  """
+  Indicates whether the product has specifications.
+  """
+  hasSpecifications: Boolean
+  """
+  Indicate the specifications of a product.
+  """
+  skuSpecifications: [SkuSpecification!]!
+  """
+  Indicate the specifications of a group of SKUs.
+  """
+  specificationGroups: [SpecificationGroup!]!
+}
+
+type SkuSpecification {
+  field: SKUSpecificationField!
+  values: [SKUSpecificationValue!]!
+}
+
+type SKUSpecificationValue {
+  name: String!
+  id: String
+  fieldId: String
+  originalName: String
+}
+
+type SKUSpecificationField {
+  name: String!
+  originalName: String
+  id: String
+}
+
+type SpecificationGroup {
+  name: String!
+  originalName: String!
+  specifications: [Specification!]!
+}
+
+type Specification {
+  name: String!
+  originalName: String!
+  values: [String!]!
 }
 
 """

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

@@ -275,6 +275,12 @@ type Query {
   ): StoreProductConnection!
     @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
 
+  """
+  Returns information about selected products.
+  """
+  products(productIds: [String!]!): [StoreProduct!]!
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
+
   """
   Returns information about all collections.
   """

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

@@ -26,7 +26,7 @@ type SkuVariants {
   availableVariations(dominantVariantName: String): FormattedVariants
 
   """
-  All possible variant combinations of the current product. It also includes the data for each variant.
+  All available options for each SKU variant property, indexed by their name.
   """
   allVariantProducts: [StoreProduct!]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "3.73.0",
+  "version": "3.78.0",
   "license": "MIT",
   "main": "dist/cjs/src/index.js",
   "typings": "dist/esm/src/index.d.ts",
@@ -73,5 +73,5 @@
   "volta": {
     "extends": "../../package.json"
   },
-  "gitHead": "f24d4ea67a2b356ec12a4fe51e30119c5d84d4f0"
+  "gitHead": "e4853a8c962f5ba4527694ea4b60984fa21e1208"
 }

package/src/__generated__/schema.ts

@@ -861,6 +861,8 @@ export type Query = {
   product: StoreProduct;
   /** Returns the total product count information based on a specific location accessible through the VTEX segment cookie. */
   productCount?: Maybe<ProductCountResult>;
+  /** Returns information about selected products. */
+  products: Array<StoreProduct>;
   /** Returns information about the profile. */
   profile?: Maybe<Profile>;
   /** Returns if there's a redirect for a search. */
@@ -923,6 +925,11 @@ export type QueryProductCountArgs = {
 };
 
 
+export type QueryProductsArgs = {
+  productIds: Array<Scalars['String']>;
+};
+
+
 export type QueryProfileArgs = {
   id: Scalars['String'];
 };
@@ -963,6 +970,21 @@ export type QueryUserOrderArgs = {
   orderId: Scalars['String'];
 };
 
+export type SkuSpecificationField = {
+  __typename?: 'SKUSpecificationField';
+  id?: Maybe<Scalars['String']>;
+  name: Scalars['String'];
+  originalName?: Maybe<Scalars['String']>;
+};
+
+export type SkuSpecificationValue = {
+  __typename?: 'SKUSpecificationValue';
+  fieldId?: Maybe<Scalars['String']>;
+  id?: Maybe<Scalars['String']>;
+  name: Scalars['String'];
+  originalName?: Maybe<Scalars['String']>;
+};
+
 /** Search result. */
 export type SearchMetadata = {
   __typename?: 'SearchMetadata';
@@ -1051,11 +1073,17 @@ export type ShippingSla = {
   shippingEstimateDate?: Maybe<Scalars['String']>;
 };
 
+export type SkuSpecification = {
+  __typename?: 'SkuSpecification';
+  field: SkuSpecificationField;
+  values: Array<SkuSpecificationValue>;
+};
+
 export type SkuVariants = {
   __typename?: 'SkuVariants';
   /** SKU property values for the current SKU. */
   activeVariations?: Maybe<Scalars['ActiveVariations']>;
-  /** All possible variant combinations of the current product. It also includes the data for each variant. */
+  /** All available options for each SKU variant property, indexed by their name. */
   allVariantProducts?: Maybe<Array<StoreProduct>>;
   /** All available options for each SKU variant property, indexed by their name. */
   allVariantsByName?: Maybe<Scalars['VariantsByName']>;
@@ -1088,6 +1116,20 @@ export type SkuVariantsSlugsMapArgs = {
   dominantVariantName?: Maybe<Scalars['String']>;
 };
 
+export type Specification = {
+  __typename?: 'Specification';
+  name: Scalars['String'];
+  originalName: Scalars['String'];
+  values: Array<Scalars['String']>;
+};
+
+export type SpecificationGroup = {
+  __typename?: 'SpecificationGroup';
+  name: Scalars['String'];
+  originalName: Scalars['String'];
+  specifications: Array<Specification>;
+};
+
 /** Account profile information. */
 export type StoreAccountProfile = {
   __typename?: 'StoreAccountProfile';
@@ -1460,6 +1502,8 @@ export type StoreProduct = {
   description: Scalars['String'];
   /** Global Trade Item Number. */
   gtin: Scalars['String'];
+  /** Indicates whether the product has specifications. */
+  hasSpecifications?: Maybe<Scalars['Boolean']>;
   /** Array of images. */
   image: Array<StoreImage>;
   /** Indicates product group related to this product. */
@@ -1478,8 +1522,12 @@ export type StoreProduct = {
   seo: StoreSeo;
   /** Stock Keeping Unit. Merchant-specific ID for the product. */
   sku: Scalars['String'];
+  /** Indicate the specifications of a product. */
+  skuSpecifications: Array<SkuSpecification>;
   /** Corresponding collection URL slug, with which to retrieve this entity. */
   slug: Scalars['String'];
+  /** Indicate the specifications of a group of SKUs. */
+  specificationGroups: Array<SpecificationGroup>;
   /** Sku Unit Multiplier */
   unitMultiplier?: Maybe<Scalars['Float']>;
 };

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

@@ -188,6 +188,12 @@ export const StoreProduct: Record<string, Resolver<Root>> & {
       ...propertyValueAttributes,
     ]
   },
+  hasSpecifications: ({ isVariantOf }) =>
+    Boolean(isVariantOf.skuSpecifications?.length),
+  skuSpecifications: ({ isVariantOf: { skuSpecifications } }) =>
+    skuSpecifications ?? [],
+  specificationGroups: ({ isVariantOf: { specificationGroups } }) =>
+    specificationGroups,
   releaseDate: ({ isVariantOf: { releaseDate } }) => releaseDate ?? '',
   advertisement: ({ isVariantOf: { advertisement } }) => advertisement,
 }

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

@@ -14,6 +14,7 @@ import type {
   QueryShippingArgs,
   QueryUserOrderArgs,
   UserOrderFromList,
+  QueryProductsArgs,
 } from '../../../__generated__/schema'
 import { BadRequestError, ForbiddenError, NotFoundError } from '../../errors'
 import type { CategoryTree } from '../clients/commerce/types/CategoryTree'
@@ -222,6 +223,34 @@ export const Query = {
       })),
     }
   },
+  products: async (
+    _: unknown,
+    { productIds }: QueryProductsArgs,
+    ctx: Context
+  ) => {
+    const {
+      clients: { search },
+    } = ctx
+
+    if (!productIds.length) {
+      return []
+    }
+
+    const query = `id:${productIds.join(';')}`
+    const products = await search.products({
+      page: 0,
+      count: productIds.length,
+      query,
+    })
+
+    return products.products
+      .flatMap((product) =>
+        product.items.map((sku) => enhanceSku(sku, product))
+      )
+      .filter(
+        (sku) => productIds.includes(sku.itemId) && sku.sellers.length > 0
+      )
+  },
   allCollections: async (
     _: unknown,
     { first, after: maybeAfter }: QueryAllCollectionsArgs,

package/src/typeDefs/product.graphql

@@ -74,6 +74,48 @@ type StoreProduct {
   Advertisement information about the product.
   """
   advertisement: Advertisement
+  """
+  Indicates whether the product has specifications.
+  """
+  hasSpecifications: Boolean
+  """
+  Indicate the specifications of a product.
+  """
+  skuSpecifications: [SkuSpecification!]!
+  """
+  Indicate the specifications of a group of SKUs.
+  """
+  specificationGroups: [SpecificationGroup!]!
+}
+
+type SkuSpecification {
+  field: SKUSpecificationField!
+  values: [SKUSpecificationValue!]!
+}
+
+type SKUSpecificationValue {
+  name: String!
+  id: String
+  fieldId: String
+  originalName: String
+}
+
+type SKUSpecificationField {
+  name: String!
+  originalName: String
+  id: String
+}
+
+type SpecificationGroup {
+  name: String!
+  originalName: String!
+  specifications: [Specification!]!
+}
+
+type Specification {
+  name: String!
+  originalName: String!
+  values: [String!]!
 }
 
 """

package/src/typeDefs/query.graphql

@@ -275,6 +275,12 @@ type Query {
   ): StoreProductConnection!
     @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
 
+  """
+  Returns information about selected products.
+  """
+  products(productIds: [String!]!): [StoreProduct!]!
+    @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
+
   """
   Returns information about all collections.
   """

package/src/typeDefs/skuVariants.graphql

@@ -26,7 +26,7 @@ type SkuVariants {
   availableVariations(dominantVariantName: String): FormattedVariants
 
   """
-  All possible variant combinations of the current product. It also includes the data for each variant.
+  All available options for each SKU variant property, indexed by their name.
   """
   allVariantProducts: [StoreProduct!]
 }