@spiffcommerce/core 22.2.1 → 22.3.0-beta.16fa91c4-be20-562e-8dd1-4fa7a696a037

package/dist/index.d.ts

@@ -2115,6 +2115,10 @@ interface WorkflowManager {
      * Returns the client that was responsible for spawning this manager.
      */
     getClient(): SpiffCommerceClient;
+    /**
+     * Returns the worjkflow experience that was responsible for creating this manager.
+     */
+    getWorkflowExperience(): WorkflowExperience;
     /**
      * Re-fetches the transactionShareActions for this WorkflowManager's Transaction object.
      * The updated transactionShareActions overwrite the existing values on the Transaction object returned by `getTransaction()`.
@@ -3051,7 +3055,7 @@ declare const moduleStepService: ModuleStepService;
 declare class DigitalContentStepService implements StepService<DigitalContentStepData> {
     init(stepData: Step<DigitalContentStepData>, workflowManager: WorkflowManager, reducerState?: LayoutsState): Promise<CommandWithFollowup | null>;
     private reload;
-    regenerateQRCode(elements: RegionElement[], uploading: boolean, assetKey: string, url: string, workflowManager: WorkflowManager, stepData: Step<DigitalContentStepData>, setUrl: (finalUrl: string) => void, commandDispatcher: (command: CanvasCommand) => void, setIsRegenerating: (state: boolean) => void): Promise<void>;
+    regenerateQRCode(elements: RegionElement[], assetKey: string, workflowManager: WorkflowManager, stepData: Step<DigitalContentStepData>): Promise<string>;
     private regionElements;
     private command;
 }
@@ -3060,6 +3064,7 @@ declare const digitalContentStepService: DigitalContentStepService;
 declare class MockWorkflowManager implements WorkflowManager {
     private client;
     getClient(): SpiffCommerceClient;
+    getWorkflowExperience(): WorkflowExperience;
     setClient(client: SpiffCommerceClient): void;
     getInitializationPromise(): Promise<void>;
     getProduct: () => Product;
@@ -3484,14 +3489,41 @@ declare function findPmsColors(input: string, limit?: number): PmsSearchResult[]
  */
 declare function browserColorToHex(color: string): string;
 
+/**
+ * The digital content step allows for associating uploaded content with a QR code. This code
+ * can be displayed on the users design such as in a gift card and people can access
+ * the hosted content by scanning the QR.
+ */
 declare class DigitalContentStepHandle extends StepHandle<DigitalContentStepData> {
     constructor(manager: WorkflowManager, step: Step<DigitalContentStepData>);
     selectVariant(): Promise<void>;
+    /**
+     * Returns a preview URL used to show the generated QR code in your UI.
+     */
+    getPreviewURL(): string;
+    /**
+     * Turns an asset into a QR code that can be used to access the content.
+     * @param asset The asset to use for the QR code.
+     * @returns The final URL string for the QR code.
+     */
+    selectVideo(asset: Asset): Promise<string>;
 }
 
 declare class ModuleStepHandle extends StepHandle<ModuleStepData> {
     constructor(manager: WorkflowManager, step: Step<ModuleStepData>);
     selectVariant(): Promise<void>;
+    /**
+     * Return the remaining amount of characters that
+     * the user is allowed to add, or undefined if there is no limit.
+     */
+    getCharactersRemaining(): number | undefined;
+    /**
+     * Return the maximum characters allowed for
+     * this step, or undefined if there is no limit.
+     */
+    getCharacterLimit(): number | undefined;
+    getText(): string;
+    setText(value: string): void;
 }
 
 export { AddonHandle, ArrayInput, AssetNotFoundError, Bundle$1 as Bundle, BundleDesignCreationMessage, BundleEvent, BundleEventData, BundleEventType, CollectionProduct, ColorOption, ColorOptionGlobalPropertyHandle, ConditionalGlobalPropertiesChangedEventData, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, DigitalContentStepHandle, EditedSteps, FileUploadGlobalPropertyHandle, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FrameService, FrameStep, FrameStepHandle, FrameThresholdSettings, GetNewWorkflowOptions, GetWorkflowOptions, GlobalPropertyHandle, IllustrationStepHandle, InformationMessageType, InformationResult, InformationStepHandle, IntegrationProduct, IntegrationType, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, ModuleStepHandle, NodeType, ObjectInput, ObjectInputType, OptionGlobalPropertyHandle, OptionNotFoundError, ParseError, PictureStepHandle, PmsSearchResult, Product, ProductCameraRig, ProductCollection, ProductWorkflow$1 as ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, StepElements, StepHandle, TextGlobalPropertyHandle, TextInput, TextStepHandle, TextStepStorage, ToastCallback, Transaction, TransactionShareAction, TransactionShareActionType, Transform, TransformCollection$1 as TransformCollection, UnhandledBehaviorError, Variant, Vector3, WorkflowExperience, WorkflowExperienceEventType, WorkflowExperienceHoverEventData, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, browserColorToHex, createDesign, designService, digitalContentStepService, findPmsColors, frameStepService, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, matchHexToPms, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, pmsToRgb, questionStepService, rgbToPms, setBearerAuthenticationToken, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };