@dhis2/app-service-offline 3.10.0-alpha.6 → 3.10.1

package/build/cjs/index.js

@@ -51,6 +51,18 @@ Object.defineProperty(exports, "useOnlineStatusMessage", {
     return _onlineStatusMessage.useOnlineStatusMessage;
   }
 });
+Object.defineProperty(exports, "useOnlineStatusMessageValue", {
+  enumerable: true,
+  get: function () {
+    return _onlineStatusMessage.useOnlineStatusMessageValue;
+  }
+});
+Object.defineProperty(exports, "useSetOnlineStatusMessage", {
+  enumerable: true,
+  get: function () {
+    return _onlineStatusMessage.useSetOnlineStatusMessage;
+  }
+});
 
 var _offlineProvider = require("./lib/offline-provider");
 

package/build/cjs/lib/dhis2-connection-status/dhis2-connection-status.js

@@ -186,6 +186,16 @@ const Dhis2ConnectionStatusProvider = (_ref) => {
     };
   }, [pingAndHandleStatus, serverVersion]);
   (0, _react.useEffect)(() => {
+    if (!offlineInterface.subscribeToDhis2ConnectionStatus) {
+      var _smartIntervalRef$cur3;
+
+      // Missing this functionality from the offline interface --
+      // use a ping on startup to get the status
+      (_smartIntervalRef$cur3 = smartIntervalRef.current) === null || _smartIntervalRef$cur3 === void 0 ? void 0 : _smartIntervalRef$cur3.invokeCallbackImmediately();
+      console.warn('Please upgrade to @dhis2/cli-app-scripts@>10.3.8 for full connection status features');
+      return;
+    }
+
     const unsubscribe = offlineInterface.subscribeToDhis2ConnectionStatus({
       onUpdate
     });
@@ -194,18 +204,21 @@ const Dhis2ConnectionStatusProvider = (_ref) => {
     };
   }, [offlineInterface, onUpdate]); // Memoize this value to prevent unnecessary rerenders of context provider
 
-  const contextValue = (0, _react.useMemo)(() => ({
+  const contextValue = (0, _react.useMemo)(() => {
     // in the unlikely circumstance that offlineInterface.latestIsConnected
-    // is `null` when this initializes, fail safe by defaulting to
-    // `isConnected: false`
-    isConnected: Boolean(isConnected),
-    isDisconnected: !isConnected,
-    lastConnected: isConnected ? null : // Only evaluate if disconnected, since local storage
-    // is synchronous and disk-based.
-    // If lastConnected is not set in localStorage though, set it.
-    // (relevant on startup)
-    getLastConnected(appName) || updateLastConnected(appName)
-  }), [isConnected, appName]);
+    // is `null` or `undefined` when this initializes, fail safe by defaulting to
+    // `isConnected: true`. A ping or SW update should update the status shortly.
+    const validatedIsConnected = isConnected !== null && isConnected !== void 0 ? isConnected : true;
+    return {
+      isConnected: validatedIsConnected,
+      isDisconnected: !validatedIsConnected,
+      lastConnected: validatedIsConnected ? null : // Only evaluate if disconnected, since local storage
+      // is synchronous and disk-based.
+      // If lastConnected is not set in localStorage though, set it.
+      // (relevant on startup)
+      getLastConnected(appName) || updateLastConnected(appName)
+    };
+  }, [isConnected, appName]);
   return /*#__PURE__*/_react.default.createElement(Dhis2ConnectionStatusContext.Provider, {
     value: contextValue
   }, children);

package/build/cjs/lib/dhis2-connection-status/dhis2-connection-status.test.js

@@ -162,9 +162,9 @@ describe('initialization to the right values based on offline interface', () =>
     } = (0, _reactHooks.renderHook)(() => (0, _dhis2ConnectionStatus.useDhis2ConnectionStatus)(), {
       wrapper: customWrapper
     });
