@itwin/ecschema-metadata 5.1.0-dev.55 → 5.1.0-dev.56

package/lib/cjs/SchemaFormatsProvider.d.ts

@@ -2,9 +2,8 @@
  * @module Metadata
  */
 import { ISchemaLocater, SchemaContext } from "./Context";
-import { SchemaItemFormatProps } from "./Deserialization/JsonProps";
 import { BeEvent } from "@itwin/core-bentley";
-import { FormatsChangedArgs, FormatsProvider, UnitSystemKey } from "@itwin/core-quantity";
+import { FormatDefinition, FormatsChangedArgs, FormatsProvider, UnitSystemKey } from "@itwin/core-quantity";
 /**
  * Provides default formats and kind of quantities from a given SchemaContext or SchemaLocater.
  * @beta
@@ -26,6 +25,8 @@ export declare class SchemaFormatsProvider implements FormatsProvider {
     get unitSystem(): UnitSystemKey;
     set unitSystem(unitSystem: UnitSystemKey);
     private clear;
+    /** When using a presentation unit from a KindOfQuantity, the label and description should come from the KindOfQuantity */
+    private convertToFormatDefinition;
     private getKindOfQuantityFormatFromSchema;
     /**
      * Retrieves a Format from a SchemaContext. If the format is part of a KindOfQuantity, the first presentation format in the KindOfQuantity that matches the current unit system will be retrieved.
@@ -34,6 +35,6 @@ export declare class SchemaFormatsProvider implements FormatsProvider {
      * @param name The full name of the Format or KindOfQuantity.
      * @returns
      */
-    getFormat(name: string): Promise<SchemaItemFormatProps | undefined>;
+    getFormat(name: string): Promise<FormatDefinition | undefined>;
 }
 //# sourceMappingURL=SchemaFormatsProvider.d.ts.map

