@itwin/core-backend 5.0.0-dev.10 → 5.0.0-dev.102

package/lib/esm/NativeAppStorage.js

@@ -0,0 +1,205 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module NativeApp
+ */
+import { join, relative } from "node:path";
+import { DbResult, IModelStatus } from "@itwin/core-bentley";
+import { IModelError } from "@itwin/core-common";
+import { ECDb, ECDbOpenMode } from "./ECDb";
+import { IModelHost } from "./IModelHost";
+import { IModelJsFs } from "./IModelJsFs";
+import { NativeHost } from "./NativeHost";
+// cspell:ignore ecdb
+/**
+ * A local file stored in the [[NativeHost.appSettingsCacheDir]] for storing key/value pairs.
+ * @public
+ */
+export class NativeAppStorage {
+    _ecdb;
+    id;
+    static _ext = ".settings-db";
+    static _storages = new Map();
+    static _init = false;
+    constructor(_ecdb, id) {
+        this._ecdb = _ecdb;
+        this.id = id;
+    }
+    /** Set the value for a key */
+    setData(key, value) {
+        const rc = this._ecdb.withPreparedSqliteStatement("INSERT INTO app_setting(key,type,val)VALUES(?,?,?) ON CONFLICT(key) DO UPDATE SET type=excluded.type,val=excluded.val", (stmt) => {
+            let valType = (value === undefined || value === null) ? "null" : typeof value;
+            if (valType === "object" && (value instanceof Uint8Array))
+                valType = "Uint8Array";
+            switch (valType) {
+                case "null":
+                case "number":
+                case "string":
+                case "boolean":
+                case "Uint8Array":
+                    break;
+                default:
+                    throw new IModelError(DbResult.BE_SQLITE_ERROR, `Unsupported type ${valType} for value for key='${key}`);
+            }
+            stmt.bindValue(1, key);
+            stmt.bindValue(2, valType);
+            stmt.bindValue(3, value);
+            return stmt.step();
+        });
+        if (rc !== DbResult.BE_SQLITE_DONE)
+            throw new IModelError(rc, "SQLite error");
+        this._ecdb.saveChanges();
+    }
+    /** Get the value for a key from this Storage. If key is not present or is null, return undefined. */
+    getData(key) {
+        return this._ecdb.withPreparedSqliteStatement("SELECT type,val FROM app_setting WHERE key=?", (stmt) => {
+            stmt.bindValue(1, key);
+            if (DbResult.BE_SQLITE_ROW !== stmt.step())
+                return undefined;
+            const valType = stmt.getValueString(0);
+            switch (valType) {
+                case "number":
+                    return stmt.getValueDouble(1);
+                case "string":
+                    return stmt.getValueString(1);
+                case "boolean":
+                    return Boolean(stmt.getValueInteger(1));
+                case "Uint8Array":
+                    return stmt.getValueBlob(1);
+                case "null":
+                    return undefined;
+            }
+            throw new IModelError(DbResult.BE_SQLITE_ERROR, `Unsupported type in cache ${valType}`);
+        });
+    }
+    /** return the type of the value for a key, or undefined if not present. */
+    getValueType(key) {
+        return this._ecdb.withSqliteStatement("SELECT type FROM app_setting WHERE key=?", (stmt) => {
+            stmt.bindValue(1, key);
+            return stmt.step() === DbResult.BE_SQLITE_ROW ? stmt.getValueString(0) : undefined;
+        });
+    }
+    /** return `true` if the key is present, but has a null value. */
+    hasNullValue(key) {
+        return this.getValueType(key) === "null";
+    }
+    /** Get the value for a key as a string. If it is not present, or not of type string, return undefined */
+    getString(key) {
+        const val = this.getData(key);
+        return typeof val === "string" ? val : undefined;
+    }
+    /** Get the value for a key as a number. If it is not present, or not of type number, return undefined */
+    getNumber(key) {
+        const val = this.getData(key);
+        return typeof val === "number" ? val : undefined;
+    }
+    /** Get the value for a key as a boolean. If it is not present, or not of type boolean, return undefined */
+    getBoolean(key) {
+        const val = this.getData(key);
+        return typeof val === "boolean" ? val : undefined;
+    }
+    /** Get the value for a key as a Uint8Array. If it is not present, or not of type Uint8Array, return undefined */
+    getUint8Array(key) {
+        const val = this.getData(key);
+        return val instanceof Uint8Array ? val : undefined;
+    }
+    /** Get all key names in this Storage */
+    getKeys() {
+        const keys = new Array();
+        this._ecdb.withPreparedSqliteStatement("SELECT key FROM app_setting", (stmt) => {
+            while (DbResult.BE_SQLITE_ROW === stmt.step()) {
+                keys.push(stmt.getValueString(0));
+            }
+        });
+        return keys;
+    }
+    /** Remove a key/value pair from this Storage */
+    removeData(key) {
+        const rc = this._ecdb.withPreparedSqliteStatement("DELETE FROM app_setting WHERE key=?", (stmt) => {
+            stmt.bindValue(1, key);
+            return stmt.step();
+        });
+        if (rc !== DbResult.BE_SQLITE_DONE) {
+            throw new IModelError(rc, "SQLite error");
+        }
+    }
+    /** Remove all key/value pairs */
+    removeAll() {
+        const rc = this._ecdb.withPreparedSqliteStatement("DELETE FROM app_setting", (stmt) => {
+            return stmt.step();
+        });
+        if (rc !== DbResult.BE_SQLITE_DONE) {
+            throw new IModelError(rc, "SQLite error");
+        }
+    }
+    /** Close this Storage. */
+    close(deleteFile = false) {
+        const storageFile = join(NativeHost.appSettingsCacheDir, this.id);
+        this._ecdb.saveChanges();
+        this._ecdb.closeDb();
+        this._ecdb = undefined;
+        if (deleteFile)
+            IModelJsFs.removeSync(storageFile);
+        NativeAppStorage._storages.delete(this.id);
+    }
+    static init(ecdb) {
+        return ecdb.withPreparedSqliteStatement("CREATE TABLE app_setting(key PRIMARY KEY,type,val);", (stmt) => {
+            return stmt.step();
+        });
+    }
+    /** find and open storage by its name. */
+    static find(name) {
+        const storage = this._storages.get(name);
+        if (undefined === storage)
+            throw new IModelError(IModelStatus.FileNotFound, `Storage ${name} not open`);
+        return storage;
+    }
+    /** Close all opened Storages.
+     * @internal
+     */
+    static closeAll() {
+        this._storages.forEach((value) => value.close());
+        this._storages.clear();
+    }
+    /** @internal */
+    static getStorageNames() {
+        return IModelJsFs.readdirSync(NativeHost.appSettingsCacheDir).filter((name) => name.endsWith(this._ext));
+    }
+    /** Open or find a Storage by name. */
+    static open(name) {
+        if (!this._init) {
+            IModelHost.onBeforeShutdown.addOnce(() => this.closeAll());
+            this._init = true;
+        }
+        if (name.includes("\x00"))
+            throw new Error("Storage name contains illegal characters");
+        const fileName = name + this._ext;
+        if (!IModelJsFs.existsSync(NativeHost.appSettingsCacheDir))
+            IModelJsFs.recursiveMkDirSync(NativeHost.appSettingsCacheDir);
+        const storageFile = join(NativeHost.appSettingsCacheDir, fileName);
+        if (relative(NativeHost.appSettingsCacheDir, storageFile).startsWith(".."))
+            throw new Error("Storage name should not be a path");
+        try {
+            return this.find(fileName); // see if it's already open
+        }
+        catch {
+            const ecdb = new ECDb();
+            if (IModelJsFs.existsSync(storageFile)) {
+                ecdb.openDb(storageFile, ECDbOpenMode.ReadWrite);
+            }
+            else {
+                ecdb.createDb(storageFile);
+                const rc = this.init(ecdb);
+                if (rc !== DbResult.BE_SQLITE_DONE)
+                    throw new IModelError(rc, "SQLite error");
+                ecdb.saveChanges();
+            }
+            const storage = new NativeAppStorage(ecdb, fileName);
+            this._storages.set(fileName, storage);
+            return storage;
+        }
+    }
+}
+//# sourceMappingURL=NativeAppStorage.js.map

