@itwin/ecschema-metadata 5.0.0-dev.11 → 5.0.0-dev.110

package/lib/esm/Metadata/OverrideFormat.d.ts

@@ -3,21 +3,20 @@
  */
 import { DecimalPrecision, FormatProps, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from "@itwin/core-quantity";
 import { Format } from "./Format";
-import { InvertedUnit } from "./InvertedUnit";
 import { Schema } from "./Schema";
 import { SchemaItemOverrideFormatProps } from "../Deserialization/JsonProps";
-import { Unit } from "./Unit";
+import { LazyLoadedInvertedUnit, LazyLoadedUnit } from "../Interfaces";
 /**
- * @beta
+ * @public @preview
  */
 export interface OverrideFormatProps {
-    name: string;
-    precision?: number;
-    unitAndLabels?: Array<[string, string | undefined]>;
+    readonly name: string;
+    readonly precision?: number;
+    readonly unitAndLabels?: Array<[string, string | undefined]>;
 }
 /**
  * Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.
- * @beta
+ * @public @preview
  */
 export declare class OverrideFormat {
     private _precision?;
@@ -29,9 +28,10 @@ export declare class OverrideFormat {
      * This should be set to the [FormatString]($docs/bis/ec/kindofquantity/#format-string) which represents the format override.
      */
     readonly name: string;
-    constructor(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>);
+    /** @internal */
+    constructor(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]>);
     get precision(): DecimalPrecision | FractionalPrecision;
-    get units(): [Unit | InvertedUnit, string | undefined][] | undefined;
+    get units(): ReadonlyArray<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]> | undefined;
     get fullName(): string;
     get roundFactor(): number;
     get type(): FormatType;
@@ -48,7 +48,7 @@ export declare class OverrideFormat {
     get includeZero(): boolean | undefined;
     hasFormatTrait(formatTrait: FormatTraits): boolean;
     /** Returns the format string of this override in the Xml full name format.
-     * @alpha
+     * @internal
      */
     fullNameXml(koqSchema: Schema): string;
     /**
@@ -56,7 +56,7 @@ export declare class OverrideFormat {
      * @param parent The parent Format.
      * @param unitAndLabels The overridden unit and labels collection.
      */
-    static createOverrideFormatFullName(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>): string;
+    static createOverrideFormatFullName(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]>): string;
     /** Parses the format string into the parts that make up an Override Format
      * @param formatString
      */
@@ -64,7 +64,7 @@ export declare class OverrideFormat {
     /**
      * @internal
      */
-    static isOverrideFormat(object: any): object is OverrideFormat;
+    static isOverrideFormat(format: unknown): format is OverrideFormat;
     /**
      * 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.

package/lib/esm/Metadata/OverrideFormat.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OverrideFormat.d.ts","sourceRoot":"","sources":["../../../src/Metadata/OverrideFormat.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAmB,YAAY,EAAE,UAAU,EAAE,mBAAmB,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACrK,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,6BAA6B,EAAE,MAAM,8BAA8B,CAAC;AAC7E,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAI9B;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;CACrD;AAED;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,UAAU,CAAC,CAAyC;IAC5D,OAAO,CAAC,MAAM,CAAC,CAAmD;IAElE,uDAAuD;IACvD,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;gBAEjB,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,gBAAgB,GAAG,mBAAmB,EAAE,aAAa,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAQhJ,IAAW,SAAS,IAAI,gBAAgB,GAAG,mBAAmB,CAAsF;IACpJ,IAAW,KAAK,4DAA4E;IAG5F,IAAW,QAAQ,IAAI,MAAM,CAAsB;IACnD,IAAW,WAAW,IAAI,MAAM,CAAoC;IACpE,IAAW,IAAI,IAAI,UAAU,CAA6B;IAC1D,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAiC;IAC1E,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAAuC;IAC9F,IAAW,cAAc,IAAI,cAAc,CAAuC;IAClF,IAAW,gBAAgB,IAAI,MAAM,CAAyC;IAC9E,IAAW,iBAAiB,IAAI,MAAM,CAA0C;IAChF,IAAW,YAAY,IAAI,MAAM,CAAqC;IACtE,IAAW,gBAAgB,IAAI,MAAM,CAAyC;IAC9E,IAAW,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAA0C;IAC5F,IAAW,YAAY,IAAI,YAAY,CAAqC;IAC5E,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAA+B;IACtE,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAAoC;IAE1E,cAAc,CAAC,WAAW,EAAE,YAAY;IAI/C;;OAEG;IACI,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAkB7C;;;;OAIG;WACW,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,gBAAgB,GAAG,mBAAmB,EAAE,aAAa,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,MAAM;IAgBxL;;OAEG;WACW,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,mBAAmB;IA4D1E;;OAEG;WACW,gBAAgB,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,cAAc;IAMrE;;;;;OAKG;IACI,cAAc,IAAI,6BAA6B;CA+BvD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,GAAG,WAAW,CAE3E"}
+{"version":3,"file":"OverrideFormat.d.ts","sourceRoot":"","sources":["../../../src/Metadata/OverrideFormat.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAmB,YAAY,EAAE,UAAU,EAAE,mBAAmB,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACrK,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,6BAA6B,EAAE,MAAM,8BAA8B,CAAC;AAE7E,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAGvE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;CAC9D;AAED;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,UAAU,CAAC,CAAyC;IAC5D,OAAO,CAAC,MAAM,CAAC,CAAuE;IAEtF,uDAAuD;IACvD,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B,gBAAgB;gBACJ,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,gBAAgB,GAAG,mBAAmB,EAAE,aAAa,CAAC,EAAE,KAAK,CAAC,CAAC,cAAc,GAAG,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAQpK,IAAW,SAAS,IAAI,gBAAgB,GAAG,mBAAmB,CAE7D;IAED,IAAW,KAAK,IAAI,aAAa,CAAC,CAAC,cAAc,GAAG,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,CAE3G;IAGD,IAAW,QAAQ,IAAI,MAAM,CAAsB;IACnD,IAAW,WAAW,IAAI,MAAM,CAAoC;IACpE,IAAW,IAAI,IAAI,UAAU,CAA6B;IAC1D,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAiC;IAC1E,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAAuC;IAC9F,IAAW,cAAc,IAAI,cAAc,CAAuC;IAClF,IAAW,gBAAgB,IAAI,MAAM,CAAyC;IAC9E,IAAW,iBAAiB,IAAI,MAAM,CAA0C;IAChF,IAAW,YAAY,IAAI,MAAM,CAAqC;IACtE,IAAW,gBAAgB,IAAI,MAAM,CAAyC;IAC9E,IAAW,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAA0C;IAC5F,IAAW,YAAY,IAAI,YAAY,CAAqC;IAC5E,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAA+B;IACtE,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAAoC;IAE1E,cAAc,CAAC,WAAW,EAAE,YAAY;IAI/C;;OAEG;IACI,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAsB7C;;;;OAIG;WACW,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,gBAAgB,GAAG,mBAAmB,EAAE,aAAa,CAAC,EAAE,KAAK,CAAC,CAAC,cAAc,GAAG,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,MAAM;IAgB5M;;OAEG;WACW,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,mBAAmB;IA0D1E;;OAEG;WACW,gBAAgB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,cAAc;IAMzE;;;;;OAKG;IACI,cAAc,IAAI,6BAA6B;CA+BvD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,GAAG,WAAW,CAE3E"}

package/lib/esm/Metadata/OverrideFormat.js

@@ -8,12 +8,22 @@
 import { XmlSerializationUtils } from "../Deserialization/XmlSerializationUtils";
 import { SchemaItemType } from "../ECObjects";
 import { formatStringRgx } from "@itwin/core-quantity";
-import { ECObjectsError, ECObjectsStatus } from "../Exception";
+import { ECSchemaError, ECSchemaStatus } from "../Exception";
 /**
  * Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.
- * @beta
+ * @public @preview
  */
 export class OverrideFormat {
+    _precision;
+    _units;
+    /** The Format that this OverrideFormat is extending */
+    parent;
+    /** The name of this OverrideFormat.
+     *
+     * This should be set to the [FormatString]($docs/bis/ec/kindofquantity/#format-string) which represents the format override.
+     */
+    name;
+    /** @internal */
     constructor(parent, precision, unitAndLabels) {
         this.parent = parent;
         this.name = OverrideFormat.createOverrideFormatFullName(parent, precision, unitAndLabels);
@@ -21,8 +31,12 @@ export class OverrideFormat {
         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; }
+    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; }
@@ -42,7 +56,7 @@ export class OverrideFormat {
         return (this.parent.formatTraits & formatTrait) === formatTrait;
     }
     /** Returns the format string of this override in the Xml full name format.
-     * @alpha
+     * @internal
      */
     fullNameXml(koqSchema) {
         let fullName = XmlSerializationUtils.createXmlTypedName(koqSchema, this.parent.schema, this.parent.name);
@@ -51,8 +65,11 @@ export class OverrideFormat {
         if (undefined === this._units)
             return fullName;
         for (const [unit, unitLabel] of this._units) {
+            const unitSchema = koqSchema.context.getSchemaSync(unit.schemaKey);
+            if (unitSchema === undefined)
+                throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The unit schema ${unit.schemaKey} is not found in the context.`);
             fullName += "[";
-            fullName += XmlSerializationUtils.createXmlTypedName(koqSchema, unit.schema, unit.name);
+            fullName += XmlSerializationUtils.createXmlTypedName(koqSchema, unitSchema, unit.name);
             if (unitLabel !== undefined)
                 fullName += `|${unitLabel}`;
             fullName += `]`;
@@ -83,8 +100,8 @@ export class OverrideFormat {
     static parseFormatString(formatString) {
         const match = formatString.split(formatStringRgx); // split string based on regex groups
         if (undefined === match[1])
-            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The format string, ${formatString}, on KindOfQuantity is missing a format.`);
-        const returnValue = { name: match[1] };
+            throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The format string, ${formatString}, on KindOfQuantity is missing a format.`);
+        let precision;
         if (undefined !== match[2] && undefined !== match[3]) {
             const overrideString = match[2];
             const tokens = [];
@@ -98,41 +115,41 @@ export class OverrideFormat {
             if (overrideString.length > 0 && undefined === tokens.find((token) => {
                 return "" !== token; // there is at least one token that is not empty.
             })) {
-                throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);
+                throw new ECSchemaError(ECSchemaStatus.InvalidECJson, ``);
             }
             // The first override parameter overrides the default precision of the format
             const precisionIndx = 0;
             if (tokens.length >= precisionIndx + 1) {
                 if (tokens[precisionIndx].length > 0) {
-                    const precision = Number.parseInt(tokens[precisionIndx], 10);
+                    precision = Number.parseInt(tokens[precisionIndx], 10);
                     if (Number.isNaN(precision))
-                        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The format string '${formatString}' on KindOfQuantity has a precision override '${tokens[precisionIndx]}' that is not number.`);
-                    returnValue.precision = precision;
+                        throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The format string '${formatString}' on KindOfQuantity has a precision override '${tokens[precisionIndx]}' that is not number.`);
                 }
             }
         }
         let i = 4;
+        let unitAndLabels;
         while (i < match.length - 1) { // The regex match ends with an empty last value, which causes problems when exactly 4 unit overrides as specified, so ignore this last empty value
             if (undefined === match[i])
                 break;
             // Unit override required
             if (undefined === match[i + 1])
-                throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);
-            if (undefined === returnValue.unitAndLabels)
-                returnValue.unitAndLabels = [];
+                throw new ECSchemaError(ECSchemaStatus.InvalidECJson, ``);
+            if (undefined === unitAndLabels)
+                unitAndLabels = [];
             if (undefined !== match[i + 2]) // matches '|'
-                returnValue.unitAndLabels.push([match[i + 1], match[i + 3] ?? ""]); // add unit name and label override (if '|' matches and next value is undefined, save it as an empty string)
+                unitAndLabels.push([match[i + 1], match[i + 3] ?? ""]); // add unit name and label override (if '|' matches and next value is undefined, save it as an empty string)
             else
-                returnValue.unitAndLabels.push([match[i + 1], undefined]); // add unit name
+                unitAndLabels.push([match[i + 1], undefined]); // add unit name
             i += 4;
         }
-        return returnValue;
+        return { name: match[1], precision, unitAndLabels };
     }
     /**
      * @internal
      */
-    static isOverrideFormat(object) {
-        const overrideFormat = object;
+    static isOverrideFormat(format) {
+        const overrideFormat = format;
         return overrideFormat !== undefined && overrideFormat.name !== undefined && overrideFormat.parent !== undefined && overrideFormat.parent.schemaItemType === SchemaItemType.Format;
     }
     /**

package/lib/esm/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,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AACjF,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAiC,eAAe,EAAiF,MAAM,sBAAsB,CAAC;AAOrK,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAW/D;;;GAGG;AACH,MAAM,OAAO,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,qBAAqB,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,CAAC;YAC5C,QAAQ,IAAI,GAAG,CAAC;YAChB,QAAQ,IAAI,qBAAqB,CAAC,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACxF,IAAI,SAAS,KAAK,SAAS;gBACzB,QAAQ,IAAI,IAAI,SAAS,EAAE,CAAC;YAC9B,QAAQ,IAAI,GAAG,CAAC;QAClB,CAAC;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,iBAAiB,CAAC,YAAoB;QAClD,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,qCAAqC;QACxF,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC;YACxB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,sBAAsB,YAAY,0CAA0C,CAAC,CAAC;QAExI,MAAM,WAAW,GAAwB,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAE5D,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACrD,MAAM,cAAc,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAChC,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,2FAA2F;YAC5G,IAAI,OAAO,CAAC;YAEZ,uDAAuD;YACvD,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC;gBAC/D,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;gBACxD,OAAO,GAAG,OAAO,GAAG,CAAC,CAAC;YACxB,CAAC;YAED,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,IAAI,SAAS,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;gBACnE,OAAO,EAAE,KAAK,KAAK,CAAC,CAAC,iDAAiD;YACxE,CAAC,CAAC,EAAE,CAAC;gBACH,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAC9D,CAAC;YAED,6EAA6E;YAC7E,MAAM,aAAa,GAAW,CAAC,CAAC;YAEhC,IAAI,MAAM,CAAC,MAAM,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;gBACvC,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACrC,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC,CAAC;oBAC7D,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;wBACzB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,sBAAsB,YAAY,iDAAiD,MAAM,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;oBAC3L,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC;gBACpC,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,CAAE,mJAAmJ;YACjL,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC;gBACxB,MAAM;YACR,yBAAyB;YACzB,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC;gBAC5B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAE9D,IAAI,SAAS,KAAK,WAAW,CAAC,aAAa;gBACzC,WAAW,CAAC,aAAa,GAAG,EAAE,CAAC;YAEjC,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,cAAc;gBAC5C,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,4GAA4G;;gBAEhL,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,gBAAgB;YAE7E,CAAC,IAAI,CAAC,CAAC;QACT,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,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,cAAc,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,CAAC;YAC3C,yEAAyE;YACzE,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC;YAChC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAC3C,CAAC;QAED,sCAAsC;QACtC,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEtC,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC7B,kCAAkC;YAClC,MAAM,KAAK,GAAG,EAAE,CAAC;YACjB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBAC9B,KAAK,CAAC,IAAI,CAAC;oBACT,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ;oBACtB,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;iBACf,CAAC,CAAC;YACL,CAAC;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;QACJ,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,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","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, formatStringRgx, 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\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface OverrideFormatProps {\r\n  name: string;\r\n  precision?: number;\r\n  unitAndLabels?: Array<[string, string | undefined]>; // Tuple of [unit name | unit label]\r\n}\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      if (unitLabel !== undefined)\r\n        fullName += `|${unitLabel}`;\r\n      fullName += `]`;\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  /** Parses the format string into the parts that make up an Override Format\r\n   * @param formatString\r\n   */\r\n  public static parseFormatString(formatString: string): OverrideFormatProps {\r\n    const match = formatString.split(formatStringRgx); // split string based on regex groups\r\n    if (undefined === match[1])\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The format string, ${formatString}, on KindOfQuantity is missing a format.`);\r\n\r\n    const returnValue: OverrideFormatProps = { name: match[1] };\r\n\r\n    if (undefined !== match[2] && undefined !== match[3]) {\r\n      const overrideString = match[2];\r\n      const tokens: string[] = [];\r\n      let prevPos = 1; // Initial position is the character directly after the opening '(' in the override string.\r\n      let currPos;\r\n\r\n      // TODO need to include `,` as a valid search argument.\r\n      while (-1 !== (currPos = overrideString.indexOf(\")\", prevPos))) {\r\n        tokens.push(overrideString.substring(prevPos, currPos));\r\n        prevPos = currPos + 1;\r\n      }\r\n\r\n      if (overrideString.length > 0 && undefined === tokens.find((token) => {\r\n        return \"\" !== token; // there is at least one token that is not empty.\r\n      })) {\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);\r\n      }\r\n\r\n      // The first override parameter overrides the default precision of the format\r\n      const precisionIndx: number = 0;\r\n\r\n      if (tokens.length >= precisionIndx + 1) {\r\n        if (tokens[precisionIndx].length > 0) {\r\n          const precision = Number.parseInt(tokens[precisionIndx], 10);\r\n          if (Number.isNaN(precision))\r\n            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The format string '${formatString}' on KindOfQuantity has a precision override '${tokens[precisionIndx]}' that is not number.`);\r\n          returnValue.precision = precision;\r\n        }\r\n      }\r\n    }\r\n\r\n    let i = 4;\r\n    while (i < match.length - 1) {  // The regex match ends with an empty last value, which causes problems when exactly 4 unit overrides as specified, so ignore this last empty value\r\n      if (undefined === match[i])\r\n        break;\r\n      // Unit override required\r\n      if (undefined === match[i + 1])\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);\r\n\r\n      if (undefined === returnValue.unitAndLabels)\r\n        returnValue.unitAndLabels = [];\r\n\r\n      if (undefined !== match[i + 2]) // matches '|'\r\n        returnValue.unitAndLabels.push([match[i + 1], match[i + 3] ?? \"\"]); // add unit name and label override (if '|' matches and next value is undefined, save it as an empty string)\r\n      else\r\n        returnValue.unitAndLabels.push([match[i + 1], undefined]); // add unit name\r\n\r\n      i += 4;\r\n    }\r\n\r\n    return returnValue;\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"]}
+{"version":3,"file":"OverrideFormat.js","sourceRoot":"","sources":["../../../src/Metadata/OverrideFormat.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AACjF,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAiC,eAAe,EAAiF,MAAM,sBAAsB,CAAC;AAMrK,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAW7D;;;GAGG;AACH,MAAM,OAAO,cAAc;IACjB,UAAU,CAA0C;IACpD,MAAM,CAAwE;IAEtF,uDAAuD;IACvC,MAAM,CAAS;IAE/B;;;OAGG;IACa,IAAI,CAAS;IAE7B,gBAAgB;IAChB,YAAY,MAAc,EAAE,SAAkD,EAAE,aAAoF;QAClK,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;QAClB,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;IACnF,CAAC;IAED,IAAW,KAAK;QACd,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;IACvE,CAAC;IAED,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,qBAAqB,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,CAAC;YAC5C,MAAM,UAAU,GAAG,SAAS,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACnE,IAAG,UAAU,KAAK,SAAS;gBACzB,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,SAAS,+BAA+B,CAAC,CAAC;YAE1H,QAAQ,IAAI,GAAG,CAAC;YAChB,QAAQ,IAAI,qBAAqB,CAAC,kBAAkB,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACvF,IAAI,SAAS,KAAK,SAAS;gBACzB,QAAQ,IAAI,IAAI,SAAS,EAAE,CAAC;YAC9B,QAAQ,IAAI,GAAG,CAAC;QAClB,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,4BAA4B,CAAC,MAAc,EAAE,SAAkD,EAAE,aAAoF;QACjM,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,iBAAiB,CAAC,YAAoB;QAClD,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,qCAAqC;QACxF,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC;YACxB,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,aAAa,EAAE,sBAAsB,YAAY,0CAA0C,CAAC,CAAC;QAEtI,IAAI,SAA2C,CAAC;QAChD,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACrD,MAAM,cAAc,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAChC,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,2FAA2F;YAC5G,IAAI,OAAO,CAAC;YAEZ,uDAAuD;YACvD,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC;gBAC/D,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;gBACxD,OAAO,GAAG,OAAO,GAAG,CAAC,CAAC;YACxB,CAAC;YAED,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,IAAI,SAAS,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;gBACnE,OAAO,EAAE,KAAK,KAAK,CAAC,CAAC,iDAAiD;YACxE,CAAC,CAAC,EAAE,CAAC;gBACH,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAC5D,CAAC;YAED,6EAA6E;YAC7E,MAAM,aAAa,GAAW,CAAC,CAAC;YAChC,IAAI,MAAM,CAAC,MAAM,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;gBACvC,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACrC,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC,CAAC;oBACvD,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;wBACzB,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,aAAa,EAAE,sBAAsB,YAAY,iDAAiD,MAAM,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;gBAC3L,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,IAAI,aAAmD,CAAC;QACxD,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,CAAE,mJAAmJ;YACjL,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC;gBACxB,MAAM;YACR,yBAAyB;YACzB,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC;gBAC5B,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAE5D,IAAI,SAAS,KAAK,aAAa;gBAC7B,aAAa,GAAG,EAAE,CAAC;YAErB,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,cAAc;gBAC5C,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,4GAA4G;;gBAEpK,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,gBAAgB;YAEjE,CAAC,IAAI,CAAC,CAAC;QACT,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,gBAAgB,CAAC,MAAe;QAC5C,MAAM,cAAc,GAAG,MAAiC,CAAC;QAEzD,OAAO,cAAc,KAAK,SAAS,IAAI,cAAc,CAAC,IAAI,KAAK,SAAS,IAAI,cAAc,CAAC,MAAM,KAAK,SAAS,IAAI,cAAc,CAAC,MAAM,CAAC,cAAc,KAAK,cAAc,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,CAAC;YAC3C,yEAAyE;YACzE,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC;YAChC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAC3C,CAAC;QAED,sCAAsC;QACtC,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEtC,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC7B,kCAAkC;YAClC,MAAM,KAAK,GAAG,EAAE,CAAC;YACjB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBAC9B,KAAK,CAAC,IAAI,CAAC;oBACT,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ;oBACtB,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;iBACf,CAAC,CAAC;YACL,CAAC;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;QACJ,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,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","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, formatStringRgx, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from \"@itwin/core-quantity\";\r\nimport { Format } from \"./Format\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItemOverrideFormatProps } from \"../Deserialization/JsonProps\";\r\nimport { Mutable } from \"@itwin/core-bentley\";\r\nimport { LazyLoadedInvertedUnit, LazyLoadedUnit } from \"../Interfaces\";\r\nimport { ECSchemaError, ECSchemaStatus } from \"../Exception\";\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface OverrideFormatProps {\r\n  readonly name: string;\r\n  readonly precision?: number;\r\n  readonly unitAndLabels?: Array<[string, string | undefined]>; // Tuple of [unit name | unit label]\r\n}\r\n\r\n/**\r\n * Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.\r\n * @public @preview\r\n */\r\nexport class OverrideFormat {\r\n  private _precision?: DecimalPrecision | FractionalPrecision;\r\n  private _units?: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, 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  /** @internal */\r\n  constructor(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, 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 {\r\n    return (undefined === this._precision) ? this.parent.precision : this._precision;\r\n  }\r\n\r\n  public get units(): ReadonlyArray<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]> | undefined {\r\n    return (undefined === this._units) ? this.parent.units : this._units;\r\n  }\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   * @internal\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      const unitSchema = koqSchema.context.getSchemaSync(unit.schemaKey);\r\n      if(unitSchema === undefined)\r\n        throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The unit schema ${unit.schemaKey} is not found in the context.`);\r\n\r\n      fullName += \"[\";\r\n      fullName += XmlSerializationUtils.createXmlTypedName(koqSchema, unitSchema, unit.name);\r\n      if (unitLabel !== undefined)\r\n        fullName += `|${unitLabel}`;\r\n      fullName += `]`;\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<[LazyLoadedUnit | LazyLoadedInvertedUnit, 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  /** Parses the format string into the parts that make up an Override Format\r\n   * @param formatString\r\n   */\r\n  public static parseFormatString(formatString: string): OverrideFormatProps {\r\n    const match = formatString.split(formatStringRgx); // split string based on regex groups\r\n    if (undefined === match[1])\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The format string, ${formatString}, on KindOfQuantity is missing a format.`);\r\n\r\n    let precision: OverrideFormatProps[\"precision\"];\r\n    if (undefined !== match[2] && undefined !== match[3]) {\r\n      const overrideString = match[2];\r\n      const tokens: string[] = [];\r\n      let prevPos = 1; // Initial position is the character directly after the opening '(' in the override string.\r\n      let currPos;\r\n\r\n      // TODO need to include `,` as a valid search argument.\r\n      while (-1 !== (currPos = overrideString.indexOf(\")\", prevPos))) {\r\n        tokens.push(overrideString.substring(prevPos, currPos));\r\n        prevPos = currPos + 1;\r\n      }\r\n\r\n      if (overrideString.length > 0 && undefined === tokens.find((token) => {\r\n        return \"\" !== token; // there is at least one token that is not empty.\r\n      })) {\r\n        throw new ECSchemaError(ECSchemaStatus.InvalidECJson, ``);\r\n      }\r\n\r\n      // The first override parameter overrides the default precision of the format\r\n      const precisionIndx: number = 0;\r\n      if (tokens.length >= precisionIndx + 1) {\r\n        if (tokens[precisionIndx].length > 0) {\r\n          precision = Number.parseInt(tokens[precisionIndx], 10);\r\n          if (Number.isNaN(precision))\r\n            throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The format string '${formatString}' on KindOfQuantity has a precision override '${tokens[precisionIndx]}' that is not number.`);\r\n        }\r\n      }\r\n    }\r\n\r\n    let i = 4;\r\n    let unitAndLabels: OverrideFormatProps[\"unitAndLabels\"];\r\n    while (i < match.length - 1) {  // The regex match ends with an empty last value, which causes problems when exactly 4 unit overrides as specified, so ignore this last empty value\r\n      if (undefined === match[i])\r\n        break;\r\n      // Unit override required\r\n      if (undefined === match[i + 1])\r\n        throw new ECSchemaError(ECSchemaStatus.InvalidECJson, ``);\r\n\r\n      if (undefined === unitAndLabels)\r\n        unitAndLabels = [];\r\n\r\n      if (undefined !== match[i + 2]) // matches '|'\r\n        unitAndLabels.push([match[i + 1], match[i + 3] ?? \"\"]); // add unit name and label override (if '|' matches and next value is undefined, save it as an empty string)\r\n      else\r\n        unitAndLabels.push([match[i + 1], undefined]); // add unit name\r\n\r\n      i += 4;\r\n    }\r\n\r\n    return { name: match[1], precision, unitAndLabels };\r\n  }\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  public static isOverrideFormat(format: unknown): format is OverrideFormat {\r\n    const overrideFormat = format as Partial<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/esm/Metadata/Phenomenon.d.ts

@@ -5,10 +5,13 @@ import { PhenomenonProps } from "../Deserialization/JsonProps";
 import { SchemaItemType } from "../ECObjects";
 import { Schema } from "./Schema";
 import { SchemaItem } from "./SchemaItem";
-/** @beta */
+/** @public @preview */
 export declare class Phenomenon extends SchemaItem {
-    readonly schemaItemType: SchemaItemType.Phenomenon;
-    protected _definition: string;
+    readonly schemaItemType: SchemaItemType;
+    /** @internal */
+    static get schemaItemType(): SchemaItemType;
+    private _definition;
+    /** @internal */
     constructor(schema: Schema, name: string);
     get definition(): string;
     /**
@@ -21,7 +24,25 @@ export declare class Phenomenon extends SchemaItem {
     toXml(schemaXml: Document): Promise<Element>;
     fromJSONSync(phenomenonProps: PhenomenonProps): void;
     fromJSON(phenomenonProps: PhenomenonProps): Promise<void>;
+    /**
+     *
+     * @param definition
+     * @internal
+     */
     protected setDefinition(definition: string): Promise<void>;
+    /**
+     * Type guard to check if the SchemaItem is of type Phenomenon.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a Phenomenon, false otherwise.
+     */
+    static isPhenomenon(item?: SchemaItem): item is Phenomenon;
+    /**
+     * Type assertion to check if the SchemaItem is of type Phenomenon.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to Phenomenon if it is a Phenomenon, undefined otherwise.
+     * @internal
+     */
+    static assertIsPhenomenon(item?: SchemaItem): asserts item is Phenomenon;
 }
 /**
  * @internal

package/lib/esm/Metadata/Phenomenon.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Phenomenon.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Phenomenon.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,YAAY;AACZ,qBAAa,UAAW,SAAQ,UAAU;IACxC,SAAyB,cAAc,EAAG,cAAc,CAAC,UAAU,CAAC;IACpE,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;gBAElB,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAMxC,IAAW,UAAU,IAAI,MAAM,CAA6B;IAE5D;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,eAAe;IAM3G,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAMlD,YAAY,CAAC,eAAe,EAAE,eAAe;IAQvC,QAAQ,CAAC,eAAe,EAAE,eAAe;cAI/C,aAAa,CAAC,UAAU,EAAE,MAAM;CAGjD;AAED;;;GAGG;AACH,8BAAsB,iBAAkB,SAAQ,UAAU;aAC/B,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;aAChD,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}
+{"version":3,"file":"Phenomenon.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Phenomenon.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,uBAAuB;AACvB,qBAAa,UAAW,SAAQ,UAAU;IACxC,SAAyB,cAAc,iBAA6B;IACpE,gBAAgB;IAChB,WAA2B,cAAc,mBAAwC;IACjF,OAAO,CAAC,WAAW,CAAS;IAE5B,gBAAgB;gBACJ,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAKxC,IAAW,UAAU,IAAI,MAAM,CAA6B;IAE5D;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,eAAe;IAM3G,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAMlD,YAAY,CAAC,eAAe,EAAE,eAAe;IAQvC,QAAQ,CAAC,eAAe,EAAE,eAAe;IAI/D;;;;OAIG;cACa,aAAa,CAAC,UAAU,EAAE,MAAM;IAIhD;;;;OAIG;WACW,YAAY,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,UAAU;IAOjE;;;;;OAKG;WACW,kBAAkB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,UAAU;CAIhF;AAED;;;GAGG;AACH,8BAAsB,iBAAkB,SAAQ,UAAU;aAC/B,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;aAChD,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/esm/Metadata/Phenomenon.js

@@ -6,13 +6,17 @@
  * @module Metadata
  */
 import { SchemaItemType } from "../ECObjects";
-import { ECObjectsError, ECObjectsStatus } from "../Exception";
+import { ECSchemaError, ECSchemaStatus } from "../Exception";
 import { SchemaItem } from "./SchemaItem";
-/** @beta */
+/** @public @preview */
 export class Phenomenon extends SchemaItem {
+    schemaItemType = Phenomenon.schemaItemType;
+    /** @internal */
+    static get schemaItemType() { return SchemaItemType.Phenomenon; }
+    _definition; // Contains a combination of Phenomena names which form this Phenomenon. Each Phenomena name is separated by a * and may have an exponent, specified using parentheses
+    /** @internal */
     constructor(schema, name) {
         super(schema, name);
-        this.schemaItemType = SchemaItemType.Phenomenon;
         this._definition = "";
     }
     get definition() { return this._definition; }
@@ -35,16 +39,41 @@ export class Phenomenon extends SchemaItem {
     fromJSONSync(phenomenonProps) {
         super.fromJSONSync(phenomenonProps);
         if (this._definition !== "" && phenomenonProps.definition.toLowerCase() !== this._definition.toLowerCase())
-            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Phenomenon ${this.name} has an invalid 'definition' attribute.`);
+            throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Phenomenon ${this.name} has an invalid 'definition' attribute.`);
         else if (this._definition === "")
             this._definition = phenomenonProps.definition;
     }
     async fromJSON(phenomenonProps) {
         this.fromJSONSync(phenomenonProps);
     }
+    /**
+     *
+     * @param definition
+     * @internal
+     */
     async setDefinition(definition) {
         this._definition = definition;
     }
+    /**
+     * Type guard to check if the SchemaItem is of type Phenomenon.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a Phenomenon, false otherwise.
+     */
+    static isPhenomenon(item) {
+        if (item && item.schemaItemType === SchemaItemType.Phenomenon)
+            return true;
+        return false;
+    }
+    /**
+     * Type assertion to check if the SchemaItem is of type Phenomenon.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to Phenomenon if it is a Phenomenon, undefined otherwise.
+     * @internal
+     */
+    static assertIsPhenomenon(item) {
+        if (!this.isPhenomenon(item))
+            throw new ECSchemaError(ECSchemaStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Phenomenon}' (Phenomenon)`);
+    }
 }
 /**
  * @internal

package/lib/esm/Metadata/Phenomenon.js.map

@@ -1 +1 @@
-{"version":3,"file":"Phenomenon.js","sourceRoot":"","sources":["../../../src/Metadata/Phenomenon.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,YAAY;AACZ,MAAM,OAAO,UAAW,SAAQ,UAAU;IAIxC,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC,UAAU,CAAC;QAChD,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAED,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAE5D;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACxC,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,gBAAgB;IACA,KAAK,CAAC,KAAK,CAAC,SAAmB;QAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjD,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,eAAgC;QAC3D,KAAK,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QACpC,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE,IAAI,eAAe,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;YACxG,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,kBAAkB,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;aAC3H,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE;YAC9B,IAAI,CAAC,WAAW,GAAG,eAAe,CAAC,UAAU,CAAC;IAClD,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,eAAgC;QAC7D,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IACrC,CAAC;IAES,KAAK,CAAC,aAAa,CAAC,UAAkB;QAC9C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,iBAAkB,SAAQ,UAAU;CAGzD","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 { PhenomenonProps } from \"../Deserialization/JsonProps\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItem } from \"./SchemaItem\";\r\n\r\n/** @beta */\r\nexport class Phenomenon extends SchemaItem {\r\n  public override readonly schemaItemType!: SchemaItemType.Phenomenon;\r\n  protected _definition: string; // Contains a combination of Phenomena names which form this Phenomenon. Each Phenomena name is separated by a * and may have an exponent, specified using parentheses\r\n\r\n  constructor(schema: Schema, name: string) {\r\n    super(schema, name);\r\n    this.schemaItemType = SchemaItemType.Phenomenon;\r\n    this._definition = \"\";\r\n  }\r\n\r\n  public get definition(): string { return this._definition; }\r\n\r\n  /**\r\n   * Save this Phenomenon's properties to an object for serializing to JSON.\r\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\r\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\r\n   */\r\n  public override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): PhenomenonProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    schemaJson.definition = this.definition;\r\n    return schemaJson;\r\n  }\r\n\r\n  /** @internal */\r\n  public override async toXml(schemaXml: Document): Promise<Element> {\r\n    const itemElement = await super.toXml(schemaXml);\r\n    itemElement.setAttribute(\"definition\", this.definition);\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(phenomenonProps: PhenomenonProps) {\r\n    super.fromJSONSync(phenomenonProps);\r\n    if (this._definition !== \"\" && phenomenonProps.definition.toLowerCase() !== this._definition.toLowerCase())\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Phenomenon ${this.name} has an invalid 'definition' attribute.`);\r\n    else if (this._definition === \"\")\r\n      this._definition = phenomenonProps.definition;\r\n  }\r\n\r\n  public override async fromJSON(phenomenonProps: PhenomenonProps) {\r\n    this.fromJSONSync(phenomenonProps);\r\n  }\r\n\r\n  protected async setDefinition(definition: string) {\r\n    this._definition = definition;\r\n  }\r\n}\r\n\r\n/**\r\n * @internal\r\n * An abstract class used for schema editing.\r\n */\r\nexport abstract class MutablePhenomenon extends Phenomenon {\r\n  public abstract override setDefinition(definition: string): Promise<void>;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}
+{"version":3,"file":"Phenomenon.js","sourceRoot":"","sources":["../../../src/Metadata/Phenomenon.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE7D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,uBAAuB;AACvB,MAAM,OAAO,UAAW,SAAQ,UAAU;IACf,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IACpE,gBAAgB;IACT,MAAM,KAAc,cAAc,KAAK,OAAO,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;IACzE,WAAW,CAAS,CAAC,sKAAsK;IAEnM,gBAAgB;IAChB,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAED,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAE5D;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACxC,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,gBAAgB;IACA,KAAK,CAAC,KAAK,CAAC,SAAmB;QAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjD,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,eAAgC;QAC3D,KAAK,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QACpC,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE,IAAI,eAAe,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;YACxG,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,aAAa,EAAE,kBAAkB,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;aACzH,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE;YAC9B,IAAI,CAAC,WAAW,GAAG,eAAe,CAAC,UAAU,CAAC;IAClD,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,eAAgC;QAC7D,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,aAAa,CAAC,UAAkB;QAC9C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,IAAiB;QAC1C,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,UAAU;YAC3D,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAiB;QAChD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YAC1B,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,qBAAqB,EAAE,aAAa,cAAc,CAAC,UAAU,gBAAgB,CAAC,CAAC;IAC1H,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,iBAAkB,SAAQ,UAAU;CAGzD","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 { PhenomenonProps } from \"../Deserialization/JsonProps\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { ECSchemaError, ECSchemaStatus } from \"../Exception\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItem } from \"./SchemaItem\";\r\n\r\n/** @public @preview */\r\nexport class Phenomenon extends SchemaItem {\r\n  public override readonly schemaItemType = Phenomenon.schemaItemType;\r\n  /** @internal */\r\n  public static override get schemaItemType() { return SchemaItemType.Phenomenon; }\r\n  private _definition: string; // Contains a combination of Phenomena names which form this Phenomenon. Each Phenomena name is separated by a * and may have an exponent, specified using parentheses\r\n\r\n  /** @internal */\r\n  constructor(schema: Schema, name: string) {\r\n    super(schema, name);\r\n    this._definition = \"\";\r\n  }\r\n\r\n  public get definition(): string { return this._definition; }\r\n\r\n  /**\r\n   * Save this Phenomenon's properties to an object for serializing to JSON.\r\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\r\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\r\n   */\r\n  public override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): PhenomenonProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    schemaJson.definition = this.definition;\r\n    return schemaJson;\r\n  }\r\n\r\n  /** @internal */\r\n  public override async toXml(schemaXml: Document): Promise<Element> {\r\n    const itemElement = await super.toXml(schemaXml);\r\n    itemElement.setAttribute(\"definition\", this.definition);\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(phenomenonProps: PhenomenonProps) {\r\n    super.fromJSONSync(phenomenonProps);\r\n    if (this._definition !== \"\" && phenomenonProps.definition.toLowerCase() !== this._definition.toLowerCase())\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Phenomenon ${this.name} has an invalid 'definition' attribute.`);\r\n    else if (this._definition === \"\")\r\n      this._definition = phenomenonProps.definition;\r\n  }\r\n\r\n  public override async fromJSON(phenomenonProps: PhenomenonProps) {\r\n    this.fromJSONSync(phenomenonProps);\r\n  }\r\n\r\n  /**\r\n   *\r\n   * @param definition\r\n   * @internal\r\n   */\r\n  protected async setDefinition(definition: string) {\r\n    this._definition = definition;\r\n  }\r\n\r\n  /**\r\n   * Type guard to check if the SchemaItem is of type Phenomenon.\r\n   * @param item The SchemaItem to check.\r\n   * @returns True if the item is a Phenomenon, false otherwise.\r\n   */\r\n  public static isPhenomenon(item?: SchemaItem): item is Phenomenon {\r\n    if (item && item.schemaItemType === SchemaItemType.Phenomenon)\r\n      return true;\r\n\r\n    return false;\r\n  }\r\n\r\n  /**\r\n   * Type assertion to check if the SchemaItem is of type Phenomenon.\r\n   * @param item The SchemaItem to check.\r\n   * @returns The item cast to Phenomenon if it is a Phenomenon, undefined otherwise.\r\n   * @internal\r\n   */\r\n  public static assertIsPhenomenon(item?: SchemaItem): asserts item is Phenomenon {\r\n    if (!this.isPhenomenon(item))\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Phenomenon}' (Phenomenon)`);\r\n  }\r\n}\r\n\r\n/**\r\n * @internal\r\n * An abstract class used for schema editing.\r\n */\r\nexport abstract class MutablePhenomenon extends Phenomenon {\r\n  public abstract override setDefinition(definition: string): Promise<void>;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}

package/lib/esm/Metadata/Property.d.ts

@@ -10,23 +10,25 @@ import { ECClass, StructClass } from "./Class";
 import { CustomAttribute, CustomAttributeContainerProps, CustomAttributeSet } from "./CustomAttribute";
 import { KindOfQuantity } from "./KindOfQuantity";
 import { PropertyCategory } from "./PropertyCategory";
-import { RelationshipClass } from "./RelationshipClass";
+import { type RelationshipClass } from "./RelationshipClass";
 import { Schema } from "./Schema";
 /**
  * A common abstract class for all ECProperty types.
- * @beta
+ * @public @preview
  */
 export declare abstract class Property implements CustomAttributeContainerProps {
-    protected _name: ECName;
-    protected _type: PropertyType;
-    protected _class: AnyClass;
-    protected _description?: string;
-    protected _label?: string;
-    protected _isReadOnly?: boolean;
-    protected _priority?: number;
-    protected _category?: LazyLoadedPropertyCategory;
-    protected _kindOfQuantity?: LazyLoadedKindOfQuantity;
+    private _name;
+    private _class;
+    private _description?;
+    private _label?;
+    private _isReadOnly?;
+    private _priority?;
+    private _category?;
+    private _kindOfQuantity?;
     private _customAttributes?;
+    /** @internal */
+    protected _type: PropertyType;
+    /** @internal */
     constructor(ecClass: ECClass, name: string, type: PropertyType);
     isArray(): this is AnyArrayProperty;
     isPrimitive(): this is AnyPrimitiveProperty;
@@ -57,7 +59,9 @@ export declare abstract class Property implements CustomAttributeContainerProps
     toXml(schemaXml: Document): Promise<Element>;
     fromJSONSync(propertyProps: PropertyProps): void;
     fromJSON(propertyProps: PropertyProps): Promise<void>;
+    /** @internal */
     protected addCustomAttribute(customAttribute: CustomAttribute): void;
+    /** @internal */
     protected setName(name: ECName): void;
     /**
      * @internal Used in schema editing.
@@ -97,18 +101,24 @@ export declare abstract class Property implements CustomAttributeContainerProps
      */
     static isProperty(object: any): object is AnyProperty;
 }
-/** @beta */
+/** @public @preview */
 export declare abstract class PrimitiveOrEnumPropertyBase extends Property {
+    /** @internal */
     protected _extendedTypeName?: string;
+    /** @internal */
     protected _minLength?: number;
+    /** @internal */
     protected _maxLength?: number;
+    /** @internal */
     protected _minValue?: number;
+    /** @internal */
     protected _maxValue?: number;
     get extendedTypeName(): string | undefined;
     get minLength(): number | undefined;
     get maxLength(): number | undefined;
     get minValue(): number | undefined;
     get maxValue(): number | undefined;
+    /** @internal */
     constructor(ecClass: ECClass, name: string, type: PropertyType);
     /**
      * Save this PrimitiveOrEnumPropertyBase's properties to an object for serializing to JSON.
@@ -139,9 +149,10 @@ export declare abstract class PrimitiveOrEnumPropertyBase extends Property {
     protected setMaxValue(maxValue: number): void;
     fromJSON(propertyBaseProps: PrimitiveOrEnumPropertyBaseProps): Promise<void>;
 }
-/** @beta */
+/** @public @preview */
 export declare class PrimitiveProperty extends PrimitiveOrEnumPropertyBase {
     get primitiveType(): PrimitiveType;
+    /** @internal */
     constructor(ecClass: ECClass, name: string, primitiveType?: PrimitiveType);
     fromJSONSync(primitivePropertyProps: PrimitivePropertyProps): void;
     fromJSON(primitivePropertyProps: PrimitivePropertyProps): Promise<void>;
@@ -152,24 +163,28 @@ export declare class PrimitiveProperty extends PrimitiveOrEnumPropertyBase {
     /** @internal */
     toXml(schemaXml: Document): Promise<Element>;
 }
-/** @beta */
+/** @public @preview */
 export declare class EnumerationProperty extends PrimitiveOrEnumPropertyBase {
+    /** @internal */
     protected _enumeration?: LazyLoadedEnumeration;
     get enumeration(): LazyLoadedEnumeration | undefined;
     /**
      * Save this EnumerationProperty's properties to an object for serializing to JSON.
      */
     toJSON(): EnumerationPropertyProps;
+    /** @internal */
     constructor(ecClass: ECClass, name: string, type: LazyLoadedEnumeration);
     fromJSONSync(enumerationPropertyProps: EnumerationPropertyProps): void;
     /** @internal */
     toXml(schemaXml: Document): Promise<Element>;
     fromJSON(enumerationPropertyProps: EnumerationPropertyProps): Promise<void>;
 }
-/** @beta */
+/** @public @preview */
 export declare class StructProperty extends Property {
+    /** @internal */
     protected _structClass: StructClass;
     get structClass(): StructClass;
+    /** @internal */
     constructor(ecClass: ECClass, name: string, type: StructClass);
     /**
      * Save this StructProperty's properties to an object for serializing to JSON.
@@ -180,9 +195,11 @@ export declare class StructProperty extends Property {
     fromJSONSync(structPropertyProps: StructPropertyProps): void;
     fromJSON(structPropertyProps: StructPropertyProps): Promise<void>;
 }
-/** @beta */
+/** @public @preview */
 export declare class NavigationProperty extends Property {
+    /** @internal */
     protected _relationshipClass: LazyLoadedRelationshipClass;
+    /** @internal */
     protected _direction: StrengthDirection;
     get relationshipClass(): LazyLoadedRelationshipClass;
     getRelationshipClassSync(): RelationshipClass | undefined;
@@ -193,12 +210,15 @@ export declare class NavigationProperty extends Property {
     toJSON(): NavigationPropertyProps;
     /** @internal */
     toXml(schemaXml: Document): Promise<Element>;
+    /** @internal */
     constructor(ecClass: ECClass, name: string, relationship: LazyLoadedRelationshipClass, direction?: StrengthDirection);
 }
 type Constructor<T> = new (...args: any[]) => T;
-/** @beta */
+/** @public @preview */
 export declare abstract class ArrayProperty extends Property {
+    /** @internal */
     protected _minOccurs: number;
+    /** @internal */
     protected _maxOccurs?: number;
     get minOccurs(): number;
     get maxOccurs(): number | undefined;
@@ -212,8 +232,9 @@ export declare abstract class ArrayProperty extends Property {
     protected setMaxOccurs(maxOccurs: number): void;
 }
 declare const PrimitiveArrayProperty_base: typeof PrimitiveProperty & Constructor<ArrayProperty>;
-/** @beta */
+/** @public @preview */
 export declare class PrimitiveArrayProperty extends PrimitiveArrayProperty_base {
+    /** @internal */
     constructor(ecClass: ECClass, name: string, primitiveType?: PrimitiveType);
     /**
      * Save this PrimitiveArrayProperty's properties to an object for serializing to JSON.
@@ -221,24 +242,25 @@ export declare class PrimitiveArrayProperty extends PrimitiveArrayProperty_base
     toJSON(): PrimitiveArrayPropertyProps;
 }
 declare const EnumerationArrayProperty_base: typeof EnumerationProperty & Constructor<ArrayProperty>;
-/** @beta */
+/** @public @preview */
 export declare class EnumerationArrayProperty extends EnumerationArrayProperty_base {
     constructor(ecClass: ECClass, name: string, type: LazyLoadedEnumeration);
 }
 declare const StructArrayProperty_base: typeof StructProperty & Constructor<ArrayProperty>;
-/** @beta */
+/** @public @preview */
 export declare class StructArrayProperty extends StructArrayProperty_base {
+    /** @internal */
     constructor(ecClass: ECClass, name: string, type: StructClass);
 }
-/** @beta */
+/** @public @preview */
 export type AnyArrayProperty = PrimitiveArrayProperty | EnumerationArrayProperty | StructArrayProperty;
-/** @beta */
+/** @public @preview */
 export type AnyPrimitiveProperty = PrimitiveProperty | PrimitiveArrayProperty;
-/** @beta */
+/** @public @preview */
 export type AnyEnumerationProperty = EnumerationProperty | EnumerationArrayProperty;
-/** @beta */
+/** @public @preview */
 export type AnyStructProperty = StructProperty | StructArrayProperty;
-/** @beta */
+/** @public @preview */
 export type AnyProperty = AnyPrimitiveProperty | AnyEnumerationProperty | AnyStructProperty | NavigationProperty;
 /**
  * Hackish approach that works like a "friend class" so we can access protected members without making them public.