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

package/lib/cjs/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/cjs/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/cjs/presentation-testing/HierarchyBuilder.js

@@ -1,68 +1,79 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HierarchyBuilder = exports.defaultNodeMappingFunc = 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 Hierarchies
- */
-const core_bentley_1 = require("@itwin/core-bentley");
-const presentation_components_1 = require("@itwin/presentation-components");
-const presentation_frontend_1 = require("@itwin/presentation-frontend");
-/**
- * Default [[NodeMappingFunc]] implementation that outputs the whole `TreeNodeItem` object.
- * @public
- */
-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;
-};
-exports.defaultNodeMappingFunc = defaultNodeMappingFunc;
-/**
- * A class that constructs simple node hierarchy from specified
- * imodel and ruleset.
- *
- * @public
- */
-class HierarchyBuilder {
-    /** Constructor */
-    constructor(props) {
-        var _a;
-        this._iModel = props.imodel;
-        this._nodeMappingFunc = (_a = props.nodeMappingFunc) !== null && _a !== void 0 ? _a : exports.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 presentation_components_1.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 (0, core_bentley_1.using)(await presentation_frontend_1.Presentation.presentation.rulesets().add(rulesetOrId), async (ruleset) => {
-            return this.doCreateHierarchy(ruleset.id);
-        });
-    }
-}
-exports.HierarchyBuilder = HierarchyBuilder;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Hierarchies
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HierarchyBuilder = exports.defaultNodeMappingFunc = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const presentation_components_1 = require("@itwin/presentation-components");
+const presentation_frontend_1 = require("@itwin/presentation-frontend");
+/**
+ * Default [[NodeMappingFunc]] implementation that outputs the whole `TreeNodeItem` object.
+ * @public
+ */
+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;
+};
+exports.defaultNodeMappingFunc = defaultNodeMappingFunc;
+/**
+ * A class that constructs simple node hierarchy from specified
+ * imodel and ruleset.
+ *
+ * @public
+ */
+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 ?? exports.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 presentation_components_1.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 (0, core_bentley_1.using)(await presentation_frontend_1.Presentation.presentation.rulesets().add(rulesetOrId), async (ruleset) => {
+            return this.doCreateHierarchy(ruleset.id);
+        });
+    }
+}
+exports.HierarchyBuilder = HierarchyBuilder;
 //# sourceMappingURL=HierarchyBuilder.js.map

package/lib/cjs/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,sDAA4C;AAG5C,4EAAwG;AACxG,wEAA4D;AA+B5D;;;GAGG;AACI,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;AANW,QAAA,sBAAsB,0BAMjC;AAiBF;;;;;GAKG;AACH,MAAa,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,8BAAsB,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,sDAA4B,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,IAAA,oBAAK,EAAC,MAAM,oCAAY,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;AAxCD,4CAwCC","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,sDAA4C;AAG5C,4EAAwG;AACxG,wEAA4D;AA8B5D;;;GAGG;AACI,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;AANW,QAAA,sBAAsB,0BAMjC;AAiBF;;;;;GAKG;AACH,MAAa,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,8BAAsB,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,sDAA4B,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,IAAA,oBAAK,EAAC,MAAM,oCAAY,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;AAxCD,4CAwCC","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"]}

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

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

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

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

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

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

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

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