@itwin/core-backend 5.14.0-dev.8 → 5.15.0-dev.1

package/lib/cjs/internal/IntegrityCheck.js.map

@@ -1 +1 @@
-{"version":3,"file":"IntegrityCheck.js","sourceRoot":"","sources":["../../../src/internal/IntegrityCheck.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AA6P/F,sDAcC;AAQD,gEAOC;AAsBD,sEAkFC;AAhYD,sDAA+D;AAC/D,oDAAiD;AAGjD;;;GAGG;AACU,QAAA,qBAAqB,GAAG;IACnC,gBAAgB,EAAE;QAChB,IAAI,EAAE,oBAAoB;QAC1B,UAAU,EAAE,2BAA2B;QACvC,UAAU,EAAE,oBAAoB;QAChC,QAAQ,EAAE,sFAAsF;KACjG;IACD,cAAc,EAAE;QACd,IAAI,EAAE,kBAAkB;QACxB,UAAU,EAAE,yBAAyB;QACrC,UAAU,EAAE,kBAAkB;QAC9B,QAAQ,EAAE,oFAAoF;KAC/F;IACD,uBAAuB,EAAE;QACvB,IAAI,EAAE,4BAA4B;QAClC,UAAU,EAAE,2BAA2B;QACvC,UAAU,EAAE,qBAAqB;QACjC,QAAQ,EAAE,uFAAuF;KAClG;IACD,kBAAkB,EAAE;QAClB,IAAI,EAAE,sBAAsB;QAC5B,UAAU,EAAE,sBAAsB;QAClC,UAAU,EAAE,eAAe;QAC3B,QAAQ,EAAE,iFAAiF;KAC5F;IACD,gCAAgC,EAAE;QAChC,IAAI,EAAE,wCAAwC;QAC9C,UAAU,EAAE,mCAAmC;QAC/C,UAAU,EAAE,8BAA8B;QAC1C,QAAQ,EAAE,gGAAgG;KAC3G;IACD,2BAA2B,EAAE;QAC3B,IAAI,EAAE,kCAAkC;QACxC,UAAU,EAAE,8BAA8B;QAC1C,UAAU,EAAE,wBAAwB;QACpC,QAAQ,EAAE,0FAA0F;KACrG;IACD,aAAa,EAAE;QACb,IAAI,EAAE,iBAAiB;QACvB,UAAU,EAAE,wBAAwB;QACpC,UAAU,EAAE,iBAAiB;QAC7B,QAAQ,EAAE,mFAAmF;KAC9F;IACD,eAAe,EAAE;QACf,IAAI,EAAE,mBAAmB;QACzB,UAAU,EAAE,0BAA0B;QACtC,UAAU,EAAE,mBAAmB;QAC/B,QAAQ,EAAE,qFAAqF;KAChG;IACD,eAAe,EAAE;QACf,IAAI,EAAE,mBAAmB;QACzB,UAAU,EAAE,0BAA0B;QACtC,UAAU,EAAE,mBAAmB;QAC/B,QAAQ,EAAE,qFAAqF;KAChG;IACD,qBAAqB,EAAE;QACrB,IAAI,EAAE,0BAA0B;QAChC,UAAU,EAAE,gCAAgC;QAC5C,UAAU,EAAE,0BAA0B;QACtC,QAAQ,EAAE,4FAA4F;KACvG;IACD,qBAAqB,EAAE;QACrB,IAAI,EAAE,8BAA8B;QACpC,UAAU,EAAE,gCAAgC;QAC5C,UAAU,EAAE,0BAA0B;QACtC,QAAQ,EAAE,4FAA4F;KACvG;CACO,CAAC;AAwKX;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CAAC,KAAa;IACjD,iCAAiC;IACjC,MAAM,YAAY,GAAG,6BAAqB,CAAC,KAA0B,CAAC,CAAC;IACvE,IAAI,YAAY,EAAE,CAAC;QACjB,OAAO,YAAY,CAAC,IAAI,CAAC;IAC3B,CAAC;IACD,qCAAqC;IACrC,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,6BAAqB,CAAC,EAAE,CAAC;QAC9D,IAAI,KAAK,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;YAC/B,OAAO,KAAK,CAAC,IAAI,CAAC;QACpB,CAAC;IACH,CAAC;IACD,wCAAwC;IACxC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,0BAA0B,CAAC,MAAgB;IAC/D,MAAM,mBAAmB,GAAG,kEAAkE,CAAC;IAC/F,MAAM,qBAAqB,GAAmC,EAAE,CAAC;IACjE,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,mBAAmB,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QAC3G,qBAAqB,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,qBAAqB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;IAC/H,CAAC;IAAA,CAAC;IACF,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAsBM,KAAK,UAAU,6BAA6B,CAAC,MAAgB,EAAE,KAAwB;IAC5F,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,kBAAkB,CAAC,CAAC,CAAC;YACxB,MAAM,OAAO,GAAgC,EAAE,CAAC;YAChD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBACvI,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACvE,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;YACtB,MAAM,OAAO,GAA8B,EAAE,CAAC;YAC9C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,cAAc,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBACrI,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;YACnF,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,yBAAyB,CAAC,CAAC,CAAC;YAC/B,MAAM,OAAO,GAAgC,EAAE,CAAC;YAChD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,uBAAuB,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBAC9I,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;YACvI,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,oBAAoB,CAAC,CAAC,CAAC;YAC1B,MAAM,OAAO,GAA2B,EAAE,CAAC;YAC3C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,kBAAkB,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBACzI,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;YAC3I,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,kCAAkC,CAAC,CAAC,CAAC;YACxC,MAAM,OAAO,GAAwC,EAAE,CAAC;YACxD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,gCAAgC,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBACvJ,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,YAAY,EAAE,GAAG,CAAC,YAAY,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;YACrJ,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,6BAA6B,CAAC,CAAC,CAAC;YACnC,MAAM,OAAO,GAAmC,EAAE,CAAC;YACnD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,2BAA2B,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBAClJ,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,YAAY,EAAE,GAAG,CAAC,YAAY,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;YACzJ,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,eAAe,CAAC,CAAC,CAAC;YACrB,MAAM,OAAO,GAA6B,EAAE,CAAC;YAC7C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,aAAa,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBACpI,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;YACtG,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,iBAAiB,CAAC,CAAC,CAAC;YACvB,MAAM,OAAO,GAA+B,EAAE,CAAC;YAC/C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,eAAe,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBACtI,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;YACjE,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,iBAAiB,CAAC,CAAC,CAAC;YACvB,MAAM,OAAO,GAA+B,EAAE,CAAC;YAC/C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,eAAe,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBACtI,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACrD,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,uBAAuB,CAAC,CAAC,CAAC;YAC7B,MAAM,OAAO,GAAqC,EAAE,CAAC;YACrD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,qBAAqB,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBAC5I,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,QAAQ,EAAE,kBAAkB,EAAE,GAAG,CAAC,kBAAkB,EAAE,CAAC,CAAC;YAClI,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,uBAAuB,CAAC,CAAC,CAAC;YAC7B,MAAM,OAAO,GAAqC,EAAE,CAAC;YACrD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,qBAAqB,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBAC5I,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,CAAC,cAAc,EAAE,gBAAgB,EAAE,GAAG,CAAC,gBAAgB,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,aAAa,EAAE,GAAG,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,CAAC,YAAY,EAAE,UAAU,EAAE,GAAG,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC;YAC7Q,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD;YACE,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,8BAA8B,CAAC,CAAC;IACnF,CAAC;AACH,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 { Id64String, IModelStatus } from \"@itwin/core-bentley\";\r\nimport { IModelError } from \"@itwin/core-common\";\r\nimport { IModelDb } from \"../IModelDb\";\r\n\r\n/**\r\n * Information about each integrity check type, including the name, expected result type, and SQL query to execute\r\n * @internal\r\n */\r\nexport const integrityCheckTypeMap = {\r\n  checkDataColumns: {\r\n    name: \"Check Data Columns\",\r\n    resultType: \"CheckDataColumnsResultRow\",\r\n    sqlCommand: \"check_data_columns\",\r\n    sqlQuery: `PRAGMA integrity_check(check_data_columns) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkECProfile: {\r\n    name: \"Check EC Profile\",\r\n    resultType: \"CheckECProfileResultRow\",\r\n    sqlCommand: \"check_ec_profile\",\r\n    sqlQuery: `PRAGMA integrity_check(check_ec_profile) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkNavigationClassIds: {\r\n    name: \"Check Navigation Class Ids\",\r\n    resultType: \"CheckNavClassIdsResultRow\",\r\n    sqlCommand: \"check_nav_class_ids\",\r\n    sqlQuery: `PRAGMA integrity_check(check_nav_class_ids) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkNavigationIds: {\r\n    name: \"Check Navigation Ids\",\r\n    resultType: \"CheckNavIdsResultRow\",\r\n    sqlCommand: \"check_nav_ids\",\r\n    sqlQuery: `PRAGMA integrity_check(check_nav_ids) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkLinktableForeignKeyClassIds: {\r\n    name: \"Check Link Table Foreign Key Class Ids\",\r\n    resultType: \"CheckLinkTableFkClassIdsResultRow\",\r\n    sqlCommand: \"check_linktable_fk_class_ids\",\r\n    sqlQuery: `PRAGMA integrity_check(check_linktable_fk_class_ids) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkLinktableForeignKeyIds: {\r\n    name: \"Check Link Table Foreign Key Ids\",\r\n    resultType: \"CheckLinkTableFkIdsResultRow\",\r\n    sqlCommand: \"check_linktable_fk_ids\",\r\n    sqlQuery: `PRAGMA integrity_check(check_linktable_fk_ids) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkClassIds: {\r\n    name: \"Check Class Ids\",\r\n    resultType: \"CheckClassIdsResultRow\",\r\n    sqlCommand: \"check_class_ids\",\r\n    sqlQuery: `PRAGMA integrity_check(check_class_ids) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkDataSchema: {\r\n    name: \"Check Data Schema\",\r\n    resultType: \"CheckDataSchemaResultRow\",\r\n    sqlCommand: \"check_data_schema\",\r\n    sqlQuery: `PRAGMA integrity_check(check_data_schema) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkSchemaLoad: {\r\n    name: \"Check Schema Load\",\r\n    resultType: \"CheckSchemaLoadResultRow\",\r\n    sqlCommand: \"check_schema_load\",\r\n    sqlQuery: `PRAGMA integrity_check(check_schema_load) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkMissingChildRows: {\r\n    name: \"Check Missing Child Rows\",\r\n    resultType: \"CheckMissingChildRowsResultRow\",\r\n    sqlCommand: \"check_missing_child_rows\",\r\n    sqlQuery: `PRAGMA integrity_check(check_missing_child_rows) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkDivergedPropMaps: {\r\n    name: \"Check Diverged Property Maps\",\r\n    resultType: \"CheckDivergedPropMapsResultRow\",\r\n    sqlCommand: \"check_diverged_prop_maps\",\r\n    sqlQuery: `PRAGMA integrity_check(check_diverged_prop_maps) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n} as const;\r\n\r\n/**\r\n * Type representing the keys of the integrityCheckType map, which correspond to the different types of integrity checks that can be performed.\r\n */\r\nexport type IntegrityCheckKey = keyof typeof integrityCheckTypeMap;\r\n\r\n/** Map of integrity check keys to their result row types */\r\ninterface IntegrityCheckResultTypeMap {\r\n  checkDataColumns: CheckDataColumnsResultRow;\r\n  checkECProfile: CheckECProfileResultRow;\r\n  checkNavigationClassIds: CheckNavClassIdsResultRow;\r\n  checkNavigationIds: CheckNavIdsResultRow;\r\n  checkLinktableForeignKeyClassIds: CheckLinkTableFkClassIdsResultRow;\r\n  checkLinktableForeignKeyIds: CheckLinkTableFkIdsResultRow;\r\n  checkClassIds: CheckClassIdsResultRow;\r\n  checkDataSchema: CheckDataSchemaResultRow;\r\n  checkSchemaLoad: CheckSchemaLoadResultRow;\r\n  checkMissingChildRows: CheckMissingChildRowsResultRow;\r\n  checkDivergedPropMaps: CheckDivergedPropMapsResultRow;\r\n}\r\n\r\n/** Checks the Map to give the return type of a specific integrity check */\r\ntype IntegrityCheckResultRow<K extends IntegrityCheckKey> = IntegrityCheckResultTypeMap[K];\r\n\r\n/**\r\n * Return type for quick integrity check\r\n */\r\nexport interface QuickIntegrityCheckResultRow {\r\n  check: string;\r\n  passed: boolean;\r\n  elapsedSeconds: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Data Columns integrity check\r\n */\r\nexport interface CheckDataColumnsResultRow {\r\n  sno: number;\r\n  table: string;\r\n  column: string;\r\n}\r\n\r\n/**\r\n * Return type for Check EC Profile integrity check\r\n */\r\nexport interface CheckECProfileResultRow {\r\n  sno: number;\r\n  type: string;\r\n  name: string;\r\n  issue: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Navigation Class Ids integrity check\r\n */\r\nexport interface CheckNavClassIdsResultRow {\r\n  sno: number;\r\n  id: string;\r\n  class: string;\r\n  property: string;\r\n  navId: string;\r\n  navClassId: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Navigation Ids integrity check\r\n */\r\nexport interface CheckNavIdsResultRow {\r\n  sno: number;\r\n  id: string;\r\n  class: string;\r\n  property: string;\r\n  navId: string;\r\n  primaryClass: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Link Table Foreign Key Class Ids integrity check\r\n */\r\nexport interface CheckLinkTableFkClassIdsResultRow {\r\n  sno: number;\r\n  id: string;\r\n  relationship: string;\r\n  property: string;\r\n  keyId: string;\r\n  keyClassId: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Link Table Foreign Key Ids integrity check\r\n */\r\nexport interface CheckLinkTableFkIdsResultRow {\r\n  sno: number;\r\n  id: string;\r\n  relationship: string;\r\n  property: string;\r\n  keyId: string;\r\n  primaryClass: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Class Ids integrity check\r\n */\r\nexport interface CheckClassIdsResultRow {\r\n  sno: number;\r\n  class: string;\r\n  id: string;\r\n  classId: string;\r\n  type: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Data Schema integrity check\r\n */\r\nexport interface CheckDataSchemaResultRow {\r\n  sno: number;\r\n  type: string;\r\n  name: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Schema Load integrity check\r\n */\r\nexport interface CheckSchemaLoadResultRow {\r\n  sno: number;\r\n  schema: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Missing Child Rows integrity check\r\n */\r\nexport interface CheckMissingChildRowsResultRow {\r\n  sno: number;\r\n  class: string;\r\n  id: string;\r\n  classId: string;\r\n  missingRowInTables: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Diverged Property Maps integrity check\r\n */\r\nexport interface CheckDivergedPropMapsResultRow {\r\n  sno: number;\r\n  derivedClassId: Id64String;\r\n  derivedClassName: string;\r\n  baseClassId: Id64String;\r\n  baseClassName: string;\r\n  propertyName: string;\r\n  baseColumn: string;\r\n  divergedColumn: string;\r\n}\r\n\r\n/**\r\n * Return type for integrity check results, including the check name, whether it passed, and the specific results (if any)\r\n */\r\nexport interface IntegrityCheckResult {\r\n  /** The name of the integrity check that was performed */\r\n  check: string;\r\n  /** Whether the integrity check passed (i.e. no issues were found = true) */\r\n  passed: boolean;\r\n  /** The specific results returned by the integrity check, which may include details about any issues that were found.\r\n   * In the case where issues are found, this will be an array of result rows specific to the type of check that was performed,\r\n   * or an array of quick integrity check results if it was a quick check. */\r\n  results: IntegrityCheckResultRow<IntegrityCheckKey>[] | QuickIntegrityCheckResultRow[];\r\n}\r\n\r\n/**\r\n * Gets the user-friendly name of an integrity check based on its key or SQL command.\r\n * It first attempts to find a direct match for the key in the integrityCheckTypeMap. If not found, it searches for a match based on the SQL command.\r\n * If still not found, it returns the original check string.\r\n * @param check - The integrity check key or SQL command to get the name of\r\n * @returns The user-friendly name of the integrity check, or the original check string if no match is found\r\n * @internal\r\n */\r\nexport function getIntegrityCheckName(check: string): string {\r\n  // First try direct lookup by key\r\n  const directLookup = integrityCheckTypeMap[check as IntegrityCheckKey];\r\n  if (directLookup) {\r\n    return directLookup.name;\r\n  }\r\n  // If not found, search by sqlCommand\r\n  for (const [, value] of Object.entries(integrityCheckTypeMap)) {\r\n    if (value.sqlCommand === check) {\r\n      return value.name;\r\n    }\r\n  }\r\n  // Fallback to the original check string\r\n  return check;\r\n}\r\n\r\n/**\r\n * Performs a quick integrity check on the given iModel.\r\n * @param iModel The IModelDb instance to perform the integrity check on\r\n * @returns An array of results for each check performed, including the check name, whether it passed, and the elapsed time in seconds\r\n * @internal\r\n */\r\nexport async function performQuickIntegrityCheck(iModel: IModelDb): Promise<QuickIntegrityCheckResultRow[]> {\r\n  const integrityCheckQuery = \"PRAGMA integrity_check ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES\";\r\n  const integrityCheckResults: QuickIntegrityCheckResultRow[] = [];\r\n  for await (const row of iModel.createQueryReader(integrityCheckQuery, undefined, { usePrimaryConn: true })) {\r\n    integrityCheckResults.push({ check: getIntegrityCheckName(row.check), passed: row.result, elapsedSeconds: row.elapsed_sec });\r\n  };\r\n  return integrityCheckResults;\r\n}\r\n\r\n/**\r\n * Performs a specific integrity check on the given iModel based on the provided check key, and returns the results specific to that check type.\r\n * @param iModel The IModelDb instance to perform the integrity check on\r\n * @param check The key of the specific integrity check to perform\r\n * @return An array of results specific to the integrity check that was performed. The type of the result rows will depend on the check that was executed.\r\n * @throws IModelError with status BadRequest if an unknown integrity check key is provided\r\n * @internal\r\n */\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkDataColumns\"): Promise<IntegrityCheckResultRow<\"checkDataColumns\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkECProfile\"): Promise<IntegrityCheckResultRow<\"checkECProfile\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkNavigationClassIds\"): Promise<IntegrityCheckResultRow<\"checkNavigationClassIds\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkNavigationIds\"): Promise<IntegrityCheckResultRow<\"checkNavigationIds\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkLinktableForeignKeyClassIds\"): Promise<IntegrityCheckResultRow<\"checkLinktableForeignKeyClassIds\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkLinktableForeignKeyIds\"): Promise<IntegrityCheckResultRow<\"checkLinktableForeignKeyIds\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkClassIds\"): Promise<IntegrityCheckResultRow<\"checkClassIds\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkDataSchema\"): Promise<IntegrityCheckResultRow<\"checkDataSchema\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkSchemaLoad\"): Promise<IntegrityCheckResultRow<\"checkSchemaLoad\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkMissingChildRows\"): Promise<IntegrityCheckResultRow<\"checkMissingChildRows\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkDivergedPropMaps\"): Promise<IntegrityCheckResultRow<\"checkDivergedPropMaps\">[]>;\r\nexport async function performSpecificIntegrityCheck<K extends IntegrityCheckKey>(iModel: IModelDb, check: K): Promise<IntegrityCheckResultRow<K>[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: IntegrityCheckKey): Promise<IntegrityCheckResultRow<IntegrityCheckKey>[]> {\r\n  switch (check) {\r\n    case \"checkDataColumns\": {\r\n      const results: CheckDataColumnsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkDataColumns.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, table: row.table, column: row.column });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkECProfile\": {\r\n      const results: CheckECProfileResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkECProfile.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, type: row.type, name: row.name, issue: row.issue });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkNavigationClassIds\": {\r\n      const results: CheckNavClassIdsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkNavigationClassIds.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, id: row.id, class: row.class, property: row.property, navId: row.nav_id, navClassId: row.nav_classId });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkNavigationIds\": {\r\n      const results: CheckNavIdsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkNavigationIds.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, id: row.id, class: row.class, property: row.property, navId: row.nav_id, primaryClass: row.primary_class });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkLinktableForeignKeyClassIds\": {\r\n      const results: CheckLinkTableFkClassIdsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkLinktableForeignKeyClassIds.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, id: row.id, relationship: row.relationship, property: row.property, keyId: row.key_id, keyClassId: row.key_classId });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkLinktableForeignKeyIds\": {\r\n      const results: CheckLinkTableFkIdsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkLinktableForeignKeyIds.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, id: row.id, relationship: row.relationship, property: row.property, keyId: row.key_id, primaryClass: row.primary_class });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkClassIds\": {\r\n      const results: CheckClassIdsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkClassIds.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, class: row.class, id: row.id, classId: row.class_id, type: row.type });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkDataSchema\": {\r\n      const results: CheckDataSchemaResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkDataSchema.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, type: row.type, name: row.name });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkSchemaLoad\": {\r\n      const results: CheckSchemaLoadResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkSchemaLoad.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, schema: row.schema });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkMissingChildRows\": {\r\n      const results: CheckMissingChildRowsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkMissingChildRows.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, class: row.class, id: row.id, classId: row.class_id, missingRowInTables: row.MissingRowInTables });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkDivergedPropMaps\": {\r\n      const results: CheckDivergedPropMapsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkDivergedPropMaps.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, derivedClassId: row.derivedClassId, derivedClassName: row.derivedClassName, baseClassId: row.baseClassId, baseClassName: row.baseClassName, propertyName: row.propertyName, baseColumn: row.baseColumn, divergedColumn: row.divergedColumn });\r\n      }\r\n      return results;\r\n    }\r\n    default:\r\n      throw new IModelError(IModelStatus.BadRequest, `Unknown integrity check type`);\r\n  }\r\n}"]}
+{"version":3,"file":"IntegrityCheck.js","sourceRoot":"","sources":["../../../src/internal/IntegrityCheck.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAsT/F,sDAcC;AAQD,gEAOC;AAsBD,sEAkFC;AAzbD,sDAA+D;AAC/D,oDAAiD;AAGjD;;;GAGG;AACU,QAAA,qBAAqB,GAAG;IACnC,gBAAgB,EAAE;QAChB,IAAI,EAAE,oBAAoB;QAC1B,UAAU,EAAE,2BAA2B;QACvC,UAAU,EAAE,oBAAoB;QAChC,QAAQ,EAAE,sFAAsF;KACjG;IACD,cAAc,EAAE;QACd,IAAI,EAAE,kBAAkB;QACxB,UAAU,EAAE,yBAAyB;QACrC,UAAU,EAAE,kBAAkB;QAC9B,QAAQ,EAAE,oFAAoF;KAC/F;IACD,uBAAuB,EAAE;QACvB,IAAI,EAAE,4BAA4B;QAClC,UAAU,EAAE,2BAA2B;QACvC,UAAU,EAAE,qBAAqB;QACjC,QAAQ,EAAE,uFAAuF;KAClG;IACD,kBAAkB,EAAE;QAClB,IAAI,EAAE,sBAAsB;QAC5B,UAAU,EAAE,sBAAsB;QAClC,UAAU,EAAE,eAAe;QAC3B,QAAQ,EAAE,iFAAiF;KAC5F;IACD,gCAAgC,EAAE;QAChC,IAAI,EAAE,wCAAwC;QAC9C,UAAU,EAAE,mCAAmC;QAC/C,UAAU,EAAE,8BAA8B;QAC1C,QAAQ,EAAE,gGAAgG;KAC3G;IACD,2BAA2B,EAAE;QAC3B,IAAI,EAAE,kCAAkC;QACxC,UAAU,EAAE,8BAA8B;QAC1C,UAAU,EAAE,wBAAwB;QACpC,QAAQ,EAAE,0FAA0F;KACrG;IACD,aAAa,EAAE;QACb,IAAI,EAAE,iBAAiB;QACvB,UAAU,EAAE,wBAAwB;QACpC,UAAU,EAAE,iBAAiB;QAC7B,QAAQ,EAAE,mFAAmF;KAC9F;IACD,eAAe,EAAE;QACf,IAAI,EAAE,mBAAmB;QACzB,UAAU,EAAE,0BAA0B;QACtC,UAAU,EAAE,mBAAmB;QAC/B,QAAQ,EAAE,qFAAqF;KAChG;IACD,eAAe,EAAE;QACf,IAAI,EAAE,mBAAmB;QACzB,UAAU,EAAE,0BAA0B;QACtC,UAAU,EAAE,mBAAmB;QAC/B,QAAQ,EAAE,qFAAqF;KAChG;IACD,qBAAqB,EAAE;QACrB,IAAI,EAAE,0BAA0B;QAChC,UAAU,EAAE,gCAAgC;QAC5C,UAAU,EAAE,0BAA0B;QACtC,QAAQ,EAAE,4FAA4F;KACvG;IACD,qBAAqB,EAAE;QACrB,IAAI,EAAE,8BAA8B;QACpC,UAAU,EAAE,gCAAgC;QAC5C,UAAU,EAAE,0BAA0B;QACtC,QAAQ,EAAE,4FAA4F;KACvG;CACO,CAAC;AAiOX;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CAAC,KAAa;IACjD,iCAAiC;IACjC,MAAM,YAAY,GAAG,6BAAqB,CAAC,KAA0B,CAAC,CAAC;IACvE,IAAI,YAAY,EAAE,CAAC;QACjB,OAAO,YAAY,CAAC,IAAI,CAAC;IAC3B,CAAC;IACD,qCAAqC;IACrC,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,6BAAqB,CAAC,EAAE,CAAC;QAC9D,IAAI,KAAK,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;YAC/B,OAAO,KAAK,CAAC,IAAI,CAAC;QACpB,CAAC;IACH,CAAC;IACD,wCAAwC;IACxC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,0BAA0B,CAAC,MAAgB;IAC/D,MAAM,mBAAmB,GAAG,kEAAkE,CAAC;IAC/F,MAAM,qBAAqB,GAAmC,EAAE,CAAC;IACjE,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,mBAAmB,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QAC3G,qBAAqB,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,qBAAqB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;IAC/H,CAAC;IAAA,CAAC;IACF,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAsBM,KAAK,UAAU,6BAA6B,CAAC,MAAgB,EAAE,KAAwB;IAC5F,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,kBAAkB,CAAC,CAAC,CAAC;YACxB,MAAM,OAAO,GAAgC,EAAE,CAAC;YAChD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBACvI,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACvE,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;YACtB,MAAM,OAAO,GAA8B,EAAE,CAAC;YAC9C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,cAAc,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBACrI,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;YACnF,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,yBAAyB,CAAC,CAAC,CAAC;YAC/B,MAAM,OAAO,GAAgC,EAAE,CAAC;YAChD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,uBAAuB,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBAC9I,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;YACvI,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,oBAAoB,CAAC,CAAC,CAAC;YAC1B,MAAM,OAAO,GAA2B,EAAE,CAAC;YAC3C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,kBAAkB,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBACzI,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;YAC3I,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,kCAAkC,CAAC,CAAC,CAAC;YACxC,MAAM,OAAO,GAAwC,EAAE,CAAC;YACxD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,gCAAgC,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBACvJ,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,YAAY,EAAE,GAAG,CAAC,YAAY,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;YACrJ,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,6BAA6B,CAAC,CAAC,CAAC;YACnC,MAAM,OAAO,GAAmC,EAAE,CAAC;YACnD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,2BAA2B,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBAClJ,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,YAAY,EAAE,GAAG,CAAC,YAAY,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;YACzJ,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,eAAe,CAAC,CAAC,CAAC;YACrB,MAAM,OAAO,GAA6B,EAAE,CAAC;YAC7C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,aAAa,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBACpI,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;YACtG,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,iBAAiB,CAAC,CAAC,CAAC;YACvB,MAAM,OAAO,GAA+B,EAAE,CAAC;YAC/C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,eAAe,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBACtI,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;YACjE,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,iBAAiB,CAAC,CAAC,CAAC;YACvB,MAAM,OAAO,GAA+B,EAAE,CAAC;YAC/C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,eAAe,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBACtI,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACrD,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,uBAAuB,CAAC,CAAC,CAAC;YAC7B,MAAM,OAAO,GAAqC,EAAE,CAAC;YACrD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,qBAAqB,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBAC5I,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,QAAQ,EAAE,kBAAkB,EAAE,GAAG,CAAC,kBAAkB,EAAE,CAAC,CAAC;YAClI,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,uBAAuB,CAAC,CAAC,CAAC;YAC7B,MAAM,OAAO,GAAqC,EAAE,CAAC;YACrD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,qBAAqB,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBAC5I,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,CAAC,cAAc,EAAE,gBAAgB,EAAE,GAAG,CAAC,gBAAgB,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,aAAa,EAAE,GAAG,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,CAAC,YAAY,EAAE,UAAU,EAAE,GAAG,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC;YAC7Q,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD;YACE,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,8BAA8B,CAAC,CAAC;IACnF,CAAC;AACH,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 { Id64String, IModelStatus } from \"@itwin/core-bentley\";\r\nimport { IModelError } from \"@itwin/core-common\";\r\nimport { IModelDb } from \"../IModelDb\";\r\n\r\n/**\r\n * Information about each integrity check type, including the name, expected result type, and SQL query to execute\r\n * @internal\r\n */\r\nexport const integrityCheckTypeMap = {\r\n  checkDataColumns: {\r\n    name: \"Check Data Columns\",\r\n    resultType: \"CheckDataColumnsResultRow\",\r\n    sqlCommand: \"check_data_columns\",\r\n    sqlQuery: `PRAGMA integrity_check(check_data_columns) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkECProfile: {\r\n    name: \"Check EC Profile\",\r\n    resultType: \"CheckECProfileResultRow\",\r\n    sqlCommand: \"check_ec_profile\",\r\n    sqlQuery: `PRAGMA integrity_check(check_ec_profile) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkNavigationClassIds: {\r\n    name: \"Check Navigation Class Ids\",\r\n    resultType: \"CheckNavClassIdsResultRow\",\r\n    sqlCommand: \"check_nav_class_ids\",\r\n    sqlQuery: `PRAGMA integrity_check(check_nav_class_ids) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkNavigationIds: {\r\n    name: \"Check Navigation Ids\",\r\n    resultType: \"CheckNavIdsResultRow\",\r\n    sqlCommand: \"check_nav_ids\",\r\n    sqlQuery: `PRAGMA integrity_check(check_nav_ids) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkLinktableForeignKeyClassIds: {\r\n    name: \"Check Link Table Foreign Key Class Ids\",\r\n    resultType: \"CheckLinkTableFkClassIdsResultRow\",\r\n    sqlCommand: \"check_linktable_fk_class_ids\",\r\n    sqlQuery: `PRAGMA integrity_check(check_linktable_fk_class_ids) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkLinktableForeignKeyIds: {\r\n    name: \"Check Link Table Foreign Key Ids\",\r\n    resultType: \"CheckLinkTableFkIdsResultRow\",\r\n    sqlCommand: \"check_linktable_fk_ids\",\r\n    sqlQuery: `PRAGMA integrity_check(check_linktable_fk_ids) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkClassIds: {\r\n    name: \"Check Class Ids\",\r\n    resultType: \"CheckClassIdsResultRow\",\r\n    sqlCommand: \"check_class_ids\",\r\n    sqlQuery: `PRAGMA integrity_check(check_class_ids) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkDataSchema: {\r\n    name: \"Check Data Schema\",\r\n    resultType: \"CheckDataSchemaResultRow\",\r\n    sqlCommand: \"check_data_schema\",\r\n    sqlQuery: `PRAGMA integrity_check(check_data_schema) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkSchemaLoad: {\r\n    name: \"Check Schema Load\",\r\n    resultType: \"CheckSchemaLoadResultRow\",\r\n    sqlCommand: \"check_schema_load\",\r\n    sqlQuery: `PRAGMA integrity_check(check_schema_load) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkMissingChildRows: {\r\n    name: \"Check Missing Child Rows\",\r\n    resultType: \"CheckMissingChildRowsResultRow\",\r\n    sqlCommand: \"check_missing_child_rows\",\r\n    sqlQuery: `PRAGMA integrity_check(check_missing_child_rows) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n  checkDivergedPropMaps: {\r\n    name: \"Check Diverged Property Maps\",\r\n    resultType: \"CheckDivergedPropMapsResultRow\",\r\n    sqlCommand: \"check_diverged_prop_maps\",\r\n    sqlQuery: `PRAGMA integrity_check(check_diverged_prop_maps) ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES`,\r\n  },\r\n} as const;\r\n\r\n/**\r\n * Type representing the keys of the integrityCheckType map, which correspond to the different types of integrity checks that can be performed.\r\n */\r\nexport type IntegrityCheckKey = keyof typeof integrityCheckTypeMap;\r\n\r\n/** Map of integrity check keys to their result row types */\r\ninterface IntegrityCheckResultTypeMap {\r\n  checkDataColumns: CheckDataColumnsResultRow;\r\n  checkECProfile: CheckECProfileResultRow;\r\n  checkNavigationClassIds: CheckNavClassIdsResultRow;\r\n  checkNavigationIds: CheckNavIdsResultRow;\r\n  checkLinktableForeignKeyClassIds: CheckLinkTableFkClassIdsResultRow;\r\n  checkLinktableForeignKeyIds: CheckLinkTableFkIdsResultRow;\r\n  checkClassIds: CheckClassIdsResultRow;\r\n  checkDataSchema: CheckDataSchemaResultRow;\r\n  checkSchemaLoad: CheckSchemaLoadResultRow;\r\n  checkMissingChildRows: CheckMissingChildRowsResultRow;\r\n  checkDivergedPropMaps: CheckDivergedPropMapsResultRow;\r\n}\r\n\r\n/** Checks the Map to give the return type of a specific integrity check */\r\ntype IntegrityCheckResultRow<K extends IntegrityCheckKey> = IntegrityCheckResultTypeMap[K];\r\n\r\n/**\r\n * Return type for quick integrity check\r\n */\r\nexport interface QuickIntegrityCheckResultRow {\r\n  /** Name of the integrity check. */\r\n  check: string;\r\n  /** Whether the check passed. Quick checks do not include problem details. */\r\n  passed: boolean;\r\n  /** Elapsed time for the check, in seconds. */\r\n  elapsedSeconds: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Data Columns integrity check\r\n */\r\nexport interface CheckDataColumnsResultRow {\r\n  /** Sequential result row number. */\r\n  sno: number;\r\n  /** Mapped data table containing a missing column. */\r\n  table: string;\r\n  /** Name of the missing nonvirtual physical column. */\r\n  column: string;\r\n}\r\n\r\n/**\r\n * Return type for Check EC Profile integrity check\r\n */\r\nexport interface CheckECProfileResultRow {\r\n  /** Sequential result row number. */\r\n  sno: number;\r\n  /** Type of EC profile object, such as a table, index, or iModel trigger. */\r\n  type: string;\r\n  /** Name of the EC profile object. */\r\n  name: string;\r\n  /** Description of the missing or mismatching object definition. */\r\n  issue: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Navigation Class Ids integrity check\r\n */\r\nexport interface CheckNavClassIdsResultRow {\r\n  /** Sequential result row number. */\r\n  sno: number;\r\n  /** ID of the source instance row containing the navigation property. */\r\n  id: string;\r\n  /** Declaring or scanned class for the source row; rows from derived classes may be included. */\r\n  class: string;\r\n  /** Name of the navigation property. */\r\n  property: string;\r\n  /** ID of the referenced instance stored by the navigation property. */\r\n  navId: string;\r\n  /** Relationship class ID stored by the navigation property, not the target instance class ID. */\r\n  navClassId: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Navigation Ids integrity check\r\n */\r\nexport interface CheckNavIdsResultRow {\r\n  /** Sequential result row number. */\r\n  sno: number;\r\n  /** ID of the source instance row containing the navigation property. */\r\n  id: string;\r\n  /** Declaring or scanned class for the source row; rows from derived classes may be included. */\r\n  class: string;\r\n  /** Name of the navigation property. */\r\n  property: string;\r\n  /** ID of the referenced instance stored by the navigation property. */\r\n  navId: string;\r\n  /** Class queried for the referenced row: the first relationship constraint class in the navigation direction, including derived classes. */\r\n  primaryClass: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Link Table Foreign Key Class Ids integrity check\r\n */\r\nexport interface CheckLinkTableFkClassIdsResultRow {\r\n  /** Sequential result row number. */\r\n  sno: number;\r\n  /** ID of the relationship row containing the foreign key. */\r\n  id: string;\r\n  /** Link-table relationship class. */\r\n  relationship: string;\r\n  /** Endpoint class-ID property: SourceECClassId or TargetECClassId. */\r\n  property: string;\r\n  /** Source or target endpoint instance ID stored in the link table. */\r\n  keyId: string;\r\n  /** Source or target endpoint class ID; the check verifies that the class exists. */\r\n  keyClassId: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Link Table Foreign Key Ids integrity check\r\n */\r\nexport interface CheckLinkTableFkIdsResultRow {\r\n  /** Sequential result row number. */\r\n  sno: number;\r\n  /** ID of the relationship row containing the foreign key. */\r\n  id: string;\r\n  /** Link-table relationship class. */\r\n  relationship: string;\r\n  /** Endpoint instance-ID property: SourceECInstanceId or TargetECInstanceId. */\r\n  property: string;\r\n  /** Source or target endpoint instance ID stored in the link table. */\r\n  keyId: string;\r\n  /** Class queried for the referenced endpoint row: the first endpoint constraint class, including derived classes. */\r\n  primaryClass: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Class Ids integrity check\r\n */\r\nexport interface CheckClassIdsResultRow {\r\n  /** Sequential result row number. */\r\n  sno: number;\r\n  /** Declaring or scanned class for the row; rows from derived classes may be included. */\r\n  class: string;\r\n  /** ECInstanceId for primary/joined results, or the physical RowId for overflow results. */\r\n  id: string;\r\n  /** Persisted ECClassId value with no matching class definition. */\r\n  classId: string;\r\n  /** Check category: \"primary\", \"joined\", or \"overflow\". */\r\n  type: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Data Schema integrity check\r\n */\r\nexport interface CheckDataSchemaResultRow {\r\n  /** Sequential result row number. */\r\n  sno: number;\r\n  /** Type of missing mapped schema object, such as a table or index. */\r\n  type: string;\r\n  /** Name of the missing mapped schema object. */\r\n  name: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Schema Load integrity check\r\n */\r\nexport interface CheckSchemaLoadResultRow {\r\n  /** Sequential result row number. */\r\n  sno: number;\r\n  /** Name of the schema that the schema manager could not load. */\r\n  schema: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Missing Child Rows integrity check\r\n */\r\nexport interface CheckMissingChildRowsResultRow {\r\n  /** Sequential result row number. */\r\n  sno: number;\r\n  /** Class used to identify the checked rows: \"BisCore:Element\". */\r\n  class: string;\r\n  /** ID of the existing bis_Element row missing a required child row. */\r\n  id: string;\r\n  /** Persisted ECClassId of the existing element row. */\r\n  classId: string;\r\n  /** Comma-separated names of all child tables checked for the row, not only tables with a missing child row. */\r\n  missingRowInTables: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Diverged Property Maps integrity check\r\n */\r\nexport interface CheckDivergedPropMapsResultRow {\r\n  /** Sequential result row number. */\r\n  sno: number;\r\n  /** ID of the derived class whose inherited property map diverges. */\r\n  derivedClassId: Id64String;\r\n  /** Name of the derived class whose inherited property map diverges. */\r\n  derivedClassName: string;\r\n  /** ID of the base class whose mapping was compared with the derived class. */\r\n  baseClassId: Id64String;\r\n  /** Name of the base class whose mapping was compared with the derived class. */\r\n  baseClassName: string;\r\n  /** Access path of the inherited property with different column mappings. */\r\n  propertyName: string;\r\n  /** Base class mapping, formatted as table.column. */\r\n  baseColumn: string;\r\n  /** Derived class mapping, formatted as table.column. */\r\n  divergedColumn: string;\r\n}\r\n\r\n/**\r\n * Return type for integrity check results, including the check name, whether it passed, and the specific results (if any)\r\n */\r\nexport interface IntegrityCheckResult {\r\n  /** The name of the integrity check that was performed */\r\n  check: string;\r\n  /** Whether the integrity check passed (i.e. no issues were found = true) */\r\n  passed: boolean;\r\n  /** The specific results returned by the integrity check, which may include details about any issues that were found.\r\n   * In the case where issues are found, this will be an array of result rows specific to the type of check that was performed,\r\n   * or an array of quick integrity check results if it was a quick check. */\r\n  results: IntegrityCheckResultRow<IntegrityCheckKey>[] | QuickIntegrityCheckResultRow[];\r\n}\r\n\r\n/**\r\n * Gets the user-friendly name of an integrity check based on its key or SQL command.\r\n * It first attempts to find a direct match for the key in the integrityCheckTypeMap. If not found, it searches for a match based on the SQL command.\r\n * If still not found, it returns the original check string.\r\n * @param check - The integrity check key or SQL command to get the name of\r\n * @returns The user-friendly name of the integrity check, or the original check string if no match is found\r\n * @internal\r\n */\r\nexport function getIntegrityCheckName(check: string): string {\r\n  // First try direct lookup by key\r\n  const directLookup = integrityCheckTypeMap[check as IntegrityCheckKey];\r\n  if (directLookup) {\r\n    return directLookup.name;\r\n  }\r\n  // If not found, search by sqlCommand\r\n  for (const [, value] of Object.entries(integrityCheckTypeMap)) {\r\n    if (value.sqlCommand === check) {\r\n      return value.name;\r\n    }\r\n  }\r\n  // Fallback to the original check string\r\n  return check;\r\n}\r\n\r\n/**\r\n * Performs a quick integrity check on the given iModel.\r\n * @param iModel The IModelDb instance to perform the integrity check on\r\n * @returns An array of results for each check performed, including the check name, whether it passed, and the elapsed time in seconds\r\n * @internal\r\n */\r\nexport async function performQuickIntegrityCheck(iModel: IModelDb): Promise<QuickIntegrityCheckResultRow[]> {\r\n  const integrityCheckQuery = \"PRAGMA integrity_check ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES\";\r\n  const integrityCheckResults: QuickIntegrityCheckResultRow[] = [];\r\n  for await (const row of iModel.createQueryReader(integrityCheckQuery, undefined, { usePrimaryConn: true })) {\r\n    integrityCheckResults.push({ check: getIntegrityCheckName(row.check), passed: row.result, elapsedSeconds: row.elapsed_sec });\r\n  };\r\n  return integrityCheckResults;\r\n}\r\n\r\n/**\r\n * Performs a specific integrity check on the given iModel based on the provided check key, and returns the results specific to that check type.\r\n * @param iModel The IModelDb instance to perform the integrity check on\r\n * @param check The key of the specific integrity check to perform\r\n * @return An array of results specific to the integrity check that was performed. The type of the result rows will depend on the check that was executed.\r\n * @throws IModelError with status BadRequest if an unknown integrity check key is provided\r\n * @internal\r\n */\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkDataColumns\"): Promise<IntegrityCheckResultRow<\"checkDataColumns\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkECProfile\"): Promise<IntegrityCheckResultRow<\"checkECProfile\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkNavigationClassIds\"): Promise<IntegrityCheckResultRow<\"checkNavigationClassIds\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkNavigationIds\"): Promise<IntegrityCheckResultRow<\"checkNavigationIds\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkLinktableForeignKeyClassIds\"): Promise<IntegrityCheckResultRow<\"checkLinktableForeignKeyClassIds\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkLinktableForeignKeyIds\"): Promise<IntegrityCheckResultRow<\"checkLinktableForeignKeyIds\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkClassIds\"): Promise<IntegrityCheckResultRow<\"checkClassIds\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkDataSchema\"): Promise<IntegrityCheckResultRow<\"checkDataSchema\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkSchemaLoad\"): Promise<IntegrityCheckResultRow<\"checkSchemaLoad\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkMissingChildRows\"): Promise<IntegrityCheckResultRow<\"checkMissingChildRows\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkDivergedPropMaps\"): Promise<IntegrityCheckResultRow<\"checkDivergedPropMaps\">[]>;\r\nexport async function performSpecificIntegrityCheck<K extends IntegrityCheckKey>(iModel: IModelDb, check: K): Promise<IntegrityCheckResultRow<K>[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: IntegrityCheckKey): Promise<IntegrityCheckResultRow<IntegrityCheckKey>[]> {\r\n  switch (check) {\r\n    case \"checkDataColumns\": {\r\n      const results: CheckDataColumnsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkDataColumns.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, table: row.table, column: row.column });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkECProfile\": {\r\n      const results: CheckECProfileResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkECProfile.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, type: row.type, name: row.name, issue: row.issue });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkNavigationClassIds\": {\r\n      const results: CheckNavClassIdsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkNavigationClassIds.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, id: row.id, class: row.class, property: row.property, navId: row.nav_id, navClassId: row.nav_classId });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkNavigationIds\": {\r\n      const results: CheckNavIdsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkNavigationIds.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, id: row.id, class: row.class, property: row.property, navId: row.nav_id, primaryClass: row.primary_class });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkLinktableForeignKeyClassIds\": {\r\n      const results: CheckLinkTableFkClassIdsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkLinktableForeignKeyClassIds.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, id: row.id, relationship: row.relationship, property: row.property, keyId: row.key_id, keyClassId: row.key_classId });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkLinktableForeignKeyIds\": {\r\n      const results: CheckLinkTableFkIdsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkLinktableForeignKeyIds.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, id: row.id, relationship: row.relationship, property: row.property, keyId: row.key_id, primaryClass: row.primary_class });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkClassIds\": {\r\n      const results: CheckClassIdsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkClassIds.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, class: row.class, id: row.id, classId: row.class_id, type: row.type });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkDataSchema\": {\r\n      const results: CheckDataSchemaResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkDataSchema.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, type: row.type, name: row.name });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkSchemaLoad\": {\r\n      const results: CheckSchemaLoadResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkSchemaLoad.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, schema: row.schema });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkMissingChildRows\": {\r\n      const results: CheckMissingChildRowsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkMissingChildRows.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, class: row.class, id: row.id, classId: row.class_id, missingRowInTables: row.MissingRowInTables });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkDivergedPropMaps\": {\r\n      const results: CheckDivergedPropMapsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkDivergedPropMaps.sqlQuery, undefined, { usePrimaryConn: true })) {\r\n        results.push({ sno: row.sno, derivedClassId: row.derivedClassId, derivedClassName: row.derivedClassName, baseClassId: row.baseClassId, baseClassName: row.baseClassName, propertyName: row.propertyName, baseColumn: row.baseColumn, divergedColumn: row.divergedColumn });\r\n      }\r\n      return results;\r\n    }\r\n    default:\r\n      throw new IModelError(IModelStatus.BadRequest, `Unknown integrity check type`);\r\n  }\r\n}"]}

