@itwin/core-backend 5.0.0-dev.11 → 5.0.0-dev.111

package/lib/esm/internal/ChangesetConflictArgs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangesetConflictArgs.js","sourceRoot":"","sources":["../../../src/internal/ChangesetConflictArgs.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,QAAQ,EAAE,WAAW,EAAc,MAAM,qBAAqB,CAAC;AACxG,OAAO,EAAkB,qBAAqB,EAAoB,MAAM,0BAA0B,CAAC;AAuCnG,MAAM,OAAO,2BAA2B;IAClB;IAAuD;IAA3E,YAAoB,cAA6C,EAAU,OAAiB;QAAxE,mBAAc,GAAd,cAAc,CAA+B;QAAU,YAAO,GAAP,OAAO,CAAU;IAAE,CAAC;IAC/F,IAAW,KAAK;QACd,QAAQ,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;YAClC,KAAK,eAAe,CAAC,QAAQ,CAAC,CAAC,OAAO,UAAU,CAAC;YACjD,KAAK,eAAe,CAAC,IAAI,CAAC,CAAC,OAAO,MAAM,CAAC;YACzC,KAAK,eAAe,CAAC,UAAU,CAAC,CAAC,OAAO,YAAY,CAAC;YACrD,KAAK,eAAe,CAAC,UAAU,CAAC,CAAC,OAAO,YAAY,CAAC;YACrD,KAAK,eAAe,CAAC,QAAQ,CAAC,CAAC,OAAO,UAAU,CAAC;QACnD,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IACD,IAAW,MAAM;QACf,QAAQ,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;YACnC,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,UAAU,CAAC;YACxC,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,SAAS,CAAC;YACvC,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,SAAS,CAAC;QACzC,CAAC;IACH,CAAC;IACM,OAAO;QACZ,OAAO,qBAAqB,CAAC,OAAO,CAAC,EAAC,KAAK,EAAE,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAC,CAAC,CAAC;IAC9F,CAAC;IACD,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;IACtC,CAAC;IACD,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC;IACvC,CAAC;IACD,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC;IACzC,CAAC;IACM,sBAAsB;QAC3B,OAAO,IAAI,CAAC,cAAc,CAAC,sBAAsB,EAAE,CAAC;IACtD,CAAC;IACM,YAAY,CAAC,OAAe;QACjC,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IACM,oBAAoB;QACzB,OAAO,IAAI,CAAC,cAAc,CAAC,oBAAoB,EAAE,CAAC;IACpD,CAAC;IACM,YAAY,CAAC,WAAmB,EAAE,KAAuB;QAC9D,OAAO,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,WAAW,EAAE,KAAK,KAAI,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAC/G,CAAC;IACM,cAAc,CAAC,WAAmB,EAAE,KAAuB;QAChE,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,KAAI,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACjH,CAAC;IACM,UAAU,CAAC,WAAmB,EAAE,KAAuB;QAC5D,OAAO,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,KAAI,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAC7G,CAAC;IACM,YAAY,CAAC,WAAmB,EAAE,KAAuB;QAC9D,OAAO,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,WAAW,EAAE,KAAK,KAAI,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAC/G,CAAC;IACM,eAAe,CAAC,WAAmB,EAAE,KAAuB;QACjE,OAAO,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,WAAW,EAAE,KAAK,KAAI,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAClH,CAAC;IACM,cAAc,CAAC,WAAmB,EAAE,KAAuB;QAChE,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,KAAI,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACjH,CAAC;IACM,WAAW,CAAC,WAAmB,EAAE,KAAuB;QAC7D,OAAO,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,WAAW,EAAE,KAAK,KAAI,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAC9G,CAAC;IACM,cAAc;QACnB,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,CAAC;IAC9C,CAAC;IACM,mBAAmB;QACxB,MAAM,GAAG,GAAwD,EAAE,CAAC;QACpE,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;YAC3B,OAAO,GAAG,CAAC;QAEb,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC;QACrG,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,cAAc,CAAC,oBAAoB,EAAE,EAAE,CAAC;YAC5D,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;YACzD,IAAI,IAAI,KAAK,WAAW,CAAC,UAAU;gBACjC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;iBACjD,IAAI,IAAI,KAAK,WAAW,CAAC,OAAO;gBACnC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;iBACnD,IAAI,IAAI,KAAK,WAAW,CAAC,QAAQ;gBACpC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;iBACrD,IAAI,IAAI,KAAK,WAAW,CAAC,OAAO;gBACnC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;;gBAExD,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAAA,CAAC;IACF,IAAW,GAAG;QACZ,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC;IACjC,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\n/** @packageDocumentation\n * @module iModels\n */\n\nimport { DbChangeStage, DbConflictCause, DbOpcode, DbValueType, Id64String } from \"@itwin/core-bentley\";\nimport { SqliteChangeOp, SqliteChangesetReader, SqliteValueStage } from \"../SqliteChangesetReader\";\nimport { IModelDb } from \"../IModelDb\";\n\nexport interface DbChangesetConflictArgs {\n  cause: DbConflictCause;\n  opcode: DbOpcode;\n  indirect: boolean;\n  tableName: string;\n  columnCount: number;\n  getForeignKeyConflicts: () => number;\n  dump: () => void;\n  setLastError: (message: string) => void;\n  getPrimaryKeyColumns: () => number[];\n  getValueType: (columnIndex: number, stage: DbChangeStage) => DbValueType | null | undefined;\n  getValueBinary: (columnIndex: number, stage: DbChangeStage) => Uint8Array | null | undefined;\n  getValueId: (columnIndex: number, stage: DbChangeStage) => Id64String | null | undefined;\n  getValueText: (columnIndex: number, stage: DbChangeStage) => string | null | undefined;\n  getValueInteger: (columnIndex: number, stage: DbChangeStage) => number | null | undefined;\n  getValueDouble: (columnIndex: number, stage: DbChangeStage) => number | null | undefined;\n  isValueNull: (columnIndex: number, stage: DbChangeStage) => boolean | undefined;\n  getColumnNames(): string[];\n}\n\nexport interface DbMergeChangesetConflictArgs extends DbChangesetConflictArgs {\n  changesetFile?: string;\n}\n\nexport interface TxnArgs {\n  id: Id64String;\n  type: \"Data\" | \"Schema\";\n  descr: string;\n}\n\nexport interface DbRebaseChangesetConflictArgs extends DbChangesetConflictArgs {\n  txn: TxnArgs;\n}\n\nexport type SqliteConflictCause = \"Conflict\" | \"Data\" | \"Constraint\" | \"ForeignKey\" | \"NotFound\";\n\nexport class RebaseChangesetConflictArgs {\n  constructor(private _dbConflictArg: DbRebaseChangesetConflictArgs, private _iModel: IModelDb){}\n  public get cause() : SqliteConflictCause {\n    switch (this._dbConflictArg.cause) {\n      case DbConflictCause.Conflict: return \"Conflict\";\n      case DbConflictCause.Data: return \"Data\";\n      case DbConflictCause.Constraint: return \"Constraint\";\n      case DbConflictCause.ForeignKey: return \"ForeignKey\";\n      case DbConflictCause.NotFound: return \"NotFound\";\n    }\n    throw new Error(\"Invalid value for cause\");\n  }\n  public get opcode(): SqliteChangeOp | undefined {\n    switch (this._dbConflictArg.opcode) {\n      case DbOpcode.Insert: return \"Inserted\";\n      case DbOpcode.Update: return \"Updated\";\n      case DbOpcode.Delete: return \"Deleted\";\n    }\n  }\n  public openTxn(): SqliteChangesetReader {\n    return SqliteChangesetReader.openTxn({txnId: this._dbConflictArg.txn.id, db: this._iModel});\n  }\n  public get indirect(): boolean {\n    return this._dbConflictArg.indirect;\n  }\n  public get tableName(): string {\n    return this._dbConflictArg.tableName;\n  }\n  public get columnCount(): number {\n    return this._dbConflictArg.columnCount;\n  }\n  public getForeignKeyConflicts(): number {\n    return this._dbConflictArg.getForeignKeyConflicts();\n  }\n  public setLastError(message: string): void {\n    this._dbConflictArg.setLastError(message);\n  }\n  public getPrimaryKeyColumns(): number[] {\n    return this._dbConflictArg.getPrimaryKeyColumns();\n  }\n  public getValueType(columnIndex: number, stage: SqliteValueStage): DbValueType | null | undefined {\n    return this._dbConflictArg.getValueType(columnIndex, stage=== \"New\" ? DbChangeStage.New : DbChangeStage.Old);\n  }\n  public getValueBinary(columnIndex: number, stage: SqliteValueStage): Uint8Array | null | undefined {\n    return this._dbConflictArg.getValueBinary(columnIndex, stage=== \"New\" ? DbChangeStage.New : DbChangeStage.Old);\n  }\n  public getValueId(columnIndex: number, stage: SqliteValueStage): Id64String | null | undefined {\n    return this._dbConflictArg.getValueId(columnIndex, stage=== \"New\" ? DbChangeStage.New : DbChangeStage.Old);\n  }\n  public getValueText(columnIndex: number, stage: SqliteValueStage): string | null | undefined {\n    return this._dbConflictArg.getValueText(columnIndex, stage=== \"New\" ? DbChangeStage.New : DbChangeStage.Old);\n  }\n  public getValueInteger(columnIndex: number, stage: SqliteValueStage): number | null | undefined {\n    return this._dbConflictArg.getValueInteger(columnIndex, stage=== \"New\" ? DbChangeStage.New : DbChangeStage.Old);\n  }\n  public getValueDouble(columnIndex: number, stage: SqliteValueStage): number | null | undefined {\n    return this._dbConflictArg.getValueDouble(columnIndex, stage=== \"New\" ? DbChangeStage.New : DbChangeStage.Old);\n  }\n  public isValueNull(columnIndex: number, stage: SqliteValueStage): boolean | undefined {\n    return this._dbConflictArg.isValueNull(columnIndex, stage=== \"New\" ? DbChangeStage.New : DbChangeStage.Old);\n  }\n  public getColumnNames(): string[] {\n    return this._dbConflictArg.getColumnNames();\n  }\n  public getPrimaryKeyValues() {\n    const pkv: (Uint8Array | number | string | null | undefined)[] = [];\n    if (this.opcode === undefined)\n      return pkv;\n\n    const stage = this._dbConflictArg.opcode === DbOpcode.Insert ? DbChangeStage.New : DbChangeStage.Old;\n    for (const pk of this._dbConflictArg.getPrimaryKeyColumns()) {\n      const type = this._dbConflictArg.getValueType(pk, stage);\n      if (type === DbValueType.IntegerVal)\n        pkv.push(this._dbConflictArg.getValueId(pk, stage));\n      else if (type === DbValueType.TextVal)\n        pkv.push(this._dbConflictArg.getValueText(pk, stage));\n      else if (type === DbValueType.FloatVal)\n        pkv.push(this._dbConflictArg.getValueDouble(pk, stage));\n      else if (type === DbValueType.BlobVal)\n        pkv.push(this._dbConflictArg.getValueBinary(pk, stage));\n      else\n        pkv.push(null);\n    }\n    return pkv;\n  };\n  public get txn() {\n    return this._dbConflictArg.txn;\n  }\n}\n\n"]}

