@itwin/core-backend 5.12.0-dev.9 → 5.12.1

package/lib/esm/internal/ECSqlInstanceReshaper.d.ts

@@ -0,0 +1,23 @@
+import { AnyClass, Property } from "@itwin/ecschema-metadata";
+import { IModelDb } from "../IModelDb";
+/** Reshape a single value from `UseECSqlPropertyNames` to `UseJsPropertyNames`, dispatching on `prop`'s
+ * declared type (struct/array/point/navigation) instead of guessing from the value's shape.
+ * @internal
+ */
+export declare function reshapePropertyValue(value: any, prop: Property, iModel: IModelDb): any;
+/**
+ * Reshapes a `SELECT *` row queried with `UseECSqlPropertyNames` into the legacy `UseJsPropertyNames`
+ * shape, for a class only known at runtime. Walks `ecClass`'s metadata to rename each property, since a
+ * row's runtime shape alone can't tell a struct/point/navigation value apart from a plain object.
+ * @internal
+ */
+export declare function reshapeInstanceRow(row: {
+    [propName: string]: any;
+}, ecClass: AnyClass, iModel: IModelDb): {
+    [propName: string]: any;
+};
+/** Resolves the runtime [[AnyClass]] metadata for a "Schema:Class" or "Schema.Class" name.
+ * @internal
+ */
+export declare function getRuntimeClass(iModel: IModelDb, fullClassName: string): AnyClass;
+//# sourceMappingURL=ECSqlInstanceReshaper.d.ts.map

package/lib/esm/internal/ECSqlInstanceReshaper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ECSqlInstanceReshaper.d.ts","sourceRoot":"","sources":["../../../src/internal/ECSqlInstanceReshaper.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,QAAQ,EAA0B,QAAQ,EAAe,MAAM,0BAA0B,CAAC;AACnG,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAyDvC;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,GAAG,CA2BtF;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE;IAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG;IAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAkBrI;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,GAAG,QAAQ,CAMjF"}

package/lib/esm/internal/ECSqlInstanceReshaper.js

@@ -0,0 +1,120 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+// Reimplements `UseJsPropertyNames` value shaping so `@public`/`@beta` output stays the same after it's
+// deprecated. not permanent - see https://github.com/iTwin/itwinjs-core/issues/9489.
+import { ECClass, PrimitiveType } from "@itwin/ecschema-metadata";
+/** Maps `SELECT *` system properties/pseudo-columns to their legacy JS property name. `*ClassId` columns
+ * also resolve their raw class Id to a dot-separated class name (e.g. "BisCore.PhysicalElement").
+ */
+const systemPropertyJsNames = new Map([
+    ["ECInstanceId", { jsName: "id" }],
+    ["ECClassId", { jsName: "className", isClassId: true }],
+    ["SourceECInstanceId", { jsName: "sourceId" }],
+    ["SourceECClassId", { jsName: "sourceClassName", isClassId: true }],
+    ["TargetECInstanceId", { jsName: "targetId" }],
+    ["TargetECClassId", { jsName: "targetClassName", isClassId: true }],
+]);
+function lowerFirstChar(name) {
+    return name.length === 0 ? name : `${name[0].toLowerCase()}${name.substring(1)}`;
+}
+function classIdToDotClassName(iModel, classId) {
+    try {
+        return iModel.getClassNameFromId(classId).replace(":", ".");
+    }
+    catch {
+        // fall back to raw classId instead of throwing if it can't be resolved
+        return classId;
+    }
+}
+/** Reshape a struct value's members from `UseECSqlPropertyNames` to `UseJsPropertyNames`, recursively. */
+function reshapeStruct(value, structClass, iModel) {
+    const result = {};
+    for (const key of Object.keys(value)) {
+        const memberValue = value[key];
+        if (undefined === memberValue || null === memberValue) {
+            continue;
+        }
+        const memberProp = structClass.getPropertySync(key);
+        result[lowerFirstChar(key)] = memberProp ? reshapePropertyValue(memberValue, memberProp, iModel) : memberValue;
+    }
+    return result;
+}
+/** Reshape a scalar (non-struct, non-array, non-navigation) value. Only Point2d/Point3d change shape
+ * (X/Y/Z -> x/y/z); other primitives/enumerations pass through unchanged.
+ */
+function reshapeScalar(value, prop) {
+    if (prop.isPrimitive()) {
+        if (prop.primitiveType === PrimitiveType.Point2d) {
+            return { x: value.X, y: value.Y };
+        }
+        if (prop.primitiveType === PrimitiveType.Point3d) {
+            return { x: value.X, y: value.Y, z: value.Z };
+        }
+    }
+    return value;
+}
+/** Reshape a single value from `UseECSqlPropertyNames` to `UseJsPropertyNames`, dispatching on `prop`'s
+ * declared type (struct/array/point/navigation) instead of guessing from the value's shape.
+ * @internal
+ */
+export function reshapePropertyValue(value, prop, iModel) {
+    // struct classes can't declare navigation properties, so this only applies at the top level
+    if (prop.isNavigation()) {
+        const result = { id: value.Id };
+        // omit relClassName entirely if the relationship class Id is unset, rather than set to undefined
+        if (undefined !== value.RelECClassId && null !== value.RelECClassId) {
+            result.relClassName = classIdToDotClassName(iModel, value.RelECClassId);
+        }
+        return result;
+    }
+    if (prop.isArray()) {
+        if (!Array.isArray(value)) {
+            return value;
+        }
+        // null/undefined elements are dropped from primitive arrays, but kept as an empty object placeholder
+        // in struct arrays, to preserve array length/index
+        return prop.isStruct()
+            ? value.map((element) => (undefined === element || null === element) ? {} : reshapeStruct(element, prop.structClass, iModel))
+            : value.filter((element) => undefined !== element && null !== element).map((element) => reshapeScalar(element, prop));
+    }
+    if (prop.isStruct()) {
+        return reshapeStruct(value, prop.structClass, iModel);
+    }
+    return reshapeScalar(value, prop);
+}
+/**
+ * Reshapes a `SELECT *` row queried with `UseECSqlPropertyNames` into the legacy `UseJsPropertyNames`
+ * shape, for a class only known at runtime. Walks `ecClass`'s metadata to rename each property, since a
+ * row's runtime shape alone can't tell a struct/point/navigation value apart from a plain object.
+ * @internal
+ */
+export function reshapeInstanceRow(row, ecClass, iModel) {
+    const result = {};
+    for (const key of Object.keys(row)) {
+        const value = row[key];
+        if (undefined === value || null === value) {
+            continue;
+        }
+        const systemProperty = systemPropertyJsNames.get(key);
+        if (systemProperty) {
+            result[systemProperty.jsName] = systemProperty.isClassId ? classIdToDotClassName(iModel, value) : value;
+            continue;
+        }
+        const prop = ecClass.getPropertySync(key);
+        result[lowerFirstChar(key)] = prop ? reshapePropertyValue(value, prop, iModel) : value;
+    }
+    return result;
+}
+/** Resolves the runtime [[AnyClass]] metadata for a "Schema:Class" or "Schema.Class" name.
+ * @internal
+ */
+export function getRuntimeClass(iModel, fullClassName) {
+    const schemaItem = iModel.schemaContext.getSchemaItemSync(fullClassName);
+    if (undefined === schemaItem || !ECClass.isECClass(schemaItem)) {
+        throw new Error(`Class not found: ${fullClassName}`);
+    }
+    return schemaItem;
+}
+//# sourceMappingURL=ECSqlInstanceReshaper.js.map

