@itwin/core-backend 5.15.0-dev.5 → 5.15.0-dev.7

package/lib/esm/GeographicCRSServices.d.ts

@@ -1,7 +1,7 @@
 /** @packageDocumentation
  * @module iModels
  */
-import { Range2dProps } from "@itwin/core-geometry";
+import { Range2dProps, XAndY } from "@itwin/core-geometry";
 /** Describes a coordinate reference system produced by [[getAvailableCoordinateReferenceSystems]].
  * @beta
  */
@@ -45,13 +45,61 @@ export interface GetAvailableCoordinateReferenceSystemsArgs {
      */
     unit?: string;
 }
+/** Describes a vertical coordinate reference system produced by [[getAvailableVerticalCoordinateReferenceSystems]].
+ * @beta
+ */
+export interface AvailableVerticalCoordinateReferenceSystemProps {
+    /** Name in the Bentley Vertical Datum dictionary. */
+    crsName: string;
+    /** Backward-compatible approximation used by older readers. */
+    id: "GEOID" | "ELLIPSOID" | "NGVD29" | "NAVD88" | "LOCAL_ELLIPSOID";
+    /** EPSG code identifying the vertical coordinate reference system, when one is defined. */
+    epsg?: number;
+    /** Description of the vertical coordinate reference system. */
+    description: string;
+    /** Whether the vertical coordinate reference system is deprecated. */
+    deprecated: boolean;
+    /** The vertical coordinate reference system type. */
+    type: string;
+    /** The name of the linear unit used by the vertical coordinate reference system.
+     * The value uses the canonical casing returned by [[getAvailableCRSUnits]].
+     */
+    unit: string;
+    /** The geographic extent where the vertical coordinate reference system applies. */
+    extent: Range2dProps;
+}
+/** Arguments supplied to [[getAvailableVerticalCoordinateReferenceSystems]].
+ * @beta
+ */
+export interface GetAvailableVerticalCoordinateReferenceSystemsArgs {
+    /** If provided, only return vertical coordinate reference systems applicable at this geographic point in degrees.
+     * The x coordinate is longitude and the y coordinate is latitude.
+     */
+    point?: XAndY;
+    /** If provided, only return vertical coordinate reference systems whose extent contains this extent. */
+    extent?: Range2dProps;
+    /** If true, include vertical coordinate reference systems whose extent intersects, but does not contain, [[extent]].
+     * @default false
+     */
+    includeIntersecting?: boolean;
+    /** If provided, filter vertical coordinate reference systems by unit name.
+     * Matching is case-insensitive. Use [[getAvailableCRSUnits]] to get a list of canonical unit names.
+     */
+    unit?: string;
+}
 /** Get a list of Geographic Coordinate Reference Systems.
  * @param options Specifies the parameters to filter the returned list.
  * @returns The list of Geographic Coordinate Reference Systems, according to the supplied parameters.
  * @beta
  */
 export declare function getAvailableCoordinateReferenceSystems(args: GetAvailableCoordinateReferenceSystemsArgs): Promise<AvailableCoordinateReferenceSystemProps[]>;
-/** Get a list of units used by Geographic Coordinate Reference Systems in iTwin.js.
+/** Get a list of Vertical Coordinate Reference Systems.
+ * @param args Specifies the parameters used to filter the returned list. Point and extent filters are mutually exclusive.
+ * @returns The list of Vertical Coordinate Reference Systems according to the supplied parameters.
+ * @beta
+ */
+export declare function getAvailableVerticalCoordinateReferenceSystems(args?: GetAvailableVerticalCoordinateReferenceSystemsArgs): AvailableVerticalCoordinateReferenceSystemProps[];
+/** Get a list of units used by horizontal and vertical coordinate reference systems in iTwin.js.
  * @returns An array of canonical unit names.
  * @beta
  */

