@spiffcommerce/core 21.1.1 → 21.1.2

package/dist/index.d.ts

@@ -1667,6 +1667,76 @@ declare abstract class GlobalPropertyHandle {
      */
     protected getSharedSteps(targetExperiences?: WorkflowExperience[]): StepHandle<_spiffcommerce_papyrus.AnyStepData>[];
 }
+/**
+ * A file upload global property allows for setting a frame image against all shared steps.
+ */
+declare class FileUploadGlobalPropertyHandle extends GlobalPropertyHandle {
+    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect);
+    /**
+     * Select an image to be used for all shared steps.
+     * @param asset The asset to use.
+     * @returns A promise resolving when all affected steps have been updated.
+     */
+    selectImage(asset: Asset): Promise<void>;
+    applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
+    private applyImageSelection;
+}
+declare class TextGlobalPropertyHandle extends GlobalPropertyHandle {
+    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect);
+    /**
+     * Gets the current text
+     */
+    getText(): string;
+    /**
+     * Set the text.
+     */
+    setText(text: string): Promise<void>;
+    applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
+    private applyTextSelection;
+}
+/**
+ * An option property handle represents a property that can
+ * affect the option of steps across multiple transactions.
+ */
+declare class OptionGlobalPropertyHandle extends GlobalPropertyHandle {
+    protected optionResource?: OptionResource;
+    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect, optionResource: OptionResource | undefined);
+    /**
+     * Gets the currently selected variant, or undefined if no variant is selected.
+     */
+    getCurrentVariant(): Variant | undefined;
+    /**
+     * @returns A list of valid variants for this step. Does not include disabled variants.
+     */
+    getAvailableVariants(): Variant[];
+    /**
+     * @returns A list of all variants for this step, including disabled ones.
+     */
+    getAllVariants(): Variant[];
+    /**
+     * Select a given variant on the option for all shared steps.
+     * @param variant The variant to select.
+     */
+    selectVariant(variant: Variant): Promise<void>;
+    applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
+    private applyVariantSelection;
+}
+/**
+ * A color option property handle represents a property that can
+ * affect the option of steps across multiple transactions. This class is a specialization of the OptionGlobalPropertyHandle which includes functionality for
+ * setting custom color values when a custom color variant is selected.
+ */
+declare class ColorOptionGlobalPropertyHandle extends OptionGlobalPropertyHandle {
+    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect, optionResource: OptionResource | undefined);
+    /**
+     * Sets a custom color on the global state.
+     */
+    setCustomColor(color: string): void;
+    /**
+     * Gets the custom color used by the global state.
+     */
+    getCustomColor(): string;
+}
 
 interface GlobalPropertyStateManager {
     getInitializationPromise(): Promise<void>;
@@ -3032,4 +3102,4 @@ declare class PromiseCache {
 }
 declare const promiseCache: PromiseCache;
 
-export { ArrayInput, AssetNotFoundError, Bundle, BundleDesignCreationMessage, BundleEvent, BundleEventData, BundleEventType, CollectionProduct, ColorOption, ConditionalGlobalPropertiesChangedEventData, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FrameService, FrameStep, FrameStepHandle, FrameThresholdSettings, GetNewWorkflowOptions, GetWorkflowOptions, GlobalPropertyHandle, IllustrationStepHandle, InformationMessageType, InformationResult, InformationStepHandle, IntegrationProduct, IntegrationType, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, NodeType, ObjectInput, ObjectInputType, OptionNotFoundError, ParseError, PictureStepHandle, Product, ProductCameraRig, ProductCollection, ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, StepElements, StepHandle, TextInput, TextStepHandle, TextStepStorage, Transaction, Transform, TransformCollection, UnhandledBehaviorError, Variant, Vector3, WorkflowExperience, WorkflowExperienceEventType, WorkflowExperienceHoverEventData, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, createDesign, designService, digitalContentStepService, frameStepService, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, questionStepService, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };
+export { ArrayInput, AssetNotFoundError, Bundle, BundleDesignCreationMessage, BundleEvent, BundleEventData, BundleEventType, CollectionProduct, ColorOption, ColorOptionGlobalPropertyHandle, ConditionalGlobalPropertiesChangedEventData, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FileUploadGlobalPropertyHandle, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FrameService, FrameStep, FrameStepHandle, FrameThresholdSettings, GetNewWorkflowOptions, GetWorkflowOptions, GlobalPropertyHandle, IllustrationStepHandle, InformationMessageType, InformationResult, InformationStepHandle, IntegrationProduct, IntegrationType, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, NodeType, ObjectInput, ObjectInputType, OptionGlobalPropertyHandle, OptionNotFoundError, ParseError, PictureStepHandle, Product, ProductCameraRig, ProductCollection, ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, StepElements, StepHandle, TextGlobalPropertyHandle, TextInput, TextStepHandle, TextStepStorage, Transaction, Transform, TransformCollection, UnhandledBehaviorError, Variant, Vector3, WorkflowExperience, WorkflowExperienceEventType, WorkflowExperienceHoverEventData, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, createDesign, designService, digitalContentStepService, frameStepService, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, questionStepService, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };

package/dist/index.js

@@ -10789,12 +10789,14 @@ export {
   Xi as BringToFrontCommand,
   qi as CanvasCommand,
   Oe as CollectionProduct,
+  Wa as ColorOptionGlobalPropertyHandle,
   Zi as CommandContext,
   cn as ConversionDataType,
   rn as ConversionLocation,
   $i as CreateElementCommand,
   _i as CreateLayoutCommand,
   es as DeleteElementCommand,
+  ja as FileUploadGlobalPropertyHandle,
   Qe as FlowExecutionNodeResult,
   ii as FlowExecutionResult,
   ai as FlowService,
@@ -10822,6 +10824,7 @@ export {
   rs as MoveCommand,
   dt as ObjectInput,
   si as ObjectInputType,
+  Bt as OptionGlobalPropertyHandle,
   Me as OptionNotFoundError,
   oe as ParseError,
   Aa as PictureStepHandle,
@@ -10843,6 +10846,7 @@ export {
   W as StepHandle,
   ds as StepType,
   ws as TextChangeCommand,
+  Va as TextGlobalPropertyHandle,
   bi as TextInput,
   aa as TextStepHandle,
   ti as Transform,