@itwin/core-quantity 5.9.0-dev.9 → 5.9.1

package/CHANGELOG.md

@@ -1,6 +1,37 @@
 # Change Log - @itwin/core-quantity
 
-This log was last generated on Fri, 10 Apr 2026 13:03:16 GMT and should not be manually modified.
+This log was last generated on Tue, 05 May 2026 17:43:30 GMT and should not be manually modified.
+
+## 5.9.1
+Tue, 05 May 2026 17:43:30 GMT
+
+_Version update only_
+
+## 5.9.0
+Mon, 04 May 2026 16:32:08 GMT
+
+### Minor changes
+
+- Add Units namespace with typed constants, findPersistenceUnitForPhenomenon helper, and impliedUnitSystem to FormatsChangedArgs.
+
+### Updates
+
+- Added BasicUnitsProvider (bundled BIS units), createUnitsProvider factory, and CreateUnitsProviderOptions interface. Added UnitConversion math, parseDefinition, and Graph utilities (moved from ecschema-metadata). Added SerializedUnitSchema types and UnitDefinitionResolver.
+
+## 5.8.4
+Thu, 23 Apr 2026 18:05:14 GMT
+
+_Version update only_
+
+## 5.8.3
+Thu, 23 Apr 2026 14:52:42 GMT
+
+_Version update only_
+
+## 5.8.2
+Thu, 16 Apr 2026 11:05:01 GMT
+
+_Version update only_
 
 ## 5.8.1
 Fri, 10 Apr 2026 13:02:00 GMT

package/lib/cjs/BasicUnitsProvider.d.ts

