@spiffcommerce/core 26.25.0 → 26.26.1

package/CHANGELOG.md

@@ -14,7 +14,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -   `Fixed` for any bug fixes.
 -   `Security` in case of vulnerabilities.
 
-## [26.25.0] - 21-05-2025
+## [26.26.0] - 27-05-2025
+
+### Changed
+
+-   The event emitter on `Bundle` has been improved and made generic. Two new events will also now fire. One for a workflow being added and one for a workflow being removed.
 
 ### Added
 

package/dist/index.d.ts

@@ -1715,6 +1715,28 @@ declare class Transform {
     get(): BundleStateTransform;
 }
 
+interface ConditionalGlobalPropertiesChangedEventData {
+    globalProperties: GlobalPropertyHandle[];
+}
+interface WorkflowExperienceHoverEventData {
+    workflowExperience: WorkflowExperience;
+}
+interface WorkflowExperienceAddedEventData {
+    workflowExperiences: WorkflowExperience[];
+}
+interface WorkflowExperienceRemovedEventData extends WorkflowExperienceAddedEventData {
+}
+type BundleEventMap = {
+    "conditional-global-properties-changed": ConditionalGlobalPropertiesChangedEventData;
+    "workflow-experience-hover-enter": WorkflowExperienceHoverEventData;
+    "workflow-experience-hover-exit": WorkflowExperienceHoverEventData;
+    "workflow-experience-added": WorkflowExperienceAddedEventData;
+    "workflow-experience-removed": WorkflowExperienceRemovedEventData;
+};
+type BundleEventType = keyof BundleEventMap;
+type BundleEventData = WorkflowExperienceHoverEventData | ConditionalGlobalPropertiesChangedEventData | WorkflowExperienceAddedEventData;
+type BundleEvent<K extends BundleEventType = BundleEventType> = BundleEventMap[K];
+
 /**
  * A bundle serves as a container for a set of workflow experience.
  */
@@ -1882,11 +1904,11 @@ interface Bundle$1 {
      * @param event The event to listen for. Currently only "conditional-global-properties-changed" is supported.
      * @param listener The listener to call when the event occurs.
      */
-    addEventListener(event: BundleEventType, listener: (e: BundleEvent) => void): void;
+    addEventListener<K extends keyof BundleEventMap>(event: K, listener: (event: BundleEvent<K>) => void): void;
     /**
      * Remove a previously added event listener from this bundle.
      */
-    removeEventListener(event: BundleEventType, listener: (e: BundleEvent) => void): void;
+    removeEventListener<K extends keyof BundleEventMap>(event: K, listener: (event: BundleEvent<K>) => void): void;
     /**
      * Retrieves the current preview service for this bundle, if one exists.
      * If a preview service was specified when calling client.getExistingBundle, this will return that service.
@@ -1939,19 +1961,6 @@ interface Bundle$1 {
     generateQuoteId(): Promise<string>;
     getQuoteCompleteMessage(): CompleteQuoteMessage;
 }
-type BundleEventType = "conditional-global-properties-changed" | "workflow-experience-hover-enter" | "workflow-experience-hover-exit";
-type BundleEventData = ConditionalGlobalPropertiesChangedEventData | WorkflowExperienceHoverEventData;
-type BundleEvent = {
-    bundle: Bundle$1;
-    data: BundleEventData;
-    event: BundleEventType;
-};
-interface ConditionalGlobalPropertiesChangedEventData {
-    globalProperties: GlobalPropertyHandle[];
-}
-interface WorkflowExperienceHoverEventData {
-    workflowExperience: WorkflowExperience;
-}
 
 /**
  * A list of node types available in executions