@spiffcommerce/core 16.4.2 → 16.5.0-rc.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 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, GlobalPropertyConfigurationAspect, AspectType, Theme, StepAspect, FrameStepData, CreateElementCommand, FrameElement, IllustrationStepData, IllustrationElement, ColorDefinition, MaterialStepData, ModelStepData, TextStepData, TextboxElement, TextFillImage, FontData, GroupCommand, PictureStepData, QuestionStepData, ShapeStepData, ModuleStepData, DigitalContentStepData, FrameData as FrameData$1, BulkStepData, InformationStepData } from '@spiffcommerce/papyrus';
-export { Animatable, AnyStepData, Asset, AssetType, BringForwardCommand, BringToBackCommand, BringToFrontCommand, BulkStepData, 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 } from '@spiffcommerce/papyrus';
+export { Animatable, AnyStepData, Asset, AssetType, BringForwardCommand, BringToBackCommand, BringToFrontCommand, BulkStepData, 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';
 import * as lodash from 'lodash';
@@ -67,6 +67,7 @@ interface WorkflowScene {
     /**
      * Steps which don't display to the user.
      * Their behavior is always silent & executed in the background.
+     * @deprecated Silent steps are no longer handled seperately from normal steps.
      */
     silentSteps: Step<AnyStepData>[];
 }
@@ -1375,6 +1376,9 @@ interface ExperienceOptions {
     product: Product;
     transaction: Transaction;
     workflow?: Workflow;
+    /**
+     * @deprecated favor inject / eject functions.
+     */
     previewService?: ThreeDPreviewService;
     modelContainer?: ModelContainer;
     renderableContextService?: LayoutPreviewService;
@@ -1390,8 +1394,15 @@ interface ExperienceOptions {
     stateMutationFunc: StateMutationFunc;
     /**
      * Should be set to true when the experience is loaded from an existing transaction.
+     * FIXME: Wouldn't we know this from existance of reloadedState
      */
     isReloadedTransaction?: boolean;
+    /**
+     * When true the system will treat steps with
+     * a single variant as renderable. False
+     * by default.
+     */
+    singleVariantsRenderable?: boolean;
 }
 /**
  * A Workflow experience encapsulates the workflow manager and command context. It
@@ -2118,6 +2129,18 @@ interface GetWorkflowOptionsBase {
      * An existing preview service to use, instead of creating a new one.
      */
     previewService?: ThreeDPreviewService;
+    /**
+     * Coniguration related to the
+     * workflow and how the system interprets it.
+     */
+    workflowConfiguration?: {
+        /**
+         * False by default, when true the system will treat
+         * steps with a single variant
+         * as being renderable.
+         */
+        singleVariantsRenderable?: boolean;
+    };
     /**
      * Configuration for the graphQL request made for workflows. Allows for retrieval
      * of additional data.