@itwin/ecschema-metadata 3.1.0-dev.7 → 3.1.1

package/lib/cjs/UnitProvider/SchemaUnitProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaUnitProvider.js","sourceRoot":"","sources":["../../../src/UnitProvider/SchemaUnitProvider.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,sDAAkE;AAElE,wCAA2D;AAC3D,uDAAoD;AACpD,4CAAwD;AACxD,2CAAwC;AACxC,4CAA8C;AAC9C,mEAAgE;AAEhE;;;GAGG;AACH,MAAa,kBAAkB;IAI7B;;;;;;OAMG;IACH,YAAY,gBAAgC,EAAU,iBAAkC,EAAE;QAApC,mBAAc,GAAd,cAAc,CAAsB;QACxF,IAAI,gBAAgB,YAAY,uBAAa,EAAE;YAC7C,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC;SAClC;aAAM;YACL,IAAI,CAAC,QAAQ,GAAG,IAAI,uBAAa,EAAE,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;SAC5C;QACD,IAAI,CAAC,cAAc,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc,CAAC,QAAgB;QAC1C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB,CAAC,UAAkB;QAC9C,yDAAyD;QACzD,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,uBAAU,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC1E,MAAM,SAAS,GAAG,IAAI,qBAAS,CAAC,UAAU,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAExD,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,2BAAY,CAAC,4BAAa,CAAC,KAAK,EAAE,mCAAmC,EAAE,GAAG,EAAE;gBACpF,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;YAC5C,CAAC,CAAC,CAAC;SACJ;QAED,MAAM,OAAO,GAAG,IAAI,yBAAa,CAAC,cAAc,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QACpE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM;YACT,MAAM,IAAI,2BAAY,CAAC,4BAAa,CAAC,KAAK,EAAE,oCAAoC,EAAE,GAAG,EAAE;gBACrF,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;YACtD,CAAC,CAAC,CAAC;QAEL,IAAI,MAAM,CAAC,cAAc,KAAK,0BAAc,CAAC,UAAU;YACrD,MAAM,IAAI,2BAAY,CAAC,4BAAa,CAAC,KAAK,EAAE,0BAA0B,EAAE,GAAG,EAAE;gBAC3E,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YAC3C,CAAC,CAAC,CAAC;QAEL,2DAA2D;QAC3D,MAAM,aAAa,GAAqB,EAAE,CAAC;QAC3C,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;QACnD,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;QACzC,OAAO,CAAC,IAAI,EAAE;YACZ,IAAI,WAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;gBACtB,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;gBAC/C,IAAI,eAAe,IAAI,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE;oBACtE,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;oBAC5C,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;iBAC/B;aACF;YACD,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;SACxC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;OAGG;IACI,yBAAyB,CAAC,QAAgB;QAC/C,IAAI,eAAe,GAAkB,EAAE,CAAC;QACxC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,cAAc,EAAE;YACvC,IAAI,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,WAAW,EAAE,EAAE;gBACvD,eAAe,GAAG,KAAK,CAAC,gBAAgB,CAAC;aAC1C;SACF;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,QAAQ,CAAC,SAAiB,EAAE,UAAmB,EAAE,UAAmB,EAAE,UAAmB;QACpG,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;QAC1C,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACrE,MAAM,cAAc,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACzE,MAAM,cAAc,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACzE,IAAI,SAA2B,CAAC;QAEhC,IAAI;YACF,IAAI;gBACF,SAAS,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC;aACtG;YAAC,OAAO,GAAG,EAAE;gBACZ,oHAAoH;gBACpH,SAAS,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC;aACzG;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,2BAAY,CAAC,4BAAa,CAAC,KAAK,EAAE,6BAA6B,EAAE,GAAG,EAAE;gBAC9E,OAAO,EAAE,SAAS,EAAE,CAAC;YACvB,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CAAC,QAAmB,EAAE,MAAiB;QAC/D,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7F,OAAO;YACL,MAAM,EAAE,UAAU,CAAC,MAAM;YACzB,MAAM,EAAE,UAAU,CAAC,MAAM;SAC1B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,gBAAgB,CAAC,QAAgB;QAC7C,mDAAmD;QACnD,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,uBAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxE,MAAM,SAAS,GAAG,IAAI,qBAAS,CAAC,UAAU,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAExD,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,2BAAY,CAAC,4BAAa,CAAC,KAAK,EAAE,6BAA6B,EAAE,GAAG,EAAE;gBAC9E,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;YAChD,CAAC,CAAC,CAAC;SACJ;QAED,MAAM,OAAO,GAAG,IAAI,yBAAa,CAAC,cAAc,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QACpE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAO,OAAO,CAAC,CAAC;QAC9D,IAAI,CAAC,IAAI;YACP,MAAM,IAAI,2BAAY,CAAC,4BAAa,CAAC,KAAK,EAAE,8BAA8B,EAAE,GAAG,EAAE;gBAC/E,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;YACtD,CAAC,CAAC,CAAC;QAEL,IAAI,IAAI,CAAC,cAAc,KAAK,0BAAc,CAAC,IAAI;YAC7C,OAAO,IAAI,CAAC;QAEd,MAAM,IAAI,2BAAY,CAAC,4BAAa,CAAC,KAAK,EAAE,oBAAoB,EAAE,GAAG,EAAE;YACrE,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACK,aAAa,CAAC,IAAU;;QAC9B,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,QAAQ;YACnB,KAAK,EAAE,MAAA,IAAI,CAAC,KAAK,mCAAI,EAAE;YACvB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;YAC3D,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ;SACtE,CAAC;IACJ,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,sBAAsB,CAAC,YAAoB,EAAE,UAAmB,EAAE,UAAmB,EAAE,UAAmB;;QACtH,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;QACnD,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;QACzC,OAAO,CAAC,IAAI,EAAE;YACZ,IAAI,WAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAA,MAAA,KAAK,CAAC,KAAK,0CAAE,WAAW,EAAE,MAAK,YAAY,EAAE;gBACrE,MAAM,cAAc,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;gBAC9C,MAAM,cAAc,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;gBAC9C,IAAI,CAAC,UAAU,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,UAAU;oBAC/D,IAAI,CAAC,UAAU,IAAI,CAAC,cAAc,IAAI,cAAc,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;wBACnF,IAAI,CAAC,UAAU,IAAI,CAAC,cAAc,IAAI,cAAc,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;4BACnF,OAAO,KAAK,CAAC;aACpB;YACD,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;SACxC;QAED,MAAM,IAAI,2BAAY,CAAC,4BAAa,CAAC,KAAK,EAAE,qCAAqC,EAAE,GAAG,EAAE;YACtF,OAAO,EAAE,YAAY,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,yBAAyB,CAAC,eAAuB,EAAE,UAAmB,EAAE,UAAmB,EAAE,UAAmB;QAC5H,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,cAAc,EAAE;YACvC,IAAI,KAAK,CAAC,gBAAgB,IAAI,KAAK,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC/D,IAAI,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE;oBACnG,mDAAmD;oBACnD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACrD,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;oBAC9C,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;oBAC9C,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,UAAU;wBAC9D,IAAI,CAAC,UAAU,IAAI,CAAC,eAAe,IAAI,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;4BACrF,IAAI,CAAC,UAAU,IAAI,CAAC,eAAe,IAAI,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;gCACrF,OAAO,IAAI,CAAC;iBACnB;aACF;SACF;QAED,MAAM,IAAI,2BAAY,CAAC,4BAAa,CAAC,KAAK,EAAE,+CAA+C,EAAE,GAAG,EAAE;YAChG,OAAO,EAAE,eAAe,EAAE,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA5OD,gDA4OC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { BentleyError, BentleyStatus } from \"@itwin/core-bentley\";\r\nimport { UnitConversion, UnitExtraData, UnitProps, UnitsProvider } from \"@itwin/core-quantity\";\r\nimport { ISchemaLocater, SchemaContext } from \"../Context\";\r\nimport { SchemaItem } from \"../Metadata/SchemaItem\";\r\nimport { SchemaItemKey, SchemaKey } from \"../SchemaKey\";\r\nimport { Unit } from \"../Metadata/Unit\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { UnitConverter } from \"../UnitConversion/UnitConverter\";\r\n\r\n/**\r\n * Class used to find Units in SchemaContext by attributes such as Phenomenon and DisplayLabel.\r\n * @alpha\r\n */\r\nexport class SchemaUnitProvider implements UnitsProvider {\r\n  private _unitConverter: UnitConverter;\r\n  private _context: SchemaContext;\r\n\r\n  /**\r\n   *\r\n   * @param contextOrLocater The SchemaContext or a different ISchemaLocater implementation used to retrieve the schema. The SchemaContext\r\n   * class implements the ISchemaLocater interface. If the provided locater is not a SchemaContext instance a new SchemaContext will be\r\n   * created and the locater will be added.\r\n   * @param _unitExtraData Additional data like alternate display label not found in Units Schema to match with Units; Defaults to empty array.\r\n   */\r\n  constructor(contextOrLocater: ISchemaLocater, private _unitExtraData: UnitExtraData[] = []){\r\n    if (contextOrLocater instanceof SchemaContext) {\r\n      this._context = contextOrLocater;\r\n    } else {\r\n      this._context = new SchemaContext();\r\n      this._context.addLocater(contextOrLocater);\r\n    }\r\n    this._unitConverter = new UnitConverter(this._context);\r\n  }\r\n\r\n  /**\r\n   * Find unit in a schema that has unitName.\r\n   * @param unitName Full name of unit.\r\n   * @returns UnitProps interface from @itwin/core-quantity whose name matches unitName.\r\n   */\r\n  public async findUnitByName(unitName: string): Promise<UnitProps> {\r\n    const unit = await this.findECUnitByName(unitName);\r\n    return this.getUnitsProps(unit);\r\n  }\r\n\r\n  /**\r\n   * Find all units in context that belongs to given phenomenon.\r\n   * @param phenomenon Full name of phenomenon.\r\n   * @returns Array of UnitProps (from @itwin/core-quantity) interface objects whose name matches phenomenon param.\r\n   */\r\n  public async getUnitsByFamily(phenomenon: string): Promise<Array<UnitProps>> {\r\n    // Check if schema exists and phenomenon exists in schema\r\n    const [schemaName, schemaItemName] = SchemaItem.parseFullName(phenomenon);\r\n    const schemaKey = new SchemaKey(schemaName);\r\n    const schema = await this._context.getSchema(schemaKey);\r\n\r\n    if (!schema) {\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find schema for phenomenon\", () => {\r\n        return { phenomenon, schema: schemaName };\r\n      });\r\n    }\r\n\r\n    const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);\r\n    const phenom = await this._context.getSchemaItem(itemKey);\r\n    if (!phenom)\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find schema item/phenomenon\", () => {\r\n        return { item: schemaItemName, schema: schemaName };\r\n      });\r\n\r\n    if (phenom.schemaItemType !== SchemaItemType.Phenomenon)\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Item is not a phenomenon\", () => {\r\n        return { itemType: phenom.key.fullName };\r\n      });\r\n\r\n    // Find units' full name that match given phenomenon param.\r\n    const filteredUnits: Array<UnitProps> = [];\r\n    const schemaItems = this._context.getSchemaItems();\r\n    let { value, done } = schemaItems.next();\r\n    while (!done) {\r\n      if (Unit.isUnit(value)) {\r\n        const foundPhenomenon = await value.phenomenon;\r\n        if (foundPhenomenon && foundPhenomenon.key.matchesFullName(phenomenon)) {\r\n          const unitProps = this.getUnitsProps(value);\r\n          filteredUnits.push(unitProps);\r\n        }\r\n      }\r\n      ({ value, done } = schemaItems.next());\r\n    }\r\n\r\n    return filteredUnits;\r\n  }\r\n\r\n  /**\r\n   * Find alternate display labels associated with unitName, if any.\r\n   * @param unitName Full name of Unit.\r\n   */\r\n  public getAlternateDisplayLabels(unitName: string): Array<string> {\r\n    let alternateLabels: Array<string> = [];\r\n    for (const entry of this._unitExtraData) {\r\n      if (entry.name.toLowerCase() === unitName.toLowerCase()) {\r\n        alternateLabels = entry.altDisplayLabels;\r\n      }\r\n    }\r\n\r\n    return alternateLabels;\r\n  }\r\n\r\n  /**\r\n   * Finds Unit by unitLabel, which could be a display label in the schema or alternate an display label defined in\r\n   * this._unitExtraData. If there are duplicates of the same display label in the context or teh same alternate display\r\n   * labels, specify schemaName, phenomenon, or unitSystem to get a specific unit.\r\n   *\r\n   * @param unitLabel Display label or alternate display label to query unit by.\r\n   * @param schemaName Ensure Unit with unitLabel belongs to Schema with schemaName.\r\n   * @param phenomenon Full name of phenomenon that Unit belongs to.\r\n   * @param unitSystem Full name of unitSystem that Unit belongs to.\r\n   * @returns The UnitProps interface from the @itwin/core-quantity package.\r\n   */\r\n  public async findUnit(unitLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps> {\r\n    const findLabel = unitLabel.toLowerCase();\r\n    const findSchema = schemaName ? schemaName.toLowerCase() : undefined;\r\n    const findPhenomenon = phenomenon ? phenomenon.toLowerCase() : undefined;\r\n    const findUnitSystem = unitSystem ? unitSystem.toLowerCase() : undefined;\r\n    let foundUnit: Unit | undefined;\r\n\r\n    try {\r\n      try {\r\n        foundUnit = await this.findUnitByDisplayLabel(findLabel, findSchema, findPhenomenon, findUnitSystem);\r\n      } catch (err) {\r\n        // If there is no Unit with display label that matches label, then check for alternate display labels that may match\r\n        foundUnit = await this.findUnitByAltDisplayLabel(findLabel, findSchema, findPhenomenon, findUnitSystem);\r\n      }\r\n    } catch (err) {\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find unit with label\", () => {\r\n        return { unitLabel };\r\n      });\r\n    }\r\n\r\n    return this.getUnitsProps(foundUnit);\r\n  }\r\n\r\n  /**\r\n   * Gets the @itwin/core-quantity UnitConversion for the given fromUnit and toUnit.\r\n   * @param fromUnit The UnitProps of the 'from' unit.\r\n   * @param toUnit The UnitProps of the 'to' unit.\r\n   * @returns The UnitConversion interface from the @itwin/core-quantity package.\r\n   */\r\n  public async getConversion(fromUnit: UnitProps, toUnit: UnitProps): Promise<UnitConversion> {\r\n    const conversion = await this._unitConverter.calculateConversion(fromUnit.name, toUnit.name);\r\n    return {\r\n      factor: conversion.factor,\r\n      offset: conversion.offset,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Find unit in a schema that has unitName.\r\n   * @param unitName Full name of unit.\r\n   * @returns Unit whose full name matches unitName.\r\n   */\r\n  private async findECUnitByName(unitName: string): Promise<Unit> {\r\n    // Check if schema exists and unit exists in schema\r\n    const [schemaName, schemaItemName] = SchemaItem.parseFullName(unitName);\r\n    const schemaKey = new SchemaKey(schemaName);\r\n    const schema = await this._context.getSchema(schemaKey);\r\n\r\n    if (!schema) {\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find schema for unit\", () => {\r\n        return { schema: schemaName, unit: unitName };\r\n      });\r\n    }\r\n\r\n    const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);\r\n    const item = await this._context.getSchemaItem<Unit>(itemKey);\r\n    if (!item)\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find schema item/unit\", () => {\r\n        return { item: schemaItemName, schema: schemaName };\r\n      });\r\n\r\n    if (item.schemaItemType === SchemaItemType.Unit)\r\n      return item;\r\n\r\n    throw new BentleyError(BentleyStatus.ERROR, \"Item is not a unit\", () => {\r\n      return { itemType: item.key.fullName };\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Gets the @itwin/core UnitProps for the given Unit.\r\n   * @param unit The Unit to convert.\r\n   * @returns UnitProps interface from @itwin/core.\r\n   */\r\n  private getUnitsProps(unit: Unit): UnitProps {\r\n    return {\r\n      name: unit.fullName,\r\n      label: unit.label ?? \"\",\r\n      phenomenon: unit.phenomenon ? unit.phenomenon.fullName : \"\",\r\n      isValid: true,\r\n      system: unit.unitSystem === undefined ? \"\" : unit.unitSystem.fullName,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Finds Unit by displayLabel and that it belongs to schemaName, phenomenon, and unitSystem if defined.\r\n   * @internal\r\n   */\r\n  private async findUnitByDisplayLabel(displayLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<Unit> {\r\n    const schemaItems = this._context.getSchemaItems();\r\n    let { value, done } = schemaItems.next();\r\n    while (!done) {\r\n      if (Unit.isUnit(value) && value.label?.toLowerCase() === displayLabel) {\r\n        const currPhenomenon = await value.phenomenon;\r\n        const currUnitSystem = await value.unitSystem;\r\n        if (!schemaName || value.schema.name.toLowerCase() === schemaName)\r\n          if (!phenomenon || (currPhenomenon && currPhenomenon.key.matchesFullName(phenomenon)))\r\n            if (!unitSystem || (currUnitSystem && currUnitSystem.key.matchesFullName(unitSystem)))\r\n              return value;\r\n      }\r\n      ({ value, done } = schemaItems.next());\r\n    }\r\n\r\n    throw new BentleyError(BentleyStatus.ERROR, \"Cannot find unit with display label\", () => {\r\n      return { displayLabel };\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Finds Unit by altDisplayLabel and that it belongs to schemaName, phenomenon, and unitSystem if defined.\r\n   * @internal\r\n   */\r\n  private async findUnitByAltDisplayLabel(altDisplayLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<Unit> {\r\n    for (const entry of this._unitExtraData) {\r\n      if (entry.altDisplayLabels && entry.altDisplayLabels.length > 0) {\r\n        if (entry.altDisplayLabels.findIndex((ref: string) => ref.toLowerCase() === altDisplayLabel) !== -1) {\r\n          // Found altDisplayLabel that matches label to find\r\n          const unit = await this.findECUnitByName(entry.name);\r\n          const foundPhenomenon = await unit.phenomenon;\r\n          const foundUnitSystem = await unit.unitSystem;\r\n          if (!schemaName || unit.schema.name.toLowerCase() === schemaName)\r\n            if (!phenomenon || (foundPhenomenon && foundPhenomenon.key.matchesFullName(phenomenon)))\r\n              if (!unitSystem || (foundUnitSystem && foundUnitSystem.key.matchesFullName(unitSystem)))\r\n                return unit;\r\n        }\r\n      }\r\n    }\r\n\r\n    throw new BentleyError(BentleyStatus.ERROR, \"Cannot find unit with alternate display label\", () => {\r\n      return { altDisplayLabel };\r\n    });\r\n  }\r\n}\r\n"]}

