@bosonprotocol/core-sdk 1.35.1-alpha.1 → 1.36.0-alpha.0

package/src/metadata/bundle.graphql

@@ -0,0 +1,128 @@
+query getBundleMetadataEntityByIdQuery(
+  $metadataId: ID!
+  $metadataSkip: Int
+  $metadataFirst: Int
+  $metadataOrderBy: BundleMetadataEntity_orderBy
+  $metadataOrderDirection: OrderDirection
+  $metadataFilter: BundleMetadataEntity_filter
+) {
+  bundleMetadataEntity(id: $metadataId) {
+    ...BundleMetadataEntityFields
+  }
+}
+
+query getBundleMetadataEntitiesQuery(
+  $metadataSkip: Int
+  $metadataFirst: Int
+  $metadataOrderBy: BundleMetadataEntity_orderBy
+  $metadataOrderDirection: OrderDirection
+  $metadataFilter: BundleMetadataEntity_filter
+) {
+  bundleMetadataEntities(
+    skip: $metadataSkip
+    first: $metadataFirst
+    orderBy: $metadataOrderBy
+    orderDirection: $metadataOrderDirection
+    where: $metadataFilter
+  ) {
+    ...BundleMetadataEntityFields
+  }
+}
+
+fragment BundleMetadataEntityFields on BundleMetadataEntity {
+  ...BaseBundleMetadataEntityFields
+}
+
+fragment BaseBundleMetadataEntityFields on BundleMetadataEntity {
+  id
+  name
+  bundleUuid
+  description
+  externalUrl
+  animationUrl
+  animationMetadata {
+    ...BaseAnimationMetadataFields
+  }
+  licenseUrl
+  condition
+  schemaUrl
+  type
+  image
+  attributes {
+    traitType
+    value
+    displayType
+  }
+  offer {
+    ...BaseOfferFields
+    exchanges {
+    ...BaseExchangeFields
+    }
+  }
+  seller {
+    ...BaseSellerFields
+  }
+  exchangeToken {
+    ...BaseExchangeTokenFields
+  }
+  createdAt
+  voided
+  validFromDate
+  validUntilDate
+  quantityAvailable
+  numberOfCommits
+  numberOfRedemptions
+  productV1Seller {
+    ...BaseProductV1SellerFields
+  }
+  productUuids
+  items {
+    id
+    schemaUrl
+    type
+    metadataUri
+    ... on ProductV1ItemMetadataEntity {
+      uuid
+      productUuid
+      productVersion
+      product {
+        ...BaseProductV1ProductFields
+      }
+      variations {
+        ...BaseProductV1VariationFields
+      }
+      exchangePolicy {
+        ...BaseProductV1ExchangePolicyFields
+      }
+      shipping {
+        ...BaseProductV1ShippingOptionFields
+      }
+      productOverrides {
+        ...BaseProductV1ProductOverridesFields
+      }
+    }
+    ... on NftItemMetadataEntity {
+      name
+      description
+      image
+      externalUrl
+      animationUrl
+      youtubeUrl
+      chainId
+      contract
+      tokenId
+      tokenIdRange {
+        min
+        max
+      }
+      transferMethod
+      transferDelay
+      quantity
+      attributes {
+        traitType
+        value
+        displayType
+      }
+    }
+  }
+}

package/src/metadata/mixin.ts

