@itwin/presentation-testing 3.5.0-dev.7 → 3.6.0-dev.1

package/CHANGELOG.md

@@ -1,6 +1,63 @@
 # Change Log - @itwin/presentation-testing
 
-This log was last generated on Thu, 01 Sep 2022 14:37:23 GMT and should not be manually modified.
+This log was last generated on Wed, 30 Nov 2022 14:28:19 GMT and should not be manually modified.
+
+## 3.4.7
+Wed, 30 Nov 2022 14:28:19 GMT
+
+_Version update only_
+
+## 3.4.6
+Tue, 22 Nov 2022 14:24:19 GMT
+
+_Version update only_
+
+## 3.4.5
+Thu, 17 Nov 2022 21:32:50 GMT
+
+_Version update only_
+
+## 3.4.4
+Thu, 10 Nov 2022 19:32:17 GMT
+
+_Version update only_
+
+## 3.4.3
+Fri, 28 Oct 2022 13:34:58 GMT
+
+_Version update only_
+
+## 3.4.2
+Mon, 24 Oct 2022 13:23:45 GMT
+
+_Version update only_
+
+## 3.4.1
+Mon, 17 Oct 2022 20:06:51 GMT
+
+_Version update only_
+
+## 3.4.0
+Thu, 13 Oct 2022 20:24:47 GMT
+
+### Updates
+
+- Allow supplying `IModelHostOptions` when initializing tests
+
+## 3.3.5
+Tue, 27 Sep 2022 11:50:59 GMT
+
+_Version update only_
+
+## 3.3.4
+Thu, 08 Sep 2022 19:00:05 GMT
+
+_Version update only_
+
+## 3.3.3
+Tue, 06 Sep 2022 20:54:19 GMT
+
+_Version update only_
 
 ## 3.3.2
 Thu, 01 Sep 2022 14:37:23 GMT

package/lib/cjs/presentation-testing/Helpers.d.ts

@@ -2,6 +2,8 @@ import { IModelHostOptions } from "@itwin/core-backend";
 import { IModelApp, IModelAppOptions } from "@itwin/core-frontend";
 import { HierarchyCacheMode, PresentationManagerProps as PresentationBackendProps, PresentationManagerMode } from "@itwin/presentation-backend";
 import { PresentationProps as PresentationFrontendProps } from "@itwin/presentation-frontend";
+/** @internal */
+export declare const getTestOutputDir: () => string;
 export { HierarchyCacheMode, PresentationManagerMode, PresentationBackendProps };
 /** @public */
 export interface PresentationTestingInitProps {
@@ -17,6 +19,8 @@ export interface PresentationTestingInitProps {
     };
     /** `IModelApp` options */
     frontendAppOptions?: IModelAppOptions;
+    /** Custom test output directory. Defaults to temporary directory provided by the OS. */
+    testOutputDir?: string;
 }
 /**
  * Initialize the framework for presentation testing. The function sets up backend,

package/lib/cjs/presentation-testing/Helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Helpers.d.ts","sourceRoot":"","sources":["../../../src/presentation-testing/Helpers.ts"],"names":[],"mappings":"AASA,OAAO,EAAc,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAKpE,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAe,MAAM,sBAAsB,CAAC;AAChF,OAAO,EACL,kBAAkB,EAAuC,wBAAwB,IAAI,wBAAwB,EAAE,uBAAuB,EACvI,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAwC,iBAAiB,IAAI,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AAsBpI,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,CAAC;AAEjF,cAAc;AACd,MAAM,WAAW,4BAA4B;IAC3C,4CAA4C;IAC5C,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC,kCAAkC;IAClC,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IACrC,6CAA6C;IAC7C,aAAa,CAAC,EAAE,yBAAyB,CAAC;IAC1C,+BAA+B;IAC/B,WAAW,CAAC,EAAE;QAAE,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,gBAAgB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,CAAC;IACtE,0BAA0B;IAC1B,kBAAkB,CAAC,EAAE,gBAAgB,CAAC;CACvC;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,qEA8BtB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,mDAuBrB,CAAC"}
+{"version":3,"file":"Helpers.d.ts","sourceRoot":"","sources":["../../../src/presentation-testing/Helpers.ts"],"names":[],"mappings":"AAUA,OAAO,EAAc,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAKpE,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAe,MAAM,sBAAsB,CAAC;AAChF,OAAO,EACL,kBAAkB,EAAuC,wBAAwB,IAAI,wBAAwB,EAAE,uBAAuB,EACvI,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAwC,iBAAiB,IAAI,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AA0BpI,gBAAgB;AAChB,eAAO,MAAM,gBAAgB,QAAO,MAEnC,CAAC;AAGF,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,CAAC;AAEjF,cAAc;AACd,MAAM,WAAW,4BAA4B;IAC3C,4CAA4C;IAC5C,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC,kCAAkC;IAClC,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IACrC,6CAA6C;IAC7C,aAAa,CAAC,EAAE,yBAAyB,CAAC;IAC1C,+BAA+B;IAC/B,WAAW,CAAC,EAAE;QAAE,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,gBAAgB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,CAAC;IACtE,0BAA0B;IAC1B,kBAAkB,CAAC,EAAE,gBAAgB,CAAC;IACtC,wFAAwF;IACxF,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,qEA+BtB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,mDAuBrB,CAAC"}

package/lib/cjs/presentation-testing/Helpers.js

@@ -19,7 +19,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.terminate = exports.initialize = exports.PresentationManagerMode = exports.HierarchyCacheMode = void 0;
+exports.terminate = exports.initialize = exports.PresentationManagerMode = exports.HierarchyCacheMode = exports.getTestOutputDir = void 0;
 /*---------------------------------------------------------------------------------------------
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
@@ -27,6 +27,7 @@ exports.terminate = exports.initialize = exports.PresentationManagerMode = expor
 /** @packageDocumentation
  * @module Helpers
  */
+/* istanbul ignore file */ // TODO: Remove istanbul ignore file when https://github.com/iTwin/itwinjs-backlog/issues/463 is fixed.
 const path_1 = require("path");
 const rimraf = __importStar(require("rimraf"));
 const core_backend_1 = require("@itwin/core-backend");
