@webority/mobile-core 0.111.0 → 0.112.3

package/README.md

@@ -29,6 +29,8 @@ import { Geolocation } from '@webority/mobile-core/geolocation';
 import { openDatabase } from '@webority/mobile-core/sqlite';
 import { downloadFile } from '@webority/mobile-core/download';
 import { shareFile } from '@webority/mobile-core/share';
+import { fetchAttachment, fetchPreviewAttachment, previewKind } from '@webority/mobile-core/attachments';
+import { getOrCreateInstallationId, clearTokensOnFirstLaunch } from '@webority/mobile-core/installation';
 import { requestReviewAfterSuccess } from '@webority/mobile-core/review';
 import { initPush, enablePush, usePush } from '@webority/mobile-core/push';
 import { definePushActionTask } from '@webority/mobile-core/push/task';
@@ -229,7 +231,7 @@ await userClient.get('/status', { skipErrorLog: true });
 JWT-shaped strings, and the values of keys named `token`, `accessToken`, `refreshToken`,
 `password` and `authorization` (any case) in objects and JSON strings.
 
-`configureLogger({ redactKeys })` adds app keys to the built-in masked list and never removes one. `Logger.getBreadcrumbs()` returns the last 50 breadcrumbs, oldest first, already redacted; `configureLogger({ breadcrumbLimit })` changes the cap. `initWebority` takes a required `remoteLogger`: the sink, or `null` for a build without crash reporting.
+`configureLogger({ redactKeys })` adds app keys to the built-in masked list and never removes one. `Logger.getBreadcrumbs()` returns the last 50 breadcrumbs, oldest first, already redacted; `configureLogger({ breadcrumbLimit })` changes the cap. `initWebority` takes a required `remoteLogger`: the sink, or `null` for a build without crash reporting. It also takes a required `appId`, the compiled settings' app id, and refuses to start when it differs from the installed app's id: a bundle prebuilt for another environment stops at start-up with the prebuild step to run.
 
 ## Metro bridge
 

package/lib/commonjs/attachments/index.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.previewKind=exports.mimeTypeFromFileName=exports.fetchPreviewAttachment=exports.fetchAttachment=void 0;var _expoFileSystem=require("expo-file-system"),_userClient=_interopRequireDefault(require("../api/userClient.js")),_index=require("../download/index.js"),_index2=require("../logger/index.js");function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}const EXTENSION_TYPES={pdf:"application/pdf",doc:"application/msword",docx:"application/vnd.openxmlformats-officedocument.wordprocessingml.document",xls:"application/vnd.ms-excel",xlsx:"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",ppt:"application/vnd.ms-powerpoint",pptx:"application/vnd.openxmlformats-officedocument.presentationml.presentation",jpg:"image/jpeg",jpeg:"image/jpeg",png:"image/png",webp:"image/webp",gif:"image/gif"},mimeTypeFromFileName=e=>{const t=(e??"").split(".").pop()?.toLowerCase()??"";return Object.hasOwn(EXTENSION_TYPES,t)?EXTENSION_TYPES[t]:void 0};exports.mimeTypeFromFileName=mimeTypeFromFileName;const fetchAttachment=({url:e,fileName:t,mimeType:i})=>(0,_index.downloadFile)({client:_userClient.default,url:e,fileName:t,mimeType:i??mimeTypeFromFileName(t),destination:"cache",overwrite:!0});exports.fetchAttachment=fetchAttachment;const PREVIEW_LIMIT=20,previewCache=new Map,previewFolderName=e=>e.replace(/[^A-Za-z0-9_-]/g,"_"),forgetPreview=e=>{try{new _expoFileSystem.Directory(e.folder).delete()}catch(e){_index2.Logger.warn("Removing an old preview failed:",e)}},fetchPreviewAttachment=async({cacheId:e,version:t,url:i,fileName:r,mimeType:p})=>{if(!t)return fetchAttachment({url:i,fileName:r,mimeType:p});const n=`${e}@${t}`,o=previewCache.get(n);if(o&&new _expoFileSystem.File(o.path).exists)return previewCache.delete(n),previewCache.set(n,o),o;previewCache.delete(n);const a=await fetchAttachment({url:i,fileName:r,mimeType:p}),m=new _expoFileSystem.File(a.path),c=new _expoFileSystem.Directory(_expoFileSystem.Paths.cache,"previews",previewFolderName(n));c.exists&&c.delete(),c.create({intermediates:!0,idempotent:!0}),await m.move(new _expoFileSystem.File(c,m.name));const l={path:new _expoFileSystem.File(c,m.name).uri,mimeType:a.mimeType,folder:c.uri};if(previewCache.set(n,l),previewCache.size>20){const e=previewCache.entries().next().value;e&&(previewCache.delete(e[0]),forgetPreview(e[1]))}return l};exports.fetchPreviewAttachment=fetchPreviewAttachment;const previewKind=e=>{const{contentType:t,name:i}=e,r=(i??"").split(".").pop()?.toLowerCase()??"",p=(t??r).toLowerCase();return p.includes("pdf")?"pdf":["png","jpeg","jpg","webp","gif"].some(e=>p.includes(e))?"image":null};exports.previewKind=previewKind;