package/lib/esm/internal/ChannelAdmin.d.ts

@@ -0,0 +1,34 @@
+/** @packageDocumentation
+ * @module Elements
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { ChannelControl, ChannelKey } from "../ChannelControl";
+import { IModelDb } from "../IModelDb";
+import { _implementationProhibited, _verifyChannel } from "./Symbols";
+declare class ChannelAdmin implements ChannelControl {
+    private _iModel;
+    static readonly channelClassName = "bis:ChannelRootAspect";
+    readonly [_implementationProhibited]: undefined;
+    private _allowedChannels;
+    private _allowedModels;
+    private _deniedModels;
+    constructor(_iModel: IModelDb);
+    addAllowedChannel(channelKey: ChannelKey): void;
+    removeAllowedChannel(channelKey: ChannelKey): void;
+    getChannelKey(elementId: Id64String): ChannelKey;
+    [_verifyChannel](modelId: Id64String): void;
+    makeChannelRoot(args: {
+        elementId: Id64String;
+        channelKey: ChannelKey;
+    }): void;
+    insertChannelSubject(args: {
+        subjectName: string;
+        channelKey: ChannelKey;
+        parentSubjectId?: Id64String;
+        description?: string;
+    }): Id64String;
+    queryChannelRoot(channelKey: ChannelKey): Id64String | undefined;
+}
+export declare function createChannelControl(iModel: IModelDb): ChannelAdmin;
+export {};
+//# sourceMappingURL=ChannelAdmin.d.ts.map

package/lib/esm/internal/ChannelAdmin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChannelAdmin.d.ts","sourceRoot":"","sources":["../../../src/internal/ChannelAdmin.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAY,UAAU,EAAgB,MAAM,qBAAqB,CAAC;AAEzE,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/D,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,OAAO,EAAE,yBAAyB,EAAa,cAAc,EAAE,MAAM,WAAW,CAAC;AAEjF,cAAM,YAAa,YAAW,cAAc;IAQvB,OAAO,CAAC,OAAO;IAPlC,gBAAuB,gBAAgB,2BAA2B;IAElE,SAAgB,CAAC,yBAAyB,CAAC,YAAa;IACxD,OAAO,CAAC,gBAAgB,CAAyB;IACjD,OAAO,CAAC,cAAc,CAAyB;IAC/C,OAAO,CAAC,aAAa,CAAqC;gBAE/B,OAAO,EAAE,QAAQ;IAMrC,iBAAiB,CAAC,UAAU,EAAE,UAAU;IAKxC,oBAAoB,CAAC,UAAU,EAAE,UAAU;IAK3C,aAAa,CAAC,SAAS,EAAE,UAAU,GAAG,UAAU;IA6BhD,CAAC,cAAc,CAAC,CAAC,OAAO,EAAE,UAAU,GAAG,IAAI;IAmB3C,eAAe,CAAC,IAAI,EAAE;QAAE,SAAS,EAAE,UAAU,CAAC;QAAC,UAAU,EAAE,UAAU,CAAA;KAAE;IAYvE,oBAAoB,CAAC,IAAI,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,UAAU,CAAC;QAAC,eAAe,CAAC,EAAE,UAAU,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,UAAU;IAY3I,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS;CAoBxE;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,QAAQ,GAAG,YAAY,CAEnE"}

package/lib/esm/internal/ChannelAdmin.js

@@ -0,0 +1,116 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Elements
+ */
+import { DbResult, IModelStatus } from "@itwin/core-bentley";
+import { ChannelControlError, IModel, IModelError } from "@itwin/core-common";
+import { ChannelControl } from "../ChannelControl";
+import { Subject } from "../Element";
+import { IModelHost } from "../IModelHost";
+import { _implementationProhibited, _nativeDb, _verifyChannel } from "./Symbols";
+class ChannelAdmin {
+    _iModel;
+    static channelClassName = "bis:ChannelRootAspect";
+    [_implementationProhibited] = undefined;
+    _allowedChannels = new Set();
+    _allowedModels = new Set();
+    _deniedModels = new Map();
+    constructor(_iModel) {
+        this._iModel = _iModel;
+        // for backwards compatibility, allow the shared channel unless explicitly turned off in IModelHostOptions.
+        if (IModelHost.configuration?.allowSharedChannel !== false)
+            this._allowedChannels.add(ChannelControl.sharedChannelName);
+    }
+    addAllowedChannel(channelKey) {
+        this._allowedChannels.add(channelKey);
+        this._deniedModels.clear();
+    }
+    removeAllowedChannel(channelKey) {
+        this._allowedChannels.delete(channelKey);
+        this._allowedModels.clear();
+    }
+    getChannelKey(elementId) {
+        if (elementId === IModel.rootSubjectId)
+            return ChannelControl.sharedChannelName;
+        try {
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
+            const channel = this._iModel.withPreparedStatement(`SELECT Owner FROM ${ChannelAdmin.channelClassName} WHERE Element.Id=?`, (stmt) => {
+                stmt.bindId(1, elementId);
+                return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValue(0).getString() : undefined;
+            });
+            if (channel !== undefined)
+                return channel;
+        }
+        catch {
+            // Exception happens if the iModel is too old: ChannelRootAspect class not present in the BisCore schema (older than v1.0.10).
+            // In that case all data in such iModel is assumed to be in the shared channel.
+            return ChannelControl.sharedChannelName;
+        }
+        const parentId = this._iModel.withPreparedSqliteStatement("SELECT ParentId,ModelId FROM bis_Element WHERE id=?", (stmt) => {
+            stmt.bindId(1, elementId);
+            if (DbResult.BE_SQLITE_ROW !== stmt.step())
+                throw new IModelError(IModelStatus.NotFound, "Element does not exist");
+            return stmt.getValueId(0) ?? stmt.getValueId(1); // if parent is undefined, use modelId
+        });
+        return this.getChannelKey(parentId);
+    }
+    [_verifyChannel](modelId) {
+        // Note: indirect changes are permitted to change any channel
+        if (this._allowedModels.has(modelId) || this._iModel[_nativeDb].isIndirectChanges())
+            return;
+        const deniedChannel = this._deniedModels.get(modelId);
+        if (undefined !== deniedChannel)
+            ChannelControlError.throwError("not-allowed", `Channel ${deniedChannel} is not allowed`, deniedChannel);
+        const channel = this.getChannelKey(modelId);
+        if (this._allowedChannels.has(channel)) {
+            this._allowedModels.add(modelId);
+            return;
+        }
+        this._deniedModels.set(modelId, channel);
+        return this[_verifyChannel](modelId);
+    }
+    makeChannelRoot(args) {
+        const channelKey = this.getChannelKey(args.elementId);
+        if (ChannelControl.sharedChannelName !== channelKey)
+            ChannelControlError.throwError("may-not-nest", `Channel ${channelKey} may not nest`, channelKey);
+        if (this.queryChannelRoot(args.channelKey) !== undefined)
+            ChannelControlError.throwError("root-exists", `Channel ${args.channelKey} root already exist`, channelKey);
+        const props = { classFullName: ChannelAdmin.channelClassName, element: { id: args.elementId }, owner: args.channelKey };
+        this._iModel.elements.insertAspect(props);
+    }
+    insertChannelSubject(args) {
+        // Check if channelKey already exists before inserting Subject.
+        // makeChannelRoot will check that again, but at that point the new Subject is already inserted.
+        // Prefer to check twice instead of deleting the Subject in the latter option.
+        if (this.queryChannelRoot(args.channelKey) !== undefined)
+            ChannelControlError.throwError("root-exists", `Channel ${args.channelKey} root already exist`, args.channelKey);
+        const elementId = Subject.insert(this._iModel, args.parentSubjectId ?? IModel.rootSubjectId, args.subjectName, args.description);
+        this.makeChannelRoot({ elementId, channelKey: args.channelKey });
+        return elementId;
+    }
+    queryChannelRoot(channelKey) {
+        if (channelKey === ChannelControl.sharedChannelName)
+            // RootSubject acts as the ChannelRoot element of the shared channel
+            return IModel.rootSubjectId;
+        try {
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
+            const channelRoot = this._iModel.withPreparedStatement(`SELECT Element.Id FROM ${ChannelAdmin.channelClassName} WHERE Owner=?`, (stmt) => {
+                stmt.bindString(1, channelKey);
+                return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValue(0).getId() : undefined;
+            });
+            return channelRoot;
+        }
+        catch {
+            // Exception happens if the iModel is too old: ChannelRootAspect class not present in the BisCore schema (older than v1.0.10).
+            // In that case all data in such iModel is assumed to be in the shared channel.
+            return undefined;
+        }
+    }
+}
+export function createChannelControl(iModel) {
+    return new ChannelAdmin(iModel);
+}
+//# sourceMappingURL=ChannelAdmin.js.map

