Merge pull request #7 from openizr/0.0.18

0.0.18

library/src/scripts/lib/__mocks__/localforage.ts

@@ -14,4 +14,5 @@ export default {
     ? '{"test": "value"}'
     : null)),
   setItem: jest.fn(() => Promise.resolve()),
+  removeItem: jest.fn(() => Promise.resolve()),
 };

library/src/scripts/plugins/__tests__/valuesLoader.test.ts

@@ -23,16 +23,20 @@ describe('plugins/valuesLoader', () => {
 
   test('initialization - default options', () => {
     valuesLoader({})(engine);
-    expect(engine.on).toHaveBeenCalledTimes(3);
+    expect(engine.on).toHaveBeenCalledTimes(4);
     expect(engine.on).toHaveBeenNthCalledWith(1, 'userAction', expect.any(Function));
     expect(engine.on).toHaveBeenNthCalledWith(2, 'loadNextStep', expect.any(Function));
     expect(engine.on).toHaveBeenNthCalledWith(3, 'loadedNextStep', expect.any(Function));
+    expect(engine.on).toHaveBeenNthCalledWith(4, 'submit', expect.any(Function));
   });
 
   test('initialization - custom options', () => {
     valuesLoader({ enabled: false })(engine);
-    expect(engine.on).toHaveBeenCalledTimes(1);
-    expect(engine.on).toHaveBeenCalledWith('loadedNextStep', expect.any(Function));
+    expect(engine.on).toHaveBeenCalledTimes(4);
+    expect(engine.on).toHaveBeenNthCalledWith(1, 'userAction', expect.any(Function));
+    expect(engine.on).toHaveBeenNthCalledWith(2, 'loadNextStep', expect.any(Function));
+    expect(engine.on).toHaveBeenNthCalledWith(3, 'loadedNextStep', expect.any(Function));
+    expect(engine.on).toHaveBeenNthCalledWith(4, 'submit', expect.any(Function));
   });
 
   test('userAction hook - null user action', async () => {
@@ -116,4 +120,19 @@ describe('plugins/valuesLoader', () => {
     expect(engine.loadValues).toHaveBeenNthCalledWith(1, { test: 'first' });
     expect(engine.loadValues).toHaveBeenNthCalledWith(2, { last: undefined });
   });
+
+  test('submit hook - error in submission', async () => {
+    valuesLoader({})(engine);
+    await engine.trigger('submit', {}, null);
+    expect(localforage.removeItem).not.toHaveBeenCalled();
+  });
+
+  test('submit hook - successfully submitted', async () => {
+    valuesLoader({})(engine);
+    await engine.trigger('submit', {}, {});
+    await engine.trigger('userAction', {}, {});
+    expect(localforage.setItem).not.toHaveBeenCalled();
+    expect(localforage.removeItem).toHaveBeenCalledTimes(1);
+    expect(localforage.removeItem).toHaveBeenCalledWith('gincko_cache');
+  });
 });

library/src/scripts/plugins/valuesLoader.ts

@@ -26,7 +26,7 @@ interface Options {
 export default function valuesLoader(options: Options): Plugin {
   let loadedCache = false;
   let timeout: number | null = null;
-  const enabled = options.enabled !== false;
+  let enabled = options.enabled !== false;
   const autoSubmit = options.autoSubmit === true;
   const cacheKey = `gincko_${options.cacheId || 'cache'}`;
   const injectValuesTo = options.injectValuesTo || ['Message'];
@@ -39,28 +39,28 @@ export default function valuesLoader(options: Options): Plugin {
         : values
     ), {}) as FormValues;
 
-    if (enabled === true) {
-      // Stores new user inputs into cache.
-      engine.on('userAction', (userAction, next) => next(userAction).then((updatedUserAction) => {
+    // Stores new user inputs into cache.
+    engine.on('userAction', (userAction, next) => next(userAction).then((updatedUserAction) => {
+      if (enabled === true) {
         if (updatedUserAction !== null) {
-          Object.assign(formValues, { [updatedUserAction.fieldId]: updatedUserAction.value });
+          formValues[updatedUserAction.fieldId] = updatedUserAction.value;
           window.clearTimeout(timeout as number);
           timeout = window.setTimeout(() => {
             localforage.setItem(cacheKey, JSON.stringify(formValues));
           }, 500);
         }
-        return Promise.resolve(updatedUserAction);
-      }));
+      }
+      return Promise.resolve(updatedUserAction);
+    }));
 
-      // Automatically injects form values in specified fields' options to allow for more dynamic
-      // behaviours such as using filled values as variables in another step's message field.
-      engine.on('loadNextStep', (nextStep, next) => next((nextStep === null) ? nextStep : {
-        ...nextStep,
-        fields: nextStep.fields.map((field: Field) => ((injectValuesTo.includes(field.type))
-          ? { ...field, options: { ...field.options, formValues } }
-          : field)),
-      }));
-    }
+    // Automatically injects form values in specified fields' options to allow for more dynamic
+    // behaviours such as using filled values as variables in another step's message field.
+    engine.on('loadNextStep', (nextStep, next) => next((nextStep === null) ? nextStep : {
+      ...nextStep,
+      fields: nextStep.fields.map((field: Field) => ((injectValuesTo.includes(field.type))
+        ? { ...field, options: { ...field.options, formValues } }
+        : field)),
+    }));
 
     // Loads default values defined in configuration's fields, as well as values already filled.
     engine.on('loadedNextStep', (nextStep, next) => {
@@ -95,5 +95,16 @@ export default function valuesLoader(options: Options): Plugin {
         return next(nextStep);
       });
     });
+
+    // Empties values stored in cache if needed, and synchronizes values with engine ones on submit.
+    engine.on('submit', (submitValues, next) => next(submitValues).then((updatedFormValues) => {
+      if (updatedFormValues !== null && enabled === true) {
+        window.clearTimeout(timeout as number);
+        localforage.removeItem(cacheKey);
+        Object.assign(formValues, updatedFormValues);
+        enabled = false;
+      }
+      return Promise.resolve(updatedFormValues);
+    }));
   };
 }

library/src/scripts/types.d.ts

@@ -70,7 +70,7 @@ export type Configuration = PropTypes.InferProps<{
     [x: string]: PropTypes.InferProps<{
       fields: PropTypes.Validator<string[]>;
       submit: PropTypes.Requireable<boolean>;
-      nextStep: PropTypes.Requireable<string | ((...args: Json[]) => string)>;
+      nextStep: PropTypes.Requireable<string | ((...args: Json[]) => string | null)>;
     }>;
   }>;
   fields: PropTypes.Validator<{