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

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":["/*---------------------------------------------------------------------------------------------\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 iModels\r\n */\r\n\r\nimport { DbChangeStage, DbConflictCause, DbOpcode, DbValueType, Id64String } from \"@itwin/core-bentley\";\r\nimport { SqliteChangeOp, SqliteChangesetReader, SqliteValueStage } from \"../SqliteChangesetReader\";\r\nimport { IModelDb } from \"../IModelDb\";\r\n\r\nexport interface DbChangesetConflictArgs {\r\n  cause: DbConflictCause;\r\n  opcode: DbOpcode;\r\n  indirect: boolean;\r\n  tableName: string;\r\n  columnCount: number;\r\n  getForeignKeyConflicts: () => number;\r\n  dump: () => void;\r\n  setLastError: (message: string) => void;\r\n  getPrimaryKeyColumns: () => number[];\r\n  getValueType: (columnIndex: number, stage: DbChangeStage) => DbValueType | null | undefined;\r\n  getValueBinary: (columnIndex: number, stage: DbChangeStage) => Uint8Array | null | undefined;\r\n  getValueId: (columnIndex: number, stage: DbChangeStage) => Id64String | null | undefined;\r\n  getValueText: (columnIndex: number, stage: DbChangeStage) => string | null | undefined;\r\n  getValueInteger: (columnIndex: number, stage: DbChangeStage) => number | null | undefined;\r\n  getValueDouble: (columnIndex: number, stage: DbChangeStage) => number | null | undefined;\r\n  isValueNull: (columnIndex: number, stage: DbChangeStage) => boolean | undefined;\r\n  getColumnNames(): string[];\r\n}\r\n\r\nexport interface DbMergeChangesetConflictArgs extends DbChangesetConflictArgs {\r\n  changesetFile?: string;\r\n}\r\n\r\nexport interface TxnArgs {\r\n  id: Id64String;\r\n  type: \"Data\" | \"Schema\";\r\n  descr: string;\r\n}\r\n\r\nexport interface DbRebaseChangesetConflictArgs extends DbChangesetConflictArgs {\r\n  txn: TxnArgs;\r\n}\r\n\r\nexport type SqliteConflictCause = \"Conflict\" | \"Data\" | \"Constraint\" | \"ForeignKey\" | \"NotFound\";\r\n\r\nexport class RebaseChangesetConflictArgs {\r\n  constructor(private _dbConflictArg: DbRebaseChangesetConflictArgs, private _iModel: IModelDb){}\r\n  public get cause() : SqliteConflictCause {\r\n    switch (this._dbConflictArg.cause) {\r\n      case DbConflictCause.Conflict: return \"Conflict\";\r\n      case DbConflictCause.Data: return \"Data\";\r\n      case DbConflictCause.Constraint: return \"Constraint\";\r\n      case DbConflictCause.ForeignKey: return \"ForeignKey\";\r\n      case DbConflictCause.NotFound: return \"NotFound\";\r\n    }\r\n    throw new Error(\"Invalid value for cause\");\r\n  }\r\n  public get opcode(): SqliteChangeOp | undefined {\r\n    switch (this._dbConflictArg.opcode) {\r\n      case DbOpcode.Insert: return \"Inserted\";\r\n      case DbOpcode.Update: return \"Updated\";\r\n      case DbOpcode.Delete: return \"Deleted\";\r\n    }\r\n  }\r\n  public openTxn(): SqliteChangesetReader {\r\n    return SqliteChangesetReader.openTxn({txnId: this._dbConflictArg.txn.id, db: this._iModel});\r\n  }\r\n  public get indirect(): boolean {\r\n    return this._dbConflictArg.indirect;\r\n  }\r\n  public get tableName(): string {\r\n    return this._dbConflictArg.tableName;\r\n  }\r\n  public get columnCount(): number {\r\n    return this._dbConflictArg.columnCount;\r\n  }\r\n  public getForeignKeyConflicts(): number {\r\n    return this._dbConflictArg.getForeignKeyConflicts();\r\n  }\r\n  public setLastError(message: string): void {\r\n    this._dbConflictArg.setLastError(message);\r\n  }\r\n  public getPrimaryKeyColumns(): number[] {\r\n    return this._dbConflictArg.getPrimaryKeyColumns();\r\n  }\r\n  public getValueType(columnIndex: number, stage: SqliteValueStage): DbValueType | null | undefined {\r\n    return this._dbConflictArg.getValueType(columnIndex, stage=== \"New\" ? DbChangeStage.New : DbChangeStage.Old);\r\n  }\r\n  public getValueBinary(columnIndex: number, stage: SqliteValueStage): Uint8Array | null | undefined {\r\n    return this._dbConflictArg.getValueBinary(columnIndex, stage=== \"New\" ? DbChangeStage.New : DbChangeStage.Old);\r\n  }\r\n  public getValueId(columnIndex: number, stage: SqliteValueStage): Id64String | null | undefined {\r\n    return this._dbConflictArg.getValueId(columnIndex, stage=== \"New\" ? DbChangeStage.New : DbChangeStage.Old);\r\n  }\r\n  public getValueText(columnIndex: number, stage: SqliteValueStage): string | null | undefined {\r\n    return this._dbConflictArg.getValueText(columnIndex, stage=== \"New\" ? DbChangeStage.New : DbChangeStage.Old);\r\n  }\r\n  public getValueInteger(columnIndex: number, stage: SqliteValueStage): number | null | undefined {\r\n    return this._dbConflictArg.getValueInteger(columnIndex, stage=== \"New\" ? DbChangeStage.New : DbChangeStage.Old);\r\n  }\r\n  public getValueDouble(columnIndex: number, stage: SqliteValueStage): number | null | undefined {\r\n    return this._dbConflictArg.getValueDouble(columnIndex, stage=== \"New\" ? DbChangeStage.New : DbChangeStage.Old);\r\n  }\r\n  public isValueNull(columnIndex: number, stage: SqliteValueStage): boolean | undefined {\r\n    return this._dbConflictArg.isValueNull(columnIndex, stage=== \"New\" ? DbChangeStage.New : DbChangeStage.Old);\r\n  }\r\n  public getColumnNames(): string[] {\r\n    return this._dbConflictArg.getColumnNames();\r\n  }\r\n  public getPrimaryKeyValues() {\r\n    const pkv: (Uint8Array | number | string | null | undefined)[] = [];\r\n    if (this.opcode === undefined)\r\n      return pkv;\r\n\r\n    const stage = this._dbConflictArg.opcode === DbOpcode.Insert ? DbChangeStage.New : DbChangeStage.Old;\r\n    for (const pk of this._dbConflictArg.getPrimaryKeyColumns()) {\r\n      const type = this._dbConflictArg.getValueType(pk, stage);\r\n      if (type === DbValueType.IntegerVal)\r\n        pkv.push(this._dbConflictArg.getValueId(pk, stage));\r\n      else if (type === DbValueType.TextVal)\r\n        pkv.push(this._dbConflictArg.getValueText(pk, stage));\r\n      else if (type === DbValueType.FloatVal)\r\n        pkv.push(this._dbConflictArg.getValueDouble(pk, stage));\r\n      else if (type === DbValueType.BlobVal)\r\n        pkv.push(this._dbConflictArg.getValueBinary(pk, stage));\r\n      else\r\n        pkv.push(null);\r\n    }\r\n    return pkv;\r\n  };\r\n  public get txn() {\r\n    return this._dbConflictArg.txn;\r\n  }\r\n}\r\n\r\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":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Elements\r\n */\r\n\r\nimport { DbResult, Id64String, IModelStatus } from \"@itwin/core-bentley\";\r\nimport { ChannelControlError, ChannelRootAspectProps, IModel, IModelError } from \"@itwin/core-common\";\r\nimport { ChannelControl, ChannelKey } from \"../ChannelControl\";\r\nimport { Subject } from \"../Element\";\r\nimport { IModelDb } from \"../IModelDb\";\r\nimport { IModelHost } from \"../IModelHost\";\r\nimport { _implementationProhibited, _nativeDb, _verifyChannel } from \"./Symbols\";\r\n\r\nclass ChannelAdmin implements ChannelControl {\r\n  public static readonly channelClassName = \"bis:ChannelRootAspect\";\r\n\r\n  public readonly [_implementationProhibited] = undefined;\r\n  private _allowedChannels = new Set<ChannelKey>();\r\n  private _allowedModels = new Set<Id64String>();\r\n  private _deniedModels = new Map<Id64String, ChannelKey>();\r\n\r\n  public constructor(private _iModel: IModelDb) {\r\n    // for backwards compatibility, allow the shared channel unless explicitly turned off in IModelHostOptions.\r\n    if (IModelHost.configuration?.allowSharedChannel !== false)\r\n      this._allowedChannels.add(ChannelControl.sharedChannelName);\r\n  }\r\n\r\n  public addAllowedChannel(channelKey: ChannelKey) {\r\n    this._allowedChannels.add(channelKey);\r\n    this._deniedModels.clear();\r\n  }\r\n\r\n  public removeAllowedChannel(channelKey: ChannelKey) {\r\n    this._allowedChannels.delete(channelKey);\r\n    this._allowedModels.clear();\r\n  }\r\n\r\n  public getChannelKey(elementId: Id64String): ChannelKey {\r\n    if (elementId === IModel.rootSubjectId)\r\n      return ChannelControl.sharedChannelName;\r\n\r\n    try {\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n      const channel = this._iModel.withPreparedStatement(`SELECT Owner FROM ${ChannelAdmin.channelClassName} WHERE Element.Id=?`, (stmt) => {\r\n        stmt.bindId(1, elementId);\r\n        return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValue(0).getString() : undefined;\r\n      });\r\n\r\n      if (channel !== undefined)\r\n        return channel;\r\n    } catch {\r\n      // Exception happens if the iModel is too old: ChannelRootAspect class not present in the BisCore schema (older than v1.0.10).\r\n      // In that case all data in such iModel is assumed to be in the shared channel.\r\n      return ChannelControl.sharedChannelName;\r\n    }\r\n\r\n    const parentId = this._iModel.withPreparedSqliteStatement(\"SELECT ParentId,ModelId FROM bis_Element WHERE id=?\", (stmt) => {\r\n      stmt.bindId(1, elementId);\r\n      if (DbResult.BE_SQLITE_ROW !== stmt.step())\r\n        throw new IModelError(IModelStatus.NotFound, \"Element does not exist\");\r\n      return stmt.getValueId(0) ?? stmt.getValueId(1); // if parent is undefined, use modelId\r\n    });\r\n\r\n    return this.getChannelKey(parentId);\r\n  }\r\n\r\n  public [_verifyChannel](modelId: Id64String): void {\r\n    // Note: indirect changes are permitted to change any channel\r\n    if (this._allowedModels.has(modelId) || this._iModel[_nativeDb].isIndirectChanges())\r\n      return;\r\n\r\n    const deniedChannel = this._deniedModels.get(modelId);\r\n    if (undefined !== deniedChannel)\r\n      ChannelControlError.throwError(\"not-allowed\", `Channel ${deniedChannel} is not allowed`, deniedChannel);\r\n\r\n    const channel = this.getChannelKey(modelId);\r\n    if (this._allowedChannels.has(channel)) {\r\n      this._allowedModels.add(modelId);\r\n      return;\r\n    }\r\n\r\n    this._deniedModels.set(modelId, channel);\r\n    return this[_verifyChannel](modelId);\r\n  }\r\n\r\n  public makeChannelRoot(args: { elementId: Id64String, channelKey: ChannelKey }) {\r\n    const channelKey = this.getChannelKey(args.elementId);\r\n    if (ChannelControl.sharedChannelName !== channelKey)\r\n      ChannelControlError.throwError(\"may-not-nest\", `Channel ${channelKey} may not nest`, channelKey);\r\n\r\n    if (this.queryChannelRoot(args.channelKey) !== undefined)\r\n      ChannelControlError.throwError(\"root-exists\", `Channel ${args.channelKey} root already exist`, channelKey);\r\n\r\n    const props: ChannelRootAspectProps = { classFullName: ChannelAdmin.channelClassName, element: { id: args.elementId }, owner: args.channelKey };\r\n    this._iModel.elements.insertAspect(props);\r\n  }\r\n\r\n  public insertChannelSubject(args: { subjectName: string, channelKey: ChannelKey, parentSubjectId?: Id64String, description?: string }): Id64String {\r\n    // Check if channelKey already exists before inserting Subject.\r\n    // makeChannelRoot will check that again, but at that point the new Subject is already inserted.\r\n    // Prefer to check twice instead of deleting the Subject in the latter option.\r\n    if (this.queryChannelRoot(args.channelKey) !== undefined)\r\n      ChannelControlError.throwError(\"root-exists\", `Channel ${args.channelKey} root already exist`, args.channelKey);\r\n\r\n    const elementId = Subject.insert(this._iModel, args.parentSubjectId ?? IModel.rootSubjectId, args.subjectName, args.description);\r\n    this.makeChannelRoot({ elementId, channelKey: args.channelKey });\r\n    return elementId;\r\n  }\r\n\r\n  public queryChannelRoot(channelKey: ChannelKey): Id64String | undefined {\r\n    if (channelKey === ChannelControl.sharedChannelName)\r\n      // RootSubject acts as the ChannelRoot element of the shared channel\r\n      return IModel.rootSubjectId;\r\n\r\n    try {\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n      const channelRoot = this._iModel.withPreparedStatement(`SELECT Element.Id FROM ${ChannelAdmin.channelClassName} WHERE Owner=?`, (stmt) => {\r\n        stmt.bindString(1, channelKey);\r\n        return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValue(0).getId() : undefined;\r\n      });\r\n\r\n      return channelRoot;\r\n    } catch {\r\n      // Exception happens if the iModel is too old: ChannelRootAspect class not present in the BisCore schema (older than v1.0.10).\r\n      // In that case all data in such iModel is assumed to be in the shared channel.\r\n      return undefined;\r\n    }\r\n\r\n  }\r\n}\r\n\r\nexport function createChannelControl(iModel: IModelDb): ChannelAdmin {\r\n  return new ChannelAdmin(iModel);\r\n}\r\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":["/*---------------------------------------------------------------------------------------------\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 * as fs from \"fs\";\r\nimport { FontFace, FontType, LocalFileName } from \"@itwin/core-common\";\r\nimport type { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { CreateFontFileFromRscBlobArgs, CreateFontFileFromShxBlobArgs, FontFile } from \"../FontFile\";\r\nimport { _faceProps, _getData, _implementationProhibited, _key } from \"./Symbols\";\r\nimport { compareNumbersOrUndefined } from \"@itwin/core-bentley\";\r\nimport { IModelNative } from \"./NativePlatform\"; \r\nimport { IModelDb } from \"../IModelDb\";\r\n\r\nabstract class FontFileImpl implements FontFile {\r\n  public readonly [_implementationProhibited] = undefined;\r\n\r\n  public readonly faces: ReadonlyArray<Readonly<FontFace>>;\r\n  public abstract get type(): FontType;\r\n  public get isEmbeddable(): boolean { return true; }\r\n\r\n  public readonly [_key]: string;\r\n  public readonly [_faceProps]: IModelJsNative.FontFaceProps[];\r\n\r\n  protected constructor(faces: IModelJsNative.FontFaceProps[]) {\r\n    this.faces = faces.map((face) => {\r\n      return {\r\n        familyName: face.familyName,\r\n        isBold: face.faceName.startsWith(\"bold\"),\r\n        isItalic: face.faceName.endsWith(\"italic\"),\r\n      };\r\n    });\r\n\r\n    this[_faceProps] = faces;\r\n\r\n    // Sort the face props in canonical order so we can compare FontFiles for equivalent contents.\r\n    this[_faceProps].sort((a, b) =>\r\n      a.familyName.localeCompare(b.familyName) || a.faceName.localeCompare(b.faceName) || compareNumbersOrUndefined(a.subId, b.subId)\r\n    );\r\n\r\n    // Stringify the face props so that the key properties (and no other properties) appear in a canonical order. for trivial comparisons.\r\n    this[_key] = JSON.stringify(this[_faceProps], [\"familyName\", \"faceName\", \"type\", \"subId\"]);\r\n  }\r\n\r\n  public abstract [_getData](): Uint8Array;\r\n}\r\n\r\n/** Points to an OpenType font file on disk. */\r\nclass TrueTypeFontFile extends FontFileImpl {\r\n  readonly #fileName: LocalFileName;\r\n  readonly #embeddable: boolean;\r\n  \r\n  public constructor(fileName: LocalFileName, embeddable: boolean, faces: IModelJsNative.FontFaceProps[]) {\r\n    super(faces);\r\n    this.#fileName = fileName;\r\n    this.#embeddable = embeddable;\r\n  }\r\n\r\n  public override get type(): FontType { return FontType.TrueType; }\r\n  public override get isEmbeddable(): boolean { return this.#embeddable; }\r\n\r\n  public override [_getData](): Uint8Array {\r\n    return fs.readFileSync(this.#fileName);\r\n  }\r\n}\r\n\r\n/** Holds the binary representation of a SHX or RSC font in memory. */\r\nexport class CadFontFile extends FontFileImpl {\r\n  readonly #data: Uint8Array;\r\n  readonly #type: FontType.Shx | FontType.Rsc;\r\n\r\n  public constructor(data: Uint8Array, type: FontType.Shx | FontType.Rsc, faces: IModelJsNative.FontFaceProps[]) {\r\n    super(faces);\r\n    this.#data = data;\r\n    this.#type = type;\r\n  }\r\n\r\n  public override get type(): FontType { return this.#type; }\r\n\r\n  public override [_getData](): Uint8Array { return this.#data; }\r\n}\r\n\r\n/** Points to a font file in any format embedded in an iModel. */\r\nexport class EmbeddedFontFile extends FontFileImpl {\r\n  // The value of the Id column for the row in the be_Prop table that embeds this font's data.\r\n  readonly #db: IModelDb;\r\n  readonly #id: number;\r\n  readonly #type: FontType;\r\n\r\n  public constructor(db: IModelDb, id: number, type: FontType, faces: IModelJsNative.FontFaceProps[]) {\r\n    super(faces);\r\n    this.#db = db;\r\n    this.#id = id;\r\n    this.#type = type;\r\n  }\r\n\r\n  public override get type(): FontType { return this.#type; }\r\n\r\n  public override [_getData](): Uint8Array {\r\n    const data = this.#db.queryFilePropertyBlob({\r\n      namespace: \"dgn_Font\",\r\n      name: \"EmbeddedFaceData\",\r\n      id: this.#id,\r\n    });\r\n\r\n    if (!data) {\r\n      throw new Error(\"Embedded font not found\");\r\n    }\r\n\r\n    return data;\r\n  }\r\n}\r\n\r\nexport function shxFontFileFromBlob(args: CreateFontFileFromShxBlobArgs): FontFile {\r\n  if (args.familyName.length === 0) {\r\n    throw new Error(\"Font family name cannot be empty\");\r\n  }\r\n\r\n// An SHX file with fewer than 40 bytes isn't valid.\r\n  const minShxSize = 40;\r\n\r\n  const shxHeaders = [\r\n    \"AutoCAD-86 unifont 1.0\",\r\n    \"AutoCAD-86 shapes 1.0\",\r\n    \"AutoCAD-86 shapes 1.1\",\r\n  ].map((shxHeader) => Array.from(shxHeader))\r\n  .map((chars) => new Uint8Array(chars.map((ch) => ch.charCodeAt(0))));\r\n\r\n  // See https://github.com/iTwin/imodel-native/blob/91f509c2175dc49ce1efcf5a906c9a9aa193451d/iModelCore/iModelPlatform/DgnCore/ShxFont.cpp#L44\r\n  function validateShx(blob: Uint8Array): void {\r\n    if (blob.length >= minShxSize) {\r\n      for (const header of shxHeaders) {\r\n        if (header.every((char, index) => char === blob[index])) {\r\n          return;\r\n        }\r\n      }\r\n    }\r\n\r\n    throw new Error(\"Failed to read font file\");\r\n  }\r\n\r\n  validateShx(args.blob);\r\n\r\n  return new CadFontFile(args.blob, FontType.Shx, [{\r\n    faceName: \"regular\",\r\n    familyName: args.familyName,\r\n    type: FontType.Shx,\r\n  }]);\r\n}\r\n\r\nexport function rscFontFileFromBlob(args: CreateFontFileFromRscBlobArgs): FontFile {\r\n  if (args.familyName.length === 0) {\r\n    throw new Error(\"Font family name cannot be empty\");\r\n  }\r\n\r\n  if (!IModelNative.platform.isRscFontData(args.blob)) {\r\n    throw new Error(\"Failed to read font file\");\r\n  }\r\n\r\n  return new CadFontFile(args.blob, FontType.Rsc, [{\r\n    faceName: \"regular\",\r\n    familyName: args.familyName,\r\n    type: FontType.Rsc,\r\n    encoding: args.encoding,\r\n  }]);\r\n}\r\n\r\nexport function trueTypeFontFileFromFileName(fileName: LocalFileName): FontFile {\r\n  const metadata = IModelNative.platform.getTrueTypeFontMetadata(fileName);\r\n  if (metadata.faces.length === 0) {\r\n    // The input was almost certainly not a TrueType font file.\r\n    throw new Error(\"Failed to read font file\");\r\n  }\r\n\r\n  return new TrueTypeFontFile(fileName, metadata.embeddable, metadata.faces);\r\n}\r\n\r\n"]}

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