package/lib/esm/NativeAppStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NativeAppStorage.js","sourceRoot":"","sources":["../../src/NativeAppStorage.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAgB,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAqB;AAErB;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAIC;IAA6B;IAHjD,MAAM,CAAU,IAAI,GAAG,cAAc,CAAC;IACtC,MAAM,CAAC,SAAS,GAAG,IAAI,GAAG,EAA4B,CAAC;IACvD,MAAM,CAAC,KAAK,GAAY,KAAK,CAAC;IACtC,YAA4B,KAAW,EAAkB,EAAU;QAAvC,UAAK,GAAL,KAAK,CAAM;QAAkB,OAAE,GAAF,EAAE,CAAQ;IAAI,CAAC;IAExE,8BAA8B;IACvB,OAAO,CAAC,GAAW,EAAE,KAAmB;QAC7C,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,2BAA2B,CAAC,uHAAuH,EAAE,CAAC,IAAI,EAAE,EAAE;YAClL,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC;YAC9E,IAAI,OAAO,KAAK,QAAQ,IAAI,CAAC,KAAK,YAAY,UAAU,CAAC;gBACvD,OAAO,GAAG,YAAY,CAAC;YAEzB,QAAQ,OAAO,EAAE,CAAC;gBAChB,KAAK,MAAM,CAAC;gBACZ,KAAK,QAAQ,CAAC;gBACd,KAAK,QAAQ,CAAC;gBACd,KAAK,SAAS,CAAC;gBACf,KAAK,YAAY;oBACf,MAAM;gBACR;oBACE,MAAM,IAAI,WAAW,CAAC,QAAQ,CAAC,eAAe,EAAE,oBAAoB,OAAO,uBAAuB,GAAG,EAAE,CAAC,CAAC;YAC7G,CAAC;YAED,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACvB,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC3B,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YACzB,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QACH,IAAI,EAAE,KAAK,QAAQ,CAAC,cAAc;YAChC,MAAM,IAAI,WAAW,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAE5C,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;IAC3B,CAAC;IAED,qGAAqG;IAC9F,OAAO,CAAC,GAAW;QACxB,OAAO,IAAI,CAAC,KAAK,CAAC,2BAA2B,CAAC,8CAA8C,EAAE,CAAC,IAAI,EAAE,EAAE;YACrG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACvB,IAAI,QAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE;gBACxC,OAAO,SAAS,CAAC;YACnB,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;YACvC,QAAQ,OAAO,EAAE,CAAC;gBAChB,KAAK,QAAQ;oBACX,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;gBAChC,KAAK,QAAQ;oBACX,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;gBAChC,KAAK,SAAS;oBACZ,OAAO,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC1C,KAAK,YAAY;oBACf,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;gBAC9B,KAAK,MAAM;oBACT,OAAO,SAAS,CAAC;YACrB,CAAC;YACD,MAAM,IAAI,WAAW,CAAC,QAAQ,CAAC,eAAe,EAAE,6BAA6B,OAAO,EAAE,CAAC,CAAC;QAC1F,CAAC,CAAC,CAAC;IACL,CAAC;IAED,2EAA2E;IACpE,YAAY,CAAC,GAAW;QAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,0CAA0C,EAAE,CAAC,IAAI,EAAE,EAAE;YACzF,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACvB,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5F,CAAC,CAAC,CAAC;IACL,CAAC;IAED,iEAAiE;IAC1D,YAAY,CAAC,GAAW;QAC7B,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,MAAM,CAAC;IAC3C,CAAC;IAED,yGAAyG;IAClG,SAAS,CAAC,GAAW;QAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC9B,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IACnD,CAAC;IAED,yGAAyG;IAClG,SAAS,CAAC,GAAW;QAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC9B,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IACnD,CAAC;IAED,2GAA2G;IACpG,UAAU,CAAC,GAAW;QAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC9B,OAAO,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IACpD,CAAC;IAED,iHAAiH;IAC1G,aAAa,CAAC,GAAW;QAC9B,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC9B,OAAO,GAAG,YAAY,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IACrD,CAAC;IAED,wCAAwC;IACjC,OAAO;QACZ,MAAM,IAAI,GAAG,IAAI,KAAK,EAAU,CAAC;QACjC,IAAI,CAAC,KAAK,CAAC,2BAA2B,CAAC,6BAA6B,EAAE,CAAC,IAAI,EAAE,EAAE;YAC7E,OAAO,QAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBAC9C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;YACpC,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gDAAgD;IACzC,UAAU,CAAC,GAAW;QAC3B,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,2BAA2B,CAAC,qCAAqC,EAAE,CAAC,IAAI,EAAE,EAAE;YAChG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACvB,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QACH,IAAI,EAAE,KAAK,QAAQ,CAAC,cAAc,EAAE,CAAC;YACnC,MAAM,IAAI,WAAW,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,iCAAiC;IAC1B,SAAS;QACd,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,2BAA2B,CAAC,yBAAyB,EAAE,CAAC,IAAI,EAAE,EAAE;YACpF,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QACH,IAAI,EAAE,KAAK,QAAQ,CAAC,cAAc,EAAE,CAAC;YACnC,MAAM,IAAI,WAAW,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,0BAA0B;IACnB,KAAK,CAAC,aAAsB,KAAK;QACtC,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QACzB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACpB,IAAI,CAAC,KAAa,GAAG,SAAS,CAAC;QAChC,IAAI,UAAU;YACZ,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACrC,gBAAgB,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7C,CAAC;IAEO,MAAM,CAAC,IAAI,CAAC,IAAU;QAC5B,OAAO,IAAI,CAAC,2BAA2B,CAAC,qDAAqD,EAAE,CAAC,IAAI,EAAE,EAAE;YACtG,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,yCAAyC;IAClC,MAAM,CAAC,IAAI,CAAC,IAAY;QAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,SAAS,KAAK,OAAO;YACvB,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,WAAW,IAAI,WAAW,CAAC,CAAC;QAC/E,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ;QACpB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IACzB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,eAAe;QAC3B,OAAO,UAAU,CAAC,WAAW,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3G,CAAC;IAED,sCAAsC;IAC/B,MAAM,CAAC,IAAI,CAAC,IAAY;QAC7B,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAChB,UAAU,CAAC,gBAAgB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC3D,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QACpB,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9D,MAAM,QAAQ,GAAG,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAClC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,mBAAmB,CAAC;YACxD,UAAU,CAAC,kBAAkB,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAEhE,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;QACnE,IAAI,QAAQ,CAAC,UAAU,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC;YACxE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAEvD,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,2BAA2B;QACzD,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;YACxB,IAAI,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;gBACvC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;YACnD,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;gBAC3B,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3B,IAAI,EAAE,KAAK,QAAQ,CAAC,cAAc;oBAChC,MAAM,IAAI,WAAW,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;gBAC5C,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,CAAC;YACD,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACrD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACtC,OAAO,OAAO,CAAC;QACjB,CAAC;IACH,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/** @packageDocumentation\r\n * @module NativeApp\r\n */\r\n\r\nimport { join, relative } from \"node:path\";\r\nimport { DbResult, IModelStatus } from \"@itwin/core-bentley\";\r\nimport { IModelError, StorageValue } from \"@itwin/core-common\";\r\nimport { ECDb, ECDbOpenMode } from \"./ECDb\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\nimport { NativeHost } from \"./NativeHost\";\r\n\r\n// cspell:ignore ecdb\r\n\r\n/**\r\n * A local file stored in the [[NativeHost.appSettingsCacheDir]] for storing key/value pairs.\r\n * @public\r\n */\r\nexport class NativeAppStorage {\r\n  private static readonly _ext = \".settings-db\";\r\n  private static _storages = new Map<string, NativeAppStorage>();\r\n  private static _init: boolean = false;\r\n  private constructor(private _ecdb: ECDb, public readonly id: string) { }\r\n\r\n  /** Set the value for a key */\r\n  public setData(key: string, value: StorageValue): void {\r\n    const rc = this._ecdb.withPreparedSqliteStatement(\"INSERT INTO app_setting(key,type,val)VALUES(?,?,?) ON CONFLICT(key) DO UPDATE SET type=excluded.type,val=excluded.val\", (stmt) => {\r\n      let valType = (value === undefined || value === null) ? \"null\" : typeof value;\r\n      if (valType === \"object\" && (value instanceof Uint8Array))\r\n        valType = \"Uint8Array\";\r\n\r\n      switch (valType) {\r\n        case \"null\":\r\n        case \"number\":\r\n        case \"string\":\r\n        case \"boolean\":\r\n        case \"Uint8Array\":\r\n          break;\r\n        default:\r\n          throw new IModelError(DbResult.BE_SQLITE_ERROR, `Unsupported type ${valType} for value for key='${key}`);\r\n      }\r\n\r\n      stmt.bindValue(1, key);\r\n      stmt.bindValue(2, valType);\r\n      stmt.bindValue(3, value);\r\n      return stmt.step();\r\n    });\r\n    if (rc !== DbResult.BE_SQLITE_DONE)\r\n      throw new IModelError(rc, \"SQLite error\");\r\n\r\n    this._ecdb.saveChanges();\r\n  }\r\n\r\n  /** Get the value for a key from this Storage. If key is not present or is null, return undefined. */\r\n  public getData(key: string): StorageValue {\r\n    return this._ecdb.withPreparedSqliteStatement(\"SELECT type,val FROM app_setting WHERE key=?\", (stmt) => {\r\n      stmt.bindValue(1, key);\r\n      if (DbResult.BE_SQLITE_ROW !== stmt.step())\r\n        return undefined;\r\n      const valType = stmt.getValueString(0);\r\n      switch (valType) {\r\n        case \"number\":\r\n          return stmt.getValueDouble(1);\r\n        case \"string\":\r\n          return stmt.getValueString(1);\r\n        case \"boolean\":\r\n          return Boolean(stmt.getValueInteger(1));\r\n        case \"Uint8Array\":\r\n          return stmt.getValueBlob(1);\r\n        case \"null\":\r\n          return undefined;\r\n      }\r\n      throw new IModelError(DbResult.BE_SQLITE_ERROR, `Unsupported type in cache ${valType}`);\r\n    });\r\n  }\r\n\r\n  /** return the type of the value for a key, or undefined if not present. */\r\n  public getValueType(key: string): \"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined {\r\n    return this._ecdb.withSqliteStatement(\"SELECT type FROM app_setting WHERE key=?\", (stmt) => {\r\n      stmt.bindValue(1, key);\r\n      return stmt.step() === DbResult.BE_SQLITE_ROW ? stmt.getValueString(0) as any : undefined;\r\n    });\r\n  }\r\n\r\n  /** return `true` if the key is present, but has a null value. */\r\n  public hasNullValue(key: string): boolean {\r\n    return this.getValueType(key) === \"null\";\r\n  }\r\n\r\n  /** Get the value for a key as a string. If it is not present, or not of type string, return undefined */\r\n  public getString(key: string): string | undefined {\r\n    const val = this.getData(key);\r\n    return typeof val === \"string\" ? val : undefined;\r\n  }\r\n\r\n  /** Get the value for a key as a number. If it is not present, or not of type number, return undefined */\r\n  public getNumber(key: string): number | undefined {\r\n    const val = this.getData(key);\r\n    return typeof val === \"number\" ? val : undefined;\r\n  }\r\n\r\n  /** Get the value for a key as a boolean. If it is not present, or not of type boolean, return undefined */\r\n  public getBoolean(key: string): boolean | undefined {\r\n    const val = this.getData(key);\r\n    return typeof val === \"boolean\" ? val : undefined;\r\n  }\r\n\r\n  /** Get the value for a key as a Uint8Array. If it is not present, or not of type Uint8Array, return undefined */\r\n  public getUint8Array(key: string): Uint8Array | undefined {\r\n    const val = this.getData(key);\r\n    return val instanceof Uint8Array ? val : undefined;\r\n  }\r\n\r\n  /** Get all key names in this Storage */\r\n  public getKeys(): string[] {\r\n    const keys = new Array<string>();\r\n    this._ecdb.withPreparedSqliteStatement(\"SELECT key FROM app_setting\", (stmt) => {\r\n      while (DbResult.BE_SQLITE_ROW === stmt.step()) {\r\n        keys.push(stmt.getValueString(0));\r\n      }\r\n    });\r\n    return keys;\r\n  }\r\n\r\n  /** Remove a key/value pair from this Storage */\r\n  public removeData(key: string) {\r\n    const rc = this._ecdb.withPreparedSqliteStatement(\"DELETE FROM app_setting WHERE key=?\", (stmt) => {\r\n      stmt.bindValue(1, key);\r\n      return stmt.step();\r\n    });\r\n    if (rc !== DbResult.BE_SQLITE_DONE) {\r\n      throw new IModelError(rc, \"SQLite error\");\r\n    }\r\n  }\r\n\r\n  /** Remove all key/value pairs */\r\n  public removeAll() {\r\n    const rc = this._ecdb.withPreparedSqliteStatement(\"DELETE FROM app_setting\", (stmt) => {\r\n      return stmt.step();\r\n    });\r\n    if (rc !== DbResult.BE_SQLITE_DONE) {\r\n      throw new IModelError(rc, \"SQLite error\");\r\n    }\r\n  }\r\n\r\n  /** Close this Storage. */\r\n  public close(deleteFile: boolean = false) {\r\n    const storageFile = join(NativeHost.appSettingsCacheDir, this.id);\r\n    this._ecdb.saveChanges();\r\n    this._ecdb.closeDb();\r\n    (this._ecdb as any) = undefined;\r\n    if (deleteFile)\r\n      IModelJsFs.removeSync(storageFile);\r\n    NativeAppStorage._storages.delete(this.id);\r\n  }\r\n\r\n  private static init(ecdb: ECDb): DbResult {\r\n    return ecdb.withPreparedSqliteStatement(\"CREATE TABLE app_setting(key PRIMARY KEY,type,val);\", (stmt) => {\r\n      return stmt.step();\r\n    });\r\n  }\r\n\r\n  /** find and open storage by its name. */\r\n  public static find(name: string): NativeAppStorage {\r\n    const storage = this._storages.get(name);\r\n    if (undefined === storage)\r\n      throw new IModelError(IModelStatus.FileNotFound, `Storage ${name} not open`);\r\n    return storage;\r\n  }\r\n\r\n  /** Close all opened Storages.\r\n   * @internal\r\n   */\r\n  public static closeAll() {\r\n    this._storages.forEach((value) => value.close());\r\n    this._storages.clear();\r\n  }\r\n\r\n  /** @internal */\r\n  public static getStorageNames(): string[] {\r\n    return IModelJsFs.readdirSync(NativeHost.appSettingsCacheDir).filter((name) => name.endsWith(this._ext));\r\n  }\r\n\r\n  /** Open or find a Storage by name. */\r\n  public static open(name: string): NativeAppStorage {\r\n    if (!this._init) {\r\n      IModelHost.onBeforeShutdown.addOnce(() => this.closeAll());\r\n      this._init = true;\r\n    }\r\n    if (name.includes(\"\\x00\"))\r\n      throw new Error(\"Storage name contains illegal characters\");\r\n    const fileName = name + this._ext;\r\n    if (!IModelJsFs.existsSync(NativeHost.appSettingsCacheDir))\r\n      IModelJsFs.recursiveMkDirSync(NativeHost.appSettingsCacheDir);\r\n\r\n    const storageFile = join(NativeHost.appSettingsCacheDir, fileName);\r\n    if (relative(NativeHost.appSettingsCacheDir, storageFile).startsWith(\"..\"))\r\n      throw new Error(\"Storage name should not be a path\");\r\n\r\n    try {\r\n      return this.find(fileName); // see if it's already open\r\n    } catch {\r\n      const ecdb = new ECDb();\r\n      if (IModelJsFs.existsSync(storageFile)) {\r\n        ecdb.openDb(storageFile, ECDbOpenMode.ReadWrite);\r\n      } else {\r\n        ecdb.createDb(storageFile);\r\n        const rc = this.init(ecdb);\r\n        if (rc !== DbResult.BE_SQLITE_DONE)\r\n          throw new IModelError(rc, \"SQLite error\");\r\n        ecdb.saveChanges();\r\n      }\r\n      const storage = new NativeAppStorage(ecdb, fileName);\r\n      this._storages.set(fileName, storage);\r\n      return storage;\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/esm/NativeHost.d.ts

