@spiffcommerce/core 20.1.0-beta.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;
@@ -2438,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;
     /**
@@ -2881,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;
 }
@@ -2961,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 };

package/dist/index.js

@@ -1,6 +1,6 @@
 import { createHttpLink as Et, InMemoryCache as ht, ApolloClient as Ct, from as Qt, gql as F } from "@apollo/client/core";
 import { fetch as $A, getAttributesFromArrayBuffer as ye, AssetType as Be, StepType as D, getFrameData as _A, frameDataCache as ut, GroupCommand as G, UpdateFramePattern as Ye, UpdateFrameThresholdSettingsCommand as mt, calculateOffsets as Ae, LayoutElementType as v, generate as J, CreateElementCommand as L, generateSVGWithUnknownColors as Se, svgObjectURL as pA, fetchAsString as q, DeleteElementCommand as Z, generateDefaultRectangleFrameSvg as de, GetSVGDimensions as It, patternImageDataCache as we, fetchAsArrayBuffer as pt, findElement as fA, modifySVGWithElementProperties as ft, IllustrationColorCommand as zA, IllustrationCacheCommand as Dt, getFontMetrics as Ft, getPatternImageData as KA, FontAlignmentCommand as Mt, FontColorCommand as yt, FontImageFillCommand as kA, applyTextTransformations as jA, determineCorrectFontSizeAndLines as uA, FontSourceCommand as Ee, loadFont as ee, TextChangeCommand as Yt, FontSizeCommand as St, createElementNS as xt, createElement as lA, _loadFontExternalDataURL as te, UpdateWorkflowStateCommand as he, CommandContext as Pt, createCanvas as DA, getSvgElement as xe, LayoutRenderingPurpose as Pe, renderPapyrusComponentAsString as Ne, loadImage as He, getDomParser as Re, toBase64 as Ce, getVariant as Nt, generateFrameSVG as Ht, getDefaultVariant as NA, domParser as Ue, sanitizeSvgTree as Ge, traverse as Rt, xmlSerializer as ve, CreateLayoutCommand as Ut, AspectType as mA, rehydrateSerializedLayout as _ } from "@spiffcommerce/papyrus";
-import { AssetType as Oi, BringForwardCommand as zi, BringToBackCommand as Ki, BringToFrontCommand as ji, CanvasCommand as Vi, CommandContext as Wi, CreateElementCommand as Xi, CreateLayoutCommand as qi, DeleteElementCommand as Zi, FontAlignmentCommand as $i, FontColorCommand as _i, FontSizeCommand as As, FontSourceCommand as es, GroupCommand as ts, LayoutElementFactory as ns, LayoutElementType as as, MoveCommand as is, ResizeCommand as ss, RotateCommand as os, SendBackwardsCommand as rs, StepAspectType as cs, StepType as gs, TextChangeCommand as ls, UnitOfMeasurement as Bs, dataUrlFromExternalUrl as ds, determineCorrectFontSizeAndLines as ws, findElement as Es, frameDataCache as hs, generate as Cs, generateSVGWithUnknownColors as Qs, getAttributesFromArrayBuffer as us, getAxisAlignedBoundingBox as ms, getFrameData as Is, getSvgElement as ps, loadFont as fs, patternImageDataCache as Ds, registerFetchImplementation as Fs, registerWindowImplementation as Ms, rehydrateSerializedLayout as ys, setCanvasModule as Ys } from "@spiffcommerce/papyrus";
+import { AssetType as Vi, BringForwardCommand as Wi, BringToBackCommand as Xi, BringToFrontCommand as qi, CanvasCommand as Zi, CommandContext as $i, CreateElementCommand as _i, CreateLayoutCommand as As, DeleteElementCommand as es, FontAlignmentCommand as ts, FontColorCommand as ns, FontSizeCommand as as, FontSourceCommand as is, GroupCommand as ss, LayoutElementFactory as os, LayoutElementType as rs, MoveCommand as cs, ResizeCommand as gs, RotateCommand as ls, SendBackwardsCommand as Bs, StepAspectType as ds, StepType as ws, TextChangeCommand as Es, UnitOfMeasurement as hs, dataUrlFromExternalUrl as Cs, determineCorrectFontSizeAndLines as Qs, findElement as us, frameDataCache as ms, generate as Is, generateSVGWithUnknownColors as ps, getAttributesFromArrayBuffer as fs, getAxisAlignedBoundingBox as Ds, getFrameData as Fs, getSvgElement as Ms, loadFont as ys, patternImageDataCache as Ys, registerFetchImplementation as Ss, registerWindowImplementation as xs, rehydrateSerializedLayout as Ps, setCanvasModule as Ns } from "@spiffcommerce/papyrus";
 import { setContext as Gt } from "@apollo/client/link/context";
 import { onError as vt } from "@apollo/client/link/error";
 import { Pith as ke } from "pith";
@@ -1327,7 +1327,7 @@ function mn(c, A, e, t) {
 function dA(c, A, e) {
   return Math.min(Math.max(c, A), e);
 }
-class In {
+let In = class {
   constructor(A) {
     this.minZoomScale = [0.03], this.maxZoomScale = [20], this._debouncedUpdateFrameOffsets = Je(this.updateFrameOffsets, 200), this.targetElements = [], this.onFrameDataChangeListeners = [], this.onZoomChangeListeners = [], this.forceImageCover = A, this.thresholdSettings = { useThreshold: !1, invertThreshold: !1, threshold: 128, thresholdSaturation: 0.5 };
   }
@@ -1511,7 +1511,7 @@ class In {
       this.offsets[t] = Ae(A, e);
     }), this._debouncedUpdateFrameOffsets(this.offsets, A, this.frameData, this.thresholdSettings, this.targetElements));
   }
-}
+};
 class pe {
   constructor(A, e, t) {
     this.processRegion = async (n) => {
@@ -7478,7 +7478,7 @@ class Ya extends We {
     B.resize(s, o), await B.render(), this.onRender();
   }
 }
-const Gi = (c, A) => {
+const Ji = (c, A) => {
   const e = [];
   return c.forEach((t) => {
     const n = A.steps.find((a) => a.stepName === t.stepName);
@@ -7489,7 +7489,7 @@ const Gi = (c, A) => {
       }
     });
   }), e;
-}, vi = async (c, A, e, t) => {
+}, bi = async (c, A, e, t) => {
   let n = {
     serializableWorkflow: { steps: [] },
     layouts: {}
@@ -9010,7 +9010,7 @@ class le {
   }
 }
 var ai = /* @__PURE__ */ ((c) => (c.Transaction = "Transaction", c.Bundle = "Bundle", c.Product = "Product", c.Variant = "Variant", c.Option = "Option", c.LineItem = "LineItem", c.Asset = "Asset", c))(ai || {});
