@itwin/ecschema-metadata 5.0.0-dev.99 → 5.1.0-dev.1

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

@@ -1 +1 @@
-{"version":3,"file":"Enumeration.js","sourceRoot":"","sources":["../../../src/Metadata/Enumeration.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4E;AAE5E,4CAAoF;AACpF,4CAA+D;AAC/D,sCAAmC;AAEnC,6CAA0C;AAa1C;;;GAGG;AACH,MAAa,WAAY,SAAQ,uBAAU;IAChB,cAAc,GAAG,WAAW,CAAC,cAAc,CAAC;IAC9D,MAAM,KAAc,cAAc,KAAK,OAAO,0BAAc,CAAC,WAAW,CAAC,CAAC,CAAC;IACxE,KAAK,CAAgD;IACrD,SAAS,CAAU;IACnB,YAAY,CAAkB;IAExC,IAAW,WAAW,KAAK,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IACtD,IAAW,IAAI,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACxC,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,YAAY,MAAc,EAAE,IAAY,EAAE,aAA4D;QACpG,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;IACzB,CAAC;IAED,IAAW,KAAK,KAAc,OAAO,IAAI,CAAC,KAAK,KAAK,yBAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5E,IAAW,QAAQ,KAAc,OAAO,IAAI,CAAC,KAAK,KAAK,yBAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IAE9E;;;OAGG;IACI,mBAAmB,CAAC,IAAY;QACrC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IACzF,CAAC;IAQM,aAAa,CAAC,KAAsB;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACK,wBAAwB,CAAC,IAAY,EAAE,KAAsB;QACnE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAsB,EAAE,EAAE;YACnD,IAAI,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE;gBACnD,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0CAA0C,IAAI,IAAI,CAAC,CAAC;YAC1I,IAAI,OAAO,CAAC,KAAK,KAAK,KAAK;gBACzB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,2CAA2C,KAAK,IAAI,CAAC,CAAC;QAC9I,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,IAAY,EAAE,KAAsB,EAAE,KAAc,EAAE,WAAoB;QAChG,IAAI,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,oDAAoD;YACjG,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,8EAA8E,CAAC,CAAC;QACtK,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,4DAA4D;YAC1G,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,8EAA8E,CAAC,CAAC;QACtK,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,+CAA+C;QAC3F,IAAI,CAAC,eAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACxB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,wDAAwD,IAAI,yBAAyB,CAAC,CAAC;QAC7K,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACO,aAAa,CAAC,UAAyB;QAC/C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACpC,CAAC;IAED;;;;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,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;QAClD,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QACpC,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE;YACrF,MAAM,QAAQ,GAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YACtC,IAAI,SAAS,KAAK,KAAK;gBACrB,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;YACzB,IAAI,SAAS,KAAK,WAAW;gBAC3B,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAC;YACrC,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC,CAAC;QACH,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,IAAI,SAAS,KAAK,IAAI,CAAC,IAAI;YACzB,WAAW,CAAC,YAAY,CAAC,iBAAiB,EAAE,IAAA,iCAAqB,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAChF,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE5D,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,WAAW,GAAG,SAAS,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;YAC5D,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,SAAS,GAAG,OAAO,UAAU,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACxG,WAAW,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAC7C,IAAI,SAAS,KAAK,UAAU,CAAC,KAAK;gBAChC,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;YAC7D,IAAI,SAAS,KAAK,UAAU,CAAC,WAAW;gBACtC,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;YAClE,WAAW,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QACvC,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,gBAAkC;QAC7D,KAAK,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;QACrC,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YAC7B,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvC,IAAI,CAAC,KAAK,GAAG,yBAAa,CAAC,OAAO,CAAC;YACrC,CAAC;iBAAM,IAAI,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjD,IAAI,CAAC,KAAK,GAAG,yBAAa,CAAC,MAAM,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACN,IAAI,yBAAgB,CAAC,oBAAoB,CAAC,EAAC,WAAW,EAAE,gBAAgB,CAAC,0BAA0B,EAAE,YAAY,EAAE,gBAAgB,CAAC,0BAA0B,EAAkB,CAAC;oBAC/K,IAAI,CAAC,KAAK,GAAG,yBAAa,CAAC,MAAM,CAAC;;oBAElC,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0EAA0E,CAAC,CAAC;YACpK,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,oBAAoB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC/D,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBACnD,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0CAA0C,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;QACjN,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE3C,IAAI,SAAS,KAAK,gBAAgB,CAAC,WAAW,EAAE,CAAC;YAC/C,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAA2B,EAAE,EAAE;gBACnE,4JAA4J;gBAC5J,0FAA0F;gBAC1F,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;YACzH,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,gBAAkC;QAC/D,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACO,WAAW,CAAC,QAAiB;QACrC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,IAAiB;QAC3C,OAAO,IAAI,EAAE,cAAc,KAAK,0BAAc,CAAC,WAAW,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,IAAiB;QACjD,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;YAC3B,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,qBAAqB,EAAE,aAAa,0BAAc,CAAC,WAAW,iBAAiB,CAAC,CAAC;IAC9H,CAAC;CACF;AArLD,kCAqLC;AAED;;GAEG;AACH,MAAsB,kBAAmB,SAAQ,WAAW;CAI3D;AAJD,gDAIC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Metadata\n */\n\nimport { ECSpecVersion, SchemaReadHelper } from \"../Deserialization/Helper\";\nimport { EnumerationProps, EnumeratorProps } from \"../Deserialization/JsonProps\";\nimport { PrimitiveType, primitiveTypeToString, SchemaItemType } from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport { ECName } from \"../ECName\";\nimport { Schema } from \"./Schema\";\nimport { SchemaItem } from \"./SchemaItem\";\n\n/** @beta */\nexport interface Enumerator<T> {\n  readonly name: string;\n  readonly value: T;\n  readonly label?: string;\n  readonly description?: string;\n}\n\n/** @beta */\nexport type AnyEnumerator = Enumerator<string | number>;\n\n/**\n * A Typescript class representation of an ECEnumeration.\n * @beta\n */\nexport class Enumeration extends SchemaItem {\n  public override readonly schemaItemType = Enumeration.schemaItemType;\n  public static override get schemaItemType() { return SchemaItemType.Enumeration; }\n  protected _type?: PrimitiveType.Integer | PrimitiveType.String;\n  protected _isStrict: boolean;\n  protected _enumerators: AnyEnumerator[];\n\n  public get enumerators() { return this._enumerators; }\n  public get type() { return this._type; }\n  public get isStrict() { return this._isStrict; }\n\n  constructor(schema: Schema, name: string, primitiveType?: PrimitiveType.Integer | PrimitiveType.String) {\n    super(schema, name);\n    this._type = primitiveType;\n    this._isStrict = true;\n    this._enumerators = [];\n  }\n\n  public get isInt(): boolean { return this._type === PrimitiveType.Integer; }\n  public get isString(): boolean { return this._type === PrimitiveType.String; }\n\n  /**\n   * Gets an enumerator that matches the name provided.\n   * @param name The ECName of the Enumerator to find.\n   */\n  public getEnumeratorByName(name: string): AnyEnumerator | undefined {\n    return this.enumerators.find((item) => item.name.toLowerCase() === name.toLowerCase());\n  }\n\n  /**\n   * Gets an enumerator that matches the value provided.\n   * @param value The value of the Enumerator to find.\n   */\n  public getEnumerator(value: string): Enumerator<string> | undefined;\n  public getEnumerator(value: number): Enumerator<number> | undefined;\n  public getEnumerator(value: string | number): AnyEnumerator | undefined {\n    return this.enumerators.find((item) => item.value === value);\n  }\n\n  /**\n   * Checks whether there already exists an enumerator with this name or this value\n   * @param name The name of the enumerator we are trying to create\n   * @param value The value of the enumerator we are trying to create\n   * @internal\n   */\n  private findDuplicateEnumerators(name: string, value: string | number) {\n    this._enumerators.forEach((element: AnyEnumerator) => { // Name and value must be unique within the ECEnumerations\n      if (element.name.toLowerCase() === name.toLowerCase())\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with name '${name}'.`);\n      if (element.value === value)\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with value '${value}'.`);\n    });\n  }\n\n  /**\n   * Creates an Enumerator with the provided name and value as well as optional parameters label and description\n   * @param name The name of the enumerator\n   * @param value The value of the enumerator. The type of this value is dependent on the backing type of the this Enumeration.\n   * @param label A localized display label that is used instead of the name in a GUI.\n   * @param description A localized description for the enumerator.\n   * @return AnyEnumerator object\n   */\n  public createEnumerator(name: string, value: string | number, label?: string, description?: string): AnyEnumerator {\n    if (this.isInt && typeof (value) === \"string\") // throws if backing type is int and value is string\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a backing type 'integer' and an enumerator with value of type 'string'.`);\n    if (!this.isInt && typeof (value) === \"number\") // also throws if backing type is string and value is number\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a backing type 'string' and an enumerator with value of type 'integer'.`);\n    this.findDuplicateEnumerators(name, value); // check for duplicates; throw if there are any\n    if (!ECName.validate(name))\n      throw new ECObjectsError(ECObjectsStatus.InvalidECName, `The Enumeration ${this.name} has an enumerator with an invalid 'name' attribute. ${name} is not a valid ECName.`);\n    return { name, value, label, description };\n  }\n\n  /**\n   * Adds enumerator to list of enumerators on this Enumeration\n   * @param enumerator The enumerator to add\n   */\n  protected addEnumerator(enumerator: AnyEnumerator) {\n    this.enumerators.push(enumerator);\n  }\n\n  /**\n   * Save this Enumeration's properties to an object for serializing to JSON.\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\n   */\n  public override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): EnumerationProps {\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\n    schemaJson.type = (this.isInt) ? \"int\" : \"string\";\n    schemaJson.isStrict = this.isStrict;\n    schemaJson.enumerators = this._enumerators.map(({ name, label, value, description }) => {\n      const enumJson: any = { name, value };\n      if (undefined !== label)\n        enumJson.label = label;\n      if (undefined !== description)\n        enumJson.description = description;\n      return enumJson;\n    });\n    return schemaJson;\n  }\n\n  /** @internal */\n  public override async toXml(schemaXml: Document): Promise<Element> {\n    const itemElement = await super.toXml(schemaXml);\n    if (undefined !== this.type)\n      itemElement.setAttribute(\"backingTypeName\", primitiveTypeToString(this.type));\n    itemElement.setAttribute(\"isStrict\", String(this.isStrict));\n\n    for (const enumerator of this.enumerators) {\n      const enumElement = schemaXml.createElement(\"ECEnumerator\");\n      enumElement.setAttribute(\"name\", enumerator.name);\n      const enumValue = typeof enumerator.value === \"string\" ? enumerator.value : enumerator.value.toString();\n      enumElement.setAttribute(\"value\", enumValue);\n      if (undefined !== enumerator.label)\n        enumElement.setAttribute(\"displayLabel\", enumerator.label);\n      if (undefined !== enumerator.description)\n        enumElement.setAttribute(\"description\", enumerator.description);\n      itemElement.appendChild(enumElement);\n    }\n\n    return itemElement;\n  }\n\n  public override fromJSONSync(enumerationProps: EnumerationProps) {\n    super.fromJSONSync(enumerationProps);\n    if (undefined === this._type) {\n      if (/int/i.test(enumerationProps.type)) {\n        this._type = PrimitiveType.Integer;\n      } else if (/string/i.test(enumerationProps.type)) {\n        this._type = PrimitiveType.String;\n      } else {\n        if (SchemaReadHelper.isECSpecVersionNewer({readVersion: enumerationProps.originalECSpecMajorVersion, writeVersion: enumerationProps.originalECSpecMinorVersion} as ECSpecVersion))\n          this._type = PrimitiveType.String;\n        else\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has an invalid 'type' attribute. It should be either \"int\" or \"string\".`);\n      }\n    } else {\n      const primitiveTypePattern = (this.isInt) ? /int/i : /string/i;\n      if (!primitiveTypePattern.test(enumerationProps.type))\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has an incompatible type. It must be \"${(this.isInt) ? \"int\" : \"string\"}\", not \"${(this.isInt) ? \"string\" : \"int\"}\".`);\n    }\n    this._isStrict = enumerationProps.isStrict;\n\n    if (undefined !== enumerationProps.enumerators) {\n      enumerationProps.enumerators.forEach((enumerator: EnumeratorProps) => {\n        // Creates a new enumerator (with the specified name, value, label and description- label and description are optional) and adds to the list of enumerators.\n        // Throws ECObjectsError if there are duplicate names or values present in the enumeration\n        this.addEnumerator(this.createEnumerator(enumerator.name, enumerator.value, enumerator.label, enumerator.description));\n      });\n    }\n  }\n\n  public override async fromJSON(enumerationProps: EnumerationProps) {\n    this.fromJSONSync(enumerationProps);\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setIsStrict(isStrict: boolean) {\n    this._isStrict = isStrict;\n  }\n\n  /**\n   * Type guard to check if the SchemaItem is of type Enumeration.\n   * @param item The SchemaItem to check.\n   * @returns True if the item is an Enumeration, false otherwise.\n   */\n  public static isEnumeration(item?: SchemaItem): item is Enumeration {\n    return item?.schemaItemType === SchemaItemType.Enumeration;\n  }\n\n  /**\n   * Type assertion to check if the SchemaItem is of type Enumeration.\n   * @param item The SchemaItem to check.\n   * @returns The item cast to Enumeration if it is an Enumeration, undefined otherwise.\n   */\n  public static assertIsEnumeration(item?: SchemaItem): asserts item is Enumeration {\n    if (!this.isEnumeration(item))\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Enumeration}' (Enumeration)`);\n  }\n}\n\n/** @internal\n * An abstract class used for schema editing.\n */\nexport abstract class MutableEnumeration extends Enumeration {\n  public abstract override addEnumerator(enumerator: AnyEnumerator): void;\n  public abstract override setIsStrict(isStrict: boolean): void;\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n"]}
+{"version":3,"file":"Enumeration.js","sourceRoot":"","sources":["../../../src/Metadata/Enumeration.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4E;AAE5E,4CAAoF;AACpF,4CAA6D;AAC7D,sCAAmC;AAEnC,6CAA0C;AAa1C;;;GAGG;AACH,MAAa,WAAY,SAAQ,uBAAU;IAChB,cAAc,GAAG,WAAW,CAAC,cAAc,CAAC;IACrE,gBAAgB;IACT,MAAM,KAAc,cAAc,KAAK,OAAO,0BAAc,CAAC,WAAW,CAAC,CAAC,CAAC;IAC1E,KAAK,CAAgD;IACrD,SAAS,CAAU;IACnB,YAAY,CAAkB;IAEtC,IAAW,WAAW,KAAmC,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IACpF,IAAW,IAAI,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACxC,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,gBAAgB;IAChB,YAAY,MAAc,EAAE,IAAY,EAAE,aAA4D;QACpG,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;IACzB,CAAC;IAED,IAAW,KAAK,KAAc,OAAO,IAAI,CAAC,KAAK,KAAK,yBAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5E,IAAW,QAAQ,KAAc,OAAO,IAAI,CAAC,KAAK,KAAK,yBAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IAE9E;;;OAGG;IACI,mBAAmB,CAAC,IAAY;QACrC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IACzF,CAAC;IAQM,aAAa,CAAC,KAAsB;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACK,wBAAwB,CAAC,IAAY,EAAE,KAAsB;QACnE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAsB,EAAE,EAAE;YACnD,IAAI,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE;gBACnD,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0CAA0C,IAAI,IAAI,CAAC,CAAC;YACxI,IAAI,OAAO,CAAC,KAAK,KAAK,KAAK;gBACzB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,2CAA2C,KAAK,IAAI,CAAC,CAAC;QAC5I,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACI,gBAAgB,CAAC,IAAY,EAAE,KAAsB,EAAE,KAAc,EAAE,WAAoB;QAChG,IAAI,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,oDAAoD;YACjG,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,8EAA8E,CAAC,CAAC;QACpK,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,4DAA4D;YAC1G,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,8EAA8E,CAAC,CAAC;QACpK,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,+CAA+C;QAC3F,IAAI,CAAC,eAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACxB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,wDAAwD,IAAI,yBAAyB,CAAC,CAAC;QAC3K,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACO,aAAa,CAAC,UAAyB;QAC/C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC;IAED;;;;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,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;QAClD,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QACpC,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE;YACrF,MAAM,QAAQ,GAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YACtC,IAAI,SAAS,KAAK,KAAK;gBACrB,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;YACzB,IAAI,SAAS,KAAK,WAAW;gBAC3B,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAC;YACrC,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC,CAAC;QACH,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,IAAI,SAAS,KAAK,IAAI,CAAC,IAAI;YACzB,WAAW,CAAC,YAAY,CAAC,iBAAiB,EAAE,IAAA,iCAAqB,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAChF,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE5D,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,WAAW,GAAG,SAAS,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;YAC5D,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,SAAS,GAAG,OAAO,UAAU,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACxG,WAAW,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAC7C,IAAI,SAAS,KAAK,UAAU,CAAC,KAAK;gBAChC,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;YAC7D,IAAI,SAAS,KAAK,UAAU,CAAC,WAAW;gBACtC,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;YAClE,WAAW,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QACvC,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,gBAAkC;QAC7D,KAAK,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;QACrC,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YAC7B,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvC,IAAI,CAAC,KAAK,GAAG,yBAAa,CAAC,OAAO,CAAC;YACrC,CAAC;iBAAM,IAAI,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjD,IAAI,CAAC,KAAK,GAAG,yBAAa,CAAC,MAAM,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACN,IAAI,yBAAgB,CAAC,oBAAoB,CAAC,EAAE,WAAW,EAAE,gBAAgB,CAAC,0BAA0B,EAAE,YAAY,EAAE,gBAAgB,CAAC,0BAA0B,EAAmB,CAAC;oBACjL,IAAI,CAAC,KAAK,GAAG,yBAAa,CAAC,MAAM,CAAC;;oBAElC,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0EAA0E,CAAC,CAAC;YAClK,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,oBAAoB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC/D,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBACnD,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0CAA0C,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;QAC/M,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE3C,IAAI,SAAS,KAAK,gBAAgB,CAAC,WAAW,EAAE,CAAC;YAC/C,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAA2B,EAAE,EAAE;gBACnE,4JAA4J;gBAC5J,yFAAyF;gBACzF,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;YACzH,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,gBAAkC;QAC/D,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACO,WAAW,CAAC,QAAiB;QACrC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,IAAiB;QAC3C,OAAO,IAAI,EAAE,cAAc,KAAK,0BAAc,CAAC,WAAW,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,mBAAmB,CAAC,IAAiB;QACjD,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;YAC3B,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,qBAAqB,EAAE,aAAa,0BAAc,CAAC,WAAW,iBAAiB,CAAC,CAAC;IAC5H,CAAC;CACF;AA1LD,kCA0LC;AAED;;;;GAIG;AACH,MAAsB,kBAAmB,SAAQ,WAAW;CAI3D;AAJD,gDAIC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Metadata\n */\n\nimport { ECSpecVersion, SchemaReadHelper } from \"../Deserialization/Helper\";\nimport { EnumerationProps, EnumeratorProps } from \"../Deserialization/JsonProps\";\nimport { PrimitiveType, primitiveTypeToString, SchemaItemType } from \"../ECObjects\";\nimport { ECSchemaError, ECSchemaStatus } from \"../Exception\";\nimport { ECName } from \"../ECName\";\nimport { Schema } from \"./Schema\";\nimport { SchemaItem } from \"./SchemaItem\";\n\n/** @public @preview */\nexport interface Enumerator<T> {\n  readonly name: string;\n  readonly value: T;\n  readonly label?: string;\n  readonly description?: string;\n}\n\n/** @public @preview */\nexport type AnyEnumerator = Enumerator<string | number>;\n\n/**\n * A Typescript class representation of an ECEnumeration.\n * @public @preview\n */\nexport class Enumeration extends SchemaItem {\n  public override readonly schemaItemType = Enumeration.schemaItemType;\n  /** @internal */\n  public static override get schemaItemType() { return SchemaItemType.Enumeration; }\n  private _type?: PrimitiveType.Integer | PrimitiveType.String;\n  private _isStrict: boolean;\n  private _enumerators: AnyEnumerator[];\n\n  public get enumerators(): ReadonlyArray<AnyEnumerator> { return this._enumerators; }\n  public get type() { return this._type; }\n  public get isStrict() { return this._isStrict; }\n\n  /** @internal */\n  constructor(schema: Schema, name: string, primitiveType?: PrimitiveType.Integer | PrimitiveType.String) {\n    super(schema, name);\n    this._type = primitiveType;\n    this._isStrict = true;\n    this._enumerators = [];\n  }\n\n  public get isInt(): boolean { return this._type === PrimitiveType.Integer; }\n  public get isString(): boolean { return this._type === PrimitiveType.String; }\n\n  /**\n   * Gets an enumerator that matches the name provided.\n   * @param name The ECName of the Enumerator to find.\n   */\n  public getEnumeratorByName(name: string): AnyEnumerator | undefined {\n    return this.enumerators.find((item) => item.name.toLowerCase() === name.toLowerCase());\n  }\n\n  /**\n   * Gets an enumerator that matches the value provided.\n   * @param value The value of the Enumerator to find.\n   */\n  public getEnumerator(value: string): Enumerator<string> | undefined;\n  public getEnumerator(value: number): Enumerator<number> | undefined;\n  public getEnumerator(value: string | number): AnyEnumerator | undefined {\n    return this.enumerators.find((item) => item.value === value);\n  }\n\n  /**\n   * Checks whether there already exists an enumerator with this name or this value\n   * @param name The name of the enumerator we are trying to create\n   * @param value The value of the enumerator we are trying to create\n   * @internal\n   */\n  private findDuplicateEnumerators(name: string, value: string | number) {\n    this._enumerators.forEach((element: AnyEnumerator) => { // Name and value must be unique within the ECEnumerations\n      if (element.name.toLowerCase() === name.toLowerCase())\n        throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with name '${name}'.`);\n      if (element.value === value)\n        throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with value '${value}'.`);\n    });\n  }\n\n  /**\n   * Creates an Enumerator with the provided name and value as well as optional parameters label and description\n   * @param name The name of the enumerator\n   * @param value The value of the enumerator. The type of this value is dependent on the backing type of the this Enumeration.\n   * @param label A localized display label that is used instead of the name in a GUI.\n   * @param description A localized description for the enumerator.\n   * @return AnyEnumerator object\n   * @internal\n   */\n  public createEnumerator(name: string, value: string | number, label?: string, description?: string): AnyEnumerator {\n    if (this.isInt && typeof (value) === \"string\") // throws if backing type is int and value is string\n      throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has a backing type 'integer' and an enumerator with value of type 'string'.`);\n    if (!this.isInt && typeof (value) === \"number\") // also throws if backing type is string and value is number\n      throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has a backing type 'string' and an enumerator with value of type 'integer'.`);\n    this.findDuplicateEnumerators(name, value); // check for duplicates; throw if there are any\n    if (!ECName.validate(name))\n      throw new ECSchemaError(ECSchemaStatus.InvalidECName, `The Enumeration ${this.name} has an enumerator with an invalid 'name' attribute. ${name} is not a valid ECName.`);\n    return { name, value, label, description };\n  }\n\n  /**\n   * Adds enumerator to list of enumerators on this Enumeration\n   * @param enumerator The enumerator to add\n   * @internal\n   */\n  protected addEnumerator(enumerator: AnyEnumerator) {\n    this._enumerators.push(enumerator);\n  }\n\n  /**\n   * Save this Enumeration's properties to an object for serializing to JSON.\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\n   */\n  public override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): EnumerationProps {\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\n    schemaJson.type = (this.isInt) ? \"int\" : \"string\";\n    schemaJson.isStrict = this.isStrict;\n    schemaJson.enumerators = this._enumerators.map(({ name, label, value, description }) => {\n      const enumJson: any = { name, value };\n      if (undefined !== label)\n        enumJson.label = label;\n      if (undefined !== description)\n        enumJson.description = description;\n      return enumJson;\n    });\n    return schemaJson;\n  }\n\n  /** @internal */\n  public override async toXml(schemaXml: Document): Promise<Element> {\n    const itemElement = await super.toXml(schemaXml);\n    if (undefined !== this.type)\n      itemElement.setAttribute(\"backingTypeName\", primitiveTypeToString(this.type));\n    itemElement.setAttribute(\"isStrict\", String(this.isStrict));\n\n    for (const enumerator of this.enumerators) {\n      const enumElement = schemaXml.createElement(\"ECEnumerator\");\n      enumElement.setAttribute(\"name\", enumerator.name);\n      const enumValue = typeof enumerator.value === \"string\" ? enumerator.value : enumerator.value.toString();\n      enumElement.setAttribute(\"value\", enumValue);\n      if (undefined !== enumerator.label)\n        enumElement.setAttribute(\"displayLabel\", enumerator.label);\n      if (undefined !== enumerator.description)\n        enumElement.setAttribute(\"description\", enumerator.description);\n      itemElement.appendChild(enumElement);\n    }\n\n    return itemElement;\n  }\n\n  public override fromJSONSync(enumerationProps: EnumerationProps) {\n    super.fromJSONSync(enumerationProps);\n    if (undefined === this._type) {\n      if (/int/i.test(enumerationProps.type)) {\n        this._type = PrimitiveType.Integer;\n      } else if (/string/i.test(enumerationProps.type)) {\n        this._type = PrimitiveType.String;\n      } else {\n        if (SchemaReadHelper.isECSpecVersionNewer({ readVersion: enumerationProps.originalECSpecMajorVersion, writeVersion: enumerationProps.originalECSpecMinorVersion } as ECSpecVersion))\n          this._type = PrimitiveType.String;\n        else\n          throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has an invalid 'type' attribute. It should be either \"int\" or \"string\".`);\n      }\n    } else {\n      const primitiveTypePattern = (this.isInt) ? /int/i : /string/i;\n      if (!primitiveTypePattern.test(enumerationProps.type))\n        throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has an incompatible type. It must be \"${(this.isInt) ? \"int\" : \"string\"}\", not \"${(this.isInt) ? \"string\" : \"int\"}\".`);\n    }\n    this._isStrict = enumerationProps.isStrict;\n\n    if (undefined !== enumerationProps.enumerators) {\n      enumerationProps.enumerators.forEach((enumerator: EnumeratorProps) => {\n        // Creates a new enumerator (with the specified name, value, label and description- label and description are optional) and adds to the list of enumerators.\n        // Throws ECSchemaError if there are duplicate names or values present in the enumeration\n        this.addEnumerator(this.createEnumerator(enumerator.name, enumerator.value, enumerator.label, enumerator.description));\n      });\n    }\n  }\n\n  public override async fromJSON(enumerationProps: EnumerationProps) {\n    this.fromJSONSync(enumerationProps);\n  }\n\n  /**\n   * @internal\n   */\n  protected setIsStrict(isStrict: boolean) {\n    this._isStrict = isStrict;\n  }\n\n  /**\n   * Type guard to check if the SchemaItem is of type Enumeration.\n   * @param item The SchemaItem to check.\n   * @returns True if the item is an Enumeration, false otherwise.\n   */\n  public static isEnumeration(item?: SchemaItem): item is Enumeration {\n    return item?.schemaItemType === SchemaItemType.Enumeration;\n  }\n\n  /**\n   * Type assertion to check if the SchemaItem is of type Enumeration.\n   * @param item The SchemaItem to check.\n   * @returns The item cast to Enumeration if it is an Enumeration, undefined otherwise.\n   * @internal\n   */\n  public static assertIsEnumeration(item?: SchemaItem): asserts item is Enumeration {\n    if (!this.isEnumeration(item))\n      throw new ECSchemaError(ECSchemaStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Enumeration}' (Enumeration)`);\n  }\n}\n\n/**\n * An abstract class used for schema editing.\n *\n * @internal\n */\nexport abstract class MutableEnumeration extends Enumeration {\n  public abstract override addEnumerator(enumerator: AnyEnumerator): void;\n  public abstract override setIsStrict(isStrict: boolean): void;\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n"]}

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

