@spiffcommerce/core 14.13.2 → 15.0.0

package/dist/types.d.ts

@@ -733,15 +733,33 @@ export interface Transaction {
      */
     stakeholders?: Stakeholder[];
 }
+/**
+ * An integration product represents the connection of a product in SpiffCommerce with
+ * a product on a third party platform.
+ */
 interface IntegrationProduct {
+    /**
+     * The ID of the IntegrationProduct entity. Used internally by SpiffCommerce.
+     */
     id: string;
+    /**
+     * The ID of the product on the third party platform. For example a Shopify product ID.
+     */
     externalProductId?: string;
+    /**
+     * The integration that this product is associated with. For example a Shopify integration.
+     */
     integration?: Integration;
 }
 interface Integration {
     id: string;
     enabled: boolean;
     externalIntegrationId?: string;
+    integrationType?: IntegrationType;
+}
+enum IntegrationType {
+    Hub = "Hub",
+    Shopify = "Shopify"
 }
 /**
  * Fields found in a variant within a line item resource.
@@ -1058,7 +1076,7 @@ interface _Bundle1 {
     }[];
     name?: string;
     partner?: Partner;
-    productCollection?: ProductCollection;
+    productCollection?: ProductCollectionResource;
     transactions?: Transaction[];
 }
 interface BundleStakeholder {
@@ -1071,7 +1089,7 @@ interface BundleStakeholderInput {
     type: StakeholderType;
     customerDetails: CustomerDetailsInput;
 }
-type ProductCollection = {
+type ProductCollectionResource = {
     id: string;
     globalPropertyConfiguration?: GlobalPropertyConfiguration;
     name: string;
@@ -1462,12 +1480,17 @@ export class Variant {
      * @returns The URL for the base asset resource configured on this variant
      */
     getAsset(): string | undefined;
+    /**
+     * @returns The URL for the base asset resource configured on this variant
+     */
+    getAssetResource(): _Asset1 | undefined;
     /**
      * @returns The URL for a thumbnail resource configured on this variant. When no thumbnail is configured explicitly we fall back to the base asset and see if a thumbnail is genererated for that.
      */
     getThumbnail(): string | undefined;
     /**
      * @returns The URL for the display image configured on this variant. Can be used for things like size charts.
+     * @deprecated To be removed in a future version
      */
     getDisplayImage(): string | undefined;
     /**
@@ -2070,6 +2093,57 @@ interface GlobalPropertyStateManager {
     getAspect(name: string): string | undefined;
     setAspect(name: string, value: string): Promise<void>;
 }
+/**
+ * A collection of products that can be used to form a bundle.
+ */
+export class ProductCollection {
+    constructor(collection: ProductCollectionResource);
+    /**
+     * The ID of the product collection.
+     */
+    getId(): string;
+    /**
+     * The name of the collection.
+     */
+    getName(): string;
+    /**
+     * A list of products in this collections with useful helpers for interacting with them.
+     */
+    getProducts(): CollectionProduct[];
+    /**
+     * The raw collection resource. This is generally not needed and should be avoided.
+     */
+    getResource(): ProductCollectionResource;
+}
+/**
+ * A collection product is a product within a ProductCollection. It provides a simple interface for interacting with the product.
+ */
+export class CollectionProduct {
+    constructor(product: Product);
+    /**
+     * The ID of the product in SpiffCommerce.
+     * @returns
+     */
+    getId(): string;
+    /**
+     * The name of the product. Human readable.
+     */
+    getName(): string;
+    /**
+     * A helper function for getting integrations
+     * @param type The type of integration you want.
+     * @returns The integration if found. Throws an error if not found as this data is typically a neccesity.
+     */
+    getIntegrationByType(type: IntegrationType): IntegrationProduct;
+    /**
+     * A list of all integrations this product is connected to.
+     */
+    getIntegrations(): IntegrationProduct[];
+    /**
+     * The raw product resource. This is generally not needed and should be avoided.
+     */
+    getResource(): Product;
+}
 /**
  * A bundle serves as a container for a set of workflow experience.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "14.13.2",
+    "version": "15.0.0",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",
@@ -89,7 +89,7 @@
     },
     "dependencies": {
         "@apollo/client": "^3.7.0",
-        "@spiffcommerce/papyrus": "5.0.3",
+        "@spiffcommerce/papyrus": "5.0.4",
         "cross-fetch": "^3.1.5",
         "graphql": "^16.6.0",
         "lodash.clonedeep": "^4.5.0",