package/lib/cjs/SchemaFormatsProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaFormatsProvider.d.ts","sourceRoot":"","sources":["../../src/SchemaFormatsProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAI1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,OAAO,EAAU,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EAAe,kBAAkB,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAMvG;;;GAGG;AACH,qBAAa,qBAAsB,YAAW,eAAe;IAC3D,OAAO,CAAC,QAAQ,CAAgB;IAChC,OAAO,CAAC,WAAW,CAAgB;IACnC,OAAO,CAAC,iBAAiB,CAA0B;IAC5C,gBAAgB,iBAAsB,kBAAkB,KAAK,IAAI,EAAI;IAC5E;;;;;;OAMG;gBACS,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,aAAa;IAUvE,IAAW,OAAO,kBAA4B;IAC9C,IAAW,UAAU,IAEa,aAAa,CAFK;IAEpD,IAAW,UAAU,CAAC,UAAU,EAAE,aAAa,EAG9C;IAED,OAAO,CAAC,KAAK;YAMC,iCAAiC;IAgD/C;;;;;;OAMG;IACU,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,GAAG,SAAS,CAAC;CA8BjF"}
+{"version":3,"file":"SchemaFormatsProvider.d.ts","sourceRoot":"","sources":["../../src/SchemaFormatsProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAK1D,OAAO,EAAE,OAAO,EAAU,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EAAE,gBAAgB,EAAe,kBAAkB,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAMzH;;;GAGG;AACH,qBAAa,qBAAsB,YAAW,eAAe;IAC3D,OAAO,CAAC,QAAQ,CAAgB;IAChC,OAAO,CAAC,WAAW,CAAgB;IACnC,OAAO,CAAC,iBAAiB,CAA0B;IAC5C,gBAAgB,iBAAsB,kBAAkB,KAAK,IAAI,EAAI;IAC5E;;;;;;OAMG;gBACS,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,aAAa;IAUvE,IAAW,OAAO,kBAA4B;IAC9C,IAAW,UAAU,IAEa,aAAa,CAFK;IAEpD,IAAW,UAAU,CAAC,UAAU,EAAE,aAAa,EAG9C;IAED,OAAO,CAAC,KAAK;IAMb,0HAA0H;IAC1H,OAAO,CAAC,yBAAyB;YAenB,iCAAiC;IAmD/C;;;;;;OAMG;IACU,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;CA8B5E"}

package/lib/cjs/SchemaFormatsProvider.js

@@ -53,6 +53,20 @@ class SchemaFormatsProvider {
         this._formatsRetrieved.clear();
         this.onFormatsChanged.raiseEvent({ formatsChanged });
     }
+    /** When using a presentation unit from a KindOfQuantity, the label and description should come from the KindOfQuantity */
+    convertToFormatDefinition(format, kindOfQuantity) {
+        // Destructure all properties except 'rest'
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const { name, label, description, $schema, schema, schemaVersion, schemaItemType, 
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        customAttributes, originalECSpecMajorVersion, originalECSpecMinorVersion, ...rest } = format;
+        return {
+            ...rest,
+            name: kindOfQuantity.fullName,
+            label: kindOfQuantity.label ?? format.label,
+            description: kindOfQuantity.description ?? format.description,
+        };
+    }
     async getKindOfQuantityFormatFromSchema(itemKey) {
         let kindOfQuantity;
         try {
@@ -78,7 +92,8 @@ class SchemaFormatsProvider {
                 const currentUnitSystem = await unit.unitSystem;
                 if (currentUnitSystem && matcher(currentUnitSystem)) {
                     this._formatsRetrieved.add(itemKey.fullName);
-                    return (0, OverrideFormat_1.getFormatProps)(format);
+                    const props = (0, OverrideFormat_1.getFormatProps)(format);
+                    return this.convertToFormatDefinition(props, kindOfQuantity);
                 }
             }
         }
@@ -87,14 +102,16 @@ class SchemaFormatsProvider {
         const persistenceUnitSystem = await persistenceUnit?.unitSystem;
         if (persistenceUnitSystem && unitSystemMatchers.some((matcher) => matcher(persistenceUnitSystem))) {
             this._formatsRetrieved.add(itemKey.fullName);
-            return getPersistenceUnitFormatProps(persistenceUnit);
+            const props = getPersistenceUnitFormatProps(persistenceUnit);
+            return this.convertToFormatDefinition(props, kindOfQuantity);
         }
         const defaultFormat = kindOfQuantity.defaultPresentationFormat;
         if (!defaultFormat) {
             return undefined;
         }
         this._formatsRetrieved.add(itemKey.fullName);
-        return (0, OverrideFormat_1.getFormatProps)(await defaultFormat);
+        const defaultProps = (0, OverrideFormat_1.getFormatProps)(await defaultFormat);
+        return this.convertToFormatDefinition(defaultProps, kindOfQuantity);
     }
     /**
      * Retrieves a Format from a SchemaContext. If the format is part of a KindOfQuantity, the first presentation format in the KindOfQuantity that matches the current unit system will be retrieved.

package/lib/cjs/SchemaFormatsProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaFormatsProvider.js","sourceRoot":"","sources":["../../src/SchemaFormatsProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,uCAA0D;AAC1D,2CAAuD;AACvD,sDAAmD;AACnD,8CAA2C;AAE3C,sDAAsD;AACtD,8DAA2D;AAC3D,8DAA2D;AAM3D,MAAM,cAAc,GAAG,uBAAuB,CAAC;AAC/C;;;GAGG;AACH,MAAa,qBAAqB;IACxB,QAAQ,CAAgB;IACxB,WAAW,CAAgB;IAC3B,iBAAiB,GAAgB,IAAI,GAAG,EAAE,CAAC;IAC5C,gBAAgB,GAAG,IAAI,sBAAO,EAAsC,CAAC;IAC5E;;;;;;OAMG;IACH,YAAY,gBAAgC,EAAE,UAAyB;QACrE,IAAI,gBAAgB,YAAY,uBAAa,EAAE,CAAC;YAC9C,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,IAAI,uBAAa,EAAE,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED,IAAW,OAAO,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9C,IAAW,UAAU,KAAK,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAEpD,IAAW,UAAU,CAAC,UAAyB;QAC7C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAEO,KAAK;QACX,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC1D,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC;IACvD,CAAC;IAEO,KAAK,CAAC,iCAAiC,CAAC,OAAsB;QACpE,IAAI,cAA0C,CAAC;QAC/C,IAAI,CAAC;YACH,cAAc,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,+BAAc,CAAC,CAAC;QAC9E,CAAC;QAAC,MAAM,CAAC;YACP,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,iCAAiC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;YACrF,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,4EAA4E;QAC5E,MAAM,kBAAkB,GAAG,0BAA0B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACxE,MAAM,mBAAmB,GAAG,cAAc,CAAC,mBAAmB,CAAC;QAC/D,KAAK,MAAM,OAAO,IAAI,kBAAkB,EAAE,CAAC;YACzC,KAAK,MAAM,UAAU,IAAI,mBAAmB,EAAE,CAAC;gBAC7C,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC;gBAChC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACxD,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,SAAS;gBACX,CAAC;gBACD,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;gBAChD,IAAI,iBAAiB,IAAI,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;oBACpD,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;oBAC7C,OAAO,IAAA,+BAAc,EAAC,MAAM,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC;QACH,CAAC;QAED,uGAAuG;QACvG,MAAM,eAAe,GAAG,MAAM,cAAc,CAAC,eAAe,CAAC;QAC7D,MAAM,qBAAqB,GAAG,MAAM,eAAe,EAAE,UAAU,CAAC;QAChE,IAAI,qBAAqB,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,EAAE,CAAC;YAClG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC7C,OAAO,6BAA6B,CAAC,eAAgB,CAAC,CAAC;QACzD,CAAC;QAED,MAAM,aAAa,GAAG,cAAc,CAAC,yBAAyB,CAAC;QAC/D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC7C,OAAO,IAAA,+BAAc,EAAC,MAAM,aAAa,CAAC,CAAC;IAC7C,CAAC;IAGD;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,IAAY;QACjC,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,uBAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACpE,MAAM,SAAS,GAAG,IAAI,qBAAS,CAAC,UAAU,CAAC,CAAC;QAC5C,IAAI,MAA0B,CAAC;QAC/B,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACpD,CAAC;QAAC,MAAM,CAAC;YACP,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,yBAAyB,UAAU,EAAE,CAAC,CAAC;YACvE,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,yBAAa,CAAC,cAAc,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAEpE,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,IAAI,MAA0B,CAAC;YAC/B,IAAI,CAAC;gBACH,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,eAAM,CAAC,CAAC;YAC9D,CAAC;YAAC,MAAM,CAAC;gBACP,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,yBAAyB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAC7E,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,IAAI,CAAC,iCAAiC,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AAzHD,sDAyHC;AAED,SAAS,0BAA0B,CAAC,QAAwB;IAC1D,SAAS,aAAa,CAAC,IAAuB;QAC5C,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAClD,OAAO,CAAC,UAAsB,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC5F,CAAC;IACD,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACjF,KAAK,QAAQ;YACX,OAAO,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAC3E,KAAK,aAAa;YAChB,OAAO,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACrE,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,6BAA6B,CAAC,eAAoC;IACzE,oDAAoD;IACpD,OAAO;QACL,YAAY,EAAE,CAAC,gBAAgB,EAAE,kBAAkB,EAAE,eAAe,CAAC;QACrE,SAAS,EAAE,CAAC;QACZ,IAAI,EAAE,SAAS;QACf,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,eAAe,CAAC,QAAQ;oBAC9B,KAAK,EAAE,eAAe,CAAC,KAAK;iBAC7B;aACF;SACF;KACF,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Metadata\n */\n\nimport { ISchemaLocater, SchemaContext } from \"./Context\";\nimport { SchemaItemKey, SchemaKey } from \"./SchemaKey\";\nimport { SchemaItem } from \"./Metadata/SchemaItem\";\nimport { Format } from \"./Metadata/Format\";\nimport { SchemaItemFormatProps } from \"./Deserialization/JsonProps\";\nimport { BeEvent, Logger } from \"@itwin/core-bentley\";\nimport { KindOfQuantity } from \"./Metadata/KindOfQuantity\";\nimport { getFormatProps } from \"./Metadata/OverrideFormat\";\nimport { FormatProps, FormatsChangedArgs, FormatsProvider, UnitSystemKey } from \"@itwin/core-quantity\";\nimport { Unit } from \"./Metadata/Unit\";\nimport { InvertedUnit } from \"./Metadata/InvertedUnit\";\nimport { Schema } from \"./Metadata/Schema\";\nimport { UnitSystem } from \"./Metadata/UnitSystem\";\nconst loggerCategory = \"SchemaFormatsProvider\";\n/**\n * Provides default formats and kind of quantities from a given SchemaContext or SchemaLocater.\n * @beta\n */\nexport class SchemaFormatsProvider implements FormatsProvider {\n  private _context: SchemaContext;\n  private _unitSystem: UnitSystemKey;\n  private _formatsRetrieved: Set<string> = new Set();\n  public onFormatsChanged = new BeEvent<(args: FormatsChangedArgs) => void>();\n  /**\n   *\n   * @param contextOrLocater The SchemaContext or a different ISchemaLocater implementation used to retrieve the schema. The SchemaContext\n   * class implements the ISchemaLocater interface. If the provided locater is not a SchemaContext instance a new SchemaContext will be\n   * created and the locater will be added.\n   * @param unitSystem Used to lookup a default format through a schema specific algorithm, when the format retrieved is associated with a KindOfQuantity.\n   */\n  constructor(contextOrLocater: ISchemaLocater, unitSystem: UnitSystemKey) {\n    if (contextOrLocater instanceof SchemaContext) {\n      this._context = contextOrLocater;\n    } else {\n      this._context = new SchemaContext();\n      this._context.addLocater(contextOrLocater);\n    }\n    this._unitSystem = unitSystem;\n  }\n\n  public get context() { return this._context; }\n  public get unitSystem() { return this._unitSystem; }\n\n  public set unitSystem(unitSystem: UnitSystemKey) {\n    this._unitSystem = unitSystem;\n    this.clear();\n  }\n\n  private clear(): void {\n    const formatsChanged = Array.from(this._formatsRetrieved);\n    this._formatsRetrieved.clear();\n    this.onFormatsChanged.raiseEvent({ formatsChanged });\n  }\n\n  private async getKindOfQuantityFormatFromSchema(itemKey: SchemaItemKey): Promise<SchemaItemFormatProps | undefined> {\n    let kindOfQuantity: KindOfQuantity | undefined;\n    try {\n      kindOfQuantity = await this._context.getSchemaItem(itemKey, KindOfQuantity);\n    } catch {\n      Logger.logError(loggerCategory, `Failed to find KindOfQuantity ${itemKey.fullName}`);\n      return undefined;\n    }\n\n    if (!kindOfQuantity) {\n      return undefined;\n    }\n\n    // Find the first presentation format that matches the provided unit system.\n    const unitSystemMatchers = getUnitSystemGroupMatchers(this._unitSystem);\n    const presentationFormats = kindOfQuantity.presentationFormats;\n    for (const matcher of unitSystemMatchers) {\n      for (const lazyFormat of presentationFormats) {\n        const format = await lazyFormat;\n        const unit = await (format.units && format.units[0][0]);\n        if (!unit) {\n          continue;\n        }\n        const currentUnitSystem = await unit.unitSystem;\n        if (currentUnitSystem && matcher(currentUnitSystem)) {\n          this._formatsRetrieved.add(itemKey.fullName);\n          return getFormatProps(format);\n        }\n      }\n    }\n\n    // If no matching presentation format was found, use persistence unit format if it matches unit system.\n    const persistenceUnit = await kindOfQuantity.persistenceUnit;\n    const persistenceUnitSystem = await persistenceUnit?.unitSystem;\n    if (persistenceUnitSystem && unitSystemMatchers.some((matcher) => matcher(persistenceUnitSystem))) {\n      this._formatsRetrieved.add(itemKey.fullName);\n      return getPersistenceUnitFormatProps(persistenceUnit!);\n    }\n\n    const defaultFormat = kindOfQuantity.defaultPresentationFormat;\n    if (!defaultFormat) {\n      return undefined;\n    }\n    this._formatsRetrieved.add(itemKey.fullName);\n    return getFormatProps(await defaultFormat);\n  }\n\n\n  /**\n   * Retrieves a Format from a SchemaContext. If the format is part of a KindOfQuantity, the first presentation format in the KindOfQuantity that matches the current unit system will be retrieved.\n   * If no presentation format matches the current unit system, the persistence unit format will be retrieved if it matches the current unit system.\n   * Else, the default presentation format will be retrieved.\n   * @param name The full name of the Format or KindOfQuantity.\n   * @returns\n   */\n  public async getFormat(name: string): Promise<SchemaItemFormatProps | undefined> {\n    const [schemaName, schemaItemName] = SchemaItem.parseFullName(name);\n    const schemaKey = new SchemaKey(schemaName);\n    let schema: Schema | undefined;\n    try {\n      schema = await this._context.getSchema(schemaKey);\n    } catch {\n      Logger.logError(loggerCategory, `Failed to find schema ${schemaName}`);\n      return undefined;\n    }\n    if (!schema) {\n      return undefined;\n    }\n    const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);\n\n    if (schema.name === \"Formats\") {\n      let format: Format | undefined;\n      try {\n        format = await this._context.getSchemaItem(itemKey, Format);\n      } catch {\n        Logger.logError(loggerCategory, `Failed to find Format ${itemKey.fullName}`);\n        return undefined;\n      }\n      if (!format) {\n        return undefined;\n      }\n      return format.toJSON(true);\n    }\n    return this.getKindOfQuantityFormatFromSchema(itemKey);\n  }\n}\n\nfunction getUnitSystemGroupMatchers(groupKey?: UnitSystemKey) {\n  function createMatcher(name: string | string[]) {\n    const names = Array.isArray(name) ? name : [name];\n    return (unitSystem: UnitSystem) => names.some((n) => n === unitSystem.name.toUpperCase());\n  }\n  switch (groupKey) {\n    case \"imperial\":\n      return [\"IMPERIAL\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"metric\":\n      return [[\"SI\", \"METRIC\"], \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"usCustomary\":\n      return [\"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"usSurvey\":\n      return [\"USSURVEY\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n  }\n  return [];\n}\n\nfunction getPersistenceUnitFormatProps(persistenceUnit: Unit | InvertedUnit): FormatProps {\n  // Same as Format \"DefaultRealU\" in Formats ecschema\n  return {\n    formatTraits: [\"keepSingleZero\", \"keepDecimalPoint\", \"showUnitLabel\"],\n    precision: 6,\n    type: \"Decimal\",\n    composite: {\n      units: [\n        {\n          name: persistenceUnit.fullName,\n          label: persistenceUnit.label,\n        },\n      ],\n    },\n  };\n}"]}
+{"version":3,"file":"SchemaFormatsProvider.js","sourceRoot":"","sources":["../../src/SchemaFormatsProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,uCAA0D;AAC1D,2CAAuD;AACvD,sDAAmD;AACnD,8CAA2C;AAE3C,sDAAsD;AACtD,8DAA2D;AAC3D,8DAA2D;AAM3D,MAAM,cAAc,GAAG,uBAAuB,CAAC;AAC/C;;;GAGG;AACH,MAAa,qBAAqB;IACxB,QAAQ,CAAgB;IACxB,WAAW,CAAgB;IAC3B,iBAAiB,GAAgB,IAAI,GAAG,EAAE,CAAC;IAC5C,gBAAgB,GAAG,IAAI,sBAAO,EAAsC,CAAC;IAC5E;;;;;;OAMG;IACH,YAAY,gBAAgC,EAAE,UAAyB;QACrE,IAAI,gBAAgB,YAAY,uBAAa,EAAE,CAAC;YAC9C,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,IAAI,uBAAa,EAAE,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED,IAAW,OAAO,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9C,IAAW,UAAU,KAAK,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAEpD,IAAW,UAAU,CAAC,UAAyB;QAC7C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAEO,KAAK;QACX,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC1D,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,0HAA0H;IAClH,yBAAyB,CAAC,MAA6B,EAAE,cAA8B;QAC7F,2CAA2C;QAC3C,6DAA6D;QAC7D,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,cAAc;QAC9E,6DAA6D;QAC7D,gBAAgB,EAAE,0BAA0B,EAAE,0BAA0B,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAE/F,OAAO;YACL,GAAG,IAAI;YACP,IAAI,EAAE,cAAc,CAAC,QAAQ;YAC7B,KAAK,EAAE,cAAc,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK;YAC3C,WAAW,EAAE,cAAc,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW;SAC9D,CAAA;IACH,CAAC;IAEO,KAAK,CAAC,iCAAiC,CAAC,OAAsB;QACpE,IAAI,cAA0C,CAAC;QAC/C,IAAI,CAAC;YACH,cAAc,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,+BAAc,CAAC,CAAC;QAC9E,CAAC;QAAC,MAAM,CAAC;YACP,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,iCAAiC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;YACrF,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,4EAA4E;QAC5E,MAAM,kBAAkB,GAAG,0BAA0B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACxE,MAAM,mBAAmB,GAAG,cAAc,CAAC,mBAAmB,CAAC;QAC/D,KAAK,MAAM,OAAO,IAAI,kBAAkB,EAAE,CAAC;YACzC,KAAK,MAAM,UAAU,IAAI,mBAAmB,EAAE,CAAC;gBAC7C,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC;gBAChC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACxD,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,SAAS;gBACX,CAAC;gBACD,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;gBAChD,IAAI,iBAAiB,IAAI,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;oBACpD,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;oBAC7C,MAAM,KAAK,GAAG,IAAA,+BAAc,EAAC,MAAM,CAAC,CAAC;oBACrC,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;gBAC/D,CAAC;YACH,CAAC;QACH,CAAC;QAED,uGAAuG;QACvG,MAAM,eAAe,GAAG,MAAM,cAAc,CAAC,eAAe,CAAC;QAC7D,MAAM,qBAAqB,GAAG,MAAM,eAAe,EAAE,UAAU,CAAC;QAChE,IAAI,qBAAqB,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,EAAE,CAAC;YAClG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC7C,MAAM,KAAK,GAAG,6BAA6B,CAAC,eAAgB,CAAC,CAAC;YAC9D,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,aAAa,GAAG,cAAc,CAAC,yBAAyB,CAAC;QAC/D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,YAAY,GAAG,IAAA,+BAAc,EAAC,MAAM,aAAa,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC,yBAAyB,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IACtE,CAAC;IAGD;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,IAAY;QACjC,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,uBAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACpE,MAAM,SAAS,GAAG,IAAI,qBAAS,CAAC,UAAU,CAAC,CAAC;QAC5C,IAAI,MAA0B,CAAC;QAC/B,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACpD,CAAC;QAAC,MAAM,CAAC;YACP,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,yBAAyB,UAAU,EAAE,CAAC,CAAC;YACvE,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,yBAAa,CAAC,cAAc,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAEpE,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,IAAI,MAA0B,CAAC;YAC/B,IAAI,CAAC;gBACH,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,eAAM,CAAC,CAAC;YAC9D,CAAC;YAAC,MAAM,CAAC;gBACP,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,yBAAyB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAC7E,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,IAAI,CAAC,iCAAiC,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AA5ID,sDA4IC;AAED,SAAS,0BAA0B,CAAC,QAAwB;IAC1D,SAAS,aAAa,CAAC,IAAuB;QAC5C,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAClD,OAAO,CAAC,UAAsB,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC5F,CAAC;IACD,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACjF,KAAK,QAAQ;YACX,OAAO,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAC3E,KAAK,aAAa;YAChB,OAAO,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACrE,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,6BAA6B,CAAC,eAAoC;IACzE,oDAAoD;IACpD,OAAO;QACL,YAAY,EAAE,CAAC,gBAAgB,EAAE,kBAAkB,EAAE,eAAe,CAAC;QACrE,SAAS,EAAE,CAAC;QACZ,IAAI,EAAE,SAAS;QACf,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,eAAe,CAAC,QAAQ;oBAC9B,KAAK,EAAE,eAAe,CAAC,KAAK;iBAC7B;aACF;SACF;KACF,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Metadata\n */\n\nimport { ISchemaLocater, SchemaContext } from \"./Context\";\nimport { SchemaItemKey, SchemaKey } from \"./SchemaKey\";\nimport { SchemaItem } from \"./Metadata/SchemaItem\";\nimport { Format } from \"./Metadata/Format\";\nimport { SchemaItemFormatProps } from \"./Deserialization/JsonProps\";\nimport { BeEvent, Logger } from \"@itwin/core-bentley\";\nimport { KindOfQuantity } from \"./Metadata/KindOfQuantity\";\nimport { getFormatProps } from \"./Metadata/OverrideFormat\";\nimport { FormatDefinition, FormatProps, FormatsChangedArgs, FormatsProvider, UnitSystemKey } from \"@itwin/core-quantity\";\nimport { Unit } from \"./Metadata/Unit\";\nimport { InvertedUnit } from \"./Metadata/InvertedUnit\";\nimport { Schema } from \"./Metadata/Schema\";\nimport { UnitSystem } from \"./Metadata/UnitSystem\";\nconst loggerCategory = \"SchemaFormatsProvider\";\n/**\n * Provides default formats and kind of quantities from a given SchemaContext or SchemaLocater.\n * @beta\n */\nexport class SchemaFormatsProvider implements FormatsProvider {\n  private _context: SchemaContext;\n  private _unitSystem: UnitSystemKey;\n  private _formatsRetrieved: Set<string> = new Set();\n  public onFormatsChanged = new BeEvent<(args: FormatsChangedArgs) => void>();\n  /**\n   *\n   * @param contextOrLocater The SchemaContext or a different ISchemaLocater implementation used to retrieve the schema. The SchemaContext\n   * class implements the ISchemaLocater interface. If the provided locater is not a SchemaContext instance a new SchemaContext will be\n   * created and the locater will be added.\n   * @param unitSystem Used to lookup a default format through a schema specific algorithm, when the format retrieved is associated with a KindOfQuantity.\n   */\n  constructor(contextOrLocater: ISchemaLocater, unitSystem: UnitSystemKey) {\n    if (contextOrLocater instanceof SchemaContext) {\n      this._context = contextOrLocater;\n    } else {\n      this._context = new SchemaContext();\n      this._context.addLocater(contextOrLocater);\n    }\n    this._unitSystem = unitSystem;\n  }\n\n  public get context() { return this._context; }\n  public get unitSystem() { return this._unitSystem; }\n\n  public set unitSystem(unitSystem: UnitSystemKey) {\n    this._unitSystem = unitSystem;\n    this.clear();\n  }\n\n  private clear(): void {\n    const formatsChanged = Array.from(this._formatsRetrieved);\n    this._formatsRetrieved.clear();\n    this.onFormatsChanged.raiseEvent({ formatsChanged });\n  }\n\n  /** When using a presentation unit from a KindOfQuantity, the label and description should come from the KindOfQuantity */\n  private convertToFormatDefinition(format: SchemaItemFormatProps, kindOfQuantity: KindOfQuantity): FormatDefinition {\n    // Destructure all properties except 'rest'\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    const { name, label, description, $schema, schema, schemaVersion, schemaItemType,\n      // eslint-disable-next-line @typescript-eslint/no-unused-vars\n      customAttributes, originalECSpecMajorVersion, originalECSpecMinorVersion, ...rest } = format;\n\n    return {\n      ...rest,\n      name: kindOfQuantity.fullName,\n      label: kindOfQuantity.label ?? format.label,\n      description: kindOfQuantity.description ?? format.description,\n    }\n  }\n\n  private async getKindOfQuantityFormatFromSchema(itemKey: SchemaItemKey): Promise<FormatDefinition | undefined> {\n    let kindOfQuantity: KindOfQuantity | undefined;\n    try {\n      kindOfQuantity = await this._context.getSchemaItem(itemKey, KindOfQuantity);\n    } catch {\n      Logger.logError(loggerCategory, `Failed to find KindOfQuantity ${itemKey.fullName}`);\n      return undefined;\n    }\n\n    if (!kindOfQuantity) {\n      return undefined;\n    }\n\n    // Find the first presentation format that matches the provided unit system.\n    const unitSystemMatchers = getUnitSystemGroupMatchers(this._unitSystem);\n    const presentationFormats = kindOfQuantity.presentationFormats;\n    for (const matcher of unitSystemMatchers) {\n      for (const lazyFormat of presentationFormats) {\n        const format = await lazyFormat;\n        const unit = await (format.units && format.units[0][0]);\n        if (!unit) {\n          continue;\n        }\n        const currentUnitSystem = await unit.unitSystem;\n        if (currentUnitSystem && matcher(currentUnitSystem)) {\n          this._formatsRetrieved.add(itemKey.fullName);\n          const props = getFormatProps(format);\n          return this.convertToFormatDefinition(props, kindOfQuantity);\n        }\n      }\n    }\n\n    // If no matching presentation format was found, use persistence unit format if it matches unit system.\n    const persistenceUnit = await kindOfQuantity.persistenceUnit;\n    const persistenceUnitSystem = await persistenceUnit?.unitSystem;\n    if (persistenceUnitSystem && unitSystemMatchers.some((matcher) => matcher(persistenceUnitSystem))) {\n      this._formatsRetrieved.add(itemKey.fullName);\n      const props = getPersistenceUnitFormatProps(persistenceUnit!);\n      return this.convertToFormatDefinition(props, kindOfQuantity);\n    }\n\n    const defaultFormat = kindOfQuantity.defaultPresentationFormat;\n    if (!defaultFormat) {\n      return undefined;\n    }\n    this._formatsRetrieved.add(itemKey.fullName);\n    const defaultProps = getFormatProps(await defaultFormat);\n    return this.convertToFormatDefinition(defaultProps, kindOfQuantity);\n  }\n\n\n  /**\n   * Retrieves a Format from a SchemaContext. If the format is part of a KindOfQuantity, the first presentation format in the KindOfQuantity that matches the current unit system will be retrieved.\n   * If no presentation format matches the current unit system, the persistence unit format will be retrieved if it matches the current unit system.\n   * Else, the default presentation format will be retrieved.\n   * @param name The full name of the Format or KindOfQuantity.\n   * @returns\n   */\n  public async getFormat(name: string): Promise<FormatDefinition | undefined> {\n    const [schemaName, schemaItemName] = SchemaItem.parseFullName(name);\n    const schemaKey = new SchemaKey(schemaName);\n    let schema: Schema | undefined;\n    try {\n      schema = await this._context.getSchema(schemaKey);\n    } catch {\n      Logger.logError(loggerCategory, `Failed to find schema ${schemaName}`);\n      return undefined;\n    }\n    if (!schema) {\n      return undefined;\n    }\n    const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);\n\n    if (schema.name === \"Formats\") {\n      let format: Format | undefined;\n      try {\n        format = await this._context.getSchemaItem(itemKey, Format);\n      } catch {\n        Logger.logError(loggerCategory, `Failed to find Format ${itemKey.fullName}`);\n        return undefined;\n      }\n      if (!format) {\n        return undefined;\n      }\n      return format.toJSON(true);\n    }\n    return this.getKindOfQuantityFormatFromSchema(itemKey);\n  }\n}\n\nfunction getUnitSystemGroupMatchers(groupKey?: UnitSystemKey) {\n  function createMatcher(name: string | string[]) {\n    const names = Array.isArray(name) ? name : [name];\n    return (unitSystem: UnitSystem) => names.some((n) => n === unitSystem.name.toUpperCase());\n  }\n  switch (groupKey) {\n    case \"imperial\":\n      return [\"IMPERIAL\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"metric\":\n      return [[\"SI\", \"METRIC\"], \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"usCustomary\":\n      return [\"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"usSurvey\":\n      return [\"USSURVEY\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n  }\n  return [];\n}\n\nfunction getPersistenceUnitFormatProps(persistenceUnit: Unit | InvertedUnit): FormatProps {\n  // Same as Format \"DefaultRealU\" in Formats ecschema\n  return {\n    formatTraits: [\"keepSingleZero\", \"keepDecimalPoint\", \"showUnitLabel\"],\n    precision: 6,\n    type: \"Decimal\",\n    composite: {\n      units: [\n        {\n          name: persistenceUnit.fullName,\n          label: persistenceUnit.label,\n        },\n      ],\n    },\n  };\n}"]}

