@itwin/core-mobile 3.0.0-dev.100

package/lib/cjs/backend/MobileFileHandler.d.ts

@@ -0,0 +1,88 @@
+/** @packageDocumentation
+ * @module iModelHub
+ */
+/// <reference types="node" />
+import * as https from "https";
+import { AccessToken } from "@itwin/core-bentley";
+import { CancelRequest, FileHandler, ProgressCallback } from "@bentley/itwin-client";
+/**
+ * Provides methods to work with the file system and azure storage. An instance of this class has to be provided to [[IModelClient]] for file upload/download methods to work.
+ * @internal
+ */
+export declare class MobileFileHandler implements FileHandler {
+    /** @internal */
+    agent?: https.Agent;
+    /**
+     * Constructor for MobileFileHandler.
+     */
+    constructor();
+    /** Create a directory, recursively setting up the path as necessary. */
+    private static makeDirectoryRecursive;
+    /**
+     * Make url safe for logging by removing sensitive information
+     * @param url input url that will be strip of search and query parameters and replace them by ... for security reason
+     */
+    private static getSafeUrlForLogging;
+    /**
+     * Check if sas url has expired
+     * @param download sas url for download
+     * @param futureSeconds should be valid in future for given seconds.
+     */
+    static isUrlExpired(downloadUrl: string, futureSeconds?: number): boolean;
+    /**
+     * Download a file from AzureBlobStorage for iModelHub. Creates the directory containing the file if necessary. If there is an error in the operation, incomplete file is deleted from disk.
+     * @param downloadUrl URL to download file from.
+     * @param downloadToPathname Pathname to download the file to.
+     * @param fileSize Size of the file that's being downloaded.
+     * @param progressCallback Callback for tracking progress.
+     * @throws [[IModelHubClientError]] with [IModelHubStatus.UndefinedArgumentError]($bentley) if one of the arguments is undefined or empty.
+     */
+    downloadFile(_accessToken: AccessToken, downloadUrl: string, downloadToPathname: string, fileSize?: number, progressCallback?: ProgressCallback, cancelRequest?: CancelRequest): Promise<void>;
+    /** Get encoded block id from its number. */
+    private getBlockId;
+    private uploadChunk;
+    /**
+     * Upload a file to AzureBlobStorage for iModelHub.
+     * @param uploadUrl URL to upload the file to.
+     * @param uploadFromPathname Pathname to upload the file from.
+     * @param progressCallback Callback for tracking progress.
+     * @throws [[IModelHubClientError]] with [IModelHubStatus.UndefinedArgumentError]($bentley) if one of the arguments is undefined or empty.
+     */
+    uploadFile(accessToken: AccessToken, uploadUrlString: string, uploadFromPathname: string, progressCallback?: ProgressCallback): Promise<void>;
+    /**
+     * Get size of a file.
+     * @param filePath Path of the file.
+     * @returns Size of the file.
+     */
+    getFileSize(filePath: string): number;
+    /**
+     * Check if path is a directory.
+     * @param filePath Path of the file.
+     * @returns True if path is directory.
+     */
+    isDirectory(filePath: string): boolean;
+    /**
+     * Check if path exists.
+     * @param filePath Path of the file.
+     * @returns True if path exists.
+     */
+    exists(filePath: string): boolean;
+    /**
+     * Deletes file.
+     * @param filePath Path of the file.
+     */
+    unlink(filePath: string): void;
+    /**
+     * Get file name from the path.
+     * @param filePath Path of the file.
+     * @returns File name.
+     */
+    basename(filePath: string): string;
+    /**
+     * Join multiple strings into a single path.
+     * @param paths Strings to join.
+     * @returns Joined path.
+     */
+    join(...paths: string[]): string;
+}
+//# sourceMappingURL=MobileFileHandler.d.ts.map

package/lib/cjs/backend/MobileFileHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MobileFileHandler.d.ts","sourceRoot":"","sources":["../../../src/backend/MobileFileHandler.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAGH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,WAAW,EAAU,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EACL,aAAa,EAAkB,WAAW,EAAE,gBAAgB,EAE7D,MAAM,uBAAuB,CAAC;AAW/B;;;GAGG;AACH,qBAAa,iBAAkB,YAAW,WAAW;IACnD,gBAAgB;IACT,KAAK,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC;IAE3B;;OAEG;;IAIH,wEAAwE;IACxE,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAQrC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IASnC;;;;OAIG;WACW,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO;IAehF;;;;;;;OAOG;IACU,YAAY,CAAC,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAkC3M,4CAA4C;IAC5C,OAAO,CAAC,UAAU;YAIJ,WAAW;IA0BzB;;;;;;OAMG;IACU,UAAU,CAAC,WAAW,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IA4C1J;;;;OAIG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAI5C;;;;OAIG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAI7C;;;;OAIG;IACI,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAIxC;;;OAGG;IACI,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAIrC;;;;OAIG;IACI,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAIzC;;;;OAIG;IACI,IAAI,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM;CAGxC"}

package/lib/cjs/backend/MobileFileHandler.js

