@webority/mobile-core 0.4.1 → 0.5.0

package/README.md

@@ -32,6 +32,7 @@ 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';
+import { initOtaUpdates, useOtaUpdates } from '@webority/mobile-core/updates';
 import { createApiBaseQuery, createAppApi, setupApiListeners } from '@webority/mobile-core/query';
 ```
 

package/lib/commonjs/updates/index.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"DEFAULT_MIN_CHECK_INTERVAL_MS",{enumerable:!0,get:function(){return _updates.DEFAULT_MIN_CHECK_INTERVAL_MS}}),Object.defineProperty(exports,"applyOtaUpdate",{enumerable:!0,get:function(){return _updates.applyOtaUpdate}}),Object.defineProperty(exports,"checkForOtaUpdate",{enumerable:!0,get:function(){return _updates.checkForOtaUpdate}}),Object.defineProperty(exports,"initOtaUpdates",{enumerable:!0,get:function(){return _updates.initOtaUpdates}}),Object.defineProperty(exports,"normalizeAppIdentity",{enumerable:!0,get:function(){return _updates.normalizeAppIdentity}}),Object.defineProperty(exports,"setOtaUpdatesImplementation",{enumerable:!0,get:function(){return _updates.setOtaUpdatesImplementation}}),Object.defineProperty(exports,"stopOtaUpdates",{enumerable:!0,get:function(){return _updates.stopOtaUpdates}}),Object.defineProperty(exports,"useOtaUpdates",{enumerable:!0,get:function(){return _updates.useOtaUpdates}});var _updates=require("./updates.js");

package/lib/commonjs/updates/updates.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.useOtaUpdates=exports.stopOtaUpdates=exports.setOtaUpdatesImplementation=exports.normalizeAppIdentity=exports.initOtaUpdates=exports.checkForOtaUpdate=exports.applyOtaUpdate=exports.DEFAULT_MIN_CHECK_INTERVAL_MS=void 0;var _react=require("react"),_reactNative=require("react-native"),_index=require("../config/index.js"),_index2=require("../logger/index.js"),_index3=require("../storage/index.js");const PREFIX="[@webority/mobile-core] OTA updates:",REPORTED_KEY="@webority/ota/last-reported-update-id",ENV_IDENTITY_SUFFIXES=[".staging",".development"],DEFAULT_MIN_CHECK_INTERVAL_MS=exports.DEFAULT_MIN_CHECK_INTERVAL_MS=9e5,EVENT_TIMEOUT_MS=1e4;let resolved,override=null;const setOtaUpdatesImplementation=e=>{override=e};exports.setOtaUpdatesImplementation=setOtaUpdatesImplementation;const resolveUpdates=()=>{if(override)return override;if(void 0!==resolved)return resolved;try{resolved=require("expo-updates")}catch{resolved=null}return resolved},INITIAL_STATE={status:"unavailable",runningUpdateId:null,error:null,lastCheckedAt:null};let state=INITIAL_STATE;const subscribers=new Set,setState=e=>{state={...state,...e};for(const e of subscribers)e()};let config=null,stateSubscription=null,appStateSubscription=null,checking=null,lastCheckStartedAt=0,lastReportedError=null;const messageOf=e=>e instanceof Error?e.message:String(e),normalizeAppIdentity=e=>{const t=String(e??"").trim().toLowerCase(),a=ENV_IDENTITY_SUFFIXES.find(e=>t.endsWith(e));return a?t.slice(0,-a.length):t};exports.normalizeAppIdentity=normalizeAppIdentity;const ownIdentity=()=>config?.appIdentifier??(0,_index.getConfigValue)("appId",null)??null,identityMismatch=e=>{const t=e?.extra?.webority?.appIdentifier;if(!t)return null;const a=ownIdentity();return a&&normalizeAppIdentity(t)===normalizeAppIdentity(a)?null:`identity mismatch: the update is for '${t}' but this app is '${a??"unset"}'`},postEvent=async(e,t,a)=>{const r=config?.serverUrl;if(!r||!e)return;const s=new AbortController,n=setTimeout(()=>s.abort(),1e4);try{await fetch(`${r.replace(/\/+$/,"")}/ota/updates/${encodeURIComponent(e)}/events`,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify({status:t,platform:_reactNative.Platform.OS,runtimeVersion:resolveUpdates()?.runtimeVersion??null,message:a}),signal:s.signal})}catch(e){_index2.Logger.info(`${PREFIX} the ${t} event was not reported: ${messageOf(e)}`)}finally{clearTimeout(n)}},reportError=(e,t)=>{setState({status:"error",error:t});const a=`${e??""}|${t}`;a!==lastReportedError&&(lastReportedError=a,_index2.Logger.error(`${PREFIX} ${t}`),postEvent(e,"error",t))},reportRunningUpdate=async e=>{if(e.isEmbeddedLaunch||!e.updateId)return;const t=identityMismatch(e.manifest);t?reportError(e.updateId,t):await _index3.Storage.getItem(REPORTED_KEY)!==e.updateId&&(await postEvent(e.updateId,"success"),await _index3.Storage.setItem(REPORTED_KEY,e.updateId),_index2.Logger.info(`${PREFIX} running update ${e.updateId}`))},onStateChange=e=>{const t=e.downloadError??e.checkError;if(t){const a=e.latestManifest?.id??resolveUpdates()?.updateId;return void reportError(a,t.message)}e.isChecking?setState({status:"checking"}):e.isDownloading?setState({status:"downloading"}):e.isUpdatePending&&setState({status:"ready",error:null})},checkForOtaUpdate=()=>{const e=resolveUpdates();if(!config||!e?.isEnabled)return Promise.resolve("unavailable");if(checking)return checking;lastCheckStartedAt=Date.now();return checking=(async()=>{try{setState({status:"checking"});const t=await e.checkForUpdateAsync();if(t.isAvailable){const e=identityMismatch(t.manifest);if(e)return reportError(t.manifest?.id,e),"error"}return t.isAvailable||t.isRollBackToEmbedded?(setState({status:"downloading"}),await e.fetchUpdateAsync(),setState({status:"ready",error:null}),"ready"):(setState({status:"ready"===state.status?"ready":"idle",error:null}),state.status)}catch(t){return reportError(e.updateId,messageOf(t)),"error"}finally{setState({lastCheckedAt:Date.now()}),checking=null}})(),checking};exports.checkForOtaUpdate=checkForOtaUpdate;const onAppStateChange=e=>{if("active"!==e||!1===config?.checkOnForeground)return;const t=config?.minCheckIntervalMs??DEFAULT_MIN_CHECK_INTERVAL_MS;Date.now()-lastCheckStartedAt<t||checkForOtaUpdate()},initOtaUpdates=e=>{const t=null===config;if(config=e,!t)return;const a=resolveUpdates();if(!a?.isEnabled)return void setState({status:"unavailable"});setState({status:"idle",runningUpdateId:a.isEmbeddedLaunch?null:a.updateId}),reportRunningUpdate(a).catch(e=>{_index2.Logger.info(`${PREFIX} start-up report failed: ${messageOf(e)}`)}),"function"==typeof a.addUpdatesStateChangeListener&&(stateSubscription=a.addUpdatesStateChangeListener(e=>onStateChange(e.context))),appStateSubscription=_reactNative.AppState.addEventListener("change",onAppStateChange);"ON_LOAD"===a.checkAutomatically||"WIFI_ONLY"===a.checkAutomatically||checkForOtaUpdate()};exports.initOtaUpdates=initOtaUpdates;const applyOtaUpdate=async()=>{const e=resolveUpdates();e?.isEnabled&&"ready"===state.status&&await e.reloadAsync()};exports.applyOtaUpdate=applyOtaUpdate;const stopOtaUpdates=()=>{stateSubscription?.remove(),appStateSubscription?.remove(),stateSubscription=null,appStateSubscription=null,config=null,checking=null,lastCheckStartedAt=0,lastReportedError=null,resolved=void 0,setState(INITIAL_STATE)};exports.stopOtaUpdates=stopOtaUpdates;const subscribe=e=>(subscribers.add(e),()=>{subscribers.delete(e)}),getSnapshot=()=>state,useOtaUpdates=()=>({...(0,_react.useSyncExternalStore)(subscribe,getSnapshot,getSnapshot),check:checkForOtaUpdate,apply:applyOtaUpdate});exports.useOtaUpdates=useOtaUpdates;

package/lib/module/updates/index.js

@@ -0,0 +1 @@
+"use strict";export{applyOtaUpdate,checkForOtaUpdate,DEFAULT_MIN_CHECK_INTERVAL_MS,initOtaUpdates,normalizeAppIdentity,setOtaUpdatesImplementation,stopOtaUpdates,useOtaUpdates}from"./updates.js";

package/lib/module/updates/updates.js

@@ -0,0 +1 @@
+"use strict";import{useSyncExternalStore}from"react";import{AppState,Platform}from"react-native";import{getConfigValue}from"../config/index.js";import{Logger}from"../logger/index.js";import{Storage}from"../storage/index.js";const PREFIX="[@webority/mobile-core] OTA updates:",REPORTED_KEY="@webority/ota/last-reported-update-id",ENV_IDENTITY_SUFFIXES=[".staging",".development"];export const DEFAULT_MIN_CHECK_INTERVAL_MS=9e5;const EVENT_TIMEOUT_MS=1e4;let resolved,override=null;export const setOtaUpdatesImplementation=t=>{override=t};const resolveUpdates=()=>{if(override)return override;if(void 0!==resolved)return resolved;try{resolved=require("expo-updates")}catch{resolved=null}return resolved},INITIAL_STATE={status:"unavailable",runningUpdateId:null,error:null,lastCheckedAt:null};let state=INITIAL_STATE;const subscribers=new Set,setState=t=>{state={...state,...t};for(const t of subscribers)t()};let config=null,stateSubscription=null,appStateSubscription=null,checking=null,lastCheckStartedAt=0,lastReportedError=null;const messageOf=t=>t instanceof Error?t.message:String(t);export const normalizeAppIdentity=t=>{const e=String(t??"").trim().toLowerCase(),r=ENV_IDENTITY_SUFFIXES.find(t=>e.endsWith(t));return r?e.slice(0,-r.length):e};const ownIdentity=()=>config?.appIdentifier??getConfigValue("appId",null)??null,identityMismatch=t=>{const e=t?.extra?.webority?.appIdentifier;if(!e)return null;const r=ownIdentity();return r&&normalizeAppIdentity(e)===normalizeAppIdentity(r)?null:`identity mismatch: the update is for '${e}' but this app is '${r??"unset"}'`},postEvent=async(t,e,r)=>{const a=config?.serverUrl;if(!a||!t)return;const n=new AbortController,s=setTimeout(()=>n.abort(),1e4);try{await fetch(`${a.replace(/\/+$/,"")}/ota/updates/${encodeURIComponent(t)}/events`,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify({status:e,platform:Platform.OS,runtimeVersion:resolveUpdates()?.runtimeVersion??null,message:r}),signal:n.signal})}catch(t){Logger.info(`${PREFIX} the ${e} event was not reported: ${messageOf(t)}`)}finally{clearTimeout(s)}},reportError=(t,e)=>{setState({status:"error",error:e});const r=`${t??""}|${e}`;r!==lastReportedError&&(lastReportedError=r,Logger.error(`${PREFIX} ${e}`),postEvent(t,"error",e))},reportRunningUpdate=async t=>{if(t.isEmbeddedLaunch||!t.updateId)return;const e=identityMismatch(t.manifest);e?reportError(t.updateId,e):await Storage.getItem(REPORTED_KEY)!==t.updateId&&(await postEvent(t.updateId,"success"),await Storage.setItem(REPORTED_KEY,t.updateId),Logger.info(`${PREFIX} running update ${t.updateId}`))},onStateChange=t=>{const e=t.downloadError??t.checkError;if(e){const r=t.latestManifest?.id??resolveUpdates()?.updateId;return void reportError(r,e.message)}t.isChecking?setState({status:"checking"}):t.isDownloading?setState({status:"downloading"}):t.isUpdatePending&&setState({status:"ready",error:null})};export const checkForOtaUpdate=()=>{const t=resolveUpdates();if(!config||!t?.isEnabled)return Promise.resolve("unavailable");if(checking)return checking;lastCheckStartedAt=Date.now();return checking=(async()=>{try{setState({status:"checking"});const e=await t.checkForUpdateAsync();if(e.isAvailable){const t=identityMismatch(e.manifest);if(t)return reportError(e.manifest?.id,t),"error"}return e.isAvailable||e.isRollBackToEmbedded?(setState({status:"downloading"}),await t.fetchUpdateAsync(),setState({status:"ready",error:null}),"ready"):(setState({status:"ready"===state.status?"ready":"idle",error:null}),state.status)}catch(e){return reportError(t.updateId,messageOf(e)),"error"}finally{setState({lastCheckedAt:Date.now()}),checking=null}})(),checking};const onAppStateChange=t=>{if("active"!==t||!1===config?.checkOnForeground)return;const e=config?.minCheckIntervalMs??9e5;Date.now()-lastCheckStartedAt<e||checkForOtaUpdate()};export const initOtaUpdates=t=>{const e=null===config;if(config=t,!e)return;const r=resolveUpdates();if(!r?.isEnabled)return void setState({status:"unavailable"});setState({status:"idle",runningUpdateId:r.isEmbeddedLaunch?null:r.updateId}),reportRunningUpdate(r).catch(t=>{Logger.info(`${PREFIX} start-up report failed: ${messageOf(t)}`)}),"function"==typeof r.addUpdatesStateChangeListener&&(stateSubscription=r.addUpdatesStateChangeListener(t=>onStateChange(t.context))),appStateSubscription=AppState.addEventListener("change",onAppStateChange);"ON_LOAD"===r.checkAutomatically||"WIFI_ONLY"===r.checkAutomatically||checkForOtaUpdate()};export const applyOtaUpdate=async()=>{const t=resolveUpdates();t?.isEnabled&&"ready"===state.status&&await t.reloadAsync()};export const stopOtaUpdates=()=>{stateSubscription?.remove(),appStateSubscription?.remove(),stateSubscription=null,appStateSubscription=null,config=null,checking=null,lastCheckStartedAt=0,lastReportedError=null,resolved=void 0,setState(INITIAL_STATE)};const subscribe=t=>(subscribers.add(t),()=>{subscribers.delete(t)}),getSnapshot=()=>state;export const useOtaUpdates=()=>({...useSyncExternalStore(subscribe,getSnapshot,getSnapshot),check:checkForOtaUpdate,apply:applyOtaUpdate});

package/lib/typescript/commonjs/index.d.ts

@@ -12,6 +12,7 @@
  *   @webority/mobile-core/download     a filesystem module
  *   @webority/mobile-core/share        expo-sharing
  *   @webority/mobile-core/secureScreen expo-screen-capture
+ *   @webority/mobile-core/updates      expo-updates
  *   @webority/mobile-core/smsRetriever Android only, own TurboModule
  *   @webority/mobile-core/query        RTK Query base query and createApi preset
  *                                      (@reduxjs/toolkit and react-redux)

package/lib/typescript/commonjs/updates/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Over-the-air updates from the Webority OS update server through expo-updates. A separate entry
+ * point because it names expo-updates, an optional peer: Metro resolves every require reachable
+ * from an import, so keeping it off the main barrel lets an app without OTA skip the package.
+ */
+export type { OtaUpdatesConfig, OtaUpdatesState, OtaUpdatesStatus, UpdatesModuleLike } from './updates';
+export { applyOtaUpdate, checkForOtaUpdate, DEFAULT_MIN_CHECK_INTERVAL_MS, initOtaUpdates, normalizeAppIdentity, setOtaUpdatesImplementation, stopOtaUpdates, useOtaUpdates } from './updates';
+//# sourceMappingURL=index.d.ts.map

package/lib/typescript/commonjs/updates/updates.d.ts

@@ -0,0 +1,105 @@
+export declare const DEFAULT_MIN_CHECK_INTERVAL_MS: number;
+interface ManifestLike {
+    id?: string;
+    extra?: {
+        webority?: {
+            appIdentifier?: string | null;
+        } | null;
+    } | null;
+}
+interface StateContextLike {
+    isChecking?: boolean;
+    isDownloading?: boolean;
+    isUpdatePending?: boolean;
+    latestManifest?: ManifestLike;
+    downloadedManifest?: ManifestLike;
+    checkError?: Error;
+    downloadError?: Error;
+}
+/** The slice of expo-updates this module calls, so the optional peer stays untyped at build. */
+export interface UpdatesModuleLike {
+    isEnabled: boolean;
+    isEmbeddedLaunch: boolean;
+    updateId: string | null;
+    runtimeVersion: string | null;
+    checkAutomatically: string | null;
+    manifest: ManifestLike | null | undefined;
+    checkForUpdateAsync: () => Promise<{
+        isAvailable: boolean;
+        isRollBackToEmbedded: boolean;
+        manifest?: ManifestLike;
+    }>;
+    fetchUpdateAsync: () => Promise<{
+        isNew: boolean;
+        isRollBackToEmbedded: boolean;
+    }>;
+    reloadAsync: () => Promise<void>;
+    addUpdatesStateChangeListener?: (listener: (event: {
+        context: StateContextLike;
+    }) => void) => {
+        remove: () => void;
+    };
+}
+export interface OtaUpdatesConfig {
+    /**
+     * The update server's origin, from the app's compiled settings (`OTA_UPDATE_BASE_URL`). Update
+     * events are posted to `<serverUrl>/ota/updates/<updateId>/events`.
+     */
+    serverUrl: string;
+    /**
+     * The app's own identity, compared with the identity stamped into every served update. Defaults
+     * to `appId` from `setConfig`, the base package name / bundle id from the compiled settings.
+     */
+    appIdentifier?: string;
+    /** Check again each time the app returns to the foreground. Default true. */
+    checkOnForeground?: boolean;
+    /** The shortest gap between two checks this module starts, in milliseconds. Default 15 minutes. */
+    minCheckIntervalMs?: number;
+}
+/**
+ * `unavailable`: OTA is off in this build (a debug build, or expo-updates not installed).
+ * `ready`: an update is downloaded and applies on the next cold start, or at `applyOtaUpdate()`.
+ */
+export type OtaUpdatesStatus = 'unavailable' | 'idle' | 'checking' | 'downloading' | 'ready' | 'error';
+export interface OtaUpdatesState {
+    status: OtaUpdatesStatus;
+    /** The update now running; null for the bundle embedded in the store build. */
+    runningUpdateId: string | null;
+    /** The last check or download failure, or an identity mismatch; null after a clean check. */
+    error: string | null;
+    /** When this module last finished a check, in epoch milliseconds. */
+    lastCheckedAt: number | null;
+}
+/**
+ * Replace expo-updates. For tests and the showcase; pass `null` to restore the real module.
+ */
+export declare const setOtaUpdatesImplementation: (impl: UpdatesModuleLike | null) => void;
+/** Trims, lower-cases and strips one environment suffix, as the server does. */
+export declare const normalizeAppIdentity: (id: string | null | undefined) => string;
+/**
+ * Asks the server for a newer update and downloads it; it applies on the next cold start, or at
+ * `applyOtaUpdate()`. An update stamped for another app is refused before download. Resolves with
+ * the status the check ended in; a check already running is joined, not repeated.
+ */
+export declare const checkForOtaUpdate: () => Promise<OtaUpdatesStatus>;
+/**
+ * Starts OTA updates for this launch: reports the running update to the server (success once per
+ * update, or an error when it was built for another app), reports check and download failures,
+ * checks at launch unless expo-updates already does, and again on each return to the foreground.
+ * Call it once at start-up; a later call only replaces the config. A no-op where OTA is off.
+ */
+export declare const initOtaUpdates: (next: OtaUpdatesConfig) => void;
+/** Restarts the app on a downloaded update now, rather than at the next cold start. */
+export declare const applyOtaUpdate: () => Promise<void>;
+/** Removes the listeners and forgets the config, so `initOtaUpdates` starts over. For tests. */
+export declare const stopOtaUpdates: () => void;
+/**
+ * The update state for a screen that shows it, for example a "restart to update" banner when
+ * `status` is `ready`. Most apps show nothing and let the update apply on the next cold start.
+ */
+export declare const useOtaUpdates: () => OtaUpdatesState & {
+    check: () => Promise<OtaUpdatesStatus>;
+    apply: () => Promise<void>;
+};
+export {};
+//# sourceMappingURL=updates.d.ts.map

package/lib/typescript/module/index.d.ts

@@ -12,6 +12,7 @@
  *   @webority/mobile-core/download     a filesystem module
  *   @webority/mobile-core/share        expo-sharing
  *   @webority/mobile-core/secureScreen expo-screen-capture
+ *   @webority/mobile-core/updates      expo-updates
  *   @webority/mobile-core/smsRetriever Android only, own TurboModule
  *   @webority/mobile-core/query        RTK Query base query and createApi preset
  *                                      (@reduxjs/toolkit and react-redux)

package/lib/typescript/module/updates/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Over-the-air updates from the Webority OS update server through expo-updates. A separate entry
+ * point because it names expo-updates, an optional peer: Metro resolves every require reachable
+ * from an import, so keeping it off the main barrel lets an app without OTA skip the package.
+ */
+export type { OtaUpdatesConfig, OtaUpdatesState, OtaUpdatesStatus, UpdatesModuleLike } from './updates.js';
+export { applyOtaUpdate, checkForOtaUpdate, DEFAULT_MIN_CHECK_INTERVAL_MS, initOtaUpdates, normalizeAppIdentity, setOtaUpdatesImplementation, stopOtaUpdates, useOtaUpdates } from './updates.js';
+//# sourceMappingURL=index.d.ts.map

package/lib/typescript/module/updates/updates.d.ts

@@ -0,0 +1,105 @@
+export declare const DEFAULT_MIN_CHECK_INTERVAL_MS: number;
+interface ManifestLike {
+    id?: string;
+    extra?: {
+        webority?: {
+            appIdentifier?: string | null;
+        } | null;
+    } | null;
+}
+interface StateContextLike {
+    isChecking?: boolean;
+    isDownloading?: boolean;
+    isUpdatePending?: boolean;
+    latestManifest?: ManifestLike;
+    downloadedManifest?: ManifestLike;
+    checkError?: Error;
+    downloadError?: Error;
+}
+/** The slice of expo-updates this module calls, so the optional peer stays untyped at build. */
+export interface UpdatesModuleLike {
+    isEnabled: boolean;
+    isEmbeddedLaunch: boolean;
+    updateId: string | null;
+    runtimeVersion: string | null;
+    checkAutomatically: string | null;
+    manifest: ManifestLike | null | undefined;
+    checkForUpdateAsync: () => Promise<{
+        isAvailable: boolean;
+        isRollBackToEmbedded: boolean;
+        manifest?: ManifestLike;
+    }>;
+    fetchUpdateAsync: () => Promise<{
+        isNew: boolean;
+        isRollBackToEmbedded: boolean;
+    }>;
+    reloadAsync: () => Promise<void>;
+    addUpdatesStateChangeListener?: (listener: (event: {
+        context: StateContextLike;
+    }) => void) => {
+        remove: () => void;
+    };
+}
+export interface OtaUpdatesConfig {
+    /**
+     * The update server's origin, from the app's compiled settings (`OTA_UPDATE_BASE_URL`). Update
+     * events are posted to `<serverUrl>/ota/updates/<updateId>/events`.
+     */
+    serverUrl: string;
+    /**
+     * The app's own identity, compared with the identity stamped into every served update. Defaults
+     * to `appId` from `setConfig`, the base package name / bundle id from the compiled settings.
+     */
+    appIdentifier?: string;
+    /** Check again each time the app returns to the foreground. Default true. */
+    checkOnForeground?: boolean;
+    /** The shortest gap between two checks this module starts, in milliseconds. Default 15 minutes. */
+    minCheckIntervalMs?: number;
+}
+/**
+ * `unavailable`: OTA is off in this build (a debug build, or expo-updates not installed).
+ * `ready`: an update is downloaded and applies on the next cold start, or at `applyOtaUpdate()`.
+ */
+export type OtaUpdatesStatus = 'unavailable' | 'idle' | 'checking' | 'downloading' | 'ready' | 'error';
+export interface OtaUpdatesState {
+    status: OtaUpdatesStatus;
+    /** The update now running; null for the bundle embedded in the store build. */
+    runningUpdateId: string | null;
+    /** The last check or download failure, or an identity mismatch; null after a clean check. */
+    error: string | null;
+    /** When this module last finished a check, in epoch milliseconds. */
+    lastCheckedAt: number | null;
+}
+/**
+ * Replace expo-updates. For tests and the showcase; pass `null` to restore the real module.
+ */
+export declare const setOtaUpdatesImplementation: (impl: UpdatesModuleLike | null) => void;
+/** Trims, lower-cases and strips one environment suffix, as the server does. */
+export declare const normalizeAppIdentity: (id: string | null | undefined) => string;
+/**
+ * Asks the server for a newer update and downloads it; it applies on the next cold start, or at
+ * `applyOtaUpdate()`. An update stamped for another app is refused before download. Resolves with
+ * the status the check ended in; a check already running is joined, not repeated.
+ */
+export declare const checkForOtaUpdate: () => Promise<OtaUpdatesStatus>;
+/**
+ * Starts OTA updates for this launch: reports the running update to the server (success once per
+ * update, or an error when it was built for another app), reports check and download failures,
+ * checks at launch unless expo-updates already does, and again on each return to the foreground.
+ * Call it once at start-up; a later call only replaces the config. A no-op where OTA is off.
+ */
+export declare const initOtaUpdates: (next: OtaUpdatesConfig) => void;
+/** Restarts the app on a downloaded update now, rather than at the next cold start. */
+export declare const applyOtaUpdate: () => Promise<void>;
+/** Removes the listeners and forgets the config, so `initOtaUpdates` starts over. For tests. */
+export declare const stopOtaUpdates: () => void;
+/**
+ * The update state for a screen that shows it, for example a "restart to update" banner when
+ * `status` is `ready`. Most apps show nothing and let the update apply on the next cold start.
+ */
+export declare const useOtaUpdates: () => OtaUpdatesState & {
+    check: () => Promise<OtaUpdatesStatus>;
+    apply: () => Promise<void>;
+};
+export {};
+//# sourceMappingURL=updates.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@webority/mobile-core",
-  "version": "0.4.1",
-  "description": "Platform layer for Webority React Native apps: HTTP clients, auth/token storage, config, logging, formatters, validators, network status, permissions, storage and version checks. No UI.",
+  "version": "0.5.0",
+  "description": "Platform layer for Webority React Native apps: HTTP clients, auth/token storage, config, logging, formatters, validators, network status, permissions, storage, version checks and over-the-air updates. No UI.",
   "keywords": [
     "react-native",
     "auth",
@@ -11,6 +11,7 @@
     "network",
     "permissions",
     "storage",
+    "ota",
     "webority"
   ],
   "homepage": "https://www.webority.com",
@@ -231,6 +232,16 @@
         "default": "./lib/commonjs/redux/index.js"
       }
     },
+    "./updates": {
+      "import": {
+        "types": "./lib/typescript/module/updates/index.d.ts",
+        "default": "./lib/module/updates/index.js"
+      },
+      "require": {
+        "types": "./lib/typescript/commonjs/updates/index.d.ts",
+        "default": "./lib/commonjs/updates/index.js"
+      }
+    },
     "./package.json": "./package.json"
   },
   "main": "./lib/commonjs/index.js",
@@ -258,6 +269,7 @@
     }
   },
   "scripts": {
+    "prepack": "node ../../scripts/package-guard-pack.mjs --output-dirs lib --allow-file ../../.webority/package-allow.json",
     "build": "bob build && node ../../scripts/minify-lib.mjs",
     "clean": "rimraf lib",
     "lint": "biome lint ./src",
@@ -288,6 +300,7 @@
     "expo-sharing": ">=57.0.0",
     "expo-sqlite": ">=57.0.0",
     "expo-task-manager": ">=57.0.0",
+    "expo-updates": ">=57.0.0",
     "react": "^19.1.0",
     "react-native": ">=0.81.0",
     "react-redux": "^9.3.0"
@@ -332,6 +345,9 @@
     "expo-task-manager": {
       "optional": true
     },
+    "expo-updates": {
+      "optional": true
+    },
     "react-redux": {
       "optional": true
     }