@spiffcommerce/core 21.9.0-alpha.0 → 21.9.0-alpha.10

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _spiffcommerce_papyrus from '@spiffcommerce/papyrus';
-import { OptionResource, VariantResource, Step, AnyStepData, FrameOffsets, PatternImageData, Region, Workflow, ILayout, LayoutsState, LayoutData, SilentStepData, Placeable, StepStorage, CanvasCommand, CommandContext, LayoutState, SerializableStep, CommandState, GlobalPropertyConfiguration, Asset, MaterialResource, AssetType, StepType, AspectType, GlobalPropertyConfigurationAspect, Theme, FrameStepData, CreateElementCommand, FrameElement, IllustrationStepData, IllustrationElement, ColorDefinition, MaterialStepData, ModelStepData, TextStepData, TextboxElement, TextFillImage, FontData, GroupCommand, PictureStepData, QuestionStepData, ShapeStepData, ModuleStepData, DigitalContentStepData, FrameData as FrameData$1, InformationStepData } from '@spiffcommerce/papyrus';
+import { OptionResource, VariantResource, Step, AnyStepData, FrameOffsets, PatternImageData, Region, Workflow, ILayout, LayoutsState, LayoutData, SilentStepData, Placeable, StepStorage, CanvasCommand, CommandContext, LayoutState, SerializableStep, CommandState, GlobalPropertyConfiguration, AspectType, Asset, MaterialResource, AssetType, StepType, GlobalPropertyConfigurationAspect, Theme, FrameStepData, CreateElementCommand, FrameElement, IllustrationStepData, IllustrationElement, ColorDefinition, MaterialStepData, ModelStepData, TextStepData, TextboxElement, TextFillImage, FontData, GroupCommand, PictureStepData, QuestionStepData, ShapeStepData, ModuleStepData, DigitalContentStepData, FrameData as FrameData$1, InformationStepData } from '@spiffcommerce/papyrus';
 export { Animatable, AnyStepData, AspectType, Asset, AssetType, BringForwardCommand, BringToBackCommand, BringToFrontCommand, CanvasCommand, ColorDefinition, ColorProfileProps, CommandContext, CommandState, CreateElementCommand, CreateLayoutCommand, DeleteElementCommand, DigitalContentStepData, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, FrameElement, FrameStepData, GroupCommand, ILayout, IllustrationElement, IllustrationStepData, ImageElement, InformationStepData, LayoutData, LayoutElement, LayoutElementFactory, LayoutElementType, LayoutsState, MaterialStepData, ModelStepData, ModuleStepData, MoveCommand, OptionResource, PictureStepData, QuestionStepData, ResizeCommand, RotateCommand, SendBackwardsCommand, ShapeStepData, Step, StepAspect, StepAspectType, StepStorage, StepType, TextChangeCommand, TextStepData, TextboxElement, Theme, UnitOfMeasurement, VariantResource, Workflow, WorkflowPanel, dataUrlFromExternalUrl, determineCorrectFontSizeAndLines, findElement, frameDataCache, generate, generateSVGWithUnknownColors, getAttributesFromArrayBuffer, getAxisAlignedBoundingBox, getFrameData, getSvgElement, loadFont, patternImageDataCache, registerFetchImplementation, registerWindowImplementation, rehydrateSerializedLayout, setCanvasModule } from '@spiffcommerce/papyrus';
 import { ApolloClient, MutationOptions, FetchResult } from '@apollo/client/core';
 import { RenderableContextService, RenderableContext, ThreeDPreviewService, ModelContainer } from '@spiffcommerce/preview';