package/lib/cjs/internal/annotations/fieldSpecs.d.ts

@@ -0,0 +1,82 @@
+import { FieldValue, QuantityFieldFormatOptions } from "@itwin/core-common";
+import { FormatterSpec, FormattingSpecArgs, SyncFormatsProvider, SyncUnitsProvider } from "@itwin/core-quantity";
+import { SchemaContext } from "@itwin/ecschema-metadata";
+import type { FieldFormattingArgs } from "../../annotations/ElementDrivesTextAnnotation";
+import type { IModelDb } from "../../IModelDb";
+/** A [FieldValue]($common) as the backend resolves it: the primitive value plus, for
+ * `"quantity"` and `"coordinate"` types, the KindOfQuantity and persistence unit of the EC
+ * property it was read from. These serve as the fallback when the field's own
+ * [QuantityFieldFormatOptions]($common) do not resolve.
+ * @internal
+ */
+export interface ResolvedFieldValue extends FieldValue {
+    /** EC full name of the property's KindOfQuantity, e.g. `"AecUnits.LENGTH"`, if it has one. */
+    kindOfQuantityFullName?: string;
+    /** EC full name of the unit the stored magnitude is expressed in, e.g. `"Units.M"`. */
+    persistenceUnitFullName?: string;
+}
+/** The formats an iModel's fields resolve through, as configured by
+ * [ElementDrivesTextAnnotation.registerFieldFormatting]($backend) or defaulted from the iModel's
+ * schemas. Holds only providers; every [FormatterSpec]($core-quantity) is built on demand by
+ * [[lookupFieldSpec]] and discarded after the field is formatted. Building one costs on the order
+ * of a microsecond, so nothing is cached.
+ * @internal
+ */
+export interface FieldFormatting {
+    readonly schemaContext: SchemaContext;
+    readonly unitsProvider: SyncUnitsProvider;
+    /** The adopted FormatSet layered over the iModel's schema formats, or the schema formats alone. */
+    readonly defaultFormats: SyncFormatsProvider;
+    /** Per-field FormatSets by id, each falling through to [[defaultFormats]]. */
+    readonly formatSets: ReadonlyMap<string, SyncFormatsProvider>;
+}
+/** Returns the formats `iModel`'s fields resolve through, creating the schema-only default on
+ * first use.
+ * @internal
+ */
+export declare function getFieldFormatting(iModel: IModelDb): FieldFormatting;
+/** Replaces the formats `iModel`'s fields resolve through.
+ * @internal
+ */
+export declare function setFieldFormatting(iModel: IModelDb, formatting: FieldFormatting): void;
+/** @internal */
+export declare function createFieldFormatting(args: FieldFormattingArgs): FieldFormatting;
+/** Builds the [FormatterSpec]($core-quantity) for `args`, or `undefined` when the
+ * format fails to resolve, the persistence unit is not a bundled BIS unit, the format names a
+ * unit that is not, or the two cannot be converted between -- leaving the caller on the same
+ * fallback as any other unresolved override.
+ * @internal
+ */
+export declare function buildFieldFormatterSpec(args: FormattingSpecArgs, formatsProvider: SyncFormatsProvider, formatting: FieldFormatting): FormatterSpec | undefined;
+/** Builds the (KindOfQuantity, persistence unit) pairs a quantity/coordinate value may format
+ * through, in priority order: the field's override pair first, then the property's own pair.
+ * Names are compared exactly, so callers pass override names already normalized to the schema's
+ * spelling.
+ *
+ * The two halves fall back differently. `kindOfQuantity` only chooses how the magnitude is
+ * displayed, so the override wins and the property's is the fallback. `persistenceUnit` states
+ * what the stored magnitude *means*, so the property's own unit is authoritative when it has one;
+ * the override only supplies a unit for a property that lacks one (a coordinate, a plain double,
+ * a JSON leaf). See [[lookupFieldSpec]] for reporting an override that was ignored this way.
+ * @internal
+ */
+export declare function collectFieldQuantityPairs(args: {
+    overrideName?: string;
+    overridePersistence?: string;
+    propertyName?: string;
+    propertyPersistence?: string;
+}): FormattingSpecArgs[];
+/** Builds the first [FormatterSpec]($core-quantity) that resolves for `value` among the formats
+ * of the FormatSet named by `quantityOptions.formatSet` -- or the adopted FormatSet and schema
+ * formats when it names none, or one that was never registered -- along with the pairs that were
+ * tried, so the caller can report when none resolved. `ignoredPersistenceUnit` is set when the
+ * field's `persistenceUnit` named a unit other than the property's own and was therefore not
+ * used, so the caller can report the likely authoring mistake.
+ * @internal
+ */
+export declare function lookupFieldSpec(quantityOptions: QuantityFieldFormatOptions | undefined, value: ResolvedFieldValue, formatting: FieldFormatting): {
+    spec?: FormatterSpec;
+    candidates: FormattingSpecArgs[];
+    ignoredPersistenceUnit?: string;
+};
+//# sourceMappingURL=fieldSpecs.d.ts.map