package/lib/esm/internal/ECSqlInstanceReshaper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ECSqlInstanceReshaper.js","sourceRoot":"","sources":["../../../src/internal/ECSqlInstanceReshaper.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,wGAAwG;AACxG,qFAAqF;AACrF,OAAO,EAAY,OAAO,EAAE,aAAa,EAAyB,MAAM,0BAA0B,CAAC;AAGnG;;GAEG;AACH,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAkD;IACrF,CAAC,cAAc,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAClC,CAAC,WAAW,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IACvD,CAAC,oBAAoB,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;IAC9C,CAAC,iBAAiB,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IACnE,CAAC,oBAAoB,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;IAC9C,CAAC,iBAAiB,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;CACpE,CAAC,CAAC;AAEH,SAAS,cAAc,CAAC,IAAY;IAClC,OAAO,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;AACnF,CAAC;AAED,SAAS,qBAAqB,CAAC,MAAgB,EAAE,OAAe;IAC9D,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC9D,CAAC;IAAC,MAAM,CAAC;QACP,uEAAuE;QACvE,OAAO,OAAO,CAAC;IACjB,CAAC;AACH,CAAC;AAED,0GAA0G;AAC1G,SAAS,aAAa,CAAC,KAAkC,EAAE,WAAwB,EAAE,MAAgB;IACnG,MAAM,MAAM,GAAgC,EAAE,CAAC;IAC/C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,SAAS,KAAK,WAAW,IAAI,IAAI,KAAK,WAAW,EAAE,CAAC;YACtD,SAAS;QACX,CAAC;QAED,MAAM,UAAU,GAAG,WAAW,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QACpD,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,oBAAoB,CAAC,WAAW,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;IACjH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,SAAS,aAAa,CAAC,KAAU,EAAE,IAAc;IAC/C,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACvB,IAAI,IAAI,CAAC,aAAa,KAAK,aAAa,CAAC,OAAO,EAAE,CAAC;YACjD,OAAO,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;QACpC,CAAC;QACD,IAAI,IAAI,CAAC,aAAa,KAAK,aAAa,CAAC,OAAO,EAAE,CAAC;YACjD,OAAO,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;QAChD,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAU,EAAE,IAAc,EAAE,MAAgB;IAC/E,4FAA4F;IAC5F,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACxB,MAAM,MAAM,GAAuC,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;QACpE,iGAAiG;QACjG,IAAI,SAAS,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,KAAK,KAAK,CAAC,YAAY,EAAE,CAAC;YACpE,MAAM,CAAC,YAAY,GAAG,qBAAqB,CAAC,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;QAC1E,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;QACnB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,qGAAqG;QACrG,mDAAmD;QACnD,OAAO,IAAI,CAAC,QAAQ,EAAE;YACpB,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,SAAS,KAAK,OAAO,IAAI,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;YAC7H,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,SAAS,KAAK,OAAO,IAAI,IAAI,KAAK,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;IAC1H,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;QACpB,OAAO,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AACpC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAAgC,EAAE,OAAiB,EAAE,MAAgB;IACtG,MAAM,MAAM,GAAgC,EAAE,CAAC;IAC/C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACvB,IAAI,SAAS,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;YAC1C,SAAS;QACX,CAAC;QAED,MAAM,cAAc,GAAG,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACtD,IAAI,cAAc,EAAE,CAAC;YACnB,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,qBAAqB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YACxG,SAAS;QACX,CAAC;QAED,MAAM,IAAI,GAAG,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QAC1C,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACzF,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,MAAgB,EAAE,aAAqB;IACrE,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;IACzE,IAAI,SAAS,KAAK,UAAU,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/D,MAAM,IAAI,KAAK,CAAC,oBAAoB,aAAa,EAAE,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n// Reimplements `UseJsPropertyNames` value shaping so `@public`/`@beta` output stays the same after it's\r\n// deprecated. not permanent - see https://github.com/iTwin/itwinjs-core/issues/9489.\r\nimport { AnyClass, ECClass, PrimitiveType, Property, StructClass } from \"@itwin/ecschema-metadata\";\r\nimport { IModelDb } from \"../IModelDb\";\r\n\r\n/** Maps `SELECT *` system properties/pseudo-columns to their legacy JS property name. `*ClassId` columns\r\n * also resolve their raw class Id to a dot-separated class name (e.g. \"BisCore.PhysicalElement\").\r\n */\r\nconst systemPropertyJsNames = new Map<string, { jsName: string, isClassId?: boolean }>([\r\n  [\"ECInstanceId\", { jsName: \"id\" }],\r\n  [\"ECClassId\", { jsName: \"className\", isClassId: true }],\r\n  [\"SourceECInstanceId\", { jsName: \"sourceId\" }],\r\n  [\"SourceECClassId\", { jsName: \"sourceClassName\", isClassId: true }],\r\n  [\"TargetECInstanceId\", { jsName: \"targetId\" }],\r\n  [\"TargetECClassId\", { jsName: \"targetClassName\", isClassId: true }],\r\n]);\r\n\r\nfunction lowerFirstChar(name: string): string {\r\n  return name.length === 0 ? name : `${name[0].toLowerCase()}${name.substring(1)}`;\r\n}\r\n\r\nfunction classIdToDotClassName(iModel: IModelDb, classId: string): string {\r\n  try {\r\n    return iModel.getClassNameFromId(classId).replace(\":\", \".\");\r\n  } catch {\r\n    // fall back to raw classId instead of throwing if it can't be resolved\r\n    return classId;\r\n  }\r\n}\r\n\r\n/** Reshape a struct value's members from `UseECSqlPropertyNames` to `UseJsPropertyNames`, recursively. */\r\nfunction reshapeStruct(value: { [propName: string]: any }, structClass: StructClass, iModel: IModelDb): { [propName: string]: any } {\r\n  const result: { [propName: string]: any } = {};\r\n  for (const key of Object.keys(value)) {\r\n    const memberValue = value[key];\r\n    if (undefined === memberValue || null === memberValue) {\r\n      continue;\r\n    }\r\n\r\n    const memberProp = structClass.getPropertySync(key);\r\n    result[lowerFirstChar(key)] = memberProp ? reshapePropertyValue(memberValue, memberProp, iModel) : memberValue;\r\n  }\r\n  return result;\r\n}\r\n\r\n/** Reshape a scalar (non-struct, non-array, non-navigation) value. Only Point2d/Point3d change shape\r\n * (X/Y/Z -> x/y/z); other primitives/enumerations pass through unchanged.\r\n */\r\nfunction reshapeScalar(value: any, prop: Property): any {\r\n  if (prop.isPrimitive()) {\r\n    if (prop.primitiveType === PrimitiveType.Point2d) {\r\n      return { x: value.X, y: value.Y };\r\n    }\r\n    if (prop.primitiveType === PrimitiveType.Point3d) {\r\n      return { x: value.X, y: value.Y, z: value.Z };\r\n    }\r\n  }\r\n  return value;\r\n}\r\n\r\n/** Reshape a single value from `UseECSqlPropertyNames` to `UseJsPropertyNames`, dispatching on `prop`'s\r\n * declared type (struct/array/point/navigation) instead of guessing from the value's shape.\r\n * @internal\r\n */\r\nexport function reshapePropertyValue(value: any, prop: Property, iModel: IModelDb): any {\r\n  // struct classes can't declare navigation properties, so this only applies at the top level\r\n  if (prop.isNavigation()) {\r\n    const result: { id: any, relClassName?: string } = { id: value.Id };\r\n    // omit relClassName entirely if the relationship class Id is unset, rather than set to undefined\r\n    if (undefined !== value.RelECClassId && null !== value.RelECClassId) {\r\n      result.relClassName = classIdToDotClassName(iModel, value.RelECClassId);\r\n    }\r\n    return result;\r\n  }\r\n\r\n  if (prop.isArray()) {\r\n    if (!Array.isArray(value)) {\r\n      return value;\r\n    }\r\n    // null/undefined elements are dropped from primitive arrays, but kept as an empty object placeholder\r\n    // in struct arrays, to preserve array length/index\r\n    return prop.isStruct()\r\n      ? value.map((element) => (undefined === element || null === element) ? {} : reshapeStruct(element, prop.structClass, iModel))\r\n      : value.filter((element) => undefined !== element && null !== element).map((element) => reshapeScalar(element, prop));\r\n  }\r\n\r\n  if (prop.isStruct()) {\r\n    return reshapeStruct(value, prop.structClass, iModel);\r\n  }\r\n\r\n  return reshapeScalar(value, prop);\r\n}\r\n\r\n/**\r\n * Reshapes a `SELECT *` row queried with `UseECSqlPropertyNames` into the legacy `UseJsPropertyNames`\r\n * shape, for a class only known at runtime. Walks `ecClass`'s metadata to rename each property, since a\r\n * row's runtime shape alone can't tell a struct/point/navigation value apart from a plain object.\r\n * @internal\r\n */\r\nexport function reshapeInstanceRow(row: { [propName: string]: any }, ecClass: AnyClass, iModel: IModelDb): { [propName: string]: any } {\r\n  const result: { [propName: string]: any } = {};\r\n  for (const key of Object.keys(row)) {\r\n    const value = row[key];\r\n    if (undefined === value || null === value) {\r\n      continue;\r\n    }\r\n\r\n    const systemProperty = systemPropertyJsNames.get(key);\r\n    if (systemProperty) {\r\n      result[systemProperty.jsName] = systemProperty.isClassId ? classIdToDotClassName(iModel, value) : value;\r\n      continue;\r\n    }\r\n\r\n    const prop = ecClass.getPropertySync(key);\r\n    result[lowerFirstChar(key)] = prop ? reshapePropertyValue(value, prop, iModel) : value;\r\n  }\r\n  return result;\r\n}\r\n\r\n/** Resolves the runtime [[AnyClass]] metadata for a \"Schema:Class\" or \"Schema.Class\" name.\r\n * @internal\r\n */\r\nexport function getRuntimeClass(iModel: IModelDb, fullClassName: string): AnyClass {\r\n  const schemaItem = iModel.schemaContext.getSchemaItemSync(fullClassName);\r\n  if (undefined === schemaItem || !ECClass.isECClass(schemaItem)) {\r\n    throw new Error(`Class not found: ${fullClassName}`);\r\n  }\r\n  return schemaItem;\r\n}\r\n"]}

