@spiffcommerce/core 20.1.0-alpha.0 → 20.1.0-beta.1

package/dist/index.d.ts

@@ -137,7 +137,7 @@ declare class PromiseQueue<T extends QueueablePromise> {
  * @param mustCover When true the image sgould be bounded in such a way that it covers the entire frame at all times.
  */
 declare function getBoundedOffsets(newOffsets: FrameOffsets, frameData: FrameData, imageData: PatternImageData, mustCover?: boolean): FrameOffsets;
-declare class FrameService {
+declare class FrameService$1 {
     private offsets;
     private thresholdSettings;
     private forceImageCover?;
@@ -379,7 +379,7 @@ declare enum InformationMessageType {
  * Services required for the operaiton of individual steps.
  */
 interface StepSpecificServices {
-    frameService?: FrameService;
+    frameService?: FrameService$1;
     module?: ModuleProduct;
 }
 type DesignCreationProgressUpdate = (message: string) => void;
@@ -2378,7 +2378,6 @@ declare class SpiffCommerceClient {
      * @returns The transaction associated with this client.
      */
     getTransaction(): Transaction;
-    configureUrls(hubUrl: string, serverUrl: string, servicesApiUrl: string): void;
     /**
      * A function used to synchronize transaction state with the server.
      * @param options New state details. To be spread into the query.
@@ -2439,7 +2438,7 @@ declare class FrameStepService implements StepService<FrameStepData> {
     selectImage(stepData: Step<FrameStepData>, asset: Asset, workflowManager: WorkflowManager): 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$1): Promise<void>;
     private selectVariantCommand;
     private frameSourceSvg;
     /**
@@ -2882,7 +2881,7 @@ declare class FrameStepHandle extends StepHandle<FrameStepData> {
     selectImage(asset: Asset): void;
     getImageData(): PatternImageData | undefined;
     getCurrentFrameStep(frameData: FrameData$1, uploading?: any, imageUploadComplete?: any, variants?: VariantResource[]): FrameStep;
-    getFrameService(): FrameService | undefined;
+    getFrameService(): FrameService$1 | undefined;
     hasOverlayImageKey(): string | undefined;
     hasOverlayImageUrl(): any;
 }
@@ -2962,4 +2961,74 @@ declare class PromiseCache {
 }
 declare const promiseCache: PromiseCache;
 
-export { ArrayInput, AssetNotFoundError, Bundle, CollectionProduct, ColorOption, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FrameService, FrameStep, FrameStepHandle, FrameThresholdSettings, GetWorkflowOptions, GlobalPropertyHandle, IllustrationStepHandle, InformationMessageType, InformationResult, InformationStepHandle, IntegrationProduct, IntegrationType, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, NodeType, ObjectInput, ObjectInputType, OptionNotFoundError, ParseError, PictureStepHandle, Product, ProductCameraRig, ProductCollection, ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, StepElements, StepHandle, TextInput, TextStepHandle, TextStepStorage, Transaction, Transform, TransformCollection, UnhandledBehaviorError, Variant, Vector3, WorkflowExperience, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, createDesign, designService, digitalContentStepService, frameStepService, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, questionStepService, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };
+declare enum FrameEventType {
+    /**
+     * This event is sent when the user has clicked a close button within the frame.
+     */
+    OnCancel = "onCancel",
+    /**
+     * This event is sent when the frame has encountered an error.
+     */
+    OnError = "onError",
+    /**
+     * This event is sent when the user has completed the experience in the frame and is passign back information to the parent.
+     */
+    OnComplete = "onComplete",
+    /**
+     * This event is sent when the content in the frame is loaded and ready to display.
+     */
+    OnLoad = "onLoad"
+}
+/**
+ * This event is sent when the frame has encountered an error.
+ */
+interface ErrorEvent {
+    event: FrameEventType.OnError;
+    data: Error;
+}
+/**
+ * This event is sent when the user has clicked a close button within the frame.
+ */
+interface CancelEvent {
+    event: FrameEventType.OnCancel;
+}
+/**
+ * This event is sent when the content in the frame is loaded and ready to display. As
+ * the point at which the content is considered 'loaded' can vary between themes, we require the theme developer to report it.
+ */
+interface LoadEvent {
+    event: FrameEventType.OnLoad;
+}
+/**
+ * This event is sent when the user has completed the transaction in the frame and is passing back information to the parent.
+ */
+interface TransactionCompleteEvent {
+    event: FrameEventType.OnComplete;
+}
+/**
+ * This event is sent when the user has completed the bundle experience in the frame and is passing back information to the parent.
+ */
+interface BundleCompleteEvent {
+    bundleId: string;
+    items: TransactionCompleteEvent[];
+    event: FrameEventType.OnComplete;
+}
+/**
+ * A union of the various frame events that can be sent to the parent window.
+ */
+type FrameEvent = BundleCompleteEvent | (TransactionCompleteEvent & DesignCreationMessage) | CancelEvent | ErrorEvent | LoadEvent;
+/**
+ * Service for communicating with the parent window. Wraps calls to `window.parent.postMessage` and provides strongly typed events.
+ */
+declare class FrameService {
+    /**
+     *  * Send a message to the parent window.
+     * We don't currently know the domain of the parent window in a secure way so we use `window.parent.origin` to send the message.
+     * FIXME: One day in the future let's build a whitelist or something similar that can be used to validate the origin of the parent window.
+     * @param event The event to send. Must be strongly typed as one of the FrameEvent types.
+     */
+    postMessage(event: FrameEvent): void;
+}
+declare const frameService: FrameService;
+
+export { ArrayInput, AssetNotFoundError, Bundle, CollectionProduct, ColorOption, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FrameEventType, FrameService$1 as FrameService, FrameStep, FrameStepHandle, FrameThresholdSettings, GetWorkflowOptions, GlobalPropertyHandle, IllustrationStepHandle, InformationMessageType, InformationResult, InformationStepHandle, IntegrationProduct, IntegrationType, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, NodeType, ObjectInput, ObjectInputType, OptionNotFoundError, ParseError, PictureStepHandle, Product, ProductCameraRig, ProductCollection, ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, StepElements, StepHandle, TextInput, TextStepHandle, TextStepStorage, Transaction, Transform, TransformCollection, UnhandledBehaviorError, Variant, Vector3, WorkflowExperience, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, createDesign, designService, digitalContentStepService, frameService, frameStepService, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, questionStepService, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };