@webority/mobile-core 0.0.26 → 0.0.28

package/README.md

@@ -30,6 +30,7 @@ import { openDatabase } from '@webority/mobile-core/sqlite';
 import { downloadFile } from '@webority/mobile-core/download';
 import { shareFile } from '@webority/mobile-core/share';
 import { initPush, enablePush, usePush } from '@webority/mobile-core/push';
+import { definePushActionTask } from '@webority/mobile-core/push/task';
 import { compressImage } from '@webority/mobile-core/compressor';
 ```
 
@@ -43,7 +44,74 @@ the native token (`Fcm` on Android, `Apns` on iOS) and the bundle id to `registe
 re-registers when the token changes; `disablePush` calls `unregister`. `onOpen` receives the
 tapped notification's data as strings, including the tap that launched the app. `usePush` gives a
 settings switch its `status` and `enabled`. The library does not remember the switch: an app that
-keeps push on calls `enablePush` at each start.
+keeps push on calls `enablePush` at each start. `setBadgeCount(count)` sets the app icon badge.
+
+### Notification buttons
+
+A push names a category; the category's buttons are registered on the phone. Register them at
+every start, with the same ids on both platforms:
+
+```ts
+import { setCategories, notifyLocal } from '@webority/mobile-core/push';
+
+await setCategories([
+  {
+    id: 'approval',
+    actions: [
+      { id: 'approve', title: 'Approve', opensApp: false },
+      { id: 'reject', title: 'Reject', destructive: true }
+    ]
+  },
+  {
+    id: 'reply',
+    actions: [
+      {
+        id: 'reply',
+        title: 'Reply',
+        opensApp: false,
+        textInput: { submitTitle: 'Send', placeholder: 'Write a reply' }
+      }
+    ]
+  }
+]);
+```
+
+`opensApp` defaults to true; `destructive` and `authenticationRequired` (unlock first) are iOS
+only. A button tap arrives as `{ actionId, userText, data, notificationId }`: `userText` is the
+reply text, `data` the push data as strings, `notificationId` the notification's identifier on
+the phone. A plain tap still goes to `onOpen`; a button tap with no handler opens like a plain tap.
+
+To receive button taps in every app state, the killed app included, call `definePushActionTask`
+once at module scope in the entry file, before the root component registers. It needs
+`expo-task-manager`, an optional peer (`npx expo install expo-task-manager`), so it lives on its
+own path:
+
+```js
+// index.js
+import { definePushActionTask } from '@webority/mobile-core/push/task';
+import { notifyLocal } from '@webority/mobile-core/push';
+
+definePushActionTask(async ({ actionId, userText, data }) => {
+  try {
+    await settle(actionId, userText, data);
+  } catch {
+    await notifyLocal({ title: 'Could not approve', body: 'Open the app to try again.' });
+  }
+});
+```
+
+The handler's promise is awaited, so its request can finish before the background work ends.
+`onAction(handler)` from `/push` sets the same handler for taps while JavaScript is running and
+returns a function that removes it. A response reported twice within ten seconds (the launch read,
+the listener and the Android task can each report it) runs once.
+
+- **Android:** the background notification task runs the handler for a button tap on a
+  backgrounded or killed app. Buttons appear only on notifications expo-notifications draws (for
+  example `notifyLocal`). An app that draws its own notifications natively from data-only pushes
+  must build each button's intent with expo's `NotificationsService.createNotificationResponseIntent`,
+  so the tap reaches this handler.
+- **iOS:** a button with `opensApp: false` launches the app in the background; the response
+  reaches the listener `definePushActionTask` sets up. The task is not registered on iOS.
 
 Storage and network status stay on the main barrel but load no package on their own. Wire them at
 startup with `setStorageImplementation` and `setNetworkStatusImplementation` if you want them.

package/lib/commonjs/api/retry.js

@@ -16,10 +16,26 @@ exports.isRetryableStatus = exports.attachRetry = void 0;
  */
 const isRetryableStatus = status => typeof status === 'number' && (status === 429 || status >= 500 && status <= 599);
 exports.isRetryableStatus = isRetryableStatus;