package/lib/esm/internal/annotations/fields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../../../src/internal/annotations/fields.ts"],"names":[],"mappings":"AAKA,OAAO,EAA0C,QAAQ,EAAE,UAAU,EAAiD,iBAAiB,EAAE,SAAS,EAA8B,MAAM,oBAAoB,CAAC;AAC3M,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAyB,UAAU,EAAU,MAAM,qBAAqB,CAAC;AAIhF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AA0B7C,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,aAAa,EAAE,UAAU,GAAG,SAAS,CAAC;IAE/C,WAAW,CAAC,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAA;CACrD;AAgKD,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,GAAG,mBAAmB,CAK9H;AAGD,wBAAgB,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAsBlF;AAID,wBAAgB,YAAY,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,mBAAmB,GAAG,MAAM,CASvF;AA0BD,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,iBAAiB,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAElG;AAED,wBAAgB,eAAe,CAAC,mBAAmB,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,GAAG,IAAI,CAEnF"}
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../../../src/internal/annotations/fields.ts"],"names":[],"mappings":"AAKA,OAAO,EAA0C,QAAQ,EAAE,UAAU,EAAiD,iBAAiB,EAAE,SAAS,EAA8B,MAAM,oBAAoB,CAAC;AAC3M,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAyB,UAAU,EAAU,MAAM,qBAAqB,CAAC;AAKhF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AA0B7C,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,aAAa,EAAE,UAAU,GAAG,SAAS,CAAC;IAE/C,WAAW,CAAC,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAA;CACrD;AAoKD,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,GAAG,mBAAmB,CAK9H;AAGD,wBAAgB,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAsBlF;AAID,wBAAgB,YAAY,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,mBAAmB,GAAG,MAAM,CASvF;AA0BD,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,iBAAiB,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAElG;AAED,wBAAgB,eAAe,CAAC,mBAAmB,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,GAAG,IAAI,CAEnF"}

package/lib/esm/internal/annotations/fields.js

@@ -7,6 +7,7 @@ import { assert, expectDefined, Logger } from "@itwin/core-bentley";
 import { BackendLoggerCategory } from "../../BackendLoggerCategory";
 import { isITextAnnotation } from "../../annotations/ElementDrivesTextAnnotation";
 import { EntityClass, PrimitiveType, PropertyType, StructArrayProperty } from "@itwin/ecschema-metadata";
+import { reshapePropertyValue } from "../ECSqlInstanceReshaper";
 // Resolve the raw primitive value of the property that a field points to.
 function getFieldPropertyValue(field, iModel) {
     const host = field.propertyHost;
@@ -22,15 +23,20 @@ function getFieldPropertyValue(field, iModel) {
     }
     const isAspect = ecClass.isSync("ElementAspect", "BisCore");
     const where = ` WHERE ${isAspect ? "Element.Id" : "ECInstanceId"}=:elementId`;
+    // `propertyName` may itself be a struct/array/point/navigation property, so its value can't be
+    // decomposed into scalar sub-columns ahead of time. Query using the non-deprecated
+    // UseECSqlPropertyNames format and reshape the value into the legacy UseJsPropertyNames shape using
+    // ECSchema metadata (see ECSqlInstanceReshaper for why a naive, non-schema-aware rename isn't safe here).
     let curValue = iModel.withQueryReader(`SELECT ${propertyName} FROM ${host.schemaName}.${host.className} ${where}`, (reader) => {
         if (!reader.step()) {
             return undefined;
         }
-        const rootValue = reader.current[0];
-        if (undefined === rootValue) {
+        const rawRootValue = reader.current[0];
+        if (undefined === rawRootValue) {
             return undefined;
         }
         ecProp = expectDefined(ecProp);
+        const rootValue = reshapePropertyValue(rawRootValue, ecProp, iModel);
         if (ecProp.isArray()) {
             return ecProp.isStruct() ? { structArray: rootValue } : { primitiveArray: rootValue };
         }
@@ -44,8 +50,7 @@ function getFieldPropertyValue(field, iModel) {
             };
         }
         return undefined;
-        // eslint-disable-next-line @typescript-eslint/no-deprecated
-    }, new QueryBinder().bindId("elementId", host.elementId), { rowFormat: QueryRowFormat.UseJsPropertyNames });
+    }, new QueryBinder().bindId("elementId", host.elementId), { rowFormat: QueryRowFormat.UseECSqlPropertyNames });
     if (undefined === curValue) {
         return undefined;
     }

package/lib/esm/internal/annotations/fields.js.map