@@ -0,0 +1,44 @@
+import { type UnitConversionProps, type UnitProps, type UnitsProvider } from "./Interfaces";
+/** @internal — test use only. Resets the 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 ~90 KB bundled JSON is loaded lazily via dynamic `import()` on the first provider method
+ * call and cached at module scope — construction is essentially free, and multiple instances
+ * share the same immutable lookup indexes.
+ *
+ * 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.
+ *
+ * @see createUnitsProvider for layering schema-defined units on top of basic BIS units.
+ * @beta
+ */
+export declare class BasicUnitsProvider implements UnitsProvider {
+    /** 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"`.
+     * @param phenomenon - Optional phenomenon filter (e.g. `"Units.LENGTH"`).
+     * @param unitSystem - Optional unit system filter (e.g. `"Units.METRIC"`).
+     * @returns The matching `UnitProps`, or a `BadUnit` if no match is found.
+     */
+    findUnit(unitLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps>;
+    /** Return all units belonging to the given phenomenon (unit family).
+     * @param phenomenon - The phenomenon full name (e.g. `"Units.LENGTH"`).
+     * @returns An array of matching `UnitProps`, or an empty array if none.
+     */
+    getUnitsByFamily(phenomenon: string): Promise<UnitProps[]>;
+    /** Find a unit by its fully-qualified name (e.g. `"Units.M"`).
+     * @param unitName - The qualified unit name.
+     * @returns The matching `UnitProps`, or a `BadUnit` if not found.
+     */
+    findUnitByName(unitName: string): Promise<UnitProps>;
+    /** Compute the conversion factors from `fromUnit` to `toUnit`.
+     * Handles normal units, inverted units, and mixed (inverted ↔ non-inverted) conversions.
+     * @param fromUnit - The source unit.
+     * @param toUnit - The target unit.
+     * @returns A `UnitConversionProps` with `factor`, `offset`, and optionally `inversion` and `error`.
+     */
+    getConversion(fromUnit: UnitProps, toUnit: UnitProps): Promise<UnitConversionProps>;
+}
+//# sourceMappingURL=BasicUnitsProvider.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BasicUnitsProvider.d.ts","sourceRoot":"","sources":["../../src/BasicUnitsProvider.ts"],"names":[],"mappings":"AAIA,OAAO,EAAwB,KAAK,mBAAmB,EAAE,KAAK,SAAS,EAAE,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAgDlH,qEAAqE;AACrE,wBAAgB,oBAAoB,IAAI,IAAI,CAG3C;AAsFD;;;;;;;;;;;;GAYG;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,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAkDjG"}

package/lib/cjs/BasicUnitsProvider.js

@@ -0,0 +1,241 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BasicUnitsProvider = void 0;
+exports._testResetUnitsCache = _testResetUnitsCache;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+const Interfaces_1 = require("./Interfaces");
+const UnitDefinitionResolver_1 = require("./UnitConversion/UnitDefinitionResolver");
+const nameUtils_1 = require("./UnitConversion/nameUtils");
+const Unit_1 = require("./Unit");
+// Module-level cache: the unit data is derived deterministically from the bundled Units.json
+// asset, so the resolved indexes are effectively an immutable constant. Caching at module
+// scope avoids redundant work when multiple BasicUnitsProvider instances are created (e.g.
+// in tests or when composed inside CompositeUnitsProvider).
+// The JSON is loaded lazily via dynamic import() on first use, keeping the module footprint
+// near-zero until a provider method is actually called.
+let _resolvePromise;
+let _permanentError;
+async function resolveState() {
+    if (_permanentError !== undefined) {
+        throw _permanentError;
+    }
+    if (!_resolvePromise) {
+        _resolvePromise = _buildState().catch((err) => {
+            _permanentError = err instanceof Error ? err : new Error(String(err));
+            _resolvePromise = undefined;
+            throw _permanentError;
+        });
+    }
+    return _resolvePromise;
+}
+/** @internal — test use only. Resets the module-level lazy cache. */
+function _testResetUnitsCache() {
+    _resolvePromise = undefined;
+    _permanentError = undefined;
+}
+async function _buildState() {
+    const { default: schema } = await Promise.resolve().then(() => __importStar(require("./assets/Units.json")));
+    const nameMap = new Map();
+    const labelMap = new Map();
+    const phenomenonMap = new Map();
+    const invertedUnits = new Map();
+    const s = schema;
+    const resolver = new UnitDefinitionResolver_1.UnitDefinitionResolver(s);
+    const resolved = resolver.resolveAll();
+    for (const [name, entry] of resolved) {
+        const item = s.items[name];
+        const phenomenon = item.phenomenon;
+        const unitSystem = item.unitSystem;
+        const fullName = `${s.name}.${name}`;
+        const props = {
+            name: fullName,
+            label: entry.label,
+            phenomenon,
+            isValid: true,
+            system: unitSystem,
+        };
+        const indexed = { props, resolved: entry };
+        nameMap.set(fullName, indexed);
+        const lowerLabel = entry.label.toLowerCase();
+        const byLabel = labelMap.get(lowerLabel) ?? [];
+        byLabel.push(indexed);
+        labelMap.set(lowerLabel, byLabel);
+        const byPhen = phenomenonMap.get(phenomenon) ?? [];
+        byPhen.push(indexed);
+        phenomenonMap.set(phenomenon, byPhen);
+    }
+    // Handle InvertedUnit items — must run after nameMap is fully populated above because
+    // invertedSource lookup requires the inverted unit's target to already be in nameMap.
+    for (const [name, item] of Object.entries(s.items)) {
+        if (item.schemaItemType !== "InvertedUnit") {
+            continue;
+        }
+        const inv = item;
+        const fullName = `${s.name}.${name}`;
+        const invertsName = (0, nameUtils_1.qualifyItemName)(inv.invertsUnit, s.name);
+        const unitSystem = inv.unitSystem;
+        const invertedSource = nameMap.get(invertsName);
+        const phenomenon = invertedSource?.props.phenomenon ?? "";
+        const props = {
+            name: fullName,
+            label: inv.label ?? name,
+            phenomenon,
+            isValid: true,
+            system: unitSystem,
+        };
+        invertedUnits.set(fullName, { props, invertsUnitName: invertsName });
+        if (invertedSource) {
+            const indexed = {
+                props,
+                resolved: { ...invertedSource.resolved, name: fullName, label: props.label, unitSystem },
+            };
+            nameMap.set(fullName, indexed);
+            const lowerLabel = props.label.toLowerCase();
+            const byLabel = labelMap.get(lowerLabel) ?? [];
+            byLabel.push(indexed);
+            labelMap.set(lowerLabel, byLabel);
+            const byPhen = phenomenonMap.get(phenomenon) ?? [];
+            byPhen.push(indexed);
+            phenomenonMap.set(phenomenon, byPhen);
+        }
+    }
+    return { nameMap, labelMap, phenomenonMap, invertedUnits, schemaName: s.name };
+}
+/**
+ * A `UnitsProvider` backed by the full BIS `Units.ecschema.json` bundled as a JSON asset.
+ *
+ * The ~90 KB bundled JSON is loaded lazily via dynamic `import()` on the first provider method
+ * call and cached at module scope — construction is essentially free, and multiple instances
+ * share the same immutable lookup indexes.
+ *
+ * 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.
+ *
+ * @see createUnitsProvider for layering schema-defined units on top of basic BIS units.
+ * @beta
+ */
+class BasicUnitsProvider {
+    // ── 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).
+     * @param schemaName - Optional schema name filter. Returns `BadUnit` if provided and not `"Units"`.
+     * @param phenomenon - Optional phenomenon filter (e.g. `"Units.LENGTH"`).
+     * @param unitSystem - Optional unit system filter (e.g. `"Units.METRIC"`).
+     * @returns The matching `UnitProps`, or a `BadUnit` if no match is found.
+     */
+    async findUnit(unitLabel, schemaName, phenomenon, unitSystem) {
+        const state = await resolveState();
+        if (schemaName && schemaName !== state.schemaName) {
+            return new Unit_1.BadUnit();
+        }
+        const candidates = state.labelMap.get(unitLabel.toLowerCase());
+        if (!candidates || candidates.length === 0) {
+            return new Unit_1.BadUnit();
+        }
+        for (const c of candidates) {
+            if (phenomenon && c.props.phenomenon !== phenomenon) {
+                continue;
+            }
+            if (unitSystem && c.props.system !== unitSystem) {
+                continue;
+            }
+            return c.props;
+        }
+        return new Unit_1.BadUnit();
+    }
+    /** Return all units belonging to the given phenomenon (unit family).
+     * @param phenomenon - The phenomenon full name (e.g. `"Units.LENGTH"`).
+     * @returns An array of matching `UnitProps`, or an empty array if none.
+     */
+    async getUnitsByFamily(phenomenon) {
+        const state = await resolveState();
+        const entries = state.phenomenonMap.get(phenomenon);
+        return entries ? entries.map((e) => e.props) : [];
+    }
+    /** Find a unit by its fully-qualified name (e.g. `"Units.M"`).
+     * @param unitName - The qualified unit name.
+     * @returns The matching `UnitProps`, or a `BadUnit` if not found.
+     */
+    async findUnitByName(unitName) {
+        const state = await resolveState();
+        const entry = state.nameMap.get(unitName);
+        return entry ? entry.props : new Unit_1.BadUnit();
+    }
+    /** Compute the conversion factors from `fromUnit` to `toUnit`.
+     * Handles normal units, inverted units, and mixed (inverted ↔ non-inverted) conversions.
+     * @param fromUnit - The source unit.
+     * @param toUnit - The target unit.
+     * @returns A `UnitConversionProps` with `factor`, `offset`, and optionally `inversion` and `error`.
+     */
+    async getConversion(fromUnit, toUnit) {
+        const state = await resolveState();
+        const from = state.nameMap.get(fromUnit.name);
+        const to = state.nameMap.get(toUnit.name);
+        if (!from || !to) {
+            return { factor: 1.0, offset: 0.0, error: true };
+        }
+        const fromInverted = state.invertedUnits.get(fromUnit.name);
+        const toInverted = state.invertedUnits.get(toUnit.name);
+        const fromPhenomenon = fromInverted
+            ? state.nameMap.get(fromInverted.invertsUnitName)?.props.phenomenon
+            : from.props.phenomenon;
+        const toPhenomenon = toInverted
+            ? state.nameMap.get(toInverted.invertsUnitName)?.props.phenomenon
+            : to.props.phenomenon;
+        if (fromPhenomenon !== toPhenomenon) {
+            return { factor: 1.0, offset: 0.0, error: true };
+        }
+        if (fromInverted && toInverted) {
+            const innerFrom = state.nameMap.get(fromInverted.invertsUnitName);
+            const innerTo = state.nameMap.get(toInverted.invertsUnitName);
+            if (innerFrom && innerTo) {
+                const c = innerFrom.resolved.conversion.inverse().compose(innerTo.resolved.conversion);
+                return { factor: c.factor, offset: c.offset };
+            }
+        }
+        if (fromInverted) {
+            const innerFrom = state.nameMap.get(fromInverted.invertsUnitName);
+            if (innerFrom) {
+                const c = innerFrom.resolved.conversion.inverse().compose(to.resolved.conversion);
+                return { factor: c.factor, offset: c.offset, inversion: Interfaces_1.UnitConversionInvert.InvertPreConversion };
+            }
+        }
+        if (toInverted) {
+            const innerTo = state.nameMap.get(toInverted.invertsUnitName);
+            if (innerTo) {
+                const c = from.resolved.conversion.inverse().compose(innerTo.resolved.conversion);
+                return { factor: c.factor, offset: c.offset, inversion: Interfaces_1.UnitConversionInvert.InvertPostConversion };
+            }
+        }
+        const conv = from.resolved.conversion.inverse().compose(to.resolved.conversion);
+        return { factor: conv.factor, offset: conv.offset };
+    }
+}
+exports.BasicUnitsProvider = BasicUnitsProvider;
+//# sourceMappingURL=BasicUnitsProvider.js.map

package/lib/cjs/BasicUnitsProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BasicUnitsProvider.js","sourceRoot":"","sources":["../../src/BasicUnitsProvider.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAqDA,oDAGC;AAxDD;;;+FAG+F;AAC/F,6CAAkH;AAElH,oFAAoG;AACpG,0DAA6D;AAC7D,iCAAiC;AAqBjC,6FAA6F;AAC7F,0FAA0F;AAC1F,2FAA2F;AAC3F,4DAA4D;AAC5D,4FAA4F;AAC5F,wDAAwD;AACxD,IAAI,eAAmD,CAAC;AACxD,IAAI,eAAkC,CAAC;AAEvC,KAAK,UAAU,YAAY;IACzB,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QAClC,MAAM,eAAe,CAAC;IACxB,CAAC;IACD,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,eAAe,GAAG,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YAC5C,eAAe,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YACtE,eAAe,GAAG,SAAS,CAAC;YAC5B,MAAM,eAAe,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,eAAe,CAAC;AACzB,CAAC;AAED,qEAAqE;AACrE,SAAgB,oBAAoB;IAClC,eAAe,GAAG,SAAS,CAAC;IAC5B,eAAe,GAAG,SAAS,CAAC;AAC9B,CAAC;AAED,KAAK,UAAU,WAAW;IACxB,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,wDAAa,qBAAqB,GAAC,CAAC;IAEhE,MAAM,OAAO,GAAG,IAAI,GAAG,EAAuB,CAAC;IAC/C,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAyB,CAAC;IAClD,MAAM,aAAa,GAAG,IAAI,GAAG,EAAyB,CAAC;IACvD,MAAM,aAAa,GAAG,IAAI,GAAG,EAAyB,CAAC;IAEvD,MAAM,CAAC,GAAG,MAA8B,CAAC;IACzC,MAAM,QAAQ,GAAG,IAAI,+CAAsB,CAAC,CAAC,CAAC,CAAC;IAC/C,MAAM,QAAQ,GAAG,QAAQ,CAAC,UAAU,EAAE,CAAC;IAEvC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAmB,CAAC;QAC7C,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACnC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAEnC,MAAM,QAAQ,GAAG,GAAG,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;QACrC,MAAM,KAAK,GAAc;YACvB,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,UAAU;YACV,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,UAAU;SACnB,CAAC;QAEF,MAAM,OAAO,GAAgB,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;QAExD,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC/B,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAC7C,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QAC/C,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtB,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAElC,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QACnD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrB,aAAa,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACxC,CAAC;IAED,sFAAsF;IACtF,sFAAsF;IACtF,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;QACnD,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,EAAE,CAAC;YAC3C,SAAS;QACX,CAAC;QACD,MAAM,GAAG,GAA2B,IAAI,CAAC;QACzC,MAAM,QAAQ,GAAG,GAAG,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;QACrC,MAAM,WAAW,GAAG,IAAA,2BAAe,EAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QAC7D,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC;QAElC,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,UAAU,GAAG,cAAc,EAAE,KAAK,CAAC,UAAU,IAAI,EAAE,CAAC;QAE1D,MAAM,KAAK,GAAc;YACvB,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG,CAAC,KAAK,IAAI,IAAI;YACxB,UAAU;YACV,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,UAAU;SACnB,CAAC;QAEF,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,CAAC,CAAC;QAErE,IAAI,cAAc,EAAE,CAAC;YACnB,MAAM,OAAO,GAAgB;gBAC3B,KAAK;gBACL,QAAQ,EAAE,EAAE,GAAG,cAAc,CAAC,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,UAAU,EAAE;aACzF,CAAC;YACF,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAE/B,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;YAC7C,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;YAC/C,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACtB,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YAElC,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;YACnD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACrB,aAAa,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AACjF,CAAC;AAED;;;;;;;;;;;;GAYG;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,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAE1C,IAAI,CAAC,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;YACjB,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACnD,CAAC;QAED,MAAM,YAAY,GAAG,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC5D,MAAM,UAAU,GAAG,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAExD,MAAM,cAAc,GAAG,YAAY;YACjC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,UAAU;YACnE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;QAC1B,MAAM,YAAY,GAAG,UAAU;YAC7B,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,UAAU;YACjE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC;QACxB,IAAI,cAAc,KAAK,YAAY,EAAE,CAAC;YACpC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACnD,CAAC;QAED,IAAI,YAAY,IAAI,UAAU,EAAE,CAAC;YAC/B,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;YAClE,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;YAC9D,IAAI,SAAS,IAAI,OAAO,EAAE,CAAC;gBACzB,MAAM,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBACvF,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;YAChD,CAAC;QACH,CAAC;QAED,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;YAClE,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBAClF,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,iCAAoB,CAAC,mBAAmB,EAAE,CAAC;YACrG,CAAC;QACH,CAAC;QAED,IAAI,UAAU,EAAE,CAAC;YACf,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;YAC9D,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBAClF,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,iCAAoB,CAAC,oBAAoB,EAAE,CAAC;YACtG,CAAC;QACH,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAChF,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;IACtD,CAAC;CACF;AA9GD,gDA8GC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\nimport { UnitConversionInvert, type UnitConversionProps, type UnitProps, type UnitsProvider } from \"./Interfaces\";\nimport type { SerializedInvertedUnit, SerializedUnit, SerializedUnitSchema } from \"./SerializedUnitSchema\";\nimport { type ResolvedUnit, UnitDefinitionResolver } from \"./UnitConversion/UnitDefinitionResolver\";\nimport { qualifyItemName } from \"./UnitConversion/nameUtils\";\nimport { BadUnit } from \"./Unit\";\n\ninterface IndexedUnit {\n  readonly props: UnitProps;\n  readonly resolved: ResolvedUnit;\n}\n\ninterface InvertedEntry {\n  readonly props: UnitProps;\n  readonly invertsUnitName: string;\n}\n\n/** Immutable lookup indexes resolved from the bundled Units.json. */\ninterface ResolvedState {\n  readonly nameMap: Map<string, IndexedUnit>;\n  readonly labelMap: Map<string, IndexedUnit[]>;\n  readonly phenomenonMap: Map<string, IndexedUnit[]>;\n  readonly invertedUnits: Map<string, InvertedEntry>;\n  readonly schemaName: string;\n}\n\n// Module-level cache: the unit data is derived deterministically from the bundled Units.json\n// asset, so the resolved indexes are effectively an immutable constant. Caching at module\n// scope avoids redundant work when multiple BasicUnitsProvider instances are created (e.g.\n// in tests or when composed inside CompositeUnitsProvider).\n// The JSON is loaded lazily via dynamic import() on first use, keeping the module footprint\n// near-zero until a provider method is actually called.\nlet _resolvePromise: Promise<ResolvedState> | undefined;\nlet _permanentError: Error | undefined;\n\nasync function resolveState(): Promise<ResolvedState> {\n  if (_permanentError !== undefined) {\n    throw _permanentError;\n  }\n  if (!_resolvePromise) {\n    _resolvePromise = _buildState().catch((err) => {\n      _permanentError = err instanceof Error ? err : new Error(String(err));\n      _resolvePromise = undefined;\n      throw _permanentError;\n    });\n  }\n  return _resolvePromise;\n}\n\n/** @internal — test use only. Resets the module-level lazy cache. */\nexport function _testResetUnitsCache(): void {\n  _resolvePromise = undefined;\n  _permanentError = undefined;\n}\n\nasync function _buildState(): Promise<ResolvedState> {\n  const { default: schema } = await import(\"./assets/Units.json\");\n\n  const nameMap = new Map<string, IndexedUnit>();\n  const labelMap = new Map<string, IndexedUnit[]>();\n  const phenomenonMap = new Map<string, IndexedUnit[]>();\n  const invertedUnits = new Map<string, InvertedEntry>();\n\n  const s = schema as SerializedUnitSchema;\n  const resolver = new UnitDefinitionResolver(s);\n  const resolved = resolver.resolveAll();\n\n  for (const [name, entry] of resolved) {\n    const item = s.items[name] as SerializedUnit;\n    const phenomenon = item.phenomenon;\n    const unitSystem = item.unitSystem;\n\n    const fullName = `${s.name}.${name}`;\n    const props: UnitProps = {\n      name: fullName,\n      label: entry.label,\n      phenomenon,\n      isValid: true,\n      system: unitSystem,\n    };\n\n    const indexed: IndexedUnit = { props, resolved: entry };\n\n    nameMap.set(fullName, indexed);\n    const lowerLabel = entry.label.toLowerCase();\n    const byLabel = labelMap.get(lowerLabel) ?? [];\n    byLabel.push(indexed);\n    labelMap.set(lowerLabel, byLabel);\n\n    const byPhen = phenomenonMap.get(phenomenon) ?? [];\n    byPhen.push(indexed);\n    phenomenonMap.set(phenomenon, byPhen);\n  }\n\n  // Handle InvertedUnit items — must run after nameMap is fully populated above because\n  // invertedSource lookup requires the inverted unit's target to already be in nameMap.\n  for (const [name, item] of Object.entries(s.items)) {\n    if (item.schemaItemType !== \"InvertedUnit\") {\n      continue;\n    }\n    const inv: SerializedInvertedUnit = item;\n    const fullName = `${s.name}.${name}`;\n    const invertsName = qualifyItemName(inv.invertsUnit, s.name);\n    const unitSystem = inv.unitSystem;\n\n    const invertedSource = nameMap.get(invertsName);\n    const phenomenon = invertedSource?.props.phenomenon ?? \"\";\n\n    const props: UnitProps = {\n      name: fullName,\n      label: inv.label ?? name,\n      phenomenon,\n      isValid: true,\n      system: unitSystem,\n    };\n\n    invertedUnits.set(fullName, { props, invertsUnitName: invertsName });\n\n    if (invertedSource) {\n      const indexed: IndexedUnit = {\n        props,\n        resolved: { ...invertedSource.resolved, name: fullName, label: props.label, unitSystem },\n      };\n      nameMap.set(fullName, indexed);\n\n      const lowerLabel = props.label.toLowerCase();\n      const byLabel = labelMap.get(lowerLabel) ?? [];\n      byLabel.push(indexed);\n      labelMap.set(lowerLabel, byLabel);\n\n      const byPhen = phenomenonMap.get(phenomenon) ?? [];\n      byPhen.push(indexed);\n      phenomenonMap.set(phenomenon, byPhen);\n    }\n  }\n\n  return { nameMap, labelMap, phenomenonMap, invertedUnits, schemaName: s.name };\n}\n\n/**\n * A `UnitsProvider` backed by the full BIS `Units.ecschema.json` bundled as a JSON asset.\n *\n * The ~90 KB bundled JSON is loaded lazily via dynamic `import()` on the first provider method\n * call and cached at module scope — construction is essentially free, and multiple instances\n * share the same immutable lookup indexes.\n *\n * This is the zero-dependency default for backends, tools, and any frontend that doesn't need\n * iModel overrides. Equivalent to calling `createUnitsProvider()` with no arguments.\n *\n * @see createUnitsProvider for layering schema-defined units on top of basic BIS units.\n * @beta\n */\nexport class BasicUnitsProvider implements UnitsProvider {\n\n  // ── UnitsProvider implementation ─────────────────────────────────────\n\n  /** Find a unit by its display label, optionally filtering by schema name, phenomenon, and unit system.\n   * @param unitLabel - The display label to search for (case-insensitive).\n   * @param schemaName - Optional schema name filter. Returns `BadUnit` if provided and not `\"Units\"`.\n   * @param phenomenon - Optional phenomenon filter (e.g. `\"Units.LENGTH\"`).\n   * @param unitSystem - Optional unit system filter (e.g. `\"Units.METRIC\"`).\n   * @returns The matching `UnitProps`, or a `BadUnit` if no match is found.\n   */\n  public async findUnit(unitLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps> {\n    const state = await resolveState();\n    if (schemaName && schemaName !== state.schemaName) {\n      return new BadUnit();\n    }\n    const candidates = state.labelMap.get(unitLabel.toLowerCase());\n    if (!candidates || candidates.length === 0) {\n      return new BadUnit();\n    }\n\n    for (const c of candidates) {\n      if (phenomenon && c.props.phenomenon !== phenomenon) {\n        continue;\n      }\n      if (unitSystem && c.props.system !== unitSystem) {\n        continue;\n      }\n      return c.props;\n    }\n\n    return new BadUnit();\n  }\n\n  /** Return all units belonging to the given phenomenon (unit family).\n   * @param phenomenon - The phenomenon full name (e.g. `\"Units.LENGTH\"`).\n   * @returns An array of matching `UnitProps`, or an empty array if none.\n   */\n  public async getUnitsByFamily(phenomenon: string): Promise<UnitProps[]> {\n    const state = await resolveState();\n    const entries = state.phenomenonMap.get(phenomenon);\n    return entries ? entries.map((e) => e.props) : [];\n  }\n\n  /** Find a unit by its fully-qualified name (e.g. `\"Units.M\"`).\n   * @param unitName - The qualified unit name.\n   * @returns The matching `UnitProps`, or a `BadUnit` if not found.\n   */\n  public async findUnitByName(unitName: string): Promise<UnitProps> {\n    const state = await resolveState();\n    const entry = state.nameMap.get(unitName);\n    return entry ? entry.props : new BadUnit();\n  }\n\n  /** Compute the conversion factors from `fromUnit` to `toUnit`.\n   * Handles normal units, inverted units, and mixed (inverted ↔ non-inverted) conversions.\n   * @param fromUnit - The source unit.\n   * @param toUnit - The target unit.\n   * @returns A `UnitConversionProps` with `factor`, `offset`, and optionally `inversion` and `error`.\n   */\n  public async getConversion(fromUnit: UnitProps, toUnit: UnitProps): Promise<UnitConversionProps> {\n    const state = await resolveState();\n    const from = state.nameMap.get(fromUnit.name);\n    const to = state.nameMap.get(toUnit.name);\n\n    if (!from || !to) {\n      return { factor: 1.0, offset: 0.0, error: true };\n    }\n\n    const fromInverted = state.invertedUnits.get(fromUnit.name);\n    const toInverted = state.invertedUnits.get(toUnit.name);\n\n    const fromPhenomenon = fromInverted\n      ? state.nameMap.get(fromInverted.invertsUnitName)?.props.phenomenon\n      : from.props.phenomenon;\n    const toPhenomenon = toInverted\n      ? state.nameMap.get(toInverted.invertsUnitName)?.props.phenomenon\n      : to.props.phenomenon;\n    if (fromPhenomenon !== toPhenomenon) {\n      return { factor: 1.0, offset: 0.0, error: true };\n    }\n\n    if (fromInverted && toInverted) {\n      const innerFrom = state.nameMap.get(fromInverted.invertsUnitName);\n      const innerTo = state.nameMap.get(toInverted.invertsUnitName);\n      if (innerFrom && innerTo) {\n        const c = innerFrom.resolved.conversion.inverse().compose(innerTo.resolved.conversion);\n        return { factor: c.factor, offset: c.offset };\n      }\n    }\n\n    if (fromInverted) {\n      const innerFrom = state.nameMap.get(fromInverted.invertsUnitName);\n      if (innerFrom) {\n        const c = innerFrom.resolved.conversion.inverse().compose(to.resolved.conversion);\n        return { factor: c.factor, offset: c.offset, inversion: UnitConversionInvert.InvertPreConversion };\n      }\n    }\n\n    if (toInverted) {\n      const innerTo = state.nameMap.get(toInverted.invertsUnitName);\n      if (innerTo) {\n        const c = from.resolved.conversion.inverse().compose(innerTo.resolved.conversion);\n        return { factor: c.factor, offset: c.offset, inversion: UnitConversionInvert.InvertPostConversion };\n      }\n    }\n\n    const conv = from.resolved.conversion.inverse().compose(to.resolved.conversion);\n    return { factor: conv.factor, offset: conv.offset };\n  }\n}\n"]}

