@spiffcommerce/core 27.2.1-beta.f9f891fb-9e3d-52fc-8c9a-0382e6e1afa4 → 27.3.0-beta.03158811-571a-5ee0-a571-7a626071de03

package/CHANGELOG.md

@@ -14,6 +14,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -   `Fixed` for any bug fixes.
 -   `Security` in case of vulnerabilities.
 
+## [27.3.0] - 28-07-2025
+
+## Added
+
+-   CurrencyService & CurrencyContext can now be used to correctly transform values for display. See `client.getCurrencyContext`
+
 ## [27.2.1] - 28-07-2025
 
 ## Fixed

package/dist/index.d.ts

@@ -5,6 +5,7 @@ import { RenderableContextService, RenderableContext, ThreeDPreviewService, Mode
 import * as lodash from 'lodash';
 import { CompleteQuoteMessage, ThemeInstallConfigurationGraphQl, ConversionConfiguration } from '@spiffcommerce/theme-bridge';
 export { ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation } from '@spiffcommerce/theme-bridge';
+import { Currency } from 'dinero.js';
 import { FuseResult } from 'fuse.js';
 import { Font } from 'opentype.js';
 
@@ -1374,14 +1375,13 @@ declare abstract class GlobalPropertyHandle {
     /**
      * Applies the global state to all shared steps, if the state is set.
      * @param targetExperiences Optionally filter the workflow experiences it should be applied to.
-     * @param checkAllSteps Whether to consider all steps in the workflow, not just the ones that are conditionally active.
      */
-    abstract applyGlobalState(targetExperiences?: WorkflowExperience[], checkAllSteps?: boolean): Promise<void>;
+    abstract applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
     /**
      * Returns all steps that share this property.
      * @param targetExperiences Optionally filter the steps to only those in the given experiences.
      */
-    protected getSharedSteps(targetExperiences?: WorkflowExperience[], checkAllSteps?: boolean): StepHandle<AnyStepData>[];
+    protected getSharedSteps(targetExperiences?: WorkflowExperience[]): StepHandle<AnyStepData>[];
     protected getStateValue(): string | undefined;
 }
 /**
@@ -1428,7 +1428,7 @@ declare class FileUploadGlobalPropertyHandle extends GlobalPropertyHandle {
     getBackgroundRemovedImage(): Promise<Asset | undefined>;
     getUseOriginalImage(): boolean;
     setUseOriginalImage(value: boolean): Promise<void>;
-    applyGlobalState(targetExperiences?: WorkflowExperience[], checkAllSteps?: boolean): Promise<void>;
+    applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
     getAvailableColors(): ColorOption[];
     getCurrentColors(): {
         [key: string]: ColorDefinition;
@@ -1440,7 +1440,7 @@ declare class FileUploadGlobalPropertyHandle extends GlobalPropertyHandle {
     } | undefined>;
     changeColors(newFills: {
         [key: string]: ColorDefinition;
-    }, checkAllSteps?: boolean): Promise<void>;
+    }): Promise<void>;
     private applyImageSelection;
     private updateSharedStepStorage;
 }
@@ -1453,7 +1453,7 @@ declare class TextGlobalPropertyHandle extends GlobalPropertyHandle {
     /**
      * Set the text.
      */
-    setText(text: string, checkAllSteps?: boolean): Promise<void>;
+    setText(text: string): Promise<void>;
     applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
     private applyTextSelection;
 }
@@ -1484,7 +1484,7 @@ declare class OptionGlobalPropertyHandle extends GlobalPropertyHandle {
      * Select a given variant on the option for all shared steps.
      * @param variant The variant to select.
      */
-    selectVariant(variant: Variant, channel?: number, checkAllSteps?: boolean): Promise<void>;
+    selectVariant(variant: Variant, channel?: number): Promise<void>;
     applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
     private applyVariantSelection;
 }
@@ -1505,7 +1505,7 @@ declare class ColorOptionGlobalPropertyHandle extends OptionGlobalPropertyHandle
     /**
      * Sets a custom color on the global state.
      */
-    setCustomColor(color: string, checkAllSteps?: boolean): void;
+    setCustomColor(color: string): void;
     /**
      * Gets the custom color used by the global state.
      */
@@ -2188,6 +2188,57 @@ declare class IntegrationProduct {
     getAllWorkflows(): ProductWorkflow$1[];
 }
 
