@spiffcommerce/core 26.32.0-beta.cf9b855c-b5d3-5d50-a076-25da5f9000cd → 26.32.0-beta.d85ee52e-8aba-574e-973b-cb79d29568db
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +1 -98
- package/dist/index.js +126 -189
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +615 -721
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -5686,101 +5686,4 @@ declare class MetafieldManager {
|
|
|
5686
5686
|
}
|
|
5687
5687
|
declare const metafieldManager: MetafieldManager;
|
|
5688
5688
|
|
|
5689
|
-
|
|
5690
|
-
Confirmed = "Confirmed",
|
|
5691
|
-
Plausible = "Plausible",
|
|
5692
|
-
Unlikely = "Unlikely"
|
|
5693
|
-
}
|
|
5694
|
-
interface AddressValidationResult {
|
|
5695
|
-
/**
|
|
5696
|
-
* Whether the resulting address is considered complete.
|
|
5697
|
-
* An address is considered complete if no components were unexpected or missing.
|
|
5698
|
-
*/
|
|
5699
|
-
addressComplete?: boolean;
|
|
5700
|
-
address?: {
|
|
5701
|
-
/**
|
|
5702
|
-
* The full address, formatted in the standard format for the area.
|
|
5703
|
-
*/
|
|
5704
|
-
formattedAddress?: string;
|
|
5705
|
-
/** Country code; AU, US, UK, etc. */
|
|
5706
|
-
regionCode?: string;
|
|
5707
|
-
postalCode?: string;
|
|
5708
|
-
/** The state/province etc. */
|
|
5709
|
-
administrativeArea?: string;
|
|
5710
|
-
/** Suburb/city */
|
|
5711
|
-
locality?: string;
|
|
5712
|
-
sublocality?: string;
|
|
5713
|
-
};
|
|
5714
|
-
/** The individual components of the address, and their associated validation information. */
|
|
5715
|
-
components?: {
|
|
5716
|
-
/** The text value of the component. */
|
|
5717
|
-
name: string;
|
|
5718
|
-
/**
|
|
5719
|
-
* The type of component it is.
|
|
5720
|
-
* See https://developers.google.com/maps/documentation/places/web-service/legacy/supported_types#table2 for a list of possible types.
|
|
5721
|
-
*/
|
|
5722
|
-
type: string;
|
|
5723
|
-
/** How strongly the validator believes the result to be correct. */
|
|
5724
|
-
confirmationLevel?: AddressValidationResultConfirmationLevel;
|
|
5725
|
-
/** Whether this component was inferred by the validator, i.e. it was not present on the original input. */
|
|
5726
|
-
inferred?: boolean;
|
|
5727
|
-
/** Whether this component had spelling corrected by the validator. */
|
|
5728
|
-
spellCorrected?: boolean;
|
|
5729
|
-
/** Whether this component had its original value completely replaced by the validator. */
|
|
5730
|
-
replaced?: boolean;
|
|
5731
|
-
/** Whether the validator believes this component to be unexpected for the supplied address. */
|
|
5732
|
-
unexpected?: boolean;
|
|
5733
|
-
}[];
|
|
5734
|
-
/**
|
|
5735
|
-
* Component types that were expected to be on the address, but were not present and could not be inferred by the validator.
|
|
5736
|
-
* See https://developers.google.com/maps/documentation/places/web-service/legacy/supported_types#table2 for a list of possible types.
|
|
5737
|
-
*/
|
|
5738
|
-
missingComponentTypes?: string[];
|
|
5739
|
-
}
|
|
5740
|
-
declare enum AddressValidationJobStatus {
|
|
5741
|
-
Created = "Created",
|
|
5742
|
-
Processing = "Processing",
|
|
5743
|
-
Completed = "Completed",
|
|
5744
|
-
Failed = "Failed",
|
|
5745
|
-
Cancelled = "Cancelled"
|
|
5746
|
-
}
|
|
5747
|
-
interface AddressValidationJob {
|
|
5748
|
-
id: string;
|
|
5749
|
-
/** The current status of this Job. */
|
|
5750
|
-
status: AddressValidationJobStatus;
|
|
5751
|
-
/** The datetime of when this Job was created. */
|
|
5752
|
-
createdAt: string;
|
|
5753
|
-
/** The datetime of when this Job was last updated. */
|
|
5754
|
-
updatedAt: string;
|
|
5755
|
-
/** The validation result. Only present if status is `Confirmed`. */
|
|
5756
|
-
result?: AddressValidationResult;
|
|
5757
|
-
}
|
|
5758
|
-
/**
|
|
5759
|
-
* Fetches Recipients and their associated Address Validation Jobs.
|
|
5760
|
-
* The resulting array will be in the same order as the input `ids`. If a Recipient does not have an associated Job, it will be `undefined`.
|
|
5761
|
-
* @param ids An array of Recipient id strings.
|
|
5762
|
-
* @returns The associated Address Validation Jobs for the requested Recipients.
|
|
5763
|
-
*/
|
|
5764
|
-
declare const getRecipientsAddressValidationJobs: (ids: string[]) => Promise<(AddressValidationJob | undefined)[] | undefined>;
|
|
5765
|
-
/**
|
|
5766
|
-
* Retrieves an up-to-date version of the requested Address Validation Jobs.
|
|
5767
|
-
* If a Job has been completed, the validation result will be present on the object.
|
|
5768
|
-
* @param ids An array of Address Validation Job id strings.
|
|
5769
|
-
* @returns An array of Address Validation Jobs.
|
|
5770
|
-
*/
|
|
5771
|
-
declare const getAddressValidationJobs: (ids: string[]) => Promise<AddressValidationJob[] | undefined>;
|
|
5772
|
-
/**
|
|
5773
|
-
* Validate a single Recipient's address.
|
|
5774
|
-
* @param id The id of the Recipient.
|
|
5775
|
-
* @returns The validation result.
|
|
5776
|
-
*/
|
|
5777
|
-
declare const validateRecipient: (id: string) => Promise<AddressValidationResult | undefined>;
|
|
5778
|
-
/**
|
|
5779
|
-
* Requests to validate many Recipients' addresses asynchronously.
|
|
5780
|
-
* @param ids The ids of the Recipients to validate.
|
|
5781
|
-
* @returns An array of Address Validation Jobs.
|
|
5782
|
-
* These will likely be incomplete; consider polling `getAddressValidationJobs` with the ids of the Jobs you get from this function.
|
|
5783
|
-
*/
|
|
5784
|
-
declare const validateRecipients: (ids: string[]) => Promise<AddressValidationJob[] | undefined>;
|
|
5785
|
-
|
|
5786
|
-
export { AddonHandle, 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, 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, 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, getIntegration, getNEPoint, getNWPoint, getOrderedTransactions, getOverrideThemeConfiguration, getPointOfRotation, getProductCollections, getRecipientsAddressValidationJobs, getSEPoint, getSvgElement, getTemplateBundles, getTemplateTransactions, getTransaction, getTransactionThemeConfiguration, getTransactionsForBundle, getTrueCoordinates, getUnorderedTransactions, 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, validateRecipient, validateRecipients, xmlSerializer };
|
|
5689
|
+
export { AddonHandle, Animatable, AnyStepData, ArrayInput, AspectType, Asset, AssetConfiguration, AssetNotFoundError, AssetObjectVersion, AssetType, BringForwardCommand, BringToBackCommand, BringToFrontCommand, Bundle$1 as Bundle, BundleDesignCreationCartAddMode, BundleDesignCreationMessage, BundleEvent, BundleEventData, BundleEventType, 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, 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, getAttributesFromArrayBuffer, getAxisAlignedBoundingBox, getBoundedOffsets, getBundleThemeConfiguration, getCustomer, getCustomerBundles, getElementVertices, getFrameData, getIntegration, getNEPoint, getNWPoint, getOrderedTransactions, getOverrideThemeConfiguration, getPointOfRotation, getProductCollections, getSEPoint, getSvgElement, getTemplateBundles, getTemplateTransactions, getTransaction, getTransactionThemeConfiguration, getTransactionsForBundle, getTrueCoordinates, getUnorderedTransactions, 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, xmlSerializer };
|