package/lib/commonjs/initSDK.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.initWebority=void 0;var _authStore=require("./auth/authStore.js"),_index=require("./config/index.js"),_index2=require("./logger/index.js"),_networkStatus=require("./network/networkStatus.js"),_index3=require("./storage/index.js");const initWebority=e=>{if(!e.baseUrl)throw new Error("baseUrl is required for Webority packages initialization");if(void 0===e.remoteLogger)throw new Error("remoteLogger is required for Webority packages initialization: pass a RemoteLogger, or null for a build without crash reporting");(0,_index2.setRemoteLogger)(e.remoteLogger),(0,_index.setConfig)({baseUrl:e.baseUrl,loggingEnabled:e.loggingEnabled??!0,logLevel:e.logLevel||_index.DEFAULT_LOG_LEVEL,environment:e.environment||"Development",country:(e.country||"in").toLowerCase(),appId:e.appId??null,appVersion:e.appVersion??null,commit:e.commit??null,appBuild:e.appBuild??null,appStoreId:e.appStoreId??null,logCurl:e.logCurl??!1,timeoutMs:e.timeoutMs??_index.DEFAULT_TIMEOUT_MS,retries:e.retries??_index.DEFAULT_RETRIES});const t=e.backends;t?.storage&&(0,_index3.setStorageImplementation)(t.storage),t?.keychain&&(0,_authStore.setKeychainImplementation)(t.keychain),t?.network&&(0,_networkStatus.setNetworkStatusImplementation)(t.network),_index2.Logger.info("[@webority/mobile-core] initialized")};exports.initWebority=initWebority;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.initWebority=void 0;var cache,Application=_interopRequireWildcard(require("expo-application")),_authStore=require("./auth/authStore.js"),_index=require("./config/index.js"),_index2=require("./logger/index.js"),_networkStatus=require("./network/networkStatus.js"),_index3=require("./storage/index.js");function _interopRequireWildcard(e,r){if(!r&&e&&e.__esModule)return e;var t,i,o=Object.defineProperty,n={__proto__:null,default:e};if(Object(e)!==e)return n;if(cache||"function"!=typeof WeakMap||(cache=new WeakMap),cache){if(cache.has(e))return cache.get(e);cache.set(e,n)}for(i in e)"default"!==i&&{}.hasOwnProperty.call(e,i)&&((t=o&&Object.getOwnPropertyDescriptor(e,i))&&(t.get||t.set)?o(n,i,t):n[i]=e[i]);return n}const initWebority=e=>{if(!e.baseUrl)throw new Error("baseUrl is required for Webority packages initialisation");if(void 0===e.remoteLogger)throw new Error("remoteLogger is required for Webority packages initialisation: pass a RemoteLogger, or null for a build without crash reporting");if(!e.appId)throw new Error("appId is required for Webority packages initialisation");const r=Application.applicationId;if(null!==r&&e.appId!==r)throw new Error(`This build's settings are for ${e.appId} but the installed app is ${r}. Run mobile-tools prebuild for the right environment, then rebuild the bundle.`);(0,_index2.setRemoteLogger)(e.remoteLogger),(0,_index.setConfig)({baseUrl:e.baseUrl,loggingEnabled:e.loggingEnabled??!0,logLevel:e.logLevel||_index.DEFAULT_LOG_LEVEL,environment:e.environment||"Development",country:(e.country||"in").toLowerCase(),appId:e.appId,appVersion:e.appVersion??null,commit:e.commit??null,appBuild:e.appBuild??null,appStoreId:e.appStoreId??null,logCurl:e.logCurl??!1,timeoutMs:e.timeoutMs??_index.DEFAULT_TIMEOUT_MS,retries:e.retries??_index.DEFAULT_RETRIES});const t=e.backends;t?.storage&&(0,_index3.setStorageImplementation)(t.storage),t?.keychain&&(0,_authStore.setKeychainImplementation)(t.keychain),t?.network&&(0,_networkStatus.setNetworkStatusImplementation)(t.network),_index2.Logger.info("[@webority/mobile-core] initialized")};exports.initWebority=initWebority;

package/lib/commonjs/installation/index.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getOrCreateInstallationId=exports.clearTokensOnFirstLaunch=exports.INSTALLATION_STORAGE_KEYS=void 0;var _expoCrypto=require("expo-crypto"),_reactNative=require("react-native"),_authStore=require("../auth/authStore.js"),_index=require("../logger/index.js"),_index2=require("../storage/index.js");const INSTALLATION_STORAGE_KEYS=exports.INSTALLATION_STORAGE_KEYS={HAS_LAUNCHED_BEFORE:"hasLaunchedBefore",INSTALLATION_ID:"installationId"},getOrCreateInstallationId=async()=>{const e=await _index2.Storage.getItem(INSTALLATION_STORAGE_KEYS.INSTALLATION_ID);if(e)return e;const t=(0,_expoCrypto.randomUUID)();if(!await _index2.Storage.setItem(INSTALLATION_STORAGE_KEYS.INSTALLATION_ID,t))throw new Error("Could not persist the installation id");return t};exports.getOrCreateInstallationId=getOrCreateInstallationId;const clearTokensOnFirstLaunch=async()=>{if("ios"!==_reactNative.Platform.OS)return;null===await _index2.Storage.getItem(INSTALLATION_STORAGE_KEYS.HAS_LAUNCHED_BEFORE)&&(_index.Logger.info("First launch after install: clearing stored tokens"),await(0,_authStore.removeToken)(_authStore.ACCESS_TOKEN_KEY),await(0,_authStore.removeToken)(_authStore.REFRESH_TOKEN_KEY),await _index2.Storage.setItem(INSTALLATION_STORAGE_KEYS.HAS_LAUNCHED_BEFORE,"true"))};exports.clearTokensOnFirstLaunch=clearTokensOnFirstLaunch;

package/lib/commonjs/redux/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"SERIALIZABLE_IGNORED_ACTION_PATHS",{enumerable:!0,get:function(){return _serializableCheck.SERIALIZABLE_IGNORED_ACTION_PATHS}}),Object.defineProperty(exports,"createRootReducer",{enumerable:!0,get:function(){return _rootReducer.createRootReducer}}),Object.defineProperty(exports,"errorToastMiddleware",{enumerable:!0,get:function(){return _errorToastMiddleware.errorToastMiddleware}}),Object.defineProperty(exports,"isSilentRejection",{enumerable:!0,get:function(){return _errorToastMiddleware.isSilentRejection}}),Object.defineProperty(exports,"resetState",{enumerable:!0,get:function(){return _rootReducer.resetState}});var _errorToastMiddleware=require("./errorToastMiddleware.js"),_rootReducer=require("./rootReducer.js"),_serializableCheck=require("./serializableCheck.js");
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"SERIALIZABLE_IGNORED_ACTION_PATHS",{enumerable:!0,get:function(){return _serializableCheck.SERIALIZABLE_IGNORED_ACTION_PATHS}}),Object.defineProperty(exports,"createRootReducer",{enumerable:!0,get:function(){return _rootReducer.createRootReducer}}),Object.defineProperty(exports,"createSessionMiddleware",{enumerable:!0,get:function(){return _sessionMiddleware.createSessionMiddleware}}),Object.defineProperty(exports,"errorToastMiddleware",{enumerable:!0,get:function(){return _errorToastMiddleware.errorToastMiddleware}}),Object.defineProperty(exports,"isSilentRejection",{enumerable:!0,get:function(){return _errorToastMiddleware.isSilentRejection}}),Object.defineProperty(exports,"resetState",{enumerable:!0,get:function(){return _rootReducer.resetState}});var _errorToastMiddleware=require("./errorToastMiddleware.js"),_rootReducer=require("./rootReducer.js"),_serializableCheck=require("./serializableCheck.js"),_sessionMiddleware=require("./sessionMiddleware.js");

package/lib/commonjs/redux/sessionMiddleware.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.createSessionMiddleware=void 0;const isAction=e=>"object"==typeof e&&null!==e&&"type"in e,thunkMeta=e=>isAction(e)&&"object"==typeof e.meta&&null!==e.meta?e.meta:{},createSessionMiddleware=e=>{const t=new Set,n=new Set;return()=>r=>s=>{const{requestId:i,requestStatus:o}=thunkMeta(s);if(!i||!o)return r(s);if("pending"===o){if(isAction(s)&&e.isSignOut(s)){for(const e of t)n.add(e);t.clear()}else t.add(i);return r(s)}return t.delete(i),n.delete(i)?s:r(s)}};exports.createSessionMiddleware=createSessionMiddleware;

package/lib/module/attachments/index.js