package/lib/cjs/internal/annotations/fieldSpecs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fieldSpecs.d.ts","sourceRoot":"","sources":["../../../../src/internal/annotations/fieldSpecs.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EACuB,aAAa,EAAE,kBAAkB,EAAiB,mBAAmB,EAAE,iBAAiB,EACrH,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAA4B,aAAa,EAAgD,MAAM,0BAA0B,CAAC;AACjI,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+CAA+C,CAAC;AACzF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE/C;;;;;GAKG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,8FAA8F;IAC9F,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,uFAAuF;IACvF,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,iBAAiB,CAAC;IAC1C,mGAAmG;IACnG,QAAQ,CAAC,cAAc,EAAE,mBAAmB,CAAC;IAC7C,8EAA8E;IAC9E,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;CAC/D;AASD;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,QAAQ,GAAG,eAAe,CAQpE;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,eAAe,GAAG,IAAI,CAEtF;AAED,gBAAgB;AAChB,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,mBAAmB,GAAG,eAAe,CAgBhF;AAqBD;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,kBAAkB,EAAE,eAAe,EAAE,mBAAmB,EAAE,UAAU,EAAE,eAAe,GAAG,aAAa,GAAG,SAAS,CAqC9J;AAoBD;;;;;;;;;;;GAWG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE;IAC9C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,GAAG,kBAAkB,EAAE,CAevB;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,eAAe,EAAE,0BAA0B,GAAG,SAAS,EACvD,KAAK,EAAE,kBAAkB,EACzB,UAAU,EAAE,eAAe,GAC1B;IAAE,IAAI,CAAC,EAAE,aAAa,CAAC;IAAC,UAAU,EAAE,kBAAkB,EAAE,CAAC;IAAC,sBAAsB,CAAC,EAAE,MAAM,CAAA;CAAE,CAoB7F"}

