Remove getElement from NativeDgnDb

iModelJsNodeAddon/IModelJsNative.cpp

@@ -1238,15 +1238,6 @@ struct NativeDgnDb : BeObjectWrap<NativeDgnDb>, SQLiteOps<DgnDb>
         return worker->Queue();  // Schema serialization happens in another thread
     }
 
-    Napi::Value GetElement(NapiInfoCR info) {
-        REQUIRE_ARGUMENT_ANY_OBJ(0, opts);
-        BeJsNapiObject jsValue(Env());
-        auto status = JsInterop::GetElement(jsValue, GetOpenedDb(info), opts);
-        if (DgnDbStatus::Success != status)
-            BeNapi::ThrowJsException(Env(), "error reading element", (int)status);
-        return jsValue;
-    }
-
     Napi::Value GetModel(NapiInfoCR info) {
         REQUIRE_ARGUMENT_ANY_OBJ(0, opts);
         BeJsNapiObject modelJson(Env());
@@ -2710,7 +2701,6 @@ struct NativeDgnDb : BeObjectWrap<NativeDgnDb>, SQLiteOps<DgnDb>
             InstanceMethod("getCurrentChangeset", &NativeDgnDb::GetCurrentChangeset),
             InstanceMethod("getCurrentTxnId", &NativeDgnDb::GetCurrentTxnId),
             InstanceMethod("getECClassMetaData", &NativeDgnDb::GetECClassMetaData),
-            InstanceMethod("getElement", &NativeDgnDb::GetElement),
             InstanceMethod("getInstance", &NativeDgnDb::GetInstance),
             InstanceMethod("executeSql", &NativeDgnDb::ExecuteSql),
             InstanceMethod("getFilePath", &NativeDgnDb::GetFilePath),

iModelJsNodeAddon/IModelJsNative.h

@@ -499,7 +499,6 @@ struct JsInterop {
     static DgnDbPtr CreateIModel(Utf8StringCR filename, BeJsConst props);
     static DgnDbStatus GetECClassMetaData(BeJsValue results, DgnDbR db, Utf8CP schema, Utf8CP ecclass);
     static DgnDbStatus GetSchemaItem(BeJsValue results, DgnDbR db, Utf8CP schemaName, Utf8CP itemName);
-    static DgnDbStatus GetElement(BeJsValue results, DgnDbR db, Napi::Object);
     static Napi::String InsertElement(DgnDbR db, Napi::Object props, Napi::Value options);
     static void UpdateElement(DgnDbR db, Napi::Object);
     static void DeleteElement(DgnDbR db, Utf8StringCR eidStr);

iModelJsNodeAddon/JsInteropDgnDb.cpp

@@ -31,7 +31,6 @@ BE_JSON_NAME(minOccurs)
 BE_JSON_NAME(minimumLength)
 BE_JSON_NAME(minimumValue)
 BE_JSON_NAME(modifier)
-BE_JSON_NAME(onlyBaseProperties)
 BE_JSON_NAME(primitiveType)
 BE_JSON_NAME(properties)
 BE_JSON_NAME(readOnly)
@@ -302,39 +301,6 @@ DgnDbStatus JsInterop::GetSchemaItem(BeJsValue mjson, DgnDbR dgndb, Utf8CP schem
     return DgnDbStatus::NotFound;    // This is not an exception. It just returns an empty result.
 }
 
-//---------------------------------------------------------------------------------------
-// @bsimethod
-//---------------------------------------------------------------------------------------
-DgnDbStatus JsInterop::GetElement(BeJsValue elementJson, DgnDbR dgndb, Napi::Object obj) {
-    BeJsConst inOpts(obj);
-    DgnElementCPtr elem;
-    DgnElementId eid = inOpts[json_id()].GetId64<DgnElementId>();
-
-    if (!eid.IsValid()) {
-        auto fedJson = inOpts[json_federationGuid()];
-        if (fedJson.isString()) {
-            BeGuid federationGuid;
-            federationGuid.FromString(fedJson.asCString());
-            elem = dgndb.Elements().QueryElementByFederationGuid(federationGuid);
-        } else {
-            eid = dgndb.Elements().QueryElementIdByCode(DgnCode::FromJson(inOpts[json_code()], dgndb, false));
-        }
-    }
-
-    if (!elem.IsValid())
-        elem = dgndb.Elements().GetElement(eid);
-
-    if (!elem.IsValid())
-        return DgnDbStatus::NotFound;
-
-    // if they only want base properties, don't bother calling virtual function
-    if (inOpts[json_onlyBaseProperties()].asBool())
-        elem->ToBaseJson(elementJson);
-    else
-        elem->ToJson(elementJson, inOpts);
-    return DgnDbStatus::Success;
-}
-
 struct SetNapiObjOnElement {
     DgnElementR m_element;
     SetNapiObjOnElement(DgnElementR element, NapiObjectCP obj) : m_element(element) {BeAssert(nullptr==element.m_napiObj); element.m_napiObj = obj;}

iModelJsNodeAddon/api_package/ts/src/NativeLibrary.ts

@@ -18,7 +18,7 @@ import type {
   StatusCodeWithMessage,
 } from "@itwin/core-bentley";
 import type {
-  ChangesetIndexAndId, CodeSpecProperties, CreateEmptyStandaloneIModelProps, DbRequest, DbResponse, ElementAspectProps, ElementGraphicsRequestProps, ElementLoadProps, ElementProps,
+  ChangesetIndexAndId, CodeSpecProperties, CreateEmptyStandaloneIModelProps, DbRequest, DbResponse, ElementAspectProps, ElementGraphicsRequestProps, ElementProps,
   FilePropertyProps, FontId, FontMapProps, GeoCoordinatesRequestProps, GeoCoordinatesResponseProps, GeographicCRSInterpretRequestProps,
   GeographicCRSInterpretResponseProps, GeometryContainmentResponseProps, IModelCoordinatesRequestProps,
   IModelCoordinatesResponseProps, IModelProps, LocalDirName, LocalFileName, MassPropertiesResponseProps, ModelLoadProps,
@@ -587,7 +587,6 @@ export declare namespace IModelJsNative {
     public getCurrentChangeset(): ChangesetIndexAndId;
     public getCurrentTxnId(): TxnIdString;
     public getECClassMetaData(schema: string, className: string): ErrorStatusOrResult<IModelStatus, string>;
-    public getElement(opts: ElementLoadProps): ElementProps;
     public executeSql(sql: string): DbResult;
     public getFilePath(): string; // full path of the DgnDb file
     public getGeoCoordinatesFromIModelCoordinates(points: GeoCoordinatesRequestProps): GeoCoordinatesResponseProps;

iModelJsNodeAddon/api_package/ts/src/test/ElementDependency.test.ts

@@ -3,10 +3,10 @@
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 
-import { assert } from "chai";
-import { Guid, GuidString, Id64Array, Id64String } from "@itwin/core-bentley";
-import type { ModelGeometryChangesProps, RelatedElementProps, RelationshipProps, SubjectProps } from "@itwin/core-common";
-import { IModelJsNative } from "../NativeLibrary";
+import { assert, expect } from "chai";
+import { DbResult, Guid, GuidString, Id64Array, Id64String } from "@itwin/core-bentley";
+import { type ModelGeometryChangesProps, type RelatedElementProps, type RelationshipProps, type SubjectProps, mapNativeElementProps } from "@itwin/core-common";
+import { IModelJsNative, InstanceSerializationMethod } from "../NativeLibrary";
 import { copyFile, dbFileName } from "./utils";
 import { openDgnDb } from "./index";
 
@@ -126,8 +126,18 @@ function makeEDE(sourceId: Id64String, targetId: Id64String): ElementDrivesEleme
   };
 }
 
+function getElement(dgnDb: IModelJsNative.DgnDb, elid: Id64String) {
+  const statement = new IModelJsNative.ECSqlStatement();
+  statement.prepare(dgnDb, `SELECT ECClassId FROM Bis.Element WHERE ECInstanceId=?`);
+  statement.getBinder(1).bindId(elid);
+  expect(statement.step()).eq(DbResult.BE_SQLITE_ROW);
+  const classId = statement.getValue(0).getId();
+  statement.dispose();
+  return mapNativeElementProps(dgnDb.getInstance({ id: elid, classId, serializationMethod: InstanceSerializationMethod.BeJsNapi, useJsNames: true, classIdsToClassNames: true, abbreviateBlobs: false }));
+}
+
 function updateElement(db1: IModelJsNative.DgnDb, elid: Id64String, newLabel: string) {
-  const ed2 = db1.getElement({ id: elid });
+  const ed2 = getElement(db, elid);
   ed2.userLabel = newLabel;
   db1.updateElement(ed2);
 }
@@ -156,7 +166,7 @@ describe("elementDependency", () => {
     db.enableTxnTesting();
 
     mockTxn.fmtElem = (_cn: string, id: Id64String) => {
-      return db.getElement({ id }).code.value!;
+      return getElement(db, id).code.value!;
     };
 
     const p2id = db.insertElement(makeSubject("p2"));
@@ -215,7 +225,7 @@ describe("elementDependency", () => {
     db.enableTxnTesting();
 
     mockTxn.fmtElem = (_cn: string, id: Id64String) => {
-      return db.getElement({ id }).code.value!;
+      return getElement(db, id).code.value!;
     };
 
     // The full graph:
@@ -334,7 +344,7 @@ describe("elementDependency", () => {
     db.enableTxnTesting();
 
     mockTxn.fmtElem = (_cn: string, id: Id64String) => {
-      return db.getElement({ id }).code.value!;
+      return getElement(db, id).code.value!;
     };
 
     const e1id = db.insertElement(makeSubject("e1"));
@@ -382,41 +392,41 @@ describe("elementDependency", () => {
     db.enableTxnTesting();
 
     mockTxn.fmtElem = (_cn: string, id: Id64String) => {
-      return db.getElement({ id }).code.value!;
+      return getElement(db, id).code.value!;
     };
 
     const e1id = db.insertElement(makeSubject("e1"));
-    const e1 = db.getElement({ id: e1id });
+    const e1 = getElement(db, e1id);
     assert.isTrue(Guid.isGuid(e1.federationGuid!)); // if you don't supply a federationGuid, one is created
 
     const e11props = makeSubject("e11");
     e11props.federationGuid = Guid.empty;
     const e11id = db.insertElement(e11props);
-    const e11 = db.getElement({ id: e11id });
+    const e11 = getElement(db, e11id);
     assert.isUndefined(e11.federationGuid); // if you supply empty federationGuid, it is saved as null and returned as undefined
 
     const e2props = makeSubject("e2");
     e2props.federationGuid = Guid.createValue();
     const e2id = db.insertElement(e2props);
-    const e2 = db.getElement({ id: e2id });
+    const e2 = getElement(db, e2id);
     assert.strictEqual(e2.federationGuid, e2props.federationGuid); // you may supply your own federationGuid
 
     const e21props = makeSubject("e21");
     e21props.federationGuid = "bad guid";
     const e21id = db.insertElement(e21props);
-    const e21 = db.getElement({ id: e21id });
+    const e21 = getElement(db, e21id);
     assert.isUndefined(e21.federationGuid); // if you supply an invalid federationGuid, it is saved as null and returned as undefined
 
     const e3props = makeSubject("e3");
     e3props.federationGuid = undefined;
     const e3id = db.insertElement(e3props);
-    const e3 = db.getElement({ id: e3id });
+    const e3 = getElement(db, e3id);
     assert.isTrue(Guid.isGuid(e3.federationGuid!)); // if you supply "undefined" for federationGuid, one is created.
 
     const e4props = makeSubject("e4");
     e4props.federationGuid = "";
     const e4id = db.insertElement(e4props);
-    const e4 = db.getElement({ id: e4id });
+    const e4 = getElement(db, e4id);
     assert.isUndefined(e4.federationGuid); // if you supply an blank federationGuid, it is saved as null and returned as undefined
 
     const ede_1_2 = makeEDE(e1id, e2id);

iModelJsNodeAddon/api_package/ts/src/test/importSchema.test.ts

@@ -6,9 +6,10 @@ import { assert, expect } from "chai";
 import * as fs from "fs";
 import * as path from "path";
 import { getOutputDir, iModelJsNative } from "./utils";
-import { Guid, OpenMode } from "@itwin/core-bentley";
-import { Code, ElementProps } from "@itwin/core-common";
+import { DbResult, Guid, Id64String, OpenMode } from "@itwin/core-bentley";
+import { Code, ElementProps, mapNativeElementProps } from "@itwin/core-common";
 import { clearRegistry, loadMetaData } from "./loadMetaData";
+import { IModelJsNative, InstanceSerializationMethod } from "../NativeLibrary";
 
 const testSchemaXmlV10 = `<?xml version="1.0" encoding="UTF-8"?>
 <ECSchema schemaName="Test" alias="test" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
@@ -69,6 +70,16 @@ const testInformationRecordElementV11: ElementProps & { property1: string, prope
   property2: "Prop2",
 };
 
+function getElement(db: IModelJsNative.DgnDb, elid: Id64String) {
+  const statement = new IModelJsNative.ECSqlStatement();
+  statement.prepare(db, `SELECT ECClassId FROM Bis.Element WHERE ECInstanceId=?`);
+  statement.getBinder(1).bindId(elid);
+  expect(statement.step()).eq(DbResult.BE_SQLITE_ROW);
+  const classId = statement.getValue(0).getId();
+  statement.dispose();
+  return mapNativeElementProps(db.getInstance({ id: elid, classId, serializationMethod: InstanceSerializationMethod.BeJsNapi, useJsNames: true, classIdsToClassNames: true, abbreviateBlobs: false }));
+}
+
 describe("ImportSchema", () => {
 
   it("should import schema into a locally changed briefcase", () => {
@@ -98,7 +109,7 @@ describe("ImportSchema", () => {
     expect(testInfoClassV10.properties).not.hasOwnProperty("property2");
 
     const el1Id = db.insertElement(testInformationRecordElementV10);
-    const el1v10 = db.getElement({ id: el1Id });
+    const el1v10 = getElement(db, el1Id);
     expect(el1v10).has.property("property1");
     expect(el1v10).not.has.property("property2");
     expect((el1v10 as any).property1).eq(testInformationRecordElementV10.property1);
@@ -121,13 +132,13 @@ describe("ImportSchema", () => {
     expect(testInfoClassV11.properties).hasOwnProperty("property1");
     expect(testInfoClassV11.properties).hasOwnProperty("property2");
 
-    const el1v11 = db.getElement({ id: el1Id });
+    const el1v11 = getElement(db, el1Id);
     expect(el1v11).has.property("property1");
     expect(el1v11).not.has.property("property2");
     expect((el1v11 as any).property1).eq(testInformationRecordElementV10.property1);
 
     const el2Id = db.insertElement(testInformationRecordElementV11);
-    const el2v11 = db.getElement({ id: el2Id });
+    const el2v11 = getElement(db, el2Id);
     expect(el2v11).has.property("property1");
     expect(el2v11).has.property("property2");
     expect((el2v11 as any).property1).eq(testInformationRecordElementV11.property1);