@itwin/presentation-testing 3.7.12 → 3.7.13

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

@@ -1,43 +1,43 @@
-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 {
-    /** Properties for backend initialization */
-    backendProps?: PresentationBackendProps;
-    /** Properties for `IModelHost` */
-    backendHostProps?: IModelHostOptions;
-    /** Properties for frontend initialization */
-    frontendProps?: PresentationFrontendProps;
-    /** IModelApp implementation */
-    frontendApp?: {
-        startup: (opts?: IModelAppOptions) => Promise<void>;
-    };
-    /** `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,
- * frontend and RPC communication between them.
- *
- * @see `terminate`
- *
- * @public
- */
-export declare const initialize: (props?: PresentationTestingInitProps | undefined) => Promise<void>;
-/**
- * Undoes the setup made by `initialize`.
- * @param frontendApp IModelApp implementation
- *
- * @see `initialize`
- *
- * @public
- */
-export declare const terminate: (frontendApp?: typeof IModelApp) => Promise<void>;
+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 {
+    /** Properties for backend initialization */
+    backendProps?: PresentationBackendProps;
+    /** Properties for `IModelHost` */
+    backendHostProps?: IModelHostOptions;
+    /** Properties for frontend initialization */
+    frontendProps?: PresentationFrontendProps;
+    /** IModelApp implementation */
+    frontendApp?: {
+        startup: (opts?: IModelAppOptions) => Promise<void>;
+    };
+    /** `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,
+ * frontend and RPC communication between them.
+ *
+ * @see `terminate`
+ *
+ * @public
+ */
+export declare const initialize: (props?: PresentationTestingInitProps | undefined) => Promise<void>;
+/**
+ * Undoes the setup made by `initialize`.
+ * @param frontendApp IModelApp implementation
+ *
+ * @see `initialize`
+ *
+ * @public
+ */
+export declare const terminate: (frontendApp?: typeof IModelApp) => Promise<void>;
 //# sourceMappingURL=Helpers.d.ts.map

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

@@ -1,140 +1,140 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-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.
-*--------------------------------------------------------------------------------------------*/
-/** @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");
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_common_1 = require("@itwin/core-common");
-const core_frontend_1 = require("@itwin/core-frontend");
-const presentation_backend_1 = require("@itwin/presentation-backend");
-Object.defineProperty(exports, "HierarchyCacheMode", { enumerable: true, get: function () { return presentation_backend_1.HierarchyCacheMode; } });
-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() {
-            super(...arguments);
-            this.interfaces = () => interfaces;
-        }
-    };
-    for (const definition of interfaces)
-        core_common_1.RpcConfiguration.assign(definition, () => config);
-    const instance = core_common_1.RpcConfiguration.obtain(config);
-    try {
-        core_common_1.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 = (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.
- *
- * @see `terminate`
- *
- * @public
- */
-const initialize = async (props) => {
-    var _a;
-    if (isInitialized)
-        return;
-    if (!props)
-        props = {};
-    // set up rpc interfaces
-    initializeRpcInterfaces([core_common_1.SnapshotIModelRpcInterface, core_common_1.IModelReadRpcInterface, presentation_common_1.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-${core_bentley_1.Guid.createValue()}`;
-    await core_backend_1.IModelHost.startup({ cacheDir: (0, path_1.join)(__dirname, ".cache"), ...props.backendHostProps });
-    presentation_backend_1.Presentation.initialize(props.backendProps);
-    // init frontend
-    if (!props.frontendApp)
-        props.frontendApp = core_frontend_1.NoRenderApp;
-    props.frontendAppOptions = {
-        localization: new core_common_1.EmptyLocalization(),
-        ...props.frontendAppOptions,
-    };
-    await props.frontendApp.startup(props.frontendAppOptions);
-    const defaultFrontendProps = {
-        presentation: {
-            activeLocale: core_frontend_1.IModelApp.localization.getLanguageList()[0],
-        },
-    };
-    await presentation_frontend_1.Presentation.initialize({ ...defaultFrontendProps, ...props.frontendProps });
-    testOutputDir = props.testOutputDir;
-    isInitialized = true;
-};
-exports.initialize = initialize;
-/**
- * Undoes the setup made by `initialize`.
- * @param frontendApp IModelApp implementation
- *
- * @see `initialize`
- *
- * @public
- */
-const terminate = async (frontendApp = core_frontend_1.IModelApp) => {
-    var _a, _b, _c;
-    if (!isInitialized)
-        return;
-    // store directory that needs to be cleaned-up
-    let hierarchiesCacheDirectory;
-    const hierarchiesCacheConfig = (_b = (_a = presentation_backend_1.Presentation.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) === presentation_backend_1.HierarchyCacheMode.Disk)
-        hierarchiesCacheDirectory = hierarchiesCacheConfig === null || hierarchiesCacheConfig === void 0 ? void 0 : hierarchiesCacheConfig.directory;
-    else if ((hierarchiesCacheConfig === null || hierarchiesCacheConfig === void 0 ? void 0 : hierarchiesCacheConfig.mode) === presentation_backend_1.HierarchyCacheMode.Hybrid)
-        hierarchiesCacheDirectory = (_c = hierarchiesCacheConfig === null || hierarchiesCacheConfig === void 0 ? void 0 : hierarchiesCacheConfig.disk) === null || _c === void 0 ? void 0 : _c.directory;
-    // terminate backend
-    presentation_backend_1.Presentation.terminate();
-    await core_backend_1.IModelHost.shutdown();
-    if (hierarchiesCacheDirectory)
-        rimraf.sync(hierarchiesCacheDirectory);
-    // terminate frontend
-    presentation_frontend_1.Presentation.terminate();
-    await frontendApp.shutdown();
-    isInitialized = false;
-};
-exports.terminate = terminate;
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+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.
+*--------------------------------------------------------------------------------------------*/
+/** @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");
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const core_frontend_1 = require("@itwin/core-frontend");
+const presentation_backend_1 = require("@itwin/presentation-backend");
+Object.defineProperty(exports, "HierarchyCacheMode", { enumerable: true, get: function () { return presentation_backend_1.HierarchyCacheMode; } });
+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() {
+            super(...arguments);
+            this.interfaces = () => interfaces;
+        }
+    };
+    for (const definition of interfaces)
+        core_common_1.RpcConfiguration.assign(definition, () => config);
+    const instance = core_common_1.RpcConfiguration.obtain(config);
+    try {
+        core_common_1.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 = (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.
+ *
+ * @see `terminate`
+ *
+ * @public
+ */
+const initialize = async (props) => {
+    var _a;
+    if (isInitialized)
+        return;
+    if (!props)
+        props = {};
+    // set up rpc interfaces
+    initializeRpcInterfaces([core_common_1.SnapshotIModelRpcInterface, core_common_1.IModelReadRpcInterface, presentation_common_1.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-${core_bentley_1.Guid.createValue()}`;
+    await core_backend_1.IModelHost.startup({ cacheDir: (0, path_1.join)(__dirname, ".cache"), ...props.backendHostProps });
+    presentation_backend_1.Presentation.initialize(props.backendProps);
+    // init frontend
+    if (!props.frontendApp)
+        props.frontendApp = core_frontend_1.NoRenderApp;
+    props.frontendAppOptions = {
+        localization: new core_common_1.EmptyLocalization(),
+        ...props.frontendAppOptions,
+    };
+    await props.frontendApp.startup(props.frontendAppOptions);
+    const defaultFrontendProps = {
+        presentation: {
+            activeLocale: core_frontend_1.IModelApp.localization.getLanguageList()[0],
+        },
+    };
+    await presentation_frontend_1.Presentation.initialize({ ...defaultFrontendProps, ...props.frontendProps });
+    testOutputDir = props.testOutputDir;
+    isInitialized = true;
+};
+exports.initialize = initialize;
+/**
+ * Undoes the setup made by `initialize`.
+ * @param frontendApp IModelApp implementation
+ *
+ * @see `initialize`
+ *
+ * @public
+ */
+const terminate = async (frontendApp = core_frontend_1.IModelApp) => {
+    var _a, _b, _c;
+    if (!isInitialized)
+        return;
+    // store directory that needs to be cleaned-up
+    let hierarchiesCacheDirectory;
+    const hierarchiesCacheConfig = (_b = (_a = presentation_backend_1.Presentation.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) === presentation_backend_1.HierarchyCacheMode.Disk)
+        hierarchiesCacheDirectory = hierarchiesCacheConfig === null || hierarchiesCacheConfig === void 0 ? void 0 : hierarchiesCacheConfig.directory;
+    else if ((hierarchiesCacheConfig === null || hierarchiesCacheConfig === void 0 ? void 0 : hierarchiesCacheConfig.mode) === presentation_backend_1.HierarchyCacheMode.Hybrid)
+        hierarchiesCacheDirectory = (_c = hierarchiesCacheConfig === null || hierarchiesCacheConfig === void 0 ? void 0 : hierarchiesCacheConfig.disk) === null || _c === void 0 ? void 0 : _c.directory;
+    // terminate backend
+    presentation_backend_1.Presentation.terminate();
+    await core_backend_1.IModelHost.shutdown();
+    if (hierarchiesCacheDirectory)
+        rimraf.sync(hierarchiesCacheDirectory);
+    // terminate frontend
+    presentation_frontend_1.Presentation.terminate();
+    await frontendApp.shutdown();
+    isInitialized = false;
+};
+exports.terminate = terminate;
 //# sourceMappingURL=Helpers.js.map

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,0BAA0B,CAAE,uGAAuG;AACnI,+BAA4B;AAC5B,+CAAiC;AACjC,sDAAoE;AACpE,sDAA2C;AAC3C,oDAG4B;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,KAAK,CAAC,kBAAkB,GAAG;QACzB,YAAY,EAAE,IAAI,+BAAiB,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,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;AAnCW,QAAA,UAAU,cAmCrB;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":["/*---------------------------------------------------------------------------------------------\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/* istanbul ignore file */  // TODO: Remove istanbul ignore file when https://github.com/iTwin/itwinjs-backlog/issues/463 is fixed.\nimport { join } from \"path\";\nimport * as rimraf from \"rimraf\";\nimport { IModelHost, IModelHostOptions } from \"@itwin/core-backend\";\nimport { Guid } from \"@itwin/core-bentley\";\nimport {\n  EmptyLocalization,\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\";\nimport { tmpdir } from \"os\";\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  props.frontendAppOptions = {\n    localization: new EmptyLocalization(), // Use EmptyLocalization if none is provided\n    ...props.frontendAppOptions,\n  };\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"]}
+{"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,oDAG4B;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,KAAK,CAAC,kBAAkB,GAAG;QACzB,YAAY,EAAE,IAAI,+BAAiB,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,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;AAnCW,QAAA,UAAU,cAmCrB;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  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"]}

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

@@ -1,67 +1,67 @@
-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[]>;
-}
+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[]>;
+}
 //# sourceMappingURL=HierarchyBuilder.d.ts.map