package/lib/esm/SchemaFormatsProvider.d.ts

@@ -2,9 +2,8 @@
  * @module Metadata
  */
 import { ISchemaLocater, SchemaContext } from "./Context";
-import { SchemaItemFormatProps } from "./Deserialization/JsonProps";
 import { BeEvent } from "@itwin/core-bentley";
-import { FormatsChangedArgs, FormatsProvider, UnitSystemKey } from "@itwin/core-quantity";
+import { FormatDefinition, FormatsChangedArgs, FormatsProvider, UnitSystemKey } from "@itwin/core-quantity";
 /**
  * Provides default formats and kind of quantities from a given SchemaContext or SchemaLocater.
  * @beta
@@ -26,6 +25,8 @@ export declare class SchemaFormatsProvider implements FormatsProvider {
     get unitSystem(): UnitSystemKey;
     set unitSystem(unitSystem: UnitSystemKey);
     private clear;
+    /** When using a presentation unit from a KindOfQuantity, the label and description should come from the KindOfQuantity */
+    private convertToFormatDefinition;
     private getKindOfQuantityFormatFromSchema;
     /**
      * Retrieves a Format from a SchemaContext. If the format is part of a KindOfQuantity, the first presentation format in the KindOfQuantity that matches the current unit system will be retrieved.
@@ -34,6 +35,6 @@ export declare class SchemaFormatsProvider implements FormatsProvider {
      * @param name The full name of the Format or KindOfQuantity.
      * @returns
      */