-class ki extends le {
+class Li extends le {
   constructor(A) {
     super(`"${A}"`);
   }
@@ -9025,7 +9025,7 @@ class dt extends le {
     return A.match(/^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i);
   }
 }
-class Ji extends le {
+class Ti extends le {
   constructor(A) {
     super(`[${A.map((e) => e.getRaw()).join(",")}]`);
   }
@@ -10520,7 +10520,7 @@ class Ii {
     return new Me(a);
   }
 }
-class bi {
+class Oi {
   getInitializationPromise() {
     return Promise.resolve();
   }
@@ -10686,46 +10686,60 @@ class fi extends W {
     return this.step.data.overlayImageUrl;
   }
 }
+var Di = /* @__PURE__ */ ((c) => (c.OnCancel = "onCancel", c.OnError = "onError", c.OnComplete = "onComplete", c.OnLoad = "onLoad", c))(Di || {});
+class Fi {
+  /**
+   *  * 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(A) {
+    window.self !== window.top ? window.parent.postMessage(A, window.parent.origin) : console.warn("The frame service is being used in a context where there is no parent window.");
+  }
+}
+const zi = new Fi();
 export {
-  Ji as ArrayInput,
+  Ti as ArrayInput,
   $ as AssetNotFoundError,
-  Oi as AssetType,
-  zi as BringForwardCommand,
-  Ki as BringToBackCommand,
-  ji as BringToFrontCommand,
-  Vi as CanvasCommand,
+  Vi as AssetType,
+  Wi as BringForwardCommand,
+  Xi as BringToBackCommand,
+  qi as BringToFrontCommand,
+  Zi as CanvasCommand,
   TA as CollectionProduct,
-  Wi as CommandContext,
+  $i as CommandContext,
   cn as ConversionDataType,
   rn as ConversionLocation,
-  Xi as CreateElementCommand,
-  qi as CreateLayoutCommand,
-  Zi as DeleteElementCommand,
+  _i as CreateElementCommand,
+  As as CreateLayoutCommand,
+  es as DeleteElementCommand,
   CA as FlowExecutionNodeResult,
   ni as FlowExecutionResult,
   ti as FlowService,
-  $i as FontAlignmentCommand,
-  _i as FontColorCommand,
-  As as FontSizeCommand,
-  es as FontSourceCommand,
+  ts as FontAlignmentCommand,
+  ns as FontColorCommand,
+  as as FontSizeCommand,
+  is as FontSourceCommand,
+  Di as FrameEventType,
   In as FrameService,
   pi as FrameStep,
   fi as FrameStepHandle,
   ge as GlobalPropertyHandle,
-  ts as GroupCommand,
+  ss as GroupCommand,
   Zn as IllustrationStepHandle,
   PA as InformationMessageType,
   aa as InformationStepHandle,
   Me as IntegrationProduct,
   sn as IntegrationType,
-  ns as LayoutElementFactory,
-  as as LayoutElementType,
+  os as LayoutElementFactory,
+  rs as LayoutElementType,
   z as LayoutNotFoundError,
   $n as MaterialStepHandle,
   MA as MisconfigurationError,
-  bi as MockWorkflowManager,
+  Oi as MockWorkflowManager,
   _n as ModelStepHandle,
-  is as MoveCommand,
+  cs as MoveCommand,
   dt as ObjectInput,
   ai as ObjectInputType,
   FA as OptionNotFoundError,
@@ -10738,64 +10752,65 @@ export {
   Xe as PromiseQueue,
   ea as QuestionStepHandle,
   We as QueueablePromise,
-  ss as ResizeCommand,
+  gs as ResizeCommand,
   rA as ResourceNotFoundError,
-  os as RotateCommand,
-  rs as SendBackwardsCommand,
+  ls as RotateCommand,
+  Bs as SendBackwardsCommand,
   ta as ShapeStepHandle,
   Ii as SpiffCommerceClient,
   YA as StakeholderType,
-  cs as StepAspectType,
+  ds as StepAspectType,
   W as StepHandle,
-  gs as StepType,
-  ls as TextChangeCommand,
-  ki as TextInput,
+  ws as StepType,
+  Es as TextChangeCommand,
+  Li as TextInput,
   na as TextStepHandle,
   Ai as Transform,
   _a as TransformCollection,
   k as UnhandledBehaviorError,
-  Bs as UnitOfMeasurement,
+  hs as UnitOfMeasurement,
   X as Variant,
   EA as WorkflowExperienceImpl,
   O as assetService,
   ga as createDesign,
-  ds as dataUrlFromExternalUrl,
+  Cs as dataUrlFromExternalUrl,
   LA as designService,
-  ws as determineCorrectFontSizeAndLines,
+  Qs as determineCorrectFontSizeAndLines,
   Dn as digitalContentStepService,
-  Es as findElement,
-  hs as frameDataCache,
+  us as findElement,
+  ms as frameDataCache,
+  zi as frameService,
   WA as frameStepService,
-  Cs as generate,
+  Is as generate,
   Da as generateCommands,
-  Qs as generateSVGWithUnknownColors,
-  vi as generateStateFromDesignInputSteps,
-  us as getAttributesFromArrayBuffer,
-  ms as getAxisAlignedBoundingBox,
+  ps as generateSVGWithUnknownColors,
+  bi as generateStateFromDesignInputSteps,
+  fs as getAttributesFromArrayBuffer,
+  Ds as getAxisAlignedBoundingBox,
   mn as getBoundedOffsets,
-  Is as getFrameData,
-  ps as getSvgElement,
+  Fs as getFrameData,
+  Ms as getSvgElement,
   QA as getWorkflow,
   wt as getWorkflows,
   P as graphQlManager,
   IA as illustrationStepService,
-  fs as loadFont,
+  ys as loadFont,
   Ze as materialStepService,
   $e as modelStepService,
   xn as moduleStepService,
   j as optionService,
-  Ds as patternImageDataCache,
+  Ys as patternImageDataCache,
   x as persistenceService,
   _e as pictureStepService,
   At as questionStepService,
-  Fs as registerFetchImplementation,
-  Ms as registerWindowImplementation,
-  ys as rehydrateSerializedLayout,
-  Ys as setCanvasModule,
+  Ss as registerFetchImplementation,
+  xs as registerWindowImplementation,
+  Ps as rehydrateSerializedLayout,
+  Ns as setCanvasModule,
   oA as shapeStepService,
   pn as shortenUrl,
   yA as spiffCoreConfiguration,
-  Gi as stepAspectValuesToDesignInputSteps,
+  Ji as stepAspectValuesToDesignInputSteps,
   K as textStepService,
   Un as toast
 };