@spiffcommerce/core 21.0.0 → 21.0.2-0

package/CHANGELOG.md

@@ -0,0 +1,135 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [21.0.1] - 13-03-2024
+
+### Fixed
+
+- Package now supplies this `CHANGELOG.md` in published releases.
+
+## [21.0.0] - 13-03-2024
+
+### Added
+
+- `DesignCreationMessage` now has `quantity: number | undefined`.
+
+### Changed
+
+- `Bundle.finish()` no longer returns an array of `DesignCreationMessage` objects, but instead returns a `BundleDesignCreationMessage` object which wraps the array of `DesignCreationMessage` entries.
+
+## [20.5.1] - 12-03-2024
+
+### Fixed
+
+- `WorkflowExperience.getSelectionPriceSubunits()` (and consequently `getTotalPriceSubunits()`) can no longer return `NaN`.
+
+## [20.5.0] - 12-03-2024
+
+### Added
+
+- `WorkflowManager.injectIntoPreviewService()` now has a second argument `refocusCamera`, a boolean which allows you to disable the automatic refocusing of the camera when the model is loaded. This requires `@spiffcommerce/preview@^5.7.0`.
+
+## [20.4.5] - 08-03-2024
+
+### Added
+
+- `RenderableScene` objects will now contain a `workflowScene: WorkflowScene` field. This is only provided for backwards compatibility and is considered deprecated functionality.
+
+## [20.4.4] - 08-03-2024
+
+### Fixed
+
+- Updating quantity via `WorkflowExperience.setQuantity()` will now correctly update on the server.
+
+## [20.4.3] - 08-03-2024
+
+### Changed
+
+- `WorkflowExperience.setQuantity()` now returns a promise that resolves once the quantity has been updated on the server.
+
+## [20.4.0] - 08-03-2024
+
+### Added
+
+- `Transaction` entities now have `quantity: number | undefined`.
+- New functions on `WorkflowExperience` for managing quantity:
+    - `getQuantity()`: The amount that was, or will be, ordered of the underlying `Transaction`. This will default to `1` if the value is undefined. If you want to read the raw value, use `getWorkflowManager().getTransaction().quantity`.
+    - `setQuantity(<number>)`: Updates the quantity value on the underlying `Transaction` entity. Must be >= 1.
+- New events functionality on `WorkflowExperience`. Currently the only event is `QuantityChanged`.
+    - `addEventListener(<type>, <callback>)`: Registers a callback function to be called when the specified event is raised. The associated `WorkflowExperience` is passed as a parameter to the callback function.
+    - `removeEventListener(<type>, <callback>)`: Removes a previously registered callback.
+
+## [20.3.0] - 07-03-2024
+
+### Added
+
+- `CollectionProduct.getCurrentIntegration()`: returns the `IntegrationProductResource` associated with the product that is linked to the current Integration (resolved via the application key).
+
+## [20.2.2] - 05-03-2024
+
+### Changed
+
+- `WorkflowExperience.getStepById(<string>)` now internally caches the `StepHandle` objects that it creates. This resolves an issue with functional rendering systems that re-render when the object reference changes, where they would re-renderer whenever this function was called even if the object was identical.
+
+## [20.2.1] - 29-02-2024
+
+### Changed
+
+- The union type `GetWorkflowOptions` has some of its entries wrapped in another union. The types that will create a brand new `Transaction` are now nested under `GetNewWorkflowOptions`:
+    ```ts
+    // Before
+    export type GetWorkflowOptions = GetWorkflowFromTransactionOptions | GetWorkflowFromIntegrationProductOptions | GetWorkflowFromExternalProductOptions;
+
+    // After
+    export type GetNewWorkflowOptions = GetWorkflowFromIntegrationProductOptions | GetWorkflowFromExternalProductOptions;
+
+    export type GetWorkflowOptions = GetWorkflowFromTransactionOptions | GetNewWorkflowOptions;
+    ```
+## [20.2.0] - 29-02-2024
+
+### Added
+
+- `SpiffCommerceClient.getIntegrationProduct(<options>)`: Fetches an `IntegrationProduct` object. Essentially a wrapper for the functions `getIntegrationProductById` and `getIntegrationProductFromExternalIds`. The options object type is as follows:
+    ```ts
+    {
+        type: "integration";
+        integrationProductId: string;
+    } | {
+        type: "external";
+        externalIntegrationId: string;
+        externalProductId: string;
+    }
+    ```
+
+## [20.1.0] - 23-02-2024
+
+### Added
+
+- `IntegrationProduct.getAllWorkflows()`: Returns an array of `ProductWorkflow`, ordered by their internal `index` value (matches the order seen on the SpiffCommerce Hub).
+
+## [20.0.1] - 23-02-2024
+
+### Changed
+
+- `StepHandle.executeAnimations()` now logs a warning to the console when the associated `WorkflowManager` is not associated with a `ThreeDPreviewService`.
+
+## [20.0.0] - 15-02-2024
+
+### Added
+
+- Additional configuration options for GraphQL on bundles.
+- A separate fetchProducts function on the ProductCollection interface.
+
+### Changed
+
+- Removed async on getProducts call.
+
+### Removed
+
+- Unused normalize.css file.
+- Identical links assigned in each translation file.
+- Duplicate index file for the english version.

