@spiffcommerce/core 14.9.0 → 14.11.0

package/dist/types.d.ts

@@ -340,11 +340,13 @@ declare class QuestionStepService implements StepService<_QuestionStepData1> {
 }
 export const questionStepService: QuestionStepService;
 declare class ShapeStepService implements StepService<_ShapeStepData1> {
+    readonly shapeFillId = "spiff-fill-shape";
     availableColours(stepData: _Step1<_ShapeStepData1>): Promise<{
         fill: string | undefined;
         stroke: string | undefined;
         variant: _VariantResource1;
     }[]>;
+    setCustomColor(color: string, stepData: _Step1<_ShapeStepData1>, manager: WorkflowManager): void;
     init(stepData: _Step1<_ShapeStepData1>, workflowManager: WorkflowManager, reducerState?: _LayoutsState1): Promise<CommandWithFollowup | null>;
     selectVariant(stepData: _Step1<_ShapeStepData1>, colourOption: ColorOption, elements: RegionElement[], workflowManager: WorkflowManager): Promise<void>;
 }
@@ -550,7 +552,7 @@ export interface WorkflowManager {
      * @deprecated State updates are being pulled internally. This function will be removed in the future.
      */
     updateStateWithServerImmediate: (getReducerState: () => _CommandState1) => Promise<void>;
-    updateStorage: (stepName: string, update: _StepStorage1) => Promise<void>;
+    updateStorage: (stepName: string, update: _StepStorage1) => void;
     getModelContainer: () => any | undefined;
     setModelContainer: (container: any) => void;
     /**
@@ -1156,6 +1158,14 @@ declare class AssetService implements AssetManager {
      * Allows for retrieving an asset, returns the option from a cache if possible.
      */
     getLocalOrFromServer(assetKey: string): Promise<_Asset1>;
+    /**
+     * Caches an asset if it doesn't already exist.
+     */
+    cacheAsset(asset: _Asset1): void;
+    /**
+     * Caches a material if it doesn't already exist.
+     */
+    cacheMaterial(material: MaterialResource): void;
     /**
      * Allows for retrieving amaterial, returns the option from a cache if possible.
      * @param id The option ID to be retrieved.
@@ -1644,6 +1654,12 @@ export class ShapeStepHandle extends StepHandle<_ShapeStepData1> {
         stroke: string | undefined;
         variant: import("@spiffcommerce/papyrus").VariantResource;
     }[]>;
+    /**
+     * Allows for setting a custom color when the custom variant is selected. Will
+     * throw when a non-custom variant is selected.
+     */
+    setCustomColor(color: string): void;
+    getCustomColor(): string;
 }
 interface TextChangeResult {
     input: string;
@@ -2123,16 +2139,38 @@ export interface Bundle {
      * @param experience The workflow experience to add to this bundle.
      */
     addWorkflowExperience(experience: WorkflowExperience): Promise<void>;
+    /**
+     * Adds multiple workflow experiences to this bundle.
+     * @param experiences The workflow experiences to add to this bundle.
+     */
+    addWorkflowExperiences(experiences: WorkflowExperience[]): Promise<void>;
     /**
      * Remove a workflow experience from this bundle.
      * @param experience The workflow experience to remove from this bundle.
      */
     removeWorkflowExperience(experience: WorkflowExperience): Promise<void>;
+    /**
+     * Removes multiple workflow experiences from this bundle.
+     * @param experiences The workflow experiences to remove from this bundle.
+     */
+    removeWorkflowExperiences(experiences: WorkflowExperience[]): Promise<void>;
     /**
      * Remove a workflow experience from this bundle by transaction.
      * @param transaction The transaction to remove from this bundle.
      */
     removeWorkflowExperienceByTransaction(transaction: Transaction): Promise<void>;
+    /**
+     * Removes multiple workflow experiences from this bundle by their transactions.
+     * @param transactions The transactions to remove from this bundle.
+     */
+    removeWorkflowExperiencesByTransactions(transactions: Transaction[]): Promise<void>;
+    /**
+     * Inserts the given workflow experience into the bundle at the given index.
+     * NOTE: If you intend to insert a workflow experience at the end of the bundle, use `addWorkflowExperience` instead as it is more efficient.
+     * @param experience The workflow experience to insert.
+     * @param index The index to insert the workflow experience at.
+     */
+    insertWorkflowExperience(experience: WorkflowExperience, index: number): Promise<void>;
     /**
      * Returns all workflow experiences currently added to this bundle.
      */

package/package.json

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