@@ -0,0 +1 @@
+"use strict";import{Directory,File,Paths}from"expo-file-system";import userClient from"../api/userClient.js";import{downloadFile}from"../download/index.js";import{Logger}from"../logger/index.js";const EXTENSION_TYPES={pdf:"application/pdf",doc:"application/msword",docx:"application/vnd.openxmlformats-officedocument.wordprocessingml.document",xls:"application/vnd.ms-excel",xlsx:"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",ppt:"application/vnd.ms-powerpoint",pptx:"application/vnd.openxmlformats-officedocument.presentationml.presentation",jpg:"image/jpeg",jpeg:"image/jpeg",png:"image/png",webp:"image/webp",gif:"image/gif"};export const mimeTypeFromFileName=e=>{const t=(e??"").split(".").pop()?.toLowerCase()??"";return Object.hasOwn(EXTENSION_TYPES,t)?EXTENSION_TYPES[t]:void 0};export const fetchAttachment=({url:e,fileName:t,mimeType:i})=>downloadFile({client:userClient,url:e,fileName:t,mimeType:i??mimeTypeFromFileName(t),destination:"cache",overwrite:!0});const PREVIEW_LIMIT=20,previewCache=new Map,previewFolderName=e=>e.replace(/[^A-Za-z0-9_-]/g,"_"),forgetPreview=e=>{try{new Directory(e.folder).delete()}catch(e){Logger.warn("Removing an old preview failed:",e)}};export const fetchPreviewAttachment=async({cacheId:e,version:t,url:i,fileName:o,mimeType:p})=>{if(!t)return fetchAttachment({url:i,fileName:o,mimeType:p});const r=`${e}@${t}`,n=previewCache.get(r);if(n&&new File(n.path).exists)return previewCache.delete(r),previewCache.set(r,n),n;previewCache.delete(r);const a=await fetchAttachment({url:i,fileName:o,mimeType:p}),m=new File(a.path),c=new Directory(Paths.cache,"previews",previewFolderName(r));c.exists&&c.delete(),c.create({intermediates:!0,idempotent:!0}),await m.move(new File(c,m.name));const l={path:new File(c,m.name).uri,mimeType:a.mimeType,folder:c.uri};if(previewCache.set(r,l),previewCache.size>20){const e=previewCache.entries().next().value;e&&(previewCache.delete(e[0]),forgetPreview(e[1]))}return l};export const previewKind=e=>{const{contentType:t,name:i}=e,o=(i??"").split(".").pop()?.toLowerCase()??"",p=(t??o).toLowerCase();return p.includes("pdf")?"pdf":["png","jpeg","jpg","webp","gif"].some(e=>p.includes(e))?"image":null};

package/lib/module/initSDK.js

@@ -1 +1 @@
-"use strict";import{setKeychainImplementation}from"./auth/authStore.js";import{DEFAULT_LOG_LEVEL,DEFAULT_RETRIES,DEFAULT_TIMEOUT_MS,setConfig}from"./config/index.js";import{Logger,setRemoteLogger}from"./logger/index.js";import{setNetworkStatusImplementation}from"./network/networkStatus.js";import{setStorageImplementation}from"./storage/index.js";export const initWebority=e=>{if(!e.baseUrl)throw new Error("baseUrl is required for Webority packages initialization");if(void 0===e.remoteLogger)throw new Error("remoteLogger is required for Webority packages initialization: pass a RemoteLogger, or null for a build without crash reporting");setRemoteLogger(e.remoteLogger),setConfig({baseUrl:e.baseUrl,loggingEnabled:e.loggingEnabled??!0,logLevel:e.logLevel||DEFAULT_LOG_LEVEL,environment:e.environment||"Development",country:(e.country||"in").toLowerCase(),appId:e.appId??null,appVersion:e.appVersion??null,commit:e.commit??null,appBuild:e.appBuild??null,appStoreId:e.appStoreId??null,logCurl:e.logCurl??!1,timeoutMs:e.timeoutMs??DEFAULT_TIMEOUT_MS,retries:e.retries??DEFAULT_RETRIES});const o=e.backends;o?.storage&&setStorageImplementation(o.storage),o?.keychain&&setKeychainImplementation(o.keychain),o?.network&&setNetworkStatusImplementation(o.network),Logger.info("[@webority/mobile-core] initialized")};
+"use strict";import*as Application from"expo-application";import{setKeychainImplementation}from"./auth/authStore.js";import{DEFAULT_LOG_LEVEL,DEFAULT_RETRIES,DEFAULT_TIMEOUT_MS,setConfig}from"./config/index.js";import{Logger,setRemoteLogger}from"./logger/index.js";import{setNetworkStatusImplementation}from"./network/networkStatus.js";import{setStorageImplementation}from"./storage/index.js";export const initWebority=e=>{if(!e.baseUrl)throw new Error("baseUrl is required for Webority packages initialisation");if(void 0===e.remoteLogger)throw new Error("remoteLogger is required for Webority packages initialisation: pass a RemoteLogger, or null for a build without crash reporting");if(!e.appId)throw new Error("appId is required for Webority packages initialisation");const o=Application.applicationId;if(null!==o&&e.appId!==o)throw new Error(`This build's settings are for ${e.appId} but the installed app is ${o}. Run mobile-tools prebuild for the right environment, then rebuild the bundle.`);setRemoteLogger(e.remoteLogger),setConfig({baseUrl:e.baseUrl,loggingEnabled:e.loggingEnabled??!0,logLevel:e.logLevel||DEFAULT_LOG_LEVEL,environment:e.environment||"Development",country:(e.country||"in").toLowerCase(),appId:e.appId,appVersion:e.appVersion??null,commit:e.commit??null,appBuild:e.appBuild??null,appStoreId:e.appStoreId??null,logCurl:e.logCurl??!1,timeoutMs:e.timeoutMs??DEFAULT_TIMEOUT_MS,retries:e.retries??DEFAULT_RETRIES});const t=e.backends;t?.storage&&setStorageImplementation(t.storage),t?.keychain&&setKeychainImplementation(t.keychain),t?.network&&setNetworkStatusImplementation(t.network),Logger.info("[@webority/mobile-core] initialized")};