package/lib/esm/GeographicCRSServices.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GeographicCRSServices.d.ts","sourceRoot":"","sources":["../../src/GeographicCRSServices.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAIpD;;GAEG;AACH,MAAM,WAAW,uCAAuC;IACtD,mJAAmJ;IACnJ,IAAI,EAAE,MAAM,CAAC;IACb,8JAA8J;IAC9J,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,SAAS,EAAE,YAAY,CAAC;IACxB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,0CAA0C;IACzD;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,wBAAsB,sCAAsC,CAC1D,IAAI,EAAE,0CAA0C,GAC/C,OAAO,CAAC,uCAAuC,EAAE,CAAC,CAOpD;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,EAAE,CAG/C"}
+{"version":3,"file":"GeographicCRSServices.d.ts","sourceRoot":"","sources":["../../src/GeographicCRSServices.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAI3D;;GAEG;AACH,MAAM,WAAW,uCAAuC;IACtD,mJAAmJ;IACnJ,IAAI,EAAE,MAAM,CAAC;IACb,8JAA8J;IAC9J,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,SAAS,EAAE,YAAY,CAAC;IACxB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,0CAA0C;IACzD;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,+CAA+C;IAC9D,qDAAqD;IACrD,OAAO,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,EAAE,EAAE,OAAO,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,iBAAiB,CAAC;IACpE,2FAA2F;IAC3F,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,WAAW,EAAE,MAAM,CAAC;IACpB,sEAAsE;IACtE,UAAU,EAAE,OAAO,CAAC;IACpB,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,oFAAoF;IACpF,MAAM,EAAE,YAAY,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,kDAAkD;IACjE;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,wGAAwG;IACxG,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,wBAAsB,sCAAsC,CAC1D,IAAI,EAAE,0CAA0C,GAC/C,OAAO,CAAC,uCAAuC,EAAE,CAAC,CAOpD;AAED;;;;GAIG;AACH,wBAAgB,8CAA8C,CAC5D,IAAI,GAAE,kDAAuD,GAC5D,+CAA+C,EAAE,CAGnD;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,EAAE,CAG/C"}

package/lib/esm/GeographicCRSServices.js

@@ -16,7 +16,16 @@ export async function getAvailableCoordinateReferenceSystems(args) {
     GeoCoordConfig.loadDefaultDatabases();
     return IModelNative.platform.GeoServices.getListOfCRS(args.extent, args.includeWorld, args.unit);
 }
-/** Get a list of units used by Geographic Coordinate Reference Systems in iTwin.js.
+/** Get a list of Vertical Coordinate Reference Systems.
+ * @param args Specifies the parameters used to filter the returned list. Point and extent filters are mutually exclusive.
+ * @returns The list of Vertical Coordinate Reference Systems according to the supplied parameters.
+ * @beta
+ */
+export function getAvailableVerticalCoordinateReferenceSystems(args = {}) {
+    GeoCoordConfig.loadDefaultDatabases();
+    return IModelNative.platform.GeoServices.getListOfVerticalCRS(args);
+}
+/** Get a list of units used by horizontal and vertical coordinate reference systems in iTwin.js.
  * @returns An array of canonical unit names.
  * @beta
  */

package/lib/esm/GeographicCRSServices.js.map

@@ -1 +1 @@
-{"version":3,"file":"GeographicCRSServices.js","sourceRoot":"","sources":["../../src/GeographicCRSServices.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AA+ClD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,sCAAsC,CAC1D,IAAgD;IAEhD,cAAc,CAAC,oBAAoB,EAAE,CAAC;IACtC,OAAO,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,YAAY,CACnD,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,IAAI,CACV,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB;IAClC,cAAc,CAAC,oBAAoB,EAAE,CAAC;IACtC,OAAO,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,qBAAqB,EAAE,CAAC;AACnE,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 iModels\r\n */\r\n\r\nimport { Range2dProps } from \"@itwin/core-geometry\";\r\nimport { IModelNative } from \"./internal/NativePlatform\";\r\nimport { GeoCoordConfig } from \"./GeoCoordConfig\";\r\n\r\n/** Describes a coordinate reference system produced by [[getAvailableCoordinateReferenceSystems]].\r\n * @beta\r\n */\r\nexport interface AvailableCoordinateReferenceSystemProps {\r\n  /** The name of the coordinate reference system. It can be presented to the user in the UI as an identifier for the coordinate reference system. */\r\n  name: string;\r\n  /** The description of the coordinate reference system. It can be presented to the user in the UI as extra information for the coordinate reference system. */\r\n  description: string;\r\n  /** Indicate if the coordinate reference system is deprecated. A coordinate reference system is deprecated if it is no longer recommended for use.\r\n   *  A deprecated coordinate reference system can usually be substituted by a more accurate one. It is possible that an existing project uses a deprecated coordinate reference system.\r\n   *  However, for new projects, it is recommended to use a non-deprecated coordinate reference system.\r\n   */\r\n  deprecated: boolean;\r\n  /** Extent of the coordinate reference system. This is the area where the coordinate reference system can be used.\r\n   *  Outside of this area, the coordinate reference system may not be accurate. The extent is defined by a range of longitude and latitude values.\r\n   *  Minimum longitude and latitude correspond to crsExtent.low.x and crsExtent.low.y, respectively.\r\n   *  Maximum longitude and latitude correspond to crsExtent.high.x and crsExtent.high.y, respectively.\r\n   */\r\n  crsExtent: Range2dProps;\r\n  /** The name of the linear unit used by the coordinate reference system.\r\n   *  When returned by [[getAvailableCoordinateReferenceSystems]], the value uses the canonical casing returned by [[getAvailableCRSUnits]].\r\n   */\r\n  unit?: string;\r\n}\r\n\r\n/** Arguments supplied to [[getAvailableCoordinateReferenceSystems]].\r\n * @beta\r\n */\r\nexport interface GetAvailableCoordinateReferenceSystemsArgs {\r\n  /** If provided, only return coordinate reference systems that contain the given extent. Minimum longitude and latitude correspond to extent.low.x and extent.low.y, respectively.\r\n   * Maximum longitude and latitude correspond to extent.high.x and extent.high.y, respectively.\r\n   */\r\n  extent?: Range2dProps;\r\n  /** If true, returns additional coordinate reference systems with extents spanning the entire Earth's surface.\r\n   * @default false\r\n   */\r\n  includeWorld?: boolean;\r\n  /**\r\n   * If provided, filter coordinate reference systems by unit name.\r\n   * Matching is case-insensitive.\r\n   * Use [[getAvailableCRSUnits]] to get a list of canonical unit names.\r\n   */\r\n  unit?: string;\r\n}\r\n\r\n/** Get a list of Geographic Coordinate Reference Systems.\r\n * @param options Specifies the parameters to filter the returned list.\r\n * @returns The list of Geographic Coordinate Reference Systems, according to the supplied parameters.\r\n * @beta\r\n */\r\nexport async function getAvailableCoordinateReferenceSystems(\r\n  args: GetAvailableCoordinateReferenceSystemsArgs\r\n): Promise<AvailableCoordinateReferenceSystemProps[]> {\r\n  GeoCoordConfig.loadDefaultDatabases();\r\n  return IModelNative.platform.GeoServices.getListOfCRS(\r\n    args.extent,\r\n    args.includeWorld,\r\n    args.unit\r\n  );\r\n}\r\n\r\n/** Get a list of units used by Geographic Coordinate Reference Systems in iTwin.js.\r\n * @returns An array of canonical unit names.\r\n * @beta\r\n */\r\nexport function getAvailableCRSUnits(): string[] {\r\n  GeoCoordConfig.loadDefaultDatabases();\r\n  return IModelNative.platform.GeoServices.getAvailableUnitNames();\r\n}\r\n"]}
+{"version":3,"file":"GeographicCRSServices.js","sourceRoot":"","sources":["../../src/GeographicCRSServices.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AA2FlD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,sCAAsC,CAC1D,IAAgD;IAEhD,cAAc,CAAC,oBAAoB,EAAE,CAAC;IACtC,OAAO,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,YAAY,CACnD,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,IAAI,CACV,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,8CAA8C,CAC5D,OAA2D,EAAE;IAE7D,cAAc,CAAC,oBAAoB,EAAE,CAAC;IACtC,OAAO,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;AACtE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB;IAClC,cAAc,CAAC,oBAAoB,EAAE,CAAC;IACtC,OAAO,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,qBAAqB,EAAE,CAAC;AACnE,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 iModels\r\n */\r\n\r\nimport { Range2dProps, XAndY } from \"@itwin/core-geometry\";\r\nimport { IModelNative } from \"./internal/NativePlatform\";\r\nimport { GeoCoordConfig } from \"./GeoCoordConfig\";\r\n\r\n/** Describes a coordinate reference system produced by [[getAvailableCoordinateReferenceSystems]].\r\n * @beta\r\n */\r\nexport interface AvailableCoordinateReferenceSystemProps {\r\n  /** The name of the coordinate reference system. It can be presented to the user in the UI as an identifier for the coordinate reference system. */\r\n  name: string;\r\n  /** The description of the coordinate reference system. It can be presented to the user in the UI as extra information for the coordinate reference system. */\r\n  description: string;\r\n  /** Indicate if the coordinate reference system is deprecated. A coordinate reference system is deprecated if it is no longer recommended for use.\r\n   *  A deprecated coordinate reference system can usually be substituted by a more accurate one. It is possible that an existing project uses a deprecated coordinate reference system.\r\n   *  However, for new projects, it is recommended to use a non-deprecated coordinate reference system.\r\n   */\r\n  deprecated: boolean;\r\n  /** Extent of the coordinate reference system. This is the area where the coordinate reference system can be used.\r\n   *  Outside of this area, the coordinate reference system may not be accurate. The extent is defined by a range of longitude and latitude values.\r\n   *  Minimum longitude and latitude correspond to crsExtent.low.x and crsExtent.low.y, respectively.\r\n   *  Maximum longitude and latitude correspond to crsExtent.high.x and crsExtent.high.y, respectively.\r\n   */\r\n  crsExtent: Range2dProps;\r\n  /** The name of the linear unit used by the coordinate reference system.\r\n   *  When returned by [[getAvailableCoordinateReferenceSystems]], the value uses the canonical casing returned by [[getAvailableCRSUnits]].\r\n   */\r\n  unit?: string;\r\n}\r\n\r\n/** Arguments supplied to [[getAvailableCoordinateReferenceSystems]].\r\n * @beta\r\n */\r\nexport interface GetAvailableCoordinateReferenceSystemsArgs {\r\n  /** If provided, only return coordinate reference systems that contain the given extent. Minimum longitude and latitude correspond to extent.low.x and extent.low.y, respectively.\r\n   * Maximum longitude and latitude correspond to extent.high.x and extent.high.y, respectively.\r\n   */\r\n  extent?: Range2dProps;\r\n  /** If true, returns additional coordinate reference systems with extents spanning the entire Earth's surface.\r\n   * @default false\r\n   */\r\n  includeWorld?: boolean;\r\n  /**\r\n   * If provided, filter coordinate reference systems by unit name.\r\n   * Matching is case-insensitive.\r\n   * Use [[getAvailableCRSUnits]] to get a list of canonical unit names.\r\n   */\r\n  unit?: string;\r\n}\r\n\r\n/** Describes a vertical coordinate reference system produced by [[getAvailableVerticalCoordinateReferenceSystems]].\r\n * @beta\r\n */\r\nexport interface AvailableVerticalCoordinateReferenceSystemProps {\r\n  /** Name in the Bentley Vertical Datum dictionary. */\r\n  crsName: string;\r\n  /** Backward-compatible approximation used by older readers. */\r\n  id: \"GEOID\" | \"ELLIPSOID\" | \"NGVD29\" | \"NAVD88\" | \"LOCAL_ELLIPSOID\";\r\n  /** EPSG code identifying the vertical coordinate reference system, when one is defined. */\r\n  epsg?: number;\r\n  /** Description of the vertical coordinate reference system. */\r\n  description: string;\r\n  /** Whether the vertical coordinate reference system is deprecated. */\r\n  deprecated: boolean;\r\n  /** The vertical coordinate reference system type. */\r\n  type: string;\r\n  /** The name of the linear unit used by the vertical coordinate reference system.\r\n   * The value uses the canonical casing returned by [[getAvailableCRSUnits]].\r\n   */\r\n  unit: string;\r\n  /** The geographic extent where the vertical coordinate reference system applies. */\r\n  extent: Range2dProps;\r\n}\r\n\r\n/** Arguments supplied to [[getAvailableVerticalCoordinateReferenceSystems]].\r\n * @beta\r\n */\r\nexport interface GetAvailableVerticalCoordinateReferenceSystemsArgs {\r\n  /** If provided, only return vertical coordinate reference systems applicable at this geographic point in degrees.\r\n   * The x coordinate is longitude and the y coordinate is latitude.\r\n   */\r\n  point?: XAndY;\r\n  /** If provided, only return vertical coordinate reference systems whose extent contains this extent. */\r\n  extent?: Range2dProps;\r\n  /** If true, include vertical coordinate reference systems whose extent intersects, but does not contain, [[extent]].\r\n   * @default false\r\n   */\r\n  includeIntersecting?: boolean;\r\n  /** If provided, filter vertical coordinate reference systems by unit name.\r\n   * Matching is case-insensitive. Use [[getAvailableCRSUnits]] to get a list of canonical unit names.\r\n   */\r\n  unit?: string;\r\n}\r\n\r\n/** Get a list of Geographic Coordinate Reference Systems.\r\n * @param options Specifies the parameters to filter the returned list.\r\n * @returns The list of Geographic Coordinate Reference Systems, according to the supplied parameters.\r\n * @beta\r\n */\r\nexport async function getAvailableCoordinateReferenceSystems(\r\n  args: GetAvailableCoordinateReferenceSystemsArgs\r\n): Promise<AvailableCoordinateReferenceSystemProps[]> {\r\n  GeoCoordConfig.loadDefaultDatabases();\r\n  return IModelNative.platform.GeoServices.getListOfCRS(\r\n    args.extent,\r\n    args.includeWorld,\r\n    args.unit\r\n  );\r\n}\r\n\r\n/** Get a list of Vertical Coordinate Reference Systems.\r\n * @param args Specifies the parameters used to filter the returned list. Point and extent filters are mutually exclusive.\r\n * @returns The list of Vertical Coordinate Reference Systems according to the supplied parameters.\r\n * @beta\r\n */\r\nexport function getAvailableVerticalCoordinateReferenceSystems(\r\n  args: GetAvailableVerticalCoordinateReferenceSystemsArgs = {}\r\n): AvailableVerticalCoordinateReferenceSystemProps[] {\r\n  GeoCoordConfig.loadDefaultDatabases();\r\n  return IModelNative.platform.GeoServices.getListOfVerticalCRS(args);\r\n}\r\n\r\n/** Get a list of units used by horizontal and vertical coordinate reference systems in iTwin.js.\r\n * @returns An array of canonical unit names.\r\n * @beta\r\n */\r\nexport function getAvailableCRSUnits(): string[] {\r\n  GeoCoordConfig.loadDefaultDatabases();\r\n  return IModelNative.platform.GeoServices.getAvailableUnitNames();\r\n}\r\n"]}

package/lib/esm/test/element/ElementSubModelInsert.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ElementSubModelInsert.test.d.ts.map

package/lib/esm/test/element/ElementSubModelInsert.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ElementSubModelInsert.test.d.ts","sourceRoot":"","sources":["../../../../src/test/element/ElementSubModelInsert.test.ts"],"names":[],"mappings":""}

package/lib/esm/test/element/ElementSubModelInsert.test.js

@@ -0,0 +1,183 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the repository root for full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { expect } from "chai";
+import { spy as sinonSpy } from "sinon";
+import { Id64, IModelStatus } from "@itwin/core-bentley";
+import { Code, IModel, IModelError } from "@itwin/core-common";
+import { ClassRegistry } from "../../ClassRegistry";
+import { withEditTxn } from "../../EditTxn";
+import { Document, Drawing, SectionDrawing, Sheet, TemplateRecipe2d } from "../../Element";
+import { GenericSchema } from "../../domains/GenericSchema";
+import { SnapshotDb } from "../../IModelDb";
+import { DefinitionModel, DocumentListModel, DrawingModel, SectionDrawingModel, SheetModel } from "../../Model";
+import { Schema, Schemas } from "../../Schema";
+import { IModelTestUtils } from "../IModelTestUtils";
+class TestSubModelSchema extends Schema {
+    static get schemaName() { return "TestSubModel"; }
+}
+/** A Sheet subclass that overrides the hook and defers to the inherited validation via `super`. */
+class TestSheetSpy extends Sheet {
+    static get className() { return "TestSheetSpy"; }
+    static onSubModelInsert(arg) {
+        super.onSubModelInsert(arg);
+    }
+}
+/** A Sheet subclass that widens the inherited rule to also permit a DrawingModel. */
+class TestSheetWidened extends Sheet {
+    static get className() { return "TestSheetWidened"; }
+    static get allowedSubModelClasses() { return [SheetModel, DrawingModel]; }
+}
+/** A Sheet subclass that replaces the hook without calling `super`, opting out of validation. */
+class TestSheetUnvalidated extends Sheet {
+    static get className() { return "TestSheetUnvalidated"; }
+    static onSubModelInsert(_arg) { }
+}
+/** A domain ISubModeledElement unrelated to Sheet/Drawing that opts in by overriding only the getter. */
+class TestRestrictedDocument extends Document {
+    static get className() { return "TestRestrictedDocument"; }
+    static get allowedSubModelClasses() { return [DrawingModel]; }
+}
+const testSchemaXml = `<?xml version="1.0" encoding="UTF-8"?>
+<ECSchema schemaName="TestSubModel" alias="tsm" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
+  <ECSchemaReference name="BisCore" version="01.00.04" alias="bis"/>
+  <ECCustomAttributes>
+    <SchemaHasBehavior xmlns="BisCore.01.00.00"/>
+  </ECCustomAttributes>
+  <ECEntityClass typeName="TestSheetModel">
+    <BaseClass>bis:SheetModel</BaseClass>
+  </ECEntityClass>
+  <ECEntityClass typeName="TestSheetGenerated">
+    <BaseClass>bis:Sheet</BaseClass>
+  </ECEntityClass>
+  <ECEntityClass typeName="TestSheetSpy">
+    <BaseClass>bis:Sheet</BaseClass>
+  </ECEntityClass>
+  <ECEntityClass typeName="TestSheetWidened">
+    <BaseClass>bis:Sheet</BaseClass>
+  </ECEntityClass>
+  <ECEntityClass typeName="TestSheetUnvalidated">
+    <BaseClass>bis:Sheet</BaseClass>
+  </ECEntityClass>
+  <ECEntityClass typeName="TestHostDocument">
+    <BaseClass>bis:Document</BaseClass>
+    <BaseClass>bis:ISubModeledElement</BaseClass>
+  </ECEntityClass>
+  <ECEntityClass typeName="TestRestrictedDocument">
+    <BaseClass>bis:Document</BaseClass>
+    <BaseClass>bis:ISubModeledElement</BaseClass>
+  </ECEntityClass>
+</ECSchema>`;
+describe("Sub-model insert validation", () => {
+    let imodel;
+    let documentListModelId;
+    before(async () => {
+        GenericSchema.registerSchema();
+        Schemas.registerSchema(TestSubModelSchema);
+        ClassRegistry.register(TestSheetSpy, TestSubModelSchema);
+        ClassRegistry.register(TestSheetWidened, TestSubModelSchema);
+        ClassRegistry.register(TestSheetUnvalidated, TestSubModelSchema);
+        ClassRegistry.register(TestRestrictedDocument, TestSubModelSchema);
+        const iModelPath = IModelTestUtils.prepareOutputFile("SubModelInsert", "SubModelInsert.bim");
+        imodel = SnapshotDb.createEmpty(iModelPath, { rootSubject: { name: "SubModelInsertTest" } });
+        await imodel.importSchemaStrings([testSchemaXml]);
+        documentListModelId = withEditTxn(imodel, (txn) => DocumentListModel.insert(txn, SnapshotDb.rootSubjectId, "DocumentList"));
+    });
+    after(() => {
+        imodel.close();
+        Schemas.unregisterSchema(TestSubModelSchema.schemaName);
+    });
+    function insertHost(classFullName, modelId = documentListModelId) {
+        const id = withEditTxn(imodel, (txn) => txn.insertElement({ classFullName, model: modelId, code: Code.createEmpty() }));
+        expect(Id64.isValidId64(id)).to.be.true;
+        return id;
+    }
+    function insertSubModel(modelClassFullName, modeledElementId) {
+        return withEditTxn(imodel, (txn) => txn.insertModel({ classFullName: modelClassFullName, modeledElement: { id: modeledElementId } }));
+    }
+    function expectAccepted(hostClassFullName, modelClassFullName, hostModelId) {
+        const hostId = insertHost(hostClassFullName, hostModelId);
+        const modelId = insertSubModel(modelClassFullName, hostId);
+        expect(modelId).to.equal(hostId);
+        expect(imodel.models.getModel(modelId).classFullName).to.equal(modelClassFullName);
+    }
+    function expectRejected(hostClassFullName, modelClassFullName, hostModelId) {
+        const hostId = insertHost(hostClassFullName, hostModelId);
+        let error;
+        try {
+            insertSubModel(modelClassFullName, hostId);
+        }
+        catch (err) {
+            error = err;
+        }
+        expect(error).to.be.instanceOf(IModelError);
+        expect(error.errorNumber).to.equal(IModelStatus.WrongModel);
+        expect(error.message).to.contain("must be sub-modeled by");
+        expect(imodel.models.tryGetModel(hostId)).to.be.undefined;
+    }
+    describe("accepts", () => {
+        it("Sheet + SheetModel", () => expectAccepted(Sheet.classFullName, SheetModel.classFullName));
+        it("Drawing + DrawingModel", () => expectAccepted(Drawing.classFullName, DrawingModel.classFullName));
+        it("SectionDrawing + DrawingModel", () => expectAccepted(SectionDrawing.classFullName, DrawingModel.classFullName));
+        it("SectionDrawing + SectionDrawingModel", () => expectAccepted(SectionDrawing.classFullName, SectionDrawingModel.classFullName));
+        it("SectionDrawing + Generic:GraphicalModel3d", () => expectAccepted(SectionDrawing.classFullName, "Generic:GraphicalModel3d"));
+        it("TemplateRecipe2d + DrawingModel", () => expectAccepted(TemplateRecipe2d.classFullName, DrawingModel.classFullName, IModel.dictionaryId));
+        it("Sheet + SheetModel subclass without a JS class", () => expectAccepted(Sheet.classFullName, "TestSubModel:TestSheetModel"));
+        it("no allowedSubModelClasses → any model accepted", () => {
+            expectAccepted("TestSubModel:TestHostDocument", SheetModel.classFullName);
+            expectAccepted("TestSubModel:TestHostDocument", DrawingModel.classFullName);
+        });
+        it("Sheet subclass that widens allowedSubModelClasses + DrawingModel", () => expectAccepted(TestSheetWidened.classFullName, DrawingModel.classFullName));
+        it("Sheet subclass that overrides onSubModelInsert without super + DrawingModel", () => expectAccepted(TestSheetUnvalidated.classFullName, DrawingModel.classFullName));
+        it("Document subclass with allowedSubModelClasses + DrawingModel", () => expectAccepted(TestRestrictedDocument.classFullName, DrawingModel.classFullName));
+    });
+    describe("rejects with IModelStatus.WrongModel", () => {
+        it("Sheet + DrawingModel", () => expectRejected(Sheet.classFullName, DrawingModel.classFullName));
+        it("Drawing + SheetModel", () => expectRejected(Drawing.classFullName, SheetModel.classFullName));
+        it("SectionDrawing + SheetModel", () => expectRejected(SectionDrawing.classFullName, SheetModel.classFullName));
+        it("TemplateRecipe2d + SheetModel", () => expectRejected(TemplateRecipe2d.classFullName, SheetModel.classFullName, IModel.dictionaryId));
+        it("Sheet subclass without a JS class + DrawingModel", () => expectRejected("TestSubModel:TestSheetGenerated", DrawingModel.classFullName));
+        it("Document subclass with allowedSubModelClasses + SheetModel", () => expectRejected(TestRestrictedDocument.classFullName, SheetModel.classFullName));
+    });
+    it("invokes an overriding subclass hook that defers to the inherited validation", () => {
+        const spy = sinonSpy(TestSheetSpy, "onSubModelInsert");
+        try {
+            expectAccepted(TestSheetSpy.classFullName, SheetModel.classFullName);
+            expect(spy.calledOnce).to.be.true;
+            expect(spy.getCall(0).args[0].subModelProps.classFullName).to.equal(SheetModel.classFullName);
+            expectRejected(TestSheetSpy.classFullName, DrawingModel.classFullName);
+            expect(spy.calledTwice).to.be.true;
+            expect(spy.getCall(1).threw()).to.be.true;
+        }
+        finally {
+            spy.restore();
+        }
+    });
+    describe("missing required behavior", () => {
+        it("rejects sub-model insertion", () => {
+            const hostId = insertHost(TestRestrictedDocument.classFullName);
+            Schemas.unregisterSchema(TestSubModelSchema.schemaName);
+            try {
+                let error;
+                try {
+                    insertSubModel(DefinitionModel.classFullName, hostId);
+                }
+                catch (err) {
+                    error = err;
+                }
+                expect(error).to.be.instanceOf(IModelError);
+                expect(error.errorNumber).to.equal(IModelStatus.WrongHandler);
+                expect(imodel.models.tryGetModel(hostId)).to.be.undefined;
+            }
+            finally {
+                Schemas.registerSchema(TestSubModelSchema);
+                ClassRegistry.register(TestSheetSpy, TestSubModelSchema);
+                ClassRegistry.register(TestSheetWidened, TestSubModelSchema);
+                ClassRegistry.register(TestSheetUnvalidated, TestSubModelSchema);
+                ClassRegistry.register(TestRestrictedDocument, TestSubModelSchema);
+            }
+        });
+    });
+});
+//# sourceMappingURL=ElementSubModelInsert.test.js.map

package/lib/esm/test/element/ElementSubModelInsert.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ElementSubModelInsert.test.js","sourceRoot":"","sources":["../../../../src/test/element/ElementSubModelInsert.test.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,EAAE,GAAG,IAAI,QAAQ,EAAE,MAAM,OAAO,CAAC;AACxC,OAAO,EAAE,IAAI,EAAc,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAsB,cAAc,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAE/G,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,YAAY,EAAS,mBAAmB,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACvH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD,MAAM,kBAAmB,SAAQ,MAAM;IAC9B,MAAM,KAAc,UAAU,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;CAC3E;AAED,mGAAmG;AACnG,MAAM,YAAa,SAAQ,KAAK;IACvB,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;IAClE,MAAM,CAAU,gBAAgB,CAAC,GAAuB;QAC7D,KAAK,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;CACF;AAED,qFAAqF;AACrF,MAAM,gBAAiB,SAAQ,KAAK;IAC3B,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;IACnE,MAAM,KAAc,sBAAsB,KAAoC,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;CAC7H;AAED,iGAAiG;AACjG,MAAM,oBAAqB,SAAQ,KAAK;IAC/B,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IAC1E,MAAM,CAAU,gBAAgB,CAAC,IAAwB,IAAU,CAAC;CAC5E;AAED,yGAAyG;AACzG,MAAM,sBAAuB,SAAQ,QAAQ;IACpC,MAAM,KAAc,SAAS,KAAa,OAAO,wBAAwB,CAAC,CAAC,CAAC;IACzE,MAAM,KAAc,sBAAsB,KAAoC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;CACjH;AAED,MAAM,aAAa,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YA6BV,CAAC;AAEb,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;IAC3C,IAAI,MAAkB,CAAC;IACvB,IAAI,mBAA+B,CAAC;IAEpC,MAAM,CAAC,KAAK,IAAI,EAAE;QAChB,aAAa,CAAC,cAAc,EAAE,CAAC;QAC/B,OAAO,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;QAC3C,aAAa,CAAC,QAAQ,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;QACzD,aAAa,CAAC,QAAQ,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QAC7D,aAAa,CAAC,QAAQ,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,CAAC;QACjE,aAAa,CAAC,QAAQ,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,CAAC;QAEnE,MAAM,UAAU,GAAG,eAAe,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,oBAAoB,CAAC,CAAC;QAC7F,MAAM,GAAG,UAAU,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE,EAAE,CAAC,CAAC;QAC7F,MAAM,MAAM,CAAC,mBAAmB,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;QAClD,mBAAmB,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,iBAAiB,CAAC,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC,CAAC;IAC9H,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,GAAG,EAAE;QACT,MAAM,CAAC,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,SAAS,UAAU,CAAC,aAAqB,EAAE,UAAsB,mBAAmB;QAClF,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;QACxH,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QACxC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,SAAS,cAAc,CAAC,kBAA0B,EAAE,gBAA4B;QAC9E,OAAO,WAAW,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,aAAa,EAAE,kBAAkB,EAAE,cAAc,EAAE,EAAE,EAAE,EAAE,gBAAgB,EAAE,EAAE,CAAC,CAAC,CAAC;IACxI,CAAC;IAED,SAAS,cAAc,CAAC,iBAAyB,EAAE,kBAA0B,EAAE,WAAwB;QACrG,MAAM,MAAM,GAAG,UAAU,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;QAC1D,MAAM,OAAO,GAAG,cAAc,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;QAC3D,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACjC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACrF,CAAC;IAED,SAAS,cAAc,CAAC,iBAAyB,EAAE,kBAA0B,EAAE,WAAwB;QACrG,MAAM,MAAM,GAAG,UAAU,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;QAC1D,IAAI,KAAc,CAAC;QACnB,IAAI,CAAC;YACH,cAAc,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;QAC7C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,KAAK,GAAG,GAAG,CAAC;QACd,CAAC;QAED,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5C,MAAM,CAAE,KAAqB,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC7E,MAAM,CAAE,KAAqB,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;QAC5E,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IAC5D,CAAC;IAED,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QACvB,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,aAAa,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;QAC9F,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,aAAa,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;QACtG,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,cAAc,CAAC,aAAa,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;QACpH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,cAAc,CAAC,aAAa,EAAE,mBAAmB,CAAC,aAAa,CAAC,CAAC,CAAC;QAClI,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,cAAc,CAAC,aAAa,EAAE,0BAA0B,CAAC,CAAC,CAAC;QAChI,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,gBAAgB,CAAC,aAAa,EAAE,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;QAC7I,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,aAAa,EAAE,6BAA6B,CAAC,CAAC,CAAC;QAC/H,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACxD,cAAc,CAAC,+BAA+B,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC;YAC1E,cAAc,CAAC,+BAA+B,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC;QAC9E,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,gBAAgB,CAAC,aAAa,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;QACzJ,EAAE,CAAC,6EAA6E,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,oBAAoB,CAAC,aAAa,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;QACxK,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,sBAAsB,CAAC,aAAa,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;IAC7J,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sCAAsC,EAAE,GAAG,EAAE;QACpD,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,aAAa,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;QAClG,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,aAAa,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;QAClG,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,cAAc,CAAC,aAAa,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;QAChH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,gBAAgB,CAAC,aAAa,EAAE,UAAU,CAAC,aAAa,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;QACzI,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,iCAAiC,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;QAC5I,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,sBAAsB,CAAC,aAAa,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;IACzJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6EAA6E,EAAE,GAAG,EAAE;QACrF,MAAM,GAAG,GAAG,QAAQ,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;QACvD,IAAI,CAAC;YACH,cAAc,CAAC,YAAY,CAAC,aAAa,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC;YACrE,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YAClC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;YAE9F,cAAc,CAAC,YAAY,CAAC,aAAa,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC;YACvE,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YACnC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAC5C,CAAC;gBAAS,CAAC;YACT,GAAG,CAAC,OAAO,EAAE,CAAC;QAChB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACzC,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,MAAM,GAAG,UAAU,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;YAChE,OAAO,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;YAExD,IAAI,CAAC;gBACH,IAAI,KAAc,CAAC;gBACnB,IAAI,CAAC;oBACH,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;gBACxD,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,KAAK,GAAG,GAAG,CAAC;gBACd,CAAC;gBAED,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;gBAC5C,MAAM,CAAE,KAAqB,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;gBAC/E,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;YAC5D,CAAC;oBAAS,CAAC;gBACT,OAAO,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;gBAC3C,aAAa,CAAC,QAAQ,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;gBACzD,aAAa,CAAC,QAAQ,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;gBAC7D,aAAa,CAAC,QAAQ,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,CAAC;gBACjE,aAAa,CAAC,QAAQ,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,CAAC;YACrE,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the repository root for full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { expect } from \"chai\";\r\nimport { spy as sinonSpy } from \"sinon\";\r\nimport { Id64, Id64String, IModelStatus } from \"@itwin/core-bentley\";\r\nimport { Code, IModel, IModelError } from \"@itwin/core-common\";\r\nimport { ClassRegistry } from \"../../ClassRegistry\";\r\nimport { withEditTxn } from \"../../EditTxn\";\r\nimport { Document, Drawing, OnSubModelPropsArg, SectionDrawing, Sheet, TemplateRecipe2d } from \"../../Element\";\r\nimport { EntityClassType } from \"../../Entity\";\r\nimport { GenericSchema } from \"../../domains/GenericSchema\";\r\nimport { SnapshotDb } from \"../../IModelDb\";\r\nimport { DefinitionModel, DocumentListModel, DrawingModel, Model, SectionDrawingModel, SheetModel } from \"../../Model\";\r\nimport { Schema, Schemas } from \"../../Schema\";\r\nimport { IModelTestUtils } from \"../IModelTestUtils\";\r\n\r\nclass TestSubModelSchema extends Schema {\r\n  public static override get schemaName(): string { return \"TestSubModel\"; }\r\n}\r\n\r\n/** A Sheet subclass that overrides the hook and defers to the inherited validation via `super`. */\r\nclass TestSheetSpy extends Sheet {\r\n  public static override get className(): string { return \"TestSheetSpy\"; }\r\n  public static override onSubModelInsert(arg: OnSubModelPropsArg): void {\r\n    super.onSubModelInsert(arg);\r\n  }\r\n}\r\n\r\n/** A Sheet subclass that widens the inherited rule to also permit a DrawingModel. */\r\nclass TestSheetWidened extends Sheet {\r\n  public static override get className(): string { return \"TestSheetWidened\"; }\r\n  protected static override get allowedSubModelClasses(): Array<EntityClassType<Model>> { return [SheetModel, DrawingModel]; }\r\n}\r\n\r\n/** A Sheet subclass that replaces the hook without calling `super`, opting out of validation. */\r\nclass TestSheetUnvalidated extends Sheet {\r\n  public static override get className(): string { return \"TestSheetUnvalidated\"; }\r\n  public static override onSubModelInsert(_arg: OnSubModelPropsArg): void { }\r\n}\r\n\r\n/** A domain ISubModeledElement unrelated to Sheet/Drawing that opts in by overriding only the getter. */\r\nclass TestRestrictedDocument extends Document {\r\n  public static override get className(): string { return \"TestRestrictedDocument\"; }\r\n  protected static override get allowedSubModelClasses(): Array<EntityClassType<Model>> { return [DrawingModel]; }\r\n}\r\n\r\nconst testSchemaXml = `<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<ECSchema schemaName=\"TestSubModel\" alias=\"tsm\" version=\"01.00.00\" xmlns=\"http://www.bentley.com/schemas/Bentley.ECXML.3.2\">\r\n  <ECSchemaReference name=\"BisCore\" version=\"01.00.04\" alias=\"bis\"/>\r\n  <ECCustomAttributes>\r\n    <SchemaHasBehavior xmlns=\"BisCore.01.00.00\"/>\r\n  </ECCustomAttributes>\r\n  <ECEntityClass typeName=\"TestSheetModel\">\r\n    <BaseClass>bis:SheetModel</BaseClass>\r\n  </ECEntityClass>\r\n  <ECEntityClass typeName=\"TestSheetGenerated\">\r\n    <BaseClass>bis:Sheet</BaseClass>\r\n  </ECEntityClass>\r\n  <ECEntityClass typeName=\"TestSheetSpy\">\r\n    <BaseClass>bis:Sheet</BaseClass>\r\n  </ECEntityClass>\r\n  <ECEntityClass typeName=\"TestSheetWidened\">\r\n    <BaseClass>bis:Sheet</BaseClass>\r\n  </ECEntityClass>\r\n  <ECEntityClass typeName=\"TestSheetUnvalidated\">\r\n    <BaseClass>bis:Sheet</BaseClass>\r\n  </ECEntityClass>\r\n  <ECEntityClass typeName=\"TestHostDocument\">\r\n    <BaseClass>bis:Document</BaseClass>\r\n    <BaseClass>bis:ISubModeledElement</BaseClass>\r\n  </ECEntityClass>\r\n  <ECEntityClass typeName=\"TestRestrictedDocument\">\r\n    <BaseClass>bis:Document</BaseClass>\r\n    <BaseClass>bis:ISubModeledElement</BaseClass>\r\n  </ECEntityClass>\r\n</ECSchema>`;\r\n\r\ndescribe(\"Sub-model insert validation\", () => {\r\n  let imodel: SnapshotDb;\r\n  let documentListModelId: Id64String;\r\n\r\n  before(async () => {\r\n    GenericSchema.registerSchema();\r\n    Schemas.registerSchema(TestSubModelSchema);\r\n    ClassRegistry.register(TestSheetSpy, TestSubModelSchema);\r\n    ClassRegistry.register(TestSheetWidened, TestSubModelSchema);\r\n    ClassRegistry.register(TestSheetUnvalidated, TestSubModelSchema);\r\n    ClassRegistry.register(TestRestrictedDocument, TestSubModelSchema);\r\n\r\n    const iModelPath = IModelTestUtils.prepareOutputFile(\"SubModelInsert\", \"SubModelInsert.bim\");\r\n    imodel = SnapshotDb.createEmpty(iModelPath, { rootSubject: { name: \"SubModelInsertTest\" } });\r\n    await imodel.importSchemaStrings([testSchemaXml]);\r\n    documentListModelId = withEditTxn(imodel, (txn) => DocumentListModel.insert(txn, SnapshotDb.rootSubjectId, \"DocumentList\"));\r\n  });\r\n\r\n  after(() => {\r\n    imodel.close();\r\n    Schemas.unregisterSchema(TestSubModelSchema.schemaName);\r\n  });\r\n\r\n  function insertHost(classFullName: string, modelId: Id64String = documentListModelId): Id64String {\r\n    const id = withEditTxn(imodel, (txn) => txn.insertElement({ classFullName, model: modelId, code: Code.createEmpty() }));\r\n    expect(Id64.isValidId64(id)).to.be.true;\r\n    return id;\r\n  }\r\n\r\n  function insertSubModel(modelClassFullName: string, modeledElementId: Id64String): Id64String {\r\n    return withEditTxn(imodel, (txn) => txn.insertModel({ classFullName: modelClassFullName, modeledElement: { id: modeledElementId } }));\r\n  }\r\n\r\n  function expectAccepted(hostClassFullName: string, modelClassFullName: string, hostModelId?: Id64String): void {\r\n    const hostId = insertHost(hostClassFullName, hostModelId);\r\n    const modelId = insertSubModel(modelClassFullName, hostId);\r\n    expect(modelId).to.equal(hostId);\r\n    expect(imodel.models.getModel(modelId).classFullName).to.equal(modelClassFullName);\r\n  }\r\n\r\n  function expectRejected(hostClassFullName: string, modelClassFullName: string, hostModelId?: Id64String): void {\r\n    const hostId = insertHost(hostClassFullName, hostModelId);\r\n    let error: unknown;\r\n    try {\r\n      insertSubModel(modelClassFullName, hostId);\r\n    } catch (err) {\r\n      error = err;\r\n    }\r\n\r\n    expect(error).to.be.instanceOf(IModelError);\r\n    expect((error as IModelError).errorNumber).to.equal(IModelStatus.WrongModel);\r\n    expect((error as IModelError).message).to.contain(\"must be sub-modeled by\");\r\n    expect(imodel.models.tryGetModel(hostId)).to.be.undefined;\r\n  }\r\n\r\n  describe(\"accepts\", () => {\r\n    it(\"Sheet + SheetModel\", () => expectAccepted(Sheet.classFullName, SheetModel.classFullName));\r\n    it(\"Drawing + DrawingModel\", () => expectAccepted(Drawing.classFullName, DrawingModel.classFullName));\r\n    it(\"SectionDrawing + DrawingModel\", () => expectAccepted(SectionDrawing.classFullName, DrawingModel.classFullName));\r\n    it(\"SectionDrawing + SectionDrawingModel\", () => expectAccepted(SectionDrawing.classFullName, SectionDrawingModel.classFullName));\r\n    it(\"SectionDrawing + Generic:GraphicalModel3d\", () => expectAccepted(SectionDrawing.classFullName, \"Generic:GraphicalModel3d\"));\r\n    it(\"TemplateRecipe2d + DrawingModel\", () => expectAccepted(TemplateRecipe2d.classFullName, DrawingModel.classFullName, IModel.dictionaryId));\r\n    it(\"Sheet + SheetModel subclass without a JS class\", () => expectAccepted(Sheet.classFullName, \"TestSubModel:TestSheetModel\"));\r\n    it(\"no allowedSubModelClasses → any model accepted\", () => {\r\n      expectAccepted(\"TestSubModel:TestHostDocument\", SheetModel.classFullName);\r\n      expectAccepted(\"TestSubModel:TestHostDocument\", DrawingModel.classFullName);\r\n    });\r\n    it(\"Sheet subclass that widens allowedSubModelClasses + DrawingModel\", () => expectAccepted(TestSheetWidened.classFullName, DrawingModel.classFullName));\r\n    it(\"Sheet subclass that overrides onSubModelInsert without super + DrawingModel\", () => expectAccepted(TestSheetUnvalidated.classFullName, DrawingModel.classFullName));\r\n    it(\"Document subclass with allowedSubModelClasses + DrawingModel\", () => expectAccepted(TestRestrictedDocument.classFullName, DrawingModel.classFullName));\r\n  });\r\n\r\n  describe(\"rejects with IModelStatus.WrongModel\", () => {\r\n    it(\"Sheet + DrawingModel\", () => expectRejected(Sheet.classFullName, DrawingModel.classFullName));\r\n    it(\"Drawing + SheetModel\", () => expectRejected(Drawing.classFullName, SheetModel.classFullName));\r\n    it(\"SectionDrawing + SheetModel\", () => expectRejected(SectionDrawing.classFullName, SheetModel.classFullName));\r\n    it(\"TemplateRecipe2d + SheetModel\", () => expectRejected(TemplateRecipe2d.classFullName, SheetModel.classFullName, IModel.dictionaryId));\r\n    it(\"Sheet subclass without a JS class + DrawingModel\", () => expectRejected(\"TestSubModel:TestSheetGenerated\", DrawingModel.classFullName));\r\n    it(\"Document subclass with allowedSubModelClasses + SheetModel\", () => expectRejected(TestRestrictedDocument.classFullName, SheetModel.classFullName));\r\n  });\r\n\r\n  it(\"invokes an overriding subclass hook that defers to the inherited validation\", () => {\r\n    const spy = sinonSpy(TestSheetSpy, \"onSubModelInsert\");\r\n    try {\r\n      expectAccepted(TestSheetSpy.classFullName, SheetModel.classFullName);\r\n      expect(spy.calledOnce).to.be.true;\r\n      expect(spy.getCall(0).args[0].subModelProps.classFullName).to.equal(SheetModel.classFullName);\r\n\r\n      expectRejected(TestSheetSpy.classFullName, DrawingModel.classFullName);\r\n      expect(spy.calledTwice).to.be.true;\r\n      expect(spy.getCall(1).threw()).to.be.true;\r\n    } finally {\r\n      spy.restore();\r\n    }\r\n  });\r\n\r\n  describe(\"missing required behavior\", () => {\r\n    it(\"rejects sub-model insertion\", () => {\r\n      const hostId = insertHost(TestRestrictedDocument.classFullName);\r\n      Schemas.unregisterSchema(TestSubModelSchema.schemaName);\r\n\r\n      try {\r\n        let error: unknown;\r\n        try {\r\n          insertSubModel(DefinitionModel.classFullName, hostId);\r\n        } catch (err) {\r\n          error = err;\r\n        }\r\n\r\n        expect(error).to.be.instanceOf(IModelError);\r\n        expect((error as IModelError).errorNumber).to.equal(IModelStatus.WrongHandler);\r\n        expect(imodel.models.tryGetModel(hostId)).to.be.undefined;\r\n      } finally {\r\n        Schemas.registerSchema(TestSubModelSchema);\r\n        ClassRegistry.register(TestSheetSpy, TestSubModelSchema);\r\n        ClassRegistry.register(TestSheetWidened, TestSubModelSchema);\r\n        ClassRegistry.register(TestSheetUnvalidated, TestSubModelSchema);\r\n        ClassRegistry.register(TestRestrictedDocument, TestSubModelSchema);\r\n      }\r\n    });\r\n  });\r\n});\r\n"]}