@@ -1057,6 +1057,14 @@ type GlobalPropertyState = {
 type GlobalPropertyStateAspect = {
     name: string;
     value: string;
+    type?: AspectType;
+    storage?: GlobalPropertyStateAspectStorage;
+};
+type GlobalPropertyStateAspectStorage = GlobalPropertyStateFileUploadStorage;
+type GlobalPropertyStateFileUploadStorage = {
+    originalAssetKey?: string;
+    backgroundRemovedAssetKey?: string;
+    useOriginalAsset?: boolean;
 };
 interface BundleStateTransform {
     position: Vector3;
@@ -1771,6 +1779,12 @@ declare class FileUploadGlobalPropertyHandle extends GlobalPropertyHandle {
      * @returns A promise resolving when all affected steps have been updated.
      */
     selectImage(asset: Asset): Promise<void>;
+    /**
+     * Removes the background from an image, stores it in the state, and returns the new asset.
+     * @param applyNewAsset Optionally applies the new asset to all shared steps. Default: `true`.
+     * @returns A promise that resolves with the newly generated Asset.
+     */
+    removeBackgroundFromImage(applyNewAsset?: boolean): Promise<Asset>;
     /**
      * Returns `true` if the state has an image assigned, otherwise `false`.
      */
@@ -1780,8 +1794,21 @@ declare class FileUploadGlobalPropertyHandle extends GlobalPropertyHandle {
      * @returns A promise that resolves with an `Asset` object if one is assigned to the state, otherwise `undefined`.
      */
     getImage(): Promise<Asset | undefined>;
+    /**
+     * Retrieves the original, unmodified image selection, if one exists.
+     * @returns A promise that resolves with an `Asset` object if one is assigned to the state, otherwise `undefined`.
+     */
+    getOriginalImage(): Promise<Asset | undefined>;
+    /**
+     * Retrieves the version of the image selection that has the background removed, if one exists.
+     * @returns A promise that resolves with an `Asset` object if one is assigned to the state, otherwise `undefined`.
+     */
+    getBackgroundRemovedImage(): Promise<Asset | undefined>;
+    getUseOriginalImage(): boolean;
+    setUseOriginalImage(value: boolean): Promise<void>;
     applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
     private applyImageSelection;
+    private updateSharedStepStorage;
 }
 declare class TextGlobalPropertyHandle extends GlobalPropertyHandle {
     constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect);
@@ -1844,8 +1871,17 @@ interface GlobalPropertyStateManager {
     getInitializationPromise(): Promise<void>;
     getGlobalPropertyState(): GlobalPropertyState | undefined;
     getAspect(name: string): string | undefined;
-    setAspect(name: string, value: string): Promise<void>;
-    setBundleOptions(bundleOptions?: BundleOptions): any;
+    getAspectStorage(name: string): GlobalPropertyStateAspectStorage | undefined;
+    /**
+     * Updates the value of a named aspect in the state.
+     * @param name The name (key) of the aspect. This must match the key in the associated Global Property Config
+     * @param value The value, represented as a string.
+     * @param storage Optional: Additional data storage for the aspect. Not specifying this parameter, or providing `undefined`, will not update the
+     * storage (if it already exists). Providing `null` will clear the existing storage.
+     */
+    setAspect(name: string, value: string, storage?: GlobalPropertyStateAspectStorage | null): Promise<void>;
+    setAspectStorage(name: string, storage: GlobalPropertyStateAspectStorage | null): Promise<void>;
+    setBundleOptions(bundleOptions?: BundleOptions): void;
 }
 interface BundleOptions {
     additionalHeaders?: {
@@ -2701,7 +2737,7 @@ interface FrameCreateOpts {
 declare class FrameStepService implements StepService<FrameStepData> {
     init(stepData: Step<FrameStepData>, workflowManager: WorkflowManager, reducerState?: LayoutsState): Promise<CommandWithFollowup | null>;
     private reload;
-    selectImage(stepData: Step<FrameStepData>, asset: Asset, workflowManager: WorkflowManager): void;
+    selectImage(stepData: Step<FrameStepData>, asset: Asset, workflowManager: WorkflowManager): Promise<void>;
     selectVariant(stepData: Step<FrameStepData>, variant: VariantResource | undefined, elements: RegionElement[], workflowManager: WorkflowManager, setFrameIsUpdating?: (status: boolean) => void): Promise<void>;
     getCreateElementCommand(id: string, region: Region, layout: ILayout, options: FrameCreateOpts): CreateElementCommand<FrameElement>;
     loadPatternFromString(src: string, frameService: FrameService): Promise<void>;
@@ -3144,12 +3180,28 @@ declare class FrameStepHandle extends StepHandle<FrameStepData> {
     private frameService;
     selectVariant(variant: Variant): Promise<void>;
     onFrameDataChanged(callback: (frameData: FrameData$1[]) => void): void;
-    selectImage(asset: Asset): void;
+    /**
+     * Updates the image selection inside the frame.
+     * @param asset The asset to use.
+     * @param storeAsOriginal Optional: Store this asset as the original, unmodified version of the image. Default: `true`.
+     */
+    selectImage(asset: Asset, storeAsOriginal?: boolean): Promise<void>;
+    /**
+     * Removes the background from an image, stores it in the state, and returns the new asset.
+     * @param applyNewAsset Optionally applies the new asset as the current image selection. Default: `true`.
+     * @returns A promise that resolves with the newly generated Asset.
+     */
+    removeBackgroundFromImageSelection(applyNewAsset?: boolean): Promise<Asset>;
     getImageData(): PatternImageData | undefined;
     getCurrentFrameStep(frameData: FrameData$1, uploading?: any, imageUploadComplete?: any, variants?: VariantResource[]): FrameStep;
     getFrameService(): FrameService | undefined;
     hasOverlayImageKey(): string | undefined;
     hasOverlayImageUrl(): any;
+    getOriginalImageSelection(): Promise<Asset | undefined>;
+    getBackgroundRemovedImageSelection(): Promise<Asset | undefined>;
+    hasBackgroundRemovedImageSelection(): boolean;
+    getUseOriginalImageSelection(): boolean;
+    setUseOriginalImageSelection(value: boolean): Promise<void>;
 }
 
 declare class MaterialStepHandle extends StepHandle<MaterialStepData> {