@spiffcommerce/core 12.5.0 → 12.6.0

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { Workflow as _Workflow1, StepAspect as _StepAspect1, Step as _Step1, AnyStepData as _AnyStepData1, Asset as _Asset1, Region, VariantResource as _VariantResource1, FrameOffsets, PatternImageData, DigitalContentStepData as _DigitalContentStepData1, LayoutsState as _LayoutsState1, CanvasCommand as _CanvasCommand1, FrameStepData as _FrameStepData1, ILayout as _ILayout1, CreateElementCommand as _CreateElementCommand1, FrameElement as _FrameElement1, ColorDefinition as _ColorDefinition1, IllustrationStepData as _IllustrationStepData1, IllustrationElement as _IllustrationElement1, LayoutData as _LayoutData1, MaterialStepData as _MaterialStepData1, ModelStepData as _ModelStepData1, ModuleStepData as _ModuleStepData1, PictureStepData as _PictureStepData1, QuestionStepData as _QuestionStepData1, ShapeStepData as _ShapeStepData1, FontData, GroupCommand as _GroupCommand1, OptionResource as _OptionResource1, TextboxElement as _TextboxElement1, TextFillImage, TextStepData as _TextStepData1, StepStorage as _StepStorage1, SerializableStep, CommandState as _CommandState1, CommandContext as _CommandContext1, LayoutState, MaterialResource, AssetType as _AssetType1, Point, ScaleAxis, UnitOfMeasurement as _UnitOfMeasurement1, StepType as _StepType1, BulkStepData as _BulkStepData1, Theme as _Theme1, FrameData as _FrameData1, Animatable, AnyStepData, Asset, AssetType, BringForwardCommand, BringToFrontCommand, BringToBackCommand, BulkStepData, CanvasCommand, ColorDefinition, CommandContext, CommandState, CreateElementCommand, DeleteElementCommand, DigitalContentStepData, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, FrameElement, FrameStepData, GroupCommand, ILayout, IllustrationElement, IllustrationStepData, ImageElement, LayoutData, LayoutElement, LayoutElementFactory, LayoutElementType, LayoutsState, MaterialStepData, ModelStepData, ModuleStepData, MoveCommand, OptionResource, PictureStepData, QuestionStepData, ResizeCommand, RotateCommand, SendBackwardsCommand, ShapeStepData, Step, StepAspect, StepAspectType, StepStorage, StepType, TextChangeCommand, TextStepData, TextboxElement, UnitOfMeasurement, VariantResource, Workflow, dataUrlFromExternalUrl, findElement, frameDataCache, generate, generateSVGWithUnknownColors, getAttributesFromArrayBuffer, getFrameData, getSvgElement, loadFontFromDataUrl, loadFontFromExternalUrl, patternImageDataCache, CreateLayoutCommand, rehydrateSerializedLayout, ColorProfileProps, WorkflowPanel, determineCorrectFontSizeAndLines, registerJSDOM, getAxisAlignedBoundingBox, Theme } from "@spiffcommerce/papyrus";
+import { Workflow as _Workflow1, StepAspect as _StepAspect1, Step as _Step1, AnyStepData as _AnyStepData1, Asset as _Asset1, Region, VariantResource as _VariantResource1, FrameOffsets, PatternImageData, DigitalContentStepData as _DigitalContentStepData1, LayoutsState as _LayoutsState1, CanvasCommand as _CanvasCommand1, FrameStepData as _FrameStepData1, ILayout as _ILayout1, CreateElementCommand as _CreateElementCommand1, FrameElement as _FrameElement1, ColorDefinition as _ColorDefinition1, IllustrationStepData as _IllustrationStepData1, IllustrationElement as _IllustrationElement1, LayoutData as _LayoutData1, MaterialStepData as _MaterialStepData1, ModelStepData as _ModelStepData1, ModuleStepData as _ModuleStepData1, PictureStepData as _PictureStepData1, QuestionStepData as _QuestionStepData1, ShapeStepData as _ShapeStepData1, FontData, GroupCommand as _GroupCommand1, OptionResource as _OptionResource1, TextboxElement as _TextboxElement1, TextFillImage, TextStepData as _TextStepData1, StepStorage as _StepStorage1, SerializableStep, CommandState as _CommandState1, CommandContext as _CommandContext1, LayoutState, MaterialResource, AssetType as _AssetType1, Point, ScaleAxis, UnitOfMeasurement as _UnitOfMeasurement1, StepType as _StepType1, BulkStepData as _BulkStepData1, FrameData as _FrameData1, AspectType, GlobalPropertyConfigurationAspect, Theme as _Theme1, Animatable, AnyStepData, Asset, AssetType, BringForwardCommand, BringToFrontCommand, BringToBackCommand, BulkStepData, CanvasCommand, ColorDefinition, CommandContext, CommandState, CreateElementCommand, DeleteElementCommand, DigitalContentStepData, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, FrameElement, FrameStepData, GroupCommand, ILayout, IllustrationElement, IllustrationStepData, ImageElement, LayoutData, LayoutElement, LayoutElementFactory, LayoutElementType, LayoutsState, MaterialStepData, ModelStepData, ModuleStepData, MoveCommand, OptionResource, PictureStepData, QuestionStepData, ResizeCommand, RotateCommand, SendBackwardsCommand, ShapeStepData, Step, StepAspect, StepAspectType, StepStorage, StepType, TextChangeCommand, TextStepData, TextboxElement, UnitOfMeasurement, VariantResource, Workflow, dataUrlFromExternalUrl, findElement, frameDataCache, generate, generateSVGWithUnknownColors, getAttributesFromArrayBuffer, getFrameData, getSvgElement, loadFontFromDataUrl, loadFontFromExternalUrl, patternImageDataCache, CreateLayoutCommand, rehydrateSerializedLayout, ColorProfileProps, WorkflowPanel, determineCorrectFontSizeAndLines, registerJSDOM, getAxisAlignedBoundingBox, Theme } from "@spiffcommerce/papyrus";
 import { ApolloClient } from "@apollo/client";
 import React, { ReactNode, Dispatch, FunctionComponent, RefObject, PointerEvent, KeyboardEvent } from "react";
 export const gatherVaryingStepAspects: (workflow: _Workflow1) => _StepAspect1[];
@@ -1045,6 +1045,14 @@ type ProductCollection = {
     name: string;
     products: Product[];
 };
+type GlobalPropertyState = {
+    id: string;
+    aspects: GlobalPropertyStateAspect[];
+};
+type GlobalPropertyStateAspect = {
+    name: string;
+    value: string;
+};
 interface StorageService {
     /**
      * Get a value.
@@ -1476,6 +1484,10 @@ export abstract class StepHandle<T extends _AnyStepData1> {
      * @returns The type of the step handle.
      */
     getType(): _StepType1;
+    /**
+     * @returns The underlying data for this step. Favor using the step handle methods instead of this.
+     */
+    getRaw(): _Step1<T>;
     /**
      * Fires any configured animations on the 3D preview for this step.
      * This includes camera & model animations. If the preview is unavailable
@@ -1862,6 +1874,56 @@ export interface WorkflowExperience {
         [key: string]: string;
     }>;
 }
+export enum FrameStep {
+    SelectFrame = "SelectFrame",
+    SelectImage = "SelectImage",
+    Position = "Position"
+}
+export class FrameStepHandle extends StepHandle<_FrameStepData1> {
+    constructor(manager: WorkflowManager, step: _Step1<_FrameStepData1>);
+    selectVariant(variant: Variant): Promise<void>;
+    onFrameDataChanged(callback: (frameData: _FrameData1) => void): void;
+    selectImage(asset: _Asset1): void;
+    getImageData(): PatternImageData | undefined;
+    getCurrentFrameStep(frameData: _FrameData1, uploading?: any, imageUploadComplete?: any, variants?: _VariantResource1[]): FrameStep;
+    getFrameService(): FrameService | undefined;
+    hasOverlayImageKey(): string | undefined;
+    hasOverlayImageUrl(): any;
+    hasVaryingUpload(): boolean | undefined;
+    hasVaryingSelection(): boolean | undefined;
+}
+/**
+ * TODO: Add GlobalPropertyState mutation & queries to bundle.
+ * TODO: Optimize workflow experience state updates.
+ */
+/**
+ * A GlobalPropertyHandle acts as an interface to global properties on our platform. Currently
+ * bundles can return a handle for any global properties associated to the collection.
+ */
+declare abstract class GlobalPropertyHandle {
+    protected readonly bundle: _Bundle1;
+    protected readonly property: GlobalPropertyConfigurationAspect;
+    constructor(bundle: _Bundle1, property: GlobalPropertyConfigurationAspect);
+    /**
+     * @returns The human friendly name of the property.
+     */
+    getName(): string;
+    /**
+     * @returns A human friendly description.
+     */
+    getDescription(): string;
+    /**
+     * @returns The type of the global property. Use this to determine how to render the property.
+     */
+    getType(): AspectType;
+    /**
+     * Returns all steps that share this property.
+     */
+    protected getSharedSteps(): import("stepHandles").StepHandle<import("@spiffcommerce/papyrus").AnyStepData>[];
+}
+interface GlobalPropertyStateManager {
+    getGlobalPropertyState(): GlobalPropertyState | undefined;
+}
 /**
  * A bundle serves as a container for a set of workflow experience.
  */
@@ -1895,14 +1957,18 @@ interface _Bundle1 {
      */
     setMetadata(metadata: Map<string, string>): Promise<void>;
     /**
-     * Returns true when the bundle contains transactions with shared properties.
+     * Returns true when the bundle contains products that share global properties.
      */
-    hasGlobalProperties(): boolean;
+    hasGlobalProperties(): Promise<boolean>;
     /**
      * Get a handle to the global properties available within this bundle. Setting values
      * via this method will make selections on all bundles that share the property.
      */
-    getGlobalProperties(): any;
+    getGlobalProperties(): Promise<GlobalPropertyHandle[]>;
+    /**
+     * Get the low level state manager for this bundle. Don't use this unless you know what you're doing.
+     */
+    getGlobalPropertyStateManager(): GlobalPropertyStateManager;
     /**
      * Return the total in subunits for this bundle. This is the sum of the total for all individual transactions.
      */
@@ -1922,6 +1988,10 @@ interface _Bundle1 {
      * @param experience The workflow experience to remove from this bundle.
      */
     removeWorkflowExperience(experience: WorkflowExperience): Promise<void>;
+    /**
+     * Returns all workflow experiences currently added to this bundle.
+     */
+    getWorkflowExperiences(): WorkflowExperience[];
     /**
      * Sort the list of workflow experiences.
      */
@@ -2177,24 +2247,6 @@ export class MockWorkflowManager implements WorkflowManager {
     updateMetadata(_stepName: string, _update: any): void;
     updateStorage(_stepName: string, _update: _StepStorage1): Promise<void>;
 }
-export enum FrameStep {
-    SelectFrame = "SelectFrame",
-    SelectImage = "SelectImage",
-    Position = "Position"
-}
-export class FrameStepHandle extends StepHandle<_FrameStepData1> {
-    constructor(manager: WorkflowManager, step: _Step1<_FrameStepData1>);
-    selectVariant(variant: Variant): Promise<void>;
-    onFrameDataChanged(callback: (frameData: _FrameData1) => void): void;
-    selectImage(asset: _Asset1): void;
-    getImageData(): PatternImageData | undefined;
-    getCurrentFrameStep(frameData: _FrameData1, uploading?: any, imageUploadComplete?: any, variants?: _VariantResource1[]): FrameStep;
-    getFrameService(): FrameService | undefined;
-    hasOverlayImageKey(): string | undefined;
-    hasOverlayImageUrl(): any;
-    hasVaryingUpload(): boolean | undefined;
-    hasVaryingSelection(): boolean | undefined;
-}
 export const TransformWrapper: React.FunctionComponent;
 export { CommandContext };
 export { AssetType, BringForwardCommand, BringToFrontCommand, BringToBackCommand, CanvasCommand, CreateElementCommand, CreateLayoutCommand, DeleteElementCommand, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, GroupCommand, LayoutElementFactory, LayoutElementType, MoveCommand, ResizeCommand, RotateCommand, SendBackwardsCommand, StepAspectType, StepType, TextChangeCommand, UnitOfMeasurement, dataUrlFromExternalUrl, findElement, frameDataCache, generate, getAxisAlignedBoundingBox, generateSVGWithUnknownColors, getAttributesFromArrayBuffer, rehydrateSerializedLayout, getFrameData, getSvgElement, loadFontFromDataUrl, loadFontFromExternalUrl, determineCorrectFontSizeAndLines, patternImageDataCache, registerJSDOM };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "12.5.0",
+    "version": "12.6.0",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",
@@ -87,7 +87,7 @@
     },
     "dependencies": {
         "@apollo/client": "^3.7.0",
-        "@spiffcommerce/papyrus": "^2.0.5",
+        "@spiffcommerce/papyrus": "^2.0.9",
         "cross-fetch": "^3.1.5",
         "graphql": "^16.6.0",
         "lodash.clonedeep": "^4.5.0",