@@ -0,0 +1,233 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module iModelHub
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MobileFileHandler = void 0;
+const fs = require("fs");
+const path = require("path");
+const core_bentley_1 = require("@itwin/core-bentley");
+const itwin_client_1 = require("@bentley/itwin-client");
+const MobileHost_1 = require("./MobileHost");
+const js_base64_1 = require("js-base64");
+const loggerCategory = "mobile.filehandler";
+const defined = (argumentName, argument, allowEmpty = false) => {
+    if (argument === undefined || argument === null || (argument === "" && !allowEmpty))
+        throw Error(`Argument ${argumentName} is null or undefined`);
+};
+/**
+ * Provides methods to work with the file system and azure storage. An instance of this class has to be provided to [[IModelClient]] for file upload/download methods to work.
+ * @internal
+ */
+class MobileFileHandler {
+    /**
+     * Constructor for MobileFileHandler.
+     */
+    constructor() {
+    }
+    /** Create a directory, recursively setting up the path as necessary. */
+    static makeDirectoryRecursive(dirPath) {
+        if (fs.existsSync(dirPath))
+            return;
+        MobileFileHandler.makeDirectoryRecursive(path.dirname(dirPath));
+        fs.mkdirSync(dirPath);
+    }
+    /**
+     * Make url safe for logging by removing sensitive information
+     * @param url input url that will be strip of search and query parameters and replace them by ... for security reason
+     */
+    static getSafeUrlForLogging(url) {
+        const safeToLogDownloadUrl = new URL(url);
+        if (safeToLogDownloadUrl.search && safeToLogDownloadUrl.search.length > 0)
+            safeToLogDownloadUrl.search = "...";
+        if (safeToLogDownloadUrl.hash && safeToLogDownloadUrl.hash.length > 0)
+            safeToLogDownloadUrl.hash = "...";
+        return safeToLogDownloadUrl.toString();
+    }
+    /**
+     * Check if sas url has expired
+     * @param download sas url for download
+     * @param futureSeconds should be valid in future for given seconds.
+     */
+    static isUrlExpired(downloadUrl, futureSeconds) {
+        const sasUrl = new URL(downloadUrl);
+        const se = sasUrl.searchParams.get("se");
+        if (se) {
+            const expiryUTC = new Date(se);
+            const now = new Date();
+            const currentUTC = new Date(now.toUTCString());
+            if (futureSeconds) {
+                currentUTC.setSeconds(futureSeconds + currentUTC.getSeconds());
+            }
+            return expiryUTC <= currentUTC;
+        }
+        return false;
+    }
+    /**
+     * Download a file from AzureBlobStorage for iModelHub. Creates the directory containing the file if necessary. If there is an error in the operation, incomplete file is deleted from disk.
+     * @param downloadUrl URL to download file from.
+     * @param downloadToPathname Pathname to download the file to.
+     * @param fileSize Size of the file that's being downloaded.
+     * @param progressCallback Callback for tracking progress.
+     * @throws [[IModelHubClientError]] with [IModelHubStatus.UndefinedArgumentError]($bentley) if one of the arguments is undefined or empty.
+     */
+    async downloadFile(_accessToken, downloadUrl, downloadToPathname, fileSize, progressCallback, cancelRequest) {
+        // strip search and hash parameters from download Url for logging purpose
+        const safeToLogUrl = MobileFileHandler.getSafeUrlForLogging(downloadUrl);
+        core_bentley_1.Logger.logInfo(loggerCategory, `Downloading file from ${safeToLogUrl}`);
+        defined("downloadUrl", downloadUrl);
+        defined("downloadToPathname", downloadToPathname);
+        if (MobileFileHandler.isUrlExpired(downloadUrl)) {
+            core_bentley_1.Logger.logError(loggerCategory, `Sas url has expired ${safeToLogUrl}`);
+            throw new itwin_client_1.SasUrlExpired(403, "Download URL has expired");
+        }
+        if (fs.existsSync(downloadToPathname))
+            fs.unlinkSync(downloadToPathname);
+        MobileFileHandler.makeDirectoryRecursive(path.dirname(downloadToPathname));
+        try {
+            await MobileHost_1.MobileHost.downloadFile(downloadUrl, downloadToPathname, progressCallback, cancelRequest);
+        }
+        catch (err) {
+            if (fs.existsSync(downloadToPathname))
+                fs.unlinkSync(downloadToPathname); // Just in case there was a partial download, delete the file
+            if (!(err instanceof itwin_client_1.UserCancelledError))
+                core_bentley_1.Logger.logError(loggerCategory, `Error downloading file`);
+            throw err;
+        }
+        if (fileSize && fs.existsSync(downloadToPathname)) {
+            if (fs.lstatSync(downloadToPathname).size !== fileSize) {
+                fs.unlinkSync(downloadToPathname);
+                core_bentley_1.Logger.logError(loggerCategory, `Downloaded file is of incorrect size ${safeToLogUrl}`);
+                throw new itwin_client_1.DownloadFailed(403, "Download failed. Expected filesize does not match");
+            }
+        }
+        core_bentley_1.Logger.logTrace(loggerCategory, `Downloaded file from ${safeToLogUrl}`);
+    }
+    /** Get encoded block id from its number. */
+    getBlockId(blockId) {
+        return js_base64_1.Base64.encode(blockId.toString(16).padStart(5, "0"));
+    }
+    async uploadChunk(_accessToken, uploadUrlString, fileDescriptor, blockId, callback) {
+        const chunkSize = 4 * 1024 * 1024;
+        let buffer = Buffer.alloc(chunkSize);
+        const bytesRead = fs.readSync(fileDescriptor, buffer, 0, chunkSize, chunkSize * blockId);
+        buffer = buffer.slice(0, bytesRead);
+        const options = {
+            method: "PUT",
+            headers: {
+                "x-ms-blob-type": "BlockBlob",
+                "Content-Type": "application/octet-stream",
+                "Content-Length": buffer.length, // eslint-disable-line @typescript-eslint/naming-convention
+            },
+            body: buffer,
+            progressCallback: callback,
+            agent: this.agent,
+            timeout: {
+                deadline: 60000,
+                response: 60000,
+            },
+        };
+        const uploadUrl = `${uploadUrlString}&comp=block&blockid=${this.getBlockId(blockId)}`;
+        await (0, itwin_client_1.request)(uploadUrl, options);
+    }
+    /**
+     * Upload a file to AzureBlobStorage for iModelHub.
+     * @param uploadUrl URL to upload the file to.
+     * @param uploadFromPathname Pathname to upload the file from.
+     * @param progressCallback Callback for tracking progress.
+     * @throws [[IModelHubClientError]] with [IModelHubStatus.UndefinedArgumentError]($bentley) if one of the arguments is undefined or empty.
+     */
+    async uploadFile(accessToken, uploadUrlString, uploadFromPathname, progressCallback) {
+        const safeToLogUrl = MobileFileHandler.getSafeUrlForLogging(uploadUrlString);
+        core_bentley_1.Logger.logTrace(loggerCategory, `Uploading file to ${safeToLogUrl}`);
+        defined("uploadUrlString", uploadUrlString);
+        defined("uploadFromPathname", uploadFromPathname);
+        const fileSize = this.getFileSize(uploadFromPathname);
+        const file = fs.openSync(uploadFromPathname, "r");
+        const chunkSize = 4 * 1024 * 1024;
+        try {
+            let blockList = '<?xml version=\"1.0\" encoding=\"utf-8\"?><BlockList>';
+            let i = 0;
+            const callback = (progress) => {
+                const uploaded = i * chunkSize + progress.loaded;
+                progressCallback({ loaded: uploaded, percent: uploaded / fileSize, total: fileSize });
+            };
+            for (; i * chunkSize < fileSize; ++i) {
+                await this.uploadChunk(accessToken, uploadUrlString, file, i, progressCallback ? callback : undefined);
+                blockList += `<Latest>${this.getBlockId(i)}</Latest>`;
+            }
+            blockList += "</BlockList>";
+            const options = {
+                method: "PUT",
+                headers: {
+                    "Content-Type": "application/xml",
+                    "Content-Length": blockList.length, // eslint-disable-line @typescript-eslint/naming-convention
+                },
+                body: blockList,
+                agent: this.agent,
+                timeout: {
+                    response: 5000,
+                    deadline: 60000,
+                },
+            };
+            const uploadUrl = `${uploadUrlString}&comp=blocklist`;
+            await (0, itwin_client_1.request)(uploadUrl, options);
+        }
+        finally {
+            fs.closeSync(file);
+        }
+    }
+    /**
+     * Get size of a file.
+     * @param filePath Path of the file.
+     * @returns Size of the file.
+     */
+    getFileSize(filePath) {
+        return fs.statSync(filePath).size;
+    }
+    /**
+     * Check if path is a directory.
+     * @param filePath Path of the file.
+     * @returns True if path is directory.
+     */
+    isDirectory(filePath) {
+        return fs.statSync(filePath).isDirectory();
+    }
+    /**
+     * Check if path exists.
+     * @param filePath Path of the file.
+     * @returns True if path exists.
+     */
+    exists(filePath) {
+        return fs.existsSync(filePath);
+    }
+    /**
+     * Deletes file.
+     * @param filePath Path of the file.
+     */
+    unlink(filePath) {
+        fs.unlinkSync(filePath);
+    }
+    /**
+     * Get file name from the path.
+     * @param filePath Path of the file.
+     * @returns File name.
+     */
+    basename(filePath) {
+        return path.basename(filePath);
+    }
+    /**
+     * Join multiple strings into a single path.
+     * @param paths Strings to join.
+     * @returns Joined path.
+     */
+    join(...paths) {
+        return path.join(...paths);
+    }
+}
+exports.MobileFileHandler = MobileFileHandler;
+//# sourceMappingURL=MobileFileHandler.js.map

package/lib/cjs/backend/MobileFileHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MobileFileHandler.js","sourceRoot":"","sources":["../../../src/backend/MobileFileHandler.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yBAAyB;AAEzB,6BAA6B;AAC7B,sDAA0D;AAC1D,wDAG+B;AAC/B,6CAA0C;AAC1C,yCAAmC;AAEnC,MAAM,cAAc,GAAW,oBAAoB,CAAC;AAEpD,MAAM,OAAO,GAAG,CAAC,YAAoB,EAAE,QAAc,EAAE,aAAsB,KAAK,EAAE,EAAE;IACpF,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,IAAI,CAAC,QAAQ,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC;QACjF,MAAM,KAAK,CAAC,YAAY,YAAY,uBAAuB,CAAC,CAAC;AACjE,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAa,iBAAiB;IAI5B;;OAEG;IACH;IACA,CAAC;IAED,wEAAwE;IAChE,MAAM,CAAC,sBAAsB,CAAC,OAAe;QACnD,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC;YACxB,OAAO;QAET,iBAAiB,CAAC,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;QAChE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,oBAAoB,CAAC,GAAW;QAC7C,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,oBAAoB,CAAC,MAAM,IAAI,oBAAoB,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;YACvE,oBAAoB,CAAC,MAAM,GAAG,KAAK,CAAC;QACtC,IAAI,oBAAoB,CAAC,IAAI,IAAI,oBAAoB,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;YACnE,oBAAoB,CAAC,IAAI,GAAG,KAAK,CAAC;QACpC,OAAO,oBAAoB,CAAC,QAAQ,EAAE,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,WAAmB,EAAE,aAAsB;QACpE,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;QACpC,MAAM,EAAE,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,EAAE,EAAE;YACN,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,EAAE,CAAC,CAAC;YAC/B,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;YAC/C,IAAI,aAAa,EAAE;gBACjB,UAAU,CAAC,UAAU,CAAC,aAAa,GAAG,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC;aAChE;YACD,OAAO,SAAS,IAAI,UAAU,CAAC;SAChC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,YAAY,CAAC,YAAyB,EAAE,WAAmB,EAAE,kBAA0B,EAAE,QAAiB,EAAE,gBAAmC,EAAE,aAA6B;QACzL,yEAAyE;QACzE,MAAM,YAAY,GAAG,iBAAiB,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;QACzE,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,yBAAyB,YAAY,EAAE,CAAC,CAAC;QAExE,OAAO,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;QACpC,OAAO,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,CAAC;QAClD,IAAI,iBAAiB,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE;YAC/C,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,uBAAuB,YAAY,EAAE,CAAC,CAAC;YACvE,MAAM,IAAI,4BAAa,CAAC,GAAG,EAAE,0BAA0B,CAAC,CAAC;SAC1D;QACD,IAAI,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC;YACnC,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;QAEpC,iBAAiB,CAAC,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC;QAC3E,IAAI;YACF,MAAM,uBAAU,CAAC,YAAY,CAAC,WAAW,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,aAAa,CAAC,CAAC;SACjG;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC;gBACnC,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC,CAAC,6DAA6D;YAElG,IAAI,CAAC,CAAC,GAAG,YAAY,iCAAkB,CAAC;gBACtC,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,wBAAwB,CAAC,CAAC;YAC5D,MAAM,GAAG,CAAC;SACX;QACD,IAAI,QAAQ,IAAI,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE;YACjD,IAAI,EAAE,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC,IAAI,KAAK,QAAQ,EAAE;gBACtD,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;gBAClC,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,wCAAwC,YAAY,EAAE,CAAC,CAAC;gBACxF,MAAM,IAAI,6BAAc,CAAC,GAAG,EAAE,mDAAmD,CAAC,CAAC;aACpF;SACF;QACD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,wBAAwB,YAAY,EAAE,CAAC,CAAC;IAC1E,CAAC;IACD,4CAA4C;IACpC,UAAU,CAAC,OAAe;QAChC,OAAO,kBAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC9D,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,YAAyB,EAAE,eAAuB,EAAE,cAAsB,EAAE,OAAe,EAAE,QAA2B;QAChJ,MAAM,SAAS,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;QAClC,IAAI,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrC,MAAM,SAAS,GAAG,EAAE,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,CAAC;QACzF,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QAEpC,MAAM,OAAO,GAAmB;YAC9B,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,gBAAgB,EAAE,WAAW;gBAC7B,cAAc,EAAE,0BAA0B;gBAC1C,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,2DAA2D;aAC7F;YACD,IAAI,EAAE,MAAM;YACZ,gBAAgB,EAAE,QAAQ;YAC1B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,OAAO,EAAE;gBACP,QAAQ,EAAE,KAAK;gBACf,QAAQ,EAAE,KAAK;aAChB;SACF,CAAC;QAEF,MAAM,SAAS,GAAG,GAAG,eAAe,uBAAuB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACtF,MAAM,IAAA,sBAAO,EAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CAAC,WAAwB,EAAE,eAAuB,EAAE,kBAA0B,EAAE,gBAAmC;QACxI,MAAM,YAAY,GAAG,iBAAiB,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC;QAC7E,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,qBAAqB,YAAY,EAAE,CAAC,CAAC;QACrE,OAAO,CAAC,iBAAiB,EAAE,eAAe,CAAC,CAAC;QAC5C,OAAO,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,CAAC;QAElD,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;QACtD,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC;QAClD,MAAM,SAAS,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;QAElC,IAAI;YACF,IAAI,SAAS,GAAG,uDAAuD,CAAC;YACxE,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,MAAM,QAAQ,GAAqB,CAAC,QAAsB,EAAE,EAAE;gBAC5D,MAAM,QAAQ,GAAG,CAAC,GAAG,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC;gBACjD,gBAAiB,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,GAAG,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;YACzF,CAAC,CAAC;YACF,OAAO,CAAC,GAAG,SAAS,GAAG,QAAQ,EAAE,EAAE,CAAC,EAAE;gBACpC,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;gBACvG,SAAS,IAAI,WAAW,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC;aACvD;YACD,SAAS,IAAI,cAAc,CAAC;YAE5B,MAAM,OAAO,GAAmB;gBAC9B,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE;oBACP,cAAc,EAAE,iBAAiB;oBACjC,gBAAgB,EAAE,SAAS,CAAC,MAAM,EAAE,2DAA2D;iBAChG;gBACD,IAAI,EAAE,SAAS;gBACf,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,OAAO,EAAE;oBACP,QAAQ,EAAE,IAAI;oBACd,QAAQ,EAAE,KAAK;iBAChB;aACF,CAAC;YAEF,MAAM,SAAS,GAAG,GAAG,eAAe,iBAAiB,CAAC;YACtD,MAAM,IAAA,sBAAO,EAAC,SAAS,EAAE,OAAO,CAAC,CAAC;SACnC;gBAAS;YACR,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;SACpB;IACH,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,QAAgB;QACjC,OAAO,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,QAAgB;QACjC,OAAO,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAgB;QAC5B,OAAO,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAgB;QAC5B,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,QAAgB;QAC9B,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,GAAG,KAAe;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;IAC7B,CAAC;CACF;AApOD,8CAoOC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModelHub\r\n */\r\n\r\nimport * as fs from \"fs\";\r\nimport * as https from \"https\";\r\nimport * as path from \"path\";\r\nimport { AccessToken, Logger } from \"@itwin/core-bentley\";\r\nimport {\r\n  CancelRequest, DownloadFailed, FileHandler, ProgressCallback, ProgressInfo, request, RequestOptions, SasUrlExpired,\r\n  UserCancelledError,\r\n} from \"@bentley/itwin-client\";\r\nimport { MobileHost } from \"./MobileHost\";\r\nimport { Base64 } from \"js-base64\";\r\n\r\nconst loggerCategory: string = \"mobile.filehandler\";\r\n\r\nconst defined = (argumentName: string, argument?: any, allowEmpty: boolean = false) => {\r\n  if (argument === undefined || argument === null || (argument === \"\" && !allowEmpty))\r\n    throw Error(`Argument ${argumentName} is null or undefined`);\r\n};\r\n\r\n/**\r\n * Provides methods to work with the file system and azure storage. An instance of this class has to be provided to [[IModelClient]] for file upload/download methods to work.\r\n * @internal\r\n */\r\nexport class MobileFileHandler implements FileHandler {\r\n  /** @internal */\r\n  public agent?: https.Agent;\r\n\r\n  /**\r\n   * Constructor for MobileFileHandler.\r\n   */\r\n  constructor() {\r\n  }\r\n\r\n  /** Create a directory, recursively setting up the path as necessary. */\r\n  private static makeDirectoryRecursive(dirPath: string) {\r\n    if (fs.existsSync(dirPath))\r\n      return;\r\n\r\n    MobileFileHandler.makeDirectoryRecursive(path.dirname(dirPath));\r\n    fs.mkdirSync(dirPath);\r\n  }\r\n\r\n  /**\r\n   * Make url safe for logging by removing sensitive information\r\n   * @param url input url that will be strip of search and query parameters and replace them by ... for security reason\r\n   */\r\n  private static getSafeUrlForLogging(url: string): string {\r\n    const safeToLogDownloadUrl = new URL(url);\r\n    if (safeToLogDownloadUrl.search && safeToLogDownloadUrl.search.length > 0)\r\n      safeToLogDownloadUrl.search = \"...\";\r\n    if (safeToLogDownloadUrl.hash && safeToLogDownloadUrl.hash.length > 0)\r\n      safeToLogDownloadUrl.hash = \"...\";\r\n    return safeToLogDownloadUrl.toString();\r\n  }\r\n\r\n  /**\r\n   * Check if sas url has expired\r\n   * @param download sas url for download\r\n   * @param futureSeconds should be valid in future for given seconds.\r\n   */\r\n  public static isUrlExpired(downloadUrl: string, futureSeconds?: number): boolean {\r\n    const sasUrl = new URL(downloadUrl);\r\n    const se = sasUrl.searchParams.get(\"se\");\r\n    if (se) {\r\n      const expiryUTC = new Date(se);\r\n      const now = new Date();\r\n      const currentUTC = new Date(now.toUTCString());\r\n      if (futureSeconds) {\r\n        currentUTC.setSeconds(futureSeconds + currentUTC.getSeconds());\r\n      }\r\n      return expiryUTC <= currentUTC;\r\n    }\r\n    return false;\r\n  }\r\n\r\n  /**\r\n   * Download a file from AzureBlobStorage for iModelHub. Creates the directory containing the file if necessary. If there is an error in the operation, incomplete file is deleted from disk.\r\n   * @param downloadUrl URL to download file from.\r\n   * @param downloadToPathname Pathname to download the file to.\r\n   * @param fileSize Size of the file that's being downloaded.\r\n   * @param progressCallback Callback for tracking progress.\r\n   * @throws [[IModelHubClientError]] with [IModelHubStatus.UndefinedArgumentError]($bentley) if one of the arguments is undefined or empty.\r\n   */\r\n  public async downloadFile(_accessToken: AccessToken, downloadUrl: string, downloadToPathname: string, fileSize?: number, progressCallback?: ProgressCallback, cancelRequest?: CancelRequest): Promise<void> {\r\n    // strip search and hash parameters from download Url for logging purpose\r\n    const safeToLogUrl = MobileFileHandler.getSafeUrlForLogging(downloadUrl);\r\n    Logger.logInfo(loggerCategory, `Downloading file from ${safeToLogUrl}`);\r\n\r\n    defined(\"downloadUrl\", downloadUrl);\r\n    defined(\"downloadToPathname\", downloadToPathname);\r\n    if (MobileFileHandler.isUrlExpired(downloadUrl)) {\r\n      Logger.logError(loggerCategory, `Sas url has expired ${safeToLogUrl}`);\r\n      throw new SasUrlExpired(403, \"Download URL has expired\");\r\n    }\r\n    if (fs.existsSync(downloadToPathname))\r\n      fs.unlinkSync(downloadToPathname);\r\n\r\n    MobileFileHandler.makeDirectoryRecursive(path.dirname(downloadToPathname));\r\n    try {\r\n      await MobileHost.downloadFile(downloadUrl, downloadToPathname, progressCallback, cancelRequest);\r\n    } catch (err) {\r\n      if (fs.existsSync(downloadToPathname))\r\n        fs.unlinkSync(downloadToPathname); // Just in case there was a partial download, delete the file\r\n\r\n      if (!(err instanceof UserCancelledError))\r\n        Logger.logError(loggerCategory, `Error downloading file`);\r\n      throw err;\r\n    }\r\n    if (fileSize && fs.existsSync(downloadToPathname)) {\r\n      if (fs.lstatSync(downloadToPathname).size !== fileSize) {\r\n        fs.unlinkSync(downloadToPathname);\r\n        Logger.logError(loggerCategory, `Downloaded file is of incorrect size ${safeToLogUrl}`);\r\n        throw new DownloadFailed(403, \"Download failed. Expected filesize does not match\");\r\n      }\r\n    }\r\n    Logger.logTrace(loggerCategory, `Downloaded file from ${safeToLogUrl}`);\r\n  }\r\n  /** Get encoded block id from its number. */\r\n  private getBlockId(blockId: number) {\r\n    return Base64.encode(blockId.toString(16).padStart(5, \"0\"));\r\n  }\r\n\r\n  private async uploadChunk(_accessToken: AccessToken, uploadUrlString: string, fileDescriptor: number, blockId: number, callback?: ProgressCallback) {\r\n    const chunkSize = 4 * 1024 * 1024;\r\n    let buffer = Buffer.alloc(chunkSize);\r\n    const bytesRead = fs.readSync(fileDescriptor, buffer, 0, chunkSize, chunkSize * blockId);\r\n    buffer = buffer.slice(0, bytesRead);\r\n\r\n    const options: RequestOptions = {\r\n      method: \"PUT\",\r\n      headers: {\r\n        \"x-ms-blob-type\": \"BlockBlob\",\r\n        \"Content-Type\": \"application/octet-stream\", // eslint-disable-line @typescript-eslint/naming-convention\r\n        \"Content-Length\": buffer.length, // eslint-disable-line @typescript-eslint/naming-convention\r\n      },\r\n      body: buffer,\r\n      progressCallback: callback,\r\n      agent: this.agent,\r\n      timeout: {\r\n        deadline: 60000,\r\n        response: 60000,\r\n      },\r\n    };\r\n\r\n    const uploadUrl = `${uploadUrlString}&comp=block&blockid=${this.getBlockId(blockId)}`;\r\n    await request(uploadUrl, options);\r\n  }\r\n\r\n  /**\r\n   * Upload a file to AzureBlobStorage for iModelHub.\r\n   * @param uploadUrl URL to upload the file to.\r\n   * @param uploadFromPathname Pathname to upload the file from.\r\n   * @param progressCallback Callback for tracking progress.\r\n   * @throws [[IModelHubClientError]] with [IModelHubStatus.UndefinedArgumentError]($bentley) if one of the arguments is undefined or empty.\r\n   */\r\n  public async uploadFile(accessToken: AccessToken, uploadUrlString: string, uploadFromPathname: string, progressCallback?: ProgressCallback): Promise<void> {\r\n    const safeToLogUrl = MobileFileHandler.getSafeUrlForLogging(uploadUrlString);\r\n    Logger.logTrace(loggerCategory, `Uploading file to ${safeToLogUrl}`);\r\n    defined(\"uploadUrlString\", uploadUrlString);\r\n    defined(\"uploadFromPathname\", uploadFromPathname);\r\n\r\n    const fileSize = this.getFileSize(uploadFromPathname);\r\n    const file = fs.openSync(uploadFromPathname, \"r\");\r\n    const chunkSize = 4 * 1024 * 1024;\r\n\r\n    try {\r\n      let blockList = '<?xml version=\\\"1.0\\\" encoding=\\\"utf-8\\\"?><BlockList>';\r\n      let i = 0;\r\n      const callback: ProgressCallback = (progress: ProgressInfo) => {\r\n        const uploaded = i * chunkSize + progress.loaded;\r\n        progressCallback!({ loaded: uploaded, percent: uploaded / fileSize, total: fileSize });\r\n      };\r\n      for (; i * chunkSize < fileSize; ++i) {\r\n        await this.uploadChunk(accessToken, uploadUrlString, file, i, progressCallback ? callback : undefined);\r\n        blockList += `<Latest>${this.getBlockId(i)}</Latest>`;\r\n      }\r\n      blockList += \"</BlockList>\";\r\n\r\n      const options: RequestOptions = {\r\n        method: \"PUT\",\r\n        headers: {\r\n          \"Content-Type\": \"application/xml\", // eslint-disable-line @typescript-eslint/naming-convention\r\n          \"Content-Length\": blockList.length, // eslint-disable-line @typescript-eslint/naming-convention\r\n        },\r\n        body: blockList,\r\n        agent: this.agent,\r\n        timeout: {\r\n          response: 5000,\r\n          deadline: 60000,\r\n        },\r\n      };\r\n\r\n      const uploadUrl = `${uploadUrlString}&comp=blocklist`;\r\n      await request(uploadUrl, options);\r\n    } finally {\r\n      fs.closeSync(file);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Get size of a file.\r\n   * @param filePath Path of the file.\r\n   * @returns Size of the file.\r\n   */\r\n  public getFileSize(filePath: string): number {\r\n    return fs.statSync(filePath).size;\r\n  }\r\n\r\n  /**\r\n   * Check if path is a directory.\r\n   * @param filePath Path of the file.\r\n   * @returns True if path is directory.\r\n   */\r\n  public isDirectory(filePath: string): boolean {\r\n    return fs.statSync(filePath).isDirectory();\r\n  }\r\n\r\n  /**\r\n   * Check if path exists.\r\n   * @param filePath Path of the file.\r\n   * @returns True if path exists.\r\n   */\r\n  public exists(filePath: string): boolean {\r\n    return fs.existsSync(filePath);\r\n  }\r\n\r\n  /**\r\n   * Deletes file.\r\n   * @param filePath Path of the file.\r\n   */\r\n  public unlink(filePath: string): void {\r\n    fs.unlinkSync(filePath);\r\n  }\r\n\r\n  /**\r\n   * Get file name from the path.\r\n   * @param filePath Path of the file.\r\n   * @returns File name.\r\n   */\r\n  public basename(filePath: string): string {\r\n    return path.basename(filePath);\r\n  }\r\n\r\n  /**\r\n   * Join multiple strings into a single path.\r\n   * @param paths Strings to join.\r\n   * @returns Joined path.\r\n   */\r\n  public join(...paths: string[]): string {\r\n    return path.join(...paths);\r\n  }\r\n}\r\n"]}

