@itwin/presentation-common 4.0.0-dev.52 → 4.0.0-dev.55

package/lib/cjs/presentation-common/PropertyFormatter.js

@@ -1,199 +1,199 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Core
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContentPropertyValueFormatter = exports.PropertyValueFormatter = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_quantity_1 = require("@itwin/core-quantity");
-const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
-const Value_1 = require("./content/Value");
-/** @alpha */
-class PropertyValueFormatter {
-    constructor(_schemaContext) {
-        this._schemaContext = _schemaContext;
-        this._unitsProvider = new ecschema_metadata_1.SchemaUnitProvider(_schemaContext);
-    }
-    async format(value, options) {
-        const formatterSpec = await this.getFormatterSpec(options);
-        if (!formatterSpec)
-            return undefined;
-        return formatterSpec.applyFormatting(value);
-    }
-    async getFormatterSpec(options) {
-        const formattingProps = await getFormattingProps(this._schemaContext, options);
-        if (!formattingProps)
-            return undefined;
-        const { formatProps, persistenceUnitName } = formattingProps;
-        const persistenceUnit = await this._unitsProvider.findUnitByName(persistenceUnitName);
-        const format = await core_quantity_1.Format.createFromJSON("", this._unitsProvider, formatProps);
-        return core_quantity_1.FormatterSpec.create("", format, this._unitsProvider, persistenceUnit);
-    }
-    async getParserSpec(options) {
-        const formattingProps = await getFormattingProps(this._schemaContext, options);
-        if (!formattingProps)
-            return undefined;
-        const { formatProps, persistenceUnitName } = formattingProps;
-        const persistenceUnit = await this._unitsProvider.findUnitByName(persistenceUnitName);
-        const format = await core_quantity_1.Format.createFromJSON("", this._unitsProvider, formatProps);
-        return core_quantity_1.ParserSpec.create(format, this._unitsProvider, persistenceUnit);
-    }
-}
-exports.PropertyValueFormatter = PropertyValueFormatter;
-/** @alpha */
-class ContentPropertyValueFormatter {
-    constructor(_propertyValueFormatter, _unitSystem) {
-        this._propertyValueFormatter = _propertyValueFormatter;
-        this._unitSystem = _unitSystem;
-    }
-    async formatContent(content) {
-        const descriptor = content.descriptor;
-        for (const item of content.contentSet) {
-            await this.formatValues(item.values, item.displayValues, descriptor.fields, item.mergedFieldNames);
-        }
-        return content;
-    }
-    async formatValues(values, displayValues, fields, mergedFields) {
-        for (const field of fields) {
-            const value = values[field.name];
-            if (field.isNestedContentField() && !mergedFields.includes(field.name)) {
-                (0, core_bentley_1.assert)(Value_1.Value.isNestedContent(value));
-                await this.formatNestedContentDisplayValues(value, field.nestedFields);
-                continue;
-            }
-            if (!this.isFormattable(field) || typeof value !== "number")
-                continue;
-            const koq = field.properties[0].property.kindOfQuantity;
-            const formattedValue = await this._propertyValueFormatter.format(value, { koqName: koq.name, unitSystem: this._unitSystem });
-            if (!formattedValue)
-                continue;
-            displayValues[field.name] = formattedValue;
-        }
-    }
-    async formatNestedContentDisplayValues(nestedValues, fields) {
-        for (const nestedValue of nestedValues) {
-            await this.formatValues(nestedValue.values, nestedValue.displayValues, fields, nestedValue.mergedFieldNames);
-        }
-    }
-    isFormattable(field) {
-        return field.isPropertiesField()
-            && field.properties.length > 0
-            && field.properties[0].property.kindOfQuantity !== undefined;
-    }
-}
-exports.ContentPropertyValueFormatter = ContentPropertyValueFormatter;
-async function getFormattingProps(schemaLocater, options) {
-    const { koqName, unitSystem } = options;
-    const koq = await getKoq(schemaLocater, koqName);
-    if (!koq)
-        return undefined;
-    const persistenceUnit = await koq.persistenceUnit;
-    // istanbul ignore if
-    if (!persistenceUnit)
-        return undefined;
-    const formatProps = await getKoqFormatProps(koq, persistenceUnit, unitSystem);
-    if (!formatProps)
-        return undefined;
-    return { formatProps, persistenceUnitName: persistenceUnit.fullName };
-}
-async function getKoq(schemaLocater, fullName) {
-    const [schemaName, propKoqName] = fullName.split(":");
-    const schema = await schemaLocater.getSchema(new ecschema_metadata_1.SchemaKey(schemaName), ecschema_metadata_1.SchemaMatchType.Latest);
-    if (!schema)
-        return undefined;
-    return schema.getItem(propKoqName);
-}
-async function getKoqFormatProps(koq, persistenceUnit, unitSystem) {
-    const unitSystems = getUnitSystemGroupNames(unitSystem);
-    // use one of KOQ presentation format that matches requested unit system
-    const presentationFormat = await getKoqPresentationFormat(koq, unitSystems);
-    if (presentationFormat)
-        return formatToFormatProps(presentationFormat);
-    // use persistence unit format if it matches requested unit system and matching presentation format was not found
-    const persistenceUnitSystem = await persistenceUnit.unitSystem;
-    if (persistenceUnitSystem && unitSystems.includes(persistenceUnitSystem.name.toUpperCase()))
-        return getPersistenceUnitFormatProps(persistenceUnit);
-    // use default presentation format if persistence unit does not match requested unit system
-    if (koq.defaultPresentationFormat)
-        return formatToFormatProps(koq.defaultPresentationFormat);
-    return undefined;
-}
-async function getKoqPresentationFormat(koq, unitSystems) {
-    const presentationFormats = koq.presentationFormats;
-    for (const system of unitSystems) {
-        for (const format of presentationFormats) {
-            const unit = format.units && format.units[0][0];
-            // istanbul ignore if
-            if (!unit)
-                continue;
-            const currentUnitSystem = await unit.unitSystem;
-            if (currentUnitSystem && currentUnitSystem.name.toUpperCase() === system)
-                return format;
-        }
-    }
-    return undefined;
-}
-function formatToFormatProps(format) {
-    // istanbul ignore if
-    if (ecschema_metadata_1.OverrideFormat.isOverrideFormat(format)) {
-        const baseFormat = baseFormatToFormatProps(format.parent);
-        return {
-            ...baseFormat,
-            composite: format.units
-                ? {
-                    ...baseFormat.composite,
-                    units: format.units.map(([unit, _]) => ({ name: unit.fullName, label: unit.label })),
-                    spacer: format.spacer,
-                    includeZero: format.includeZero,
-                }
-                : baseFormat.composite,
-        };
-    }
-    return baseFormatToFormatProps(format);
-}
-function baseFormatToFormatProps(format) {
-    const json = format.toJSON();
-    return {
-        ...json,
-        composite: json.composite
-            ? {
-                ...json.composite,
-                spacer: format.spacer,
-                includeZero: format.includeZero,
-            }
-            : /* istanbul ignore next */ undefined,
-    };
-}
-function getPersistenceUnitFormatProps(persistenceUnit) {
-    // Same as Format "DefaultRealU" in Formats ecschema
-    return {
-        formatTraits: ["keepSingleZero", "keepDecimalPoint", "showUnitLabel"],
-        precision: 6,
-        type: "Decimal",
-        uomSeparator: " ",
-        decimalSeparator: ".",
-        composite: {
-            units: [{
-                    name: persistenceUnit.fullName,
-                    label: persistenceUnit.label,
-                }],
-        },
-    };
-}
-function getUnitSystemGroupNames(unitSystem) {
-    switch (unitSystem) {
-        case "imperial":
-            return ["IMPERIAL", "USCUSTOM", "INTERNATIONAL", "FINANCE"];
-        case "metric":
-            return ["SI", "METRIC", "INTERNATIONAL", "FINANCE"];
-        case "usCustomary":
-            return ["USCUSTOM", "INTERNATIONAL", "FINANCE"];
-        case "usSurvey":
-            return ["USSURVEY", "USCUSTOM", "INTERNATIONAL", "FINANCE"];
-    }
-}
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Core
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentPropertyValueFormatter = exports.PropertyValueFormatter = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_quantity_1 = require("@itwin/core-quantity");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+const Value_1 = require("./content/Value");
+/** @alpha */
+class PropertyValueFormatter {
+    constructor(_schemaContext) {
+        this._schemaContext = _schemaContext;
+        this._unitsProvider = new ecschema_metadata_1.SchemaUnitProvider(_schemaContext);
+    }
+    async format(value, options) {
+        const formatterSpec = await this.getFormatterSpec(options);
+        if (!formatterSpec)
+            return undefined;
+        return formatterSpec.applyFormatting(value);
+    }
+    async getFormatterSpec(options) {
+        const formattingProps = await getFormattingProps(this._schemaContext, options);
+        if (!formattingProps)
+            return undefined;
+        const { formatProps, persistenceUnitName } = formattingProps;
+        const persistenceUnit = await this._unitsProvider.findUnitByName(persistenceUnitName);
+        const format = await core_quantity_1.Format.createFromJSON("", this._unitsProvider, formatProps);
+        return core_quantity_1.FormatterSpec.create("", format, this._unitsProvider, persistenceUnit);
+    }
+    async getParserSpec(options) {
+        const formattingProps = await getFormattingProps(this._schemaContext, options);
+        if (!formattingProps)
+            return undefined;
+        const { formatProps, persistenceUnitName } = formattingProps;
+        const persistenceUnit = await this._unitsProvider.findUnitByName(persistenceUnitName);
+        const format = await core_quantity_1.Format.createFromJSON("", this._unitsProvider, formatProps);
+        return core_quantity_1.ParserSpec.create(format, this._unitsProvider, persistenceUnit);
+    }
+}
+exports.PropertyValueFormatter = PropertyValueFormatter;
+/** @alpha */
+class ContentPropertyValueFormatter {
+    constructor(_propertyValueFormatter, _unitSystem) {
+        this._propertyValueFormatter = _propertyValueFormatter;
+        this._unitSystem = _unitSystem;
+    }
+    async formatContent(content) {
+        const descriptor = content.descriptor;
+        for (const item of content.contentSet) {
+            await this.formatValues(item.values, item.displayValues, descriptor.fields, item.mergedFieldNames);
+        }
+        return content;
+    }
+    async formatValues(values, displayValues, fields, mergedFields) {
+        for (const field of fields) {
+            const value = values[field.name];
+            if (field.isNestedContentField() && !mergedFields.includes(field.name)) {
+                (0, core_bentley_1.assert)(Value_1.Value.isNestedContent(value));
+                await this.formatNestedContentDisplayValues(value, field.nestedFields);
+                continue;
+            }
+            if (!this.isFormattable(field) || typeof value !== "number")
+                continue;
+            const koq = field.properties[0].property.kindOfQuantity;
+            const formattedValue = await this._propertyValueFormatter.format(value, { koqName: koq.name, unitSystem: this._unitSystem });
+            if (!formattedValue)
+                continue;
+            displayValues[field.name] = formattedValue;
+        }
+    }
+    async formatNestedContentDisplayValues(nestedValues, fields) {
+        for (const nestedValue of nestedValues) {
+            await this.formatValues(nestedValue.values, nestedValue.displayValues, fields, nestedValue.mergedFieldNames);
+        }
+    }
+    isFormattable(field) {
+        return field.isPropertiesField()
+            && field.properties.length > 0
+            && field.properties[0].property.kindOfQuantity !== undefined;
+    }
+}
+exports.ContentPropertyValueFormatter = ContentPropertyValueFormatter;
+async function getFormattingProps(schemaLocater, options) {
+    const { koqName, unitSystem } = options;
+    const koq = await getKoq(schemaLocater, koqName);
+    if (!koq)
+        return undefined;
+    const persistenceUnit = await koq.persistenceUnit;
+    // istanbul ignore if
+    if (!persistenceUnit)
+        return undefined;
+    const formatProps = await getKoqFormatProps(koq, persistenceUnit, unitSystem);
+    if (!formatProps)
+        return undefined;
+    return { formatProps, persistenceUnitName: persistenceUnit.fullName };
+}
+async function getKoq(schemaLocater, fullName) {
+    const [schemaName, propKoqName] = fullName.split(":");
+    const schema = await schemaLocater.getSchema(new ecschema_metadata_1.SchemaKey(schemaName), ecschema_metadata_1.SchemaMatchType.Latest);
+    if (!schema)
+        return undefined;
+    return schema.getItem(propKoqName);
+}
+async function getKoqFormatProps(koq, persistenceUnit, unitSystem) {
+    const unitSystems = getUnitSystemGroupNames(unitSystem);
+    // use one of KOQ presentation format that matches requested unit system
+    const presentationFormat = await getKoqPresentationFormat(koq, unitSystems);
+    if (presentationFormat)
+        return formatToFormatProps(presentationFormat);
+    // use persistence unit format if it matches requested unit system and matching presentation format was not found
+    const persistenceUnitSystem = await persistenceUnit.unitSystem;
+    if (persistenceUnitSystem && unitSystems.includes(persistenceUnitSystem.name.toUpperCase()))
+        return getPersistenceUnitFormatProps(persistenceUnit);
+    // use default presentation format if persistence unit does not match requested unit system
+    if (koq.defaultPresentationFormat)
+        return formatToFormatProps(koq.defaultPresentationFormat);
+    return undefined;
+}
+async function getKoqPresentationFormat(koq, unitSystems) {
+    const presentationFormats = koq.presentationFormats;
+    for (const system of unitSystems) {
+        for (const format of presentationFormats) {
+            const unit = format.units && format.units[0][0];
+            // istanbul ignore if
+            if (!unit)
+                continue;
+            const currentUnitSystem = await unit.unitSystem;
+            if (currentUnitSystem && currentUnitSystem.name.toUpperCase() === system)
+                return format;
+        }
+    }
+    return undefined;
+}
+function formatToFormatProps(format) {
+    // istanbul ignore if
+    if (ecschema_metadata_1.OverrideFormat.isOverrideFormat(format)) {
+        const baseFormat = baseFormatToFormatProps(format.parent);
+        return {
+            ...baseFormat,
+            composite: format.units
+                ? {
+                    ...baseFormat.composite,
+                    units: format.units.map(([unit, _]) => ({ name: unit.fullName, label: unit.label })),
+                    spacer: format.spacer,
+                    includeZero: format.includeZero,
+                }
+                : baseFormat.composite,
+        };
+    }
+    return baseFormatToFormatProps(format);
+}
+function baseFormatToFormatProps(format) {
+    const json = format.toJSON();
+    return {
+        ...json,
+        composite: json.composite
+            ? {
+                ...json.composite,
+                spacer: format.spacer,
+                includeZero: format.includeZero,
+            }
+            : /* istanbul ignore next */ undefined,
+    };
+}
+function getPersistenceUnitFormatProps(persistenceUnit) {
+    // Same as Format "DefaultRealU" in Formats ecschema
+    return {
+        formatTraits: ["keepSingleZero", "keepDecimalPoint", "showUnitLabel"],
+        precision: 6,
+        type: "Decimal",
+        uomSeparator: " ",
+        decimalSeparator: ".",
+        composite: {
+            units: [{
+                    name: persistenceUnit.fullName,
+                    label: persistenceUnit.label,
+                }],
+        },
+    };
+}
+function getUnitSystemGroupNames(unitSystem) {
+    switch (unitSystem) {
+        case "imperial":
+            return ["IMPERIAL", "USCUSTOM", "INTERNATIONAL", "FINANCE"];
+        case "metric":
+            return ["SI", "METRIC", "INTERNATIONAL", "FINANCE"];
+        case "usCustomary":
+            return ["USCUSTOM", "INTERNATIONAL", "FINANCE"];
+        case "usSurvey":
+            return ["USSURVEY", "USCUSTOM", "INTERNATIONAL", "FINANCE"];
+    }
+}
 //# sourceMappingURL=PropertyFormatter.js.map