package/README.md

@@ -7,6 +7,6 @@ This is the Spiff Commerce Javascript client API.
 -   The Client API manages the heavy lifting related to setting up, executing & finishing a workflow experience. It is a wrapper around the Workflow Manager,
     which is responsible for executing workflow steps and managing things like state and conditions.
 
--   Whilst the workflow manager is exposed we recommened getting started with a "Workflow Experience" instead.
+-   Whilst the workflow manager is exposed we recommend getting started with a "Workflow Experience" instead.
 
 ## Getting Started

package/dist/index.d.ts

@@ -836,6 +836,28 @@ interface Product {
      * The Spiff SKU code for the product.
      */
     skuCode?: string;
+    /**
+     * Price breaks for this product when dealing with quantity.
+     */
+    priceBreaks?: ProductPriceBreak[];
+}
+/**
+ * A price break represents a minimum quantity of a product and the price that will be charged for that quantity.
+ * This can be seen as an override for the base price of the product.
+ */
+interface ProductPriceBreak {
+    /**
+     * The id of this price breal.
+     */
+    id: string;
+    /**
+     * The minimum quantity of this price break. A positive integer.
+     */
+    minQty: number;
+    /**
+     * A percentage to apply to the overall price. A value between 0-1 where 1 retains 100% of the original price and 0 completely discounts it to free.
+     */
+    percentage: number;
 }
 interface ProductTag {
     id: string;
@@ -1422,6 +1444,14 @@ interface ExperienceOptions {
  * should get an instance of this class from a Client you have constructed previously.
  */
 interface WorkflowExperience {
+    /**
+     * Get the bundle this experience is part of. May be undefined.
+     */
+    getBundle(): Bundle | undefined;
+    /**
+     * Set the bundle this experience is part of. Can be cleared using undefined.
+     */
+    setBundle(bundle: Bundle | undefined): any;
     /**
      * Returns the client that was responsible for spawning this experience.
      */
@@ -1582,10 +1612,16 @@ declare class WorkflowExperienceImpl implements WorkflowExperience {
     readonly workflowManager: WorkflowManager;
     readonly isReadOnly: boolean;
     readonly cachedStepHandles: Map<string, StepHandle<any>>;
+    /**
+     * Bundle this experience has been added to.
+     */
+    private bundle?;
     private renderableScenes;
     private renderableSceneCallbacks;
     private eventCallbacks;
     constructor(client: SpiffCommerceClient, experienceOptions: ExperienceOptions);
+    getBundle(): Bundle | undefined;
+    setBundle(bundle: Bundle): void;
     getClient(): SpiffCommerceClient;
     getIsReadOnly(): boolean;
     getCommandContext(): CommandContext;
@@ -1598,6 +1634,7 @@ declare class WorkflowExperienceImpl implements WorkflowExperience {
     getBasePriceSubunits(includeAdditionalProduct?: boolean): number;
     getAdditionalProductPriceSubunits(): number | undefined;
     getTotalPriceSubunits(): number;
+    private getPriceSubUnitsAfterPriceBreaks;
     copySelectionsViaGlobalConfiguration(bundle: Bundle, experience: WorkflowExperience, filter?: StepHandle<AnyStepData>[]): Promise<void>;
     getStepByName(name: string): TextStepHandle | FrameStepHandle | ShapeStepHandle | InformationStepHandle | IllustrationStepHandle | MaterialStepHandle | ModelStepHandle | PictureStepHandle | QuestionStepHandle | undefined;
     getStepsByType(type: StepType): StepHandle<AnyStepData>[];