-    getFormat(name: string): Promise<SchemaItemFormatProps | undefined>;
+    getFormat(name: string): Promise<FormatDefinition | undefined>;
 }
 //# sourceMappingURL=SchemaFormatsProvider.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SchemaFormatsProvider.d.ts","sourceRoot":"","sources":["../../src/SchemaFormatsProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAI1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,OAAO,EAAU,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EAAe,kBAAkB,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAMvG;;;GAGG;AACH,qBAAa,qBAAsB,YAAW,eAAe;IAC3D,OAAO,CAAC,QAAQ,CAAgB;IAChC,OAAO,CAAC,WAAW,CAAgB;IACnC,OAAO,CAAC,iBAAiB,CAA0B;IAC5C,gBAAgB,iBAAsB,kBAAkB,KAAK,IAAI,EAAI;IAC5E;;;;;;OAMG;gBACS,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,aAAa;IAUvE,IAAW,OAAO,kBAA4B;IAC9C,IAAW,UAAU,IAEa,aAAa,CAFK;IAEpD,IAAW,UAAU,CAAC,UAAU,EAAE,aAAa,EAG9C;IAED,OAAO,CAAC,KAAK;YAMC,iCAAiC;IAgD/C;;;;;;OAMG;IACU,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,GAAG,SAAS,CAAC;CA8BjF"}