@@ -1 +1 @@
-{"version":3,"file":"fields.js","sourceRoot":"","sources":["../../../../src/internal/annotations/fields.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAA0C,QAAQ,EAAc,gBAAgB,EAAE,WAAW,EAAE,cAAc,EAAgC,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAE3M,OAAO,EAAE,MAAM,EAAE,aAAa,EAAc,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAClF,OAAO,EAAY,WAAW,EAAE,aAAa,EAAY,YAAY,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAiC7H,0EAA0E;AAC1E,SAAS,qBAAqB,CAAC,KAAe,EAAE,MAAgB;IAC9D,MAAM,IAAI,GAAG,KAAK,CAAC,YAAY,CAAC;IAChC,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC3F,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;QAC3C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,OAAO,GAAa,UAAU,CAAC;IACnC,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,YAAY,CAAC;IACvD,IAAI,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;IACnD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;IAC5D,MAAM,KAAK,GAAG,UAAU,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,cAAc,aAAa,CAAC;IAC9E,IAAI,QAAQ,GAA+B,MAAM,CAAC,eAAe,CAAC,UAAU,YAAY,SAAS,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,SAAS,IAAI,KAAK,EAAE,EAAE,CAAC,MAAM,EAA8B,EAAE;QACpL,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;YACnB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;QAC/B,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;YACrB,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC;QACxF,CAAC;QAED,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;YACtB,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC;YAC7B,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;QAC/B,CAAC;QAED,IAAI,MAAM,CAAC,WAAW,EAAE,EAAE,CAAC;YACzB,OAAO;gBACL,SAAS,EAAE,MAAM,CAAC,aAAa,KAAK,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;aAC7F,CAAC;QACJ,CAAC;QAED,OAAO,SAAS,CAAC;QACjB,4DAA4D;IAC9D,CAAC,EAAE,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,cAAc,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAE5G,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC3B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACd,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,IAAI,SAAS,KAAK,QAAQ,CAAC,SAAS,EAAE,CAAC;gBACrC,gCAAgC;gBAChC,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACjC,MAAM,KAAK,GAA2D,QAAQ,CAAC,cAAc,IAAI,QAAQ,CAAC,WAAW,CAAC;gBACtH,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,OAAO,SAAS,CAAC;gBACnB,CAAC;gBAED,MAAM,KAAK,GAAW,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;gBAC1E,MAAM,IAAI,GAA2C,KAAK,CAAC,KAAK,CAAC,CAAC;gBAClE,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;oBACvB,OAAO,SAAS,CAAC;gBACnB,CAAC;qBAAM,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;oBACnC,QAAQ,GAAG,EAAE,SAAS,EAAE,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3D,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,SAAS,KAAK,QAAQ,CAAC,WAAW,CAAC,CAAC;oBAC3C,MAAM,CAAC,MAAM,YAAY,mBAAmB,CAAC,CAAC;oBAE9C,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC;oBAC7B,QAAQ,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrD,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,SAAS,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC;oBAClC,OAAO,SAAS,CAAC;gBACnB,CAAC;gBAED,MAAM,IAAI,GAAQ,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBAC5C,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;oBACvB,OAAO,SAAS,CAAC;gBACnB,CAAC;gBAED,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;gBAC3C,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,OAAO,SAAS,CAAC;gBACnB,CAAC;gBAED,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;oBACrB,QAAQ,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC;gBAClF,CAAC;qBAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;oBAC7B,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC;oBAC7B,QAAQ,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;gBAC9B,CAAC;qBAAM,IAAI,MAAM,CAAC,WAAW,EAAE,EAAE,CAAC;oBAChC,QAAQ,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;gBACjC,CAAC;qBAAM,CAAC;oBACN,OAAO,SAAS,CAAC;gBACnB,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,YAAY,GAAG,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACxD,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,iDAAiD;IACjD,IAAI,SAAS,KAAK,QAAQ,CAAC,SAAS,EAAE,CAAC;QACrC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;AAC3D,CAAC;AAED,SAAS,0BAA0B,CAAC,IAAc;IAChD,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;QACzB,QAAQ,IAAI,CAAC,YAAY,EAAE,CAAC;YAC1B,KAAK,YAAY,CAAC,mBAAmB;gBACnC,OAAO,UAAU,CAAC;YACpB,KAAK,YAAY,CAAC,kBAAkB;gBAClC,OAAO,aAAa,CAAC;YACvB;gBACE,OAAO,SAAS,CAAC;QACrB,CAAC;IACH,CAAC;IAED,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACvB,QAAQ,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3B,KAAK,aAAa,CAAC,OAAO;gBACxB,OAAO,SAAS,CAAC;YACnB,KAAK,aAAa,CAAC,MAAM;gBACvB,OAAO,IAAI,CAAC,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC;YACtE,KAAK,aAAa,CAAC,QAAQ;gBACzB,OAAO,UAAU,CAAC;YACpB,KAAK,aAAa,CAAC,MAAM,CAAC;YAC1B,KAAK,aAAa,CAAC,IAAI;gBACrB,OAAO,UAAU,CAAC;YACpB,KAAK,aAAa,CAAC,OAAO,CAAC;YAC3B,KAAK,aAAa,CAAC,OAAO;gBACxB,OAAO,YAAY,CAAC;YACtB,KAAK,aAAa,CAAC,MAAM;gBACvB,OAAO,IAAI,CAAC,gBAAgB,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YACnE,KAAK,aAAa,CAAC,OAAO,CAAC;YAC3B,KAAK,aAAa,CAAC,IAAI;gBACrB,OAAO,QAAQ,CAAC;YAClB;gBACE,OAAO,SAAS,CAAC;QACrB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,aAAiC,EAAE,MAAgB,EAAE,OAAgB;IACvG,OAAO;QACL,aAAa;QACb,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,EAAE,MAAM,CAAC;KACzF,CAAC;AACJ,CAAC;AAED,2FAA2F;AAC3F,MAAM,UAAU,WAAW,CAAC,KAAe,EAAE,OAA4B;IACvE,IAAI,OAAO,CAAC,aAAa,IAAI,OAAO,CAAC,aAAa,KAAK,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;QACpF,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,UAA8B,CAAC;IACnC,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,UAAU,GAAG,gBAAgB,CAAC,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IACvD,CAAC;IAED,UAAU,GAAG,UAAU,IAAI,QAAQ,CAAC,uBAAuB,CAAC;IAC5D,IAAI,UAAU,KAAK,KAAK,CAAC,aAAa,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IACnC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,wHAAwH;AACxH,uDAAuD;AACvD,MAAM,UAAU,YAAY,CAAC,SAAoB,EAAE,OAA4B;IAC7E,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,KAAK,MAAM,EAAE,KAAK,EAAE,IAAI,0BAA0B,CAAC,SAAS,CAAC,EAAE,CAAC;QAC9D,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;YAC1D,EAAE,UAAU,CAAC;QACf,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAS,cAAc,CAAC,GAAY,EAAE,YAAwB,EAAE,QAAgC,EAAE,OAAgB;IAChH,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAC1B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QACxD,IAAI,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,MAAM,OAAO,GAAG,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YAC/D,MAAM,aAAa,GAAG,EAAE,CAAC;YACzB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,aAAa,EAAE,EAAE,CAAC;gBAC3C,IAAI,YAAY,CAAC,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,CAAC;oBAC3C,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC5B,CAAC;YACH,CAAC;YAED,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC7B,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;gBACvC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IACvD,CAAC;AACH,CAAC;AAED,uHAAuH;AACvH,MAAM,UAAU,mBAAmB,CAAC,KAAwB,EAAE,GAAY,EAAE,OAAgB;IAC1F,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,mBAA+B,EAAE,GAAY;IAC3E,cAAc,CAAC,GAAG,EAAE,mBAAmB,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;AAC7D,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\r\nimport { FieldPrimitiveValue, FieldPropertyType, FieldRun, FieldValue, formatFieldValue, QueryBinder, QueryRowFormat, RelationshipProps, TextBlock, traverseTextBlockComponent } from \"@itwin/core-common\";\r\nimport { IModelDb } from \"../../IModelDb\";\r\nimport { assert, expectDefined, Id64String, Logger } from \"@itwin/core-bentley\";\r\nimport { BackendLoggerCategory } from \"../../BackendLoggerCategory\";\r\nimport { isITextAnnotation } from \"../../annotations/ElementDrivesTextAnnotation\";\r\nimport { AnyClass, EntityClass, PrimitiveType, Property, PropertyType, StructArrayProperty } from \"@itwin/ecschema-metadata\";\r\nimport type { EditTxn } from \"../../EditTxn\";\r\ninterface FieldStructValue { [key: string]: any }\r\n\r\n// An intermediate value obtained while evaluating a FieldPropertyPath.\r\ntype FieldValueType = {\r\n  primitive: FieldPrimitiveValue;\r\n  struct?: never;\r\n  primitiveArray?: never;\r\n  structArray?: never;\r\n} | {\r\n  primitive?: never;\r\n  struct: FieldStructValue;\r\n  primitiveArray?: never;\r\n  structArray?: never;\r\n} | {\r\n  primitive?: never;\r\n  struct?: never;\r\n  primitiveArray: FieldPrimitiveValue[];\r\n  structArray?: never;\r\n} | {\r\n  primitive?: never;\r\n  struct?: never;\r\n  primitiveArray?: never;\r\n  structArray: FieldStructValue[];\r\n}\r\n\r\nexport interface UpdateFieldsContext {\r\n  readonly hostElementId: Id64String | undefined;\r\n\r\n  getProperty(field: FieldRun): FieldValue | undefined\r\n}\r\n\r\n// Resolve the raw primitive value of the property that a field points to.\r\nfunction getFieldPropertyValue(field: FieldRun, iModel: IModelDb): FieldValue | undefined {\r\n  const host = field.propertyHost;\r\n  const schemaItem = iModel.schemaContext.getSchemaItemSync(host.schemaName, host.className);\r\n  if (!EntityClass.isEntityClass(schemaItem)) {\r\n    return undefined;\r\n  }\r\n\r\n  let ecClass: AnyClass = schemaItem;\r\n  const { propertyName, accessors } = field.propertyPath;\r\n  let ecProp = ecClass.getPropertySync(propertyName);\r\n  if (!ecProp) {\r\n    return undefined;\r\n  }\r\n\r\n  const isAspect = ecClass.isSync(\"ElementAspect\", \"BisCore\");\r\n  const where = ` WHERE ${isAspect ? \"Element.Id\" : \"ECInstanceId\"}=:elementId`;\r\n  let curValue: FieldValueType | undefined = iModel.withQueryReader(`SELECT ${propertyName} FROM ${host.schemaName}.${host.className} ${where}`, (reader): FieldValueType | undefined => {\r\n    if (!reader.step()) {\r\n      return undefined;\r\n    }\r\n\r\n    const rootValue = reader.current[0];\r\n    if (undefined === rootValue) {\r\n      return undefined;\r\n    }\r\n\r\n    ecProp = expectDefined(ecProp);\r\n    if (ecProp.isArray()) {\r\n      return ecProp.isStruct() ? { structArray: rootValue } : { primitiveArray: rootValue };\r\n    }\r\n\r\n    if (ecProp.isStruct()) {\r\n      ecClass = ecProp.structClass;\r\n      return { struct: rootValue };\r\n    }\r\n\r\n    if (ecProp.isPrimitive()) {\r\n      return {\r\n        primitive: ecProp.primitiveType === PrimitiveType.DateTime ? new Date(rootValue) : rootValue,\r\n      };\r\n    }\r\n\r\n    return undefined;\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  }, new QueryBinder().bindId(\"elementId\", host.elementId), { rowFormat: QueryRowFormat.UseJsPropertyNames });\r\n\r\n  if (undefined === curValue) {\r\n    return undefined;\r\n  }\r\n\r\n  if (accessors) {\r\n    for (const accessor of accessors) {\r\n      if (undefined !== curValue.primitive) {\r\n        // Can't index into a primitive.\r\n        return undefined;\r\n      }\r\n\r\n      if (typeof accessor === \"number\") {\r\n        const array: FieldPrimitiveValue[] | FieldStructValue[] | undefined = curValue.primitiveArray ?? curValue.structArray;\r\n        if (!array) {\r\n          return undefined;\r\n        }\r\n\r\n        const index: number = accessor < 0 ? (array.length + accessor) : accessor;\r\n        const item: FieldPrimitiveValue | FieldStructValue = array[index];\r\n        if (undefined === item) {\r\n          return undefined;\r\n        } else if (curValue.primitiveArray) {\r\n          curValue = { primitive: curValue.primitiveArray[index] };\r\n        } else {\r\n          assert(undefined !== curValue.structArray);\r\n          assert(ecProp instanceof StructArrayProperty);\r\n\r\n          ecClass = ecProp.structClass;\r\n          curValue = { struct: curValue.structArray[index] };\r\n        }\r\n      } else {\r\n        if (undefined === curValue.struct) {\r\n          return undefined;\r\n        }\r\n\r\n        const item: any = curValue.struct[accessor];\r\n        if (undefined === item) {\r\n          return undefined;\r\n        }\r\n\r\n        ecProp = ecClass.getPropertySync(accessor);\r\n        if (!ecProp) {\r\n          return undefined;\r\n        }\r\n\r\n        if (ecProp.isArray()) {\r\n          curValue = ecProp.isStruct() ? { structArray: item } : { primitiveArray: item };\r\n        } else if (ecProp.isStruct()) {\r\n          ecClass = ecProp.structClass;\r\n          curValue = { struct: item };\r\n        } else if (ecProp.isPrimitive()) {\r\n          curValue = { primitive: item };\r\n        } else {\r\n          return undefined;\r\n        }\r\n      }\r\n    }\r\n  }\r\n\r\n  const propertyType = determineFieldPropertyType(ecProp);\r\n  if (!propertyType) {\r\n    return undefined;\r\n  }\r\n\r\n  // The ultimate result must be a primitive value.\r\n  if (undefined === curValue.primitive) {\r\n    return undefined;\r\n  }\r\n\r\n  return { value: curValue.primitive, type: propertyType };\r\n}\r\n\r\nfunction determineFieldPropertyType(prop: Property): FieldPropertyType | undefined {\r\n  if (prop.isEnumeration()) {\r\n    switch (prop.propertyType) {\r\n      case PropertyType.Integer_Enumeration:\r\n        return \"int-enum\";\r\n      case PropertyType.String_Enumeration:\r\n        return \"string-enum\";\r\n      default:\r\n        return undefined;\r\n    }\r\n  }\r\n\r\n  if (prop.isPrimitive()) {\r\n    switch (prop.primitiveType) {\r\n      case PrimitiveType.Boolean:\r\n        return \"boolean\";\r\n      case PrimitiveType.String:\r\n        return prop.extendedTypeName === \"DateTime\" ? \"datetime\" : \"string\";\r\n      case PrimitiveType.DateTime:\r\n        return \"datetime\";\r\n      case PrimitiveType.Double:\r\n      case PrimitiveType.Long:\r\n        return \"quantity\";\r\n      case PrimitiveType.Point2d:\r\n      case PrimitiveType.Point3d:\r\n        return \"coordinate\";\r\n      case PrimitiveType.Binary:\r\n        return prop.extendedTypeName === \"BeGuid\" ? \"string\" : undefined;\r\n      case PrimitiveType.Integer:\r\n      case PrimitiveType.Long:\r\n        return \"string\";\r\n      default:\r\n        return undefined;\r\n    }\r\n  }\r\n\r\n  return undefined;\r\n}\r\n\r\nexport function createUpdateContext(hostElementId: string | undefined, iModel: IModelDb, deleted: boolean): UpdateFieldsContext {\r\n  return {\r\n    hostElementId,\r\n    getProperty: deleted ? () => undefined : (field) => getFieldPropertyValue(field, iModel),\r\n  };\r\n}\r\n\r\n// Recompute the display value of a single field, return false if it couldn't be evaluated.\r\nexport function updateField(field: FieldRun, context: UpdateFieldsContext): boolean {\r\n  if (context.hostElementId && context.hostElementId !== field.propertyHost.elementId) {\r\n    return false;\r\n  }\r\n\r\n  let newContent: string | undefined;\r\n  try {\r\n    const propValue = context.getProperty(field);\r\n    if (undefined !== propValue) {\r\n      newContent = formatFieldValue(propValue, field.formatOptions);\r\n    }\r\n  } catch (err) {\r\n    Logger.logError(BackendLoggerCategory.IModelDb, err);\r\n  }\r\n\r\n  newContent = newContent ?? FieldRun.invalidContentIndicator;\r\n  if (newContent === field.cachedContent) {\r\n    return false;\r\n  }\r\n\r\n  field.setCachedContent(newContent);\r\n  return true;\r\n}\r\n\r\n// Re-evaluates the display strings for all fields that target the element specified by `context` and returns the number\r\n// of fields whose display strings changed as a result.\r\nexport function updateFields(textBlock: TextBlock, context: UpdateFieldsContext): number {\r\n  let numUpdated = 0;\r\n  for (const { child } of traverseTextBlockComponent(textBlock)) {\r\n    if (child.type === \"field\" && updateField(child, context)) {\r\n      ++numUpdated;\r\n    }\r\n  }\r\n\r\n  return numUpdated;\r\n}\r\n\r\nfunction doUpdateFields(txn: EditTxn, annotationId: Id64String, sourceId: Id64String | undefined, deleted: boolean): void {\r\n  const iModel = txn.iModel;\r\n  try {\r\n    const target = iModel.elements.getElement(annotationId);\r\n    if (isITextAnnotation(target)) {\r\n      const context = createUpdateContext(sourceId, iModel, deleted);\r\n      const updatedBlocks = [];\r\n      for (const block of target.getTextBlocks()) {\r\n        if (updateFields(block.textBlock, context)) {\r\n          updatedBlocks.push(block);\r\n        }\r\n      }\r\n\r\n      if (updatedBlocks.length > 0) {\r\n        target.updateTextBlocks(updatedBlocks);\r\n        target.update(txn);\r\n      }\r\n    }\r\n  } catch (err) {\r\n    Logger.logError(BackendLoggerCategory.IModelDb, err);\r\n  }\r\n}\r\n\r\n// Invoked by ElementDrivesTextAnnotation to update fields in target element when source element changes or is deleted.\r\nexport function updateElementFields(props: RelationshipProps, txn: EditTxn, deleted: boolean): void {\r\n  doUpdateFields(txn, props.targetId, props.sourceId, deleted);\r\n}\r\n\r\nexport function updateAllFields(annotationElementId: Id64String, txn: EditTxn): void {\r\n  doUpdateFields(txn, annotationElementId, undefined, false);\r\n}\r\n"]}
+{"version":3,"file":"fields.js","sourceRoot":"","sources":["../../../../src/internal/annotations/fields.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAA0C,QAAQ,EAAc,gBAAgB,EAAE,WAAW,EAAE,cAAc,EAAgC,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAE3M,OAAO,EAAE,MAAM,EAAE,aAAa,EAAc,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAClF,OAAO,EAAY,WAAW,EAAE,aAAa,EAAY,YAAY,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC7H,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAiChE,0EAA0E;AAC1E,SAAS,qBAAqB,CAAC,KAAe,EAAE,MAAgB;IAC9D,MAAM,IAAI,GAAG,KAAK,CAAC,YAAY,CAAC;IAChC,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC3F,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;QAC3C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,OAAO,GAAa,UAAU,CAAC;IACnC,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,YAAY,CAAC;IACvD,IAAI,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;IACnD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;IAC5D,MAAM,KAAK,GAAG,UAAU,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,cAAc,aAAa,CAAC;IAC9E,+FAA+F;IAC/F,mFAAmF;IACnF,oGAAoG;IACpG,0GAA0G;IAC1G,IAAI,QAAQ,GAA+B,MAAM,CAAC,eAAe,CAAC,UAAU,YAAY,SAAS,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,SAAS,IAAI,KAAK,EAAE,EAAE,CAAC,MAAM,EAA8B,EAAE;QACpL,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;YACnB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACvC,IAAI,SAAS,KAAK,YAAY,EAAE,CAAC;YAC/B,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;QAC/B,MAAM,SAAS,GAAG,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QACrE,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;YACrB,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC;QACxF,CAAC;QAED,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;YACtB,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC;YAC7B,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;QAC/B,CAAC;QAED,IAAI,MAAM,CAAC,WAAW,EAAE,EAAE,CAAC;YACzB,OAAO;gBACL,SAAS,EAAE,MAAM,CAAC,aAAa,KAAK,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;aAC7F,CAAC;QACJ,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC,EAAE,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,cAAc,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAE/G,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC3B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACd,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,IAAI,SAAS,KAAK,QAAQ,CAAC,SAAS,EAAE,CAAC;gBACrC,gCAAgC;gBAChC,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACjC,MAAM,KAAK,GAA2D,QAAQ,CAAC,cAAc,IAAI,QAAQ,CAAC,WAAW,CAAC;gBACtH,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,OAAO,SAAS,CAAC;gBACnB,CAAC;gBAED,MAAM,KAAK,GAAW,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;gBAC1E,MAAM,IAAI,GAA2C,KAAK,CAAC,KAAK,CAAC,CAAC;gBAClE,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;oBACvB,OAAO,SAAS,CAAC;gBACnB,CAAC;qBAAM,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;oBACnC,QAAQ,GAAG,EAAE,SAAS,EAAE,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3D,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,SAAS,KAAK,QAAQ,CAAC,WAAW,CAAC,CAAC;oBAC3C,MAAM,CAAC,MAAM,YAAY,mBAAmB,CAAC,CAAC;oBAE9C,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC;oBAC7B,QAAQ,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrD,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,SAAS,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC;oBAClC,OAAO,SAAS,CAAC;gBACnB,CAAC;gBAED,MAAM,IAAI,GAAQ,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBAC5C,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;oBACvB,OAAO,SAAS,CAAC;gBACnB,CAAC;gBAED,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;gBAC3C,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,OAAO,SAAS,CAAC;gBACnB,CAAC;gBAED,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;oBACrB,QAAQ,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC;gBAClF,CAAC;qBAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;oBAC7B,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC;oBAC7B,QAAQ,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;gBAC9B,CAAC;qBAAM,IAAI,MAAM,CAAC,WAAW,EAAE,EAAE,CAAC;oBAChC,QAAQ,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;gBACjC,CAAC;qBAAM,CAAC;oBACN,OAAO,SAAS,CAAC;gBACnB,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,YAAY,GAAG,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACxD,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,iDAAiD;IACjD,IAAI,SAAS,KAAK,QAAQ,CAAC,SAAS,EAAE,CAAC;QACrC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;AAC3D,CAAC;AAED,SAAS,0BAA0B,CAAC,IAAc;IAChD,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;QACzB,QAAQ,IAAI,CAAC,YAAY,EAAE,CAAC;YAC1B,KAAK,YAAY,CAAC,mBAAmB;gBACnC,OAAO,UAAU,CAAC;YACpB,KAAK,YAAY,CAAC,kBAAkB;gBAClC,OAAO,aAAa,CAAC;YACvB;gBACE,OAAO,SAAS,CAAC;QACrB,CAAC;IACH,CAAC;IAED,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACvB,QAAQ,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3B,KAAK,aAAa,CAAC,OAAO;gBACxB,OAAO,SAAS,CAAC;YACnB,KAAK,aAAa,CAAC,MAAM;gBACvB,OAAO,IAAI,CAAC,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC;YACtE,KAAK,aAAa,CAAC,QAAQ;gBACzB,OAAO,UAAU,CAAC;YACpB,KAAK,aAAa,CAAC,MAAM,CAAC;YAC1B,KAAK,aAAa,CAAC,IAAI;gBACrB,OAAO,UAAU,CAAC;YACpB,KAAK,aAAa,CAAC,OAAO,CAAC;YAC3B,KAAK,aAAa,CAAC,OAAO;gBACxB,OAAO,YAAY,CAAC;YACtB,KAAK,aAAa,CAAC,MAAM;gBACvB,OAAO,IAAI,CAAC,gBAAgB,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YACnE,KAAK,aAAa,CAAC,OAAO,CAAC;YAC3B,KAAK,aAAa,CAAC,IAAI;gBACrB,OAAO,QAAQ,CAAC;YAClB;gBACE,OAAO,SAAS,CAAC;QACrB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,aAAiC,EAAE,MAAgB,EAAE,OAAgB;IACvG,OAAO;QACL,aAAa;QACb,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,EAAE,MAAM,CAAC;KACzF,CAAC;AACJ,CAAC;AAED,2FAA2F;AAC3F,MAAM,UAAU,WAAW,CAAC,KAAe,EAAE,OAA4B;IACvE,IAAI,OAAO,CAAC,aAAa,IAAI,OAAO,CAAC,aAAa,KAAK,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;QACpF,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,UAA8B,CAAC;IACnC,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,UAAU,GAAG,gBAAgB,CAAC,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IACvD,CAAC;IAED,UAAU,GAAG,UAAU,IAAI,QAAQ,CAAC,uBAAuB,CAAC;IAC5D,IAAI,UAAU,KAAK,KAAK,CAAC,aAAa,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IACnC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,wHAAwH;AACxH,uDAAuD;AACvD,MAAM,UAAU,YAAY,CAAC,SAAoB,EAAE,OAA4B;IAC7E,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,KAAK,MAAM,EAAE,KAAK,EAAE,IAAI,0BAA0B,CAAC,SAAS,CAAC,EAAE,CAAC;QAC9D,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;YAC1D,EAAE,UAAU,CAAC;QACf,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAS,cAAc,CAAC,GAAY,EAAE,YAAwB,EAAE,QAAgC,EAAE,OAAgB;IAChH,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAC1B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QACxD,IAAI,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,MAAM,OAAO,GAAG,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YAC/D,MAAM,aAAa,GAAG,EAAE,CAAC;YACzB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,aAAa,EAAE,EAAE,CAAC;gBAC3C,IAAI,YAAY,CAAC,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,CAAC;oBAC3C,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC5B,CAAC;YACH,CAAC;YAED,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC7B,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;gBACvC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IACvD,CAAC;AACH,CAAC;AAED,uHAAuH;AACvH,MAAM,UAAU,mBAAmB,CAAC,KAAwB,EAAE,GAAY,EAAE,OAAgB;IAC1F,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,mBAA+B,EAAE,GAAY;IAC3E,cAAc,CAAC,GAAG,EAAE,mBAAmB,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;AAC7D,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\r\nimport { FieldPrimitiveValue, FieldPropertyType, FieldRun, FieldValue, formatFieldValue, QueryBinder, QueryRowFormat, RelationshipProps, TextBlock, traverseTextBlockComponent } from \"@itwin/core-common\";\r\nimport { IModelDb } from \"../../IModelDb\";\r\nimport { assert, expectDefined, Id64String, Logger } from \"@itwin/core-bentley\";\r\nimport { BackendLoggerCategory } from \"../../BackendLoggerCategory\";\r\nimport { isITextAnnotation } from \"../../annotations/ElementDrivesTextAnnotation\";\r\nimport { AnyClass, EntityClass, PrimitiveType, Property, PropertyType, StructArrayProperty } from \"@itwin/ecschema-metadata\";\r\nimport { reshapePropertyValue } from \"../ECSqlInstanceReshaper\";\r\nimport type { EditTxn } from \"../../EditTxn\";\r\ninterface FieldStructValue { [key: string]: any }\r\n\r\n// An intermediate value obtained while evaluating a FieldPropertyPath.\r\ntype FieldValueType = {\r\n  primitive: FieldPrimitiveValue;\r\n  struct?: never;\r\n  primitiveArray?: never;\r\n  structArray?: never;\r\n} | {\r\n  primitive?: never;\r\n  struct: FieldStructValue;\r\n  primitiveArray?: never;\r\n  structArray?: never;\r\n} | {\r\n  primitive?: never;\r\n  struct?: never;\r\n  primitiveArray: FieldPrimitiveValue[];\r\n  structArray?: never;\r\n} | {\r\n  primitive?: never;\r\n  struct?: never;\r\n  primitiveArray?: never;\r\n  structArray: FieldStructValue[];\r\n}\r\n\r\nexport interface UpdateFieldsContext {\r\n  readonly hostElementId: Id64String | undefined;\r\n\r\n  getProperty(field: FieldRun): FieldValue | undefined\r\n}\r\n\r\n// Resolve the raw primitive value of the property that a field points to.\r\nfunction getFieldPropertyValue(field: FieldRun, iModel: IModelDb): FieldValue | undefined {\r\n  const host = field.propertyHost;\r\n  const schemaItem = iModel.schemaContext.getSchemaItemSync(host.schemaName, host.className);\r\n  if (!EntityClass.isEntityClass(schemaItem)) {\r\n    return undefined;\r\n  }\r\n\r\n  let ecClass: AnyClass = schemaItem;\r\n  const { propertyName, accessors } = field.propertyPath;\r\n  let ecProp = ecClass.getPropertySync(propertyName);\r\n  if (!ecProp) {\r\n    return undefined;\r\n  }\r\n\r\n  const isAspect = ecClass.isSync(\"ElementAspect\", \"BisCore\");\r\n  const where = ` WHERE ${isAspect ? \"Element.Id\" : \"ECInstanceId\"}=:elementId`;\r\n  // `propertyName` may itself be a struct/array/point/navigation property, so its value can't be\r\n  // decomposed into scalar sub-columns ahead of time. Query using the non-deprecated\r\n  // UseECSqlPropertyNames format and reshape the value into the legacy UseJsPropertyNames shape using\r\n  // ECSchema metadata (see ECSqlInstanceReshaper for why a naive, non-schema-aware rename isn't safe here).\r\n  let curValue: FieldValueType | undefined = iModel.withQueryReader(`SELECT ${propertyName} FROM ${host.schemaName}.${host.className} ${where}`, (reader): FieldValueType | undefined => {\r\n    if (!reader.step()) {\r\n      return undefined;\r\n    }\r\n\r\n    const rawRootValue = reader.current[0];\r\n    if (undefined === rawRootValue) {\r\n      return undefined;\r\n    }\r\n\r\n    ecProp = expectDefined(ecProp);\r\n    const rootValue = reshapePropertyValue(rawRootValue, ecProp, iModel);\r\n    if (ecProp.isArray()) {\r\n      return ecProp.isStruct() ? { structArray: rootValue } : { primitiveArray: rootValue };\r\n    }\r\n\r\n    if (ecProp.isStruct()) {\r\n      ecClass = ecProp.structClass;\r\n      return { struct: rootValue };\r\n    }\r\n\r\n    if (ecProp.isPrimitive()) {\r\n      return {\r\n        primitive: ecProp.primitiveType === PrimitiveType.DateTime ? new Date(rootValue) : rootValue,\r\n      };\r\n    }\r\n\r\n    return undefined;\r\n  }, new QueryBinder().bindId(\"elementId\", host.elementId), { rowFormat: QueryRowFormat.UseECSqlPropertyNames });\r\n\r\n  if (undefined === curValue) {\r\n    return undefined;\r\n  }\r\n\r\n  if (accessors) {\r\n    for (const accessor of accessors) {\r\n      if (undefined !== curValue.primitive) {\r\n        // Can't index into a primitive.\r\n        return undefined;\r\n      }\r\n\r\n      if (typeof accessor === \"number\") {\r\n        const array: FieldPrimitiveValue[] | FieldStructValue[] | undefined = curValue.primitiveArray ?? curValue.structArray;\r\n        if (!array) {\r\n          return undefined;\r\n        }\r\n\r\n        const index: number = accessor < 0 ? (array.length + accessor) : accessor;\r\n        const item: FieldPrimitiveValue | FieldStructValue = array[index];\r\n        if (undefined === item) {\r\n          return undefined;\r\n        } else if (curValue.primitiveArray) {\r\n          curValue = { primitive: curValue.primitiveArray[index] };\r\n        } else {\r\n          assert(undefined !== curValue.structArray);\r\n          assert(ecProp instanceof StructArrayProperty);\r\n\r\n          ecClass = ecProp.structClass;\r\n          curValue = { struct: curValue.structArray[index] };\r\n        }\r\n      } else {\r\n        if (undefined === curValue.struct) {\r\n          return undefined;\r\n        }\r\n\r\n        const item: any = curValue.struct[accessor];\r\n        if (undefined === item) {\r\n          return undefined;\r\n        }\r\n\r\n        ecProp = ecClass.getPropertySync(accessor);\r\n        if (!ecProp) {\r\n          return undefined;\r\n        }\r\n\r\n        if (ecProp.isArray()) {\r\n          curValue = ecProp.isStruct() ? { structArray: item } : { primitiveArray: item };\r\n        } else if (ecProp.isStruct()) {\r\n          ecClass = ecProp.structClass;\r\n          curValue = { struct: item };\r\n        } else if (ecProp.isPrimitive()) {\r\n          curValue = { primitive: item };\r\n        } else {\r\n          return undefined;\r\n        }\r\n      }\r\n    }\r\n  }\r\n\r\n  const propertyType = determineFieldPropertyType(ecProp);\r\n  if (!propertyType) {\r\n    return undefined;\r\n  }\r\n\r\n  // The ultimate result must be a primitive value.\r\n  if (undefined === curValue.primitive) {\r\n    return undefined;\r\n  }\r\n\r\n  return { value: curValue.primitive, type: propertyType };\r\n}\r\n\r\nfunction determineFieldPropertyType(prop: Property): FieldPropertyType | undefined {\r\n  if (prop.isEnumeration()) {\r\n    switch (prop.propertyType) {\r\n      case PropertyType.Integer_Enumeration:\r\n        return \"int-enum\";\r\n      case PropertyType.String_Enumeration:\r\n        return \"string-enum\";\r\n      default:\r\n        return undefined;\r\n    }\r\n  }\r\n\r\n  if (prop.isPrimitive()) {\r\n    switch (prop.primitiveType) {\r\n      case PrimitiveType.Boolean:\r\n        return \"boolean\";\r\n      case PrimitiveType.String:\r\n        return prop.extendedTypeName === \"DateTime\" ? \"datetime\" : \"string\";\r\n      case PrimitiveType.DateTime:\r\n        return \"datetime\";\r\n      case PrimitiveType.Double:\r\n      case PrimitiveType.Long:\r\n        return \"quantity\";\r\n      case PrimitiveType.Point2d:\r\n      case PrimitiveType.Point3d:\r\n        return \"coordinate\";\r\n      case PrimitiveType.Binary:\r\n        return prop.extendedTypeName === \"BeGuid\" ? \"string\" : undefined;\r\n      case PrimitiveType.Integer:\r\n      case PrimitiveType.Long:\r\n        return \"string\";\r\n      default:\r\n        return undefined;\r\n    }\r\n  }\r\n\r\n  return undefined;\r\n}\r\n\r\nexport function createUpdateContext(hostElementId: string | undefined, iModel: IModelDb, deleted: boolean): UpdateFieldsContext {\r\n  return {\r\n    hostElementId,\r\n    getProperty: deleted ? () => undefined : (field) => getFieldPropertyValue(field, iModel),\r\n  };\r\n}\r\n\r\n// Recompute the display value of a single field, return false if it couldn't be evaluated.\r\nexport function updateField(field: FieldRun, context: UpdateFieldsContext): boolean {\r\n  if (context.hostElementId && context.hostElementId !== field.propertyHost.elementId) {\r\n    return false;\r\n  }\r\n\r\n  let newContent: string | undefined;\r\n  try {\r\n    const propValue = context.getProperty(field);\r\n    if (undefined !== propValue) {\r\n      newContent = formatFieldValue(propValue, field.formatOptions);\r\n    }\r\n  } catch (err) {\r\n    Logger.logError(BackendLoggerCategory.IModelDb, err);\r\n  }\r\n\r\n  newContent = newContent ?? FieldRun.invalidContentIndicator;\r\n  if (newContent === field.cachedContent) {\r\n    return false;\r\n  }\r\n\r\n  field.setCachedContent(newContent);\r\n  return true;\r\n}\r\n\r\n// Re-evaluates the display strings for all fields that target the element specified by `context` and returns the number\r\n// of fields whose display strings changed as a result.\r\nexport function updateFields(textBlock: TextBlock, context: UpdateFieldsContext): number {\r\n  let numUpdated = 0;\r\n  for (const { child } of traverseTextBlockComponent(textBlock)) {\r\n    if (child.type === \"field\" && updateField(child, context)) {\r\n      ++numUpdated;\r\n    }\r\n  }\r\n\r\n  return numUpdated;\r\n}\r\n\r\nfunction doUpdateFields(txn: EditTxn, annotationId: Id64String, sourceId: Id64String | undefined, deleted: boolean): void {\r\n  const iModel = txn.iModel;\r\n  try {\r\n    const target = iModel.elements.getElement(annotationId);\r\n    if (isITextAnnotation(target)) {\r\n      const context = createUpdateContext(sourceId, iModel, deleted);\r\n      const updatedBlocks = [];\r\n      for (const block of target.getTextBlocks()) {\r\n        if (updateFields(block.textBlock, context)) {\r\n          updatedBlocks.push(block);\r\n        }\r\n      }\r\n\r\n      if (updatedBlocks.length > 0) {\r\n        target.updateTextBlocks(updatedBlocks);\r\n        target.update(txn);\r\n      }\r\n    }\r\n  } catch (err) {\r\n    Logger.logError(BackendLoggerCategory.IModelDb, err);\r\n  }\r\n}\r\n\r\n// Invoked by ElementDrivesTextAnnotation to update fields in target element when source element changes or is deleted.\r\nexport function updateElementFields(props: RelationshipProps, txn: EditTxn, deleted: boolean): void {\r\n  doUpdateFields(txn, props.targetId, props.sourceId, deleted);\r\n}\r\n\r\nexport function updateAllFields(annotationElementId: Id64String, txn: EditTxn): void {\r\n  doUpdateFields(txn, annotationElementId, undefined, false);\r\n}\r\n"]}

