@dhis2/app-service-offline 3.5.0 → 3.6.1

package/build/cjs/index.js

@@ -33,6 +33,12 @@ Object.defineProperty(exports, "useOnlineStatus", {
     return _onlineStatus.useOnlineStatus;
   }
 });
+Object.defineProperty(exports, "useOnlineStatusMessage", {
+  enumerable: true,
+  get: function () {
+    return _onlineStatusMessage.useOnlineStatusMessage;
+  }
+});
 Object.defineProperty(exports, "clearSensitiveCaches", {
   enumerable: true,
   get: function () {
@@ -48,4 +54,6 @@ var _cacheableSectionState = require("./lib/cacheable-section-state");
 
 var _onlineStatus = require("./lib/online-status");
 
+var _onlineStatusMessage = require("./lib/online-status-message");
+
 var _clearSensitiveCaches = require("./lib/clear-sensitive-caches");

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

@@ -20,7 +20,11 @@ const keysMockDefault = jest.fn().mockImplementation(async () => []);
 const deleteMockDefault = makeCachesDeleteMock([]);
 const cachesDefault = {
   keys: keysMockDefault,
-  delete: deleteMockDefault
+  delete: deleteMockDefault,
+  // the following to satisfy types:
+  has: () => Promise.resolve(true),
+  open: () => Promise.resolve(new Cache()),
+  match: () => Promise.resolve(new Response())
 };
 window.caches = cachesDefault;
 afterEach(() => {
@@ -51,7 +55,7 @@ it('returns false if caches.keys throws', async () => {
   const spy = jest.fn(() => {
     throw new Error('Security Error');
   });
-  window.caches = {
+  window.caches = { ...cachesDefault,
     keys: spy
   };
   const result = await (0, _clearSensitiveCaches.clearSensitiveCaches)();
@@ -59,19 +63,20 @@ it('returns false if caches.keys throws', async () => {
   expect(result).toBe(false);
 });
 it('clears potentially sensitive caches', async () => {
-  const testKeys = ['cache1', 'cache2', 'app-shell'];
+  const testKeys = ['cache1', 'cache2', 'app-shell', 'other-assets'];
   const keysMock = jest.fn().mockImplementation(() => Promise.resolve(testKeys));
   const deleteMock = makeCachesDeleteMock(testKeys);
-  window.caches = {
+  window.caches = { ...cachesDefault,
     keys: keysMock,
     delete: deleteMock
   };
   const cachesDeleted = await (0, _clearSensitiveCaches.clearSensitiveCaches)();
   expect(cachesDeleted).toBe(true);
-  expect(deleteMock).toHaveBeenCalledTimes(3);
+  expect(deleteMock).toHaveBeenCalledTimes(4);
   expect(deleteMock.mock.calls[0][0]).toBe('cache1');
   expect(deleteMock.mock.calls[1][0]).toBe('cache2');
   expect(deleteMock.mock.calls[2][0]).toBe('app-shell');
+  expect(deleteMock.mock.calls[3][0]).toBe('other-assets');
 });
 it('preserves keepable caches', async () => {
   const keysMock = jest.fn().mockImplementation(async () => ['cache1', 'cache2', 'app-shell', 'other-assets', 'workbox-precache-v2-https://hey.howareya.now/']);
@@ -79,11 +84,11 @@ it('preserves keepable caches', async () => {
     keys: keysMock
   };
   await (0, _clearSensitiveCaches.clearSensitiveCaches)();
-  expect(deleteMockDefault).toHaveBeenCalledTimes(3);
+  expect(deleteMockDefault).toHaveBeenCalledTimes(4);
   expect(deleteMockDefault.mock.calls[0][0]).toBe('cache1');
   expect(deleteMockDefault.mock.calls[1][0]).toBe('cache2');
   expect(deleteMockDefault.mock.calls[2][0]).toBe('app-shell');
-  expect(deleteMockDefault).not.toHaveBeenCalledWith('other-assets');
+  expect(deleteMockDefault.mock.calls[3][0]).toBe('other-assets');
   expect(deleteMockDefault).not.toHaveBeenCalledWith('workbox-precache-v2-https://hey.howareya.now/');
 });
 describe('clears sections-db', () => {

package/build/cjs/lib/__tests__/use-online-staus-message.test.js

@@ -0,0 +1,34 @@
+"use strict";
+
+var _reactHooks = require("@testing-library/react-hooks");
+
+var _react = _interopRequireDefault(require("react"));
+
+var _testMocks = require("../../utils/test-mocks");
+
+var _offlineProvider = require("../offline-provider");
+
+var _onlineStatusMessage = require("../online-status-message");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+describe('useOnlineStatusMessage', () => {
+  it('should allow the online status to be updated ', () => {
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/_react.default.createElement(_offlineProvider.OfflineProvider, {
+      offlineInterface: _testMocks.mockOfflineInterface
+    }, children);
+
+    const {
+      result
+    } = (0, _reactHooks.renderHook)(() => (0, _onlineStatusMessage.useOnlineStatusMessage)(), {
+      wrapper
+    });
+    expect(result.current.onlineStatusMessage).toBeUndefined();
+    (0, _reactHooks.act)(() => {
+      result.current.setOnlineStatusMessage('8 offline events');
+    });
+    expect(result.current.onlineStatusMessage).toEqual('8 offline events');
+  });
+});

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

@@ -11,8 +11,7 @@ exports.SECTIONS_DB = SECTIONS_DB;
 const SECTIONS_STORE = 'sections-store'; // Non-sensitive caches that can be kept:
 
 exports.SECTIONS_STORE = SECTIONS_STORE;
-const KEEPABLE_CACHES = [/^workbox-precache/, // precached static assets
-/^other-assets/ // static assets cached at runtime - shouldn't be sensitive
+const KEEPABLE_CACHES = [/^workbox-precache/ // precached static assets
 ];
 
 /*

package/build/cjs/lib/offline-provider.js

@@ -13,6 +13,8 @@ var _cacheableSectionState = require("./cacheable-section-state");
 
 var _offlineInterface = require("./offline-interface");
 
+var _onlineStatusMessage = require("./online-status-message");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /** A context provider for all the relevant offline contexts */
@@ -28,7 +30,7 @@ function OfflineProvider({
 
   return /*#__PURE__*/_react.default.createElement(_offlineInterface.OfflineInterfaceProvider, {
     offlineInterface: offlineInterface
-  }, /*#__PURE__*/_react.default.createElement(_cacheableSectionState.CacheableSectionProvider, null, children));
+  }, /*#__PURE__*/_react.default.createElement(_cacheableSectionState.CacheableSectionProvider, null, /*#__PURE__*/_react.default.createElement(_onlineStatusMessage.OnlineStatusMessageProvider, null, children)));
 }
 
 OfflineProvider.propTypes = {

package/build/cjs/lib/online-status-message.js

@@ -0,0 +1,46 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.OnlineStatusMessageProvider = exports.useOnlineStatusMessage = void 0;
+
+var _react = _interopRequireWildcard(require("react"));
+
+function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
+
+function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+const defaultApi = {
+  onlineStatusMessage: undefined,
+  setOnlineStatusMessage: () => undefined
+};
+
+const OnlineStatusMessageContext = /*#__PURE__*/_react.default.createContext(defaultApi);
+
+const useOnlineStatusMessage = () => {
+  const {
+    onlineStatusMessage,
+    setOnlineStatusMessage
+  } = (0, _react.useContext)(OnlineStatusMessageContext);
+  return {
+    onlineStatusMessage,
+    setOnlineStatusMessage
+  };
+};
+
+exports.useOnlineStatusMessage = useOnlineStatusMessage;
+
+const OnlineStatusMessageProvider = ({
+  children
+}) => {
+  const [onlineStatusMessage, setOnlineStatusMessage] = (0, _react.useState)();
+  return /*#__PURE__*/_react.default.createElement(OnlineStatusMessageContext.Provider, {
+    value: {
+      onlineStatusMessage,
+      setOnlineStatusMessage
+    }
+  }, children);
+};
+
+exports.OnlineStatusMessageProvider = OnlineStatusMessageProvider;

package/build/es/index.js

@@ -2,4 +2,5 @@ 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 { useOnlineStatusMessage } from './lib/online-status-message';
 export { clearSensitiveCaches } from './lib/clear-sensitive-caches';

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

@@ -12,7 +12,11 @@ const keysMockDefault = jest.fn().mockImplementation(async () => []);
 const deleteMockDefault = makeCachesDeleteMock([]);
 const cachesDefault = {
   keys: keysMockDefault,
-  delete: deleteMockDefault
+  delete: deleteMockDefault,
+  // the following to satisfy types:
+  has: () => Promise.resolve(true),
+  open: () => Promise.resolve(new Cache()),
+  match: () => Promise.resolve(new Response())
 };
 window.caches = cachesDefault;
 afterEach(() => {
@@ -43,7 +47,7 @@ it('returns false if caches.keys throws', async () => {
   const spy = jest.fn(() => {
     throw new Error('Security Error');
   });
-  window.caches = {
+  window.caches = { ...cachesDefault,
     keys: spy
   };
   const result = await clearSensitiveCaches();
@@ -51,19 +55,20 @@ it('returns false if caches.keys throws', async () => {
   expect(result).toBe(false);
 });
 it('clears potentially sensitive caches', async () => {
-  const testKeys = ['cache1', 'cache2', 'app-shell'];
+  const testKeys = ['cache1', 'cache2', 'app-shell', 'other-assets'];
   const keysMock = jest.fn().mockImplementation(() => Promise.resolve(testKeys));
   const deleteMock = makeCachesDeleteMock(testKeys);
-  window.caches = {
+  window.caches = { ...cachesDefault,
     keys: keysMock,
     delete: deleteMock
   };
   const cachesDeleted = await clearSensitiveCaches();
   expect(cachesDeleted).toBe(true);
-  expect(deleteMock).toHaveBeenCalledTimes(3);
+  expect(deleteMock).toHaveBeenCalledTimes(4);
   expect(deleteMock.mock.calls[0][0]).toBe('cache1');
   expect(deleteMock.mock.calls[1][0]).toBe('cache2');
   expect(deleteMock.mock.calls[2][0]).toBe('app-shell');
+  expect(deleteMock.mock.calls[3][0]).toBe('other-assets');
 });
 it('preserves keepable caches', async () => {
   const keysMock = jest.fn().mockImplementation(async () => ['cache1', 'cache2', 'app-shell', 'other-assets', 'workbox-precache-v2-https://hey.howareya.now/']);
@@ -71,11 +76,11 @@ it('preserves keepable caches', async () => {
     keys: keysMock
   };
   await clearSensitiveCaches();
-  expect(deleteMockDefault).toHaveBeenCalledTimes(3);
+  expect(deleteMockDefault).toHaveBeenCalledTimes(4);
   expect(deleteMockDefault.mock.calls[0][0]).toBe('cache1');
   expect(deleteMockDefault.mock.calls[1][0]).toBe('cache2');
   expect(deleteMockDefault.mock.calls[2][0]).toBe('app-shell');
-  expect(deleteMockDefault).not.toHaveBeenCalledWith('other-assets');
+  expect(deleteMockDefault.mock.calls[3][0]).toBe('other-assets');
   expect(deleteMockDefault).not.toHaveBeenCalledWith('workbox-precache-v2-https://hey.howareya.now/');
 });
 describe('clears sections-db', () => {

package/build/es/lib/__tests__/use-online-staus-message.test.js

@@ -0,0 +1,25 @@
+import { renderHook, act } from '@testing-library/react-hooks';
+import React from 'react';
+import { mockOfflineInterface } from '../../utils/test-mocks';
+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 {
+      result
+    } = renderHook(() => useOnlineStatusMessage(), {
+      wrapper
+    });
+    expect(result.current.onlineStatusMessage).toBeUndefined();
+    act(() => {
+      result.current.setOnlineStatusMessage('8 offline events');
+    });
+    expect(result.current.onlineStatusMessage).toEqual('8 offline events');
+  });
+});

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

@@ -2,8 +2,7 @@
 export const SECTIONS_DB = 'sections-db';
 export const SECTIONS_STORE = 'sections-store'; // Non-sensitive caches that can be kept:
 
-const KEEPABLE_CACHES = [/^workbox-precache/, // precached static assets
-/^other-assets/ // static assets cached at runtime - shouldn't be sensitive
+const KEEPABLE_CACHES = [/^workbox-precache/ // precached static assets
 ];
 
 /*

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

@@ -2,6 +2,7 @@ import PropTypes from 'prop-types';
 import React from 'react';
 import { CacheableSectionProvider } from './cacheable-section-state';
 import { OfflineInterfaceProvider } from './offline-interface';
+import { OnlineStatusMessageProvider } from './online-status-message';
 
 /** A context provider for all the relevant offline contexts */
 export function OfflineProvider({
@@ -16,7 +17,7 @@ export function OfflineProvider({
 
   return /*#__PURE__*/React.createElement(OfflineInterfaceProvider, {
     offlineInterface: offlineInterface
-  }, /*#__PURE__*/React.createElement(CacheableSectionProvider, null, children));
+  }, /*#__PURE__*/React.createElement(CacheableSectionProvider, null, /*#__PURE__*/React.createElement(OnlineStatusMessageProvider, null, children)));
 }
 OfflineProvider.propTypes = {
   children: PropTypes.node,

package/build/es/lib/online-status-message.js

@@ -0,0 +1,27 @@
+import React, { useContext, useState } from 'react';
+const defaultApi = {
+  onlineStatusMessage: undefined,
+  setOnlineStatusMessage: () => undefined
+};
+const OnlineStatusMessageContext = /*#__PURE__*/React.createContext(defaultApi);
+export const useOnlineStatusMessage = () => {
+  const {
+    onlineStatusMessage,
+    setOnlineStatusMessage
+  } = useContext(OnlineStatusMessageContext);
+  return {
+    onlineStatusMessage,
+    setOnlineStatusMessage
+  };
+};
+export const OnlineStatusMessageProvider = ({
+  children
+}) => {
+  const [onlineStatusMessage, setOnlineStatusMessage] = useState();
+  return /*#__PURE__*/React.createElement(OnlineStatusMessageContext.Provider, {
+    value: {
+      onlineStatusMessage,
+      setOnlineStatusMessage
+    }
+  }, children);
+};

package/build/types/index.d.ts

@@ -2,4 +2,5 @@ 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 { useOnlineStatusMessage } from './lib/online-status-message';
 export { clearSensitiveCaches } from './lib/clear-sensitive-caches';

package/build/types/lib/online-status-message.d.ts

@@ -0,0 +1,6 @@
+import { ReactElement, ReactNode } from 'react';
+import { OnlineStatusMessageContextAPI } from '../types';
+export declare const useOnlineStatusMessage: () => OnlineStatusMessageContextAPI;
+export declare const OnlineStatusMessageProvider: ({ children, }: {
+    children: ReactNode;
+}) => ReactElement;

package/build/types/types.d.ts

@@ -1,3 +1,4 @@
+import { ReactNode } from 'react';
 export declare type RecordingState = 'default' | 'pending' | 'error' | 'recording';
 export interface GlobalStateStoreMutation {
     (state: any): any;
@@ -37,4 +38,8 @@ export interface OfflineInterface {
     getCachedSections: () => Promise<IndexedDBCachedSection[]>;
     removeSection: (id: string) => Promise<boolean>;
 }
+export declare type OnlineStatusMessageContextAPI = {
+    onlineStatusMessage?: ReactNode;
+    setOnlineStatusMessage: (additionalInfo: ReactNode) => void;
+};
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@dhis2/app-service-offline",
     "description": "A runtime service for online/offline detection and offline caching",
-    "version": "3.5.0",
+    "version": "3.6.1",
     "main": "./build/cjs/index.js",
     "module": "./build/es/index.js",
     "types": "build/types/index.d.ts",
@@ -33,7 +33,7 @@
         "coverage": "yarn test --coverage"
     },
     "peerDependencies": {
-        "@dhis2/app-service-alerts": "3.5.0",
+        "@dhis2/app-service-alerts": "3.6.1",
         "prop-types": "^15.7.2",
         "react": "^16.8.6",
         "react-dom": "^16.8.6"