package/lib/esm/internal/ChannelAdmin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChannelAdmin.js","sourceRoot":"","sources":["../../../src/internal/ChannelAdmin.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAc,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACzE,OAAO,EAAE,mBAAmB,EAA0B,MAAM,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtG,OAAO,EAAE,cAAc,EAAc,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,yBAAyB,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEjF,MAAM,YAAY;IAQW;IAPpB,MAAM,CAAU,gBAAgB,GAAG,uBAAuB,CAAC;IAElD,CAAC,yBAAyB,CAAC,GAAG,SAAS,CAAC;IAChD,gBAAgB,GAAG,IAAI,GAAG,EAAc,CAAC;IACzC,cAAc,GAAG,IAAI,GAAG,EAAc,CAAC;IACvC,aAAa,GAAG,IAAI,GAAG,EAA0B,CAAC;IAE1D,YAA2B,OAAiB;QAAjB,YAAO,GAAP,OAAO,CAAU;QAC1C,2GAA2G;QAC3G,IAAI,UAAU,CAAC,aAAa,EAAE,kBAAkB,KAAK,KAAK;YACxD,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;IAChE,CAAC;IAEM,iBAAiB,CAAC,UAAsB;QAC7C,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACtC,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;IAC7B,CAAC;IAEM,oBAAoB,CAAC,UAAsB;QAChD,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACzC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;IAEM,aAAa,CAAC,SAAqB;QACxC,IAAI,SAAS,KAAK,MAAM,CAAC,aAAa;YACpC,OAAO,cAAc,CAAC,iBAAiB,CAAC;QAE1C,IAAI,CAAC;YACH,4DAA4D;YAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,qBAAqB,YAAY,CAAC,gBAAgB,qBAAqB,EAAE,CAAC,IAAI,EAAE,EAAE;gBACnI,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;gBAC1B,OAAO,QAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YAC3F,CAAC,CAAC,CAAC;YAEH,IAAI,OAAO,KAAK,SAAS;gBACvB,OAAO,OAAO,CAAC;QACnB,CAAC;QAAC,MAAM,CAAC;YACP,8HAA8H;YAC9H,+EAA+E;YAC/E,OAAO,cAAc,CAAC,iBAAiB,CAAC;QAC1C,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,qDAAqD,EAAE,CAAC,IAAI,EAAE,EAAE;YACxH,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;YAC1B,IAAI,QAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE;gBACxC,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,wBAAwB,CAAC,CAAC;YACzE,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,sCAAsC;QACzF,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAEM,CAAC,cAAc,CAAC,CAAC,OAAmB;QACzC,6DAA6D;QAC7D,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,iBAAiB,EAAE;YACjF,OAAO;QAET,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACtD,IAAI,SAAS,KAAK,aAAa;YAC7B,mBAAmB,CAAC,UAAU,CAAC,aAAa,EAAE,WAAW,aAAa,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAE1G,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC5C,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACjC,OAAO;QACT,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAEM,eAAe,CAAC,IAAuD;QAC5E,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACtD,IAAI,cAAc,CAAC,iBAAiB,KAAK,UAAU;YACjD,mBAAmB,CAAC,UAAU,CAAC,cAAc,EAAE,WAAW,UAAU,eAAe,EAAE,UAAU,CAAC,CAAC;QAEnG,IAAI,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,SAAS;YACtD,mBAAmB,CAAC,UAAU,CAAC,aAAa,EAAE,WAAW,IAAI,CAAC,UAAU,qBAAqB,EAAE,UAAU,CAAC,CAAC;QAE7G,MAAM,KAAK,GAA2B,EAAE,aAAa,EAAE,YAAY,CAAC,gBAAgB,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;QAChJ,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAEM,oBAAoB,CAAC,IAAyG;QACnI,+DAA+D;QAC/D,gGAAgG;QAChG,8EAA8E;QAC9E,IAAI,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,SAAS;YACtD,mBAAmB,CAAC,UAAU,CAAC,aAAa,EAAE,WAAW,IAAI,CAAC,UAAU,qBAAqB,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAElH,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,eAAe,IAAI,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACjI,IAAI,CAAC,eAAe,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;QACjE,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,gBAAgB,CAAC,UAAsB;QAC5C,IAAI,UAAU,KAAK,cAAc,CAAC,iBAAiB;YACjD,oEAAoE;YACpE,OAAO,MAAM,CAAC,aAAa,CAAC;QAE9B,IAAI,CAAC;YACH,4DAA4D;YAC5D,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,0BAA0B,YAAY,CAAC,gBAAgB,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE;gBACvI,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;gBAC/B,OAAO,QAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YACvF,CAAC,CAAC,CAAC;YAEH,OAAO,WAAW,CAAC;QACrB,CAAC;QAAC,MAAM,CAAC;YACP,8HAA8H;YAC9H,+EAA+E;YAC/E,OAAO,SAAS,CAAC;QACnB,CAAC;IAEH,CAAC;;AAGH,MAAM,UAAU,oBAAoB,CAAC,MAAgB;IACnD,OAAO,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;AAClC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Elements\n */\n\nimport { DbResult, Id64String, IModelStatus } from \"@itwin/core-bentley\";\nimport { ChannelControlError, ChannelRootAspectProps, IModel, IModelError } from \"@itwin/core-common\";\nimport { ChannelControl, ChannelKey } from \"../ChannelControl\";\nimport { Subject } from \"../Element\";\nimport { IModelDb } from \"../IModelDb\";\nimport { IModelHost } from \"../IModelHost\";\nimport { _implementationProhibited, _nativeDb, _verifyChannel } from \"./Symbols\";\n\nclass ChannelAdmin implements ChannelControl {\n  public static readonly channelClassName = \"bis:ChannelRootAspect\";\n\n  public readonly [_implementationProhibited] = undefined;\n  private _allowedChannels = new Set<ChannelKey>();\n  private _allowedModels = new Set<Id64String>();\n  private _deniedModels = new Map<Id64String, ChannelKey>();\n\n  public constructor(private _iModel: IModelDb) {\n    // for backwards compatibility, allow the shared channel unless explicitly turned off in IModelHostOptions.\n    if (IModelHost.configuration?.allowSharedChannel !== false)\n      this._allowedChannels.add(ChannelControl.sharedChannelName);\n  }\n\n  public addAllowedChannel(channelKey: ChannelKey) {\n    this._allowedChannels.add(channelKey);\n    this._deniedModels.clear();\n  }\n\n  public removeAllowedChannel(channelKey: ChannelKey) {\n    this._allowedChannels.delete(channelKey);\n    this._allowedModels.clear();\n  }\n\n  public getChannelKey(elementId: Id64String): ChannelKey {\n    if (elementId === IModel.rootSubjectId)\n      return ChannelControl.sharedChannelName;\n\n    try {\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      const channel = this._iModel.withPreparedStatement(`SELECT Owner FROM ${ChannelAdmin.channelClassName} WHERE Element.Id=?`, (stmt) => {\n        stmt.bindId(1, elementId);\n        return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValue(0).getString() : undefined;\n      });\n\n      if (channel !== undefined)\n        return channel;\n    } catch {\n      // Exception happens if the iModel is too old: ChannelRootAspect class not present in the BisCore schema (older than v1.0.10).\n      // In that case all data in such iModel is assumed to be in the shared channel.\n      return ChannelControl.sharedChannelName;\n    }\n\n    const parentId = this._iModel.withPreparedSqliteStatement(\"SELECT ParentId,ModelId FROM bis_Element WHERE id=?\", (stmt) => {\n      stmt.bindId(1, elementId);\n      if (DbResult.BE_SQLITE_ROW !== stmt.step())\n        throw new IModelError(IModelStatus.NotFound, \"Element does not exist\");\n      return stmt.getValueId(0) ?? stmt.getValueId(1); // if parent is undefined, use modelId\n    });\n\n    return this.getChannelKey(parentId);\n  }\n\n  public [_verifyChannel](modelId: Id64String): void {\n    // Note: indirect changes are permitted to change any channel\n    if (this._allowedModels.has(modelId) || this._iModel[_nativeDb].isIndirectChanges())\n      return;\n\n    const deniedChannel = this._deniedModels.get(modelId);\n    if (undefined !== deniedChannel)\n      ChannelControlError.throwError(\"not-allowed\", `Channel ${deniedChannel} is not allowed`, deniedChannel);\n\n    const channel = this.getChannelKey(modelId);\n    if (this._allowedChannels.has(channel)) {\n      this._allowedModels.add(modelId);\n      return;\n    }\n\n    this._deniedModels.set(modelId, channel);\n    return this[_verifyChannel](modelId);\n  }\n\n  public makeChannelRoot(args: { elementId: Id64String, channelKey: ChannelKey }) {\n    const channelKey = this.getChannelKey(args.elementId);\n    if (ChannelControl.sharedChannelName !== channelKey)\n      ChannelControlError.throwError(\"may-not-nest\", `Channel ${channelKey} may not nest`, channelKey);\n\n    if (this.queryChannelRoot(args.channelKey) !== undefined)\n      ChannelControlError.throwError(\"root-exists\", `Channel ${args.channelKey} root already exist`, channelKey);\n\n    const props: ChannelRootAspectProps = { classFullName: ChannelAdmin.channelClassName, element: { id: args.elementId }, owner: args.channelKey };\n    this._iModel.elements.insertAspect(props);\n  }\n\n  public insertChannelSubject(args: { subjectName: string, channelKey: ChannelKey, parentSubjectId?: Id64String, description?: string }): Id64String {\n    // Check if channelKey already exists before inserting Subject.\n    // makeChannelRoot will check that again, but at that point the new Subject is already inserted.\n    // Prefer to check twice instead of deleting the Subject in the latter option.\n    if (this.queryChannelRoot(args.channelKey) !== undefined)\n      ChannelControlError.throwError(\"root-exists\", `Channel ${args.channelKey} root already exist`, args.channelKey);\n\n    const elementId = Subject.insert(this._iModel, args.parentSubjectId ?? IModel.rootSubjectId, args.subjectName, args.description);\n    this.makeChannelRoot({ elementId, channelKey: args.channelKey });\n    return elementId;\n  }\n\n  public queryChannelRoot(channelKey: ChannelKey): Id64String | undefined {\n    if (channelKey === ChannelControl.sharedChannelName)\n      // RootSubject acts as the ChannelRoot element of the shared channel\n      return IModel.rootSubjectId;\n\n    try {\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      const channelRoot = this._iModel.withPreparedStatement(`SELECT Element.Id FROM ${ChannelAdmin.channelClassName} WHERE Owner=?`, (stmt) => {\n        stmt.bindString(1, channelKey);\n        return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValue(0).getId() : undefined;\n      });\n\n      return channelRoot;\n    } catch {\n      // Exception happens if the iModel is too old: ChannelRootAspect class not present in the BisCore schema (older than v1.0.10).\n      // In that case all data in such iModel is assumed to be in the shared channel.\n      return undefined;\n    }\n\n  }\n}\n\nexport function createChannelControl(iModel: IModelDb): ChannelAdmin {\n  return new ChannelAdmin(iModel);\n}\n"]}

