@spiffcommerce/core 22.5.2 → 22.6.0

package/dist/index.d.ts

@@ -523,7 +523,11 @@ declare abstract class StepHandle<T extends AnyStepData> {
      * The step metadata, useful for determining logic based on configuration.
      */
     protected readonly step: Step<T>;
-    constructor(manager: WorkflowManager, step: Step<T>);
+    /**
+     * The tags set against this step.
+     */
+    protected readonly tags: string[];
+    constructor(manager: WorkflowManager, step: Step<T>, tags: string[]);
     /**
      * Set the current update state of this step. All step handles pointing to this step will
      * see this value.
@@ -706,6 +710,9 @@ interface ExperienceOptions {
     product: Product;
     transaction: Transaction;
     workflow?: Workflow;
+    stepTags?: {
+        [stepId: string]: string[];
+    };
     /**
      * @deprecated favor inject / eject functions.
      */
@@ -1151,11 +1158,14 @@ interface GlobalPropertyStateManager {
     setAspect(name: string, value: string, storage?: GlobalPropertyStateAspectStorage | null): Promise<void>;
     setAspectStorage<S extends GlobalPropertyStateAspectStorage>(name: string, storage: S | null): Promise<void>;
     setBundleOptions(bundleOptions?: BundleOptions): void;
+    getBundleOptions(): BundleOptions | undefined;
+    setConfiguration(configuration: GlobalPropertyConfiguration | undefined): void;
 }
 interface BundleOptions {
     additionalHeaders?: {
         [key: string]: string;
     };
+    eagerFetchProducts?: boolean;
 }
 
 /**
@@ -1508,6 +1518,11 @@ interface Bundle$1 {
      */
     getGlobalPropertyConfiguration(): GlobalPropertyConfiguration | undefined;
     setBundleOptions(bundleOptions?: BundleOptions): any;
+    /**
+     * Assigns a Product Collection to the Bundle. This will only succeed if the Bundle does not already have a Product Collection assigned to it.
+     * @param productCollectionId The ID of the Product Collection to assign to this Bundle.
+     */
+    assignProductCollection(productCollectionId: string): Promise<void>;
 }
 type BundleEventType = "conditional-global-properties-changed" | "workflow-experience-hover-enter" | "workflow-experience-hover-exit";
 type BundleEventData = ConditionalGlobalPropertiesChangedEventData | WorkflowExperienceHoverEventData;
