@spiffcommerce/core 21.1.0 → 21.1.2

package/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [21.1.1] - 15-03-2024
+
+### Fixed
+
+- Exported missing `AspectType` for global property handles.
+
+## [21.1.0] - 14-03-2024
+
+### Added
+
+- `Bundle.hasGlobalProperties(): boolean`: Returns true when the bundle is linked to a Global Property Configuration.
+
 ## [21.0.1] - 13-03-2024
 
 ### Fixed

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as _spiffcommerce_papyrus 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, FrameStepData, CreateElementCommand, FrameElement, IllustrationStepData, IllustrationElement, ColorDefinition, MaterialStepData, ModelStepData, TextStepData, TextboxElement, TextFillImage, FontData, GroupCommand, PictureStepData, QuestionStepData, ShapeStepData, ModuleStepData, DigitalContentStepData, FrameData as FrameData$1, InformationStepData } from '@spiffcommerce/papyrus';
-export { Animatable, AnyStepData, Asset, AssetType, BringForwardCommand, BringToBackCommand, BringToFrontCommand, 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, loadFont, patternImageDataCache, registerFetchImplementation, registerWindowImplementation, rehydrateSerializedLayout, setCanvasModule } from '@spiffcommerce/papyrus';
+export { Animatable, AnyStepData, AspectType, Asset, AssetType, BringForwardCommand, BringToBackCommand, BringToFrontCommand, 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, loadFont, patternImageDataCache, registerFetchImplementation, registerWindowImplementation, rehydrateSerializedLayout, setCanvasModule } from '@spiffcommerce/papyrus';
 import { ApolloClient, MutationOptions, FetchResult } from '@apollo/client/core';
 import { RenderableContextService, RenderableContext, ThreeDPreviewService, ModelContainer } from '@spiffcommerce/preview';
 import * as lodash from 'lodash';
@@ -1667,6 +1667,76 @@ declare abstract class GlobalPropertyHandle {
      */
     protected getSharedSteps(targetExperiences?: WorkflowExperience[]): StepHandle<_spiffcommerce_papyrus.AnyStepData>[];
 }
