@spiffcommerce/core 22.3.0 → 22.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -3069,7 +3069,7 @@ declare const moduleStepService: ModuleStepService;
3069
3069
  declare class DigitalContentStepService implements StepService<DigitalContentStepData> {
3070
3070
  init(stepData: Step<DigitalContentStepData>, workflowManager: WorkflowManager, reducerState?: LayoutsState): Promise<CommandWithFollowup | null>;
3071
3071
  private reload;
3072
- 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>;
3072
+ regenerateQRCode(elements: RegionElement[], assetKey: string, workflowManager: WorkflowManager, stepData: Step<DigitalContentStepData>): Promise<string>;
3073
3073
  private regionElements;
3074
3074
  private command;
3075
3075
  }
@@ -3503,14 +3503,41 @@ declare function findPmsColors(input: string, limit?: number): PmsSearchResult[]
3503
3503
  */
3504
3504
  declare function browserColorToHex(color: string): string;
3505
3505
 
3506
+ /**
3507
+ * The digital content step allows for associating uploaded content with a QR code. This code
3508
+ * can be displayed on the users design such as in a gift card and people can access
3509
+ * the hosted content by scanning the QR.
3510
+ */
3506
3511
  declare class DigitalContentStepHandle extends StepHandle<DigitalContentStepData> {
3507
3512
  constructor(manager: WorkflowManager, step: Step<DigitalContentStepData>);
3508
3513
  selectVariant(): Promise<void>;
3514
+ /**
3515
+ * Returns a preview URL used to show the generated QR code in your UI.
3516
+ */
3517
+ getPreviewURL(): string;
3518
+ /**
3519
+ * Turns an asset into a QR code that can be used to access the content.
3520
+ * @param asset The asset to use for the QR code.
3521
+ * @returns The final URL string for the QR code.
3522
+ */
3523
+ selectVideo(asset: Asset): Promise<string>;
3509
3524
  }
3510
3525
 
3511
3526
  declare class ModuleStepHandle extends StepHandle<ModuleStepData> {
3512
3527
  constructor(manager: WorkflowManager, step: Step<ModuleStepData>);
3513
3528
  selectVariant(): Promise<void>;
3529
+ /**
3530
+ * Return the remaining amount of characters that
3531
+ * the user is allowed to add, or undefined if there is no limit.
3532
+ */
3533
+ getCharactersRemaining(): number | undefined;
3534
+ /**
3535
+ * Return the maximum characters allowed for
3536
+ * this step, or undefined if there is no limit.
3537
+ */
3538
+ getCharacterLimit(): number | undefined;
3539
+ getText(): string;
3540
+ setText(value: string): void;
3514
3541
  }
3515
3542
 
3516
3543
  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 };