@itwin/ecschema-metadata 5.14.0-dev.21 → 5.14.0-dev.23

package/lib/cjs/ECName.d.ts

@@ -25,6 +25,10 @@ export declare class ECName {
      * @throws ECSchemaError if `input` is an empty string.
      */
     static encode(input: string): ECName;
+    /** Decode EC name escape sequences without requiring a valid EC identifier.
+     * @internal
+     */
+    static decode(name: string): string;
     /** Decode this ECName, replacing encoded special characters with the characters they encode. */
     decode(): string;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"ECName.d.ts","sourceRoot":"","sources":["../../src/ECName.ts"],"names":[],"mappings":"AAIA;;GAEG;AAmBH;;;;;;;;;GASG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,KAAK,CAAS;IAEtB;;OAEG;gBACS,IAAI,EAAE,MAAM;IAOxB,sEAAsE;WACxD,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI7C,uCAAuC;IACvC,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;WACW,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAiC3C,gGAAgG;IACzF,MAAM,IAAI,MAAM;CAGxB"}
+{"version":3,"file":"ECName.d.ts","sourceRoot":"","sources":["../../src/ECName.ts"],"names":[],"mappings":"AAIA;;GAEG;AAmBH;;;;;;;;;GASG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,KAAK,CAAS;IAEtB;;OAEG;gBACS,IAAI,EAAE,MAAM;IAOxB,sEAAsE;WACxD,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI7C,uCAAuC;IACvC,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;WACW,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAiC3C;;OAEG;WACW,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAO1C,gGAAgG;IACzF,MAAM,IAAI,MAAM;CAGxB"}

package/lib/cjs/ECName.js

@@ -78,9 +78,17 @@ class ECName {
         }
         return new ECName(output);
     }
+    /** Decode EC name escape sequences without requiring a valid EC identifier.
+     * @internal
+     */
+    static decode(name) {
+        if (!name.includes("__x"))
+            return name;
+        return name.replace(ecNameReplacerRegex, (_match, hex) => String.fromCharCode(Number.parseInt(hex, 16)));
+    }
     /** Decode this ECName, replacing encoded special characters with the characters they encode. */
     decode() {
-        return this.name.replace(ecNameReplacerRegex, (_match, hex) => String.fromCharCode(Number.parseInt(hex, 16)));
+        return ECName.decode(this.name);
     }
 }
 exports.ECName = ECName;

package/lib/cjs/ECName.js.map

