@itwin/core-quantity 5.14.0-dev.9 → 5.14.0

package/CHANGELOG.md

@@ -1,6 +1,49 @@
 # Change Log - @itwin/core-quantity
 
-This log was last generated on Thu, 03 Sep 2026 18:51:17 GMT and should not be manually modified.
+This log was last generated on Fri, 02 Oct 2026 14:55:04 GMT and should not be manually modified.
+
+## 5.14.0
+Fri, 02 Oct 2026 14:55:04 GMT
+
+### Updates
+
+- Allow ratio separators to be a string with one non-whitespace character
+- Add synchronous unit and format APIs to @itwin/core-quantity.
+
+## 5.13.7
+Thu, 01 Oct 2026 15:15:30 GMT
+
+_Version update only_
+
+## 5.13.6
+Fri, 25 Sep 2026 22:27:22 GMT
+
+_Version update only_
+
+## 5.13.5
+Tue, 22 Sep 2026 22:38:08 GMT
+
+_Version update only_
+
+## 5.13.4
+Fri, 18 Sep 2026 15:11:19 GMT
+
+_Version update only_
+
+## 5.13.3
+Tue, 15 Sep 2026 20:25:28 GMT
+
+_Version update only_
+
+## 5.13.2
+Mon, 14 Sep 2026 20:22:20 GMT
+
+_Version update only_
+
+## 5.13.1
+Tue, 08 Sep 2026 18:43:29 GMT
+
+_Version update only_
 
 ## 5.13.0
 Thu, 03 Sep 2026 18:49:56 GMT

package/lib/cjs/BasicUnitsProvider.d.ts

@@ -1,15 +1,14 @@
-import type { UnitProps, UnitsProvider } from "./Interfaces";
+import type { SyncUnitsProvider, UnitProps, UnitsProvider } from "./Interfaces";
 /** @internal — test use only. Resets the shared module-level lazy cache. */
 export declare function _testResetUnitsCache(): void;
 /**
  * A `UnitsProvider` backed by the full BIS `Units.ecschema.json` bundled as a JSON asset.
  *
- * The bundled JSON is loaded lazily via dynamic `import()` on the first provider call and cached
- * at module scope — construction is essentially free, and multiple instances
- * share the same immutable lookup indexes.
+ * The bundled data is available locally. The provider builds its immutable lookup indexes on the
+ * first call and caches them at module scope, so multiple instances share the same indexes.
  *
- * If an initial schema load fails, later provider calls will retry the load instead of pinning the
- * provider into a permanently failed module-level state.
+ * If resolving the bundled data fails, the next provider call retries instead of retaining a failed
+ * module-level state.
  *
  * This is the zero-dependency default for backends, tools, and any frontend that doesn't need
  * iModel overrides. Equivalent to calling `createUnitsProvider()` with no arguments.
@@ -17,7 +16,11 @@ export declare function _testResetUnitsCache(): void;
  * @see createUnitsProvider for layering schema-defined units on top of basic BIS units.
  * @beta
  */