-    expect(result.current.isConnected).toBe(false);
-    expect(result.current.isDisconnected).toBe(true);
-    expect(result.current.lastConnected).toEqual(testCurrentDate);
+    expect(result.current.isConnected).toBe(true);
+    expect(result.current.isDisconnected).toBe(false);
+    expect(result.current.lastConnected).toBe(null);
   });
 });
 describe('interval behavior', () => {

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

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.useOnlineStatusMessage = exports.OnlineStatusMessageProvider = void 0;
+exports.useSetOnlineStatusMessage = exports.useOnlineStatusMessageValue = exports.useOnlineStatusMessage = exports.OnlineStatusMessageProvider = void 0;
 
 var _react = _interopRequireWildcard(require("react"));
 
@@ -11,37 +11,47 @@ function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return
 
 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
+// 'get' and 'set' contexts are separated so 'setter' consumers that don't
+// actually need the value don't have to rerender when the value changes:
+const OnlineStatusMessageValueContext = /*#__PURE__*/_react.default.createContext(undefined);
+
+const SetOnlineStatusMessageContext = /*#__PURE__*/_react.default.createContext(() => undefined);
+
+const OnlineStatusMessageProvider = (_ref) => {
+  let {
+    children
+  } = _ref;
+  const [onlineStatusMessage, setOnlineStatusMessage] = (0, _react.useState)(); // note: not undefined
+
+  return /*#__PURE__*/_react.default.createElement(OnlineStatusMessageValueContext.Provider, {
+    value: onlineStatusMessage
+  }, /*#__PURE__*/_react.default.createElement(SetOnlineStatusMessageContext.Provider, {
+    value: setOnlineStatusMessage
+  }, children));
 };
 
-const OnlineStatusMessageContext = /*#__PURE__*/_react.default.createContext(defaultApi);
+exports.OnlineStatusMessageProvider = OnlineStatusMessageProvider;
+
+const useOnlineStatusMessageValue = () => {
+  return (0, _react.useContext)(OnlineStatusMessageValueContext);
+};
+
+exports.useOnlineStatusMessageValue = useOnlineStatusMessageValue;
+
+const useSetOnlineStatusMessage = () => {
+  return (0, _react.useContext)(SetOnlineStatusMessageContext);
+}; // combination of both getter and setter (also provides backward compatability)
+
+
+exports.useSetOnlineStatusMessage = useSetOnlineStatusMessage;
 
 const useOnlineStatusMessage = () => {
-  const {
-    onlineStatusMessage,
-    setOnlineStatusMessage
-  } = (0, _react.useContext)(OnlineStatusMessageContext);
+  const onlineStatusMessage = useOnlineStatusMessageValue();
+  const setOnlineStatusMessage = useSetOnlineStatusMessage();
   return {
     onlineStatusMessage,
     setOnlineStatusMessage
   };
 };
 
-exports.useOnlineStatusMessage = useOnlineStatusMessage;
-
-const OnlineStatusMessageProvider = (_ref) => {
-  let {
-    children
-  } = _ref;
-  const [onlineStatusMessage, setOnlineStatusMessage] = (0, _react.useState)();
-  return /*#__PURE__*/_react.default.createElement(OnlineStatusMessageContext.Provider, {
-    value: {
-      onlineStatusMessage,
-      setOnlineStatusMessage
-    }
-  }, children);
-};
-
-exports.OnlineStatusMessageProvider = OnlineStatusMessageProvider;
+exports.useOnlineStatusMessage = useOnlineStatusMessage;

package/build/es/index.js

@@ -3,6 +3,6 @@ export { CacheableSection, useCacheableSection } from './lib/cacheable-section';
 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 { useOnlineStatusMessage, useSetOnlineStatusMessage, useOnlineStatusMessageValue } from './lib/online-status-message';
 export { clearSensitiveCaches } from './lib/clear-sensitive-caches';
 export { useDhis2ConnectionStatus } from './lib/dhis2-connection-status';

package/build/es/lib/dhis2-connection-status/dhis2-connection-status.js

@@ -160,6 +160,16 @@ export const Dhis2ConnectionStatusProvider = (_ref) => {
     };
   }, [pingAndHandleStatus, serverVersion]);
   useEffect(() => {
+    if (!offlineInterface.subscribeToDhis2ConnectionStatus) {
+      var _smartIntervalRef$cur3;
+
+      // Missing this functionality from the offline interface --
+      // use a ping on startup to get the status
+      (_smartIntervalRef$cur3 = smartIntervalRef.current) === null || _smartIntervalRef$cur3 === void 0 ? void 0 : _smartIntervalRef$cur3.invokeCallbackImmediately();
+      console.warn('Please upgrade to @dhis2/cli-app-scripts@>10.3.8 for full connection status features');
+      return;
+    }
+
     const unsubscribe = offlineInterface.subscribeToDhis2ConnectionStatus({
       onUpdate
     });
@@ -168,18 +178,21 @@ export const Dhis2ConnectionStatusProvider = (_ref) => {
     };
   }, [offlineInterface, onUpdate]); // Memoize this value to prevent unnecessary rerenders of context provider
 