package/lib/cjs/backend/MobileHost.d.ts

@@ -0,0 +1,78 @@
+import { BeEvent } from "@itwin/core-bentley";
+import { NativeHostOpts } from "@itwin/core-backend";
+import { NativeAppAuthorizationConfiguration, RpcInterfaceDefinition } from "@itwin/core-common";
+import { CancelRequest, ProgressCallback } from "@bentley/itwin-client";
+import { BatteryState, DeviceEvents, Orientation } from "../common/MobileAppProps";
+import { MobileAuthorizationBackend } from "./MobileAuthorizationBackend";
+/** @beta */
+export declare type MobileCompletionCallback = (downloadUrl: string, downloadFileUrl: string, cancelled: boolean, err?: string) => void;
+/** @beta */
+export declare type MobileProgressCallback = (bytesWritten: number, totalBytesWritten: number, totalBytesExpectedToWrite: number) => void;
+/** @beta */
+export declare type MobileCancelCallback = () => boolean;
+/** @beta */
+export interface DownloadTask {
+    url: string;
+    downloadPath: string;
+    isDetached: boolean;
+    isRunning: boolean;
+    totalBytes?: number;
+    doneBytes?: number;
+    cancelId?: number;
+    isBackground?: boolean;
+    cancel?: MobileCancelCallback;
+    toBackground: () => boolean;
+    toForeground: () => boolean;
+}
+/** @beta */
+export declare abstract class MobileDevice {
+    emit(eventName: DeviceEvents, ...args: any[]): void;
+    abstract getOrientation(): Orientation;
+    abstract getBatteryState(): BatteryState;
+    abstract getBatteryLevel(): number;
+    abstract createDownloadTask(downloadUrl: string, isBackground: boolean, downloadTo: string, completion: MobileCompletionCallback, progress?: MobileProgressCallback): number;
+    abstract cancelDownloadTask(cancelId: number): boolean;
+    abstract getDownloadTasks(): DownloadTask[];
+    abstract resumeDownloadInForeground(requestId: number): boolean;
+    abstract resumeDownloadInBackground(requestId: number): boolean;
+    abstract reconnect(connection: number): void;
+    abstract authSignIn(callback: (err?: string) => void): void;
+    abstract authSignOut(callback: (err?: string) => void): void;
+    abstract authGetAccessToken(callback: (accessToken?: string, err?: string) => void): void;
+    authInit(_config: NativeAppAuthorizationConfiguration, callback: (err?: string) => void): void;
+    abstract authStateChanged(accessToken?: string, err?: string): void;
+}
+/** @beta */
+export interface MobileHostOpts extends NativeHostOpts {
+    mobileHost?: {
+        device?: MobileDevice;
+        /** list of RPC interface definitions to register */
+        rpcInterfaces?: RpcInterfaceDefinition[];
+        /** if present, [[NativeHost.authorizationClient]] will be set to an instance of NativeAppAuthorizationBackend and will be initialized. */
+        authConfig?: NativeAppAuthorizationConfiguration;
+        /** if true, do not attempt to initialize AuthorizationClient on startup */
+        noInitializeAuthClient?: boolean;
+    };
+}
+/**
+ * @beta
+ */
+export declare class MobileHost {
+    private static _device?;
+    static get device(): MobileDevice;
+    static readonly onMemoryWarning: BeEvent<import("@itwin/core-bentley").Listener>;
+    static readonly onOrientationChanged: BeEvent<import("@itwin/core-bentley").Listener>;
+    static readonly onEnterForeground: BeEvent<import("@itwin/core-bentley").Listener>;
+    static readonly onEnterBackground: BeEvent<import("@itwin/core-bentley").Listener>;
+    static readonly onWillTerminate: BeEvent<import("@itwin/core-bentley").Listener>;
+    /** @internal */
+    static get authorization(): MobileAuthorizationBackend;
+    /**  @internal */
+    static reconnect(connection: number): void;
+    /**  @internal */
+    static downloadFile(downloadUrl: string, downloadTo: string, progress?: ProgressCallback, cancelRequest?: CancelRequest): Promise<void>;
+    static get isValid(): boolean;
+    /** Start the backend of a mobile app. */
+    static startup(opt?: MobileHostOpts): Promise<void>;
+}
+//# sourceMappingURL=MobileHost.d.ts.map

