@itwin/core-backend 3.0.0-dev.100

package/lib/cjs/IModelJsFs.js

@@ -0,0 +1,141 @@
+"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.IModelJsFs = exports.IModelJsFsStats = void 0;
+/** @packageDocumentation
+ * @module Portability
+ */
+// cspell: ignore wflag
+const fs = require("fs-extra");
+const path = require("path");
+/* TODO: define File Mode Constants: S_IWUSR, et al. */
+/** Information about a file. See [[IModelJsFs.lstatSync]]
+ * @public
+ */
+class IModelJsFsStats {
+    constructor(size, atimeMs, mtimeMs, birthtimeMs, isDirectory, isFile, isSocket, isSymbolicLink, isReadOnly) {
+        this.size = size;
+        this.atimeMs = atimeMs;
+        this.mtimeMs = mtimeMs;
+        this.birthtimeMs = birthtimeMs;
+        this.isDirectory = isDirectory;
+        this.isFile = isFile;
+        this.isSocket = isSocket;
+        this.isSymbolicLink = isSymbolicLink;
+        this.isReadOnly = isReadOnly;
+    }
+}
+exports.IModelJsFsStats = IModelJsFsStats;
+/** File system operations that are defined on all platforms. See also [[Platform]] and [[KnownLocations]]
+ * @public
+ */
+class IModelJsFs {
+    /** Does file or directory exist? */
+    static existsSync(pathname) { return fs.existsSync(pathname); }
+    /** Delete a file. */
+    static unlinkSync(pathname) { fs.unlinkSync(pathname); }
+    /** Delete a file or remove a directory (rm -r). */
+    static removeSync(pathname) { fs.removeSync(pathname); }
+    /** Create a directory. */
+    static mkdirSync(pathname) { fs.mkdirSync(pathname); }
+    /** Remove a directory. */
+    static rmdirSync(pathname) { fs.rmdirSync(pathname); }
+    /** Write to a file. */
+    static writeFileSync(pathname, data, wflag = "w") { fs.writeFileSync(pathname, data, { flag: wflag }); }
+    /** Append to a file. */
+    static appendFileSync(pathname, str) { fs.appendFileSync(pathname, str); }
+    /** Make a copy of a file */
+    static copySync(src, dest, opts) { fs.copySync(src, dest, opts); }
+    /** Get the file and directory names in the specified directory. Excludes "." and "..". */
+    static readdirSync(pathname) { return fs.readdirSync(pathname); }
+    /** Read file */
+    static readFileSync(pathname) { return fs.readFileSync(pathname); }
+    /** Test if the current user has permission to write to a file. */
+    static isFileWritable(pathname) {
+        try {
+            fs.accessSync(pathname, fs.constants.W_OK);
+            return true;
+        }
+        catch (_err) {
+            return false;
+        }
+    }
+    /** Get information about a file. */
+    static lstatSync(pathname) {
+        const stats = fs.lstatSync(pathname);
+        if (stats === undefined)
+            return undefined;
+        return new IModelJsFsStats(stats.size, stats.atime.getTime(), stats.mtime.getTime(), stats.birthtime.getTime(), stats.isDirectory(), stats.isFile(), stats.isSocket(), stats.isSymbolicLink(), !IModelJsFs.isFileWritable(pathname));
+    }
+    /**
+     * Finds files recursively based on a pattern
+     * @param rootDir Directory from where to start searching for files.
+     * @param pattern A Regex that would be match to basename of files including extension
+     * @returns list of file that match the pattern.
+     */
+    static recursiveFindSync(rootDir, pattern) {
+        const files = [];
+        IModelJsFs.walkDirSync(rootDir, (pathname, isDir) => {
+            if (!isDir) {
+                const fileName = path.basename(pathname);
+                if (pattern.test(fileName)) {
+                    files.push(pathname);
+                }
+            }
+            return true;
+        });
+        return files;
+    }
+    /**
+     * Walks a directory in breadth first fashion
+     * @param rootDir  directory from where the traversal starts
+     * @param cb callback that would be called with full path of file or directory
+     */
+    static walkDirSync(rootDir, cb) {
+        var _a;
+        const subDir = [];
+        for (const childPath of IModelJsFs.readdirSync(rootDir)) {
+            const fullPath = path.join(rootDir, childPath);
+            const isDir = (_a = IModelJsFs.lstatSync(fullPath)) === null || _a === void 0 ? void 0 : _a.isDirectory;
+            if (!cb(fullPath, isDir)) {
+                return;
+            }
+            // Need to check if the directory still exists in case the callback has deleted it.
+            if (isDir && IModelJsFs.existsSync(fullPath)) {
+                subDir.push(fullPath);
+            }
+        }
+        subDir.forEach((v) => {
+            IModelJsFs.walkDirSync(v, cb);
+        });
+    }
+    /** Create a directory, recursively setting up the path as necessary */
+    static recursiveMkDirSync(dirPath) {
+        if (IModelJsFs.existsSync(dirPath))
+            return;
+        const parentPath = path.dirname(dirPath);
+        if (parentPath !== dirPath)
+            IModelJsFs.recursiveMkDirSync(parentPath);
+        IModelJsFs.mkdirSync(dirPath);
+    }
+    /** Remove a directory, recursively */
+    static purgeDirSync(dirPath) {
+        if (!IModelJsFs.existsSync(dirPath))
+            return;
+        IModelJsFs.walkDirSync(dirPath, (pathName, isDir) => {
+            if (isDir) {
+                IModelJsFs.purgeDirSync(pathName);
+                IModelJsFs.removeSync(pathName);
+            }
+            else {
+                IModelJsFs.unlinkSync(pathName);
+            }
+            return true;
+        });
+    }
+}
+exports.IModelJsFs = IModelJsFs;
+//# sourceMappingURL=IModelJsFs.js.map