@@ -38,6 +39,7 @@ Object.defineProperty(exports, "HierarchyCacheMode", { enumerable: true, get: fu
 Object.defineProperty(exports, "PresentationManagerMode", { enumerable: true, get: function () { return presentation_backend_1.PresentationManagerMode; } });
 const presentation_common_1 = require("@itwin/presentation-common");
 const presentation_frontend_1 = require("@itwin/presentation-frontend");
+const os_1 = require("os");
 function initializeRpcInterfaces(interfaces) {
     const config = class extends core_common_1.RpcDefaultConfiguration {
         constructor() {
@@ -57,6 +59,13 @@ function initializeRpcInterfaces(interfaces) {
     }
 }
 let isInitialized = false;
+const defaultTestOutputDir = (0, os_1.tmpdir)();
+let testOutputDir;
+/** @internal */
+const getTestOutputDir = () => {
+    return testOutputDir !== null && testOutputDir !== void 0 ? testOutputDir : defaultTestOutputDir;
+};
+exports.getTestOutputDir = getTestOutputDir;
 /**
  * Initialize the framework for presentation testing. The function sets up backend,
  * frontend and RPC communication between them.
@@ -90,6 +99,7 @@ const initialize = async (props) => {
         },
     };
     await presentation_frontend_1.Presentation.initialize({ ...defaultFrontendProps, ...props.frontendProps });
+    testOutputDir = props.testOutputDir;
     isInitialized = true;
 };
 exports.initialize = initialize;

package/lib/cjs/presentation-testing/Helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"Helpers.js","sourceRoot":"","sources":["../../../src/presentation-testing/Helpers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,+BAA4B;AAC5B,+CAAiC;AACjC,sDAAoE;AACpE,sDAA2C;AAC3C,oDAE4B;AAC5B,wDAAgF;AAChF,sEAEqC;AAwB5B,mGAzBP,yCAAkB,OAyBO;AAAE,wGAzBoF,8CAAuB,OAyBpF;AAvBpD,oEAAsE;AACtE,wEAAoI;AAEpI,SAAS,uBAAuB,CAAC,UAAoC;IACnE,MAAM,MAAM,GAAG,KAAM,SAAQ,qCAAuB;QAArC;;YACG,eAAU,GAAQ,GAAG,EAAE,CAAC,UAAU,CAAC;QACrD,CAAC;KAAA,CAAC;IAEF,KAAK,MAAM,UAAU,IAAI,UAAU;QACjC,8BAAgB,CAAC,MAAM,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;IAEpD,MAAM,QAAQ,GAAG,8BAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAEjD,IAAI;QACF,8BAAgB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;KACjD;IAAC,MAAM;QACN,kFAAkF;QAClF,yDAAyD;KAC1D;AACH,CAAC;AAED,IAAI,aAAa,GAAG,KAAK,CAAC;AAkB1B;;;;;;;GAOG;AACI,MAAM,UAAU,GAAG,KAAK,EAAE,KAAoC,EAAE,EAAE;;IACvE,IAAI,aAAa;QACf,OAAO;IAET,IAAI,CAAC,KAAK;QACR,KAAK,GAAG,EAAE,CAAC;IAEb,wBAAwB;IACxB,uBAAuB,CAAC,CAAC,wCAA0B,EAAE,oCAAsB,EAAE,8CAAwB,CAAC,CAAC,CAAC;IAExG,eAAe;IACf,yFAAyF;IACzF,KAAK,CAAC,YAAY,GAAG,MAAA,KAAK,CAAC,YAAY,mCAAI,EAAE,CAAC;IAC9C,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE;QACxB,KAAK,CAAC,YAAY,CAAC,EAAE,GAAG,QAAQ,mBAAI,CAAC,WAAW,EAAE,EAAE,CAAC;IACvD,MAAM,yBAAU,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAA,WAAI,EAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,GAAG,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAC7F,mCAAmB,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAEnD,gBAAgB;IAChB,IAAI,CAAC,KAAK,CAAC,WAAW;QACpB,KAAK,CAAC,WAAW,GAAG,2BAAW,CAAC;IAClC,MAAM,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAC1D,MAAM,oBAAoB,GAA8B;QACtD,YAAY,EAAE;YACZ,YAAY,EAAE,yBAAS,CAAC,YAAY,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;SAC1D;KACF,CAAC;IACF,MAAM,oCAAoB,CAAC,UAAU,CAAC,EAAE,GAAG,oBAAoB,EAAE,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC,CAAC;IAE3F,aAAa,GAAG,IAAI,CAAC;AACvB,CAAC,CAAC;AA9BW,QAAA,UAAU,cA8BrB;AAEF;;;;;;;GAOG;AACI,MAAM,SAAS,GAAG,KAAK,EAAE,WAAW,GAAG,yBAAS,EAAE,EAAE;;IACzD,IAAI,CAAC,aAAa;QAChB,OAAO;IAET,8CAA8C;IAC9C,IAAI,yBAA6C,CAAC;IAClD,MAAM,sBAAsB,GAAG,MAAA,MAAA,mCAAmB,CAAC,SAAS,0CAAE,OAAO,0CAAE,WAAW,CAAC;IACnF,IAAI,CAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,IAAI,MAAK,yCAAkB,CAAC,IAAI;QAC1D,yBAAyB,GAAG,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,SAAS,CAAC;SAC3D,IAAI,CAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,IAAI,MAAK,yCAAkB,CAAC,MAAM;QACjE,yBAAyB,GAAG,MAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,IAAI,0CAAE,SAAS,CAAC;IAEtE,oBAAoB;IACpB,mCAAmB,CAAC,SAAS,EAAE,CAAC;IAChC,MAAM,yBAAU,CAAC,QAAQ,EAAE,CAAC;IAC5B,IAAI,yBAAyB;QAC3B,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IAEzC,qBAAqB;IACrB,oCAAoB,CAAC,SAAS,EAAE,CAAC;IACjC,MAAM,WAAW,CAAC,QAAQ,EAAE,CAAC;IAE7B,aAAa,GAAG,KAAK,CAAC;AACxB,CAAC,CAAC;AAvBW,QAAA,SAAS,aAuBpB","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 Helpers\r\n */\r\nimport { join } from \"path\";\r\nimport * as rimraf from \"rimraf\";\r\nimport { IModelHost, IModelHostOptions } from \"@itwin/core-backend\";\r\nimport { Guid } from \"@itwin/core-bentley\";\r\nimport {\r\n  IModelReadRpcInterface, RpcConfiguration, RpcDefaultConfiguration, RpcInterfaceDefinition, SnapshotIModelRpcInterface,\r\n} from \"@itwin/core-common\";\r\nimport { IModelApp, IModelAppOptions, NoRenderApp } from \"@itwin/core-frontend\";\r\nimport {\r\n  HierarchyCacheMode, Presentation as PresentationBackend, PresentationManagerProps as PresentationBackendProps, PresentationManagerMode,\r\n} from \"@itwin/presentation-backend\";\r\nimport { PresentationRpcInterface } from \"@itwin/presentation-common\";\r\nimport { Presentation as PresentationFrontend, PresentationProps as PresentationFrontendProps } from \"@itwin/presentation-frontend\";\r\n\r\nfunction initializeRpcInterfaces(interfaces: RpcInterfaceDefinition[]) {\r\n  const config = class extends RpcDefaultConfiguration {\r\n    public override interfaces: any = () => interfaces;\r\n  };\r\n\r\n  for (const definition of interfaces)\r\n    RpcConfiguration.assign(definition, () => config);\r\n\r\n  const instance = RpcConfiguration.obtain(config);\r\n\r\n  try {\r\n    RpcConfiguration.initializeInterfaces(instance);\r\n  } catch {\r\n    // this may fail with \"Error: RPC interface \"xxx\" is already initialized.\" because\r\n    // multiple different tests want to set up rpc interfaces\r\n  }\r\n}\r\n\r\nlet isInitialized = false;\r\n\r\nexport { HierarchyCacheMode, PresentationManagerMode, PresentationBackendProps };\r\n\r\n/** @public */\r\nexport interface PresentationTestingInitProps {\r\n  /** Properties for backend initialization */\r\n  backendProps?: PresentationBackendProps;\r\n  /** Properties for `IModelHost` */\r\n  backendHostProps?: IModelHostOptions;\r\n  /** Properties for frontend initialization */\r\n  frontendProps?: PresentationFrontendProps;\r\n  /** IModelApp implementation */\r\n  frontendApp?: { startup: (opts?: IModelAppOptions) => Promise<void> };\r\n  /** `IModelApp` options */\r\n  frontendAppOptions?: IModelAppOptions;\r\n}\r\n\r\n/**\r\n * Initialize the framework for presentation testing. The function sets up backend,\r\n * frontend and RPC communication between them.\r\n *\r\n * @see `terminate`\r\n *\r\n * @public\r\n */\r\nexport const initialize = async (props?: PresentationTestingInitProps) => {\r\n  if (isInitialized)\r\n    return;\r\n\r\n  if (!props)\r\n    props = {};\r\n\r\n  // set up rpc interfaces\r\n  initializeRpcInterfaces([SnapshotIModelRpcInterface, IModelReadRpcInterface, PresentationRpcInterface]);\r\n\r\n  // init backend\r\n  // make sure backend gets assigned an id which puts its resources into a unique directory\r\n  props.backendProps = props.backendProps ?? {};\r\n  if (!props.backendProps.id)\r\n    props.backendProps.id = `test-${Guid.createValue()}`;\r\n  await IModelHost.startup({ cacheDir: join(__dirname, \".cache\"), ...props.backendHostProps });\r\n  PresentationBackend.initialize(props.backendProps);\r\n\r\n  // init frontend\r\n  if (!props.frontendApp)\r\n    props.frontendApp = NoRenderApp;\r\n  await props.frontendApp.startup(props.frontendAppOptions);\r\n  const defaultFrontendProps: PresentationFrontendProps = {\r\n    presentation: {\r\n      activeLocale: IModelApp.localization.getLanguageList()[0],\r\n    },\r\n  };\r\n  await PresentationFrontend.initialize({ ...defaultFrontendProps, ...props.frontendProps });\r\n\r\n  isInitialized = true;\r\n};\r\n\r\n/**\r\n * Undoes the setup made by `initialize`.\r\n * @param frontendApp IModelApp implementation\r\n *\r\n * @see `initialize`\r\n *\r\n * @public\r\n */\r\nexport const terminate = async (frontendApp = IModelApp) => {\r\n  if (!isInitialized)\r\n    return;\r\n\r\n  // store directory that needs to be cleaned-up\r\n  let hierarchiesCacheDirectory: string | undefined;\r\n  const hierarchiesCacheConfig = PresentationBackend.initProps?.caching?.hierarchies;\r\n  if (hierarchiesCacheConfig?.mode === HierarchyCacheMode.Disk)\r\n    hierarchiesCacheDirectory = hierarchiesCacheConfig?.directory;\r\n  else if (hierarchiesCacheConfig?.mode === HierarchyCacheMode.Hybrid)\r\n    hierarchiesCacheDirectory = hierarchiesCacheConfig?.disk?.directory;\r\n\r\n  // terminate backend\r\n  PresentationBackend.terminate();\r\n  await IModelHost.shutdown();\r\n  if (hierarchiesCacheDirectory)\r\n    rimraf.sync(hierarchiesCacheDirectory);\r\n\r\n  // terminate frontend\r\n  PresentationFrontend.terminate();\r\n  await frontendApp.shutdown();\r\n\r\n  isInitialized = false;\r\n};\r\n"]}
+{"version":3,"file":"Helpers.js","sourceRoot":"","sources":["../../../src/presentation-testing/Helpers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,0BAA0B,CAAE,uGAAuG;AACnI,+BAA4B;AAC5B,+CAAiC;AACjC,sDAAoE;AACpE,sDAA2C;AAC3C,oDAE4B;AAC5B,wDAAgF;AAChF,sEAEqC;AAkC5B,mGAnCP,yCAAkB,OAmCO;AAAE,wGAnCoF,8CAAuB,OAmCpF;AAjCpD,oEAAsE;AACtE,wEAAoI;AACpI,2BAA4B;AAE5B,SAAS,uBAAuB,CAAC,UAAoC;IACnE,MAAM,MAAM,GAAG,KAAM,SAAQ,qCAAuB;QAArC;;YACG,eAAU,GAAQ,GAAG,EAAE,CAAC,UAAU,CAAC;QACrD,CAAC;KAAA,CAAC;IAEF,KAAK,MAAM,UAAU,IAAI,UAAU;QACjC,8BAAgB,CAAC,MAAM,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;IAEpD,MAAM,QAAQ,GAAG,8BAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAEjD,IAAI;QACF,8BAAgB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;KACjD;IAAC,MAAM;QACN,kFAAkF;QAClF,yDAAyD;KAC1D;AACH,CAAC;AAED,IAAI,aAAa,GAAG,KAAK,CAAC;AAE1B,MAAM,oBAAoB,GAAG,IAAA,WAAM,GAAE,CAAC;AACtC,IAAI,aAAiC,CAAC;AAEtC,gBAAgB;AACT,MAAM,gBAAgB,GAAG,GAAW,EAAE;IAC3C,OAAO,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,oBAAoB,CAAC;AAC/C,CAAC,CAAC;AAFW,QAAA,gBAAgB,oBAE3B;AAqBF;;;;;;;GAOG;AACI,MAAM,UAAU,GAAG,KAAK,EAAE,KAAoC,EAAE,EAAE;;IACvE,IAAI,aAAa;QACf,OAAO;IAET,IAAI,CAAC,KAAK;QACR,KAAK,GAAG,EAAE,CAAC;IAEb,wBAAwB;IACxB,uBAAuB,CAAC,CAAC,wCAA0B,EAAE,oCAAsB,EAAE,8CAAwB,CAAC,CAAC,CAAC;IAExG,eAAe;IACf,yFAAyF;IACzF,KAAK,CAAC,YAAY,GAAG,MAAA,KAAK,CAAC,YAAY,mCAAI,EAAE,CAAC;IAC9C,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE;QACxB,KAAK,CAAC,YAAY,CAAC,EAAE,GAAG,QAAQ,mBAAI,CAAC,WAAW,EAAE,EAAE,CAAC;IACvD,MAAM,yBAAU,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAA,WAAI,EAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,GAAG,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAC7F,mCAAmB,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAEnD,gBAAgB;IAChB,IAAI,CAAC,KAAK,CAAC,WAAW;QACpB,KAAK,CAAC,WAAW,GAAG,2BAAW,CAAC;IAClC,MAAM,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAC1D,MAAM,oBAAoB,GAA8B;QACtD,YAAY,EAAE;YACZ,YAAY,EAAE,yBAAS,CAAC,YAAY,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;SAC1D;KACF,CAAC;IACF,MAAM,oCAAoB,CAAC,UAAU,CAAC,EAAE,GAAG,oBAAoB,EAAE,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC,CAAC;IAC3F,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;IAEpC,aAAa,GAAG,IAAI,CAAC;AACvB,CAAC,CAAC;AA/BW,QAAA,UAAU,cA+BrB;AAEF;;;;;;;GAOG;AACI,MAAM,SAAS,GAAG,KAAK,EAAE,WAAW,GAAG,yBAAS,EAAE,EAAE;;IACzD,IAAI,CAAC,aAAa;QAChB,OAAO;IAET,8CAA8C;IAC9C,IAAI,yBAA6C,CAAC;IAClD,MAAM,sBAAsB,GAAG,MAAA,MAAA,mCAAmB,CAAC,SAAS,0CAAE,OAAO,0CAAE,WAAW,CAAC;IACnF,IAAI,CAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,IAAI,MAAK,yCAAkB,CAAC,IAAI;QAC1D,yBAAyB,GAAG,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,SAAS,CAAC;SAC3D,IAAI,CAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,IAAI,MAAK,yCAAkB,CAAC,MAAM;QACjE,yBAAyB,GAAG,MAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,IAAI,0CAAE,SAAS,CAAC;IAEtE,oBAAoB;IACpB,mCAAmB,CAAC,SAAS,EAAE,CAAC;IAChC,MAAM,yBAAU,CAAC,QAAQ,EAAE,CAAC;IAC5B,IAAI,yBAAyB;QAC3B,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IAEzC,qBAAqB;IACrB,oCAAoB,CAAC,SAAS,EAAE,CAAC;IACjC,MAAM,WAAW,CAAC,QAAQ,EAAE,CAAC;IAE7B,aAAa,GAAG,KAAK,CAAC;AACxB,CAAC,CAAC;AAvBW,QAAA,SAAS,aAuBpB","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 Helpers\r\n */\r\n/* istanbul ignore file */  // TODO: Remove istanbul ignore file when https://github.com/iTwin/itwinjs-backlog/issues/463 is fixed.\r\nimport { join } from \"path\";\r\nimport * as rimraf from \"rimraf\";\r\nimport { IModelHost, IModelHostOptions } from \"@itwin/core-backend\";\r\nimport { Guid } from \"@itwin/core-bentley\";\r\nimport {\r\n  IModelReadRpcInterface, RpcConfiguration, RpcDefaultConfiguration, RpcInterfaceDefinition, SnapshotIModelRpcInterface,\r\n} from \"@itwin/core-common\";\r\nimport { IModelApp, IModelAppOptions, NoRenderApp } from \"@itwin/core-frontend\";\r\nimport {\r\n  HierarchyCacheMode, Presentation as PresentationBackend, PresentationManagerProps as PresentationBackendProps, PresentationManagerMode,\r\n} from \"@itwin/presentation-backend\";\r\nimport { PresentationRpcInterface } from \"@itwin/presentation-common\";\r\nimport { Presentation as PresentationFrontend, PresentationProps as PresentationFrontendProps } from \"@itwin/presentation-frontend\";\r\nimport { tmpdir } from \"os\";\r\n\r\nfunction initializeRpcInterfaces(interfaces: RpcInterfaceDefinition[]) {\r\n  const config = class extends RpcDefaultConfiguration {\r\n    public override interfaces: any = () => interfaces;\r\n  };\r\n\r\n  for (const definition of interfaces)\r\n    RpcConfiguration.assign(definition, () => config);\r\n\r\n  const instance = RpcConfiguration.obtain(config);\r\n\r\n  try {\r\n    RpcConfiguration.initializeInterfaces(instance);\r\n  } catch {\r\n    // this may fail with \"Error: RPC interface \"xxx\" is already initialized.\" because\r\n    // multiple different tests want to set up rpc interfaces\r\n  }\r\n}\r\n\r\nlet isInitialized = false;\r\n\r\nconst defaultTestOutputDir = tmpdir();\r\nlet testOutputDir: string | undefined;\r\n\r\n/** @internal */\r\nexport const getTestOutputDir = (): string => {\r\n  return testOutputDir ?? defaultTestOutputDir;\r\n};\r\n\r\n// eslint-disable-next-line deprecation/deprecation\r\nexport { HierarchyCacheMode, PresentationManagerMode, PresentationBackendProps };\r\n\r\n/** @public */\r\nexport interface PresentationTestingInitProps {\r\n  /** Properties for backend initialization */\r\n  backendProps?: PresentationBackendProps;\r\n  /** Properties for `IModelHost` */\r\n  backendHostProps?: IModelHostOptions;\r\n  /** Properties for frontend initialization */\r\n  frontendProps?: PresentationFrontendProps;\r\n  /** IModelApp implementation */\r\n  frontendApp?: { startup: (opts?: IModelAppOptions) => Promise<void> };\r\n  /** `IModelApp` options */\r\n  frontendAppOptions?: IModelAppOptions;\r\n  /** Custom test output directory. Defaults to temporary directory provided by the OS. */\r\n  testOutputDir?: string;\r\n}\r\n\r\n/**\r\n * Initialize the framework for presentation testing. The function sets up backend,\r\n * frontend and RPC communication between them.\r\n *\r\n * @see `terminate`\r\n *\r\n * @public\r\n */\r\nexport const initialize = async (props?: PresentationTestingInitProps) => {\r\n  if (isInitialized)\r\n    return;\r\n\r\n  if (!props)\r\n    props = {};\r\n\r\n  // set up rpc interfaces\r\n  initializeRpcInterfaces([SnapshotIModelRpcInterface, IModelReadRpcInterface, PresentationRpcInterface]);\r\n\r\n  // init backend\r\n  // make sure backend gets assigned an id which puts its resources into a unique directory\r\n  props.backendProps = props.backendProps ?? {};\r\n  if (!props.backendProps.id)\r\n    props.backendProps.id = `test-${Guid.createValue()}`;\r\n  await IModelHost.startup({ cacheDir: join(__dirname, \".cache\"), ...props.backendHostProps });\r\n  PresentationBackend.initialize(props.backendProps);\r\n\r\n  // init frontend\r\n  if (!props.frontendApp)\r\n    props.frontendApp = NoRenderApp;\r\n  await props.frontendApp.startup(props.frontendAppOptions);\r\n  const defaultFrontendProps: PresentationFrontendProps = {\r\n    presentation: {\r\n      activeLocale: IModelApp.localization.getLanguageList()[0],\r\n    },\r\n  };\r\n  await PresentationFrontend.initialize({ ...defaultFrontendProps, ...props.frontendProps });\r\n  testOutputDir = props.testOutputDir;\r\n\r\n  isInitialized = true;\r\n};\r\n\r\n/**\r\n * Undoes the setup made by `initialize`.\r\n * @param frontendApp IModelApp implementation\r\n *\r\n * @see `initialize`\r\n *\r\n * @public\r\n */\r\nexport const terminate = async (frontendApp = IModelApp) => {\r\n  if (!isInitialized)\r\n    return;\r\n\r\n  // store directory that needs to be cleaned-up\r\n  let hierarchiesCacheDirectory: string | undefined;\r\n  const hierarchiesCacheConfig = PresentationBackend.initProps?.caching?.hierarchies;\r\n  if (hierarchiesCacheConfig?.mode === HierarchyCacheMode.Disk)\r\n    hierarchiesCacheDirectory = hierarchiesCacheConfig?.directory;\r\n  else if (hierarchiesCacheConfig?.mode === HierarchyCacheMode.Hybrid)\r\n    hierarchiesCacheDirectory = hierarchiesCacheConfig?.disk?.directory;\r\n\r\n  // terminate backend\r\n  PresentationBackend.terminate();\r\n  await IModelHost.shutdown();\r\n  if (hierarchiesCacheDirectory)\r\n    rimraf.sync(hierarchiesCacheDirectory);\r\n\r\n  // terminate frontend\r\n  PresentationFrontend.terminate();\r\n  await frontendApp.shutdown();\r\n\r\n  isInitialized = false;\r\n};\r\n"]}

package/lib/cjs/presentation-testing/IModelUtilities.d.ts

@@ -0,0 +1,47 @@
+/** @packageDocumentation
+ * @module IModel
+ */
+import { IModelDb } from "@itwin/core-backend";
+import { Id64String } from "@itwin/core-bentley";
+import { BisCodeSpec, Code, CodeScopeProps, ElementAspectProps, ElementProps, ModelProps } from "@itwin/core-common";
+import { IModelConnection } from "@itwin/core-frontend";
+/**
+ * Interface for IModel builder pattern. Used for building IModels to test rulesets.
+ *
+ * @beta
+ */
+export interface TestIModelBuilder {
+    /** Insert a model into the builder's iModel */
+    insertModel<TProps extends ModelProps>(props: TProps): Id64String;
+    /** Insert an element into the builder's iModel */
+    insertElement<TProps extends ElementProps>(props: TProps): Id64String;
+    /** Insert an element aspect into the specified element */
+    insertAspect<TProps extends ElementAspectProps>(props: TProps): void;
+    /**
+     * Create code for specified element.
+     * Code value has to be unique within its scope (see [Codes documentation page]($docs/bis/guide/fundamentals/codes.md)).
+     */
+    createCode(scopeModelId: CodeScopeProps, codeSpecName: BisCodeSpec, codeValue: string): Code;
+}
+/**
+ * Function that creates an iModel and returns a connection to it.
+ * @param name Name of test IModel
+ * @param cb Callback function that receives an [[TestIModelBuilder]] to fill the iModel with data
+ *
+ * @beta
+ */
+export declare function buildTestIModel(name: string, cb: (builder: TestIModelBuilder) => void): Promise<IModelConnection>;
+/**
+ * Default implementation of IModel builder pattern. Used for building IModels to test rulesets.
+ *
+ * @internal
+ */
+export declare class IModelBuilder implements TestIModelBuilder {
+    private _iModel;
+    constructor(iModel: IModelDb);
+    insertModel<TProps extends ModelProps>(props: TProps): Id64String;
+    insertElement<TProps extends ElementProps>(props: TProps): Id64String;
+    insertAspect<TProps extends ElementAspectProps>(props: TProps): void;
+    createCode(scopeModelId: CodeScopeProps, codeSpecName: BisCodeSpec, codeValue: string): Code;
+}
+//# sourceMappingURL=IModelUtilities.d.ts.map

package/lib/cjs/presentation-testing/IModelUtilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelUtilities.d.ts","sourceRoot":"","sources":["../../../src/presentation-testing/IModelUtilities.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAA0B,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,cAAc,EAAY,kBAAkB,EAAE,YAAY,EAAiB,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC9I,OAAO,EAAE,gBAAgB,EAAsB,MAAM,sBAAsB,CAAC;AAI5E;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,+CAA+C;IAC/C,WAAW,CAAC,MAAM,SAAS,UAAU,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC;IAClE,kDAAkD;IAClD,aAAa,CAAC,MAAM,SAAS,YAAY,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC;IACtE,0DAA0D;IAC1D,YAAY,CAAC,MAAM,SAAS,kBAAkB,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrE;;;OAGG;IACH,UAAU,CAAC,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9F;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAWvH;AAED;;;;GAIG;AACH,qBAAa,aAAc,YAAW,iBAAiB;IACrD,OAAO,CAAC,OAAO,CAAW;gBAEd,MAAM,EAAE,QAAQ;IAIrB,WAAW,CAAC,MAAM,SAAS,UAAU,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU;IAIjE,aAAa,CAAC,MAAM,SAAS,YAAY,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU;IAIrE,YAAY,CAAC,MAAM,SAAS,kBAAkB,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAIpE,UAAU,CAAC,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAIpG"}

package/lib/cjs/presentation-testing/IModelUtilities.js

@@ -0,0 +1,78 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module IModel
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IModelBuilder = exports.buildTestIModel = void 0;
+const core_backend_1 = require("@itwin/core-backend");
+const core_common_1 = require("@itwin/core-common");
+const core_frontend_1 = require("@itwin/core-frontend");
+const path_1 = __importDefault(require("path"));
+const Helpers_1 = require("./Helpers");
+/**
+ * Function that creates an iModel and returns a connection to it.
+ * @param name Name of test IModel
+ * @param cb Callback function that receives an [[TestIModelBuilder]] to fill the iModel with data
+ *
+ * @beta
+ */
+async function buildTestIModel(name, cb) {
+    const outputFile = setupOutputFileLocation(name);
+    const db = core_backend_1.SnapshotDb.createEmpty(outputFile, { rootSubject: { name } });
+    const builder = new IModelBuilder(db);
+    try {
+        cb(builder);
+    }
+    finally {
+        db.saveChanges("Created test IModel");
+        db.close();
+    }
+    return core_frontend_1.SnapshotConnection.openFile(outputFile);
+}
+exports.buildTestIModel = buildTestIModel;
+/**
+ * Default implementation of IModel builder pattern. Used for building IModels to test rulesets.
+ *
+ * @internal
+ */
+class IModelBuilder {
+    constructor(iModel) {
+        this._iModel = iModel;
+    }
+    insertModel(props) {
+        return this._iModel.models.insertModel(props);
+    }
+    insertElement(props) {
+        return this._iModel.elements.insertElement(props);
+    }
+    insertAspect(props) {
+        this._iModel.elements.insertAspect(props);
+    }
+    createCode(scopeModelId, codeSpecName, codeValue) {
+        const codeSpec = this._iModel.codeSpecs.getByName(codeSpecName);
+        return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
+    }
+}
+exports.IModelBuilder = IModelBuilder;
+/**
+ * Prepare for an output file by:
+ * - Resolving the output file name under the known test output directory
+ * - Making directories as necessary
+ * - Removing a previous copy of the output file
+ * @param fileName Name of output file
+ */
+function setupOutputFileLocation(fileName) {
+    const testOutputDir = (0, Helpers_1.getTestOutputDir)();
+    !core_backend_1.IModelJsFs.existsSync(testOutputDir) && core_backend_1.IModelJsFs.mkdirSync(testOutputDir);
+    const outputFile = path_1.default.join(testOutputDir, `${fileName}.bim`);
+    core_backend_1.IModelJsFs.existsSync(outputFile) && core_backend_1.IModelJsFs.unlinkSync(outputFile);
+    return outputFile;
+}
+//# sourceMappingURL=IModelUtilities.js.map

package/lib/cjs/presentation-testing/IModelUtilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelUtilities.js","sourceRoot":"","sources":["../../../src/presentation-testing/IModelUtilities.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;AAEH,sDAAuE;AAEvE,oDAA8I;AAC9I,wDAA4E;AAC5E,gDAAwB;AACxB,uCAA6C;AAqB7C;;;;;;GAMG;AACI,KAAK,UAAU,eAAe,CAAC,IAAY,EAAE,EAAwC;IAC1F,MAAM,UAAU,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;IACjD,MAAM,EAAE,GAAG,yBAAU,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IACzE,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,EAAE,CAAC,CAAC;IACtC,IAAI;QACF,EAAE,CAAC,OAAO,CAAC,CAAC;KACb;YAAS;QACR,EAAE,CAAC,WAAW,CAAC,qBAAqB,CAAC,CAAC;QACtC,EAAE,CAAC,KAAK,EAAE,CAAC;KACZ;IACD,OAAO,kCAAkB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;AACjD,CAAC;AAXD,0CAWC;AAED;;;;GAIG;AACH,MAAa,aAAa;IAGxB,YAAY,MAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAEM,WAAW,CAA4B,KAAa;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IAEM,aAAa,CAA8B,KAAa;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACpD,CAAC;IAEM,YAAY,CAAoC,KAAa;QAClE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAEM,UAAU,CAAC,YAA4B,EAAE,YAAyB,EAAE,SAAiB;QAC1F,MAAM,QAAQ,GAAa,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QAC1E,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAvBD,sCAuBC;AAED;;;;;;GAMG;AACH,SAAS,uBAAuB,CAAC,QAAgB;IAC/C,MAAM,aAAa,GAAG,IAAA,0BAAgB,GAAE,CAAC;IACzC,CAAC,yBAAU,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,yBAAU,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAE7E,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,QAAQ,MAAM,CAAC,CAAC;IAC/D,yBAAU,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,yBAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IACvE,OAAO,UAAU,CAAC;AACpB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module IModel\r\n */\r\n\r\nimport { IModelDb, IModelJsFs, SnapshotDb } from \"@itwin/core-backend\";\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { BisCodeSpec, Code, CodeScopeProps, CodeSpec, ElementAspectProps, ElementProps, LocalFileName, ModelProps } from \"@itwin/core-common\";\r\nimport { IModelConnection, SnapshotConnection } from \"@itwin/core-frontend\";\r\nimport path from \"path\";\r\nimport { getTestOutputDir } from \"./Helpers\";\r\n\r\n/**\r\n * Interface for IModel builder pattern. Used for building IModels to test rulesets.\r\n *\r\n * @beta\r\n */\r\nexport interface TestIModelBuilder {\r\n  /** Insert a model into the builder's iModel */\r\n  insertModel<TProps extends ModelProps>(props: TProps): Id64String;\r\n  /** Insert an element into the builder's iModel */\r\n  insertElement<TProps extends ElementProps>(props: TProps): Id64String;\r\n  /** Insert an element aspect into the specified element */\r\n  insertAspect<TProps extends ElementAspectProps>(props: TProps): void;\r\n  /**\r\n   * Create code for specified element.\r\n   * Code value has to be unique within its scope (see [Codes documentation page]($docs/bis/guide/fundamentals/codes.md)).\r\n   */\r\n  createCode(scopeModelId: CodeScopeProps, codeSpecName: BisCodeSpec, codeValue: string): Code;\r\n}\r\n\r\n/**\r\n * Function that creates an iModel and returns a connection to it.\r\n * @param name Name of test IModel\r\n * @param cb Callback function that receives an [[TestIModelBuilder]] to fill the iModel with data\r\n *\r\n * @beta\r\n */\r\nexport async function buildTestIModel(name: string, cb: (builder: TestIModelBuilder) => void): Promise<IModelConnection> {\r\n  const outputFile = setupOutputFileLocation(name);\r\n  const db = SnapshotDb.createEmpty(outputFile, { rootSubject: { name } });\r\n  const builder = new IModelBuilder(db);\r\n  try {\r\n    cb(builder);\r\n  } finally {\r\n    db.saveChanges(\"Created test IModel\");\r\n    db.close();\r\n  }\r\n  return SnapshotConnection.openFile(outputFile);\r\n}\r\n\r\n/**\r\n * Default implementation of IModel builder pattern. Used for building IModels to test rulesets.\r\n *\r\n * @internal\r\n */\r\nexport class IModelBuilder implements TestIModelBuilder {\r\n  private _iModel: IModelDb;\r\n\r\n  constructor(iModel: IModelDb) {\r\n    this._iModel = iModel;\r\n  }\r\n\r\n  public insertModel<TProps extends ModelProps>(props: TProps): Id64String {\r\n    return this._iModel.models.insertModel(props);\r\n  }\r\n\r\n  public insertElement<TProps extends ElementProps>(props: TProps): Id64String {\r\n    return this._iModel.elements.insertElement(props);\r\n  }\r\n\r\n  public insertAspect<TProps extends ElementAspectProps>(props: TProps): void {\r\n    this._iModel.elements.insertAspect(props);\r\n  }\r\n\r\n  public createCode(scopeModelId: CodeScopeProps, codeSpecName: BisCodeSpec, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = this._iModel.codeSpecs.getByName(codeSpecName);\r\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\r\n  }\r\n}\r\n\r\n/**\r\n * Prepare for an output file by:\r\n * - Resolving the output file name under the known test output directory\r\n * - Making directories as necessary\r\n * - Removing a previous copy of the output file\r\n * @param fileName Name of output file\r\n */\r\nfunction setupOutputFileLocation(fileName: string): LocalFileName {\r\n  const testOutputDir = getTestOutputDir();\r\n  !IModelJsFs.existsSync(testOutputDir) && IModelJsFs.mkdirSync(testOutputDir);\r\n\r\n  const outputFile = path.join(testOutputDir, `${fileName}.bim`);\r\n  IModelJsFs.existsSync(outputFile) && IModelJsFs.unlinkSync(outputFile);\r\n  return outputFile;\r\n}\r\n"]}

