@spiffcommerce/core 3.3.1 → 5.0.0

package/dist/types.d.ts

@@ -1308,6 +1308,53 @@ export const AdvancedEditor: FunctionComponent<{
     variationRecord: null | VariationRecord;
     workflow: _Workflow1;
 }>;
+/**
+ * A wrapping component that provides a simple interface for interacting with a variant.
+ */
+declare class Variant {
+    constructor(variant: _VariantResource1);
+    /**
+     * @returns The unique identifier for the variant.
+     */
+    getId(): string;
+    /**
+     * @returns The configured name of the variant. Generally a human readable value.
+     */
+    getName(): string;
+    /**
+     * @returns The price modifier for this variant. This is the amount that will be added to the base price of the product.
+     */
+    getPriceFormatted(locales?: Intl.LocalesArgument, options?: Intl.NumberFormatOptions | undefined): string;
+    /**
+     * @returns The price modifier for this variant. This is the amount that will be added to the base price of the product.
+     *          Presented in subunits of the currency of the option. For example, if the option is configured to use USD, the price modifier will be in cents.
+     */
+    getPrice(): number;
+    /**
+     * @returns The URL for the base asset resource configured on this variant
+     */
+    getAsset(): string | undefined;
+    /**
+     * @returns The URL for a thumbnail resource configured on this variant. When no thumbnail is configured explicitly we fall back to the base asset and see if a thumbnail is genererated for that.
+     */
+    getThumbnail(): string | undefined;
+    /**
+     * @returns The URL for the display image configured on this variant. Can be used for things like size charts.
+     */
+    getDisplayImage(): string | undefined;
+    /**
+     * @returns When this variant is configured to have a color, this will return the hex value for that color.
+     */
+    getColor(): string | undefined;
+    /**
+     * @returns True when the variant is the default for its containing option. False otherwise.
+     */
+    isDefault(): boolean;
+    /**
+     * @returns The underlying variant resource. Generally not needed but made available just incase.
+     */
+    getResource(): _VariantResource1;
+}
 /**
  * A StepHandle allows for managing the state of a specific step in a workflow. This class
  * abstracts away the complexities of dealing with a step directly and allows for using high level
@@ -1336,18 +1383,18 @@ export abstract class StepHandle<T extends _AnyStepData1> {
     /**
      * Gets the currently selected variant, or undefined if no variant is selected.
      */
-    getCurrentVariant(): Promise<_VariantResource1>;
+    getCurrentVariant(): Variant | undefined;
     /**
      * Returns a list of valid variants for this step.
      */
-    getAvailableVariants(): Promise<_VariantResource1[]>;
+    getAvailableVariants(): Variant[];
     /**
      * Most step types have a base option type that variants can be selected for.
      * Selects a specific variant for this step. This will execute all required changes to
      * the design and update the metadata to include the new selection. Any conditions
      * that would be triggered will also be executed.
      */
-    abstract selectVariant(variant: _VariantResource1): Promise<void>;
+    abstract selectVariant(variant: Variant): Promise<void>;
     /**
      * @returns A unique identifier for this step within the workflow.
      */