package/lib/cjs/IModelJsFs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelJsFs.js","sourceRoot":"","sources":["../../src/IModelJsFs.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,uBAAuB;AAEvB,+BAA+B;AAC/B,6BAA6B;AAE7B,uDAAuD;AACvD;;GAEG;AACH,MAAa,eAAe;IAC1B,YACS,IAAY,EACZ,OAAe,EACf,OAAe,EACf,WAAmB,EACnB,WAAoB,EACpB,MAAe,EACf,QAAiB,EACjB,cAAuB,EACvB,UAAmB;QARnB,SAAI,GAAJ,IAAI,CAAQ;QACZ,YAAO,GAAP,OAAO,CAAQ;QACf,YAAO,GAAP,OAAO,CAAQ;QACf,gBAAW,GAAX,WAAW,CAAQ;QACnB,gBAAW,GAAX,WAAW,CAAS;QACpB,WAAM,GAAN,MAAM,CAAS;QACf,aAAQ,GAAR,QAAQ,CAAS;QACjB,mBAAc,GAAd,cAAc,CAAS;QACvB,eAAU,GAAV,UAAU,CAAS;IACxB,CAAC;CACN;AAZD,0CAYC;AAED;;GAEG;AACH,MAAa,UAAU;IAErB,oCAAoC;IAC7B,MAAM,CAAC,UAAU,CAAC,QAAgB,IAAa,OAAO,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAEvF,qBAAqB;IACd,MAAM,CAAC,UAAU,CAAC,QAAgB,IAAU,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAE7E,mDAAmD;IAC5C,MAAM,CAAC,UAAU,CAAC,QAAgB,IAAU,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAE7E,0BAA0B;IACnB,MAAM,CAAC,SAAS,CAAC,QAAgB,IAAU,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAE3E,0BAA0B;IACnB,MAAM,CAAC,SAAS,CAAC,QAAgB,IAAU,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAE3E,uBAAuB;IAChB,MAAM,CAAC,aAAa,CAAC,QAAgB,EAAE,IAAyB,EAAE,QAAgB,GAAG,IAAU,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;IAE1J,wBAAwB;IACjB,MAAM,CAAC,cAAc,CAAC,QAAgB,EAAE,GAAW,IAAU,EAAE,CAAC,cAAc,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAEvG,4BAA4B;IACrB,MAAM,CAAC,QAAQ,CAAC,GAAW,EAAE,IAAY,EAAE,IAAU,IAAU,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAErG,0FAA0F;IACnF,MAAM,CAAC,WAAW,CAAC,QAAgB,IAAc,OAAO,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAE1F,gBAAgB;IACT,MAAM,CAAC,YAAY,CAAC,QAAgB,IAAqB,OAAO,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAEnG,kEAAkE;IAC1D,MAAM,CAAC,cAAc,CAAC,QAAgB;QAC5C,IAAI;YACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC3C,OAAO,IAAI,CAAC;SACb;QAAC,OAAO,IAAI,EAAE;YACb,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAED,oCAAoC;IAC7B,MAAM,CAAC,SAAS,CAAC,QAAgB;QACtC,MAAM,KAAK,GAAG,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACrC,IAAI,KAAK,KAAK,SAAS;YACrB,OAAO,SAAS,CAAC;QAEnB,OAAO,IAAI,eAAe,CACxB,KAAK,CAAC,IAAI,EACV,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,EACrB,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,EACrB,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE,EACzB,KAAK,CAAC,WAAW,EAAE,EACnB,KAAK,CAAC,MAAM,EAAE,EACd,KAAK,CAAC,QAAQ,EAAE,EAChB,KAAK,CAAC,cAAc,EAAE,EACtB,CAAC,UAAU,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,OAAe;QAC9D,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,UAAU,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,QAAgB,EAAE,KAAc,EAAE,EAAE;YACnE,IAAI,CAAC,KAAK,EAAE;gBACV,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBACzC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;oBAC1B,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;iBACtB;aACF;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,WAAW,CAAC,OAAe,EAAE,EAAiD;;QAC1F,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,SAAS,IAAI,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;YACvD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAC/C,MAAM,KAAK,GAAG,MAAA,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,0CAAE,WAAW,CAAC;YAC1D,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAM,CAAC,EAAE;gBACzB,OAAO;aACR;YACD,mFAAmF;YACnF,IAAI,KAAK,IAAI,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;gBAC5C,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aACvB;SACF;QACD,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACnB,UAAU,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,uEAAuE;IAChE,MAAM,CAAC,kBAAkB,CAAC,OAAe;QAC9C,IAAI,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC;YAChC,OAAO;QACT,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,UAAU,KAAK,OAAO;YACxB,UAAU,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED,sCAAsC;IAC/B,MAAM,CAAC,YAAY,CAAC,OAAe;QACxC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC;YACjC,OAAO;QAET,UAAU,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,QAAgB,EAAE,KAAc,EAAE,EAAE;YACnE,IAAI,KAAK,EAAE;gBACT,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;gBAClC,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;aACjC;iBAAM;gBACL,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;aACjC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAhID,gCAgIC","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\n/** @packageDocumentation\r\n * @module Portability\r\n */\r\n\r\n// cspell: ignore wflag\r\n\r\nimport * as fs from \"fs-extra\";\r\nimport * as path from \"path\";\r\n\r\n/* TODO: define File Mode Constants: S_IWUSR, et al. */\r\n/** Information about a file. See [[IModelJsFs.lstatSync]]\r\n * @public\r\n */\r\nexport class IModelJsFsStats {\r\n  constructor(\r\n    public size: number,\r\n    public atimeMs: number,\r\n    public mtimeMs: number,\r\n    public birthtimeMs: number,\r\n    public isDirectory: boolean,\r\n    public isFile: boolean,\r\n    public isSocket: boolean,\r\n    public isSymbolicLink: boolean,\r\n    public isReadOnly: boolean,\r\n  ) { }\r\n}\r\n\r\n/** File system operations that are defined on all platforms. See also [[Platform]] and [[KnownLocations]]\r\n * @public\r\n */\r\nexport class IModelJsFs {\r\n\r\n  /** Does file or directory exist? */\r\n  public static existsSync(pathname: string): boolean { return fs.existsSync(pathname); }\r\n\r\n  /** Delete a file. */\r\n  public static unlinkSync(pathname: string): void { fs.unlinkSync(pathname); }\r\n\r\n  /** Delete a file or remove a directory (rm -r). */\r\n  public static removeSync(pathname: string): void { fs.removeSync(pathname); }\r\n\r\n  /** Create a directory. */\r\n  public static mkdirSync(pathname: string): void { fs.mkdirSync(pathname); }\r\n\r\n  /** Remove a directory. */\r\n  public static rmdirSync(pathname: string): void { fs.rmdirSync(pathname); }\r\n\r\n  /** Write to a file. */\r\n  public static writeFileSync(pathname: string, data: string | Uint8Array, wflag: string = \"w\"): void { fs.writeFileSync(pathname, data, { flag: wflag }); }\r\n\r\n  /** Append to a file. */\r\n  public static appendFileSync(pathname: string, str: string): void { fs.appendFileSync(pathname, str); }\r\n\r\n  /** Make a copy of a file */\r\n  public static copySync(src: string, dest: string, opts?: any): void { fs.copySync(src, dest, opts); }\r\n\r\n  /** Get the file and directory names in the specified directory. Excludes \".\" and \"..\". */\r\n  public static readdirSync(pathname: string): string[] { return fs.readdirSync(pathname); }\r\n\r\n  /** Read file */\r\n  public static readFileSync(pathname: string): string | Buffer { return fs.readFileSync(pathname); }\r\n\r\n  /** Test if the current user has permission to write to a file. */\r\n  private static isFileWritable(pathname: string): boolean {\r\n    try {\r\n      fs.accessSync(pathname, fs.constants.W_OK);\r\n      return true;\r\n    } catch (_err) {\r\n      return false;\r\n    }\r\n  }\r\n\r\n  /** Get information about a file. */\r\n  public static lstatSync(pathname: string): IModelJsFsStats | undefined {\r\n    const stats = fs.lstatSync(pathname);\r\n    if (stats === undefined)\r\n      return undefined;\r\n\r\n    return new IModelJsFsStats(\r\n      stats.size,\r\n      stats.atime.getTime(),\r\n      stats.mtime.getTime(),\r\n      stats.birthtime.getTime(),\r\n      stats.isDirectory(),\r\n      stats.isFile(),\r\n      stats.isSocket(),\r\n      stats.isSymbolicLink(),\r\n      !IModelJsFs.isFileWritable(pathname));\r\n  }\r\n\r\n  /**\r\n   * Finds files recursively based on a pattern\r\n   * @param rootDir Directory from where to start searching for files.\r\n   * @param pattern A Regex that would be match to basename of files including extension\r\n   * @returns list of file that match the pattern.\r\n   */\r\n  public static recursiveFindSync(rootDir: string, pattern: RegExp): string[] {\r\n    const files: string[] = [];\r\n    IModelJsFs.walkDirSync(rootDir, (pathname: string, isDir: boolean) => {\r\n      if (!isDir) {\r\n        const fileName = path.basename(pathname);\r\n        if (pattern.test(fileName)) {\r\n          files.push(pathname);\r\n        }\r\n      }\r\n      return true;\r\n    });\r\n    return files;\r\n  }\r\n\r\n  /**\r\n   * Walks a directory in breadth first fashion\r\n   * @param rootDir  directory from where the traversal starts\r\n   * @param cb callback that would be called with full path of file or directory\r\n   */\r\n  public static walkDirSync(rootDir: string, cb: (pathname: string, isDir: boolean) => boolean): void {\r\n    const subDir = [];\r\n    for (const childPath of IModelJsFs.readdirSync(rootDir)) {\r\n      const fullPath = path.join(rootDir, childPath);\r\n      const isDir = IModelJsFs.lstatSync(fullPath)?.isDirectory;\r\n      if (!cb(fullPath, isDir!)) {\r\n        return;\r\n      }\r\n      // Need to check if the directory still exists in case the callback has deleted it.\r\n      if (isDir && IModelJsFs.existsSync(fullPath)) {\r\n        subDir.push(fullPath);\r\n      }\r\n    }\r\n    subDir.forEach((v) => {\r\n      IModelJsFs.walkDirSync(v, cb);\r\n    });\r\n  }\r\n\r\n  /** Create a directory, recursively setting up the path as necessary */\r\n  public static recursiveMkDirSync(dirPath: string) {\r\n    if (IModelJsFs.existsSync(dirPath))\r\n      return;\r\n    const parentPath = path.dirname(dirPath);\r\n    if (parentPath !== dirPath)\r\n      IModelJsFs.recursiveMkDirSync(parentPath);\r\n    IModelJsFs.mkdirSync(dirPath);\r\n  }\r\n\r\n  /** Remove a directory, recursively */\r\n  public static purgeDirSync(dirPath: string) {\r\n    if (!IModelJsFs.existsSync(dirPath))\r\n      return;\r\n\r\n    IModelJsFs.walkDirSync(dirPath, (pathName: string, isDir: boolean) => {\r\n      if (isDir) {\r\n        IModelJsFs.purgeDirSync(pathName);\r\n        IModelJsFs.removeSync(pathName);\r\n      } else {\r\n        IModelJsFs.unlinkSync(pathName);\r\n      }\r\n      return true;\r\n    });\r\n  }\r\n}\r\n"]}