@@ -0,0 +1,53 @@
+/** @packageDocumentation
+ * @module NativeApp
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { InternetConnectivityStatus, NativeAppNotifications, OverriddenBy } from "@itwin/core-common";
+import { IpcHostOpts } from "./IpcHost";
+import { NativeAppStorage } from "./NativeAppStorage";
+/** Options for [[NativeHost.startup]]
+ * @public
+ */
+export interface NativeHostOpts extends IpcHostOpts {
+    nativeHost?: {
+        /** Application name. Used, for example, to name the settings file. If not supplied, defaults to "iTwinApp". */
+        applicationName?: string;
+    };
+}
+/**
+ * Backend for desktop/mobile native applications
+ * @public
+ */
+export declare class NativeHost {
+    private static _reachability?;
+    private static _applicationName;
+    private constructor();
+    /** Event called when the internet connectivity changes, if known. */
+    static readonly onInternetConnectivityChanged: BeEvent<(status: InternetConnectivityStatus) => void>;
+    private static _appSettingsCacheDir?;
+    /** Get the local cache folder for application settings */
+    static get appSettingsCacheDir(): string;
+    /** Send a notification to the NativeApp connected to this NativeHost. */
+    static notifyNativeFrontend<T extends keyof NativeAppNotifications>(methodName: T, ...args: Parameters<NativeAppNotifications[T]>): void;
+    private static _isValid;
+    static get isValid(): boolean;
+    static get applicationName(): string;
+    /** Get the settings store for this NativeHost. */
+    static get settingsStore(): NativeAppStorage;
+    /**
+     * Start the backend of a native app.
+     * @note this method calls [[IpcHost.startup]] internally.
+     */
+    static startup(opt?: NativeHostOpts): Promise<void>;
+    /** Shutdown native app backend. Also calls [[IpcHost.shutdown]] */
+    static shutdown(): Promise<void>;
+    /** get current value of internet connectivity */
+    static checkInternetConnectivity(): InternetConnectivityStatus;
+    /**
+     * Override internet connectivity state
+     * @param _overridenBy who overrode the value.
+     * @internal
+     */
+    static overrideInternetConnectivity(_overridenBy: OverriddenBy, status: InternetConnectivityStatus): void;
+}
+//# sourceMappingURL=NativeHost.d.ts.map