package/lib/cjs/internal/annotations/fieldSpecs.js

@@ -0,0 +1,187 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFieldFormatting = getFieldFormatting;
+exports.setFieldFormatting = setFieldFormatting;
+exports.createFieldFormatting = createFieldFormatting;
+exports.buildFieldFormatterSpec = buildFieldFormatterSpec;
+exports.collectFieldQuantityPairs = collectFieldQuantityPairs;
+exports.lookupFieldSpec = lookupFieldSpec;
+const core_quantity_1 = require("@itwin/core-quantity");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+/** Per-iModel [[FieldFormatting]], as configured by the last
+ * [ElementDrivesTextAnnotation.registerFieldFormatting]($backend) call, or the schema-only default
+ * created the first time one of the iModel's fields was evaluated. Weakly keyed so a closed iModel
+ * takes its entry with it.
+ */
+const fieldFormattings = new WeakMap();
+/** Returns the formats `iModel`'s fields resolve through, creating the schema-only default on
+ * first use.
+ * @internal
+ */
+function getFieldFormatting(iModel) {
+    let formatting = fieldFormattings.get(iModel);
+    if (!formatting) {
+        formatting = createFieldFormatting({ iModel });
+        fieldFormattings.set(iModel, formatting);
+    }
+    return formatting;
+}
+/** Replaces the formats `iModel`'s fields resolve through.
+ * @internal
+ */
+function setFieldFormatting(iModel, formatting) {
+    fieldFormattings.set(iModel, formatting);
+}
+/** @internal */
+function createFieldFormatting(args) {
+    // An adopted FormatSet declares the unit system it was authored for; honor it unless the
+    // caller says otherwise.
+    const unitSystem = args.unitSystem ?? args.formatSet?.unitSystem ?? "metric";
+    const schemaContext = args.iModel.schemaContext;
+    const schemaFormats = new ecschema_metadata_1.SchemaFormatsProvider(schemaContext, unitSystem);
+    // Every per-field FormatSet falls through to this same chain, so a field naming a FormatSet
+    // that has no entry for its KindOfQuantity still sees the adopted presentation before the
+    // schema's, matching the documented resolution order.
+    const defaultFormats = args.formatSet ? new ecschema_metadata_1.FormatSetFormatsProvider({ formatSet: args.formatSet, fallbackProvider: schemaFormats }) : schemaFormats;
+    const formatSets = new Map();
+    for (const { id, formatSet } of args.formatSets ?? []) {
+        formatSets.set(id, new ecschema_metadata_1.FormatSetFormatsProvider({ formatSet, fallbackProvider: defaultFormats }));
+    }
+    return { schemaContext, unitsProvider: new core_quantity_1.BasicUnitsProvider(), defaultFormats, formatSets };
+}
+/** [SchemaFormatsProvider.getFormatSync]($ecschema-metadata) reads only schemas already in the
+ * context's cache; it never asks a locater to load one. The backend locater *can* load
+ * synchronously, so ask the context for the schema first. That pulls it -- and the `Formats` and
+ * `Units` schemas it references -- into the cache. A name whose schema the iModel lacks (a key
+ * defined only by a FormatSet, say) is left for the formats provider to resolve or reject.
+ */
+function ensureSchemaLoaded(context, fullName) {
+    const [schemaName] = ecschema_metadata_1.SchemaItem.parseFullName(fullName);
+    if (!schemaName) {
+        return;
+    }
+    try {
+        context.getSchemaSync(new ecschema_metadata_1.SchemaKey(schemaName));
+    }
+    catch {
+        // Not a schema this iModel knows.
+    }
+}
+/** Builds the [FormatterSpec]($core-quantity) for `args`, or `undefined` when the
+ * format fails to resolve, the persistence unit is not a bundled BIS unit, the format names a
+ * unit that is not, or the two cannot be converted between -- leaving the caller on the same
+ * fallback as any other unresolved override.
+ * @internal
+ */
+function buildFieldFormatterSpec(args, formatsProvider, formatting) {
+    const { unitsProvider, schemaContext } = formatting;
+    ensureSchemaLoaded(schemaContext, args.name);
+    const formatProps = formatsProvider.getFormatSync(args.name, args.system);
+    if (!formatProps) {
+        return undefined;
+    }
+    // BasicUnitsProvider reports an unknown unit as an invalid BadUnit rather than throwing.
+    const persistenceUnit = unitsProvider.findUnitByNameSync(args.persistenceUnitName);
+    if (!persistenceUnit.isValid) {
+        return undefined;
+    }
+    let formatterSpec;
+    try {
+        const format = core_quantity_1.Format.createFromJSONSync("fieldFormat", unitsProvider, formatProps);
+        formatterSpec = core_quantity_1.FormatterSpec.createSync("fieldFormat", format, unitsProvider, persistenceUnit);
+    }
+    catch (err) {
+        // A format naming a unit the bundled provider lacks can't be resolved.
+        if (err instanceof core_quantity_1.QuantityError) {
+            return undefined;
+        }
+        throw err;
+    }
+    // Reject a format whose units belong to a different phenomenon than the persisted value.
+    // SyncUnitsProvider.getConversionSync reports this by returning the identity conversion tagged
+    // `error: true`, and its contract requires callers to check that flag before applying the
+    // result. FormatterSpec.createSync only logs a warning and keeps the identity conversion, so
+    // without this check a length persisted in meters would render through an angle format as
+    // "2.5 deg" -- relabelled rather than converted.
+    if (formatterSpec.unitConversions.some((conversion) => conversion.conversion.error)) {
+        return undefined;
+    }
+    return formatterSpec;
+}
+/** Returns `name` as the iModel's schemas spell it (`Units.M` for `units:m`), so later lookups
+ * and comparisons can be exact: [BasicUnitsProvider.findUnitByNameSync]($core-quantity) only
+ * recognizes the canonical spelling. An empty name counts as unset. A name no schema defines,
+ * such as a KindOfQuantity only a FormatSet declares, is returned unchanged.
+ */
+function normalizeToSchemaName(context, name) {
+    if (!name) {
+        return undefined;
+    }
+    try {
+        return context.getSchemaItemSync(name)?.fullName ?? name;
+    }
+    catch {
+        // Not a schema this iModel knows.
+        return name;
+    }
+}
+/** Builds the (KindOfQuantity, persistence unit) pairs a quantity/coordinate value may format
+ * through, in priority order: the field's override pair first, then the property's own pair.
+ * Names are compared exactly, so callers pass override names already normalized to the schema's
+ * spelling.
+ *
+ * The two halves fall back differently. `kindOfQuantity` only chooses how the magnitude is
+ * displayed, so the override wins and the property's is the fallback. `persistenceUnit` states
+ * what the stored magnitude *means*, so the property's own unit is authoritative when it has one;
+ * the override only supplies a unit for a property that lacks one (a coordinate, a plain double,
+ * a JSON leaf). See [[lookupFieldSpec]] for reporting an override that was ignored this way.
+ * @internal
+ */
+function collectFieldQuantityPairs(args) {
+    const { overrideName, overridePersistence, propertyName, propertyPersistence } = args;
+    const name = overrideName ?? propertyName;
+    const persistenceUnitName = propertyPersistence ?? overridePersistence;
+    const pairs = [];
+    if (name && persistenceUnitName) {
+        pairs.push({ name, persistenceUnitName });
+    }
+    // Fall back to the property's own pair unless the pair above already is it.
+    if (propertyName && propertyPersistence && name !== propertyName) {
+        pairs.push({ name: propertyName, persistenceUnitName: propertyPersistence });
+    }
+    return pairs;
+}
+/** Builds the first [FormatterSpec]($core-quantity) that resolves for `value` among the formats
+ * of the FormatSet named by `quantityOptions.formatSet` -- or the adopted FormatSet and schema
+ * formats when it names none, or one that was never registered -- along with the pairs that were
+ * tried, so the caller can report when none resolved. `ignoredPersistenceUnit` is set when the
+ * field's `persistenceUnit` named a unit other than the property's own and was therefore not
+ * used, so the caller can report the likely authoring mistake.
+ * @internal
+ */
+function lookupFieldSpec(quantityOptions, value, formatting) {
+    const overridePersistence = normalizeToSchemaName(formatting.schemaContext, quantityOptions?.persistenceUnit);
+    const propertyPersistence = value.persistenceUnitFullName;
+    const ignoredPersistenceUnit = overridePersistence && propertyPersistence && overridePersistence !== propertyPersistence
+        ? overridePersistence : undefined;
+    const candidates = collectFieldQuantityPairs({
+        overrideName: normalizeToSchemaName(formatting.schemaContext, quantityOptions?.kindOfQuantity),
+        overridePersistence,
+        propertyName: value.kindOfQuantityFullName,
+        propertyPersistence,
+    });
+    const formatSet = quantityOptions?.formatSet;
+    const formats = (formatSet ? formatting.formatSets.get(formatSet) : undefined) ?? formatting.defaultFormats;
+    for (const candidate of candidates) {
+        const spec = buildFieldFormatterSpec(candidate, formats, formatting);
+        if (spec) {
+            return { spec, candidates, ignoredPersistenceUnit };
+        }
+    }
+    return { candidates, ignoredPersistenceUnit };
+}
+//# sourceMappingURL=fieldSpecs.js.map

