@itwin/presentation-testing 4.0.0-dev.6 → 4.0.0-dev.8

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

@@ -1,115 +1,114 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @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";
-import { Guid } from "@itwin/core-bentley";
-import { EmptyLocalization, IModelReadRpcInterface, RpcConfiguration, RpcDefaultConfiguration, SnapshotIModelRpcInterface, } from "@itwin/core-common";
-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() {
-            super(...arguments);
-            this.interfaces = () => interfaces;
-        }
-    };
-    for (const definition of interfaces)
-        RpcConfiguration.assign(definition, () => config);
-    const instance = RpcConfiguration.obtain(config);
-    try {
-        RpcConfiguration.initializeInterfaces(instance);
-    }
-    catch {
-        // this may fail with "Error: RPC interface "xxx" is already initialized." because
-        // multiple different tests want to set up rpc 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,
- * frontend and RPC communication between them.
- *
- * @see `terminate`
- *
- * @public
- */
-export const initialize = async (props) => {
-    var _a;
-    if (isInitialized)
-        return;
-    if (!props)
-        props = {};
-    // set up rpc interfaces
-    initializeRpcInterfaces([SnapshotIModelRpcInterface, IModelReadRpcInterface, PresentationRpcInterface]);
-    // init backend
-    // make sure backend gets assigned an id which puts its resources into a unique directory
-    props.backendProps = (_a = props.backendProps) !== null && _a !== void 0 ? _a : {};
-    if (!props.backendProps.id)
-        props.backendProps.id = `test-${Guid.createValue()}`;
-    await IModelHost.startup({ cacheDir: join(__dirname, ".cache"), ...props.backendHostProps });
-    PresentationBackend.initialize(props.backendProps);
-    // init frontend
-    if (!props.frontendApp)
-        props.frontendApp = NoRenderApp;
-    props.frontendAppOptions = {
-        localization: new EmptyLocalization(),
-        ...props.frontendAppOptions,
-    };
-    await props.frontendApp.startup(props.frontendAppOptions);
-    const defaultFrontendProps = {
-        presentation: {
-            activeLocale: IModelApp.localization.getLanguageList()[0],
-        },
-    };
-    await PresentationFrontend.initialize({ ...defaultFrontendProps, ...props.frontendProps });
-    testOutputDir = props.testOutputDir;
-    isInitialized = true;
-};
-/**
- * Undoes the setup made by `initialize`.
- * @param frontendApp IModelApp implementation
- *
- * @see `initialize`
- *
- * @public
- */
-export const terminate = async (frontendApp = IModelApp) => {
-    var _a, _b, _c;
-    if (!isInitialized)
-        return;
-    // store directory that needs to be cleaned-up
-    let hierarchiesCacheDirectory;
-    const hierarchiesCacheConfig = (_b = (_a = PresentationBackend.initProps) === null || _a === void 0 ? void 0 : _a.caching) === null || _b === void 0 ? void 0 : _b.hierarchies;
-    if ((hierarchiesCacheConfig === null || hierarchiesCacheConfig === void 0 ? void 0 : hierarchiesCacheConfig.mode) === HierarchyCacheMode.Disk)
-        hierarchiesCacheDirectory = hierarchiesCacheConfig === null || hierarchiesCacheConfig === void 0 ? void 0 : hierarchiesCacheConfig.directory;
-    else if ((hierarchiesCacheConfig === null || hierarchiesCacheConfig === void 0 ? void 0 : hierarchiesCacheConfig.mode) === HierarchyCacheMode.Hybrid)
-        hierarchiesCacheDirectory = (_c = hierarchiesCacheConfig === null || hierarchiesCacheConfig === void 0 ? void 0 : hierarchiesCacheConfig.disk) === null || _c === void 0 ? void 0 : _c.directory;
-    // terminate backend
-    PresentationBackend.terminate();
-    await IModelHost.shutdown();
-    if (hierarchiesCacheDirectory)
-        rimraf.sync(hierarchiesCacheDirectory);
-    // terminate frontend
-    PresentationFrontend.terminate();
-    await frontendApp.shutdown();
-    isInitialized = false;
-};
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Helpers
+ */
+/* istanbul ignore file */ // TODO: Remove istanbul ignore file when https://github.com/iTwin/itwinjs-backlog/issues/463 is fixed.
+import { tmpdir } from "os";
+import { join } from "path";
+import * as rimraf from "rimraf";
+import { IModelHost } from "@itwin/core-backend";
+import { Guid } from "@itwin/core-bentley";
+import { IModelReadRpcInterface, RpcConfiguration, RpcDefaultConfiguration, SnapshotIModelRpcInterface, } from "@itwin/core-common";
+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";
+function initializeRpcInterfaces(interfaces) {
+    const config = class extends RpcDefaultConfiguration {
+        constructor() {
+            super(...arguments);
+            Object.defineProperty(this, "interfaces", {
+                enumerable: true,
+                configurable: true,
+                writable: true,
+                value: () => interfaces
+            });
+        }
+    };
+    for (const definition of interfaces)
+        RpcConfiguration.assign(definition, () => config);
+    const instance = RpcConfiguration.obtain(config);
+    try {
+        RpcConfiguration.initializeInterfaces(instance);
+    }
+    catch {
+        // this may fail with "Error: RPC interface "xxx" is already initialized." because
+        // multiple different tests want to set up rpc interfaces
+    }
+}
+let isInitialized = false;
+const defaultTestOutputDir = tmpdir();
+let testOutputDir;
+/** @internal */
+export const getTestOutputDir = () => {
+    return testOutputDir ?? defaultTestOutputDir;
+};
+// eslint-disable-next-line deprecation/deprecation
+export { HierarchyCacheMode, PresentationManagerMode };
+/**
+ * Initialize the framework for presentation testing. The function sets up backend,
+ * frontend and RPC communication between them.
+ *
+ * @see `terminate`
+ *
+ * @public
+ */
+export const initialize = async (props) => {
+    if (isInitialized)
+        return;
+    if (!props)
+        props = {};
+    // set up rpc interfaces
+    initializeRpcInterfaces([SnapshotIModelRpcInterface, IModelReadRpcInterface, PresentationRpcInterface]);
+    // init backend
+    // make sure backend gets assigned an id which puts its resources into a unique directory
+    props.backendProps = props.backendProps ?? {};
+    if (!props.backendProps.id)
+        props.backendProps.id = `test-${Guid.createValue()}`;
+    await IModelHost.startup({ cacheDir: join(__dirname, ".cache"), ...props.backendHostProps });
+    PresentationBackend.initialize(props.backendProps);
+    // init frontend
+    if (!props.frontendApp)
+        props.frontendApp = NoRenderApp;
+    await props.frontendApp.startup(props.frontendAppOptions);
+    const defaultFrontendProps = {
+        presentation: {
+            activeLocale: IModelApp.localization.getLanguageList()[0],
+        },
+    };
+    await PresentationFrontend.initialize({ ...defaultFrontendProps, ...props.frontendProps });
+    testOutputDir = props.testOutputDir;
+    isInitialized = true;
+};
+/**
+ * Undoes the setup made by `initialize`.
+ * @param frontendApp IModelApp implementation
+ *
+ * @see `initialize`
+ *
+ * @public
+ */
+export const terminate = async (frontendApp = IModelApp) => {
+    if (!isInitialized)
+        return;
+    // store directory that needs to be cleaned-up
+    let hierarchiesCacheDirectory;
+    const hierarchiesCacheConfig = PresentationBackend.initProps?.caching?.hierarchies;
+    if (hierarchiesCacheConfig?.mode === HierarchyCacheMode.Disk)
+        hierarchiesCacheDirectory = hierarchiesCacheConfig?.directory;
+    else if (hierarchiesCacheConfig?.mode === HierarchyCacheMode.Hybrid)
+        hierarchiesCacheDirectory = hierarchiesCacheConfig?.disk?.directory;
+    // terminate backend
+    PresentationBackend.terminate();
+    await IModelHost.shutdown();
+    if (hierarchiesCacheDirectory)
+        rimraf.sync(hierarchiesCacheDirectory);
+    // terminate frontend
+    PresentationFrontend.terminate();
+    await frontendApp.shutdown();
+    isInitialized = false;
+};
 //# sourceMappingURL=Helpers.js.map

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,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,iBAAiB,EACjB,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,KAAK,CAAC,kBAAkB,GAAG;QACzB,YAAY,EAAE,IAAI,iBAAiB,EAAE;QACrC,GAAG,KAAK,CAAC,kBAAkB;KAC5B,CAAC;IACF,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  EmptyLocalization,\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  props.frontendAppOptions = {\r\n    localization: new EmptyLocalization(), // Use EmptyLocalization if none is provided\r\n    ...props.frontendAppOptions,\r\n  };\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"]}
+{"version":3,"file":"Helpers.js","sourceRoot":"","sources":["../../../src/presentation-testing/Helpers.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,0BAA0B,CAAE,uGAAuG;AAEnI,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC;AAC5B,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;;YACb;;;;uBAAkC,GAAG,EAAE,CAAC,UAAU;eAAC;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,IAAI,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,KAAK,CAAC,YAAY,IAAI,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,mBAAmB,CAAC,SAAS,EAAE,OAAO,EAAE,WAAW,CAAC;IACnF,IAAI,sBAAsB,EAAE,IAAI,KAAK,kBAAkB,CAAC,IAAI;QAC1D,yBAAyB,GAAG,sBAAsB,EAAE,SAAS,CAAC;SAC3D,IAAI,sBAAsB,EAAE,IAAI,KAAK,kBAAkB,CAAC,MAAM;QACjE,yBAAyB,GAAG,sBAAsB,EAAE,IAAI,EAAE,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":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Helpers\n */\n\n/* istanbul ignore file */  // TODO: Remove istanbul ignore file when https://github.com/iTwin/itwinjs-backlog/issues/463 is fixed.\n\nimport { tmpdir } from \"os\";\nimport { join } from \"path\";\nimport * as rimraf from \"rimraf\";\nimport { IModelHost, IModelHostOptions } from \"@itwin/core-backend\";\nimport { Guid } from \"@itwin/core-bentley\";\nimport {\n  IModelReadRpcInterface, RpcConfiguration, RpcDefaultConfiguration, RpcInterfaceDefinition, SnapshotIModelRpcInterface,\n} from \"@itwin/core-common\";\nimport { IModelApp, IModelAppOptions, NoRenderApp } from \"@itwin/core-frontend\";\nimport {\n  HierarchyCacheMode, Presentation as PresentationBackend, PresentationManagerProps as PresentationBackendProps, PresentationManagerMode,\n} from \"@itwin/presentation-backend\";\nimport { PresentationRpcInterface } from \"@itwin/presentation-common\";\nimport { Presentation as PresentationFrontend, PresentationProps as PresentationFrontendProps } from \"@itwin/presentation-frontend\";\n\nfunction initializeRpcInterfaces(interfaces: RpcInterfaceDefinition[]) {\n  const config = class extends RpcDefaultConfiguration {\n    public override interfaces: any = () => interfaces;\n  };\n\n  for (const definition of interfaces)\n    RpcConfiguration.assign(definition, () => config);\n\n  const instance = RpcConfiguration.obtain(config);\n\n  try {\n    RpcConfiguration.initializeInterfaces(instance);\n  } catch {\n    // this may fail with \"Error: RPC interface \"xxx\" is already initialized.\" because\n    // multiple different tests want to set up rpc interfaces\n  }\n}\n\nlet isInitialized = false;\n\nconst defaultTestOutputDir = tmpdir();\nlet testOutputDir: string | undefined;\n\n/** @internal */\nexport const getTestOutputDir = (): string => {\n  return testOutputDir ?? defaultTestOutputDir;\n};\n\n// eslint-disable-next-line deprecation/deprecation\nexport { HierarchyCacheMode, PresentationManagerMode, PresentationBackendProps };\n\n/** @public */\nexport interface PresentationTestingInitProps {\n  /** Properties for backend initialization */\n  backendProps?: PresentationBackendProps;\n  /** Properties for `IModelHost` */\n  backendHostProps?: IModelHostOptions;\n  /** Properties for frontend initialization */\n  frontendProps?: PresentationFrontendProps;\n  /** IModelApp implementation */\n  frontendApp?: { startup: (opts?: IModelAppOptions) => Promise<void> };\n  /** `IModelApp` options */\n  frontendAppOptions?: IModelAppOptions;\n  /** Custom test output directory. Defaults to temporary directory provided by the OS. */\n  testOutputDir?: string;\n}\n\n/**\n * Initialize the framework for presentation testing. The function sets up backend,\n * frontend and RPC communication between them.\n *\n * @see `terminate`\n *\n * @public\n */\nexport const initialize = async (props?: PresentationTestingInitProps) => {\n  if (isInitialized)\n    return;\n\n  if (!props)\n    props = {};\n\n  // set up rpc interfaces\n  initializeRpcInterfaces([SnapshotIModelRpcInterface, IModelReadRpcInterface, PresentationRpcInterface]);\n\n  // init backend\n  // make sure backend gets assigned an id which puts its resources into a unique directory\n  props.backendProps = props.backendProps ?? {};\n  if (!props.backendProps.id)\n    props.backendProps.id = `test-${Guid.createValue()}`;\n  await IModelHost.startup({ cacheDir: join(__dirname, \".cache\"), ...props.backendHostProps });\n  PresentationBackend.initialize(props.backendProps);\n\n  // init frontend\n  if (!props.frontendApp)\n    props.frontendApp = NoRenderApp;\n  await props.frontendApp.startup(props.frontendAppOptions);\n  const defaultFrontendProps: PresentationFrontendProps = {\n    presentation: {\n      activeLocale: IModelApp.localization.getLanguageList()[0],\n    },\n  };\n  await PresentationFrontend.initialize({ ...defaultFrontendProps, ...props.frontendProps });\n  testOutputDir = props.testOutputDir;\n\n  isInitialized = true;\n};\n\n/**\n * Undoes the setup made by `initialize`.\n * @param frontendApp IModelApp implementation\n *\n * @see `initialize`\n *\n * @public\n */\nexport const terminate = async (frontendApp = IModelApp) => {\n  if (!isInitialized)\n    return;\n\n  // store directory that needs to be cleaned-up\n  let hierarchiesCacheDirectory: string | undefined;\n  const hierarchiesCacheConfig = PresentationBackend.initProps?.caching?.hierarchies;\n  if (hierarchiesCacheConfig?.mode === HierarchyCacheMode.Disk)\n    hierarchiesCacheDirectory = hierarchiesCacheConfig?.directory;\n  else if (hierarchiesCacheConfig?.mode === HierarchyCacheMode.Hybrid)\n    hierarchiesCacheDirectory = hierarchiesCacheConfig?.disk?.directory;\n\n  // terminate backend\n  PresentationBackend.terminate();\n  await IModelHost.shutdown();\n  if (hierarchiesCacheDirectory)\n    rimraf.sync(hierarchiesCacheDirectory);\n\n  // terminate frontend\n  PresentationFrontend.terminate();\n  await frontendApp.shutdown();\n\n  isInitialized = false;\n};\n"]}

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

@@ -1,67 +1,70 @@
-import { IModelConnection } from "@itwin/core-frontend";
-import { Omit, Ruleset } from "@itwin/presentation-common";
-import { TreeNodeItem } from "@itwin/components-react";
-/**
- * Structure that describes a Node with any indexed properties
- * except `children`.
- *
- * @public
- */
-export interface MappedNode {
-    /** Indexer for all properties in this data structure */
-    [index: string]: any;
-    /** Prohibited property */
-    children?: never;
-}
-/**
- * Node in a hierarchy.
- * @public
- */
-export interface HierarchyNode extends Omit<MappedNode, "children"> {
-    /** Children of this node */
-    children?: HierarchyNode[];
-}
-/**
- * A function that converts `TreeNodeItem` into a new custom object.
- * @public
- */
-export declare type NodeMappingFunc = (node: TreeNodeItem) => MappedNode;
-/**
- * Default [[NodeMappingFunc]] implementation that outputs the whole `TreeNodeItem` object.
- * @public
- */
-export declare const defaultNodeMappingFunc: NodeMappingFunc;
-/**
- * Properties for creating a `HierarchyBuilder` instance.
- * @public
- */
-export interface HierarchyBuilderProps {
-    /** The iModel to pull data from */
-    imodel: IModelConnection;
-    /**
-     * A function that maps node to something that the user of
-     * this API is interested in. E.g. custom implementation may skip some unimportant
-     * node properties to make resulting object smaller and easier to read.
-     */
-    nodeMappingFunc?: NodeMappingFunc;
-}
-/**
- * A class that constructs simple node hierarchy from specified
- * imodel and ruleset.
- *
- * @public
- */
-export declare class HierarchyBuilder {
-    private readonly _iModel;
-    private readonly _nodeMappingFunc;
-    /** Constructor */
-    constructor(props: HierarchyBuilderProps);
-    private createSubHierarchy;
-    private doCreateHierarchy;
-    /**
-     * Create a hierarchy using the supplied presentation ruleset.
-     * @param rulesetOrId Either a [[Ruleset]] object or a ruleset id.
-     */
-    createHierarchy(rulesetOrId: Ruleset | string): Promise<HierarchyNode[]>;
-}
+/** @packageDocumentation
+ * @module Hierarchies
+ */
+import { TreeNodeItem } from "@itwin/components-react";
+import { IModelConnection } from "@itwin/core-frontend";
+import { Omit, Ruleset } from "@itwin/presentation-common";
+/**
+ * Structure that describes a Node with any indexed properties
+ * except `children`.
+ *
+ * @public
+ */
+export interface MappedNode {
+    /** Indexer for all properties in this data structure */
+    [index: string]: any;
+    /** Prohibited property */
+    children?: never;
+}
+/**
+ * Node in a hierarchy.
+ * @public
+ */
+export interface HierarchyNode extends Omit<MappedNode, "children"> {
+    /** Children of this node */
+    children?: HierarchyNode[];
+}
+/**
+ * A function that converts `TreeNodeItem` into a new custom object.
+ * @public
+ */
+export declare type NodeMappingFunc = (node: TreeNodeItem) => MappedNode;
+/**
+ * Default [[NodeMappingFunc]] implementation that outputs the whole `TreeNodeItem` object.
+ * @public
+ */
+export declare const defaultNodeMappingFunc: NodeMappingFunc;
+/**
+ * Properties for creating a `HierarchyBuilder` instance.
+ * @public
+ */
+export interface HierarchyBuilderProps {
+    /** The iModel to pull data from */
+    imodel: IModelConnection;
+    /**
+     * A function that maps node to something that the user of
+     * this API is interested in. E.g. custom implementation may skip some unimportant
+     * node properties to make resulting object smaller and easier to read.
+     */
+    nodeMappingFunc?: NodeMappingFunc;
+}
+/**
+ * A class that constructs simple node hierarchy from specified
+ * imodel and ruleset.
+ *
+ * @public
+ */
+export declare class HierarchyBuilder {
+    private readonly _iModel;
+    private readonly _nodeMappingFunc;
+    /** Constructor */
+    constructor(props: HierarchyBuilderProps);
+    private createSubHierarchy;
+    private doCreateHierarchy;
+    /**
+     * Create a hierarchy using the supplied presentation ruleset.
+     * @param rulesetOrId Either a [[Ruleset]] object or a ruleset id.
+     */
+    createHierarchy(rulesetOrId: Ruleset | string): Promise<HierarchyNode[]>;
+}
 //# sourceMappingURL=HierarchyBuilder.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"HierarchyBuilder.d.ts","sourceRoot":"","sources":["../../../src/presentation-testing/HierarchyBuilder.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,IAAI,EAAqB,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAG9E,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,wDAAwD;IACxD,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;IACrB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC;IACjE,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED;;;GAGG;AACH,oBAAY,eAAe,GAAG,CAAC,IAAI,EAAE,YAAY,KAAK,UAAU,CAAC;AAEjE;;;GAGG;AACH,eAAO,MAAM,sBAAsB,EAAE,eAMpC,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,mCAAmC;IACnC,MAAM,EAAE,gBAAgB,CAAC;IACzB;;;;OAIG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED;;;;;GAKG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmB;IAC3C,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAkB;IAEnD,kBAAkB;gBACN,KAAK,EAAE,qBAAqB;YAK1B,kBAAkB;YAYlB,iBAAiB;IAM/B;;;OAGG;IACU,eAAe,CAAC,WAAW,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;CAQtF"}
+{"version":3,"file":"HierarchyBuilder.d.ts","sourceRoot":"","sources":["../../../src/presentation-testing/HierarchyBuilder.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,IAAI,EAAqB,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAI9E;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,wDAAwD;IACxD,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;IACrB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC;IACjE,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED;;;GAGG;AACH,oBAAY,eAAe,GAAG,CAAC,IAAI,EAAE,YAAY,KAAK,UAAU,CAAC;AAEjE;;;GAGG;AACH,eAAO,MAAM,sBAAsB,EAAE,eAMpC,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,mCAAmC;IACnC,MAAM,EAAE,gBAAgB,CAAC;IACzB;;;;OAIG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED;;;;;GAKG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmB;IAC3C,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAkB;IAEnD,kBAAkB;gBACN,KAAK,EAAE,qBAAqB;YAK1B,kBAAkB;YAYlB,iBAAiB;IAM/B;;;OAGG;IACU,eAAe,CAAC,WAAW,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;CAQtF"}

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

@@ -1,63 +1,74 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Hierarchies
- */
-import { using } from "@itwin/core-bentley";
-import { PresentationTreeDataProvider } from "@itwin/presentation-components";
-import { Presentation } from "@itwin/presentation-frontend";
-/**
- * Default [[NodeMappingFunc]] implementation that outputs the whole `TreeNodeItem` object.
- * @public
- */
-export const defaultNodeMappingFunc = (node) => {
-    // Skip properties 'id', 'parentId' as they contain  internal stuff
-    // that callers are most likely not interested in. Otherwise they can supply
-    // a custom `NodeMappingFunc` that does return those properties as well.
-    const { id, parentId, ...resultNode } = node; // eslint-disable-line @typescript-eslint/no-unused-vars
-    return resultNode;
-};
-/**
- * A class that constructs simple node hierarchy from specified
- * imodel and ruleset.
- *
- * @public
- */
-export class HierarchyBuilder {
-    /** Constructor */
-    constructor(props) {
-        var _a;
-        this._iModel = props.imodel;
-        this._nodeMappingFunc = (_a = props.nodeMappingFunc) !== null && _a !== void 0 ? _a : defaultNodeMappingFunc;
-    }
-    async createSubHierarchy(nodes, dataProvider) {
-        const hierarchy = [];
-        for (const node of nodes) {
-            const { key: _key, ...nodeNoKey } = node;
-            const nodeIndex = hierarchy.push(this._nodeMappingFunc(nodeNoKey)) - 1;
-            const childNodes = await dataProvider.getNodes(node);
-            if (childNodes.length > 0)
-                hierarchy[nodeIndex].children = await this.createSubHierarchy(childNodes, dataProvider);
-        }
-        return hierarchy;
-    }
-    async doCreateHierarchy(rulesetId) {
-        const dataProvider = new PresentationTreeDataProvider({ imodel: this._iModel, ruleset: rulesetId });
-        const rootNodes = await dataProvider.getNodes();
-        return this.createSubHierarchy(rootNodes, dataProvider);
-    }
-    /**
-     * Create a hierarchy using the supplied presentation ruleset.
-     * @param rulesetOrId Either a [[Ruleset]] object or a ruleset id.
-     */
-    async createHierarchy(rulesetOrId) {
-        if (typeof rulesetOrId === "string")
-            return this.doCreateHierarchy(rulesetOrId);
-        return using(await Presentation.presentation.rulesets().add(rulesetOrId), async (ruleset) => {
-            return this.doCreateHierarchy(ruleset.id);
-        });
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Hierarchies
+ */
+import { using } from "@itwin/core-bentley";
+import { PresentationTreeDataProvider } from "@itwin/presentation-components";
+import { Presentation } from "@itwin/presentation-frontend";
+/**
+ * Default [[NodeMappingFunc]] implementation that outputs the whole `TreeNodeItem` object.
+ * @public
+ */
+export const defaultNodeMappingFunc = (node) => {
+    // Skip properties 'id', 'parentId' as they contain  internal stuff
+    // that callers are most likely not interested in. Otherwise they can supply
+    // a custom `NodeMappingFunc` that does return those properties as well.
+    const { id, parentId, ...resultNode } = node; // eslint-disable-line @typescript-eslint/no-unused-vars
+    return resultNode;
+};
+/**
+ * A class that constructs simple node hierarchy from specified
+ * imodel and ruleset.
+ *
+ * @public
+ */
+export class HierarchyBuilder {
+    /** Constructor */
+    constructor(props) {
+        Object.defineProperty(this, "_iModel", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "_nodeMappingFunc", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this._iModel = props.imodel;
+        this._nodeMappingFunc = props.nodeMappingFunc ?? defaultNodeMappingFunc;
+    }
+    async createSubHierarchy(nodes, dataProvider) {
+        const hierarchy = [];
+        for (const node of nodes) {
+            const { key: _key, ...nodeNoKey } = node;
+            const nodeIndex = hierarchy.push(this._nodeMappingFunc(nodeNoKey)) - 1;
+            const childNodes = await dataProvider.getNodes(node);
+            if (childNodes.length > 0)
+                hierarchy[nodeIndex].children = await this.createSubHierarchy(childNodes, dataProvider);
+        }
+        return hierarchy;
+    }
+    async doCreateHierarchy(rulesetId) {
+        const dataProvider = new PresentationTreeDataProvider({ imodel: this._iModel, ruleset: rulesetId });
+        const rootNodes = await dataProvider.getNodes();
+        return this.createSubHierarchy(rootNodes, dataProvider);
+    }
+    /**
+     * Create a hierarchy using the supplied presentation ruleset.
+     * @param rulesetOrId Either a [[Ruleset]] object or a ruleset id.
+     */
+    async createHierarchy(rulesetOrId) {
+        if (typeof rulesetOrId === "string")
+            return this.doCreateHierarchy(rulesetOrId);
+        return using(await Presentation.presentation.rulesets().add(rulesetOrId), async (ruleset) => {
+            return this.doCreateHierarchy(ruleset.id);
+        });
+    }
+}
 //# sourceMappingURL=HierarchyBuilder.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"HierarchyBuilder.js","sourceRoot":"","sources":["../../../src/presentation-testing/HierarchyBuilder.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAG5C,OAAO,EAAE,4BAA4B,EAA4B,MAAM,gCAAgC,CAAC;AACxG,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AA+B5D;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAoB,CAAC,IAAkB,EAAE,EAAE;IAC5E,mEAAmE;IACnE,4EAA4E;IAC5E,wEAAwE;IACxE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC,wDAAwD;IACtG,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAiBF;;;;;GAKG;AACH,MAAM,OAAO,gBAAgB;IAI3B,kBAAkB;IAClB,YAAY,KAA4B;;QACtC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,gBAAgB,GAAG,MAAA,KAAK,CAAC,eAAe,mCAAI,sBAAsB,CAAC;IAC1E,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,KAAqB,EAAE,YAA0C;QAChG,MAAM,SAAS,GAAoB,EAAE,CAAC;QACtC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,SAAS,EAAE,GAAI,IAAiC,CAAC;YACvE,MAAM,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC;YACvE,MAAM,UAAU,GAAG,MAAM,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACrD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC;gBACvB,SAAS,CAAC,SAAS,CAAC,CAAC,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;SAC3F;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAAC,SAAiB;QAC/C,MAAM,YAAY,GAAG,IAAI,4BAA4B,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;QACpG,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,QAAQ,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,eAAe,CAAC,WAA6B;QACxD,IAAI,OAAO,WAAW,KAAK,QAAQ;YACjC,OAAO,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;QAE7C,OAAO,KAAK,CAAC,MAAM,YAAY,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,OAA0B,EAAE,EAAE;YAC7G,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Hierarchies\r\n */\r\nimport { using } from \"@itwin/core-bentley\";\r\nimport { IModelConnection } from \"@itwin/core-frontend\";\r\nimport { Omit, RegisteredRuleset, Ruleset } from \"@itwin/presentation-common\";\r\nimport { PresentationTreeDataProvider, PresentationTreeNodeItem } from \"@itwin/presentation-components\";\r\nimport { Presentation } from \"@itwin/presentation-frontend\";\r\nimport { TreeNodeItem } from \"@itwin/components-react\";\r\n\r\n/**\r\n * Structure that describes a Node with any indexed properties\r\n * except `children`.\r\n *\r\n * @public\r\n */\r\nexport interface MappedNode {\r\n  /** Indexer for all properties in this data structure */\r\n  [index: string]: any;\r\n  /** Prohibited property */\r\n  children?: never;\r\n}\r\n\r\n/**\r\n * Node in a hierarchy.\r\n * @public\r\n */\r\nexport interface HierarchyNode extends Omit<MappedNode, \"children\"> {\r\n  /** Children of this node */\r\n  children?: HierarchyNode[];\r\n}\r\n\r\n/**\r\n * A function that converts `TreeNodeItem` into a new custom object.\r\n * @public\r\n */\r\nexport type NodeMappingFunc = (node: TreeNodeItem) => MappedNode;\r\n\r\n/**\r\n * Default [[NodeMappingFunc]] implementation that outputs the whole `TreeNodeItem` object.\r\n * @public\r\n */\r\nexport const defaultNodeMappingFunc: NodeMappingFunc = (node: TreeNodeItem) => {\r\n  // Skip properties 'id', 'parentId' as they contain  internal stuff\r\n  // that callers are most likely not interested in. Otherwise they can supply\r\n  // a custom `NodeMappingFunc` that does return those properties as well.\r\n  const { id, parentId, ...resultNode } = node; // eslint-disable-line @typescript-eslint/no-unused-vars\r\n  return resultNode;\r\n};\r\n\r\n/**\r\n * Properties for creating a `HierarchyBuilder` instance.\r\n * @public\r\n */\r\nexport interface HierarchyBuilderProps {\r\n  /** The iModel to pull data from */\r\n  imodel: IModelConnection;\r\n  /**\r\n   * A function that maps node to something that the user of\r\n   * this API is interested in. E.g. custom implementation may skip some unimportant\r\n   * node properties to make resulting object smaller and easier to read.\r\n   */\r\n  nodeMappingFunc?: NodeMappingFunc;\r\n}\r\n\r\n/**\r\n * A class that constructs simple node hierarchy from specified\r\n * imodel and ruleset.\r\n *\r\n * @public\r\n */\r\nexport class HierarchyBuilder {\r\n  private readonly _iModel: IModelConnection;\r\n  private readonly _nodeMappingFunc: NodeMappingFunc;\r\n\r\n  /** Constructor */\r\n  constructor(props: HierarchyBuilderProps) {\r\n    this._iModel = props.imodel;\r\n    this._nodeMappingFunc = props.nodeMappingFunc ?? defaultNodeMappingFunc;\r\n  }\r\n\r\n  private async createSubHierarchy(nodes: TreeNodeItem[], dataProvider: PresentationTreeDataProvider) {\r\n    const hierarchy: HierarchyNode[] = [];\r\n    for (const node of nodes) {\r\n      const { key: _key, ...nodeNoKey } = (node as PresentationTreeNodeItem);\r\n      const nodeIndex = hierarchy.push(this._nodeMappingFunc(nodeNoKey)) - 1;\r\n      const childNodes = await dataProvider.getNodes(node);\r\n      if (childNodes.length > 0)\r\n        hierarchy[nodeIndex].children = await this.createSubHierarchy(childNodes, dataProvider);\r\n    }\r\n    return hierarchy;\r\n  }\r\n\r\n  private async doCreateHierarchy(rulesetId: string): Promise<HierarchyNode[]> {\r\n    const dataProvider = new PresentationTreeDataProvider({ imodel: this._iModel, ruleset: rulesetId });\r\n    const rootNodes = await dataProvider.getNodes();\r\n    return this.createSubHierarchy(rootNodes, dataProvider);\r\n  }\r\n\r\n  /**\r\n   * Create a hierarchy using the supplied presentation ruleset.\r\n   * @param rulesetOrId Either a [[Ruleset]] object or a ruleset id.\r\n   */\r\n  public async createHierarchy(rulesetOrId: Ruleset | string): Promise<HierarchyNode[]> {\r\n    if (typeof rulesetOrId === \"string\")\r\n      return this.doCreateHierarchy(rulesetOrId);\r\n\r\n    return using(await Presentation.presentation.rulesets().add(rulesetOrId), async (ruleset: RegisteredRuleset) => {\r\n      return this.doCreateHierarchy(ruleset.id);\r\n    });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"HierarchyBuilder.js","sourceRoot":"","sources":["../../../src/presentation-testing/HierarchyBuilder.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAG5C,OAAO,EAAE,4BAA4B,EAA4B,MAAM,gCAAgC,CAAC;AACxG,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AA8B5D;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAoB,CAAC,IAAkB,EAAE,EAAE;IAC5E,mEAAmE;IACnE,4EAA4E;IAC5E,wEAAwE;IACxE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC,wDAAwD;IACtG,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAiBF;;;;;GAKG;AACH,MAAM,OAAO,gBAAgB;IAI3B,kBAAkB;IAClB,YAAY,KAA4B;QAJxC;;;;;WAA2C;QAC3C;;;;;WAAmD;QAIjD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,eAAe,IAAI,sBAAsB,CAAC;IAC1E,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,KAAqB,EAAE,YAA0C;QAChG,MAAM,SAAS,GAAoB,EAAE,CAAC;QACtC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,SAAS,EAAE,GAAI,IAAiC,CAAC;YACvE,MAAM,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC;YACvE,MAAM,UAAU,GAAG,MAAM,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACrD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC;gBACvB,SAAS,CAAC,SAAS,CAAC,CAAC,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;SAC3F;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAAC,SAAiB;QAC/C,MAAM,YAAY,GAAG,IAAI,4BAA4B,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;QACpG,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,QAAQ,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,eAAe,CAAC,WAA6B;QACxD,IAAI,OAAO,WAAW,KAAK,QAAQ;YACjC,OAAO,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;QAE7C,OAAO,KAAK,CAAC,MAAM,YAAY,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,OAA0B,EAAE,EAAE;YAC7G,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Hierarchies\n */\n\nimport { TreeNodeItem } from \"@itwin/components-react\";\nimport { using } from \"@itwin/core-bentley\";\nimport { IModelConnection } from \"@itwin/core-frontend\";\nimport { Omit, RegisteredRuleset, Ruleset } from \"@itwin/presentation-common\";\nimport { PresentationTreeDataProvider, PresentationTreeNodeItem } from \"@itwin/presentation-components\";\nimport { Presentation } from \"@itwin/presentation-frontend\";\n\n/**\n * Structure that describes a Node with any indexed properties\n * except `children`.\n *\n * @public\n */\nexport interface MappedNode {\n  /** Indexer for all properties in this data structure */\n  [index: string]: any;\n  /** Prohibited property */\n  children?: never;\n}\n\n/**\n * Node in a hierarchy.\n * @public\n */\nexport interface HierarchyNode extends Omit<MappedNode, \"children\"> {\n  /** Children of this node */\n  children?: HierarchyNode[];\n}\n\n/**\n * A function that converts `TreeNodeItem` into a new custom object.\n * @public\n */\nexport type NodeMappingFunc = (node: TreeNodeItem) => MappedNode;\n\n/**\n * Default [[NodeMappingFunc]] implementation that outputs the whole `TreeNodeItem` object.\n * @public\n */\nexport const defaultNodeMappingFunc: NodeMappingFunc = (node: TreeNodeItem) => {\n  // Skip properties 'id', 'parentId' as they contain  internal stuff\n  // that callers are most likely not interested in. Otherwise they can supply\n  // a custom `NodeMappingFunc` that does return those properties as well.\n  const { id, parentId, ...resultNode } = node; // eslint-disable-line @typescript-eslint/no-unused-vars\n  return resultNode;\n};\n\n/**\n * Properties for creating a `HierarchyBuilder` instance.\n * @public\n */\nexport interface HierarchyBuilderProps {\n  /** The iModel to pull data from */\n  imodel: IModelConnection;\n  /**\n   * A function that maps node to something that the user of\n   * this API is interested in. E.g. custom implementation may skip some unimportant\n   * node properties to make resulting object smaller and easier to read.\n   */\n  nodeMappingFunc?: NodeMappingFunc;\n}\n\n/**\n * A class that constructs simple node hierarchy from specified\n * imodel and ruleset.\n *\n * @public\n */\nexport class HierarchyBuilder {\n  private readonly _iModel: IModelConnection;\n  private readonly _nodeMappingFunc: NodeMappingFunc;\n\n  /** Constructor */\n  constructor(props: HierarchyBuilderProps) {\n    this._iModel = props.imodel;\n    this._nodeMappingFunc = props.nodeMappingFunc ?? defaultNodeMappingFunc;\n  }\n\n  private async createSubHierarchy(nodes: TreeNodeItem[], dataProvider: PresentationTreeDataProvider) {\n    const hierarchy: HierarchyNode[] = [];\n    for (const node of nodes) {\n      const { key: _key, ...nodeNoKey } = (node as PresentationTreeNodeItem);\n      const nodeIndex = hierarchy.push(this._nodeMappingFunc(nodeNoKey)) - 1;\n      const childNodes = await dataProvider.getNodes(node);\n      if (childNodes.length > 0)\n        hierarchy[nodeIndex].children = await this.createSubHierarchy(childNodes, dataProvider);\n    }\n    return hierarchy;\n  }\n\n  private async doCreateHierarchy(rulesetId: string): Promise<HierarchyNode[]> {\n    const dataProvider = new PresentationTreeDataProvider({ imodel: this._iModel, ruleset: rulesetId });\n    const rootNodes = await dataProvider.getNodes();\n    return this.createSubHierarchy(rootNodes, dataProvider);\n  }\n\n  /**\n   * Create a hierarchy using the supplied presentation ruleset.\n   * @param rulesetOrId Either a [[Ruleset]] object or a ruleset id.\n   */\n  public async createHierarchy(rulesetOrId: Ruleset | string): Promise<HierarchyNode[]> {\n    if (typeof rulesetOrId === \"string\")\n      return this.doCreateHierarchy(rulesetOrId);\n\n    return using(await Presentation.presentation.rulesets().add(rulesetOrId), async (ruleset: RegisteredRuleset) => {\n      return this.doCreateHierarchy(ruleset.id);\n    });\n  }\n}\n"]}