package/lib/esm/internal/ElementLRUCache.d.ts

@@ -0,0 +1,28 @@
+import { Id64String } from "@itwin/core-bentley";
+import { ElementLoadOptions, ElementLoadProps, ElementProps } from "@itwin/core-common";
+export interface CachedElement {
+    loadOptions: ElementLoadOptions;
+    elProps: ElementProps;
+}
+/**
+ * A LRU cache for entities. Cache contains the ElementProps and the load options used to load it.
+ * Cache can be searched by id, code or federationGuid.
+ */
+export declare class ElementLRUCache {
+    readonly capacity: number;
+    static readonly DEFAULT_CAPACITY = 2000;
+    private _elementCache;
+    private _cacheByCode;
+    private _cacheByFederationGuid;
+    private static makeCodeKey;
+    private findElement;
+    constructor(capacity?: number);
+    clear(): void;
+    get size(): number;
+    deleteWithModel(modelId: Id64String): void;
+    delete(key: ElementLoadProps): boolean;
+    get(key: ElementLoadProps): CachedElement | undefined;
+    set(el: CachedElement): this;
+    get [Symbol.toStringTag](): string;
+}
+//# sourceMappingURL=ElementLRUCache.d.ts.map

package/lib/esm/internal/ElementLRUCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ElementLRUCache.d.ts","sourceRoot":"","sources":["../../../src/internal/ElementLRUCache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAa,kBAAkB,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAGnG,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,kBAAkB,CAAA;IAC/B,OAAO,EAAE,YAAY,CAAC;CACvB;AAED;;;GAGG;AACH,qBAAa,eAAe;aA6BS,QAAQ;IA5B3C,gBAAuB,gBAAgB,QAAQ;IAC/C,OAAO,CAAC,aAAa,CAAwC;IAC7D,OAAO,CAAC,YAAY,CAAqC;IACzD,OAAO,CAAC,sBAAsB,CAAiC;IAE/D,OAAO,CAAC,MAAM,CAAC,WAAW;IAO1B,OAAO,CAAC,WAAW;gBAgBgB,QAAQ,SAAmC;IACvE,KAAK,IAAI,IAAI;IAKpB,IAAW,IAAI,IAAI,MAAM,CAExB;IACM,eAAe,CAAC,OAAO,EAAE,UAAU,GAAG,IAAI;IAM1C,MAAM,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO;IAYtC,GAAG,CAAC,GAAG,EAAE,gBAAgB,GAAG,aAAa,GAAG,SAAS;IAoBrD,GAAG,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI;IA6BnC,IAAW,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAExC;CACF"}

