@spiffcommerce/core 16.2.6 → 16.4.0-rc.0

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 import * as _spiffcommerce_papyrus from '@spiffcommerce/papyrus';
-import { OptionResource, VariantResource, Step, AnyStepData, FrameOffsets, PatternImageData, Region, SilentStepData, Placeable, StepStorage, CanvasCommand, CommandContext, ILayout, LayoutState, SerializableStep, Workflow, CommandState, GlobalPropertyConfiguration, LayoutsState, Asset, MaterialResource, AssetType, StepType, GlobalPropertyConfigurationAspect, AspectType, Theme, StepAspect, FrameStepData, CreateElementCommand, FrameElement, IllustrationStepData, IllustrationElement, ColorDefinition, LayoutData, MaterialStepData, ModelStepData, TextStepData, TextboxElement, TextFillImage, FontData, GroupCommand, PictureStepData, QuestionStepData, ShapeStepData, ModuleStepData, DigitalContentStepData, FrameData as FrameData$1, BulkStepData, 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, 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, loadFontFromDataUrl, loadFontFromExternalUrl, patternImageDataCache, registerFetchImplementation, registerWindowImplementation, rehydrateSerializedLayout } from '@spiffcommerce/papyrus';
 import { ApolloClient, MutationOptions, FetchResult } from '@apollo/client/core';
