@aehrc/smart-forms-renderer 1.0.0-alpha.99 → 1.1.0

package/src/stores/index.ts

@@ -2,7 +2,7 @@ export * from './questionnaireStore';
 export * from './questionnaireResponseStore';
 export * from './smartConfigStore';
 export * from './terminologyServerStore';
-export * from './rendererStylingStore';
+export * from './rendererConfigStore';
 
 export type { QuestionnaireStoreType } from './questionnaireStore';
 
@@ -12,8 +12,8 @@ export type { SmartConfigStoreType } from './smartConfigStore';
 
 export type { TerminologyServerStoreType } from './terminologyServerStore';
 
-export type { RendererStyling, RendererStylingStoreType } from './rendererStylingStore';
+export type { RendererConfig, RendererConfigStoreType } from './rendererConfigStore';
 
 export { smartConfigStore, useSmartConfigStore } from './smartConfigStore';
 export { terminologyServerStore, useTerminologyServerStore } from './terminologyServerStore';
-export { rendererStylingStore, useRendererStylingStore } from './rendererStylingStore';
+export { rendererConfigStore, useRendererConfigStore } from './rendererConfigStore';

package/src/stores/questionnaireResponseStore.ts

@@ -46,8 +46,7 @@ import { generateUniqueId } from '../utils/extractObservation';
  * @property responseIsValid - Whether there are any invalid items in the response
  * @property validateQuestionnaireResponse - Used to validate the questionnaire response based on the questionnaire
  * @property buildSourceResponse - Used to build the source response when the form is first initialised
- * @property setUpdatableResponseAsPopulated - Used to set a pre-populated response as the current response
- * @property updateResponse - Used to update the current response
+ * @property updateResponse - Used to update the current response, initialUpdate flag is to ensure formChangesHistory is not updated during the first update after form build
  * @property setUpdatableResponseAsSaved - Used to set a saved response as the current response
  * @property setUpdatableResponseAsEmpty - Used to set an empty response as the current response
  * @property destroySourceResponse - Used to destroy the source response  and reset all properties
@@ -66,8 +65,7 @@ export interface QuestionnaireResponseStoreType {
   responseIsValid: boolean;
   validateResponse: (questionnaire: Questionnaire, updatedResponse: QuestionnaireResponse) => void;
   buildSourceResponse: (response: QuestionnaireResponse) => void;
-  setUpdatableResponseAsPopulated: (populatedResponse: QuestionnaireResponse) => void;
-  updateResponse: (updatedResponse: QuestionnaireResponse, debugType: 'initial' | 'async') => void;
+  updateResponse: (updatedResponse: QuestionnaireResponse, isInitialUpdate: boolean) => void;
   setUpdatableResponseAsSaved: (savedResponse: QuestionnaireResponse) => void;
   setUpdatableResponseAsEmpty: (clearedResponse: QuestionnaireResponse) => void;
   destroySourceResponse: () => void;
@@ -77,7 +75,7 @@ export interface QuestionnaireResponseStoreType {
 /**
  * QuestionnaireResponse state management store which contains all properties and methods to manage the state of the questionnaireResponse.
  * This is the vanilla version of the store which can be used in non-React environments.
- * @see QuestionnaireResponseStoreType for available properties and methods.
+ * @see {@link QuestionnaireResponseStoreType} for available properties and methods.
  *
  * @author Sean Fong
  */
@@ -116,40 +114,33 @@ export const questionnaireResponseStore = createStore<QuestionnaireResponseStore
         responseIsValid: Object.keys(initialInvalidItems).length === 0
       }));
     },
-    setUpdatableResponseAsPopulated: (populatedResponse: QuestionnaireResponse) => {
+    updateResponse: (updatedResponse: QuestionnaireResponse, isInitialUpdate: boolean) => {
       const sourceQuestionnaire = questionnaireStore.getState().sourceQuestionnaire;
-      const formChanges = diff(get().updatableResponse, populatedResponse) ?? null;
+      const updatedInvalidItems = validateForm(sourceQuestionnaire, updatedResponse);
 
-      const updatedInvalidItems = validateForm(sourceQuestionnaire, populatedResponse);
+      set(() => {
+        const stateUpdate = {
+          updatableResponse: updatedResponse,
+          updatableResponseItems: createQuestionnaireResponseItemMap(
+            sourceQuestionnaire,
+            updatedResponse
+          ),
+          invalidItems: updatedInvalidItems,
+          responseIsValid: Object.keys(updatedInvalidItems).length === 0
+        };
 
-      set(() => ({
-        sourceResponse: populatedResponse,
-        updatableResponse: populatedResponse,
-        updatableResponseItems: createQuestionnaireResponseItemMap(
-          sourceQuestionnaire,
-          populatedResponse
-        ),
-        formChangesHistory: [...get().formChangesHistory, formChanges],
-        invalidItems: updatedInvalidItems,
-        requiredItemsIsHighlighted: false,
-        responseIsValid: Object.keys(updatedInvalidItems).length === 0
-      }));
-    },
-    updateResponse: (updatedResponse: QuestionnaireResponse) => {
-      const sourceQuestionnaire = questionnaireStore.getState().sourceQuestionnaire;
-      const formChanges = diff(get().updatableResponse, updatedResponse) ?? null;
-      const updatedInvalidItems = validateForm(sourceQuestionnaire, updatedResponse);
+        // If this is the initial update, skip updating the form changes
+        if (isInitialUpdate) {
+          return stateUpdate;
+        }
 
-      set(() => ({
-        updatableResponse: updatedResponse,
-        updatableResponseItems: createQuestionnaireResponseItemMap(
-          sourceQuestionnaire,
-          updatedResponse
-        ),
-        formChangesHistory: [...get().formChangesHistory, formChanges],
-        invalidItems: updatedInvalidItems,
-        responseIsValid: Object.keys(updatedInvalidItems).length === 0
-      }));
+        // Otherwise update form changes history
+        const formChanges = diff(get().updatableResponse, updatedResponse) ?? null;
+        return {
+          ...stateUpdate,
+          formChangesHistory: [...get().formChangesHistory, formChanges]
+        };
+      });
     },
     setUpdatableResponseAsSaved: (savedResponse: QuestionnaireResponse) => {
       const sourceQuestionnaire = questionnaireStore.getState().sourceQuestionnaire;
@@ -210,8 +201,8 @@ export const questionnaireResponseStore = createStore<QuestionnaireResponseStore
 /**
  * QuestionnaireResponse state management store which contains all properties and methods to manage the state of the questionnaire.
  * This is the React version of the store which can be used as React hooks in React functional components.
- * @see QuestionnaireResponseStoreType for available properties and methods.
- * @see questionnaireResponseStore for the vanilla store.
+ * @see {@link QuestionnaireResponseStoreType} for available properties and methods.
+ * @see {@link questionnaireResponseStore} for the vanilla store.
  *
  * @author Sean Fong
  */