package/lib/esm/internal/ElementLRUCache.js

@@ -0,0 +1,116 @@
+/**
+ * A LRU cache for entities. Cache contains the ElementProps and the load options used to load it.
+ * Cache can be searched by id, code or federationGuid.
+ */
+export class ElementLRUCache {
+    capacity;
+    static DEFAULT_CAPACITY = 2000;
+    _elementCache = new Map();
+    _cacheByCode = new Map();
+    _cacheByFederationGuid = new Map();
+    static makeCodeKey(code) {
+        const keys = [code.scope, code.spec];
+        if (code.value !== undefined) {
+            keys.push(code.value);
+        }
+        return JSON.stringify(keys);
+    }
+    findElement(key) {
+        if (key.id) {
+            return this._elementCache.get(key.id);
+        }
+        else if (key.federationGuid) {
+            const id = this._cacheByFederationGuid.get(key.federationGuid);
+            if (id)
+                return this._elementCache.get(id);
+        }
+        else if (key.code) {
+            const id = this._cacheByCode.get(ElementLRUCache.makeCodeKey(key.code));
+            if (id)
+                return this._elementCache.get(id);
+        }
+        else {
+            throw new Error("No key provided");
+        }
+        return undefined;
+    }
+    constructor(capacity = ElementLRUCache.DEFAULT_CAPACITY) {
+        this.capacity = capacity;
+    }
+    clear() {
+        this._elementCache.clear();
+        this._cacheByCode.clear();
+        this._cacheByFederationGuid.clear();
+    }
+    get size() {
+        return this._elementCache.size;
+    }
+    deleteWithModel(modelId) {
+        this._elementCache.forEach((cachedVal, elementId) => {
+            if (cachedVal.elProps.model === modelId)
+                this.delete({ id: elementId });
+        });
+    }
+    delete(key) {
+        const cachedElement = this.findElement(key);
+        if (cachedElement) {
+            if (cachedElement.elProps.id)
+                this._elementCache.delete(cachedElement.elProps.id);
+            this._cacheByCode.delete(ElementLRUCache.makeCodeKey(cachedElement.elProps.code));
+            if (cachedElement.elProps.federationGuid)
+                this._cacheByFederationGuid.delete(cachedElement.elProps.federationGuid);
+            return true;
+        }
+        return false;
+    }
+    get(key) {
+        const cachedElement = this.findElement(key);
+        if (cachedElement) {
+            if (cachedElement.elProps.id) {
+                this._elementCache.delete(cachedElement.elProps.id);
+                this._elementCache.set(cachedElement.elProps.id, cachedElement);
+            }
+        }
+        if (cachedElement) {
+            if (key.displayStyle !== cachedElement.loadOptions.displayStyle ||
+                key.onlyBaseProperties !== cachedElement.loadOptions.onlyBaseProperties ||
+                key.renderTimeline !== cachedElement.loadOptions.renderTimeline ||
+                key.wantBRepData !== cachedElement.loadOptions.wantBRepData ||
+                key.wantGeometry !== cachedElement.loadOptions.wantGeometry) {
+                return undefined;
+            }
+        }
+        return cachedElement;
+    }
+    set(el) {
+        if (!el.elProps.id)
+            throw new Error("Element must have an id");
+        // do not cache this element as geom need to be rerender into geom props if any part changes
+        // TODO: find a way to handle caching geometry
+        if (el.loadOptions.wantGeometry) {
+            return this;
+        }
+        if (this._elementCache.has(el.elProps.id)) {
+            this._elementCache.delete(el.elProps.id);
+            this._elementCache.set(el.elProps.id, el);
+        }
+        else {
+            this._elementCache.set(el.elProps.id, el);
+        }
+        if (el.elProps.federationGuid) {
+            this._cacheByFederationGuid.set(el.elProps.federationGuid, el.elProps.id);
+        }
+        this._cacheByCode.set(ElementLRUCache.makeCodeKey(el.elProps.code), el.elProps.id);
+        if (this._elementCache.size > this.capacity) {
+            const oldestKey = this._elementCache.keys().next().value;
+            const oldestElement = this._elementCache.get(oldestKey);
+            this.delete({ id: oldestKey, federationGuid: oldestElement?.elProps.federationGuid, code: oldestElement?.elProps.code });
+        }
+        return this;
+    }
+    get [Symbol.toStringTag]() {
+        return `EntityCache(this.size=${this.size}, capacity=${this.capacity})`;
+    }
+}
+;
+//# sourceMappingURL=ElementLRUCache.js.map