package/lib/cjs/presentation-testing.d.ts

@@ -20,10 +20,10 @@ export * from "./presentation-testing/ContentBuilder";
  */
 export * from "./presentation-testing/Helpers";
 /**
- * @module TestUtilities
+ * @module IModel
  *
- * @docs-group-description TestUtilities
- * Various test helpers.
+ * @docs-group-description IModel
+ * Utilities for creating test iModels that can be used to exercise presentation rules.
  */
-export * from "./presentation-testing/IModelTestUtility";
+export * from "./presentation-testing/IModelUtilities";
 //# sourceMappingURL=presentation-testing.d.ts.map

package/lib/cjs/presentation-testing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"presentation-testing.d.ts","sourceRoot":"","sources":["../../src/presentation-testing.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,cAAc,yCAAyC,CAAC;AAExD;;;;;GAKG;AACH,cAAc,uCAAuC,CAAC;AAEtD;;;;;GAKG;AACH,cAAc,gCAAgC,CAAC;AAE/C;;;;;GAKG;AACH,cAAc,0CAA0C,CAAC"}
+{"version":3,"file":"presentation-testing.d.ts","sourceRoot":"","sources":["../../src/presentation-testing.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,cAAc,yCAAyC,CAAC;AAExD;;;;;GAKG;AACH,cAAc,uCAAuC,CAAC;AAEtD;;;;;GAKG;AACH,cAAc,gCAAgC,CAAC;AAE/C;;;;;GAKG;AACH,cAAc,wCAAwC,CAAC"}

package/lib/cjs/presentation-testing.js

@@ -36,10 +36,10 @@ __exportStar(require("./presentation-testing/ContentBuilder"), exports);
  */
 __exportStar(require("./presentation-testing/Helpers"), exports);
 /**
- * @module TestUtilities
+ * @module IModel
  *
- * @docs-group-description TestUtilities
- * Various test helpers.
+ * @docs-group-description IModel
+ * Utilities for creating test iModels that can be used to exercise presentation rules.
  */
-__exportStar(require("./presentation-testing/IModelTestUtility"), exports);
+__exportStar(require("./presentation-testing/IModelUtilities"), exports);
 //# sourceMappingURL=presentation-testing.js.map

package/lib/cjs/presentation-testing.js.map

@@ -1 +1 @@
-{"version":3,"file":"presentation-testing.js","sourceRoot":"","sources":["../../src/presentation-testing.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA;;;+FAG+F;AAC/F;;;;;GAKG;AACH,0EAAwD;AAExD;;;;;GAKG;AACH,wEAAsD;AAEtD;;;;;GAKG;AACH,iEAA+C;AAE/C;;;;;GAKG;AACH,2EAAyD","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/**\r\n * @module Hierarchies\r\n *\r\n * @docs-group-description Hierarchies\r\n * Types for testing hierarchies.\r\n */\r\nexport * from \"./presentation-testing/HierarchyBuilder\";\r\n\r\n/**\r\n * @module Content\r\n *\r\n * @docs-group-description Content\r\n * Types for testing content.\r\n */\r\nexport * from \"./presentation-testing/ContentBuilder\";\r\n\r\n/**\r\n * @module Helpers\r\n *\r\n * @docs-group-description Helpers\r\n * Various test helpers.\r\n */\r\nexport * from \"./presentation-testing/Helpers\";\r\n\r\n/**\r\n * @module TestUtilities\r\n *\r\n * @docs-group-description TestUtilities\r\n * Various test helpers.\r\n */\r\nexport * from \"./presentation-testing/IModelTestUtility\";\r\n"]}
+{"version":3,"file":"presentation-testing.js","sourceRoot":"","sources":["../../src/presentation-testing.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA;;;+FAG+F;AAC/F;;;;;GAKG;AACH,0EAAwD;AAExD;;;;;GAKG;AACH,wEAAsD;AAEtD;;;;;GAKG;AACH,iEAA+C;AAE/C;;;;;GAKG;AACH,yEAAuD","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/**\r\n * @module Hierarchies\r\n *\r\n * @docs-group-description Hierarchies\r\n * Types for testing hierarchies.\r\n */\r\nexport * from \"./presentation-testing/HierarchyBuilder\";\r\n\r\n/**\r\n * @module Content\r\n *\r\n * @docs-group-description Content\r\n * Types for testing content.\r\n */\r\nexport * from \"./presentation-testing/ContentBuilder\";\r\n\r\n/**\r\n * @module Helpers\r\n *\r\n * @docs-group-description Helpers\r\n * Various test helpers.\r\n */\r\nexport * from \"./presentation-testing/Helpers\";\r\n\r\n/**\r\n * @module IModel\r\n *\r\n * @docs-group-description IModel\r\n * Utilities for creating test iModels that can be used to exercise presentation rules.\r\n */\r\nexport * from \"./presentation-testing/IModelUtilities\";\r\n"]}

package/lib/esm/presentation-testing/Helpers.d.ts

@@ -2,6 +2,8 @@ import { IModelHostOptions } from "@itwin/core-backend";
 import { IModelApp, IModelAppOptions } from "@itwin/core-frontend";
 import { HierarchyCacheMode, PresentationManagerProps as PresentationBackendProps, PresentationManagerMode } from "@itwin/presentation-backend";
 import { PresentationProps as PresentationFrontendProps } from "@itwin/presentation-frontend";
+/** @internal */
+export declare const getTestOutputDir: () => string;
 export { HierarchyCacheMode, PresentationManagerMode, PresentationBackendProps };
 /** @public */
 export interface PresentationTestingInitProps {
@@ -17,6 +19,8 @@ export interface PresentationTestingInitProps {
     };
     /** `IModelApp` options */
     frontendAppOptions?: IModelAppOptions;
+    /** Custom test output directory. Defaults to temporary directory provided by the OS. */
+    testOutputDir?: string;
 }
 /**
  * Initialize the framework for presentation testing. The function sets up backend,

package/lib/esm/presentation-testing/Helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Helpers.d.ts","sourceRoot":"","sources":["../../../src/presentation-testing/Helpers.ts"],"names":[],"mappings":"AASA,OAAO,EAAc,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAKpE,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAe,MAAM,sBAAsB,CAAC;AAChF,OAAO,EACL,kBAAkB,EAAuC,wBAAwB,IAAI,wBAAwB,EAAE,uBAAuB,EACvI,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAwC,iBAAiB,IAAI,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AAsBpI,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,CAAC;AAEjF,cAAc;AACd,MAAM,WAAW,4BAA4B;IAC3C,4CAA4C;IAC5C,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC,kCAAkC;IAClC,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IACrC,6CAA6C;IAC7C,aAAa,CAAC,EAAE,yBAAyB,CAAC;IAC1C,+BAA+B;IAC/B,WAAW,CAAC,EAAE;QAAE,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,gBAAgB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,CAAC;IACtE,0BAA0B;IAC1B,kBAAkB,CAAC,EAAE,gBAAgB,CAAC;CACvC;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,qEA8BtB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,mDAuBrB,CAAC"}
+{"version":3,"file":"Helpers.d.ts","sourceRoot":"","sources":["../../../src/presentation-testing/Helpers.ts"],"names":[],"mappings":"AAUA,OAAO,EAAc,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAKpE,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAe,MAAM,sBAAsB,CAAC;AAChF,OAAO,EACL,kBAAkB,EAAuC,wBAAwB,IAAI,wBAAwB,EAAE,uBAAuB,EACvI,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAwC,iBAAiB,IAAI,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AA0BpI,gBAAgB;AAChB,eAAO,MAAM,gBAAgB,QAAO,MAEnC,CAAC;AAGF,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,CAAC;AAEjF,cAAc;AACd,MAAM,WAAW,4BAA4B;IAC3C,4CAA4C;IAC5C,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC,kCAAkC;IAClC,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IACrC,6CAA6C;IAC7C,aAAa,CAAC,EAAE,yBAAyB,CAAC;IAC1C,+BAA+B;IAC/B,WAAW,CAAC,EAAE;QAAE,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,gBAAgB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,CAAC;IACtE,0BAA0B;IAC1B,kBAAkB,CAAC,EAAE,gBAAgB,CAAC;IACtC,wFAAwF;IACxF,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,qEA+BtB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,mDAuBrB,CAAC"}

package/lib/esm/presentation-testing/Helpers.js

@@ -5,6 +5,7 @@
 /** @packageDocumentation
  * @module Helpers
  */
+/* istanbul ignore file */ // TODO: Remove istanbul ignore file when https://github.com/iTwin/itwinjs-backlog/issues/463 is fixed.
 import { join } from "path";
 import * as rimraf from "rimraf";
 import { IModelHost } from "@itwin/core-backend";
@@ -14,6 +15,7 @@ import { IModelApp, NoRenderApp } from "@itwin/core-frontend";
 import { HierarchyCacheMode, Presentation as PresentationBackend, PresentationManagerMode, } from "@itwin/presentation-backend";
 import { PresentationRpcInterface } from "@itwin/presentation-common";
 import { Presentation as PresentationFrontend } from "@itwin/presentation-frontend";
+import { tmpdir } from "os";
 function initializeRpcInterfaces(interfaces) {
     const config = class extends RpcDefaultConfiguration {
         constructor() {
@@ -33,6 +35,13 @@ function initializeRpcInterfaces(interfaces) {
     }
 }
 let isInitialized = false;
+const defaultTestOutputDir = tmpdir();
+let testOutputDir;
+/** @internal */
+export const getTestOutputDir = () => {
+    return testOutputDir !== null && testOutputDir !== void 0 ? testOutputDir : defaultTestOutputDir;
+};
+// eslint-disable-next-line deprecation/deprecation
 export { HierarchyCacheMode, PresentationManagerMode };
 /**
  * Initialize the framework for presentation testing. The function sets up backend,
@@ -67,6 +76,7 @@ export const initialize = async (props) => {
         },
     };
     await PresentationFrontend.initialize({ ...defaultFrontendProps, ...props.frontendProps });
+    testOutputDir = props.testOutputDir;
     isInitialized = true;
 };
 /**

package/lib/esm/presentation-testing/Helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"Helpers.js","sourceRoot":"","sources":["../../../src/presentation-testing/Helpers.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAE,UAAU,EAAqB,MAAM,qBAAqB,CAAC;AACpE,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EACL,sBAAsB,EAAE,gBAAgB,EAAE,uBAAuB,EAA0B,0BAA0B,GACtH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAoB,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAChF,OAAO,EACL,kBAAkB,EAAE,YAAY,IAAI,mBAAmB,EAAwD,uBAAuB,GACvI,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,YAAY,IAAI,oBAAoB,EAAkD,MAAM,8BAA8B,CAAC;AAEpI,SAAS,uBAAuB,CAAC,UAAoC;IACnE,MAAM,MAAM,GAAG,KAAM,SAAQ,uBAAuB;QAArC;;YACG,eAAU,GAAQ,GAAG,EAAE,CAAC,UAAU,CAAC;QACrD,CAAC;KAAA,CAAC;IAEF,KAAK,MAAM,UAAU,IAAI,UAAU;QACjC,gBAAgB,CAAC,MAAM,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;IAEpD,MAAM,QAAQ,GAAG,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAEjD,IAAI;QACF,gBAAgB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;KACjD;IAAC,MAAM;QACN,kFAAkF;QAClF,yDAAyD;KAC1D;AACH,CAAC;AAED,IAAI,aAAa,GAAG,KAAK,CAAC;AAE1B,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAA4B,CAAC;AAgBjF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAAE,KAAoC,EAAE,EAAE;;IACvE,IAAI,aAAa;QACf,OAAO;IAET,IAAI,CAAC,KAAK;QACR,KAAK,GAAG,EAAE,CAAC;IAEb,wBAAwB;IACxB,uBAAuB,CAAC,CAAC,0BAA0B,EAAE,sBAAsB,EAAE,wBAAwB,CAAC,CAAC,CAAC;IAExG,eAAe;IACf,yFAAyF;IACzF,KAAK,CAAC,YAAY,GAAG,MAAA,KAAK,CAAC,YAAY,mCAAI,EAAE,CAAC;IAC9C,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE;QACxB,KAAK,CAAC,YAAY,CAAC,EAAE,GAAG,QAAQ,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;IACvD,MAAM,UAAU,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,GAAG,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAC7F,mBAAmB,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAEnD,gBAAgB;IAChB,IAAI,CAAC,KAAK,CAAC,WAAW;QACpB,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;IAClC,MAAM,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAC1D,MAAM,oBAAoB,GAA8B;QACtD,YAAY,EAAE;YACZ,YAAY,EAAE,SAAS,CAAC,YAAY,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;SAC1D;KACF,CAAC;IACF,MAAM,oBAAoB,CAAC,UAAU,CAAC,EAAE,GAAG,oBAAoB,EAAE,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC,CAAC;IAE3F,aAAa,GAAG,IAAI,CAAC;AACvB,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,KAAK,EAAE,WAAW,GAAG,SAAS,EAAE,EAAE;;IACzD,IAAI,CAAC,aAAa;QAChB,OAAO;IAET,8CAA8C;IAC9C,IAAI,yBAA6C,CAAC;IAClD,MAAM,sBAAsB,GAAG,MAAA,MAAA,mBAAmB,CAAC,SAAS,0CAAE,OAAO,0CAAE,WAAW,CAAC;IACnF,IAAI,CAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,IAAI,MAAK,kBAAkB,CAAC,IAAI;QAC1D,yBAAyB,GAAG,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,SAAS,CAAC;SAC3D,IAAI,CAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,IAAI,MAAK,kBAAkB,CAAC,MAAM;QACjE,yBAAyB,GAAG,MAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,IAAI,0CAAE,SAAS,CAAC;IAEtE,oBAAoB;IACpB,mBAAmB,CAAC,SAAS,EAAE,CAAC;IAChC,MAAM,UAAU,CAAC,QAAQ,EAAE,CAAC;IAC5B,IAAI,yBAAyB;QAC3B,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IAEzC,qBAAqB;IACrB,oBAAoB,CAAC,SAAS,EAAE,CAAC;IACjC,MAAM,WAAW,CAAC,QAAQ,EAAE,CAAC;IAE7B,aAAa,GAAG,KAAK,CAAC;AACxB,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Helpers\r\n */\r\nimport { join } from \"path\";\r\nimport * as rimraf from \"rimraf\";\r\nimport { IModelHost, IModelHostOptions } from \"@itwin/core-backend\";\r\nimport { Guid } from \"@itwin/core-bentley\";\r\nimport {\r\n  IModelReadRpcInterface, RpcConfiguration, RpcDefaultConfiguration, RpcInterfaceDefinition, SnapshotIModelRpcInterface,\r\n} from \"@itwin/core-common\";\r\nimport { IModelApp, IModelAppOptions, NoRenderApp } from \"@itwin/core-frontend\";\r\nimport {\r\n  HierarchyCacheMode, Presentation as PresentationBackend, PresentationManagerProps as PresentationBackendProps, PresentationManagerMode,\r\n} from \"@itwin/presentation-backend\";\r\nimport { PresentationRpcInterface } from \"@itwin/presentation-common\";\r\nimport { Presentation as PresentationFrontend, PresentationProps as PresentationFrontendProps } from \"@itwin/presentation-frontend\";\r\n\r\nfunction initializeRpcInterfaces(interfaces: RpcInterfaceDefinition[]) {\r\n  const config = class extends RpcDefaultConfiguration {\r\n    public override interfaces: any = () => interfaces;\r\n  };\r\n\r\n  for (const definition of interfaces)\r\n    RpcConfiguration.assign(definition, () => config);\r\n\r\n  const instance = RpcConfiguration.obtain(config);\r\n\r\n  try {\r\n    RpcConfiguration.initializeInterfaces(instance);\r\n  } catch {\r\n    // this may fail with \"Error: RPC interface \"xxx\" is already initialized.\" because\r\n    // multiple different tests want to set up rpc interfaces\r\n  }\r\n}\r\n\r\nlet isInitialized = false;\r\n\r\nexport { HierarchyCacheMode, PresentationManagerMode, PresentationBackendProps };\r\n\r\n/** @public */\r\nexport interface PresentationTestingInitProps {\r\n  /** Properties for backend initialization */\r\n  backendProps?: PresentationBackendProps;\r\n  /** Properties for `IModelHost` */\r\n  backendHostProps?: IModelHostOptions;\r\n  /** Properties for frontend initialization */\r\n  frontendProps?: PresentationFrontendProps;\r\n  /** IModelApp implementation */\r\n  frontendApp?: { startup: (opts?: IModelAppOptions) => Promise<void> };\r\n  /** `IModelApp` options */\r\n  frontendAppOptions?: IModelAppOptions;\r\n}\r\n\r\n/**\r\n * Initialize the framework for presentation testing. The function sets up backend,\r\n * frontend and RPC communication between them.\r\n *\r\n * @see `terminate`\r\n *\r\n * @public\r\n */\r\nexport const initialize = async (props?: PresentationTestingInitProps) => {\r\n  if (isInitialized)\r\n    return;\r\n\r\n  if (!props)\r\n    props = {};\r\n\r\n  // set up rpc interfaces\r\n  initializeRpcInterfaces([SnapshotIModelRpcInterface, IModelReadRpcInterface, PresentationRpcInterface]);\r\n\r\n  // init backend\r\n  // make sure backend gets assigned an id which puts its resources into a unique directory\r\n  props.backendProps = props.backendProps ?? {};\r\n  if (!props.backendProps.id)\r\n    props.backendProps.id = `test-${Guid.createValue()}`;\r\n  await IModelHost.startup({ cacheDir: join(__dirname, \".cache\"), ...props.backendHostProps });\r\n  PresentationBackend.initialize(props.backendProps);\r\n\r\n  // init frontend\r\n  if (!props.frontendApp)\r\n    props.frontendApp = NoRenderApp;\r\n  await props.frontendApp.startup(props.frontendAppOptions);\r\n  const defaultFrontendProps: PresentationFrontendProps = {\r\n    presentation: {\r\n      activeLocale: IModelApp.localization.getLanguageList()[0],\r\n    },\r\n  };\r\n  await PresentationFrontend.initialize({ ...defaultFrontendProps, ...props.frontendProps });\r\n\r\n  isInitialized = true;\r\n};\r\n\r\n/**\r\n * Undoes the setup made by `initialize`.\r\n * @param frontendApp IModelApp implementation\r\n *\r\n * @see `initialize`\r\n *\r\n * @public\r\n */\r\nexport const terminate = async (frontendApp = IModelApp) => {\r\n  if (!isInitialized)\r\n    return;\r\n\r\n  // store directory that needs to be cleaned-up\r\n  let hierarchiesCacheDirectory: string | undefined;\r\n  const hierarchiesCacheConfig = PresentationBackend.initProps?.caching?.hierarchies;\r\n  if (hierarchiesCacheConfig?.mode === HierarchyCacheMode.Disk)\r\n    hierarchiesCacheDirectory = hierarchiesCacheConfig?.directory;\r\n  else if (hierarchiesCacheConfig?.mode === HierarchyCacheMode.Hybrid)\r\n    hierarchiesCacheDirectory = hierarchiesCacheConfig?.disk?.directory;\r\n\r\n  // terminate backend\r\n  PresentationBackend.terminate();\r\n  await IModelHost.shutdown();\r\n  if (hierarchiesCacheDirectory)\r\n    rimraf.sync(hierarchiesCacheDirectory);\r\n\r\n  // terminate frontend\r\n  PresentationFrontend.terminate();\r\n  await frontendApp.shutdown();\r\n\r\n  isInitialized = false;\r\n};\r\n"]}
+{"version":3,"file":"Helpers.js","sourceRoot":"","sources":["../../../src/presentation-testing/Helpers.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,0BAA0B,CAAE,uGAAuG;AACnI,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAE,UAAU,EAAqB,MAAM,qBAAqB,CAAC;AACpE,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EACL,sBAAsB,EAAE,gBAAgB,EAAE,uBAAuB,EAA0B,0BAA0B,GACtH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAoB,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAChF,OAAO,EACL,kBAAkB,EAAE,YAAY,IAAI,mBAAmB,EAAwD,uBAAuB,GACvI,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,YAAY,IAAI,oBAAoB,EAAkD,MAAM,8BAA8B,CAAC;AACpI,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC;AAE5B,SAAS,uBAAuB,CAAC,UAAoC;IACnE,MAAM,MAAM,GAAG,KAAM,SAAQ,uBAAuB;QAArC;;YACG,eAAU,GAAQ,GAAG,EAAE,CAAC,UAAU,CAAC;QACrD,CAAC;KAAA,CAAC;IAEF,KAAK,MAAM,UAAU,IAAI,UAAU;QACjC,gBAAgB,CAAC,MAAM,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;IAEpD,MAAM,QAAQ,GAAG,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAEjD,IAAI;QACF,gBAAgB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;KACjD;IAAC,MAAM;QACN,kFAAkF;QAClF,yDAAyD;KAC1D;AACH,CAAC;AAED,IAAI,aAAa,GAAG,KAAK,CAAC;AAE1B,MAAM,oBAAoB,GAAG,MAAM,EAAE,CAAC;AACtC,IAAI,aAAiC,CAAC;AAEtC,gBAAgB;AAChB,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAW,EAAE;IAC3C,OAAO,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,oBAAoB,CAAC;AAC/C,CAAC,CAAC;AAEF,mDAAmD;AACnD,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAA4B,CAAC;AAkBjF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAAE,KAAoC,EAAE,EAAE;;IACvE,IAAI,aAAa;QACf,OAAO;IAET,IAAI,CAAC,KAAK;QACR,KAAK,GAAG,EAAE,CAAC;IAEb,wBAAwB;IACxB,uBAAuB,CAAC,CAAC,0BAA0B,EAAE,sBAAsB,EAAE,wBAAwB,CAAC,CAAC,CAAC;IAExG,eAAe;IACf,yFAAyF;IACzF,KAAK,CAAC,YAAY,GAAG,MAAA,KAAK,CAAC,YAAY,mCAAI,EAAE,CAAC;IAC9C,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE;QACxB,KAAK,CAAC,YAAY,CAAC,EAAE,GAAG,QAAQ,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;IACvD,MAAM,UAAU,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,GAAG,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAC7F,mBAAmB,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAEnD,gBAAgB;IAChB,IAAI,CAAC,KAAK,CAAC,WAAW;QACpB,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;IAClC,MAAM,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAC1D,MAAM,oBAAoB,GAA8B;QACtD,YAAY,EAAE;YACZ,YAAY,EAAE,SAAS,CAAC,YAAY,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;SAC1D;KACF,CAAC;IACF,MAAM,oBAAoB,CAAC,UAAU,CAAC,EAAE,GAAG,oBAAoB,EAAE,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC,CAAC;IAC3F,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;IAEpC,aAAa,GAAG,IAAI,CAAC;AACvB,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,KAAK,EAAE,WAAW,GAAG,SAAS,EAAE,EAAE;;IACzD,IAAI,CAAC,aAAa;QAChB,OAAO;IAET,8CAA8C;IAC9C,IAAI,yBAA6C,CAAC;IAClD,MAAM,sBAAsB,GAAG,MAAA,MAAA,mBAAmB,CAAC,SAAS,0CAAE,OAAO,0CAAE,WAAW,CAAC;IACnF,IAAI,CAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,IAAI,MAAK,kBAAkB,CAAC,IAAI;QAC1D,yBAAyB,GAAG,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,SAAS,CAAC;SAC3D,IAAI,CAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,IAAI,MAAK,kBAAkB,CAAC,MAAM;QACjE,yBAAyB,GAAG,MAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,IAAI,0CAAE,SAAS,CAAC;IAEtE,oBAAoB;IACpB,mBAAmB,CAAC,SAAS,EAAE,CAAC;IAChC,MAAM,UAAU,CAAC,QAAQ,EAAE,CAAC;IAC5B,IAAI,yBAAyB;QAC3B,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IAEzC,qBAAqB;IACrB,oBAAoB,CAAC,SAAS,EAAE,CAAC;IACjC,MAAM,WAAW,CAAC,QAAQ,EAAE,CAAC;IAE7B,aAAa,GAAG,KAAK,CAAC;AACxB,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Helpers\r\n */\r\n/* istanbul ignore file */  // TODO: Remove istanbul ignore file when https://github.com/iTwin/itwinjs-backlog/issues/463 is fixed.\r\nimport { join } from \"path\";\r\nimport * as rimraf from \"rimraf\";\r\nimport { IModelHost, IModelHostOptions } from \"@itwin/core-backend\";\r\nimport { Guid } from \"@itwin/core-bentley\";\r\nimport {\r\n  IModelReadRpcInterface, RpcConfiguration, RpcDefaultConfiguration, RpcInterfaceDefinition, SnapshotIModelRpcInterface,\r\n} from \"@itwin/core-common\";\r\nimport { IModelApp, IModelAppOptions, NoRenderApp } from \"@itwin/core-frontend\";\r\nimport {\r\n  HierarchyCacheMode, Presentation as PresentationBackend, PresentationManagerProps as PresentationBackendProps, PresentationManagerMode,\r\n} from \"@itwin/presentation-backend\";\r\nimport { PresentationRpcInterface } from \"@itwin/presentation-common\";\r\nimport { Presentation as PresentationFrontend, PresentationProps as PresentationFrontendProps } from \"@itwin/presentation-frontend\";\r\nimport { tmpdir } from \"os\";\r\n\r\nfunction initializeRpcInterfaces(interfaces: RpcInterfaceDefinition[]) {\r\n  const config = class extends RpcDefaultConfiguration {\r\n    public override interfaces: any = () => interfaces;\r\n  };\r\n\r\n  for (const definition of interfaces)\r\n    RpcConfiguration.assign(definition, () => config);\r\n\r\n  const instance = RpcConfiguration.obtain(config);\r\n\r\n  try {\r\n    RpcConfiguration.initializeInterfaces(instance);\r\n  } catch {\r\n    // this may fail with \"Error: RPC interface \"xxx\" is already initialized.\" because\r\n    // multiple different tests want to set up rpc interfaces\r\n  }\r\n}\r\n\r\nlet isInitialized = false;\r\n\r\nconst defaultTestOutputDir = tmpdir();\r\nlet testOutputDir: string | undefined;\r\n\r\n/** @internal */\r\nexport const getTestOutputDir = (): string => {\r\n  return testOutputDir ?? defaultTestOutputDir;\r\n};\r\n\r\n// eslint-disable-next-line deprecation/deprecation\r\nexport { HierarchyCacheMode, PresentationManagerMode, PresentationBackendProps };\r\n\r\n/** @public */\r\nexport interface PresentationTestingInitProps {\r\n  /** Properties for backend initialization */\r\n  backendProps?: PresentationBackendProps;\r\n  /** Properties for `IModelHost` */\r\n  backendHostProps?: IModelHostOptions;\r\n  /** Properties for frontend initialization */\r\n  frontendProps?: PresentationFrontendProps;\r\n  /** IModelApp implementation */\r\n  frontendApp?: { startup: (opts?: IModelAppOptions) => Promise<void> };\r\n  /** `IModelApp` options */\r\n  frontendAppOptions?: IModelAppOptions;\r\n  /** Custom test output directory. Defaults to temporary directory provided by the OS. */\r\n  testOutputDir?: string;\r\n}\r\n\r\n/**\r\n * Initialize the framework for presentation testing. The function sets up backend,\r\n * frontend and RPC communication between them.\r\n *\r\n * @see `terminate`\r\n *\r\n * @public\r\n */\r\nexport const initialize = async (props?: PresentationTestingInitProps) => {\r\n  if (isInitialized)\r\n    return;\r\n\r\n  if (!props)\r\n    props = {};\r\n\r\n  // set up rpc interfaces\r\n  initializeRpcInterfaces([SnapshotIModelRpcInterface, IModelReadRpcInterface, PresentationRpcInterface]);\r\n\r\n  // init backend\r\n  // make sure backend gets assigned an id which puts its resources into a unique directory\r\n  props.backendProps = props.backendProps ?? {};\r\n  if (!props.backendProps.id)\r\n    props.backendProps.id = `test-${Guid.createValue()}`;\r\n  await IModelHost.startup({ cacheDir: join(__dirname, \".cache\"), ...props.backendHostProps });\r\n  PresentationBackend.initialize(props.backendProps);\r\n\r\n  // init frontend\r\n  if (!props.frontendApp)\r\n    props.frontendApp = NoRenderApp;\r\n  await props.frontendApp.startup(props.frontendAppOptions);\r\n  const defaultFrontendProps: PresentationFrontendProps = {\r\n    presentation: {\r\n      activeLocale: IModelApp.localization.getLanguageList()[0],\r\n    },\r\n  };\r\n  await PresentationFrontend.initialize({ ...defaultFrontendProps, ...props.frontendProps });\r\n  testOutputDir = props.testOutputDir;\r\n\r\n  isInitialized = true;\r\n};\r\n\r\n/**\r\n * Undoes the setup made by `initialize`.\r\n * @param frontendApp IModelApp implementation\r\n *\r\n * @see `initialize`\r\n *\r\n * @public\r\n */\r\nexport const terminate = async (frontendApp = IModelApp) => {\r\n  if (!isInitialized)\r\n    return;\r\n\r\n  // store directory that needs to be cleaned-up\r\n  let hierarchiesCacheDirectory: string | undefined;\r\n  const hierarchiesCacheConfig = PresentationBackend.initProps?.caching?.hierarchies;\r\n  if (hierarchiesCacheConfig?.mode === HierarchyCacheMode.Disk)\r\n    hierarchiesCacheDirectory = hierarchiesCacheConfig?.directory;\r\n  else if (hierarchiesCacheConfig?.mode === HierarchyCacheMode.Hybrid)\r\n    hierarchiesCacheDirectory = hierarchiesCacheConfig?.disk?.directory;\r\n\r\n  // terminate backend\r\n  PresentationBackend.terminate();\r\n  await IModelHost.shutdown();\r\n  if (hierarchiesCacheDirectory)\r\n    rimraf.sync(hierarchiesCacheDirectory);\r\n\r\n  // terminate frontend\r\n  PresentationFrontend.terminate();\r\n  await frontendApp.shutdown();\r\n\r\n  isInitialized = false;\r\n};\r\n"]}

package/lib/esm/presentation-testing/IModelUtilities.d.ts

@@ -0,0 +1,47 @@
+/** @packageDocumentation
+ * @module IModel
+ */
+import { IModelDb } from "@itwin/core-backend";
+import { Id64String } from "@itwin/core-bentley";
+import { BisCodeSpec, Code, CodeScopeProps, ElementAspectProps, ElementProps, ModelProps } from "@itwin/core-common";
+import { IModelConnection } from "@itwin/core-frontend";
+/**
+ * Interface for IModel builder pattern. Used for building IModels to test rulesets.
+ *
+ * @beta
+ */
+export interface TestIModelBuilder {
+    /** Insert a model into the builder's iModel */
+    insertModel<TProps extends ModelProps>(props: TProps): Id64String;
+    /** Insert an element into the builder's iModel */
+    insertElement<TProps extends ElementProps>(props: TProps): Id64String;
+    /** Insert an element aspect into the specified element */
+    insertAspect<TProps extends ElementAspectProps>(props: TProps): void;
+    /**
+     * Create code for specified element.
+     * Code value has to be unique within its scope (see [Codes documentation page]($docs/bis/guide/fundamentals/codes.md)).
+     */
+    createCode(scopeModelId: CodeScopeProps, codeSpecName: BisCodeSpec, codeValue: string): Code;
+}
+/**
+ * Function that creates an iModel and returns a connection to it.
+ * @param name Name of test IModel
+ * @param cb Callback function that receives an [[TestIModelBuilder]] to fill the iModel with data
+ *
+ * @beta
+ */
+export declare function buildTestIModel(name: string, cb: (builder: TestIModelBuilder) => void): Promise<IModelConnection>;
+/**
+ * Default implementation of IModel builder pattern. Used for building IModels to test rulesets.
+ *
+ * @internal
+ */
+export declare class IModelBuilder implements TestIModelBuilder {
+    private _iModel;
+    constructor(iModel: IModelDb);
+    insertModel<TProps extends ModelProps>(props: TProps): Id64String;
+    insertElement<TProps extends ElementProps>(props: TProps): Id64String;
+    insertAspect<TProps extends ElementAspectProps>(props: TProps): void;
+    createCode(scopeModelId: CodeScopeProps, codeSpecName: BisCodeSpec, codeValue: string): Code;
+}
+//# sourceMappingURL=IModelUtilities.d.ts.map

package/lib/esm/presentation-testing/IModelUtilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelUtilities.d.ts","sourceRoot":"","sources":["../../../src/presentation-testing/IModelUtilities.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAA0B,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,cAAc,EAAY,kBAAkB,EAAE,YAAY,EAAiB,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC9I,OAAO,EAAE,gBAAgB,EAAsB,MAAM,sBAAsB,CAAC;AAI5E;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,+CAA+C;IAC/C,WAAW,CAAC,MAAM,SAAS,UAAU,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC;IAClE,kDAAkD;IAClD,aAAa,CAAC,MAAM,SAAS,YAAY,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC;IACtE,0DAA0D;IAC1D,YAAY,CAAC,MAAM,SAAS,kBAAkB,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrE;;;OAGG;IACH,UAAU,CAAC,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9F;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAWvH;AAED;;;;GAIG;AACH,qBAAa,aAAc,YAAW,iBAAiB;IACrD,OAAO,CAAC,OAAO,CAAW;gBAEd,MAAM,EAAE,QAAQ;IAIrB,WAAW,CAAC,MAAM,SAAS,UAAU,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU;IAIjE,aAAa,CAAC,MAAM,SAAS,YAAY,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU;IAIrE,YAAY,CAAC,MAAM,SAAS,kBAAkB,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAIpE,UAAU,CAAC,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAIpG"}

package/lib/esm/presentation-testing/IModelUtilities.js

@@ -0,0 +1,70 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module IModel
+ */
+import { IModelJsFs, SnapshotDb } from "@itwin/core-backend";
+import { Code } from "@itwin/core-common";
+import { SnapshotConnection } from "@itwin/core-frontend";
+import path from "path";
+import { getTestOutputDir } from "./Helpers";
+/**
+ * Function that creates an iModel and returns a connection to it.
+ * @param name Name of test IModel
+ * @param cb Callback function that receives an [[TestIModelBuilder]] to fill the iModel with data
+ *
+ * @beta
+ */
+export async function buildTestIModel(name, cb) {
+    const outputFile = setupOutputFileLocation(name);
+    const db = SnapshotDb.createEmpty(outputFile, { rootSubject: { name } });
+    const builder = new IModelBuilder(db);
+    try {
+        cb(builder);
+    }
+    finally {
+        db.saveChanges("Created test IModel");
+        db.close();
+    }
+    return SnapshotConnection.openFile(outputFile);
+}
+/**
+ * Default implementation of IModel builder pattern. Used for building IModels to test rulesets.
+ *
+ * @internal
+ */
+export class IModelBuilder {
+    constructor(iModel) {
+        this._iModel = iModel;
+    }
+    insertModel(props) {
+        return this._iModel.models.insertModel(props);
+    }
+    insertElement(props) {
+        return this._iModel.elements.insertElement(props);
+    }
+    insertAspect(props) {
+        this._iModel.elements.insertAspect(props);
+    }
+    createCode(scopeModelId, codeSpecName, codeValue) {
+        const codeSpec = this._iModel.codeSpecs.getByName(codeSpecName);
+        return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
+    }
+}
+/**
+ * Prepare for an output file by:
+ * - Resolving the output file name under the known test output directory
+ * - Making directories as necessary
+ * - Removing a previous copy of the output file
+ * @param fileName Name of output file
+ */
+function setupOutputFileLocation(fileName) {
+    const testOutputDir = getTestOutputDir();
+    !IModelJsFs.existsSync(testOutputDir) && IModelJsFs.mkdirSync(testOutputDir);
+    const outputFile = path.join(testOutputDir, `${fileName}.bim`);
+    IModelJsFs.existsSync(outputFile) && IModelJsFs.unlinkSync(outputFile);
+    return outputFile;
+}
+//# sourceMappingURL=IModelUtilities.js.map

package/lib/esm/presentation-testing/IModelUtilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelUtilities.js","sourceRoot":"","sources":["../../../src/presentation-testing/IModelUtilities.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAY,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEvE,OAAO,EAAe,IAAI,EAAyF,MAAM,oBAAoB,CAAC;AAC9I,OAAO,EAAoB,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAqB7C;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,IAAY,EAAE,EAAwC;IAC1F,MAAM,UAAU,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;IACjD,MAAM,EAAE,GAAG,UAAU,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IACzE,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,EAAE,CAAC,CAAC;IACtC,IAAI;QACF,EAAE,CAAC,OAAO,CAAC,CAAC;KACb;YAAS;QACR,EAAE,CAAC,WAAW,CAAC,qBAAqB,CAAC,CAAC;QACtC,EAAE,CAAC,KAAK,EAAE,CAAC;KACZ;IACD,OAAO,kBAAkB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;AACjD,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,aAAa;IAGxB,YAAY,MAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAEM,WAAW,CAA4B,KAAa;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IAEM,aAAa,CAA8B,KAAa;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACpD,CAAC;IAEM,YAAY,CAAoC,KAAa;QAClE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAEM,UAAU,CAAC,YAA4B,EAAE,YAAyB,EAAE,SAAiB;QAC1F,MAAM,QAAQ,GAAa,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QAC1E,OAAO,IAAI,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAED;;;;;;GAMG;AACH,SAAS,uBAAuB,CAAC,QAAgB;IAC/C,MAAM,aAAa,GAAG,gBAAgB,EAAE,CAAC;IACzC,CAAC,UAAU,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,UAAU,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAE7E,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,QAAQ,MAAM,CAAC,CAAC;IAC/D,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IACvE,OAAO,UAAU,CAAC;AACpB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module IModel\r\n */\r\n\r\nimport { IModelDb, IModelJsFs, SnapshotDb } from \"@itwin/core-backend\";\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { BisCodeSpec, Code, CodeScopeProps, CodeSpec, ElementAspectProps, ElementProps, LocalFileName, ModelProps } from \"@itwin/core-common\";\r\nimport { IModelConnection, SnapshotConnection } from \"@itwin/core-frontend\";\r\nimport path from \"path\";\r\nimport { getTestOutputDir } from \"./Helpers\";\r\n\r\n/**\r\n * Interface for IModel builder pattern. Used for building IModels to test rulesets.\r\n *\r\n * @beta\r\n */\r\nexport interface TestIModelBuilder {\r\n  /** Insert a model into the builder's iModel */\r\n  insertModel<TProps extends ModelProps>(props: TProps): Id64String;\r\n  /** Insert an element into the builder's iModel */\r\n  insertElement<TProps extends ElementProps>(props: TProps): Id64String;\r\n  /** Insert an element aspect into the specified element */\r\n  insertAspect<TProps extends ElementAspectProps>(props: TProps): void;\r\n  /**\r\n   * Create code for specified element.\r\n   * Code value has to be unique within its scope (see [Codes documentation page]($docs/bis/guide/fundamentals/codes.md)).\r\n   */\r\n  createCode(scopeModelId: CodeScopeProps, codeSpecName: BisCodeSpec, codeValue: string): Code;\r\n}\r\n\r\n/**\r\n * Function that creates an iModel and returns a connection to it.\r\n * @param name Name of test IModel\r\n * @param cb Callback function that receives an [[TestIModelBuilder]] to fill the iModel with data\r\n *\r\n * @beta\r\n */\r\nexport async function buildTestIModel(name: string, cb: (builder: TestIModelBuilder) => void): Promise<IModelConnection> {\r\n  const outputFile = setupOutputFileLocation(name);\r\n  const db = SnapshotDb.createEmpty(outputFile, { rootSubject: { name } });\r\n  const builder = new IModelBuilder(db);\r\n  try {\r\n    cb(builder);\r\n  } finally {\r\n    db.saveChanges(\"Created test IModel\");\r\n    db.close();\r\n  }\r\n  return SnapshotConnection.openFile(outputFile);\r\n}\r\n\r\n/**\r\n * Default implementation of IModel builder pattern. Used for building IModels to test rulesets.\r\n *\r\n * @internal\r\n */\r\nexport class IModelBuilder implements TestIModelBuilder {\r\n  private _iModel: IModelDb;\r\n\r\n  constructor(iModel: IModelDb) {\r\n    this._iModel = iModel;\r\n  }\r\n\r\n  public insertModel<TProps extends ModelProps>(props: TProps): Id64String {\r\n    return this._iModel.models.insertModel(props);\r\n  }\r\n\r\n  public insertElement<TProps extends ElementProps>(props: TProps): Id64String {\r\n    return this._iModel.elements.insertElement(props);\r\n  }\r\n\r\n  public insertAspect<TProps extends ElementAspectProps>(props: TProps): void {\r\n    this._iModel.elements.insertAspect(props);\r\n  }\r\n\r\n  public createCode(scopeModelId: CodeScopeProps, codeSpecName: BisCodeSpec, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = this._iModel.codeSpecs.getByName(codeSpecName);\r\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\r\n  }\r\n}\r\n\r\n/**\r\n * Prepare for an output file by:\r\n * - Resolving the output file name under the known test output directory\r\n * - Making directories as necessary\r\n * - Removing a previous copy of the output file\r\n * @param fileName Name of output file\r\n */\r\nfunction setupOutputFileLocation(fileName: string): LocalFileName {\r\n  const testOutputDir = getTestOutputDir();\r\n  !IModelJsFs.existsSync(testOutputDir) && IModelJsFs.mkdirSync(testOutputDir);\r\n\r\n  const outputFile = path.join(testOutputDir, `${fileName}.bim`);\r\n  IModelJsFs.existsSync(outputFile) && IModelJsFs.unlinkSync(outputFile);\r\n  return outputFile;\r\n}\r\n"]}