@@ -0,0 +1,94 @@
+import { GuidString } from "@itwin/core-bentley";
+import { ChangesetFileProps, ChangesetIndex, ChangesetProps, ChangesetRange, IModelVersion, LocalDirName } from "@itwin/core-common";
+import { AcquireNewBriefcaseIdArg, BriefcaseDbArg, BriefcaseIdArg, ChangesetArg, CreateNewIModelProps, DownloadChangesetArg, DownloadChangesetRangeArg, IModelIdArg, IModelNameArg, LockMap, LockProps, V2CheckpointAccessProps } from "../BackendHubAccess";
+import { CheckpointProps } from "../CheckpointManager";
+import { LocalHub } from "../LocalHub";
+/**
+ * Mocks iModelHub for testing creating Briefcases, downloading checkpoints, and simulating multiple users pushing and pulling changesets, etc.
+ *
+ * Generally, tests for apis that *create or modify* iModels can and should be mocked. Otherwise they:
+ * - create tremendous load on the test servers when they run on programmer's desktops and in CI jobs
+ * - waste network and data center resources (i.e. $$$s),
+ * - interfere with other tests running on the same or other systems, and
+ * - (far worse) are the source of test flakiness outside of the api being tested.
+ *
+ * This class can be used to create tests that do not require authentication, are synchronous,
+ * are guaranteed to be self-contained (i.e. do not interfere with other tests running at the same time or later), and do not fail for reasons outside
+ * of the control of the test itself. As a bonus, in addition to making tests more reliable, mocking IModelHub generally makes tests run *much* faster.
+ *
+ * On the other hand, tests that expect to find an existing iModels, checkpoints, changesets, etc. in IModelHub cannot be mocked. In that case, those tests
+ * should be careful to NOT modify the data, since doing so causes interference with other tests running simultaneously. These tests should be limited to
+ * low level testing of the core apis only.
+ *
+ * To initialize HubMock, call [[startup]] at the beginning of your test, usually in `describe.before`. Thereafter, all access to iModelHub for an iModel will be
+ * directed to a [[LocalHub]] - your test code does not change. After the test(s) complete, call [[shutdown]] (usually in `describe.after`) to stop mocking IModelHub and clean
+ * up any resources used by the test(s). If you want to mock a single test, call [[startup]] as the first line and [[shutdown]] as the last. If you wish to run the
+ * test against a "real" IModelHub, you can simply comment off the call [[startup]], though in that case you should make sure the name of your
+ * iModel is unique so your test won't collide with other tests (iModel name uniqueness is not necessary for mocked tests.)
+ *
+ * Mocked tests must always start by creating a new iModel via [[IModelHost[_hubAccess].createNewIModel]] with a `version0` iModel.
+ * They use mock (aka "bogus") credentials for `AccessTokens`, which is fine since [[HubMock]] never accesses resources outside the current
+ * computer.
+ *
+ * @note Only one HubMock at a time, *running in a single process*, may be active. The comments above about multiple simultaneous tests refer to tests
+ * running on different computers, or on a single computer in multiple processes. All of those scenarios are problematic without mocking.
+ *
+ * @internal
+ */
+export declare class HubMock {
+    private static mockRoot;
+    private static hubs;
+    private static _saveHubAccess;
+    private static _iTwinId;
+    /** Determine whether a test us currently being run under HubMock */
+    static get isValid(): boolean;
+    static get iTwinId(): string;
+    /**
+     * Begin mocking IModelHub access. After this call, all access to IModelHub will be directed to a [[LocalHub]].
+     * @param mockName a unique name (e.g. "MyTest") for this HubMock to disambiguate tests when more than one is simultaneously active.
+     * It is used to create a private directory used by the HubMock for a test. That directory is removed when [[shutdown]] is called.
+     */
+    static startup(mockName: LocalDirName, outputDir: string): void;
+    /** Stop a HubMock that was previously started with [[startup]]
+     * @note this function throws an exception if any of the iModels used during the tests are left open.
+     */
+    static shutdown(): void;
+    static findLocalHub(iModelId: GuidString): LocalHub;
+    /** create a [[LocalHub]] for an iModel.  */
+    static createNewIModel(arg: CreateNewIModelProps): Promise<GuidString>;
+    /** remove the [[LocalHub]] for an iModel */
+    static destroy(iModelId: GuidString): void;
+    /** All methods below are mocks of the [[BackendHubAccess]] interface */
+    static getChangesetFromNamedVersion(arg: IModelIdArg & {
+        versionName: string;
+    }): Promise<ChangesetProps>;
+    private static changesetIndexFromArg;
+    static getChangesetFromVersion(arg: IModelIdArg & {
+        version: IModelVersion;
+    }): Promise<ChangesetProps>;
+    static getLatestChangeset(arg: IModelIdArg): Promise<ChangesetProps>;
+    private static getAccessToken;
+    static getMyBriefcaseIds(arg: IModelIdArg): Promise<number[]>;
+    static acquireNewBriefcaseId(arg: AcquireNewBriefcaseIdArg): Promise<number>;
+    /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */
+    static releaseBriefcase(arg: BriefcaseIdArg): Promise<void>;
+    static downloadChangeset(arg: DownloadChangesetArg): Promise<ChangesetFileProps>;
+    static downloadChangesets(arg: DownloadChangesetRangeArg): Promise<ChangesetFileProps[]>;
+    static queryChangeset(arg: ChangesetArg): Promise<ChangesetProps>;
+    static queryChangesets(arg: IModelIdArg & {
+        range?: ChangesetRange;
+    }): Promise<ChangesetProps[]>;
+    static pushChangeset(arg: IModelIdArg & {
+        changesetProps: ChangesetFileProps;
+    }): Promise<ChangesetIndex>;
+    static queryV2Checkpoint(arg: CheckpointProps): Promise<V2CheckpointAccessProps | undefined>;
+    static releaseAllLocks(arg: BriefcaseDbArg): Promise<void>;
+    static queryAllLocks(_arg: BriefcaseDbArg): Promise<LockProps[]>;
+    static acquireLocks(arg: BriefcaseDbArg, locks: LockMap): Promise<void>;
+    static queryIModelByName(arg: IModelNameArg): Promise<GuidString | undefined>;
+    static deleteIModel(arg: IModelIdArg & {
+        iTwinId: GuidString;
+    }): Promise<void>;
+    private static mockProgressReporting;
+}
+//# sourceMappingURL=HubMock.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"HubMock.d.ts","sourceRoot":"","sources":["../../../src/internal/HubMock.ts"],"names":[],"mappings":"AAMA,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EACL,kBAAkB,EAAE,cAAc,EAAsB,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EACpH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,wBAAwB,EACN,cAAc,EAAE,cAAc,EAAE,YAAY,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,WAAW,EAAE,aAAa,EACjK,OAAO,EAAE,SAAS,EAAE,uBAAuB,EAC5C,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,eAAe,EAA0F,MAAM,sBAAsB,CAAC;AAG/I,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AA0BvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA2B;IAClD,OAAO,CAAC,MAAM,CAAC,IAAI,CAA+B;IAClD,OAAO,CAAC,MAAM,CAAC,cAAc,CAA+B;IAC5D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAyB;IAEhD,oEAAoE;IACpE,WAAkB,OAAO,YAA0C;IACnE,WAAkB,OAAO,WAGxB;IAED;;;;OAIG;WACW,OAAO,CAAC,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM;IAgB/D;;OAEG;WACW,QAAQ;WAiBR,YAAY,CAAC,QAAQ,EAAE,UAAU,GAAG,QAAQ;IAO1D,4CAA4C;WACxB,eAAe,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;IAQnF,4CAA4C;WAC9B,OAAO,CAAC,QAAQ,EAAE,UAAU;IAK1C,wEAAwE;WAEpD,4BAA4B,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAIrH,OAAO,CAAC,MAAM,CAAC,qBAAqB;WAIhB,uBAAuB,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,OAAO,EAAE,aAAa,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;WAiB/F,kBAAkB,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC;mBAI5D,cAAc;WAIf,iBAAiB,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;WAKtD,qBAAqB,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC;IAKzF,gHAAgH;WAC5F,gBAAgB,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;WAIpD,iBAAiB,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,kBAAkB,CAAC;WAYzE,kBAAkB,CAAC,GAAG,EAAE,yBAAyB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;WAWjF,cAAc,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;WAI1D,eAAe,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,KAAK,CAAC,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;WAIzF,aAAa,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,cAAc,EAAE,kBAAkB,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;WAIjG,iBAAiB,CAAC,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC;WAYrF,eAAe,CAAC,GAAG,EAAE,cAAc;WAKnC,aAAa,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;WAIzD,YAAY,CAAC,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;WAIhE,iBAAiB,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;WAStE,YAAY,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,OAAO,EAAE,UAAU,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;mBAItE,qBAAqB;CAqB3C"}