@@ -1399,7 +1446,7 @@ export class IllustrationStepHandle extends StepHandle<_IllustrationStepData1> {
      * @param variant The new vector variant to use for this step.
      * @returns A promise that can be awaited to know when the new vector asset has been updated on the design.
      */
-    selectVariant(variant: _VariantResource1): Promise<void>;
+    selectVariant(variant: Variant): Promise<void>;
     /**
      * Get colors for the illustration.
      * @returns A list of color definitions that are currently applied to the illustration.
@@ -1415,7 +1462,7 @@ export class IllustrationStepHandle extends StepHandle<_IllustrationStepData1> {
     getAvailableColors(): Promise<{
         fill: string | undefined;
         stroke: string | undefined;
-        variant: _VariantResource1;
+        variant: import("@spiffcommerce/papyrus").VariantResource;
     }[] | undefined>;
     hasVaryingSelection(): boolean | undefined;
     hasVaryingColors(): boolean | undefined;
@@ -1423,11 +1470,11 @@ export class IllustrationStepHandle extends StepHandle<_IllustrationStepData1> {
 }
 export class MaterialStepHandle extends StepHandle<_MaterialStepData1> {
     constructor(manager: WorkflowManager, step: _Step1<_MaterialStepData1>);
-    selectVariant(variant: _VariantResource1): Promise<void>;
+    selectVariant(variant: Variant): Promise<void>;
 }
 export class ModelStepHandle extends StepHandle<_ModelStepData1> {
     constructor(manager: WorkflowManager, step: _Step1<_ModelStepData1>);
-    selectVariant(variant: _VariantResource1): Promise<void>;
+    selectVariant(variant: Variant): Promise<void>;
 }
 export class PictureStepHandle extends StepHandle<_PictureStepData1> {
     constructor(manager: WorkflowManager, step: _Step1<_PictureStepData1>);
@@ -1436,11 +1483,11 @@ export class PictureStepHandle extends StepHandle<_PictureStepData1> {
      * @param variant The new image variant to use.
      * @returns A promise that can be awaited to ensure the new image asset has been updated on the design.
      */
-    selectVariant(variant: _VariantResource1): Promise<void>;
+    selectVariant(variant: Variant): Promise<void>;
 }
 export class QuestionStepHandle extends StepHandle<_QuestionStepData1> {
     constructor(manager: WorkflowManager, step: _Step1<_QuestionStepData1>);
-    selectVariant(variant: _VariantResource1): Promise<void>;
+    selectVariant(variant: Variant): Promise<void>;
     /**
      * The way that this step expects to be rendered.
      */
@@ -1448,7 +1495,7 @@ export class QuestionStepHandle extends StepHandle<_QuestionStepData1> {
 }
 export class ShapeStepHandle extends StepHandle<_ShapeStepData1> {
     constructor(manager: WorkflowManager, step: _Step1<_ShapeStepData1>);
-    selectVariant(_: _VariantResource1): Promise<void>;
+    selectVariant(_: Variant): Promise<void>;
     /**
      * Sets the color of the shape.
      * @param color The color option to use.
@@ -1462,7 +1509,7 @@ export class ShapeStepHandle extends StepHandle<_ShapeStepData1> {
     getColors(): Promise<{
         fill: string | undefined;
         stroke: string | undefined;
-        variant: _VariantResource1;
+        variant: import("@spiffcommerce/papyrus").VariantResource;
     }[]>;
 }
 interface TextChangeResult {
@@ -1476,7 +1523,7 @@ export class TextStepHandle extends StepHandle<_TextStepData1> {
      * Allows for select a font from the available fonts configured on this steps base option.
      * @param variant The font variant to use.
      */
-    selectVariant(variant: _VariantResource1): Promise<void>;
+    selectVariant(variant: Variant): Promise<void>;
     /**
      * @returns A list of colors that can be used to fill the text.
      */
@@ -1720,12 +1767,9 @@ export interface WorkflowExperience {
     createPreviewImage(isThreeD?: boolean, resolution?: number): Promise<string>;
     /**
      * To be called when the workflow experience is considered completed by the user.
-     * @param product
-     * @param onProgressUpdate Progress callback for finalizing the design.
-     * @param selections
-     * @param metadata
+     * @param onProgressUpdate Progress callback for finalizing the design. Optional
      */
-    onDesignFinished(product: Product, onProgressUpdate: DesignCreationProgressUpdate, selections: WorkflowSelections, metadata?: WorkflowMetadata | undefined): Promise<DesignCreationMessage>;
+    onDesignFinished(onProgressUpdate?: DesignCreationProgressUpdate): Promise<DesignCreationMessage>;
     /**
      * Returns the metadata associated with this workflow experience.
      * This is a combination of the metadata from the workflow, and the selections made by the user.
@@ -1880,7 +1924,7 @@ export enum FrameStep {
 }
 export class FrameStepHandle extends StepHandle<_FrameStepData1> {
     constructor(manager: WorkflowManager, step: _Step1<_FrameStepData1>);
-    selectVariant(variant: _VariantResource1): Promise<void>;
+    selectVariant(variant: Variant): Promise<void>;
     onFrameDataChanged(callback: (frameData: _FrameData1) => void): void;
     selectImage(asset: _Asset1): void;
     getImageData(): PatternImageData | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "3.3.1",
+    "version": "5.0.0",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",