+/**
+ * A file upload global property allows for setting a frame image against all shared steps.
+ */
+declare class FileUploadGlobalPropertyHandle extends GlobalPropertyHandle {
+    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect);
+    /**
+     * Select an image to be used for all shared steps.
+     * @param asset The asset to use.
+     * @returns A promise resolving when all affected steps have been updated.
+     */
+    selectImage(asset: Asset): Promise<void>;
+    applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
+    private applyImageSelection;
+}
+declare class TextGlobalPropertyHandle extends GlobalPropertyHandle {
+    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect);
+    /**
+     * Gets the current text
+     */
+    getText(): string;
+    /**
+     * Set the text.
+     */
+    setText(text: string): Promise<void>;
+    applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
+    private applyTextSelection;
+}
+/**
+ * An option property handle represents a property that can
+ * affect the option of steps across multiple transactions.
+ */
+declare class OptionGlobalPropertyHandle extends GlobalPropertyHandle {
+    protected optionResource?: OptionResource;
+    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect, optionResource: OptionResource | undefined);
+    /**
+     * Gets the currently selected variant, or undefined if no variant is selected.
+     */
+    getCurrentVariant(): Variant | undefined;
+    /**
+     * @returns A list of valid variants for this step. Does not include disabled variants.
+     */
+    getAvailableVariants(): Variant[];
+    /**
+     * @returns A list of all variants for this step, including disabled ones.
+     */
+    getAllVariants(): Variant[];
+    /**
+     * Select a given variant on the option for all shared steps.
+     * @param variant The variant to select.
+     */
+    selectVariant(variant: Variant): Promise<void>;
+    applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
+    private applyVariantSelection;
+}
+/**
+ * A color option property handle represents a property that can
+ * affect the option of steps across multiple transactions. This class is a specialization of the OptionGlobalPropertyHandle which includes functionality for
+ * setting custom color values when a custom color variant is selected.
+ */
+declare class ColorOptionGlobalPropertyHandle extends OptionGlobalPropertyHandle {
+    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect, optionResource: OptionResource | undefined);
+    /**
+     * Sets a custom color on the global state.
+     */
+    setCustomColor(color: string): void;
+    /**
+     * Gets the custom color used by the global state.
+     */
+    getCustomColor(): string;
+}
 
 interface GlobalPropertyStateManager {
     getInitializationPromise(): Promise<void>;
@@ -3032,4 +3102,4 @@ declare class PromiseCache {
 }
 declare const promiseCache: PromiseCache;
 
-export { ArrayInput, AssetNotFoundError, Bundle, BundleDesignCreationMessage, BundleEvent, BundleEventData, BundleEventType, CollectionProduct, ColorOption, ConditionalGlobalPropertiesChangedEventData, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FrameService, FrameStep, FrameStepHandle, FrameThresholdSettings, GetNewWorkflowOptions, 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, WorkflowExperienceEventType, WorkflowExperienceHoverEventData, 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 };
+export { ArrayInput, AssetNotFoundError, Bundle, BundleDesignCreationMessage, BundleEvent, BundleEventData, BundleEventType, CollectionProduct, ColorOption, ColorOptionGlobalPropertyHandle, ConditionalGlobalPropertiesChangedEventData, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FileUploadGlobalPropertyHandle, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FrameService, FrameStep, FrameStepHandle, FrameThresholdSettings, GetNewWorkflowOptions, GetWorkflowOptions, GlobalPropertyHandle, IllustrationStepHandle, InformationMessageType, InformationResult, InformationStepHandle, IntegrationProduct, IntegrationType, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, NodeType, ObjectInput, ObjectInputType, OptionGlobalPropertyHandle, 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, TextGlobalPropertyHandle, TextInput, TextStepHandle, TextStepStorage, Transaction, Transform, TransformCollection, UnhandledBehaviorError, Variant, Vector3, WorkflowExperience, WorkflowExperienceEventType, WorkflowExperienceHoverEventData, 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 };

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 $e, getAttributesFromArrayBuffer as yA, AssetType as BA, StepType as D, getFrameData as _e, frameDataCache as ut, GroupCommand as G, UpdateFramePattern as YA, UpdateFrameThresholdSettingsCommand as mt, calculateOffsets as eA, LayoutElementType as v, generate as J, CreateElementCommand as L, generateSVGWithUnknownColors as SA, svgObjectURL as fe, fetchAsString as Z, DeleteElementCommand as $, generateDefaultRectangleFrameSvg as dA, GetSVGDimensions as It, patternImageDataCache as wA, fetchAsArrayBuffer as pt, findElement as De, modifySVGWithElementProperties as ft, IllustrationColorCommand as Ke, IllustrationCacheCommand as Dt, getFontMetrics as Ft, getPatternImageData as je, FontAlignmentCommand as Mt, FontColorCommand as yt, FontImageFillCommand as Je, applyTextTransformations as Ve, determineCorrectFontSizeAndLines as me, FontSourceCommand as EA, loadFont as AA, TextChangeCommand as Yt, FontSizeCommand as St, createElementNS as xt, createElement as Be, _loadFontExternalDataURL as tA, UpdateWorkflowStateCommand as hA, CommandContext as Pt, createCanvas as Fe, getSvgElement as xA, LayoutRenderingPurpose as PA, renderPapyrusComponentAsString as NA, loadImage as HA, getDomParser as RA, toBase64 as CA, getVariant as Nt, generateFrameSVG as Ht, getDefaultVariant as He, domParser as UA, sanitizeSvgTree as GA, traverse as Rt, xmlSerializer as vA, CreateLayoutCommand as Ut, AspectType as Ie, rehydrateSerializedLayout as ee } from "@spiffcommerce/papyrus";
-import { AssetType as Ki, BringForwardCommand as ji, BringToBackCommand as Vi, BringToFrontCommand as Wi, CanvasCommand as Xi, CommandContext as qi, CreateElementCommand as Zi, CreateLayoutCommand as $i, DeleteElementCommand as _i, FontAlignmentCommand as es, FontColorCommand as As, FontSizeCommand as ts, FontSourceCommand as ns, GroupCommand as as, LayoutElementFactory as is, LayoutElementType as ss, MoveCommand as os, ResizeCommand as rs, RotateCommand as cs, SendBackwardsCommand as gs, StepAspectType as ls, StepType as Bs, TextChangeCommand as ds, UnitOfMeasurement as ws, dataUrlFromExternalUrl as Es, determineCorrectFontSizeAndLines as hs, findElement as Cs, frameDataCache as Qs, generate as us, generateSVGWithUnknownColors as ms, getAttributesFromArrayBuffer as Is, getAxisAlignedBoundingBox as ps, getFrameData as fs, getSvgElement as Ds, loadFont as Fs, patternImageDataCache as Ms, registerFetchImplementation as ys, registerWindowImplementation as Ys, rehydrateSerializedLayout as Ss, setCanvasModule as xs } from "@spiffcommerce/papyrus";
+import { AspectType as Ki, AssetType as ji, BringForwardCommand as Vi, BringToBackCommand as Wi, BringToFrontCommand as Xi, CanvasCommand as qi, CommandContext as Zi, CreateElementCommand as $i, CreateLayoutCommand as _i, DeleteElementCommand as es, FontAlignmentCommand as As, FontColorCommand as ts, FontSizeCommand as ns, FontSourceCommand as as, GroupCommand as is, LayoutElementFactory as ss, LayoutElementType as os, MoveCommand as rs, ResizeCommand as cs, RotateCommand as gs, SendBackwardsCommand as ls, StepAspectType as Bs, StepType as ds, TextChangeCommand as ws, UnitOfMeasurement as Es, dataUrlFromExternalUrl as hs, determineCorrectFontSizeAndLines as Cs, findElement as Qs, frameDataCache as us, generate as ms, generateSVGWithUnknownColors as Is, getAttributesFromArrayBuffer as ps, getAxisAlignedBoundingBox as fs, getFrameData as Ds, getSvgElement as Fs, loadFont as Ms, patternImageDataCache as ys, registerFetchImplementation as Ys, registerWindowImplementation as Ss, rehydrateSerializedLayout as xs, setCanvasModule as Ps } from "@spiffcommerce/papyrus";
 import { setContext as Gt } from "@apollo/client/link/context";
 import { onError as vt } from "@apollo/client/link/error";
 import { Pith as kA } from "pith";
