@itwin/core-backend 5.15.0-dev.9 → 5.15.0

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

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

package/lib/cjs/NativeHost.js

@@ -18,6 +18,7 @@ const IpcHost_1 = require("./IpcHost");
 const NativeAppStorage_1 = require("./NativeAppStorage");
 const CatalogDb_1 = require("./CatalogDb");
 const OnlineStatus_1 = require("./internal/OnlineStatus");
+const BriefcaseUtils_1 = require("./internal/BriefcaseUtils");
 /**
  * Implementation of NativeAppFunctions
  */
@@ -65,7 +66,10 @@ class NativeAppHandler extends IpcHost_1.IpcHandler {
         return job !== undefined;
     }
     async deleteBriefcaseFiles(fileName) {
-        await BriefcaseManager_1.BriefcaseManager.deleteBriefcaseFiles(fileName, await IModelHost_1.IModelHost.getAccessToken());
+        // fileName comes from the frontend. Only allow deleting files in the briefcase cache, or valid iModels.
+        const filePath = (0, BriefcaseUtils_1.checkFrontendBriefcaseDelete)(fileName, BriefcaseManager_1.BriefcaseManager.cacheDir);
+        if (undefined !== filePath)
+            await BriefcaseManager_1.BriefcaseManager.deleteBriefcaseFiles(filePath, await IModelHost_1.IModelHost.getAccessToken());
     }
     async getCachedBriefcases(iModelId) {
         return BriefcaseManager_1.BriefcaseManager.getCachedBriefcases(iModelId);

package/lib/cjs/NativeHost.js.map

@@ -1 +1 @@
-{"version":3,"file":"NativeHost.js","sourceRoot":"","sources":["../../src/NativeHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA4B;AAC5B,sDAAgG;AAChG,oDAG4B;AAC5B,yDAA8E;AAC9E,2DAAkF;AAClF,6CAA0C;AAC1C,uCAAuF;AACvF,yDAAsD;AACtD,2CAAmD;AACnD,0DAA0D;AAE1D;;GAEG;AACH,MAAM,gBAAiB,SAAQ,oBAAU;IACvC,IAAW,WAAW,KAAK,OAAO,iCAAmB,CAAC,WAAW,CAAC,CAAC,CAAC;IAE7D,KAAK,CAAC,cAAc;QACzB,OAAO,uBAAU,CAAC,mBAAmB,EAAE,cAAc,EAAE,CAAC;IAC1D,CAAC;IAEM,KAAK,CAAC,yBAAyB;QACpC,OAAO,UAAU,CAAC,yBAAyB,EAAE,CAAC;IAChD,CAAC;IACM,KAAK,CAAC,4BAA4B,CAAC,EAAgB,EAAE,MAAkC;QAC5F,UAAU,CAAC,4BAA4B,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IACM,KAAK,CAAC,qBAAqB,CAAC,QAAoB;QACrD,OAAO,mCAAgB,CAAC,qBAAqB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC9D,CAAC;IACM,KAAK,CAAC,oBAAoB,CAAC,KAAqB;QACrD,OAAO,mCAAgB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;IACM,KAAK,CAAC,iBAAiB,CAAC,OAAiC,EAAE,cAAuB,EAAE,gBAAyB;QAClH,MAAM,IAAI,GAA2B;YACnC,GAAG,OAAO;YACV,WAAW,EAAE,MAAM,IAAI,CAAC,cAAc,EAAE;YACxC,UAAU,EAAE,CAAC,EAAU,EAAE,EAAU,EAAE,EAAE,CAAC,UAAU,EAAE;SACrD,CAAC;QAEF,MAAM,UAAU,GAAG,GAAG,EAAE;YACtB,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpC,MAAM,GAAG,GAAG,6BAAS,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAClD,OAAO,CAAC,GAAG,IAAK,GAAG,CAAC,OAAe,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,kCAAc,CAAC,KAAK,CAAC,CAAC,CAAC,kCAAc,CAAC,QAAQ,CAAC;QACpG,CAAC,CAAC;QAEF,IAAI,cAAc,EAAE,CAAC;YACnB,MAAM,gBAAgB,GAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBAC3D,iBAAO,CAAC,IAAI,CAAC,sBAAsB,OAAO,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC1E,OAAO,UAAU,EAAE,CAAC;YACtB,CAAC,CAAC;YACF,IAAI,CAAC,UAAU,GAAG,IAAA,kCAAwB,EAAC,gBAAgB,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;QAC7F,CAAC;QAED,OAAO,mCAAgB,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IAEM,KAAK,CAAC,8BAA8B,CAAC,QAAgB;QAC1D,MAAM,GAAG,GAAG,6BAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC7C,IAAI,GAAG;YACJ,GAAG,CAAC,OAAe,CAAC,KAAK,GAAG,CAAC,CAAC;QACjC,OAAO,GAAG,KAAK,SAAS,CAAC;IAC3B,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,QAAgB;QAChD,MAAM,mCAAgB,CAAC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC,CAAC;IAC3F,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,QAAqB;QACpD,OAAO,mCAAgB,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,SAAiB;QAC3C,OAAO,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,SAAiB,EAAE,QAAiB;QAC/D,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,OAAO,mCAAgB,CAAC,eAAe,EAAE,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,SAAiB,EAAE,GAAW;QAC7D,OAAO,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IAC5D,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,GAAW;QACpD,OAAO,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,GAAW,EAAE,KAAmB;QACzE,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,SAAiB,EAAE,GAAW;QACvD,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,SAAiB;QACxC,OAAO,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC;IACpD,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,SAAiB;QAC7C,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC;IAC/C,CAAC;CACF;AAYD;;;GAGG;AACH,MAAa,UAAU;IACb,MAAM,CAAC,aAAa,CAA8B;IAClD,MAAM,CAAC,gBAAgB,CAAS;IACxC,gBAAwB,CAAC,CAAC,qCAAqC;IAE/D,qEAAqE;IAC9D,MAAM,CAAU,6BAA6B,GAAG,IAAI,sBAAO,EAAgD,CAAC;IAE3G,MAAM,CAAC,oBAAoB,CAAU;IAE7C,0DAA0D;IACnD,MAAM,KAAK,mBAAmB;QACnC,OAAO,IAAI,CAAC,oBAAoB,KAAK,IAAA,WAAI,EAAC,uBAAU,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;IAChF,CAAC;IAED,yEAAyE;IAClE,MAAM,CAAC,oBAAoB,CAAyC,UAAa,EAAE,GAAG,IAA2C;QACtI,OAAO,iBAAO,CAAC,IAAI,CAAC,iCAAmB,CAAC,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IAC9E,CAAC;IAEO,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC;IACzB,MAAM,KAAK,OAAO,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvD,MAAM,KAAK,eAAe,KAAK,OAAO,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACrE,kDAAkD;IAC3C,MAAM,KAAK,aAAa;QAC7B,OAAO,mCAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAoB;QAC9C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,6BAA6B,CAAC,WAAW,CAAC,CAAC,MAAkC,EAAE,EAAE,CACpF,UAAU,CAAC,oBAAoB,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC,CAAC;YAChF,IAAI,CAAC,gBAAgB,GAAG,GAAG,EAAE,UAAU,EAAE,eAAe,IAAI,UAAU,CAAC;QACzE,CAAC;QAED,MAAM,iBAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,iBAAO,CAAC,OAAO,EAAE,CAAC,CAAE,yDAAyD;YAC/E,gBAAgB,CAAC,QAAQ,EAAE,CAAC;YAC5B,gCAAoB,CAAC,QAAQ,EAAE,CAAC;QAClC,CAAC;IACH,CAAC;IAED,mEAAmE;IAC5D,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,6BAA6B,CAAC,KAAK,EAAE,CAAC;QAC3C,MAAM,iBAAO,CAAC,QAAQ,EAAE,CAAC;IAC3B,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,yBAAyB;QACrC,OAAO,IAAI,CAAC,aAAa,IAAI,wCAA0B,CAAC,MAAM,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,4BAA4B,CAAC,YAA0B,EAAE,MAAkC;QACvG,IAAI,IAAI,CAAC,aAAa,KAAK,MAAM,EAAE,CAAC;YAClC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC;YAC5B,IAAI,CAAC,6BAA6B,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YACtD,IAAI,8BAAe,CAAC,kBAAkB,IAAI,8BAAe,CAAC,oBAAoB,EAAE,CAAC;gBAC/E,2FAA2F;gBAC3F,6FAA6F;gBAC7F,qFAAqF;gBACrF,IAAA,8BAAe,EAAC,MAAM,KAAK,wCAA0B,CAAC,MAAM,CAAC,CAAC;YAChE,CAAC;QACH,CAAC;IACH,CAAC;;AA3EH,gCA4EC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module NativeApp\r\n */\r\n\r\nimport { join } from \"path\";\r\nimport { AccessToken, assert, BeEvent, GuidString, ProcessDetector } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseProps, InternetConnectivityStatus, LocalBriefcaseProps, NativeAppFunctions, nativeAppIpcStrings, NativeAppNotifications,\r\n  OverriddenBy, RequestNewBriefcaseProps, StorageValue,\r\n} from \"@itwin/core-common\";\r\nimport { BriefcaseManager, RequestNewBriefcaseArg } from \"./BriefcaseManager\";\r\nimport { Downloads, ProgressFunction, ProgressStatus } from \"./CheckpointManager\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { IpcHandler, IpcHost, IpcHostOpts, throttleProgressCallback } from \"./IpcHost\";\r\nimport { NativeAppStorage } from \"./NativeAppStorage\";\r\nimport { CatalogIModelHandler } from \"./CatalogDb\";\r\nimport { setOnlineStatus } from \"./internal/OnlineStatus\";\r\n\r\n/**\r\n * Implementation of NativeAppFunctions\r\n */\r\nclass NativeAppHandler extends IpcHandler implements NativeAppFunctions {\r\n  public get channelName() { return nativeAppIpcStrings.channelName; }\r\n\r\n  public async getAccessToken(): Promise<AccessToken | undefined> {\r\n    return IModelHost.authorizationClient?.getAccessToken();\r\n  }\r\n\r\n  public async checkInternetConnectivity(): Promise<InternetConnectivityStatus> {\r\n    return NativeHost.checkInternetConnectivity();\r\n  }\r\n  public async overrideInternetConnectivity(by: OverriddenBy, status: InternetConnectivityStatus): Promise<void> {\r\n    NativeHost.overrideInternetConnectivity(by, status);\r\n  }\r\n  public async acquireNewBriefcaseId(iModelId: GuidString): Promise<number> {\r\n    return BriefcaseManager.acquireNewBriefcaseId({ iModelId });\r\n  }\r\n  public async getBriefcaseFileName(props: BriefcaseProps): Promise<string> {\r\n    return BriefcaseManager.getFileName(props);\r\n  }\r\n  public async downloadBriefcase(request: RequestNewBriefcaseProps, reportProgress: boolean, progressInterval?: number): Promise<LocalBriefcaseProps> {\r\n    const args: RequestNewBriefcaseArg = {\r\n      ...request,\r\n      accessToken: await this.getAccessToken(),\r\n      onProgress: (_a: number, _b: number) => checkAbort(),\r\n    };\r\n\r\n    const checkAbort = () => {\r\n      assert(undefined !== args.fileName);\r\n      const job = Downloads.isInProgress(args.fileName);\r\n      return (job && (job.request as any).abort === 1) ? ProgressStatus.Abort : ProgressStatus.Continue;\r\n    };\r\n\r\n    if (reportProgress) {\r\n      const progressCallback: ProgressFunction = (loaded, total) => {\r\n        IpcHost.send(`nativeApp.progress-${request.iModelId}`, { loaded, total });\r\n        return checkAbort();\r\n      };\r\n      args.onProgress = throttleProgressCallback(progressCallback, checkAbort, progressInterval);\r\n    }\r\n\r\n    return BriefcaseManager.downloadBriefcase(args);\r\n  }\r\n\r\n  public async requestCancelDownloadBriefcase(fileName: string): Promise<boolean> {\r\n    const job = Downloads.isInProgress(fileName);\r\n    if (job)\r\n      (job.request as any).abort = 1;\r\n    return job !== undefined;\r\n  }\r\n\r\n  public async deleteBriefcaseFiles(fileName: string): Promise<void> {\r\n    await BriefcaseManager.deleteBriefcaseFiles(fileName, await IModelHost.getAccessToken());\r\n  }\r\n\r\n  public async getCachedBriefcases(iModelId?: GuidString): Promise<LocalBriefcaseProps[]> {\r\n    return BriefcaseManager.getCachedBriefcases(iModelId);\r\n  }\r\n\r\n  public async storageMgrOpen(storageId: string): Promise<string> {\r\n    return NativeAppStorage.open(storageId).id;\r\n  }\r\n\r\n  public async storageMgrClose(storageId: string, deleteIt: boolean): Promise<void> {\r\n    NativeAppStorage.find(storageId).close(deleteIt);\r\n  }\r\n\r\n  public async storageMgrNames(): Promise<string[]> {\r\n    return NativeAppStorage.getStorageNames();\r\n  }\r\n\r\n  public async storageGetValueType(storageId: string, key: string): Promise<\"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined> {\r\n    return NativeAppStorage.find(storageId).getValueType(key);\r\n  }\r\n\r\n  public async storageGet(storageId: string, key: string): Promise<StorageValue | undefined> {\r\n    return NativeAppStorage.find(storageId).getData(key);\r\n  }\r\n\r\n  public async storageSet(storageId: string, key: string, value: StorageValue): Promise<void> {\r\n    NativeAppStorage.find(storageId).setData(key, value);\r\n  }\r\n\r\n  public async storageRemove(storageId: string, key: string): Promise<void> {\r\n    NativeAppStorage.find(storageId).removeData(key);\r\n  }\r\n\r\n  public async storageKeys(storageId: string): Promise<string[]> {\r\n    return NativeAppStorage.find(storageId).getKeys();\r\n  }\r\n\r\n  public async storageRemoveAll(storageId: string): Promise<void> {\r\n    NativeAppStorage.find(storageId).removeAll();\r\n  }\r\n}\r\n\r\n/** Options for [[NativeHost.startup]]\r\n * @public\r\n */\r\nexport interface NativeHostOpts extends IpcHostOpts {\r\n  nativeHost?: {\r\n    /** Application name. Used, for example, to name the settings file. If not supplied, defaults to \"iTwinApp\". */\r\n    applicationName?: string;\r\n  };\r\n}\r\n\r\n/**\r\n * Backend for desktop/mobile native applications\r\n * @public\r\n */\r\nexport class NativeHost {\r\n  private static _reachability?: InternetConnectivityStatus;\r\n  private static _applicationName: string;\r\n  private constructor() { } // no instances - static methods only\r\n\r\n  /** Event called when the internet connectivity changes, if known. */\r\n  public static readonly onInternetConnectivityChanged = new BeEvent<(status: InternetConnectivityStatus) => void>();\r\n\r\n  private static _appSettingsCacheDir?: string;\r\n\r\n  /** Get the local cache folder for application settings */\r\n  public static get appSettingsCacheDir(): string {\r\n    return this._appSettingsCacheDir ??= join(IModelHost.cacheDir, \"appSettings\");\r\n  }\r\n\r\n  /** Send a notification to the NativeApp connected to this NativeHost. */\r\n  public static notifyNativeFrontend<T extends keyof NativeAppNotifications>(methodName: T, ...args: Parameters<NativeAppNotifications[T]>) {\r\n    return IpcHost.send(nativeAppIpcStrings.notifyChannel, methodName, ...args);\r\n  }\r\n\r\n  private static _isValid = false;\r\n  public static get isValid(): boolean { return this._isValid; }\r\n  public static get applicationName() { return this._applicationName; }\r\n  /** Get the settings store for this NativeHost. */\r\n  public static get settingsStore() {\r\n    return NativeAppStorage.open(this.applicationName);\r\n  }\r\n\r\n  /**\r\n   * Start the backend of a native app.\r\n   * @note this method calls [[IpcHost.startup]] internally.\r\n   */\r\n  public static async startup(opt?: NativeHostOpts): Promise<void> {\r\n    if (!this.isValid) {\r\n      this._isValid = true;\r\n      this.onInternetConnectivityChanged.addListener((status: InternetConnectivityStatus) =>\r\n        NativeHost.notifyNativeFrontend(\"notifyInternetConnectivityChanged\", status));\r\n      this._applicationName = opt?.nativeHost?.applicationName ?? \"iTwinApp\";\r\n    }\r\n\r\n    await IpcHost.startup(opt);\r\n    if (IpcHost.isValid) {  // for tests, we use NativeHost but don't have a frontend\r\n      NativeAppHandler.register();\r\n      CatalogIModelHandler.register();\r\n    }\r\n  }\r\n\r\n  /** Shutdown native app backend. Also calls [[IpcHost.shutdown]] */\r\n  public static async shutdown(): Promise<void> {\r\n    this._isValid = false;\r\n    this.onInternetConnectivityChanged.clear();\r\n    await IpcHost.shutdown();\r\n  }\r\n\r\n  /** get current value of internet connectivity */\r\n  public static checkInternetConnectivity(): InternetConnectivityStatus {\r\n    return this._reachability ?? InternetConnectivityStatus.Online;\r\n  }\r\n\r\n  /**\r\n   * Override internet connectivity state\r\n   * @param _overridenBy who overrode the value.\r\n   * @internal\r\n   */\r\n  public static overrideInternetConnectivity(_overridenBy: OverriddenBy, status: InternetConnectivityStatus): void {\r\n    if (this._reachability !== status) {\r\n      this._reachability = status;\r\n      this.onInternetConnectivityChanged.raiseEvent(status);\r\n      if (ProcessDetector.isMobileAppBackend || ProcessDetector.isElectronAppBackend) {\r\n        // Merely referencing NativeHost from a non-native backend causes a runtime exception (even\r\n        // inside an if statement that checks that the backend is a mobile backend). This allows code\r\n        // that needs to check connectivity to do so without referencing NativeHost directly.\r\n        setOnlineStatus(status === InternetConnectivityStatus.Online);\r\n      }\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"NativeHost.js","sourceRoot":"","sources":["../../src/NativeHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA4B;AAC5B,sDAAgG;AAChG,oDAG4B;AAC5B,yDAA8E;AAC9E,2DAAkF;AAClF,6CAA0C;AAC1C,uCAAuF;AACvF,yDAAsD;AACtD,2CAAmD;AACnD,0DAA0D;AAC1D,8DAAyE;AAEzE;;GAEG;AACH,MAAM,gBAAiB,SAAQ,oBAAU;IACvC,IAAW,WAAW,KAAK,OAAO,iCAAmB,CAAC,WAAW,CAAC,CAAC,CAAC;IAE7D,KAAK,CAAC,cAAc;QACzB,OAAO,uBAAU,CAAC,mBAAmB,EAAE,cAAc,EAAE,CAAC;IAC1D,CAAC;IAEM,KAAK,CAAC,yBAAyB;QACpC,OAAO,UAAU,CAAC,yBAAyB,EAAE,CAAC;IAChD,CAAC;IACM,KAAK,CAAC,4BAA4B,CAAC,EAAgB,EAAE,MAAkC;QAC5F,UAAU,CAAC,4BAA4B,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IACM,KAAK,CAAC,qBAAqB,CAAC,QAAoB;QACrD,OAAO,mCAAgB,CAAC,qBAAqB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC9D,CAAC;IACM,KAAK,CAAC,oBAAoB,CAAC,KAAqB;QACrD,OAAO,mCAAgB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;IACM,KAAK,CAAC,iBAAiB,CAAC,OAAiC,EAAE,cAAuB,EAAE,gBAAyB;QAClH,MAAM,IAAI,GAA2B;YACnC,GAAG,OAAO;YACV,WAAW,EAAE,MAAM,IAAI,CAAC,cAAc,EAAE;YACxC,UAAU,EAAE,CAAC,EAAU,EAAE,EAAU,EAAE,EAAE,CAAC,UAAU,EAAE;SACrD,CAAC;QAEF,MAAM,UAAU,GAAG,GAAG,EAAE;YACtB,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpC,MAAM,GAAG,GAAG,6BAAS,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAClD,OAAO,CAAC,GAAG,IAAK,GAAG,CAAC,OAAe,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,kCAAc,CAAC,KAAK,CAAC,CAAC,CAAC,kCAAc,CAAC,QAAQ,CAAC;QACpG,CAAC,CAAC;QAEF,IAAI,cAAc,EAAE,CAAC;YACnB,MAAM,gBAAgB,GAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBAC3D,iBAAO,CAAC,IAAI,CAAC,sBAAsB,OAAO,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC1E,OAAO,UAAU,EAAE,CAAC;YACtB,CAAC,CAAC;YACF,IAAI,CAAC,UAAU,GAAG,IAAA,kCAAwB,EAAC,gBAAgB,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;QAC7F,CAAC;QAED,OAAO,mCAAgB,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IAEM,KAAK,CAAC,8BAA8B,CAAC,QAAgB;QAC1D,MAAM,GAAG,GAAG,6BAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC7C,IAAI,GAAG;YACJ,GAAG,CAAC,OAAe,CAAC,KAAK,GAAG,CAAC,CAAC;QACjC,OAAO,GAAG,KAAK,SAAS,CAAC;IAC3B,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,QAAgB;QAChD,wGAAwG;QACxG,MAAM,QAAQ,GAAG,IAAA,6CAA4B,EAAC,QAAQ,EAAE,mCAAgB,CAAC,QAAQ,CAAC,CAAC;QACnF,IAAI,SAAS,KAAK,QAAQ;YACxB,MAAM,mCAAgB,CAAC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC,CAAC;IAC7F,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,QAAqB;QACpD,OAAO,mCAAgB,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,SAAiB;QAC3C,OAAO,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,SAAiB,EAAE,QAAiB;QAC/D,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,OAAO,mCAAgB,CAAC,eAAe,EAAE,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,SAAiB,EAAE,GAAW;QAC7D,OAAO,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IAC5D,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,GAAW;QACpD,OAAO,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,GAAW,EAAE,KAAmB;QACzE,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,SAAiB,EAAE,GAAW;QACvD,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,SAAiB;QACxC,OAAO,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC;IACpD,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,SAAiB;QAC7C,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC;IAC/C,CAAC;CACF;AAYD;;;GAGG;AACH,MAAa,UAAU;IACb,MAAM,CAAC,aAAa,CAA8B;IAClD,MAAM,CAAC,gBAAgB,CAAS;IACxC,gBAAwB,CAAC,CAAC,qCAAqC;IAE/D,qEAAqE;IAC9D,MAAM,CAAU,6BAA6B,GAAG,IAAI,sBAAO,EAAgD,CAAC;IAE3G,MAAM,CAAC,oBAAoB,CAAU;IAE7C,0DAA0D;IACnD,MAAM,KAAK,mBAAmB;QACnC,OAAO,IAAI,CAAC,oBAAoB,KAAK,IAAA,WAAI,EAAC,uBAAU,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;IAChF,CAAC;IAED,yEAAyE;IAClE,MAAM,CAAC,oBAAoB,CAAyC,UAAa,EAAE,GAAG,IAA2C;QACtI,OAAO,iBAAO,CAAC,IAAI,CAAC,iCAAmB,CAAC,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IAC9E,CAAC;IAEO,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC;IACzB,MAAM,KAAK,OAAO,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvD,MAAM,KAAK,eAAe,KAAK,OAAO,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACrE,kDAAkD;IAC3C,MAAM,KAAK,aAAa;QAC7B,OAAO,mCAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAoB;QAC9C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,6BAA6B,CAAC,WAAW,CAAC,CAAC,MAAkC,EAAE,EAAE,CACpF,UAAU,CAAC,oBAAoB,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC,CAAC;YAChF,IAAI,CAAC,gBAAgB,GAAG,GAAG,EAAE,UAAU,EAAE,eAAe,IAAI,UAAU,CAAC;QACzE,CAAC;QAED,MAAM,iBAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,iBAAO,CAAC,OAAO,EAAE,CAAC,CAAE,yDAAyD;YAC/E,gBAAgB,CAAC,QAAQ,EAAE,CAAC;YAC5B,gCAAoB,CAAC,QAAQ,EAAE,CAAC;QAClC,CAAC;IACH,CAAC;IAED,mEAAmE;IAC5D,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,6BAA6B,CAAC,KAAK,EAAE,CAAC;QAC3C,MAAM,iBAAO,CAAC,QAAQ,EAAE,CAAC;IAC3B,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,yBAAyB;QACrC,OAAO,IAAI,CAAC,aAAa,IAAI,wCAA0B,CAAC,MAAM,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,4BAA4B,CAAC,YAA0B,EAAE,MAAkC;QACvG,IAAI,IAAI,CAAC,aAAa,KAAK,MAAM,EAAE,CAAC;YAClC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC;YAC5B,IAAI,CAAC,6BAA6B,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YACtD,IAAI,8BAAe,CAAC,kBAAkB,IAAI,8BAAe,CAAC,oBAAoB,EAAE,CAAC;gBAC/E,2FAA2F;gBAC3F,6FAA6F;gBAC7F,qFAAqF;gBACrF,IAAA,8BAAe,EAAC,MAAM,KAAK,wCAA0B,CAAC,MAAM,CAAC,CAAC;YAChE,CAAC;QACH,CAAC;IACH,CAAC;;AA3EH,gCA4EC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module NativeApp\r\n */\r\n\r\nimport { join } from \"path\";\r\nimport { AccessToken, assert, BeEvent, GuidString, ProcessDetector } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseProps, InternetConnectivityStatus, LocalBriefcaseProps, NativeAppFunctions, nativeAppIpcStrings, NativeAppNotifications,\r\n  OverriddenBy, RequestNewBriefcaseProps, StorageValue,\r\n} from \"@itwin/core-common\";\r\nimport { BriefcaseManager, RequestNewBriefcaseArg } from \"./BriefcaseManager\";\r\nimport { Downloads, ProgressFunction, ProgressStatus } from \"./CheckpointManager\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { IpcHandler, IpcHost, IpcHostOpts, throttleProgressCallback } from \"./IpcHost\";\r\nimport { NativeAppStorage } from \"./NativeAppStorage\";\r\nimport { CatalogIModelHandler } from \"./CatalogDb\";\r\nimport { setOnlineStatus } from \"./internal/OnlineStatus\";\r\nimport { checkFrontendBriefcaseDelete } from \"./internal/BriefcaseUtils\";\r\n\r\n/**\r\n * Implementation of NativeAppFunctions\r\n */\r\nclass NativeAppHandler extends IpcHandler implements NativeAppFunctions {\r\n  public get channelName() { return nativeAppIpcStrings.channelName; }\r\n\r\n  public async getAccessToken(): Promise<AccessToken | undefined> {\r\n    return IModelHost.authorizationClient?.getAccessToken();\r\n  }\r\n\r\n  public async checkInternetConnectivity(): Promise<InternetConnectivityStatus> {\r\n    return NativeHost.checkInternetConnectivity();\r\n  }\r\n  public async overrideInternetConnectivity(by: OverriddenBy, status: InternetConnectivityStatus): Promise<void> {\r\n    NativeHost.overrideInternetConnectivity(by, status);\r\n  }\r\n  public async acquireNewBriefcaseId(iModelId: GuidString): Promise<number> {\r\n    return BriefcaseManager.acquireNewBriefcaseId({ iModelId });\r\n  }\r\n  public async getBriefcaseFileName(props: BriefcaseProps): Promise<string> {\r\n    return BriefcaseManager.getFileName(props);\r\n  }\r\n  public async downloadBriefcase(request: RequestNewBriefcaseProps, reportProgress: boolean, progressInterval?: number): Promise<LocalBriefcaseProps> {\r\n    const args: RequestNewBriefcaseArg = {\r\n      ...request,\r\n      accessToken: await this.getAccessToken(),\r\n      onProgress: (_a: number, _b: number) => checkAbort(),\r\n    };\r\n\r\n    const checkAbort = () => {\r\n      assert(undefined !== args.fileName);\r\n      const job = Downloads.isInProgress(args.fileName);\r\n      return (job && (job.request as any).abort === 1) ? ProgressStatus.Abort : ProgressStatus.Continue;\r\n    };\r\n\r\n    if (reportProgress) {\r\n      const progressCallback: ProgressFunction = (loaded, total) => {\r\n        IpcHost.send(`nativeApp.progress-${request.iModelId}`, { loaded, total });\r\n        return checkAbort();\r\n      };\r\n      args.onProgress = throttleProgressCallback(progressCallback, checkAbort, progressInterval);\r\n    }\r\n\r\n    return BriefcaseManager.downloadBriefcase(args);\r\n  }\r\n\r\n  public async requestCancelDownloadBriefcase(fileName: string): Promise<boolean> {\r\n    const job = Downloads.isInProgress(fileName);\r\n    if (job)\r\n      (job.request as any).abort = 1;\r\n    return job !== undefined;\r\n  }\r\n\r\n  public async deleteBriefcaseFiles(fileName: string): Promise<void> {\r\n    // fileName comes from the frontend. Only allow deleting files in the briefcase cache, or valid iModels.\r\n    const filePath = checkFrontendBriefcaseDelete(fileName, BriefcaseManager.cacheDir);\r\n    if (undefined !== filePath)\r\n      await BriefcaseManager.deleteBriefcaseFiles(filePath, await IModelHost.getAccessToken());\r\n  }\r\n\r\n  public async getCachedBriefcases(iModelId?: GuidString): Promise<LocalBriefcaseProps[]> {\r\n    return BriefcaseManager.getCachedBriefcases(iModelId);\r\n  }\r\n\r\n  public async storageMgrOpen(storageId: string): Promise<string> {\r\n    return NativeAppStorage.open(storageId).id;\r\n  }\r\n\r\n  public async storageMgrClose(storageId: string, deleteIt: boolean): Promise<void> {\r\n    NativeAppStorage.find(storageId).close(deleteIt);\r\n  }\r\n\r\n  public async storageMgrNames(): Promise<string[]> {\r\n    return NativeAppStorage.getStorageNames();\r\n  }\r\n\r\n  public async storageGetValueType(storageId: string, key: string): Promise<\"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined> {\r\n    return NativeAppStorage.find(storageId).getValueType(key);\r\n  }\r\n\r\n  public async storageGet(storageId: string, key: string): Promise<StorageValue | undefined> {\r\n    return NativeAppStorage.find(storageId).getData(key);\r\n  }\r\n\r\n  public async storageSet(storageId: string, key: string, value: StorageValue): Promise<void> {\r\n    NativeAppStorage.find(storageId).setData(key, value);\r\n  }\r\n\r\n  public async storageRemove(storageId: string, key: string): Promise<void> {\r\n    NativeAppStorage.find(storageId).removeData(key);\r\n  }\r\n\r\n  public async storageKeys(storageId: string): Promise<string[]> {\r\n    return NativeAppStorage.find(storageId).getKeys();\r\n  }\r\n\r\n  public async storageRemoveAll(storageId: string): Promise<void> {\r\n    NativeAppStorage.find(storageId).removeAll();\r\n  }\r\n}\r\n\r\n/** Options for [[NativeHost.startup]]\r\n * @public\r\n */\r\nexport interface NativeHostOpts extends IpcHostOpts {\r\n  nativeHost?: {\r\n    /** Application name. Used, for example, to name the settings file. If not supplied, defaults to \"iTwinApp\". */\r\n    applicationName?: string;\r\n  };\r\n}\r\n\r\n/**\r\n * Backend for desktop/mobile native applications\r\n * @public\r\n */\r\nexport class NativeHost {\r\n  private static _reachability?: InternetConnectivityStatus;\r\n  private static _applicationName: string;\r\n  private constructor() { } // no instances - static methods only\r\n\r\n  /** Event called when the internet connectivity changes, if known. */\r\n  public static readonly onInternetConnectivityChanged = new BeEvent<(status: InternetConnectivityStatus) => void>();\r\n\r\n  private static _appSettingsCacheDir?: string;\r\n\r\n  /** Get the local cache folder for application settings */\r\n  public static get appSettingsCacheDir(): string {\r\n    return this._appSettingsCacheDir ??= join(IModelHost.cacheDir, \"appSettings\");\r\n  }\r\n\r\n  /** Send a notification to the NativeApp connected to this NativeHost. */\r\n  public static notifyNativeFrontend<T extends keyof NativeAppNotifications>(methodName: T, ...args: Parameters<NativeAppNotifications[T]>) {\r\n    return IpcHost.send(nativeAppIpcStrings.notifyChannel, methodName, ...args);\r\n  }\r\n\r\n  private static _isValid = false;\r\n  public static get isValid(): boolean { return this._isValid; }\r\n  public static get applicationName() { return this._applicationName; }\r\n  /** Get the settings store for this NativeHost. */\r\n  public static get settingsStore() {\r\n    return NativeAppStorage.open(this.applicationName);\r\n  }\r\n\r\n  /**\r\n   * Start the backend of a native app.\r\n   * @note this method calls [[IpcHost.startup]] internally.\r\n   */\r\n  public static async startup(opt?: NativeHostOpts): Promise<void> {\r\n    if (!this.isValid) {\r\n      this._isValid = true;\r\n      this.onInternetConnectivityChanged.addListener((status: InternetConnectivityStatus) =>\r\n        NativeHost.notifyNativeFrontend(\"notifyInternetConnectivityChanged\", status));\r\n      this._applicationName = opt?.nativeHost?.applicationName ?? \"iTwinApp\";\r\n    }\r\n\r\n    await IpcHost.startup(opt);\r\n    if (IpcHost.isValid) {  // for tests, we use NativeHost but don't have a frontend\r\n      NativeAppHandler.register();\r\n      CatalogIModelHandler.register();\r\n    }\r\n  }\r\n\r\n  /** Shutdown native app backend. Also calls [[IpcHost.shutdown]] */\r\n  public static async shutdown(): Promise<void> {\r\n    this._isValid = false;\r\n    this.onInternetConnectivityChanged.clear();\r\n    await IpcHost.shutdown();\r\n  }\r\n\r\n  /** get current value of internet connectivity */\r\n  public static checkInternetConnectivity(): InternetConnectivityStatus {\r\n    return this._reachability ?? InternetConnectivityStatus.Online;\r\n  }\r\n\r\n  /**\r\n   * Override internet connectivity state\r\n   * @param _overridenBy who overrode the value.\r\n   * @internal\r\n   */\r\n  public static overrideInternetConnectivity(_overridenBy: OverriddenBy, status: InternetConnectivityStatus): void {\r\n    if (this._reachability !== status) {\r\n      this._reachability = status;\r\n      this.onInternetConnectivityChanged.raiseEvent(status);\r\n      if (ProcessDetector.isMobileAppBackend || ProcessDetector.isElectronAppBackend) {\r\n        // Merely referencing NativeHost from a non-native backend causes a runtime exception (even\r\n        // inside an if statement that checks that the backend is a mobile backend). This allows code\r\n        // that needs to check connectivity to do so without referencing NativeHost directly.\r\n        setOnlineStatus(status === InternetConnectivityStatus.Online);\r\n      }\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/cjs/Relationship.d.ts

@@ -470,5 +470,33 @@ export declare class Relationships {
      * @see getInstance
      */
     tryGetInstance<T extends Relationship>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T | undefined;
+    /** Get the props of multiple Relationship instances of the same class using batched queries.
+     * This produces the same results as calling [[tryGetInstanceProps]] for each entry in `criteria`, but executes at most two queries regardless of the number of entries.
+     * @param relClassFullName The full class name of the relationship in the form of "schema:class"
+     * @param criteria The relationships to look up. Each entry is either a relationship instanceId or the source and target Ids. Entries of both kinds may be mixed.
+     * @param options.usePrimaryConn If `true` (the default), the queries run on the primary connection so that unsaved changes are visible, matching [[tryGetInstanceProps]].
+     * If `false`, they run on a concurrent query connection, which does not see unsaved changes.
+     * @returns An array with the same length and order as `criteria`. Each entry holds the RelationshipProps matching the corresponding criterion, or `undefined` if no such relationship was found.
+     * @see tryGetInstanceProps
+     * @see queryInstances
+     * @beta
+     */
+    queryInstancesProps<T extends RelationshipProps>(relClassFullName: string, criteria: ReadonlyArray<Id64String | SourceAndTarget>, options?: {
+        usePrimaryConn?: boolean;
+    }): Promise<Array<T | undefined>>;
+    /** Get multiple Relationship instances of the same class using batched queries.
+     * This produces the same results as calling [[tryGetInstance]] for each entry in `criteria`, but executes at most two queries regardless of the number of entries.
+     * @param relClassFullName The full class name of the relationship in the form of "schema:class"
+     * @param criteria The relationships to look up. Each entry is either a relationship instanceId or the source and target Ids. Entries of both kinds may be mixed.
+     * @param options.usePrimaryConn If `true` (the default), the queries run on the primary connection so that unsaved changes are visible, matching [[tryGetInstance]].
+     * If `false`, they run on a concurrent query connection, which does not see unsaved changes.
+     * @returns An array with the same length and order as `criteria`. Each entry holds the relationship matching the corresponding criterion, or `undefined` if no such relationship was found.
+     * @see tryGetInstance
+     * @see queryInstancesProps
+     * @beta
+     */
+    queryInstances<T extends Relationship>(relClassFullName: string, criteria: ReadonlyArray<Id64String | SourceAndTarget>, options?: {
+        usePrimaryConn?: boolean;
+    }): Promise<Array<T | undefined>>;
 }
 //# sourceMappingURL=Relationship.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Relationship.d.ts","sourceRoot":"","sources":["../../src/Relationship.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAkB,UAAU,EAAgB,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAA4C,iBAAiB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACtI,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,YAAY,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,+DAA+D;IAC/D,MAAM,EAAE,QAAQ,CAAC;IACjB,8EAA8E;IAC9E,KAAK,EAAE,iBAAiB,CAAC;IACzB,+CAA+C;IAC/C,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,MAAM;IACtC,WAA2B,SAAS,IAAI,MAAM,CAA2B;IACzE,SAAgB,QAAQ,EAAE,UAAU,CAAC;IACrC,SAAgB,QAAQ,EAAE,UAAU,CAAC;IAErC,SAAS,aAAa,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ;IAMhD,MAAM,IAAI,iBAAiB;IAO3C;;OAEG;IACmB,WAAW,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAc/D;;;;;OAKG;WACW,gBAAgB,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IAK1D;;;;;;;OAOG;WACW,aAAa,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,EAAE,QAAQ,GAAG,IAAI;IAE/E;;;;OAIG;WACW,sBAAsB,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IAKhE;;;;;;OAMG;WACW,mBAAmB,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,EAAE,QAAQ,GAAG,IAAI;IAErF;;;OAGG;IACI,MAAM,CAAC,GAAG,EAAE,OAAO,GAAG,UAAU;IACvC;;;OAGG;IACI,MAAM,IAAI,UAAU;IAG3B;;;OAGG;IACI,MAAM,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IACjC;;;OAGG;IACI,MAAM,IAAI,IAAI;IAGrB;;;OAGG;IACI,MAAM,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IACjC;;;OAGG;IACI,MAAM,IAAI,IAAI;WAGP,WAAW,CAAC,CAAC,SAAS,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC;CAC/G;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IACvD,WAA2B,SAAS,IAAI,MAAM,CAAsC;IACpF;;;;;OAKG;WACW,MAAM,CAAC,CAAC,SAAS,uBAAuB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,GAAG,CAAC;IAIxH;;;;;;OAMG;WACW,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,GAAG,UAAU;IAC1F;;;;;;OAMG;WACW,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,GAAG,UAAU;cAO3E,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAK/E;AAED;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,uBAAuB;IAC1E,WAA2B,SAAS,IAAI,MAAM,CAA8C;CAC7F;AAED;;GAEG;AACH,qBAAa,mCAAoC,SAAQ,uBAAuB;IAC9E,WAA2B,SAAS,IAAI,MAAM,CAAkD;CACjG;AAED;;;;GAIG;AACH,qBAAa,qCAAsC,SAAQ,uBAAuB;IAChF,WAA2B,SAAS,IAAI,MAAM,CAAoD;CACnG;AAED;;;GAGG;AACH,qBAAa,yCAA0C,SAAQ,qCAAqC;IAClG,WAA2B,SAAS,IAAI,MAAM,CAAwD;CACvG;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAClE,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,uBAAuB;IAC/D,WAA2B,SAAS,IAAI,MAAM,CAAmC;IAC1E,cAAc,EAAE,MAAM,CAAC;gBAElB,KAAK,EAAE,yBAAyB,EAAE,MAAM,EAAE,QAAQ;WAKvC,MAAM,CAAC,CAAC,SAAS,uBAAuB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,cAAc,GAAE,MAAU,GAAG,CAAC;CAI9J;AAED;;;GAGG;AACH,qBAAa,gCAAiC,SAAQ,oBAAoB;IACxE,WAA2B,SAAS,IAAI,MAAM,CAA+C;CAC9F;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,oBAAoB;IAC7D,WAA2B,SAAS,IAAI,MAAM,CAAoC;CACnF;AAED;;;GAGG;AACH,qBAAa,gCAAiC,SAAQ,oBAAoB;IACxE,WAA2B,SAAS,IAAI,MAAM,CAA+C;CAC9F;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAClE,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuLG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,WAA2B,SAAS,IAAI,MAAM,CAAmC;IACjF;;;;OAIG;IACI,MAAM,EAAE,MAAM,CAAC;IACtB,uHAAuH;IAChH,QAAQ,EAAE,MAAM,CAAC;IAExB,SAAS,aAAa,KAAK,EAAE,yBAAyB,EAAE,MAAM,EAAE,QAAQ;WAM1D,MAAM,CAAC,CAAC,SAAS,oBAAoB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,GAAE,MAAU,GAAG,CAAC;IAK3H,MAAM,IAAI,yBAAyB;cAOhC,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAK/E;AAED;;;;;GAKG;AACH,qBAAa,2BAA4B,SAAQ,YAAY;IAC3D,WAA2B,SAAS,IAAI,MAAM,CAA0C;cACrE,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAK/E;AAED;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,OAAO,CAAW;IAE1B,gBAAgB;gBACG,MAAM,EAAE,QAAQ;IAEnC;;;OAGG;IACI,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,YAAY;IAE7D,2EAA2E;IAC3E,OAAO,CAAC,sBAAsB;IAM9B;;;;;OAKG;IACI,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,UAAU;IAI3D;;;OAGG;IACI,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAIrD;;OAEG;IACI,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAIrD;;;;OAIG;IACI,eAAe,CAAC,KAAK,EAAE,aAAa,CAAC,iBAAiB,CAAC,GAAG,IAAI;IAIrE;;;;;OAKG;IACI,gBAAgB,CAAC,CAAC,SAAS,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC;IAQzH;;;;;;OAMG;IACI,mBAAmB,CAAC,CAAC,SAAS,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC,GAAG,SAAS;IAwBxI;;;;;OAKG;IACI,WAAW,CAAC,CAAC,SAAS,YAAY,EAAE,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC;IAI9G;;;;;;OAMG;IACI,cAAc,CAAC,CAAC,SAAS,YAAY,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC,GAAG,SAAS;CAI/H"}
+{"version":3,"file":"Relationship.d.ts","sourceRoot":"","sources":["../../src/Relationship.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAkB,UAAU,EAAgB,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAA4C,iBAAiB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACtI,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,YAAY,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,+DAA+D;IAC/D,MAAM,EAAE,QAAQ,CAAC;IACjB,8EAA8E;IAC9E,KAAK,EAAE,iBAAiB,CAAC;IACzB,+CAA+C;IAC/C,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,MAAM;IACtC,WAA2B,SAAS,IAAI,MAAM,CAA2B;IACzE,SAAgB,QAAQ,EAAE,UAAU,CAAC;IACrC,SAAgB,QAAQ,EAAE,UAAU,CAAC;IAErC,SAAS,aAAa,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ;IAMhD,MAAM,IAAI,iBAAiB;IAO3C;;OAEG;IACmB,WAAW,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAc/D;;;;;OAKG;WACW,gBAAgB,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IAK1D;;;;;;;OAOG;WACW,aAAa,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,EAAE,QAAQ,GAAG,IAAI;IAE/E;;;;OAIG;WACW,sBAAsB,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IAKhE;;;;;;OAMG;WACW,mBAAmB,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,EAAE,QAAQ,GAAG,IAAI;IAErF;;;OAGG;IACI,MAAM,CAAC,GAAG,EAAE,OAAO,GAAG,UAAU;IACvC;;;OAGG;IACI,MAAM,IAAI,UAAU;IAG3B;;;OAGG;IACI,MAAM,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IACjC;;;OAGG;IACI,MAAM,IAAI,IAAI;IAGrB;;;OAGG;IACI,MAAM,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IACjC;;;OAGG;IACI,MAAM,IAAI,IAAI;WAGP,WAAW,CAAC,CAAC,SAAS,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC;CAC/G;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IACvD,WAA2B,SAAS,IAAI,MAAM,CAAsC;IACpF;;;;;OAKG;WACW,MAAM,CAAC,CAAC,SAAS,uBAAuB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,GAAG,CAAC;IAIxH;;;;;;OAMG;WACW,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,GAAG,UAAU;IAC1F;;;;;;OAMG;WACW,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,GAAG,UAAU;cAO3E,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAK/E;AAED;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,uBAAuB;IAC1E,WAA2B,SAAS,IAAI,MAAM,CAA8C;CAC7F;AAED;;GAEG;AACH,qBAAa,mCAAoC,SAAQ,uBAAuB;IAC9E,WAA2B,SAAS,IAAI,MAAM,CAAkD;CACjG;AAED;;;;GAIG;AACH,qBAAa,qCAAsC,SAAQ,uBAAuB;IAChF,WAA2B,SAAS,IAAI,MAAM,CAAoD;CACnG;AAED;;;GAGG;AACH,qBAAa,yCAA0C,SAAQ,qCAAqC;IAClG,WAA2B,SAAS,IAAI,MAAM,CAAwD;CACvG;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAClE,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,uBAAuB;IAC/D,WAA2B,SAAS,IAAI,MAAM,CAAmC;IAC1E,cAAc,EAAE,MAAM,CAAC;gBAElB,KAAK,EAAE,yBAAyB,EAAE,MAAM,EAAE,QAAQ;WAKvC,MAAM,CAAC,CAAC,SAAS,uBAAuB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,cAAc,GAAE,MAAU,GAAG,CAAC;CAI9J;AAED;;;GAGG;AACH,qBAAa,gCAAiC,SAAQ,oBAAoB;IACxE,WAA2B,SAAS,IAAI,MAAM,CAA+C;CAC9F;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,oBAAoB;IAC7D,WAA2B,SAAS,IAAI,MAAM,CAAoC;CACnF;AAED;;;GAGG;AACH,qBAAa,gCAAiC,SAAQ,oBAAoB;IACxE,WAA2B,SAAS,IAAI,MAAM,CAA+C;CAC9F;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAClE,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuLG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,WAA2B,SAAS,IAAI,MAAM,CAAmC;IACjF;;;;OAIG;IACI,MAAM,EAAE,MAAM,CAAC;IACtB,uHAAuH;IAChH,QAAQ,EAAE,MAAM,CAAC;IAExB,SAAS,aAAa,KAAK,EAAE,yBAAyB,EAAE,MAAM,EAAE,QAAQ;WAM1D,MAAM,CAAC,CAAC,SAAS,oBAAoB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,GAAE,MAAU,GAAG,CAAC;IAK3H,MAAM,IAAI,yBAAyB;cAOhC,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAK/E;AAED;;;;;GAKG;AACH,qBAAa,2BAA4B,SAAQ,YAAY;IAC3D,WAA2B,SAAS,IAAI,MAAM,CAA0C;cACrE,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAK/E;AAED;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,OAAO,CAAW;IAE1B,gBAAgB;gBACG,MAAM,EAAE,QAAQ;IAEnC;;;OAGG;IACI,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,YAAY;IAE7D,2EAA2E;IAC3E,OAAO,CAAC,sBAAsB;IAM9B;;;;;OAKG;IACI,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,UAAU;IAI3D;;;OAGG;IACI,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAIrD;;OAEG;IACI,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAIrD;;;;OAIG;IACI,eAAe,CAAC,KAAK,EAAE,aAAa,CAAC,iBAAiB,CAAC,GAAG,IAAI;IAIrE;;;;;OAKG;IACI,gBAAgB,CAAC,CAAC,SAAS,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC;IAQzH;;;;;;OAMG;IACI,mBAAmB,CAAC,CAAC,SAAS,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC,GAAG,SAAS;IAwBxI;;;;;OAKG;IACI,WAAW,CAAC,CAAC,SAAS,YAAY,EAAE,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC;IAI9G;;;;;;OAMG;IACI,cAAc,CAAC,CAAC,SAAS,YAAY,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC,GAAG,SAAS;IAK9H;;;;;;;;;;OAUG;IACU,mBAAmB,CAAC,CAAC,SAAS,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,UAAU,GAAG,eAAe,CAAC,EAAE,OAAO,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAyDrN;;;;;;;;;;OAUG;IACU,cAAc,CAAC,CAAC,SAAS,YAAY,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,UAAU,GAAG,eAAe,CAAC,EAAE,OAAO,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;CAI5M"}

package/lib/cjs/Relationship.js

@@ -532,6 +532,84 @@ class Relationships {
         const relationshipProps = this.tryGetInstanceProps(relClassFullName, criteria);
         return undefined !== relationshipProps ? this._iModel.constructEntity(relationshipProps) : undefined;
     }
+    /** Get the props of multiple Relationship instances of the same class using batched queries.
+     * This produces the same results as calling [[tryGetInstanceProps]] for each entry in `criteria`, but executes at most two queries regardless of the number of entries.
+     * @param relClassFullName The full class name of the relationship in the form of "schema:class"
+     * @param criteria The relationships to look up. Each entry is either a relationship instanceId or the source and target Ids. Entries of both kinds may be mixed.
+     * @param options.usePrimaryConn If `true` (the default), the queries run on the primary connection so that unsaved changes are visible, matching [[tryGetInstanceProps]].
+     * If `false`, they run on a concurrent query connection, which does not see unsaved changes.
+     * @returns An array with the same length and order as `criteria`. Each entry holds the RelationshipProps matching the corresponding criterion, or `undefined` if no such relationship was found.
+     * @see tryGetInstanceProps
+     * @see queryInstances
+     * @beta
+     */
+    async queryInstancesProps(relClassFullName, criteria, options) {
+        const pairKey = (pair) => `${pair.sourceId}|${pair.targetId}`;
+        const ids = new Set();
+        const pairs = new Map();
+        for (const criterion of criteria) {
+            if (typeof criterion === "string") {
+                if (core_bentley_1.Id64.isValidId64(criterion))
+                    ids.add(criterion);
+            }
+            else if (core_bentley_1.Id64.isValidId64(criterion.sourceId) && core_bentley_1.Id64.isValidId64(criterion.targetId)) {
+                pairs.set(pairKey(criterion), [criterion.sourceId, criterion.targetId]);
+            }
+        }
+        // Each query joins the requested values (as an IdSet or json_each virtual table) to the relationship class. CROSS JOIN makes SQLite iterate
+        // the requested values and look up each one by index, so only the requested relationships are read, regardless of the size of the class.
+        const propsById = new Map();
+        const propsByPair = new Map();
+        const queries = [];
+        if (ids.size > 0) {
+            queries.push({
+                ecsql: `SELECT r.* FROM IdSet(?) p CROSS JOIN ${relClassFullName} r WHERE r.ECInstanceId = p.id`,
+                params: new core_common_1.QueryBinder().bindIdSet(1, ids),
+                onProps: (props) => propsById.set(props.id, props),
+            });
+        }
+        if (pairs.size > 0) {
+            // json_each yields the ids as hex strings; HexToId converts them to the integer ids stored in the table.
+            queries.push({
+                ecsql: `SELECT r.* FROM json1.json_each(?) p CROSS JOIN ${relClassFullName} r WHERE r.SourceECInstanceId = HexToId(json_extract(p.[value], '$[0]')) AND r.TargetECInstanceId = HexToId(json_extract(p.[value], '$[1]'))`,
+                params: new core_common_1.QueryBinder().bindString(1, JSON.stringify([...pairs.values()])),
+                onProps: (props) => {
+                    // A polymorphic query may find more than one relationship for the same pair; keep the first, like tryGetInstanceProps.
+                    const key = pairKey(props);
+                    if (!propsByPair.has(key))
+                        propsByPair.set(key, props);
+                },
+            });
+        }
+        if (queries.length > 0) {
+            // Convert rows the same way as tryGetInstanceProps, so that both produce identical props.
+            const ecClass = (0, ECSqlInstanceReshaper_1.getRuntimeClass)(this._iModel, relClassFullName);
+            const usePrimaryConn = options?.usePrimaryConn ?? true;
+            await Promise.all(queries.map(async (query) => {
+                for await (const row of this._iModel.createQueryReader(query.ecsql, query.params, { rowFormat: core_common_1.QueryRowFormat.UseECSqlPropertyNames, usePrimaryConn })) {
+                    const props = (0, ECSqlInstanceReshaper_1.reshapeInstanceRow)(row.toRow(), ecClass, this._iModel);
+                    props.classFullName = props.className.replace(".", ":");
+                    query.onProps(props);
+                }
+            }));
+        }
+        return criteria.map((criterion) => typeof criterion === "string" ? propsById.get(criterion) : propsByPair.get(pairKey(criterion)));
+    }
+    /** Get multiple Relationship instances of the same class using batched queries.
+     * This produces the same results as calling [[tryGetInstance]] for each entry in `criteria`, but executes at most two queries regardless of the number of entries.
+     * @param relClassFullName The full class name of the relationship in the form of "schema:class"
+     * @param criteria The relationships to look up. Each entry is either a relationship instanceId or the source and target Ids. Entries of both kinds may be mixed.
+     * @param options.usePrimaryConn If `true` (the default), the queries run on the primary connection so that unsaved changes are visible, matching [[tryGetInstance]].
+     * If `false`, they run on a concurrent query connection, which does not see unsaved changes.
+     * @returns An array with the same length and order as `criteria`. Each entry holds the relationship matching the corresponding criterion, or `undefined` if no such relationship was found.
+     * @see tryGetInstance
+     * @see queryInstancesProps
+     * @beta
+     */
+    async queryInstances(relClassFullName, criteria, options) {
+        const allProps = await this.queryInstancesProps(relClassFullName, criteria, options);
+        return allProps.map((props) => undefined !== props ? this._iModel.constructEntity(props) : undefined);
+    }
 }
 exports.Relationships = Relationships;
 //# sourceMappingURL=Relationship.js.map

package/lib/cjs/Relationship.js.map

@@ -1 +1 @@
-{"version":3,"file":"Relationship.js","sourceRoot":"","sources":["../../src/Relationship.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA+E;AAC/E,oDAAsI;AACtI,qCAAkC;AAClC,uCAAoC;AAEpC,gDAA6D;AAC7D,4EAAuF;AACvF,gEAA6D;AAgB7D;;GAEG;AACH,MAAa,YAAa,SAAQ,eAAM;IAC/B,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;IACzD,QAAQ,CAAa;IACrB,QAAQ,CAAa;IAErC,YAAsB,KAAwB,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAuB,CAAC;QAChD,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;OAEG;IACa,KAAK,CAAC,WAAW;QAC/B,IAAI,IAAI,CAAC,SAAS,IAAI,qCAAiB,CAAC,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5E,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,qCAAiB,CAAC,CAAC;QAC1G,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC;YAC9B,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,gBAAgB,CAAC,GAAoB;QACjD,4DAA4D;QAC5D,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,aAAa,CAAC,MAAyB,EAAE,OAAiB,IAAU,CAAC;IAEnF;;;;OAIG;IACI,MAAM,CAAC,sBAAsB,CAAC,GAAoB;QACvD,4DAA4D;QAC5D,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAAyB,EAAE,OAAiB,IAAU,CAAC;IAYlF,MAAM,CAAC,GAAa,IAAgB,OAAO,IAAI,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,sBAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAY5H,MAAM,CAAC,GAAa,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,sBAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAY/F,MAAM,CAAC,GAAa,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,sBAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAE/F,MAAM,CAAC,WAAW,CAAyB,MAAgB,EAAE,QAAsC,IAAO,OAAO,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CAC1L;AAhHD,oCAgHC;AAED;;GAEG;AACH,MAAa,uBAAwB,SAAQ,YAAY;IAChD,MAAM,KAAc,SAAS,KAAa,OAAO,yBAAyB,CAAC,CAAC,CAAC;IACpF;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAoC,MAAgB,EAAE,QAAoB,EAAE,QAAoB;QAClH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAM,CAAC;IAC7G,CAAC;IAkBM,MAAM,CAAC,MAAM,CAAC,WAA+B,EAAE,QAAoB,EAAE,QAAoB;QAC9F,MAAM,GAAG,GAAG,WAAW,YAAY,iBAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,sBAAY,CAAC,CAAC;QACrF,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACjE,OAAO,GAAG,CAAC,kBAAkB,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AAvCD,0DAuCC;AAED;;GAEG;AACH,MAAa,+BAAgC,SAAQ,uBAAuB;IACnE,MAAM,KAAc,SAAS,KAAa,OAAO,iCAAiC,CAAC,CAAC,CAAC;CAC7F;AAFD,0EAEC;AAED;;GAEG;AACH,MAAa,mCAAoC,SAAQ,uBAAuB;IACvE,MAAM,KAAc,SAAS,KAAa,OAAO,qCAAqC,CAAC,CAAC,CAAC;CACjG;AAFD,kFAEC;AAED;;;;GAIG;AACH,MAAa,qCAAsC,SAAQ,uBAAuB;IACzE,MAAM,KAAc,SAAS,KAAa,OAAO,uCAAuC,CAAC,CAAC,CAAC;CACnG;AAFD,sFAEC;AAED;;;GAGG;AACH,MAAa,yCAA0C,SAAQ,qCAAqC;IAC3F,MAAM,KAAc,SAAS,KAAa,OAAO,2CAA2C,CAAC,CAAC,CAAC;CACvG;AAFD,8FAEC;AASD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,uBAAuB;IACxD,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IAC1E,cAAc,CAAS;IAE9B,YAAY,KAAgC,EAAE,MAAgB;QAC5D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;IAC7C,CAAC;IAEM,MAAM,CAAU,MAAM,CAAoC,MAAgB,EAAE,QAAoB,EAAE,QAAoB,EAAE,iBAAyB,CAAC;QACvJ,MAAM,KAAK,GAA8B,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;QACnH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAM,CAAC;IACzD,CAAC;CACF;AAbD,oDAaC;AAED;;;GAGG;AACH,MAAa,gCAAiC,SAAQ,oBAAoB;IACjE,MAAM,KAAc,SAAS,KAAa,OAAO,kCAAkC,CAAC,CAAC,CAAC;CAC9F;AAFD,4EAEC;AAED;;;;GAIG;AACH,MAAa,qBAAsB,SAAQ,oBAAoB;IACtD,MAAM,KAAc,SAAS,KAAa,OAAO,uBAAuB,CAAC,CAAC,CAAC;CACnF;AAFD,sDAEC;AAED;;;GAGG;AACH,MAAa,gCAAiC,SAAQ,oBAAoB;IACjE,MAAM,KAAc,SAAS,KAAa,OAAO,kCAAkC,CAAC,CAAC,CAAC;CAC9F;AAFD,4EAEC;AAUD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuLG;AACH,MAAa,oBAAqB,SAAQ,YAAY;IAC7C,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IACjF;;;;OAIG;IACI,MAAM,CAAS;IACtB,uHAAuH;IAChH,QAAQ,CAAS;IAExB,YAAsB,KAAgC,EAAE,MAAgB;QACtE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;IACjC,CAAC;IAEM,MAAM,CAAC,MAAM,CAAiC,MAAgB,EAAE,QAAoB,EAAE,QAAoB,EAAE,WAAmB,CAAC;QACrI,MAAM,KAAK,GAA8B,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;QACxH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAM,CAAC;IACzD,CAAC;IAEe,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAA+B,CAAC;QAC1D,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,OAAO,KAAK,CAAC;IACf,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AAlCD,oDAkCC;AAED;;;;;GAKG;AACH,MAAa,2BAA4B,SAAQ,YAAY;IACpD,MAAM,KAAc,SAAS,KAAa,OAAO,6BAA6B,CAAC,CAAC,CAAC;IACrE,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;CACF;AAPD,kEAOC;AAED;;GAEG;AACH,MAAa,aAAa;IAChB,OAAO,CAAW;IAE1B,gBAAgB;IAChB,YAAmB,MAAgB,IAAI,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC;IAE/D;;;OAGG;IACI,cAAc,CAAC,KAAwB,IAAkB,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAe,KAAK,CAAC,CAAC,CAAC,CAAC;IAE3H,2EAA2E;IACnE,sBAAsB,CAAC,aAAqB;QAClD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAS,CAAC,CAAC,uBAAuB,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;YACtF,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,UAAU,aAAa,8HAA8H,CAAC,CAAC;QACzM,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,KAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,OAAO,CAAC,sBAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,OAAO,CAAC,sBAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,KAAuC;QAC5D,IAAI,CAAC,OAAO,CAAC,sBAAY,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAA8B,gBAAwB,EAAE,QAAsC;QACnH,MAAM,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAI,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAClF,IAAI,SAAS,KAAK,iBAAiB,EAAE,CAAC;YACpC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,wBAAwB,CAAC,CAAC;QACzE,CAAC;QACD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB,CAA8B,gBAAwB,EAAE,QAAsC;QACtH,qGAAqG;QACrG,iGAAiG;QACjG,sGAAsG;QACtG,4CAA4C;QAC5C,MAAM,OAAO,GAAG,IAAA,uCAAe,EAAC,IAAI,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAChE,IAAI,KAAoB,CAAC;QACzB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,iBAAiB,gBAAgB,uBAAuB,EAAE,CAAC,MAAM,EAAiB,EAAE;gBACvH,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAA,0CAAkB,EAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5G,CAAC,EAAE,IAAI,yBAAW,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,4BAAc,CAAC,qBAAqB,EAAE,CAAC,CAAC;QACjG,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,iBAAiB,gBAAgB,sDAAsD,EAAE,CAAC,MAAM,EAAiB,EAAE;gBACtJ,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAA,0CAAkB,EAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5G,CAAC,EAAE,IAAI,yBAAW,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,4BAAc,CAAC,qBAAqB,EAAE,CAAC,CAAC;QACvI,CAAC;QACD,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;YACxB,uGAAuG;YACvG,MAAM,aAAa,GAAG,KAAmC,CAAC;YAC1D,aAAa,CAAC,aAAa,GAAI,aAAa,CAAC,SAAoB,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACtF,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAyB,eAAuB,EAAE,QAAsC;QACxG,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAI,IAAI,CAAC,gBAAgB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAyB,gBAAwB,EAAE,QAAsC;QAC5G,MAAM,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAoB,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAClG,OAAO,SAAS,KAAK,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1G,CAAC;CACF;AAvHD,sCAuHC","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 Relationships\r\n */\r\n\r\nimport { DbResult, Id64, Id64String, IModelStatus } from \"@itwin/core-bentley\";\r\nimport { EntityReferenceSet, IModelError, QueryBinder, QueryRowFormat, RelationshipProps, SourceAndTarget } from \"@itwin/core-common\";\r\nimport { Entity } from \"./Entity\";\r\nimport { EditTxn } from \"./EditTxn\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { _implicitTxn, _nativeDb } from \"./internal/Symbols\";\r\nimport { getRuntimeClass, reshapeInstanceRow } from \"./internal/ECSqlInstanceReshaper\";\r\nimport { RelationshipClass } from \"@itwin/ecschema-metadata\";\r\n\r\nexport type { SourceAndTarget, RelationshipProps } from \"@itwin/core-common\"; // for backwards compatibility\r\n\r\n/** Argument for relationship dependency callbacks.\r\n * @beta\r\n */\r\nexport interface OnDependencyArg {\r\n  /** The iModel for the relationship affected by this method. */\r\n  iModel: IModelDb;\r\n  /** The ElementDrivesElement relationship instance affected by this method. */\r\n  props: RelationshipProps;\r\n  /** The transaction for indirect processing. */\r\n  indirectEditTxn: EditTxn;\r\n}\r\n\r\n/** Base class for all link table ECRelationships\r\n * @public\r\n */\r\nexport class Relationship extends Entity {\r\n  public static override get className(): string { return \"Relationship\"; }\r\n  public readonly sourceId: Id64String;\r\n  public readonly targetId: Id64String;\r\n\r\n  protected constructor(props: RelationshipProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.sourceId = Id64.fromJSON(props.sourceId);\r\n    this.targetId = Id64.fromJSON(props.targetId);\r\n  }\r\n\r\n  public override toJSON(): RelationshipProps {\r\n    const val = super.toJSON() as RelationshipProps;\r\n    val.sourceId = this.sourceId;\r\n    val.targetId = this.targetId;\r\n    return val;\r\n  }\r\n\r\n  /** Query metadata for this relationship class from the iModel's schema. Returns cached metadata if available.\r\n   * @deprecated in 5.10.0 - will not be removed until after 2027-06-03. Obtain a `SchemaView` via `iModel.getSchemaView()` and call `view.findClass(relationship.classFullName)` to retrieve a `SchemaView.Class`. The returned type differs from `RelationshipClass` and offers a synchronous, snapshot-style API.\r\n   */\r\n  public override async getMetaData(): Promise<RelationshipClass> {\r\n    if (this._metadata && RelationshipClass.isRelationshipClass(this._metadata)) {\r\n      return this._metadata;\r\n    }\r\n\r\n    const relationship = await this.iModel.schemaContext.getSchemaItem(this.schemaItemKey, RelationshipClass);\r\n    if (relationship !== undefined) {\r\n      this._metadata = relationship;\r\n      return this._metadata;\r\n    } else {\r\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when its input has changed or is the output of some upstream relationship whose input has changed.\r\n   * This callback is invoked after the input element has been processed by upstream relationships.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.\r\n   * @beta\r\n   */\r\n  public static onRootChangedArg(arg: OnDependencyArg): void {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.onRootChanged(arg.props, arg.iModel);\r\n  }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when its input has changed or is the output of some upstream relationship whose input has changed.\r\n   * This callback is invoked after the input element has been processed by upstream relationships.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.\r\n   * @param _props The ElementDrivesElement relationship instance.\r\n   * @param _iModel The iModel\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use onRootChangedArg instead.\r\n   */\r\n  public static onRootChanged(_props: RelationshipProps, _iModel: IModelDb): void { }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action.\r\n   * @beta\r\n   */\r\n  public static onDeletedDependencyArg(arg: OnDependencyArg): void {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.onDeletedDependency(arg.props, arg.iModel);\r\n  }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action.\r\n   * @param _props The deleted ElementDrivesElement relationship instance.\r\n   * @param _iModel The iModel\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use onDeletedDependencyArg instead.\r\n   */\r\n  public static onDeletedDependency(_props: RelationshipProps, _iModel: IModelDb): void { }\r\n\r\n  /**\r\n   * Insert this Relationship into the iModel using the supplied EditTxn.\r\n   * @beta\r\n   */\r\n  public insert(txn: EditTxn): Id64String;\r\n  /**\r\n   * Insert this Relationship into the iModel.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use Relationship.insert(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\r\n   */\r\n  public insert(): Id64String;\r\n  public insert(txn?: EditTxn): Id64String { return this.id = (txn ?? this.iModel[_implicitTxn]).insertRelationship(this.toJSON()); }\r\n\r\n  /**\r\n   * Update this Relationship in the iModel using the supplied EditTxn.\r\n   * @beta\r\n   */\r\n  public update(txn: EditTxn): void;\r\n  /**\r\n   * Update this Relationship in the iModel.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use Relationship.update(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\r\n   */\r\n  public update(): void;\r\n  public update(txn?: EditTxn) { (txn ?? this.iModel[_implicitTxn]).updateRelationship(this.toJSON()); }\r\n\r\n  /**\r\n   * Delete this Relationship from the iModel using the supplied EditTxn.\r\n   * @beta\r\n   */\r\n  public delete(txn: EditTxn): void;\r\n  /**\r\n   * Delete this Relationship from the iModel.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use Relationship.delete(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\r\n   */\r\n  public delete(): void;\r\n  public delete(txn?: EditTxn) { (txn ?? this.iModel[_implicitTxn]).deleteRelationship(this.toJSON()); }\r\n\r\n  public static getInstance<T extends Relationship>(iModel: IModelDb, criteria: Id64String | SourceAndTarget): T { return iModel.relationships.getInstance(this.classFullName, criteria); }\r\n}\r\n\r\n/** A Relationship where one Element refers to another Element\r\n * @public\r\n */\r\nexport class ElementRefersToElements extends Relationship {\r\n  public static override get className(): string { return \"ElementRefersToElements\"; }\r\n  /** Create an instance of the Relationship.\r\n   * @param iModel The iModel that will contain the relationship\r\n   * @param sourceId The sourceId of the relationship, that is, the driver element\r\n   * @param targetId The targetId of the relationship, that is, the driven element\r\n   * @return an instance of the specified class.\r\n   */\r\n  public static create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): T {\r\n    return iModel.relationships.createInstance({ sourceId, targetId, classFullName: this.classFullName }) as T;\r\n  }\r\n\r\n  /** Insert a new instance of the Relationship using an explicit transaction.\r\n   * @param txn The EditTxn used to perform the insert.\r\n   * @param sourceId The sourceId of the relationship, that is, the driver element\r\n   * @param targetId The targetId of the relationship, that is, the driven element\r\n   * @return The Id of the inserted Relationship.\r\n   * @beta\r\n   */\r\n  public static insert(txn: EditTxn, sourceId: Id64String, targetId: Id64String): Id64String;\r\n  /** Insert a new instance of the Relationship.\r\n   * @param iModel The iModel that will contain the relationship.\r\n   * @param sourceId The sourceId of the relationship, that is, the driver element.\r\n   * @param targetId The targetId of the relationship, that is, the driven element.\r\n   * @return The Id of the inserted Relationship.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use ElementRefersToElements.insert(txn, ...) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\r\n   */\r\n  public static insert(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): Id64String;\r\n  public static insert(txnOrIModel: EditTxn | IModelDb, sourceId: Id64String, targetId: Id64String): Id64String {\r\n    const txn = txnOrIModel instanceof EditTxn ? txnOrIModel : txnOrIModel[_implicitTxn];\r\n    const relationship = this.create(txn.iModel, sourceId, targetId);\r\n    return txn.insertRelationship(relationship.toJSON());\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addElement(this.targetId);\r\n  }\r\n}\r\n\r\n/** Relates a [[DrawingGraphic]] to the [[Element]] that it represents\r\n * @public\r\n */\r\nexport class DrawingGraphicRepresentsElement extends ElementRefersToElements {\r\n  public static override get className(): string { return \"DrawingGraphicRepresentsElement\"; }\r\n}\r\n\r\n/** Relates a [[GraphicalElement3d]] to the [[Element]] that it represents\r\n * @public\r\n */\r\nexport class GraphicalElement3dRepresentsElement extends ElementRefersToElements {\r\n  public static override get className(): string { return \"GraphicalElement3dRepresentsElement\"; }\r\n}\r\n\r\n/** Relates a [[SynchronizationConfigLink]] to N [[ExternalSource]] instances.\r\n * Each relationship instance represents an external source processed by the synchronization configuration.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class SynchronizationConfigProcessesSources extends ElementRefersToElements {\r\n  public static override get className(): string { return \"SynchronizationConfigProcessesSources\"; }\r\n}\r\n\r\n/** Relates a [[SynchronizationConfigLink]] to *root* [[ExternalSource]] instances.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class SynchronizationConfigSpecifiesRootSources extends SynchronizationConfigProcessesSources {\r\n  public static override get className(): string { return \"SynchronizationConfigSpecifiesRootSources\"; }\r\n}\r\n\r\n/** Properties that are common to all types of link table ECRelationships\r\n * @public\r\n */\r\nexport interface ElementGroupsMembersProps extends RelationshipProps {\r\n  memberPriority: number;\r\n}\r\n\r\n/** An ElementRefersToElements relationship where one Element *groups* a set of other Elements.\r\n * @public\r\n */\r\nexport class ElementGroupsMembers extends ElementRefersToElements {\r\n  public static override get className(): string { return \"ElementGroupsMembers\"; }\r\n  public memberPriority: number;\r\n\r\n  constructor(props: ElementGroupsMembersProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.memberPriority = props.memberPriority;\r\n  }\r\n\r\n  public static override create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String, memberPriority: number = 0): T {\r\n    const props: ElementGroupsMembersProps = { sourceId, targetId, memberPriority, classFullName: this.classFullName };\r\n    return iModel.relationships.createInstance(props) as T;\r\n  }\r\n}\r\n\r\n/** Relates a [[DefinitionGroup]] to its [[DefinitionElement]] members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.10\r\n * @public\r\n */\r\nexport class DefinitionGroupGroupsDefinitions extends ElementGroupsMembers {\r\n  public static override get className(): string { return \"DefinitionGroupGroupsDefinitions\"; }\r\n}\r\n\r\n/** Represents group membership where the group Element (and its properties) impart information about the member Elements above mere membership.\r\n * Implies that properties of the group should be considered as properties of its members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.11\r\n * @public\r\n */\r\nexport class GroupImpartsToMembers extends ElementGroupsMembers {\r\n  public static override get className(): string { return \"GroupImpartsToMembers\"; }\r\n}\r\n\r\n/** Relates an [[ExternalSourceGroup]] to its [[ExternalSource]] members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class ExternalSourceGroupGroupsSources extends ElementGroupsMembers {\r\n  public static override get className(): string { return \"ExternalSourceGroupGroupsSources\"; }\r\n}\r\n\r\n/** Properties that are common to all types of ElementDrivesElements\r\n * @beta\r\n */\r\nexport interface ElementDrivesElementProps extends RelationshipProps {\r\n  status: number;\r\n  priority: number;\r\n}\r\n\r\n/** A Relationship indicating that one Element *drives* another Element.\r\n * An ElementDrivesElement relationship defines a one-way \"driving\" relationship from the source to the target.\r\n * When the source of an ElementDrivesElement relationship changes, the ElementDrivesElement itself can get a callback, and both the source and target elements can get callbacks.\r\n * By inserting ElementDrivesElement relationships, an app can create and store an acyclic directed graph of dependencies between elements.\r\n *\r\n * # Defining dependencies\r\n * Create an ElementDrivesElement relationship to specify that the source element drives the target element.\r\n * For example, to specify that element e1 drives element e2, create a relationship between them like this:\r\n * ```ts\r\n *  const ede = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  ede.insert();\r\n * ```\r\n * This creates a persistent relationship. The fact that e1 drives e2 is persisted in the iModel.\r\n *\r\n * # Defining dependency graphs\r\n * When you create multiple ElementDrivesElement relationships, you create a network of dependencies. The target of one may be the source of another.\r\n * A change in the content of an DgnElement can therefore trigger changes to many downstream elements.\r\n *\r\n * For example, to make element e1 drive element e2 and e2 drive another element, e3, create two relationships like this:\r\n * ```ts\r\n *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);\r\n *  ede12.insert();\r\n *  ede23.insert();\r\n * ```\r\n * Those two relationships create this graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n * Where the \"-->\" is meant to represent a driving relationship.\r\n *\r\n * The order in which you create the relationships does not matter.\r\n * The graph indicates that e3 depends on e2 and e2 depends on e1.\r\n *\r\n * An ElementDrivesElement relationship is between one source element and one target element.\r\n * Many ElementDrivesElement relationships can point to a given element, and many can point out of it.\r\n * Thus, you can define many:many relationships.\r\n * For example:\r\n * ```ts\r\n *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  const ede112 = ElementDrivesElement.create(iModel, e11id, e2id);\r\n *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);\r\n *  const ede231 = ElementDrivesElement.create(iModel, e2id, e31id);\r\n *  ede12.insert();\r\n *  ede112.insert();\r\n *  ede23.insert();\r\n *  ede231.insert();\r\n * ```\r\n * Creates this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * e2 depends on both e1 and e11. e2 then drives e3 and e31.\r\n *\r\n * In an ElementDrivesElement dependency graph, the relationships are the \"edges\" and the Elements are the \"nodes\".\r\n * The following terms are used when referring to the elements (nodes) in a dependency graph:\r\n * * Inputs - The sources of all edges that point to the element. This includes all upstream elements that flow into the element.\r\n * * Outputs - The targets of all edges that point out of the element. This includes all downstream elements.\r\n *\r\n * # Subgraph Processing\r\n * When changes are made, only the part of the overall graph that is affected will be processed. So, for example,\r\n * suppose we have this graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n * If e1 changes, then the subgraph to be processed is equal to the full graph, as shown.\r\n *\r\n * If only e2 changes, then the subgraph to be processed is just:\r\n * ```\r\n *       e2 --> e3\r\n * ```\r\n * If only e3 changes, then the subgraph consists of e3 by itself.\r\n *\r\n * Returning to the second example above, suppose we have this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * If e1 is changed, the affected subgraph is:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * If e2 is changed, the affected subgraph is:\r\n * ```\r\n *           e3\r\n *         /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * # Callbacks\r\n * Once the affected subgraph to process is found, it propagates changes through it by making callbacks.\r\n * Classes for both elements (nodes) and ElementDrivesElements relationships (edges) can receive callbacks.\r\n *\r\n * ## ElementDrivesElement Callbacks\r\n * The following callbacks are invoked on ElementDrivesElement relationship classes (edges):\r\n * * onRootChanged\r\n * * onDeletedDependency\r\n *\r\n * Note that these are static methods. Their default implementations do nothing.\r\n * To receive and act on these callbacks, a domain should define a subclass of ElementDrivesElement and use that to create relationships.\r\n * The subclass should then implement the callbacks that it would like to act on.\r\n *\r\n * A ElementDrivesElement subclass callback is expected to make changes to the output element only!\r\n *\r\n * ## Element Callbacks\r\n * The following callbacks are invoked on Element classes (nodes):\r\n * * Element.onBeforeOutputsHandled\r\n * * Element.onAllInputsHandled\r\n *\r\n * ## Order\r\n * Callbacks are invoked by BriefcaseDb.saveChanges.\r\n * They are invoked in dependency (topological) order: driving elements first, then driven elements.\r\n *\r\n * Each callback is invoked only once. No matter how many times a given element was changed during the transaction,\r\n * a callback such as ElementDrivesElement.onRootChanged will be invoked only once.\r\n * In the same way, no matter how many of its inputs were changed, a callback such as Element.onAllInputsHandled will be\r\n * invoked only once.\r\n *\r\n * For example, suppose we have a graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n *\r\n * Suppose that e1 is directly modified. No callbacks are made at that time.\r\n * Later, when BriefcaseDb.saveChanges is called, the following callbacks are made, in order:\r\n * 1. Element.onBeforeOutputsHandled e1\r\n * 1. ElementDrivesElement.onRootChanged e1->e2\r\n * 1. Element.onAllInputsHandled e2\r\n * 1. ElementDrivesElement.onRootChanged e2->e3\r\n * 1. Element.onAllInputsHandled e3\r\n *\r\n * Suppose that e3 is modified directly and BriefcaseDb.saveChanges is called.\r\n * Since no input to a relationship was changed, the sub-graph will be empty, and no callbacks will be made.\r\n *\r\n * Returning to the second example above, suppose we have this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * If e1 is changed and BriefcaseDb.saveChanges is called, the subgraph is:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * The callbacks are:\r\n * 1. Element.onBeforeOutputsHandled e1\r\n * 1. ElementDrivesElement.onRootChanged e1->e2\r\n * 1. Element.onAllInputsHandled e2\r\n * 1. ElementDrivesElement.onRootChanged e2->e3\r\n * 1. Element.onAllInputsHandled e3\r\n * 1. ElementDrivesElement.onRootChanged e2->e31\r\n * 1. Element.onAllInputsHandled e31\r\n *\r\n * (The ElementDrivesElement.)\r\n *\r\n * #Errors\r\n * Circular dependencies are not permitted. If a cycle is detected, that is treated as a fatal error. All ElementDrivesElement relationships\r\n * involved in a cycle will have their status set to 1, indicating a failure.\r\n *\r\n * A callback may call txnManager.reportError to reject an invalid change. It can classify the error as fatal or just a warning.\r\n * A callback make set the status value of an ElementDrivesElement instance to 1 to indicate a processing failure in that edge.\r\n *\r\n * After BriefcaseDb.saveChanges is called, an app should check db.txns.validationErrors and db.txns.hasFatalError to find out if graph-evaluation failed.\r\n *\r\n * @beta\r\n */\r\nexport class ElementDrivesElement extends Relationship {\r\n  public static override get className(): string { return \"ElementDrivesElement\"; }\r\n  /** Relationship status\r\n   * * 0 indicates no errors. Set after a successful evaluation.\r\n   * * 1 indicates that this driving relationship could not be evaluated. The callback itself can set this to indicate that it failed to process the input changes. Also, it is set if the relationship is part of a circular dependency.\r\n   * * 0x80 The app or callback can set this to indicate to not propagate changes through this relationship.\r\n   */\r\n  public status: number;\r\n  /** Affects the order in which relationships are processed in the case where two relationships have the same output. */\r\n  public priority: number;\r\n\r\n  protected constructor(props: ElementDrivesElementProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.status = props.status;\r\n    this.priority = props.priority;\r\n  }\r\n\r\n  public static create<T extends ElementDrivesElement>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String, priority: number = 0): T {\r\n    const props: ElementDrivesElementProps = { sourceId, targetId, priority, status: 0, classFullName: this.classFullName };\r\n    return iModel.relationships.createInstance(props) as T;\r\n  }\r\n\r\n  public override toJSON(): ElementDrivesElementProps {\r\n    const props = super.toJSON() as ElementDrivesElementProps;\r\n    props.status = this.status;\r\n    props.priority = this.priority;\r\n    return props;\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addElement(this.targetId);\r\n  }\r\n}\r\n\r\n/** The third (and last) possible link-table relationship base class in an iModel.\r\n * Has no external use, but is included for completeness of the [Entity.collectReferenceIds]($backend)\r\n * implementations for link-table relationships. Generating the types of the source and target automatically would require\r\n * coupling this package with ecschema-metadata which we do not want to do.\r\n * @internal\r\n */\r\nexport class ModelSelectorRefersToModels extends Relationship {\r\n  public static override get className(): string { return \"ModelSelectorRefersToModels\"; }\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addModel(this.targetId);\r\n  }\r\n}\r\n\r\n/** Manages [[Relationship]]s.\r\n * @public\r\n */\r\nexport class Relationships {\r\n  private _iModel: IModelDb;\r\n\r\n  /** @internal */\r\n  public constructor(iModel: IModelDb) { this._iModel = iModel; }\r\n\r\n  /** Create a new instance of a Relationship.\r\n   * @param props The properties of the new Relationship.\r\n   * @throws [[IModelError]] if there is a problem creating the Relationship.\r\n   */\r\n  public createInstance(props: RelationshipProps): Relationship { return this._iModel.constructEntity<Relationship>(props); }\r\n\r\n  /** Check classFullName to ensure it is a link table relationship class. */\r\n  private checkRelationshipClass(classFullName: string) {\r\n    if (!this._iModel[_nativeDb].isLinkTableRelationship(classFullName.replace(\".\", \":\"))) {\r\n      throw new IModelError(DbResult.BE_SQLITE_ERROR, `Class '${classFullName}' must be a relationship class and it should be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.`);\r\n    }\r\n  }\r\n\r\n  /** Insert a new relationship instance into the iModel. The relationship provided must be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.\r\n   * @param props The properties of the new relationship.\r\n   * @returns The Id of the newly inserted relationship.\r\n   * @note The id property of the props object is set as a side effect of this function.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.insertRelationship instead.\r\n   */\r\n  public insertInstance(props: RelationshipProps): Id64String {\r\n    return this._iModel[_implicitTxn].insertRelationship(props);\r\n  }\r\n\r\n  /** Update the properties of an existing relationship instance in the iModel.\r\n   * @param props the properties of the relationship instance to update. Any properties that are not present will be left unchanged.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.updateRelationship instead.\r\n   */\r\n  public updateInstance(props: RelationshipProps): void {\r\n    this._iModel[_implicitTxn].updateRelationship(props);\r\n  }\r\n\r\n  /** Delete an Relationship instance from this iModel.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.deleteRelationship instead.\r\n   */\r\n  public deleteInstance(props: RelationshipProps): void {\r\n    this._iModel[_implicitTxn].deleteRelationship(props);\r\n  }\r\n\r\n  /** Delete multiple Relationship instances from this iModel.\r\n   * @param props The properties of the relationship instances to delete.\r\n   * @remarks This method handles bulk deletion of relationships and supports mixed collections containing instances from different relationship classes.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.deleteRelationships instead.\r\n   */\r\n  public deleteInstances(props: ReadonlyArray<RelationshipProps>): void {\r\n    this._iModel[_implicitTxn].deleteRelationships(props);\r\n  }\r\n\r\n  /** Get the props of a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.\r\n   * @see tryGetInstanceProps\r\n   */\r\n  public getInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T {\r\n    const relationshipProps = this.tryGetInstanceProps<T>(relClassFullName, criteria);\r\n    if (undefined === relationshipProps) {\r\n      throw new IModelError(IModelStatus.NotFound, \"Relationship not found\");\r\n    }\r\n    return relationshipProps;\r\n  }\r\n\r\n  /** Get the props of a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @returns The RelationshipProps or `undefined` if the relationship is not found.\r\n   * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.\r\n   * @see getInstanceProps\r\n   */\r\n  public tryGetInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T | undefined {\r\n    // `SELECT *` targets a caller-supplied relationship class, so its shape can't be decomposed ahead of\r\n    // time. Query using the non-deprecated UseECSqlPropertyNames format and reshape the row into the\r\n    // legacy UseJsPropertyNames shape using ECSchema metadata (see ECSqlInstanceReshaper for why a naive,\r\n    // non-schema-aware rename isn't safe here).\r\n    const ecClass = getRuntimeClass(this._iModel, relClassFullName);\r\n    let props: T | undefined;\r\n    if (typeof criteria === \"string\") {\r\n      props = this._iModel.withQueryReader(`SELECT * FROM ${relClassFullName} WHERE ecinstanceid=?`, (reader): T | undefined => {\r\n        return reader.step() ? reshapeInstanceRow(reader.current.toRow(), ecClass, this._iModel) as T : undefined;\r\n      }, new QueryBinder().bindId(1, criteria), { rowFormat: QueryRowFormat.UseECSqlPropertyNames });\r\n    } else {\r\n      props = this._iModel.withQueryReader(`SELECT * FROM ${relClassFullName} WHERE SourceECInstanceId=? AND TargetECInstanceId=?`, (reader): T | undefined => {\r\n        return reader.step() ? reshapeInstanceRow(reader.current.toRow(), ecClass, this._iModel) as T : undefined;\r\n      }, new QueryBinder().bindId(1, criteria.sourceId).bindId(2, criteria.targetId), { rowFormat: QueryRowFormat.UseECSqlPropertyNames });\r\n    }\r\n    if (undefined !== props) {\r\n      // convert `className` (from `SELECT *`'s ECClassId) into `classFullName`, as required by `EntityProps`\r\n      const reshapedProps = props as T & { className?: string };\r\n      reshapedProps.classFullName = (reshapedProps.className as string).replace(\".\", \":\");\r\n    }\r\n    return props;\r\n  }\r\n\r\n  /** Get a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.\r\n   * @see tryGetInstance\r\n   */\r\n  public getInstance<T extends Relationship>(relClassSqlName: string, criteria: Id64String | SourceAndTarget): T {\r\n    return this._iModel.constructEntity<T>(this.getInstanceProps(relClassSqlName, criteria));\r\n  }\r\n\r\n  /** Get a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @returns The relationship or `undefined` if the relationship is not found.\r\n   * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.\r\n   * @see getInstance\r\n   */\r\n  public tryGetInstance<T extends Relationship>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T | undefined {\r\n    const relationshipProps = this.tryGetInstanceProps<RelationshipProps>(relClassFullName, criteria);\r\n    return undefined !== relationshipProps ? this._iModel.constructEntity<T>(relationshipProps) : undefined;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Relationship.js","sourceRoot":"","sources":["../../src/Relationship.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA+E;AAC/E,oDAAsI;AACtI,qCAAkC;AAClC,uCAAoC;AAEpC,gDAA6D;AAC7D,4EAAuF;AACvF,gEAA6D;AAgB7D;;GAEG;AACH,MAAa,YAAa,SAAQ,eAAM;IAC/B,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;IACzD,QAAQ,CAAa;IACrB,QAAQ,CAAa;IAErC,YAAsB,KAAwB,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAuB,CAAC;QAChD,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;OAEG;IACa,KAAK,CAAC,WAAW;QAC/B,IAAI,IAAI,CAAC,SAAS,IAAI,qCAAiB,CAAC,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5E,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,qCAAiB,CAAC,CAAC;QAC1G,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC;YAC9B,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,gBAAgB,CAAC,GAAoB;QACjD,4DAA4D;QAC5D,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,aAAa,CAAC,MAAyB,EAAE,OAAiB,IAAU,CAAC;IAEnF;;;;OAIG;IACI,MAAM,CAAC,sBAAsB,CAAC,GAAoB;QACvD,4DAA4D;QAC5D,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAAyB,EAAE,OAAiB,IAAU,CAAC;IAYlF,MAAM,CAAC,GAAa,IAAgB,OAAO,IAAI,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,sBAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAY5H,MAAM,CAAC,GAAa,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,sBAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAY/F,MAAM,CAAC,GAAa,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,sBAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAE/F,MAAM,CAAC,WAAW,CAAyB,MAAgB,EAAE,QAAsC,IAAO,OAAO,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CAC1L;AAhHD,oCAgHC;AAED;;GAEG;AACH,MAAa,uBAAwB,SAAQ,YAAY;IAChD,MAAM,KAAc,SAAS,KAAa,OAAO,yBAAyB,CAAC,CAAC,CAAC;IACpF;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAoC,MAAgB,EAAE,QAAoB,EAAE,QAAoB;QAClH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAM,CAAC;IAC7G,CAAC;IAkBM,MAAM,CAAC,MAAM,CAAC,WAA+B,EAAE,QAAoB,EAAE,QAAoB;QAC9F,MAAM,GAAG,GAAG,WAAW,YAAY,iBAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,sBAAY,CAAC,CAAC;QACrF,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACjE,OAAO,GAAG,CAAC,kBAAkB,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AAvCD,0DAuCC;AAED;;GAEG;AACH,MAAa,+BAAgC,SAAQ,uBAAuB;IACnE,MAAM,KAAc,SAAS,KAAa,OAAO,iCAAiC,CAAC,CAAC,CAAC;CAC7F;AAFD,0EAEC;AAED;;GAEG;AACH,MAAa,mCAAoC,SAAQ,uBAAuB;IACvE,MAAM,KAAc,SAAS,KAAa,OAAO,qCAAqC,CAAC,CAAC,CAAC;CACjG;AAFD,kFAEC;AAED;;;;GAIG;AACH,MAAa,qCAAsC,SAAQ,uBAAuB;IACzE,MAAM,KAAc,SAAS,KAAa,OAAO,uCAAuC,CAAC,CAAC,CAAC;CACnG;AAFD,sFAEC;AAED;;;GAGG;AACH,MAAa,yCAA0C,SAAQ,qCAAqC;IAC3F,MAAM,KAAc,SAAS,KAAa,OAAO,2CAA2C,CAAC,CAAC,CAAC;CACvG;AAFD,8FAEC;AASD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,uBAAuB;IACxD,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IAC1E,cAAc,CAAS;IAE9B,YAAY,KAAgC,EAAE,MAAgB;QAC5D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;IAC7C,CAAC;IAEM,MAAM,CAAU,MAAM,CAAoC,MAAgB,EAAE,QAAoB,EAAE,QAAoB,EAAE,iBAAyB,CAAC;QACvJ,MAAM,KAAK,GAA8B,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;QACnH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAM,CAAC;IACzD,CAAC;CACF;AAbD,oDAaC;AAED;;;GAGG;AACH,MAAa,gCAAiC,SAAQ,oBAAoB;IACjE,MAAM,KAAc,SAAS,KAAa,OAAO,kCAAkC,CAAC,CAAC,CAAC;CAC9F;AAFD,4EAEC;AAED;;;;GAIG;AACH,MAAa,qBAAsB,SAAQ,oBAAoB;IACtD,MAAM,KAAc,SAAS,KAAa,OAAO,uBAAuB,CAAC,CAAC,CAAC;CACnF;AAFD,sDAEC;AAED;;;GAGG;AACH,MAAa,gCAAiC,SAAQ,oBAAoB;IACjE,MAAM,KAAc,SAAS,KAAa,OAAO,kCAAkC,CAAC,CAAC,CAAC;CAC9F;AAFD,4EAEC;AAUD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuLG;AACH,MAAa,oBAAqB,SAAQ,YAAY;IAC7C,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IACjF;;;;OAIG;IACI,MAAM,CAAS;IACtB,uHAAuH;IAChH,QAAQ,CAAS;IAExB,YAAsB,KAAgC,EAAE,MAAgB;QACtE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;IACjC,CAAC;IAEM,MAAM,CAAC,MAAM,CAAiC,MAAgB,EAAE,QAAoB,EAAE,QAAoB,EAAE,WAAmB,CAAC;QACrI,MAAM,KAAK,GAA8B,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;QACxH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAM,CAAC;IACzD,CAAC;IAEe,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAA+B,CAAC;QAC1D,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,OAAO,KAAK,CAAC;IACf,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AAlCD,oDAkCC;AAED;;;;;GAKG;AACH,MAAa,2BAA4B,SAAQ,YAAY;IACpD,MAAM,KAAc,SAAS,KAAa,OAAO,6BAA6B,CAAC,CAAC,CAAC;IACrE,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;CACF;AAPD,kEAOC;AAED;;GAEG;AACH,MAAa,aAAa;IAChB,OAAO,CAAW;IAE1B,gBAAgB;IAChB,YAAmB,MAAgB,IAAI,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC;IAE/D;;;OAGG;IACI,cAAc,CAAC,KAAwB,IAAkB,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAe,KAAK,CAAC,CAAC,CAAC,CAAC;IAE3H,2EAA2E;IACnE,sBAAsB,CAAC,aAAqB;QAClD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAS,CAAC,CAAC,uBAAuB,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;YACtF,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,UAAU,aAAa,8HAA8H,CAAC,CAAC;QACzM,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,KAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,OAAO,CAAC,sBAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,OAAO,CAAC,sBAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,KAAuC;QAC5D,IAAI,CAAC,OAAO,CAAC,sBAAY,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAA8B,gBAAwB,EAAE,QAAsC;QACnH,MAAM,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAI,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAClF,IAAI,SAAS,KAAK,iBAAiB,EAAE,CAAC;YACpC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,wBAAwB,CAAC,CAAC;QACzE,CAAC;QACD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB,CAA8B,gBAAwB,EAAE,QAAsC;QACtH,qGAAqG;QACrG,iGAAiG;QACjG,sGAAsG;QACtG,4CAA4C;QAC5C,MAAM,OAAO,GAAG,IAAA,uCAAe,EAAC,IAAI,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAChE,IAAI,KAAoB,CAAC;QACzB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,iBAAiB,gBAAgB,uBAAuB,EAAE,CAAC,MAAM,EAAiB,EAAE;gBACvH,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAA,0CAAkB,EAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5G,CAAC,EAAE,IAAI,yBAAW,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,4BAAc,CAAC,qBAAqB,EAAE,CAAC,CAAC;QACjG,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,iBAAiB,gBAAgB,sDAAsD,EAAE,CAAC,MAAM,EAAiB,EAAE;gBACtJ,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAA,0CAAkB,EAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5G,CAAC,EAAE,IAAI,yBAAW,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,4BAAc,CAAC,qBAAqB,EAAE,CAAC,CAAC;QACvI,CAAC;QACD,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;YACxB,uGAAuG;YACvG,MAAM,aAAa,GAAG,KAAmC,CAAC;YAC1D,aAAa,CAAC,aAAa,GAAI,aAAa,CAAC,SAAoB,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACtF,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAyB,eAAuB,EAAE,QAAsC;QACxG,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAI,IAAI,CAAC,gBAAgB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAyB,gBAAwB,EAAE,QAAsC;QAC5G,MAAM,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAoB,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAClG,OAAO,SAAS,KAAK,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,mBAAmB,CAA8B,gBAAwB,EAAE,QAAqD,EAAE,OAAsC;QACnL,MAAM,OAAO,GAAG,CAAC,IAAqB,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAE/E,MAAM,GAAG,GAAG,IAAI,GAAG,EAAc,CAAC;QAClC,MAAM,KAAK,GAAG,IAAI,GAAG,EAAoC,CAAC;QAC1D,KAAK,MAAM,SAAS,IAAI,QAAQ,EAAE,CAAC;YACjC,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;gBAClC,IAAI,mBAAI,CAAC,WAAW,CAAC,SAAS,CAAC;oBAC7B,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACvB,CAAC;iBAAM,IAAI,mBAAI,CAAC,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,mBAAI,CAAC,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACxF,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC1E,CAAC;QACH,CAAC;QAED,4IAA4I;QAC5I,yIAAyI;QACzI,MAAM,SAAS,GAAG,IAAI,GAAG,EAAiB,CAAC;QAC3C,MAAM,WAAW,GAAG,IAAI,GAAG,EAAa,CAAC;QACzC,MAAM,OAAO,GAA+E,EAAE,CAAC;QAC/F,IAAI,GAAG,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YACjB,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,yCAAyC,gBAAgB,gCAAgC;gBAChG,MAAM,EAAE,IAAI,yBAAW,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC;gBAC3C,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,EAAgB,EAAE,KAAK,CAAC;aACjE,CAAC,CAAC;QACL,CAAC;QAED,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YACnB,yGAAyG;YACzG,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,mDAAmD,gBAAgB,8IAA8I;gBACxN,MAAM,EAAE,IAAI,yBAAW,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;gBAC5E,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;oBACjB,uHAAuH;oBACvH,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;oBAC3B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC;wBACvB,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAChC,CAAC;aACF,CAAC,CAAC;QACL,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,0FAA0F;YAC1F,MAAM,OAAO,GAAG,IAAA,uCAAe,EAAC,IAAI,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;YAChE,MAAM,cAAc,GAAG,OAAO,EAAE,cAAc,IAAI,IAAI,CAAC;YACvD,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;gBAC5C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,4BAAc,CAAC,qBAAqB,EAAE,cAAc,EAAE,CAAC,EAAE,CAAC;oBACvJ,MAAM,KAAK,GAAG,IAAA,0CAAkB,EAAC,GAAG,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAA8B,CAAC;oBAClG,KAAK,CAAC,aAAa,GAAG,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;oBACxD,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC,CAAC,CAAC,CAAC;QACN,CAAC;QAED,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACrI,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,cAAc,CAAyB,gBAAwB,EAAE,QAAqD,EAAE,OAAsC;QACzK,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAoB,gBAAgB,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACxG,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAI,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC3G,CAAC;CACF;AA3MD,sCA2MC","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 Relationships\r\n */\r\n\r\nimport { DbResult, Id64, Id64String, IModelStatus } from \"@itwin/core-bentley\";\r\nimport { EntityReferenceSet, IModelError, QueryBinder, QueryRowFormat, RelationshipProps, SourceAndTarget } from \"@itwin/core-common\";\r\nimport { Entity } from \"./Entity\";\r\nimport { EditTxn } from \"./EditTxn\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { _implicitTxn, _nativeDb } from \"./internal/Symbols\";\r\nimport { getRuntimeClass, reshapeInstanceRow } from \"./internal/ECSqlInstanceReshaper\";\r\nimport { RelationshipClass } from \"@itwin/ecschema-metadata\";\r\n\r\nexport type { SourceAndTarget, RelationshipProps } from \"@itwin/core-common\"; // for backwards compatibility\r\n\r\n/** Argument for relationship dependency callbacks.\r\n * @beta\r\n */\r\nexport interface OnDependencyArg {\r\n  /** The iModel for the relationship affected by this method. */\r\n  iModel: IModelDb;\r\n  /** The ElementDrivesElement relationship instance affected by this method. */\r\n  props: RelationshipProps;\r\n  /** The transaction for indirect processing. */\r\n  indirectEditTxn: EditTxn;\r\n}\r\n\r\n/** Base class for all link table ECRelationships\r\n * @public\r\n */\r\nexport class Relationship extends Entity {\r\n  public static override get className(): string { return \"Relationship\"; }\r\n  public readonly sourceId: Id64String;\r\n  public readonly targetId: Id64String;\r\n\r\n  protected constructor(props: RelationshipProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.sourceId = Id64.fromJSON(props.sourceId);\r\n    this.targetId = Id64.fromJSON(props.targetId);\r\n  }\r\n\r\n  public override toJSON(): RelationshipProps {\r\n    const val = super.toJSON() as RelationshipProps;\r\n    val.sourceId = this.sourceId;\r\n    val.targetId = this.targetId;\r\n    return val;\r\n  }\r\n\r\n  /** Query metadata for this relationship class from the iModel's schema. Returns cached metadata if available.\r\n   * @deprecated in 5.10.0 - will not be removed until after 2027-06-03. Obtain a `SchemaView` via `iModel.getSchemaView()` and call `view.findClass(relationship.classFullName)` to retrieve a `SchemaView.Class`. The returned type differs from `RelationshipClass` and offers a synchronous, snapshot-style API.\r\n   */\r\n  public override async getMetaData(): Promise<RelationshipClass> {\r\n    if (this._metadata && RelationshipClass.isRelationshipClass(this._metadata)) {\r\n      return this._metadata;\r\n    }\r\n\r\n    const relationship = await this.iModel.schemaContext.getSchemaItem(this.schemaItemKey, RelationshipClass);\r\n    if (relationship !== undefined) {\r\n      this._metadata = relationship;\r\n      return this._metadata;\r\n    } else {\r\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when its input has changed or is the output of some upstream relationship whose input has changed.\r\n   * This callback is invoked after the input element has been processed by upstream relationships.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.\r\n   * @beta\r\n   */\r\n  public static onRootChangedArg(arg: OnDependencyArg): void {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.onRootChanged(arg.props, arg.iModel);\r\n  }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when its input has changed or is the output of some upstream relationship whose input has changed.\r\n   * This callback is invoked after the input element has been processed by upstream relationships.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.\r\n   * @param _props The ElementDrivesElement relationship instance.\r\n   * @param _iModel The iModel\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use onRootChangedArg instead.\r\n   */\r\n  public static onRootChanged(_props: RelationshipProps, _iModel: IModelDb): void { }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action.\r\n   * @beta\r\n   */\r\n  public static onDeletedDependencyArg(arg: OnDependencyArg): void {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.onDeletedDependency(arg.props, arg.iModel);\r\n  }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action.\r\n   * @param _props The deleted ElementDrivesElement relationship instance.\r\n   * @param _iModel The iModel\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use onDeletedDependencyArg instead.\r\n   */\r\n  public static onDeletedDependency(_props: RelationshipProps, _iModel: IModelDb): void { }\r\n\r\n  /**\r\n   * Insert this Relationship into the iModel using the supplied EditTxn.\r\n   * @beta\r\n   */\r\n  public insert(txn: EditTxn): Id64String;\r\n  /**\r\n   * Insert this Relationship into the iModel.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use Relationship.insert(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\r\n   */\r\n  public insert(): Id64String;\r\n  public insert(txn?: EditTxn): Id64String { return this.id = (txn ?? this.iModel[_implicitTxn]).insertRelationship(this.toJSON()); }\r\n\r\n  /**\r\n   * Update this Relationship in the iModel using the supplied EditTxn.\r\n   * @beta\r\n   */\r\n  public update(txn: EditTxn): void;\r\n  /**\r\n   * Update this Relationship in the iModel.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use Relationship.update(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\r\n   */\r\n  public update(): void;\r\n  public update(txn?: EditTxn) { (txn ?? this.iModel[_implicitTxn]).updateRelationship(this.toJSON()); }\r\n\r\n  /**\r\n   * Delete this Relationship from the iModel using the supplied EditTxn.\r\n   * @beta\r\n   */\r\n  public delete(txn: EditTxn): void;\r\n  /**\r\n   * Delete this Relationship from the iModel.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use Relationship.delete(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\r\n   */\r\n  public delete(): void;\r\n  public delete(txn?: EditTxn) { (txn ?? this.iModel[_implicitTxn]).deleteRelationship(this.toJSON()); }\r\n\r\n  public static getInstance<T extends Relationship>(iModel: IModelDb, criteria: Id64String | SourceAndTarget): T { return iModel.relationships.getInstance(this.classFullName, criteria); }\r\n}\r\n\r\n/** A Relationship where one Element refers to another Element\r\n * @public\r\n */\r\nexport class ElementRefersToElements extends Relationship {\r\n  public static override get className(): string { return \"ElementRefersToElements\"; }\r\n  /** Create an instance of the Relationship.\r\n   * @param iModel The iModel that will contain the relationship\r\n   * @param sourceId The sourceId of the relationship, that is, the driver element\r\n   * @param targetId The targetId of the relationship, that is, the driven element\r\n   * @return an instance of the specified class.\r\n   */\r\n  public static create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): T {\r\n    return iModel.relationships.createInstance({ sourceId, targetId, classFullName: this.classFullName }) as T;\r\n  }\r\n\r\n  /** Insert a new instance of the Relationship using an explicit transaction.\r\n   * @param txn The EditTxn used to perform the insert.\r\n   * @param sourceId The sourceId of the relationship, that is, the driver element\r\n   * @param targetId The targetId of the relationship, that is, the driven element\r\n   * @return The Id of the inserted Relationship.\r\n   * @beta\r\n   */\r\n  public static insert(txn: EditTxn, sourceId: Id64String, targetId: Id64String): Id64String;\r\n  /** Insert a new instance of the Relationship.\r\n   * @param iModel The iModel that will contain the relationship.\r\n   * @param sourceId The sourceId of the relationship, that is, the driver element.\r\n   * @param targetId The targetId of the relationship, that is, the driven element.\r\n   * @return The Id of the inserted Relationship.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use ElementRefersToElements.insert(txn, ...) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\r\n   */\r\n  public static insert(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): Id64String;\r\n  public static insert(txnOrIModel: EditTxn | IModelDb, sourceId: Id64String, targetId: Id64String): Id64String {\r\n    const txn = txnOrIModel instanceof EditTxn ? txnOrIModel : txnOrIModel[_implicitTxn];\r\n    const relationship = this.create(txn.iModel, sourceId, targetId);\r\n    return txn.insertRelationship(relationship.toJSON());\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addElement(this.targetId);\r\n  }\r\n}\r\n\r\n/** Relates a [[DrawingGraphic]] to the [[Element]] that it represents\r\n * @public\r\n */\r\nexport class DrawingGraphicRepresentsElement extends ElementRefersToElements {\r\n  public static override get className(): string { return \"DrawingGraphicRepresentsElement\"; }\r\n}\r\n\r\n/** Relates a [[GraphicalElement3d]] to the [[Element]] that it represents\r\n * @public\r\n */\r\nexport class GraphicalElement3dRepresentsElement extends ElementRefersToElements {\r\n  public static override get className(): string { return \"GraphicalElement3dRepresentsElement\"; }\r\n}\r\n\r\n/** Relates a [[SynchronizationConfigLink]] to N [[ExternalSource]] instances.\r\n * Each relationship instance represents an external source processed by the synchronization configuration.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class SynchronizationConfigProcessesSources extends ElementRefersToElements {\r\n  public static override get className(): string { return \"SynchronizationConfigProcessesSources\"; }\r\n}\r\n\r\n/** Relates a [[SynchronizationConfigLink]] to *root* [[ExternalSource]] instances.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class SynchronizationConfigSpecifiesRootSources extends SynchronizationConfigProcessesSources {\r\n  public static override get className(): string { return \"SynchronizationConfigSpecifiesRootSources\"; }\r\n}\r\n\r\n/** Properties that are common to all types of link table ECRelationships\r\n * @public\r\n */\r\nexport interface ElementGroupsMembersProps extends RelationshipProps {\r\n  memberPriority: number;\r\n}\r\n\r\n/** An ElementRefersToElements relationship where one Element *groups* a set of other Elements.\r\n * @public\r\n */\r\nexport class ElementGroupsMembers extends ElementRefersToElements {\r\n  public static override get className(): string { return \"ElementGroupsMembers\"; }\r\n  public memberPriority: number;\r\n\r\n  constructor(props: ElementGroupsMembersProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.memberPriority = props.memberPriority;\r\n  }\r\n\r\n  public static override create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String, memberPriority: number = 0): T {\r\n    const props: ElementGroupsMembersProps = { sourceId, targetId, memberPriority, classFullName: this.classFullName };\r\n    return iModel.relationships.createInstance(props) as T;\r\n  }\r\n}\r\n\r\n/** Relates a [[DefinitionGroup]] to its [[DefinitionElement]] members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.10\r\n * @public\r\n */\r\nexport class DefinitionGroupGroupsDefinitions extends ElementGroupsMembers {\r\n  public static override get className(): string { return \"DefinitionGroupGroupsDefinitions\"; }\r\n}\r\n\r\n/** Represents group membership where the group Element (and its properties) impart information about the member Elements above mere membership.\r\n * Implies that properties of the group should be considered as properties of its members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.11\r\n * @public\r\n */\r\nexport class GroupImpartsToMembers extends ElementGroupsMembers {\r\n  public static override get className(): string { return \"GroupImpartsToMembers\"; }\r\n}\r\n\r\n/** Relates an [[ExternalSourceGroup]] to its [[ExternalSource]] members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class ExternalSourceGroupGroupsSources extends ElementGroupsMembers {\r\n  public static override get className(): string { return \"ExternalSourceGroupGroupsSources\"; }\r\n}\r\n\r\n/** Properties that are common to all types of ElementDrivesElements\r\n * @beta\r\n */\r\nexport interface ElementDrivesElementProps extends RelationshipProps {\r\n  status: number;\r\n  priority: number;\r\n}\r\n\r\n/** A Relationship indicating that one Element *drives* another Element.\r\n * An ElementDrivesElement relationship defines a one-way \"driving\" relationship from the source to the target.\r\n * When the source of an ElementDrivesElement relationship changes, the ElementDrivesElement itself can get a callback, and both the source and target elements can get callbacks.\r\n * By inserting ElementDrivesElement relationships, an app can create and store an acyclic directed graph of dependencies between elements.\r\n *\r\n * # Defining dependencies\r\n * Create an ElementDrivesElement relationship to specify that the source element drives the target element.\r\n * For example, to specify that element e1 drives element e2, create a relationship between them like this:\r\n * ```ts\r\n *  const ede = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  ede.insert();\r\n * ```\r\n * This creates a persistent relationship. The fact that e1 drives e2 is persisted in the iModel.\r\n *\r\n * # Defining dependency graphs\r\n * When you create multiple ElementDrivesElement relationships, you create a network of dependencies. The target of one may be the source of another.\r\n * A change in the content of an DgnElement can therefore trigger changes to many downstream elements.\r\n *\r\n * For example, to make element e1 drive element e2 and e2 drive another element, e3, create two relationships like this:\r\n * ```ts\r\n *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);\r\n *  ede12.insert();\r\n *  ede23.insert();\r\n * ```\r\n * Those two relationships create this graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n * Where the \"-->\" is meant to represent a driving relationship.\r\n *\r\n * The order in which you create the relationships does not matter.\r\n * The graph indicates that e3 depends on e2 and e2 depends on e1.\r\n *\r\n * An ElementDrivesElement relationship is between one source element and one target element.\r\n * Many ElementDrivesElement relationships can point to a given element, and many can point out of it.\r\n * Thus, you can define many:many relationships.\r\n * For example:\r\n * ```ts\r\n *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  const ede112 = ElementDrivesElement.create(iModel, e11id, e2id);\r\n *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);\r\n *  const ede231 = ElementDrivesElement.create(iModel, e2id, e31id);\r\n *  ede12.insert();\r\n *  ede112.insert();\r\n *  ede23.insert();\r\n *  ede231.insert();\r\n * ```\r\n * Creates this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * e2 depends on both e1 and e11. e2 then drives e3 and e31.\r\n *\r\n * In an ElementDrivesElement dependency graph, the relationships are the \"edges\" and the Elements are the \"nodes\".\r\n * The following terms are used when referring to the elements (nodes) in a dependency graph:\r\n * * Inputs - The sources of all edges that point to the element. This includes all upstream elements that flow into the element.\r\n * * Outputs - The targets of all edges that point out of the element. This includes all downstream elements.\r\n *\r\n * # Subgraph Processing\r\n * When changes are made, only the part of the overall graph that is affected will be processed. So, for example,\r\n * suppose we have this graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n * If e1 changes, then the subgraph to be processed is equal to the full graph, as shown.\r\n *\r\n * If only e2 changes, then the subgraph to be processed is just:\r\n * ```\r\n *       e2 --> e3\r\n * ```\r\n * If only e3 changes, then the subgraph consists of e3 by itself.\r\n *\r\n * Returning to the second example above, suppose we have this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * If e1 is changed, the affected subgraph is:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * If e2 is changed, the affected subgraph is:\r\n * ```\r\n *           e3\r\n *         /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * # Callbacks\r\n * Once the affected subgraph to process is found, it propagates changes through it by making callbacks.\r\n * Classes for both elements (nodes) and ElementDrivesElements relationships (edges) can receive callbacks.\r\n *\r\n * ## ElementDrivesElement Callbacks\r\n * The following callbacks are invoked on ElementDrivesElement relationship classes (edges):\r\n * * onRootChanged\r\n * * onDeletedDependency\r\n *\r\n * Note that these are static methods. Their default implementations do nothing.\r\n * To receive and act on these callbacks, a domain should define a subclass of ElementDrivesElement and use that to create relationships.\r\n * The subclass should then implement the callbacks that it would like to act on.\r\n *\r\n * A ElementDrivesElement subclass callback is expected to make changes to the output element only!\r\n *\r\n * ## Element Callbacks\r\n * The following callbacks are invoked on Element classes (nodes):\r\n * * Element.onBeforeOutputsHandled\r\n * * Element.onAllInputsHandled\r\n *\r\n * ## Order\r\n * Callbacks are invoked by BriefcaseDb.saveChanges.\r\n * They are invoked in dependency (topological) order: driving elements first, then driven elements.\r\n *\r\n * Each callback is invoked only once. No matter how many times a given element was changed during the transaction,\r\n * a callback such as ElementDrivesElement.onRootChanged will be invoked only once.\r\n * In the same way, no matter how many of its inputs were changed, a callback such as Element.onAllInputsHandled will be\r\n * invoked only once.\r\n *\r\n * For example, suppose we have a graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n *\r\n * Suppose that e1 is directly modified. No callbacks are made at that time.\r\n * Later, when BriefcaseDb.saveChanges is called, the following callbacks are made, in order:\r\n * 1. Element.onBeforeOutputsHandled e1\r\n * 1. ElementDrivesElement.onRootChanged e1->e2\r\n * 1. Element.onAllInputsHandled e2\r\n * 1. ElementDrivesElement.onRootChanged e2->e3\r\n * 1. Element.onAllInputsHandled e3\r\n *\r\n * Suppose that e3 is modified directly and BriefcaseDb.saveChanges is called.\r\n * Since no input to a relationship was changed, the sub-graph will be empty, and no callbacks will be made.\r\n *\r\n * Returning to the second example above, suppose we have this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * If e1 is changed and BriefcaseDb.saveChanges is called, the subgraph is:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * The callbacks are:\r\n * 1. Element.onBeforeOutputsHandled e1\r\n * 1. ElementDrivesElement.onRootChanged e1->e2\r\n * 1. Element.onAllInputsHandled e2\r\n * 1. ElementDrivesElement.onRootChanged e2->e3\r\n * 1. Element.onAllInputsHandled e3\r\n * 1. ElementDrivesElement.onRootChanged e2->e31\r\n * 1. Element.onAllInputsHandled e31\r\n *\r\n * (The ElementDrivesElement.)\r\n *\r\n * #Errors\r\n * Circular dependencies are not permitted. If a cycle is detected, that is treated as a fatal error. All ElementDrivesElement relationships\r\n * involved in a cycle will have their status set to 1, indicating a failure.\r\n *\r\n * A callback may call txnManager.reportError to reject an invalid change. It can classify the error as fatal or just a warning.\r\n * A callback make set the status value of an ElementDrivesElement instance to 1 to indicate a processing failure in that edge.\r\n *\r\n * After BriefcaseDb.saveChanges is called, an app should check db.txns.validationErrors and db.txns.hasFatalError to find out if graph-evaluation failed.\r\n *\r\n * @beta\r\n */\r\nexport class ElementDrivesElement extends Relationship {\r\n  public static override get className(): string { return \"ElementDrivesElement\"; }\r\n  /** Relationship status\r\n   * * 0 indicates no errors. Set after a successful evaluation.\r\n   * * 1 indicates that this driving relationship could not be evaluated. The callback itself can set this to indicate that it failed to process the input changes. Also, it is set if the relationship is part of a circular dependency.\r\n   * * 0x80 The app or callback can set this to indicate to not propagate changes through this relationship.\r\n   */\r\n  public status: number;\r\n  /** Affects the order in which relationships are processed in the case where two relationships have the same output. */\r\n  public priority: number;\r\n\r\n  protected constructor(props: ElementDrivesElementProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.status = props.status;\r\n    this.priority = props.priority;\r\n  }\r\n\r\n  public static create<T extends ElementDrivesElement>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String, priority: number = 0): T {\r\n    const props: ElementDrivesElementProps = { sourceId, targetId, priority, status: 0, classFullName: this.classFullName };\r\n    return iModel.relationships.createInstance(props) as T;\r\n  }\r\n\r\n  public override toJSON(): ElementDrivesElementProps {\r\n    const props = super.toJSON() as ElementDrivesElementProps;\r\n    props.status = this.status;\r\n    props.priority = this.priority;\r\n    return props;\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addElement(this.targetId);\r\n  }\r\n}\r\n\r\n/** The third (and last) possible link-table relationship base class in an iModel.\r\n * Has no external use, but is included for completeness of the [Entity.collectReferenceIds]($backend)\r\n * implementations for link-table relationships. Generating the types of the source and target automatically would require\r\n * coupling this package with ecschema-metadata which we do not want to do.\r\n * @internal\r\n */\r\nexport class ModelSelectorRefersToModels extends Relationship {\r\n  public static override get className(): string { return \"ModelSelectorRefersToModels\"; }\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addModel(this.targetId);\r\n  }\r\n}\r\n\r\n/** Manages [[Relationship]]s.\r\n * @public\r\n */\r\nexport class Relationships {\r\n  private _iModel: IModelDb;\r\n\r\n  /** @internal */\r\n  public constructor(iModel: IModelDb) { this._iModel = iModel; }\r\n\r\n  /** Create a new instance of a Relationship.\r\n   * @param props The properties of the new Relationship.\r\n   * @throws [[IModelError]] if there is a problem creating the Relationship.\r\n   */\r\n  public createInstance(props: RelationshipProps): Relationship { return this._iModel.constructEntity<Relationship>(props); }\r\n\r\n  /** Check classFullName to ensure it is a link table relationship class. */\r\n  private checkRelationshipClass(classFullName: string) {\r\n    if (!this._iModel[_nativeDb].isLinkTableRelationship(classFullName.replace(\".\", \":\"))) {\r\n      throw new IModelError(DbResult.BE_SQLITE_ERROR, `Class '${classFullName}' must be a relationship class and it should be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.`);\r\n    }\r\n  }\r\n\r\n  /** Insert a new relationship instance into the iModel. The relationship provided must be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.\r\n   * @param props The properties of the new relationship.\r\n   * @returns The Id of the newly inserted relationship.\r\n   * @note The id property of the props object is set as a side effect of this function.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.insertRelationship instead.\r\n   */\r\n  public insertInstance(props: RelationshipProps): Id64String {\r\n    return this._iModel[_implicitTxn].insertRelationship(props);\r\n  }\r\n\r\n  /** Update the properties of an existing relationship instance in the iModel.\r\n   * @param props the properties of the relationship instance to update. Any properties that are not present will be left unchanged.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.updateRelationship instead.\r\n   */\r\n  public updateInstance(props: RelationshipProps): void {\r\n    this._iModel[_implicitTxn].updateRelationship(props);\r\n  }\r\n\r\n  /** Delete an Relationship instance from this iModel.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.deleteRelationship instead.\r\n   */\r\n  public deleteInstance(props: RelationshipProps): void {\r\n    this._iModel[_implicitTxn].deleteRelationship(props);\r\n  }\r\n\r\n  /** Delete multiple Relationship instances from this iModel.\r\n   * @param props The properties of the relationship instances to delete.\r\n   * @remarks This method handles bulk deletion of relationships and supports mixed collections containing instances from different relationship classes.\r\n   * @deprecated in 5.9.0 - will not be removed until after 2027-05-04. Use EditTxn.deleteRelationships instead.\r\n   */\r\n  public deleteInstances(props: ReadonlyArray<RelationshipProps>): void {\r\n    this._iModel[_implicitTxn].deleteRelationships(props);\r\n  }\r\n\r\n  /** Get the props of a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.\r\n   * @see tryGetInstanceProps\r\n   */\r\n  public getInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T {\r\n    const relationshipProps = this.tryGetInstanceProps<T>(relClassFullName, criteria);\r\n    if (undefined === relationshipProps) {\r\n      throw new IModelError(IModelStatus.NotFound, \"Relationship not found\");\r\n    }\r\n    return relationshipProps;\r\n  }\r\n\r\n  /** Get the props of a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @returns The RelationshipProps or `undefined` if the relationship is not found.\r\n   * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.\r\n   * @see getInstanceProps\r\n   */\r\n  public tryGetInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T | undefined {\r\n    // `SELECT *` targets a caller-supplied relationship class, so its shape can't be decomposed ahead of\r\n    // time. Query using the non-deprecated UseECSqlPropertyNames format and reshape the row into the\r\n    // legacy UseJsPropertyNames shape using ECSchema metadata (see ECSqlInstanceReshaper for why a naive,\r\n    // non-schema-aware rename isn't safe here).\r\n    const ecClass = getRuntimeClass(this._iModel, relClassFullName);\r\n    let props: T | undefined;\r\n    if (typeof criteria === \"string\") {\r\n      props = this._iModel.withQueryReader(`SELECT * FROM ${relClassFullName} WHERE ecinstanceid=?`, (reader): T | undefined => {\r\n        return reader.step() ? reshapeInstanceRow(reader.current.toRow(), ecClass, this._iModel) as T : undefined;\r\n      }, new QueryBinder().bindId(1, criteria), { rowFormat: QueryRowFormat.UseECSqlPropertyNames });\r\n    } else {\r\n      props = this._iModel.withQueryReader(`SELECT * FROM ${relClassFullName} WHERE SourceECInstanceId=? AND TargetECInstanceId=?`, (reader): T | undefined => {\r\n        return reader.step() ? reshapeInstanceRow(reader.current.toRow(), ecClass, this._iModel) as T : undefined;\r\n      }, new QueryBinder().bindId(1, criteria.sourceId).bindId(2, criteria.targetId), { rowFormat: QueryRowFormat.UseECSqlPropertyNames });\r\n    }\r\n    if (undefined !== props) {\r\n      // convert `className` (from `SELECT *`'s ECClassId) into `classFullName`, as required by `EntityProps`\r\n      const reshapedProps = props as T & { className?: string };\r\n      reshapedProps.classFullName = (reshapedProps.className as string).replace(\".\", \":\");\r\n    }\r\n    return props;\r\n  }\r\n\r\n  /** Get a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.\r\n   * @see tryGetInstance\r\n   */\r\n  public getInstance<T extends Relationship>(relClassSqlName: string, criteria: Id64String | SourceAndTarget): T {\r\n    return this._iModel.constructEntity<T>(this.getInstanceProps(relClassSqlName, criteria));\r\n  }\r\n\r\n  /** Get a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @returns The relationship or `undefined` if the relationship is not found.\r\n   * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.\r\n   * @see getInstance\r\n   */\r\n  public tryGetInstance<T extends Relationship>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T | undefined {\r\n    const relationshipProps = this.tryGetInstanceProps<RelationshipProps>(relClassFullName, criteria);\r\n    return undefined !== relationshipProps ? this._iModel.constructEntity<T>(relationshipProps) : undefined;\r\n  }\r\n\r\n  /** Get the props of multiple Relationship instances of the same class using batched queries.\r\n   * This produces the same results as calling [[tryGetInstanceProps]] for each entry in `criteria`, but executes at most two queries regardless of the number of entries.\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria The relationships to look up. Each entry is either a relationship instanceId or the source and target Ids. Entries of both kinds may be mixed.\r\n   * @param options.usePrimaryConn If `true` (the default), the queries run on the primary connection so that unsaved changes are visible, matching [[tryGetInstanceProps]].\r\n   * If `false`, they run on a concurrent query connection, which does not see unsaved changes.\r\n   * @returns An array with the same length and order as `criteria`. Each entry holds the RelationshipProps matching the corresponding criterion, or `undefined` if no such relationship was found.\r\n   * @see tryGetInstanceProps\r\n   * @see queryInstances\r\n   * @beta\r\n   */\r\n  public async queryInstancesProps<T extends RelationshipProps>(relClassFullName: string, criteria: ReadonlyArray<Id64String | SourceAndTarget>, options?: { usePrimaryConn?: boolean }): Promise<Array<T | undefined>> {\r\n    const pairKey = (pair: SourceAndTarget) => `${pair.sourceId}|${pair.targetId}`;\r\n\r\n    const ids = new Set<Id64String>();\r\n    const pairs = new Map<string, [Id64String, Id64String]>();\r\n    for (const criterion of criteria) {\r\n      if (typeof criterion === \"string\") {\r\n        if (Id64.isValidId64(criterion))\r\n          ids.add(criterion);\r\n      } else if (Id64.isValidId64(criterion.sourceId) && Id64.isValidId64(criterion.targetId)) {\r\n        pairs.set(pairKey(criterion), [criterion.sourceId, criterion.targetId]);\r\n      }\r\n    }\r\n\r\n    // Each query joins the requested values (as an IdSet or json_each virtual table) to the relationship class. CROSS JOIN makes SQLite iterate\r\n    // the requested values and look up each one by index, so only the requested relationships are read, regardless of the size of the class.\r\n    const propsById = new Map<Id64String, T>();\r\n    const propsByPair = new Map<string, T>();\r\n    const queries: Array<{ ecsql: string, params: QueryBinder, onProps: (props: T) => void }> = [];\r\n    if (ids.size > 0) {\r\n      queries.push({\r\n        ecsql: `SELECT r.* FROM IdSet(?) p CROSS JOIN ${relClassFullName} r WHERE r.ECInstanceId = p.id`,\r\n        params: new QueryBinder().bindIdSet(1, ids),\r\n        onProps: (props) => propsById.set(props.id as Id64String, props),\r\n      });\r\n    }\r\n\r\n    if (pairs.size > 0) {\r\n      // json_each yields the ids as hex strings; HexToId converts them to the integer ids stored in the table.\r\n      queries.push({\r\n        ecsql: `SELECT r.* FROM json1.json_each(?) p CROSS JOIN ${relClassFullName} r WHERE r.SourceECInstanceId = HexToId(json_extract(p.[value], '$[0]')) AND r.TargetECInstanceId = HexToId(json_extract(p.[value], '$[1]'))`,\r\n        params: new QueryBinder().bindString(1, JSON.stringify([...pairs.values()])),\r\n        onProps: (props) => {\r\n          // A polymorphic query may find more than one relationship for the same pair; keep the first, like tryGetInstanceProps.\r\n          const key = pairKey(props);\r\n          if (!propsByPair.has(key))\r\n            propsByPair.set(key, props);\r\n        },\r\n      });\r\n    }\r\n\r\n    if (queries.length > 0) {\r\n      // Convert rows the same way as tryGetInstanceProps, so that both produce identical props.\r\n      const ecClass = getRuntimeClass(this._iModel, relClassFullName);\r\n      const usePrimaryConn = options?.usePrimaryConn ?? true;\r\n      await Promise.all(queries.map(async (query) => {\r\n        for await (const row of this._iModel.createQueryReader(query.ecsql, query.params, { rowFormat: QueryRowFormat.UseECSqlPropertyNames, usePrimaryConn })) {\r\n          const props = reshapeInstanceRow(row.toRow(), ecClass, this._iModel) as T & { className: string };\r\n          props.classFullName = props.className.replace(\".\", \":\");\r\n          query.onProps(props);\r\n        }\r\n      }));\r\n    }\r\n\r\n    return criteria.map((criterion) => typeof criterion === \"string\" ? propsById.get(criterion) : propsByPair.get(pairKey(criterion)));\r\n  }\r\n\r\n  /** Get multiple Relationship instances of the same class using batched queries.\r\n   * This produces the same results as calling [[tryGetInstance]] for each entry in `criteria`, but executes at most two queries regardless of the number of entries.\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria The relationships to look up. Each entry is either a relationship instanceId or the source and target Ids. Entries of both kinds may be mixed.\r\n   * @param options.usePrimaryConn If `true` (the default), the queries run on the primary connection so that unsaved changes are visible, matching [[tryGetInstance]].\r\n   * If `false`, they run on a concurrent query connection, which does not see unsaved changes.\r\n   * @returns An array with the same length and order as `criteria`. Each entry holds the relationship matching the corresponding criterion, or `undefined` if no such relationship was found.\r\n   * @see tryGetInstance\r\n   * @see queryInstancesProps\r\n   * @beta\r\n   */\r\n  public async queryInstances<T extends Relationship>(relClassFullName: string, criteria: ReadonlyArray<Id64String | SourceAndTarget>, options?: { usePrimaryConn?: boolean }): Promise<Array<T | undefined>> {\r\n    const allProps = await this.queryInstancesProps<RelationshipProps>(relClassFullName, criteria, options);\r\n    return allProps.map((props) => undefined !== props ? this._iModel.constructEntity<T>(props) : undefined);\r\n  }\r\n}\r\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"SchemaSync.d.ts","sourceRoot":"","sources":["../../src/SchemaSync.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAiD,UAAU,EAAQ,UAAU,EAAwB,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAClJ,OAAO,EAAoB,IAAI,EAA2D,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEpI,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAI5D,gBAAgB;AAChB,yBAAiB,UAAU,CAAC;IAmB1B,0EAA0E;IAC1E,UAAiB,0BAA0B;QACzC,QAAQ,CAAC,cAAc,EAAE,UAAU,CAAC;QACpC,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;QAC/B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;QACpB,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;KAC/B;IAED,oFAAoF;IACpF,UAAiB,eAAgB,SAAQ,0BAA0B;QACjE,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;KAChC;IAED,UAAiB,WAAW;QAC1B,iEAAiE;QACjE,mBAAmB,CAAC,cAAc,EAAE,UAAU,GAAG,eAAe,GAAG,SAAS,CAAC;KAC9E;IAED,UAAiB,YAAY;QAC3B,wIAAwI;QACxI,eAAe,CAAC,UAAU,EAAE,0BAA0B,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KAC1E;IAED,kFAAkF;IAClF,MAAa,YAAa,SAAQ,iBAAkB,YAAW,WAAW,EAAE,YAAY;QACtF,OAAO,CAAC,qBAAqB,CAAC,CAAU;QACxC,SAAyB,SAAS,WAAW;kBAC1B,SAAS;QAIZ,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc;QAKvH,OAAO,CAAC,2BAA2B;QAmB5B,mBAAmB,CAAC,cAAc,EAAE,UAAU,GAAG,eAAe,GAAG,SAAS;QAyBnF,OAAO,CAAC,qBAAqB;QAkBhB,eAAe,CAAC,QAAQ,EAAE,0BAA0B,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;QAyCnF,OAAO,CAAC,eAAe;QAMvB,OAAO,CAAC,6BAA6B;QASrC,OAAO,CAAC,6BAA6B;KAGtC;IAID,6FAA6F;IACtF,MAAM,aAAa,eAAe,CAAC;IAG1C,SAAgB,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAKvE;IAED;;OAEG;IACH,KAAY,gBAAgB,GAAG,QAAQ,GAAG;QAAE,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAA;KAAE,CAAC;IAgB/E;;;;;;;;OAQG;IACH,SAAgB,SAAS,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAExD;IAyBD;;;;OAIG;IACH,SAAgB,mBAAmB,CAAC,GAAG,EAAE,gBAAgB,GAAG,WAAW,CAAC,cAAc,GAAG,SAAS,CAEjG;IAWD,SAAsB,cAAc,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAAC,WAAW,CAAC,CAmChF;IAED,6DAA6D;IAC7D,SAAgB,kBAAkB,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAc5D;IAED,0CAA0C;IAC1C,UAAiB,oBAAoB;QACnC,aAAa,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,EAAE,QAAQ,CAAC;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,SAAsB,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,oBAAoB,EAAE,SAAS,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAO7J;IAED;;OAEG;IACH,SAAgB,cAAc,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI,CAMrD;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAIvD;IAED,kDAAkD;IAClD,UAAiB,4BAA4B;QAC3C,MAAM,EAAE,QAAQ,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED;;;;;;OAMG;IACH,SAAsB,wBAAwB,CAAC,GAAG,EAAE,4BAA4B,GAAG,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAUrH;IAED,6CAA6C;IAC7C,UAAiB,uBAAuB;QACtC,MAAM,EAAE,QAAQ,CAAC;QACjB,cAAc,EAAE,WAAW,CAAC,cAAc,CAAC;QAC3C,gFAAgF;QAChF,iBAAiB,CAAC,EAAE,OAAO,CAAC;KAC7B;IA0DD;;;OAGG;IACH,SAAsB,mBAAmB,CAAC,GAAG,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC,CAGrF;IAED,oFAAoF;IACpF,KAAY,WAAW,GAAG,gBAAgB,GAAG,0BAA0B,CAAC;IAOxE,gDAAgD;IAChD,UAAiB,mBAAmB;QAClC,8EAA8E;QAC9E,MAAM,EAAE,WAAW,CAAC;QACpB,0EAA0E;QAC1E,KAAK,CAAC,EAAE,WAAW,CAAC;KACrB;IAED;;;;;OAKG;IACH,SAAsB,eAAe,CAAC,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAuC7E;IAED,yCAAyC;IACzC,UAAiB,mBAAmB;QAClC,MAAM,EAAE,QAAQ,CAAC;QACjB,iFAAiF;QACjF,cAAc,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;QAC5C,gFAAgF;QAChF,iBAAiB,CAAC,EAAE,OAAO,CAAC;QAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED;;;;;;;;;OASG;IACH,SAAsB,eAAe,CAAC,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CASnG;IAED,wDAAwD;IACxD,UAAiB,uBAAuB;QACtC,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC;QAC3B,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;KACzD;IAED,0EAA0E;IAC1E,MAAa,WAAY,SAAQ,WAAW,CAAC,QAAQ,CAAC,YAAY,EAAE,WAAW,EAAE,YAAY,CAAC;oBACzE,KAAK,EAAE,WAAW,CAAC,oBAAoB;QAInD,MAAM;QAGb;;;;SAIC;eACmB,YAAY,CAAC,KAAK,EAAE,WAAW,CAAC,cAAc;QAIlE,uFAAuF;eACnE,kBAAkB,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC;KAK3G;CACF"}
+{"version":3,"file":"SchemaSync.d.ts","sourceRoot":"","sources":["../../src/SchemaSync.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAiD,UAAU,EAAQ,UAAU,EAAwB,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAClJ,OAAO,EAAoB,IAAI,EAA2D,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEpI,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAI5D,gBAAgB;AAChB,yBAAiB,UAAU,CAAC;IAmB1B,0EAA0E;IAC1E,UAAiB,0BAA0B;QACzC,QAAQ,CAAC,cAAc,EAAE,UAAU,CAAC;QACpC,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;QAC/B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;QACpB,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;KAC/B;IAED,oFAAoF;IACpF,UAAiB,eAAgB,SAAQ,0BAA0B;QACjE,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;KAChC;IAED,UAAiB,WAAW;QAC1B,iEAAiE;QACjE,mBAAmB,CAAC,cAAc,EAAE,UAAU,GAAG,eAAe,GAAG,SAAS,CAAC;KAC9E;IAED,UAAiB,YAAY;QAC3B,wIAAwI;QACxI,eAAe,CAAC,UAAU,EAAE,0BAA0B,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KAC1E;IAED,kFAAkF;IAClF,MAAa,YAAa,SAAQ,iBAAkB,YAAW,WAAW,EAAE,YAAY;QACtF,OAAO,CAAC,qBAAqB,CAAC,CAAU;QACxC,SAAyB,SAAS,WAAW;kBAC1B,SAAS;QAIZ,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc;QAKvH,OAAO,CAAC,2BAA2B;QAmB5B,mBAAmB,CAAC,cAAc,EAAE,UAAU,GAAG,eAAe,GAAG,SAAS;QAyBnF,OAAO,CAAC,qBAAqB;QAkBhB,eAAe,CAAC,QAAQ,EAAE,0BAA0B,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;QAyCnF,OAAO,CAAC,eAAe;QAMvB,OAAO,CAAC,6BAA6B;QASrC,OAAO,CAAC,6BAA6B;KAGtC;IAID,6FAA6F;IACtF,MAAM,aAAa,eAAe,CAAC;IAG1C,SAAgB,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAKvE;IAED;;OAEG;IACH,KAAY,gBAAgB,GAAG,QAAQ,GAAG;QAAE,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAA;KAAE,CAAC;IAgB/E;;;;;;;;OAQG;IACH,SAAgB,SAAS,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAExD;IAyBD;;;;OAIG;IACH,SAAgB,mBAAmB,CAAC,GAAG,EAAE,gBAAgB,GAAG,WAAW,CAAC,cAAc,GAAG,SAAS,CAEjG;IAWD,SAAsB,cAAc,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAAC,WAAW,CAAC,CAmChF;IAED,6DAA6D;IAC7D,SAAgB,kBAAkB,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAc5D;IAED,0CAA0C;IAC1C,UAAiB,oBAAoB;QACnC,aAAa,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,EAAE,QAAQ,CAAC;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,SAAsB,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,oBAAoB,EAAE,SAAS,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAO7J;IAED;;OAEG;IACH,SAAgB,cAAc,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI,CAMrD;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAIvD;IAED,kDAAkD;IAClD,UAAiB,4BAA4B;QAC3C,MAAM,EAAE,QAAQ,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED;;;;;;OAMG;IACH,SAAsB,wBAAwB,CAAC,GAAG,EAAE,4BAA4B,GAAG,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAUrH;IAED,6CAA6C;IAC7C,UAAiB,uBAAuB;QACtC,MAAM,EAAE,QAAQ,CAAC;QACjB,cAAc,EAAE,WAAW,CAAC,cAAc,CAAC;QAC3C,gFAAgF;QAChF,iBAAiB,CAAC,EAAE,OAAO,CAAC;KAC7B;IA2DD;;;OAGG;IACH,SAAsB,mBAAmB,CAAC,GAAG,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC,CAGrF;IAED,oFAAoF;IACpF,KAAY,WAAW,GAAG,gBAAgB,GAAG,0BAA0B,CAAC;IAOxE,gDAAgD;IAChD,UAAiB,mBAAmB;QAClC,8EAA8E;QAC9E,MAAM,EAAE,WAAW,CAAC;QACpB,0EAA0E;QAC1E,KAAK,CAAC,EAAE,WAAW,CAAC;KACrB;IAED;;;;;OAKG;IACH,SAAsB,eAAe,CAAC,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAuC7E;IAED,yCAAyC;IACzC,UAAiB,mBAAmB;QAClC,MAAM,EAAE,QAAQ,CAAC;QACjB,iFAAiF;QACjF,cAAc,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;QAC5C,gFAAgF;QAChF,iBAAiB,CAAC,EAAE,OAAO,CAAC;QAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED;;;;;;;;;OASG;IACH,SAAsB,eAAe,CAAC,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CASnG;IAED,wDAAwD;IACxD,UAAiB,uBAAuB;QACtC,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC;QAC3B,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;KACzD;IAED,0EAA0E;IAC1E,MAAa,WAAY,SAAQ,WAAW,CAAC,QAAQ,CAAC,YAAY,EAAE,WAAW,EAAE,YAAY,CAAC;oBACzE,KAAK,EAAE,WAAW,CAAC,oBAAoB;QAInD,MAAM;QAGb;;;;SAIC;eACmB,YAAY,CAAC,KAAK,EAAE,WAAW,CAAC,cAAc;QAIlE,uFAAuF;eACnE,kBAAkB,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC;KAK3G;CACF"}

package/lib/cjs/SchemaSync.js

@@ -376,6 +376,7 @@ var SchemaSync;
                     const status = briefcase[Symbols_1._nativeDb].cancelTo(txnBeforeInit, true);
                     if (status !== core_bentley_1.IModelStatus.Success)
                         core_bentley_1.Logger.logError("SchemaSync", `Failed to roll back schema sync initialization after the container upload failed: ${core_bentley_1.IModelStatus[status] ?? status}`);
+                    briefcase.clearCaches();
                 }
                 throw error;
             }