@spiffcommerce/core 21.12.0 → 21.13.0-alpha.0

package/dist/index.d.ts

@@ -211,8 +211,10 @@ declare class FrameService {
     /**
      * Sets the image currently contained by this frame.
      * @param value The new image as an ImageData property
+     * @param [recalculateOffsets=true] Optional: Enable/disable re-calculating of frame offsets.
+     * Useful when you are replacing an image with the exact same dimensions (e.g. alterations to an image). Default: `true`.
      */
-    setPatternData(value: PatternImageData): void;
+    setPatternData(value: PatternImageData, recalculateOffsets?: boolean): void;
     /**
      * Modify the offsets of the frame.
      * @param value The new FrameOffsets objects.
@@ -2755,10 +2757,10 @@ 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): Promise<void>;
+    selectImage(stepData: Step<FrameStepData>, asset: Asset, workflowManager: WorkflowManager, recalculateOffsets?: boolean): 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>;
+    loadPatternFromString(src: string, frameService: FrameService, recalculateOffsets: boolean): Promise<void>;
     private selectVariantCommand;
     private frameSourceSvg;
     /**
@@ -3205,8 +3207,9 @@ declare class FrameStepHandle extends StepHandle<FrameStepData> {
      * 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`.
+     * @param [recalculateOffsets=true] Optional: Recalculates the offsets of the image inside the frame. Default: `true`.
      */
-    selectImage(asset: Asset, storeAsOriginal?: boolean): Promise<void>;
+    selectImage(asset: Asset, storeAsOriginal?: boolean, recalculateOffsets?: boolean): Promise<void>;
     canUseBackgroundRemover(): Promise<boolean>;
     /**
      * Removes the background from an image, stores it in the state, and returns the new asset.