@spiffcommerce/core 0.4.2 → 0.4.3

package/dist/types.d.ts

@@ -1,12 +1,12 @@
-import { StepAspect, Workflow, AnyStepData, Step, Asset, AssetType, IServerModel, MaterialResource, IllustrationStepData, VariantResource, DigitalContentStepData, FrameStepData, MaterialStepData, ModelStepData, ModuleStepData, PatchworkStepData, PictureStepData, QuestionStepData, ShapeStepData, TextStepData as _TextStepData1, CameraAnimation, ModelAnimation, OptionResource, StepType, TextStepData } from "papyrus/build/main/generation/Workflow";
+import { StepAspect, Workflow, AnyStepData, Step, Asset, AssetType, IServerModel, MaterialResource, IllustrationStepData, VariantResource, DigitalContentStepData, FrameStepData, MaterialStepData, ModelStepData, ModuleStepData, PatchworkStepData, PictureStepData, QuestionStepData, ShapeStepData, TextStepData as _TextStepData1, OptionResource, StepType, TextStepData } from "papyrus/build/main/generation/Workflow";
 import { PatternImageData, FrameData as _FrameData1, Point, ScaleAxis, UnitOfMeasurement } from "papyrus/build/main/types";
 import { FrameOffsets, ColorDefinition, ILayout, IllustrationElement as _IllustrationElement1, LayoutsState as _LayoutsState1, Region, FrameElement as _FrameElement1, PatchworkOffsets, TextboxElement as _TextboxElement1, FontData, SerializableStep, StepStorage, FrameElement, IllustrationElement, LayoutElement, LayoutsState, PatchworkElement, TextboxElement, ImageElement } from "papyrus/build/main/LayoutsState/types";
 import { ApolloClient } from "@apollo/client";
 import { CanvasCommand, CreateElementCommand as _CreateElementCommand1, GroupCommand, CreateElementCommand, FontAlignmentCommand, FontColorCommand, TextChangeCommand } from "papyrus/build/main/command";
 import { LayoutData as _LayoutData1, CommandState, CommandContext as _CommandContext1, CommandContext, LayoutData } from "papyrus/build/main/CommandContext";
 import { ModuleProduct } from "papyrus/build/main/module/ModuleProduct";
+import { ThreeDPreviewService as _ThreeDPreviewService1, LoadProgressEventData, ProductCameraRig, SpiffCommerce3DPreviewService, ThreeDPreviewService } from "spiff-preview";
 import { ReactNode, Dispatch, FunctionComponent, RefObject, PointerEvent, KeyboardEvent, MouseEvent } from "react";