package/lib/esm/NativeHost.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NativeHost.d.ts","sourceRoot":"","sources":["../../src/NativeHost.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAuB,OAAO,EAAc,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EACW,0BAA0B,EAAgE,sBAAsB,EAChI,YAAY,EACb,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAAuB,WAAW,EAA4B,MAAM,WAAW,CAAC;AACvF,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAoGtD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,UAAU,CAAC,EAAE;QACX,+GAA+G;QAC/G,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;CACH;AAED;;;GAGG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAA6B;IAC1D,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAS;IACxC,OAAO;IAEP,qEAAqE;IACrE,gBAAuB,6BAA6B,mBAAwB,0BAA0B,KAAK,IAAI,EAAI;IAEnH,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAS;IAE7C,0DAA0D;IAC1D,WAAkB,mBAAmB,IAAI,MAAM,CAE9C;IAED,yEAAyE;WAC3D,oBAAoB,CAAC,CAAC,SAAS,MAAM,sBAAsB,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAIxI,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAS;IAChC,WAAkB,OAAO,IAAI,OAAO,CAA0B;IAC9D,WAAkB,eAAe,WAAoC;IACrE,kDAAkD;IAClD,WAAkB,aAAa,qBAE9B;IAED;;;OAGG;WACiB,OAAO,CAAC,GAAG,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAahE,mEAAmE;WAC/C,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAM7C,iDAAiD;WACnC,yBAAyB,IAAI,0BAA0B;IAIrE;;;;OAIG;WACW,4BAA4B,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,0BAA0B,GAAG,IAAI;CAMjH"}

