@spiffcommerce/core 35.0.1 → 36.1.0
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/CHANGELOG.md +26 -0
- package/dist/index.cjs +2667 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.ts +74 -119
- package/dist/index.mjs +3385 -3597
- package/dist/index.mjs.map +1 -1
- package/package.json +8 -7
- package/dist/index.js +0 -2730
- package/dist/index.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -870,11 +870,11 @@ declare abstract class StepHandle<T extends AnyStepData> {
|
|
|
870
870
|
/**
|
|
871
871
|
* @returns A list of valid variants for this step. Does not include disabled variants.
|
|
872
872
|
*/
|
|
873
|
-
getAvailableVariants(): Variant[]
|
|
873
|
+
getAvailableVariants(): Promise<Variant[]>;
|
|
874
874
|
/**
|
|
875
875
|
* @returns A list of all variants for this step, including disabled ones.
|
|
876
876
|
*/
|
|
877
|
-
getAllVariants(): Variant[]
|
|
877
|
+
getAllVariants(): Promise<Variant[]>;
|
|
878
878
|
/**
|
|
879
879
|
* Most step types have a base option type that variants can be selected for.
|
|
880
880
|
* Selects a specific variant for this step. This will execute all required changes to
|
|
@@ -1265,7 +1265,7 @@ interface WorkflowExperience {
|
|
|
1265
1265
|
* This is a combination of the metadata from the workflow, and the selections made by the user.
|
|
1266
1266
|
* @returns An array of ExportedStepData objects, each containing the step ID, title, and properties.
|
|
1267
1267
|
*/
|
|
1268
|
-
getExportedStepData(): ExportedStepData[]
|
|
1268
|
+
getExportedStepData(): Promise<ExportedStepData[]>;
|
|
1269
1269
|
/**
|
|
1270
1270
|
* Get the quantity of this WorkflowExperience's Transaction.
|
|
1271
1271
|
* @returns The amount that was, or will be, ordered.
|
|
@@ -1381,7 +1381,7 @@ declare class WorkflowExperienceImpl implements WorkflowExperience {
|
|
|
1381
1381
|
*/
|
|
1382
1382
|
private stepHasHandle;
|
|
1383
1383
|
private getCanvasObjectURLAsync;
|
|
1384
|
-
getExportedStepData(): ExportedStepData[]
|
|
1384
|
+
getExportedStepData(): Promise<ExportedStepData[]>;
|
|
1385
1385
|
getQuantity(): number;
|
|
1386
1386
|
setQuantity(quantity: number): Promise<void>;
|
|
1387
1387
|
addEventListener(type: WorkflowExperienceEventType, callback: (workflowExperience: WorkflowExperience) => void): void;
|
|
@@ -1522,6 +1522,11 @@ declare class TextGlobalPropertyHandle extends GlobalPropertyHandle {
|
|
|
1522
1522
|
declare class OptionGlobalPropertyHandle extends GlobalPropertyHandle {
|
|
1523
1523
|
protected optionResource?: OptionResource;
|
|
1524
1524
|
constructor(bundle: Bundle$1, property: GlobalPropertyConfigurationAspect, optionResource: OptionResource | undefined);
|
|
1525
|
+
/**
|
|
1526
|
+
* Ensures the option resource has its variants loaded. If the option was loaded
|
|
1527
|
+
* with minimal fields (e.g., lazy loading), this will re-fetch the full option.
|
|
1528
|
+
*/
|
|
1529
|
+
protected ensureOptionLoaded(): Promise<OptionResource | undefined>;
|
|
1525
1530
|
/**
|
|
1526
1531
|
* If the option has a default variant, select it.
|
|
1527
1532
|
*/
|
|
@@ -1533,11 +1538,11 @@ declare class OptionGlobalPropertyHandle extends GlobalPropertyHandle {
|
|
|
1533
1538
|
/**
|
|
1534
1539
|
* @returns A list of valid variants for this step. Does not include disabled variants.
|
|
1535
1540
|
*/
|
|
1536
|
-
getAvailableVariants(): Variant[]
|
|
1541
|
+
getAvailableVariants(): Promise<Variant[]>;
|
|
1537
1542
|
/**
|
|
1538
1543
|
* @returns A list of all variants for this step, including disabled ones.
|
|
1539
1544
|
*/
|
|
1540
|
-
getAllVariants(): Variant[]
|
|
1545
|
+
getAllVariants(): Promise<Variant[]>;
|
|
1541
1546
|
/**
|
|
1542
1547
|
* Select a given variant on the option for all shared steps.
|
|
1543
1548
|
* @param variant The variant to select.
|
|
@@ -1569,6 +1574,13 @@ declare class ColorOptionGlobalPropertyHandle extends OptionGlobalPropertyHandle
|
|
|
1569
1574
|
*/
|
|
1570
1575
|
getCustomColor(): string;
|
|
1571
1576
|
}
|
|
1577
|
+
/**
|
|
1578
|
+
* Get the amount of channels needed to cover illustration steps of the given aspect name.
|
|
1579
|
+
* @param bundle
|
|
1580
|
+
* @param aspectName
|
|
1581
|
+
* @returns
|
|
1582
|
+
*/
|
|
1583
|
+
declare const amtChannelsForAspect: (bundle: Bundle$1, aspectName: string) => number;
|
|
1572
1584
|
|
|
1573
1585
|
interface GlobalPropertyStateManager {
|
|
1574
1586
|
getInitializationPromise(): Promise<void>;
|
|
@@ -1688,7 +1700,6 @@ declare class ProductCollection {
|
|
|
1688
1700
|
items: CollectionProduct[];
|
|
1689
1701
|
total: number;
|
|
1690
1702
|
}>;
|
|
1691
|
-
getTransformCollection(): TransformCollection$1 | undefined;
|
|
1692
1703
|
/**
|
|
1693
1704
|
* The raw collection resource. This is generally not needed and should be avoided.
|
|
1694
1705
|
*/
|
|
@@ -1780,44 +1791,6 @@ declare class ProductWorkflow$1 {
|
|
|
1780
1791
|
*/
|
|
1781
1792
|
getThumbnail(): string;
|
|
1782
1793
|
}
|
|
1783
|
-
/**
|
|
1784
|
-
* Represents a collection of transforms that can be applied inside a product collection.
|
|
1785
|
-
*/
|
|
1786
|
-
declare class TransformCollection$1 {
|
|
1787
|
-
private readonly collection;
|
|
1788
|
-
constructor(collection: TransformCollection);
|
|
1789
|
-
/**
|
|
1790
|
-
* @returns The ID of the transform collection.
|
|
1791
|
-
*/
|
|
1792
|
-
getId(): string;
|
|
1793
|
-
/**
|
|
1794
|
-
* @returns The name of the transform collection.
|
|
1795
|
-
*/
|
|
1796
|
-
getName(): string;
|
|
1797
|
-
/**
|
|
1798
|
-
* @returns The transforms in this collection.
|
|
1799
|
-
*/
|
|
1800
|
-
getTransforms(): Transform[];
|
|
1801
|
-
}
|
|
1802
|
-
/**
|
|
1803
|
-
* Represents the translations, rotation & scale of a product in 3D space.
|
|
1804
|
-
*/
|
|
1805
|
-
declare class Transform {
|
|
1806
|
-
private readonly transform;
|
|
1807
|
-
constructor(position: TransformCollectionTransform);
|
|
1808
|
-
/**
|
|
1809
|
-
* @returns The ID of the transform.
|
|
1810
|
-
*/
|
|
1811
|
-
getId(): string;
|
|
1812
|
-
/**
|
|
1813
|
-
* @returns The name of the transform.
|
|
1814
|
-
*/
|
|
1815
|
-
getName(): string;
|
|
1816
|
-
/**
|
|
1817
|
-
* @returns The transformation to be used to place the object.
|
|
1818
|
-
*/
|
|
1819
|
-
get(): BundleStateTransform;
|
|
1820
|
-
}
|
|
1821
1794
|
declare const getProductCollections: (ids: string[]) => Promise<ProductCollection[] | undefined>;
|
|
1822
1795
|
|
|
1823
1796
|
interface BundleIntegrationProductsAddedEventData {
|
|
@@ -2064,19 +2037,6 @@ interface Bundle$1 {
|
|
|
2064
2037
|
* This will resolve immediately if the bundle has no experiences, or if the bundle has already been initialized.
|
|
2065
2038
|
*/
|
|
2066
2039
|
getInitializationPromise(): Promise<void>;
|
|
2067
|
-
/**
|
|
2068
|
-
* Sets the position, rotation, and scale of a named transform for a workflow experience within this bundle.
|
|
2069
|
-
* @param workflowExperience The workflow experience to update.
|
|
2070
|
-
* @param transformName The name of the transform.
|
|
2071
|
-
* @param transform An object containing `position`, `rotation`, and `scale` properties. Each property is an object with `x`, `y`, and `z` properties.
|
|
2072
|
-
*/
|
|
2073
|
-
updateWorkflowExperienceTransform(workflowExperience: WorkflowExperience, transformName: string, transform: BundleStateTransform): Promise<void>;
|
|
2074
|
-
/**
|
|
2075
|
-
* Sets a transform of a workflow experience within this bundle to be the active one.
|
|
2076
|
-
* @param workflowExperience The workflow experience to update.
|
|
2077
|
-
* @param transform The name of the transform to make the active transform.
|
|
2078
|
-
*/
|
|
2079
|
-
activateWorkflowExperienceTransform(workflowExperience: WorkflowExperience, transformName: string): Promise<void>;
|
|
2080
2040
|
/**
|
|
2081
2041
|
* @returns The raw Global Property Configuration that is in use, otherwise `undefined`.
|
|
2082
2042
|
*/
|
|
@@ -2343,6 +2303,12 @@ interface ClientOptions {
|
|
|
2343
2303
|
* authenticate with the SpiffCommerce API. This key can be generated and replaced in Spiffcommerce Hub.
|
|
2344
2304
|
*/
|
|
2345
2305
|
applicationKey?: string;
|
|
2306
|
+
/**
|
|
2307
|
+
* Force enable beta features, even if the partner does not have the flag turned on.
|
|
2308
|
+
*
|
|
2309
|
+
* This is generally reserved for development and testing.
|
|
2310
|
+
*/
|
|
2311
|
+
enableBetaFeatures?: boolean;
|
|
2346
2312
|
}
|
|
2347
2313
|
interface GetBundleGraphqlAssetsOptions {
|
|
2348
2314
|
metadata?: boolean;
|
|
@@ -2463,36 +2429,14 @@ declare class SpiffCommerceClient {
|
|
|
2463
2429
|
* and the Spiff Commerce platform.
|
|
2464
2430
|
*/
|
|
2465
2431
|
getAssetManager(): AssetManager;
|
|
2432
|
+
/**
|
|
2433
|
+
* @returns A promise that resolves with a boolean indicating whether to use beta features.
|
|
2434
|
+
*/
|
|
2435
|
+
getBetaEnabled(): Promise<boolean>;
|
|
2466
2436
|
getFlowService(): FlowService;
|
|
2467
2437
|
getCurrencyContext(presentmentCurrency: string): Promise<CurrencyContext>;
|
|
2468
2438
|
getIntegration(): Promise<Integration>;
|
|
2469
2439
|
canUseAddon(addonHandle: AddonHandle): Promise<boolean>;
|
|
2470
|
-
/**
|
|
2471
|
-
* Attempts to load persisted authentication information from local storage, and authenticate with the Spiff Commerce API.
|
|
2472
|
-
* @param bundleId The ID of the bundle you intend to load.
|
|
2473
|
-
* @returns An object containing the success status of the authentication attempt, and the type of stakeholder when successful.
|
|
2474
|
-
*/
|
|
2475
|
-
authenticateBundleFromLocalStorage(bundleId: string): Promise<{
|
|
2476
|
-
stakeholderType?: StakeholderType;
|
|
2477
|
-
success: boolean;
|
|
2478
|
-
}>;
|
|
2479
|
-
/**
|
|
2480
|
-
* Attempts to load persisted authentication information from local storage, and authenticate with the Spiff Commerce API.
|
|
2481
|
-
* @param transactionId The ID of the transaction that the user is attempting to load.
|
|
2482
|
-
* @returns An object containing the following:
|
|
2483
|
-
* - `customLogoLink`: A link to a custom logo to display in the header.
|
|
2484
|
-
* - `transactionReadOnly`: Whether or not the transaction is read-only. Shadow will not accept any changes to the transaction if this is set to true.
|
|
2485
|
-
* - `stakeholderType`: The type of stakeholder that the user is authenticated as.
|
|
2486
|
-
* - `success`: Whether or not the authentication was successful.
|
|
2487
|
-
* @throws An error if the transaction is not found.
|
|
2488
|
-
*/
|
|
2489
|
-
authenticateTransactionFromLocalStorage(transactionId: string): Promise<{
|
|
2490
|
-
customLogoLink?: string;
|
|
2491
|
-
transactionReadOnly?: boolean;
|
|
2492
|
-
stakeholderType?: StakeholderType;
|
|
2493
|
-
success: boolean;
|
|
2494
|
-
theme?: Theme;
|
|
2495
|
-
}>;
|
|
2496
2440
|
clearCustomer(): void;
|
|
2497
2441
|
clearCustomerForTransaction(transactionId: string): void;
|
|
2498
2442
|
customerHasBundleTemplates(emailAddress: string): Promise<boolean>;
|
|
@@ -2746,6 +2690,11 @@ interface WorkflowManager {
|
|
|
2746
2690
|
* Returns true when the initial state of the workflow has been loaded and settled.
|
|
2747
2691
|
*/
|
|
2748
2692
|
isInitialized(): boolean;
|
|
2693
|
+
/**
|
|
2694
|
+
* Returns a set of strings representing the identifiers of the minimal set of options
|
|
2695
|
+
* required to satisfy the default initial loaded state of the workflow.
|
|
2696
|
+
*/
|
|
2697
|
+
getInitialOptionIds(existingSelections?: StepSelections): Set<string>;
|
|
2749
2698
|
markStepsAsInitialised: (stepNames: string[]) => void;
|
|
2750
2699
|
getUpdatesPending: () => boolean;
|
|
2751
2700
|
markUpdateCompleted: (id: string) => void;
|
|
@@ -3262,6 +3211,7 @@ interface IllustrationStepData extends Animatable, Placeable, Colorable {
|
|
|
3262
3211
|
hideColorsInCart?: boolean;
|
|
3263
3212
|
displaySelectionOnFinishStep?: boolean;
|
|
3264
3213
|
displayColorsOnFinishStep?: boolean;
|
|
3214
|
+
enableVariantSearch?: boolean;
|
|
3265
3215
|
markSelectionAsCustomField?: boolean;
|
|
3266
3216
|
markColorsAsCustomField?: boolean;
|
|
3267
3217
|
assetKeys?: string[];
|
|
@@ -3297,6 +3247,7 @@ interface ModuleStepData extends Animatable, Placeable {
|
|
|
3297
3247
|
interface PictureStepData extends Animatable, Placeable {
|
|
3298
3248
|
hideSelectionInCart?: boolean;
|
|
3299
3249
|
displaySelectionOnFinishStep?: boolean;
|
|
3250
|
+
enableVariantSearch?: boolean;
|
|
3300
3251
|
markSelectionAsCustomField?: boolean;
|
|
3301
3252
|
varySelection?: boolean;
|
|
3302
3253
|
}
|
|
@@ -4370,7 +4321,6 @@ type ProductCollectionResource = {
|
|
|
4370
4321
|
dispatchStartDate?: string;
|
|
4371
4322
|
dispatchEndDate?: string;
|
|
4372
4323
|
image?: Asset;
|
|
4373
|
-
transformCollection?: TransformCollection;
|
|
4374
4324
|
productCollectionCustomers?: ProductCollectionCustomer[];
|
|
4375
4325
|
};
|
|
4376
4326
|
type ProductCollectionProductResource = {
|
|
@@ -4421,28 +4371,6 @@ type GlobalPropertyStateIllustrationColor = {
|
|
|
4421
4371
|
type GlobalPropertyStateColorOptionStorage = {
|
|
4422
4372
|
customColor?: string;
|
|
4423
4373
|
};
|
|
4424
|
-
interface BundleStateTransform {
|
|
4425
|
-
position: Vector3;
|
|
4426
|
-
rotation: Vector3;
|
|
4427
|
-
scale: Vector3;
|
|
4428
|
-
}
|
|
4429
|
-
interface Vector3 {
|
|
4430
|
-
x: number;
|
|
4431
|
-
y: number;
|
|
4432
|
-
z: number;
|
|
4433
|
-
}
|
|
4434
|
-
interface TransformCollection {
|
|
4435
|
-
id: string;
|
|
4436
|
-
name: string;
|
|
4437
|
-
transforms: TransformCollectionTransform[];
|
|
4438
|
-
}
|
|
4439
|
-
interface TransformCollectionTransform {
|
|
4440
|
-
id: string;
|
|
4441
|
-
name: string;
|
|
4442
|
-
position: Vector3;
|
|
4443
|
-
rotation: Vector3;
|
|
4444
|
-
scale: Vector3;
|
|
4445
|
-
}
|
|
4446
4374
|
type Extendable<T> = T & {
|
|
4447
4375
|
[key: string]: any;
|
|
4448
4376
|
};
|
|
@@ -4953,13 +4881,37 @@ declare class OptionService {
|
|
|
4953
4881
|
* Allows for retrieving an option, returns the option from a cache if possible.
|
|
4954
4882
|
* @param id The option ID to be retrieved.
|
|
4955
4883
|
*/
|
|
4956
|
-
getOption(id: string): Promise<
|
|
4884
|
+
getOption(id: string): Promise<OptionResource | undefined>;
|
|
4885
|
+
getOptions(ids: string[]): Promise<OptionResource[]>;
|
|
4886
|
+
getOptionForStep(stepData: Step<AnyStepData>): Promise<OptionResource | undefined>;
|
|
4887
|
+
/**
|
|
4888
|
+
* Utility function to get the full option from either the network or return the existing option if it can be considered to have the "full" state.
|
|
4889
|
+
*
|
|
4890
|
+
* @returns The full option resource, or `undefined` if invalid.
|
|
4891
|
+
*/
|
|
4892
|
+
ensureFullOption(option: OptionResource | undefined): Promise<OptionResource | undefined>;
|
|
4893
|
+
/**
|
|
4894
|
+
* Returns the URL of the image to be used for a given variant. The priority is:
|
|
4895
|
+
* 1. The variant's thumbnail (if it exists)
|
|
4896
|
+
* 2. The variant's asset (if it exists)
|
|
4897
|
+
* 3. The variant's material ID (if it exists) // TODO: Does this really make sense?
|
|
4898
|
+
* 4. An empty string if none of the above exist
|
|
4899
|
+
* @param variant The variant for which to retrieve the image URL.
|
|
4900
|
+
* @returns A promise that resolves to the URL of the image to be used for the given variant, or an empty string if no image is available.
|
|
4901
|
+
*/
|
|
4957
4902
|
getAssetTileImageForVariant(variant: VariantResource): Promise<string>;
|
|
4958
|
-
getDefaultVariant: (option: OptionResource, overrideDefaultVariantId?: string) => VariantResource | undefined;
|
|
4959
4903
|
/**
|
|
4960
|
-
* Returns the
|
|
4904
|
+
* Returns the default variant for a given option. If there is only one variant, that variant is returned. If there are multiple variants, the variant with the ID matching overrideDefaultVariantId is returned (if provided). If overrideDefaultVariantId is not provided or does not match any variant, the variant marked as defaultVariant on the option is returned.
|
|
4905
|
+
* @param option The option for which to retrieve the default variant.
|
|
4906
|
+
* @param overrideDefaultVariantId An optional variant ID to override the default variant selection. This is used in certain cases where we want to specify a default variant that is different from the one marked as defaultVariant on the option.
|
|
4907
|
+
* @returns The default variant for the given option, or undefined if no default variant can be determined.
|
|
4961
4908
|
*/
|
|
4962
|
-
|
|
4909
|
+
getDefaultVariant: (option: OptionResource, overrideDefaultVariantId?: string) => Promise<VariantResource | undefined>;
|
|
4910
|
+
getTagsForAssets: (variants: VariantResource[]) => Promise<{
|
|
4911
|
+
id: string;
|
|
4912
|
+
entityId: string;
|
|
4913
|
+
name: string;
|
|
4914
|
+
}[][]>;
|
|
4963
4915
|
}
|
|
4964
4916
|
declare const optionService: OptionService;
|
|
4965
4917
|
|
|
@@ -5056,7 +5008,7 @@ declare class FrameStepService implements StepService<FrameStepData> {
|
|
|
5056
5008
|
loadPatternFromString(src: string, frameService: FrameService, recalculateOffsets?: boolean, colors?: {
|
|
5057
5009
|
[key: string]: ColorDefinition;
|
|
5058
5010
|
} | undefined, colorSafeSvg?: boolean): Promise<void>;
|
|
5059
|
-
changeColors(stepData: Step<FrameStepData>, workflowManager: WorkflowManager, newFills: Map<string, ColorDefinition>): void
|
|
5011
|
+
changeColors(stepData: Step<FrameStepData>, workflowManager: WorkflowManager, newFills: Map<string, ColorDefinition>): Promise<void>;
|
|
5060
5012
|
getUniqueColorCount(stepData: Step<FrameStepData>, workflowManager: WorkflowManager): number;
|
|
5061
5013
|
private calculateColorMetadata;
|
|
5062
5014
|
private validateColorCount;
|
|
@@ -5096,7 +5048,7 @@ declare class IllustrationStepService implements StepService<IllustrationStepDat
|
|
|
5096
5048
|
pmsValue: string;
|
|
5097
5049
|
}[] | undefined>;
|
|
5098
5050
|
changeColorsCommand(svg: string, illustrationWidth: number, illustrationHeight: number, elements: string[], newFills: Map<string, string | ColorDefinition>): Promise<CanvasCommand>;
|
|
5099
|
-
changeColors(stepData: Step<IllustrationStepData>, elements: RegionElement[], workflowManager: WorkflowManager,
|
|
5051
|
+
changeColors(stepData: Step<IllustrationStepData>, elements: RegionElement[], workflowManager: WorkflowManager, newFills: Map<string, string | ColorDefinition>): Promise<void>;
|
|
5100
5052
|
selectVariant(stepData: Step<IllustrationStepData>, variant: VariantResource, elements: RegionElement[], setIsUpdating: (isUpdating: boolean) => void, workflowManager: WorkflowManager): Promise<void>;
|
|
5101
5053
|
private selectVariantCommand;
|
|
5102
5054
|
}
|
|
@@ -5146,7 +5098,7 @@ declare class TextStepService implements StepService<TextStepData> {
|
|
|
5146
5098
|
* @param stepData The text step to get colors for.
|
|
5147
5099
|
* @returns A list of color objects containing fill, stroke and variant if available.
|
|
5148
5100
|
*/
|
|
5149
|
-
availableFillColors(stepData: Step<TextStepData>): ColorOption[]
|
|
5101
|
+
availableFillColors(stepData: Step<TextStepData>): Promise<ColorOption[]>;
|
|
5150
5102
|
changeAlignment(stepData: Step<TextStepData>, alignment: "left" | "center" | "right", elements: RegionElement[], workflowManager: WorkflowManager): void;
|
|
5151
5103
|
changeFillColor(stepData: Step<TextStepData>, newColor: ColorOption, elements: RegionElement[], workflowManager: WorkflowManager): Promise<void>;
|
|
5152
5104
|
availableFillImages(stepData: Step<TextStepData>): Promise<TextFillImage[]>;
|
|
@@ -5156,7 +5108,7 @@ declare class TextStepService implements StepService<TextStepData> {
|
|
|
5156
5108
|
* @param stepData The text step to get colors for.
|
|
5157
5109
|
* @returns A list of color objects containing fill, stroke and variant if available.
|
|
5158
5110
|
*/
|
|
5159
|
-
availableStrokeColors(stepData: Step<TextStepData>): ColorOption[]
|
|
5111
|
+
availableStrokeColors(stepData: Step<TextStepData>): Promise<ColorOption[]>;
|
|
5160
5112
|
changeStrokeColor(stepData: Step<TextStepData>, newColor: ColorOption | undefined, elements: RegionElement[], workflowManager: WorkflowManager): Promise<void>;
|
|
5161
5113
|
/**
|
|
5162
5114
|
* Given an element and a string, filters any characters from the string that are
|
|
@@ -5308,6 +5260,7 @@ declare class MockWorkflowManager implements WorkflowManager {
|
|
|
5308
5260
|
getTransactionCustomer(): undefined;
|
|
5309
5261
|
setTransactionCustomer(): void;
|
|
5310
5262
|
setTransactionCustomerDetails(): void;
|
|
5263
|
+
getInitialOptionIds(): Set<string>;
|
|
5311
5264
|
getWorkflow(): {
|
|
5312
5265
|
id: string;
|
|
5313
5266
|
name: string;
|
|
@@ -5376,6 +5329,7 @@ declare class IllustrationStepHandle extends StepHandle<IllustrationStepData> {
|
|
|
5376
5329
|
}[] | undefined>;
|
|
5377
5330
|
isColorPickerEnabled(): boolean;
|
|
5378
5331
|
isPMSPickerEnabled(): boolean;
|
|
5332
|
+
isVariantSearchEnabled(): boolean;
|
|
5379
5333
|
}
|
|
5380
5334
|
|
|
5381
5335
|
interface TextChangeResult {
|
|
@@ -5404,7 +5358,7 @@ declare class TextStepHandle extends StepHandle<TextStepData> implements CustomC
|
|
|
5404
5358
|
/**
|
|
5405
5359
|
* @returns A list of colors that can be used to fill the text.
|
|
5406
5360
|
*/
|
|
5407
|
-
getAvailableFillColors(): ColorOption[]
|
|
5361
|
+
getAvailableFillColors(): Promise<ColorOption[]>;
|
|
5408
5362
|
/**
|
|
5409
5363
|
* Changes the fill of text related to this step to the new fill value.
|
|
5410
5364
|
* @param fill A new fill value to use.
|
|
@@ -5462,7 +5416,7 @@ declare class TextStepHandle extends StepHandle<TextStepData> implements CustomC
|
|
|
5462
5416
|
/**
|
|
5463
5417
|
* @returns A list of colors that can be used for the text's outline.
|
|
5464
5418
|
*/
|
|
5465
|
-
getAvailableStrokeColors(): ColorOption[]
|
|
5419
|
+
getAvailableStrokeColors(): Promise<ColorOption[]>;
|
|
5466
5420
|
getStrokeColor(): string;
|
|
5467
5421
|
/**
|
|
5468
5422
|
* Changes the stroke of text related to this step to the new stroke value.
|
|
@@ -5479,6 +5433,7 @@ declare class PictureStepHandle extends StepHandle<PictureStepData> {
|
|
|
5479
5433
|
* @returns A promise that can be awaited to ensure the new image asset has been updated on the design.
|
|
5480
5434
|
*/
|
|
5481
5435
|
selectVariant(variant: Variant): Promise<void>;
|
|
5436
|
+
isVariantSearchEnabled(): boolean;
|
|
5482
5437
|
}
|
|
5483
5438
|
|
|
5484
5439
|
/**
|
|
@@ -5591,7 +5546,7 @@ declare class FrameStepHandle extends StepHandle<FrameStepData> {
|
|
|
5591
5546
|
* @returns A promise that resolves with the newly generated Asset.
|
|
5592
5547
|
*/
|
|
5593
5548
|
removeBackgroundFromImageSelection(applyNewAsset?: boolean): Promise<Asset>;
|
|
5594
|
-
changeColors(newFills: Map<string, ColorDefinition>): void
|
|
5549
|
+
changeColors(newFills: Map<string, ColorDefinition>): Promise<void>;
|
|
5595
5550
|
getImageData(): PatternImageData | undefined;
|
|
5596
5551
|
getColorOption(): Promise<OptionResource | undefined>;
|
|
5597
5552
|
getAvailableColors(): Promise<ColorOption[]>;
|
|
@@ -6132,4 +6087,4 @@ declare const getGlobalPropertyStateForBundle: (bundleId: string) => Promise<Glo
|
|
|
6132
6087
|
|
|
6133
6088
|
declare const getIntegrationProducts: (ids: string[]) => Promise<IntegrationProductResource[]>;
|
|
6134
6089
|
|
|
6135
|
-
export { AddonHandle, type AddressComponent, type AddressValidationJob, AddressValidationJobStatus, type AddressValidationResult, AddressValidationResultConfirmationLevel, AddressValidationStatus, type Animatable, type AnyStepData, ArrayInput, AspectType, type Asset, type AssetConfiguration, AssetNotFoundError, type AssetObjectVersion, AssetType, BringForwardCommand, BringToBackCommand, BringToFrontCommand, type Bundle$1 as Bundle, BundleDesignCreationCartAddMode, type BundleDesignCreationMessage, type BundleEvent, type BundleEventData, type BundleEventType, type Bundle as BundleRaw, type BundleStakeholder, CanvasCommand, CollectionProduct, type ColorDefinition, type ColorOption, ColorOptionGlobalPropertyHandle, type ColorProfileProps, CommandContext, type CommandState, type Condition, type ConditionalGlobalPropertiesChangedEventData, CreateElementCommand, CreateLayoutCommand, CurrencyContext, CurrencyService, type Customer, type CustomerDetailsInput, DeleteElementCommand, type DesignCreationMessage, type DesignCreationProgressUpdate, type DesignInputStep, type DigitalContentStepData, DigitalContentStepHandle, type EditedSteps, type ExportedStepData, type ExportedStepDataProperty, type ExportedStepDataPropertyType, FileUploadGlobalPropertyHandle, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, type FrameElement, FrameService, FrameStep, type FrameStepData, FrameStepHandle, type FrameThresholdSettings, type GetNewWorkflowExperienceOptions as GetNewWorkflowOptions, type GetWorkflowOptions, type GlobalPropertiesMandatoryChangedEventData, type GlobalPropertyConfiguration, GlobalPropertyHandle, GroupCommand, type ILayout, type IllustrationElement, type IllustrationStepData, IllustrationStepHandle, type ImageElement, InformationMessageType, type InformationResult, type InformationStepData, InformationStepHandle, type Integration, type IntegrationOptionResource, IntegrationProduct, IntegrationType, type LayoutComponentConfiguration, type LayoutData, type LayoutElement, LayoutElementFactory, LayoutElementType, LayoutNotFoundError, LayoutRenderingPurpose, type LayoutState, type LayoutsState, type MandatorySteps, MaterialEffectMode, type MaterialStepData, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, type ModelStepData, ModelStepHandle, type ModuleStepData, ModuleStepHandle, MoveCommand, NodeType, ObjectInput, ObjectInputType, OptionGlobalPropertyHandle, OptionNotFoundError, type OptionResource, type Order, type OrderItem, type PapyrusComponent, ParseError, type PictureStepData, PictureStepHandle, type Placeable, type PmsSearchResult, type Point, type Product, ProductCameraRig, ProductCollection, ProductCollectionProductSortKey, ProductWorkflow$1 as ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, type QuestionStepData, QuestionStepHandle, QueueablePromise, type Recipient, type Region, type RegionElement, type RenderableScene, ResizeCommand, ResourceNotFoundError, RotateCommand, type SavedDesign, ScaleAxis, type SelectionStorage, SendBackwardsCommand, type ShapeStepData, ShapeStepHandle, type ShareAction, ShareActionType, type SilentIllustrationStepData, SpiffCommerceClient, type Stakeholder, StakeholderType, type StateMutationFunc, type Step, type StepAspect, StepAspectType, type StepElements, type StepGroup, StepHandle, type StepStorage, StepType, TextAlgorithm, TextChangeCommand, type TextChangeResult, TextGlobalPropertyHandle, TextInput, type TextStepData, TextStepHandle, type TextStepStorage, type TextboxElement, type Theme, type ToastCallback, type Transaction,
|
|
6090
|
+
export { AddonHandle, type AddressComponent, type AddressValidationJob, AddressValidationJobStatus, type AddressValidationResult, AddressValidationResultConfirmationLevel, AddressValidationStatus, type Animatable, type AnyStepData, ArrayInput, AspectType, type Asset, type AssetConfiguration, AssetNotFoundError, type AssetObjectVersion, AssetType, BringForwardCommand, BringToBackCommand, BringToFrontCommand, type Bundle$1 as Bundle, BundleDesignCreationCartAddMode, type BundleDesignCreationMessage, type BundleEvent, type BundleEventData, type BundleEventType, type Bundle as BundleRaw, type BundleStakeholder, CanvasCommand, CollectionProduct, type ColorDefinition, type ColorOption, ColorOptionGlobalPropertyHandle, type ColorProfileProps, CommandContext, type CommandState, type Condition, type ConditionalGlobalPropertiesChangedEventData, CreateElementCommand, CreateLayoutCommand, CurrencyContext, CurrencyService, type Customer, type CustomerDetailsInput, DeleteElementCommand, type DesignCreationMessage, type DesignCreationProgressUpdate, type DesignInputStep, type DigitalContentStepData, DigitalContentStepHandle, type EditedSteps, type ExportedStepData, type ExportedStepDataProperty, type ExportedStepDataPropertyType, FileUploadGlobalPropertyHandle, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, type FrameElement, FrameService, FrameStep, type FrameStepData, FrameStepHandle, type FrameThresholdSettings, type GetNewWorkflowExperienceOptions as GetNewWorkflowOptions, type GetWorkflowOptions, type GlobalPropertiesMandatoryChangedEventData, type GlobalPropertyConfiguration, GlobalPropertyHandle, GroupCommand, type ILayout, type IllustrationElement, type IllustrationStepData, IllustrationStepHandle, type ImageElement, InformationMessageType, type InformationResult, type InformationStepData, InformationStepHandle, type Integration, type IntegrationOptionResource, IntegrationProduct, IntegrationType, type LayoutComponentConfiguration, type LayoutData, type LayoutElement, LayoutElementFactory, LayoutElementType, LayoutNotFoundError, LayoutRenderingPurpose, type LayoutState, type LayoutsState, type MandatorySteps, MaterialEffectMode, type MaterialStepData, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, type ModelStepData, ModelStepHandle, type ModuleStepData, ModuleStepHandle, MoveCommand, NodeType, ObjectInput, ObjectInputType, OptionGlobalPropertyHandle, OptionNotFoundError, type OptionResource, type Order, type OrderItem, type PapyrusComponent, ParseError, type PictureStepData, PictureStepHandle, type Placeable, type PmsSearchResult, type Point, type Product, ProductCameraRig, ProductCollection, ProductCollectionProductSortKey, ProductWorkflow$1 as ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, type QuestionStepData, QuestionStepHandle, QueueablePromise, type Recipient, type Region, type RegionElement, type RenderableScene, ResizeCommand, ResourceNotFoundError, RotateCommand, type SavedDesign, ScaleAxis, type SelectionStorage, SendBackwardsCommand, type ShapeStepData, ShapeStepHandle, type ShareAction, ShareActionType, type SilentIllustrationStepData, SpiffCommerceClient, type Stakeholder, StakeholderType, type StateMutationFunc, type Step, type StepAspect, StepAspectType, type StepElements, type StepGroup, StepHandle, type StepStorage, StepType, TextAlgorithm, TextChangeCommand, type TextChangeResult, TextGlobalPropertyHandle, TextInput, type TextStepData, TextStepHandle, type TextStepStorage, type TextboxElement, type Theme, type ToastCallback, type Transaction, UnhandledBehaviorError, UnitOfMeasurement, UpdateImageSourceCommand, Variant, type VariantResource, type Workflow, type WorkflowExperience, WorkflowExperienceEventType, type WorkflowExperienceHoverEventData, WorkflowExperienceImpl, type WorkflowManager, type WorkflowMetadata, type WorkflowPanel, type WorkflowScene, type WorkflowSelections, type WorkflowStorage, amtChannelsForAspect, assetService, browserColorToHex, cmPerPixel, currentDirection, dataUrlFromExternalUrl, deleteBundle, designService, determineCorrectFontSizeAndLines, digitalContentStepService, domParser, duplicateBundle, duplicateTransaction, fetchAsString, findAngle, findElement, findPmsColors, frameDataCache, frameStepService, generate, generateCommands, generateSVGWithUnknownColors, generateStateFromDesignInputSteps, getAddressValidationJobs, getAttributesFromArrayBuffer, getAxisAlignedBoundingBox, getBoundedOffsets, getBundleIdForTransaction, getBundleThemeConfiguration, getCustomer, getCustomerBundles, getElementVertices, getFrameData, getGlobalPropertyStateForBundle, getIntegration, getIntegrationProducts, 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, overrideWorkflowExperienceRecipientAddress, 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 };
|