package/lib/cjs/backend/MobileHost.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MobileHost.d.ts","sourceRoot":"","sources":["../../../src/backend/MobileHost.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAmB,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAA+C,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAClG,OAAO,EACuE,mCAAmC,EAAE,sBAAsB,EAExI,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,aAAa,EAAkB,gBAAgB,EAAsB,MAAM,uBAAuB,CAAC;AAE5G,OAAO,EAAE,YAAY,EAAE,YAAY,EAAwC,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEzH,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAG1E,YAAY;AACZ,oBAAY,wBAAwB,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;AAChI,YAAY;AACZ,oBAAY,sBAAsB,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,yBAAyB,EAAE,MAAM,KAAK,IAAI,CAAC;AAClI,YAAY;AACZ,oBAAY,oBAAoB,GAAG,MAAM,OAAO,CAAC;AAEjD,YAAY;AACZ,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,YAAY,EAAE,MAAM,OAAO,CAAC;IAC5B,YAAY,EAAE,MAAM,OAAO,CAAC;CAC7B;AAED,YAAY;AACZ,8BAAsB,YAAY;IACzB,IAAI,CAAC,SAAS,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE;aAenC,cAAc,IAAI,WAAW;aAC7B,eAAe,IAAI,YAAY;aAC/B,eAAe,IAAI,MAAM;aACzB,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,wBAAwB,EAAE,QAAQ,CAAC,EAAE,sBAAsB,GAAG,MAAM;aACnK,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;aAC7C,gBAAgB,IAAI,YAAY,EAAE;aAClC,0BAA0B,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;aACtD,0BAA0B,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;aACtD,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;aACnC,UAAU,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;aAClD,WAAW,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;aACnD,kBAAkB,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IACzF,QAAQ,CAAC,OAAO,EAAE,mCAAmC,EAAE,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;aACrF,gBAAgB,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI;CAC3E;AASD,YAAY;AACZ,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD,UAAU,CAAC,EAAE;QACX,MAAM,CAAC,EAAE,YAAY,CAAC;QACtB,oDAAoD;QACpD,aAAa,CAAC,EAAE,sBAAsB,EAAE,CAAC;QACzC,0IAA0I;QAC1I,UAAU,CAAC,EAAE,mCAAmC,CAAC;QACjD,2EAA2E;QAC3E,sBAAsB,CAAC,EAAE,OAAO,CAAC;KAClC,CAAC;CACH;AAED;;GAEG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAe;IACtC,WAAkB,MAAM,iBAA4B;IACpD,gBAAuB,eAAe,kDAAiB;IACvD,gBAAuB,oBAAoB,kDAAiB;IAC5D,gBAAuB,iBAAiB,kDAAiB;IACzD,gBAAuB,iBAAiB,kDAAiB;IACzD,gBAAuB,eAAe,kDAAiB;IAEvD,gBAAgB;IAChB,WAAkB,aAAa,+BAA2E;IAE1G,iBAAiB;WACH,SAAS,CAAC,UAAU,EAAE,MAAM;IAI1C,iBAAiB;WACG,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAmCpJ,WAAkB,OAAO,YAAyC;IAElE,yCAAyC;WACrB,OAAO,CAAC,GAAG,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CA6BjE"}

