@spiffcommerce/core 19.3.3 → 20.0.0

package/dist/index.d.ts

@@ -1638,7 +1638,11 @@ declare class ProductCollection {
     /**
      * A list of products in this collections with useful helpers for interacting with them.
      */
-    getProducts(): Promise<CollectionProduct[]>;
+    getProducts(): CollectionProduct[];
+    /**
+     * A list of products in this collections with useful helpers for interacting with them.
+     */
+    fetchProducts(): Promise<CollectionProduct[]>;
     getTransformCollection(): TransformCollection | undefined;
     /**
      * The raw collection resource. This is generally not needed and should be avoided.
@@ -2152,6 +2156,23 @@ interface ClientOptions {
      */
     applicationKey?: string;
 }
+interface GetBundleGraphqlAssetsOptions {
+    metadata?: boolean;
+}
+interface GetBundleGraphqlProductCollectionOptions {
+    eagerFetchProducts?: boolean;
+}
+interface GetBundleGraphqlOptions {
+    productCollection?: GetBundleGraphqlProductCollectionOptions;
+    assets?: GetBundleGraphqlAssetsOptions;
+}
+interface GetBundleOptions {
+    /**
+     * Configuration for the graphQL request made for bundles. Allows for retrieval
+     * of additional data.
+     */
+    graphql?: GetBundleGraphqlOptions;
+}
 interface GetWorkflowGraphqlAssetsOptions {
     metadata?: boolean;
 }
@@ -2164,7 +2185,7 @@ interface GetWorkflowOptionsBase {
      */
     previewService?: ThreeDPreviewService;
     /**
-     * Coniguration related to the
+     * Configuration related to the
      * workflow and how the system interprets it.
      */
     workflowConfiguration?: {
@@ -2290,7 +2311,7 @@ declare class SpiffCommerceClient {
      */
     getNewBundle(collectionId?: string, initialMetadata?: {
         [key: string]: string;
-    }): Promise<Bundle>;
+    }, options?: GetBundleOptions): Promise<Bundle>;
     /**
      * Retrieves an existing bundle from the API, by id.
      * @param bundleId The id of the bundle to retrieve.
@@ -2298,7 +2319,11 @@ declare class SpiffCommerceClient {
      * @param graphqlOptions Optional: Options to configure loading the workflow.
      * @returns A bundle to be used for grouping and operating on large amounts of workflow experiences.
      */
-    getExistingBundle(bundleId: string, previewService?: ThreeDPreviewService, graphqlOptions?: GetWorkflowGraphqlOptions): Promise<Bundle>;
+    getExistingBundle(bundleId: string, previewService?: ThreeDPreviewService, 
+    /**
+     * @deprecated use GetBundleOptions instead. This attribute will be removed in the future.
+     */
+    graphqlOptions?: GetBundleGraphqlOptions, options?: GetBundleOptions): Promise<Bundle>;
     /**
      * Retrieves all existing bundle stakeholders from the API, for the currently authenticated customer.
      * @returns An array of bundle stakeholders.