@dhis2/app-service-offline 3.8.0 → 3.9.0

package/build/es/__tests__/integration.test.js

@@ -11,10 +11,11 @@ const renderCounts = {};
 
 const identity = arg => arg;
 
-const TestControls = ({
-  id,
-  makeRecordingHandler = identity
-}) => {
+const TestControls = (_ref) => {
+  let {
+    id,
+    makeRecordingHandler = identity
+  } = _ref;
   const {
     startRecording,
     remove,
@@ -23,37 +24,40 @@ const TestControls = ({
     recordingState
   } = useCacheableSection(id);
   return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(RenderCounter, {
-    id: "controls-rc-".concat(id),
+    id: `controls-rc-${id}`,
     countsObj: renderCounts
   }), /*#__PURE__*/React.createElement("button", {
-    "data-testid": "start-recording-".concat(id),
+    "data-testid": `start-recording-${id}`,
     onClick: makeRecordingHandler(startRecording)
   }), /*#__PURE__*/React.createElement("button", {
-    "data-testid": "remove-".concat(id),
+    "data-testid": `remove-${id}`,
     onClick: () => {
       remove();
     }
   }), /*#__PURE__*/React.createElement("div", {
-    "data-testid": "is-cached-".concat(id)
+    "data-testid": `is-cached-${id}`
   }, isCached ? 'yes' : 'no'), /*#__PURE__*/React.createElement("div", {
-    "data-testid": "last-updated-".concat(id)
+    "data-testid": `last-updated-${id}`
   }, lastUpdated || 'never'), /*#__PURE__*/React.createElement("div", {
-    "data-testid": "recording-state-".concat(id)
+    "data-testid": `recording-state-${id}`
   }, recordingState));
 };
 
-const TestSection = ({
-  id,
-  children
-}) => /*#__PURE__*/React.createElement(CacheableSection, {
-  id: id,
-  loadingMask: /*#__PURE__*/React.createElement("div", {
-    "data-testid": "loading-mask-".concat(id)
-  })
-}, /*#__PURE__*/React.createElement(RenderCounter, {
-  id: "section-rc-".concat(id),
-  countsObj: renderCounts
-}), children);
+const TestSection = (_ref2) => {
+  let {
+    id,
+    children
+  } = _ref2;
+  return /*#__PURE__*/React.createElement(CacheableSection, {
+    id: id,
+    loadingMask: /*#__PURE__*/React.createElement("div", {
+      "data-testid": `loading-mask-${id}`
+    })
+  }, /*#__PURE__*/React.createElement(RenderCounter, {
+    id: `section-rc-${id}`,
+    countsObj: renderCounts
+  }), children);
+};
 
 const TestSingleSection = props => {
   // Props are spread so they can be overwritten
@@ -71,9 +75,13 @@ const originalError = console.error;
 beforeEach(() => {
   // This is done before each because the 'recording error' test uses its own
   // spy on console.error
-  jest.spyOn(console, 'error').mockImplementation((...args) => {
+  jest.spyOn(console, 'error').mockImplementation(function () {
     const pattern = /Warning: An update to .* inside a test was not wrapped in act/;
 
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
     if (typeof args[0] === 'string' && pattern.test(args[0])) {
       return;
     }
@@ -139,9 +147,14 @@ describe('Coordination between useCacheableSection and CacheableSection', () =>
   });
   it('handles a recording that encounters an error', async done => {
     // Suppress the expected error from console (in addition to 'act' warning)
-    jest.spyOn(console, 'error').mockImplementation((...args) => {
+    jest.spyOn(console, 'error').mockImplementation(function () {
       const actPattern = /Warning: An update to .* inside a test was not wrapped in act/;
       const errPattern = /Error during recording/;
+
+      for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
+        args[_key2] = arguments[_key2];
+      }
+
       const matchesPattern = actPattern.test(args[0]) || errPattern.test(args[0]);
 
       if (typeof args[0] === 'string' && matchesPattern) {

package/build/es/index.js

@@ -1,6 +1,8 @@
 export { OfflineProvider } from './lib/offline-provider';
 export { CacheableSection, useCacheableSection } from './lib/cacheable-section';
-export { useCachedSections } from './lib/cacheable-section-state';
-export { useOnlineStatus } from './lib/online-status';
+export { useCachedSections } from './lib/cacheable-section-state'; // Use "useOnlineStatus" name for backwards compatibility
+
+export { useNetworkStatus as useOnlineStatus } from './lib/network-status';
 export { useOnlineStatusMessage } from './lib/online-status-message';
-export { clearSensitiveCaches } from './lib/clear-sensitive-caches';
+export { clearSensitiveCaches } from './lib/clear-sensitive-caches';
+export { useDhis2ConnectionStatus } from './lib/dhis2-connection-status';

package/build/es/lib/__tests__/clear-sensitive-caches.test.js

@@ -26,9 +26,13 @@ afterEach(() => {
 
 const originalDebug = console.debug;
 beforeAll(() => {
-  jest.spyOn(console, 'debug').mockImplementation((...args) => {
+  jest.spyOn(console, 'debug').mockImplementation(function () {
     const pattern = /Clearing sensitive caches/;
 
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
     if (typeof args[0] === 'string' && pattern.test(args[0])) {
       return;
     }

package/build/es/lib/__tests__/{online-status.test.js → network-status.test.js}

@@ -1,7 +1,7 @@
 import { render, screen, waitFor } from '@testing-library/react';
 import { act, renderHook } from '@testing-library/react-hooks';
 import React from 'react';
-import { useOnlineStatus } from '../online-status';
+import { useNetworkStatus as useOnlineStatus } from '../network-status';
 
 function wait(ms) {
   return new Promise(resolve => {
@@ -42,7 +42,9 @@ describe('state changes in response to browser "online" and "offline" events', (
     const {
       result,
       waitForNextUpdate
-    } = renderHook((...args) => useOnlineStatus(...args), {
+    } = renderHook(function () {
+      return useOnlineStatus(...arguments);
+    }, {
       initialProps: {
         debounceDelay: 50
       }
@@ -65,7 +67,9 @@ describe('state changes in response to browser "online" and "offline" events', (
     const {
       result,
       waitForNextUpdate
-    } = renderHook((...args) => useOnlineStatus(...args), {
+    } = renderHook(function () {
+      return useOnlineStatus(...arguments);
+    }, {
       initialProps: {
         debounceDelay: 50
       }
@@ -113,7 +117,9 @@ describe('debouncing state changes', () => {
     const {
       result,
       waitForNextUpdate
-    } = renderHook((...args) => useOnlineStatus(...args), {
+    } = renderHook(function () {
+      return useOnlineStatus(...arguments);
+    }, {
       initialProps: {
         debounceDelay: 50
       }
@@ -139,7 +145,9 @@ describe('debouncing state changes', () => {
     const {
       result,
       waitForNextUpdate
-    } = renderHook((...args) => useOnlineStatus(...args), {
+    } = renderHook(function () {
+      return useOnlineStatus(...arguments);
+    }, {
       initialProps: {
         debounceDelay: 0
       }
@@ -166,7 +174,9 @@ describe('debouncing state changes', () => {
       result,
       waitForNextUpdate,
       rerender
-    } = renderHook((...args) => useOnlineStatus(...args), {
+    } = renderHook(function () {
+      return useOnlineStatus(...arguments);
+    }, {
       initialProps: {
         debounceDelay: 150
       }
@@ -243,9 +253,10 @@ describe('debouncing state changes', () => {
     const events = {};
     window.addEventListener = jest.fn((event, cb) => events[event] = cb);
 
-    const TestComponent = ({
-      options
-    }) => {
+    const TestComponent = (_ref) => {
+      let {
+        options
+      } = _ref;
       const {
         online
       } = useOnlineStatus(options);
@@ -341,7 +352,9 @@ describe('it updates the lastOnline value in local storage', () => {
     const {
       result,
       waitForNextUpdate
-    } = renderHook((...args) => useOnlineStatus(...args), {
+    } = renderHook(function () {
+      return useOnlineStatus(...arguments);
+    }, {
       initialProps: {
         debounceDelay: 0
       }
@@ -374,7 +387,9 @@ describe('it updates the lastOnline value in local storage', () => {
     window.addEventListener = jest.fn((event, cb) => events[event] = cb);
     const {
       result
-    } = renderHook((...args) => useOnlineStatus(...args), {
+    } = renderHook(function () {
+      return useOnlineStatus(...arguments);
+    }, {
       initialProps: {
         debounceDelay: 0
       }
@@ -392,7 +407,9 @@ describe('it updates the lastOnline value in local storage', () => {
     window.addEventListener = jest.fn((event, cb) => events[event] = cb);
     const {
       result
-    } = renderHook((...args) => useOnlineStatus(...args), {
+    } = renderHook(function () {
+      return useOnlineStatus(...arguments);
+    }, {
       initialProps: {
         debounceDelay: 0
       }
@@ -417,7 +434,9 @@ describe('it updates the lastOnline value in local storage', () => {
     const {
       result,
       waitForNextUpdate
-    } = renderHook((...args) => useOnlineStatus(...args), {
+    } = renderHook(function () {
+      return useOnlineStatus(...arguments);
+    }, {
       initialProps: {
         debounceDelay: 0
       }
@@ -445,7 +464,9 @@ describe('it updates the lastOnline value in local storage', () => {
     const {
       result,
       waitForNextUpdate
-    } = renderHook((...args) => useOnlineStatus(...args), {
+    } = renderHook(function () {
+      return useOnlineStatus(...arguments);
+    }, {
       initialProps: {
         debounceDelay: 0
       }

package/build/es/lib/__tests__/offline-provider.test.js

@@ -7,9 +7,13 @@ import { OfflineProvider } from '../offline-provider'; // Suppress 'act' warning
 
 const originalError = console.error;
 beforeEach(() => {
-  jest.spyOn(console, 'error').mockImplementation((...args) => {
+  jest.spyOn(console, 'error').mockImplementation(function () {
     const pattern = /Warning: An update to .* inside a test was not wrapped in act/;
 
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
     if (typeof args[0] === 'string' && pattern.test(args[0])) {
       return;
     }

package/build/es/lib/__tests__/use-cacheable-section.test.js

@@ -1,4 +1,3 @@
-import { AlertsProvider } from '@dhis2/app-service-alerts';
 import { renderHook, act } from '@testing-library/react-hooks';
 import React from 'react';
 import { errorRecordingMock, failedMessageRecordingMock, mockOfflineInterface } from '../../utils/test-mocks';
@@ -7,9 +6,13 @@ import { OfflineProvider } from '../offline-provider'; // Suppress 'act' warning
 
 const originalError = console.error;
 beforeEach(() => {
-  jest.spyOn(console, 'error').mockImplementation((...args) => {
+  jest.spyOn(console, 'error').mockImplementation(function () {
     const pattern = /Warning: An update to .* inside a test was not wrapped in act/;
 
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
     if (typeof args[0] === 'string' && pattern.test(args[0])) {
       return;
     }
@@ -23,14 +26,19 @@ afterEach(() => {
   console.error.mockRestore();
 });
 it('renders in the default state initially', () => {
+  const wrapper = (_ref) => {
+    let {
+      children
+    } = _ref;
+    return /*#__PURE__*/React.createElement(OfflineProvider, {
+      offlineInterface: mockOfflineInterface
+    }, children);
+  };
+
   const {
     result
   } = renderHook(() => useCacheableSection('one'), {
-    wrapper: ({
-      children
-    }) => /*#__PURE__*/React.createElement(AlertsProvider, null, /*#__PURE__*/React.createElement(OfflineProvider, {
-      offlineInterface: mockOfflineInterface
-    }, children))
+    wrapper
   });
   expect(result.current.recordingState).toBe('default');
   expect(result.current.isCached).toBe(false);
@@ -44,15 +52,21 @@ it('handles a successful recording', async done => {
       lastUpdated: new Date()
     }])
   };
+
+  const wrapper = (_ref2) => {
+    let {
+      children
+    } = _ref2;
+    return /*#__PURE__*/React.createElement(OfflineProvider, {
+      offlineInterface: testOfflineInterface
+    }, children);
+  };
+
   const {
     result,
     waitFor
   } = renderHook(() => useCacheableSection(sectionId), {
-    wrapper: ({
-      children
-    }) => /*#__PURE__*/React.createElement(AlertsProvider, null, /*#__PURE__*/React.createElement(OfflineProvider, {
-      offlineInterface: testOfflineInterface
-    }, children))
+    wrapper
   });
 
   const assertRecordingStarted = () => {
@@ -91,9 +105,14 @@ it('handles a successful recording', async done => {
 });
 it('handles a recording that encounters an error', async done => {
   // Suppress the expected error from console (in addition to 'act' warning)
-  jest.spyOn(console, 'error').mockImplementation((...args) => {
+  jest.spyOn(console, 'error').mockImplementation(function () {
     const actPattern = /Warning: An update to .* inside a test was not wrapped in act/;
     const errPattern = /Error during recording/;
+
+    for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
+      args[_key2] = arguments[_key2];
+    }
+
     const matchesPattern = actPattern.test(args[0]) || errPattern.test(args[0]);
 
     if (typeof args[0] === 'string' && matchesPattern) {
@@ -105,14 +124,20 @@ it('handles a recording that encounters an error', async done => {
   const testOfflineInterface = { ...mockOfflineInterface,
     startRecording: errorRecordingMock
   };
+
+  const wrapper = (_ref3) => {
+    let {
+      children
+    } = _ref3;
+    return /*#__PURE__*/React.createElement(OfflineProvider, {
+      offlineInterface: testOfflineInterface
+    }, children);
+  };
+
   const {
     result
   } = renderHook(() => useCacheableSection('one'), {
-    wrapper: ({
-      children
-    }) => /*#__PURE__*/React.createElement(AlertsProvider, null, /*#__PURE__*/React.createElement(OfflineProvider, {
-      offlineInterface: testOfflineInterface
-    }, children))
+    wrapper
   });
 
   const assertRecordingStarted = () => {
@@ -145,14 +170,20 @@ it('handles an error starting the recording', async () => {
   const testOfflineInterface = { ...mockOfflineInterface,
     startRecording: failedMessageRecordingMock
   };
+
+  const wrapper = (_ref4) => {
+    let {
+      children
+    } = _ref4;
+    return /*#__PURE__*/React.createElement(OfflineProvider, {
+      offlineInterface: testOfflineInterface
+    }, children);
+  };
+
   const {
     result
   } = renderHook(() => useCacheableSection('err'), {
-    wrapper: ({
-      children
-    }) => /*#__PURE__*/React.createElement(AlertsProvider, null, /*#__PURE__*/React.createElement(OfflineProvider, {
-      offlineInterface: testOfflineInterface
-    }, children))
+    wrapper
   });
   await expect(result.current.startRecording()).rejects.toThrow('Failed message' // from failedMessageRecordingMock
   );
@@ -165,15 +196,21 @@ it('handles remove and updates sections', async () => {
       lastUpdated: new Date()
     }]).mockResolvedValueOnce([])
   };
+
+  const wrapper = (_ref5) => {
+    let {
+      children
+    } = _ref5;
+    return /*#__PURE__*/React.createElement(OfflineProvider, {
+      offlineInterface: testOfflineInterface
+    }, children);
+  };
+
   const {
     result,
     waitFor
   } = renderHook(() => useCacheableSection(sectionId), {
-    wrapper: ({
-      children
-    }) => /*#__PURE__*/React.createElement(AlertsProvider, null, /*#__PURE__*/React.createElement(OfflineProvider, {
-      offlineInterface: testOfflineInterface
-    }, children))
+    wrapper
   }); // Wait for state to sync with indexedDB
 
   await waitFor(() => result.current.isCached === true);
@@ -195,16 +232,22 @@ it('handles a change in ID', async () => {
       lastUpdated: new Date()
     }])
   };
+
+  const wrapper = (_ref6) => {
+    let {
+      children
+    } = _ref6;
+    return /*#__PURE__*/React.createElement(OfflineProvider, {
+      offlineInterface: testOfflineInterface
+    }, children);
+  };
+
   const {
     result,
     waitFor,
     rerender
-  } = renderHook((...args) => useCacheableSection(...args), {
-    wrapper: ({
-      children
-    }) => /*#__PURE__*/React.createElement(AlertsProvider, null, /*#__PURE__*/React.createElement(OfflineProvider, {
-      offlineInterface: testOfflineInterface
-    }, children)),
+  } = renderHook(id => useCacheableSection(id), {
+    wrapper,
     initialProps: 'id-one'
   }); // Wait for state to sync with indexedDB
 

package/build/es/lib/__tests__/{use-online-staus-message.test.js → use-online-status-message.test.js}

@@ -5,11 +5,14 @@ import { OfflineProvider } from '../offline-provider';
 import { useOnlineStatusMessage } from '../online-status-message';
 describe('useOnlineStatusMessage', () => {
   it('should allow the online status to be updated ', () => {
-    const wrapper = ({
-      children
-    }) => /*#__PURE__*/React.createElement(OfflineProvider, {
-      offlineInterface: mockOfflineInterface
-    }, children);
+    const wrapper = (_ref) => {
+      let {
+        children
+      } = _ref;
+      return /*#__PURE__*/React.createElement(OfflineProvider, {
+        offlineInterface: mockOfflineInterface
+      }, children);
+    };
 
     const {
       result

package/build/es/lib/cacheable-section-state.js

@@ -12,14 +12,17 @@ import { useOfflineInterface } from './offline-interface'; // Functions in here
  * @returns {Object} An object of sections, keyed by ID
  */
 function getSectionsById(sectionsArray) {
-  return sectionsArray.reduce((result, {
-    sectionId,
-    lastUpdated
-  }) => ({ ...result,
-    [sectionId]: {
+  return sectionsArray.reduce((result, _ref) => {
+    let {
+      sectionId,
       lastUpdated
-    }
-  }), {});
+    } = _ref;
+    return { ...result,
+      [sectionId]: {
+        lastUpdated
+      }
+    };
+  }, {});
 }
 /**
  * Create a store for Cacheable Section state.
@@ -57,9 +60,10 @@ function useConst(factory) {
  */
 
 
-export function CacheableSectionProvider({
-  children
-}) {
+export function CacheableSectionProvider(_ref2) {
+  let {
+    children
+  } = _ref2;
   const offlineInterface = useOfflineInterface();
   const store = useConst(createCacheableSectionStore); // On load, get sections and add to store
 

package/build/es/lib/cacheable-section.js

@@ -45,12 +45,13 @@ export function useCacheableSection(id) {
     };
   }, []); // eslint-disable-line react-hooks/exhaustive-deps
 
-  function startRecording({
-    recordingTimeoutDelay = 1000,
-    onStarted,
-    onCompleted,
-    onError
-  } = {}) {
+  function startRecording() {
+    let {
+      recordingTimeoutDelay = 1000,
+      onStarted,
+      onCompleted,
+      onError
+    } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     // This promise resolving means that the message to the service worker
     // to start recording was successful. Waiting for resolution prevents
     // unnecessarily rerendering the whole component in case of an error
@@ -108,11 +109,12 @@ export function useCacheableSection(id) {
  * intended to prevent other interaction with the app that might interfere
  * with the recording process.
  */
-export function CacheableSection({
-  id,
-  loadingMask,
-  children
-}) {
+export function CacheableSection(_ref) {
+  let {
+    id,
+    loadingMask,
+    children
+  } = _ref;
   // Accesses recording state that useCacheableSection controls
   const {
     recordingState

package/build/es/lib/clear-sensitive-caches.js

@@ -22,9 +22,12 @@ const clearDB = async dbName => {
 
   const dbs = await window.indexedDB.databases();
 
-  if (!dbs.some(({
-    name
-  }) => name === dbName)) {
+  if (!dbs.some((_ref) => {
+    let {
+      name
+    } = _ref;
+    return name === dbName;
+  })) {
     // Sections-db is not created; nothing to do here
     return;
   }
@@ -59,7 +62,8 @@ const clearDB = async dbName => {
  */
 
 
-export async function clearSensitiveCaches(dbName = SECTIONS_DB) {
+export async function clearSensitiveCaches() {
+  let dbName = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : SECTIONS_DB;
   console.debug('Clearing sensitive caches');
   let cacheKeys; // caches.keys can fail in insecure contexts, see:
   // https://developer.mozilla.org/en-US/docs/Web/API/CacheStorage

package/build/es/lib/dhis2-connection-status/dev-debug-log.js

@@ -0,0 +1,20 @@
+const shouldLog = localStorage.getItem('dhis2.debugConnectionStatus');
+
+if (shouldLog) {
+  console.log('Logging for dhis2ConnectionStatus is enabled. Remove the `dhis2.debugConnectionStatus` item in localStorage to disable logging.');
+}
+/**
+ * This can be used to log info if the `dhis2.debugConnectionStatus` value
+ * in localStorage is set to a truthy value during development.
+ * Set the value manually and refresh the page to see the logs.
+ *
+ * The behavior of the connection status can be quite hard to inspect without
+ * logs, but the logs are quite chatty and should be omitted normally.
+ */
+
+
+export function devDebugLog() {
+  if (shouldLog) {
+    console.log(...arguments);
+  }
+}