@spiffcommerce/core 38.0.0 → 39.0.0

package/dist/index.d.ts

@@ -1173,7 +1173,7 @@ interface WorkflowExperience {
     /**
      * Returns all steps in the workflow that are conditionally active. Ordered by scene and appearance within their respective scenes.
      */
-    getStepsConditionallyActive(): StepHandle<AnyStepData>[];
+    getStepsConditionallyActive(): Promise<StepHandle<AnyStepData>[]>;
     /**
      * Returns a list of scenes that are configured in the workflow. Each scene
      * contains a list of steps. See getStepsByScene to access these.
@@ -1355,7 +1355,7 @@ declare class WorkflowExperienceImpl implements WorkflowExperience {
     createPreviewImage(isThreeD?: boolean, resolution?: number): Promise<string>;
     getStepById(id: string): StepHandle<any> | undefined;
     getSteps(): StepHandle<AnyStepData>[];
-    getStepsConditionallyActive(): StepHandle<AnyStepData>[];
+    getStepsConditionallyActive(): Promise<StepHandle<AnyStepData>[]>;
     getScenes(): Scene[];
     getSelectionPriceSubunits(disablePriceBreaks?: boolean): number;
     getBasePriceSubunits(includeAdditionalProduct?: boolean, disablePriceBreaks?: boolean): number;
@@ -1439,7 +1439,7 @@ declare abstract class GlobalPropertyHandle {
      * Returns all steps that share this property.
      * @param targetExperiences Optionally filter the steps to only those in the given experiences.
      */
-    protected getSharedSteps(targetExperiences?: WorkflowExperience[]): StepHandle<AnyStepData>[];
+    protected getSharedSteps(targetExperiences?: WorkflowExperience[]): Promise<StepHandle<AnyStepData>[]>;
     protected getStateValue(): string | undefined;
 }
 /**
@@ -1580,7 +1580,7 @@ declare class ColorOptionGlobalPropertyHandle extends OptionGlobalPropertyHandle
     /**
      * Sets a custom color on the global state.
      */
-    setCustomColor(color: string): void;
+    setCustomColor(color: string): Promise<void>;
     /**
      * Gets the custom color used by the global state.
      */
@@ -2708,7 +2708,7 @@ interface WorkflowManager {
      * Returns a set of strings representing the identifiers of the minimal set of options
      * required to satisfy the default initial loaded state of the workflow.
      */
-    getInitialOptionIds(existingSelections?: StepSelections): Set<string>;
+    getInitialOptionIds(existingSelections?: StepSelections): Promise<Set<string>>;
     markStepsAsInitialised: (stepNames: string[]) => void;
     getUpdatesPending: () => boolean;
     markUpdateCompleted: (id: string) => void;
@@ -2719,7 +2719,7 @@ interface WorkflowManager {
     setEditedStatus: (stepName: string, status: boolean) => void;
     setInformationResults: (results: InformationResult[]) => void;
     setMandatoryFulfilled: (stepName: string, status: boolean) => void;
-    getMandatoryUnfulfilledSteps: () => string[];
+    getMandatoryUnfulfilledSteps: () => Promise<string[]>;
     setSelectionsAndElements: (stepName: string, variants: VariantResource[], elements: RegionElement[], callback?: () => Promise<void>) => Promise<void>;
     getStateHash(): Promise<string>;
     setStepError: (stepName: string, field: string, error: string | undefined) => void;
@@ -3046,9 +3046,15 @@ interface Region {
         width: number;
     };
 }
+interface RequiredVariantMetafield {
+    variantMetafieldConfigurationId?: string;
+    variantMetafieldValue?: string;
+}
 interface Condition {
+    requiredVariantMetafields?: RequiredVariantMetafield[];
     requiredVariantSelections: string[];
     action: string;
+    type?: string;
     targetStepName: string;
 }
 interface StepAsset {
@@ -5232,7 +5238,7 @@ declare const digitalContentStepService: DigitalContentStepService;
 
 declare class MockWorkflowManager implements WorkflowManager {
     traversableScenes(): Promise<WorkflowScene[]>;
-    getMandatoryUnfulfilledSteps: () => string[];
+    getMandatoryUnfulfilledSteps: () => Promise<string[]>;
     getTemplatingContext: () => Promise<{
         [key: string]: any;
     }>;
@@ -5287,7 +5293,7 @@ declare class MockWorkflowManager implements WorkflowManager {
     getTransactionCustomer(): undefined;
     setTransactionCustomer(): void;
     setTransactionCustomerDetails(): void;
-    getInitialOptionIds(): Set<string>;
+    getInitialOptionIds(): Promise<Set<string>>;
     getWorkflow(): {
         id: string;
         name: string;
@@ -5982,11 +5988,14 @@ declare const getOrderedTransactions: (customerId: string, limit: number, offset
 declare const getTemplateTransactions: (customerId: string, limit: number, offset: number) => Promise<Transaction[]>;
 declare const getTemplateBundles: (customerId: string, limit: number, offset: number) => Promise<Bundle[]>;
 
+interface MetafieldMapValue {
+    key: string;
+    value: string;
+    metafieldConfigurationId: string;
+    metafieldType: string;
+}
 declare class MetafieldManager {
-    readonly internalMap: Map<string, {
-        key: string;
-        value: string;
-    }[]>;
+    readonly internalMap: Map<string, MetafieldMapValue[]>;
     /**
      * Given a specific entity, request the given keys for that entity.
      * This will first check if the keys are already present in the internal map, and if not, it will fetch them from the server.
@@ -6010,6 +6019,7 @@ declare class MetafieldManager {
      * @returns A promise resolving to the field if available or undefined if not.
      */
     requestKeyForEntityIfAvailable(entityId: string, key: string): string | undefined;
+    requestIfAvailable(entityId: string, metafieldConfigurationId: string): MetafieldMapValue | undefined;
 }
 declare const metafieldManager: MetafieldManager;