package/lib/cjs/backend/MobileHost.js

@@ -0,0 +1,126 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MobileHost = exports.MobileDevice = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_backend_1 = require("@itwin/core-backend");
+const core_common_1 = require("@itwin/core-common");
+const itwin_client_1 = require("@bentley/itwin-client");
+const presentation_common_1 = require("@itwin/presentation-common");
+const MobileAppProps_1 = require("../common/MobileAppProps");
+const MobileRpcManager_1 = require("../common/MobileRpcManager");
+const MobileAuthorizationBackend_1 = require("./MobileAuthorizationBackend");
+const MobileRpcServer_1 = require("./MobileRpcServer");
+/** @beta */
+class MobileDevice {
+    emit(eventName, ...args) {
+        switch (eventName) {
+            case "memoryWarning":
+                MobileHost.onMemoryWarning.raiseEvent(...args);
+                break;
+            case "orientationChanged":
+                MobileHost.onOrientationChanged.raiseEvent(...args);
+                break;
+            case "enterForeground":
+                MobileHost.onEnterForeground.raiseEvent(...args);
+                break;
+            case "enterBackground":
+                MobileHost.onEnterBackground.raiseEvent(...args);
+                break;
+            case "willTerminate":
+                MobileHost.onWillTerminate.raiseEvent(...args);
+                break;
+        }
+    }
+    authInit(_config, callback) { callback(); }
+}
+exports.MobileDevice = MobileDevice;
+class MobileAppHandler extends core_backend_1.IpcHandler {
+    get channelName() { return MobileAppProps_1.mobileAppChannel; }
+    async reconnect(connection) {
+        MobileHost.reconnect(connection);
+    }
+}
+/**
+ * @beta
+ */
+class MobileHost {
+    static get device() { return this._device; }
+    /** @internal */
+    static get authorization() { return core_backend_1.IModelHost.authorizationClient; }
+    /**  @internal */
+    static reconnect(connection) {
+        this.device.reconnect(connection);
+    }
+    /**  @internal */
+    static async downloadFile(downloadUrl, downloadTo, progress, cancelRequest) {
+        return new Promise((resolve, reject) => {
+            let progressCb;
+            let lastReportedOn = Date.now();
+            const minTimeBeforeReportingProgress = 1000;
+            if (progress) {
+                progressCb = (_bytesWritten, totalBytesWritten, totalBytesExpectedToWrite) => {
+                    const currentTime = Date.now();
+                    const timeSinceLastEvent = currentTime - lastReportedOn;
+                    // report all event for last 5 Mbs so we never miss 100% progress event
+                    const lastEvent = (totalBytesExpectedToWrite - totalBytesWritten) < 1024 * 1024 * 5;
+                    if (timeSinceLastEvent < minTimeBeforeReportingProgress && !lastEvent)
+                        return;
+                    lastReportedOn = currentTime;
+                    const percent = Number((100 * (totalBytesWritten / totalBytesExpectedToWrite)).toFixed(2));
+                    progress({ total: totalBytesExpectedToWrite, loaded: totalBytesWritten, percent });
+                };
+            }
+            const requestId = this.device.createDownloadTask(downloadUrl, false, downloadTo, (_downloadUrl, _downloadFileUrl, cancelled, err) => {
+                if (cancelled)
+                    reject(new itwin_client_1.UserCancelledError(core_bentley_1.BriefcaseStatus.DownloadCancelled, "User cancelled download"));
+                else if (err)
+                    reject(new itwin_client_1.DownloadFailed(400, "Download failed"));
+                else
+                    resolve();
+            }, progressCb);
+            if (cancelRequest) {
+                // eslint-disable-next-line @typescript-eslint/unbound-method
+                cancelRequest.cancel = () => { return this.device.cancelDownloadTask(requestId); };
+            }
+        });
+    }
+    static get isValid() { return undefined !== this._device; }
+    /** Start the backend of a mobile app. */
+    static async startup(opt) {
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        if (!this.isValid) {
+            this._device = (_b = (_a = opt === null || opt === void 0 ? void 0 : opt.mobileHost) === null || _a === void 0 ? void 0 : _a.device) !== null && _b !== void 0 ? _b : new MobileDevice();
+            // set global device interface.
+            global.__iTwinJsNativeBridge = this._device;
+            // following will provide impl for device specific api.
+            (0, MobileRpcServer_1.setupMobileRpc)();
+        }
+        await core_backend_1.NativeHost.startup(opt);
+        if (core_backend_1.IpcHost.isValid)
+            MobileAppHandler.register();
+        const rpcInterfaces = (_d = (_c = opt === null || opt === void 0 ? void 0 : opt.mobileHost) === null || _c === void 0 ? void 0 : _c.rpcInterfaces) !== null && _d !== void 0 ? _d : [
+            core_common_1.IModelReadRpcInterface,
+            core_common_1.IModelTileRpcInterface,
+            core_common_1.SnapshotIModelRpcInterface,
+            presentation_common_1.PresentationRpcInterface,
+        ];
+        MobileRpcManager_1.MobileRpcManager.initializeImpl(rpcInterfaces);
+        const authorizationBackend = new MobileAuthorizationBackend_1.MobileAuthorizationBackend((_e = opt === null || opt === void 0 ? void 0 : opt.mobileHost) === null || _e === void 0 ? void 0 : _e.authConfig);
+        const connectivityStatus = core_backend_1.NativeHost.checkInternetConnectivity();
+        if (((_f = opt === null || opt === void 0 ? void 0 : opt.mobileHost) === null || _f === void 0 ? void 0 : _f.authConfig) && true !== ((_g = opt === null || opt === void 0 ? void 0 : opt.mobileHost) === null || _g === void 0 ? void 0 : _g.noInitializeAuthClient) && connectivityStatus === core_common_1.InternetConnectivityStatus.Online) {
+            await authorizationBackend.initialize((_h = opt === null || opt === void 0 ? void 0 : opt.mobileHost) === null || _h === void 0 ? void 0 : _h.authConfig);
+        }
+        core_backend_1.IModelHost.authorizationClient = authorizationBackend;
+    }
+}
+exports.MobileHost = MobileHost;
+MobileHost.onMemoryWarning = new core_bentley_1.BeEvent();
+MobileHost.onOrientationChanged = new core_bentley_1.BeEvent();
+MobileHost.onEnterForeground = new core_bentley_1.BeEvent();
+MobileHost.onEnterBackground = new core_bentley_1.BeEvent();
+MobileHost.onWillTerminate = new core_bentley_1.BeEvent();
+//# sourceMappingURL=MobileHost.js.map