@@ -8,7 +8,8 @@ import {
   getProductWithVariants,
   getProductWithVariantsFromOfferId,
   getAllProductsWithVariants,
-  getAllProductsWithNotVoidedVariants
+  getAllProductsWithNotVoidedVariants,
+  getBundleMetadataEntities
 } from "./subgraph";
 
 export class MetadataMixin extends BaseCoreSDK {
@@ -68,6 +69,17 @@ export class MetadataMixin extends BaseCoreSDK {
     return getProductV1MetadataEntities(this._subgraphUrl, queryVars);
   }
 
+  /**
+   * Returns `BUNDLE` type offer metadata entities from subgraph.
+   * @param queryVars - Optional query variables to skip, order or filter.
+   * @returns BundleMetadataEntities from subgraph.
+   */
+  public async getBundleMetadataEntities(
+    queryVars?: subgraph.GetBundleMetadataEntitiesQueryQueryVariables
+  ): Promise<subgraph.BundleMetadataEntityFieldsFragment[]> {
+    return getBundleMetadataEntities(this._subgraphUrl, queryVars);
+  }
+
   public async getProductV1Products(
     queryVars?: subgraph.GetProductV1ProductsQueryQueryVariables
   ): Promise<subgraph.BaseProductV1ProductFieldsFragment[]> {
@@ -79,6 +91,7 @@ export class MetadataMixin extends BaseCoreSDK {
     productUuid: string
   ): Promise<{
     product: subgraph.BaseProductV1ProductFieldsFragment;
+    bundles: subgraph.BundleMetadataEntityFieldsFragment[];
     variants: Array<{
       offer: subgraph.OfferFieldsFragment;
       variations: Array<subgraph.ProductV1Variation>;

package/src/metadata/subgraph.ts

@@ -18,8 +18,15 @@ import {
   GetProductV1ProductsWithVariantsQueryQueryVariables,
   BaseProductV1ProductWithNotVoidedVariantsFieldsFragment,
   BaseProductV1ProductWithVariantsFieldsFragment,
-  GetAllProductsWithNotVoidedVariantsQueryQueryVariables
+  GetAllProductsWithNotVoidedVariantsQueryQueryVariables,
+  GetBundleMetadataEntityByIdQueryQueryVariables,
+  GetBundleMetadataEntitiesQueryQueryVariables,
+  BundleMetadataEntityFieldsFragment,
+  ItemMetadataType,
+  ProductV1ItemMetadataEntity
 } from "../subgraph";
+import { productV1 } from "..";
+import { productV1Item } from "@bosonprotocol/metadata";
 
 export type SingleBaseMetadataEntityQueryVariables = Omit<
   GetBaseMetadataEntityByIdQueryQueryVariables,
@@ -31,6 +38,11 @@ export type SingleProductV1MetadataEntityQueryVariables = Omit<
   "metadataId"
 >;
 
+export type SingleBundleMetadataEntityQueryVariables = Omit<
+  GetBundleMetadataEntityByIdQueryQueryVariables,
+  "metadataId"
+>;
+
 export async function getBaseMetadataEntityByOfferId(
   subgraphUrl: string,
   offerId: BigNumberish,
@@ -87,6 +99,34 @@ export async function getProductV1MetadataEntities(
   return productV1MetadataEntities;
 }
 
+export async function getBundleMetadataEntityByOfferId(
+  subgraphUrl: string,
+  offerId: BigNumberish,
+  queryVars: SingleBundleMetadataEntityQueryVariables = {}
+): Promise<BundleMetadataEntityFieldsFragment> {
+  const subgraphSdk = getSubgraphSdk(subgraphUrl);
+  const { bundleMetadataEntity } =
+    await subgraphSdk.getBundleMetadataEntityByIdQuery({
+      metadataId: `${offerId}-metadata`,
+      ...queryVars
+    });
+
+  return bundleMetadataEntity;
+}
+
+export async function getBundleMetadataEntities(
+  subgraphUrl: string,
+  queryVars: GetBundleMetadataEntitiesQueryQueryVariables = {}
+): Promise<BundleMetadataEntityFieldsFragment[]> {
+  const subgraphSdk = getSubgraphSdk(subgraphUrl);
+  const { bundleMetadataEntities = [] } =
+    await subgraphSdk.getBundleMetadataEntitiesQuery({
+      ...queryVars
+    });
+
+  return bundleMetadataEntities;
+}
+
 export async function getProductV1Brands(
   subgraphUrl: string,
   queryVars: GetProductV1BrandsQueryQueryVariables = {}
@@ -157,32 +197,89 @@ export async function getProductWithVariants(
   productUuid: string
 ): Promise<{
   product: BaseProductV1ProductFieldsFragment;
+  bundles: BundleMetadataEntityFieldsFragment[];
   variants: {
     offer: OfferFieldsFragment;
     variations: ProductV1Variation[];
   }[];
 } | null> {
   // Look for ProductV1MetadataEntities, filtered per productUuid
-  const metadataEntities = await getProductV1MetadataEntities(subgraphUrl, {
+  const productV1MetadataEntities = await getProductV1MetadataEntities(
+    subgraphUrl,
+    {
+      metadataFilter: {
+        productUuid,
+        offer_: {
+          sellerId
+        }
+      }
+    }
+  );
+  // Look for BundleMetadataEntities, filtered per productUuid
+  const bundleMetadataEntities = await getBundleMetadataEntities(subgraphUrl, {
     metadataFilter: {
-      productUuid,
+      productUuids_contains: [productUuid],
       offer_: {
         sellerId
       }
     }
   });
-  if (metadataEntities.length === 0) {
+  if (productV1MetadataEntities.length + bundleMetadataEntities.length === 0) {
     return null;
   }
+  const itemsFromBundles = bundleMetadataEntities.reduce((prev, bundle) => {
+    const itemsFromBundle = getProductV1ItemFromBundle(bundle, productUuid);
+    return [...prev, ...itemsFromBundle];
+  }, [] as { productV1Item: ProductV1ItemMetadataEntity; offer: ProductV1MetadataEntityFieldsFragment["offer"] }[]);
+  const product = productV1MetadataEntities.length
+    ? productV1MetadataEntities[0].product
+    : itemsFromBundles[0]?.productV1Item.product;
+  const variants = productV1MetadataEntities.map((m) => {
+    return {
+      offer: m.offer,
+      variations: m.variations
+    };
+  });
+  const variantsFromBundleMap = itemsFromBundles.reduce((map, item) => {
+    if (!map.has(item.offer.id)) {
+      // ensure only add the same offer once
+      map.set(item.offer.id, {
+        offer: item.offer,
+        variations: item.productV1Item.variations
+      });
+    }
+    return map;
+  }, new Map());
+  variants.push(...Array.from(variantsFromBundleMap.values()));
   return {
-    product: metadataEntities[0].product,
-    variants: metadataEntities.map((m) => {
+    product, // return the product
+    bundles: bundleMetadataEntities, // return all bundles that contain this product
+    variants // return all variants for this product
+  };
+}
+
+/** returns the productV1ItemMetadataEntities in a bundle for a given productUuid */
+// Note: it may returns several items, in case the BUNDLE contains different variants of
+// the same product (or even the same variant several times),
+function getProductV1ItemFromBundle(
+  bundle: BundleMetadataEntityFieldsFragment,
+  productUuid: string
+): {
+  productV1Item: ProductV1ItemMetadataEntity;
+  offer: ProductV1MetadataEntityFieldsFragment["offer"];
+}[] {
+  return bundle.items
+    .filter(
+      (item): item is ProductV1ItemMetadataEntity =>
+        item.type === ItemMetadataType.ItemProductV1
+    )
+    .filter((item) => item.productUuid === productUuid)
+    .map((item) => {
       return {
-        offer: m.offer,
-        variations: m.variations
+        productV1Item: item,
+        offer: bundle.offer as ProductV1MetadataEntityFieldsFragment["offer"]
       };
-    })
-  };
+    });
 }
 
 export async function getProductWithVariantsFromOfferId(

package/src/offers/queries.graphql

@@ -84,6 +84,34 @@ query getOffersMediaQuery(
           }
         }
       }
+      ... on BundleMetadataEntity {
+        bundleUuid
+        productV1Seller {
+          images {
+            url
+          }
+        }
+        items {
+          ... on ProductV1ItemMetadataEntity {
+            productOverrides {
+              visuals_images {
+                url
+              }
+              visuals_videos {
+                url
+              }
+            }
+            product {
+              visuals_images {
+                url
+              }
+              visuals_videos {
+                url
+              }
+            }
+          }
+        }
+      }
     }
   }
 }
@@ -189,6 +217,67 @@ fragment BaseOfferFields on Offer {
         ...BaseProductV1ShippingOptionFields
       }
     }
+    ... on BundleMetadataEntity {
+      bundleUuid
+      attributes {
+        traitType
+        value
+        displayType
+      }
+      createdAt
+      voided
+      validFromDate
+      validUntilDate
+      quantityAvailable
+      productV1Seller {
+        ...BaseProductV1SellerFields
+      }
+      items {
+        type
+        metadataUri
+        ... on ProductV1ItemMetadataEntity {
+          uuid
+          product {
+            ...BaseProductV1ProductFields
+          }
+          variations {
+            ...BaseProductV1VariationFields
+          }
+          exchangePolicy {
+            ...BaseProductV1ExchangePolicyFields
+          }
+          shipping {
+            ...BaseProductV1ShippingOptionFields
+          }
+          productOverrides {
+            ...BaseProductV1ProductOverridesFields
+          }
+        }
+        ... on NftItemMetadataEntity {
+          name
+          description
+          image
+          externalUrl
+          animationUrl
+          youtubeUrl
+          chainId
+          contract
+          tokenId
+          tokenIdRange {
+            min
+            max
+          }
+          transferMethod
+          transferDelay
+          quantity
+          attributes {
+            traitType
+            value
+            displayType
+          }
+        }
+      }
+    }
   }
   range {
     ...BaseRangeFields