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

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

@@ -1,13 +1,13 @@
 /** @packageDocumentation
  * @module IModel
  */
+/// <reference types="mocha" />
 import { IModelDb } from "@itwin/core-backend";
 import { Id64String } from "@itwin/core-bentley";
-import { BisCodeSpec, Code, CodeScopeProps, ElementAspectProps, ElementProps, ModelProps } from "@itwin/core-common";
+import { BisCodeSpec, Code, CodeScopeProps, ElementAspectProps, ElementProps, ModelProps, RelationshipProps } 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 {
@@ -16,7 +16,12 @@ export interface TestIModelBuilder {
     /** 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;
+    insertAspect<TProps extends ElementAspectProps>(props: TProps): Id64String;
+    /**
+     * Insert a relationship between two instances. The relationship is expected to be a subclass
+     * of `BisCore:ElementRefersToElements` or `BisCore:ElementDrivesElement`.
+     */
+    insertRelationship<TProps extends RelationshipProps>(props: TProps): Id64String;
     /**
      * Create code for specified element.
      * Code value has to be unique within its scope (see [Codes documentation page]($docs/bis/guide/fundamentals/codes.md)).
@@ -27,10 +32,16 @@ export interface TestIModelBuilder {
  * 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>;
+/**
+ * Function that creates an iModel and returns a connection to it.
+ * @param mochaContext Mocha context to generate iModel name from
+ * @param cb Callback function that receives an [[TestIModelBuilder]] to fill the iModel with data
+ * @beta
+ */
+export declare function buildTestIModel(mochaContext: Mocha.Context, cb: (builder: TestIModelBuilder) => void): Promise<IModelConnection>;
 /**
  * Default implementation of IModel builder pattern. Used for building IModels to test rulesets.
  *
@@ -41,7 +52,10 @@ export declare class IModelBuilder implements TestIModelBuilder {
     constructor(iModel: IModelDb);
     insertModel<TProps extends ModelProps>(props: TProps): Id64String;
     insertElement<TProps extends ElementProps>(props: TProps): Id64String;
-    insertAspect<TProps extends ElementAspectProps>(props: TProps): void;
+    insertAspect<TProps extends ElementAspectProps>(props: TProps): Id64String;
+    insertRelationship<TProps extends RelationshipProps>(props: TProps): Id64String;
     createCode(scopeModelId: CodeScopeProps, codeSpecName: BisCodeSpec, codeValue: string): Code;
 }
+/** @internal */
+export declare function createFileNameFromString(str: string): string;
 //# sourceMappingURL=IModelUtilities.d.ts.map

package/lib/esm/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;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"}
+{"version":3,"file":"IModelUtilities.d.ts","sourceRoot":"","sources":["../../../src/presentation-testing/IModelUtilities.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAIH,OAAO,EAAE,QAAQ,EAA0B,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EACL,WAAW,EACX,IAAI,EACJ,cAAc,EAEd,kBAAkB,EAClB,YAAY,EAEZ,UAAU,EACV,iBAAiB,EAClB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAsB,MAAM,sBAAsB,CAAC;AAG5E;;;GAGG;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,UAAU,CAAC;IAC3E;;;OAGG;IACH,kBAAkB,CAAC,MAAM,SAAS,iBAAiB,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC;IAChF;;;OAGG;IACH,UAAU,CAAC,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9F;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AACzH;;;;;GAKG;AAEH,wBAAsB,eAAe,CAAC,YAAY,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAexI;;;;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,UAAU;IAI1E,kBAAkB,CAAC,MAAM,SAAS,iBAAiB,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU;IAI/E,UAAU,CAAC,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAIpG;AAkBD,gBAAgB;AAChB,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,MAAM,UAEnD"}

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

@@ -1,23 +1,18 @@
 /*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
 /** @packageDocumentation
  * @module IModel
  */
 import path from "path";
+import sanitize from "sanitize-filename";
 import { IModelJsFs, SnapshotDb } from "@itwin/core-backend";
-import { Code } from "@itwin/core-common";
+import { Code, } from "@itwin/core-common";
 import { SnapshotConnection } from "@itwin/core-frontend";
 import { getTestOutputDir } from "./Helpers";
-/**
- * Function that creates an iModel and returns a connection to it.
- * @param name Name of test IModel
- * @param cb Callback function that receives an [[TestIModelBuilder]] to fill the iModel with data
- *
- * @beta
- */
-export async function buildTestIModel(name, cb) {
+export async function buildTestIModel(nameParam, cb) {
+    const name = typeof nameParam === "string" ? nameParam : createFileNameFromString(nameParam.test.fullTitle());
     const outputFile = setupOutputFileLocation(name);
     const db = SnapshotDb.createEmpty(outputFile, { rootSubject: { name } });
     const builder = new IModelBuilder(db);
@@ -52,7 +47,10 @@ export class IModelBuilder {
         return this._iModel.elements.insertElement(props);
     }
     insertAspect(props) {
-        this._iModel.elements.insertAspect(props);
+        return this._iModel.elements.insertAspect(props);
+    }
+    insertRelationship(props) {
+        return this._iModel.relationships.insertInstance(props);
     }
     createCode(scopeModelId, codeSpecName, codeValue) {
         const codeSpec = this._iModel.codeSpecs.getByName(codeSpecName);
@@ -73,4 +71,8 @@ function setupOutputFileLocation(fileName) {
     IModelJsFs.existsSync(outputFile) && IModelJsFs.unlinkSync(outputFile);
     return outputFile;
 }
+/** @internal */
+export function createFileNameFromString(str) {
+    return sanitize(str.replace(/[ ]+/g, "-")).toLocaleLowerCase();
+}
 //# sourceMappingURL=IModelUtilities.js.map

package/lib/esm/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,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAY,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEvE,OAAO,EAAe,IAAI,EAAyF,MAAM,oBAAoB,CAAC;AAC9I,OAAO,EAAoB,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAqB7C;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,IAAY,EAAE,EAAwC;IAC1F,MAAM,UAAU,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;IACjD,MAAM,EAAE,GAAG,UAAU,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IACzE,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,EAAE,CAAC,CAAC;IACtC,IAAI;QACF,EAAE,CAAC,OAAO,CAAC,CAAC;KACb;YAAS;QACR,EAAE,CAAC,WAAW,CAAC,qBAAqB,CAAC,CAAC;QACtC,EAAE,CAAC,KAAK,EAAE,CAAC;KACZ;IACD,OAAO,kBAAkB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;AACjD,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,aAAa;IAGxB,YAAY,MAAgB;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,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAED;;;;;;GAMG;AACH,SAAS,uBAAuB,CAAC,QAAgB;IAC/C,MAAM,aAAa,GAAG,gBAAgB,EAAE,CAAC;IACzC,CAAC,UAAU,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,UAAU,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAE7E,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,QAAQ,MAAM,CAAC,CAAC;IAC/D,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IACvE,OAAO,UAAU,CAAC;AACpB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\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"]}
+{"version":3,"file":"IModelUtilities.js","sourceRoot":"","sources":["../../../src/presentation-testing/IModelUtilities.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAY,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEvE,OAAO,EAEL,IAAI,GAQL,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAoB,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAwC7C,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,SAAiC,EAAE,EAAwC;IAC/G,MAAM,IAAI,GAAG,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,wBAAwB,CAAC,SAAS,CAAC,IAAK,CAAC,SAAS,EAAE,CAAC,CAAC;IAC/G,MAAM,UAAU,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;IACjD,MAAM,EAAE,GAAG,UAAU,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IACzE,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,EAAE,CAAC,CAAC;IACtC,IAAI;QACF,EAAE,CAAC,OAAO,CAAC,CAAC;KACb;YAAS;QACR,EAAE,CAAC,WAAW,CAAC,qBAAqB,CAAC,CAAC;QACtC,EAAE,CAAC,KAAK,EAAE,CAAC;KACZ;IACD,OAAO,kBAAkB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;AACjD,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,aAAa;IAGxB,YAAY,MAAgB;QAFpB;;;;;WAAkB;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,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IACnD,CAAC;IAEM,kBAAkB,CAAmC,KAAa;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAC1D,CAAC;IAEM,UAAU,CAAC,YAA4B,EAAE,YAAyB,EAAE,SAAiB;QAC1F,MAAM,QAAQ,GAAa,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QAC1E,OAAO,IAAI,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAED;;;;;;GAMG;AACH,SAAS,uBAAuB,CAAC,QAAgB;IAC/C,MAAM,aAAa,GAAG,gBAAgB,EAAE,CAAC;IACzC,CAAC,UAAU,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,UAAU,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAE7E,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,QAAQ,MAAM,CAAC,CAAC;IAC/D,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IACvE,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,wBAAwB,CAAC,GAAW;IAClD,OAAO,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;AACjE,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 sanitize from \"sanitize-filename\";\nimport { IModelDb, IModelJsFs, SnapshotDb } from \"@itwin/core-backend\";\nimport { Id64String } from \"@itwin/core-bentley\";\nimport {\n  BisCodeSpec,\n  Code,\n  CodeScopeProps,\n  CodeSpec,\n  ElementAspectProps,\n  ElementProps,\n  LocalFileName,\n  ModelProps,\n  RelationshipProps,\n} 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 * @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): Id64String;\n  /**\n   * Insert a relationship between two instances. The relationship is expected to be a subclass\n   * of `BisCore:ElementRefersToElements` or `BisCore:ElementDrivesElement`.\n   */\n  insertRelationship<TProps extends RelationshipProps>(props: TProps): Id64String;\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 * @beta\n */\nexport async function buildTestIModel(name: string, cb: (builder: TestIModelBuilder) => void): Promise<IModelConnection>;\n/**\n * Function that creates an iModel and returns a connection to it.\n * @param mochaContext Mocha context to generate iModel name from\n * @param cb Callback function that receives an [[TestIModelBuilder]] to fill the iModel with data\n * @beta\n */\n// eslint-disable-next-line @typescript-eslint/unified-signatures\nexport async function buildTestIModel(mochaContext: Mocha.Context, cb: (builder: TestIModelBuilder) => void): Promise<IModelConnection>;\nexport async function buildTestIModel(nameParam: string | Mocha.Context, cb: (builder: TestIModelBuilder) => void): Promise<IModelConnection> {\n  const name = typeof nameParam === \"string\" ? nameParam : createFileNameFromString(nameParam.test!.fullTitle());\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): Id64String {\n    return this._iModel.elements.insertAspect(props);\n  }\n\n  public insertRelationship<TProps extends RelationshipProps>(props: TProps): Id64String {\n    return this._iModel.relationships.insertInstance(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\n/** @internal */\nexport function createFileNameFromString(str: string) {\n  return sanitize(str.replace(/[ ]+/g, \"-\")).toLocaleLowerCase();\n}\n"]}

package/lib/esm/presentation-testing.js

@@ -1,7 +1,7 @@
 /*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
 /**
  * @module Hierarchies
  *

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

@@ -1 +1 @@
-{"version":3,"file":"presentation-testing.js","sourceRoot":"","sources":["../../src/presentation-testing.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;;;;GAKG;AACH,cAAc,yCAAyC,CAAC;AAExD;;;;;GAKG;AACH,cAAc,uCAAuC,CAAC;AAEtD;;;;;GAKG;AACH,cAAc,gCAAgC,CAAC;AAE/C;;;;;GAKG;AACH,cAAc,wCAAwC,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\n/**\n * @module Hierarchies\n *\n * @docs-group-description Hierarchies\n * Types for testing hierarchies.\n */\nexport * from \"./presentation-testing/HierarchyBuilder\";\n\n/**\n * @module Content\n *\n * @docs-group-description Content\n * Types for testing content.\n */\nexport * from \"./presentation-testing/ContentBuilder\";\n\n/**\n * @module Helpers\n *\n * @docs-group-description Helpers\n * Various test helpers.\n */\nexport * from \"./presentation-testing/Helpers\";\n\n/**\n * @module IModel\n *\n * @docs-group-description IModel\n * Utilities for creating test iModels that can be used to exercise presentation rules.\n */\nexport * from \"./presentation-testing/IModelUtilities\";\n"]}
+{"version":3,"file":"presentation-testing.js","sourceRoot":"","sources":["../../src/presentation-testing.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG;;;;;GAKG;AACH,cAAc,yCAAyC,CAAC;AAExD;;;;;GAKG;AACH,cAAc,uCAAuC,CAAC;AAEtD;;;;;GAKG;AACH,cAAc,gCAAgC,CAAC;AAE/C;;;;;GAKG;AACH,cAAc,wCAAwC,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\n/**\n * @module Hierarchies\n *\n * @docs-group-description Hierarchies\n * Types for testing hierarchies.\n */\nexport * from \"./presentation-testing/HierarchyBuilder\";\n\n/**\n * @module Content\n *\n * @docs-group-description Content\n * Types for testing content.\n */\nexport * from \"./presentation-testing/ContentBuilder\";\n\n/**\n * @module Helpers\n *\n * @docs-group-description Helpers\n * Various test helpers.\n */\nexport * from \"./presentation-testing/Helpers\";\n\n/**\n * @module IModel\n *\n * @docs-group-description IModel\n * Utilities for creating test iModels that can be used to exercise presentation rules.\n */\nexport * from \"./presentation-testing/IModelUtilities\";\n"]}

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@itwin/presentation-testing",
-  "version": "4.0.0-dev.8",
+  "version": "4.0.0",
   "description": "Testing utilities for iTwin.js Presentation library",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/iTwin/presentation/tree/master/packages/testing"
+    "url": "https://github.com/iTwin/presentation.git",
+    "directory": "packages/testing"
   },
   "keywords": [
     "Bentley",
@@ -34,38 +35,41 @@
     "test": "mocha --config ./.mocharc.json \"./lib/cjs/test/**/*.test.js\""
   },
   "dependencies": {
-    "rimraf": "^3.0.2"
+    "rimraf": "^3.0.2",
+    "sanitize-filename": "^1.6.3"
   },
   "peerDependencies": {
-    "@itwin/appui-abstract": "^3.6.0 || 4.0.0-dev.3",
-    "@itwin/components-react": "^3.6.0 || 4.0.0-dev.3",
-    "@itwin/core-backend": "^3.6.0 || ^4.0.0-dev.7",
-    "@itwin/core-bentley": "^3.6.0 || ^4.0.0-dev.7",
-    "@itwin/core-common": "^3.6.0 || ^4.0.0-dev.7",
-    "@itwin/core-frontend": "^3.6.0 || ^4.0.0-dev.7",
-    "@itwin/presentation-backend": "^3.6.0 || ^4.0.0-dev.7",
-    "@itwin/presentation-common": "^3.6.0 || ^4.0.0-dev.7",
-    "@itwin/presentation-frontend": "^3.6.0 || ^4.0.0-dev.7",
-    "@itwin/presentation-components": "^4.0.0-dev.8"
+    "@itwin/appui-abstract": "^3.6.3 || ^4.0.0",
+    "@itwin/components-react": "^4.0.0",
+    "@itwin/core-backend": "^3.6.3 || ^4.0.0",
+    "@itwin/core-bentley": "^3.6.3 || ^4.0.0",
+    "@itwin/core-common": "^3.6.3 || ^4.0.0",
+    "@itwin/core-frontend": "^3.6.3 || ^4.0.0",
+    "@itwin/presentation-backend": "^3.6.3 || ^4.0.0",
+    "@itwin/presentation-common": "^3.6.3 || ^4.0.0",
+    "@itwin/presentation-frontend": "^3.6.3 || ^4.0.0",
+    "@itwin/presentation-components": "^4.0.0"
   },
   "devDependencies": {
-    "@itwin/appui-abstract": "4.0.0-dev.3",
-    "@itwin/build-tools": "^4.0.0-dev.7",
-    "@itwin/components-react": "4.0.0-dev.3",
-    "@itwin/core-backend": "^4.0.0-dev.7",
-    "@itwin/core-bentley": "^4.0.0-dev.7",
-    "@itwin/core-common": "^4.0.0-dev.7",
-    "@itwin/core-frontend": "^4.0.0-dev.7",
-    "@itwin/core-geometry": "^4.0.0-dev.7",
-    "@itwin/core-orbitgt": "^4.0.0-dev.7",
-    "@itwin/core-quantity": "^4.0.0-dev.7",
-    "@itwin/core-react": "4.0.0-dev.3",
-    "@itwin/eslint-plugin": "^4.0.0-dev.7",
-    "@itwin/presentation-backend": "^4.0.0-dev.7",
-    "@itwin/presentation-common": "^4.0.0-dev.7",
-    "@itwin/presentation-frontend": "^4.0.0-dev.7",
-    "@itwin/presentation-components": "^4.0.0-dev.8",
-    "@itwin/webgl-compatibility": "^4.0.0-dev.7",
+    "@itwin/appui-abstract": "^4.0.0-dev.90",
+    "@itwin/build-tools": "^4.0.0-dev.90",
+    "@itwin/components-react": "^4.0.0",
+    "@itwin/core-backend": "^4.0.0-dev.90",
+    "@itwin/core-bentley": "^4.0.0-dev.90",
+    "@itwin/core-common": "^4.0.0-dev.90",
+    "@itwin/core-frontend": "^4.0.0-dev.90",
+    "@itwin/core-geometry": "^4.0.0-dev.90",
+    "@itwin/core-orbitgt": "^4.0.0-dev.90",
+    "@itwin/core-quantity": "^4.0.0-dev.90",
+    "@itwin/core-react": "^4.0.0",
+    "@itwin/ecschema-metadata": "^4.0.0-dev.90",
+    "@itwin/eslint-plugin": "^4.0.0-dev.38",
+    "@itwin/presentation-backend": "^4.0.0-dev.90",
+    "@itwin/presentation-common": "^4.0.0-dev.90",
+    "@itwin/presentation-frontend": "^4.0.0-dev.90",
+    "@itwin/presentation-components": "^4.0.0",
+    "@itwin/webgl-compatibility": "^4.0.0-dev.90",
+    "@opentelemetry/api": "^1.4.1",
     "@types/chai": "4.3.1",
     "@types/chai-as-promised": "^7",
     "@types/chai-jest-snapshot": "^1.3.0",
@@ -80,7 +84,7 @@
     "chai-jest-snapshot": "^2.0.0",
     "cross-env": "^5.1.4",
     "cpx2": "^3.0.0",
-    "eslint": "^7.11.0",
+    "eslint": "^8.36.0",
     "faker": "^4.1.0",
     "ignore-styles": "^5.0.1",
     "jsdom": "^19.0.0",
@@ -93,6 +97,6 @@
     "sinon": "^9.0.2",
     "sinon-chai": "^3.2.0",
     "typemoq": "^2.1.0",
-    "typescript": "~4.4.0"
+    "typescript": "~5.0.2"
   }
 }