package/lib/esm/test/imodel/IModelGeolocation.test.js

@@ -188,7 +188,7 @@ describe("iModel geolocation", () => {
                     const expectedPt1 = Point3d.fromJSON(outputCoord.p);
                     const outPt1 = Point3d.fromJSON(response1.geoCoords[0].p);
                     expect(Geometry.isSamePoint3dXY(expectedPt1, outPt1, 0.001)).to.be.true;
-                    expect(Math.abs(expectedPt1.z - outPt1.z), fileName).to.be.lessThan(0.0001);
+                    expect(Math.abs(expectedPt1.z - outPt1.z), fileName).to.be.lessThan(0.001);
                     // No point testing reversal when Out of useful range since reversibility is doubtful
                     if (outputCoord.s !== GeoCoordStatus.OutOfUsefulRange) {
                         const testPoint2 = [];
@@ -197,8 +197,8 @@ describe("iModel geolocation", () => {
                         const response2 = await iModel.getIModelCoordinatesFromGeoCoordinates(requestProps2);
                         const expectedPt2 = Point3d.fromJSON(inputCoord);
                         const outPt2 = Point3d.fromJSON(response2.iModelCoords[0].p);
-                        expect(expectedPt2.distanceXY(outPt2) < 0.001).to.be.true;
-                        expect(Math.abs(expectedPt2.z - outPt2.z) < 0.001).to.be.true;
+                        expect(expectedPt2.distanceXY(outPt2), fileName).to.be.lessThan(0.001);
+                        expect(Math.abs(expectedPt2.z - outPt2.z), fileName).to.be.lessThan(0.001);
                     }
                 }
                 iModel.close();