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

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
@@ -3055,7 +3055,7 @@ declare const moduleStepService: ModuleStepService;
3055
3055
  declare class DigitalContentStepService implements StepService<DigitalContentStepData> {
3056
3056
  init(stepData: Step<DigitalContentStepData>, workflowManager: WorkflowManager, reducerState?: LayoutsState): Promise<CommandWithFollowup | null>;
3057
3057
  private reload;
3058
- 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>;
3058
+ regenerateQRCode(elements: RegionElement[], assetKey: string, workflowManager: WorkflowManager, stepData: Step<DigitalContentStepData>): Promise<string>;
3059
3059
  private regionElements;
3060
3060
  private command;
3061
3061
  }
@@ -3489,14 +3489,41 @@ declare function findPmsColors(input: string, limit?: number): PmsSearchResult[]
3489
3489
  */
3490
3490
  declare function browserColorToHex(color: string): string;
3491
3491
 
3492
+ /**
3493
+ * The digital content step allows for associating uploaded content with a QR code. This code
3494
+ * can be displayed on the users design such as in a gift card and people can access
3495
+ * the hosted content by scanning the QR.
3496
+ */
3492
3497
  declare class DigitalContentStepHandle extends StepHandle<DigitalContentStepData> {
3493
3498
  constructor(manager: WorkflowManager, step: Step<DigitalContentStepData>);
3494
3499
  selectVariant(): Promise<void>;
3500
+ /**
3501
+ * Returns a preview URL used to show the generated QR code in your UI.
3502
+ */
3503
+ getPreviewURL(): string;
3504
+ /**
3505
+ * Turns an asset into a QR code that can be used to access the content.
3506
+ * @param asset The asset to use for the QR code.
3507
+ * @returns The final URL string for the QR code.
3508
+ */
3509
+ selectVideo(asset: Asset): Promise<string>;
3495
3510
  }
3496
3511
 
3497
3512
  declare class ModuleStepHandle extends StepHandle<ModuleStepData> {
3498
3513
  constructor(manager: WorkflowManager, step: Step<ModuleStepData>);
3499
3514
  selectVariant(): Promise<void>;
3515
+ /**
3516
+ * Return the remaining amount of characters that
3517
+ * the user is allowed to add, or undefined if there is no limit.
3518
+ */
3519
+ getCharactersRemaining(): number | undefined;
3520
+ /**
3521
+ * Return the maximum characters allowed for
3522
+ * this step, or undefined if there is no limit.
3523
+ */
3524
+ getCharacterLimit(): number | undefined;
3525
+ getText(): string;
3526
+ setText(value: string): void;
3500
3527
  }
3501
3528
 
3502
3529
  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 };