-  const contextValue = useMemo(() => ({
+  const contextValue = useMemo(() => {
     // in the unlikely circumstance that offlineInterface.latestIsConnected
-    // is `null` when this initializes, fail safe by defaulting to
-    // `isConnected: false`
-    isConnected: Boolean(isConnected),
-    isDisconnected: !isConnected,
-    lastConnected: isConnected ? null : // Only evaluate if disconnected, since local storage
-    // is synchronous and disk-based.
-    // If lastConnected is not set in localStorage though, set it.
-    // (relevant on startup)
-    getLastConnected(appName) || updateLastConnected(appName)
-  }), [isConnected, appName]);
+    // is `null` or `undefined` when this initializes, fail safe by defaulting to
+    // `isConnected: true`. A ping or SW update should update the status shortly.
+    const validatedIsConnected = isConnected !== null && isConnected !== void 0 ? isConnected : true;
+    return {
+      isConnected: validatedIsConnected,
+      isDisconnected: !validatedIsConnected,
+      lastConnected: validatedIsConnected ? null : // Only evaluate if disconnected, since local storage
+      // is synchronous and disk-based.
+      // If lastConnected is not set in localStorage though, set it.
+      // (relevant on startup)
+      getLastConnected(appName) || updateLastConnected(appName)
+    };
+  }, [isConnected, appName]);
   return /*#__PURE__*/React.createElement(Dhis2ConnectionStatusContext.Provider, {
     value: contextValue
   }, children);

package/build/es/lib/dhis2-connection-status/dhis2-connection-status.test.js

@@ -152,9 +152,9 @@ describe('initialization to the right values based on offline interface', () =>
     } = renderHook(() => useDhis2ConnectionStatus(), {
       wrapper: customWrapper
     });