package/lib/cjs/presentation-common/RegisteredRuleset.d.ts

@@ -1,27 +1,27 @@
-/** @packageDocumentation
- * @module Core
- */
-import { IDisposable } from "@itwin/core-bentley";
-import { Rule } from "./rules/Rule";
-import { Ruleset, SupplementationInfo } from "./rules/Ruleset";
-import { VariablesGroup } from "./rules/Variables";
-/**
- * A ruleset that is registered in a ruleset manager.
- * @public
- */
-export declare class RegisteredRuleset implements IDisposable, Ruleset {
-    private _ruleset;
-    private _uniqueIdentifier;
-    private _disposeFunc;
-    /** Create a registered ruleset */
-    constructor(ruleset: Ruleset, uniqueIdentifier: string, disposeFunc: (ruleset: RegisteredRuleset) => void);
-    /** Dispose registered ruleset. */
-    dispose(): void;
-    get uniqueIdentifier(): string;
-    get id(): string;
-    get supplementationInfo(): SupplementationInfo | undefined;
-    get rules(): Rule[];
-    get vars(): VariablesGroup[] | undefined;
-    toJSON(): Ruleset;
-}
+/** @packageDocumentation
+ * @module Core
+ */
+import { IDisposable } from "@itwin/core-bentley";
+import { Rule } from "./rules/Rule";
+import { Ruleset, SupplementationInfo } from "./rules/Ruleset";
+import { VariablesGroup } from "./rules/Variables";
+/**
+ * A ruleset that is registered in a ruleset manager.
+ * @public
+ */
+export declare class RegisteredRuleset implements IDisposable, Ruleset {
+    private _ruleset;
+    private _uniqueIdentifier;
+    private _disposeFunc;
+    /** Create a registered ruleset */
+    constructor(ruleset: Ruleset, uniqueIdentifier: string, disposeFunc: (ruleset: RegisteredRuleset) => void);
+    /** Dispose registered ruleset. */
+    dispose(): void;
+    get uniqueIdentifier(): string;
+    get id(): string;
+    get supplementationInfo(): SupplementationInfo | undefined;
+    get rules(): Rule[];
+    get vars(): VariablesGroup[] | undefined;
+    toJSON(): Ruleset;
+}
 //# sourceMappingURL=RegisteredRuleset.d.ts.map