package/lib/cjs/IModelSchemaLoader.d.ts

@@ -0,0 +1,26 @@
+import { Schema } from "@itwin/ecschema-metadata";
+import { IModelDb } from "./IModelDb";
+/**
+ * A utility class for retrieving EC Schema objects from an iModel. Loaded schemas are held in memory within
+ * a schema context managed by IModelSchemaLoader. The IModelSchemaLoader object should be held in memory if
+ * multiple calls to [[getSchema]] or [[tryGetSchema]] is a possibility, thereby avoiding unnecessary schema
+ * retrievals from an iModel.
+ * @alpha
+ */
+export declare class IModelSchemaLoader {
+    private _iModel;
+    private _context;
+    /** @internal */
+    constructor(_iModel: IModelDb);
+    /** Get a schema by name
+     * @param schemaName a string with the name of the schema to load.
+     * @throws [IModelError]($common) if the schema is not found or cannot be loaded.
+     */
+    getSchema<T extends Schema>(schemaName: string): T;
+    /** Attempts to get a schema by name
+     * @param schemaName a string with the name of the schema to load.
+     * @throws [IModelError]($common) if the schema exists, but cannot be loaded.
+     */
+    tryGetSchema<T extends Schema>(schemaName: string): T | undefined;
+}
+//# sourceMappingURL=IModelSchemaLoader.d.ts.map

