@spiffcommerce/core 16.0.3-0 → 16.2.0

package/dist/index.d.ts

@@ -943,8 +943,16 @@ type ProductCollectionResource = {
     id: string;
     globalPropertyConfiguration?: GlobalPropertyConfiguration;
     name: string;
-    products: Product[];
-    transformCollection?: TransformCollection;
+    productCollectionProducts: ProductCollectionProductResource[];
+    transformCollection?: TransformCollection$1;
+};
+type ProductCollectionProductResource = {
+    id: string;
+    productCollection?: ProductCollectionResource;
+    productCollectionId?: string;
+    product: Product;
+    productId: string;
+    workflowId?: string;
 };
 type GlobalPropertyState = {
     id: string;
@@ -964,7 +972,7 @@ interface Vector3 {
     y: number;
     z: number;
 }
-interface TransformCollection {
+interface TransformCollection$1 {
     id: string;
     name: string;
     transforms: TransformCollectionTransform[];
@@ -1560,6 +1568,7 @@ declare class ProductCollection {
      * A list of products in this collections with useful helpers for interacting with them.
      */
     getProducts(): CollectionProduct[];
+    getTransformCollection(): TransformCollection | undefined;
     /**
      * The raw collection resource. This is generally not needed and should be avoided.
      */
@@ -1570,7 +1579,8 @@ declare class ProductCollection {
  */
 declare class CollectionProduct {
     private readonly product;
-    constructor(product: Product);
+    private readonly productResource;
+    constructor(productCollectionProduct: ProductCollectionProductResource);
     /**
      * The ID of the product in SpiffCommerce.
      * @returns
@@ -1619,6 +1629,44 @@ declare class ProductWorkflow {
      */
     getThumbnail(): string;
 }
+/**
+ * Represents a collection of transforms that can be applied inside a product collection.
+ */
+declare class TransformCollection {
+    private readonly collection;
+    constructor(collection: TransformCollection$1);
+    /**
+     * @returns The ID of the transform collection.
+     */
+    getId(): string;
+    /**
+     * @returns The name of the transform collection.
+     */
+    getName(): string;
+    /**
+     * @returns The transforms in this collection.
+     */
+    getTransforms(): Transform[];
+}
+/**
+ * Represents the translations, rotation & scale of a product in 3D space.
+ */
+declare class Transform {
+    private readonly transform;
+    constructor(position: TransformCollectionTransform);
+    /**
+     * @returns The ID of the transform.
+     */
+    getId(): string;
+    /**
+     * @returns The name of the transform.
+     */
+    getName(): string;
+    /**
+     * @returns The transformation to be used to place the object.
+     */
+    get(): BundleStateTransform;
+}
 
 /**
  * A bundle serves as a container for a set of workflow experience.
@@ -1995,13 +2043,6 @@ 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;
@@ -2797,4 +2838,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, 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 };
+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, Transform, TransformCollection, UnhandledBehaviorError, Variant, VariationRecord, Vector3, 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 };