@@ -10781,46 +10781,50 @@ class Fi extends W {
 }
 export {
   Li as ArrayInput,
+  Ki as AspectType,
   _ as AssetNotFoundError,
-  Ki as AssetType,
-  ji as BringForwardCommand,
-  Vi as BringToBackCommand,
-  Wi as BringToFrontCommand,
-  Xi as CanvasCommand,
+  ji as AssetType,
+  Vi as BringForwardCommand,
+  Wi as BringToBackCommand,
+  Xi as BringToFrontCommand,
+  qi as CanvasCommand,
   Oe as CollectionProduct,
-  qi as CommandContext,
+  Wa as ColorOptionGlobalPropertyHandle,
+  Zi as CommandContext,
   cn as ConversionDataType,
   rn as ConversionLocation,
-  Zi as CreateElementCommand,
-  $i as CreateLayoutCommand,
-  _i as DeleteElementCommand,
+  $i as CreateElementCommand,
+  _i as CreateLayoutCommand,
+  es as DeleteElementCommand,
+  ja as FileUploadGlobalPropertyHandle,
   Qe as FlowExecutionNodeResult,
   ii as FlowExecutionResult,
   ai as FlowService,
-  es as FontAlignmentCommand,
-  As as FontColorCommand,
-  ts as FontSizeCommand,
-  ns as FontSourceCommand,
+  As as FontAlignmentCommand,
+  ts as FontColorCommand,
+  ns as FontSizeCommand,
+  as as FontSourceCommand,
   pn as FrameService,
   Di as FrameStep,
   Fi as FrameStepHandle,
   gA as GlobalPropertyHandle,
-  as as GroupCommand,
+  is as GroupCommand,
   $n as IllustrationStepHandle,
   Pe as InformationMessageType,
   ia as InformationStepHandle,
   MA as IntegrationProduct,
   sn as IntegrationType,
-  is as LayoutElementFactory,
-  ss as LayoutElementType,
+  ss as LayoutElementFactory,
+  os as LayoutElementType,
   z as LayoutNotFoundError,
   _n as MaterialStepHandle,
   ye as MisconfigurationError,
   Ti as MockWorkflowManager,
   ea as ModelStepHandle,
-  os as MoveCommand,
+  rs as MoveCommand,
   dt as ObjectInput,
   si as ObjectInputType,
+  Bt as OptionGlobalPropertyHandle,
   Me as OptionNotFoundError,
   oe as ParseError,
   Aa as PictureStepHandle,
@@ -10831,61 +10835,62 @@ export {
   XA as PromiseQueue,
   ta as QuestionStepHandle,
   WA as QueueablePromise,
-  rs as ResizeCommand,
+  cs as ResizeCommand,
   ce as ResourceNotFoundError,
-  cs as RotateCommand,
-  gs as SendBackwardsCommand,
+  gs as RotateCommand,
+  ls as SendBackwardsCommand,
   na as ShapeStepHandle,
   fi as SpiffCommerceClient,
   Ye as StakeholderType,
-  ls as StepAspectType,
+  Bs as StepAspectType,
   W as StepHandle,
-  Bs as StepType,
-  ds as TextChangeCommand,
+  ds as StepType,
+  ws as TextChangeCommand,
+  Va as TextGlobalPropertyHandle,
   bi as TextInput,
   aa as TextStepHandle,
   ti as Transform,
   Ai as TransformCollection,
   k as UnhandledBehaviorError,
-  ws as UnitOfMeasurement,
+  Es as UnitOfMeasurement,
   X as Variant,
   Ea as WorkflowExperienceEventType,
   he as WorkflowExperienceImpl,
   O as assetService,
   la as createDesign,
-  Es as dataUrlFromExternalUrl,
+  hs as dataUrlFromExternalUrl,
   Te as designService,
-  hs as determineCorrectFontSizeAndLines,
+  Cs as determineCorrectFontSizeAndLines,
   Fn as digitalContentStepService,
-  Cs as findElement,
-  Qs as frameDataCache,
+  Qs as findElement,
+  us as frameDataCache,
   Xe as frameStepService,
-  us as generate,
+  ms as generate,
   Ma as generateCommands,
-  ms as generateSVGWithUnknownColors,
+  Is as generateSVGWithUnknownColors,
   Ji as generateStateFromDesignInputSteps,
-  Is as getAttributesFromArrayBuffer,
-  ps as getAxisAlignedBoundingBox,
+  ps as getAttributesFromArrayBuffer,
+  fs as getAxisAlignedBoundingBox,
   In as getBoundedOffsets,
-  fs as getFrameData,
-  Ds as getSvgElement,
+  Ds as getFrameData,
+  Fs as getSvgElement,
   ue as getWorkflow,
   wt as getWorkflows,
   P as graphQlManager,
   pe as illustrationStepService,
-  Fs as loadFont,
+  Ms as loadFont,
   ZA as materialStepService,
   $A as modelStepService,
   Pn as moduleStepService,
   j as optionService,
-  Ms as patternImageDataCache,
+  ys as patternImageDataCache,
   x as persistenceService,
   _A as pictureStepService,
   et as questionStepService,
-  ys as registerFetchImplementation,
-  Ys as registerWindowImplementation,
-  Ss as rehydrateSerializedLayout,
-  xs as setCanvasModule,
+  Ys as registerFetchImplementation,
+  Ss as registerWindowImplementation,
+  xs as rehydrateSerializedLayout,
+  Ps as setCanvasModule,
   re as shapeStepService,
   fn as shortenUrl,
   q as spiffCoreConfiguration,