package/lib/cjs/CompositeUnitsProvider.d.ts

@@ -0,0 +1,45 @@
+import type { UnitsProvider } from "./Interfaces";
+/**
+ * Options for [[createUnitsProvider]].
+ * @beta
+ */
+export interface CreateUnitsProviderOptions {
+    /**
+     * A `UnitsProvider` consulted before the basic BIS units (e.g. a `SchemaUnitProvider`
+     * for an open iModel's `SchemaContext`). When omitted, the returned provider behaves
+     * exactly like `new BasicUnitsProvider()`.
+     */
+    primary?: UnitsProvider;
+    /**
+     * Controls which provider is consulted first and wins ties.
+     * - `"preferSchema"` (default): `primary` is authoritative; bundled BIS units are fallback.
+     * - `"preferBundled"`: bundled BIS units win; `primary` is consulted only for units not in
+     *   the bundled set. Use when the iModel's schema may be stale.
+     *
+     * Affects `findUnit`, `findUnitByName`, and `getConversion` (first-consulted wins or
+     * falls through). `getUnitsByFamily` always merges both providers — the first-consulted
+     * provider wins name collisions.
+     *
+     * Has no effect when `primary` is omitted — the returned provider is a plain `BasicUnitsProvider`.
+     */
+    bisUnitsPolicy?: "preferSchema" | "preferBundled";
+}
+/**
+ * Returns a `UnitsProvider` that layers the basic BIS units under (or over) an optional
+ * `primary` provider. Typical use: layer an iModel's schema units on top of the bundled
+ * defaults from `@itwin/core-quantity`.
+ *
+ * Precedence rules:
+ * - When `primary` is supplied and `bisUnitsPolicy` is `"preferSchema"` (the default): `primary` wins;
+ *   basic BIS units fill any gaps where `primary` returns an invalid unit or throws.
+ * - When `bisUnitsPolicy` is `"preferBundled"`: basic BIS units win; `primary` is consulted only when the
+ *   basic provider can't answer.
+ * - `getUnitsByFamily` always merges results from both providers, deduplicated by
+ *   `UnitProps.name` (fully-qualified). The first-consulted provider wins ties.
+ * - When no `primary` is supplied, the returned provider is exactly `new BasicUnitsProvider()`
+ *   (no wrapper), preserving `instanceof` checks and keeping the hot path fast.
+ *
+ * @beta
+ */
+export declare function createUnitsProvider(options?: CreateUnitsProviderOptions): UnitsProvider;
+//# sourceMappingURL=CompositeUnitsProvider.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CompositeUnitsProvider.d.ts","sourceRoot":"","sources":["../../src/CompositeUnitsProvider.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAkC,aAAa,EAAE,MAAM,cAAc,CAAC;AAGlF;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC;IAExB;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAE,cAAc,GAAG,eAAe,CAAC;CACnD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,GAAE,0BAA+B,GAAG,aAAa,CAY3F"}