package/lib/cjs/IModelSchemaLoader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelSchemaLoader.d.ts","sourceRoot":"","sources":["../../src/IModelSchemaLoader.ts"],"names":[],"mappings":"AAMA,OAAO,EAA6B,MAAM,EAA6C,MAAM,0BAA0B,CAAC;AAGxH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;GAMG;AACH,qBAAa,kBAAkB;IAIV,OAAO,CAAC,OAAO;IAHlC,OAAO,CAAC,QAAQ,CAAgB;IAEhC,gBAAgB;gBACW,OAAO,EAAE,QAAQ;IAM5C;;;OAGG;IACI,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,CAAC;IAQzD;;;OAGG;IACI,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;CAMzE"}

package/lib/cjs/IModelSchemaLoader.js

@@ -0,0 +1,95 @@
+"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.IModelSchemaLoader = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+const core_common_1 = require("@itwin/core-common");
+/**
+ * A utility class for retrieving EC Schema objects from an iModel. Loaded schemas are held in memory within
+ * a schema context managed by IModelSchemaLoader. The IModelSchemaLoader object should be held in memory if
+ * multiple calls to [[getSchema]] or [[tryGetSchema]] is a possibility, thereby avoiding unnecessary schema
+ * retrievals from an iModel.
+ * @alpha
+ */
+class IModelSchemaLoader {
+    /** @internal */
+    constructor(_iModel) {
+        this._iModel = _iModel;
+        this._context = new ecschema_metadata_1.SchemaContext();
+        const locater = new IModelSchemaLocater(this._iModel);
+        this._context.addLocater(locater);
+    }
+    /** Get a schema by name
+     * @param schemaName a string with the name of the schema to load.
+     * @throws [IModelError]($common) if the schema is not found or cannot be loaded.
+     */
+    getSchema(schemaName) {
+        const schema = this.tryGetSchema(schemaName);
+        if (!schema)
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `reading schema=${schemaName}`);
+        return schema;
+    }
+    /** Attempts to get a schema by name
+     * @param schemaName a string with the name of the schema to load.
+     * @throws [IModelError]($common) if the schema exists, but cannot be loaded.
+     */
+    tryGetSchema(schemaName) {
+        // SchemaKey version is not used when locating schema in an iModel, so the version is arbitrary.
+        const key = new ecschema_metadata_1.SchemaKey(schemaName, new ecschema_metadata_1.ECVersion(1, 0, 0));
+        const schema = this._context.getSchemaSync(key, ecschema_metadata_1.SchemaMatchType.Latest);
+        return schema;
+    }
+}
+exports.IModelSchemaLoader = IModelSchemaLoader;
+/**
+ * A private ISchemaLocater implementation for locating and retrieving EC Schema objects from an iModel
+ * @alpha
+ */
+class IModelSchemaLocater {
+    /** @internal */
+    constructor(_iModel) {
+        this._iModel = _iModel;
+    }
+    /** Get a schema by [SchemaKey]
+     * @param schemaKey The [SchemaKey] that identifies the schema.
+     * @param matchType The [SchemaMatchType] to used for comparing schema versions.
+     * @param context The [SchemaContext] used to facilitate schema location.
+     * @throws [IModelError]($common) if the schema exists, but cannot be loaded.
+     */
+    async getSchema(schemaKey, matchType, context) {
+        return this.getSchemaSync(schemaKey, matchType, context);
+    }
+    /** Get a schema by [SchemaKey] synchronously.
+     * @param schemaKey The [SchemaKey] that identifies the schema.
+     * * @param matchType The [SchemaMatchType] to used for comparing schema versions.
+     * @param context The [SchemaContext] used to facilitate schema location.
+     * @throws [IModelError]($common) if the schema exists, but cannot be loaded.
+     */
+    getSchemaSync(schemaKey, _matchType, context) {
+        const schemaProps = this.getSchemaString(schemaKey.name);
+        if (!schemaProps)
+            return undefined;
+        context = context ? context : new ecschema_metadata_1.SchemaContext();
+        return ecschema_metadata_1.Schema.fromJsonSync(schemaProps, context);
+    }
+    /** Read schema data from the iModel as JSON string
+     * @param schemaName A string with the name of the schema to load.
+     * @returns A string with the JSON for the schema or `undefined` if the schema is not found.
+     * @throws [IModelError]($common) if the schema exists, but cannot be loaded.
+     */
+    getSchemaString(schemaName) {
+        const val = this._iModel.nativeDb.getSchema(schemaName);
+        if (undefined !== val.error) {
+            if (core_bentley_1.IModelStatus.NotFound === val.error.status) {
+                return undefined;
+            }
+            throw new core_common_1.IModelError(val.error.status, `reading schema=${schemaName}`);
+        }
+        return val.result;
+    }
+}
+//# sourceMappingURL=IModelSchemaLoader.js.map