package/lib/esm/internal/workspace/WorkspaceImpl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WorkspaceImpl.d.ts","sourceRoot":"","sources":["../../../../src/internal/workspace/WorkspaceImpl.ts"],"names":[],"mappings":"AAIA;;GAEG;AAMH,OAAO,EAAoB,iBAAiB,EAA+C,MAAM,oBAAoB,CAAC;AAMtH,OAAO,EAAe,QAAQ,EAAgE,MAAM,0BAA0B,CAAC;AAI/H,OAAO,EACsB,SAAS,EAAE,kBAAkB,EAAE,oBAAoB,EAA2B,WAAW,EAC/F,oBAAoB,EAA0F,gBAAgB,EACtE,aAAa,EAC3F,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAqH,eAAe,EAAwC,MAAM,iCAAiC,CAAC;AAY3N,4CAA4C;AAC5C,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AAkvBpD,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,kBAAkB,GAAG,WAAW,CAExG;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,cAAc,CAE3F;AAED,wBAAgB,wBAAwB,IAAI,eAAe,CAE1D;AAED;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAAC,EAAE,EAAE,oBAAoB,QAGpE;AAED,eAAO,MAAM,yBAAyB,EAAE,iBAAgE,CAAC;AAOzG,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,oBAAoB,EAAE,GAAG,KAAK,CAEvG;AAED,MAAM,WAAW,cAAe,SAAQ,SAAS;IAC/C,kDAAkD;IAClD,KAAK,IAAI,IAAI,CAAC;CACf"}
+{"version":3,"file":"WorkspaceImpl.d.ts","sourceRoot":"","sources":["../../../../src/internal/workspace/WorkspaceImpl.ts"],"names":[],"mappings":"AAIA;;GAEG;AAMH,OAAO,EAAoB,iBAAiB,EAA+C,MAAM,oBAAoB,CAAC;AAMtH,OAAO,EAAe,QAAQ,EAAgE,MAAM,0BAA0B,CAAC;AAI/H,OAAO,EACsB,SAAS,EAAE,kBAAkB,EAAE,oBAAoB,EAA2B,WAAW,EAC/F,oBAAoB,EAA0F,gBAAgB,EACtE,aAAa,EAC3F,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAqH,eAAe,EAAwC,MAAM,iCAAiC,CAAC;AAY3N,4CAA4C;AAC5C,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AAsvBpD,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,kBAAkB,GAAG,WAAW,CAExG;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,cAAc,CAE3F;AAED,wBAAgB,wBAAwB,IAAI,eAAe,CAE1D;AAED;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAAC,EAAE,EAAE,oBAAoB,QAGpE;AAED,eAAO,MAAM,yBAAyB,EAAE,iBAAgE,CAAC;AAOzG,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,oBAAoB,EAAE,GAAG,KAAK,CAEvG;AAED,MAAM,WAAW,cAAe,SAAQ,SAAS;IAC/C,kDAAkD;IAClD,KAAK,IAAI,IAAI,CAAC;CACf"}

package/lib/esm/internal/workspace/WorkspaceImpl.js

@@ -312,8 +312,13 @@ class WorkspaceImpl {
     async getWorkspaceDb(props) {
         let container = this.findContainer(props.containerId);
         if (undefined === container) {
-            const accessToken = (props.baseUri === "" || props.isPublic) ? "" : await CloudSqlite.requestToken({ accessLevel: "read", ...props });
-            container = new WorkspaceContainerImpl(this, { ...props, accessToken });
+            if (props.accessToken) {
+                container = new WorkspaceContainerImpl(this, { ...props, accessToken: props.accessToken });
+            }
+            else {
+                const accessToken = (props.baseUri === "" || props.isPublic) ? "" : await CloudSqlite.requestToken({ ...props, accessLevel: "read" });
+                container = new WorkspaceContainerImpl(this, { ...props, accessToken });
+            }
         }
         return container.getWorkspaceDb(props);
     }