package/lib/cjs/CompositeUnitsProvider.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createUnitsProvider = createUnitsProvider;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+const BasicUnitsProvider_1 = require("./BasicUnitsProvider");
+const Unit_1 = require("./Unit");
+/**
+ * Returns a `UnitsProvider` that layers the basic BIS units under (or over) an optional
+ * `primary` provider. Typical use: layer an iModel's schema units on top of the bundled
+ * defaults from `@itwin/core-quantity`.
+ *
+ * Precedence rules:
+ * - When `primary` is supplied and `bisUnitsPolicy` is `"preferSchema"` (the default): `primary` wins;
+ *   basic BIS units fill any gaps where `primary` returns an invalid unit or throws.
+ * - When `bisUnitsPolicy` is `"preferBundled"`: basic BIS units win; `primary` is consulted only when the
+ *   basic provider can't answer.
+ * - `getUnitsByFamily` always merges results from both providers, deduplicated by
+ *   `UnitProps.name` (fully-qualified). The first-consulted provider wins ties.
+ * - When no `primary` is supplied, the returned provider is exactly `new BasicUnitsProvider()`
+ *   (no wrapper), preserving `instanceof` checks and keeping the hot path fast.
+ *
+ * @beta
+ */
+function createUnitsProvider(options = {}) {
+    const basic = new BasicUnitsProvider_1.BasicUnitsProvider();
+    const primary = options.primary;
+    // NOTE: returns BasicUnitsProvider directly when no primary is provided.
+    // QuantityFormatter.resetToUseInternalUnitsProvider uses instanceof BasicUnitsProvider to detect this.
+    // If this fast-path is ever wrapped (e.g. for telemetry), that guard must be updated.
+    if (!primary) {
+        return basic;
+    }
+    const providers = options.bisUnitsPolicy === "preferBundled" ? [basic, primary] : [primary, basic];
+    return new CompositeUnitsProvider(providers);
+}
+class CompositeUnitsProvider {
+    _providers;
+    constructor(_providers) {
+        this._providers = _providers;
+    }
+    async findUnit(label, schemaName, phenomenon, unitSystem) {
+        for (let i = 0; i < this._providers.length - 1; i++) {
+            const hit = await tryFind(async () => this._providers[i].findUnit(label, schemaName, phenomenon, unitSystem));
+            if (hit?.isValid) {
+                return hit;
+            }
+        }
+        return tryFind(async () => this._providers[this._providers.length - 1].findUnit(label, schemaName, phenomenon, unitSystem)).then((hit) => hit ?? new Unit_1.BadUnit());
+    }
+    async findUnitByName(name) {
+        for (let i = 0; i < this._providers.length - 1; i++) {
+            const hit = await tryFind(async () => this._providers[i].findUnitByName(name));
+            if (hit?.isValid) {
+                return hit;
+            }
+        }
+        return tryFind(async () => this._providers[this._providers.length - 1].findUnitByName(name)).then((hit) => hit ?? new Unit_1.BadUnit());
+    }
+    async getUnitsByFamily(phenomenon) {
+        const seen = new Set();
+        const out = [];
+        // Query all providers in parallel; process results in declaration order to honour precedence.
+        const results = await Promise.all(this._providers.map(async (p) => tryList(async () => p.getUnitsByFamily(phenomenon))));
+        for (const units of results) {
+            for (const u of units) {
+                if (!seen.has(u.name)) {
+                    seen.add(u.name);
+                    out.push(u);
+                }
+            }
+        }
+        return out;
+    }
+    async getConversion(from, to) {
+        for (let i = 0; i < this._providers.length - 1; i++) {
+            try {
+                const result = await this._providers[i].getConversion(from, to);
+                if (!result.error) {
+                    return result;
+                }
+            }
+            catch { /* fall through to next provider */ }
+        }
+        try {
+            return await this._providers[this._providers.length - 1].getConversion(from, to);
+        }
+        catch {
+            return { factor: 1.0, offset: 0.0, error: true };
+        }
+    }
+}
+async function tryFind(fn) {
+    try {
+        return await fn();
+    }
+    catch {
+        return undefined;
+    }
+}
+async function tryList(fn) {
+    try {
+        return await fn();
+    }
+    catch {
+        return [];
+    }
+}
+//# sourceMappingURL=CompositeUnitsProvider.js.map

package/lib/cjs/CompositeUnitsProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CompositeUnitsProvider.js","sourceRoot":"","sources":["../../src/CompositeUnitsProvider.ts"],"names":[],"mappings":";;AAoDA,kDAYC;AAhED;;;+FAG+F;AAC/F,6DAA0D;AAE1D,iCAAiC;AA6BjC;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,mBAAmB,CAAC,UAAsC,EAAE;IAC1E,MAAM,KAAK,GAAG,IAAI,uCAAkB,EAAE,CAAC;IACvC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAChC,yEAAyE;IACzE,uGAAuG;IACvG,sFAAsF;IACtF,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,CAAC,cAAc,KAAK,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACnG,OAAO,IAAI,sBAAsB,CAAC,SAAS,CAAC,CAAC;AAC/C,CAAC;AAED,MAAM,sBAAsB;IACG;IAA7B,YAA6B,UAA2B;QAA3B,eAAU,GAAV,UAAU,CAAiB;IAAG,CAAC;IAErD,KAAK,CAAC,QAAQ,CAAC,KAAa,EAAE,UAAmB,EAAE,UAAmB,EAAE,UAAmB;QAChG,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACpD,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;YAC9G,IAAI,GAAG,EAAE,OAAO,EAAE,CAAC;gBACjB,OAAO,GAAG,CAAC;YACb,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,cAAO,EAAE,CAAC,CAAC;IAClK,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,IAAY;QACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACpD,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;YAC/E,IAAI,GAAG,EAAE,OAAO,EAAE,CAAC;gBACjB,OAAO,GAAG,CAAC;YACb,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,cAAO,EAAE,CAAC,CAAC;IACnI,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,UAAkB;QAC9C,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;QAC/B,MAAM,GAAG,GAAgB,EAAE,CAAC;QAC5B,8FAA8F;QAC9F,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QACzH,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;gBACtB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;oBACtB,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;oBACjB,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBACd,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,IAAe,EAAE,EAAa;QACvD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACpD,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBAChE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;oBAClB,OAAO,MAAM,CAAC;gBAChB,CAAC;YACH,CAAC;YAAC,MAAM,CAAC,CAAC,mCAAmC,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACnF,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACnD,CAAC;IACH,CAAC;CACF;AAED,KAAK,UAAU,OAAO,CAAC,EAA4B;IACjD,IAAI,CAAC;QAAC,OAAO,MAAM,EAAE,EAAE,CAAC;IAAC,CAAC;IAAC,MAAM,CAAC;QAAC,OAAO,SAAS,CAAC;IAAC,CAAC;AACxD,CAAC;AAED,KAAK,UAAU,OAAO,CAAC,EAA8B;IACnD,IAAI,CAAC;QAAC,OAAO,MAAM,EAAE,EAAE,CAAC;IAAC,CAAC;IAAC,MAAM,CAAC;QAAC,OAAO,EAAE,CAAC;IAAC,CAAC;AACjD,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\nimport { BasicUnitsProvider } from \"./BasicUnitsProvider\";\nimport type { UnitConversionProps, UnitProps, UnitsProvider } from \"./Interfaces\";\nimport { BadUnit } from \"./Unit\";\n\n/**\n * Options for [[createUnitsProvider]].\n * @beta\n */\nexport interface CreateUnitsProviderOptions {\n  /**\n   * A `UnitsProvider` consulted before the basic BIS units (e.g. a `SchemaUnitProvider`\n   * for an open iModel's `SchemaContext`). When omitted, the returned provider behaves\n   * exactly like `new BasicUnitsProvider()`.\n   */\n  primary?: UnitsProvider;\n\n  /**\n   * Controls which provider is consulted first and wins ties.\n   * - `\"preferSchema\"` (default): `primary` is authoritative; bundled BIS units are fallback.\n   * - `\"preferBundled\"`: bundled BIS units win; `primary` is consulted only for units not in\n   *   the bundled set. Use when the iModel's schema may be stale.\n   *\n   * Affects `findUnit`, `findUnitByName`, and `getConversion` (first-consulted wins or\n   * falls through). `getUnitsByFamily` always merges both providers — the first-consulted\n   * provider wins name collisions.\n   *\n   * Has no effect when `primary` is omitted — the returned provider is a plain `BasicUnitsProvider`.\n   */\n  bisUnitsPolicy?: \"preferSchema\" | \"preferBundled\";\n}\n\n/**\n * Returns a `UnitsProvider` that layers the basic BIS units under (or over) an optional\n * `primary` provider. Typical use: layer an iModel's schema units on top of the bundled\n * defaults from `@itwin/core-quantity`.\n *\n * Precedence rules:\n * - When `primary` is supplied and `bisUnitsPolicy` is `\"preferSchema\"` (the default): `primary` wins;\n *   basic BIS units fill any gaps where `primary` returns an invalid unit or throws.\n * - When `bisUnitsPolicy` is `\"preferBundled\"`: basic BIS units win; `primary` is consulted only when the\n *   basic provider can't answer.\n * - `getUnitsByFamily` always merges results from both providers, deduplicated by\n *   `UnitProps.name` (fully-qualified). The first-consulted provider wins ties.\n * - When no `primary` is supplied, the returned provider is exactly `new BasicUnitsProvider()`\n *   (no wrapper), preserving `instanceof` checks and keeping the hot path fast.\n *\n * @beta\n */\nexport function createUnitsProvider(options: CreateUnitsProviderOptions = {}): UnitsProvider {\n  const basic = new BasicUnitsProvider();\n  const primary = options.primary;\n  // NOTE: returns BasicUnitsProvider directly when no primary is provided.\n  // QuantityFormatter.resetToUseInternalUnitsProvider uses instanceof BasicUnitsProvider to detect this.\n  // If this fast-path is ever wrapped (e.g. for telemetry), that guard must be updated.\n  if (!primary) {\n    return basic;\n  }\n\n  const providers = options.bisUnitsPolicy === \"preferBundled\" ? [basic, primary] : [primary, basic];\n  return new CompositeUnitsProvider(providers);\n}\n\nclass CompositeUnitsProvider implements UnitsProvider {\n  constructor(private readonly _providers: UnitsProvider[]) {}\n\n  public async findUnit(label: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps> {\n    for (let i = 0; i < this._providers.length - 1; i++) {\n      const hit = await tryFind(async () => this._providers[i].findUnit(label, schemaName, phenomenon, unitSystem));\n      if (hit?.isValid) {\n        return hit;\n      }\n    }\n    return tryFind(async () => this._providers[this._providers.length - 1].findUnit(label, schemaName, phenomenon, unitSystem)).then((hit) => hit ?? new BadUnit());\n  }\n\n  public async findUnitByName(name: string): Promise<UnitProps> {\n    for (let i = 0; i < this._providers.length - 1; i++) {\n      const hit = await tryFind(async () => this._providers[i].findUnitByName(name));\n      if (hit?.isValid) {\n        return hit;\n      }\n    }\n    return tryFind(async () => this._providers[this._providers.length - 1].findUnitByName(name)).then((hit) => hit ?? new BadUnit());\n  }\n\n  public async getUnitsByFamily(phenomenon: string): Promise<UnitProps[]> {\n    const seen = new Set<string>();\n    const out: UnitProps[] = [];\n    // Query all providers in parallel; process results in declaration order to honour precedence.\n    const results = await Promise.all(this._providers.map(async (p) => tryList(async () => p.getUnitsByFamily(phenomenon))));\n    for (const units of results) {\n      for (const u of units) {\n        if (!seen.has(u.name)) {\n          seen.add(u.name);\n          out.push(u);\n        }\n      }\n    }\n    return out;\n  }\n\n  public async getConversion(from: UnitProps, to: UnitProps): Promise<UnitConversionProps> {\n    for (let i = 0; i < this._providers.length - 1; i++) {\n      try {\n        const result = await this._providers[i].getConversion(from, to);\n        if (!result.error) {\n          return result;\n        }\n      } catch { /* fall through to next provider */ }\n    }\n    try {\n      return await this._providers[this._providers.length - 1].getConversion(from, to);\n    } catch {\n      return { factor: 1.0, offset: 0.0, error: true };\n    }\n  }\n}\n\nasync function tryFind(fn: () => Promise<UnitProps>): Promise<UnitProps | undefined> {\n  try { return await fn(); } catch { return undefined; }\n}\n\nasync function tryList(fn: () => Promise<UnitProps[]>): Promise<UnitProps[]> {\n  try { return await fn(); } catch { return []; }\n}\n"]}