@@ -1901,6 +1916,7 @@ declare class SpiffCommerceClient {
      * @returns An array of bundle stakeholders.
      */
     getBundleStakeholders(): Promise<BundleStakeholder[]>;
+    private getStepTags;
     /**
      * Creates a new instance of WorkflowExperience. A high level wrapper for workflows.
      * @param workflowId The id of the workflow to be run. Deprecated: Provide options instead.
@@ -2142,6 +2158,10 @@ interface WorkflowManager {
      * The updated stakeholders and currentStakeholder overwrite the existing values on the Transaction object returned by `getTransaction()`.
      */
     updateTransactionStakeholders(): Promise<void>;
+    /**
+     * Returns the tags for a step.
+     */
+    getStepTags(stepId: string): string[];
 }
 
 interface StepService<T extends AnyStepData> {
@@ -3159,12 +3179,13 @@ declare class MockWorkflowManager implements WorkflowManager {
         steps: Map<any, any>;
     };
     updateTransactionStakeholders(): Promise<void>;
+    getStepTags(_stepId: string): string[];
 }
 
 declare const generateCommands: (designInputSteps: DesignInputStep[], workflow: Workflow, layouts: ILayout[], productOverlayImageUrl?: string) => Promise<CanvasCommand[]>;
 
 declare class IllustrationStepHandle extends StepHandle<IllustrationStepData> {
-    constructor(manager: WorkflowManager, step: Step<IllustrationStepData>);
+    constructor(manager: WorkflowManager, step: Step<IllustrationStepData>, tags: string[]);
     /**
      * Allows for select a vector from the available vectors configured on this steps base option.
      * @param variant The new vector variant to use for this step.
@@ -3197,7 +3218,7 @@ interface TextChangeResult {
     errorText?: string;
 }
 declare class TextStepHandle extends StepHandle<TextStepData> implements CustomColorSupport {
-    constructor(manager: WorkflowManager, step: Step<TextStepData>);
+    constructor(manager: WorkflowManager, step: Step<TextStepData>, tags: string[]);
     /**
      * Allows for select a font from the available fonts configured on this steps base option.
      * @param variant The font variant to use.
@@ -3260,7 +3281,7 @@ declare class TextStepHandle extends StepHandle<TextStepData> implements CustomC
 }
 
 declare class PictureStepHandle extends StepHandle<PictureStepData> {
-    constructor(manager: WorkflowManager, step: Step<PictureStepData>);
+    constructor(manager: WorkflowManager, step: Step<PictureStepData>, tags: string[]);
     /**
      * Allows the user to select an image variant from the available variants configured on this steps base option.
      * @param variant The new image variant to use.
@@ -3344,7 +3365,7 @@ declare class ParseError extends ImplementationError {
 }
 
 declare class ModelStepHandle extends StepHandle<ModelStepData> {
-    constructor(manager: WorkflowManager, step: Step<ModelStepData>);
+    constructor(manager: WorkflowManager, step: Step<ModelStepData>, tags: string[]);
     selectVariant(variant: Variant): Promise<void>;
 }
 
@@ -3354,7 +3375,7 @@ declare enum FrameStep {
     Position = "Position"
 }
 declare class FrameStepHandle extends StepHandle<FrameStepData> {
-    constructor(manager: WorkflowManager, step: Step<FrameStepData>);
+    constructor(manager: WorkflowManager, step: Step<FrameStepData>, tags: string[]);
     private frameService;
     selectVariant(variant: Variant): Promise<void>;
     onFrameDataChanged(callback: (frameData: FrameData$1[]) => void): void;
@@ -3404,12 +3425,12 @@ declare class FrameStepHandle extends StepHandle<FrameStepData> {
 }
 
 declare class MaterialStepHandle extends StepHandle<MaterialStepData> {
-    constructor(manager: WorkflowManager, step: Step<MaterialStepData>);
+    constructor(manager: WorkflowManager, step: Step<MaterialStepData>, tags: string[]);
     selectVariant(variant: Variant): Promise<void>;
 }
 
 declare class QuestionStepHandle extends StepHandle<QuestionStepData> {
-    constructor(manager: WorkflowManager, step: Step<QuestionStepData>);
+    constructor(manager: WorkflowManager, step: Step<QuestionStepData>, tags: string[]);
     selectVariant(variant: Variant): Promise<void>;
     /**
      * The way that this step expects to be rendered.
@@ -3418,7 +3439,7 @@ declare class QuestionStepHandle extends StepHandle<QuestionStepData> {
 }
 
 declare class ShapeStepHandle extends StepHandle<ShapeStepData> implements CustomColorSupport {
-    constructor(manager: WorkflowManager, step: Step<ShapeStepData>);
+    constructor(manager: WorkflowManager, step: Step<ShapeStepData>, tags: string[]);
     selectVariant(variant: Variant): Promise<void>;
     /**
      * Sets the color of the shape.
@@ -3447,7 +3468,7 @@ declare class ShapeStepHandle extends StepHandle<ShapeStepData> implements Custo
 declare const shortenUrl: (longUrl: string) => Promise<string>;
 
 declare class InformationStepHandle extends StepHandle<InformationStepData> {
-    constructor(manager: WorkflowManager, step: Step<InformationStepData>);
+    constructor(manager: WorkflowManager, step: Step<InformationStepData>, tags: string[]);
     selectVariant(): Promise<void>;
     /**
      * The way that this step expects to be rendered.
@@ -3513,7 +3534,7 @@ declare function browserColorToHex(color: string): string;
  * the hosted content by scanning the QR.
  */
 declare class DigitalContentStepHandle extends StepHandle<DigitalContentStepData> {
-    constructor(manager: WorkflowManager, step: Step<DigitalContentStepData>);
+    constructor(manager: WorkflowManager, step: Step<DigitalContentStepData>, tags: string[]);
     selectVariant(): Promise<void>;
     /**
      * Returns a preview URL used to show the generated QR code in your UI.
@@ -3528,7 +3549,7 @@ declare class DigitalContentStepHandle extends StepHandle<DigitalContentStepData
 }
 
 declare class ModuleStepHandle extends StepHandle<ModuleStepData> {
-    constructor(manager: WorkflowManager, step: Step<ModuleStepData>);
+    constructor(manager: WorkflowManager, step: Step<ModuleStepData>, tags: string[]);
     selectVariant(): Promise<void>;
     /**
      * Return the remaining amount of characters that