package/lib/module/installation/index.js

@@ -0,0 +1 @@
+"use strict";import{randomUUID}from"expo-crypto";import{Platform}from"react-native";import{ACCESS_TOKEN_KEY,REFRESH_TOKEN_KEY,removeToken}from"../auth/authStore.js";import{Logger}from"../logger/index.js";import{Storage}from"../storage/index.js";export const INSTALLATION_STORAGE_KEYS={HAS_LAUNCHED_BEFORE:"hasLaunchedBefore",INSTALLATION_ID:"installationId"};export const getOrCreateInstallationId=async()=>{const t=await Storage.getItem(INSTALLATION_STORAGE_KEYS.INSTALLATION_ID);if(t)return t;const e=randomUUID();if(!await Storage.setItem(INSTALLATION_STORAGE_KEYS.INSTALLATION_ID,e))throw new Error("Could not persist the installation id");return e};export const clearTokensOnFirstLaunch=async()=>{if("ios"!==Platform.OS)return;null===await Storage.getItem(INSTALLATION_STORAGE_KEYS.HAS_LAUNCHED_BEFORE)&&(Logger.info("First launch after install: clearing stored tokens"),await removeToken(ACCESS_TOKEN_KEY),await removeToken(REFRESH_TOKEN_KEY),await Storage.setItem(INSTALLATION_STORAGE_KEYS.HAS_LAUNCHED_BEFORE,"true"))};

package/lib/module/redux/index.js

@@ -1 +1 @@
-"use strict";export{errorToastMiddleware,isSilentRejection}from"./errorToastMiddleware.js";export{createRootReducer,resetState}from"./rootReducer.js";export{SERIALIZABLE_IGNORED_ACTION_PATHS}from"./serializableCheck.js";
+"use strict";export{errorToastMiddleware,isSilentRejection}from"./errorToastMiddleware.js";export{createRootReducer,resetState}from"./rootReducer.js";export{SERIALIZABLE_IGNORED_ACTION_PATHS}from"./serializableCheck.js";export{createSessionMiddleware}from"./sessionMiddleware.js";

package/lib/module/redux/sessionMiddleware.js

@@ -0,0 +1 @@
+"use strict";const isAction=e=>"object"==typeof e&&null!==e&&"type"in e,thunkMeta=e=>isAction(e)&&"object"==typeof e.meta&&null!==e.meta?e.meta:{};export const createSessionMiddleware=e=>{const t=new Set,n=new Set;return()=>s=>i=>{const{requestId:o,requestStatus:r}=thunkMeta(i);if(!o||!r)return s(i);if("pending"===r){if(isAction(i)&&e.isSignOut(i)){for(const e of t)n.add(e);t.clear()}else t.add(o);return s(i)}return t.delete(o),n.delete(o)?i:s(i)}};

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

@@ -0,0 +1,37 @@
+import { type DownloadResult } from "../download";
+/**
+ * The content type a file name's extension stands for. Files that arrive with a name only need a type to be saved
+ * properly and to offer the right apps for them.
+ */
+export declare const mimeTypeFromFileName: (fileName: string | null | undefined) => string | undefined;
+export interface AttachmentRequest {
+    url: string;
+    fileName: string;
+    mimeType?: string | null;
+}
+/**
+ * Fetches a file through the signed-in client into the app's cache, where a viewer or a save reads it. Answers with
+ * its local `path` and `mimeType`; a file with no content type of its own takes the one its name stands for.
+ */
+export declare const fetchAttachment: ({ url, fileName, mimeType }: AttachmentRequest) => Promise<DownloadResult>;
+export interface PreviewAttachment {
+    path: string;
+    mimeType?: string;
+    folder: string;
+}
+/**
+ * fetchAttachment for a preview: a document already downloaded this session opens from the phone with no second
+ * download. The document's `version` (its updated time) is part of the key, so a replaced document is fetched again;
+ * without a version the file is not kept at all.
+ */
+export declare const fetchPreviewAttachment: ({ cacheId, version, url, fileName, mimeType, }: AttachmentRequest & {
+    cacheId: string;
+    version?: string | null;
+}) => Promise<PreviewAttachment | DownloadResult>;
+export type PreviewKind = "image" | "pdf";
+/** What the app can show itself, from a content type or a file name: "image", "pdf", or null for anything else. */
+export declare const previewKind: (file: {
+    contentType?: string | null;
+    name?: string | null;
+}) => PreviewKind | null;
+//# sourceMappingURL=index.d.ts.map

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

