@spiffcommerce/core 16.0.2-alpha.0 → 16.0.3-0

package/dist/index.d.ts

@@ -634,7 +634,7 @@ interface LineItemMetadata {
     stepName: string;
     metadata: string;
 }
-interface ProductWorkflow {
+interface ProductWorkflow$1 {
     friendlyName: string;
     id: string;
     present?: boolean;
@@ -708,7 +708,7 @@ interface Product {
     /**
      * Workflows which have been assigned to this product.
      */
-    workflows?: ProductWorkflow[];
+    workflows?: ProductWorkflow$1[];
     /**
      * The base price of this product in sub units. Essentially the cost of the
      * product without any customisations applied.
@@ -1586,6 +1586,10 @@ declare class CollectionProduct {
      * @returns The integration if found. Throws an error if not found as this data is typically a neccesity.
      */
     getIntegrationByType(type: IntegrationType): IntegrationProduct;
+    /**
+     * A helper function for pulling the default workflow.
+     */
+    getDefaultWorkflow(): ProductWorkflow;
     /**
      * A list of all integrations this product is connected to.
      */
@@ -1595,6 +1599,26 @@ declare class CollectionProduct {
      */
     getResource(): Product;
 }
+/**
+ * Represents a the relationship between a workflow and a product.
+ */
+declare class ProductWorkflow {
+    private readonly workflow;
+    constructor(workflow: ProductWorkflow$1);
+    /**
+     * @returns The ID of this workflow, to be used when starting an experience.
+     */
+    getId(): string;
+    /**
+     * @returns The name of the workflow.
+     */
+    getName(): string;
+    /**
+     * An image to be used to display this workflow in a UI to the customer.
+     * @returns A resource URL.
+     */
+    getThumbnail(): string;
+}
 
 /**
  * A bundle serves as a container for a set of workflow experience.
@@ -1971,6 +1995,13 @@ interface ClientOptions {
      * authenticate with the SpiffCommerce API.
      */
     applicationKey?: string;
+    /**
+     * When set to true, the client will instantiate a service for tracking internal errors. This allows
+     * us to track errors that occur within the client, and improve the experience for our users.
+     *
+     * NOTE: True by default, you may disable if you have privacy requirements.
+     */
+    internalAnalytics?: boolean;
 }
 interface GetWorkflowGraphqlAssetsOptions {
     metadata?: boolean;
@@ -2766,4 +2797,4 @@ interface StepAspectValue {
 declare const stepAspectValuesToDesignInputSteps: (stepAspectValues: StepAspectValue[], workflow: Workflow) => DesignInputStep[];
 declare const generateStateFromDesignInputSteps: (designInputSteps: DesignInputStep[], workflow: Workflow, layouts: ILayout[], productOverlayImageUrl?: string) => Promise<LayoutsState>;
 
-export { AssetNotFoundError, BulkPriceCalculationStrategy, BulkStepHandle, Bundle, CollectionProduct, ColorOption, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FrameService, FrameStep, FrameStepHandle, GetWorkflowOptions, GlobalPropertyHandle, IllustrationStepHandle, InformationMessageType, InformationResult, InformationStepHandle, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, NodeType, ObjectInput, ObjectInputType, OptionNotFoundError, ParseError, PictureStepHandle, Product, ProductCameraRig, ProductCollection, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, StepElements, StepHandle, TextStepHandle, TextStepStorage, Transaction, UnhandledBehaviorError, Variant, VariationRecord, WorkflowExperience, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, createDesign, designService, digitalContentStepService, frameStepService, gatherVaryingStepAspects, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, questionStepService, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };
+export { AssetNotFoundError, BulkPriceCalculationStrategy, BulkStepHandle, Bundle, CollectionProduct, ColorOption, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FrameService, FrameStep, FrameStepHandle, GetWorkflowOptions, GlobalPropertyHandle, IllustrationStepHandle, InformationMessageType, InformationResult, InformationStepHandle, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, NodeType, ObjectInput, ObjectInputType, OptionNotFoundError, ParseError, PictureStepHandle, Product, ProductCameraRig, ProductCollection, ProductWorkflow, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, StepElements, StepHandle, TextStepHandle, TextStepStorage, Transaction, UnhandledBehaviorError, Variant, VariationRecord, WorkflowExperience, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, createDesign, designService, digitalContentStepService, frameStepService, gatherVaryingStepAspects, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, questionStepService, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };