@mxenabled/connect-widget 0.15.5 → 0.17.1

package/README.md

@@ -52,18 +52,33 @@ const App = () => {
 
 You need to pass an object containing API endpoint callbacks as the `apiValue` prop of the ApiProvider as described in the [usage](#usage) section for the widget to work. [Here](./docs/APIDOCUMENTATION.md) is a more detailed list of the API endpoint callbacks.
 
-## Developing
+## Development Set Up
 
 1. Clone project
 2. Install `Node(with npm)`. See [package.json](/package.json) for current required versions
 3. Run `npm i`
-4. Make your code changes
+4. Make your code changes - [Follow Conventional Commits](#commit-message-requirements)
 5. Run `npm run build` to build the project
 6. [Link Project](#linking-for-development)
 7. Test your changes
-8. Update change log, translations, and documentation as needed
+8. Update translations and documentation as needed
 9. Open Pull Request
 
+## Commit Message Requirements
+
+_To make commits that trigger a package release, use `npx cz`, it will launch easy to follow commitizen prompts._
+
+A new _MAJOR.MINOR.PATCH_ release will be generated if at least one of the following types are used, see [Conventional Commits Documentation](https://www.conventionalcommits.org/) for more specifics.
+* `fix:` -> PATCH bump
+* `feat:` -> MINOR bump
+
+Major bump (any type with a footer of `BREAKING CHANGE:`)
+```
+<any_type>: <message>
+
+BREAKING CHANGE: <description>
+```
+
 ## Linking for Development
 
 For developing this package locally, we suggest you use npm link to connect your local version of the package to your client app using the package.

package/dist/index.es.js

@@ -9516,6 +9516,7 @@ const COMBO_JOB_DATA_TYPES = {
 };
 
 const initialState$5 = {
+  _initialValues: "",
   is_mobile_webview: false,
   target_origin_referrer: null,
   ui_message_protocol: "post_message",
@@ -9549,12 +9550,23 @@ const configSlice = createSlice({
       (state, action) => {
         const productDetermineMode = getProductDeterminedMode(action.payload);
         const ui_message_version = typeof action.payload.ui_message_version === "string" ? parseInt(action.payload.ui_message_version, 10) : action.payload.ui_message_version || state.ui_message_version;
-        return {
+        const loadedState = {
           ...state,
           ...action.payload,
           ui_message_version,
           mode: productDetermineMode !== null ? productDetermineMode : action.payload.mode || state.mode
         };
+        const { _initialValues, ...stateWithoutInitialValues } = loadedState;
+        return {
+          ...stateWithoutInitialValues,
+          // _initialValues is a reference to the values that were used to load the widget initially.
+          // It is meant to be set, and then READ ONLY after that.
+          // Example:
+          // When a user dynamically changes the mode, use_cases, or data for a connection we need to
+          // reset the mode, use_cases, and data to the initial state for the next connection attempt.
+          // JSON is used here to deeply copy the object, use a selector to get the values.
+          _initialValues: JSON.stringify(stateWithoutInitialValues)
+        };
       }
     );
   }