-export declare class BasicUnitsProvider implements UnitsProvider {
+export declare class BasicUnitsProvider implements UnitsProvider, SyncUnitsProvider {
+    /** Find a built-in unit by fully qualified name using local data. */
+    findUnitByNameSync(unitName: string): UnitProps;
+    /** Compute a conversion between built-in units using the same bundled data as [[getConversion]]. */
+    getConversionSync(fromUnit: UnitProps, toUnit: UnitProps): import("./Interfaces").UnitConversionProps;
     /** Find a unit by its display label, optionally filtering by schema name, phenomenon, and unit system.
      * @param unitLabel - The display label to search for (case-insensitive).
      * @param schemaName - Optional schema name filter. Returns `BadUnit` if provided and not `"Units"`.

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

@@ -1 +1 @@
-{"version":3,"file":"BasicUnitsProvider.d.ts","sourceRoot":"","sources":["../../src/BasicUnitsProvider.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAe7D,4EAA4E;AAC5E,wBAAgB,oBAAoB,IAAI,IAAI,CAE3C;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,kBAAmB,YAAW,aAAa;IAItD;;;;;;OAMG;IACU,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAuB3H;;;OAGG;IACU,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAMvE;;;OAGG;IACU,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAMjE;;;;;OAKG;IACU,aAAa,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS;CAIlE"}
+{"version":3,"file":"BasicUnitsProvider.d.ts","sourceRoot":"","sources":["../../src/BasicUnitsProvider.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAiBhF,4EAA4E;AAC5E,wBAAgB,oBAAoB,IAAI,IAAI,CAE3C;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,kBAAmB,YAAW,aAAa,EAAE,iBAAiB;IAEzE,qEAAqE;IAC9D,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS;IAMtD,oGAAoG;IAC7F,iBAAiB,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS;IAM/D;;;;;;OAMG;IACU,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAuB3H;;;OAGG;IACU,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAMvE;;;OAGG;IACU,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAMjE;;;;;OAKG;IACU,aAAa,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS;CAIlE"}

package/lib/cjs/BasicUnitsProvider.js

@@ -1,26 +1,6 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BasicUnitsProvider = void 0;
@@ -28,13 +8,13 @@ exports._testResetUnitsCache = _testResetUnitsCache;
 const Unit_1 = require("./Unit");
 const BasicUnitConversionData_1 = require("./internal/BasicUnitConversionData");
 const BasicUnitsResolvedStateCache_1 = require("./internal/BasicUnitsResolvedStateCache");
+const Units_json_1 = __importDefault(require("./assets/Units.json"));
+const bundledSchema = Units_json_1.default;
 async function resolveState() {
-    return (0, BasicUnitsResolvedStateCache_1.resolveBasicUnitsData)(async () => {
-        // First caller pays the dynamic-import + schema-index build cost.
-        // Concurrent callers await the same promise, and later callers reuse the resolved state.
-        const { default: schema } = await Promise.resolve().then(() => __importStar(require("./assets/Units.json")));
-        return schema;
-    });
+    return (0, BasicUnitsResolvedStateCache_1.resolveBasicUnitsData)(async () => bundledSchema);
+}
+function resolveStateSync() {
+    return (0, BasicUnitsResolvedStateCache_1.resolveBasicUnitsDataSync)(bundledSchema);
 }
 /** @internal — test use only. Resets the shared module-level lazy cache. */
 function _testResetUnitsCache() {
@@ -43,12 +23,11 @@ function _testResetUnitsCache() {
 /**
  * A `UnitsProvider` backed by the full BIS `Units.ecschema.json` bundled as a JSON asset.
  *
- * The bundled JSON is loaded lazily via dynamic `import()` on the first provider call and cached
- * at module scope — construction is essentially free, and multiple instances
- * share the same immutable lookup indexes.
+ * The bundled data is available locally. The provider builds its immutable lookup indexes on the
+ * first call and caches them at module scope, so multiple instances share the same indexes.
  *
- * If an initial schema load fails, later provider calls will retry the load instead of pinning the
- * provider into a permanently failed module-level state.
+ * If resolving the bundled data fails, the next provider call retries instead of retaining a failed
+ * module-level state.
  *
  * This is the zero-dependency default for backends, tools, and any frontend that doesn't need
  * iModel overrides. Equivalent to calling `createUnitsProvider()` with no arguments.
@@ -57,6 +36,16 @@ function _testResetUnitsCache() {
  * @beta
  */
 class BasicUnitsProvider {
+    /** Find a built-in unit by fully qualified name using local data. */
+    findUnitByNameSync(unitName) {
+        const state = resolveStateSync();
+        const entry = state.nameMap.get(unitName);
+        return entry ? entry.props : new Unit_1.BadUnit();
+    }
+    /** Compute a conversion between built-in units using the same bundled data as [[getConversion]]. */
+    getConversionSync(fromUnit, toUnit) {
+        return (0, BasicUnitConversionData_1.getBasicUnitConversion)(resolveStateSync(), fromUnit, toUnit);
+    }
     // ── UnitsProvider implementation ─────────────────────────────────────
     /** Find a unit by its display label, optionally filtering by schema name, phenomenon, and unit system.
      * @param unitLabel - The display label to search for (case-insensitive).

package/lib/cjs/BasicUnitsProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"BasicUnitsProvider.js","sourceRoot":"","sources":["../../src/BasicUnitsProvider.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAoBA,oDAEC;AAhBD,iCAAiC;AACjC,gFAA4E;AAC5E,0FAAuH;AAEvH,KAAK,UAAU,YAAY;IACzB,OAAO,IAAA,oDAAqB,EAAC,KAAK,IAAI,EAAE;QACtC,kEAAkE;QAClE,yFAAyF;QACzF,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,wDAAa,qBAAqB,GAAC,CAAC;QAChE,OAAO,MAA8B,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,4EAA4E;AAC5E,SAAgB,oBAAoB;IAClC,IAAA,oEAAqC,GAAE,CAAC;AAC1C,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAa,kBAAkB;IAE7B,wEAAwE;IAExE;;;;;;OAMG;IACI,KAAK,CAAC,QAAQ,CAAC,SAAiB,EAAE,UAAmB,EAAE,UAAmB,EAAE,UAAmB;QACpG,MAAM,KAAK,GAAG,MAAM,YAAY,EAAE,CAAC;QACnC,IAAI,UAAU,IAAI,UAAU,KAAK,KAAK,CAAC,UAAU,EAAE,CAAC;YAClD,OAAO,IAAI,cAAO,EAAE,CAAC;QACvB,CAAC;QACD,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;QAC/D,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3C,OAAO,IAAI,cAAO,EAAE,CAAC;QACvB,CAAC;QAED,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;YAC3B,IAAI,UAAU,IAAI,CAAC,CAAC,KAAK,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;gBACpD,SAAS;YACX,CAAC;YACD,IAAI,UAAU,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;gBAChD,SAAS;YACX,CAAC;YACD,OAAO,CAAC,CAAC,KAAK,CAAC;QACjB,CAAC;QAED,OAAO,IAAI,cAAO,EAAE,CAAC;IACvB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gBAAgB,CAAC,UAAkB;QAC9C,MAAM,KAAK,GAAG,MAAM,YAAY,EAAE,CAAC;QACnC,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACpD,OAAO,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACpD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,cAAc,CAAC,QAAgB;QAC1C,MAAM,KAAK,GAAG,MAAM,YAAY,EAAE,CAAC;QACnC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC1C,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,cAAO,EAAE,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CAAC,QAAmB,EAAE,MAAiB;QAC/D,MAAM,KAAK,GAAG,MAAM,YAAY,EAAE,CAAC;QACnC,OAAO,IAAA,gDAAsB,EAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;CACF;AAhED,gDAgEC","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\nimport type { UnitProps, UnitsProvider } from \"./Interfaces\";\r\nimport type { SerializedUnitSchema } from \"./SerializedUnitSchema\";\r\nimport { BadUnit } from \"./Unit\";\r\nimport { getBasicUnitConversion } from \"./internal/BasicUnitConversionData\";\r\nimport { _testResetResolvedBasicUnitsDataCache, resolveBasicUnitsData } from \"./internal/BasicUnitsResolvedStateCache\";\r\n\r\nasync function resolveState() {\r\n  return resolveBasicUnitsData(async () => {\r\n    // First caller pays the dynamic-import + schema-index build cost.\r\n    // Concurrent callers await the same promise, and later callers reuse the resolved state.\r\n    const { default: schema } = await import(\"./assets/Units.json\");\r\n    return schema as SerializedUnitSchema;\r\n  });\r\n}\r\n\r\n/** @internal — test use only. Resets the shared module-level lazy cache. */\r\nexport function _testResetUnitsCache(): void {\r\n  _testResetResolvedBasicUnitsDataCache();\r\n}\r\n\r\n/**\r\n * A `UnitsProvider` backed by the full BIS `Units.ecschema.json` bundled as a JSON asset.\r\n *\r\n * The bundled JSON is loaded lazily via dynamic `import()` on the first provider call and cached\r\n * at module scope — construction is essentially free, and multiple instances\r\n * share the same immutable lookup indexes.\r\n *\r\n * If an initial schema load fails, later provider calls will retry the load instead of pinning the\r\n * provider into a permanently failed module-level state.\r\n *\r\n * This is the zero-dependency default for backends, tools, and any frontend that doesn't need\r\n * iModel overrides. Equivalent to calling `createUnitsProvider()` with no arguments.\r\n *\r\n * @see createUnitsProvider for layering schema-defined units on top of basic BIS units.\r\n * @beta\r\n */\r\nexport class BasicUnitsProvider implements UnitsProvider {\r\n\r\n  // ── UnitsProvider implementation ─────────────────────────────────────\r\n\r\n  /** Find a unit by its display label, optionally filtering by schema name, phenomenon, and unit system.\r\n   * @param unitLabel - The display label to search for (case-insensitive).\r\n   * @param schemaName - Optional schema name filter. Returns `BadUnit` if provided and not `\"Units\"`.\r\n   * @param phenomenon - Optional phenomenon filter (e.g. `\"Units.LENGTH\"`).\r\n   * @param unitSystem - Optional unit system filter (e.g. `\"Units.METRIC\"`).\r\n   * @returns The matching `UnitProps`, or a `BadUnit` if no match is found.\r\n   */\r\n  public async findUnit(unitLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps> {\r\n    const state = await resolveState();\r\n    if (schemaName && schemaName !== state.schemaName) {\r\n      return new BadUnit();\r\n    }\r\n    const candidates = state.labelMap.get(unitLabel.toLowerCase());\r\n    if (!candidates || candidates.length === 0) {\r\n      return new BadUnit();\r\n    }\r\n\r\n    for (const c of candidates) {\r\n      if (phenomenon && c.props.phenomenon !== phenomenon) {\r\n        continue;\r\n      }\r\n      if (unitSystem && c.props.system !== unitSystem) {\r\n        continue;\r\n      }\r\n      return c.props;\r\n    }\r\n\r\n    return new BadUnit();\r\n  }\r\n\r\n  /** Return all units belonging to the given phenomenon (unit family).\r\n   * @param phenomenon - The phenomenon full name (e.g. `\"Units.LENGTH\"`).\r\n   * @returns An array of matching `UnitProps`, or an empty array if none.\r\n   */\r\n  public async getUnitsByFamily(phenomenon: string): Promise<UnitProps[]> {\r\n    const state = await resolveState();\r\n    const entries = state.phenomenonMap.get(phenomenon);\r\n    return entries ? entries.map((e) => e.props) : [];\r\n  }\r\n\r\n  /** Find a unit by its fully-qualified name (e.g. `\"Units.M\"`).\r\n   * @param unitName - The qualified unit name.\r\n   * @returns The matching `UnitProps`, or a `BadUnit` if not found.\r\n   */\r\n  public async findUnitByName(unitName: string): Promise<UnitProps> {\r\n    const state = await resolveState();\r\n    const entry = state.nameMap.get(unitName);\r\n    return entry ? entry.props : new BadUnit();\r\n  }\r\n\r\n  /** Compute the conversion factors from `fromUnit` to `toUnit`.\r\n   * Handles normal units, inverted units, and mixed (inverted ↔ non-inverted) conversions.\r\n   * @param fromUnit - The source unit.\r\n   * @param toUnit - The target unit.\r\n   * @returns A `UnitConversionProps` with `factor`, `offset`, and optionally `inversion` and `error`.\r\n   */\r\n  public async getConversion(fromUnit: UnitProps, toUnit: UnitProps) {\r\n    const state = await resolveState();\r\n    return getBasicUnitConversion(state, fromUnit, toUnit);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BasicUnitsProvider.js","sourceRoot":"","sources":["../../src/BasicUnitsProvider.ts"],"names":[],"mappings":";;;;;;AAsBA,oDAEC;AAlBD,iCAAiC;AACjC,gFAA4E;AAC5E,0FAAkJ;AAClJ,qEAAqD;AAErD,MAAM,aAAa,GAAG,oBAA0C,CAAC;AAEjE,KAAK,UAAU,YAAY;IACzB,OAAO,IAAA,oDAAqB,EAAC,KAAK,IAAI,EAAE,CAAC,aAAa,CAAC,CAAC;AAC1D,CAAC;AAED,SAAS,gBAAgB;IACvB,OAAO,IAAA,wDAAyB,EAAC,aAAa,CAAC,CAAC;AAClD,CAAC;AAED,4EAA4E;AAC5E,SAAgB,oBAAoB;IAClC,IAAA,oEAAqC,GAAE,CAAC;AAC1C,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,kBAAkB;IAE7B,qEAAqE;IAC9D,kBAAkB,CAAC,QAAgB;QACxC,MAAM,KAAK,GAAG,gBAAgB,EAAE,CAAC;QACjC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC1C,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,cAAO,EAAE,CAAC;IAC7C,CAAC;IAED,oGAAoG;IAC7F,iBAAiB,CAAC,QAAmB,EAAE,MAAiB;QAC7D,OAAO,IAAA,gDAAsB,EAAC,gBAAgB,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC;IAED,wEAAwE;IAExE;;;;;;OAMG;IACI,KAAK,CAAC,QAAQ,CAAC,SAAiB,EAAE,UAAmB,EAAE,UAAmB,EAAE,UAAmB;QACpG,MAAM,KAAK,GAAG,MAAM,YAAY,EAAE,CAAC;QACnC,IAAI,UAAU,IAAI,UAAU,KAAK,KAAK,CAAC,UAAU,EAAE,CAAC;YAClD,OAAO,IAAI,cAAO,EAAE,CAAC;QACvB,CAAC;QACD,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;QAC/D,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3C,OAAO,IAAI,cAAO,EAAE,CAAC;QACvB,CAAC;QAED,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;YAC3B,IAAI,UAAU,IAAI,CAAC,CAAC,KAAK,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;gBACpD,SAAS;YACX,CAAC;YACD,IAAI,UAAU,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;gBAChD,SAAS;YACX,CAAC;YACD,OAAO,CAAC,CAAC,KAAK,CAAC;QACjB,CAAC;QAED,OAAO,IAAI,cAAO,EAAE,CAAC;IACvB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gBAAgB,CAAC,UAAkB;QAC9C,MAAM,KAAK,GAAG,MAAM,YAAY,EAAE,CAAC;QACnC,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACpD,OAAO,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACpD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,cAAc,CAAC,QAAgB;QAC1C,MAAM,KAAK,GAAG,MAAM,YAAY,EAAE,CAAC;QACnC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC1C,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,cAAO,EAAE,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CAAC,QAAmB,EAAE,MAAiB;QAC/D,MAAM,KAAK,GAAG,MAAM,YAAY,EAAE,CAAC;QACnC,OAAO,IAAA,gDAAsB,EAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;CACF;AA5ED,gDA4EC","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\nimport type { SyncUnitsProvider, UnitProps, UnitsProvider } from \"./Interfaces\";\r\nimport type { SerializedUnitSchema } from \"./SerializedUnitSchema\";\r\nimport { BadUnit } from \"./Unit\";\r\nimport { getBasicUnitConversion } from \"./internal/BasicUnitConversionData\";\r\nimport { _testResetResolvedBasicUnitsDataCache, resolveBasicUnitsData, resolveBasicUnitsDataSync } from \"./internal/BasicUnitsResolvedStateCache\";\r\nimport bundledUnitsSchema from \"./assets/Units.json\";\r\n\r\nconst bundledSchema = bundledUnitsSchema as SerializedUnitSchema;\r\n\r\nasync function resolveState() {\r\n  return resolveBasicUnitsData(async () => bundledSchema);\r\n}\r\n\r\nfunction resolveStateSync() {\r\n  return resolveBasicUnitsDataSync(bundledSchema);\r\n}\r\n\r\n/** @internal — test use only. Resets the shared module-level lazy cache. */\r\nexport function _testResetUnitsCache(): void {\r\n  _testResetResolvedBasicUnitsDataCache();\r\n}\r\n\r\n/**\r\n * A `UnitsProvider` backed by the full BIS `Units.ecschema.json` bundled as a JSON asset.\r\n *\r\n * The bundled data is available locally. The provider builds its immutable lookup indexes on the\r\n * first call and caches them at module scope, so multiple instances share the same indexes.\r\n *\r\n * If resolving the bundled data fails, the next provider call retries instead of retaining a failed\r\n * module-level state.\r\n *\r\n * This is the zero-dependency default for backends, tools, and any frontend that doesn't need\r\n * iModel overrides. Equivalent to calling `createUnitsProvider()` with no arguments.\r\n *\r\n * @see createUnitsProvider for layering schema-defined units on top of basic BIS units.\r\n * @beta\r\n */\r\nexport class BasicUnitsProvider implements UnitsProvider, SyncUnitsProvider {\r\n\r\n  /** Find a built-in unit by fully qualified name using local data. */\r\n  public findUnitByNameSync(unitName: string): UnitProps {\r\n    const state = resolveStateSync();\r\n    const entry = state.nameMap.get(unitName);\r\n    return entry ? entry.props : new BadUnit();\r\n  }\r\n\r\n  /** Compute a conversion between built-in units using the same bundled data as [[getConversion]]. */\r\n  public getConversionSync(fromUnit: UnitProps, toUnit: UnitProps) {\r\n    return getBasicUnitConversion(resolveStateSync(), fromUnit, toUnit);\r\n  }\r\n\r\n  // ── UnitsProvider implementation ─────────────────────────────────────\r\n\r\n  /** Find a unit by its display label, optionally filtering by schema name, phenomenon, and unit system.\r\n   * @param unitLabel - The display label to search for (case-insensitive).\r\n   * @param schemaName - Optional schema name filter. Returns `BadUnit` if provided and not `\"Units\"`.\r\n   * @param phenomenon - Optional phenomenon filter (e.g. `\"Units.LENGTH\"`).\r\n   * @param unitSystem - Optional unit system filter (e.g. `\"Units.METRIC\"`).\r\n   * @returns The matching `UnitProps`, or a `BadUnit` if no match is found.\r\n   */\r\n  public async findUnit(unitLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps> {\r\n    const state = await resolveState();\r\n    if (schemaName && schemaName !== state.schemaName) {\r\n      return new BadUnit();\r\n    }\r\n    const candidates = state.labelMap.get(unitLabel.toLowerCase());\r\n    if (!candidates || candidates.length === 0) {\r\n      return new BadUnit();\r\n    }\r\n\r\n    for (const c of candidates) {\r\n      if (phenomenon && c.props.phenomenon !== phenomenon) {\r\n        continue;\r\n      }\r\n      if (unitSystem && c.props.system !== unitSystem) {\r\n        continue;\r\n      }\r\n      return c.props;\r\n    }\r\n\r\n    return new BadUnit();\r\n  }\r\n\r\n  /** Return all units belonging to the given phenomenon (unit family).\r\n   * @param phenomenon - The phenomenon full name (e.g. `\"Units.LENGTH\"`).\r\n   * @returns An array of matching `UnitProps`, or an empty array if none.\r\n   */\r\n  public async getUnitsByFamily(phenomenon: string): Promise<UnitProps[]> {\r\n    const state = await resolveState();\r\n    const entries = state.phenomenonMap.get(phenomenon);\r\n    return entries ? entries.map((e) => e.props) : [];\r\n  }\r\n\r\n  /** Find a unit by its fully-qualified name (e.g. `\"Units.M\"`).\r\n   * @param unitName - The qualified unit name.\r\n   * @returns The matching `UnitProps`, or a `BadUnit` if not found.\r\n   */\r\n  public async findUnitByName(unitName: string): Promise<UnitProps> {\r\n    const state = await resolveState();\r\n    const entry = state.nameMap.get(unitName);\r\n    return entry ? entry.props : new BadUnit();\r\n  }\r\n\r\n  /** Compute the conversion factors from `fromUnit` to `toUnit`.\r\n   * Handles normal units, inverted units, and mixed (inverted ↔ non-inverted) conversions.\r\n   * @param fromUnit - The source unit.\r\n   * @param toUnit - The target unit.\r\n   * @returns A `UnitConversionProps` with `factor`, `offset`, and optionally `inversion` and `error`.\r\n   */\r\n  public async getConversion(fromUnit: UnitProps, toUnit: UnitProps) {\r\n    const state = await resolveState();\r\n    return getBasicUnitConversion(state, fromUnit, toUnit);\r\n  }\r\n}\r\n"]}

package/lib/cjs/Formatter/Format.d.ts

@@ -1,7 +1,7 @@
 /** @packageDocumentation
  * @module Quantity
  */
-import { UnitProps, UnitsProvider } from "../Interfaces";
+import { SyncUnitsProvider, UnitProps, UnitsProvider } from "../Interfaces";
 import { DecimalPrecision, FormatTraits, FormatType, FractionalPrecision, RatioFormatType, RatioType, ScientificType, ShowSignOption } from "./FormatEnums";
 import { CloneOptions, FormatProps, ResolvedFormatProps } from "./Interfaces";
 /** A base Format class with shared properties and functionality between quantity and ecschema-metadata Format classes
@@ -124,6 +124,8 @@ export declare class Format extends BaseFormat {
     fromFullyResolvedJSON(jsonObj: ResolvedFormatProps): void;
     /** Create a Format from FormatProps */
     static createFromJSON(name: string, unitsProvider: UnitsProvider, formatProps: FormatProps): Promise<Format>;
+    /** Create a `Format` from `FormatProps` using a synchronous unit provider. */
+    static createFromJSONSync(name: string, unitsProvider: SyncUnitsProvider, formatProps: FormatProps): Format;
     static createFromFullyResolvedJSON(name: string, formatProps: ResolvedFormatProps): Format;
     /**
      * Returns a JSON object that contain the specification for this Format.

package/lib/cjs/Formatter/Format.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Format.d.ts","sourceRoot":"","sources":["../../../src/Formatter/Format.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,EACL,gBAAgB,EAAE,YAAY,EAAuB,UAAU,EAAE,mBAAmB,EAEpF,eAAe,EAAE,SAAS,EAC1B,cAAc,EACd,cAAc,EACf,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAA0B,MAAM,cAAc,CAAC;AAKtG;;GAEG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,KAAK,CAAM;IACnB,SAAS,CAAC,YAAY,EAAE,MAAM,CAAO;IACrC,SAAS,CAAC,KAAK,EAAE,UAAU,CAAsB;IACjD,SAAS,CAAC,UAAU,EAAE,MAAM,CAAwB;IACpD,SAAS,CAAC,eAAe,EAAE,cAAc,CAA+B;IACxE,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAoD;IACvF,SAAS,CAAC,kBAAkB,EAAE,MAAM,CAAqD;IACzF,SAAS,CAAC,aAAa,SAAO;IAC9B,SAAS,CAAC,iBAAiB,SAAO;IAClC,SAAS,CAAC,aAAa,EAAE,YAAY,CAA8B;IACnE,SAAS,CAAC,OAAO,EAAE,MAAM,CAAO;IAChC,SAAS,CAAC,YAAY,EAAE,OAAO,CAAQ;IACvC,SAAS,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,eAAe,CAAC,EAAE,cAAc,CAAC;IAC3C,SAAS,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IACtC,SAAS,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IACtC,SAAS,CAAC,UAAU,CAAC,EAAE,SAAS,CAAC;IACjC,SAAS,CAAC,gBAAgB,CAAC,EAAE,eAAe,CAAC;IAC7C,SAAS,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IACnC,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAChC,SAAS,CAAC,gBAAgB,CAAC,EAAE,SAAS,CAAC;IACvC,SAAS,CAAC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAC7C,SAAS,CAAC,eAAe,CAAC,EAAE,SAAS,CAAC;IACtC,SAAS,CAAC,0BAA0B,EAAE,OAAO,CAAS;gBAE1C,IAAI,EAAE,MAAM;IAIxB,IAAW,IAAI,IAAI,MAAM,CAAuB;IAEhD,IAAW,WAAW,IAAI,MAAM,CAA8B;IAC9D,IAAW,WAAW,CAAC,WAAW,EAAE,MAAM,EAAsC;IAEhF,IAAW,IAAI,IAAI,UAAU,CAAuB;IACpD,IAAW,IAAI,CAAC,UAAU,EAAE,UAAU,EAA8B;IAEpE,IAAW,SAAS,IAAI,gBAAgB,GAAG,mBAAmB,CAA4B;IAC1F,IAAW,SAAS,CAAC,SAAS,EAAE,gBAAgB,GAAG,mBAAmB,EAAkC;IAExG,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAA2B;IACpE,IAAW,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAAgC;IAEhF,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAAiC;IACxF,IAAW,cAAc,CAAC,cAAc,EAAE,cAAc,GAAG,SAAS,EAA4C;IAEhH,IAAW,SAAS,IAAI,SAAS,GAAG,SAAS,CAA4B;IACzE,IAAW,SAAS,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,EAAkC;IAEvF,IAAW,eAAe,IAAI,eAAe,GAAG,SAAS,CAAkC;IAC3F,IAAW,eAAe,CAAC,eAAe,EAAE,eAAe,GAAG,SAAS,EAA8C;IAErH,IAAW,cAAc,IAAI,MAAM,GAAG,SAAS,CAAiC;IAChF,IAAW,cAAc,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,EAA4C;IAExG,IAAW,cAAc,IAAI,cAAc,CAAiC;IAC5E,IAAW,cAAc,CAAC,cAAc,EAAE,cAAc,EAA4C;IAEpG,IAAW,gBAAgB,IAAI,MAAM,CAAmC;IACxE,IAAW,gBAAgB,CAAC,gBAAgB,EAAE,MAAM,EAAgD;IAEpG,IAAW,iBAAiB,IAAI,MAAM,CAAoC;IAC1E,IAAW,iBAAiB,CAAC,iBAAiB,EAAE,MAAM,EAAkD;IAExG,IAAW,YAAY,IAAI,MAAM,CAA+B;IAChE,IAAW,YAAY,CAAC,YAAY,EAAE,MAAM,EAAwC;IAEpF,IAAW,gBAAgB,IAAI,MAAM,CAAmC;IACxE,IAAW,gBAAgB,CAAC,gBAAgB,EAAE,MAAM,EAAgD;IAEpG,IAAW,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAAoC;IACtF,IAAW,iBAAiB,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,EAAsE;IAExI;;OAEG;IACH,IAAW,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAEjD;IACD,IAAW,iBAAiB,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,EAEjE;IAED,IAAW,yBAAyB,IAAI,OAAO,CAA4C;IAC3F,IAAW,yBAAyB,CAAC,yBAAyB,EAAE,OAAO,EAAkE;IAEzI,IAAW,YAAY,IAAI,YAAY,CAA+B;IACtE,IAAW,YAAY,CAAC,YAAY,EAAE,YAAY,EAAwC;IAE1F,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAAyB;IAChE,IAAW,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAA4C;IACxF,IAAW,eAAe,IAAI,MAAM,CAAgC;IAEpE,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAA8B;IAC3E,IAAW,WAAW,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS,EAA2D;IAGlH,IAAW,WAAW,IAAI,MAAM,GAAG,SAAS,CAA8B;IAC1E,IAAW,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,EAAsC;IAE5F;;;OAGG;IACH,IAAW,eAAe,IAAI,SAAS,GAAG,SAAS,CAAkC;IACrF,IAAW,eAAe,CAAC,eAAe,EAAE,SAAS,GAAG,SAAS,EAA8C;IAE/G,IAAW,uBAAuB,IAAI,OAAO,GAAG,SAAS,CAA0C;IACnG,IAAW,uBAAuB,CAAC,uBAAuB,EAAE,OAAO,GAAG,SAAS,EAA8D;IAC7I,IAAW,yBAAyB,IAAI,OAAO,CAA2C;IAE1F;;;OAGG;IACH,IAAW,cAAc,IAAI,SAAS,GAAG,SAAS,CAAiC;IACnF,IAAW,cAAc,CAAC,cAAc,EAAE,SAAS,GAAG,SAAS,EAA4C;IAE3G,8KAA8K;IACvK,iBAAiB,CAAC,oBAAoB,EAAE,MAAM,GAAG,MAAM,EAAE;IAQhE,gFAAgF;IACzE,iBAAiB,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO;IAIrD,oBAAoB,CAAC,WAAW,EAAE,WAAW,GAAG,mBAAmB;CA4H3E;AAED;;GAEG;AACH,qBAAa,MAAO,SAAQ,UAAU;IACpC,SAAS,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;IAC1D,SAAS,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC;IAE7B;;OAEG;gBACS,IAAI,EAAE,MAAM;IAIxB,IAAW,KAAK,IAAI,KAAK,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,CAAwB;IAC9F,IAAW,QAAQ,IAAI,OAAO,CAAgE;IAC9F,IAAW,WAAW,IAAI,GAAG,CAA8B;WAE7C,uBAAuB,CAAC,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,YAAY;IAQnF;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,MAAM;IA2D5C;;OAEG;IACU,QAAQ,CAAC,aAAa,EAAE,aAAa,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAKjF,qBAAqB,CAAC,OAAO,EAAE,mBAAmB,GAAG,IAAI;IA+DhE,uCAAuC;WACnB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,WAAW;WAMzF,2BAA2B,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,mBAAmB;IAMxF;;OAEG;IACI,MAAM,IAAI,WAAW;IAerB,mBAAmB,IAAI,mBAAmB;CA+ClD"}
+{"version":3,"file":"Format.d.ts","sourceRoot":"","sources":["../../../src/Formatter/Format.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC5E,OAAO,EACL,gBAAgB,EAAE,YAAY,EAAuB,UAAU,EAAE,mBAAmB,EAEpF,eAAe,EAAE,SAAS,EAC1B,cAAc,EACd,cAAc,EACf,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAA0B,MAAM,cAAc,CAAC;AAKtG;;GAEG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,KAAK,CAAM;IACnB,SAAS,CAAC,YAAY,EAAE,MAAM,CAAO;IACrC,SAAS,CAAC,KAAK,EAAE,UAAU,CAAsB;IACjD,SAAS,CAAC,UAAU,EAAE,MAAM,CAAwB;IACpD,SAAS,CAAC,eAAe,EAAE,cAAc,CAA+B;IACxE,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAoD;IACvF,SAAS,CAAC,kBAAkB,EAAE,MAAM,CAAqD;IACzF,SAAS,CAAC,aAAa,SAAO;IAC9B,SAAS,CAAC,iBAAiB,SAAO;IAClC,SAAS,CAAC,aAAa,EAAE,YAAY,CAA8B;IACnE,SAAS,CAAC,OAAO,EAAE,MAAM,CAAO;IAChC,SAAS,CAAC,YAAY,EAAE,OAAO,CAAQ;IACvC,SAAS,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,eAAe,CAAC,EAAE,cAAc,CAAC;IAC3C,SAAS,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IACtC,SAAS,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IACtC,SAAS,CAAC,UAAU,CAAC,EAAE,SAAS,CAAC;IACjC,SAAS,CAAC,gBAAgB,CAAC,EAAE,eAAe,CAAC;IAC7C,SAAS,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IACnC,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAChC,SAAS,CAAC,gBAAgB,CAAC,EAAE,SAAS,CAAC;IACvC,SAAS,CAAC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAC7C,SAAS,CAAC,eAAe,CAAC,EAAE,SAAS,CAAC;IACtC,SAAS,CAAC,0BAA0B,EAAE,OAAO,CAAS;gBAE1C,IAAI,EAAE,MAAM;IAIxB,IAAW,IAAI,IAAI,MAAM,CAAuB;IAEhD,IAAW,WAAW,IAAI,MAAM,CAA8B;IAC9D,IAAW,WAAW,CAAC,WAAW,EAAE,MAAM,EAAsC;IAEhF,IAAW,IAAI,IAAI,UAAU,CAAuB;IACpD,IAAW,IAAI,CAAC,UAAU,EAAE,UAAU,EAA8B;IAEpE,IAAW,SAAS,IAAI,gBAAgB,GAAG,mBAAmB,CAA4B;IAC1F,IAAW,SAAS,CAAC,SAAS,EAAE,gBAAgB,GAAG,mBAAmB,EAAkC;IAExG,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAA2B;IACpE,IAAW,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAAgC;IAEhF,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAAiC;IACxF,IAAW,cAAc,CAAC,cAAc,EAAE,cAAc,GAAG,SAAS,EAA4C;IAEhH,IAAW,SAAS,IAAI,SAAS,GAAG,SAAS,CAA4B;IACzE,IAAW,SAAS,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,EAAkC;IAEvF,IAAW,eAAe,IAAI,eAAe,GAAG,SAAS,CAAkC;IAC3F,IAAW,eAAe,CAAC,eAAe,EAAE,eAAe,GAAG,SAAS,EAA8C;IAErH,IAAW,cAAc,IAAI,MAAM,GAAG,SAAS,CAAiC;IAChF,IAAW,cAAc,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,EAA4C;IAExG,IAAW,cAAc,IAAI,cAAc,CAAiC;IAC5E,IAAW,cAAc,CAAC,cAAc,EAAE,cAAc,EAA4C;IAEpG,IAAW,gBAAgB,IAAI,MAAM,CAAmC;IACxE,IAAW,gBAAgB,CAAC,gBAAgB,EAAE,MAAM,EAAgD;IAEpG,IAAW,iBAAiB,IAAI,MAAM,CAAoC;IAC1E,IAAW,iBAAiB,CAAC,iBAAiB,EAAE,MAAM,EAAkD;IAExG,IAAW,YAAY,IAAI,MAAM,CAA+B;IAChE,IAAW,YAAY,CAAC,YAAY,EAAE,MAAM,EAAwC;IAEpF,IAAW,gBAAgB,IAAI,MAAM,CAAmC;IACxE,IAAW,gBAAgB,CAAC,gBAAgB,EAAE,MAAM,EAAgD;IAEpG,IAAW,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAAoC;IACtF,IAAW,iBAAiB,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,EAAsE;IAExI;;OAEG;IACH,IAAW,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAEjD;IACD,IAAW,iBAAiB,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,EAEjE;IAED,IAAW,yBAAyB,IAAI,OAAO,CAA4C;IAC3F,IAAW,yBAAyB,CAAC,yBAAyB,EAAE,OAAO,EAAkE;IAEzI,IAAW,YAAY,IAAI,YAAY,CAA+B;IACtE,IAAW,YAAY,CAAC,YAAY,EAAE,YAAY,EAAwC;IAE1F,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAAyB;IAChE,IAAW,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAA4C;IACxF,IAAW,eAAe,IAAI,MAAM,CAAgC;IAEpE,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAA8B;IAC3E,IAAW,WAAW,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS,EAA2D;IAGlH,IAAW,WAAW,IAAI,MAAM,GAAG,SAAS,CAA8B;IAC1E,IAAW,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,EAAsC;IAE5F;;;OAGG;IACH,IAAW,eAAe,IAAI,SAAS,GAAG,SAAS,CAAkC;IACrF,IAAW,eAAe,CAAC,eAAe,EAAE,SAAS,GAAG,SAAS,EAA8C;IAE/G,IAAW,uBAAuB,IAAI,OAAO,GAAG,SAAS,CAA0C;IACnG,IAAW,uBAAuB,CAAC,uBAAuB,EAAE,OAAO,GAAG,SAAS,EAA8D;IAC7I,IAAW,yBAAyB,IAAI,OAAO,CAA2C;IAE1F;;;OAGG;IACH,IAAW,cAAc,IAAI,SAAS,GAAG,SAAS,CAAiC;IACnF,IAAW,cAAc,CAAC,cAAc,EAAE,SAAS,GAAG,SAAS,EAA4C;IAE3G,8KAA8K;IACvK,iBAAiB,CAAC,oBAAoB,EAAE,MAAM,GAAG,MAAM,EAAE;IAQhE,gFAAgF;IACzE,iBAAiB,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO;IAIrD,oBAAoB,CAAC,WAAW,EAAE,WAAW,GAAG,mBAAmB;CA6H3E;AAED;;GAEG;AACH,qBAAa,MAAO,SAAQ,UAAU;IACpC,SAAS,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;IAC1D,SAAS,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC;IAE7B;;OAEG;gBACS,IAAI,EAAE,MAAM;IAIxB,IAAW,KAAK,IAAI,KAAK,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,CAAwB;IAC9F,IAAW,QAAQ,IAAI,OAAO,CAAgE;IAC9F,IAAW,WAAW,IAAI,GAAG,CAA8B;WAE7C,uBAAuB,CAAC,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,YAAY;IAQnF;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,MAAM;IA2D5C;;OAEG;IACU,QAAQ,CAAC,aAAa,EAAE,aAAa,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAKjF,qBAAqB,CAAC,OAAO,EAAE,mBAAmB,GAAG,IAAI;IA+DhE,uCAAuC;WACnB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,WAAW;IAMvG,8EAA8E;WAChE,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,iBAAiB,EAAE,WAAW,EAAE,WAAW,GAAG,MAAM;WAMpG,2BAA2B,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,mBAAmB;IAMxF;;OAEG;IACI,MAAM,IAAI,WAAW;IAerB,mBAAmB,IAAI,mBAAmB;CA+ClD"}

package/lib/cjs/Formatter/Format.js

@@ -35,7 +35,7 @@ class BaseFormat {
     _stationBaseFactor; // optional positive integer base factor for station formatting; default is 1
     _ratioType; // required if type is ratio; options: oneToN, NToOne, ValueBased, useGreatestCommonDivisor
     _ratioFormatType; // defaults to Decimal if not specified
-    _ratioSeparator; // default is ":"; separator character used in ratio formatting
+    _ratioSeparator; // default is ":"; separator string used in ratio formatting
     _azimuthBase; // value always clockwise from north
     _azimuthBaseUnit; // unit for azimuthBase value
     _azimuthCounterClockwise; // if set to true, azimuth values are returned counter-clockwise from base
@@ -137,11 +137,12 @@ class BaseFormat {
             if (undefined === formatProps.ratioType)
                 throw new Exception_1.QuantityError(Exception_1.QuantityStatus.InvalidJson, `The Format ${this.name} is 'Ratio' type therefore the attribute 'ratioType' is required.`);
             this._ratioType = (0, FormatEnums_1.parseRatioType)(formatProps.ratioType, this.name);
-            if (undefined !== formatProps.ratioSeparator) { // optional; default is 0.0
+            if (undefined !== formatProps.ratioSeparator) { // optional; default is ":"
                 if (typeof (formatProps.ratioSeparator) !== "string")
                     throw new Exception_1.QuantityError(Exception_1.QuantityStatus.InvalidJson, `The Format ${this.name} has an invalid 'ratioSeparator' attribute. It should be of type 'string'.`);
-                if (formatProps.ratioSeparator.length !== 1)
-                    throw new Exception_1.QuantityError(Exception_1.QuantityStatus.InvalidJson, `The Format ${this.name} has an invalid 'ratioSeparator' attribute. It should be a one character string.`);
+                const nonSpaceCharacters = [...formatProps.ratioSeparator].filter((character) => character !== " ");
+                if (nonSpaceCharacters.length !== 1 || nonSpaceCharacters[0].trim().length === 0)
+                    throw new Exception_1.QuantityError(Exception_1.QuantityStatus.InvalidJson, `The Format ${this.name} has an invalid 'ratioSeparator' attribute. It should contain exactly one non-space character, optionally surrounded by spaces.`);
                 this._ratioSeparator = formatProps.ratioSeparator;
             }
             else {
@@ -376,6 +377,12 @@ class Format extends BaseFormat {
         await actualFormat.fromJSON(unitsProvider, formatProps);
         return actualFormat;
     }
+    /** Create a `Format` from `FormatProps` using a synchronous unit provider. */
+    static createFromJSONSync(name, unitsProvider, formatProps) {
+        const actualFormat = new Format(name);
+        actualFormat.fromFullyResolvedJSON(resolveFormatPropsSync(name, unitsProvider, formatProps));
+        return actualFormat;
+    }
     static createFromFullyResolvedJSON(name, formatProps) {
         const actualFormat = new Format(name);
         actualFormat.fromFullyResolvedJSON(formatProps);
@@ -443,52 +450,50 @@ class Format extends BaseFormat {
     }
 }
 exports.Format = Format;
-async function resolveCompositeUnit(provider, name, label) {
+function validateCompositeUnitInput(name, label) {
     if (typeof name !== "string" || (undefined !== label && typeof label !== "string")) {
         throw new Exception_1.QuantityError(Exception_1.QuantityStatus.InvalidJson, `This Composite has a unit with an invalid 'name' or 'label' attribute.`);
     }
-    const unit = await provider.findUnitByName(name);
+}
+function validateResolvedUnit(unit, errorMessage) {
     if (!unit || !unit.isValid) {
-        throw new Exception_1.QuantityError(Exception_1.QuantityStatus.InvalidJson, `Invalid unit name '${name}'.`);
+        throw new Exception_1.QuantityError(Exception_1.QuantityStatus.InvalidJson, errorMessage);
     }
     return unit;
 }
-async function resolveAzimuthBearingUnit(formatName, jsonObj, key, provider) {
+function getAzimuthBearingUnitName(formatName, jsonObj, key) {
     const unitName = jsonObj[key];
-    if (undefined !== unitName) {
-        if (typeof unitName !== "string") {
-            throw new Exception_1.QuantityError(Exception_1.QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid '${key}' attribute. It should be of type 'string'.`);
-        }
-        const unit = await provider.findUnitByName(unitName);
-        if (!unit || !unit.isValid) {
-            throw new Exception_1.QuantityError(Exception_1.QuantityStatus.InvalidJson, `Invalid unit name '${unitName}' for ${key} in Format '${formatName}'.`);
-        }
-        return unit;
+    if (undefined !== unitName && typeof unitName !== "string") {
+        throw new Exception_1.QuantityError(Exception_1.QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid '${key}' attribute. It should be of type 'string'.`);
     }
-    return undefined;
+    return unitName;
 }
-async function resolveFormatProps(formatName, unitsProvider, jsonObj) {
-    let units;
-    if (undefined !== jsonObj.composite?.units) {
-        units = await Promise.all(jsonObj.composite.units.map(async (entry) => {
-            const unit = await resolveCompositeUnit(unitsProvider, entry.name);
-            return { unit, label: entry.label };
-        }));
-        // For Ratio formats with 2 units: validate both units have the same phenomenon
-        const formatType = (0, FormatEnums_1.parseFormatType)(jsonObj.type, formatName);
-        if (formatType === FormatEnums_1.FormatType.Ratio && units.length === 2) {
-            const phenomenon1 = units[0].unit.phenomenon;
-            const phenomenon2 = units[1].unit.phenomenon;
-            if (phenomenon1 !== phenomenon2) {
-                throw new Exception_1.QuantityError(Exception_1.QuantityStatus.InvalidJson, `The Format ${formatName} has 2-unit composite with different phenomena. Both units must have the same phenomenon. Found '${phenomenon1}' and '${phenomenon2}'.`);
-            }
+async function resolveCompositeUnit(provider, name, label) {
+    validateCompositeUnitInput(name, label);
+    return validateResolvedUnit(await provider.findUnitByName(name), `Invalid unit name '${name}'.`);
+}
+function resolveCompositeUnitSync(provider, name, label) {
+    validateCompositeUnitInput(name, label);
+    return validateResolvedUnit(provider.findUnitByNameSync(name), `Invalid unit name '${name}'.`);
+}
+async function resolveAzimuthBearingUnit(formatName, jsonObj, key, provider) {
+    const unitName = getAzimuthBearingUnitName(formatName, jsonObj, key);
+    return undefined === unitName ? undefined : validateResolvedUnit(await provider.findUnitByName(unitName), `Invalid unit name '${unitName}' for ${key} in Format '${formatName}'.`);
+}
+function resolveAzimuthBearingUnitSync(formatName, jsonObj, key, provider) {
+    const unitName = getAzimuthBearingUnitName(formatName, jsonObj, key);
+    return undefined === unitName ? undefined : validateResolvedUnit(provider.findUnitByNameSync(unitName), `Invalid unit name '${unitName}' for ${key} in Format '${formatName}'.`);
+}
+function validateResolvedFormatProps(formatName, jsonObj, units, azimuthBaseUnit, revolutionUnit) {
+    const formatType = (0, FormatEnums_1.parseFormatType)(jsonObj.type, formatName);
+    if (formatType === FormatEnums_1.FormatType.Ratio && units?.length === 2) {
+        const phenomenon1 = units[0].unit.phenomenon;
+        const phenomenon2 = units[1].unit.phenomenon;
+        if (phenomenon1 !== phenomenon2) {
+            throw new Exception_1.QuantityError(Exception_1.QuantityStatus.InvalidJson, `The Format ${formatName} has 2-unit composite with different phenomena. Both units must have the same phenomenon. Found '${phenomenon1}' and '${phenomenon2}'.`);
         }
     }
-    let azimuthBaseUnit, revolutionUnit;
-    const type = (0, FormatEnums_1.parseFormatType)(jsonObj.type, formatName);
-    if (type === FormatEnums_1.FormatType.Azimuth || type === FormatEnums_1.FormatType.Bearing) {
-        azimuthBaseUnit = await resolveAzimuthBearingUnit(formatName, jsonObj, "azimuthBaseUnit", unitsProvider);
-        revolutionUnit = await resolveAzimuthBearingUnit(formatName, jsonObj, "revolutionUnit", unitsProvider);
+    if (formatType === FormatEnums_1.FormatType.Azimuth || formatType === FormatEnums_1.FormatType.Bearing) {
         if (!revolutionUnit) {
             throw new Exception_1.QuantityError(Exception_1.QuantityStatus.InvalidJson, `The Format ${formatName} is 'Azimuth' or 'Bearing' type therefore the attribute 'revolutionUnit' is required.`);
         }
@@ -496,6 +501,8 @@ async function resolveFormatProps(formatName, unitsProvider, jsonObj) {
             throw new Exception_1.QuantityError(Exception_1.QuantityStatus.InvalidJson, `The Format ${formatName} has an 'azimuthBase' attribute therefore the attribute 'azimuthBaseUnit' is required.`);
         }
     }
+}
+function createResolvedFormatProps(jsonObj, units, azimuthBaseUnit, revolutionUnit) {
     return {
         ...jsonObj,
         azimuthBaseUnit,
@@ -506,4 +513,36 @@ async function resolveFormatProps(formatName, unitsProvider, jsonObj) {
         } : undefined,
     };
 }
+async function resolveFormatProps(formatName, unitsProvider, jsonObj) {
+    const units = undefined === jsonObj.composite?.units ? undefined : await Promise.all(jsonObj.composite.units.map(async (entry) => ({
+        // Label is intentionally not validated, matching master: existing JSON may carry a non-string label (e.g. null).
+        unit: await resolveCompositeUnit(unitsProvider, entry.name),
+        label: entry.label,
+    })));
+    let azimuthBaseUnit;
+    let revolutionUnit;
+    const formatType = (0, FormatEnums_1.parseFormatType)(jsonObj.type, formatName);
+    if (formatType === FormatEnums_1.FormatType.Azimuth || formatType === FormatEnums_1.FormatType.Bearing) {
+        azimuthBaseUnit = await resolveAzimuthBearingUnit(formatName, jsonObj, "azimuthBaseUnit", unitsProvider);
+        revolutionUnit = await resolveAzimuthBearingUnit(formatName, jsonObj, "revolutionUnit", unitsProvider);
+    }
+    validateResolvedFormatProps(formatName, jsonObj, units, azimuthBaseUnit, revolutionUnit);
+    return createResolvedFormatProps(jsonObj, units, azimuthBaseUnit, revolutionUnit);
+}
+function resolveFormatPropsSync(formatName, unitsProvider, jsonObj) {
+    const units = undefined === jsonObj.composite?.units ? undefined : jsonObj.composite.units.map((entry) => ({
+        // Keep in sync with resolveFormatProps: label is intentionally not validated.
+        unit: resolveCompositeUnitSync(unitsProvider, entry.name),
+        label: entry.label,
+    }));
+    let azimuthBaseUnit;
+    let revolutionUnit;
+    const formatType = (0, FormatEnums_1.parseFormatType)(jsonObj.type, formatName);
+    if (formatType === FormatEnums_1.FormatType.Azimuth || formatType === FormatEnums_1.FormatType.Bearing) {
+        azimuthBaseUnit = resolveAzimuthBearingUnitSync(formatName, jsonObj, "azimuthBaseUnit", unitsProvider);
+        revolutionUnit = resolveAzimuthBearingUnitSync(formatName, jsonObj, "revolutionUnit", unitsProvider);
+    }
+    validateResolvedFormatProps(formatName, jsonObj, units, azimuthBaseUnit, revolutionUnit);
+    return createResolvedFormatProps(jsonObj, units, azimuthBaseUnit, revolutionUnit);
+}
 //# sourceMappingURL=Format.js.map