package/lib/cjs/IModelSchemaLoader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelSchemaLoader.js","sourceRoot":"","sources":["../../src/IModelSchemaLoader.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,sDAAmD;AACnD,gEAAwH;AACxH,oDAAiD;AAIjD;;;;;;GAMG;AACH,MAAa,kBAAkB;IAG7B,gBAAgB;IAChB,YAA2B,OAAiB;QAAjB,YAAO,GAAP,OAAO,CAAU;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,iCAAa,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtD,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED;;;OAGG;IACI,SAAS,CAAmB,UAAkB;QACnD,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM;YACT,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,kBAAkB,UAAU,EAAE,CAAC,CAAC;QAE/E,OAAO,MAAW,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,YAAY,CAAmB,UAAkB;QACtD,gGAAgG;QAChG,MAAM,GAAG,GAAG,IAAI,6BAAS,CAAC,UAAU,EAAE,IAAI,6BAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC9D,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC;QACxE,OAAO,MAAW,CAAC;IACrB,CAAC;CACF;AAhCD,gDAgCC;AAED;;;GAGG;AACH,MAAM,mBAAmB;IACvB,gBAAgB;IAChB,YAA2B,OAAiB;QAAjB,YAAO,GAAP,OAAO,CAAU;IAAI,CAAC;IAEjD;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CAAmB,SAAoB,EAAE,SAA0B,EAAE,OAAmC;QAC5H,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAM,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAmB,SAAoB,EAAE,UAA2B,EAAE,OAAmC;QAC3H,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACzD,IAAI,CAAC,WAAW;YACd,OAAO,SAAS,CAAC;QAEnB,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,iCAAa,EAAE,CAAC;QAClD,OAAO,0BAAM,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,CAAM,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACK,eAAe,CAAC,UAAkB;QACxC,MAAM,GAAG,GAAiD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACtG,IAAI,SAAS,KAAK,GAAG,CAAC,KAAK,EAAE;YAC3B,IAAI,2BAAY,CAAC,QAAQ,KAAK,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE;gBAC9C,OAAO,SAAS,CAAC;aAClB;YACD,MAAM,IAAI,yBAAW,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,kBAAkB,UAAU,EAAE,CAAC,CAAC;SACzE;QACD,OAAO,GAAG,CAAC,MAAM,CAAC;IACpB,CAAC;CACF","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 { IModelStatus } from \"@itwin/core-bentley\";\r\nimport { ECVersion, ISchemaLocater, Schema, SchemaContext, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\r\nimport { IModelError } from \"@itwin/core-common\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { IModelDb } from \"./IModelDb\";\r\n\r\n/**\r\n * A utility class for retrieving EC Schema objects from an iModel. Loaded schemas are held in memory within\r\n * a schema context managed by IModelSchemaLoader. The IModelSchemaLoader object should be held in memory if\r\n * multiple calls to [[getSchema]] or [[tryGetSchema]] is a possibility, thereby avoiding unnecessary schema\r\n * retrievals from an iModel.\r\n * @alpha\r\n */\r\nexport class IModelSchemaLoader {\r\n  private _context: SchemaContext;\r\n\r\n  /** @internal */\r\n  public constructor(private _iModel: IModelDb) {\r\n    this._context = new SchemaContext();\r\n    const locater = new IModelSchemaLocater(this._iModel);\r\n    this._context.addLocater(locater);\r\n  }\r\n\r\n  /** Get a schema by name\r\n   * @param schemaName a string with the name of the schema to load.\r\n   * @throws [IModelError]($common) if the schema is not found or cannot be loaded.\r\n   */\r\n  public getSchema<T extends Schema>(schemaName: string): T {\r\n    const schema = this.tryGetSchema(schemaName);\r\n    if (!schema)\r\n      throw new IModelError(IModelStatus.NotFound, `reading schema=${schemaName}`);\r\n\r\n    return schema as T;\r\n  }\r\n\r\n  /** Attempts to get a schema by name\r\n   * @param schemaName a string with the name of the schema to load.\r\n   * @throws [IModelError]($common) if the schema exists, but cannot be loaded.\r\n   */\r\n  public tryGetSchema<T extends Schema>(schemaName: string): T | undefined {\r\n    // SchemaKey version is not used when locating schema in an iModel, so the version is arbitrary.\r\n    const key = new SchemaKey(schemaName, new ECVersion(1, 0, 0));\r\n    const schema = this._context.getSchemaSync(key, SchemaMatchType.Latest);\r\n    return schema as T;\r\n  }\r\n}\r\n\r\n/**\r\n * A private ISchemaLocater implementation for locating and retrieving EC Schema objects from an iModel\r\n * @alpha\r\n */\r\nclass IModelSchemaLocater implements ISchemaLocater {\r\n  /** @internal */\r\n  public constructor(private _iModel: IModelDb) { }\r\n\r\n  /** Get a schema by [SchemaKey]\r\n   * @param schemaKey The [SchemaKey] that identifies the schema.\r\n   * @param matchType The [SchemaMatchType] to used for comparing schema versions.\r\n   * @param context The [SchemaContext] used to facilitate schema location.\r\n   * @throws [IModelError]($common) if the schema exists, but cannot be loaded.\r\n   */\r\n  public async getSchema<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context?: SchemaContext | undefined): Promise<T | undefined> {\r\n    return this.getSchemaSync(schemaKey, matchType, context) as T;\r\n  }\r\n\r\n  /** Get a schema by [SchemaKey] synchronously.\r\n   * @param schemaKey The [SchemaKey] that identifies the schema.\r\n   * * @param matchType The [SchemaMatchType] to used for comparing schema versions.\r\n   * @param context The [SchemaContext] used to facilitate schema location.\r\n   * @throws [IModelError]($common) if the schema exists, but cannot be loaded.\r\n   */\r\n  public getSchemaSync<T extends Schema>(schemaKey: SchemaKey, _matchType: SchemaMatchType, context?: SchemaContext | undefined): T | undefined {\r\n    const schemaProps = this.getSchemaString(schemaKey.name);\r\n    if (!schemaProps)\r\n      return undefined;\r\n\r\n    context = context ? context : new SchemaContext();\r\n    return Schema.fromJsonSync(schemaProps, context) as T;\r\n  }\r\n\r\n  /** Read schema data from the iModel as JSON string\r\n   * @param schemaName A string with the name of the schema to load.\r\n   * @returns A string with the JSON for the schema or `undefined` if the schema is not found.\r\n   * @throws [IModelError]($common) if the schema exists, but cannot be loaded.\r\n   */\r\n  private getSchemaString(schemaName: string): string | undefined {\r\n    const val: IModelJsNative.ErrorStatusOrResult<any, any> = this._iModel.nativeDb.getSchema(schemaName);\r\n    if (undefined !== val.error) {\r\n      if (IModelStatus.NotFound === val.error.status) {\r\n        return undefined;\r\n      }\r\n      throw new IModelError(val.error.status, `reading schema=${schemaName}`);\r\n    }\r\n    return val.result;\r\n  }\r\n}\r\n"]}