package/lib/esm/internal/ElementLRUCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ElementLRUCache.js","sourceRoot":"","sources":["../../../src/internal/ElementLRUCache.ts"],"names":[],"mappings":"AASA;;;GAGG;AACH,MAAM,OAAO,eAAe;IA6BS;IA5B5B,MAAM,CAAU,gBAAgB,GAAG,IAAI,CAAC;IACvC,aAAa,GAAG,IAAI,GAAG,EAA6B,CAAC;IACrD,YAAY,GAAG,IAAI,GAAG,EAA0B,CAAC;IACjD,sBAAsB,GAAG,IAAI,GAAG,EAAsB,CAAC;IAEvD,MAAM,CAAC,WAAW,CAAC,IAAe;QACxC,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC7B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IACO,WAAW,CAAC,GAAqB;QACvC,IAAI,GAAG,CAAC,EAAE,EAAE,CAAC;YACX,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACxC,CAAC;aAAM,IAAI,GAAG,CAAC,cAAc,EAAE,CAAC;YAC9B,MAAM,EAAE,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAC/D,IAAI,EAAE;gBACJ,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACtC,CAAC;aAAM,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;YACpB,MAAM,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;YACxE,IAAI,EAAE;gBACJ,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,YAAmC,WAAW,eAAe,CAAC,gBAAgB;QAA3C,aAAQ,GAAR,QAAQ,CAAmC;IAAI,CAAC;IAC5E,KAAK;QACV,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;QAC3B,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,CAAC;IACtC,CAAC;IACD,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;IACjC,CAAC;IACM,eAAe,CAAC,OAAmB;QACxC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE;YAClD,IAAI,SAAS,CAAC,OAAO,CAAC,KAAK,KAAK,OAAO;gBACrC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IACM,MAAM,CAAC,GAAqB;QACjC,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC5C,IAAI,aAAa,EAAE,CAAC;YAClB,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE;gBAC1B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACtD,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,eAAe,CAAC,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;YAClF,IAAI,aAAa,CAAC,OAAO,CAAC,cAAc;gBACtC,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YAC3E,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACM,GAAG,CAAC,GAAqB;QAC9B,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC5C,IAAI,aAAa,EAAE,CAAC;YAClB,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;gBAC7B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBACpD,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;YAClE,CAAC;QACH,CAAC;QAED,IAAI,aAAa,EAAE,CAAC;YAClB,IAAI,GAAG,CAAC,YAAY,KAAK,aAAa,CAAC,WAAW,CAAC,YAAY;gBAC7D,GAAG,CAAC,kBAAkB,KAAK,aAAa,CAAC,WAAW,CAAC,kBAAkB;gBACvE,GAAG,CAAC,cAAc,KAAK,aAAa,CAAC,WAAW,CAAC,cAAc;gBAC/D,GAAG,CAAC,YAAY,KAAK,aAAa,CAAC,WAAW,CAAC,YAAY;gBAC3D,GAAG,CAAC,YAAY,KAAK,aAAa,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC;gBAC9D,OAAO,SAAS,CAAA;YAClB,CAAC;QACH,CAAC;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IACM,GAAG,CAAC,EAAiB;QAC1B,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAE7C,4FAA4F;QAC5F,8CAA8C;QAC9C,IAAI,EAAE,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACzC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC5C,CAAC;QAED,IAAI,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;YAC9B,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC5E,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACnF,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC5C,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAmB,CAAC;YACvE,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACxD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,CAAC,cAAc,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAC3H,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAW,CAAC,MAAM,CAAC,WAAW,CAAC;QAC7B,OAAO,yBAAyB,IAAI,CAAC,IAAI,cAAc,IAAI,CAAC,QAAQ,GAAG,CAAC;IAC1E,CAAC;;AACF,CAAC","sourcesContent":["import { Id64String } from \"@itwin/core-bentley\";\nimport { CodeProps, ElementLoadOptions, ElementLoadProps, ElementProps } from \"@itwin/core-common\";\n\n/* @internal */\nexport interface CachedElement {\n  loadOptions: ElementLoadOptions\n  elProps: ElementProps;\n}\n\n/**\n * A LRU cache for entities. Cache contains the ElementProps and the load options used to load it.\n * Cache can be searched by id, code or federationGuid.\n */\nexport class ElementLRUCache {\n  public static readonly DEFAULT_CAPACITY = 2000;\n  private _elementCache = new Map<Id64String, CachedElement>();\n  private _cacheByCode = new Map<Id64String, Id64String>();\n  private _cacheByFederationGuid = new Map<string, Id64String>();\n\n  private static makeCodeKey(code: CodeProps): string {\n    const keys = [code.scope, code.spec];\n    if (code.value !== undefined) {\n      keys.push(code.value);\n    }\n    return JSON.stringify(keys);\n  }\n  private findElement(key: ElementLoadProps): CachedElement | undefined {\n    if (key.id) {\n      return this._elementCache.get(key.id);\n    } else if (key.federationGuid) {\n      const id = this._cacheByFederationGuid.get(key.federationGuid);\n      if (id)\n        return this._elementCache.get(id);\n    } else if (key.code) {\n      const id = this._cacheByCode.get(ElementLRUCache.makeCodeKey(key.code));\n      if (id)\n        return this._elementCache.get(id);\n    } else {\n      throw new Error(\"No key provided\");\n    }\n    return undefined;\n  }\n  public constructor(public readonly capacity = ElementLRUCache.DEFAULT_CAPACITY) { }\n  public clear(): void {\n    this._elementCache.clear();\n    this._cacheByCode.clear();\n    this._cacheByFederationGuid.clear();\n  }\n  public get size(): number {\n    return this._elementCache.size;\n  }\n  public deleteWithModel(modelId: Id64String): void {\n    this._elementCache.forEach((cachedVal, elementId) => {\n      if (cachedVal.elProps.model === modelId)\n        this.delete({ id: elementId });\n    });\n  }\n  public delete(key: ElementLoadProps): boolean {\n    const cachedElement = this.findElement(key);\n    if (cachedElement) {\n      if (cachedElement.elProps.id)\n        this._elementCache.delete(cachedElement.elProps.id);\n      this._cacheByCode.delete(ElementLRUCache.makeCodeKey(cachedElement.elProps.code));\n      if (cachedElement.elProps.federationGuid)\n        this._cacheByFederationGuid.delete(cachedElement.elProps.federationGuid);\n      return true;\n    }\n    return false;\n  }\n  public get(key: ElementLoadProps): CachedElement | undefined {\n    const cachedElement = this.findElement(key);\n    if (cachedElement) {\n      if (cachedElement.elProps.id) {\n        this._elementCache.delete(cachedElement.elProps.id);\n        this._elementCache.set(cachedElement.elProps.id, cachedElement);\n      }\n    }\n\n    if (cachedElement) {\n      if (key.displayStyle !== cachedElement.loadOptions.displayStyle ||\n        key.onlyBaseProperties !== cachedElement.loadOptions.onlyBaseProperties ||\n        key.renderTimeline !== cachedElement.loadOptions.renderTimeline ||\n        key.wantBRepData !== cachedElement.loadOptions.wantBRepData ||\n        key.wantGeometry !== cachedElement.loadOptions.wantGeometry) {\n        return undefined\n      }\n    }\n    return cachedElement;\n  }\n  public set(el: CachedElement): this {\n    if (!el.elProps.id)\n      throw new Error(\"Element must have an id\");\n\n    // do not cache this element as geom need to be rerender into geom props if any part changes\n    // TODO: find a way to handle caching geometry\n    if (el.loadOptions.wantGeometry) {\n      return this;\n    }\n\n    if (this._elementCache.has(el.elProps.id)) {\n      this._elementCache.delete(el.elProps.id);\n      this._elementCache.set(el.elProps.id, el);\n    } else {\n      this._elementCache.set(el.elProps.id, el);\n    }\n\n    if (el.elProps.federationGuid) {\n      this._cacheByFederationGuid.set(el.elProps.federationGuid, el.elProps.id);\n    }\n\n    this._cacheByCode.set(ElementLRUCache.makeCodeKey(el.elProps.code), el.elProps.id);\n    if (this._elementCache.size > this.capacity) {\n      const oldestKey = this._elementCache.keys().next().value as Id64String;\n      const oldestElement = this._elementCache.get(oldestKey);\n      this.delete({ id: oldestKey, federationGuid: oldestElement?.elProps.federationGuid, code: oldestElement?.elProps.code });\n    }\n    return this;\n  }\n  public get [Symbol.toStringTag](): string {\n    return `EntityCache(this.size=${this.size}, capacity=${this.capacity})`;\n  }\n};\n"]}

package/lib/esm/internal/FontFileImpl.d.ts

@@ -0,0 +1,34 @@
+import { FontFace, FontType, LocalFileName } from "@itwin/core-common";
+import type { IModelJsNative } from "@bentley/imodeljs-native";
+import { CreateFontFileFromRscBlobArgs, CreateFontFileFromShxBlobArgs, FontFile } from "../FontFile";
+import { _faceProps, _getData, _implementationProhibited, _key } from "./Symbols";
+import { IModelDb } from "../IModelDb";
+declare abstract class FontFileImpl implements FontFile {
+    readonly [_implementationProhibited]: undefined;
+    readonly faces: ReadonlyArray<Readonly<FontFace>>;
+    abstract get type(): FontType;
+    get isEmbeddable(): boolean;
+    readonly [_key]: string;
+    readonly [_faceProps]: IModelJsNative.FontFaceProps[];
+    protected constructor(faces: IModelJsNative.FontFaceProps[]);
+    abstract [_getData](): Uint8Array;
+}
+/** Holds the binary representation of a SHX or RSC font in memory. */
+export declare class CadFontFile extends FontFileImpl {
+    #private;
+    constructor(data: Uint8Array, type: FontType.Shx | FontType.Rsc, faces: IModelJsNative.FontFaceProps[]);
+    get type(): FontType;
+    [_getData](): Uint8Array;
+}
+/** Points to a font file in any format embedded in an iModel. */
+export declare class EmbeddedFontFile extends FontFileImpl {
+    #private;
+    constructor(db: IModelDb, id: number, type: FontType, faces: IModelJsNative.FontFaceProps[]);
+    get type(): FontType;
+    [_getData](): Uint8Array;
+}
+export declare function shxFontFileFromBlob(args: CreateFontFileFromShxBlobArgs): FontFile;
+export declare function rscFontFileFromBlob(args: CreateFontFileFromRscBlobArgs): FontFile;
+export declare function trueTypeFontFileFromFileName(fileName: LocalFileName): FontFile;
+export {};
+//# sourceMappingURL=FontFileImpl.d.ts.map

package/lib/esm/internal/FontFileImpl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FontFileImpl.d.ts","sourceRoot":"","sources":["../../../src/internal/FontFileImpl.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,6BAA6B,EAAE,6BAA6B,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACrG,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,yBAAyB,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAGlF,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,uBAAe,YAAa,YAAW,QAAQ;IAC7C,SAAgB,CAAC,yBAAyB,CAAC,YAAa;IAExD,SAAgB,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;IACzD,aAAoB,IAAI,IAAI,QAAQ,CAAC;IACrC,IAAW,YAAY,IAAI,OAAO,CAAiB;IAEnD,SAAgB,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAC/B,SAAgB,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,aAAa,EAAE,CAAC;IAE7D,SAAS,aAAa,KAAK,EAAE,cAAc,CAAC,aAAa,EAAE;aAoB3C,CAAC,QAAQ,CAAC,IAAI,UAAU;CACzC;AAqBD,sEAAsE;AACtE,qBAAa,WAAY,SAAQ,YAAY;;gBAIxB,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,cAAc,CAAC,aAAa,EAAE;IAM7G,IAAoB,IAAI,IAAI,QAAQ,CAAuB;IAE3C,CAAC,QAAQ,CAAC,IAAI,UAAU;CACzC;AAED,iEAAiE;AACjE,qBAAa,gBAAiB,SAAQ,YAAY;;gBAM7B,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,cAAc,CAAC,aAAa,EAAE;IAOlG,IAAoB,IAAI,IAAI,QAAQ,CAAuB;IAE3C,CAAC,QAAQ,CAAC,IAAI,UAAU;CAazC;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,6BAA6B,GAAG,QAAQ,CAmCjF;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,6BAA6B,GAAG,QAAQ,CAejF;AAED,wBAAgB,4BAA4B,CAAC,QAAQ,EAAE,aAAa,GAAG,QAAQ,CAQ9E"}