+{"version":3,"file":"SchemaFormatsProvider.d.ts","sourceRoot":"","sources":["../../src/SchemaFormatsProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAK1D,OAAO,EAAE,OAAO,EAAU,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EAAE,gBAAgB,EAAe,kBAAkB,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAMzH;;;GAGG;AACH,qBAAa,qBAAsB,YAAW,eAAe;IAC3D,OAAO,CAAC,QAAQ,CAAgB;IAChC,OAAO,CAAC,WAAW,CAAgB;IACnC,OAAO,CAAC,iBAAiB,CAA0B;IAC5C,gBAAgB,iBAAsB,kBAAkB,KAAK,IAAI,EAAI;IAC5E;;;;;;OAMG;gBACS,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,aAAa;IAUvE,IAAW,OAAO,kBAA4B;IAC9C,IAAW,UAAU,IAEa,aAAa,CAFK;IAEpD,IAAW,UAAU,CAAC,UAAU,EAAE,aAAa,EAG9C;IAED,OAAO,CAAC,KAAK;IAMb,0HAA0H;IAC1H,OAAO,CAAC,yBAAyB;YAenB,iCAAiC;IAmD/C;;;;;;OAMG;IACU,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;CA8B5E"}

package/lib/esm/SchemaFormatsProvider.js

@@ -50,6 +50,20 @@ export class SchemaFormatsProvider {
         this._formatsRetrieved.clear();
         this.onFormatsChanged.raiseEvent({ formatsChanged });
     }
+    /** When using a presentation unit from a KindOfQuantity, the label and description should come from the KindOfQuantity */
+    convertToFormatDefinition(format, kindOfQuantity) {
+        // Destructure all properties except 'rest'
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const { name, label, description, $schema, schema, schemaVersion, schemaItemType, 
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        customAttributes, originalECSpecMajorVersion, originalECSpecMinorVersion, ...rest } = format;
+        return {
+            ...rest,
+            name: kindOfQuantity.fullName,
+            label: kindOfQuantity.label ?? format.label,
+            description: kindOfQuantity.description ?? format.description,
+        };
+    }
     async getKindOfQuantityFormatFromSchema(itemKey) {
         let kindOfQuantity;
         try {
@@ -75,7 +89,8 @@ export class SchemaFormatsProvider {
                 const currentUnitSystem = await unit.unitSystem;
                 if (currentUnitSystem && matcher(currentUnitSystem)) {
                     this._formatsRetrieved.add(itemKey.fullName);
-                    return getFormatProps(format);
+                    const props = getFormatProps(format);
+                    return this.convertToFormatDefinition(props, kindOfQuantity);
                 }
             }
         }
@@ -84,14 +99,16 @@ export class SchemaFormatsProvider {
         const persistenceUnitSystem = await persistenceUnit?.unitSystem;
         if (persistenceUnitSystem && unitSystemMatchers.some((matcher) => matcher(persistenceUnitSystem))) {
             this._formatsRetrieved.add(itemKey.fullName);
-            return getPersistenceUnitFormatProps(persistenceUnit);
+            const props = getPersistenceUnitFormatProps(persistenceUnit);
+            return this.convertToFormatDefinition(props, kindOfQuantity);
         }
         const defaultFormat = kindOfQuantity.defaultPresentationFormat;
         if (!defaultFormat) {
             return undefined;
         }
         this._formatsRetrieved.add(itemKey.fullName);
-        return getFormatProps(await defaultFormat);
+        const defaultProps = getFormatProps(await defaultFormat);
+        return this.convertToFormatDefinition(defaultProps, kindOfQuantity);
     }
     /**
      * Retrieves a Format from a SchemaContext. If the format is part of a KindOfQuantity, the first presentation format in the KindOfQuantity that matches the current unit system will be retrieved.

package/lib/esm/SchemaFormatsProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaFormatsProvider.js","sourceRoot":"","sources":["../../src/SchemaFormatsProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAkB,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAM3D,MAAM,cAAc,GAAG,uBAAuB,CAAC;AAC/C;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IACxB,QAAQ,CAAgB;IACxB,WAAW,CAAgB;IAC3B,iBAAiB,GAAgB,IAAI,GAAG,EAAE,CAAC;IAC5C,gBAAgB,GAAG,IAAI,OAAO,EAAsC,CAAC;IAC5E;;;;;;OAMG;IACH,YAAY,gBAAgC,EAAE,UAAyB;QACrE,IAAI,gBAAgB,YAAY,aAAa,EAAE,CAAC;YAC9C,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED,IAAW,OAAO,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9C,IAAW,UAAU,KAAK,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAEpD,IAAW,UAAU,CAAC,UAAyB;QAC7C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAEO,KAAK;QACX,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC1D,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC;IACvD,CAAC;IAEO,KAAK,CAAC,iCAAiC,CAAC,OAAsB;QACpE,IAAI,cAA0C,CAAC;QAC/C,IAAI,CAAC;YACH,cAAc,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QAC9E,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,iCAAiC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;YACrF,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,4EAA4E;QAC5E,MAAM,kBAAkB,GAAG,0BAA0B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACxE,MAAM,mBAAmB,GAAG,cAAc,CAAC,mBAAmB,CAAC;QAC/D,KAAK,MAAM,OAAO,IAAI,kBAAkB,EAAE,CAAC;YACzC,KAAK,MAAM,UAAU,IAAI,mBAAmB,EAAE,CAAC;gBAC7C,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC;gBAChC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACxD,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,SAAS;gBACX,CAAC;gBACD,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;gBAChD,IAAI,iBAAiB,IAAI,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;oBACpD,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;oBAC7C,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC;QACH,CAAC;QAED,uGAAuG;QACvG,MAAM,eAAe,GAAG,MAAM,cAAc,CAAC,eAAe,CAAC;QAC7D,MAAM,qBAAqB,GAAG,MAAM,eAAe,EAAE,UAAU,CAAC;QAChE,IAAI,qBAAqB,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,EAAE,CAAC;YAClG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC7C,OAAO,6BAA6B,CAAC,eAAgB,CAAC,CAAC;QACzD,CAAC;QAED,MAAM,aAAa,GAAG,cAAc,CAAC,yBAAyB,CAAC;QAC/D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC7C,OAAO,cAAc,CAAC,MAAM,aAAa,CAAC,CAAC;IAC7C,CAAC;IAGD;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,IAAY;QACjC,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACpE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;QAC5C,IAAI,MAA0B,CAAC;QAC/B,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACpD,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,yBAAyB,UAAU,EAAE,CAAC,CAAC;YACvE,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,cAAc,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAEpE,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,IAAI,MAA0B,CAAC;YAC/B,IAAI,CAAC;gBACH,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC9D,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,yBAAyB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAC7E,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,IAAI,CAAC,iCAAiC,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AAED,SAAS,0BAA0B,CAAC,QAAwB;IAC1D,SAAS,aAAa,CAAC,IAAuB;QAC5C,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAClD,OAAO,CAAC,UAAsB,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC5F,CAAC;IACD,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACjF,KAAK,QAAQ;YACX,OAAO,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAC3E,KAAK,aAAa;YAChB,OAAO,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACrE,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,6BAA6B,CAAC,eAAoC;IACzE,oDAAoD;IACpD,OAAO;QACL,YAAY,EAAE,CAAC,gBAAgB,EAAE,kBAAkB,EAAE,eAAe,CAAC;QACrE,SAAS,EAAE,CAAC;QACZ,IAAI,EAAE,SAAS;QACf,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,eAAe,CAAC,QAAQ;oBAC9B,KAAK,EAAE,eAAe,CAAC,KAAK;iBAC7B;aACF;SACF;KACF,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Metadata\n */\n\nimport { ISchemaLocater, SchemaContext } from \"./Context\";\nimport { SchemaItemKey, SchemaKey } from \"./SchemaKey\";\nimport { SchemaItem } from \"./Metadata/SchemaItem\";\nimport { Format } from \"./Metadata/Format\";\nimport { SchemaItemFormatProps } from \"./Deserialization/JsonProps\";\nimport { BeEvent, Logger } from \"@itwin/core-bentley\";\nimport { KindOfQuantity } from \"./Metadata/KindOfQuantity\";\nimport { getFormatProps } from \"./Metadata/OverrideFormat\";\nimport { FormatProps, FormatsChangedArgs, FormatsProvider, UnitSystemKey } from \"@itwin/core-quantity\";\nimport { Unit } from \"./Metadata/Unit\";\nimport { InvertedUnit } from \"./Metadata/InvertedUnit\";\nimport { Schema } from \"./Metadata/Schema\";\nimport { UnitSystem } from \"./Metadata/UnitSystem\";\nconst loggerCategory = \"SchemaFormatsProvider\";\n/**\n * Provides default formats and kind of quantities from a given SchemaContext or SchemaLocater.\n * @beta\n */\nexport class SchemaFormatsProvider implements FormatsProvider {\n  private _context: SchemaContext;\n  private _unitSystem: UnitSystemKey;\n  private _formatsRetrieved: Set<string> = new Set();\n  public onFormatsChanged = new BeEvent<(args: FormatsChangedArgs) => void>();\n  /**\n   *\n   * @param contextOrLocater The SchemaContext or a different ISchemaLocater implementation used to retrieve the schema. The SchemaContext\n   * class implements the ISchemaLocater interface. If the provided locater is not a SchemaContext instance a new SchemaContext will be\n   * created and the locater will be added.\n   * @param unitSystem Used to lookup a default format through a schema specific algorithm, when the format retrieved is associated with a KindOfQuantity.\n   */\n  constructor(contextOrLocater: ISchemaLocater, unitSystem: UnitSystemKey) {\n    if (contextOrLocater instanceof SchemaContext) {\n      this._context = contextOrLocater;\n    } else {\n      this._context = new SchemaContext();\n      this._context.addLocater(contextOrLocater);\n    }\n    this._unitSystem = unitSystem;\n  }\n\n  public get context() { return this._context; }\n  public get unitSystem() { return this._unitSystem; }\n\n  public set unitSystem(unitSystem: UnitSystemKey) {\n    this._unitSystem = unitSystem;\n    this.clear();\n  }\n\n  private clear(): void {\n    const formatsChanged = Array.from(this._formatsRetrieved);\n    this._formatsRetrieved.clear();\n    this.onFormatsChanged.raiseEvent({ formatsChanged });\n  }\n\n  private async getKindOfQuantityFormatFromSchema(itemKey: SchemaItemKey): Promise<SchemaItemFormatProps | undefined> {\n    let kindOfQuantity: KindOfQuantity | undefined;\n    try {\n      kindOfQuantity = await this._context.getSchemaItem(itemKey, KindOfQuantity);\n    } catch {\n      Logger.logError(loggerCategory, `Failed to find KindOfQuantity ${itemKey.fullName}`);\n      return undefined;\n    }\n\n    if (!kindOfQuantity) {\n      return undefined;\n    }\n\n    // Find the first presentation format that matches the provided unit system.\n    const unitSystemMatchers = getUnitSystemGroupMatchers(this._unitSystem);\n    const presentationFormats = kindOfQuantity.presentationFormats;\n    for (const matcher of unitSystemMatchers) {\n      for (const lazyFormat of presentationFormats) {\n        const format = await lazyFormat;\n        const unit = await (format.units && format.units[0][0]);\n        if (!unit) {\n          continue;\n        }\n        const currentUnitSystem = await unit.unitSystem;\n        if (currentUnitSystem && matcher(currentUnitSystem)) {\n          this._formatsRetrieved.add(itemKey.fullName);\n          return getFormatProps(format);\n        }\n      }\n    }\n\n    // If no matching presentation format was found, use persistence unit format if it matches unit system.\n    const persistenceUnit = await kindOfQuantity.persistenceUnit;\n    const persistenceUnitSystem = await persistenceUnit?.unitSystem;\n    if (persistenceUnitSystem && unitSystemMatchers.some((matcher) => matcher(persistenceUnitSystem))) {\n      this._formatsRetrieved.add(itemKey.fullName);\n      return getPersistenceUnitFormatProps(persistenceUnit!);\n    }\n\n    const defaultFormat = kindOfQuantity.defaultPresentationFormat;\n    if (!defaultFormat) {\n      return undefined;\n    }\n    this._formatsRetrieved.add(itemKey.fullName);\n    return getFormatProps(await defaultFormat);\n  }\n\n\n  /**\n   * Retrieves a Format from a SchemaContext. If the format is part of a KindOfQuantity, the first presentation format in the KindOfQuantity that matches the current unit system will be retrieved.\n   * If no presentation format matches the current unit system, the persistence unit format will be retrieved if it matches the current unit system.\n   * Else, the default presentation format will be retrieved.\n   * @param name The full name of the Format or KindOfQuantity.\n   * @returns\n   */\n  public async getFormat(name: string): Promise<SchemaItemFormatProps | undefined> {\n    const [schemaName, schemaItemName] = SchemaItem.parseFullName(name);\n    const schemaKey = new SchemaKey(schemaName);\n    let schema: Schema | undefined;\n    try {\n      schema = await this._context.getSchema(schemaKey);\n    } catch {\n      Logger.logError(loggerCategory, `Failed to find schema ${schemaName}`);\n      return undefined;\n    }\n    if (!schema) {\n      return undefined;\n    }\n    const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);\n\n    if (schema.name === \"Formats\") {\n      let format: Format | undefined;\n      try {\n        format = await this._context.getSchemaItem(itemKey, Format);\n      } catch {\n        Logger.logError(loggerCategory, `Failed to find Format ${itemKey.fullName}`);\n        return undefined;\n      }\n      if (!format) {\n        return undefined;\n      }\n      return format.toJSON(true);\n    }\n    return this.getKindOfQuantityFormatFromSchema(itemKey);\n  }\n}\n\nfunction getUnitSystemGroupMatchers(groupKey?: UnitSystemKey) {\n  function createMatcher(name: string | string[]) {\n    const names = Array.isArray(name) ? name : [name];\n    return (unitSystem: UnitSystem) => names.some((n) => n === unitSystem.name.toUpperCase());\n  }\n  switch (groupKey) {\n    case \"imperial\":\n      return [\"IMPERIAL\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"metric\":\n      return [[\"SI\", \"METRIC\"], \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"usCustomary\":\n      return [\"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"usSurvey\":\n      return [\"USSURVEY\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n  }\n  return [];\n}\n\nfunction getPersistenceUnitFormatProps(persistenceUnit: Unit | InvertedUnit): FormatProps {\n  // Same as Format \"DefaultRealU\" in Formats ecschema\n  return {\n    formatTraits: [\"keepSingleZero\", \"keepDecimalPoint\", \"showUnitLabel\"],\n    precision: 6,\n    type: \"Decimal\",\n    composite: {\n      units: [\n        {\n          name: persistenceUnit.fullName,\n          label: persistenceUnit.label,\n        },\n      ],\n    },\n  };\n}"]}
+{"version":3,"file":"SchemaFormatsProvider.js","sourceRoot":"","sources":["../../src/SchemaFormatsProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAkB,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAM3D,MAAM,cAAc,GAAG,uBAAuB,CAAC;AAC/C;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IACxB,QAAQ,CAAgB;IACxB,WAAW,CAAgB;IAC3B,iBAAiB,GAAgB,IAAI,GAAG,EAAE,CAAC;IAC5C,gBAAgB,GAAG,IAAI,OAAO,EAAsC,CAAC;IAC5E;;;;;;OAMG;IACH,YAAY,gBAAgC,EAAE,UAAyB;QACrE,IAAI,gBAAgB,YAAY,aAAa,EAAE,CAAC;YAC9C,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED,IAAW,OAAO,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9C,IAAW,UAAU,KAAK,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAEpD,IAAW,UAAU,CAAC,UAAyB;QAC7C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAEO,KAAK;QACX,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC1D,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,0HAA0H;IAClH,yBAAyB,CAAC,MAA6B,EAAE,cAA8B;QAC7F,2CAA2C;QAC3C,6DAA6D;QAC7D,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,cAAc;QAC9E,6DAA6D;QAC7D,gBAAgB,EAAE,0BAA0B,EAAE,0BAA0B,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAE/F,OAAO;YACL,GAAG,IAAI;YACP,IAAI,EAAE,cAAc,CAAC,QAAQ;YAC7B,KAAK,EAAE,cAAc,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK;YAC3C,WAAW,EAAE,cAAc,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW;SAC9D,CAAA;IACH,CAAC;IAEO,KAAK,CAAC,iCAAiC,CAAC,OAAsB;QACpE,IAAI,cAA0C,CAAC;QAC/C,IAAI,CAAC;YACH,cAAc,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QAC9E,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,iCAAiC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;YACrF,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,4EAA4E;QAC5E,MAAM,kBAAkB,GAAG,0BAA0B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACxE,MAAM,mBAAmB,GAAG,cAAc,CAAC,mBAAmB,CAAC;QAC/D,KAAK,MAAM,OAAO,IAAI,kBAAkB,EAAE,CAAC;YACzC,KAAK,MAAM,UAAU,IAAI,mBAAmB,EAAE,CAAC;gBAC7C,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC;gBAChC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACxD,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,SAAS;gBACX,CAAC;gBACD,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;gBAChD,IAAI,iBAAiB,IAAI,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;oBACpD,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;oBAC7C,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;oBACrC,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;gBAC/D,CAAC;YACH,CAAC;QACH,CAAC;QAED,uGAAuG;QACvG,MAAM,eAAe,GAAG,MAAM,cAAc,CAAC,eAAe,CAAC;QAC7D,MAAM,qBAAqB,GAAG,MAAM,eAAe,EAAE,UAAU,CAAC;QAChE,IAAI,qBAAqB,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,EAAE,CAAC;YAClG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC7C,MAAM,KAAK,GAAG,6BAA6B,CAAC,eAAgB,CAAC,CAAC;YAC9D,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,aAAa,GAAG,cAAc,CAAC,yBAAyB,CAAC;QAC/D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,YAAY,GAAG,cAAc,CAAC,MAAM,aAAa,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC,yBAAyB,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IACtE,CAAC;IAGD;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,IAAY;QACjC,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACpE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;QAC5C,IAAI,MAA0B,CAAC;QAC/B,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACpD,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,yBAAyB,UAAU,EAAE,CAAC,CAAC;YACvE,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,cAAc,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAEpE,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,IAAI,MAA0B,CAAC;YAC/B,IAAI,CAAC;gBACH,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC9D,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,yBAAyB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAC7E,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,IAAI,CAAC,iCAAiC,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AAED,SAAS,0BAA0B,CAAC,QAAwB;IAC1D,SAAS,aAAa,CAAC,IAAuB;QAC5C,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAClD,OAAO,CAAC,UAAsB,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC5F,CAAC;IACD,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACjF,KAAK,QAAQ;YACX,OAAO,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAC3E,KAAK,aAAa;YAChB,OAAO,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACrE,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,6BAA6B,CAAC,eAAoC;IACzE,oDAAoD;IACpD,OAAO;QACL,YAAY,EAAE,CAAC,gBAAgB,EAAE,kBAAkB,EAAE,eAAe,CAAC;QACrE,SAAS,EAAE,CAAC;QACZ,IAAI,EAAE,SAAS;QACf,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,eAAe,CAAC,QAAQ;oBAC9B,KAAK,EAAE,eAAe,CAAC,KAAK;iBAC7B;aACF;SACF;KACF,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Metadata\n */\n\nimport { ISchemaLocater, SchemaContext } from \"./Context\";\nimport { SchemaItemKey, SchemaKey } from \"./SchemaKey\";\nimport { SchemaItem } from \"./Metadata/SchemaItem\";\nimport { Format } from \"./Metadata/Format\";\nimport { SchemaItemFormatProps } from \"./Deserialization/JsonProps\";\nimport { BeEvent, Logger } from \"@itwin/core-bentley\";\nimport { KindOfQuantity } from \"./Metadata/KindOfQuantity\";\nimport { getFormatProps } from \"./Metadata/OverrideFormat\";\nimport { FormatDefinition, FormatProps, FormatsChangedArgs, FormatsProvider, UnitSystemKey } from \"@itwin/core-quantity\";\nimport { Unit } from \"./Metadata/Unit\";\nimport { InvertedUnit } from \"./Metadata/InvertedUnit\";\nimport { Schema } from \"./Metadata/Schema\";\nimport { UnitSystem } from \"./Metadata/UnitSystem\";\nconst loggerCategory = \"SchemaFormatsProvider\";\n/**\n * Provides default formats and kind of quantities from a given SchemaContext or SchemaLocater.\n * @beta\n */\nexport class SchemaFormatsProvider implements FormatsProvider {\n  private _context: SchemaContext;\n  private _unitSystem: UnitSystemKey;\n  private _formatsRetrieved: Set<string> = new Set();\n  public onFormatsChanged = new BeEvent<(args: FormatsChangedArgs) => void>();\n  /**\n   *\n   * @param contextOrLocater The SchemaContext or a different ISchemaLocater implementation used to retrieve the schema. The SchemaContext\n   * class implements the ISchemaLocater interface. If the provided locater is not a SchemaContext instance a new SchemaContext will be\n   * created and the locater will be added.\n   * @param unitSystem Used to lookup a default format through a schema specific algorithm, when the format retrieved is associated with a KindOfQuantity.\n   */\n  constructor(contextOrLocater: ISchemaLocater, unitSystem: UnitSystemKey) {\n    if (contextOrLocater instanceof SchemaContext) {\n      this._context = contextOrLocater;\n    } else {\n      this._context = new SchemaContext();\n      this._context.addLocater(contextOrLocater);\n    }\n    this._unitSystem = unitSystem;\n  }\n\n  public get context() { return this._context; }\n  public get unitSystem() { return this._unitSystem; }\n\n  public set unitSystem(unitSystem: UnitSystemKey) {\n    this._unitSystem = unitSystem;\n    this.clear();\n  }\n\n  private clear(): void {\n    const formatsChanged = Array.from(this._formatsRetrieved);\n    this._formatsRetrieved.clear();\n    this.onFormatsChanged.raiseEvent({ formatsChanged });\n  }\n\n  /** When using a presentation unit from a KindOfQuantity, the label and description should come from the KindOfQuantity */\n  private convertToFormatDefinition(format: SchemaItemFormatProps, kindOfQuantity: KindOfQuantity): FormatDefinition {\n    // Destructure all properties except 'rest'\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    const { name, label, description, $schema, schema, schemaVersion, schemaItemType,\n      // eslint-disable-next-line @typescript-eslint/no-unused-vars\n      customAttributes, originalECSpecMajorVersion, originalECSpecMinorVersion, ...rest } = format;\n\n    return {\n      ...rest,\n      name: kindOfQuantity.fullName,\n      label: kindOfQuantity.label ?? format.label,\n      description: kindOfQuantity.description ?? format.description,\n    }\n  }\n\n  private async getKindOfQuantityFormatFromSchema(itemKey: SchemaItemKey): Promise<FormatDefinition | undefined> {\n    let kindOfQuantity: KindOfQuantity | undefined;\n    try {\n      kindOfQuantity = await this._context.getSchemaItem(itemKey, KindOfQuantity);\n    } catch {\n      Logger.logError(loggerCategory, `Failed to find KindOfQuantity ${itemKey.fullName}`);\n      return undefined;\n    }\n\n    if (!kindOfQuantity) {\n      return undefined;\n    }\n\n    // Find the first presentation format that matches the provided unit system.\n    const unitSystemMatchers = getUnitSystemGroupMatchers(this._unitSystem);\n    const presentationFormats = kindOfQuantity.presentationFormats;\n    for (const matcher of unitSystemMatchers) {\n      for (const lazyFormat of presentationFormats) {\n        const format = await lazyFormat;\n        const unit = await (format.units && format.units[0][0]);\n        if (!unit) {\n          continue;\n        }\n        const currentUnitSystem = await unit.unitSystem;\n        if (currentUnitSystem && matcher(currentUnitSystem)) {\n          this._formatsRetrieved.add(itemKey.fullName);\n          const props = getFormatProps(format);\n          return this.convertToFormatDefinition(props, kindOfQuantity);\n        }\n      }\n    }\n\n    // If no matching presentation format was found, use persistence unit format if it matches unit system.\n    const persistenceUnit = await kindOfQuantity.persistenceUnit;\n    const persistenceUnitSystem = await persistenceUnit?.unitSystem;\n    if (persistenceUnitSystem && unitSystemMatchers.some((matcher) => matcher(persistenceUnitSystem))) {\n      this._formatsRetrieved.add(itemKey.fullName);\n      const props = getPersistenceUnitFormatProps(persistenceUnit!);\n      return this.convertToFormatDefinition(props, kindOfQuantity);\n    }\n\n    const defaultFormat = kindOfQuantity.defaultPresentationFormat;\n    if (!defaultFormat) {\n      return undefined;\n    }\n    this._formatsRetrieved.add(itemKey.fullName);\n    const defaultProps = getFormatProps(await defaultFormat);\n    return this.convertToFormatDefinition(defaultProps, kindOfQuantity);\n  }\n\n\n  /**\n   * Retrieves a Format from a SchemaContext. If the format is part of a KindOfQuantity, the first presentation format in the KindOfQuantity that matches the current unit system will be retrieved.\n   * If no presentation format matches the current unit system, the persistence unit format will be retrieved if it matches the current unit system.\n   * Else, the default presentation format will be retrieved.\n   * @param name The full name of the Format or KindOfQuantity.\n   * @returns\n   */\n  public async getFormat(name: string): Promise<FormatDefinition | undefined> {\n    const [schemaName, schemaItemName] = SchemaItem.parseFullName(name);\n    const schemaKey = new SchemaKey(schemaName);\n    let schema: Schema | undefined;\n    try {\n      schema = await this._context.getSchema(schemaKey);\n    } catch {\n      Logger.logError(loggerCategory, `Failed to find schema ${schemaName}`);\n      return undefined;\n    }\n    if (!schema) {\n      return undefined;\n    }\n    const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);\n\n    if (schema.name === \"Formats\") {\n      let format: Format | undefined;\n      try {\n        format = await this._context.getSchemaItem(itemKey, Format);\n      } catch {\n        Logger.logError(loggerCategory, `Failed to find Format ${itemKey.fullName}`);\n        return undefined;\n      }\n      if (!format) {\n        return undefined;\n      }\n      return format.toJSON(true);\n    }\n    return this.getKindOfQuantityFormatFromSchema(itemKey);\n  }\n}\n\nfunction getUnitSystemGroupMatchers(groupKey?: UnitSystemKey) {\n  function createMatcher(name: string | string[]) {\n    const names = Array.isArray(name) ? name : [name];\n    return (unitSystem: UnitSystem) => names.some((n) => n === unitSystem.name.toUpperCase());\n  }\n  switch (groupKey) {\n    case \"imperial\":\n      return [\"IMPERIAL\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"metric\":\n      return [[\"SI\", \"METRIC\"], \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"usCustomary\":\n      return [\"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"usSurvey\":\n      return [\"USSURVEY\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n  }\n  return [];\n}\n\nfunction getPersistenceUnitFormatProps(persistenceUnit: Unit | InvertedUnit): FormatProps {\n  // Same as Format \"DefaultRealU\" in Formats ecschema\n  return {\n    formatTraits: [\"keepSingleZero\", \"keepDecimalPoint\", \"showUnitLabel\"],\n    precision: 6,\n    type: \"Decimal\",\n    composite: {\n      units: [\n        {\n          name: persistenceUnit.fullName,\n          label: persistenceUnit.label,\n        },\n      ],\n    },\n  };\n}"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/ecschema-metadata",
-  "version": "5.1.0-dev.55",
+  "version": "5.1.0-dev.56",
   "description": "ECObjects core concepts in typescript",
   "license": "MIT",
   "main": "lib/cjs/ecschema-metadata.js",
@@ -48,13 +48,13 @@
     "rimraf": "^6.0.1",
     "sinon": "^17.0.2",
     "typescript": "~5.6.2",
-    "@itwin/build-tools": "5.1.0-dev.55",
-    "@itwin/core-bentley": "5.1.0-dev.55",
-    "@itwin/core-quantity": "5.1.0-dev.55"
+    "@itwin/build-tools": "5.1.0-dev.56",
+    "@itwin/core-quantity": "5.1.0-dev.56",
+    "@itwin/core-bentley": "5.1.0-dev.56"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "5.1.0-dev.55",
-    "@itwin/core-quantity": "5.1.0-dev.55"
+    "@itwin/core-bentley": "5.1.0-dev.56",
+    "@itwin/core-quantity": "5.1.0-dev.56"
   },
   "nyc": {
     "extends": "./node_modules/@itwin/build-tools/.nycrc"