+const IDEMPOTENT_METHODS = new Set(['get', 'head', 'options', 'put', 'delete']);
+
+/**
+ * The same reasoning reaches status codes on a write. A 500 on a POST or PATCH
+ * can follow a partial commit, so replaying it can duplicate the record; only
+ * 429 and 503 say the server refused the request before doing the work. A
+ * request that knows its write is safe to repeat passes its own `shouldRetry`.
+ */
+const isRetryableFailure = error => {
+  const status = error.response?.status;
+  if (!isRetryableStatus(status)) {
+    return false;
+  }
+  const method = (error.config?.method ?? 'get').toLowerCase();
+  return IDEMPOTENT_METHODS.has(method) || status === 429 || status === 503;
+};
 const DEFAULT_POLICY = {
   retries: 3,
   retryDelayMs: attempt => attempt <= 1 ? 0 : 2 ** attempt * 1000,
-  shouldRetry: error => isRetryableStatus(error.response?.status),
+  shouldRetry: isRetryableFailure,
   onRetry: () => undefined
 };
 const waitOrAbort = (delay, signal) => new Promise(resolve => {

package/lib/commonjs/api/userClient.js

@@ -157,7 +157,7 @@ userClient.interceptors.request.use(async config => {
   // Reject before any network call when the device is known to be offline.
   // Unknown connectivity (netinfo not installed, or undetermined) is treated
   // as online — never block a request on an unavailable probe.
-  const network = await (0, _networkStatus.getNetworkStatus)();
+  const network = await (0, _networkStatus.getLastKnownNetworkStatus)();
   if (network.isConnected === false) {
     _index2.Logger.warn(`Request blocked: device is offline. URL: ${config.url}`);
     return Promise.reject(new RequestOfflineError());

package/lib/commonjs/auth/authStore.js

@@ -87,6 +87,24 @@ const expoSecureStoreBackend = {
   }
 };
 const resolveBackend = () => backend ?? expoSecureStoreBackend;
+
+/**
+ * Every request reads the access token, and a secure-store read is a native
+ * keychain/keystore decrypt. Reads are therefore served from memory, written
+ * through by `storeToken` and dropped by `removeToken`. `generation` moves on
+ * every write, removal and backend swap, so a read that started before one of
+ * those cannot cache the value it saw.
+ */
+const memo = new Map();
+let generation = 0;
+const forget = key => {
+  generation += 1;
+  if (key === undefined) {
+    memo.clear();
+  } else {
+    memo.delete(key);
+  }
+};
 const requireBackend = op => {
   const b = resolveBackend();
   if (!b) {
@@ -104,6 +122,7 @@ const requireBackend = op => {
  */
 const setKeychainImplementation = impl => {
   backend = impl;
+  forget();
 };
 
 /**
@@ -114,6 +133,7 @@ const storeToken = async (key, token, expiry) => {
   // Never log the token or expiry values: Logger forwards to whatever remote
   // sink the app wired (Crashlytics/Sentry), so a token here leaves the device.
   _index.Logger.info(`Storing token for key: ${key}`);
+  forget(key);
   try {
     const data = JSON.stringify({
       token,
@@ -122,8 +142,14 @@ const storeToken = async (key, token, expiry) => {
     await requireBackend('store a token').setGenericPassword('token', data, {
       service: key
     });
+    forget(key);
+    memo.set(key, {
+      token,
+      expiry
+    });
     _index.Logger.info(`Token stored successfully for key: ${key}`);
   } catch (error) {
+    forget(key);
     // Log AND rethrow. Swallowing this told the caller the token was persisted
     // when it was not, so an app would show a signed-in user holding a token
     // that never reached the keychain — the session then dies at the next
@@ -162,6 +188,10 @@ const parseTokenData = credentials => {
  * Retrieve token and check if expired.
  */
 const getToken = async key => {
+  if (memo.has(key)) {
+    return memo.get(key) ?? null;
+  }
+  const seen = generation;
   try {
     const credentials = await requireBackend('read a token').getGenericPassword({
       service: key
@@ -170,24 +200,24 @@ const getToken = async key => {
     // token, and every authenticated request, image and download asks for one.
     // Warning here put three info lines and a warning into the log, and into the
     // remote crash sink, on every one of those calls.
-    if (!credentials) {
-      return null;
+    let value = null;
+    if (credentials) {
+      const parsedData = parseTokenData(credentials);
+      if (parsedData) {
+        value = {
+          token: parsedData.token,
+          expiry: parsedData.expiry
+        };
+      } else {
+        // Something IS stored and it is not a token. That is corruption worth
+        // hearing about, and it is a different event from having no token.
+        _index.Logger.warn(`Stored credentials for key "${key}" are not a valid token; ignoring them.`);
+      }
     }
-    const parsedData = parseTokenData(credentials);
-    if (!parsedData) {
-      // Something IS stored and it is not a token. That is corruption worth
-      // hearing about, and it is a different event from having no token.
-      _index.Logger.warn(`Stored credentials for key "${key}" are not a valid token; ignoring them.`);
-      return null;
+    if (seen === generation) {
+      memo.set(key, value);
     }
-    const {
-      token,
-      expiry
-    } = parsedData;
-    return {
-      token,
-      expiry
-    };
+    return value;
   } catch (error) {
     const message = error instanceof Error ? error.message : String(error);
     // Both spellings matter. Android throws "Key permanently invalidated" when
@@ -211,6 +241,7 @@ const getToken = async key => {
  */
 exports.getToken = getToken;
 const removeToken = async key => {
+  forget(key);
   try {
     await requireBackend('remove a token').resetGenericPassword({
       service: key
@@ -226,6 +257,8 @@ const removeToken = async key => {
       return;
     }
     _index.Logger.error(`Failed to remove token for key: ${key}`, error);
+  } finally {
+    forget(key);
   }
 };
 exports.removeToken = removeToken;

package/lib/commonjs/config/index.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getConfig = void 0;
+exports.getConfig = exports.DEFAULT_LOG_LEVEL = void 0;
 exports.getConfigValue = getConfigValue;
 exports.setConfig = exports.resetConfig = void 0;
 /**
@@ -11,10 +11,16 @@ exports.setConfig = exports.resetConfig = void 0;
  * Provides a flexible way to inject configuration without hard dependencies
  */
 
+/**
+ * Info lines (each token refresh, each unauthorised URL) reach the device log
+ * and any remote sink, so a release build that sets nothing logs warnings and
+ * errors only.
+ */
+const DEFAULT_LOG_LEVEL = exports.DEFAULT_LOG_LEVEL = __DEV__ ? 'info' : 'warn';
 const DEFAULT_CONFIG = {
   baseUrl: null,
   loggingEnabled: true,
-  logLevel: 'info',
+  logLevel: DEFAULT_LOG_LEVEL,
   environment: 'Development',
   country: 'in',
   appId: null,

package/lib/commonjs/formatters/currency.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.formatCurrency = void 0;
+var _intlCache = require("./intlCache.js");
 const hasIntlNumber = () => typeof Intl !== 'undefined' && typeof Intl.NumberFormat === 'function';
 const indianGroupingFallback = (n, fractionDigits) => {
   // Indian numbering: 1,23,45,678.90 (last 3 digits, then groups of 2).
@@ -41,7 +42,7 @@ const formatCurrency = (amount, options = {}) => {
   const minFrac = minimumFractionDigits ?? (Number.isInteger(amount) ? 0 : 2);
   if (hasIntlNumber()) {
     try {
-      const formatted = new Intl.NumberFormat(locale, {
+      const formatted = (0, _intlCache.numberFormat)(locale, {
         style: 'currency',
         currency,
         minimumFractionDigits: minFrac,

package/lib/commonjs/formatters/date.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.formatTime = exports.formatRelativeTime = exports.formatDateTime = exports.formatDate = void 0;
+var _intlCache = require("./intlCache.js");
 const toDate = value => {
   if (value instanceof Date) {
     return Number.isNaN(value.getTime()) ? null : value;
@@ -52,7 +53,7 @@ const formatDate = (value, style = 'medium', locale = 'en-IN') => {
   }
   if (hasIntl()) {
     try {
-      return new Intl.DateTimeFormat(locale, {
+      return (0, _intlCache.dateTimeFormat)(locale, {
         dateStyle: style
       }).format(d);
     } catch {
@@ -73,7 +74,7 @@ const formatTime = (value, style = 'short', locale = 'en-IN') => {
   }
   if (hasIntl()) {
     try {
-      return new Intl.DateTimeFormat(locale, {
+      return (0, _intlCache.dateTimeFormat)(locale, {
         timeStyle: style
       }).format(d);
     } catch {
@@ -94,7 +95,7 @@ const formatDateTime = (value, dateStyle = 'medium', timeStyle = 'short', locale
   }
   if (hasIntl()) {
     try {
-      return new Intl.DateTimeFormat(locale, {
+      return (0, _intlCache.dateTimeFormat)(locale, {
         dateStyle,
         timeStyle
       }).format(d);
@@ -152,9 +153,7 @@ const formatRelativeTime = (value, base = new Date(), locale = 'en-IN') => {
   const Rtf = hasIntl() ? Intl.RelativeTimeFormat : undefined;
   if (typeof Rtf === 'function') {
     try {
-      return new Rtf(locale, {
-        numeric: 'auto'
-      }).format(amount, unit);
+      return (0, _intlCache.relativeTimeFormat)(Rtf, locale).format(amount, unit);
     } catch {
       /* fall through */
     }

package/lib/commonjs/formatters/dateMath.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.startOfDay = exports.isSameDay = exports.isDateBefore = exports.isDateAfter = exports.formatTimeInZone = exports.formatTimeInWindowsZone = exports.formatTime12h = exports.formatDatePattern = exports.formatDateISO = exports.formatDateDDMMMYYYY = exports.diffMs = exports.addDays = void 0;
+var _intlCache = require("./intlCache.js");
 var _windowsToIanaTable = require("./windowsToIanaTable.js");
 const toDate = value => {
   if (value instanceof Date) {
@@ -277,7 +278,7 @@ const formatTimeInZone = (value, ianaTimeZone) => {
     // answer available, not a genuine timezone conversion.
     return formatTime12h(d);
   }
-  const parts = new Intl.DateTimeFormat('en-US', {
+  const parts = (0, _intlCache.dateTimeFormat)('en-US', {
     timeZone: ianaTimeZone,
     hour: 'numeric',
     minute: '2-digit',

package/lib/commonjs/formatters/intlCache.js

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.relativeTimeFormat = exports.numberFormat = exports.dateTimeFormat = void 0;
+/**
+ * Building an Intl formatter costs far more than using one (and on Hermes for
+ * Android it goes through ICU over JNI), while list rows and slider frames call
+ * the formatters many times with the same arguments. Formatters are therefore
+ * built once per locale and options. The limit only guards against unbounded
+ * input such as arbitrary time zones; real apps use a handful of keys.
+ */
+const LIMIT = 100;
+const cached = (cache, key, create) => {
+  let formatter = cache.get(key);
+  if (formatter === undefined) {
+    formatter = create();
+    if (cache.size >= LIMIT) {
+      cache.clear();
+    }
+    cache.set(key, formatter);
+  }
+  return formatter;
+};
+const numberFormats = new Map();
+const dateTimeFormats = new Map();
+const relativeTimeFormats = new Map();
+const numberFormat = (locale, options = {}) => cached(numberFormats, `${locale}|${JSON.stringify(options)}`, () => new Intl.NumberFormat(locale, options));
+exports.numberFormat = numberFormat;
+const dateTimeFormat = (locale, options) => cached(dateTimeFormats, `${locale}|${JSON.stringify(options)}`, () => new Intl.DateTimeFormat(locale, options));
+exports.dateTimeFormat = dateTimeFormat;
+const relativeTimeFormat = (RelativeTimeFormat, locale) => cached(relativeTimeFormats, locale, () => new RelativeTimeFormat(locale, {
+  numeric: 'auto'
+}));
+exports.relativeTimeFormat = relativeTimeFormat;
+//# sourceMappingURL=intlCache.js.map

package/lib/commonjs/formatters/number.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.formatPercent = exports.formatNumber = exports.formatCompactNumber = void 0;
+var _intlCache = require("./intlCache.js");
 const hasIntlNumber = () => typeof Intl !== 'undefined' && typeof Intl.NumberFormat === 'function';
 
 /**
@@ -20,7 +21,7 @@ const formatNumber = (value, fractionDigits, locale = 'en-IN') => {
         opts.minimumFractionDigits = fractionDigits;
         opts.maximumFractionDigits = fractionDigits;
       }
-      return new Intl.NumberFormat(locale, opts).format(value);
+      return (0, _intlCache.numberFormat)(locale, opts).format(value);
     } catch {
       /* fall through */
     }
@@ -40,7 +41,7 @@ const formatPercent = (value, fractionDigits = 0, asRatio = true, locale = 'en-I
   const ratio = asRatio ? value : value / 100;
   if (hasIntlNumber()) {
     try {
-      return new Intl.NumberFormat(locale, {
+      return (0, _intlCache.numberFormat)(locale, {
         style: 'percent',
         minimumFractionDigits: fractionDigits,
         maximumFractionDigits: fractionDigits
@@ -63,7 +64,7 @@ const formatCompactNumber = (value, locale = 'en-IN') => {
   }
   if (hasIntlNumber()) {
     try {
-      return new Intl.NumberFormat(locale, {
+      return (0, _intlCache.numberFormat)(locale, {
         notation: 'compact',
         maximumFractionDigits: 1
       }).format(value);

package/lib/commonjs/index.js

@@ -117,6 +117,12 @@ Object.defineProperty(exports, "diffMs", {
     return _index3.diffMs;
   }
 });
+Object.defineProperty(exports, "encodeBase64", {
+  enumerable: true,
+  get: function () {
+    return _base.encodeBase64;
+  }
+});
 Object.defineProperty(exports, "formatCompactNumber", {
   enumerable: true,
   get: function () {
@@ -630,6 +636,7 @@ var _initUserAuth = require("./initUserAuth.js");
 var _index4 = require("./logger/index.js");
 var _index5 = require("./network/index.js");
 var _index6 = require("./storage/index.js");
+var _base = require("./utils/base64.js");
 var _index7 = require("./validators/index.js");
 var _index8 = require("./versionCheck/index.js");
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }

package/lib/commonjs/initSDK.js

@@ -39,7 +39,7 @@ const initWebority = config => {
   (0, _index.setConfig)({
     baseUrl: config.baseUrl,
     loggingEnabled: config.loggingEnabled ?? true,
-    logLevel: config.logLevel || 'info',
+    logLevel: config.logLevel || _index.DEFAULT_LOG_LEVEL,
     environment: config.environment || 'Development',
     country: (config.country || 'in').toLowerCase(),
     appId: config.appId ?? null,

package/lib/commonjs/network/networkStatus.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.useNetworkStatus = exports.setNetworkStatusImplementation = exports.getNetworkStatus = exports.addNetworkStatusListener = void 0;
+exports.useNetworkStatus = exports.setNetworkStatusImplementation = exports.getNetworkStatus = exports.getLastKnownNetworkStatus = exports.addNetworkStatusListener = void 0;
 var ExpoNetwork = _interopRequireWildcard(require("expo-network"));
 var _react = require("react");
 var _index = require("../logger/index.js");
@@ -23,6 +23,13 @@ const DEFAULT_STATUS = {
  * One backend also means one behaviour, rather than each app choosing.
  */
 let override = null;
+let lastKnown = null;
+let stopFollowing = null;
+const stopFollowingNetwork = () => {
+  stopFollowing?.();
+  stopFollowing = null;
+  lastKnown = null;
+};
 
 /**
  * Replace the backend. Intended for TESTS and for the showcase, which uses it
@@ -31,6 +38,7 @@ let override = null;
  */
 const setNetworkStatusImplementation = impl => {
   override = impl;
+  stopFollowingNetwork();
 };
 exports.setNetworkStatusImplementation = setNetworkStatusImplementation;
 const resolveNetInfo = () => override ?? expoNetworkBackend;
@@ -103,11 +111,41 @@ const addNetworkStatusListener = listener => {
   return ni.addEventListener(state => listener(normalize(state)));
 };
 
+/**
+ * The connectivity the HTTP client checks before every request. One listener,
+ * attached on first use, keeps it current, so a request costs no native probe:
+ * one probe seeds the value and the listener's events replace it.
+ */
+exports.addNetworkStatusListener = addNetworkStatusListener;
+const getLastKnownNetworkStatus = async () => {
+  if (!stopFollowing) {
+    try {
+      stopFollowing = addNetworkStatusListener(status => {
+        lastKnown = status;
+      });
+    } catch (error) {
+      _index.Logger.error('[network] could not follow network changes', error);
+      return getNetworkStatus();
+    }
+  }
+  if (lastKnown) {
+    return lastKnown;
+  }
+  const following = stopFollowing;
+  const probed = await getNetworkStatus();
+  if (stopFollowing !== following) {
+    return probed;
+  }
+  // An event that arrived during the probe is newer than the probe.
+  lastKnown ??= probed;
+  return lastKnown;
+};
+
 /**
  * React hook that returns the current network status and re-renders on change.
  * Reports an optimistic online default when NetInfo is not installed.
  */
-exports.addNetworkStatusListener = addNetworkStatusListener;
+exports.getLastKnownNetworkStatus = getLastKnownNetworkStatus;
 const useNetworkStatus = () => {
   const [status, setStatus] = (0, _react.useState)(DEFAULT_STATUS);
   (0, _react.useEffect)(() => {

package/lib/commonjs/push/index.js

@@ -21,12 +21,30 @@ Object.defineProperty(exports, "initPush", {
     return _push.initPush;
   }
 });
+Object.defineProperty(exports, "notifyLocal", {
+  enumerable: true,
+  get: function () {
+    return _push.notifyLocal;
+  }
+});
+Object.defineProperty(exports, "onAction", {
+  enumerable: true,
+  get: function () {
+    return _push.onAction;
+  }
+});
 Object.defineProperty(exports, "setBadgeCount", {
   enumerable: true,
   get: function () {
     return _push.setBadgeCount;
   }
 });
+Object.defineProperty(exports, "setCategories", {
+  enumerable: true,
+  get: function () {
+    return _push.setCategories;
+  }
+});
 Object.defineProperty(exports, "setPushImplementation", {
   enumerable: true,
   get: function () {