package/lib/esm/internal/FontFileImpl.js

@@ -0,0 +1,135 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import * as fs from "fs";
+import { FontType } from "@itwin/core-common";
+import { _faceProps, _getData, _implementationProhibited, _key } from "./Symbols";
+import { compareNumbersOrUndefined } from "@itwin/core-bentley";
+import { IModelNative } from "./NativePlatform";
+class FontFileImpl {
+    [_implementationProhibited] = undefined;
+    faces;
+    get isEmbeddable() { return true; }
+    [_key];
+    [_faceProps];
+    constructor(faces) {
+        this.faces = faces.map((face) => {
+            return {
+                familyName: face.familyName,
+                isBold: face.faceName.startsWith("bold"),
+                isItalic: face.faceName.endsWith("italic"),
+            };
+        });
+        this[_faceProps] = faces;
+        // Sort the face props in canonical order so we can compare FontFiles for equivalent contents.
+        this[_faceProps].sort((a, b) => a.familyName.localeCompare(b.familyName) || a.faceName.localeCompare(b.faceName) || compareNumbersOrUndefined(a.subId, b.subId));
+        // Stringify the face props so that the key properties (and no other properties) appear in a canonical order. for trivial comparisons.
+        this[_key] = JSON.stringify(this[_faceProps], ["familyName", "faceName", "type", "subId"]);
+    }
+}
+/** Points to an OpenType font file on disk. */
+class TrueTypeFontFile extends FontFileImpl {
+    #fileName;
+    #embeddable;
+    constructor(fileName, embeddable, faces) {
+        super(faces);
+        this.#fileName = fileName;
+        this.#embeddable = embeddable;
+    }
+    get type() { return FontType.TrueType; }
+    get isEmbeddable() { return this.#embeddable; }
+    [_getData]() {
+        return fs.readFileSync(this.#fileName);
+    }
+}
+/** Holds the binary representation of a SHX or RSC font in memory. */
+export class CadFontFile extends FontFileImpl {
+    #data;
+    #type;
+    constructor(data, type, faces) {
+        super(faces);
+        this.#data = data;
+        this.#type = type;
+    }
+    get type() { return this.#type; }
+    [_getData]() { return this.#data; }
+}
+/** Points to a font file in any format embedded in an iModel. */
+export class EmbeddedFontFile extends FontFileImpl {
+    // The value of the Id column for the row in the be_Prop table that embeds this font's data.
+    #db;
+    #id;
+    #type;
+    constructor(db, id, type, faces) {
+        super(faces);
+        this.#db = db;
+        this.#id = id;
+        this.#type = type;
+    }
+    get type() { return this.#type; }
+    [_getData]() {
+        const data = this.#db.queryFilePropertyBlob({
+            namespace: "dgn_Font",
+            name: "EmbeddedFaceData",
+            id: this.#id,
+        });
+        if (!data) {
+            throw new Error("Embedded font not found");
+        }
+        return data;
+    }
+}
+export function shxFontFileFromBlob(args) {
+    if (args.familyName.length === 0) {
+        throw new Error("Font family name cannot be empty");
+    }
+    // An SHX file with fewer than 40 bytes isn't valid.
+    const minShxSize = 40;
+    const shxHeaders = [
+        "AutoCAD-86 unifont 1.0",
+        "AutoCAD-86 shapes 1.0",
+        "AutoCAD-86 shapes 1.1",
+    ].map((shxHeader) => Array.from(shxHeader))
+        .map((chars) => new Uint8Array(chars.map((ch) => ch.charCodeAt(0))));
+    // See https://github.com/iTwin/imodel-native/blob/91f509c2175dc49ce1efcf5a906c9a9aa193451d/iModelCore/iModelPlatform/DgnCore/ShxFont.cpp#L44
+    function validateShx(blob) {
+        if (blob.length >= minShxSize) {
+            for (const header of shxHeaders) {
+                if (header.every((char, index) => char === blob[index])) {
+                    return;
+                }
+            }
+        }
+        throw new Error("Failed to read font file");
+    }
+    validateShx(args.blob);
+    return new CadFontFile(args.blob, FontType.Shx, [{
+            faceName: "regular",
+            familyName: args.familyName,
+            type: FontType.Shx,
+        }]);
+}
+export function rscFontFileFromBlob(args) {
+    if (args.familyName.length === 0) {
+        throw new Error("Font family name cannot be empty");
+    }
+    if (!IModelNative.platform.isRscFontData(args.blob)) {
+        throw new Error("Failed to read font file");
+    }
+    return new CadFontFile(args.blob, FontType.Rsc, [{
+            faceName: "regular",
+            familyName: args.familyName,
+            type: FontType.Rsc,
+            encoding: args.encoding,
+        }]);
+}
+export function trueTypeFontFileFromFileName(fileName) {
+    const metadata = IModelNative.platform.getTrueTypeFontMetadata(fileName);
+    if (metadata.faces.length === 0) {
+        // The input was almost certainly not a TrueType font file.
+        throw new Error("Failed to read font file");
+    }
+    return new TrueTypeFontFile(fileName, metadata.embeddable, metadata.faces);
+}
+//# sourceMappingURL=FontFileImpl.js.map

package/lib/esm/internal/FontFileImpl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FontFileImpl.js","sourceRoot":"","sources":["../../../src/internal/FontFileImpl.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAY,QAAQ,EAAiB,MAAM,oBAAoB,CAAC;AAGvE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,yBAAyB,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAClF,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAGhD,MAAe,YAAY;IACT,CAAC,yBAAyB,CAAC,GAAG,SAAS,CAAC;IAExC,KAAK,CAAoC;IAEzD,IAAW,YAAY,KAAc,OAAO,IAAI,CAAC,CAAC,CAAC;IAEnC,CAAC,IAAI,CAAC,CAAS;IACf,CAAC,UAAU,CAAC,CAAiC;IAE7D,YAAsB,KAAqC;QACzD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YAC9B,OAAO;gBACL,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;gBACxC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC;aAC3C,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC;QAEzB,8FAA8F;QAC9F,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAC7B,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,yBAAyB,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAChI,CAAC;QAEF,sIAAsI;QACtI,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC7F,CAAC;CAGF;AAED,+CAA+C;AAC/C,MAAM,gBAAiB,SAAQ,YAAY;IAChC,SAAS,CAAgB;IACzB,WAAW,CAAU;IAE9B,YAAmB,QAAuB,EAAE,UAAmB,EAAE,KAAqC;QACpG,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED,IAAoB,IAAI,KAAe,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClE,IAAoB,YAAY,KAAc,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAExD,CAAC,QAAQ,CAAC;QACxB,OAAO,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;CACF;AAED,sEAAsE;AACtE,MAAM,OAAO,WAAY,SAAQ,YAAY;IAClC,KAAK,CAAa;IAClB,KAAK,CAA8B;IAE5C,YAAmB,IAAgB,EAAE,IAAiC,EAAE,KAAqC;QAC3G,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,IAAoB,IAAI,KAAe,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAE3C,CAAC,QAAQ,CAAC,KAAiB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;CAChE;AAED,iEAAiE;AACjE,MAAM,OAAO,gBAAiB,SAAQ,YAAY;IAChD,4FAA4F;IACnF,GAAG,CAAW;IACd,GAAG,CAAS;IACZ,KAAK,CAAW;IAEzB,YAAmB,EAAY,EAAE,EAAU,EAAE,IAAc,EAAE,KAAqC;QAChG,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,IAAoB,IAAI,KAAe,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAE3C,CAAC,QAAQ,CAAC;QACxB,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,qBAAqB,CAAC;YAC1C,SAAS,EAAE,UAAU;YACrB,IAAI,EAAE,kBAAkB;YACxB,EAAE,EAAE,IAAI,CAAC,GAAG;SACb,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,MAAM,UAAU,mBAAmB,CAAC,IAAmC;IACrE,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;IACtD,CAAC;IAEH,oDAAoD;IAClD,MAAM,UAAU,GAAG,EAAE,CAAC;IAEtB,MAAM,UAAU,GAAG;QACjB,wBAAwB;QACxB,uBAAuB;QACvB,uBAAuB;KACxB,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SAC1C,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAErE,6IAA6I;IAC7I,SAAS,WAAW,CAAC,IAAgB;QACnC,IAAI,IAAI,CAAC,MAAM,IAAI,UAAU,EAAE,CAAC;YAC9B,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE,CAAC;gBAChC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;oBACxD,OAAO;gBACT,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IAED,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEvB,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,EAAE,CAAC;YAC/C,QAAQ,EAAE,SAAS;YACnB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,IAAI,EAAE,QAAQ,CAAC,GAAG;SACnB,CAAC,CAAC,CAAC;AACN,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,IAAmC;IACrE,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;IACtD,CAAC;IAED,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACpD,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IAED,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,EAAE,CAAC;YAC/C,QAAQ,EAAE,SAAS;YACnB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,IAAI,EAAE,QAAQ,CAAC,GAAG;YAClB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC,CAAC,CAAC;AACN,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,QAAuB;IAClE,MAAM,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IACzE,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChC,2DAA2D;QAC3D,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IAED,OAAO,IAAI,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC7E,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nimport * as fs from \"fs\";\nimport { FontFace, FontType, LocalFileName } from \"@itwin/core-common\";\nimport type { IModelJsNative } from \"@bentley/imodeljs-native\";\nimport { CreateFontFileFromRscBlobArgs, CreateFontFileFromShxBlobArgs, FontFile } from \"../FontFile\";\nimport { _faceProps, _getData, _implementationProhibited, _key } from \"./Symbols\";\nimport { compareNumbersOrUndefined } from \"@itwin/core-bentley\";\nimport { IModelNative } from \"./NativePlatform\"; \nimport { IModelDb } from \"../IModelDb\";\n\nabstract class FontFileImpl implements FontFile {\n  public readonly [_implementationProhibited] = undefined;\n\n  public readonly faces: ReadonlyArray<Readonly<FontFace>>;\n  public abstract get type(): FontType;\n  public get isEmbeddable(): boolean { return true; }\n\n  public readonly [_key]: string;\n  public readonly [_faceProps]: IModelJsNative.FontFaceProps[];\n\n  protected constructor(faces: IModelJsNative.FontFaceProps[]) {\n    this.faces = faces.map((face) => {\n      return {\n        familyName: face.familyName,\n        isBold: face.faceName.startsWith(\"bold\"),\n        isItalic: face.faceName.endsWith(\"italic\"),\n      };\n    });\n\n    this[_faceProps] = faces;\n\n    // Sort the face props in canonical order so we can compare FontFiles for equivalent contents.\n    this[_faceProps].sort((a, b) =>\n      a.familyName.localeCompare(b.familyName) || a.faceName.localeCompare(b.faceName) || compareNumbersOrUndefined(a.subId, b.subId)\n    );\n\n    // Stringify the face props so that the key properties (and no other properties) appear in a canonical order. for trivial comparisons.\n    this[_key] = JSON.stringify(this[_faceProps], [\"familyName\", \"faceName\", \"type\", \"subId\"]);\n  }\n\n  public abstract [_getData](): Uint8Array;\n}\n\n/** Points to an OpenType font file on disk. */\nclass TrueTypeFontFile extends FontFileImpl {\n  readonly #fileName: LocalFileName;\n  readonly #embeddable: boolean;\n  \n  public constructor(fileName: LocalFileName, embeddable: boolean, faces: IModelJsNative.FontFaceProps[]) {\n    super(faces);\n    this.#fileName = fileName;\n    this.#embeddable = embeddable;\n  }\n\n  public override get type(): FontType { return FontType.TrueType; }\n  public override get isEmbeddable(): boolean { return this.#embeddable; }\n\n  public override [_getData](): Uint8Array {\n    return fs.readFileSync(this.#fileName);\n  }\n}\n\n/** Holds the binary representation of a SHX or RSC font in memory. */\nexport class CadFontFile extends FontFileImpl {\n  readonly #data: Uint8Array;\n  readonly #type: FontType.Shx | FontType.Rsc;\n\n  public constructor(data: Uint8Array, type: FontType.Shx | FontType.Rsc, faces: IModelJsNative.FontFaceProps[]) {\n    super(faces);\n    this.#data = data;\n    this.#type = type;\n  }\n\n  public override get type(): FontType { return this.#type; }\n\n  public override [_getData](): Uint8Array { return this.#data; }\n}\n\n/** Points to a font file in any format embedded in an iModel. */\nexport class EmbeddedFontFile extends FontFileImpl {\n  // The value of the Id column for the row in the be_Prop table that embeds this font's data.\n  readonly #db: IModelDb;\n  readonly #id: number;\n  readonly #type: FontType;\n\n  public constructor(db: IModelDb, id: number, type: FontType, faces: IModelJsNative.FontFaceProps[]) {\n    super(faces);\n    this.#db = db;\n    this.#id = id;\n    this.#type = type;\n  }\n\n  public override get type(): FontType { return this.#type; }\n\n  public override [_getData](): Uint8Array {\n    const data = this.#db.queryFilePropertyBlob({\n      namespace: \"dgn_Font\",\n      name: \"EmbeddedFaceData\",\n      id: this.#id,\n    });\n\n    if (!data) {\n      throw new Error(\"Embedded font not found\");\n    }\n\n    return data;\n  }\n}\n\nexport function shxFontFileFromBlob(args: CreateFontFileFromShxBlobArgs): FontFile {\n  if (args.familyName.length === 0) {\n    throw new Error(\"Font family name cannot be empty\");\n  }\n\n// An SHX file with fewer than 40 bytes isn't valid.\n  const minShxSize = 40;\n\n  const shxHeaders = [\n    \"AutoCAD-86 unifont 1.0\",\n    \"AutoCAD-86 shapes 1.0\",\n    \"AutoCAD-86 shapes 1.1\",\n  ].map((shxHeader) => Array.from(shxHeader))\n  .map((chars) => new Uint8Array(chars.map((ch) => ch.charCodeAt(0))));\n\n  // See https://github.com/iTwin/imodel-native/blob/91f509c2175dc49ce1efcf5a906c9a9aa193451d/iModelCore/iModelPlatform/DgnCore/ShxFont.cpp#L44\n  function validateShx(blob: Uint8Array): void {\n    if (blob.length >= minShxSize) {\n      for (const header of shxHeaders) {\n        if (header.every((char, index) => char === blob[index])) {\n          return;\n        }\n      }\n    }\n\n    throw new Error(\"Failed to read font file\");\n  }\n\n  validateShx(args.blob);\n\n  return new CadFontFile(args.blob, FontType.Shx, [{\n    faceName: \"regular\",\n    familyName: args.familyName,\n    type: FontType.Shx,\n  }]);\n}\n\nexport function rscFontFileFromBlob(args: CreateFontFileFromRscBlobArgs): FontFile {\n  if (args.familyName.length === 0) {\n    throw new Error(\"Font family name cannot be empty\");\n  }\n\n  if (!IModelNative.platform.isRscFontData(args.blob)) {\n    throw new Error(\"Failed to read font file\");\n  }\n\n  return new CadFontFile(args.blob, FontType.Rsc, [{\n    faceName: \"regular\",\n    familyName: args.familyName,\n    type: FontType.Rsc,\n    encoding: args.encoding,\n  }]);\n}\n\nexport function trueTypeFontFileFromFileName(fileName: LocalFileName): FontFile {\n  const metadata = IModelNative.platform.getTrueTypeFontMetadata(fileName);\n  if (metadata.faces.length === 0) {\n    // The input was almost certainly not a TrueType font file.\n    throw new Error(\"Failed to read font file\");\n  }\n\n  return new TrueTypeFontFile(fileName, metadata.embeddable, metadata.faces);\n}\n\n"]}