@@ -10,6 +10,8 @@
  *   @webority/mobile-core/geolocation  a geolocation provider
  *   @webority/mobile-core/sqlite       expo-sqlite
  *   @webority/mobile-core/download     a filesystem module
+ *   @webority/mobile-core/installation  installation id (expo-crypto)
+ *   @webority/mobile-core/attachments  fetch, preview cache and preview kind (expo-file-system)
  *   @webority/mobile-core/share        expo-sharing
  *   @webority/mobile-core/review       expo-store-review
  *   @webority/mobile-core/secureScreen expo-screen-capture

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

@@ -1,5 +1,5 @@
 /**
- * Simple initialization API for Webority packages
+ * Simple initialisation API for Webority packages
  * One function to configure everything needed
  */
 import { type KeychainLike } from "./auth/authStore";
@@ -27,13 +27,17 @@ export interface InitConfig {
      */
     country?: string;
     /**
-     * The app's store identifier (Android package name / iOS bundle id), its
-     * user-visible version and its internal build number (`VERSION_INTERNAL`).
+     * The app's store identifier (Android package name / iOS bundle id), from `APP_ID` in
+     * `appsettings.Compiled.json`. Required: it must equal the bundle id the installed app runs,
+     * so a bundle compiled for another environment stops at start-up.
+     */
+    appId: string;
+    /**
+     * The app's user-visible version and its internal build number (`VERSION_INTERNAL`).
      * Every Webority app already has them in `appsettings.Compiled.json`, which
      * is why they come from config rather than across the native bridge. The
      * version check compares `appBuild` with the API's `Min-App-Version`.
      */
-    appId?: string;
     appVersion?: string;
     appBuild?: number;
     /** The numeric Apple App Store id; the iOS update button needs it. */
@@ -73,6 +77,7 @@ export interface InitConfig {
  * // Basic setup
  * initWebority({
  *   baseUrl: 'https://api.myapp.com',
+ *   appId: 'com.myapp',
  *   remoteLogger: null
  * });
  *
@@ -80,6 +85,7 @@ export interface InitConfig {
  * // Full configuration
  * initWebority({
  *   baseUrl: 'https://api.myapp.com',
+ *   appId: 'com.myapp',
  *   remoteLogger: crashlyticsRemoteLogger(crashlytics),
  *   loggingEnabled: __DEV__,
  *   logLevel: 'warn',

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

@@ -0,0 +1,23 @@
+/**
+ * The stored names the existing apps already use. Keeping them means an
+ * installation that already has an id keeps it after the app adopts this module.
+ */
+export declare const INSTALLATION_STORAGE_KEYS: {
+    readonly HAS_LAUNCHED_BEFORE: "hasLaunchedBefore";
+    readonly INSTALLATION_ID: "installationId";
+};
+/**
+ * Returns this installation's id, creating and persisting one on first use. A
+ * stored id is never replaced, whatever its format. Throws when the new id cannot
+ * be persisted: every account call is keyed on the id, and a fresh id per call
+ * would register a new installation on each sign-in.
+ */
+export declare const getOrCreateInstallationId: () => Promise<string>;
+/**
+ * The iOS keychain keeps tokens across an uninstall, so a reinstalled app would
+ * start signed in as the previous person. This clears them on the first launch
+ * after install. It never calls clearSession: no session-ended listener may fire
+ * before the app has started.
+ */
+export declare const clearTokensOnFirstLaunch: () => Promise<void>;
+//# sourceMappingURL=index.d.ts.map

package/lib/typescript/commonjs/logger/crashlytics.d.ts

@@ -18,7 +18,7 @@ export interface CrashlyticsModule<Instance = unknown> {
  * import * as crashlytics from '@react-native-firebase/crashlytics';
  * import { crashlyticsRemoteLogger, initWebority } from '@webority/mobile-core';
  *
- * initWebority({ baseUrl, remoteLogger: crashlyticsRemoteLogger(crashlytics) });
+ * initWebority({ baseUrl, appId, remoteLogger: crashlyticsRemoteLogger(crashlytics) });
  * ```
  *
  * Breadcrumbs and log lines become Crashlytics log lines, errors become

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

@@ -3,4 +3,6 @@ export { errorToastMiddleware, isSilentRejection } from "./errorToastMiddleware"
 export type { RootReducerOptions } from "./rootReducer";
 export { createRootReducer, resetState } from "./rootReducer";
 export { SERIALIZABLE_IGNORED_ACTION_PATHS } from "./serializableCheck";
+export type { SessionMiddlewareOptions } from "./sessionMiddleware";
+export { createSessionMiddleware } from "./sessionMiddleware";
 //# sourceMappingURL=index.d.ts.map

package/lib/typescript/commonjs/redux/sessionMiddleware.d.ts

@@ -0,0 +1,14 @@
+import type { Middleware, UnknownAction } from "@reduxjs/toolkit";
+export interface SessionMiddlewareOptions {
+    /** Answers true for the pending action of the app's own sign-out thunk, for example `logout.pending.match`. */
+    isSignOut: (action: UnknownAction) => boolean;
+}
+/**
+ * Drops the outcome of every call still out when the person signs out, so an answer for the ended
+ * session never refills the store the sign-out just cleared, or shows to the next person on this
+ * phone. Each async thunk's actions carry a `requestId`; the ones in flight at the sign-out's
+ * pending action are stale. The thunk's own promise still settles, so a caller awaiting it is not
+ * left hanging.
+ */
+export declare const createSessionMiddleware: (options: SessionMiddlewareOptions) => Middleware;
+//# sourceMappingURL=sessionMiddleware.d.ts.map

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

@@ -0,0 +1,37 @@
+import { type DownloadResult } from "../download/index.js";
+/**
+ * The content type a file name's extension stands for. Files that arrive with a name only need a type to be saved
+ * properly and to offer the right apps for them.
+ */
+export declare const mimeTypeFromFileName: (fileName: string | null | undefined) => string | undefined;
+export interface AttachmentRequest {
+    url: string;
+    fileName: string;
+    mimeType?: string | null;
+}
+/**
+ * Fetches a file through the signed-in client into the app's cache, where a viewer or a save reads it. Answers with
+ * its local `path` and `mimeType`; a file with no content type of its own takes the one its name stands for.
+ */
+export declare const fetchAttachment: ({ url, fileName, mimeType }: AttachmentRequest) => Promise<DownloadResult>;
+export interface PreviewAttachment {
+    path: string;
+    mimeType?: string;
+    folder: string;
+}
+/**
+ * fetchAttachment for a preview: a document already downloaded this session opens from the phone with no second
+ * download. The document's `version` (its updated time) is part of the key, so a replaced document is fetched again;
+ * without a version the file is not kept at all.
+ */
+export declare const fetchPreviewAttachment: ({ cacheId, version, url, fileName, mimeType, }: AttachmentRequest & {
+    cacheId: string;
+    version?: string | null;
+}) => Promise<PreviewAttachment | DownloadResult>;
+export type PreviewKind = "image" | "pdf";
+/** What the app can show itself, from a content type or a file name: "image", "pdf", or null for anything else. */
+export declare const previewKind: (file: {
+    contentType?: string | null;
+    name?: string | null;
+}) => PreviewKind | null;
+//# sourceMappingURL=index.d.ts.map

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

@@ -10,6 +10,8 @@
  *   @webority/mobile-core/geolocation  a geolocation provider
  *   @webority/mobile-core/sqlite       expo-sqlite
  *   @webority/mobile-core/download     a filesystem module
+ *   @webority/mobile-core/installation  installation id (expo-crypto)
+ *   @webority/mobile-core/attachments  fetch, preview cache and preview kind (expo-file-system)
  *   @webority/mobile-core/share        expo-sharing
  *   @webority/mobile-core/review       expo-store-review
  *   @webority/mobile-core/secureScreen expo-screen-capture

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

@@ -1,5 +1,5 @@
 /**
- * Simple initialization API for Webority packages
+ * Simple initialisation API for Webority packages
  * One function to configure everything needed
  */
 import { type KeychainLike } from "./auth/authStore.js";
@@ -27,13 +27,17 @@ export interface InitConfig {
      */
     country?: string;
     /**
-     * The app's store identifier (Android package name / iOS bundle id), its
-     * user-visible version and its internal build number (`VERSION_INTERNAL`).
+     * The app's store identifier (Android package name / iOS bundle id), from `APP_ID` in
+     * `appsettings.Compiled.json`. Required: it must equal the bundle id the installed app runs,
+     * so a bundle compiled for another environment stops at start-up.
+     */
+    appId: string;
+    /**
+     * The app's user-visible version and its internal build number (`VERSION_INTERNAL`).
      * Every Webority app already has them in `appsettings.Compiled.json`, which
      * is why they come from config rather than across the native bridge. The
      * version check compares `appBuild` with the API's `Min-App-Version`.
      */
-    appId?: string;
     appVersion?: string;
     appBuild?: number;
     /** The numeric Apple App Store id; the iOS update button needs it. */
@@ -73,6 +77,7 @@ export interface InitConfig {
  * // Basic setup
  * initWebority({
  *   baseUrl: 'https://api.myapp.com',
+ *   appId: 'com.myapp',
  *   remoteLogger: null
  * });
  *
@@ -80,6 +85,7 @@ export interface InitConfig {
  * // Full configuration
  * initWebority({
  *   baseUrl: 'https://api.myapp.com',
+ *   appId: 'com.myapp',
  *   remoteLogger: crashlyticsRemoteLogger(crashlytics),
  *   loggingEnabled: __DEV__,
  *   logLevel: 'warn',

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

@@ -0,0 +1,23 @@
+/**
+ * The stored names the existing apps already use. Keeping them means an
+ * installation that already has an id keeps it after the app adopts this module.
+ */
+export declare const INSTALLATION_STORAGE_KEYS: {
+    readonly HAS_LAUNCHED_BEFORE: "hasLaunchedBefore";
+    readonly INSTALLATION_ID: "installationId";
+};
+/**
+ * Returns this installation's id, creating and persisting one on first use. A
+ * stored id is never replaced, whatever its format. Throws when the new id cannot
+ * be persisted: every account call is keyed on the id, and a fresh id per call
+ * would register a new installation on each sign-in.
+ */
+export declare const getOrCreateInstallationId: () => Promise<string>;
+/**
+ * The iOS keychain keeps tokens across an uninstall, so a reinstalled app would
+ * start signed in as the previous person. This clears them on the first launch
+ * after install. It never calls clearSession: no session-ended listener may fire
+ * before the app has started.
+ */
+export declare const clearTokensOnFirstLaunch: () => Promise<void>;
+//# sourceMappingURL=index.d.ts.map

package/lib/typescript/module/logger/crashlytics.d.ts

@@ -18,7 +18,7 @@ export interface CrashlyticsModule<Instance = unknown> {
  * import * as crashlytics from '@react-native-firebase/crashlytics';
  * import { crashlyticsRemoteLogger, initWebority } from '@webority/mobile-core';
  *
- * initWebority({ baseUrl, remoteLogger: crashlyticsRemoteLogger(crashlytics) });
+ * initWebority({ baseUrl, appId, remoteLogger: crashlyticsRemoteLogger(crashlytics) });
  * ```
  *
  * Breadcrumbs and log lines become Crashlytics log lines, errors become

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

@@ -3,4 +3,6 @@ export { errorToastMiddleware, isSilentRejection } from "./errorToastMiddleware.
 export type { RootReducerOptions } from "./rootReducer.js";
 export { createRootReducer, resetState } from "./rootReducer.js";
 export { SERIALIZABLE_IGNORED_ACTION_PATHS } from "./serializableCheck.js";
+export type { SessionMiddlewareOptions } from "./sessionMiddleware.js";
+export { createSessionMiddleware } from "./sessionMiddleware.js";
 //# sourceMappingURL=index.d.ts.map

package/lib/typescript/module/redux/sessionMiddleware.d.ts

@@ -0,0 +1,14 @@
+import type { Middleware, UnknownAction } from "@reduxjs/toolkit";
+export interface SessionMiddlewareOptions {
+    /** Answers true for the pending action of the app's own sign-out thunk, for example `logout.pending.match`. */
+    isSignOut: (action: UnknownAction) => boolean;
+}
+/**
+ * Drops the outcome of every call still out when the person signs out, so an answer for the ended
+ * session never refills the store the sign-out just cleared, or shows to the next person on this
+ * phone. Each async thunk's actions carry a `requestId`; the ones in flight at the sign-out's
+ * pending action are stale. The thunk's own promise still settles, so a caller awaiting it is not
+ * left hanging.
+ */
+export declare const createSessionMiddleware: (options: SessionMiddlewareOptions) => Middleware;
+//# sourceMappingURL=sessionMiddleware.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webority/mobile-core",
-  "version": "0.111.0",
+  "version": "0.112.3",
   "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",
@@ -152,6 +152,26 @@
         "default": "./lib/commonjs/download/index.js"
       }
     },
+    "./installation": {
+      "import": {
+        "types": "./lib/typescript/module/installation/index.d.ts",
+        "default": "./lib/module/installation/index.js"
+      },
+      "require": {
+        "types": "./lib/typescript/commonjs/installation/index.d.ts",
+        "default": "./lib/commonjs/installation/index.js"
+      }
+    },
+    "./attachments": {
+      "import": {
+        "types": "./lib/typescript/module/attachments/index.d.ts",
+        "default": "./lib/module/attachments/index.js"
+      },
+      "require": {
+        "types": "./lib/typescript/commonjs/attachments/index.d.ts",
+        "default": "./lib/commonjs/attachments/index.js"
+      }
+    },
     "./share": {
       "import": {
         "types": "./lib/typescript/module/share/index.d.ts",
@@ -329,6 +349,7 @@
     "expo-calendar": ">=57.0.0",
     "expo-camera": ">=57.0.0",
     "expo-contacts": ">=57.0.0",
+    "expo-crypto": ">=57.0.0",
     "expo-document-picker": ">=57.0.0",
     "expo-file-system": ">=57.0.0",
     "expo-image-manipulator": ">=57.0.0",
@@ -362,6 +383,9 @@
     "expo-contacts": {
       "optional": true
     },
+    "expo-crypto": {
+      "optional": true
+    },
     "expo-document-picker": {
       "optional": true
     },
@@ -443,6 +467,7 @@
     "@types/react": "19.2.18",
     "expo": "57.0.17",
     "expo-application": "57.0.2",
+    "expo-crypto": "57.0.4",
     "expo-document-picker": "57.0.2",
     "expo-file-system": "57.0.6",
     "expo-image-manipulator": "57.0.14",