package/lib/cjs/internal/annotations/fieldSpecs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fieldSpecs.js","sourceRoot":"","sources":["../../../../src/internal/annotations/fieldSpecs.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;AAkD/F,gDAQC;AAKD,gDAEC;AAGD,sDAgBC;AA2BD,0DAqCC;AAgCD,8DAoBC;AAUD,0CAwBC;AAvOD,wDAE8B;AAC9B,gEAAiI;AAiCjI;;;;GAIG;AACH,MAAM,gBAAgB,GAAG,IAAI,OAAO,EAA6B,CAAC;AAElE;;;GAGG;AACH,SAAgB,kBAAkB,CAAC,MAAgB;IACjD,IAAI,UAAU,GAAG,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC9C,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,UAAU,GAAG,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAC/C,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CAAC,MAAgB,EAAE,UAA2B;IAC9E,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AAC3C,CAAC;AAED,gBAAgB;AAChB,SAAgB,qBAAqB,CAAC,IAAyB;IAC7D,yFAAyF;IACzF,yBAAyB;IACzB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,SAAS,EAAE,UAAU,IAAI,QAAQ,CAAC;IAC7E,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC;IAChD,MAAM,aAAa,GAAG,IAAI,yCAAqB,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IAC3E,4FAA4F;IAC5F,0FAA0F;IAC1F,sDAAsD;IACtD,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,4CAAwB,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,gBAAgB,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;IACrJ,MAAM,UAAU,GAAG,IAAI,GAAG,EAA+B,CAAC;IAC1D,KAAK,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,IAAI,CAAC,UAAU,IAAI,EAAE,EAAE,CAAC;QACtD,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,4CAAwB,CAAC,EAAE,SAAS,EAAE,gBAAgB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;IACpG,CAAC;IAED,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,IAAI,kCAAkB,EAAE,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC;AAChG,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,OAAsB,EAAE,QAAgB;IAClE,MAAM,CAAC,UAAU,CAAC,GAAG,8BAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACxD,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO;IACT,CAAC;IAED,IAAI,CAAC;QACH,OAAO,CAAC,aAAa,CAAC,IAAI,6BAAS,CAAC,UAAU,CAAC,CAAC,CAAC;IACnD,CAAC;IAAC,MAAM,CAAC;QACP,kCAAkC;IACpC,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CAAC,IAAwB,EAAE,eAAoC,EAAE,UAA2B;IACjI,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,GAAG,UAAU,CAAC;IACpD,kBAAkB,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,WAAW,GAAG,eAAe,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1E,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,yFAAyF;IACzF,MAAM,eAAe,GAAG,aAAa,CAAC,kBAAkB,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACnF,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;QAC7B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,aAA4B,CAAC;IACjC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,sBAAM,CAAC,kBAAkB,CAAC,aAAa,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;QACpF,aAAa,GAAG,6BAAa,CAAC,UAAU,CAAC,aAAa,EAAE,MAAM,EAAE,aAAa,EAAE,eAAe,CAAC,CAAC;IAClG,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,uEAAuE;QACvE,IAAI,GAAG,YAAY,6BAAa,EAAE,CAAC;YACjC,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,GAAG,CAAC;IACZ,CAAC;IAED,yFAAyF;IACzF,+FAA+F;IAC/F,0FAA0F;IAC1F,6FAA6F;IAC7F,0FAA0F;IAC1F,iDAAiD;IACjD,IAAI,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QACpF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;;GAIG;AACH,SAAS,qBAAqB,CAAC,OAAsB,EAAE,IAAwB;IAC7E,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,CAAC;QACH,OAAO,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,QAAQ,IAAI,IAAI,CAAC;IAC3D,CAAC;IAAC,MAAM,CAAC;QACP,kCAAkC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,yBAAyB,CAAC,IAKzC;IACC,MAAM,EAAE,YAAY,EAAE,mBAAmB,EAAE,YAAY,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAC;IACtF,MAAM,IAAI,GAAG,YAAY,IAAI,YAAY,CAAC;IAC1C,MAAM,mBAAmB,GAAG,mBAAmB,IAAI,mBAAmB,CAAC;IACvE,MAAM,KAAK,GAAyB,EAAE,CAAC;IACvC,IAAI,IAAI,IAAI,mBAAmB,EAAE,CAAC;QAChC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,4EAA4E;IAC5E,IAAI,YAAY,IAAI,mBAAmB,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;QACjE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,eAAe,CAC7B,eAAuD,EACvD,KAAyB,EACzB,UAA2B;IAE3B,MAAM,mBAAmB,GAAG,qBAAqB,CAAC,UAAU,CAAC,aAAa,EAAE,eAAe,EAAE,eAAe,CAAC,CAAC;IAC9G,MAAM,mBAAmB,GAAG,KAAK,CAAC,uBAAuB,CAAC;IAC1D,MAAM,sBAAsB,GAAG,mBAAmB,IAAI,mBAAmB,IAAI,mBAAmB,KAAK,mBAAmB;QACtH,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;IACpC,MAAM,UAAU,GAAG,yBAAyB,CAAC;QAC3C,YAAY,EAAE,qBAAqB,CAAC,UAAU,CAAC,aAAa,EAAE,eAAe,EAAE,cAAc,CAAC;QAC9F,mBAAmB;QACnB,YAAY,EAAE,KAAK,CAAC,sBAAsB;QAC1C,mBAAmB;KACpB,CAAC,CAAC;IACH,MAAM,SAAS,GAAG,eAAe,EAAE,SAAS,CAAC;IAC7C,MAAM,OAAO,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,UAAU,CAAC,cAAc,CAAC;IAC5G,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,uBAAuB,CAAC,SAAS,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QACrE,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,sBAAsB,EAAE,CAAC;QACtD,CAAC;IACH,CAAC;IACD,OAAO,EAAE,UAAU,EAAE,sBAAsB,EAAE,CAAC;AAChD,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 { FieldValue, QuantityFieldFormatOptions } from \"@itwin/core-common\";\r\nimport {\r\n  BasicUnitsProvider, Format, FormatterSpec, FormattingSpecArgs, QuantityError, SyncFormatsProvider, SyncUnitsProvider,\r\n} from \"@itwin/core-quantity\";\r\nimport { FormatSetFormatsProvider, SchemaContext, SchemaFormatsProvider, SchemaItem, SchemaKey } from \"@itwin/ecschema-metadata\";\r\nimport type { FieldFormattingArgs } from \"../../annotations/ElementDrivesTextAnnotation\";\r\nimport type { IModelDb } from \"../../IModelDb\";\r\n\r\n/** A [FieldValue]($common) as the backend resolves it: the primitive value plus, for\r\n * `\"quantity\"` and `\"coordinate\"` types, the KindOfQuantity and persistence unit of the EC\r\n * property it was read from. These serve as the fallback when the field's own\r\n * [QuantityFieldFormatOptions]($common) do not resolve.\r\n * @internal\r\n */\r\nexport interface ResolvedFieldValue extends FieldValue {\r\n  /** EC full name of the property's KindOfQuantity, e.g. `\"AecUnits.LENGTH\"`, if it has one. */\r\n  kindOfQuantityFullName?: string;\r\n  /** EC full name of the unit the stored magnitude is expressed in, e.g. `\"Units.M\"`. */\r\n  persistenceUnitFullName?: string;\r\n}\r\n\r\n/** The formats an iModel's fields resolve through, as configured by\r\n * [ElementDrivesTextAnnotation.registerFieldFormatting]($backend) or defaulted from the iModel's\r\n * schemas. Holds only providers; every [FormatterSpec]($core-quantity) is built on demand by\r\n * [[lookupFieldSpec]] and discarded after the field is formatted. Building one costs on the order\r\n * of a microsecond, so nothing is cached.\r\n * @internal\r\n */\r\nexport interface FieldFormatting {\r\n  readonly schemaContext: SchemaContext;\r\n  readonly unitsProvider: SyncUnitsProvider;\r\n  /** The adopted FormatSet layered over the iModel's schema formats, or the schema formats alone. */\r\n  readonly defaultFormats: SyncFormatsProvider;\r\n  /** Per-field FormatSets by id, each falling through to [[defaultFormats]]. */\r\n  readonly formatSets: ReadonlyMap<string, SyncFormatsProvider>;\r\n}\r\n\r\n/** Per-iModel [[FieldFormatting]], as configured by the last\r\n * [ElementDrivesTextAnnotation.registerFieldFormatting]($backend) call, or the schema-only default\r\n * created the first time one of the iModel's fields was evaluated. Weakly keyed so a closed iModel\r\n * takes its entry with it.\r\n */\r\nconst fieldFormattings = new WeakMap<IModelDb, FieldFormatting>();\r\n\r\n/** Returns the formats `iModel`'s fields resolve through, creating the schema-only default on\r\n * first use.\r\n * @internal\r\n */\r\nexport function getFieldFormatting(iModel: IModelDb): FieldFormatting {\r\n  let formatting = fieldFormattings.get(iModel);\r\n  if (!formatting) {\r\n    formatting = createFieldFormatting({ iModel });\r\n    fieldFormattings.set(iModel, formatting);\r\n  }\r\n\r\n  return formatting;\r\n}\r\n\r\n/** Replaces the formats `iModel`'s fields resolve through.\r\n * @internal\r\n */\r\nexport function setFieldFormatting(iModel: IModelDb, formatting: FieldFormatting): void {\r\n  fieldFormattings.set(iModel, formatting);\r\n}\r\n\r\n/** @internal */\r\nexport function createFieldFormatting(args: FieldFormattingArgs): FieldFormatting {\r\n  // An adopted FormatSet declares the unit system it was authored for; honor it unless the\r\n  // caller says otherwise.\r\n  const unitSystem = args.unitSystem ?? args.formatSet?.unitSystem ?? \"metric\";\r\n  const schemaContext = args.iModel.schemaContext;\r\n  const schemaFormats = new SchemaFormatsProvider(schemaContext, unitSystem);\r\n  // Every per-field FormatSet falls through to this same chain, so a field naming a FormatSet\r\n  // that has no entry for its KindOfQuantity still sees the adopted presentation before the\r\n  // schema's, matching the documented resolution order.\r\n  const defaultFormats = args.formatSet ? new FormatSetFormatsProvider({ formatSet: args.formatSet, fallbackProvider: schemaFormats }) : schemaFormats;\r\n  const formatSets = new Map<string, SyncFormatsProvider>();\r\n  for (const { id, formatSet } of args.formatSets ?? []) {\r\n    formatSets.set(id, new FormatSetFormatsProvider({ formatSet, fallbackProvider: defaultFormats }));\r\n  }\r\n\r\n  return { schemaContext, unitsProvider: new BasicUnitsProvider(), defaultFormats, formatSets };\r\n}\r\n\r\n/** [SchemaFormatsProvider.getFormatSync]($ecschema-metadata) reads only schemas already in the\r\n * context's cache; it never asks a locater to load one. The backend locater *can* load\r\n * synchronously, so ask the context for the schema first. That pulls it -- and the `Formats` and\r\n * `Units` schemas it references -- into the cache. A name whose schema the iModel lacks (a key\r\n * defined only by a FormatSet, say) is left for the formats provider to resolve or reject.\r\n */\r\nfunction ensureSchemaLoaded(context: SchemaContext, fullName: string): void {\r\n  const [schemaName] = SchemaItem.parseFullName(fullName);\r\n  if (!schemaName) {\r\n    return;\r\n  }\r\n\r\n  try {\r\n    context.getSchemaSync(new SchemaKey(schemaName));\r\n  } catch {\r\n    // Not a schema this iModel knows.\r\n  }\r\n}\r\n\r\n/** Builds the [FormatterSpec]($core-quantity) for `args`, or `undefined` when the\r\n * format fails to resolve, the persistence unit is not a bundled BIS unit, the format names a\r\n * unit that is not, or the two cannot be converted between -- leaving the caller on the same\r\n * fallback as any other unresolved override.\r\n * @internal\r\n */\r\nexport function buildFieldFormatterSpec(args: FormattingSpecArgs, formatsProvider: SyncFormatsProvider, formatting: FieldFormatting): FormatterSpec | undefined {\r\n  const { unitsProvider, schemaContext } = formatting;\r\n  ensureSchemaLoaded(schemaContext, args.name);\r\n  const formatProps = formatsProvider.getFormatSync(args.name, args.system);\r\n  if (!formatProps) {\r\n    return undefined;\r\n  }\r\n\r\n  // BasicUnitsProvider reports an unknown unit as an invalid BadUnit rather than throwing.\r\n  const persistenceUnit = unitsProvider.findUnitByNameSync(args.persistenceUnitName);\r\n  if (!persistenceUnit.isValid) {\r\n    return undefined;\r\n  }\r\n\r\n  let formatterSpec: FormatterSpec;\r\n  try {\r\n    const format = Format.createFromJSONSync(\"fieldFormat\", unitsProvider, formatProps);\r\n    formatterSpec = FormatterSpec.createSync(\"fieldFormat\", format, unitsProvider, persistenceUnit);\r\n  } catch (err) {\r\n    // A format naming a unit the bundled provider lacks can't be resolved.\r\n    if (err instanceof QuantityError) {\r\n      return undefined;\r\n    }\r\n    throw err;\r\n  }\r\n\r\n  // Reject a format whose units belong to a different phenomenon than the persisted value.\r\n  // SyncUnitsProvider.getConversionSync reports this by returning the identity conversion tagged\r\n  // `error: true`, and its contract requires callers to check that flag before applying the\r\n  // result. FormatterSpec.createSync only logs a warning and keeps the identity conversion, so\r\n  // without this check a length persisted in meters would render through an angle format as\r\n  // \"2.5 deg\" -- relabelled rather than converted.\r\n  if (formatterSpec.unitConversions.some((conversion) => conversion.conversion.error)) {\r\n    return undefined;\r\n  }\r\n\r\n  return formatterSpec;\r\n}\r\n\r\n/** Returns `name` as the iModel's schemas spell it (`Units.M` for `units:m`), so later lookups\r\n * and comparisons can be exact: [BasicUnitsProvider.findUnitByNameSync]($core-quantity) only\r\n * recognizes the canonical spelling. An empty name counts as unset. A name no schema defines,\r\n * such as a KindOfQuantity only a FormatSet declares, is returned unchanged.\r\n */\r\nfunction normalizeToSchemaName(context: SchemaContext, name: string | undefined): string | undefined {\r\n  if (!name) {\r\n    return undefined;\r\n  }\r\n\r\n  try {\r\n    return context.getSchemaItemSync(name)?.fullName ?? name;\r\n  } catch {\r\n    // Not a schema this iModel knows.\r\n    return name;\r\n  }\r\n}\r\n\r\n/** Builds the (KindOfQuantity, persistence unit) pairs a quantity/coordinate value may format\r\n * through, in priority order: the field's override pair first, then the property's own pair.\r\n * Names are compared exactly, so callers pass override names already normalized to the schema's\r\n * spelling.\r\n *\r\n * The two halves fall back differently. `kindOfQuantity` only chooses how the magnitude is\r\n * displayed, so the override wins and the property's is the fallback. `persistenceUnit` states\r\n * what the stored magnitude *means*, so the property's own unit is authoritative when it has one;\r\n * the override only supplies a unit for a property that lacks one (a coordinate, a plain double,\r\n * a JSON leaf). See [[lookupFieldSpec]] for reporting an override that was ignored this way.\r\n * @internal\r\n */\r\nexport function collectFieldQuantityPairs(args: {\r\n  overrideName?: string;\r\n  overridePersistence?: string;\r\n  propertyName?: string;\r\n  propertyPersistence?: string;\r\n}): FormattingSpecArgs[] {\r\n  const { overrideName, overridePersistence, propertyName, propertyPersistence } = args;\r\n  const name = overrideName ?? propertyName;\r\n  const persistenceUnitName = propertyPersistence ?? overridePersistence;\r\n  const pairs: FormattingSpecArgs[] = [];\r\n  if (name && persistenceUnitName) {\r\n    pairs.push({ name, persistenceUnitName });\r\n  }\r\n\r\n  // Fall back to the property's own pair unless the pair above already is it.\r\n  if (propertyName && propertyPersistence && name !== propertyName) {\r\n    pairs.push({ name: propertyName, persistenceUnitName: propertyPersistence });\r\n  }\r\n\r\n  return pairs;\r\n}\r\n\r\n/** Builds the first [FormatterSpec]($core-quantity) that resolves for `value` among the formats\r\n * of the FormatSet named by `quantityOptions.formatSet` -- or the adopted FormatSet and schema\r\n * formats when it names none, or one that was never registered -- along with the pairs that were\r\n * tried, so the caller can report when none resolved. `ignoredPersistenceUnit` is set when the\r\n * field's `persistenceUnit` named a unit other than the property's own and was therefore not\r\n * used, so the caller can report the likely authoring mistake.\r\n * @internal\r\n */\r\nexport function lookupFieldSpec(\r\n  quantityOptions: QuantityFieldFormatOptions | undefined,\r\n  value: ResolvedFieldValue,\r\n  formatting: FieldFormatting,\r\n): { spec?: FormatterSpec, candidates: FormattingSpecArgs[], ignoredPersistenceUnit?: string } {\r\n  const overridePersistence = normalizeToSchemaName(formatting.schemaContext, quantityOptions?.persistenceUnit);\r\n  const propertyPersistence = value.persistenceUnitFullName;\r\n  const ignoredPersistenceUnit = overridePersistence && propertyPersistence && overridePersistence !== propertyPersistence\r\n    ? overridePersistence : undefined;\r\n  const candidates = collectFieldQuantityPairs({\r\n    overrideName: normalizeToSchemaName(formatting.schemaContext, quantityOptions?.kindOfQuantity),\r\n    overridePersistence,\r\n    propertyName: value.kindOfQuantityFullName,\r\n    propertyPersistence,\r\n  });\r\n  const formatSet = quantityOptions?.formatSet;\r\n  const formats = (formatSet ? formatting.formatSets.get(formatSet) : undefined) ?? formatting.defaultFormats;\r\n  for (const candidate of candidates) {\r\n    const spec = buildFieldFormatterSpec(candidate, formats, formatting);\r\n    if (spec) {\r\n      return { spec, candidates, ignoredPersistenceUnit };\r\n    }\r\n  }\r\n  return { candidates, ignoredPersistenceUnit };\r\n}\r\n"]}