package/lib/cjs/ecschema-metadata.d.ts

@@ -29,7 +29,9 @@ export { Unit } from "./Metadata/Unit";
 export { UnitSystem } from "./Metadata/UnitSystem";
 export * from "./PropertyTypes";
 export * from "./SchemaKey";
-export * from "./utils/FormatEnums";
+export * from "./UnitConversion/UnitConversion";
+export * from "./UnitConversion/UnitConverter";
+export * from "./UnitProvider/SchemaUnitProvider";
 export * from "./Validation/SchemaWalker";
 export * from "./SchemaPartVisitorDelegate";
 export { CustomAttribute, CustomAttributeContainerProps } from "./Metadata/CustomAttribute";

package/lib/cjs/ecschema-metadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ecschema-metadata.d.ts","sourceRoot":"","sources":["../../src/ecschema-metadata.ts"],"names":[],"mappings":"AAKA,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,kBAAkB,CAAC;AACjC,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EACL,QAAQ,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,cAAc,EACxF,mBAAmB,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,sBAAsB,EAC3G,oBAAoB,EAAE,WAAW,EAAE,iBAAiB,EAAE,aAAa,EAAE,2BAA2B,GACjG,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AACnH,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,6BAA6B,EAAC,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD;;GAEG;AACH;;;GAGG;AACH;;;GAGG"}
+{"version":3,"file":"ecschema-metadata.d.ts","sourceRoot":"","sources":["../../src/ecschema-metadata.ts"],"names":[],"mappings":"AAKA,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,kBAAkB,CAAC;AACjC,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EACL,QAAQ,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,cAAc,EACxF,mBAAmB,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,sBAAsB,EAC3G,oBAAoB,EAAE,WAAW,EAAE,iBAAiB,EAAE,aAAa,EAAE,2BAA2B,GACjG,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AACnH,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,6BAA6B,EAAC,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD;;GAEG;AACH;;;GAGG;AACH;;;GAGG"}