package/lib/cjs/presentation-common/RegisteredRuleset.js

@@ -1,34 +1,34 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Core
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RegisteredRuleset = void 0;
-/**
- * A ruleset that is registered in a ruleset manager.
- * @public
- */
-class RegisteredRuleset {
-    /** Create a registered ruleset */
-    constructor(ruleset, uniqueIdentifier, disposeFunc) {
-        this._disposeFunc = disposeFunc;
-        this._ruleset = ruleset;
-        this._uniqueIdentifier = uniqueIdentifier;
-    }
-    /** Dispose registered ruleset. */
-    dispose() {
-        this._disposeFunc(this);
-    }
-    get uniqueIdentifier() { return this._uniqueIdentifier; }
-    get id() { return this._ruleset.id; }
-    get supplementationInfo() { return this._ruleset.supplementationInfo; }
-    get rules() { return this._ruleset.rules; }
-    get vars() { return this._ruleset.vars; }
-    toJSON() { return this._ruleset; }
-}
-exports.RegisteredRuleset = RegisteredRuleset;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Core
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegisteredRuleset = void 0;
+/**
+ * A ruleset that is registered in a ruleset manager.
+ * @public
+ */
+class RegisteredRuleset {
+    /** Create a registered ruleset */
+    constructor(ruleset, uniqueIdentifier, disposeFunc) {
+        this._disposeFunc = disposeFunc;
+        this._ruleset = ruleset;
+        this._uniqueIdentifier = uniqueIdentifier;
+    }
+    /** Dispose registered ruleset. */
+    dispose() {
+        this._disposeFunc(this);
+    }
+    get uniqueIdentifier() { return this._uniqueIdentifier; }
+    get id() { return this._ruleset.id; }
+    get supplementationInfo() { return this._ruleset.supplementationInfo; }
+    get rules() { return this._ruleset.rules; }
+    get vars() { return this._ruleset.vars; }
+    toJSON() { return this._ruleset; }
+}
+exports.RegisteredRuleset = RegisteredRuleset;
 //# sourceMappingURL=RegisteredRuleset.js.map