package/lib/cjs/backend/MobileHost.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MobileHost.js","sourceRoot":"","sources":["../../../src/backend/MobileHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,sDAA+D;AAC/D,sDAAkG;AAClG,oDAG4B;AAC5B,wDAA4G;AAC5G,oEAAsE;AACtE,6DAAyH;AACzH,iEAA8D;AAC9D,6EAA0E;AAC1E,uDAAmD;AAwBnD,YAAY;AACZ,MAAsB,YAAY;IACzB,IAAI,CAAC,SAAuB,EAAE,GAAG,IAAW;QACjD,QAAQ,SAAS,EAAE;YACjB,KAAK,eAAe;gBAClB,UAAU,CAAC,eAAe,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;gBAAC,MAAM;YACxD,KAAK,oBAAoB;gBACvB,UAAU,CAAC,oBAAoB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;gBAAC,MAAM;YAC7D,KAAK,iBAAiB;gBACpB,UAAU,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;gBAAC,MAAM;YAC1D,KAAK,iBAAiB;gBACpB,UAAU,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;gBAAC,MAAM;YAC1D,KAAK,eAAe;gBAClB,UAAU,CAAC,eAAe,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;gBAAC,MAAM;SACzD;IACH,CAAC;IAcM,QAAQ,CAAC,OAA4C,EAAE,QAAgC,IAAU,QAAQ,EAAE,CAAC,CAAC,CAAC;CAEtH;AA9BD,oCA8BC;AAED,MAAM,gBAAiB,SAAQ,yBAAU;IACvC,IAAW,WAAW,KAAK,OAAO,iCAAgB,CAAC,CAAC,CAAC;IAC9C,KAAK,CAAC,SAAS,CAAC,UAAkB;QACvC,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACnC,CAAC;CACF;AAeD;;GAEG;AACH,MAAa,UAAU;IAEd,MAAM,KAAK,MAAM,KAAK,OAAO,IAAI,CAAC,OAAQ,CAAC,CAAC,CAAC;IAOpD,gBAAgB;IACT,MAAM,KAAK,aAAa,KAAK,OAAO,yBAAU,CAAC,mBAAiD,CAAC,CAAC,CAAC;IAE1G,iBAAiB;IACV,MAAM,CAAC,SAAS,CAAC,UAAkB;QACxC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACpC,CAAC;IAED,iBAAiB;IACV,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,WAAmB,EAAE,UAAkB,EAAE,QAA2B,EAAE,aAA6B;QAClI,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAE3C,IAAI,UAA8C,CAAC;YACnD,IAAI,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAChC,MAAM,8BAA8B,GAAG,IAAI,CAAC;YAC5C,IAAI,QAAQ,EAAE;gBACZ,UAAU,GAAG,CAAC,aAAqB,EAAE,iBAAyB,EAAE,yBAAiC,EAAE,EAAE;oBACnG,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBAC/B,MAAM,kBAAkB,GAAG,WAAW,GAAG,cAAc,CAAC;oBACxD,uEAAuE;oBACvE,MAAM,SAAS,GAAG,CAAC,yBAAyB,GAAG,iBAAiB,CAAC,GAAG,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC;oBACpF,IAAI,kBAAkB,GAAG,8BAA8B,IAAI,CAAC,SAAS;wBACnE,OAAO;oBAET,cAAc,GAAG,WAAW,CAAC;oBAC7B,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,GAAG,GAAG,CAAC,iBAAiB,GAAG,yBAAyB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC3F,QAAQ,CAAC,EAAE,KAAK,EAAE,yBAAyB,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO,EAAE,CAAC,CAAC;gBACrF,CAAC,CAAC;aACH;YACD,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,YAAoB,EAAE,gBAAwB,EAAE,SAAkB,EAAE,GAAY,EAAE,EAAE;gBACpK,IAAI,SAAS;oBACX,MAAM,CAAC,IAAI,iCAAkB,CAAC,8BAAe,CAAC,iBAAiB,EAAE,yBAAyB,CAAC,CAAC,CAAC;qBAC1F,IAAI,GAAG;oBACV,MAAM,CAAC,IAAI,6BAAc,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC,CAAC;;oBAEnD,OAAO,EAAE,CAAC;YACd,CAAC,EAAE,UAAU,CAAC,CAAC;YACf,IAAI,aAAa,EAAE;gBACjB,6DAA6D;gBAC7D,aAAa,CAAC,MAAM,GAAG,GAAG,EAAE,GAAG,OAAO,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;aACpF;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,KAAK,OAAO,KAAK,OAAO,SAAS,KAAK,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAElE,yCAAyC;IAClC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAoB;;QAC9C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,OAAO,GAAG,MAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,0CAAE,MAAM,mCAAI,IAAK,YAAoB,EAAE,CAAC;YACtE,+BAA+B;YAC9B,MAAc,CAAC,qBAAqB,GAAG,IAAI,CAAC,OAAO,CAAC;YACrD,uDAAuD;YACvD,IAAA,gCAAc,GAAE,CAAC;SAClB;QAED,MAAM,yBAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,sBAAO,CAAC,OAAO;YACjB,gBAAgB,CAAC,QAAQ,EAAE,CAAC;QAE9B,MAAM,aAAa,GAAG,MAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,0CAAE,aAAa,mCAAI;YACtD,oCAAsB;YACtB,oCAAsB;YACtB,wCAA0B;YAC1B,8CAAwB;SACzB,CAAC;QAEF,mCAAgB,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAE/C,MAAM,oBAAoB,GAAG,IAAI,uDAA0B,CAAC,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,0CAAE,UAAU,CAAC,CAAC;QACzF,MAAM,kBAAkB,GAAG,yBAAU,CAAC,yBAAyB,EAAE,CAAC;QAClE,IAAI,CAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,0CAAE,UAAU,KAAI,IAAI,MAAK,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,0CAAE,sBAAsB,CAAA,IAAI,kBAAkB,KAAK,wCAA0B,CAAC,MAAM,EAAE;YAC/I,MAAM,oBAAoB,CAAC,UAAU,CAAC,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,0CAAE,UAAU,CAAC,CAAC;SACpE;QACD,yBAAU,CAAC,mBAAmB,GAAG,oBAAoB,CAAC;IACxD,CAAC;;AApFH,gCAqFC;AAlFwB,0BAAe,GAAG,IAAI,sBAAO,EAAE,CAAC;AAChC,+BAAoB,GAAG,IAAI,sBAAO,EAAE,CAAC;AACrC,4BAAiB,GAAG,IAAI,sBAAO,EAAE,CAAC;AAClC,4BAAiB,GAAG,IAAI,sBAAO,EAAE,CAAC;AAClC,0BAAe,GAAG,IAAI,sBAAO,EAAE,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport { BeEvent, BriefcaseStatus } from \"@itwin/core-bentley\";\r\nimport { IModelHost, IpcHandler, IpcHost, NativeHost, NativeHostOpts } from \"@itwin/core-backend\";\r\nimport {\r\n  IModelReadRpcInterface, IModelTileRpcInterface, InternetConnectivityStatus, NativeAppAuthorizationConfiguration, RpcInterfaceDefinition,\r\n  SnapshotIModelRpcInterface,\r\n} from \"@itwin/core-common\";\r\nimport { CancelRequest, DownloadFailed, ProgressCallback, UserCancelledError } from \"@bentley/itwin-client\";\r\nimport { PresentationRpcInterface } from \"@itwin/presentation-common\";\r\nimport { BatteryState, DeviceEvents, mobileAppChannel, MobileAppFunctions, Orientation } from \"../common/MobileAppProps\";\r\nimport { MobileRpcManager } from \"../common/MobileRpcManager\";\r\nimport { MobileAuthorizationBackend } from \"./MobileAuthorizationBackend\";\r\nimport { setupMobileRpc } from \"./MobileRpcServer\";\r\n\r\n/** @beta */\r\nexport type MobileCompletionCallback = (downloadUrl: string, downloadFileUrl: string, cancelled: boolean, err?: string) => void;\r\n/** @beta */\r\nexport type MobileProgressCallback = (bytesWritten: number, totalBytesWritten: number, totalBytesExpectedToWrite: number) => void;\r\n/** @beta */\r\nexport type MobileCancelCallback = () => boolean;\r\n\r\n/** @beta */\r\nexport interface DownloadTask {\r\n  url: string;\r\n  downloadPath: string;\r\n  isDetached: boolean;\r\n  isRunning: boolean;\r\n  totalBytes?: number;\r\n  doneBytes?: number;\r\n  cancelId?: number;\r\n  isBackground?: boolean;\r\n  cancel?: MobileCancelCallback;\r\n  toBackground: () => boolean;\r\n  toForeground: () => boolean;\r\n}\r\n\r\n/** @beta */\r\nexport abstract class MobileDevice {\r\n  public emit(eventName: DeviceEvents, ...args: any[]) {\r\n    switch (eventName) {\r\n      case \"memoryWarning\":\r\n        MobileHost.onMemoryWarning.raiseEvent(...args); break;\r\n      case \"orientationChanged\":\r\n        MobileHost.onOrientationChanged.raiseEvent(...args); break;\r\n      case \"enterForeground\":\r\n        MobileHost.onEnterForeground.raiseEvent(...args); break;\r\n      case \"enterBackground\":\r\n        MobileHost.onEnterBackground.raiseEvent(...args); break;\r\n      case \"willTerminate\":\r\n        MobileHost.onWillTerminate.raiseEvent(...args); break;\r\n    }\r\n  }\r\n\r\n  public abstract getOrientation(): Orientation;\r\n  public abstract getBatteryState(): BatteryState;\r\n  public abstract getBatteryLevel(): number;\r\n  public abstract createDownloadTask(downloadUrl: string, isBackground: boolean, downloadTo: string, completion: MobileCompletionCallback, progress?: MobileProgressCallback): number;\r\n  public abstract cancelDownloadTask(cancelId: number): boolean;\r\n  public abstract getDownloadTasks(): DownloadTask[];\r\n  public abstract resumeDownloadInForeground(requestId: number): boolean;\r\n  public abstract resumeDownloadInBackground(requestId: number): boolean;\r\n  public abstract reconnect(connection: number): void;\r\n  public abstract authSignIn(callback: (err?: string) => void): void;\r\n  public abstract authSignOut(callback: (err?: string) => void): void;\r\n  public abstract authGetAccessToken(callback: (accessToken?: string, err?: string) => void): void;\r\n  public authInit(_config: NativeAppAuthorizationConfiguration, callback: (err?: string) => void): void { callback(); }\r\n  public abstract authStateChanged(accessToken?: string, err?: string): void;\r\n}\r\n\r\nclass MobileAppHandler extends IpcHandler implements MobileAppFunctions {\r\n  public get channelName() { return mobileAppChannel; }\r\n  public async reconnect(connection: number) {\r\n    MobileHost.reconnect(connection);\r\n  }\r\n}\r\n\r\n/** @beta */\r\nexport interface MobileHostOpts extends NativeHostOpts {\r\n  mobileHost?: {\r\n    device?: MobileDevice;\r\n    /** list of RPC interface definitions to register */\r\n    rpcInterfaces?: RpcInterfaceDefinition[];\r\n    /** if present, [[NativeHost.authorizationClient]] will be set to an instance of NativeAppAuthorizationBackend and will be initialized. */\r\n    authConfig?: NativeAppAuthorizationConfiguration;\r\n    /** if true, do not attempt to initialize AuthorizationClient on startup */\r\n    noInitializeAuthClient?: boolean;\r\n  };\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport class MobileHost {\r\n  private static _device?: MobileDevice;\r\n  public static get device() { return this._device!; }\r\n  public static readonly onMemoryWarning = new BeEvent();\r\n  public static readonly onOrientationChanged = new BeEvent();\r\n  public static readonly onEnterForeground = new BeEvent();\r\n  public static readonly onEnterBackground = new BeEvent();\r\n  public static readonly onWillTerminate = new BeEvent();\r\n\r\n  /** @internal */\r\n  public static get authorization() { return IModelHost.authorizationClient as MobileAuthorizationBackend; }\r\n\r\n  /**  @internal */\r\n  public static reconnect(connection: number) {\r\n    this.device.reconnect(connection);\r\n  }\r\n\r\n  /**  @internal */\r\n  public static async downloadFile(downloadUrl: string, downloadTo: string, progress?: ProgressCallback, cancelRequest?: CancelRequest): Promise<void> {\r\n    return new Promise<void>((resolve, reject) => {\r\n\r\n      let progressCb: MobileProgressCallback | undefined;\r\n      let lastReportedOn = Date.now();\r\n      const minTimeBeforeReportingProgress = 1000;\r\n      if (progress) {\r\n        progressCb = (_bytesWritten: number, totalBytesWritten: number, totalBytesExpectedToWrite: number) => {\r\n          const currentTime = Date.now();\r\n          const timeSinceLastEvent = currentTime - lastReportedOn;\r\n          // report all event for last 5 Mbs so we never miss 100% progress event\r\n          const lastEvent = (totalBytesExpectedToWrite - totalBytesWritten) < 1024 * 1024 * 5;\r\n          if (timeSinceLastEvent < minTimeBeforeReportingProgress && !lastEvent)\r\n            return;\r\n\r\n          lastReportedOn = currentTime;\r\n          const percent = Number((100 * (totalBytesWritten / totalBytesExpectedToWrite)).toFixed(2));\r\n          progress({ total: totalBytesExpectedToWrite, loaded: totalBytesWritten, percent });\r\n        };\r\n      }\r\n      const requestId = this.device.createDownloadTask(downloadUrl, false, downloadTo, (_downloadUrl: string, _downloadFileUrl: string, cancelled: boolean, err?: string) => {\r\n        if (cancelled)\r\n          reject(new UserCancelledError(BriefcaseStatus.DownloadCancelled, \"User cancelled download\"));\r\n        else if (err)\r\n          reject(new DownloadFailed(400, \"Download failed\"));\r\n        else\r\n          resolve();\r\n      }, progressCb);\r\n      if (cancelRequest) {\r\n        // eslint-disable-next-line @typescript-eslint/unbound-method\r\n        cancelRequest.cancel = () => { return this.device.cancelDownloadTask(requestId); };\r\n      }\r\n    });\r\n  }\r\n\r\n  public static get isValid() { return undefined !== this._device; }\r\n\r\n  /** Start the backend of a mobile app. */\r\n  public static async startup(opt?: MobileHostOpts): Promise<void> {\r\n    if (!this.isValid) {\r\n      this._device = opt?.mobileHost?.device ?? new (MobileDevice as any)();\r\n      // set global device interface.\r\n      (global as any).__iTwinJsNativeBridge = this._device;\r\n      // following will provide impl for device specific api.\r\n      setupMobileRpc();\r\n    }\r\n\r\n    await NativeHost.startup(opt);\r\n    if (IpcHost.isValid)\r\n      MobileAppHandler.register();\r\n\r\n    const rpcInterfaces = opt?.mobileHost?.rpcInterfaces ?? [\r\n      IModelReadRpcInterface,\r\n      IModelTileRpcInterface,\r\n      SnapshotIModelRpcInterface,\r\n      PresentationRpcInterface,\r\n    ];\r\n\r\n    MobileRpcManager.initializeImpl(rpcInterfaces);\r\n\r\n    const authorizationBackend = new MobileAuthorizationBackend(opt?.mobileHost?.authConfig);\r\n    const connectivityStatus = NativeHost.checkInternetConnectivity();\r\n    if (opt?.mobileHost?.authConfig && true !== opt?.mobileHost?.noInitializeAuthClient && connectivityStatus === InternetConnectivityStatus.Online) {\r\n      await authorizationBackend.initialize(opt?.mobileHost?.authConfig);\r\n    }\r\n    IModelHost.authorizationClient = authorizationBackend;\r\n  }\r\n}\r\n"]}