package/lib/cjs/ecschema-metadata.js

@@ -74,7 +74,9 @@ var UnitSystem_1 = require("./Metadata/UnitSystem");
 Object.defineProperty(exports, "UnitSystem", { enumerable: true, get: function () { return UnitSystem_1.UnitSystem; } });
 __exportStar(require("./PropertyTypes"), exports);
 __exportStar(require("./SchemaKey"), exports);
-__exportStar(require("./utils/FormatEnums"), exports);
+__exportStar(require("./UnitConversion/UnitConversion"), exports);
+__exportStar(require("./UnitConversion/UnitConverter"), exports);
+__exportStar(require("./UnitProvider/SchemaUnitProvider"), exports);
 __exportStar(require("./Validation/SchemaWalker"), exports);
 __exportStar(require("./SchemaPartVisitorDelegate"), exports);
 var SchemaGraph_1 = require("./utils/SchemaGraph");

package/lib/cjs/ecschema-metadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"ecschema-metadata.js","sourceRoot":"","sources":["../../src/ecschema-metadata.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;;AAE/F,8CAA4B;AAC5B,4CAA0B;AAC1B,mDAAiC;AACjC,oEAAkD;AAClD,8DAA4C;AAC5C,2DAAyC;AACzC,8DAA4C;AAC5C,2CAAyB;AACzB,8CAA4B;AAC5B,8CAA4B;AAC5B,+CAA6B;AAC7B,0CAAwD;AAA/C,gGAAA,OAAO,OAAA;AAAE,oGAAA,WAAW,OAAA;AAC7B,gDAA+C;AAAtC,oGAAA,QAAQ,OAAA;AACjB,wEAAuE;AAA9D,4HAAA,oBAAoB,OAAA;AAC7B,sDAAqD;AAA5C,0GAAA,WAAW,OAAA;AACpB,sDAAgF;AAAxD,0GAAA,WAAW,OAAA;AACnC,4CAA2C;AAAlC,gGAAA,MAAM,OAAA;AACf,wDAAuD;AAA9C,4GAAA,YAAY,OAAA;AACrB,4DAA2D;AAAlD,gHAAA,cAAc,OAAA;AACvB,0CAAyC;AAAhC,8FAAA,KAAK,OAAA;AACd,4DAA0C;AAC1C,oDAAmD;AAA1C,wGAAA,UAAU,OAAA;AACnB,gDAI6B;AAH3B,oGAAA,QAAQ,OAAA;AAAE,6GAAA,iBAAiB,OAAA;AAAE,kHAAA,sBAAsB,OAAA;AAAE,+GAAA,mBAAmB,OAAA;AAAE,0GAAA,cAAc,OAAA;AACxF,+GAAA,mBAAmB,OAAA;AAAE,oHAAA,wBAAwB,OAAA;AAAE,8GAAA,kBAAkB,OAAA;AACX,yGAAA,aAAa,OAAA;AAAE,uHAAA,2BAA2B,OAAA;AAElG,gEAA+D;AAAtD,oHAAA,gBAAgB,OAAA;AACzB,kEAAmH;AAA1G,sHAAA,iBAAiB,OAAA;AAAE,2HAAA,sBAAsB,OAAA;AAAE,6HAAA,wBAAwB,OAAA;AAC5E,4CAA2C;AAAlC,gGAAA,MAAM,OAAA;AACf,wDAAsC;AACtC,wCAAuC;AAA9B,4FAAA,IAAI,OAAA;AACb,oDAAmD;AAA1C,wGAAA,UAAU,OAAA;AACnB,kDAAgC;AAChC,8CAA4B;AAC5B,sDAAoC;AACpC,4DAA0C;AAC1C,8DAA4C;AAE5C,mDAAkD;AAAzC,0GAAA,WAAW,OAAA;AAEpB;;GAEG;AACH;;;GAGG;AACH;;;GAGG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nexport * from \"./Constants\";\r\nexport * from \"./Context\";\r\nexport * from \"./DelayedPromise\";\r\nexport * from \"./Deserialization/SchemaGraphUtil\";\r\nexport * from \"./Deserialization/JsonProps\";\r\nexport * from \"./Deserialization/Helper\";\r\nexport * from \"./Deserialization/XmlParser\";\r\nexport * from \"./ECName\";\r\nexport * from \"./ECObjects\";\r\nexport * from \"./Exception\";\r\nexport * from \"./Interfaces\";\r\nexport { ECClass, StructClass } from \"./Metadata/Class\";\r\nexport { Constant } from \"./Metadata/Constant\";\r\nexport { CustomAttributeClass } from \"./Metadata/CustomAttributeClass\";\r\nexport { EntityClass } from \"./Metadata/EntityClass\";\r\nexport { AnyEnumerator, Enumeration, Enumerator } from \"./Metadata/Enumeration\";\r\nexport { Format } from \"./Metadata/Format\";\r\nexport { InvertedUnit } from \"./Metadata/InvertedUnit\";\r\nexport { KindOfQuantity } from \"./Metadata/KindOfQuantity\";\r\nexport { Mixin } from \"./Metadata/Mixin\";\r\nexport * from \"./Metadata/OverrideFormat\";\r\nexport { Phenomenon } from \"./Metadata/Phenomenon\";\r\nexport {\r\n  Property, PrimitiveProperty, PrimitiveArrayProperty, EnumerationProperty, StructProperty,\r\n  StructArrayProperty, EnumerationArrayProperty, NavigationProperty, AnyArrayProperty, AnyEnumerationProperty,\r\n  AnyPrimitiveProperty, AnyProperty, AnyStructProperty, ArrayProperty, PrimitiveOrEnumPropertyBase,\r\n} from \"./Metadata/Property\";\r\nexport { PropertyCategory } from \"./Metadata/PropertyCategory\";\r\nexport { RelationshipClass, RelationshipConstraint, RelationshipMultiplicity } from \"./Metadata/RelationshipClass\";\r\nexport { Schema } from \"./Metadata/Schema\";\r\nexport * from \"./Metadata/SchemaItem\";\r\nexport { Unit } from \"./Metadata/Unit\";\r\nexport { UnitSystem } from \"./Metadata/UnitSystem\";\r\nexport * from \"./PropertyTypes\";\r\nexport * from \"./SchemaKey\";\r\nexport * from \"./utils/FormatEnums\";\r\nexport * from \"./Validation/SchemaWalker\";\r\nexport * from \"./SchemaPartVisitorDelegate\";\r\nexport { CustomAttribute, CustomAttributeContainerProps} from \"./Metadata/CustomAttribute\";\r\nexport { SchemaGraph } from \"./utils/SchemaGraph\";\r\n\r\n/** @docs-package-description\r\n * The ecschema-metadata package contains classes for working with ECSchemas that can be used in both [frontend]($docs/learning/frontend/index.md) and [backend]($docs/learning/backend/index.md).\r\n */\r\n/**\r\n * @docs-group-description Metadata\r\n * Definitions of classes and interfaces that represent all [EC elements]($docs/bis/ec/index.md).\r\n */\r\n/**\r\n * @docs-group-description Utils\r\n * A set of utility classes used throughout the package.\r\n */\r\n"]}
+{"version":3,"file":"ecschema-metadata.js","sourceRoot":"","sources":["../../src/ecschema-metadata.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;;AAE/F,8CAA4B;AAC5B,4CAA0B;AAC1B,mDAAiC;AACjC,oEAAkD;AAClD,8DAA4C;AAC5C,2DAAyC;AACzC,8DAA4C;AAC5C,2CAAyB;AACzB,8CAA4B;AAC5B,8CAA4B;AAC5B,+CAA6B;AAC7B,0CAAwD;AAA/C,gGAAA,OAAO,OAAA;AAAE,oGAAA,WAAW,OAAA;AAC7B,gDAA+C;AAAtC,oGAAA,QAAQ,OAAA;AACjB,wEAAuE;AAA9D,4HAAA,oBAAoB,OAAA;AAC7B,sDAAqD;AAA5C,0GAAA,WAAW,OAAA;AACpB,sDAAgF;AAAxD,0GAAA,WAAW,OAAA;AACnC,4CAA2C;AAAlC,gGAAA,MAAM,OAAA;AACf,wDAAuD;AAA9C,4GAAA,YAAY,OAAA;AACrB,4DAA2D;AAAlD,gHAAA,cAAc,OAAA;AACvB,0CAAyC;AAAhC,8FAAA,KAAK,OAAA;AACd,4DAA0C;AAC1C,oDAAmD;AAA1C,wGAAA,UAAU,OAAA;AACnB,gDAI6B;AAH3B,oGAAA,QAAQ,OAAA;AAAE,6GAAA,iBAAiB,OAAA;AAAE,kHAAA,sBAAsB,OAAA;AAAE,+GAAA,mBAAmB,OAAA;AAAE,0GAAA,cAAc,OAAA;AACxF,+GAAA,mBAAmB,OAAA;AAAE,oHAAA,wBAAwB,OAAA;AAAE,8GAAA,kBAAkB,OAAA;AACX,yGAAA,aAAa,OAAA;AAAE,uHAAA,2BAA2B,OAAA;AAElG,gEAA+D;AAAtD,oHAAA,gBAAgB,OAAA;AACzB,kEAAmH;AAA1G,sHAAA,iBAAiB,OAAA;AAAE,2HAAA,sBAAsB,OAAA;AAAE,6HAAA,wBAAwB,OAAA;AAC5E,4CAA2C;AAAlC,gGAAA,MAAM,OAAA;AACf,wDAAsC;AACtC,wCAAuC;AAA9B,4FAAA,IAAI,OAAA;AACb,oDAAmD;AAA1C,wGAAA,UAAU,OAAA;AACnB,kDAAgC;AAChC,8CAA4B;AAC5B,kEAAgD;AAChD,iEAA+C;AAC/C,oEAAkD;AAClD,4DAA0C;AAC1C,8DAA4C;AAE5C,mDAAkD;AAAzC,0GAAA,WAAW,OAAA;AAEpB;;GAEG;AACH;;;GAGG;AACH;;;GAGG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nexport * from \"./Constants\";\r\nexport * from \"./Context\";\r\nexport * from \"./DelayedPromise\";\r\nexport * from \"./Deserialization/SchemaGraphUtil\";\r\nexport * from \"./Deserialization/JsonProps\";\r\nexport * from \"./Deserialization/Helper\";\r\nexport * from \"./Deserialization/XmlParser\";\r\nexport * from \"./ECName\";\r\nexport * from \"./ECObjects\";\r\nexport * from \"./Exception\";\r\nexport * from \"./Interfaces\";\r\nexport { ECClass, StructClass } from \"./Metadata/Class\";\r\nexport { Constant } from \"./Metadata/Constant\";\r\nexport { CustomAttributeClass } from \"./Metadata/CustomAttributeClass\";\r\nexport { EntityClass } from \"./Metadata/EntityClass\";\r\nexport { AnyEnumerator, Enumeration, Enumerator } from \"./Metadata/Enumeration\";\r\nexport { Format } from \"./Metadata/Format\";\r\nexport { InvertedUnit } from \"./Metadata/InvertedUnit\";\r\nexport { KindOfQuantity } from \"./Metadata/KindOfQuantity\";\r\nexport { Mixin } from \"./Metadata/Mixin\";\r\nexport * from \"./Metadata/OverrideFormat\";\r\nexport { Phenomenon } from \"./Metadata/Phenomenon\";\r\nexport {\r\n  Property, PrimitiveProperty, PrimitiveArrayProperty, EnumerationProperty, StructProperty,\r\n  StructArrayProperty, EnumerationArrayProperty, NavigationProperty, AnyArrayProperty, AnyEnumerationProperty,\r\n  AnyPrimitiveProperty, AnyProperty, AnyStructProperty, ArrayProperty, PrimitiveOrEnumPropertyBase,\r\n} from \"./Metadata/Property\";\r\nexport { PropertyCategory } from \"./Metadata/PropertyCategory\";\r\nexport { RelationshipClass, RelationshipConstraint, RelationshipMultiplicity } from \"./Metadata/RelationshipClass\";\r\nexport { Schema } from \"./Metadata/Schema\";\r\nexport * from \"./Metadata/SchemaItem\";\r\nexport { Unit } from \"./Metadata/Unit\";\r\nexport { UnitSystem } from \"./Metadata/UnitSystem\";\r\nexport * from \"./PropertyTypes\";\r\nexport * from \"./SchemaKey\";\r\nexport * from \"./UnitConversion/UnitConversion\";\r\nexport * from \"./UnitConversion/UnitConverter\";\r\nexport * from \"./UnitProvider/SchemaUnitProvider\";\r\nexport * from \"./Validation/SchemaWalker\";\r\nexport * from \"./SchemaPartVisitorDelegate\";\r\nexport { CustomAttribute, CustomAttributeContainerProps} from \"./Metadata/CustomAttribute\";\r\nexport { SchemaGraph } from \"./utils/SchemaGraph\";\r\n\r\n/** @docs-package-description\r\n * The ecschema-metadata package contains classes for working with ECSchemas that can be used in both [frontend]($docs/learning/frontend/index.md) and [backend]($docs/learning/backend/index.md).\r\n */\r\n/**\r\n * @docs-group-description Metadata\r\n * Definitions of classes and interfaces that represent all [EC elements]($docs/bis/ec/index.md).\r\n */\r\n/**\r\n * @docs-group-description Utils\r\n * A set of utility classes used throughout the package.\r\n */\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/ecschema-metadata",
-  "version": "3.1.0-dev.7",
+  "version": "3.1.1",
   "description": "ECObjects core concepts in typescript",
   "license": "MIT",
   "main": "lib/cjs/ecschema-metadata.js",
@@ -23,9 +23,10 @@
   },
   "devDependencies": {
     "@bentley/units-schema": "^1.0.5",
-    "@itwin/build-tools": "3.1.0-dev.7",
-    "@itwin/core-bentley": "3.1.0-dev.7",
-    "@itwin/eslint-plugin": "3.1.0-dev.7",
+    "@itwin/build-tools": "3.1.1",
+    "@itwin/core-bentley": "3.1.1",
+    "@itwin/core-quantity": "3.1.1",
+    "@itwin/eslint-plugin": "3.1.1",
     "@types/almost-equal": "1.1.0",
     "@types/benchmark": "^2.1.0",
     "@types/chai": "^4.1.4",
@@ -46,7 +47,8 @@
     "typescript": "~4.4.0"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "^3.1.0-dev.7"
+    "@itwin/core-bentley": "^3.1.1",
+    "@itwin/core-quantity": "^3.1.1"
   },
   "dependencies": {
     "almost-equal": "^1.1.0"

package/lib/cjs/utils/FormatEnums.d.ts

@@ -1,106 +0,0 @@
-/** @packageDocumentation
- * @module Metadata
- */
-/** The regular expression to parse [format strings]($docs/bis/ec/kindofquantity.md#format-string)
- * provided in serialized formats as well as the full name of an [[OverrideFormat]].
- *
- * `formatName(precision)[unitName|unitLabel][unitName|unitLabel][unitName|unitLabel][unitName|unitLabel]`
- *
- * Explanation of the regex:
- * - ([\w.:]+)
- *   - Grabs the format full name
- * - (\(([^\)]+)\))?
- *   - Grabs the precision part with and without the `()`.
- *   - The parentheses are needed to validate the entire string.  (TODO: Need to check if this is true)
- * - (\[([^\|\]]+)([\|])?([^\]]+)?\])?
- *   - 4 of these make up the rest of the regex, none of them are required so each end in `?`
- *   - Grabs the unit name and label including the `[]`
- *   - Grabs the unit name, `|` and label separately
- * @internal
- */
-export declare const formatStringRgx: RegExp;
-/** @internal Needs to be moved to quantity */
-export declare function getItemNamesFromFormatString(formatString: string): Iterable<string>;
-/** @beta Needs to be moved to quantity  */
-export declare enum FormatTraits {
-    TrailZeroes = 1,
-    KeepSingleZero = 2,
-    ZeroEmpty = 4,
-    KeepDecimalPoint = 8,
-    ApplyRounding = 16,
-    FractionDash = 32,
-    ShowUnitLabel = 64,
-    PrependUnitLabel = 128,
-    Use1000Separator = 256,
-    ExponentOnlyNegative = 512
-}
-/** @beta Needs to be moved to quantity  */
-export declare enum FractionalPrecision {
-    One = 1,
-    Two = 2,
-    Four = 4,
-    Eight = 8,
-    Sixteen = 16,
-    ThirtyTwo = 32,
-    SixtyFour = 64,
-    OneHundredTwentyEight = 128,
-    TwoHundredFiftySix = 256
-}
-/** @beta Needs to be moved to quantity  */
-export declare enum DecimalPrecision {
-    Zero = 0,
-    One = 1,
-    Two = 2,
-    Three = 3,
-    Four = 4,
-    Five = 5,
-    Six = 6,
-    Seven = 7,
-    Eight = 8,
-    Nine = 9,
-    Ten = 10,
-    Eleven = 11,
-    Twelve = 12
-}
-/** @beta Needs to be moved to quantity  */
-export declare enum FormatType {
-    Decimal = 0,
-    Fractional = 1,
-    Scientific = 2,
-    Station = 3
-}
-/** @beta Needs to be moved to quantity  */
-export declare enum ScientificType {
-    Normalized = 0,
-    ZeroNormalized = 1
-}
-/** @beta Needs to be moved to quantity  */
-export declare enum ShowSignOption {
-    NoSign = 0,
-    OnlyNegative = 1,
-    SignAlways = 2,
-    NegativeParentheses = 3
-}
-/** @internal Needs to be moved to quantity  */
-export declare function parseScientificType(scientificType: string): ScientificType | undefined;
-/** @internal Needs to be moved to quantity  */
-export declare function scientificTypeToString(scientificType: ScientificType): string;
-/** @internal Needs to be moved to quantity  */
-export declare function parseShowSignOption(showSignOption: string): ShowSignOption | undefined;
-/** @internal Needs to be moved to quantity  */
-export declare function showSignOptionToString(showSign: ShowSignOption): string;
-/** @internal Needs to be moved to quantity  */
-export declare function parseFormatTrait(formatTraitsString: string): FormatTraits | undefined;
-/** @internal Needs to be moved to quantity  */
-export declare function formatTraitsToArray(currentFormatTrait: FormatTraits): string[];
-/** @internal Needs to be moved to quantity  */
-export declare function parseFormatType(jsonObjType: string): FormatType | undefined;
-/** @internal Needs to be moved to quantity  */
-export declare function formatTypeToString(type: FormatType): string;
-/** @internal Needs to be moved to quantity  */
-export declare function parseDecimalPrecision(jsonObjPrecision: number): DecimalPrecision | undefined;
-/** @internal Needs to be moved to quantity  */
-export declare function parseFractionalPrecision(jsonObjPrecision: number): FractionalPrecision | undefined;
-/** @internal Needs to be moved to quantity  */
-export declare function parsePrecision(precision: number, type: FormatType): DecimalPrecision | FractionalPrecision | undefined;
-//# sourceMappingURL=FormatEnums.d.ts.map

package/lib/cjs/utils/FormatEnums.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FormatEnums.d.ts","sourceRoot":"","sources":["../../../src/utils/FormatEnums.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,eAAe,QAAiK,CAAC;AAE9L,8CAA8C;AAC9C,wBAAiB,4BAA4B,CAAC,YAAY,EAAE,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAWpF;AAED,2CAA2C;AAC3C,oBAAY,YAAY;IAEtB,WAAW,IAAO;IAClB,cAAc,IAAM;IACpB,SAAS,IAAM;IACf,gBAAgB,IAAM;IACtB,aAAa,KAAO;IACpB,YAAY,KAAO;IACnB,aAAa,KAAO;IACpB,gBAAgB,MAAO;IACvB,gBAAgB,MAAQ;IACxB,oBAAoB,MAAQ;CAC7B;AAED,2CAA2C;AAC3C,oBAAY,mBAAmB;IAC7B,GAAG,IAAI;IACP,GAAG,IAAI;IACP,IAAI,IAAI;IACR,KAAK,IAAI;IACT,OAAO,KAAK;IACZ,SAAS,KAAK;IACd,SAAS,KAAK;IACd,qBAAqB,MAAM;IAC3B,kBAAkB,MAAM;CACzB;AAED,2CAA2C;AAC3C,oBAAY,gBAAgB;IAC1B,IAAI,IAAI;IACR,GAAG,IAAI;IACP,GAAG,IAAI;IACP,KAAK,IAAI;IACT,IAAI,IAAI;IACR,IAAI,IAAI;IACR,GAAG,IAAI;IACP,KAAK,IAAI;IACT,KAAK,IAAI;IACT,IAAI,IAAI;IACR,GAAG,KAAK;IACR,MAAM,KAAK;IACX,MAAM,KAAK;CACZ;AAED,2CAA2C;AAC3C,oBAAY,UAAU;IACpB,OAAO,IAAA;IACP,UAAU,IAAA;IACV,UAAU,IAAA;IACV,OAAO,IAAA;CACR;AAED,2CAA2C;AAC3C,oBAAY,cAAc;IACxB,UAAU,IAAA;IACV,cAAc,IAAA;CACf;AAED,2CAA2C;AAC3C,oBAAY,cAAc;IACxB,MAAM,IAAA;IACN,YAAY,IAAA;IACZ,UAAU,IAAA;IACV,mBAAmB,IAAA;CACpB;AAID,+CAA+C;AAC/C,wBAAgB,mBAAmB,CAAC,cAAc,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAOtF;AAED,+CAA+C;AAC/C,wBAAgB,sBAAsB,CAAC,cAAc,EAAE,cAAc,GAAG,MAAM,CAE7E;AAED,+CAA+C;AAC/C,wBAAgB,mBAAmB,CAAC,cAAc,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAStF;AAED,+CAA+C;AAC/C,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,cAAc,GAAG,MAAM,CAOvE;AAED,+CAA+C;AAC/C,wBAAgB,gBAAgB,CAAC,kBAAkB,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAcrF;AAED,+CAA+C;AAC/C,wBAAgB,mBAAmB,CAAC,kBAAkB,EAAE,YAAY,GAAG,MAAM,EAAE,CAuB9E;AAED,+CAA+C;AAC/C,wBAAgB,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAS3E;AAED,+CAA+C;AAC/C,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAO3D;AAED,+CAA+C;AAC/C,wBAAgB,qBAAqB,CAAC,gBAAgB,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAkB5F;AAED,+CAA+C;AAC/C,wBAAgB,wBAAwB,CAAC,gBAAgB,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS,CAclG;AAED,+CAA+C;AAC/C,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,gBAAgB,GAAG,mBAAmB,GAAG,SAAS,CAWtH"}

package/lib/cjs/utils/FormatEnums.js

@@ -1,265 +0,0 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Metadata
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parsePrecision = exports.parseFractionalPrecision = exports.parseDecimalPrecision = exports.formatTypeToString = exports.parseFormatType = exports.formatTraitsToArray = exports.parseFormatTrait = exports.showSignOptionToString = exports.parseShowSignOption = exports.scientificTypeToString = exports.parseScientificType = exports.ShowSignOption = exports.ScientificType = exports.FormatType = exports.DecimalPrecision = exports.FractionalPrecision = exports.FormatTraits = exports.getItemNamesFromFormatString = exports.formatStringRgx = void 0;
-/** The regular expression to parse [format strings]($docs/bis/ec/kindofquantity.md#format-string)
- * provided in serialized formats as well as the full name of an [[OverrideFormat]].
- *
- * `formatName(precision)[unitName|unitLabel][unitName|unitLabel][unitName|unitLabel][unitName|unitLabel]`
- *
- * Explanation of the regex:
- * - ([\w.:]+)
- *   - Grabs the format full name
- * - (\(([^\)]+)\))?
- *   - Grabs the precision part with and without the `()`.
- *   - The parentheses are needed to validate the entire string.  (TODO: Need to check if this is true)
- * - (\[([^\|\]]+)([\|])?([^\]]+)?\])?
- *   - 4 of these make up the rest of the regex, none of them are required so each end in `?`
- *   - Grabs the unit name and label including the `[]`
- *   - Grabs the unit name, `|` and label separately
- * @internal
- */
-exports.formatStringRgx = /([\w.:]+)(\(([^\)]+)\))?(\[([^\|\]]+)([\|])?([^\]]+)?\])?(\[([^\|\]]+)([\|])?([^\]]+)?\])?(\[([^\|\]]+)([\|])?([^\]]+)?\])?(\[([^\|\]]+)([\|])?([^\]]+)?\])?/;
-/** @internal Needs to be moved to quantity */
-function* getItemNamesFromFormatString(formatString) {
-    const match = formatString.split(exports.formatStringRgx);
-    yield match[1]; // the Format Name
-    let index = 4;
-    while (index < match.length - 1) { // index 0 and 21 are empty strings
-        if (match[index] !== undefined)
-            yield match[index + 1]; // Unit Name
-        else
-            break;
-        index += 4;
-    }
-}
-exports.getItemNamesFromFormatString = getItemNamesFromFormatString;
-/** @beta Needs to be moved to quantity  */
-var FormatTraits;
-(function (FormatTraits) {
-    // the leading + opts TypeScript out of inferring a union enum
-    FormatTraits[FormatTraits["TrailZeroes"] = 1] = "TrailZeroes";
-    FormatTraits[FormatTraits["KeepSingleZero"] = 2] = "KeepSingleZero";
-    FormatTraits[FormatTraits["ZeroEmpty"] = 4] = "ZeroEmpty";
-    FormatTraits[FormatTraits["KeepDecimalPoint"] = 8] = "KeepDecimalPoint";
-    FormatTraits[FormatTraits["ApplyRounding"] = 16] = "ApplyRounding";
-    FormatTraits[FormatTraits["FractionDash"] = 32] = "FractionDash";
-    FormatTraits[FormatTraits["ShowUnitLabel"] = 64] = "ShowUnitLabel";
-    FormatTraits[FormatTraits["PrependUnitLabel"] = 128] = "PrependUnitLabel";
-    FormatTraits[FormatTraits["Use1000Separator"] = 256] = "Use1000Separator";
-    FormatTraits[FormatTraits["ExponentOnlyNegative"] = 512] = "ExponentOnlyNegative";
-})(FormatTraits = exports.FormatTraits || (exports.FormatTraits = {}));
-/** @beta Needs to be moved to quantity  */
-var FractionalPrecision;
-(function (FractionalPrecision) {
-    FractionalPrecision[FractionalPrecision["One"] = 1] = "One";
-    FractionalPrecision[FractionalPrecision["Two"] = 2] = "Two";
-    FractionalPrecision[FractionalPrecision["Four"] = 4] = "Four";
-    FractionalPrecision[FractionalPrecision["Eight"] = 8] = "Eight";
-    FractionalPrecision[FractionalPrecision["Sixteen"] = 16] = "Sixteen";
-    FractionalPrecision[FractionalPrecision["ThirtyTwo"] = 32] = "ThirtyTwo";
-    FractionalPrecision[FractionalPrecision["SixtyFour"] = 64] = "SixtyFour";
-    FractionalPrecision[FractionalPrecision["OneHundredTwentyEight"] = 128] = "OneHundredTwentyEight";
-    FractionalPrecision[FractionalPrecision["TwoHundredFiftySix"] = 256] = "TwoHundredFiftySix";
-})(FractionalPrecision = exports.FractionalPrecision || (exports.FractionalPrecision = {}));
-/** @beta Needs to be moved to quantity  */
-var DecimalPrecision;
-(function (DecimalPrecision) {
-    DecimalPrecision[DecimalPrecision["Zero"] = 0] = "Zero";
-    DecimalPrecision[DecimalPrecision["One"] = 1] = "One";
-    DecimalPrecision[DecimalPrecision["Two"] = 2] = "Two";
-    DecimalPrecision[DecimalPrecision["Three"] = 3] = "Three";
-    DecimalPrecision[DecimalPrecision["Four"] = 4] = "Four";
-    DecimalPrecision[DecimalPrecision["Five"] = 5] = "Five";
-    DecimalPrecision[DecimalPrecision["Six"] = 6] = "Six";
-    DecimalPrecision[DecimalPrecision["Seven"] = 7] = "Seven";
-    DecimalPrecision[DecimalPrecision["Eight"] = 8] = "Eight";
-    DecimalPrecision[DecimalPrecision["Nine"] = 9] = "Nine";
-    DecimalPrecision[DecimalPrecision["Ten"] = 10] = "Ten";
-    DecimalPrecision[DecimalPrecision["Eleven"] = 11] = "Eleven";
-    DecimalPrecision[DecimalPrecision["Twelve"] = 12] = "Twelve";
-})(DecimalPrecision = exports.DecimalPrecision || (exports.DecimalPrecision = {}));
-/** @beta Needs to be moved to quantity  */
-var FormatType;
-(function (FormatType) {
-    FormatType[FormatType["Decimal"] = 0] = "Decimal";
-    FormatType[FormatType["Fractional"] = 1] = "Fractional";
-    FormatType[FormatType["Scientific"] = 2] = "Scientific";
-    FormatType[FormatType["Station"] = 3] = "Station";
-})(FormatType = exports.FormatType || (exports.FormatType = {}));
-/** @beta Needs to be moved to quantity  */
-var ScientificType;
-(function (ScientificType) {
-    ScientificType[ScientificType["Normalized"] = 0] = "Normalized";
-    ScientificType[ScientificType["ZeroNormalized"] = 1] = "ZeroNormalized";
-})(ScientificType = exports.ScientificType || (exports.ScientificType = {}));
-/** @beta Needs to be moved to quantity  */
-var ShowSignOption;
-(function (ShowSignOption) {
-    ShowSignOption[ShowSignOption["NoSign"] = 0] = "NoSign";
-    ShowSignOption[ShowSignOption["OnlyNegative"] = 1] = "OnlyNegative";
-    ShowSignOption[ShowSignOption["SignAlways"] = 2] = "SignAlways";
-    ShowSignOption[ShowSignOption["NegativeParentheses"] = 3] = "NegativeParentheses";
-})(ShowSignOption = exports.ShowSignOption || (exports.ShowSignOption = {}));
-// parse and toString methods
-/** @internal Needs to be moved to quantity  */
-function parseScientificType(scientificType) {
-    switch (scientificType.toLowerCase()) {
-        case "normalized": return ScientificType.Normalized;
-        case "zeronormalized": return ScientificType.ZeroNormalized;
-        default:
-            return undefined;
-    }
-}
-exports.parseScientificType = parseScientificType;
-/** @internal Needs to be moved to quantity  */
-function scientificTypeToString(scientificType) {
-    return (scientificType === ScientificType.Normalized) ? "Normalized" : "ZeroNormalized";
-}
-exports.scientificTypeToString = scientificTypeToString;
-/** @internal Needs to be moved to quantity  */
-function parseShowSignOption(showSignOption) {
-    switch (showSignOption.toLowerCase()) {
-        case "nosign": return ShowSignOption.NoSign;
-        case "onlynegative": return ShowSignOption.OnlyNegative;
-        case "signalways": return ShowSignOption.SignAlways;
-        case "negativeparentheses": return ShowSignOption.NegativeParentheses;
-        default:
-            return undefined;
-    }
-}
-exports.parseShowSignOption = parseShowSignOption;
-/** @internal Needs to be moved to quantity  */
-function showSignOptionToString(showSign) {
-    switch (showSign) {
-        case ShowSignOption.NegativeParentheses: return "NegativeParentheses";
-        case ShowSignOption.NoSign: return "NoSign";
-        case ShowSignOption.OnlyNegative: return "OnlyNegative";
-        case ShowSignOption.SignAlways: return "SignAlways";
-    }
-}
-exports.showSignOptionToString = showSignOptionToString;
-/** @internal Needs to be moved to quantity  */
-function parseFormatTrait(formatTraitsString) {
-    switch (formatTraitsString.toLowerCase()) {
-        case "trailzeroes": return FormatTraits.TrailZeroes;
-        case "keepsinglezero": return FormatTraits.KeepSingleZero;
-        case "zeroempty": return FormatTraits.ZeroEmpty;
-        case "keepdecimalpoint": return FormatTraits.KeepDecimalPoint;
-        case "applyrounding": return FormatTraits.ApplyRounding;
-        case "fractiondash": return FormatTraits.FractionDash;
-        case "showunitlabel": return FormatTraits.ShowUnitLabel;
-        case "prependunitlabel": return FormatTraits.PrependUnitLabel;
-        case "use1000separator": return FormatTraits.Use1000Separator;
-        case "exponentonlynegative": return FormatTraits.ExponentOnlyNegative;
-        default: return undefined;
-    }
-}
-exports.parseFormatTrait = parseFormatTrait;
-/** @internal Needs to be moved to quantity  */
-function formatTraitsToArray(currentFormatTrait) {
-    const formatTraitsArr = Array();
-    if ((currentFormatTrait & FormatTraits.TrailZeroes) === FormatTraits.TrailZeroes)
-        formatTraitsArr.push("TrailZeroes");
-    if ((currentFormatTrait & FormatTraits.KeepSingleZero) === FormatTraits.KeepSingleZero)
-        formatTraitsArr.push("KeepSingleZero");
-    if ((currentFormatTrait & FormatTraits.ZeroEmpty) === FormatTraits.ZeroEmpty)
-        formatTraitsArr.push("ZeroEmpty");
-    if ((currentFormatTrait & FormatTraits.KeepDecimalPoint) === FormatTraits.KeepDecimalPoint)
-        formatTraitsArr.push("KeepDecimalPoint");
-    if ((currentFormatTrait & FormatTraits.ApplyRounding) === FormatTraits.ApplyRounding)
-        formatTraitsArr.push("ApplyRounding");
-    if ((currentFormatTrait & FormatTraits.FractionDash) === FormatTraits.FractionDash)
-        formatTraitsArr.push("FractionDash");
-    if ((currentFormatTrait & FormatTraits.ShowUnitLabel) === FormatTraits.ShowUnitLabel)
-        formatTraitsArr.push("ShowUnitLabel");
-    if ((currentFormatTrait & FormatTraits.PrependUnitLabel) === FormatTraits.PrependUnitLabel)
-        formatTraitsArr.push("PrependUnitLabel");
-    if ((currentFormatTrait & FormatTraits.Use1000Separator) === FormatTraits.Use1000Separator)
-        formatTraitsArr.push("Use1000Separator");
-    if ((currentFormatTrait & FormatTraits.ExponentOnlyNegative) === FormatTraits.ExponentOnlyNegative)
-        formatTraitsArr.push("ExponentOnlyNegative");
-    return formatTraitsArr;
-}
-exports.formatTraitsToArray = formatTraitsToArray;
-/** @internal Needs to be moved to quantity  */
-function parseFormatType(jsonObjType) {
-    switch (jsonObjType.toLowerCase()) {
-        case "decimal": return FormatType.Decimal;
-        case "scientific": return FormatType.Scientific;
-        case "station": return FormatType.Station;
-        case "fractional": return FormatType.Fractional;
-        default:
-            return undefined;
-    }
-}
-exports.parseFormatType = parseFormatType;
-/** @internal Needs to be moved to quantity  */
-function formatTypeToString(type) {
-    switch (type) {
-        case FormatType.Decimal: return "Decimal";
-        case FormatType.Scientific: return "Scientific";
-        case FormatType.Station: return "Station";
-        case FormatType.Fractional: return "Fractional";
-    }
-}
-exports.formatTypeToString = formatTypeToString;
-/** @internal Needs to be moved to quantity  */
-function parseDecimalPrecision(jsonObjPrecision) {
-    switch (jsonObjPrecision) {
-        case 0: return DecimalPrecision.Zero;
-        case 1: return DecimalPrecision.One;
-        case 2: return DecimalPrecision.Two;
-        case 3: return DecimalPrecision.Three;
-        case 4: return DecimalPrecision.Four;
-        case 5: return DecimalPrecision.Five;
-        case 6: return DecimalPrecision.Six;
-        case 7: return DecimalPrecision.Seven;
-        case 8: return DecimalPrecision.Eight;
-        case 9: return DecimalPrecision.Nine;
-        case 10: return DecimalPrecision.Ten;
-        case 11: return DecimalPrecision.Eleven;
-        case 12: return DecimalPrecision.Twelve;
-        default:
-            return undefined;
-    }
-}
-exports.parseDecimalPrecision = parseDecimalPrecision;
-/** @internal Needs to be moved to quantity  */
-function parseFractionalPrecision(jsonObjPrecision) {
-    switch (jsonObjPrecision) {
-        case 1: return FractionalPrecision.One;
-        case 2: return FractionalPrecision.Two;
-        case 4: return FractionalPrecision.Four;
-        case 8: return FractionalPrecision.Eight;
-        case 16: return FractionalPrecision.Sixteen;
-        case 32: return FractionalPrecision.ThirtyTwo;
-        case 64: return FractionalPrecision.SixtyFour;
-        case 128: return FractionalPrecision.OneHundredTwentyEight;
-        case 256: return FractionalPrecision.TwoHundredFiftySix;
-        default:
-            return undefined;
-    }
-}
-exports.parseFractionalPrecision = parseFractionalPrecision;
-/** @internal Needs to be moved to quantity  */
-function parsePrecision(precision, type) {
-    switch (type) { // type must be decimal, fractional, scientific, or station
-        case FormatType.Decimal:
-        case FormatType.Scientific:
-        case FormatType.Station:
-            return parseDecimalPrecision(precision);
-        case FormatType.Fractional:
-            return parseFractionalPrecision(precision);
-        default:
-            return undefined;
-    }
-}
-exports.parsePrecision = parsePrecision;
-//# sourceMappingURL=FormatEnums.js.map