@@ -3,19 +3,20 @@
  */
 import { SchemaItemFormatProps } from "../Deserialization/JsonProps";
 import { SchemaItemType } from "../ECObjects";
-import { BaseFormat, DecimalPrecision, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from "@itwin/core-quantity";
-import { InvertedUnit } from "./InvertedUnit";
+import { DecimalPrecision, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from "@itwin/core-quantity";
 import { Schema } from "./Schema";
 import { SchemaItem } from "./SchemaItem";
-import { Unit } from "./Unit";
+import { LazyLoadedInvertedUnit, LazyLoadedUnit } from "../Interfaces";
 /**
- * @beta
+ * @public @preview
  */
 export declare class Format extends SchemaItem {
     readonly schemaItemType: SchemaItemType;
+    /** @internal */
     static get schemaItemType(): SchemaItemType;
-    protected _base: BaseFormat;
-    protected _units?: Array<[Unit | InvertedUnit, string | undefined]>;
+    private _base;
+    private _units?;
+    /** @internal */
     constructor(schema: Schema, name: string);
     get roundFactor(): number;
     get type(): FormatType;
@@ -31,15 +32,21 @@ export declare class Format extends SchemaItem {
     get formatTraits(): FormatTraits;
     get spacer(): string | undefined;
     get includeZero(): boolean | undefined;
-    get units(): Array<[Unit | InvertedUnit, string | undefined]> | undefined;
+    get units(): ReadonlyArray<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]> | undefined;
     private parseFormatTraits;
     hasFormatTrait(formatTrait: FormatTraits): boolean;
     /**
      * Adds a Unit, or InvertedUnit, with an optional label override.
      * @param unit The Unit, or InvertedUnit, to add to this Format.
      * @param label A label that overrides the label defined within the Unit when a value is formatted.
+     * @internal
+     */
+    protected addUnit(unit: LazyLoadedUnit | LazyLoadedInvertedUnit, label?: string): void;
+    /**
+     *
+     * @param precision
+     * @internal
      */
-    protected addUnit(unit: Unit | InvertedUnit, label?: string): void;
     protected setPrecision(precision: number): void;
     private typecheck;
     fromJSONSync(formatProps: SchemaItemFormatProps): void;
@@ -53,61 +60,61 @@ export declare class Format extends SchemaItem {
     /** @internal */
     toXml(schemaXml: Document): Promise<Element>;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setFormatType(formatType: FormatType): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setRoundFactor(roundFactor: number): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setShowSignOption(signOption: ShowSignOption): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setDecimalSeparator(separator: string): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setThousandSeparator(separator: string): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setUomSeparator(separator: string): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setStationSeparator(separator: string): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setStationOffsetSize(stationOffsetSize: number): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setScientificType(scientificType: ScientificType): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setMinWidth(minWidth: number): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setSpacer(spacer: string): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setIncludeZero(includeZero: boolean): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setFormatTraits(formatTraits: FormatTraits): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
-    protected setUnits(units: Array<[Unit | InvertedUnit, string | undefined]>): void;
+    protected setUnits(units: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]>): void;
     /** Type guard to check if the SchemaItem is of type Format.
      * @param item The SchemaItem to check.
      * @returns True if the item is a Format, false otherwise.
@@ -117,6 +124,7 @@ export declare class Format extends SchemaItem {
      * Type assertion to check if the SchemaItem is of type Format.
      * @param item The SchemaItem to check.
      * @returns The item cast to Format if it is a Format, undefined otherwise.
+     * @internal
      */
     static assertIsFormat(item?: SchemaItem): asserts item is Format;
 }
@@ -125,7 +133,7 @@ export declare class Format extends SchemaItem {
  * An abstract class used for schema editing.
  */
 export declare abstract class MutableFormat extends Format {
-    abstract addUnit(unit: Unit | InvertedUnit, label?: string): void;
+    abstract addUnit(unit: LazyLoadedUnit | LazyLoadedInvertedUnit, label?: string): void;
     abstract setPrecision(precision: number): void;
     abstract setFormatType(formatType: FormatType): void;
     abstract setRoundFactor(roundFactor: number): void;

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

@@ -1 +1 @@
-{"version":3,"file":"Format.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Format.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAErE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EACL,UAAU,EAAE,gBAAgB,EAAE,YAAY,EAAuB,UAAU,EAAE,mBAAmB,EAChG,cAAc,EAAE,cAAc,EAC/B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;GAEG;AACH,qBAAa,MAAO,SAAQ,UAAU;IACpC,SAAyB,cAAc,iBAAyB;IAChE,WAA2B,cAAc,mBAAoC;IAC7E,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC;IAC5B,SAAS,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;gBAExD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAKxC,IAAW,WAAW,IAAI,MAAM,CAAmC;IACnE,IAAW,IAAI,IAAI,UAAU,CAA4B;IACzD,IAAW,SAAS,IAAI,gBAAgB,GAAG,mBAAmB,CAAiC;IAC/F,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAgC;IACzE,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAAsC;IAC7F,IAAW,cAAc,IAAI,cAAc,CAAsC;IACjF,IAAW,gBAAgB,IAAI,MAAM,CAAwC;IAC7E,IAAW,iBAAiB,IAAI,MAAM,CAAyC;IAC/E,IAAW,YAAY,IAAI,MAAM,CAAoC;IACrE,IAAW,gBAAgB,IAAI,MAAM,CAAwC;IAC7E,IAAW,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAAyC;IAC3F,IAAW,YAAY,IAAI,YAAY,CAAoC;IAC3E,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAA8B;IACrE,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAAmC;IAChF,IAAW,KAAK,IAAI,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,CAAwB;IAExG,OAAO,CAAC,iBAAiB;IAIlB,cAAc,CAAC,WAAW,EAAE,YAAY;IAI/C;;;;OAIG;IACH,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,YAAY,EAAE,KAAK,CAAC,EAAE,MAAM;IAa3D,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM;IAExC,OAAO,CAAC,SAAS;IAmBD,YAAY,CAAC,WAAW,EAAE,qBAAqB;IAezC,QAAQ,CAAC,WAAW,EAAE,qBAAqB;IAejE;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,qBAAqB;IAyDjH,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IA4ClE;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,UAAU;IAI9C;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM;IAI5C;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,cAAc;IAItD;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM;IAI/C;;OAEG;IACH,SAAS,CAAC,oBAAoB,CAAC,SAAS,EAAE,MAAM;IAIhD;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,MAAM;IAI3C;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM;IAI/C;;OAEG;IACH,SAAS,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,MAAM;IAIxD;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,cAAc,EAAE,cAAc;IAI1D;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM;IAItC;;OAEG;IACH,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM;IAIlC;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,OAAO;IAI7C;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,YAAY,EAAE,YAAY;IAIpD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAI1E;;;OAGG;WACW,QAAQ,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,MAAM;IAOzD;;;;OAIG;WACW,cAAc,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,MAAM;CAIxE;AAED;;;GAGG;AACH,8BAAsB,aAAc,SAAQ,MAAM;aACvB,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,YAAY,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI;aACxD,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aACrC,aAAa,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;aAC3C,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;aACzC,iBAAiB,CAAC,UAAU,EAAE,cAAc,GAAG,IAAI;aACnD,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC5C,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC7C,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aACxC,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC5C,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}
+{"version":3,"file":"Format.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Format.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAErE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EACO,gBAAgB,EAAE,YAAY,EAAuB,UAAU,EAAE,mBAAmB,EAChG,cAAc,EAAE,cAAc,EAC/B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAGvE;;GAEG;AACH,qBAAa,MAAO,SAAQ,UAAU;IACpC,SAAyB,cAAc,iBAAyB;IAChE,gBAAgB;IAChB,WAA2B,cAAc,mBAAoC;IAC7E,OAAO,CAAC,KAAK,CAAa;IAC1B,OAAO,CAAC,MAAM,CAAC,CAAuE;IAEtF,gBAAgB;gBACJ,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAKxC,IAAW,WAAW,IAAI,MAAM,CAAmC;IACnE,IAAW,IAAI,IAAI,UAAU,CAA4B;IACzD,IAAW,SAAS,IAAI,gBAAgB,GAAG,mBAAmB,CAAiC;IAC/F,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAgC;IACzE,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAAsC;IAC7F,IAAW,cAAc,IAAI,cAAc,CAAsC;IACjF,IAAW,gBAAgB,IAAI,MAAM,CAAwC;IAC7E,IAAW,iBAAiB,IAAI,MAAM,CAAyC;IAC/E,IAAW,YAAY,IAAI,MAAM,CAAoC;IACrE,IAAW,gBAAgB,IAAI,MAAM,CAAwC;IAC7E,IAAW,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAAyC;IAC3F,IAAW,YAAY,IAAI,YAAY,CAAoC;IAC3E,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAA8B;IACrE,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAAmC;IAChF,IAAW,KAAK,IAAI,aAAa,CAAC,CAAC,cAAc,GAAG,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,CAE3G;IAED,OAAO,CAAC,iBAAiB;IAIlB,cAAc,CAAC,WAAW,EAAE,YAAY;IAI/C;;;;;OAKG;IACH,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,cAAc,GAAG,sBAAsB,EAAE,KAAK,CAAC,EAAE,MAAM;IAa/E;;;;OAIG;IACH,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM;IAExC,OAAO,CAAC,SAAS;IAmBD,YAAY,CAAC,WAAW,EAAE,qBAAqB;IAmBzC,QAAQ,CAAC,WAAW,EAAE,qBAAqB;IAmBjE;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,qBAAqB;IAyDjH,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IA6ClE;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,UAAU;IAI9C;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM;IAI5C;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,cAAc;IAItD;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM;IAI/C;;OAEG;IACH,SAAS,CAAC,oBAAoB,CAAC,SAAS,EAAE,MAAM;IAIhD;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,MAAM;IAI3C;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM;IAI/C;;OAEG;IACH,SAAS,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,MAAM;IAIxD;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,cAAc,EAAE,cAAc;IAI1D;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM;IAItC;;OAEG;IACH,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM;IAIlC;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,OAAO;IAI7C;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,YAAY,EAAE,YAAY;IAIpD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,cAAc,GAAG,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAI9F;;;OAGG;WACW,QAAQ,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,MAAM;IAOzD;;;;;OAKG;WACW,cAAc,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,MAAM;CAIxE;AAED;;;GAGG;AACH,8BAAsB,aAAc,SAAQ,MAAM;aACvB,OAAO,CAAC,IAAI,EAAE,cAAc,GAAG,sBAAsB,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI;aAC5E,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aACrC,aAAa,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;aAC3C,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;aACzC,iBAAiB,CAAC,UAAU,EAAE,cAAc,GAAG,IAAI;aACnD,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC5C,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC7C,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aACxC,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC5C,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/cjs/Metadata/Format.js

@@ -15,14 +15,17 @@ const core_quantity_1 = require("@itwin/core-quantity");
 const InvertedUnit_1 = require("./InvertedUnit");
 const SchemaItem_1 = require("./SchemaItem");
 const Unit_1 = require("./Unit");
+const DelayedPromise_1 = require("../DelayedPromise");
 /**
- * @beta
+ * @public @preview
  */
 class Format extends SchemaItem_1.SchemaItem {
     schemaItemType = Format.schemaItemType;
+    /** @internal */
     static get schemaItemType() { return ECObjects_1.SchemaItemType.Format; }
     _base;
     _units;
+    /** @internal */
     constructor(schema, name) {
         super(schema, name);
         this._base = new core_quantity_1.BaseFormat(name);
@@ -41,7 +44,9 @@ class Format extends SchemaItem_1.SchemaItem {
     get formatTraits() { return this._base.formatTraits; }
     get spacer() { return this._base.spacer; }
     get includeZero() { return this._base.includeZero; }
-    get units() { return this._units; }
+    get units() {
+        return this._units;
+    }
     parseFormatTraits(formatTraitsFromJson) {
         return this._base.parseFormatTraits(formatTraitsFromJson);
     }
@@ -52,6 +57,7 @@ class Format extends SchemaItem_1.SchemaItem {
      * Adds a Unit, or InvertedUnit, with an optional label override.
      * @param unit The Unit, or InvertedUnit, to add to this Format.
      * @param label A label that overrides the label defined within the Unit when a value is formatted.
+     * @internal
      */
     addUnit(unit, label) {
         if (undefined === this._units)
@@ -59,11 +65,16 @@ class Format extends SchemaItem_1.SchemaItem {
         else { // Validate that a duplicate is not added.
             for (const existingUnit of this._units) {
                 if (unit.fullName.toLowerCase() === existingUnit[0].fullName.toLowerCase())
-                    throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Format ${this.fullName} has duplicate units, '${unit.fullName}'.`); // TODO: Validation - this should be a validation error not a hard failure.
+                    throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Format ${this.fullName} has duplicate units, '${unit.fullName}'.`); // TODO: Validation - this should be a validation error not a hard failure.
             }
         }
         this._units.push([unit, label]);
     }
+    /**
+     *
+     * @param precision
+     * @internal
+     */
     setPrecision(precision) { this._base.precision = precision; }
     typecheck(formatProps) {
         this._base.loadFormatProperties(formatProps);
@@ -72,12 +83,12 @@ class Format extends SchemaItem_1.SchemaItem {
                 this._base.includeZero = formatProps.composite.includeZero;
             if (undefined !== formatProps.composite.spacer) {
                 if (formatProps.composite.spacer.length > 1)
-                    throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Format ${this.fullName} has a composite with an invalid 'spacer' attribute. It should be an empty or one character string.`);
+                    throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Format ${this.fullName} has a composite with an invalid 'spacer' attribute. It should be an empty or one character string.`);
                 this._base.spacer = formatProps.composite.spacer;
             }
             // Composite requires 1-4 units
             if (formatProps.composite.units.length <= 0 || formatProps.composite.units.length > 4)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Format ${this.fullName} has an invalid 'Composite' attribute. It should have 1-4 units.`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Format ${this.fullName} has an invalid 'Composite' attribute. It should have 1-4 units.`);
         }
     }
     fromJSONSync(formatProps) {
@@ -89,8 +100,11 @@ class Format extends SchemaItem_1.SchemaItem {
         for (const unit of formatProps.composite.units) {
             const newUnit = this.schema.lookupItemSync(unit.name);
             if (undefined === newUnit || (!Unit_1.Unit.isUnit(newUnit) && !InvertedUnit_1.InvertedUnit.isInvertedUnit(newUnit)))
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, ``);
-            this.addUnit(newUnit, unit.label);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, ``);
+            if (Unit_1.Unit.isUnit(newUnit))
+                this.addUnit(new DelayedPromise_1.DelayedPromiseWithProps(newUnit.key, async () => newUnit), unit.label);
+            else if (InvertedUnit_1.InvertedUnit.isInvertedUnit(newUnit))
+                this.addUnit(new DelayedPromise_1.DelayedPromiseWithProps(newUnit.key, async () => newUnit), unit.label);
         }
     }
     async fromJSON(formatProps) {
@@ -102,8 +116,11 @@ class Format extends SchemaItem_1.SchemaItem {
         for (const unit of formatProps.composite.units) {
             const newUnit = await this.schema.lookupItem(unit.name);
             if (undefined === newUnit || (!Unit_1.Unit.isUnit(newUnit) && !InvertedUnit_1.InvertedUnit.isInvertedUnit(newUnit)))
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, ``);
-            this.addUnit(newUnit, unit.label);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, ``);
+            if (Unit_1.Unit.isUnit(newUnit))
+                this.addUnit(new DelayedPromise_1.DelayedPromiseWithProps(newUnit.key, async () => newUnit), unit.label);
+            else if (InvertedUnit_1.InvertedUnit.isInvertedUnit(newUnit))
+                this.addUnit(new DelayedPromise_1.DelayedPromiseWithProps(newUnit.key, async () => newUnit), unit.label);
         }
     }
     /**
@@ -182,98 +199,100 @@ class Format extends SchemaItem_1.SchemaItem {
                 compositeElement.setAttribute("spacer", this.spacer);
             if (undefined !== this.includeZero)
                 compositeElement.setAttribute("includeZero", this.includeZero.toString());
-            this.units.forEach(([unit, label]) => {
+            for (const [unit, label] of this.units) {
+                const resolvedUnit = await unit;
                 const unitElement = schemaXml.createElement("Unit");
                 if (undefined !== label)
                     unitElement.setAttribute("label", label);
-                const unitName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, unit.schema, unit.name);
+                const unitName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, resolvedUnit.schema, resolvedUnit.name);
                 unitElement.textContent = unitName;
                 compositeElement.appendChild(unitElement);
-            });
+            }
+            ;
             itemElement.appendChild(compositeElement);
         }
         return itemElement;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setFormatType(formatType) {
         this._base.type = formatType;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setRoundFactor(roundFactor) {
         this._base.roundFactor = roundFactor;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setShowSignOption(signOption) {
         this._base.showSignOption = signOption;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setDecimalSeparator(separator) {
         this._base.decimalSeparator = separator;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setThousandSeparator(separator) {
         this._base.thousandSeparator = separator;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setUomSeparator(separator) {
         this._base.uomSeparator = separator;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setStationSeparator(separator) {
         this._base.stationSeparator = separator;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setStationOffsetSize(stationOffsetSize) {
         this._base.stationOffsetSize = stationOffsetSize;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setScientificType(scientificType) {
         this._base.scientificType = scientificType;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setMinWidth(minWidth) {
         this._base.minWidth = minWidth;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setSpacer(spacer) {
         this._base.spacer = spacer;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setIncludeZero(includeZero) {
         this._base.includeZero = includeZero;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setFormatTraits(formatTraits) {
         this._base.formatTraits = formatTraits;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setUnits(units) {
         this._units = units;
@@ -291,10 +310,11 @@ class Format extends SchemaItem_1.SchemaItem {
      * Type assertion to check if the SchemaItem is of type Format.
      * @param item The SchemaItem to check.
      * @returns The item cast to Format if it is a Format, undefined otherwise.
+     * @internal
      */
     static assertIsFormat(item) {
         if (!this.isFormat(item))
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidSchemaItemType, `Expected '${ECObjects_1.SchemaItemType.Format}' (Format)`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidSchemaItemType, `Expected '${ECObjects_1.SchemaItemType.Format}' (Format)`);
     }
 }
 exports.Format = Format;

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

@@ -1 +1 @@
-{"version":3,"file":"Format.js","sourceRoot":"","sources":["../../../src/Metadata/Format.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,oFAAiF;AACjF,4CAA8C;AAC9C,4CAA+D;AAC/D,wDAG8B;AAC9B,iDAA8C;AAE9C,6CAA0C;AAC1C,iCAA8B;AAE9B;;GAEG;AACH,MAAa,MAAO,SAAQ,uBAAU;IACX,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;IACzD,MAAM,KAAc,cAAc,KAAK,OAAO,0BAAc,CAAC,MAAM,CAAC,CAAC,CAAC;IACnE,KAAK,CAAa;IAClB,MAAM,CAAoD;IAEpE,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,KAAK,GAAG,IAAI,0BAAU,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;IACnE,IAAW,IAAI,KAAiB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACzD,IAAW,SAAS,KAA6C,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/F,IAAW,QAAQ,KAAyB,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IACzE,IAAW,cAAc,KAAiC,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC;IAC7F,IAAW,cAAc,KAAqB,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC;IACjF,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC7E,IAAW,iBAAiB,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC/E,IAAW,YAAY,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IACrE,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC7E,IAAW,iBAAiB,KAAyB,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC3F,IAAW,YAAY,KAAmB,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IAC3E,IAAW,MAAM,KAAyB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACrE,IAAW,WAAW,KAA0B,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;IAChF,IAAW,KAAK,KAAmE,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhG,iBAAiB,CAAC,oBAAuC;QAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;IAC5D,CAAC;IAEM,cAAc,CAAC,WAAyB;QAC7C,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACO,OAAO,CAAC,IAAyB,EAAE,KAAc;QACzD,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;aACd,CAAC,CAAC,0CAA0C;YAC/C,KAAK,MAAM,YAAY,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBACvC,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE;oBACxE,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,cAAc,IAAI,CAAC,QAAQ,0BAA0B,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,2EAA2E;YAChN,CAAC;QACH,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;IAClC,CAAC;IAES,YAAY,CAAC,SAAiB,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC;IAEvE,SAAS,CAAC,WAAkC;QAClD,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;QAE7C,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,wEAAwE;YACjH,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS,CAAC,WAAW;gBACjD,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC;YAE7D,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;gBAC/C,IAAI,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;oBACzC,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,cAAc,IAAI,CAAC,QAAQ,qGAAqG,CAAC,CAAC;gBAC5L,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC;YACnD,CAAC;YAED,+BAA+B;YAC/B,IAAI,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;gBACnF,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,cAAc,IAAI,CAAC,QAAQ,kEAAkE,CAAC,CAAC;QAC3J,CAAC;IACH,CAAC;IAEe,YAAY,CAAC,WAAkC;QAC7D,KAAK,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAChC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAC5B,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS;YACrC,OAAO;QAET,8HAA8H;QAC9H,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;YAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtD,IAAI,SAAS,KAAK,OAAO,IAAI,CAAC,CAAC,WAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,2BAAY,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;gBAC3F,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAC9D,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,WAAkC;QAC/D,MAAM,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAClC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAC5B,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS;YACrC,OAAO;QAET,8HAA8H;QAC9H,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;YAC/C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxD,IAAI,SAAS,KAAK,OAAO,IAAI,CAAC,CAAC,WAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,2BAAY,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;gBAC3F,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAC9D,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED;;;;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,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAC5B,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEtC,sBAAsB;QACtB,4BAA4B;QAE5B,oHAAoH;QACpH,IAAI,GAAG,KAAK,IAAI,CAAC,WAAW;YAC1B,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAC5C,IAAI,8BAAc,CAAC,YAAY,KAAK,IAAI,CAAC,cAAc;YACrD,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAClD,IAAI,4BAAY,CAAC,aAAa,KAAK,IAAI,CAAC,YAAY;YAClD,UAAU,CAAC,YAAY,GAAG,IAAA,mCAAmB,EAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACnE,IAAI,GAAG,KAAK,IAAI,CAAC,gBAAgB;YAC/B,UAAU,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACtD,IAAI,GAAG,KAAK,IAAI,CAAC,iBAAiB;YAChC,UAAU,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACxD,IAAI,GAAG,KAAK,IAAI,CAAC,YAAY;YAC3B,UAAU,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAE9C,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEtC,IAAI,0BAAU,CAAC,UAAU,KAAK,IAAI,CAAC,IAAI,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc;YAC1E,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAElD,IAAI,0BAAU,CAAC,OAAO,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YACrC,IAAI,SAAS,KAAK,IAAI,CAAC,iBAAiB;gBACtC,UAAU,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;YACxD,IAAI,GAAG,KAAK,IAAI,CAAC,gBAAgB;gBAC/B,UAAU,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACxD,CAAC;QAED,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,OAAO,UAAU,CAAC;QAEpB,UAAU,CAAC,SAAS,GAAG,EAAE,CAAC;QAE1B,IAAI,GAAG,KAAK,IAAI,CAAC,MAAM;YACrB,UAAU,CAAC,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE5C,IAAI,IAAI,KAAK,IAAI,CAAC,WAAW;YAC3B,UAAU,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAEtD,UAAU,CAAC,SAAS,CAAC,KAAK,GAAG,EAAE,CAAC;QAChC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC9B,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC9B,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ;gBACtB,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;aACf,CAAC,CAAC;QACL,CAAC;QAED,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,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QAC1D,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QACjE,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;QACrE,WAAW,CAAC,YAAY,CAAC,gBAAgB,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAChE,WAAW,CAAC,YAAY,CAAC,kBAAkB,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACpE,WAAW,CAAC,YAAY,CAAC,mBAAmB,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACtE,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5D,WAAW,CAAC,YAAY,CAAC,kBAAkB,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAEpE,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;QACjE,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc;YACnC,WAAW,CAAC,YAAY,CAAC,gBAAgB,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAClE,IAAI,SAAS,KAAK,IAAI,CAAC,iBAAiB;YACtC,WAAW,CAAC,YAAY,CAAC,mBAAmB,EAAE,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEnF,MAAM,YAAY,GAAG,IAAA,mCAAmB,EAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5D,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC;YACzB,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAEnE,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YAC7B,MAAM,gBAAgB,GAAG,SAAS,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YAC9D,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;gBAC3B,gBAAgB,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YACvD,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW;gBAChC,gBAAgB,CAAC,YAAY,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;YAE5E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE;gBACnC,MAAM,WAAW,GAAG,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;gBACpD,IAAI,SAAS,KAAK,KAAK;oBACrB,WAAW,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBAC3C,MAAM,QAAQ,GAAG,6CAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC/F,WAAW,CAAC,WAAW,GAAG,QAAQ,CAAC;gBACnC,gBAAgB,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;YAC5C,CAAC,CAAC,CAAC;YAEH,WAAW,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;QAC5C,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;OAEG;IACO,aAAa,CAAC,UAAsB;QAC5C,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,UAAU,CAAC;IAC/B,CAAC;IAED;;OAEG;IACO,cAAc,CAAC,WAAmB;QAC1C,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;IACvC,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,UAA0B;QACpD,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,UAAU,CAAC;IACzC,CAAC;IAED;;OAEG;IACO,mBAAmB,CAAC,SAAiB;QAC7C,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAC1C,CAAC;IAED;;OAEG;IACO,oBAAoB,CAAC,SAAiB;QAC9C,IAAI,CAAC,KAAK,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAC3C,CAAC;IAED;;OAEG;IACO,eAAe,CAAC,SAAiB;QACzC,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,SAAS,CAAC;IACtC,CAAC;IAED;;OAEG;IACO,mBAAmB,CAAC,SAAiB;QAC7C,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAC1C,CAAC;IAED;;OAEG;IACO,oBAAoB,CAAC,iBAAyB;QACtD,IAAI,CAAC,KAAK,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IACnD,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,cAA8B;QACxD,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,cAAc,CAAC;IAC7C,CAAC;IAED;;OAEG;IACO,WAAW,CAAC,QAAgB;QACpC,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;IACjC,CAAC;IAED;;OAEG;IACO,SAAS,CAAC,MAAc;QAChC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;IAC7B,CAAC;IAED;;OAEG;IACO,cAAc,CAAC,WAAoB;QAC3C,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;IACvC,CAAC;IAED;;OAEG;IACO,eAAe,CAAC,YAA0B;QAClD,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,YAAY,CAAC;IACzC,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,KAAuD;QACxE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAiB;QACxC,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,0BAAc,CAAC,MAAM;YACvD,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,IAAiB;QAC5C,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YACtB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,qBAAqB,EAAE,aAAa,0BAAc,CAAC,MAAM,YAAY,CAAC,CAAC;IACpH,CAAC;CACF;AAzUD,wBAyUC;AAED;;;GAGG;AACH,MAAsB,aAAc,SAAQ,MAAM;CAWjD;AAXD,sCAWC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Metadata\n */\n\nimport { SchemaItemFormatProps } from \"../Deserialization/JsonProps\";\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\nimport { SchemaItemType } from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport {\n  BaseFormat, DecimalPrecision, FormatTraits, formatTraitsToArray, FormatType, FractionalPrecision,\n  ScientificType, ShowSignOption,\n} from \"@itwin/core-quantity\";\nimport { InvertedUnit } from \"./InvertedUnit\";\nimport { Schema } from \"./Schema\";\nimport { SchemaItem } from \"./SchemaItem\";\nimport { Unit } from \"./Unit\";\n\n/**\n * @beta\n */\nexport class Format extends SchemaItem {\n  public override readonly schemaItemType = Format.schemaItemType;\n  public static override get schemaItemType() { return SchemaItemType.Format; }\n  protected _base: BaseFormat;\n  protected _units?: Array<[Unit | InvertedUnit, string | undefined]>;\n\n  constructor(schema: Schema, name: string) {\n    super(schema, name);\n    this._base = new BaseFormat(name);\n  }\n\n  public get roundFactor(): number { return this._base.roundFactor; }\n  public get type(): FormatType { return this._base.type; }\n  public get precision(): DecimalPrecision | FractionalPrecision { return this._base.precision; }\n  public get minWidth(): number | undefined { return this._base.minWidth; }\n  public get scientificType(): ScientificType | undefined { return this._base.scientificType; }\n  public get showSignOption(): ShowSignOption { return this._base.showSignOption; }\n  public get decimalSeparator(): string { return this._base.decimalSeparator; }\n  public get thousandSeparator(): string { return this._base.thousandSeparator; }\n  public get uomSeparator(): string { return this._base.uomSeparator; }\n  public get stationSeparator(): string { return this._base.stationSeparator; }\n  public get stationOffsetSize(): number | undefined { return this._base.stationOffsetSize; }\n  public get formatTraits(): FormatTraits { return this._base.formatTraits; }\n  public get spacer(): string | undefined { return this._base.spacer; }\n  public get includeZero(): boolean | undefined { return this._base.includeZero; }\n  public get units(): Array<[Unit | InvertedUnit, string | undefined]> | undefined { return this._units; }\n\n  private parseFormatTraits(formatTraitsFromJson: string | string[]) {\n    return this._base.parseFormatTraits(formatTraitsFromJson);\n  }\n\n  public hasFormatTrait(formatTrait: FormatTraits) {\n    return this._base.hasFormatTraitSet(formatTrait);\n  }\n\n  /**\n   * Adds a Unit, or InvertedUnit, with an optional label override.\n   * @param unit The Unit, or InvertedUnit, to add to this Format.\n   * @param label A label that overrides the label defined within the Unit when a value is formatted.\n   */\n  protected addUnit(unit: Unit | InvertedUnit, label?: string) {\n    if (undefined === this._units)\n      this._units = [];\n    else { // Validate that a duplicate is not added.\n      for (const existingUnit of this._units) {\n        if (unit.fullName.toLowerCase() === existingUnit[0].fullName.toLowerCase())\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Format ${this.fullName} has duplicate units, '${unit.fullName}'.`); // TODO: Validation - this should be a validation error not a hard failure.\n      }\n    }\n\n    this._units.push([unit, label]);\n  }\n\n  protected setPrecision(precision: number) { this._base.precision = precision; }\n\n  private typecheck(formatProps: SchemaItemFormatProps) {\n    this._base.loadFormatProperties(formatProps);\n\n    if (undefined !== formatProps.composite) { // TODO: This is duplicated below when the units need to be processed...\n      if (undefined !== formatProps.composite.includeZero)\n        this._base.includeZero = formatProps.composite.includeZero;\n\n      if (undefined !== formatProps.composite.spacer) {\n        if (formatProps.composite.spacer.length > 1)\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Format ${this.fullName} has a composite with an invalid 'spacer' attribute. It should be an empty or one character string.`);\n        this._base.spacer = formatProps.composite.spacer;\n      }\n\n      // Composite requires 1-4 units\n      if (formatProps.composite.units.length <= 0 || formatProps.composite.units.length > 4)\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Format ${this.fullName} has an invalid 'Composite' attribute. It should have 1-4 units.`);\n    }\n  }\n\n  public override fromJSONSync(formatProps: SchemaItemFormatProps) {\n    super.fromJSONSync(formatProps);\n    this.typecheck(formatProps);\n    if (undefined === formatProps.composite)\n      return;\n\n    // Units are separated from the rest of the deserialization because of the need to have separate sync and async implementation\n    for (const unit of formatProps.composite.units) {\n      const newUnit = this.schema.lookupItemSync(unit.name);\n      if (undefined === newUnit || (!Unit.isUnit(newUnit) && !InvertedUnit.isInvertedUnit(newUnit)))\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);\n      this.addUnit(newUnit, unit.label);\n    }\n  }\n\n  public override async fromJSON(formatProps: SchemaItemFormatProps) {\n    await super.fromJSON(formatProps);\n    this.typecheck(formatProps);\n    if (undefined === formatProps.composite)\n      return;\n\n    // Units are separated from the rest of the deserialization because of the need to have separate sync and async implementation\n    for (const unit of formatProps.composite.units) {\n      const newUnit = await this.schema.lookupItem(unit.name);\n      if (undefined === newUnit || (!Unit.isUnit(newUnit) && !InvertedUnit.isInvertedUnit(newUnit)))\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);\n      this.addUnit(newUnit, unit.label);\n    }\n  }\n\n  /**\n   * Save this Format's properties to an object for serializing to JSON.\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\n   */\n  public override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): SchemaItemFormatProps {\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\n    schemaJson.type = this.type;\n    schemaJson.precision = this.precision;\n\n    // this._spacer = \" \";\n    // this._includeZero = true;\n\n    // Serialize the minimal amount of information needed so anything that is the same as the default, do not serialize.\n    if (0.0 !== this.roundFactor)\n      schemaJson.roundFactor = this.roundFactor;\n    if (ShowSignOption.OnlyNegative !== this.showSignOption)\n      schemaJson.showSignOption = this.showSignOption;\n    if (FormatTraits.Uninitialized !== this.formatTraits)\n      schemaJson.formatTraits = formatTraitsToArray(this.formatTraits);\n    if (\".\" !== this.decimalSeparator)\n      schemaJson.decimalSeparator = this.decimalSeparator;\n    if (\",\" !== this.thousandSeparator)\n      schemaJson.thousandSeparator = this.thousandSeparator;\n    if (\" \" !== this.uomSeparator)\n      schemaJson.uomSeparator = this.uomSeparator;\n\n    if (undefined !== this.minWidth)\n      schemaJson.minWidth = this.minWidth;\n\n    if (FormatType.Scientific === this.type && undefined !== this.scientificType)\n      schemaJson.scientificType = this.scientificType;\n\n    if (FormatType.Station === this.type) {\n      if (undefined !== this.stationOffsetSize)\n        schemaJson.stationOffsetSize = this.stationOffsetSize;\n      if (\" \" !== this.stationSeparator)\n        schemaJson.stationSeparator = this.stationSeparator;\n    }\n\n    if (undefined === this.units)\n      return schemaJson;\n\n    schemaJson.composite = {};\n\n    if (\" \" !== this.spacer)\n      schemaJson.composite.spacer = this.spacer;\n\n    if (true !== this.includeZero)\n      schemaJson.composite.includeZero = this.includeZero;\n\n    schemaJson.composite.units = [];\n    for (const unit of this.units) {\n      schemaJson.composite.units.push({\n        name: unit[0].fullName,\n        label: unit[1],\n      });\n    }\n\n    return schemaJson;\n  }\n\n  /** @internal */\n  public override async toXml(schemaXml: Document): Promise<Element> {\n    const itemElement = await super.toXml(schemaXml);\n    itemElement.setAttribute(\"type\", this.type.toLowerCase());\n    itemElement.setAttribute(\"precision\", this.precision.toString());\n    itemElement.setAttribute(\"roundFactor\", this.roundFactor.toString());\n    itemElement.setAttribute(\"showSignOption\", this.showSignOption);\n    itemElement.setAttribute(\"decimalSeparator\", this.decimalSeparator);\n    itemElement.setAttribute(\"thousandSeparator\", this.thousandSeparator);\n    itemElement.setAttribute(\"uomSeparator\", this.uomSeparator);\n    itemElement.setAttribute(\"stationSeparator\", this.stationSeparator);\n\n    if (undefined !== this.minWidth)\n      itemElement.setAttribute(\"minWidth\", this.minWidth.toString());\n    if (undefined !== this.scientificType)\n      itemElement.setAttribute(\"scientificType\", this.scientificType);\n    if (undefined !== this.stationOffsetSize)\n      itemElement.setAttribute(\"stationOffsetSize\", this.stationOffsetSize.toString());\n\n    const formatTraits = formatTraitsToArray(this.formatTraits);\n    if (formatTraits.length > 0)\n      itemElement.setAttribute(\"formatTraits\", formatTraits.join(\"|\"));\n\n    if (undefined !== this.units) {\n      const compositeElement = schemaXml.createElement(\"Composite\");\n      if (undefined !== this.spacer)\n        compositeElement.setAttribute(\"spacer\", this.spacer);\n      if (undefined !== this.includeZero)\n        compositeElement.setAttribute(\"includeZero\", this.includeZero.toString());\n\n      this.units.forEach(([unit, label]) => {\n        const unitElement = schemaXml.createElement(\"Unit\");\n        if (undefined !== label)\n          unitElement.setAttribute(\"label\", label);\n        const unitName = XmlSerializationUtils.createXmlTypedName(this.schema, unit.schema, unit.name);\n        unitElement.textContent = unitName;\n        compositeElement.appendChild(unitElement);\n      });\n\n      itemElement.appendChild(compositeElement);\n    }\n\n    return itemElement;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setFormatType(formatType: FormatType) {\n    this._base.type = formatType;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setRoundFactor(roundFactor: number) {\n    this._base.roundFactor = roundFactor;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setShowSignOption(signOption: ShowSignOption) {\n    this._base.showSignOption = signOption;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setDecimalSeparator(separator: string) {\n    this._base.decimalSeparator = separator;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setThousandSeparator(separator: string) {\n    this._base.thousandSeparator = separator;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setUomSeparator(separator: string) {\n    this._base.uomSeparator = separator;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setStationSeparator(separator: string) {\n    this._base.stationSeparator = separator;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setStationOffsetSize(stationOffsetSize: number) {\n    this._base.stationOffsetSize = stationOffsetSize;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setScientificType(scientificType: ScientificType) {\n    this._base.scientificType = scientificType;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setMinWidth(minWidth: number) {\n    this._base.minWidth = minWidth;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setSpacer(spacer: string) {\n    this._base.spacer = spacer;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setIncludeZero(includeZero: boolean) {\n    this._base.includeZero = includeZero;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setFormatTraits(formatTraits: FormatTraits) {\n    this._base.formatTraits = formatTraits;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setUnits(units: Array<[Unit | InvertedUnit, string | undefined]>) {\n    this._units = units;\n  }\n\n  /** Type guard to check if the SchemaItem is of type Format.\n   * @param item The SchemaItem to check.\n   * @returns True if the item is a Format, false otherwise.\n   */\n  public static isFormat(item?: SchemaItem): item is Format {\n  if (item && item.schemaItemType === SchemaItemType.Format)\n    return true;\n\n  return false;\n  }\n\n  /**\n   * Type assertion to check if the SchemaItem is of type Format.\n   * @param item The SchemaItem to check.\n   * @returns The item cast to Format if it is a Format, undefined otherwise.\n   */\n  public static assertIsFormat(item?: SchemaItem): asserts item is Format {\n    if (!this.isFormat(item))\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Format}' (Format)`);\n  }\n}\n\n/**\n * @internal\n * An abstract class used for schema editing.\n */\nexport abstract class MutableFormat extends Format {\n  public abstract override addUnit(unit: Unit | InvertedUnit, label?: string): void;\n  public abstract override setPrecision(precision: number): void;\n  public abstract override setFormatType(formatType: FormatType): void;\n  public abstract override setRoundFactor(roundFactor: number): void;\n  public abstract override setShowSignOption(signOption: ShowSignOption): void;\n  public abstract override setDecimalSeparator(separator: string): void;\n  public abstract override setThousandSeparator(separator: string): void;\n  public abstract override setUomSeparator(separator: string): void;\n  public abstract override setStationSeparator(separator: string): void;\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n"]}
+{"version":3,"file":"Format.js","sourceRoot":"","sources":["../../../src/Metadata/Format.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,oFAAiF;AACjF,4CAA8C;AAC9C,4CAA6D;AAC7D,wDAG8B;AAC9B,iDAA8C;AAE9C,6CAA0C;AAC1C,iCAA8B;AAE9B,sDAA4D;AAE5D;;GAEG;AACH,MAAa,MAAO,SAAQ,uBAAU;IACX,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;IAChE,gBAAgB;IACT,MAAM,KAAc,cAAc,KAAK,OAAO,0BAAc,CAAC,MAAM,CAAC,CAAC,CAAC;IACrE,KAAK,CAAa;IAClB,MAAM,CAAwE;IAEtF,gBAAgB;IAChB,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,KAAK,GAAG,IAAI,0BAAU,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;IACnE,IAAW,IAAI,KAAiB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACzD,IAAW,SAAS,KAA6C,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/F,IAAW,QAAQ,KAAyB,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IACzE,IAAW,cAAc,KAAiC,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC;IAC7F,IAAW,cAAc,KAAqB,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC;IACjF,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC7E,IAAW,iBAAiB,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC/E,IAAW,YAAY,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IACrE,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC7E,IAAW,iBAAiB,KAAyB,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC3F,IAAW,YAAY,KAAmB,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IAC3E,IAAW,MAAM,KAAyB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACrE,IAAW,WAAW,KAA0B,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;IAChF,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAEO,iBAAiB,CAAC,oBAAuC;QAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;IAC5D,CAAC;IAEM,cAAc,CAAC,WAAyB;QAC7C,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACO,OAAO,CAAC,IAA6C,EAAE,KAAc;QAC7E,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;aACd,CAAC,CAAC,0CAA0C;YAC/C,KAAK,MAAM,YAAY,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBACvC,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE;oBACxE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,cAAc,IAAI,CAAC,QAAQ,0BAA0B,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,2EAA2E;YAC9M,CAAC;QACH,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACO,YAAY,CAAC,SAAiB,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC;IAEvE,SAAS,CAAC,WAAkC;QAClD,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;QAE7C,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,wEAAwE;YACjH,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS,CAAC,WAAW;gBACjD,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC;YAE7D,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;gBAC/C,IAAI,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;oBACzC,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,cAAc,IAAI,CAAC,QAAQ,qGAAqG,CAAC,CAAC;gBAC1L,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC;YACnD,CAAC;YAED,+BAA+B;YAC/B,IAAI,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;gBACnF,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,cAAc,IAAI,CAAC,QAAQ,kEAAkE,CAAC,CAAC;QACzJ,CAAC;IACH,CAAC;IAEe,YAAY,CAAC,WAAkC;QAC7D,KAAK,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAChC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAC5B,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS;YACrC,OAAO;QAET,8HAA8H;QAC9H,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;YAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtD,IAAI,SAAS,KAAK,OAAO,IAAI,CAAC,CAAC,WAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,2BAAY,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;gBAC3F,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAE5D,IAAG,WAAI,CAAC,MAAM,CAAC,OAAO,CAAC;gBACrB,IAAI,CAAC,OAAO,CAAC,IAAI,wCAAuB,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;iBACrF,IAAG,2BAAY,CAAC,cAAc,CAAC,OAAO,CAAC;gBAC1C,IAAI,CAAC,OAAO,CAAC,IAAI,wCAAuB,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5F,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,WAAkC;QAC/D,MAAM,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAClC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAC5B,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS;YACrC,OAAO;QAET,8HAA8H;QAC9H,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;YAC/C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxD,IAAI,SAAS,KAAK,OAAO,IAAI,CAAC,CAAC,WAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,2BAAY,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;gBAC3F,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAE5D,IAAG,WAAI,CAAC,MAAM,CAAC,OAAO,CAAC;gBACrB,IAAI,CAAC,OAAO,CAAC,IAAI,wCAAuB,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;iBACrF,IAAG,2BAAY,CAAC,cAAc,CAAC,OAAO,CAAC;gBAC1C,IAAI,CAAC,OAAO,CAAC,IAAI,wCAAuB,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5F,CAAC;IACH,CAAC;IAED;;;;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,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAC5B,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEtC,sBAAsB;QACtB,4BAA4B;QAE5B,oHAAoH;QACpH,IAAI,GAAG,KAAK,IAAI,CAAC,WAAW;YAC1B,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAC5C,IAAI,8BAAc,CAAC,YAAY,KAAK,IAAI,CAAC,cAAc;YACrD,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAClD,IAAI,4BAAY,CAAC,aAAa,KAAK,IAAI,CAAC,YAAY;YAClD,UAAU,CAAC,YAAY,GAAG,IAAA,mCAAmB,EAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACnE,IAAI,GAAG,KAAK,IAAI,CAAC,gBAAgB;YAC/B,UAAU,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACtD,IAAI,GAAG,KAAK,IAAI,CAAC,iBAAiB;YAChC,UAAU,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACxD,IAAI,GAAG,KAAK,IAAI,CAAC,YAAY;YAC3B,UAAU,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAE9C,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEtC,IAAI,0BAAU,CAAC,UAAU,KAAK,IAAI,CAAC,IAAI,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc;YAC1E,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAElD,IAAI,0BAAU,CAAC,OAAO,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YACrC,IAAI,SAAS,KAAK,IAAI,CAAC,iBAAiB;gBACtC,UAAU,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;YACxD,IAAI,GAAG,KAAK,IAAI,CAAC,gBAAgB;gBAC/B,UAAU,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACxD,CAAC;QAED,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,OAAO,UAAU,CAAC;QAEpB,UAAU,CAAC,SAAS,GAAG,EAAE,CAAC;QAE1B,IAAI,GAAG,KAAK,IAAI,CAAC,MAAM;YACrB,UAAU,CAAC,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE5C,IAAI,IAAI,KAAK,IAAI,CAAC,WAAW;YAC3B,UAAU,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAEtD,UAAU,CAAC,SAAS,CAAC,KAAK,GAAG,EAAE,CAAC;QAChC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC9B,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC9B,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ;gBACtB,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;aACf,CAAC,CAAC;QACL,CAAC;QAED,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,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QAC1D,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QACjE,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;QACrE,WAAW,CAAC,YAAY,CAAC,gBAAgB,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAChE,WAAW,CAAC,YAAY,CAAC,kBAAkB,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACpE,WAAW,CAAC,YAAY,CAAC,mBAAmB,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACtE,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5D,WAAW,CAAC,YAAY,CAAC,kBAAkB,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAEpE,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;QACjE,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc;YACnC,WAAW,CAAC,YAAY,CAAC,gBAAgB,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAClE,IAAI,SAAS,KAAK,IAAI,CAAC,iBAAiB;YACtC,WAAW,CAAC,YAAY,CAAC,mBAAmB,EAAE,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEnF,MAAM,YAAY,GAAG,IAAA,mCAAmB,EAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5D,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC;YACzB,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAEnE,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YAC7B,MAAM,gBAAgB,GAAG,SAAS,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YAC9D,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;gBAC3B,gBAAgB,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YACvD,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW;gBAChC,gBAAgB,CAAC,YAAY,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;YAE5E,KAAI,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACtC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC;gBAChC,MAAM,WAAW,GAAG,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;gBACpD,IAAI,SAAS,KAAK,KAAK;oBACrB,WAAW,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBAC3C,MAAM,QAAQ,GAAG,6CAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;gBAC/G,WAAW,CAAC,WAAW,GAAG,QAAQ,CAAC;gBACnC,gBAAgB,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;YAC5C,CAAC;YAAA,CAAC;YAEF,WAAW,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;QAC5C,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;OAEG;IACO,aAAa,CAAC,UAAsB;QAC5C,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,UAAU,CAAC;IAC/B,CAAC;IAED;;OAEG;IACO,cAAc,CAAC,WAAmB;QAC1C,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;IACvC,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,UAA0B;QACpD,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,UAAU,CAAC;IACzC,CAAC;IAED;;OAEG;IACO,mBAAmB,CAAC,SAAiB;QAC7C,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAC1C,CAAC;IAED;;OAEG;IACO,oBAAoB,CAAC,SAAiB;QAC9C,IAAI,CAAC,KAAK,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAC3C,CAAC;IAED;;OAEG;IACO,eAAe,CAAC,SAAiB;QACzC,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,SAAS,CAAC;IACtC,CAAC;IAED;;OAEG;IACO,mBAAmB,CAAC,SAAiB;QAC7C,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAC1C,CAAC;IAED;;OAEG;IACO,oBAAoB,CAAC,iBAAyB;QACtD,IAAI,CAAC,KAAK,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IACnD,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,cAA8B;QACxD,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,cAAc,CAAC;IAC7C,CAAC;IAED;;OAEG;IACO,WAAW,CAAC,QAAgB;QACpC,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;IACjC,CAAC;IAED;;OAEG;IACO,SAAS,CAAC,MAAc;QAChC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;IAC7B,CAAC;IAED;;OAEG;IACO,cAAc,CAAC,WAAoB;QAC3C,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;IACvC,CAAC;IAED;;OAEG;IACO,eAAe,CAAC,YAA0B;QAClD,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,YAAY,CAAC;IACzC,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,KAA2E;QAC5F,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAiB;QACtC,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,0BAAc,CAAC,MAAM;YACvD,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAC,IAAiB;QAC5C,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YACtB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,qBAAqB,EAAE,aAAa,0BAAc,CAAC,MAAM,YAAY,CAAC,CAAC;IAClH,CAAC;CACF;AA7VD,wBA6VC;AAED;;;GAGG;AACH,MAAsB,aAAc,SAAQ,MAAM;CAWjD;AAXD,sCAWC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Metadata\n */\n\nimport { SchemaItemFormatProps } from \"../Deserialization/JsonProps\";\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\nimport { SchemaItemType } from \"../ECObjects\";\nimport { ECSchemaError, ECSchemaStatus } from \"../Exception\";\nimport {\n  BaseFormat, DecimalPrecision, FormatTraits, formatTraitsToArray, FormatType, FractionalPrecision,\n  ScientificType, ShowSignOption,\n} from \"@itwin/core-quantity\";\nimport { InvertedUnit } from \"./InvertedUnit\";\nimport { Schema } from \"./Schema\";\nimport { SchemaItem } from \"./SchemaItem\";\nimport { Unit } from \"./Unit\";\nimport { LazyLoadedInvertedUnit, LazyLoadedUnit } from \"../Interfaces\";\nimport { DelayedPromiseWithProps } from \"../DelayedPromise\";\n\n/**\n * @public @preview\n */\nexport class Format extends SchemaItem {\n  public override readonly schemaItemType = Format.schemaItemType;\n  /** @internal */\n  public static override get schemaItemType() { return SchemaItemType.Format; }\n  private _base: BaseFormat;\n  private _units?: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]>;\n\n  /** @internal */\n  constructor(schema: Schema, name: string) {\n    super(schema, name);\n    this._base = new BaseFormat(name);\n  }\n\n  public get roundFactor(): number { return this._base.roundFactor; }\n  public get type(): FormatType { return this._base.type; }\n  public get precision(): DecimalPrecision | FractionalPrecision { return this._base.precision; }\n  public get minWidth(): number | undefined { return this._base.minWidth; }\n  public get scientificType(): ScientificType | undefined { return this._base.scientificType; }\n  public get showSignOption(): ShowSignOption { return this._base.showSignOption; }\n  public get decimalSeparator(): string { return this._base.decimalSeparator; }\n  public get thousandSeparator(): string { return this._base.thousandSeparator; }\n  public get uomSeparator(): string { return this._base.uomSeparator; }\n  public get stationSeparator(): string { return this._base.stationSeparator; }\n  public get stationOffsetSize(): number | undefined { return this._base.stationOffsetSize; }\n  public get formatTraits(): FormatTraits { return this._base.formatTraits; }\n  public get spacer(): string | undefined { return this._base.spacer; }\n  public get includeZero(): boolean | undefined { return this._base.includeZero; }\n  public get units(): ReadonlyArray<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]> | undefined {\n    return this._units;\n  }\n\n  private parseFormatTraits(formatTraitsFromJson: string | string[]) {\n    return this._base.parseFormatTraits(formatTraitsFromJson);\n  }\n\n  public hasFormatTrait(formatTrait: FormatTraits) {\n    return this._base.hasFormatTraitSet(formatTrait);\n  }\n\n  /**\n   * Adds a Unit, or InvertedUnit, with an optional label override.\n   * @param unit The Unit, or InvertedUnit, to add to this Format.\n   * @param label A label that overrides the label defined within the Unit when a value is formatted.\n   * @internal\n   */\n  protected addUnit(unit: LazyLoadedUnit | LazyLoadedInvertedUnit, label?: string) {\n    if (undefined === this._units)\n      this._units = [];\n    else { // Validate that a duplicate is not added.\n      for (const existingUnit of this._units) {\n        if (unit.fullName.toLowerCase() === existingUnit[0].fullName.toLowerCase())\n          throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Format ${this.fullName} has duplicate units, '${unit.fullName}'.`); // TODO: Validation - this should be a validation error not a hard failure.\n      }\n    }\n\n    this._units.push([unit, label]);\n  }\n\n  /**\n   *\n   * @param precision\n   * @internal\n   */\n  protected setPrecision(precision: number) { this._base.precision = precision; }\n\n  private typecheck(formatProps: SchemaItemFormatProps) {\n    this._base.loadFormatProperties(formatProps);\n\n    if (undefined !== formatProps.composite) { // TODO: This is duplicated below when the units need to be processed...\n      if (undefined !== formatProps.composite.includeZero)\n        this._base.includeZero = formatProps.composite.includeZero;\n\n      if (undefined !== formatProps.composite.spacer) {\n        if (formatProps.composite.spacer.length > 1)\n          throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Format ${this.fullName} has a composite with an invalid 'spacer' attribute. It should be an empty or one character string.`);\n        this._base.spacer = formatProps.composite.spacer;\n      }\n\n      // Composite requires 1-4 units\n      if (formatProps.composite.units.length <= 0 || formatProps.composite.units.length > 4)\n        throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Format ${this.fullName} has an invalid 'Composite' attribute. It should have 1-4 units.`);\n    }\n  }\n\n  public override fromJSONSync(formatProps: SchemaItemFormatProps) {\n    super.fromJSONSync(formatProps);\n    this.typecheck(formatProps);\n    if (undefined === formatProps.composite)\n      return;\n\n    // Units are separated from the rest of the deserialization because of the need to have separate sync and async implementation\n    for (const unit of formatProps.composite.units) {\n      const newUnit = this.schema.lookupItemSync(unit.name);\n      if (undefined === newUnit || (!Unit.isUnit(newUnit) && !InvertedUnit.isInvertedUnit(newUnit)))\n        throw new ECSchemaError(ECSchemaStatus.InvalidECJson, ``);\n      \n      if(Unit.isUnit(newUnit))\n        this.addUnit(new DelayedPromiseWithProps(newUnit.key, async () => newUnit), unit.label);\n      else if(InvertedUnit.isInvertedUnit(newUnit))\n        this.addUnit(new DelayedPromiseWithProps(newUnit.key, async () => newUnit), unit.label);\n    }\n  }\n\n  public override async fromJSON(formatProps: SchemaItemFormatProps) {\n    await super.fromJSON(formatProps);\n    this.typecheck(formatProps);\n    if (undefined === formatProps.composite)\n      return;\n\n    // Units are separated from the rest of the deserialization because of the need to have separate sync and async implementation\n    for (const unit of formatProps.composite.units) {\n      const newUnit = await this.schema.lookupItem(unit.name);\n      if (undefined === newUnit || (!Unit.isUnit(newUnit) && !InvertedUnit.isInvertedUnit(newUnit)))\n        throw new ECSchemaError(ECSchemaStatus.InvalidECJson, ``);\n\n      if(Unit.isUnit(newUnit))\n        this.addUnit(new DelayedPromiseWithProps(newUnit.key, async () => newUnit), unit.label);\n      else if(InvertedUnit.isInvertedUnit(newUnit))\n        this.addUnit(new DelayedPromiseWithProps(newUnit.key, async () => newUnit), unit.label);\n    }\n  }\n\n  /**\n   * Save this Format's properties to an object for serializing to JSON.\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\n   */\n  public override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): SchemaItemFormatProps {\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\n    schemaJson.type = this.type;\n    schemaJson.precision = this.precision;\n\n    // this._spacer = \" \";\n    // this._includeZero = true;\n\n    // Serialize the minimal amount of information needed so anything that is the same as the default, do not serialize.\n    if (0.0 !== this.roundFactor)\n      schemaJson.roundFactor = this.roundFactor;\n    if (ShowSignOption.OnlyNegative !== this.showSignOption)\n      schemaJson.showSignOption = this.showSignOption;\n    if (FormatTraits.Uninitialized !== this.formatTraits)\n      schemaJson.formatTraits = formatTraitsToArray(this.formatTraits);\n    if (\".\" !== this.decimalSeparator)\n      schemaJson.decimalSeparator = this.decimalSeparator;\n    if (\",\" !== this.thousandSeparator)\n      schemaJson.thousandSeparator = this.thousandSeparator;\n    if (\" \" !== this.uomSeparator)\n      schemaJson.uomSeparator = this.uomSeparator;\n\n    if (undefined !== this.minWidth)\n      schemaJson.minWidth = this.minWidth;\n\n    if (FormatType.Scientific === this.type && undefined !== this.scientificType)\n      schemaJson.scientificType = this.scientificType;\n\n    if (FormatType.Station === this.type) {\n      if (undefined !== this.stationOffsetSize)\n        schemaJson.stationOffsetSize = this.stationOffsetSize;\n      if (\" \" !== this.stationSeparator)\n        schemaJson.stationSeparator = this.stationSeparator;\n    }\n\n    if (undefined === this.units)\n      return schemaJson;\n\n    schemaJson.composite = {};\n\n    if (\" \" !== this.spacer)\n      schemaJson.composite.spacer = this.spacer;\n\n    if (true !== this.includeZero)\n      schemaJson.composite.includeZero = this.includeZero;\n\n    schemaJson.composite.units = [];\n    for (const unit of this.units) {\n      schemaJson.composite.units.push({\n        name: unit[0].fullName,\n        label: unit[1],\n      });\n    }\n\n    return schemaJson;\n  }\n\n  /** @internal */\n  public override async toXml(schemaXml: Document): Promise<Element> {\n    const itemElement = await super.toXml(schemaXml);\n    itemElement.setAttribute(\"type\", this.type.toLowerCase());\n    itemElement.setAttribute(\"precision\", this.precision.toString());\n    itemElement.setAttribute(\"roundFactor\", this.roundFactor.toString());\n    itemElement.setAttribute(\"showSignOption\", this.showSignOption);\n    itemElement.setAttribute(\"decimalSeparator\", this.decimalSeparator);\n    itemElement.setAttribute(\"thousandSeparator\", this.thousandSeparator);\n    itemElement.setAttribute(\"uomSeparator\", this.uomSeparator);\n    itemElement.setAttribute(\"stationSeparator\", this.stationSeparator);\n\n    if (undefined !== this.minWidth)\n      itemElement.setAttribute(\"minWidth\", this.minWidth.toString());\n    if (undefined !== this.scientificType)\n      itemElement.setAttribute(\"scientificType\", this.scientificType);\n    if (undefined !== this.stationOffsetSize)\n      itemElement.setAttribute(\"stationOffsetSize\", this.stationOffsetSize.toString());\n\n    const formatTraits = formatTraitsToArray(this.formatTraits);\n    if (formatTraits.length > 0)\n      itemElement.setAttribute(\"formatTraits\", formatTraits.join(\"|\"));\n\n    if (undefined !== this.units) {\n      const compositeElement = schemaXml.createElement(\"Composite\");\n      if (undefined !== this.spacer)\n        compositeElement.setAttribute(\"spacer\", this.spacer);\n      if (undefined !== this.includeZero)\n        compositeElement.setAttribute(\"includeZero\", this.includeZero.toString());\n\n      for(const [unit, label] of this.units) {\n        const resolvedUnit = await unit;\n        const unitElement = schemaXml.createElement(\"Unit\");\n        if (undefined !== label)\n          unitElement.setAttribute(\"label\", label);\n        const unitName = XmlSerializationUtils.createXmlTypedName(this.schema, resolvedUnit.schema, resolvedUnit.name);\n        unitElement.textContent = unitName;\n        compositeElement.appendChild(unitElement);\n      };\n\n      itemElement.appendChild(compositeElement);\n    }\n\n    return itemElement;\n  }\n\n  /**\n   * @internal\n   */\n  protected setFormatType(formatType: FormatType) {\n    this._base.type = formatType;\n  }\n\n  /**\n   * @internal\n   */\n  protected setRoundFactor(roundFactor: number) {\n    this._base.roundFactor = roundFactor;\n  }\n\n  /**\n   * @internal\n   */\n  protected setShowSignOption(signOption: ShowSignOption) {\n    this._base.showSignOption = signOption;\n  }\n\n  /**\n   * @internal\n   */\n  protected setDecimalSeparator(separator: string) {\n    this._base.decimalSeparator = separator;\n  }\n\n  /**\n   * @internal\n   */\n  protected setThousandSeparator(separator: string) {\n    this._base.thousandSeparator = separator;\n  }\n\n  /**\n   * @internal\n   */\n  protected setUomSeparator(separator: string) {\n    this._base.uomSeparator = separator;\n  }\n\n  /**\n   * @internal\n   */\n  protected setStationSeparator(separator: string) {\n    this._base.stationSeparator = separator;\n  }\n\n  /**\n   * @internal\n   */\n  protected setStationOffsetSize(stationOffsetSize: number) {\n    this._base.stationOffsetSize = stationOffsetSize;\n  }\n\n  /**\n   * @internal\n   */\n  protected setScientificType(scientificType: ScientificType) {\n    this._base.scientificType = scientificType;\n  }\n\n  /**\n   * @internal\n   */\n  protected setMinWidth(minWidth: number) {\n    this._base.minWidth = minWidth;\n  }\n\n  /**\n   * @internal\n   */\n  protected setSpacer(spacer: string) {\n    this._base.spacer = spacer;\n  }\n\n  /**\n   * @internal\n   */\n  protected setIncludeZero(includeZero: boolean) {\n    this._base.includeZero = includeZero;\n  }\n\n  /**\n   * @internal\n   */\n  protected setFormatTraits(formatTraits: FormatTraits) {\n    this._base.formatTraits = formatTraits;\n  }\n\n  /**\n   * @internal\n   */\n  protected setUnits(units: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]>) {\n    this._units = units;\n  }\n\n  /** Type guard to check if the SchemaItem is of type Format.\n   * @param item The SchemaItem to check.\n   * @returns True if the item is a Format, false otherwise.\n   */\n  public static isFormat(item?: SchemaItem): item is Format {\n    if (item && item.schemaItemType === SchemaItemType.Format)\n      return true;\n\n    return false;\n  }\n\n  /**\n   * Type assertion to check if the SchemaItem is of type Format.\n   * @param item The SchemaItem to check.\n   * @returns The item cast to Format if it is a Format, undefined otherwise.\n   * @internal\n   */\n  public static assertIsFormat(item?: SchemaItem): asserts item is Format {\n    if (!this.isFormat(item))\n      throw new ECSchemaError(ECSchemaStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Format}' (Format)`);\n  }\n}\n\n/**\n * @internal\n * An abstract class used for schema editing.\n */\nexport abstract class MutableFormat extends Format {\n  public abstract override addUnit(unit: LazyLoadedUnit | LazyLoadedInvertedUnit, label?: string): void;\n  public abstract override setPrecision(precision: number): void;\n  public abstract override setFormatType(formatType: FormatType): void;\n  public abstract override setRoundFactor(roundFactor: number): void;\n  public abstract override setShowSignOption(signOption: ShowSignOption): void;\n  public abstract override setDecimalSeparator(separator: string): void;\n  public abstract override setThousandSeparator(separator: string): void;\n  public abstract override setUomSeparator(separator: string): void;\n  public abstract override setStationSeparator(separator: string): void;\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n"]}