-    expect(result.current.isConnected).toBe(false);
-    expect(result.current.isDisconnected).toBe(true);
-    expect(result.current.lastConnected).toEqual(testCurrentDate);
+    expect(result.current.isConnected).toBe(true);
+    expect(result.current.isDisconnected).toBe(false);
+    expect(result.current.lastConnected).toBe(null);
   });
 });
 describe('interval behavior', () => {

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

@@ -1,28 +1,32 @@
 import React, { useContext, useState } from 'react';
-const defaultApi = {
-  onlineStatusMessage: undefined,
-  setOnlineStatusMessage: () => undefined
+// 'get' and 'set' contexts are separated so 'setter' consumers that don't
+// actually need the value don't have to rerender when the value changes:
+const OnlineStatusMessageValueContext = /*#__PURE__*/React.createContext(undefined);
+const SetOnlineStatusMessageContext = /*#__PURE__*/React.createContext(() => undefined);
+export const OnlineStatusMessageProvider = (_ref) => {
+  let {
+    children
+  } = _ref;
+  const [onlineStatusMessage, setOnlineStatusMessage] = useState(); // note: not undefined
+
+  return /*#__PURE__*/React.createElement(OnlineStatusMessageValueContext.Provider, {
+    value: onlineStatusMessage
+  }, /*#__PURE__*/React.createElement(SetOnlineStatusMessageContext.Provider, {
+    value: setOnlineStatusMessage
+  }, children));
+};
+export const useOnlineStatusMessageValue = () => {
+  return useContext(OnlineStatusMessageValueContext);
 };
-const OnlineStatusMessageContext = /*#__PURE__*/React.createContext(defaultApi);
+export const useSetOnlineStatusMessage = () => {
+  return useContext(SetOnlineStatusMessageContext);
+}; // combination of both getter and setter (also provides backward compatability)
+
 export const useOnlineStatusMessage = () => {
-  const {
-    onlineStatusMessage,
-    setOnlineStatusMessage
-  } = useContext(OnlineStatusMessageContext);
+  const onlineStatusMessage = useOnlineStatusMessageValue();
+  const setOnlineStatusMessage = useSetOnlineStatusMessage();
   return {
     onlineStatusMessage,
     setOnlineStatusMessage
   };
-};
-export const OnlineStatusMessageProvider = (_ref) => {
-  let {
-    children
-  } = _ref;
-  const [onlineStatusMessage, setOnlineStatusMessage] = useState();
-  return /*#__PURE__*/React.createElement(OnlineStatusMessageContext.Provider, {
-    value: {
-      onlineStatusMessage,
-      setOnlineStatusMessage
-    }
-  }, children);
 };

package/build/types/index.d.ts

@@ -2,6 +2,6 @@ export { OfflineProvider } from './lib/offline-provider';
 export { CacheableSection, useCacheableSection } from './lib/cacheable-section';
 export { useCachedSections } from './lib/cacheable-section-state';
 export { useNetworkStatus as useOnlineStatus } from './lib/network-status';
-export { useOnlineStatusMessage } from './lib/online-status-message';
+export { useOnlineStatusMessage, useSetOnlineStatusMessage, useOnlineStatusMessageValue, } from './lib/online-status-message';
 export { clearSensitiveCaches } from './lib/clear-sensitive-caches';
 export { useDhis2ConnectionStatus } from './lib/dhis2-connection-status';

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

@@ -1,6 +1,12 @@
-import { ReactElement, ReactNode } from 'react';
-import { OnlineStatusMessageContextAPI } from '../types';
-export declare const useOnlineStatusMessage: () => OnlineStatusMessageContextAPI;
+import React, { ReactElement, ReactNode } from 'react';
+declare type SetOnlineStatusMessage = (message: ReactNode) => void;
 export declare const OnlineStatusMessageProvider: ({ children, }: {
     children: ReactNode;
 }) => ReactElement;
+export declare const useOnlineStatusMessageValue: () => React.ReactNode;
+export declare const useSetOnlineStatusMessage: () => SetOnlineStatusMessage;
+export declare const useOnlineStatusMessage: () => {
+    onlineStatusMessage: React.ReactNode;
+    setOnlineStatusMessage: SetOnlineStatusMessage;
+};
+export {};

package/build/types/types.d.ts

@@ -1,4 +1,3 @@
-import { ReactNode } from 'react';
 export declare type RecordingState = 'default' | 'pending' | 'error' | 'recording';
 export interface GlobalStateStoreMutation {
     (state: any): any;
@@ -44,8 +43,4 @@ 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.10.0-alpha.6",
+    "version": "3.10.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-config": "3.10.0-alpha.6",
+        "@dhis2/app-service-config": "3.10.1",
         "prop-types": "^15.7.2",
         "react": "^16.8.6",
         "react-dom": "^16.8.6"