@@ -1 +1 @@
-{"version":3,"file":"ECName.js","sourceRoot":"","sources":["../../src/ECName.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,2CAA4D;AAE5D,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AAC3C,MAAM,mBAAmB,GAAG,wBAAwB,CAAC;AACrD,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;AAErD,SAAS,OAAO,CAAC,SAAiB;IAChC,IAAA,qBAAM,EAAC,CAAC,KAAK,SAAS,CAAC,MAAM,CAAC,CAAC;IAC/B,OAAO,SAAS,IAAI,GAAG,IAAI,SAAS,IAAI,GAAG,CAAC;AAC9C,CAAC;AAED,SAAS,4BAA4B,CAAC,CAAS;IAC7C,IAAA,qBAAM,EAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC;IACvB,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;AACrG,CAAC;AAED;;;;;;;;;GASG;AACH,MAAa,MAAM;IACT,KAAK,CAAS;IAEtB;;OAEG;IACH,YAAY,IAAY;QACtB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACxB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,CAAC,CAAC;QAExD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,sEAAsE;IAC/D,MAAM,CAAC,QAAQ,CAAC,IAAY;QACjC,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED,uCAAuC;IACvC,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,KAAa;QAChC,IAAI,CAAC,KAAK,KAAK,CAAC,MAAM;YACpB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,CAAC,CAAC;QAExD,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,gCAAgC;YAChC,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QAED,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,SAAS,sBAAsB,CAAC,KAAa;YAC3C,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;YAC/D,IAAA,qBAAM,EAAC,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACzC,MAAM,IAAI,MAAM,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC;QACtD,CAAC;QAED,qCAAqC;QACrC,MAAM,gBAAgB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,IAAI,gBAAgB;YAClB,sBAAsB,CAAC,CAAC,CAAC,CAAC;QAE5B,KAAK,IAAI,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7D,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC;gBACrC,sBAAsB,CAAC,CAAC,CAAC,CAAC;;gBAE1B,MAAM,IAAI,IAAI,CAAC;QACnB,CAAC;QAED,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC;IAED,gGAAgG;IACzF,MAAM;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAChH,CAAC;CACF;AA/DD,wBA+DC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\nimport { assert } from \"@itwin/core-bentley\";\r\nimport { ECSchemaError, ECSchemaStatus } from \"./Exception\";\r\n\r\nconst validECNameRegex = /^[a-zA-Z_]\\w*$/i;\r\nconst ecNameReplacerRegex = /__x([0-9a-fA-F]{4})__/g;\r\nconst leadingDigits = [\"0000\", \"000\", \"00\", \"0\", \"\"];\r\n\r\nfunction isDigit(character: string): boolean {\r\n  assert(1 === character.length);\r\n  return character >= \"0\" && character <= \"9\";\r\n}\r\n\r\nfunction isValidAlphaNumericCharacter(c: string): boolean {\r\n  assert(1 === c.length);\r\n  return (((c >= \"0\" && c <= \"9\") || (c >= \"A\" && c <= \"Z\") || (c >= \"a\" && c <= \"z\") || c === \"_\"));\r\n}\r\n\r\n/** The name of an item in a [[Schema]], encoded to meet restrictions on the characters usable in such names.\r\n * An ECName meets the following criteria:\r\n *  - Contains at least one character.\r\n *  - Does not begin with a digit.\r\n *  - Consists entirely of characters in the ASCII ranges A-Z, a-z, and 0-9; and the underscore (\"_\") character.\r\n *\r\n * All characters not meeting the above criteria are encoded as \"__x####__\" where \"####\" is the UTF-16 character code.\r\n * Such names are often automatically generated from the item's display label, which is unrestricted in the characters it may contain.\r\n * @public\r\n */\r\nexport class ECName {\r\n  private _name: string;\r\n\r\n  /** Construct a new ECName from a valid EC name.\r\n   * throws ECSchemaError if `name` does not meet the criteria for a valid EC name.\r\n   */\r\n  constructor(name: string) {\r\n    if (!ECName.validate(name))\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidECName);\r\n\r\n    this._name = name;\r\n  }\r\n\r\n  /** Returns true if a string meets the criteria of a valid EC name. */\r\n  public static validate(name: string): boolean {\r\n    return validECNameRegex.test(name);\r\n  }\r\n\r\n  /** The underlying name as a string. */\r\n  public get name(): string {\r\n    return this._name;\r\n  }\r\n\r\n  /** Create an ECName from an arbitrary string, encoding any special characters as \"__x####__\" where \"####\" is the UTF-16 character code.\r\n   * @throws ECSchemaError if `input` is an empty string.\r\n   */\r\n  public static encode(input: string): ECName {\r\n    if (0 === input.length)\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidECName);\r\n\r\n    if (ECName.validate(input)) {\r\n      // It's already a valid EC name.\r\n      return new ECName(input);\r\n    }\r\n\r\n    let output = \"\";\r\n\r\n    function appendEncodedCharacter(index: number): void {\r\n      const hex = input.charCodeAt(index).toString(16).toUpperCase();\r\n      assert(hex.length > 0 && hex.length < 5);\r\n      output += `__x${leadingDigits[hex.length]}${hex}__`;\r\n    }\r\n\r\n    // First character cannot be a digit.\r\n    const firstCharIsDigit = isDigit(input[0]);\r\n    if (firstCharIsDigit)\r\n      appendEncodedCharacter(0);\r\n\r\n    for (let i = firstCharIsDigit ? 1 : 0; i < input.length; i++) {\r\n      const char = input[i];\r\n      if (!isValidAlphaNumericCharacter(char))\r\n        appendEncodedCharacter(i);\r\n      else\r\n        output += char;\r\n    }\r\n\r\n    return new ECName(output);\r\n  }\r\n\r\n  /** Decode this ECName, replacing encoded special characters with the characters they encode. */\r\n  public decode(): string {\r\n    return this.name.replace(ecNameReplacerRegex, (_match, hex) => String.fromCharCode(Number.parseInt(hex, 16)));\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ECName.js","sourceRoot":"","sources":["../../src/ECName.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,2CAA4D;AAE5D,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AAC3C,MAAM,mBAAmB,GAAG,wBAAwB,CAAC;AACrD,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;AAErD,SAAS,OAAO,CAAC,SAAiB;IAChC,IAAA,qBAAM,EAAC,CAAC,KAAK,SAAS,CAAC,MAAM,CAAC,CAAC;IAC/B,OAAO,SAAS,IAAI,GAAG,IAAI,SAAS,IAAI,GAAG,CAAC;AAC9C,CAAC;AAED,SAAS,4BAA4B,CAAC,CAAS;IAC7C,IAAA,qBAAM,EAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC;IACvB,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;AACrG,CAAC;AAED;;;;;;;;;GASG;AACH,MAAa,MAAM;IACT,KAAK,CAAS;IAEtB;;OAEG;IACH,YAAY,IAAY;QACtB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACxB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,CAAC,CAAC;QAExD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,sEAAsE;IAC/D,MAAM,CAAC,QAAQ,CAAC,IAAY;QACjC,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED,uCAAuC;IACvC,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,KAAa;QAChC,IAAI,CAAC,KAAK,KAAK,CAAC,MAAM;YACpB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,CAAC,CAAC;QAExD,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,gCAAgC;YAChC,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QAED,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,SAAS,sBAAsB,CAAC,KAAa;YAC3C,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;YAC/D,IAAA,qBAAM,EAAC,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACzC,MAAM,IAAI,MAAM,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC;QACtD,CAAC;QAED,qCAAqC;QACrC,MAAM,gBAAgB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,IAAI,gBAAgB;YAClB,sBAAsB,CAAC,CAAC,CAAC,CAAC;QAE5B,KAAK,IAAI,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7D,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC;gBACrC,sBAAsB,CAAC,CAAC,CAAC,CAAC;;gBAE1B,MAAM,IAAI,IAAI,CAAC;QACnB,CAAC;QAED,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,IAAY;QAC/B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;YACvB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,CAAC,MAAM,EAAE,GAAW,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IACnH,CAAC;IAED,gGAAgG;IACzF,MAAM;QACX,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;CACF;AAzED,wBAyEC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\nimport { assert } from \"@itwin/core-bentley\";\r\nimport { ECSchemaError, ECSchemaStatus } from \"./Exception\";\r\n\r\nconst validECNameRegex = /^[a-zA-Z_]\\w*$/i;\r\nconst ecNameReplacerRegex = /__x([0-9a-fA-F]{4})__/g;\r\nconst leadingDigits = [\"0000\", \"000\", \"00\", \"0\", \"\"];\r\n\r\nfunction isDigit(character: string): boolean {\r\n  assert(1 === character.length);\r\n  return character >= \"0\" && character <= \"9\";\r\n}\r\n\r\nfunction isValidAlphaNumericCharacter(c: string): boolean {\r\n  assert(1 === c.length);\r\n  return (((c >= \"0\" && c <= \"9\") || (c >= \"A\" && c <= \"Z\") || (c >= \"a\" && c <= \"z\") || c === \"_\"));\r\n}\r\n\r\n/** The name of an item in a [[Schema]], encoded to meet restrictions on the characters usable in such names.\r\n * An ECName meets the following criteria:\r\n *  - Contains at least one character.\r\n *  - Does not begin with a digit.\r\n *  - Consists entirely of characters in the ASCII ranges A-Z, a-z, and 0-9; and the underscore (\"_\") character.\r\n *\r\n * All characters not meeting the above criteria are encoded as \"__x####__\" where \"####\" is the UTF-16 character code.\r\n * Such names are often automatically generated from the item's display label, which is unrestricted in the characters it may contain.\r\n * @public\r\n */\r\nexport class ECName {\r\n  private _name: string;\r\n\r\n  /** Construct a new ECName from a valid EC name.\r\n   * throws ECSchemaError if `name` does not meet the criteria for a valid EC name.\r\n   */\r\n  constructor(name: string) {\r\n    if (!ECName.validate(name))\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidECName);\r\n\r\n    this._name = name;\r\n  }\r\n\r\n  /** Returns true if a string meets the criteria of a valid EC name. */\r\n  public static validate(name: string): boolean {\r\n    return validECNameRegex.test(name);\r\n  }\r\n\r\n  /** The underlying name as a string. */\r\n  public get name(): string {\r\n    return this._name;\r\n  }\r\n\r\n  /** Create an ECName from an arbitrary string, encoding any special characters as \"__x####__\" where \"####\" is the UTF-16 character code.\r\n   * @throws ECSchemaError if `input` is an empty string.\r\n   */\r\n  public static encode(input: string): ECName {\r\n    if (0 === input.length)\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidECName);\r\n\r\n    if (ECName.validate(input)) {\r\n      // It's already a valid EC name.\r\n      return new ECName(input);\r\n    }\r\n\r\n    let output = \"\";\r\n\r\n    function appendEncodedCharacter(index: number): void {\r\n      const hex = input.charCodeAt(index).toString(16).toUpperCase();\r\n      assert(hex.length > 0 && hex.length < 5);\r\n      output += `__x${leadingDigits[hex.length]}${hex}__`;\r\n    }\r\n\r\n    // First character cannot be a digit.\r\n    const firstCharIsDigit = isDigit(input[0]);\r\n    if (firstCharIsDigit)\r\n      appendEncodedCharacter(0);\r\n\r\n    for (let i = firstCharIsDigit ? 1 : 0; i < input.length; i++) {\r\n      const char = input[i];\r\n      if (!isValidAlphaNumericCharacter(char))\r\n        appendEncodedCharacter(i);\r\n      else\r\n        output += char;\r\n    }\r\n\r\n    return new ECName(output);\r\n  }\r\n\r\n  /** Decode EC name escape sequences without requiring a valid EC identifier.\r\n   * @internal\r\n   */\r\n  public static decode(name: string): string {\r\n    if (!name.includes(\"__x\"))\r\n      return name;\r\n\r\n    return name.replace(ecNameReplacerRegex, (_match, hex: string) => String.fromCharCode(Number.parseInt(hex, 16)));\r\n  }\r\n\r\n  /** Decode this ECName, replacing encoded special characters with the characters they encode. */\r\n  public decode(): string {\r\n    return ECName.decode(this.name);\r\n  }\r\n}\r\n"]}

package/lib/cjs/Formatting/FormatSetFormatsProvider.d.ts

@@ -1,12 +1,12 @@
 import { BeEvent } from "@itwin/core-bentley";
-import { FormatDefinition, FormatsChangedArgs, FormatsProvider, MutableFormatsProvider, UnitSystemKey } from "@itwin/core-quantity";
+import { FormatDefinition, FormatsChangedArgs, FormatsProvider, FormatsProviderContext, MutableFormatsProvider, SyncFormatsProvider, UnitSystemKey } from "@itwin/core-quantity";
 import { FormatSet } from "../Deserialization/JsonProps";
 /**
  * A mutable format provider that manages format definitions within a format set.
  * When formats are added or removed, the underlying format set is automatically updated.
  * @beta
  */
-export declare class FormatSetFormatsProvider implements MutableFormatsProvider {
+export declare class FormatSetFormatsProvider implements MutableFormatsProvider, SyncFormatsProvider {
     onFormatsChanged: BeEvent<(args: FormatsChangedArgs) => void>;
     private _formatSet;
     private _fallbackProvider?;
@@ -26,17 +26,25 @@ export declare class FormatSetFormatsProvider implements MutableFormatsProvider
      */
     clearFallbackProvider(): void;
     /**
-     * Retrieves a format definition by its name from the format set. If not found, it checks the fallback provider to find the format, else returns undefined.
-     * If the format is a string reference to another format, it resolves the reference and returns the FormatDefinition.
+     * Retrieves a format definition from the format set, resolving string references and consulting the fallback provider when needed.
      */
-    getFormat(input: string, system?: UnitSystemKey): Promise<FormatDefinition | undefined>;
+    getFormat(input: string, system?: UnitSystemKey, context?: FormatsProviderContext): Promise<FormatDefinition | undefined>;
+    private getFormatFromFallback;
+    /**
+     * Retrieves a format definition from the format set without awaiting a provider. String references are resolved
+     * locally; a fallback is used only when it implements `SyncFormatsProvider`.
+     */
+    getFormatSync(input: string, system?: UnitSystemKey, context?: FormatsProviderContext): FormatDefinition | undefined;
+    private getFormatSyncFromFallback;
     /**
      * Resolves a string reference to its FormatDefinition, following chains of references.
      * @param reference The string reference to resolve
      * @param visited Set of visited references to detect circular references
      * @param system Optional unit system override
+     * @param context Lookup context to forward to the fallback provider
      */
     private resolveReference;
+    private resolveReferenceSync;
     /**
      * Removes a format definition or string reference from the format set.
      * @param name The name of the format to remove

package/lib/cjs/Formatting/FormatSetFormatsProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FormatSetFormatsProvider.d.ts","sourceRoot":"","sources":["../../../src/Formatting/FormatSetFormatsProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,eAAe,EAAE,sBAAsB,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACpI,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAGzD;;;;GAIG;AACH,qBAAa,wBAAyB,YAAW,sBAAsB;IAC9D,gBAAgB,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE,kBAAkB,KAAK,IAAI,CAAC,CAAqD;IAEzH,OAAO,CAAC,UAAU,CAAY;IAC9B,OAAO,CAAC,iBAAiB,CAAC,CAAkB;IAC5C,OAAO,CAAC,WAAW,CAAsB;gBAEtB,KAAK,EAAE;QAAC,SAAS,EAAE,SAAS,CAAC;QAAC,gBAAgB,CAAC,EAAE,eAAe,CAAA;KAAC;IAapF;;;;OAIG;IACU,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBtF;;OAEG;IACI,qBAAqB,IAAI,IAAI;IAIpC;;;OAGG;IACU,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAmBpG;;;;;OAKG;YACW,gBAAgB;IAwB9B;;;OAGG;IACU,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAWtD;;;;OAIG;IACH,OAAO,CAAC,2BAA2B;CAiBpC"}
+{"version":3,"file":"FormatSetFormatsProvider.d.ts","sourceRoot":"","sources":["../../../src/Formatting/FormatSetFormatsProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,eAAe,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACjL,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAGzD;;;;GAIG;AACH,qBAAa,wBAAyB,YAAW,sBAAsB,EAAE,mBAAmB;IACnF,gBAAgB,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE,kBAAkB,KAAK,IAAI,CAAC,CAAqD;IAEzH,OAAO,CAAC,UAAU,CAAY;IAC9B,OAAO,CAAC,iBAAiB,CAAC,CAAkB;IAC5C,OAAO,CAAC,WAAW,CAAsB;gBAEtB,KAAK,EAAE;QAAC,SAAS,EAAE,SAAS,CAAC;QAAC,gBAAgB,CAAC,EAAE,eAAe,CAAA;KAAC;IAapF;;;;OAIG;IACU,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBtF;;OAEG;IACI,qBAAqB,IAAI,IAAI;IAIpC;;OAEG;IACU,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;YAiBxH,qBAAqB;IAOnC;;;OAGG;IACI,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,gBAAgB,GAAG,SAAS;IAiB3H,OAAO,CAAC,yBAAyB;IAKjC;;;;;;OAMG;YACW,gBAAgB;IAkB9B,OAAO,CAAC,oBAAoB;IAiB5B;;;OAGG;IACU,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAWtD;;;;OAIG;IACH,OAAO,CAAC,2BAA2B;CAiBpC"}

package/lib/cjs/Formatting/FormatSetFormatsProvider.js

@@ -50,48 +50,79 @@ class FormatSetFormatsProvider {
         this._fallbackProvider = undefined;
     }
     /**
-     * Retrieves a format definition by its name from the format set. If not found, it checks the fallback provider to find the format, else returns undefined.
-     * If the format is a string reference to another format, it resolves the reference and returns the FormatDefinition.
+     * Retrieves a format definition from the format set, resolving string references and consulting the fallback provider when needed.
      */
-    async getFormat(input, system) {
-        // Normalizes any schemaItem names coming from node addon 'schemaName:schemaItemName' -> 'schemaName.schemaItemName'
-        const [schemaName, itemName] = SchemaItem_1.SchemaItem.parseFullName(input);
-        const name = (schemaName === "") ? itemName : `${schemaName}.${itemName}`;
+    async getFormat(input, system, context) {
+        const lookupContext = extendProviderContext(context, this);
+        if (!lookupContext)
+            return undefined;
+        const name = normalizeFormatName(input);
         const format = this._formatSet.formats[name];
         if (format !== undefined) {
-            // If format is a string reference, resolve it
-            if (typeof format === "string") {
-                return this.resolveReference(format, undefined, system);
-            }
+            if (typeof format === "string")
+                return this.resolveReference(format, new Set(), system, lookupContext);
             return format;
         }
-        if (this._fallbackProvider)
-            return this._fallbackProvider.getFormat(name, system);
-        return undefined;
+        return this.getFormatFromFallback(name, system, lookupContext);
+    }
+    async getFormatFromFallback(name, system, context) {
+        const fallbackProvider = this._fallbackProvider;
+        if (!fallbackProvider)
+            return undefined;
+        return fallbackProvider.getFormat(name, system, context);
+    }
+    /**
+     * Retrieves a format definition from the format set without awaiting a provider. String references are resolved
+     * locally; a fallback is used only when it implements `SyncFormatsProvider`.
+     */
+    getFormatSync(input, system, context) {
+        const lookupContext = extendProviderContext(context, this);
+        if (!lookupContext)
+            return undefined;
+        const name = normalizeFormatName(input);
+        const format = this._formatSet.formats[name];
+        if (format !== undefined) {
+            if (typeof format === "string")
+                return this.resolveReferenceSync(format, new Set(), system, lookupContext);
+            return format;
+        }
+        return this.getFormatSyncFromFallback(name, system, lookupContext);
+    }
+    getFormatSyncFromFallback(name, system, context) {
+        const fallbackProvider = this._fallbackProvider;
+        return typeof fallbackProvider?.getFormatSync === "function" ? fallbackProvider.getFormatSync(name, system, context) : undefined;
     }
     /**
      * Resolves a string reference to its FormatDefinition, following chains of references.
      * @param reference The string reference to resolve
      * @param visited Set of visited references to detect circular references
      * @param system Optional unit system override
+     * @param context Lookup context to forward to the fallback provider
      */
-    async resolveReference(reference, visited = new Set(), system) {
+    async resolveReference(reference, visited, system, context) {
         // Prevent infinite loops from circular references
         if (visited.has(reference)) {
             return undefined;
         }
         visited.add(reference);
         const format = this._formatSet.formats[reference];
-        if (format === undefined) {
-            if (this._fallbackProvider) {
-                return this._fallbackProvider.getFormat(reference, system);
-            }
+        if (format === undefined)
+            return this.getFormatFromFallback(reference, system, context);
+        if (typeof format === "string")
+            return this.resolveReference(format, visited, system, context);
+        return format;
+    }
+    resolveReferenceSync(reference, visited, system, context) {
+        // Prevent infinite loops from circular references
+        if (visited.has(reference)) {
             return undefined;
         }
-        // If we found another string reference, resolve it recursively
-        if (typeof format === "string") {
-            return this.resolveReference(format, visited, system);
-        }
+        visited.add(reference);
+        const format = this._formatSet.formats[reference];
+        if (format === undefined)
+            return this.getFormatSyncFromFallback(reference, system, context);
+        if (typeof format === "string")
+            return this.resolveReferenceSync(format, visited, system, context);
         return format;
     }
     /**
@@ -128,4 +159,16 @@ class FormatSetFormatsProvider {
     }
 }
 exports.FormatSetFormatsProvider = FormatSetFormatsProvider;
+function extendProviderContext(context, provider) {
+    const providerChain = new Set(context?.providerChain);
+    if (providerChain.has(provider))
+        return undefined;
+    providerChain.add(provider);
+    return { providerChain };
+}
+function normalizeFormatName(input) {
+    // Convert node-addon names from `schemaName:schemaItemName` to the dot-separated key used by FormatSet.
+    const [schemaName, itemName] = SchemaItem_1.SchemaItem.parseFullName(input);
+    return schemaName === "" ? itemName : `${schemaName}.${itemName}`;
+}
 //# sourceMappingURL=FormatSetFormatsProvider.js.map

package/lib/cjs/Formatting/FormatSetFormatsProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"FormatSetFormatsProvider.js","sourceRoot":"","sources":["../../../src/Formatting/FormatSetFormatsProvider.ts"],"names":[],"mappings":";;;AAAA,sDAA8C;AAG9C,uDAAoD;AAEpD;;;;GAIG;AACH,MAAa,wBAAwB;IAC5B,gBAAgB,GAAgD,IAAI,sBAAO,EAAsC,CAAC;IAEjH,UAAU,CAAY;IACtB,iBAAiB,CAAmB;IACpC,WAAW,CAAsB,CAAC,iDAAiD;IAE3F,YAAmB,KAAiE;QAClF,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAChD,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;QAE7C,wCAAwC;QACxC,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrE,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC/B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,IAAY,EAAE,MAAiC;QACpE,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;QAEvC,4BAA4B;QAC5B,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACrC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;QAED,0EAA0E;QAC1E,MAAM,eAAe,GAAG,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;QAC/D,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,4BAA4B;QAEvD,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACI,qBAAqB;QAC1B,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;IACrC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS,CAAC,KAAa,EAAE,MAAsB;QAC1D,oHAAoH;QACpH,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,GAAG,uBAAU,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAE/D,MAAM,IAAI,GAAG,CAAC,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,UAAU,IAAI,QAAQ,EAAE,CAAC;QAC1E,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAE7C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,8CAA8C;YAC9C,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC/B,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;YAC1D,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,IAAI,CAAC,iBAAiB;YAAE,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAClF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,gBAAgB,CAAC,SAAiB,EAAE,UAAuB,IAAI,GAAG,EAAE,EAAE,MAAsB;QACxG,kDAAkD;QAClD,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;YAC3B,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAEvB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAElD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBAC3B,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YAC7D,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,+DAA+D;QAC/D,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QACxD,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,IAAY;QACpC,0EAA0E;QAC1E,MAAM,eAAe,GAAG,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;QAC/D,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,4BAA4B;QAEvD,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAE9B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;OAIG;IACK,2BAA2B,CAAC,MAAc;QAChD,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAU,CAAC;QAE7C,sDAAsD;QACtD,KAAK,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC;YACjE,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;gBACzB,kBAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBACnC,sDAAsD;gBACtD,MAAM,kBAAkB,GAAG,IAAI,CAAC,2BAA2B,CAAC,UAAU,CAAC,CAAC;gBACxE,KAAK,MAAM,WAAW,IAAI,kBAAkB,EAAE,CAAC;oBAC7C,kBAAkB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;gBACtC,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,kBAAkB,CAAC;IAC5B,CAAC;CACF;AA3ID,4DA2IC","sourcesContent":["import { BeEvent } from \"@itwin/core-bentley\";\r\nimport { FormatDefinition, FormatsChangedArgs, FormatsProvider, MutableFormatsProvider, UnitSystemKey } from \"@itwin/core-quantity\";\r\nimport { FormatSet } from \"../Deserialization/JsonProps\";\r\nimport { SchemaItem } from \"../Metadata/SchemaItem\";\r\n\r\n/**\r\n * A mutable format provider that manages format definitions within a format set.\r\n * When formats are added or removed, the underlying format set is automatically updated.\r\n * @beta\r\n */\r\nexport class FormatSetFormatsProvider implements MutableFormatsProvider {\r\n  public onFormatsChanged: BeEvent<(args: FormatsChangedArgs) => void> = new BeEvent<(args: FormatsChangedArgs) => void>();\r\n\r\n  private _formatSet: FormatSet;\r\n  private _fallbackProvider?: FormatsProvider;\r\n  private _references: Map<string, string>; // Maps format name to the reference it points to\r\n\r\n  public constructor(props: {formatSet: FormatSet, fallbackProvider?: FormatsProvider}) {\r\n    this._formatSet = props.formatSet;\r\n    this._fallbackProvider = props.fallbackProvider;\r\n    this._references = new Map<string, string>();\r\n\r\n    // Build up the map of string references\r\n    for (const [name, format] of Object.entries(this._formatSet.formats)) {\r\n      if (typeof format === \"string\") {\r\n        this._references.set(name, format);\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Adds or updates the format definition returned for a kind of quantity.  Takes either a format definition or a kind of quantity full name that will be used to lookup the format that will be used.\r\n   * @param name A kind of quantity full name used as a key to lookup this format\r\n   * @param format The format definition or the name of a kind of quantity\r\n   */\r\n  public async addFormat(name: string, format: FormatDefinition | string): Promise<void> {\r\n    this._formatSet.formats[name] = format;\r\n\r\n    // Update the references map\r\n    if (typeof format === \"string\") {\r\n      this._references.set(name, format);\r\n    } else {\r\n      this._references.delete(name);\r\n    }\r\n\r\n    // Collect all formats that reference this format (directly or indirectly)\r\n    const affectedFormats = this.getFormatsReferencingTarget(name);\r\n    affectedFormats.add(name); // Include the format itself\r\n\r\n    this.onFormatsChanged.raiseEvent({ formatsChanged: Array.from(affectedFormats) });\r\n  }\r\n\r\n  /**\r\n   * Clears the fallback provider, if one is set.\r\n   */\r\n  public clearFallbackProvider(): void {\r\n    this._fallbackProvider = undefined;\r\n  }\r\n\r\n  /**\r\n   * Retrieves a format definition by its name from the format set. If not found, it checks the fallback provider to find the format, else returns undefined.\r\n   * If the format is a string reference to another format, it resolves the reference and returns the FormatDefinition.\r\n   */\r\n  public async getFormat(input: string, system?: UnitSystemKey): Promise<FormatDefinition | undefined> {\r\n    // Normalizes any schemaItem names coming from node addon 'schemaName:schemaItemName' -> 'schemaName.schemaItemName'\r\n    const [schemaName, itemName] = SchemaItem.parseFullName(input);\r\n\r\n    const name = (schemaName === \"\") ? itemName : `${schemaName}.${itemName}`;\r\n    const format = this._formatSet.formats[name];\r\n\r\n    if (format !== undefined) {\r\n      // If format is a string reference, resolve it\r\n      if (typeof format === \"string\") {\r\n        return this.resolveReference(format, undefined, system);\r\n      }\r\n      return format;\r\n    }\r\n\r\n    if (this._fallbackProvider) return this._fallbackProvider.getFormat(name, system);\r\n    return undefined;\r\n  }\r\n\r\n  /**\r\n   * Resolves a string reference to its FormatDefinition, following chains of references.\r\n   * @param reference The string reference to resolve\r\n   * @param visited Set of visited references to detect circular references\r\n   * @param system Optional unit system override\r\n   */\r\n  private async resolveReference(reference: string, visited: Set<string> = new Set(), system?: UnitSystemKey): Promise<FormatDefinition | undefined> {\r\n    // Prevent infinite loops from circular references\r\n    if (visited.has(reference)) {\r\n      return undefined;\r\n    }\r\n    visited.add(reference);\r\n\r\n    const format = this._formatSet.formats[reference];\r\n\r\n    if (format === undefined) {\r\n      if (this._fallbackProvider) {\r\n        return this._fallbackProvider.getFormat(reference, system);\r\n      }\r\n      return undefined;\r\n    }\r\n\r\n    // If we found another string reference, resolve it recursively\r\n    if (typeof format === \"string\") {\r\n      return this.resolveReference(format, visited, system);\r\n    }\r\n\r\n    return format;\r\n  }\r\n\r\n  /**\r\n   * Removes a format definition or string reference from the format set.\r\n   * @param name The name of the format to remove\r\n   */\r\n  public async removeFormat(name: string): Promise<void> {\r\n    // Collect all formats that reference this format (directly or indirectly)\r\n    const affectedFormats = this.getFormatsReferencingTarget(name);\r\n    affectedFormats.add(name); // Include the format itself\r\n\r\n    delete this._formatSet.formats[name];\r\n    this._references.delete(name);\r\n\r\n    this.onFormatsChanged.raiseEvent({ formatsChanged: Array.from(affectedFormats) });\r\n  }\r\n\r\n  /**\r\n   * Gets all format names that reference the target format (directly or indirectly).\r\n   * @param target The format name to find references to\r\n   * @returns Set of format names that reference the target\r\n   */\r\n  private getFormatsReferencingTarget(target: string): Set<string> {\r\n    const referencingFormats = new Set<string>();\r\n\r\n    // Find all formats that directly reference the target\r\n    for (const [formatName, reference] of this._references.entries()) {\r\n      if (reference === target) {\r\n        referencingFormats.add(formatName);\r\n        // Recursively find formats that reference this format\r\n        const indirectReferences = this.getFormatsReferencingTarget(formatName);\r\n        for (const indirectRef of indirectReferences) {\r\n          referencingFormats.add(indirectRef);\r\n        }\r\n      }\r\n    }\r\n\r\n    return referencingFormats;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"FormatSetFormatsProvider.js","sourceRoot":"","sources":["../../../src/Formatting/FormatSetFormatsProvider.ts"],"names":[],"mappings":";;;AAAA,sDAA8C;AAG9C,uDAAoD;AAEpD;;;;GAIG;AACH,MAAa,wBAAwB;IAC5B,gBAAgB,GAAgD,IAAI,sBAAO,EAAsC,CAAC;IAEjH,UAAU,CAAY;IACtB,iBAAiB,CAAmB;IACpC,WAAW,CAAsB,CAAC,iDAAiD;IAE3F,YAAmB,KAAiE;QAClF,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAChD,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;QAE7C,wCAAwC;QACxC,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrE,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC/B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,IAAY,EAAE,MAAiC;QACpE,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;QAEvC,4BAA4B;QAC5B,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACrC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;QAED,0EAA0E;QAC1E,MAAM,eAAe,GAAG,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;QAC/D,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,4BAA4B;QAEvD,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACI,qBAAqB;QAC1B,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;IACrC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CAAC,KAAa,EAAE,MAAsB,EAAE,OAAgC;QAC5F,MAAM,aAAa,GAAG,qBAAqB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3D,IAAI,CAAC,aAAa;YAChB,OAAO,SAAS,CAAC;QAEnB,MAAM,IAAI,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAE7C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,IAAI,OAAO,MAAM,KAAK,QAAQ;gBAC5B,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;YACzE,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,OAAO,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IACjE,CAAC;IAEO,KAAK,CAAC,qBAAqB,CAAC,IAAY,EAAE,MAAiC,EAAE,OAA+B;QAClH,MAAM,gBAAgB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAChD,IAAI,CAAC,gBAAgB;YACnB,OAAO,SAAS,CAAC;QACnB,OAAO,gBAAgB,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,KAAa,EAAE,MAAsB,EAAE,OAAgC;QAC1F,MAAM,aAAa,GAAG,qBAAqB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3D,IAAI,CAAC,aAAa;YAChB,OAAO,SAAS,CAAC;QAEnB,MAAM,IAAI,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAE7C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,IAAI,OAAO,MAAM,KAAK,QAAQ;gBAC5B,OAAO,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;YAC7E,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,OAAO,IAAI,CAAC,yBAAyB,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IACrE,CAAC;IAEO,yBAAyB,CAAC,IAAY,EAAE,MAAiC,EAAE,OAA+B;QAChH,MAAM,gBAAgB,GAAiE,IAAI,CAAC,iBAAiB,CAAC;QAC9G,OAAO,OAAO,gBAAgB,EAAE,aAAa,KAAK,UAAU,CAAC,CAAC,CAAC,gBAAgB,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACnI,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,gBAAgB,CAAC,SAAiB,EAAE,OAAoB,EAAE,MAAiC,EAAE,OAA+B;QACxI,kDAAkD;QAClD,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;YAC3B,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAEvB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAElD,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,IAAI,CAAC,qBAAqB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAEhE,IAAI,OAAO,MAAM,KAAK,QAAQ;YAC5B,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAEjE,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,oBAAoB,CAAC,SAAiB,EAAE,OAAoB,EAAE,MAAiC,EAAE,OAA+B;QACtI,kDAAkD;QAClD,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;YAC3B,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAEvB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,IAAI,CAAC,yBAAyB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAEpE,IAAI,OAAO,MAAM,KAAK,QAAQ;YAC5B,OAAO,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAErE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,IAAY;QACpC,0EAA0E;QAC1E,MAAM,eAAe,GAAG,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;QAC/D,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,4BAA4B;QAEvD,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAE9B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;OAIG;IACK,2BAA2B,CAAC,MAAc;QAChD,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAU,CAAC;QAE7C,sDAAsD;QACtD,KAAK,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC;YACjE,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;gBACzB,kBAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBACnC,sDAAsD;gBACtD,MAAM,kBAAkB,GAAG,IAAI,CAAC,2BAA2B,CAAC,UAAU,CAAC,CAAC;gBACxE,KAAK,MAAM,WAAW,IAAI,kBAAkB,EAAE,CAAC;oBAC7C,kBAAkB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;gBACtC,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,kBAAkB,CAAC;IAC5B,CAAC;CACF;AArLD,4DAqLC;AAED,SAAS,qBAAqB,CAAC,OAA2C,EAAE,QAAyB;IACnG,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IACtD,IAAI,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC;QAC7B,OAAO,SAAS,CAAC;IAEnB,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5B,OAAO,EAAE,aAAa,EAAE,CAAC;AAC3B,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAa;IACxC,wGAAwG;IACxG,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,GAAG,uBAAU,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC/D,OAAO,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,UAAU,IAAI,QAAQ,EAAE,CAAC;AACpE,CAAC","sourcesContent":["import { BeEvent } from \"@itwin/core-bentley\";\r\nimport { FormatDefinition, FormatsChangedArgs, FormatsProvider, FormatsProviderContext, MutableFormatsProvider, SyncFormatsProvider, UnitSystemKey } from \"@itwin/core-quantity\";\r\nimport { FormatSet } from \"../Deserialization/JsonProps\";\r\nimport { SchemaItem } from \"../Metadata/SchemaItem\";\r\n\r\n/**\r\n * A mutable format provider that manages format definitions within a format set.\r\n * When formats are added or removed, the underlying format set is automatically updated.\r\n * @beta\r\n */\r\nexport class FormatSetFormatsProvider implements MutableFormatsProvider, SyncFormatsProvider {\r\n  public onFormatsChanged: BeEvent<(args: FormatsChangedArgs) => void> = new BeEvent<(args: FormatsChangedArgs) => void>();\r\n\r\n  private _formatSet: FormatSet;\r\n  private _fallbackProvider?: FormatsProvider;\r\n  private _references: Map<string, string>; // Maps format name to the reference it points to\r\n\r\n  public constructor(props: {formatSet: FormatSet, fallbackProvider?: FormatsProvider}) {\r\n    this._formatSet = props.formatSet;\r\n    this._fallbackProvider = props.fallbackProvider;\r\n    this._references = new Map<string, string>();\r\n\r\n    // Build up the map of string references\r\n    for (const [name, format] of Object.entries(this._formatSet.formats)) {\r\n      if (typeof format === \"string\") {\r\n        this._references.set(name, format);\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Adds or updates the format definition returned for a kind of quantity.  Takes either a format definition or a kind of quantity full name that will be used to lookup the format that will be used.\r\n   * @param name A kind of quantity full name used as a key to lookup this format\r\n   * @param format The format definition or the name of a kind of quantity\r\n   */\r\n  public async addFormat(name: string, format: FormatDefinition | string): Promise<void> {\r\n    this._formatSet.formats[name] = format;\r\n\r\n    // Update the references map\r\n    if (typeof format === \"string\") {\r\n      this._references.set(name, format);\r\n    } else {\r\n      this._references.delete(name);\r\n    }\r\n\r\n    // Collect all formats that reference this format (directly or indirectly)\r\n    const affectedFormats = this.getFormatsReferencingTarget(name);\r\n    affectedFormats.add(name); // Include the format itself\r\n\r\n    this.onFormatsChanged.raiseEvent({ formatsChanged: Array.from(affectedFormats) });\r\n  }\r\n\r\n  /**\r\n   * Clears the fallback provider, if one is set.\r\n   */\r\n  public clearFallbackProvider(): void {\r\n    this._fallbackProvider = undefined;\r\n  }\r\n\r\n  /**\r\n   * Retrieves a format definition from the format set, resolving string references and consulting the fallback provider when needed.\r\n   */\r\n  public async getFormat(input: string, system?: UnitSystemKey, context?: FormatsProviderContext): Promise<FormatDefinition | undefined> {\r\n    const lookupContext = extendProviderContext(context, this);\r\n    if (!lookupContext)\r\n      return undefined;\r\n\r\n    const name = normalizeFormatName(input);\r\n    const format = this._formatSet.formats[name];\r\n\r\n    if (format !== undefined) {\r\n      if (typeof format === \"string\")\r\n        return this.resolveReference(format, new Set(), system, lookupContext);\r\n      return format;\r\n    }\r\n\r\n    return this.getFormatFromFallback(name, system, lookupContext);\r\n  }\r\n\r\n  private async getFormatFromFallback(name: string, system: UnitSystemKey | undefined, context: FormatsProviderContext): Promise<FormatDefinition | undefined> {\r\n    const fallbackProvider = this._fallbackProvider;\r\n    if (!fallbackProvider)\r\n      return undefined;\r\n    return fallbackProvider.getFormat(name, system, context);\r\n  }\r\n\r\n  /**\r\n   * Retrieves a format definition from the format set without awaiting a provider. String references are resolved\r\n   * locally; a fallback is used only when it implements `SyncFormatsProvider`.\r\n   */\r\n  public getFormatSync(input: string, system?: UnitSystemKey, context?: FormatsProviderContext): FormatDefinition | undefined {\r\n    const lookupContext = extendProviderContext(context, this);\r\n    if (!lookupContext)\r\n      return undefined;\r\n\r\n    const name = normalizeFormatName(input);\r\n    const format = this._formatSet.formats[name];\r\n\r\n    if (format !== undefined) {\r\n      if (typeof format === \"string\")\r\n        return this.resolveReferenceSync(format, new Set(), system, lookupContext);\r\n      return format;\r\n    }\r\n\r\n    return this.getFormatSyncFromFallback(name, system, lookupContext);\r\n  }\r\n\r\n  private getFormatSyncFromFallback(name: string, system: UnitSystemKey | undefined, context: FormatsProviderContext): FormatDefinition | undefined {\r\n    const fallbackProvider: (FormatsProvider & Partial<SyncFormatsProvider>) | undefined = this._fallbackProvider;\r\n    return typeof fallbackProvider?.getFormatSync === \"function\" ? fallbackProvider.getFormatSync(name, system, context) : undefined;\r\n  }\r\n\r\n  /**\r\n   * Resolves a string reference to its FormatDefinition, following chains of references.\r\n   * @param reference The string reference to resolve\r\n   * @param visited Set of visited references to detect circular references\r\n   * @param system Optional unit system override\r\n   * @param context Lookup context to forward to the fallback provider\r\n   */\r\n  private async resolveReference(reference: string, visited: Set<string>, system: UnitSystemKey | undefined, context: FormatsProviderContext): Promise<FormatDefinition | undefined> {\r\n    // Prevent infinite loops from circular references\r\n    if (visited.has(reference)) {\r\n      return undefined;\r\n    }\r\n    visited.add(reference);\r\n\r\n    const format = this._formatSet.formats[reference];\r\n\r\n    if (format === undefined)\r\n      return this.getFormatFromFallback(reference, system, context);\r\n\r\n    if (typeof format === \"string\")\r\n      return this.resolveReference(format, visited, system, context);\r\n\r\n    return format;\r\n  }\r\n\r\n  private resolveReferenceSync(reference: string, visited: Set<string>, system: UnitSystemKey | undefined, context: FormatsProviderContext): FormatDefinition | undefined {\r\n    // Prevent infinite loops from circular references\r\n    if (visited.has(reference)) {\r\n      return undefined;\r\n    }\r\n    visited.add(reference);\r\n\r\n    const format = this._formatSet.formats[reference];\r\n    if (format === undefined)\r\n      return this.getFormatSyncFromFallback(reference, system, context);\r\n\r\n    if (typeof format === \"string\")\r\n      return this.resolveReferenceSync(format, visited, system, context);\r\n\r\n    return format;\r\n  }\r\n\r\n  /**\r\n   * Removes a format definition or string reference from the format set.\r\n   * @param name The name of the format to remove\r\n   */\r\n  public async removeFormat(name: string): Promise<void> {\r\n    // Collect all formats that reference this format (directly or indirectly)\r\n    const affectedFormats = this.getFormatsReferencingTarget(name);\r\n    affectedFormats.add(name); // Include the format itself\r\n\r\n    delete this._formatSet.formats[name];\r\n    this._references.delete(name);\r\n\r\n    this.onFormatsChanged.raiseEvent({ formatsChanged: Array.from(affectedFormats) });\r\n  }\r\n\r\n  /**\r\n   * Gets all format names that reference the target format (directly or indirectly).\r\n   * @param target The format name to find references to\r\n   * @returns Set of format names that reference the target\r\n   */\r\n  private getFormatsReferencingTarget(target: string): Set<string> {\r\n    const referencingFormats = new Set<string>();\r\n\r\n    // Find all formats that directly reference the target\r\n    for (const [formatName, reference] of this._references.entries()) {\r\n      if (reference === target) {\r\n        referencingFormats.add(formatName);\r\n        // Recursively find formats that reference this format\r\n        const indirectReferences = this.getFormatsReferencingTarget(formatName);\r\n        for (const indirectRef of indirectReferences) {\r\n          referencingFormats.add(indirectRef);\r\n        }\r\n      }\r\n    }\r\n\r\n    return referencingFormats;\r\n  }\r\n}\r\n\r\nfunction extendProviderContext(context: FormatsProviderContext | undefined, provider: FormatsProvider): FormatsProviderContext | undefined {\r\n  const providerChain = new Set(context?.providerChain);\r\n  if (providerChain.has(provider))\r\n    return undefined;\r\n\r\n  providerChain.add(provider);\r\n  return { providerChain };\r\n}\r\n\r\nfunction normalizeFormatName(input: string): string {\r\n  // Convert node-addon names from `schemaName:schemaItemName` to the dot-separated key used by FormatSet.\r\n  const [schemaName, itemName] = SchemaItem.parseFullName(input);\r\n  return schemaName === \"\" ? itemName : `${schemaName}.${itemName}`;\r\n}\r\n"]}

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

@@ -3,12 +3,12 @@
  */
 import { ISchemaLocater, SchemaContext } from "../Context";
 import { BeEvent } from "@itwin/core-bentley";
-import { FormatDefinition, FormatsChangedArgs, FormatsProvider, UnitSystemKey } from "@itwin/core-quantity";
+import { FormatDefinition, FormatsChangedArgs, FormatsProvider, SyncFormatsProvider, UnitSystemKey } from "@itwin/core-quantity";
 /**
  * Provides default formats and kind of quantities from a given SchemaContext or SchemaLocater.
  * @beta
  */
-export declare class SchemaFormatsProvider implements FormatsProvider {
+export declare class SchemaFormatsProvider implements FormatsProvider, SyncFormatsProvider {
     private _context;
     private _unitSystem?;
     private _formatsRetrieved;
@@ -29,13 +29,22 @@ export declare class SchemaFormatsProvider implements FormatsProvider {
     /** When using a presentation unit from a KindOfQuantity, the label and description should come from the KindOfQuantity */
     private convertToFormatDefinition;
     private getKindOfQuantityFormatFromSchema;
+    private getKindOfQuantityFormatProps;
     /**
-     * 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.
-     * If no presentation format matches the current unit system, the persistence unit format will be retrieved if it matches the current unit system.
-     * Else, the default presentation format will be retrieved.
+     * Retrieves a format definition from the schema context.
+     *
+     * For a KindOfQuantity with a unit system, matching presentation formats are checked first, followed by the persistence unit and then the default presentation format. Without a unit system, the default presentation format is used.
      * @param name The full name of the Format or KindOfQuantity.
-     * @returns
+     * @param system Optional unit system used to select a KindOfQuantity format.
      */
     getFormat(name: string, system?: UnitSystemKey): Promise<FormatDefinition | undefined>;
+    /**
+     * Retrieves a format definition using only schema metadata already loaded in the context.
+     * It follows the same selection order as `getFormat` but never asks a locater to load a schema. Returns `undefined` when required metadata is not cached.
+     * Unlike `getFormat`, which logs lookup errors and returns `undefined`, this method treats only a schema that is still loading as a cache miss and rethrows other errors.
+     */
+    getFormatSync(name: string, system?: UnitSystemKey): FormatDefinition | undefined;
+    private getKindOfQuantityFormatFromSchemaSync;
+    private getKindOfQuantityFormatPropsSync;
 }
 //# sourceMappingURL=SchemaFormatsProvider.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SchemaFormatsProvider.d.ts","sourceRoot":"","sources":["../../../src/Formatting/SchemaFormatsProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAK3D,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,CAAC,CAAgB;IACpC,OAAO,CAAC,iBAAiB,CAA0B;IAC5C,gBAAgB,iBAAsB,kBAAkB,KAAK,IAAI,EAAI;IAC5E;;;;;;;OAOG;gBACS,gBAAgB,EAAE,cAAc,EAAE,UAAU,CAAC,EAAE,aAAa;IAUxE,IAAW,OAAO,kBAA4B;IAC9C,IAAW,UAAU,IAEa,aAAa,GAAG,SAAS,CAFP;IAEpD,IAAW,UAAU,CAAC,UAAU,EAAE,aAAa,GAAG,SAAS,EAG1D;IAED,OAAO,CAAC,KAAK;IAMb,0HAA0H;IAC1H,OAAO,CAAC,yBAAyB;YAenB,iCAAiC;IA0D/C;;;;;;OAMG;IACU,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;CA8BpG"}
+{"version":3,"file":"SchemaFormatsProvider.d.ts","sourceRoot":"","sources":["../../../src/Formatting/SchemaFormatsProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAQ3D,OAAO,EAAE,OAAO,EAAU,MAAM,qBAAqB,CAAC;AAEtD,OAAO,EAAE,gBAAgB,EAAe,kBAAkB,EAAE,eAAe,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAO9I;;;GAGG;AACH,qBAAa,qBAAsB,YAAW,eAAe,EAAE,mBAAmB;IAChF,OAAO,CAAC,QAAQ,CAAgB;IAChC,OAAO,CAAC,WAAW,CAAC,CAAgB;IACpC,OAAO,CAAC,iBAAiB,CAA0B;IAC5C,gBAAgB,iBAAsB,kBAAkB,KAAK,IAAI,EAAI;IAC5E;;;;;;;OAOG;gBACS,gBAAgB,EAAE,cAAc,EAAE,UAAU,CAAC,EAAE,aAAa;IAUxE,IAAW,OAAO,kBAA4B;IAC9C,IAAW,UAAU,IAEa,aAAa,GAAG,SAAS,CAFP;IAEpD,IAAW,UAAU,CAAC,UAAU,EAAE,aAAa,GAAG,SAAS,EAG1D;IAED,OAAO,CAAC,KAAK;IAMb,0HAA0H;IAC1H,OAAO,CAAC,yBAAyB;YAenB,iCAAiC;YAoBjC,4BAA4B;IA0B1C;;;;;;OAMG;IACU,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IA+BnG;;;;OAIG;IACI,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,gBAAgB,GAAG,SAAS;IAgBxF,OAAO,CAAC,qCAAqC;IAc7C,OAAO,CAAC,gCAAgC;CAkCzC"}

package/lib/cjs/Formatting/SchemaFormatsProvider.js

@@ -10,11 +10,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SchemaFormatsProvider = void 0;
 const Context_1 = require("../Context");
 const SchemaKey_1 = require("../SchemaKey");
+const ECObjects_1 = require("../ECObjects");
+const Exception_1 = require("../Exception");
 const SchemaItem_1 = require("../Metadata/SchemaItem");
 const Format_1 = require("../Metadata/Format");
+const OverrideFormat_1 = require("../Metadata/OverrideFormat");
 const core_bentley_1 = require("@itwin/core-bentley");
 const KindOfQuantity_1 = require("../Metadata/KindOfQuantity");
-const OverrideFormat_1 = require("../Metadata/OverrideFormat");
+const Unit_1 = require("../Metadata/Unit");
+const InvertedUnit_1 = require("../Metadata/InvertedUnit");
+const UnitSystem_1 = require("../Metadata/UnitSystem");
 const loggerCategory = "SchemaFormatsProvider";
 /**
  * Provides default formats and kind of quantities from a given SchemaContext or SchemaLocater.
@@ -77,55 +82,42 @@ class SchemaFormatsProvider {
             core_bentley_1.Logger.logError(loggerCategory, `Failed to find KindOfQuantity ${itemKey.fullName}`);
             return undefined;
         }
-        if (!kindOfQuantity) {
+        if (!kindOfQuantity)
             return undefined;
-        }
-        // If a unit system is provided, find the first presentation format that matches it.
-        const effectiveSystem = systemOverride ?? this._unitSystem;
-        if (effectiveSystem) {
-            const unitSystemMatchers = getUnitSystemGroupMatchers(effectiveSystem);
-            const presentationFormats = kindOfQuantity.presentationFormats;
-            for (const matcher of unitSystemMatchers) {
-                for (const lazyFormat of presentationFormats) {
-                    const format = await lazyFormat;
-                    const unit = await (format.units && format.units[0][0]);
-                    if (!unit) {
-                        continue;
-                    }
-                    const currentUnitSystem = await unit.unitSystem;
-                    if (currentUnitSystem && matcher(currentUnitSystem)) {
-                        this._formatsRetrieved.add(itemKey.fullName);
-                        const props = (0, OverrideFormat_1.getFormatProps)(format);
-                        return this.convertToFormatDefinition(props, kindOfQuantity);
-                    }
-                }
-            }
-            // If no matching presentation format was found, fall back to persistence unit format
-            // only if it matches the requested unit system.
-            const persistenceUnit = await kindOfQuantity.persistenceUnit;
-            const persistenceUnitSystem = await persistenceUnit?.unitSystem;
-            if (persistenceUnit && persistenceUnitSystem && unitSystemMatchers.some((matcher) => matcher(persistenceUnitSystem))) {
-                this._formatsRetrieved.add(itemKey.fullName);
-                const props = getPersistenceUnitFormatProps(persistenceUnit);
-                return this.convertToFormatDefinition(props, kindOfQuantity);
+        const props = await this.getKindOfQuantityFormatProps(kindOfQuantity, systemOverride);
+        if (!props)
+            return undefined;
+        this._formatsRetrieved.add(itemKey.fullName);
+        return this.convertToFormatDefinition(props, kindOfQuantity);
+    }
+    async getKindOfQuantityFormatProps(kindOfQuantity, systemOverride) {
+        // Cache each unit once per lookup because matchers may revisit it. Lazy formats already resolve only once.
+        const unitCache = new Map();
+        const getUnit = (unit) => {
+            if (!unit)
+                return undefined;
+            let resolved = unitCache.get(unit);
+            if (!resolved) {
+                resolved = resolveUnitAsync(unit);
+                unitCache.set(unit, resolved);
             }
-        }
-        // If no unit system was provided, or no matching format was found, use the default presentation format.
-        // Unit conversion from persistence unit to presentation unit will be handled by FormatterSpec.
-        const defaultFormat = kindOfQuantity.defaultPresentationFormat;
-        if (defaultFormat) {
-            this._formatsRetrieved.add(itemKey.fullName);
-            const defaultProps = (0, OverrideFormat_1.getFormatProps)(await defaultFormat);
-            return this.convertToFormatDefinition(defaultProps, kindOfQuantity);
+            return resolved;
+        };
+        for (const candidate of getFormatSelectionCandidates(kindOfQuantity, systemOverride ?? this._unitSystem)) {
+            const format = candidate.type === "persistence" ? undefined : await candidate.format;
+            const unit = candidate.type === "default" ? undefined : await getUnit(candidate.type === "persistence" ? candidate.unit : format?.units?.[0]?.[0]);
+            const props = getFormatPropsForCandidate(candidate, format, unit);
+            if (props)
+                return props;
         }
         return undefined;
     }
     /**
-     * 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.
-     * If no presentation format matches the current unit system, the persistence unit format will be retrieved if it matches the current unit system.
-     * Else, the default presentation format will be retrieved.
+     * Retrieves a format definition from the schema context.
+     *
+     * For a KindOfQuantity with a unit system, matching presentation formats are checked first, followed by the persistence unit and then the default presentation format. Without a unit system, the default presentation format is used.
      * @param name The full name of the Format or KindOfQuantity.
-     * @returns
+     * @param system Optional unit system used to select a KindOfQuantity format.
      */
     async getFormat(name, system) {
         const [schemaName, schemaItemName] = SchemaItem_1.SchemaItem.parseFullName(name);
@@ -158,12 +150,139 @@ class SchemaFormatsProvider {
         }
         return this.getKindOfQuantityFormatFromSchema(itemKey, system);
     }
+    /**
+     * Retrieves a format definition using only schema metadata already loaded in the context.
+     * It follows the same selection order as `getFormat` but never asks a locater to load a schema. Returns `undefined` when required metadata is not cached.
+     * Unlike `getFormat`, which logs lookup errors and returns `undefined`, this method treats only a schema that is still loading as a cache miss and rethrows other errors.
+     */
+    getFormatSync(name, system) {
+        const [schemaName, schemaItemName] = SchemaItem_1.SchemaItem.parseFullName(name);
+        const schemaKey = new SchemaKey_1.SchemaKey(schemaName);
+        const schema = getCachedSchemaSync(this._context, schemaKey, ECObjects_1.SchemaMatchType.Latest);
+        if (!schema)
+            return undefined;
+        const itemKey = new SchemaKey_1.SchemaItemKey(schemaItemName, schema.schemaKey);
+        if (schema.name === "Formats") {
+            const format = schema.getItemSync(itemKey.name, Format_1.Format);
+            return format?.toJSON(true);
+        }
+        return this.getKindOfQuantityFormatFromSchemaSync(itemKey, system);
+    }
+    getKindOfQuantityFormatFromSchemaSync(itemKey, systemOverride) {
+        const schema = getCachedSchemaSync(this._context, itemKey.schemaKey, ECObjects_1.SchemaMatchType.Latest);
+        const kindOfQuantity = schema?.getItemSync(itemKey.name, KindOfQuantity_1.KindOfQuantity);
+        if (!kindOfQuantity)
+            return undefined;
+        const props = this.getKindOfQuantityFormatPropsSync(kindOfQuantity, systemOverride);
+        if (!props)
+            return undefined;
+        this._formatsRetrieved.add(itemKey.fullName);
+        return this.convertToFormatDefinition(props, kindOfQuantity);
+    }
+    getKindOfQuantityFormatPropsSync(kindOfQuantity, systemOverride) {
+        const formatCache = new Map();
+        const unitCache = new Map();
+        const getFormat = (format) => {
+            if (!formatCache.has(format))
+                formatCache.set(format, resolveFormatSync(this._context, format));
+            return formatCache.get(format);
+        };
+        const getUnit = (unit) => {
+            if (!unit)
+                return undefined;
+            if (!unitCache.has(unit))
+                unitCache.set(unit, resolveUnitSync(this._context, unit));
+            return unitCache.get(unit);
+        };
+        // A reference that cannot be resolved means metadata is not cached. Stop there: async lookup would resolve it and never reach a later candidate.
+        for (const candidate of getFormatSelectionCandidates(kindOfQuantity, systemOverride ?? this._unitSystem)) {
+            const format = candidate.type === "persistence" ? undefined : getFormat(candidate.format);
+            if (candidate.type !== "persistence" && !format)
+                return undefined;
+            const unitReference = candidate.type === "presentation" ? format?.units?.[0]?.[0] : candidate.type === "persistence" ? candidate.unit : undefined;
+            const unit = getUnit(unitReference);
+            if (unitReference && !unit)
+                return undefined;
+            const props = getFormatPropsForCandidate(candidate, format, unit);
+            if (props)
+                return props;
+        }
+        return undefined;
+    }
 }
 exports.SchemaFormatsProvider = SchemaFormatsProvider;
+/**
+ * Produces candidates in lookup order: presentation formats by unit-system priority, then the persistence unit,
+ * then the default presentation format. The generator defers each candidate until the lookup reaches it.
+ */
+function* getFormatSelectionCandidates(kindOfQuantity, effectiveSystem) {
+    if (effectiveSystem) {
+        const matchers = getUnitSystemGroupMatchers(effectiveSystem);
+        for (const matcher of matchers) {
+            for (const format of kindOfQuantity.presentationFormats)
+                yield { type: "presentation", format, matcher };
+        }
+        yield { type: "persistence", unit: kindOfQuantity.persistenceUnit, matchers };
+    }
+    const defaultFormat = kindOfQuantity.defaultPresentationFormat;
+    if (defaultFormat)
+        yield { type: "default", format: defaultFormat };
+}
+function getFormatPropsForCandidate(candidate, format, unit) {
+    const unitSystemName = unit?.unitSystemName;
+    switch (candidate.type) {
+        case "presentation":
+            return format && unitSystemName && candidate.matcher(unitSystemName) ? (0, OverrideFormat_1.getFormatProps)(format) : undefined;
+        case "persistence":
+            return unit && unitSystemName && candidate.matchers.some((matcher) => matcher(unitSystemName)) ? getPersistenceUnitFormatProps(unit.unit) : undefined;
+        case "default":
+            return format ? (0, OverrideFormat_1.getFormatProps)(format) : undefined;
+    }
+}
+function resolveFormatSync(context, format) {
+    if (OverrideFormat_1.OverrideFormat.isOverrideFormat(format))
+        return format;
+    const schema = getCachedSchemaSync(context, format.schemaKey, ECObjects_1.SchemaMatchType.Exact);
+    return schema?.getItemSync(format.name, Format_1.Format);
+}
+async function resolveUnitAsync(unit) {
+    const resolvedUnit = await unit;
+    const unitSystem = await resolvedUnit.unitSystem;
+    return { unit: resolvedUnit, unitSystemName: unitSystem?.name };
+}
+function resolveUnitSync(context, unit) {
+    const resolvedUnit = getLoadedUnitSync(context, unit);
+    if (!resolvedUnit)
+        return undefined;
+    const unitSystem = resolvedUnit.unitSystem;
+    if (!unitSystem)
+        return { unit: resolvedUnit };
+    const unitSystemName = getCachedSchemaSync(context, unitSystem.schemaKey, ECObjects_1.SchemaMatchType.Exact)?.getItemSync(unitSystem.name, UnitSystem_1.UnitSystem)?.name;
+    return unitSystemName ? { unit: resolvedUnit, unitSystemName } : undefined;
+}
+/**
+ * Name-only lookups use `SchemaMatchType.Latest`. References use `SchemaMatchType.Exact` because they carry the version
+ * the loaded item resolved; matching by name alone could return an item from a different cached version.
+ */
+function getCachedSchemaSync(context, schemaKey, matchType) {
+    try {
+        return context.getCachedSchemaSync(schemaKey, matchType);
+    }
+    catch (error) {
+        if (error instanceof Exception_1.ECSchemaError && error.errorNumber === Exception_1.ECSchemaStatus.UnableToLoadSchema)
+            return undefined;
+        throw error;
+    }
+}
+function getLoadedUnitSync(context, unit) {
+    const schema = getCachedSchemaSync(context, unit.schemaKey, ECObjects_1.SchemaMatchType.Exact);
+    const item = schema?.getItemSync(unit.name);
+    return Unit_1.Unit.isUnit(item) || InvertedUnit_1.InvertedUnit.isInvertedUnit(item) ? item : undefined;
+}
 function getUnitSystemGroupMatchers(groupKey) {
     function createMatcher(name) {
         const names = Array.isArray(name) ? name : [name];
-        return (unitSystem) => names.some((n) => n === unitSystem.name.toUpperCase());
+        return (unitSystemName) => names.some((n) => n === unitSystemName.toUpperCase());
     }
     switch (groupKey) {
         case "imperial":