package/lib/cjs/FormatSpecHandle.d.ts

@@ -0,0 +1,56 @@
+/** @packageDocumentation
+ * @module Quantity
+ */
+import type { FormatterSpec } from "./Formatter/FormatterSpec";
+import type { FormattingSpecArgs, FormattingSpecProvider } from "./Formatter/Interfaces";
+import type { ParserSpec } from "./ParserSpec";
+import type { UnitSystemKey } from "./Interfaces";
+/** Arguments for constructing a [[FormatSpecHandle]].
+ * @internal
+ */
+export interface FormatSpecHandleArgs extends FormattingSpecArgs {
+    /** The provider that supplies spec lookups and reload events. */
+    provider: FormattingSpecProvider;
+}
+/** A cacheable handle to formatting and parsing specs for a specific KoQ and persistence unit.
+ * Automatically refreshes when the QuantityFormatter reloads. Use [[QuantityFormatter.getFormatSpecHandle]]
+ * to create instances.
+ *
+ * When formatting is not yet ready, [[format]] returns a `value.toString()` fallback.
+ * Call [[dispose]] when the handle is no longer needed to unsubscribe from reload events.
+ *
+ * @beta
+ */
+export declare class FormatSpecHandle implements Disposable {
+    private _formatterSpec;
+    private _parserSpec;
+    private _removeListener;
+    private readonly _provider;
+    private readonly _koqName;
+    private readonly _persistenceUnit;
+    private readonly _system;
+    /** @internal */
+    constructor(args: FormatSpecHandleArgs);
+    /** The KoQ name this handle is keyed to. */
+    get koqName(): string;
+    /** The persistence unit this handle is keyed to. */
+    get persistenceUnit(): string;
+    /** The unit system this handle is pinned to, or `undefined` for the active system. */
+    get system(): UnitSystemKey | undefined;
+    /** The current FormatterSpec, or undefined if not yet loaded. */
+    get formatterSpec(): FormatterSpec | undefined;
+    /** The current ParserSpec, or undefined if not yet loaded. */
+    get parserSpec(): ParserSpec | undefined;
+    /** Format a quantity value using the current spec.
+     * If the formatter is not yet ready, returns `value.toString()` as a fallback.
+     * @param value - The numeric value to format.
+     * @returns The formatted string.
+     */
+    format(value: number): string;
+    /** Unsubscribe from reload events and clear cached specs.
+     * Idempotent and safe to call during a pending reload.
+     */
+    [Symbol.dispose](): void;
+    private _refresh;
+}
+//# sourceMappingURL=FormatSpecHandle.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FormatSpecHandle.d.ts","sourceRoot":"","sources":["../../src/FormatSpecHandle.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAuB,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAC9G,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB;IAC9D,iEAAiE;IACjE,QAAQ,EAAE,sBAAsB,CAAC;CAClC;AAED;;;;;;;;GAQG;AACH,qBAAa,gBAAiB,YAAW,UAAU;IACjD,OAAO,CAAC,cAAc,CAA4B;IAClD,OAAO,CAAC,WAAW,CAAyB;IAC5C,OAAO,CAAC,eAAe,CAA2B;IAClD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAyB;IACnD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAC1C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA4B;IAEpD,gBAAgB;gBACJ,IAAI,EAAE,oBAAoB;IAWtC,4CAA4C;IAC5C,IAAW,OAAO,IAAI,MAAM,CAA0B;IAEtD,oDAAoD;IACpD,IAAW,eAAe,IAAI,MAAM,CAAkC;IAEtE,sFAAsF;IACtF,IAAW,MAAM,IAAI,aAAa,GAAG,SAAS,CAAyB;IAEvE,iEAAiE;IACjE,IAAW,aAAa,IAAI,aAAa,GAAG,SAAS,CAAgC;IAErF,8DAA8D;IAC9D,IAAW,UAAU,IAAI,UAAU,GAAG,SAAS,CAA6B;IAE5E;;;;OAIG;IACI,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAMpC;;OAEG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;IAS/B,OAAO,CAAC,QAAQ;CAiBjB"}