package/lib/cjs/IpcHost.d.ts

@@ -0,0 +1,99 @@
+/** @packageDocumentation
+ * @module NativeApp
+ */
+import { EditingScopeNotifications, IpcAppNotifications, IpcListener, IpcSocketBackend, RemoveFunction, TxnNotifications } from "@itwin/core-common";
+import { BriefcaseDb, StandaloneDb } from "./IModelDb";
+import { IModelHostConfiguration } from "./IModelHost";
+/**
+  * Options for [[IpcHost.startup]]
+  * @public
+  */
+export interface IpcHostOpts {
+    iModelHost?: IModelHostConfiguration;
+    ipcHost?: {
+        /** The Ipc socket to use for communications with frontend. Allows undefined only for headless tests. */
+        socket?: IpcSocketBackend;
+        /** don't send stack information on exceptions */
+        exceptions?: {
+            noStack?: boolean;
+        };
+    };
+}
+/**
+ * Used by applications that have a dedicated backend. IpcHosts may send messages to their corresponding IpcApp.
+ * @note if either end terminates, the other must too.
+ * @public
+ */
+export declare class IpcHost {
+    static noStack: boolean;
+    private static _ipc;
+    /** Get the implementation of the [IpcSocketBackend]($common) interface. */
+    private static get ipc();
+    /** Determine whether Ipc is available for this backend. This will only be true if [[startup]] has been called on this class. */
+    static get isValid(): boolean;
+    /**
+     * Send a message to the frontend over an Ipc channel.
+     * @param channel the name of the channel matching the name registered with [[IpcApp.addListener]].
+     * @param data The content of the message.
+     */
+    static send(channel: string, ...data: any[]): void;
+    /**
+     * Establish a handler for an Ipc channel to receive [[Frontend.invoke]] calls
+     * @param channel The name of the channel for this handler.
+     * @param handler A function that supplies the implementation for `channel`
+     * @note returns A function to call to remove the handler.
+     */
+    static handle(channel: string, handler: (...args: any[]) => Promise<any>): RemoveFunction;
+    /**
+     * Establish a handler to receive messages sent via [[IpcApp.send]].
+     * @param channel The name of the channel for the messages.
+     * @param listener A function called when messages are sent over `channel`
+     * @note returns A function to call to remove the listener.
+     */
+    static addListener(channel: string, listener: IpcListener): RemoveFunction;
+    /**
+     * Remove a previously registered listener
+     * @param channel The name of the channel for the listener previously registered with [[addListener]]
+     * @param listener The function passed to [[addListener]]
+     */
+    static removeListener(channel: string, listener: IpcListener): void;
+    private static notify;
+    /** @internal */
+    static notifyIpcFrontend<T extends keyof IpcAppNotifications>(methodName: T, ...args: Parameters<IpcAppNotifications[T]>): void;
+    /** @internal */
+    static notifyTxns<T extends keyof TxnNotifications>(briefcase: BriefcaseDb | StandaloneDb, methodName: T, ...args: Parameters<TxnNotifications[T]>): void;
+    /** @internal */
+    static notifyEditingScope<T extends keyof EditingScopeNotifications>(briefcase: BriefcaseDb | StandaloneDb, methodName: T, ...args: Parameters<EditingScopeNotifications[T]>): void;
+    /**
+     * Start the backend of an Ipc app.
+     * @param opt
+     * @note this method calls [[IModelHost.startup]] internally.
+     */
+    static startup(opt?: IpcHostOpts): Promise<void>;
+    /** Shutdown IpcHost backend. Also calls [[IModelHost.shutdown]] */
+    static shutdown(): Promise<void>;
+}
+/**
+ * Base class for all implementations of an Ipc interface.
+ *
+ * Create a subclass to implement your Ipc interface. Your class should be declared like this:
+ * ```ts
+ * class MyHandler extends IpcHandler implements MyInterface
+ * ```
+ * to ensure all methods and signatures are correct.
+ *
+ * Then, call `MyClass.register` at startup to connect your class to your channel.
+ * @public
+ */
+export declare abstract class IpcHandler {
+    /** All subclasses must implement this method to specify their channel name. */
+    abstract get channelName(): string;
+    /**
+     * Register this class as the handler for methods on its channel. This static method creates a new instance
+     * that becomes the handler and is `this` when its methods are called.
+     * @returns A function that can be called to remove the handler.
+     * @note this method should only be called once per channel. If it is called multiple times, subsequent calls replace the previous ones.
+     */
+    static register(): RemoveFunction;
+}
+//# sourceMappingURL=IpcHost.d.ts.map

