@spiffcommerce/core 0.10.184 → 0.10.186

package/dist/types.d.ts

@@ -24,6 +24,23 @@ declare class GraphQlManager {
     getShadowGraphqlClient(): ApolloClient<any>;
 }
 export const graphQlManager: GraphQlManager;
+/**
+ * A renderable scene is a scene that can be displayed to the user. This is based on the workflow state.
+ */
+export interface RenderableScene {
+    /**
+     * The id of the scene.
+     */
+    id: string;
+    /**
+     * The title of the scene.
+     */
+    title: string;
+    /**
+     * The id of each step inside the scene that can be rendered. This is based on the workflow state.
+     */
+    renderableSteps: string[];
+}
 /**
  * Information parsed froma workflow structure that is relevant
  * to a given scene.
@@ -1256,7 +1273,7 @@ export class BulkStepHandle extends StepHandle<_BulkStepData1> {
     /**
      * @param variant The variant to select. This is not supported in the bulk step.
      */
-    selectVariant(variant: _VariantResource1): Promise<void>;
+    selectVariant(): Promise<void>;
     setDesignName(designName: string): Promise<void>;
     addVariationRecord(): VariationRecord;
     updateBulkIsConnected(bulkIsConnected: boolean): void;
@@ -1521,6 +1538,16 @@ export interface WorkflowExperience {
      * @param scene The scene you want the steps for.
      */
     getStepsByScene(scene: StepGroup): StepHandle<_AnyStepData1>[];
+    /**
+     * Attaches a listener to the scenes on a workflow experience. The scenes returned are a subset of the scenes configured in the
+     * workflow and are based on the current state of the experience. This is useful for building a navigation menu.
+     * @param cb The callback to be called when the scenes change. The new scenes are passed as an argument.
+     */
+    attachRenderableSceneListener(cb: (scenes: RenderableScene[]) => void): void;
+    /**
+     * Detaches a listener from the scenes on a workflow experience.
+     */
+    detachRenderableSceneListener(cb: (scenes: RenderableScene[]) => void): void;
     /**
      * Saves this experience to storage. This may be local or remote depending
      * on configuration.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "0.10.184",
+    "version": "0.10.186",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",