+declare class CurrencyService {
+    /**
+     * Returns a formatted string representing a given amount with desired currency.
+     * @param currency The currency to represent the amount in.
+     * @param amount The amount in minor units to format.
+     */
+    formatCurrencyForDisplay(currency: Currency, amount: number): any;
+    /**
+     * Get the number of decimal places expected in a currency string.
+     * @param currency The currency to determine precision for.
+     */
+    getPrecisionForCurrency(currency: Currency): number;
+    /**
+     * Sometimes default formatting will display format in a way that isn't natural
+     * for natives of a currency. This function is intended to capture those specific cases and return a format
+     * that makes the most sense.
+     * @param currency The currency to test for special format.
+     */
+    private getSpecialFormat;
+}
+declare class CurrencyContext {
+    private readonly presentmentCurrency?;
+    private readonly partnerCurrency;
+    private readonly rateFrom;
+    private readonly rateTo;
+    constructor(rateFrom: number, rateTo: number, partnerCurrency: Currency, presentmentCurrency?: Currency);
+    /**
+     * @returns The currency code for the currency being used for monetary display.
+     */
+    code(): Currency;
+    /**
+     * @returns true if the conversion is required, false otherwise.
+     */
+    conversionRequired(): boolean;
+    /**
+     * Converts a monetary value from a workflow in a partner specified currency
+     * to the units of the currency being used for display.
+     * @param amount The amount in minor units to convert.
+     * @returns
+     */
+    getConvertedSubunits(amount: number): number;
+    /**
+     * Converts a monetary value from the database to the units of its currency.
+     */
+    private units;
+    /**
+     * Converts a monetary value in units to the subunits of its currency.
+     */
+    private subunits;
+}
+
 declare const getWorkflows: (ids: string[], options?: GetWorkflowGraphqlOptions) => Promise<Workflow[]>;
 declare const getWorkflow: (id: string, options?: GetWorkflowGraphqlOptions) => Promise<Workflow>;
 /**
@@ -2299,7 +2350,6 @@ interface ClientConfiguration {
  */
 declare class SpiffCommerceClient {
     private options;
-    private currencyCode?;
     private customer?;
     private activeIntegration?;
     private marketplaceThemeInstallId?;
@@ -2314,8 +2364,8 @@ declare class SpiffCommerceClient {
      * and the Spiff Commerce platform.
      */
     getAssetManager(): AssetManager;
-    getCurrencyCode(): string;
     getFlowService(): FlowService;
+    getCurrencyContext(presentmentCurrency: string): Promise<CurrencyContext>;
     getIntegration(): Promise<Integration>;
     canUseAddon(addonHandle: AddonHandle): Promise<boolean>;
     /**
@@ -2400,7 +2450,7 @@ declare class SpiffCommerceClient {
      * @param duplicateTransactions Optional: Whether to also duplicate the original bundle's transactions. Default is true.
      * @returns A bundle to be used for grouping and operating on large amounts of workflow experiences.
      */
-    duplicateBundle(bundleId: string, template?: boolean, duplicateTransactions?: boolean, options?: GetBundleOptions): Promise<Bundle$1>;
+    duplicateBundle(bundleId: string, template?: boolean, duplicateTransactions?: boolean, options?: GetBundleOptions): Promise<() => Promise<Bundle$1>>;
     /**
      * Fetches information about the currently authenticated customer's bundles.
      * NOTE: This does not initialize a bundle for active use.
@@ -5854,4 +5904,4 @@ declare const validateWorkflowExperienceRecipients: (workflowExperiences: Workfl
  */
 declare const getGlobalPropertyStateForBundle: (bundleId: string) => Promise<GlobalPropertyState | undefined>;
 
-export { AddonHandle, AddressComponent, AddressValidationJob, AddressValidationJobStatus, AddressValidationResult, AddressValidationResultConfirmationLevel, Animatable, AnyStepData, ArrayInput, AspectType, Asset, AssetConfiguration, AssetNotFoundError, AssetObjectVersion, AssetType, BringForwardCommand, BringToBackCommand, BringToFrontCommand, Bundle$1 as Bundle, BundleDesignCreationCartAddMode, BundleDesignCreationMessage, BundleEvent, BundleEventData, BundleEventType, Bundle as BundleRaw, BundleStakeholder, CanvasCommand, CollectionProduct, ColorDefinition, ColorOption, ColorOptionGlobalPropertyHandle, ColorProfileProps, CommandContext, CommandState, Condition, ConditionalGlobalPropertiesChangedEventData, CreateElementCommand, CreateLayoutCommand, Customer, CustomerDetailsInput, DeleteElementCommand, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, DigitalContentStepData, DigitalContentStepHandle, EditedSteps, FileUploadGlobalPropertyHandle, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, FrameElement, FrameService, FrameStep, FrameStepData, FrameStepHandle, FrameThresholdSettings, GetNewWorkflowOptions, GetWorkflowOptions, GlobalPropertyConfiguration, GlobalPropertyHandle, GroupCommand, ILayout, IllustrationElement, IllustrationStepData, IllustrationStepHandle, ImageElement, InformationMessageType, InformationResult, InformationStepData, InformationStepHandle, Integration, IntegrationOptionResource, IntegrationProduct, IntegrationType, LayoutComponentConfiguration, LayoutData, LayoutElement, LayoutElementFactory, LayoutElementType, LayoutNotFoundError, LayoutRenderingPurpose, LayoutState, LayoutsState, MandatorySteps, MaterialEffectMode, MaterialStepData, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepData, ModelStepHandle, ModuleStepData, ModuleStepHandle, MoveCommand, NodeType, ObjectInput, ObjectInputType, OptionGlobalPropertyHandle, OptionNotFoundError, OptionResource, Order, OrderItem, PapyrusComponent, ParseError, PictureStepData, PictureStepHandle, Placeable, PmsSearchResult, Point, Product, ProductCameraRig, ProductCollection, ProductCollectionProductSortKey, ProductWorkflow$1 as ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, QuestionStepData, QuestionStepHandle, QueueablePromise, Recipient, Region, RegionElement, RenderableScene, ResizeCommand, ResourceNotFoundError, RotateCommand, SavedDesign, ScaleAxis, SelectionStorage, SendBackwardsCommand, ShapeStepData, ShapeStepHandle, ShareAction, ShareActionType, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, Step, StepAspect, StepAspectType, StepElements, StepGroup, StepHandle, StepStorage, StepType, TextAlgorithm, TextChangeCommand, TextChangeResult, TextGlobalPropertyHandle, TextInput, TextStepData, TextStepHandle, TextStepStorage, TextboxElement, Theme, ToastCallback, Transaction, Transform, TransformCollection$1 as TransformCollection, UnhandledBehaviorError, UnitOfMeasurement, UpdateImageSourceCommand, Variant, VariantResource, Vector3, Workflow, WorkflowExperience, WorkflowExperienceEventType, WorkflowExperienceHoverEventData, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowPanel, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, browserColorToHex, cmPerPixel, createDesign, currentDirection, dataUrlFromExternalUrl, designService, determineCorrectFontSizeAndLines, digitalContentStepService, domParser, duplicateBundle, duplicateTransaction, fetchAsString, findAngle, findElement, findPmsColors, frameDataCache, frameStepService, generate, generateCommands, generateSVGWithUnknownColors, generateStateFromDesignInputSteps, getAddressValidationJobs, getAttributesFromArrayBuffer, getAxisAlignedBoundingBox, getBoundedOffsets, getBundleThemeConfiguration, getCustomer, getCustomerBundles, getElementVertices, getFrameData, getGlobalPropertyStateForBundle, getIntegration, getNEPoint, getNWPoint, getOrderedTransactions, getOverrideThemeConfiguration, getPointOfRotation, getProductCollections, getSEPoint, getSvgElement, getTemplateBundles, getTemplateTransactions, getTransaction, getTransactionThemeConfiguration, getTransactionsForBundle, getTrueCoordinates, getUnorderedTransactions, getValidationJobsForWorkflowExperiences, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, isCloseToValue, loadFont, matchHexToPms, materialStepService, metafieldManager, mmPerPixel, modelStepService, modifySVGColors, moduleStepService, nameBundle, nameTransaction, optionService, outlineFontsInSvg, patternImageDataCache, persistenceService, pictureStepService, pmsToRgb, questionStepService, registerFetchImplementation, registerWindowImplementation, rehydrateSerializedLayout, rgbToPms, rotateAroundPoint, sanitizeSvgTree, setBearerAuthenticationToken, setCanvasModule, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, svgColorValueToDefinition, svgStringDimensions, svgToDataUrl, textStepService, toast, validateWorkflowExperienceRecipient, validateWorkflowExperienceRecipients, xmlSerializer };
+export { AddonHandle, AddressComponent, AddressValidationJob, AddressValidationJobStatus, AddressValidationResult, AddressValidationResultConfirmationLevel, Animatable, AnyStepData, ArrayInput, AspectType, Asset, AssetConfiguration, AssetNotFoundError, AssetObjectVersion, AssetType, BringForwardCommand, BringToBackCommand, BringToFrontCommand, Bundle$1 as Bundle, BundleDesignCreationCartAddMode, BundleDesignCreationMessage, BundleEvent, BundleEventData, BundleEventType, Bundle as BundleRaw, BundleStakeholder, CanvasCommand, CollectionProduct, ColorDefinition, ColorOption, ColorOptionGlobalPropertyHandle, ColorProfileProps, CommandContext, CommandState, Condition, ConditionalGlobalPropertiesChangedEventData, CreateElementCommand, CreateLayoutCommand, CurrencyContext, CurrencyService, Customer, CustomerDetailsInput, DeleteElementCommand, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, DigitalContentStepData, DigitalContentStepHandle, EditedSteps, FileUploadGlobalPropertyHandle, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, FrameElement, FrameService, FrameStep, FrameStepData, FrameStepHandle, FrameThresholdSettings, GetNewWorkflowOptions, GetWorkflowOptions, GlobalPropertyConfiguration, GlobalPropertyHandle, GroupCommand, ILayout, IllustrationElement, IllustrationStepData, IllustrationStepHandle, ImageElement, InformationMessageType, InformationResult, InformationStepData, InformationStepHandle, Integration, IntegrationOptionResource, IntegrationProduct, IntegrationType, LayoutComponentConfiguration, LayoutData, LayoutElement, LayoutElementFactory, LayoutElementType, LayoutNotFoundError, LayoutRenderingPurpose, LayoutState, LayoutsState, MandatorySteps, MaterialEffectMode, MaterialStepData, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepData, ModelStepHandle, ModuleStepData, ModuleStepHandle, MoveCommand, NodeType, ObjectInput, ObjectInputType, OptionGlobalPropertyHandle, OptionNotFoundError, OptionResource, Order, OrderItem, PapyrusComponent, ParseError, PictureStepData, PictureStepHandle, Placeable, PmsSearchResult, Point, Product, ProductCameraRig, ProductCollection, ProductCollectionProductSortKey, ProductWorkflow$1 as ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, QuestionStepData, QuestionStepHandle, QueueablePromise, Recipient, Region, RegionElement, RenderableScene, ResizeCommand, ResourceNotFoundError, RotateCommand, SavedDesign, ScaleAxis, SelectionStorage, SendBackwardsCommand, ShapeStepData, ShapeStepHandle, ShareAction, ShareActionType, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, Step, StepAspect, StepAspectType, StepElements, StepGroup, StepHandle, StepStorage, StepType, TextAlgorithm, TextChangeCommand, TextChangeResult, TextGlobalPropertyHandle, TextInput, TextStepData, TextStepHandle, TextStepStorage, TextboxElement, Theme, ToastCallback, Transaction, Transform, TransformCollection$1 as TransformCollection, UnhandledBehaviorError, UnitOfMeasurement, UpdateImageSourceCommand, Variant, VariantResource, Vector3, Workflow, WorkflowExperience, WorkflowExperienceEventType, WorkflowExperienceHoverEventData, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowPanel, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, browserColorToHex, cmPerPixel, createDesign, currentDirection, dataUrlFromExternalUrl, designService, determineCorrectFontSizeAndLines, digitalContentStepService, domParser, duplicateBundle, duplicateTransaction, fetchAsString, findAngle, findElement, findPmsColors, frameDataCache, frameStepService, generate, generateCommands, generateSVGWithUnknownColors, generateStateFromDesignInputSteps, getAddressValidationJobs, getAttributesFromArrayBuffer, getAxisAlignedBoundingBox, getBoundedOffsets, getBundleThemeConfiguration, getCustomer, getCustomerBundles, getElementVertices, getFrameData, getGlobalPropertyStateForBundle, getIntegration, getNEPoint, getNWPoint, getOrderedTransactions, getOverrideThemeConfiguration, getPointOfRotation, getProductCollections, getSEPoint, getSvgElement, getTemplateBundles, getTemplateTransactions, getTransaction, getTransactionThemeConfiguration, getTransactionsForBundle, getTrueCoordinates, getUnorderedTransactions, getValidationJobsForWorkflowExperiences, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, isCloseToValue, loadFont, matchHexToPms, materialStepService, metafieldManager, mmPerPixel, modelStepService, modifySVGColors, moduleStepService, nameBundle, nameTransaction, optionService, outlineFontsInSvg, patternImageDataCache, persistenceService, pictureStepService, pmsToRgb, questionStepService, registerFetchImplementation, registerWindowImplementation, rehydrateSerializedLayout, rgbToPms, rotateAroundPoint, sanitizeSvgTree, setBearerAuthenticationToken, setCanvasModule, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, svgColorValueToDefinition, svgStringDimensions, svgToDataUrl, textStepService, toast, validateWorkflowExperienceRecipient, validateWorkflowExperienceRecipients, xmlSerializer };