+import { RenderableContextService, RenderableContext, ThreeDPreviewService, ModelContainer } from '@spiffcommerce/preview';
 import * as lodash from 'lodash';
 
 declare class OptionService {
@@ -263,6 +264,69 @@ declare abstract class ModuleProduct {
     abstract svgPrint(text: string, region: Region): string;
 }
 
+interface DesignInputStep {
+    data: DesignInputStepData;
+    name: string;
+}
+interface DesignInputStepData {
+}
+
+declare class LayoutPreviewService implements RenderableContextService {
+    private readonly layouts;
+    private handleCompleteRender;
+    constructor(layouts: ILayout[]);
+    setCompleteRenderCallback(handleCompleteRender: (layouts: LayoutPreviewBridge[]) => void): void;
+    onCompleteRender(): void;
+    getAll(): ReadonlyMap<string, LayoutPreviewBridge>;
+}
+/**
+ * The panel canvas class that stores both the main rendering canvas as well as rendering context
+ * for a rendering context
+ */
+declare class LayoutPreviewBridge implements RenderableContext {
+    hasSetStaticContext: boolean;
+    private readonly id;
+    private readonly name;
+    private service;
+    private interactiveDirty;
+    private textureCtx?;
+    private staticCtxDirty;
+    private lastRequestedRenderArguments;
+    private lastCompletedStaticRender;
+    private lastModificationID;
+    private renderQueue;
+    constructor(id: string, name: string, service: LayoutPreviewService);
+    getID(): string;
+    getName(): string;
+    getStaticContext(): CanvasRenderingContext2D | undefined;
+    /**
+     * Register canvas to be rendered to.
+     */
+    setStaticContext(ctx: CanvasRenderingContext2D): void;
+    getStaticContextDirty(): boolean;
+    setStaticContextDirty(dirty: boolean): void;
+    getInteractiveCanvasDirty(): boolean;
+    setInteractiveCanvasDirty(dirty: boolean): void;
+    markLastCompletedStaticRender(): void;
+    /**
+     * Returns a timestamp for the last time that this canvas rendered to its dynamic texture in the
+     * form of Date.now(). If this panel has never rendered undefined will be returned.
+     */
+    getLastCompletedStaticRender(): number | undefined;
+    getLastModificationID(): string | undefined;
+    /**
+     * Actions to perform when a static render event is fired for this canvas.
+     */
+    render(workflow: Workflow, layouts: LayoutData[], variationRecord: null | VariationRecord, productOverlayImageUrl?: string): Promise<void>;
+}
+interface StepAspectValue {
+    stepName: string;
+    stepAspectType: string;
+    value?: string;
+}
+declare const stepAspectValuesToDesignInputSteps: (stepAspectValues: StepAspectValue[], workflow: Workflow) => DesignInputStep[];
+declare const generateStateFromDesignInputSteps: (designInputSteps: DesignInputStep[], workflow: Workflow, layouts: ILayout[], productOverlayImageUrl?: string) => Promise<LayoutsState>;
+
 interface SilentIllustrationStepData extends SilentStepData, Placeable {
 }
 interface EditedSteps {
@@ -347,8 +411,8 @@ interface WorkflowManager {
     getCommandContext: () => CommandContext;
     getLayouts: () => ILayout[];
     getAllLayoutData: () => LayoutState[];
-    getLayoutPreviewService: () => any | undefined;
-    getPreviewService: () => any | undefined;
+    getLayoutPreviewService: () => LayoutPreviewService | undefined;
+    getPreviewService: () => ThreeDPreviewService | undefined;
     getProfanities: () => string[];
     getRegionElements: (stepName: string) => RegionElement[];
     getSerializedStep: (stepName: string, serializedSteps: SerializableStep[]) => SerializableStep | undefined;
@@ -401,14 +465,14 @@ interface WorkflowManager {
      */
     updateStateWithServerImmediate: (getReducerState: () => CommandState) => Promise<void>;
     updateStorage: (stepName: string, update: StepStorage) => void;
-    getModelContainer: () => any | undefined;
-    setModelContainer: (container: any) => void;
+    getModelContainer: () => ModelContainer | undefined;
+    setModelContainer: (container: ModelContainer) => void;
     /**
      * Injects the model of this product into the preview service.
      * This also overwrites the internal preview service.
      * @param previewService The preview service to inject into.
      */
-    injectIntoPreviewService(previewService: any): Promise<void>;
+    injectIntoPreviewService(previewService: ThreeDPreviewService): Promise<void>;
     /**
      * Ejects the model of this product from the preview service. This also sets the internal preview service to undefined.
      */
@@ -1311,9 +1375,9 @@ interface ExperienceOptions {
     product: Product;
     transaction: Transaction;
     workflow?: Workflow;
-    previewService?: any;
-    modelContainer?: any;
-    renderableContextService?: any;
+    previewService?: ThreeDPreviewService;
+    modelContainer?: ModelContainer;
+    renderableContextService?: LayoutPreviewService;
     layouts: ILayout[];
     reloadedState?: LayoutsState;
     /**
@@ -1830,7 +1894,7 @@ interface Bundle {
      * If a preview service was specified when calling client.getExistingBundle, this will return that service.
      * Call `setPreviewService` to update the preview service for this bundle.
      */
-    getPreviewService(): any | undefined;
+    getPreviewService(): ThreeDPreviewService | undefined;
     /**
      * Set the preview service for this bundle. This will update the preview service for all workflow experiences in this bundle, and will
      * also automatically inject the preview service into any new workflow experiences that are added to this bundle.
@@ -1838,7 +1902,7 @@ interface Bundle {
      * @param previewService The preview service to use for this bundle.
      * @returns A promise that resolves when the preview service has been updated for all workflow experiences in this bundle.
      */
-    setPreviewService(previewService?: any): Promise<void>;
+    setPreviewService(previewService?: ThreeDPreviewService): Promise<void>;
     /**
      * Returns a promise that resolves when the bundle has been initialized.
      * This will resolve immediately if the bundle has no experiences, or if the bundle has already been initialized.
@@ -2053,7 +2117,7 @@ interface GetWorkflowOptionsBase {
     /**
      * An existing preview service to use, instead of creating a new one.
      */
-    previewService?: any;
+    previewService?: ThreeDPreviewService;
     graphql?: GetWorkflowGraphqlOptions;
 }
 interface GetWorkflowFromTransactionOptions extends GetWorkflowOptionsBase {
@@ -2167,7 +2231,7 @@ declare class SpiffCommerceClient {
      * @param graphqlOptions Optional: Options to configure loading the workflow.
      * @returns A bundle to be used for grouping and operating on large amounts of workflow experiences.
      */
-    getExistingBundle(bundleId: string, previewService?: any, graphqlOptions?: GetWorkflowGraphqlOptions): Promise<Bundle>;
+    getExistingBundle(bundleId: string, previewService?: ThreeDPreviewService, graphqlOptions?: GetWorkflowGraphqlOptions): Promise<Bundle>;
     /**
      * Retrieves all existing bundle stakeholders from the API, for the currently authenticated customer.
      * @returns An array of bundle stakeholders.
@@ -2181,7 +2245,7 @@ declare class SpiffCommerceClient {
      * @param options Options to configure loading the transaction and workflow.
      * @returns A workflow experience configured as requested.
      */
-    getWorkflowExperience(workflowId?: string, workflowState?: string, previewServiceConstructor?: (workflow: Workflow) => any, options?: GetWorkflowOptions): Promise<WorkflowExperience>;
+    getWorkflowExperience(workflowId?: string, workflowState?: string, previewServiceConstructor?: (workflow: Workflow) => ThreeDPreviewService, options?: GetWorkflowOptions): Promise<WorkflowExperience>;
     /**
      * Gets multiple workflow experiences at once.
      * @param optionsArray An array of options to configure loading the transactions and workflows.
@@ -2211,7 +2275,7 @@ declare class SpiffCommerceClient {
      * @deprecated The value this returns will be changed whenever `getWorkflowExperience()` is called. Use `workflowExperience.getWorkflowManager().getPreviewService()` instead.
      * @returns The preview service that was provided during construction.
      */
-    getPreviewService(): any;
+    getPreviewService(): ThreeDPreviewService | undefined;
     /**
      * @deprecated The value this returns will be changed whenever `getWorkflowExperience()` is called. Use `WorkflowManager.getProduct()` instead.
      * @returns The product associated with this client.
@@ -2494,9 +2558,7 @@ declare class MockWorkflowManager implements WorkflowManager {
     addVariationRecordsCallback(_callback: VariationRecordsCallback): void;
     getCommandDispatcher(): (_command: CanvasCommand) => void;
     getLayouts(): never[];
-    getLayoutPreviewService(): {
-        getAll: () => Map<any, any>;
-    };
+    getLayoutPreviewService(): any;
     getPreviewService(): undefined;
     setModelContainer: (container: any) => void;
     getModelContainer(): undefined;
@@ -2539,13 +2601,6 @@ declare class MockWorkflowManager implements WorkflowManager {
     ejectFromPreviewService(): void;
 }
 
-interface DesignInputStep {
-    data: DesignInputStepData;
-    name: string;
-}
-interface DesignInputStepData {
-}
-
 declare const generateCommands: (designInputSteps: DesignInputStep[], workflow: Workflow, layouts: ILayout[], productOverlayImageUrl?: string) => Promise<CanvasCommand[]>;
 
 declare class IllustrationStepHandle extends StepHandle<IllustrationStepData> {
@@ -2829,12 +2884,4 @@ declare class InformationStepHandle extends StepHandle<InformationStepData> {
     getContent(): string;
 }
 
-interface StepAspectValue {
-    stepName: string;
-    stepAspectType: string;
-    value?: string;
-}
-declare const stepAspectValuesToDesignInputSteps: (stepAspectValues: StepAspectValue[], workflow: Workflow) => DesignInputStep[];
-declare const generateStateFromDesignInputSteps: (designInputSteps: DesignInputStep[], workflow: Workflow, layouts: ILayout[], productOverlayImageUrl?: string) => Promise<LayoutsState>;
-
 export { AssetNotFoundError, BulkPriceCalculationStrategy, BulkStepHandle, Bundle, CollectionProduct, ColorOption, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FrameService, FrameStep, FrameStepHandle, GetWorkflowOptions, GlobalPropertyHandle, IllustrationStepHandle, InformationMessageType, InformationResult, InformationStepHandle, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, NodeType, ObjectInput, ObjectInputType, OptionNotFoundError, ParseError, PictureStepHandle, Product, ProductCameraRig, ProductCollection, ProductWorkflow, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, StepElements, StepHandle, TextStepHandle, TextStepStorage, Transaction, Transform, TransformCollection, UnhandledBehaviorError, Variant, VariationRecord, Vector3, WorkflowExperience, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, createDesign, designService, digitalContentStepService, frameStepService, gatherVaryingStepAspects, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, questionStepService, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };