@itwin/ecschema-metadata 4.0.0-dev.10 → 4.0.0-dev.100

package/lib/cjs/Metadata/OverrideFormat.js

@@ -1,89 +1,127 @@
-"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 Metadata
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OverrideFormat = void 0;
-const XmlSerializationUtils_1 = require("../Deserialization/XmlSerializationUtils");
-const ECObjects_1 = require("../ECObjects");
-/**
- * Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.
- * @beta
- */
-class OverrideFormat {
-    constructor(parent, precision, unitAndLabels) {
-        this.parent = parent;
-        this.name = OverrideFormat.createOverrideFormatFullName(parent, precision, unitAndLabels);
-        this._precision = precision;
-        this._units = unitAndLabels;
-    }
-    // Properties that can be overriden
-    get precision() { return (undefined === this._precision) ? this.parent.precision : this._precision; }
-    get units() { return (undefined === this._units) ? this.parent.units : this._units; }
-    // Properties that cannot be overriden
-    get fullName() { return this.name; }
-    get roundFactor() { return this.parent.roundFactor; }
-    get type() { return this.parent.type; }
-    get minWidth() { return this.parent.minWidth; }
-    get scientificType() { return this.parent.scientificType; }
-    get showSignOption() { return this.parent.showSignOption; }
-    get decimalSeparator() { return this.parent.decimalSeparator; }
-    get thousandSeparator() { return this.parent.thousandSeparator; }
-    get uomSeparator() { return this.parent.uomSeparator; }
-    get stationSeparator() { return this.parent.stationSeparator; }
-    get stationOffsetSize() { return this.parent.stationOffsetSize; }
-    get formatTraits() { return this.parent.formatTraits; }
-    get spacer() { return this.parent.spacer; }
-    get includeZero() { return this.parent.includeZero; }
-    hasFormatTrait(formatTrait) {
-        return (this.parent.formatTraits & formatTrait) === formatTrait;
-    }
-    /** Returns the format string of this override in the Xml full name format.
-     * @alpha
-     */
-    fullNameXml(koqSchema) {
-        let fullName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(koqSchema, this.parent.schema, this.parent.name);
-        if (undefined !== this.precision)
-            fullName += `(${this.precision.toString()})`;
-        if (undefined === this._units)
-            return fullName;
-        for (const [unit, unitLabel] of this._units) {
-            fullName += "[";
-            fullName += XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(koqSchema, unit.schema, unit.name);
-            fullName += `|${unitLabel}]`;
-        }
-        return fullName;
-    }
-    /**
-     * Creates a valid OverrideFormat fullName from the parent Format and overridden units.
-     * @param parent The parent Format.
-     * @param unitAndLabels The overridden unit and labels collection.
-     */
-    static createOverrideFormatFullName(parent, precision, unitAndLabels) {
-        let fullName = parent.fullName;
-        if (precision)
-            fullName += `(${precision.toString()})`;
-        if (undefined === unitAndLabels)
-            return fullName;
-        for (const [unit, unitLabel] of unitAndLabels)
-            if (undefined === unitLabel)
-                fullName += `[${unit.fullName}]`;
-            else
-                fullName += `[${unit.fullName}|${unitLabel}]`;
-        return fullName;
-    }
-    /**
-     * @internal
-     */
-    static isOverrideFormat(object) {
-        const overrideFormat = object;
-        return overrideFormat !== undefined && overrideFormat.name !== undefined && overrideFormat.parent !== undefined &&
-            overrideFormat.parent.schemaItemType === ECObjects_1.SchemaItemType.Format;
-    }
-}
-exports.OverrideFormat = OverrideFormat;
+"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 Metadata
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFormatProps = exports.OverrideFormat = void 0;
+const XmlSerializationUtils_1 = require("../Deserialization/XmlSerializationUtils");
+const ECObjects_1 = require("../ECObjects");
+/**
+ * Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.
+ * @beta
+ */
+class OverrideFormat {
+    constructor(parent, precision, unitAndLabels) {
+        this.parent = parent;
+        this.name = OverrideFormat.createOverrideFormatFullName(parent, precision, unitAndLabels);
+        this._precision = precision;
+        this._units = unitAndLabels;
+    }
+    // Properties that can be overriden
+    get precision() { return (undefined === this._precision) ? this.parent.precision : this._precision; }
+    get units() { return (undefined === this._units) ? this.parent.units : this._units; }
+    // Properties that cannot be overriden
+    get fullName() { return this.name; }
+    get roundFactor() { return this.parent.roundFactor; }
+    get type() { return this.parent.type; }
+    get minWidth() { return this.parent.minWidth; }
+    get scientificType() { return this.parent.scientificType; }
+    get showSignOption() { return this.parent.showSignOption; }
+    get decimalSeparator() { return this.parent.decimalSeparator; }
+    get thousandSeparator() { return this.parent.thousandSeparator; }
+    get uomSeparator() { return this.parent.uomSeparator; }
+    get stationSeparator() { return this.parent.stationSeparator; }
+    get stationOffsetSize() { return this.parent.stationOffsetSize; }
+    get formatTraits() { return this.parent.formatTraits; }
+    get spacer() { return this.parent.spacer; }
+    get includeZero() { return this.parent.includeZero; }
+    hasFormatTrait(formatTrait) {
+        return (this.parent.formatTraits & formatTrait) === formatTrait;
+    }
+    /** Returns the format string of this override in the Xml full name format.
+     * @alpha
+     */
+    fullNameXml(koqSchema) {
+        let fullName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(koqSchema, this.parent.schema, this.parent.name);
+        if (undefined !== this.precision)
+            fullName += `(${this.precision.toString()})`;
+        if (undefined === this._units)
+            return fullName;
+        for (const [unit, unitLabel] of this._units) {
+            fullName += "[";
+            fullName += XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(koqSchema, unit.schema, unit.name);
+            fullName += `|${unitLabel}]`;
+        }
+        return fullName;
+    }
+    /**
+     * Creates a valid OverrideFormat fullName from the parent Format and overridden units.
+     * @param parent The parent Format.
+     * @param unitAndLabels The overridden unit and labels collection.
+     */
+    static createOverrideFormatFullName(parent, precision, unitAndLabels) {
+        let fullName = parent.fullName;
+        if (precision)
+            fullName += `(${precision.toString()})`;
+        if (undefined === unitAndLabels)
+            return fullName;
+        for (const [unit, unitLabel] of unitAndLabels)
+            if (undefined === unitLabel)
+                fullName += `[${unit.fullName}]`;
+            else
+                fullName += `[${unit.fullName}|${unitLabel}]`;
+        return fullName;
+    }
+    /**
+     * @internal
+     */
+    static isOverrideFormat(object) {
+        const overrideFormat = object;
+        return overrideFormat !== undefined && overrideFormat.name !== undefined && overrideFormat.parent !== undefined && overrideFormat.parent.schemaItemType === ECObjects_1.SchemaItemType.Format;
+    }
+    /**
+     * Returns a JSON object that contains the specification for the OverrideFormat where the precision and units properties have been overriden.
+     * If the precision and/or units properties have been overriden, the returned object will contain a "name" and a "parent" property.
+     * The "name" property identifies the OverrideFormat object itself and the "parent" property identifies the Format that has been overriden.
+     * This method is not intended for complete serialization as it does not serialize any of the schema item properties.
+     */
+    getFormatProps() {
+        const formatJson = this.parent.toJSON();
+        if (this.parent.fullName !== this.fullName) {
+            // Update name and parent properties to distinguish it from parent Format
+            formatJson.name = this.fullName;
+            formatJson.parent = this.parent.fullName;
+        }
+        // Update Precision overriden property
+        formatJson.precision = this.precision;
+        if (this.units !== undefined) {
+            // Update Units overriden property
+            const units = [];
+            for (const unit of this.units) {
+                units.push({
+                    name: unit[0].fullName,
+                    label: unit[1],
+                });
+            }
+            formatJson.composite = {
+                spacer: (this.spacer !== " ") ? this.spacer : undefined,
+                includeZero: (this.includeZero === false) ? this.includeZero : undefined,
+                units,
+            };
+        }
+        return formatJson;
+    }
+}
+exports.OverrideFormat = OverrideFormat;
+/**
+ * @internal
+ */
+function getFormatProps(format) {
+    return OverrideFormat.isOverrideFormat(format) ? format.getFormatProps() : format.toJSON();
+}
+exports.getFormatProps = getFormatProps;
 //# sourceMappingURL=OverrideFormat.js.map