package/lib/cjs/utils/FormatEnums.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FormatEnums.js","sourceRoot":"","sources":["../../../src/utils/FormatEnums.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;;;;;;;;;;;;;;;GAgBG;AACU,QAAA,eAAe,GAAG,8JAA8J,CAAC;AAE9L,8CAA8C;AAC9C,QAAe,CAAC,CAAC,4BAA4B,CAAC,YAAoB;IAChE,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,uBAAe,CAAC,CAAC;IAClD,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,kBAAkB;IAClC,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,OAAO,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,EAAE,mCAAmC;QACpE,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,SAAS;YAC5B,MAAM,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY;;YAEpC,MAAM;QACR,KAAK,IAAI,CAAC,CAAC;KACZ;AACH,CAAC;AAXD,oEAWC;AAED,2CAA2C;AAC3C,IAAY,YAYX;AAZD,WAAY,YAAY;IACtB,8DAA8D;IAC9D,6DAAkB,CAAA;IAClB,mEAAoB,CAAA;IACpB,yDAAe,CAAA;IACf,uEAAsB,CAAA;IACtB,kEAAoB,CAAA;IACpB,gEAAmB,CAAA;IACnB,kEAAoB,CAAA;IACpB,yEAAuB,CAAA;IACvB,yEAAwB,CAAA;IACxB,iFAA4B,CAAA;AAC9B,CAAC,EAZW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAYvB;AAED,2CAA2C;AAC3C,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC7B,2DAAO,CAAA;IACP,2DAAO,CAAA;IACP,6DAAQ,CAAA;IACR,+DAAS,CAAA;IACT,oEAAY,CAAA;IACZ,wEAAc,CAAA;IACd,wEAAc,CAAA;IACd,iGAA2B,CAAA;IAC3B,2FAAwB,CAAA;AAC1B,CAAC,EAVW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAU9B;AAED,2CAA2C;AAC3C,IAAY,gBAcX;AAdD,WAAY,gBAAgB;IAC1B,uDAAQ,CAAA;IACR,qDAAO,CAAA;IACP,qDAAO,CAAA;IACP,yDAAS,CAAA;IACT,uDAAQ,CAAA;IACR,uDAAQ,CAAA;IACR,qDAAO,CAAA;IACP,yDAAS,CAAA;IACT,yDAAS,CAAA;IACT,uDAAQ,CAAA;IACR,sDAAQ,CAAA;IACR,4DAAW,CAAA;IACX,4DAAW,CAAA;AACb,CAAC,EAdW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAc3B;AAED,2CAA2C;AAC3C,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,iDAAO,CAAA;IACP,uDAAU,CAAA;IACV,uDAAU,CAAA;IACV,iDAAO,CAAA;AACT,CAAC,EALW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAKrB;AAED,2CAA2C;AAC3C,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,+DAAU,CAAA;IACV,uEAAc,CAAA;AAChB,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAED,2CAA2C;AAC3C,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,uDAAM,CAAA;IACN,mEAAY,CAAA;IACZ,+DAAU,CAAA;IACV,iFAAmB,CAAA;AACrB,CAAC,EALW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAKzB;AAED,6BAA6B;AAE7B,+CAA+C;AAC/C,SAAgB,mBAAmB,CAAC,cAAsB;IACxD,QAAQ,cAAc,CAAC,WAAW,EAAE,EAAE;QACpC,KAAK,YAAY,CAAC,CAAC,OAAO,cAAc,CAAC,UAAU,CAAC;QACpD,KAAK,gBAAgB,CAAC,CAAC,OAAO,cAAc,CAAC,cAAc,CAAC;QAC5D;YACE,OAAO,SAAS,CAAC;KACpB;AACH,CAAC;AAPD,kDAOC;AAED,+CAA+C;AAC/C,SAAgB,sBAAsB,CAAC,cAA8B;IACnE,OAAO,CAAC,cAAc,KAAK,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,gBAAgB,CAAC;AAC1F,CAAC;AAFD,wDAEC;AAED,+CAA+C;AAC/C,SAAgB,mBAAmB,CAAC,cAAsB;IACxD,QAAQ,cAAc,CAAC,WAAW,EAAE,EAAE;QACpC,KAAK,QAAQ,CAAC,CAAC,OAAO,cAAc,CAAC,MAAM,CAAC;QAC5C,KAAK,cAAc,CAAC,CAAC,OAAO,cAAc,CAAC,YAAY,CAAC;QACxD,KAAK,YAAY,CAAC,CAAC,OAAO,cAAc,CAAC,UAAU,CAAC;QACpD,KAAK,qBAAqB,CAAC,CAAC,OAAO,cAAc,CAAC,mBAAmB,CAAC;QACtE;YACE,OAAO,SAAS,CAAC;KACpB;AACH,CAAC;AATD,kDASC;AAED,+CAA+C;AAC/C,SAAgB,sBAAsB,CAAC,QAAwB;IAC7D,QAAQ,QAAQ,EAAE;QAChB,KAAK,cAAc,CAAC,mBAAmB,CAAC,CAAC,OAAO,qBAAqB,CAAC;QACtE,KAAK,cAAc,CAAC,MAAM,CAAC,CAAC,OAAO,QAAQ,CAAC;QAC5C,KAAK,cAAc,CAAC,YAAY,CAAC,CAAC,OAAO,cAAc,CAAC;QACxD,KAAK,cAAc,CAAC,UAAU,CAAC,CAAC,OAAO,YAAY,CAAC;KACrD;AACH,CAAC;AAPD,wDAOC;AAED,+CAA+C;AAC/C,SAAgB,gBAAgB,CAAC,kBAA0B;IACzD,QAAQ,kBAAkB,CAAC,WAAW,EAAE,EAAE;QACxC,KAAK,aAAa,CAAC,CAAC,OAAO,YAAY,CAAC,WAAW,CAAC;QACpD,KAAK,gBAAgB,CAAC,CAAC,OAAO,YAAY,CAAC,cAAc,CAAC;QAC1D,KAAK,WAAW,CAAC,CAAC,OAAO,YAAY,CAAC,SAAS,CAAC;QAChD,KAAK,kBAAkB,CAAC,CAAC,OAAO,YAAY,CAAC,gBAAgB,CAAC;QAC9D,KAAK,eAAe,CAAC,CAAC,OAAO,YAAY,CAAC,aAAa,CAAC;QACxD,KAAK,cAAc,CAAC,CAAC,OAAO,YAAY,CAAC,YAAY,CAAC;QACtD,KAAK,eAAe,CAAC,CAAC,OAAO,YAAY,CAAC,aAAa,CAAC;QACxD,KAAK,kBAAkB,CAAC,CAAC,OAAO,YAAY,CAAC,gBAAgB,CAAC;QAC9D,KAAK,kBAAkB,CAAC,CAAC,OAAO,YAAY,CAAC,gBAAgB,CAAC;QAC9D,KAAK,sBAAsB,CAAC,CAAC,OAAO,YAAY,CAAC,oBAAoB,CAAC;QACtE,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;KAC3B;AACH,CAAC;AAdD,4CAcC;AAED,+CAA+C;AAC/C,SAAgB,mBAAmB,CAAC,kBAAgC;IAClE,MAAM,eAAe,GAAG,KAAK,EAAU,CAAC;IACxC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,WAAW,CAAC,KAAK,YAAY,CAAC,WAAW;QAC9E,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACtC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,cAAc,CAAC,KAAK,YAAY,CAAC,cAAc;QACpF,eAAe,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACzC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,SAAS,CAAC,KAAK,YAAY,CAAC,SAAS;QAC1E,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACpC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,gBAAgB,CAAC,KAAK,YAAY,CAAC,gBAAgB;QACxF,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC3C,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,aAAa,CAAC,KAAK,YAAY,CAAC,aAAa;QAClF,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,YAAY,CAAC,KAAK,YAAY,CAAC,YAAY;QAChF,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACvC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,aAAa,CAAC,KAAK,YAAY,CAAC,aAAa;QAClF,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,gBAAgB,CAAC,KAAK,YAAY,CAAC,gBAAgB;QACxF,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC3C,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,gBAAgB,CAAC,KAAK,YAAY,CAAC,gBAAgB;QACxF,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC3C,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,oBAAoB,CAAC,KAAK,YAAY,CAAC,oBAAoB;QAChG,eAAe,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IAC/C,OAAO,eAAe,CAAC;AACzB,CAAC;AAvBD,kDAuBC;AAED,+CAA+C;AAC/C,SAAgB,eAAe,CAAC,WAAmB;IACjD,QAAQ,WAAW,CAAC,WAAW,EAAE,EAAE;QACjC,KAAK,SAAS,CAAC,CAAC,OAAO,UAAU,CAAC,OAAO,CAAC;QAC1C,KAAK,YAAY,CAAC,CAAC,OAAO,UAAU,CAAC,UAAU,CAAC;QAChD,KAAK,SAAS,CAAC,CAAC,OAAO,UAAU,CAAC,OAAO,CAAC;QAC1C,KAAK,YAAY,CAAC,CAAC,OAAO,UAAU,CAAC,UAAU,CAAC;QAChD;YACE,OAAO,SAAS,CAAC;KACpB;AACH,CAAC;AATD,0CASC;AAED,+CAA+C;AAC/C,SAAgB,kBAAkB,CAAC,IAAgB;IACjD,QAAQ,IAAI,EAAE;QACZ,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;QAC1C,KAAK,UAAU,CAAC,UAAU,CAAC,CAAC,OAAO,YAAY,CAAC;QAChD,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;QAC1C,KAAK,UAAU,CAAC,UAAU,CAAC,CAAC,OAAO,YAAY,CAAC;KACjD;AACH,CAAC;AAPD,gDAOC;AAED,+CAA+C;AAC/C,SAAgB,qBAAqB,CAAC,gBAAwB;IAC5D,QAAQ,gBAAgB,EAAE;QACxB,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACpC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACpC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,KAAK,CAAC;QACtC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACpC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,KAAK,CAAC;QACtC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,KAAK,CAAC;QACtC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,EAAE,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACrC,KAAK,EAAE,CAAC,CAAC,OAAO,gBAAgB,CAAC,MAAM,CAAC;QACxC,KAAK,EAAE,CAAC,CAAC,OAAO,gBAAgB,CAAC,MAAM,CAAC;QACxC;YACE,OAAO,SAAS,CAAC;KACpB;AACH,CAAC;AAlBD,sDAkBC;AAED,+CAA+C;AAC/C,SAAgB,wBAAwB,CAAC,gBAAwB;IAC/D,QAAQ,gBAAgB,EAAE;QACxB,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,GAAG,CAAC;QACvC,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,GAAG,CAAC;QACvC,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,IAAI,CAAC;QACxC,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,KAAK,CAAC;QACzC,KAAK,EAAE,CAAC,CAAC,OAAO,mBAAmB,CAAC,OAAO,CAAC;QAC5C,KAAK,EAAE,CAAC,CAAC,OAAO,mBAAmB,CAAC,SAAS,CAAC;QAC9C,KAAK,EAAE,CAAC,CAAC,OAAO,mBAAmB,CAAC,SAAS,CAAC;QAC9C,KAAK,GAAG,CAAC,CAAC,OAAO,mBAAmB,CAAC,qBAAqB,CAAC;QAC3D,KAAK,GAAG,CAAC,CAAC,OAAO,mBAAmB,CAAC,kBAAkB,CAAC;QACxD;YACE,OAAO,SAAS,CAAC;KACpB;AACH,CAAC;AAdD,4DAcC;AAED,+CAA+C;AAC/C,SAAgB,cAAc,CAAC,SAAiB,EAAE,IAAgB;IAChE,QAAQ,IAAI,EAAE,EAAE,2DAA2D;QACzE,KAAK,UAAU,CAAC,OAAO,CAAC;QACxB,KAAK,UAAU,CAAC,UAAU,CAAC;QAC3B,KAAK,UAAU,CAAC,OAAO;YACrB,OAAO,qBAAqB,CAAC,SAAS,CAAC,CAAC;QAC1C,KAAK,UAAU,CAAC,UAAU;YACxB,OAAO,wBAAwB,CAAC,SAAS,CAAC,CAAC;QAC7C;YACE,OAAO,SAAS,CAAC;KACpB;AACH,CAAC;AAXD,wCAWC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\n/** The regular expression to parse [format strings]($docs/bis/ec/kindofquantity.md#format-string)\r\n * provided in serialized formats as well as the full name of an [[OverrideFormat]].\r\n *\r\n * `formatName(precision)[unitName|unitLabel][unitName|unitLabel][unitName|unitLabel][unitName|unitLabel]`\r\n *\r\n * Explanation of the regex:\r\n * - ([\\w.:]+)\r\n *   - Grabs the format full name\r\n * - (\\(([^\\)]+)\\))?\r\n *   - Grabs the precision part with and without the `()`.\r\n *   - The parentheses are needed to validate the entire string.  (TODO: Need to check if this is true)\r\n * - (\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?\r\n *   - 4 of these make up the rest of the regex, none of them are required so each end in `?`\r\n *   - Grabs the unit name and label including the `[]`\r\n *   - Grabs the unit name, `|` and label separately\r\n * @internal\r\n */\r\nexport const formatStringRgx = /([\\w.:]+)(\\(([^\\)]+)\\))?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?/;\r\n\r\n/** @internal Needs to be moved to quantity */\r\nexport function* getItemNamesFromFormatString(formatString: string): Iterable<string> {\r\n  const match = formatString.split(formatStringRgx);\r\n  yield match[1]; // the Format Name\r\n  let index = 4;\r\n  while (index < match.length - 1) { // index 0 and 21 are empty strings\r\n    if (match[index] !== undefined)\r\n      yield match[index + 1]; // Unit Name\r\n    else\r\n      break;\r\n    index += 4;\r\n  }\r\n}\r\n\r\n/** @beta Needs to be moved to quantity  */\r\nexport enum FormatTraits {\r\n  // the leading + opts TypeScript out of inferring a union enum\r\n  TrailZeroes = +0x1,\r\n  KeepSingleZero = 0x2,\r\n  ZeroEmpty = 0x4,\r\n  KeepDecimalPoint = 0x8,\r\n  ApplyRounding = 0x10,\r\n  FractionDash = 0x20,\r\n  ShowUnitLabel = 0x40,\r\n  PrependUnitLabel = 0x80,\r\n  Use1000Separator = 0x100,\r\n  ExponentOnlyNegative = 0x200,\r\n}\r\n\r\n/** @beta Needs to be moved to quantity  */\r\nexport enum FractionalPrecision {\r\n  One = 1,\r\n  Two = 2,\r\n  Four = 4,\r\n  Eight = 8,\r\n  Sixteen = 16,\r\n  ThirtyTwo = 32,\r\n  SixtyFour = 64,\r\n  OneHundredTwentyEight = 128,\r\n  TwoHundredFiftySix = 256,\r\n}\r\n\r\n/** @beta Needs to be moved to quantity  */\r\nexport enum DecimalPrecision {\r\n  Zero = 0,\r\n  One = 1,\r\n  Two = 2,\r\n  Three = 3,\r\n  Four = 4,\r\n  Five = 5,\r\n  Six = 6,\r\n  Seven = 7,\r\n  Eight = 8,\r\n  Nine = 9,\r\n  Ten = 10,\r\n  Eleven = 11,\r\n  Twelve = 12,\r\n}\r\n\r\n/** @beta Needs to be moved to quantity  */\r\nexport enum FormatType {\r\n  Decimal,\r\n  Fractional,\r\n  Scientific,\r\n  Station,\r\n}\r\n\r\n/** @beta Needs to be moved to quantity  */\r\nexport enum ScientificType { // required if type is scientific; options: normalized, zeroNormalized\r\n  Normalized,\r\n  ZeroNormalized,\r\n}\r\n\r\n/** @beta Needs to be moved to quantity  */\r\nexport enum ShowSignOption { // default is no sign\r\n  NoSign,\r\n  OnlyNegative,\r\n  SignAlways,\r\n  NegativeParentheses,\r\n}\r\n\r\n// parse and toString methods\r\n\r\n/** @internal Needs to be moved to quantity  */\r\nexport function parseScientificType(scientificType: string): ScientificType | undefined {\r\n  switch (scientificType.toLowerCase()) {\r\n    case \"normalized\": return ScientificType.Normalized;\r\n    case \"zeronormalized\": return ScientificType.ZeroNormalized;\r\n    default:\r\n      return undefined;\r\n  }\r\n}\r\n\r\n/** @internal Needs to be moved to quantity  */\r\nexport function scientificTypeToString(scientificType: ScientificType): string {\r\n  return (scientificType === ScientificType.Normalized) ? \"Normalized\" : \"ZeroNormalized\";\r\n}\r\n\r\n/** @internal Needs to be moved to quantity  */\r\nexport function parseShowSignOption(showSignOption: string): ShowSignOption | undefined {\r\n  switch (showSignOption.toLowerCase()) {\r\n    case \"nosign\": return ShowSignOption.NoSign;\r\n    case \"onlynegative\": return ShowSignOption.OnlyNegative;\r\n    case \"signalways\": return ShowSignOption.SignAlways;\r\n    case \"negativeparentheses\": return ShowSignOption.NegativeParentheses;\r\n    default:\r\n      return undefined;\r\n  }\r\n}\r\n\r\n/** @internal Needs to be moved to quantity  */\r\nexport function showSignOptionToString(showSign: ShowSignOption): string {\r\n  switch (showSign) {\r\n    case ShowSignOption.NegativeParentheses: return \"NegativeParentheses\";\r\n    case ShowSignOption.NoSign: return \"NoSign\";\r\n    case ShowSignOption.OnlyNegative: return \"OnlyNegative\";\r\n    case ShowSignOption.SignAlways: return \"SignAlways\";\r\n  }\r\n}\r\n\r\n/** @internal Needs to be moved to quantity  */\r\nexport function parseFormatTrait(formatTraitsString: string): FormatTraits | undefined {\r\n  switch (formatTraitsString.toLowerCase()) {\r\n    case \"trailzeroes\": return FormatTraits.TrailZeroes;\r\n    case \"keepsinglezero\": return FormatTraits.KeepSingleZero;\r\n    case \"zeroempty\": return FormatTraits.ZeroEmpty;\r\n    case \"keepdecimalpoint\": return FormatTraits.KeepDecimalPoint;\r\n    case \"applyrounding\": return FormatTraits.ApplyRounding;\r\n    case \"fractiondash\": return FormatTraits.FractionDash;\r\n    case \"showunitlabel\": return FormatTraits.ShowUnitLabel;\r\n    case \"prependunitlabel\": return FormatTraits.PrependUnitLabel;\r\n    case \"use1000separator\": return FormatTraits.Use1000Separator;\r\n    case \"exponentonlynegative\": return FormatTraits.ExponentOnlyNegative;\r\n    default: return undefined;\r\n  }\r\n}\r\n\r\n/** @internal Needs to be moved to quantity  */\r\nexport function formatTraitsToArray(currentFormatTrait: FormatTraits): string[] {\r\n  const formatTraitsArr = Array<string>();\r\n  if ((currentFormatTrait & FormatTraits.TrailZeroes) === FormatTraits.TrailZeroes)\r\n    formatTraitsArr.push(\"TrailZeroes\");\r\n  if ((currentFormatTrait & FormatTraits.KeepSingleZero) === FormatTraits.KeepSingleZero)\r\n    formatTraitsArr.push(\"KeepSingleZero\");\r\n  if ((currentFormatTrait & FormatTraits.ZeroEmpty) === FormatTraits.ZeroEmpty)\r\n    formatTraitsArr.push(\"ZeroEmpty\");\r\n  if ((currentFormatTrait & FormatTraits.KeepDecimalPoint) === FormatTraits.KeepDecimalPoint)\r\n    formatTraitsArr.push(\"KeepDecimalPoint\");\r\n  if ((currentFormatTrait & FormatTraits.ApplyRounding) === FormatTraits.ApplyRounding)\r\n    formatTraitsArr.push(\"ApplyRounding\");\r\n  if ((currentFormatTrait & FormatTraits.FractionDash) === FormatTraits.FractionDash)\r\n    formatTraitsArr.push(\"FractionDash\");\r\n  if ((currentFormatTrait & FormatTraits.ShowUnitLabel) === FormatTraits.ShowUnitLabel)\r\n    formatTraitsArr.push(\"ShowUnitLabel\");\r\n  if ((currentFormatTrait & FormatTraits.PrependUnitLabel) === FormatTraits.PrependUnitLabel)\r\n    formatTraitsArr.push(\"PrependUnitLabel\");\r\n  if ((currentFormatTrait & FormatTraits.Use1000Separator) === FormatTraits.Use1000Separator)\r\n    formatTraitsArr.push(\"Use1000Separator\");\r\n  if ((currentFormatTrait & FormatTraits.ExponentOnlyNegative) === FormatTraits.ExponentOnlyNegative)\r\n    formatTraitsArr.push(\"ExponentOnlyNegative\");\r\n  return formatTraitsArr;\r\n}\r\n\r\n/** @internal Needs to be moved to quantity  */\r\nexport function parseFormatType(jsonObjType: string): FormatType | undefined {\r\n  switch (jsonObjType.toLowerCase()) {\r\n    case \"decimal\": return FormatType.Decimal;\r\n    case \"scientific\": return FormatType.Scientific;\r\n    case \"station\": return FormatType.Station;\r\n    case \"fractional\": return FormatType.Fractional;\r\n    default:\r\n      return undefined;\r\n  }\r\n}\r\n\r\n/** @internal Needs to be moved to quantity  */\r\nexport function formatTypeToString(type: FormatType): string {\r\n  switch (type) {\r\n    case FormatType.Decimal: return \"Decimal\";\r\n    case FormatType.Scientific: return \"Scientific\";\r\n    case FormatType.Station: return \"Station\";\r\n    case FormatType.Fractional: return \"Fractional\";\r\n  }\r\n}\r\n\r\n/** @internal Needs to be moved to quantity  */\r\nexport function parseDecimalPrecision(jsonObjPrecision: number): DecimalPrecision | undefined {\r\n  switch (jsonObjPrecision) {\r\n    case 0: return DecimalPrecision.Zero;\r\n    case 1: return DecimalPrecision.One;\r\n    case 2: return DecimalPrecision.Two;\r\n    case 3: return DecimalPrecision.Three;\r\n    case 4: return DecimalPrecision.Four;\r\n    case 5: return DecimalPrecision.Five;\r\n    case 6: return DecimalPrecision.Six;\r\n    case 7: return DecimalPrecision.Seven;\r\n    case 8: return DecimalPrecision.Eight;\r\n    case 9: return DecimalPrecision.Nine;\r\n    case 10: return DecimalPrecision.Ten;\r\n    case 11: return DecimalPrecision.Eleven;\r\n    case 12: return DecimalPrecision.Twelve;\r\n    default:\r\n      return undefined;\r\n  }\r\n}\r\n\r\n/** @internal Needs to be moved to quantity  */\r\nexport function parseFractionalPrecision(jsonObjPrecision: number): FractionalPrecision | undefined {\r\n  switch (jsonObjPrecision) {\r\n    case 1: return FractionalPrecision.One;\r\n    case 2: return FractionalPrecision.Two;\r\n    case 4: return FractionalPrecision.Four;\r\n    case 8: return FractionalPrecision.Eight;\r\n    case 16: return FractionalPrecision.Sixteen;\r\n    case 32: return FractionalPrecision.ThirtyTwo;\r\n    case 64: return FractionalPrecision.SixtyFour;\r\n    case 128: return FractionalPrecision.OneHundredTwentyEight;\r\n    case 256: return FractionalPrecision.TwoHundredFiftySix;\r\n    default:\r\n      return undefined;\r\n  }\r\n}\r\n\r\n/** @internal Needs to be moved to quantity  */\r\nexport function parsePrecision(precision: number, type: FormatType): DecimalPrecision | FractionalPrecision | undefined {\r\n  switch (type) { // type must be decimal, fractional, scientific, or station\r\n    case FormatType.Decimal:\r\n    case FormatType.Scientific:\r\n    case FormatType.Station:\r\n      return parseDecimalPrecision(precision);\r\n    case FormatType.Fractional:\r\n      return parseFractionalPrecision(precision);\r\n    default:\r\n      return undefined;\r\n  }\r\n}\r\n"]}