package/lib/esm/NativeHost.js

@@ -0,0 +1,158 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module NativeApp
+ */
+import { join } from "path";
+import { assert, BeEvent } from "@itwin/core-bentley";
+import { InternetConnectivityStatus, nativeAppIpcStrings, } from "@itwin/core-common";
+import { BriefcaseManager } from "./BriefcaseManager";
+import { Downloads, ProgressStatus } from "./CheckpointManager";
+import { IModelHost } from "./IModelHost";
+import { IpcHandler, IpcHost, throttleProgressCallback } from "./IpcHost";
+import { NativeAppStorage } from "./NativeAppStorage";
+/**
+ * Implementation of NativeAppFunctions
+ */
+class NativeAppHandler extends IpcHandler {
+    get channelName() { return nativeAppIpcStrings.channelName; }
+    async getAccessToken() {
+        return IModelHost.authorizationClient?.getAccessToken();
+    }
+    async checkInternetConnectivity() {
+        return NativeHost.checkInternetConnectivity();
+    }
+    async overrideInternetConnectivity(by, status) {
+        NativeHost.overrideInternetConnectivity(by, status);
+    }
+    async acquireNewBriefcaseId(iModelId) {
+        return BriefcaseManager.acquireNewBriefcaseId({ iModelId });
+    }
+    async getBriefcaseFileName(props) {
+        return BriefcaseManager.getFileName(props);
+    }
+    async downloadBriefcase(request, reportProgress, progressInterval) {
+        const args = {
+            ...request,
+            accessToken: await this.getAccessToken(),
+            onProgress: (_a, _b) => checkAbort(),
+        };
+        const checkAbort = () => {
+            assert(undefined !== args.fileName);
+            const job = Downloads.isInProgress(args.fileName);
+            return (job && job.request.abort === 1) ? ProgressStatus.Abort : ProgressStatus.Continue;
+        };
+        if (reportProgress) {
+            const progressCallback = (loaded, total) => {
+                IpcHost.send(`nativeApp.progress-${request.iModelId}`, { loaded, total });
+                return checkAbort();
+            };
+            args.onProgress = throttleProgressCallback(progressCallback, checkAbort, progressInterval);
+        }
+        return BriefcaseManager.downloadBriefcase(args);
+    }
+    async requestCancelDownloadBriefcase(fileName) {
+        const job = Downloads.isInProgress(fileName);
+        if (job)
+            job.request.abort = 1;
+        return job !== undefined;
+    }
+    async deleteBriefcaseFiles(fileName) {
+        await BriefcaseManager.deleteBriefcaseFiles(fileName, await IModelHost.getAccessToken());
+    }
+    async getCachedBriefcases(iModelId) {
+        return BriefcaseManager.getCachedBriefcases(iModelId);
+    }
+    async storageMgrOpen(storageId) {
+        return NativeAppStorage.open(storageId).id;
+    }
+    async storageMgrClose(storageId, deleteIt) {
+        NativeAppStorage.find(storageId).close(deleteIt);
+    }
+    async storageMgrNames() {
+        return NativeAppStorage.getStorageNames();
+    }
+    async storageGetValueType(storageId, key) {
+        return NativeAppStorage.find(storageId).getValueType(key);
+    }
+    async storageGet(storageId, key) {
+        return NativeAppStorage.find(storageId).getData(key);
+    }
+    async storageSet(storageId, key, value) {
+        NativeAppStorage.find(storageId).setData(key, value);
+    }
+    async storageRemove(storageId, key) {
+        NativeAppStorage.find(storageId).removeData(key);
+    }
+    async storageKeys(storageId) {
+        return NativeAppStorage.find(storageId).getKeys();
+    }
+    async storageRemoveAll(storageId) {
+        NativeAppStorage.find(storageId).removeAll();
+    }
+}
+/**
+ * Backend for desktop/mobile native applications
+ * @public
+ */
+export class NativeHost {
+    static _reachability;
+    static _applicationName;
+    constructor() { } // no instances - static methods only
+    /** Event called when the internet connectivity changes, if known. */
+    static onInternetConnectivityChanged = new BeEvent();
+    static _appSettingsCacheDir;
+    /** Get the local cache folder for application settings */
+    static get appSettingsCacheDir() {
+        return this._appSettingsCacheDir ??= join(IModelHost.cacheDir, "appSettings");
+    }
+    /** Send a notification to the NativeApp connected to this NativeHost. */
+    static notifyNativeFrontend(methodName, ...args) {
+        return IpcHost.send(nativeAppIpcStrings.notifyChannel, methodName, ...args);
+    }
+    static _isValid = false;
+    static get isValid() { return this._isValid; }
+    static get applicationName() { return this._applicationName; }
+    /** Get the settings store for this NativeHost. */
+    static get settingsStore() {
+        return NativeAppStorage.open(this.applicationName);
+    }
+    /**
+     * Start the backend of a native app.
+     * @note this method calls [[IpcHost.startup]] internally.
+     */
+    static async startup(opt) {
+        if (!this.isValid) {
+            this._isValid = true;
+            this.onInternetConnectivityChanged.addListener((status) => NativeHost.notifyNativeFrontend("notifyInternetConnectivityChanged", status));
+            this._applicationName = opt?.nativeHost?.applicationName ?? "iTwinApp";
+        }
+        await IpcHost.startup(opt);
+        if (IpcHost.isValid) // for tests, we use NativeHost but don't have a frontend
+            NativeAppHandler.register();
+    }
+    /** Shutdown native app backend. Also calls [[IpcHost.shutdown]] */
+    static async shutdown() {
+        this._isValid = false;
+        this.onInternetConnectivityChanged.clear();
+        await IpcHost.shutdown();
+    }
+    /** get current value of internet connectivity */
+    static checkInternetConnectivity() {
+        return this._reachability ?? InternetConnectivityStatus.Online;
+    }
+    /**
+     * Override internet connectivity state
+     * @param _overridenBy who overrode the value.
+     * @internal
+     */
+    static overrideInternetConnectivity(_overridenBy, status) {
+        if (this._reachability !== status) {
+            this._reachability = status;
+            this.onInternetConnectivityChanged.raiseEvent(status);
+        }
+    }
+}
+//# sourceMappingURL=NativeHost.js.map