package/lib/cjs/internal/annotations/fields.d.ts

@@ -1,14 +1,51 @@
-import { FieldRun, FieldValue, RelationshipProps, TextBlock } from "@itwin/core-common";
+import { FieldRun, RelationshipProps, TextBlock } from "@itwin/core-common";
 import { IModelDb } from "../../IModelDb";
 import { Id64String } from "@itwin/core-bentley";
+import { FieldFormatting, ResolvedFieldValue } from "./fieldSpecs";
 import type { EditTxn } from "../../EditTxn";
+/** The per-evaluation state [[updateField]] needs: which element's fields to recompute, how to
+ * read a field's property value, and how to format quantities.
+ */
 export interface UpdateFieldsContext {
+    /** When set, only fields whose [FieldPropertyHost.elementId]($common) matches are recomputed —
+     * an edit to one source element leaves the annotation's other fields untouched.
+     */
     readonly hostElementId: Id64String | undefined;
-    getProperty(field: FieldRun): FieldValue | undefined;
+    /** Reads the value a field points at, or `undefined` if it cannot be resolved — including
+     * every field when the source element was deleted.
+     */
+    getProperty(field: FieldRun): ResolvedFieldValue | undefined;
+    /** The formats `"quantity"` and `"coordinate"` values resolve through. [[updateField]] builds
+     * a [FormatterSpec]($core-quantity) per field from the FormatSet named by
+     * [QuantityFieldFormatOptions.formatSet]($common), falling back to the adopted FormatSet and
+     * the schemas; a value none of them can format falls back to `value.toString()`.
+     * [[createUpdateContext]] always supplies the iModel's formatting; only hand-built contexts in
+     * tests that never format a quantity leave it out.
+     */
+    readonly formatting?: FieldFormatting;
 }
 export declare function createUpdateContext(hostElementId: string | undefined, iModel: IModelDb, deleted: boolean): UpdateFieldsContext;