package/lib/cjs/IpcHost.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IpcHost.d.ts","sourceRoot":"","sources":["../../src/IpcHost.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EACgC,yBAAyB,EAC9D,mBAAmB,EAAmB,WAAW,EAAE,gBAAgB,EAAoC,cAAc,EACjG,gBAAgB,EACrC,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,WAAW,EAAY,YAAY,EAAE,MAAM,YAAY,CAAC;AACjE,OAAO,EAAc,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAGnE;;;IAGI;AACJ,MAAM,WAAW,WAAW;IAC1B,UAAU,CAAC,EAAE,uBAAuB,CAAC;IACrC,OAAO,CAAC,EAAE;QACR,wGAAwG;QACxG,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAE1B,iDAAiD;QACjD,UAAU,CAAC,EAAE;YACX,OAAO,CAAC,EAAE,OAAO,CAAC;SACnB,CAAC;KACH,CAAC;CACH;AAED;;;;GAIG;AACH,qBAAa,OAAO;IAClB,OAAc,OAAO,UAAS;IAC9B,OAAO,CAAC,MAAM,CAAC,IAAI,CAA+B;IAClD,2EAA2E;IAC3E,OAAO,CAAC,MAAM,KAAK,GAAG,GAA2C;IACjE,gIAAgI;IAChI,WAAkB,OAAO,IAAI,OAAO,CAAoC;IAExE;;;;OAIG;WACW,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;IAIzD;;;;;OAKG;WACW,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,GAAG,cAAc;IAGhG;;;;;OAKG;WACW,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,GAAG,cAAc;IAGjF;;;;OAIG;WACW,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,GAAG,IAAI;IAI1E,OAAO,CAAC,MAAM,CAAC,MAAM;IAKrB,gBAAgB;WACF,iBAAiB,CAAC,CAAC,SAAS,MAAM,mBAAmB,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAI/H,gBAAgB;WACF,UAAU,CAAC,CAAC,SAAS,MAAM,gBAAgB,EAAE,SAAS,EAAE,WAAW,GAAG,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAIzJ,gBAAgB;WACF,kBAAkB,CAAC,CAAC,SAAS,MAAM,yBAAyB,EAAE,SAAS,EAAE,WAAW,GAAG,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;IAInL;;;;OAIG;WACiB,OAAO,CAAC,GAAG,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAY7D,mEAAmE;WAC/C,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;CAI9C;AAED;;;;;;;;;;;GAWG;AACH,8BAAsB,UAAU;IAC9B,+EAA+E;IAC/E,aAAoB,WAAW,IAAI,MAAM,CAAC;IAE1C;;;;;OAKG;WACW,QAAQ,IAAI,cAAc;CAuBzC"}

package/lib/cjs/IpcHost.js