package/lib/cjs/Metadata/OverrideFormat.js.map

@@ -1 +1 @@
-{"version":3,"file":"OverrideFormat.js","sourceRoot":"","sources":["../../../src/Metadata/OverrideFormat.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oFAAiF;AACjF,4CAA8C;AAO9C;;;GAGG;AACH,MAAa,cAAc;IAazB,YAAY,MAAc,EAAE,SAAkD,EAAE,aAAgE;QAC9I,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,4BAA4B,CAAC,MAAM,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QAC1F,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC;IAC9B,CAAC;IAED,mCAAmC;IACnC,IAAW,SAAS,KAA6C,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACpJ,IAAW,KAAK,KAAK,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAE5F,sCAAsC;IACtC,IAAW,QAAQ,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACnD,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IACpE,IAAW,IAAI,KAAiB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1D,IAAW,QAAQ,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC1E,IAAW,cAAc,KAAiC,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;IAC9F,IAAW,cAAc,KAAqB,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;IAClF,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC9E,IAAW,iBAAiB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAChF,IAAW,YAAY,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IACtE,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC9E,IAAW,iBAAiB,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC5F,IAAW,YAAY,KAAmB,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IAC5E,IAAW,MAAM,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IACtE,IAAW,WAAW,KAA0B,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IAE1E,cAAc,CAAC,WAAyB;QAC7C,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,WAAW,CAAC,KAAK,WAAW,CAAC;IAClE,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,SAAiB;QAClC,IAAI,QAAQ,GAAG,6CAAqB,CAAC,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEzG,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,QAAQ,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC;QAE/C,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,OAAO,QAAQ,CAAC;QAClB,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE;YAC3C,QAAQ,IAAI,GAAG,CAAC;YAChB,QAAQ,IAAI,6CAAqB,CAAC,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACxF,QAAQ,IAAI,IAAI,SAAS,GAAG,CAAC;SAC9B;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,4BAA4B,CAAC,MAAc,EAAE,SAAkD,EAAE,aAAgE;QAC7K,IAAI,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAE/B,IAAI,SAAS;YACX,QAAQ,IAAI,IAAI,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC;QAE1C,IAAI,SAAS,KAAK,aAAa;YAC7B,OAAO,QAAQ,CAAC;QAClB,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,aAAa;YAC3C,IAAI,SAAS,KAAK,SAAS;gBACzB,QAAQ,IAAI,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC;;gBAEjC,QAAQ,IAAI,IAAI,IAAI,CAAC,QAAQ,IAAI,SAAS,GAAG,CAAC;QAClD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,gBAAgB,CAAC,MAAW;QACxC,MAAM,cAAc,GAAG,MAAwB,CAAC;QAEhD,OAAO,cAAc,KAAK,SAAS,IAAI,cAAc,CAAC,IAAI,KAAK,SAAS,IAAI,cAAc,CAAC,MAAM,KAAK,SAAS;YACtG,cAAc,CAAC,MAAM,CAAC,cAAc,KAAK,0BAAc,CAAC,MAAM,CAAC;IAC1E,CAAC;CACF;AA7FD,wCA6FC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { DecimalPrecision, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from \"@itwin/core-quantity\";\r\nimport { Format } from \"./Format\";\r\nimport { InvertedUnit } from \"./InvertedUnit\";\r\nimport { Schema } from \"./Schema\";\r\nimport { Unit } from \"./Unit\";\r\n\r\n/**\r\n * Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.\r\n * @beta\r\n */\r\nexport class OverrideFormat {\r\n  private _precision?: DecimalPrecision | FractionalPrecision;\r\n  private _units?: Array<[Unit | InvertedUnit, string | undefined]>;\r\n\r\n  /** The Format that this OverrideFormat is extending */\r\n  public readonly parent: Format;\r\n\r\n  /** The name of this OverrideFormat.\r\n   *\r\n   * This should be set to the [FormatString]($docs/bis/ec/kindofquantity/#format-string) which represents the format override.\r\n   */\r\n  public readonly name: string;\r\n\r\n  constructor(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>) {\r\n    this.parent = parent;\r\n    this.name = OverrideFormat.createOverrideFormatFullName(parent, precision, unitAndLabels);\r\n    this._precision = precision;\r\n    this._units = unitAndLabels;\r\n  }\r\n\r\n  // Properties that can be overriden\r\n  public get precision(): DecimalPrecision | FractionalPrecision { return (undefined === this._precision) ? this.parent.precision : this._precision; }\r\n  public get units() { return (undefined === this._units) ? this.parent.units : this._units; }\r\n\r\n  // Properties that cannot be overriden\r\n  public get fullName(): string { return this.name; }\r\n  public get roundFactor(): number { return this.parent.roundFactor; }\r\n  public get type(): FormatType { return this.parent.type; }\r\n  public get minWidth(): number | undefined { return this.parent.minWidth; }\r\n  public get scientificType(): ScientificType | undefined { return this.parent.scientificType; }\r\n  public get showSignOption(): ShowSignOption { return this.parent.showSignOption; }\r\n  public get decimalSeparator(): string { return this.parent.decimalSeparator; }\r\n  public get thousandSeparator(): string { return this.parent.thousandSeparator; }\r\n  public get uomSeparator(): string { return this.parent.uomSeparator; }\r\n  public get stationSeparator(): string { return this.parent.stationSeparator; }\r\n  public get stationOffsetSize(): number | undefined { return this.parent.stationOffsetSize; }\r\n  public get formatTraits(): FormatTraits { return this.parent.formatTraits; }\r\n  public get spacer(): string | undefined { return this.parent.spacer; }\r\n  public get includeZero(): boolean | undefined { return this.parent.includeZero; }\r\n\r\n  public hasFormatTrait(formatTrait: FormatTraits) {\r\n    return (this.parent.formatTraits & formatTrait) === formatTrait;\r\n  }\r\n\r\n  /** Returns the format string of this override in the Xml full name format.\r\n   * @alpha\r\n   */\r\n  public fullNameXml(koqSchema: Schema): string {\r\n    let fullName = XmlSerializationUtils.createXmlTypedName(koqSchema, this.parent.schema, this.parent.name);\r\n\r\n    if (undefined !== this.precision)\r\n      fullName += `(${this.precision.toString()})`;\r\n\r\n    if (undefined === this._units)\r\n      return fullName;\r\n    for (const [unit, unitLabel] of this._units) {\r\n      fullName += \"[\";\r\n      fullName += XmlSerializationUtils.createXmlTypedName(koqSchema, unit.schema, unit.name);\r\n      fullName += `|${unitLabel}]`;\r\n    }\r\n    return fullName;\r\n  }\r\n\r\n  /**\r\n   * Creates a valid OverrideFormat fullName from the parent Format and overridden units.\r\n   * @param parent The parent Format.\r\n   * @param unitAndLabels The overridden unit and labels collection.\r\n   */\r\n  public static createOverrideFormatFullName(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>): string {\r\n    let fullName = parent.fullName;\r\n\r\n    if (precision)\r\n      fullName += `(${precision.toString()})`;\r\n\r\n    if (undefined === unitAndLabels)\r\n      return fullName;\r\n    for (const [unit, unitLabel] of unitAndLabels)\r\n      if (undefined === unitLabel)\r\n        fullName += `[${unit.fullName}]`;\r\n      else\r\n        fullName += `[${unit.fullName}|${unitLabel}]`;\r\n    return fullName;\r\n  }\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  public static isOverrideFormat(object: any): object is OverrideFormat {\r\n    const overrideFormat = object as OverrideFormat;\r\n\r\n    return overrideFormat !== undefined && overrideFormat.name !== undefined && overrideFormat.parent !== undefined &&\r\n             overrideFormat.parent.schemaItemType === SchemaItemType.Format;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"OverrideFormat.js","sourceRoot":"","sources":["../../../src/Metadata/OverrideFormat.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oFAAiF;AACjF,4CAA8C;AAS9C;;;GAGG;AACH,MAAa,cAAc;IAazB,YAAY,MAAc,EAAE,SAAkD,EAAE,aAAgE;QAC9I,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,4BAA4B,CAAC,MAAM,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QAC1F,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC;IAC9B,CAAC;IAED,mCAAmC;IACnC,IAAW,SAAS,KAA6C,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACpJ,IAAW,KAAK,KAAK,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAE5F,sCAAsC;IACtC,IAAW,QAAQ,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACnD,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IACpE,IAAW,IAAI,KAAiB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1D,IAAW,QAAQ,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC1E,IAAW,cAAc,KAAiC,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;IAC9F,IAAW,cAAc,KAAqB,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;IAClF,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC9E,IAAW,iBAAiB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAChF,IAAW,YAAY,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IACtE,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC9E,IAAW,iBAAiB,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC5F,IAAW,YAAY,KAAmB,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IAC5E,IAAW,MAAM,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IACtE,IAAW,WAAW,KAA0B,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IAE1E,cAAc,CAAC,WAAyB;QAC7C,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,WAAW,CAAC,KAAK,WAAW,CAAC;IAClE,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,SAAiB;QAClC,IAAI,QAAQ,GAAG,6CAAqB,CAAC,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEzG,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,QAAQ,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC;QAE/C,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,OAAO,QAAQ,CAAC;QAClB,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE;YAC3C,QAAQ,IAAI,GAAG,CAAC;YAChB,QAAQ,IAAI,6CAAqB,CAAC,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACxF,QAAQ,IAAI,IAAI,SAAS,GAAG,CAAC;SAC9B;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,4BAA4B,CAAC,MAAc,EAAE,SAAkD,EAAE,aAAgE;QAC7K,IAAI,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAE/B,IAAI,SAAS;YACX,QAAQ,IAAI,IAAI,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC;QAE1C,IAAI,SAAS,KAAK,aAAa;YAC7B,OAAO,QAAQ,CAAC;QAClB,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,aAAa;YAC3C,IAAI,SAAS,KAAK,SAAS;gBACzB,QAAQ,IAAI,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC;;gBAEjC,QAAQ,IAAI,IAAI,IAAI,CAAC,QAAQ,IAAI,SAAS,GAAG,CAAC;QAClD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,gBAAgB,CAAC,MAAW;QACxC,MAAM,cAAc,GAAG,MAAwB,CAAC;QAEhD,OAAO,cAAc,KAAK,SAAS,IAAI,cAAc,CAAC,IAAI,KAAK,SAAS,IAAI,cAAc,CAAC,MAAM,KAAK,SAAS,IAAI,cAAc,CAAC,MAAM,CAAC,cAAc,KAAK,0BAAc,CAAC,MAAM,CAAC;IACpL,CAAC;IAED;;;;;OAKG;IACI,cAAc;QACnB,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAA4C,CAAC;QAElF,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,EAAE;YAC1C,yEAAyE;YACzE,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC;YAChC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;SAC1C;QAED,sCAAsC;QACtC,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEtC,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE;YAC5B,kCAAkC;YAClC,MAAM,KAAK,GAAG,EAAE,CAAC;YACjB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE;gBAC7B,KAAK,CAAC,IAAI,CAAC;oBACT,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ;oBACtB,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;iBACf,CAAC,CAAC;aACJ;YAED,UAAU,CAAC,SAAS,GAAG;gBACrB,MAAM,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;gBACvD,WAAW,EAAE,CAAC,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;gBACxE,KAAK;aACN,CAAC;SACH;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AAlID,wCAkIC;AAED;;GAEG;AACH,SAAgB,cAAc,CAAC,MAA+B;IAC5D,OAAO,cAAc,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;AAC7F,CAAC;AAFD,wCAEC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { DecimalPrecision, FormatProps, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from \"@itwin/core-quantity\";\r\nimport { Format } from \"./Format\";\r\nimport { InvertedUnit } from \"./InvertedUnit\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItemOverrideFormatProps } from \"../Deserialization/JsonProps\";\r\nimport { Unit } from \"./Unit\";\r\nimport { Mutable } from \"@itwin/core-bentley\";\r\n\r\n/**\r\n * Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.\r\n * @beta\r\n */\r\nexport class OverrideFormat {\r\n  private _precision?: DecimalPrecision | FractionalPrecision;\r\n  private _units?: Array<[Unit | InvertedUnit, string | undefined]>;\r\n\r\n  /** The Format that this OverrideFormat is extending */\r\n  public readonly parent: Format;\r\n\r\n  /** The name of this OverrideFormat.\r\n   *\r\n   * This should be set to the [FormatString]($docs/bis/ec/kindofquantity/#format-string) which represents the format override.\r\n   */\r\n  public readonly name: string;\r\n\r\n  constructor(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>) {\r\n    this.parent = parent;\r\n    this.name = OverrideFormat.createOverrideFormatFullName(parent, precision, unitAndLabels);\r\n    this._precision = precision;\r\n    this._units = unitAndLabels;\r\n  }\r\n\r\n  // Properties that can be overriden\r\n  public get precision(): DecimalPrecision | FractionalPrecision { return (undefined === this._precision) ? this.parent.precision : this._precision; }\r\n  public get units() { return (undefined === this._units) ? this.parent.units : this._units; }\r\n\r\n  // Properties that cannot be overriden\r\n  public get fullName(): string { return this.name; }\r\n  public get roundFactor(): number { return this.parent.roundFactor; }\r\n  public get type(): FormatType { return this.parent.type; }\r\n  public get minWidth(): number | undefined { return this.parent.minWidth; }\r\n  public get scientificType(): ScientificType | undefined { return this.parent.scientificType; }\r\n  public get showSignOption(): ShowSignOption { return this.parent.showSignOption; }\r\n  public get decimalSeparator(): string { return this.parent.decimalSeparator; }\r\n  public get thousandSeparator(): string { return this.parent.thousandSeparator; }\r\n  public get uomSeparator(): string { return this.parent.uomSeparator; }\r\n  public get stationSeparator(): string { return this.parent.stationSeparator; }\r\n  public get stationOffsetSize(): number | undefined { return this.parent.stationOffsetSize; }\r\n  public get formatTraits(): FormatTraits { return this.parent.formatTraits; }\r\n  public get spacer(): string | undefined { return this.parent.spacer; }\r\n  public get includeZero(): boolean | undefined { return this.parent.includeZero; }\r\n\r\n  public hasFormatTrait(formatTrait: FormatTraits) {\r\n    return (this.parent.formatTraits & formatTrait) === formatTrait;\r\n  }\r\n\r\n  /** Returns the format string of this override in the Xml full name format.\r\n   * @alpha\r\n   */\r\n  public fullNameXml(koqSchema: Schema): string {\r\n    let fullName = XmlSerializationUtils.createXmlTypedName(koqSchema, this.parent.schema, this.parent.name);\r\n\r\n    if (undefined !== this.precision)\r\n      fullName += `(${this.precision.toString()})`;\r\n\r\n    if (undefined === this._units)\r\n      return fullName;\r\n    for (const [unit, unitLabel] of this._units) {\r\n      fullName += \"[\";\r\n      fullName += XmlSerializationUtils.createXmlTypedName(koqSchema, unit.schema, unit.name);\r\n      fullName += `|${unitLabel}]`;\r\n    }\r\n    return fullName;\r\n  }\r\n\r\n  /**\r\n   * Creates a valid OverrideFormat fullName from the parent Format and overridden units.\r\n   * @param parent The parent Format.\r\n   * @param unitAndLabels The overridden unit and labels collection.\r\n   */\r\n  public static createOverrideFormatFullName(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>): string {\r\n    let fullName = parent.fullName;\r\n\r\n    if (precision)\r\n      fullName += `(${precision.toString()})`;\r\n\r\n    if (undefined === unitAndLabels)\r\n      return fullName;\r\n    for (const [unit, unitLabel] of unitAndLabels)\r\n      if (undefined === unitLabel)\r\n        fullName += `[${unit.fullName}]`;\r\n      else\r\n        fullName += `[${unit.fullName}|${unitLabel}]`;\r\n    return fullName;\r\n  }\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  public static isOverrideFormat(object: any): object is OverrideFormat {\r\n    const overrideFormat = object as OverrideFormat;\r\n\r\n    return overrideFormat !== undefined && overrideFormat.name !== undefined && overrideFormat.parent !== undefined && overrideFormat.parent.schemaItemType === SchemaItemType.Format;\r\n  }\r\n\r\n  /**\r\n   * Returns a JSON object that contains the specification for the OverrideFormat where the precision and units properties have been overriden.\r\n   * If the precision and/or units properties have been overriden, the returned object will contain a \"name\" and a \"parent\" property.\r\n   * The \"name\" property identifies the OverrideFormat object itself and the \"parent\" property identifies the Format that has been overriden.\r\n   * This method is not intended for complete serialization as it does not serialize any of the schema item properties.\r\n   */\r\n  public getFormatProps(): SchemaItemOverrideFormatProps {\r\n    const formatJson = this.parent.toJSON() as Mutable<SchemaItemOverrideFormatProps>;\r\n\r\n    if (this.parent.fullName !== this.fullName) {\r\n      // Update name and parent properties to distinguish it from parent Format\r\n      formatJson.name = this.fullName;\r\n      formatJson.parent = this.parent.fullName;\r\n    }\r\n\r\n    // Update Precision overriden property\r\n    formatJson.precision = this.precision;\r\n\r\n    if (this.units !== undefined) {\r\n      // Update Units overriden property\r\n      const units = [];\r\n      for (const unit of this.units) {\r\n        units.push({\r\n          name: unit[0].fullName,\r\n          label: unit[1],\r\n        });\r\n      }\r\n\r\n      formatJson.composite = {\r\n        spacer: (this.spacer !== \" \") ? this.spacer : undefined,\r\n        includeZero: (this.includeZero === false) ? this.includeZero : undefined,\r\n        units,\r\n      };\r\n    }\r\n\r\n    return formatJson;\r\n  }\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport function getFormatProps(format: Format | OverrideFormat): FormatProps {\r\n  return OverrideFormat.isOverrideFormat(format) ? format.getFormatProps() : format.toJSON();\r\n}\r\n"]}

package/lib/cjs/Metadata/Phenomenon.d.ts

@@ -1,34 +1,34 @@
-/** @packageDocumentation
- * @module Metadata
- */
-import { PhenomenonProps } from "../Deserialization/JsonProps";
-import { SchemaItemType } from "../ECObjects";
-import { Schema } from "./Schema";
-import { SchemaItem } from "./SchemaItem";
-/** @beta */
-export declare class Phenomenon extends SchemaItem {
-    readonly schemaItemType: SchemaItemType.Phenomenon;
-    protected _definition: string;
-    constructor(schema: Schema, name: string);
-    get definition(): string;
-    /**
-     * Save this Phenomenon's properties to an object for serializing to JSON.
-     * @param standalone Serialization includes only this object (as opposed to the full schema).
-     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
-     */
-    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): PhenomenonProps;
-    /** @internal */
-    toXml(schemaXml: Document): Promise<Element>;
-    fromJSONSync(phenomenonProps: PhenomenonProps): void;
-    fromJSON(phenomenonProps: PhenomenonProps): Promise<void>;
-    protected setDefinition(definition: string): Promise<void>;
-}
-/**
- * @internal
- * An abstract class used for schema editing.
- */
-export declare abstract class MutablePhenomenon extends Phenomenon {
-    abstract setDefinition(definition: string): Promise<void>;
-    abstract setDisplayLabel(displayLabel: string): void;
-}
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { PhenomenonProps } from "../Deserialization/JsonProps";
+import { SchemaItemType } from "../ECObjects";
+import { Schema } from "./Schema";
+import { SchemaItem } from "./SchemaItem";
+/** @beta */
+export declare class Phenomenon extends SchemaItem {
+    readonly schemaItemType: SchemaItemType.Phenomenon;
+    protected _definition: string;
+    constructor(schema: Schema, name: string);
+    get definition(): string;
+    /**
+     * Save this Phenomenon's properties to an object for serializing to JSON.
+     * @param standalone Serialization includes only this object (as opposed to the full schema).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): PhenomenonProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    fromJSONSync(phenomenonProps: PhenomenonProps): void;
+    fromJSON(phenomenonProps: PhenomenonProps): Promise<void>;
+    protected setDefinition(definition: string): Promise<void>;
+}
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+export declare abstract class MutablePhenomenon extends Phenomenon {
+    abstract setDefinition(definition: string): Promise<void>;
+    abstract setDisplayLabel(displayLabel: string): void;
+}
 //# sourceMappingURL=Phenomenon.d.ts.map

package/lib/cjs/Metadata/Phenomenon.js

@@ -1,60 +1,60 @@
-"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 Metadata
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MutablePhenomenon = exports.Phenomenon = void 0;
-const ECObjects_1 = require("../ECObjects");
-const Exception_1 = require("../Exception");
-const SchemaItem_1 = require("./SchemaItem");
-/** @beta */
-class Phenomenon extends SchemaItem_1.SchemaItem {
-    constructor(schema, name) {
-        super(schema, name);
-        this.schemaItemType = ECObjects_1.SchemaItemType.Phenomenon;
-        this._definition = "";
-    }
-    get definition() { return this._definition; }
-    /**
-     * Save this Phenomenon's properties to an object for serializing to JSON.
-     * @param standalone Serialization includes only this object (as opposed to the full schema).
-     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
-     */
-    toJSON(standalone = false, includeSchemaVersion = false) {
-        const schemaJson = super.toJSON(standalone, includeSchemaVersion);
-        schemaJson.definition = this.definition;
-        return schemaJson;
-    }
-    /** @internal */
-    async toXml(schemaXml) {
-        const itemElement = await super.toXml(schemaXml);
-        itemElement.setAttribute("definition", this.definition);
-        return itemElement;
-    }
-    fromJSONSync(phenomenonProps) {
-        super.fromJSONSync(phenomenonProps);
-        if (this._definition !== "" && phenomenonProps.definition.toLowerCase() !== this._definition.toLowerCase())
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Phenomenon ${this.name} has an invalid 'definition' attribute.`);
-        else if (this._definition === "")
-            this._definition = phenomenonProps.definition;
-    }
-    async fromJSON(phenomenonProps) {
-        this.fromJSONSync(phenomenonProps);
-    }
-    async setDefinition(definition) {
-        this._definition = definition;
-    }
-}
-exports.Phenomenon = Phenomenon;
-/**
- * @internal
- * An abstract class used for schema editing.
- */
-class MutablePhenomenon extends Phenomenon {
-}
-exports.MutablePhenomenon = MutablePhenomenon;
+"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 Metadata
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MutablePhenomenon = exports.Phenomenon = void 0;
+const ECObjects_1 = require("../ECObjects");
+const Exception_1 = require("../Exception");
+const SchemaItem_1 = require("./SchemaItem");
+/** @beta */
+class Phenomenon extends SchemaItem_1.SchemaItem {
+    constructor(schema, name) {
+        super(schema, name);
+        this.schemaItemType = ECObjects_1.SchemaItemType.Phenomenon;
+        this._definition = "";
+    }
+    get definition() { return this._definition; }
+    /**
+     * Save this Phenomenon's properties to an object for serializing to JSON.
+     * @param standalone Serialization includes only this object (as opposed to the full schema).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone = false, includeSchemaVersion = false) {
+        const schemaJson = super.toJSON(standalone, includeSchemaVersion);
+        schemaJson.definition = this.definition;
+        return schemaJson;
+    }
+    /** @internal */
+    async toXml(schemaXml) {
+        const itemElement = await super.toXml(schemaXml);
+        itemElement.setAttribute("definition", this.definition);
+        return itemElement;
+    }
+    fromJSONSync(phenomenonProps) {
+        super.fromJSONSync(phenomenonProps);
+        if (this._definition !== "" && phenomenonProps.definition.toLowerCase() !== this._definition.toLowerCase())
+            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Phenomenon ${this.name} has an invalid 'definition' attribute.`);
+        else if (this._definition === "")
+            this._definition = phenomenonProps.definition;
+    }
+    async fromJSON(phenomenonProps) {
+        this.fromJSONSync(phenomenonProps);
+    }
+    async setDefinition(definition) {
+        this._definition = definition;
+    }
+}
+exports.Phenomenon = Phenomenon;
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+class MutablePhenomenon extends Phenomenon {
+}
+exports.MutablePhenomenon = MutablePhenomenon;
 //# sourceMappingURL=Phenomenon.js.map