package/lib/esm/NativeHost.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NativeHost.js","sourceRoot":"","sources":["../../src/NativeHost.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,EAAe,MAAM,EAAE,OAAO,EAAc,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EACW,0BAA0B,EAA2C,mBAAmB,GAEzG,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAA0B,MAAM,oBAAoB,CAAC;AAC9E,OAAO,EAAE,SAAS,EAAoB,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAClF,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,OAAO,EAAe,wBAAwB,EAAE,MAAM,WAAW,CAAC;AACvF,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;GAEG;AACH,MAAM,gBAAiB,SAAQ,UAAU;IACvC,IAAW,WAAW,KAAK,OAAO,mBAAmB,CAAC,WAAW,CAAC,CAAC,CAAC;IAE7D,KAAK,CAAC,cAAc;QACzB,OAAO,UAAU,CAAC,mBAAmB,EAAE,cAAc,EAAE,CAAC;IAC1D,CAAC;IAEM,KAAK,CAAC,yBAAyB;QACpC,OAAO,UAAU,CAAC,yBAAyB,EAAE,CAAC;IAChD,CAAC;IACM,KAAK,CAAC,4BAA4B,CAAC,EAAgB,EAAE,MAAkC;QAC5F,UAAU,CAAC,4BAA4B,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IACM,KAAK,CAAC,qBAAqB,CAAC,QAAoB;QACrD,OAAO,gBAAgB,CAAC,qBAAqB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC9D,CAAC;IACM,KAAK,CAAC,oBAAoB,CAAC,KAAqB;QACrD,OAAO,gBAAgB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;IACM,KAAK,CAAC,iBAAiB,CAAC,OAAiC,EAAE,cAAuB,EAAE,gBAAyB;QAClH,MAAM,IAAI,GAA2B;YACnC,GAAG,OAAO;YACV,WAAW,EAAE,MAAM,IAAI,CAAC,cAAc,EAAE;YACxC,UAAU,EAAE,CAAC,EAAU,EAAE,EAAU,EAAE,EAAE,CAAC,UAAU,EAAE;SACrD,CAAC;QAEF,MAAM,UAAU,GAAG,GAAG,EAAE;YACtB,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpC,MAAM,GAAG,GAAG,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAClD,OAAO,CAAC,GAAG,IAAK,GAAG,CAAC,OAAe,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC;QACpG,CAAC,CAAC;QAEF,IAAI,cAAc,EAAE,CAAC;YACnB,MAAM,gBAAgB,GAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBAC3D,OAAO,CAAC,IAAI,CAAC,sBAAsB,OAAO,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC1E,OAAO,UAAU,EAAE,CAAC;YACtB,CAAC,CAAC;YACF,IAAI,CAAC,UAAU,GAAG,wBAAwB,CAAC,gBAAgB,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;QAC7F,CAAC;QAED,OAAO,gBAAgB,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IAEM,KAAK,CAAC,8BAA8B,CAAC,QAAgB;QAC1D,MAAM,GAAG,GAAG,SAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC7C,IAAI,GAAG;YACJ,GAAG,CAAC,OAAe,CAAC,KAAK,GAAG,CAAC,CAAC;QACjC,OAAO,GAAG,KAAK,SAAS,CAAC;IAC3B,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,QAAgB;QAChD,MAAM,gBAAgB,CAAC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;IAC3F,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,QAAqB;QACpD,OAAO,gBAAgB,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,SAAiB;QAC3C,OAAO,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,SAAiB,EAAE,QAAiB;QAC/D,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,OAAO,gBAAgB,CAAC,eAAe,EAAE,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,SAAiB,EAAE,GAAW;QAC7D,OAAO,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IAC5D,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,GAAW;QACpD,OAAO,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,GAAW,EAAE,KAAmB;QACzE,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,SAAiB,EAAE,GAAW;QACvD,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,SAAiB;QACxC,OAAO,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC;IACpD,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,SAAiB;QAC7C,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC;IAC/C,CAAC;CACF;AAYD;;;GAGG;AACH,MAAM,OAAO,UAAU;IACb,MAAM,CAAC,aAAa,CAA8B;IAClD,MAAM,CAAC,gBAAgB,CAAS;IACxC,gBAAwB,CAAC,CAAC,qCAAqC;IAE/D,qEAAqE;IAC9D,MAAM,CAAU,6BAA6B,GAAG,IAAI,OAAO,EAAgD,CAAC;IAE3G,MAAM,CAAC,oBAAoB,CAAU;IAE7C,0DAA0D;IACnD,MAAM,KAAK,mBAAmB;QACnC,OAAO,IAAI,CAAC,oBAAoB,KAAK,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;IAChF,CAAC;IAED,yEAAyE;IAClE,MAAM,CAAC,oBAAoB,CAAyC,UAAa,EAAE,GAAG,IAA2C;QACtI,OAAO,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IAC9E,CAAC;IAEO,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC;IACzB,MAAM,KAAK,OAAO,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvD,MAAM,KAAK,eAAe,KAAK,OAAO,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACrE,kDAAkD;IAC3C,MAAM,KAAK,aAAa;QAC7B,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAoB;QAC9C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,6BAA6B,CAAC,WAAW,CAAC,CAAC,MAAkC,EAAE,EAAE,CACpF,UAAU,CAAC,oBAAoB,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC,CAAC;YAChF,IAAI,CAAC,gBAAgB,GAAG,GAAG,EAAE,UAAU,EAAE,eAAe,IAAI,UAAU,CAAC;QACzE,CAAC;QAED,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,OAAO,CAAC,OAAO,EAAG,yDAAyD;YAC7E,gBAAgB,CAAC,QAAQ,EAAE,CAAC;IAChC,CAAC;IAED,mEAAmE;IAC5D,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,6BAA6B,CAAC,KAAK,EAAE,CAAC;QAC3C,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC3B,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,yBAAyB;QACrC,OAAO,IAAI,CAAC,aAAa,IAAI,0BAA0B,CAAC,MAAM,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,4BAA4B,CAAC,YAA0B,EAAE,MAAkC;QACvG,IAAI,IAAI,CAAC,aAAa,KAAK,MAAM,EAAE,CAAC;YAClC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC;YAC5B,IAAI,CAAC,6BAA6B,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACxD,CAAC;IACH,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/** @packageDocumentation\r\n * @module NativeApp\r\n */\r\n\r\nimport { join } from \"path\";\r\nimport { AccessToken, assert, BeEvent, GuidString } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseProps, InternetConnectivityStatus, LocalBriefcaseProps, NativeAppFunctions, nativeAppIpcStrings, NativeAppNotifications,\r\n  OverriddenBy, RequestNewBriefcaseProps, StorageValue,\r\n} from \"@itwin/core-common\";\r\nimport { BriefcaseManager, RequestNewBriefcaseArg } from \"./BriefcaseManager\";\r\nimport { Downloads, ProgressFunction, ProgressStatus } from \"./CheckpointManager\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { IpcHandler, IpcHost, IpcHostOpts, throttleProgressCallback } from \"./IpcHost\";\r\nimport { NativeAppStorage } from \"./NativeAppStorage\";\r\n\r\n/**\r\n * Implementation of NativeAppFunctions\r\n */\r\nclass NativeAppHandler extends IpcHandler implements NativeAppFunctions {\r\n  public get channelName() { return nativeAppIpcStrings.channelName; }\r\n\r\n  public async getAccessToken(): Promise<AccessToken | undefined> {\r\n    return IModelHost.authorizationClient?.getAccessToken();\r\n  }\r\n\r\n  public async checkInternetConnectivity(): Promise<InternetConnectivityStatus> {\r\n    return NativeHost.checkInternetConnectivity();\r\n  }\r\n  public async overrideInternetConnectivity(by: OverriddenBy, status: InternetConnectivityStatus): Promise<void> {\r\n    NativeHost.overrideInternetConnectivity(by, status);\r\n  }\r\n  public async acquireNewBriefcaseId(iModelId: GuidString): Promise<number> {\r\n    return BriefcaseManager.acquireNewBriefcaseId({ iModelId });\r\n  }\r\n  public async getBriefcaseFileName(props: BriefcaseProps): Promise<string> {\r\n    return BriefcaseManager.getFileName(props);\r\n  }\r\n  public async downloadBriefcase(request: RequestNewBriefcaseProps, reportProgress: boolean, progressInterval?: number): Promise<LocalBriefcaseProps> {\r\n    const args: RequestNewBriefcaseArg = {\r\n      ...request,\r\n      accessToken: await this.getAccessToken(),\r\n      onProgress: (_a: number, _b: number) => checkAbort(),\r\n    };\r\n\r\n    const checkAbort = () => {\r\n      assert(undefined !== args.fileName);\r\n      const job = Downloads.isInProgress(args.fileName);\r\n      return (job && (job.request as any).abort === 1) ? ProgressStatus.Abort : ProgressStatus.Continue;\r\n    };\r\n\r\n    if (reportProgress) {\r\n      const progressCallback: ProgressFunction = (loaded, total) => {\r\n        IpcHost.send(`nativeApp.progress-${request.iModelId}`, { loaded, total });\r\n        return checkAbort();\r\n      };\r\n      args.onProgress = throttleProgressCallback(progressCallback, checkAbort, progressInterval);\r\n    }\r\n\r\n    return BriefcaseManager.downloadBriefcase(args);\r\n  }\r\n\r\n  public async requestCancelDownloadBriefcase(fileName: string): Promise<boolean> {\r\n    const job = Downloads.isInProgress(fileName);\r\n    if (job)\r\n      (job.request as any).abort = 1;\r\n    return job !== undefined;\r\n  }\r\n\r\n  public async deleteBriefcaseFiles(fileName: string): Promise<void> {\r\n    await BriefcaseManager.deleteBriefcaseFiles(fileName, await IModelHost.getAccessToken());\r\n  }\r\n\r\n  public async getCachedBriefcases(iModelId?: GuidString): Promise<LocalBriefcaseProps[]> {\r\n    return BriefcaseManager.getCachedBriefcases(iModelId);\r\n  }\r\n\r\n  public async storageMgrOpen(storageId: string): Promise<string> {\r\n    return NativeAppStorage.open(storageId).id;\r\n  }\r\n\r\n  public async storageMgrClose(storageId: string, deleteIt: boolean): Promise<void> {\r\n    NativeAppStorage.find(storageId).close(deleteIt);\r\n  }\r\n\r\n  public async storageMgrNames(): Promise<string[]> {\r\n    return NativeAppStorage.getStorageNames();\r\n  }\r\n\r\n  public async storageGetValueType(storageId: string, key: string): Promise<\"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined> {\r\n    return NativeAppStorage.find(storageId).getValueType(key);\r\n  }\r\n\r\n  public async storageGet(storageId: string, key: string): Promise<StorageValue | undefined> {\r\n    return NativeAppStorage.find(storageId).getData(key);\r\n  }\r\n\r\n  public async storageSet(storageId: string, key: string, value: StorageValue): Promise<void> {\r\n    NativeAppStorage.find(storageId).setData(key, value);\r\n  }\r\n\r\n  public async storageRemove(storageId: string, key: string): Promise<void> {\r\n    NativeAppStorage.find(storageId).removeData(key);\r\n  }\r\n\r\n  public async storageKeys(storageId: string): Promise<string[]> {\r\n    return NativeAppStorage.find(storageId).getKeys();\r\n  }\r\n\r\n  public async storageRemoveAll(storageId: string): Promise<void> {\r\n    NativeAppStorage.find(storageId).removeAll();\r\n  }\r\n}\r\n\r\n/** Options for [[NativeHost.startup]]\r\n * @public\r\n */\r\nexport interface NativeHostOpts extends IpcHostOpts {\r\n  nativeHost?: {\r\n    /** Application name. Used, for example, to name the settings file. If not supplied, defaults to \"iTwinApp\". */\r\n    applicationName?: string;\r\n  };\r\n}\r\n\r\n/**\r\n * Backend for desktop/mobile native applications\r\n * @public\r\n */\r\nexport class NativeHost {\r\n  private static _reachability?: InternetConnectivityStatus;\r\n  private static _applicationName: string;\r\n  private constructor() { } // no instances - static methods only\r\n\r\n  /** Event called when the internet connectivity changes, if known. */\r\n  public static readonly onInternetConnectivityChanged = new BeEvent<(status: InternetConnectivityStatus) => void>();\r\n\r\n  private static _appSettingsCacheDir?: string;\r\n\r\n  /** Get the local cache folder for application settings */\r\n  public static get appSettingsCacheDir(): string {\r\n    return this._appSettingsCacheDir ??= join(IModelHost.cacheDir, \"appSettings\");\r\n  }\r\n\r\n  /** Send a notification to the NativeApp connected to this NativeHost. */\r\n  public static notifyNativeFrontend<T extends keyof NativeAppNotifications>(methodName: T, ...args: Parameters<NativeAppNotifications[T]>) {\r\n    return IpcHost.send(nativeAppIpcStrings.notifyChannel, methodName, ...args);\r\n  }\r\n\r\n  private static _isValid = false;\r\n  public static get isValid(): boolean { return this._isValid; }\r\n  public static get applicationName() { return this._applicationName; }\r\n  /** Get the settings store for this NativeHost. */\r\n  public static get settingsStore() {\r\n    return NativeAppStorage.open(this.applicationName);\r\n  }\r\n\r\n  /**\r\n   * Start the backend of a native app.\r\n   * @note this method calls [[IpcHost.startup]] internally.\r\n   */\r\n  public static async startup(opt?: NativeHostOpts): Promise<void> {\r\n    if (!this.isValid) {\r\n      this._isValid = true;\r\n      this.onInternetConnectivityChanged.addListener((status: InternetConnectivityStatus) =>\r\n        NativeHost.notifyNativeFrontend(\"notifyInternetConnectivityChanged\", status));\r\n      this._applicationName = opt?.nativeHost?.applicationName ?? \"iTwinApp\";\r\n    }\r\n\r\n    await IpcHost.startup(opt);\r\n    if (IpcHost.isValid)  // for tests, we use NativeHost but don't have a frontend\r\n      NativeAppHandler.register();\r\n  }\r\n\r\n  /** Shutdown native app backend. Also calls [[IpcHost.shutdown]] */\r\n  public static async shutdown(): Promise<void> {\r\n    this._isValid = false;\r\n    this.onInternetConnectivityChanged.clear();\r\n    await IpcHost.shutdown();\r\n  }\r\n\r\n  /** get current value of internet connectivity */\r\n  public static checkInternetConnectivity(): InternetConnectivityStatus {\r\n    return this._reachability ?? InternetConnectivityStatus.Online;\r\n  }\r\n\r\n  /**\r\n   * Override internet connectivity state\r\n   * @param _overridenBy who overrode the value.\r\n   * @internal\r\n   */\r\n  public static overrideInternetConnectivity(_overridenBy: OverriddenBy, status: InternetConnectivityStatus): void {\r\n    if (this._reachability !== status) {\r\n      this._reachability = status;\r\n      this.onInternetConnectivityChanged.raiseEvent(status);\r\n    }\r\n  }\r\n}\r\n"]}