@spiffcommerce/core 13.0.0 → 13.1.0

package/dist/types.d.ts

@@ -1909,10 +1909,6 @@ export class FrameStepHandle extends StepHandle<_FrameStepData1> {
     hasVaryingUpload(): boolean | undefined;
     hasVaryingSelection(): boolean | undefined;
 }
-/**
- * TODO: Add GlobalPropertyState mutation & queries to bundle.
- * TODO: Optimize workflow experience state updates.
- */
 /**
  * A GlobalPropertyHandle acts as an interface to global properties on our platform. Currently
  * bundles can return a handle for any global properties associated to the collection.
@@ -1922,9 +1918,13 @@ declare abstract class GlobalPropertyHandle {
     protected readonly property: GlobalPropertyConfigurationAspect;
     constructor(bundle: _Bundle1, property: GlobalPropertyConfigurationAspect);
     /**
-     * @returns The human friendly name of the property.
+     * @returns The name of the global property. This is the key used to store the property in the state.
      */
     getName(): string;
+    /**
+     * @returns A human friendly title.
+     */
+    getTitle(): string;
     /**
      * @returns A human friendly description.
      */
@@ -2055,7 +2055,18 @@ interface _Bundle1 {
      * helpful details like what product to add to cart on supported e-commerce platforms.
      */
     finish(): Promise<DesignCreationMessage[]>;
+    /**
+     * Add an event listener to this bundle.
+     * @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: BundleEvent, listener: () => void): void;
+    /**
+     * Remove a previously added event listener from this bundle.
+     */
+    removeEventListener(event: BundleEvent, listener: () => void): void;
 }
+type BundleEvent = "conditional-global-properties-changed";
 export const getWorkflow: (id: string) => Promise<_Workflow1>;
 /**
  * Options that can be used during instantiation of the SpiffCommerce Javascript Client.

package/package.json

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