+/** Recomputes a single field's cached display string synchronously. Returns true iff
+ * cachedContent changed.
+ *
+ * Resolving the property value and formatting it are both fallible. A failure of either is
+ * logged and degrades *this* field to [FieldRun.invalidContentIndicator]($common); other
+ * fields in the same block are unaffected.
+ */
 export declare function updateField(field: FieldRun, context: UpdateFieldsContext): boolean;
+/** Re-evaluates every [FieldRun]($common) in `textBlock` synchronously and returns the number
+ * whose cached display string changed. Fields targeting an element other than
+ * `context.hostElementId` (when set) are skipped.
+ */
 export declare function updateFields(textBlock: TextBlock, context: UpdateFieldsContext): number;
+/** Re-evaluates the fields of the `props.targetId` annotation in response to a source-element
+ * change (`deleted=false`) or delete (`deleted=true`). Invoked from
+ * [[ElementDrivesTextAnnotation.onRootChangedArg]] / `onDeletedDependencyArg`.
+ */
 export declare function updateElementFields(props: RelationshipProps, txn: EditTxn, deleted: boolean): void;
+/** Re-evaluates every field of the given annotation element against its current property
+ * values. Invoked from [[ElementDrivesTextAnnotation.updateFieldDependencies]] when
+ * establishing / refreshing relationships.
+ */
 export declare function updateAllFields(annotationElementId: Id64String, txn: EditTxn): void;
 //# sourceMappingURL=fields.d.ts.map

package/lib/cjs/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;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"}
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../../../src/internal/annotations/fields.ts"],"names":[],"mappings":"AAKA,OAAO,EAA0C,QAAQ,EAA8E,iBAAiB,EAAE,SAAS,EAA8B,MAAM,oBAAoB,CAAC;AAC5N,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAyB,UAAU,EAAU,MAAM,qBAAqB,CAAC;AAKhF,OAAO,EAAE,eAAe,EAAuC,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACxG,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AA0B7C;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,UAAU,GAAG,SAAS,CAAC;IAE/C;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,QAAQ,GAAG,kBAAkB,GAAG,SAAS,CAAC;IAE7D;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,eAAe,CAAC;CACvC;AA+OD,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,GAAG,mBAAmB,CAM9H;AA0CD;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,mBAAmB,GAAG,OAAO,CA0BlF;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,mBAAmB,GAAG,MAAM,CASvF;AAyBD;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,iBAAiB,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAElG;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,mBAAmB,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,GAAG,IAAI,CAEnF"}