package/lib/cjs/backend/MobileRpcServer.d.ts

@@ -0,0 +1,19 @@
+import { MobileRpcGateway } from "../common/MobileRpcProtocol";
+export declare class MobileRpcServer {
+    private static _nextId;
+    static interop: MobileRpcGateway;
+    private _server;
+    private _connection;
+    private _port;
+    private _connectionId;
+    private _pingTimer;
+    constructor();
+    private _onListening;
+    private _notifyListening;
+    private _onConnection;
+    private _createSender;
+    private _onConnectionMessage;
+    dispose(): void;
+}
+export declare function setupMobileRpc(): void;
+//# sourceMappingURL=MobileRpcServer.d.ts.map

package/lib/cjs/backend/MobileRpcServer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MobileRpcServer.d.ts","sourceRoot":"","sources":["../../../src/backend/MobileRpcServer.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,gBAAgB,EAAqB,MAAM,6BAA6B,CAAC;AAYlF,qBAAa,eAAe;IAC1B,OAAO,CAAC,MAAM,CAAC,OAAO,CAAM;IAE5B,OAAc,OAAO,EAAE,gBAAgB,CAMrC;IAEF,OAAO,CAAC,OAAO,CAAY;IAC3B,OAAO,CAAC,WAAW,CAAiB;IACpC,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,UAAU,CAAiB;;IAoBnC,OAAO,CAAC,YAAY;IASpB,OAAO,CAAC,gBAAgB;IAYxB,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,aAAa;IAiBrB,OAAO,CAAC,oBAAoB;IAiBrB,OAAO;CAUf;AAKD,wBAAgB,cAAc,SAiC7B"}