@@ -0,0 +1,234 @@
+"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 NativeApp
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IpcHandler = exports.IpcHost = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const IModelDb_1 = require("./IModelDb");
+const IModelHost_1 = require("./IModelHost");
+const IModelTileRpcImpl_1 = require("./rpc-impl/IModelTileRpcImpl");
+/**
+ * Used by applications that have a dedicated backend. IpcHosts may send messages to their corresponding IpcApp.
+ * @note if either end terminates, the other must too.
+ * @public
+ */
+class IpcHost {
+    /** Get the implementation of the [IpcSocketBackend]($common) interface. */
+    static get ipc() { return this._ipc; }
+    /** Determine whether Ipc is available for this backend. This will only be true if [[startup]] has been called on this class. */
+    static get isValid() { return undefined !== this._ipc; }
+    /**
+     * Send a message to the frontend over an Ipc channel.
+     * @param channel the name of the channel matching the name registered with [[IpcApp.addListener]].
+     * @param data The content of the message.
+     */
+    static send(channel, ...data) {
+        this.ipc.send((0, core_common_1.iTwinChannel)(channel), ...data);
+    }
+    /**
+     * Establish a handler for an Ipc channel to receive [[Frontend.invoke]] calls
+     * @param channel The name of the channel for this handler.
+     * @param handler A function that supplies the implementation for `channel`
+     * @note returns A function to call to remove the handler.
+     */
+    static handle(channel, handler) {
+        return this.ipc.handle((0, core_common_1.iTwinChannel)(channel), handler);
+    }
+    /**
+     * Establish a handler to receive messages sent via [[IpcApp.send]].
+     * @param channel The name of the channel for the messages.
+     * @param listener A function called when messages are sent over `channel`
+     * @note returns A function to call to remove the listener.
+     */
+    static addListener(channel, listener) {
+        return this.ipc.addListener((0, core_common_1.iTwinChannel)(channel), listener);
+    }
+    /**
+     * Remove a previously registered listener
+     * @param channel The name of the channel for the listener previously registered with [[addListener]]
+     * @param listener The function passed to [[addListener]]
+     */
+    static removeListener(channel, listener) {
+        this.ipc.removeListener((0, core_common_1.iTwinChannel)(channel), listener);
+    }
+    static notify(channel, briefcase, methodName, ...args) {
+        if (this.isValid)
+            return this.send(`${channel}:${briefcase.key}`, methodName, ...args);
+    }
+    /** @internal */
+    static notifyIpcFrontend(methodName, ...args) {
+        return IpcHost.send(core_common_1.IpcAppChannel.AppNotify, methodName, ...args);
+    }
+    /** @internal */
+    static notifyTxns(briefcase, methodName, ...args) {
+        this.notify(core_common_1.IpcAppChannel.Txns, briefcase, methodName, ...args);
+    }
+    /** @internal */
+    static notifyEditingScope(briefcase, methodName, ...args) {
+        this.notify(core_common_1.IpcAppChannel.EditingScope, briefcase, methodName, ...args);
+    }
+    /**
+     * Start the backend of an Ipc app.
+     * @param opt
+     * @note this method calls [[IModelHost.startup]] internally.
+     */
+    static async startup(opt) {
+        var _a, _b, _c;
+        this._ipc = (_a = opt === null || opt === void 0 ? void 0 : opt.ipcHost) === null || _a === void 0 ? void 0 : _a.socket;
+        if ((_c = (_b = opt === null || opt === void 0 ? void 0 : opt.ipcHost) === null || _b === void 0 ? void 0 : _b.exceptions) === null || _c === void 0 ? void 0 : _c.noStack)
+            this.noStack = true;
+        if (this.isValid) { // for tests, we use IpcHost but don't have a frontend
+            IpcAppHandler.register();
+        }
+        await IModelHost_1.IModelHost.startup(opt === null || opt === void 0 ? void 0 : opt.iModelHost);
+    }
+    /** Shutdown IpcHost backend. Also calls [[IModelHost.shutdown]] */
+    static async shutdown() {
+        this._ipc = undefined;
+        await IModelHost_1.IModelHost.shutdown();
+    }
+}
+exports.IpcHost = IpcHost;
+IpcHost.noStack = false;
+/**
+ * Base class for all implementations of an Ipc interface.
+ *
+ * Create a subclass to implement your Ipc interface. Your class should be declared like this:
+ * ```ts
+ * class MyHandler extends IpcHandler implements MyInterface
+ * ```
+ * to ensure all methods and signatures are correct.
+ *
+ * Then, call `MyClass.register` at startup to connect your class to your channel.
+ * @public
+ */
+class IpcHandler {
+    /**
+     * Register this class as the handler for methods on its channel. This static method creates a new instance
+     * that becomes the handler and is `this` when its methods are called.
+     * @returns A function that can be called to remove the handler.
+     * @note this method should only be called once per channel. If it is called multiple times, subsequent calls replace the previous ones.
+     */
+    static register() {
+        const impl = new this(); // create an instance of subclass. "as any" is necessary because base class is abstract
+        return IpcHost.handle(impl.channelName, async (_evt, funcName, ...args) => {
+            var _a;
+            try {
+                const func = impl[funcName];
+                if (typeof func !== "function")
+                    throw new core_common_1.IModelError(core_bentley_1.IModelStatus.FunctionNotFound, `Method "${impl.constructor.name}.${funcName}" not found on IpcHandler registered for channel: ${impl.channelName}`);
+                return { result: await func.call(impl, ...args) };
+            }
+            catch (err) {
+                const ret = {
+                    error: {
+                        name: (err && typeof (err) === "object") ? err.constructor.name : "Unknown Error",
+                        message: core_bentley_1.BentleyError.getErrorMessage(err),
+                        errorNumber: (_a = err.errorNumber) !== null && _a !== void 0 ? _a : 0,
+                    },
+                };
+                if (!IpcHost.noStack)
+                    ret.error.stack = core_bentley_1.BentleyError.getErrorStack(err);
+                return ret;
+            }
+        });
+    }
+}
+exports.IpcHandler = IpcHandler;
+/**
+ * Implementation  of IpcAppFunctions
+ */
+class IpcAppHandler extends IpcHandler {
+    get channelName() { return core_common_1.IpcAppChannel.Functions; }
+    async log(_timestamp, level, category, message, metaData) {
+        switch (level) {
+            case core_bentley_1.LogLevel.Error:
+                core_bentley_1.Logger.logError(category, message, metaData);
+                break;
+            case core_bentley_1.LogLevel.Info:
+                core_bentley_1.Logger.logInfo(category, message, metaData);
+                break;
+            case core_bentley_1.LogLevel.Trace:
+                core_bentley_1.Logger.logTrace(category, message, metaData);
+                break;
+            case core_bentley_1.LogLevel.Warning:
+                core_bentley_1.Logger.logWarning(category, message, metaData);
+                break;
+        }
+    }
+    async cancelTileContentRequests(tokenProps, contentIds) {
+        return (0, IModelTileRpcImpl_1.cancelTileContentRequests)(tokenProps, contentIds);
+    }
+    async cancelElementGraphicsRequests(key, requestIds) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.cancelElementGraphicsRequests(requestIds);
+    }
+    async openBriefcase(args) {
+        const db = await IModelDb_1.BriefcaseDb.open(args);
+        return db.toJSON();
+    }
+    async openStandalone(filePath, openMode, opts) {
+        return IModelDb_1.StandaloneDb.openFile(filePath, openMode, opts).getConnectionProps();
+    }
+    async closeIModel(key) {
+        IModelDb_1.IModelDb.findByKey(key).close();
+    }
+    async saveChanges(key, description) {
+        IModelDb_1.IModelDb.findByKey(key).saveChanges(description);
+    }
+    async hasPendingTxns(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.hasPendingTxns();
+    }
+    async isUndoPossible(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.isUndoPossible();
+    }
+    async isRedoPossible(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.isRedoPossible();
+    }
+    async getUndoString(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.getUndoString();
+    }
+    async getRedoString(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.getUndoString();
+    }
+    async pullChanges(key, toIndex) {
+        const iModelDb = IModelDb_1.BriefcaseDb.findByKey(key);
+        await iModelDb.pullChanges({ toIndex });
+        return iModelDb.changeset;
+    }
+    async pushChanges(key, description) {
+        const iModelDb = IModelDb_1.BriefcaseDb.findByKey(key);
+        await iModelDb.pushChanges({ description });
+        return iModelDb.changeset;
+    }
+    async toggleGraphicalEditingScope(key, startSession) {
+        const val = IModelDb_1.IModelDb.findByKey(key).nativeDb.setGeometricModelTrackingEnabled(startSession);
+        if (val.error)
+            throw new core_common_1.IModelError(val.error.status, "Failed to toggle graphical editing scope");
+        return val.result;
+    }
+    async isGraphicalEditingSupported(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.isGeometricModelTrackingSupported();
+    }
+    async reverseTxns(key, numOperations) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.reverseTxns(numOperations);
+    }
+    async reverseAllTxn(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.reverseAll();
+    }
+    async reinstateTxn(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.reinstateTxn();
+    }
+    async restartTxnSession(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.restartTxnSession();
+    }
+    async queryConcurrency(pool) {
+        return IModelHost_1.IModelHost.platform.queryConcurrency(pool);
+    }
+}
+//# sourceMappingURL=IpcHost.js.map