-import { ThreeDPreviewService as _ThreeDPreviewService2, LoadProgressEventData, ProductCameraRig, SpiffCommerce3DPreviewService, ThreeDPreviewService } from "spiff-preview";
 import { LayoutElementFactory } from "papyrus/build/main/Elements/factory";
 export const gatherVaryingStepAspects: (workflow: Workflow) => StepAspect[];
 export interface WorkflowScene {
@@ -760,316 +760,6 @@ interface FrameData {
      */
     height: number;
 }
-type _ThreeDPreviewService1 = {
-    /**
-     * Allows listeners to be aware of the camera losing focus of the
-     * main product.
-     * @param listener A function to be called when focus is lost.
-     */
-    registerFocusLostListener(listener: () => void): void;
-    /**
-     * Removes a listener from the focusLost observers. The listener will
-     * no longer be notified
-     * @param listener The listener to remove.
-     */
-    unregisterFocusLostListener(listener: () => void): void;
-    /**
-     * Providers listeners with information about load progress when
-     * the preview is loading scenes.
-     * @param listener A function to get load progress updates
-     */
-    registerLoadProgressListener(listener: (e: _LoadProgressEventData1) => void): void;
-    /**
-     * Allows you to pass any function that originally called registerLoadProgressListener()
-     * to have it excluded from load progress updates.
-     * If the function was never registered this call has no effect.
-     * @param listener The listener to exclude from load progress.
-     */
-    unregisterLoadProgressListener(listener: (e: _LoadProgressEventData1) => void): void;
-    /**
-     * Request that the scene renders to a given canvas
-     * @param canvas The canvas we should render to.
-     */
-    registerView(canvas: HTMLCanvasElement): void;
-    /**
-     * Returns the number of active viewers of the scene. Useful for
-     * avoiding unnecessary rendering when there are no active viewers.
-     */
-    getNumViewports(): number;
-    /**
-     * Tells babylon that we no longer want the given canvas to be rendered to.
-     * @param canvas The canvas to be excluded from rendering.
-     */
-    unregisterView(canvas: HTMLCanvasElement): void;
-    /**
-     * Shutdown the preview engine. Noop if the engine is not initialized.
-     */
-    shutdown(): void;
-    /**
-     * Initialize the scene. Also initialize the engine, if it hasn't been done already.
-     */
-    initialize(src: string, contextService?: RenderableContextService): Promise<void>;
-    /**
-     * Executes an animation in the currently loaded scene.
-     * @param animation The current animation track to run.
-     */
-    executeModelAnimation(animation: ModelAnimation): void;
-    /**
-     * Executes an animation of the camera.
-     * @param animation The animation to execute.
-     */
-    executeCameraAnimation(animation: CameraAnimation): void;
-    /**
-     * Returns the values of the Arc Rotate Camera
-     */
-    getCameraPose(): CameraPose | undefined;
-    /**
-     * Sets the values of the Arc Rotate Camera
-     */
-    setCameraPose(cameraPose: CameraPose): void;
-    /**
-     * Applies a given material modifier to a target material in the scene.
-     * @param targetMaterial The material to target.
-     * @param key A unique key used to identify this action.
-     * @param material The material modifier to apply.
-     */
-    applyMaterialVariant(targetMaterial: string, key: string, material: MaterialResource, removeWhenUndefined?: boolean): Promise<void>;
-    /**
-     * Applies a given model variant to the scene.
-     * @param key A unique key used to identify this action.
-     * @param modelDetails An asset containing a model file to be loaded into the scene.
-     */
-    applyModelVariant(key: string, modelDetails: ModelDetails, replaceProductModel: boolean): Promise<void>;
-    /**
-     * Controls the current control state of the camera.
-     * @param rigType The control type to use.
-     */
-    setCameraState(rigType: _ProductCameraRig1): void;
-    /**
-     * Restores the product camera to it's last set focus point. If the user has
-     * been panning this will animate the camera to the original focus point. If the camera is still
-     * focused on it's origin point this function is a noop.
-     */
-    animateToLastCameraFocus(): Promise<void>;
-    /**
-     * When configuration has allowed for auto rotation we
-     * can pause the rotation via this function.
-     * @param shouldAutoRotate When true rotation is running, paused otherwise.
-     */
-    setAutoRotation(shouldAutoRotate: boolean): void;
-    /**
-     * Get current load progress for the scene.
-     */
-    getSceneInitializationProgress(): number;
-    /**
-     * Returns the current configuration object applied to the scene.
-     */
-    getCurrentConfiguration(): PreviewOptions | undefined;
-    /**
-     * Takes a screenshot of the scene using a given
-     * camera animation otherwise using the existing orientation
-     * of the camera in the scene. A resolution must be provided
-     * to render the scene at.
-     */
-    renderSceneScreenshot(resolution: number, cameraAnimation: CameraAnimation): Promise<string>;
-    /**
-     * Returns true when the current configuration allows the user
-     * to rotate around the product.
-     */
-    orbitEnabled(): boolean;
-    /**
-     * When called will trigger the internal engine to match the current
-     * canvas size. This ensures the image renders correctly in the view and
-     * also prevents performance problems.
-     */
-    fireResizeEvent(): void;
-    /**
-     * A callback when the user clicks in the scene and a material is hit.
-     */
-    onMaterialSelected(cb: (material: MaterialHandle) => void): void;
-    /**
-     * Designed for use when utilizing the 3D preview in an editor format.
-     * List named materials that are available in the scene.
-     */
-    listMaterials(): readonly MaterialHandle[];
-    /**
-     * Designed for use when utilizing the 3D preview in an editor format.
-     * Given a list of material names, highlights the associated meshes in the scene.
-     */
-    setHighlights(materials: readonly MaterialHandle[], color?: readonly [number, number, number]): void;
-};
-/**
- * Details relating to a model for use in the preview.
- */
-type ModelDetails = {
-    readonly model?: string;
-    readonly contextService: RenderableContextService;
-};
-/**
- * Represents a service capable of managing and returning contexts that
- * can be used for rendering to textures in the 3D preview.
- */
-type RenderableContextService = {
-    /**
-     * Returns all managed renderable contexts.
-     */
-    getAll(): ReadonlyMap<string, RenderableContext>;
-};
-/**
- * A renderable context represents the relationship of a texture in the 3D preview
- * with an external canvas. This context allows external clients to render to a texture
- * in the 3D preview with a simple interface.
- */
-type RenderableContext = {
-    /**
-     * A unique identifier for this renderable context.
-     */
-    getID(): string;
-    /**
-     * A name for this renderable.
-     */
-    getName(): string;
-    /**
-     * Sets the render context associated to this renderable.
-     * @param ctx The context to use for rendering.
-     */
-    setStaticContext(ctx: CanvasRenderingContext2D): void;
-    /**
-     * Get the render context associated to this renderable.
-     */
-    getStaticContext(): CanvasRenderingContext2D | undefined;
-    /**
-     * Sets whether or not this renderable is dirty and will need re-rendering.
-     * @param value The new value
-     */
-    setStaticContextDirty(value: boolean): void;
-    /**
-     * When this context has been set as dirty, returns true.
-     */
-    getStaticContextDirty(): boolean;
-    /**
-     * A timestamp for the last successful render of the context.
-     */
-    getLastCompletedStaticRender(): number | undefined;
-};
-/**
- * Represents a handle to a material in the 3D scene. The underlying complexity of materials is abstracted
- * away so the client doesn't need to know anything more than the ID they're given and the name.
- */
-type MaterialHandle = {
-    /**
-     * The identifier for the material.
-     */
-    readonly id: string;
-    /**
-     * The human readable name for the material.
-     */
-    readonly name: string;
-};
-/**
- * Settings related to the 3D preview.
- */
-type PreviewOptions = {
-    /**
-     * The color expected to be seen in the background of the product. Expects a hexadecimal value.
-     */
-    readonly backgroundColor?: string;
-    /**
-     * Image to be used as a background when running withh transparency, the image
-     * will be scaled and centered to fill the preview based on aspect ratio.
-     */
-    readonly backgroundImage?: string;
-    /**
-     * The closest zoom the camera can achieve to the product.
-     */
-    readonly maxZoomOverride?: number;
-    /**
-     * The furthest zoom the camera can achieve to the product.
-     */
-    readonly minZoomOverride?: number;
-    /**
-     * The environment file used to calculate product lighting.
-     */
-    readonly environmentFile?: string;
-    /**
-     * The lowest point, vertically, that the camera can rotate to.
-     * https://doc.babylonjs.com/divingDeeper/cameras/camera_introduction
-     */
-    readonly lowerBetaLimitDeg?: number;
-    /**
-     * The highest point, vertically, that the camera can rotate to.
-     * https://doc.babylonjs.com/divingDeeper/cameras/camera_introduction
-     */
-    readonly upperBetaLimitDeg?: number;
-    /**
-     * The leftmost point, horizontally, that the camera can rotate to.
-     * https://doc.babylonjs.com/divingDeeper/cameras/camera_introduction
-     */
-    readonly lowerAlphaLimitDeg?: number;
-    /**
-     * The rightmost point, horizontally, that the camera can rotate to.
-     * https://doc.babylonjs.com/divingDeeper/cameras/camera_introduction
-     */
-    readonly upperAlphaLimitDeg?: number;
-    /**
-     * When set the product while rotate slowly
-     */
-    readonly autoRotation?: boolean;
-    /**
-     * Time in milliseconds before the product starts rotating after a user input has taken control.
-     */
-    readonly idleTimeBeforeRotation?: number;
-    /**
-     * When set the 3D preview won't attempt to orient the product automatically to its front view at load.
-     */
-    readonly disableAutomaticOrientation?: boolean;
-    /**
-     * When true the action bar won't be displayed to the user.
-     */
-    readonly disableActionBar?: boolean;
-    /**
-     * When set, mousing over the model in this preview will highlight the associated mesh/material.
-     * When layout contexts are provided, only the materials with matching names will highlight.
-     */
-    readonly highlightOnMaterialHover?: boolean;
-    /**
-     * Sets the color of highlights when enabled. Expects hexadecimal value.
-     */
-    readonly highlightColor?: string;
-};
-/**
- * Defines the different behaviors supported by the camera system
- * for control when viewing a product.
- */
-enum _ProductCameraRig1 {
-    Orbit = 0,
-    Pan = 1
-}
-/**
- * Identical to CameraAnimation typing, however the
- * target is always available and hence is not optional.
- */
-type CameraPose = {
-    readonly lonDeg: number;
-    readonly radius: number;
-    readonly latDeg: number;
-    readonly target: {
-        readonly x: number;
-        readonly y: number;
-        readonly z: number;
-    };
-};
-type _LoadProgressEventData1 = {
-    /**
-     * The total load value of the scene, this is an average of all
-     * 'in progress' loading events. when all events are fully loaded this value will be 100.
-     */
-    readonly loadValue: number;
-    /**
-     * This value is true when the base model and scene have been initialized.
-     */
-    readonly sceneInitialized: boolean;
-};
 declare class OptionService {
     /**
      * Returns a promise that resolves once all options required for a given workflow
@@ -1430,11 +1120,11 @@ export class Client {
      * @param previewServiceConstructor A function called during initialization. Takes a class implementing ThreeDPreviewService in return.
      * @returns A workflow experience configured as requested.
      */
-    getWorkflowExperience(workflowId?: string, workflowState?: string, previewServiceConstructor?: (workflow: Workflow) => _ThreeDPreviewService2): Promise<WorkflowExperience>;
+    getWorkflowExperience(workflowId?: string, workflowState?: string, previewServiceConstructor?: (workflow: Workflow) => _ThreeDPreviewService1): Promise<WorkflowExperience>;
     /**
      * @returns The preview service that was provided during construction.
      */
-    getPreviewService(): import("types")._ThreeDPreviewService2;
+    getPreviewService(): _ThreeDPreviewService1;
     /**
      * @returns The product associated with this client.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "0.4.2",
+    "version": "0.4.3",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",