@itwin/core-quantity 4.9.0-dev.12 → 4.9.0-dev.14

package/lib/esm/Formatter/FormatterSpec.js.map

@@ -1 +1 @@
-{"version":3,"file":"FormatterSpec.js","sourceRoot":"","sources":["../../../src/Formatter/FormatterSpec.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,sFAAsF;AACtF,6JAA6J;AAE7J;;;GAGG;AACH,MAAM,OAAO,aAAa;IAMxB;;;;;OAKG;IACH,YAAY,IAAY,EAAE,MAAc,EAAE,WAAkC,EAAE,eAA2B;QAV/F,iBAAY,GAAyB,EAAE,CAAC,CAAE,mBAAmB;QAWrE,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAChC,eAAe,GAAG,KAAK,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;YAC3E,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;QACxC,IAAI,WAAW;YACb,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IACpC,CAAC;IAED,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAChD,uHAAuH;IACvH,IAAW,eAAe,KAA2B,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAChF,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACpD,IAAW,eAAe,KAAgB,OAAO,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAEzE,mHAAmH;IAC5G,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,MAAc,EAAE,aAA4B,EAAE,SAAqB;QACxG,MAAM,WAAW,GAAyB,EAAE,CAAC;QAC7C,IAAI,eAAe,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAChC,eAAe,GAAG,KAAK,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;YAC3E,CAAC;QACH,CAAC;QAED,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,IAAI,eAAe,GAAG,SAAS,CAAC;YAChC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBAChC,IAAI,cAAmC,CAAC;gBACxC,IAAI,eAAe,EAAE,CAAC;oBACpB,cAAc,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC/E,CAAC;qBAAM,CAAC;oBACN,cAAc,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;gBAChD,CAAC;gBACD,MAAM,SAAS,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;gBAC5E,MAAM,IAAI,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAuB,CAAC;gBAElI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACvB,eAAe,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;aAAM,CAAC;YACN,0GAA0G;YAC1G,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,IAAI,GAAuB,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;gBACtJ,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACzB,CAAC;QACH,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAY,EAAE,MAAc,EAAE,aAA4B,EAAE,SAAqB;QAC1G,MAAM,WAAW,GAAyB,MAAM,aAAa,CAAC,kBAAkB,CAAC,MAAM,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;QACnH,OAAO,IAAI,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;IACjE,CAAC;IAED,+BAA+B;IACxB,eAAe,CAAC,SAAiB;QACtC,OAAO,SAAS,CAAC,cAAc,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;CACF","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 Quantity\r\n */\r\n\r\nimport { UnitConversionProps, UnitConversionSpec, UnitProps, UnitsProvider } from \"../Interfaces\";\r\nimport { Format } from \"./Format\";\r\nimport { Formatter } from \"./Formatter\";\r\n\r\n// cSpell:ignore ZERONORMALIZED, nosign, onlynegative, signalways, negativeparentheses\r\n// cSpell:ignore trailzeroes, keepsinglezero, zeroempty, keepdecimalpoint, applyrounding, fractiondash, showunitlabel, prependunitlabel, exponentonlynegative\r\n\r\n/** A class that contains both formatting information and the conversion factors necessary to convert from an input unit to the units specified in the format.\r\n * Once created the FormatterSpec will be able to format quantity values with synchronous calls.\r\n * @beta\r\n */\r\nexport class FormatterSpec {\r\n  protected _name: string;\r\n  protected _conversions: UnitConversionSpec[] = [];  // max four entries\r\n  protected _format: Format;\r\n  protected _persistenceUnit: UnitProps;\r\n\r\n  /** Constructor\r\n   *  @param name     The name of a format specification.\r\n   *  @param format   Defines the output format for the quantity value.\r\n   *  @param conversions An array of conversion factors necessary to convert from an input unit to the units specified in the format.\r\n   *  @param persistenceUnit The unit the magnitude value is input.\r\n   */\r\n  constructor(name: string, format: Format, conversions?: UnitConversionSpec[], persistenceUnit?: UnitProps) {\r\n    if (!persistenceUnit) {\r\n      if (format.units) {\r\n        const [props] = format.units[0];\r\n        persistenceUnit = props;\r\n      } else {\r\n        throw new Error(\"Formatter Spec needs persistence unit to be specified\");\r\n      }\r\n    }\r\n\r\n    this._name = name;\r\n    this._format = format;\r\n    this._persistenceUnit = persistenceUnit;\r\n    if (conversions)\r\n      this._conversions = conversions;\r\n  }\r\n\r\n  public get name(): string { return this._name; }\r\n  /** Returns an array of UnitConversionSpecs, one for each unit that is to be shown in the formatted quantity string. */\r\n  public get unitConversions(): UnitConversionSpec[] { return this._conversions; }\r\n  public get format(): Format { return this._format; }\r\n  public get persistenceUnit(): UnitProps { return this._persistenceUnit; }\r\n\r\n  /** Get an array of UnitConversionSpecs, one for each unit that is to be shown in the formatted quantity string. */\r\n  public static async getUnitConversions(format: Format, unitsProvider: UnitsProvider, inputUnit?: UnitProps): Promise<UnitConversionSpec[]> {\r\n    const conversions: UnitConversionSpec[] = [];\r\n    let persistenceUnit = inputUnit;\r\n    if (!persistenceUnit) {\r\n      if (format.units) {\r\n        const [props] = format.units[0];\r\n        persistenceUnit = props;\r\n      } else {\r\n        throw new Error(\"Formatter Spec needs persistence unit to be specified\");\r\n      }\r\n    }\r\n\r\n    if (format.units) {\r\n      let convertFromUnit = inputUnit;\r\n      for (const unit of format.units) {\r\n        let unitConversion: UnitConversionProps;\r\n        if (convertFromUnit) {\r\n          unitConversion = await unitsProvider.getConversion(convertFromUnit, unit[0]);\r\n        } else {\r\n          unitConversion = { factor: 1.0, offset: 0.0 };\r\n        }\r\n        const unitLabel = (unit[1] && unit[1].length > 0) ? unit[1] : unit[0].label;\r\n        const spec = ({ name: unit[0].name, label: unitLabel, conversion: unitConversion, system: unit[0].system }) as UnitConversionSpec;\r\n\r\n        conversions.push(spec);\r\n        convertFromUnit = unit[0];\r\n      }\r\n    } else {\r\n      // if format is only numeric and a input unit is defined set spec to use the input unit as the format unit\r\n      if (inputUnit) {\r\n        const spec: UnitConversionSpec = { name: inputUnit.name, label: inputUnit.label, system: inputUnit.system, conversion: { factor: 1.0, offset: 0.0 } };\r\n        conversions.push(spec);\r\n      }\r\n    }\r\n\r\n    return conversions;\r\n  }\r\n\r\n  /** Static async method to create a FormatSpec given the format and unit of the quantity that will be passed to the Formatter. The input unit will\r\n   * be used to generate conversion information for each unit specified in the Format. This method is async due to the fact that the units provider must make\r\n   * async calls to lookup unit definitions.\r\n   *  @param name     The name of a format specification.\r\n   *  @param unitsProvider The units provider is used to look up unit definitions and provide conversion information for converting between units.\r\n   *  @param inputUnit The unit the value to be formatted. This unit is often referred to as persistence unit.\r\n   */\r\n  public static async create(name: string, format: Format, unitsProvider: UnitsProvider, inputUnit?: UnitProps): Promise<FormatterSpec> {\r\n    const conversions: UnitConversionSpec[] = await FormatterSpec.getUnitConversions(format, unitsProvider, inputUnit);\r\n    return new FormatterSpec(name, format, conversions, inputUnit);\r\n  }\r\n\r\n  /** Format a quantity value. */\r\n  public applyFormatting(magnitude: number): string {\r\n    return Formatter.formatQuantity(magnitude, this);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"FormatterSpec.js","sourceRoot":"","sources":["../../../src/Formatter/FormatterSpec.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,sFAAsF;AACtF,6JAA6J;AAE7J;;;GAGG;AACH,MAAM,OAAO,aAAa;IAQxB;;;;;;;OAOG;IACH,YAAY,IAAY,EAAE,MAAc,EAAE,WAAkC,EAAE,eAA2B,EAAE,qBAA2C,EAAE,oBAA0C;QAdxL,iBAAY,GAAyB,EAAE,CAAC,CAAE,mBAAmB;QAerE,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAChC,eAAe,GAAG,KAAK,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;YAC3E,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;QACxC,IAAI,WAAW;YACb,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAClC,IAAI,CAAC,sBAAsB,GAAG,qBAAqB,CAAC;QACpD,IAAI,CAAC,qBAAqB,GAAG,oBAAoB,CAAC;IACpD,CAAC;IAED,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAChD,uHAAuH;IACvH,IAAW,eAAe,KAA2B,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAChF,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACpD,IAAW,eAAe,KAAgB,OAAO,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACzE,IAAW,qBAAqB,KAAsC,OAAO,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAC3G,IAAW,oBAAoB,KAAsC,OAAO,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAEzG,mHAAmH;IAC5G,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,MAAc,EAAE,aAA4B,EAAE,SAAqB;QACxG,MAAM,WAAW,GAAyB,EAAE,CAAC;QAC7C,IAAI,eAAe,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAChC,eAAe,GAAG,KAAK,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;YAC3E,CAAC;QACH,CAAC;QAED,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,IAAI,eAAe,GAAG,SAAS,CAAC;YAChC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBAChC,IAAI,cAAmC,CAAC;gBACxC,IAAI,eAAe,EAAE,CAAC;oBACpB,cAAc,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC/E,CAAC;qBAAM,CAAC;oBACN,cAAc,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;gBAChD,CAAC;gBACD,MAAM,SAAS,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;gBAC5E,MAAM,IAAI,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAuB,CAAC;gBAElI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACvB,eAAe,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;aAAM,CAAC;YACN,0GAA0G;YAC1G,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,IAAI,GAAuB,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;gBACtJ,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACzB,CAAC;QACH,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAY,EAAE,MAAc,EAAE,aAA4B,EAAE,SAAqB;QAC1G,MAAM,WAAW,GAAyB,MAAM,aAAa,CAAC,kBAAkB,CAAC,MAAM,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;QACnH,IAAI,qBAAsD,CAAC;QAC3D,IAAI,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,qBAAqB,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;YAC/F,CAAC;iBAAM,CAAC;gBACN,qBAAqB,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;YACvD,CAAC;QACH,CAAC;QACD,IAAI,oBAAqD,CAAC;QAC1D,IAAI,MAAM,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACxC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,oBAAoB,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;YAC7F,CAAC;iBAAM,CAAC;gBACN,oBAAoB,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;YACtD,CAAC;QACH,CAAC;QAED,OAAO,IAAI,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,qBAAqB,EAAE,oBAAoB,CAAC,CAAC;IAC9G,CAAC;IAED,+BAA+B;IACxB,eAAe,CAAC,SAAiB;QACtC,OAAO,SAAS,CAAC,cAAc,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;CACF","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 Quantity\r\n */\r\n\r\nimport { UnitConversionProps, UnitConversionSpec, UnitProps, UnitsProvider } from \"../Interfaces\";\r\nimport { Format } from \"./Format\";\r\nimport { Formatter } from \"./Formatter\";\r\n\r\n// cSpell:ignore ZERONORMALIZED, nosign, onlynegative, signalways, negativeparentheses\r\n// cSpell:ignore trailzeroes, keepsinglezero, zeroempty, keepdecimalpoint, applyrounding, fractiondash, showunitlabel, prependunitlabel, exponentonlynegative\r\n\r\n/** A class that contains both formatting information and the conversion factors necessary to convert from an input unit to the units specified in the format.\r\n * Once created the FormatterSpec will be able to format quantity values with synchronous calls.\r\n * @beta\r\n */\r\nexport class FormatterSpec {\r\n  protected _name: string;\r\n  protected _conversions: UnitConversionSpec[] = [];  // max four entries\r\n  protected _format: Format;\r\n  protected _persistenceUnit: UnitProps;\r\n  protected _azimuthBaseConversion?: UnitConversionProps; // converts azimuth base unit to persistence unit\r\n  protected _revolutionConversion?: UnitConversionProps; // converts revolution unit to persistence unit\r\n\r\n  /** Constructor\r\n   *  @param name     The name of a format specification.\r\n   *  @param format   Defines the output format for the quantity value.\r\n   *  @param conversions An array of conversion factors necessary to convert from an input unit to the units specified in the format.\r\n   *  @param persistenceUnit The unit the magnitude value is input.\r\n   *  @param azimuthBaseConversion The conversion used to interpret azimuth base values.\r\n   *  @param revolutionConversion The conversion used to determine a revolution value (used for bearing and azimuth).\r\n   */\r\n  constructor(name: string, format: Format, conversions?: UnitConversionSpec[], persistenceUnit?: UnitProps, azimuthBaseConversion?: UnitConversionProps, revolutionConversion?: UnitConversionProps) {\r\n    if (!persistenceUnit) {\r\n      if (format.units) {\r\n        const [props] = format.units[0];\r\n        persistenceUnit = props;\r\n      } else {\r\n        throw new Error(\"Formatter Spec needs persistence unit to be specified\");\r\n      }\r\n    }\r\n\r\n    this._name = name;\r\n    this._format = format;\r\n    this._persistenceUnit = persistenceUnit;\r\n    if (conversions)\r\n      this._conversions = conversions;\r\n    this._azimuthBaseConversion = azimuthBaseConversion;\r\n    this._revolutionConversion = revolutionConversion;\r\n  }\r\n\r\n  public get name(): string { return this._name; }\r\n  /** Returns an array of UnitConversionSpecs, one for each unit that is to be shown in the formatted quantity string. */\r\n  public get unitConversions(): UnitConversionSpec[] { return this._conversions; }\r\n  public get format(): Format { return this._format; }\r\n  public get persistenceUnit(): UnitProps { return this._persistenceUnit; }\r\n  public get azimuthBaseConversion(): UnitConversionProps | undefined { return this._azimuthBaseConversion; }\r\n  public get revolutionConversion(): UnitConversionProps | undefined { return this._revolutionConversion; }\r\n\r\n  /** Get an array of UnitConversionSpecs, one for each unit that is to be shown in the formatted quantity string. */\r\n  public static async getUnitConversions(format: Format, unitsProvider: UnitsProvider, inputUnit?: UnitProps): Promise<UnitConversionSpec[]> {\r\n    const conversions: UnitConversionSpec[] = [];\r\n    let persistenceUnit = inputUnit;\r\n    if (!persistenceUnit) {\r\n      if (format.units) {\r\n        const [props] = format.units[0];\r\n        persistenceUnit = props;\r\n      } else {\r\n        throw new Error(\"Formatter Spec needs persistence unit to be specified\");\r\n      }\r\n    }\r\n\r\n    if (format.units) {\r\n      let convertFromUnit = inputUnit;\r\n      for (const unit of format.units) {\r\n        let unitConversion: UnitConversionProps;\r\n        if (convertFromUnit) {\r\n          unitConversion = await unitsProvider.getConversion(convertFromUnit, unit[0]);\r\n        } else {\r\n          unitConversion = { factor: 1.0, offset: 0.0 };\r\n        }\r\n        const unitLabel = (unit[1] && unit[1].length > 0) ? unit[1] : unit[0].label;\r\n        const spec = ({ name: unit[0].name, label: unitLabel, conversion: unitConversion, system: unit[0].system }) as UnitConversionSpec;\r\n\r\n        conversions.push(spec);\r\n        convertFromUnit = unit[0];\r\n      }\r\n    } else {\r\n      // if format is only numeric and a input unit is defined set spec to use the input unit as the format unit\r\n      if (inputUnit) {\r\n        const spec: UnitConversionSpec = { name: inputUnit.name, label: inputUnit.label, system: inputUnit.system, conversion: { factor: 1.0, offset: 0.0 } };\r\n        conversions.push(spec);\r\n      }\r\n    }\r\n\r\n    return conversions;\r\n  }\r\n\r\n  /** Static async method to create a FormatSpec given the format and unit of the quantity that will be passed to the Formatter. The input unit will\r\n   * be used to generate conversion information for each unit specified in the Format. This method is async due to the fact that the units provider must make\r\n   * async calls to lookup unit definitions.\r\n   *  @param name     The name of a format specification.\r\n   *  @param unitsProvider The units provider is used to look up unit definitions and provide conversion information for converting between units.\r\n   *  @param inputUnit The unit the value to be formatted. This unit is often referred to as persistence unit.\r\n   */\r\n  public static async create(name: string, format: Format, unitsProvider: UnitsProvider, inputUnit?: UnitProps): Promise<FormatterSpec> {\r\n    const conversions: UnitConversionSpec[] = await FormatterSpec.getUnitConversions(format, unitsProvider, inputUnit);\r\n    let azimuthBaseConversion: UnitConversionProps | undefined;\r\n    if (format.azimuthBaseUnit !== undefined) {\r\n      if (inputUnit !== undefined) {\r\n        azimuthBaseConversion = await unitsProvider.getConversion(format.azimuthBaseUnit, inputUnit);\r\n      } else {\r\n        azimuthBaseConversion = { factor: 1.0, offset: 0.0 };\r\n      }\r\n    }\r\n    let revolutionConversion: UnitConversionProps | undefined;\r\n    if (format.revolutionUnit !== undefined) {\r\n      if (inputUnit !== undefined) {\r\n        revolutionConversion = await unitsProvider.getConversion(format.revolutionUnit, inputUnit);\r\n      } else {\r\n        revolutionConversion = { factor: 1.0, offset: 0.0 };\r\n      }\r\n    }\r\n\r\n    return new FormatterSpec(name, format, conversions, inputUnit, azimuthBaseConversion, revolutionConversion);\r\n  }\r\n\r\n  /** Format a quantity value. */\r\n  public applyFormatting(magnitude: number): string {\r\n    return Formatter.formatQuantity(magnitude, this);\r\n  }\r\n}\r\n"]}

package/lib/esm/Formatter/Interfaces.d.ts

@@ -16,11 +16,22 @@ export interface FormatProps {
     readonly decimalSeparator?: string;
     readonly thousandSeparator?: string;
     readonly uomSeparator?: string;
+    /** conditionally required. */
     readonly scientificType?: string;
+    /** conditionally required. */
     readonly stationOffsetSize?: number;
     readonly stationSeparator?: string;
+    /** The base value for azimuth, specified from east counter-clockwise. */
+    readonly azimuthBase?: number;
+    /** The name of the unit for the azimuth base value. */
+    readonly azimuthBaseUnit?: string;
+    /** If set to true, azimuth values are returned counter-clockwise from the base. */
+    readonly azimuthCounterClockwise?: boolean;
+    /** The name of the unit that represents a revolution/perigon. Required for bearing or azimuth types. */
+    readonly revolutionUnit?: string;
     readonly allowMathematicOperations?: boolean;
     readonly composite?: {
+        /** separates values when formatting composite strings */
         readonly spacer?: string;
         readonly includeZero?: boolean;
         readonly units: Array<{

package/lib/esm/Formatter/Interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Interfaces.d.ts","sourceRoot":"","sources":["../../../src/Formatter/Interfaces.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEhG;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1C,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAC7C,QAAQ,CAAC,SAAS,CAAC,EAAE;QACnB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;QAC/B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;YACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;YACtB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;SACzB,CAAC,CAAC;KACJ,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC;CACtB;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,SAAU,WAAW,8BAEpD,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,yEAAyE;IACzE,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,oCAAoC;IACpC,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,4CAA4C;IAC5C,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,uFAAuF;IACvF,SAAS,CAAC,EAAE,gBAAgB,GAAG,mBAAmB,CAAC;IACnD,oDAAoD;IACpD,WAAW,CAAC,EAAE,SAAS,CAAC;CACzB"}
+{"version":3,"file":"Interfaces.d.ts","sourceRoot":"","sources":["../../../src/Formatter/Interfaces.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEhG;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1C,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAE/B,8BAA8B;IAC9B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAEjC,8BAA8B;IAC9B,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAEnC,yEAAyE;IACzE,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B,uDAAuD;IACvD,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAElC,mFAAmF;IACnF,QAAQ,CAAC,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAE3C,wGAAwG;IACxG,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAEjC,QAAQ,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAC7C,QAAQ,CAAC,SAAS,CAAC,EAAE;QACnB,yDAAyD;QACzD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;QAC/B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;YACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;YACtB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;SACzB,CAAC,CAAC;KACJ,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC;CACtB;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,SAAU,WAAW,8BAEpD,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,yEAAyE;IACzE,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,oCAAoC;IACpC,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,4CAA4C;IAC5C,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,uFAAuF;IACvF,SAAS,CAAC,EAAE,gBAAgB,GAAG,mBAAmB,CAAC;IACnD,oDAAoD;IACpD,WAAW,CAAC,EAAE,SAAS,CAAC;CACzB"}

package/lib/esm/Formatter/Interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"Interfaces.js","sourceRoot":"","sources":["../../../src/Formatter/Interfaces.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAuCH;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAAiB,EAA6B,EAAE;IAClF,OAAQ,IAA0B,CAAC,MAAM,KAAK,SAAS,CAAC;AAC1D,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Quantity\r\n */\r\n\r\nimport { UnitProps } from \"../Interfaces\";\r\nimport { DecimalPrecision, FormatTraits, FormatType, FractionalPrecision } from \"./FormatEnums\";\r\n\r\n/** This interface defines the persistence format for describing the formatting of quantity values.\r\n * @beta\r\n */\r\nexport interface FormatProps {\r\n  readonly type: string;\r\n  readonly precision?: number;\r\n  readonly roundFactor?: number;\r\n  readonly minWidth?: number;\r\n  readonly showSignOption?: string;\r\n  readonly formatTraits?: string | string[];\r\n  readonly decimalSeparator?: string;\r\n  readonly thousandSeparator?: string;\r\n  readonly uomSeparator?: string;\r\n  readonly scientificType?: string; // conditionally required\r\n  readonly stationOffsetSize?: number; // conditionally required\r\n  readonly stationSeparator?: string;\r\n  readonly allowMathematicOperations?: boolean;\r\n  readonly composite?: {\r\n    readonly spacer?: string;\r\n    readonly includeZero?: boolean; // not currently used in Native formatter\r\n    readonly units: Array<{\r\n      readonly name: string;\r\n      readonly label?: string;\r\n    }>;\r\n  };\r\n}\r\n\r\n/** This interface is used when supporting Custom Formatters that need more than the standard set of properties.\r\n * @beta\r\n */\r\nexport interface CustomFormatProps extends FormatProps {\r\n  readonly custom: any;\r\n}\r\n\r\n/** CustomFormatProps type guard.\r\n * @beta\r\n */\r\nexport const isCustomFormatProps = (item: FormatProps): item is CustomFormatProps => {\r\n  return (item as CustomFormatProps).custom !== undefined;\r\n};\r\n\r\n/** CloneFormat defines unit and label specification if primary unit is to be set during clone.\r\n * @beta\r\n */\r\nexport interface CloneUnit {\r\n  unit?: UnitProps;\r\n  label?: string;\r\n}\r\n\r\n/** CloneOptions that define modifications that can be made during the cloning of a Format.\r\n * @beta\r\n */\r\nexport interface CloneOptions {\r\n  /** allows composite formats to be converted to only show primary unit */\r\n  showOnlyPrimaryUnit?: boolean;\r\n  /** allow format traits to be set */\r\n  traits?: FormatTraits;\r\n  /** allows new FormatType to be specified */\r\n  type?: FormatType;\r\n  /** allows precision to be set, this will throw if value is not valid for FormatType */\r\n  precision?: DecimalPrecision | FractionalPrecision;\r\n  /** allows primary unit and label to be specified */\r\n  primaryUnit?: CloneUnit;\r\n}\r\n"]}
+{"version":3,"file":"Interfaces.js","sourceRoot":"","sources":["../../../src/Formatter/Interfaces.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAyDH;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAAiB,EAA6B,EAAE;IAClF,OAAQ,IAA0B,CAAC,MAAM,KAAK,SAAS,CAAC;AAC1D,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Quantity\r\n */\r\n\r\nimport { UnitProps } from \"../Interfaces\";\r\nimport { DecimalPrecision, FormatTraits, FormatType, FractionalPrecision } from \"./FormatEnums\";\r\n\r\n/** This interface defines the persistence format for describing the formatting of quantity values.\r\n * @beta\r\n */\r\nexport interface FormatProps {\r\n  readonly type: string;\r\n  readonly precision?: number;\r\n  readonly roundFactor?: number;\r\n  readonly minWidth?: number;\r\n  readonly showSignOption?: string;\r\n  readonly formatTraits?: string | string[];\r\n  readonly decimalSeparator?: string;\r\n  readonly thousandSeparator?: string;\r\n  readonly uomSeparator?: string;\r\n\r\n  /** conditionally required. */\r\n  readonly scientificType?: string;\r\n\r\n  /** conditionally required. */\r\n  readonly stationOffsetSize?: number;\r\n  readonly stationSeparator?: string;\r\n\r\n  /** The base value for azimuth, specified from east counter-clockwise. */\r\n  readonly azimuthBase?: number;\r\n\r\n  /** The name of the unit for the azimuth base value. */\r\n  readonly azimuthBaseUnit?: string;\r\n\r\n  /** If set to true, azimuth values are returned counter-clockwise from the base. */\r\n  readonly azimuthCounterClockwise?: boolean;\r\n\r\n  /** The name of the unit that represents a revolution/perigon. Required for bearing or azimuth types. */\r\n  readonly revolutionUnit?: string;\r\n\r\n  readonly allowMathematicOperations?: boolean;\r\n  readonly composite?: {\r\n    /** separates values when formatting composite strings */\r\n    readonly spacer?: string;\r\n    readonly includeZero?: boolean;\r\n    readonly units: Array<{\r\n      readonly name: string;\r\n      readonly label?: string;\r\n    }>;\r\n  };\r\n}\r\n\r\n/** This interface is used when supporting Custom Formatters that need more than the standard set of properties.\r\n * @beta\r\n */\r\nexport interface CustomFormatProps extends FormatProps {\r\n  readonly custom: any;\r\n}\r\n\r\n/** CustomFormatProps type guard.\r\n * @beta\r\n */\r\nexport const isCustomFormatProps = (item: FormatProps): item is CustomFormatProps => {\r\n  return (item as CustomFormatProps).custom !== undefined;\r\n};\r\n\r\n/** CloneFormat defines unit and label specification if primary unit is to be set during clone.\r\n * @beta\r\n */\r\nexport interface CloneUnit {\r\n  unit?: UnitProps;\r\n  label?: string;\r\n}\r\n\r\n/** CloneOptions that define modifications that can be made during the cloning of a Format.\r\n * @beta\r\n */\r\nexport interface CloneOptions {\r\n  /** allows composite formats to be converted to only show primary unit */\r\n  showOnlyPrimaryUnit?: boolean;\r\n  /** allow format traits to be set */\r\n  traits?: FormatTraits;\r\n  /** allows new FormatType to be specified */\r\n  type?: FormatType;\r\n  /** allows precision to be set, this will throw if value is not valid for FormatType */\r\n  precision?: DecimalPrecision | FractionalPrecision;\r\n  /** allows primary unit and label to be specified */\r\n  primaryUnit?: CloneUnit;\r\n}\r\n"]}

package/lib/esm/Parser.d.ts

@@ -14,7 +14,8 @@ export declare enum ParseError {
     UnknownUnit = 4,
     UnableToConvertParseTokensToQuantity = 5,
     InvalidParserSpec = 6,
-    MathematicOperationFoundButIsNotAllowed = 7
+    BearingPrefixOrSuffixMissing = 7,
+    MathematicOperationFoundButIsNotAllowed = 8
 }
 /** Parse error result from [[Parser.parseToQuantityValue]] or [[Parser.parseToQuantityValue]].
  * @beta
@@ -106,6 +107,11 @@ export declare class Parser {
      *  @param unitsConversions dictionary of conversions used to convert from unit used in inString to output quantity
      */
     static parseToQuantityValue(inString: string, format: Format, unitsConversions: UnitConversionSpec[]): QuantityParseResult;
+    private static parseBearingFormat;
+    private static parseAzimuthFormat;
+    private static normalizeAngle;
+    private static getRevolution;
+    private static parseAndProcessTokens;
     /** Async Method used to create an array of UnitConversionSpec entries that can be used in synchronous calls to parse units. */
     static createUnitConversionSpecsForUnit(unitsProvider: UnitsProvider, outUnit: UnitProps, altUnitLabelsProvider?: AlternateUnitLabelsProvider): Promise<UnitConversionSpec[]>;
     /** Async Method used to create an array of UnitConversionSpec entries that can be used in synchronous calls to parse units. */

package/lib/esm/Parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Parser.d.ts","sourceRoot":"","sources":["../../src/Parser.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C,OAAO,EAAE,2BAA2B,EAAE,kBAAkB,EAAE,aAAa,EAAuB,kBAAkB,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AACjK,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C;;GAEG;AACH,oBAAY,UAAU;IACpB,2BAA2B,IAAI;IAC/B,0BAA0B,IAAA;IAC1B,8BAA8B,IAAA;IAC9B,WAAW,IAAA;IACX,oCAAoC,IAAA;IACpC,iBAAiB,IAAA;IACjB,uCAAuC,IAAA;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,uDAAuD;IACvD,EAAE,EAAE,KAAK,CAAC;IACV,uDAAuD;IACvD,KAAK,EAAE,UAAU,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,uDAAuD;IACvD,EAAE,EAAE,IAAI,CAAC;IACT,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAC;CACf;AAED,aAAK,QAAQ;IACX,QAAQ,MAAM;IACd,WAAW,MAAM;CAClB;AAUD;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,cAAc,GAAG,kBAAkB,CAAC;AAEtE;;GAEG;AACH,cAAM,UAAU;IACP,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;IAClC,UAAU,EAAE,OAAO,CAAS;gBAEvB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ;IAS7C,IAAW,QAAQ,IAAI,OAAO,CAA+D;IAC7F,IAAW,QAAQ,IAAI,OAAO,CAA2C;CAC1E;AA+BD;;GAEG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAS;WAEd,gBAAgB,CAAC,IAAI,EAAE,mBAAmB,GAAG,IAAI,IAAI,cAAc;WAInE,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,IAAI,IAAI,kBAAkB;IAIjF,OAAO,CAAC,MAAM,CAAC,0BAA0B;IAoBzC,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAyChC,OAAO,CAAC,MAAM,CAAC,OAAO;IAItB,OAAO,CAAC,MAAM,CAAC,yBAAyB;IAIxC;;OAEG;WACW,0BAA0B,CAAC,qBAAqB,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE;IAoKrG,OAAO,CAAC,MAAM,CAAC,qBAAqB;mBAYf,iBAAiB;IA6BtC;;OAEG;mBACkB,wCAAwC;IAqC7D;;OAEG;mBACkB,6BAA6B;IAYlD;;;;OAIG;WACiB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,qBAAqB,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,aAAa,CAAC;IAQlL,2DAA2D;IAC3D,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAyCpC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,wBAAwB;IAevC,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAkC/B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,+BAA+B;IAoD9C;;;OAGG;WACW,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,mBAAmB;IAIhG;;;;OAIG;WACW,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,GAAG,mBAAmB;IAmCjI,+HAA+H;WAC3G,gCAAgC,CAAC,aAAa,EAAE,aAAa,EAAE,OAAO,EAAE,SAAS,EAAE,qBAAqB,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IA4B1L,+HAA+H;WAC3G,yBAAyB,CAAC,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,EAAE,qBAAqB,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;CAgDhO"}
+{"version":3,"file":"Parser.d.ts","sourceRoot":"","sources":["../../src/Parser.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C,OAAO,EAAE,2BAA2B,EAAE,kBAAkB,EAAE,aAAa,EAAuB,kBAAkB,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AACjK,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C;;GAEG;AACH,oBAAY,UAAU;IACpB,2BAA2B,IAAI;IAC/B,0BAA0B,IAAA;IAC1B,8BAA8B,IAAA;IAC9B,WAAW,IAAA;IACX,oCAAoC,IAAA;IACpC,iBAAiB,IAAA;IACjB,4BAA4B,IAAA;IAC5B,uCAAuC,IAAA;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,uDAAuD;IACvD,EAAE,EAAE,KAAK,CAAC;IACV,uDAAuD;IACvD,KAAK,EAAE,UAAU,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,uDAAuD;IACvD,EAAE,EAAE,IAAI,CAAC;IACT,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAC;CACf;AAED,aAAK,QAAQ;IACX,QAAQ,MAAM;IACd,WAAW,MAAM;CAClB;AAUD;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,cAAc,GAAG,kBAAkB,CAAC;AAEtE;;GAEG;AACH,cAAM,UAAU;IACP,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;IAClC,UAAU,EAAE,OAAO,CAAS;gBAEvB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ;IAS7C,IAAW,QAAQ,IAAI,OAAO,CAA+D;IAC7F,IAAW,QAAQ,IAAI,OAAO,CAA2C;CAC1E;AA+BD;;GAEG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAS;WAEd,gBAAgB,CAAC,IAAI,EAAE,mBAAmB,GAAG,IAAI,IAAI,cAAc;WAInE,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,IAAI,IAAI,kBAAkB;IAIjF,OAAO,CAAC,MAAM,CAAC,0BAA0B;IAoBzC,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAyChC,OAAO,CAAC,MAAM,CAAC,OAAO;IAItB,OAAO,CAAC,MAAM,CAAC,yBAAyB;IAIxC;;OAEG;WACW,0BAA0B,CAAC,qBAAqB,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE;IAoKrG,OAAO,CAAC,MAAM,CAAC,qBAAqB;mBAYf,iBAAiB;IA6BtC;;OAEG;mBACkB,wCAAwC;IAqC7D;;OAEG;mBACkB,6BAA6B;IAYlD;;;;OAIG;WACiB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,qBAAqB,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,aAAa,CAAC;IAQlL,2DAA2D;IAC3D,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAyCpC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,wBAAwB;IAevC,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAkC/B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,+BAA+B;IAkE9C;;;OAGG;WACW,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,mBAAmB;IAwBhG;;;;OAIG;WACW,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,GAAG,mBAAmB;IAyBjI,OAAO,CAAC,MAAM,CAAC,kBAAkB;IA4DjC,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAyCjC,OAAO,CAAC,MAAM,CAAC,cAAc;IAS7B,OAAO,CAAC,MAAM,CAAC,aAAa;IAc5B,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAsBpC,+HAA+H;WAC3G,gCAAgC,CAAC,aAAa,EAAE,aAAa,EAAE,OAAO,EAAE,SAAS,EAAE,qBAAqB,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IA4B1L,+HAA+H;WAC3G,yBAAyB,CAAC,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,EAAE,qBAAqB,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;CAgDhO"}

package/lib/esm/Parser.js

@@ -6,6 +6,7 @@
  * @module Quantity
  */
 import { QuantityConstants } from "./Constants";
+import { QuantityError, QuantityStatus } from "./Exception";
 import { FormatTraits, FormatType } from "./Formatter/FormatEnums";
 import { Quantity } from "./Quantity";
 /** Possible parser errors
@@ -19,7 +20,8 @@ export var ParseError;
     ParseError[ParseError["UnknownUnit"] = 4] = "UnknownUnit";
     ParseError[ParseError["UnableToConvertParseTokensToQuantity"] = 5] = "UnableToConvertParseTokensToQuantity";
     ParseError[ParseError["InvalidParserSpec"] = 6] = "InvalidParserSpec";
-    ParseError[ParseError["MathematicOperationFoundButIsNotAllowed"] = 7] = "MathematicOperationFoundButIsNotAllowed";
+    ParseError[ParseError["BearingPrefixOrSuffixMissing"] = 7] = "BearingPrefixOrSuffixMissing";
+    ParseError[ParseError["MathematicOperationFoundButIsNotAllowed"] = 8] = "MathematicOperationFoundButIsNotAllowed";
 })(ParseError || (ParseError = {}));
 var Operator;
 (function (Operator) {
@@ -487,6 +489,7 @@ export class Parser {
         let mag = 0.0;
         // The sign is saved outside from the loop for cases like this. '-1m 50cm 10mm + 2m 30cm 40mm' => -1.51m + 2.34m
         let sign = 1;
+        let compositeUnitIndex = 0;
         for (let i = 0; i < tokens.length; i = i + increment) {
             tokenPair = this.getNextTokenPair(i, tokens);
             if (!tokenPair || tokenPair.length === 0) {
@@ -497,6 +500,7 @@ export class Parser {
             if (tokenPair[0].isOperator) {
                 sign = tokenPair[0].value === Operator.addition ? 1 : -1;
                 tokenPair.shift();
+                compositeUnitIndex = 0; // Reset the composite unit index, the following tokens begin from start.
             }
             // unit specification comes before value (like currency)
             if (tokenPair.length === 2 && tokenPair[0].isString) {
@@ -507,13 +511,26 @@ export class Parser {
                 let value = sign * tokenPair[0].value;
                 let conversion;
                 if (tokenPair.length === 2 && tokenPair[1].isString) {
-                    conversion = Parser.tryFindUnitConversion(tokenPair[1].value, unitsConversions, defaultUnit);
+                    const spacer = format.spacerOrDefault;
+                    if (tokenPair[1].value !== spacer) { // ignore spacer
+                        conversion = Parser.tryFindUnitConversion(tokenPair[1].value, unitsConversions, defaultUnit);
+                    }
+                }
+                if (!conversion) {
+                    if (compositeUnitIndex > 0 && format.units && format.units.length > compositeUnitIndex) {
+                        // if this is not the first token, and we have a composite spec, look up the unit from the current index
+                        const presUnitAtIndex = format.units[compositeUnitIndex][0];
+                        conversion = Parser.tryFindUnitConversion(presUnitAtIndex.label, unitsConversions, presUnitAtIndex);
+                    }
+                    else if (defaultUnitConversion) {
+                        conversion = defaultUnitConversion;
+                    }
                 }
-                conversion = conversion ? conversion : defaultUnitConversion;
                 if (conversion) {
                     value = (value * conversion.factor) + conversion.offset;
                 }
                 mag = mag + value;
+                compositeUnitIndex++;
             }
             else {
                 // only the unit label was specified so assume magnitude of 0
@@ -531,7 +548,25 @@ export class Parser {
      *  @param parserSpec unit label if not explicitly defined by user. Must have matching entry in supplied array of unitsConversions.
      */
     static parseQuantityString(inString, parserSpec) {
-        return Parser.parseToQuantityValue(inString, parserSpec.format, parserSpec.unitConversions);
+        // ensure any labels defined in composite unit definition are specified in unitConversions
+        if (parserSpec.format.units) {
+            parserSpec.format.units.forEach(([unit, label]) => {
+                if (label) {
+                    if (unit.label !== label) { // if default unit label does not match composite label ensure the label is in the list of parse labels for the conversion
+                        const unitConversion = parserSpec.unitConversions.find((conversion) => conversion.name === unit.name);
+                        if (unitConversion && unitConversion.parseLabels && !unitConversion.parseLabels.find((entry) => entry === label))
+                            unitConversion.parseLabels.push(label);
+                    }
+                }
+            });
+        }
+        if (parserSpec.format.type === FormatType.Bearing) {
+            return this.parseBearingFormat(inString, parserSpec);
+        }
+        if (parserSpec.format.type === FormatType.Azimuth) {
+            return this.parseAzimuthFormat(inString, parserSpec);
+        }
+        return this.parseAndProcessTokens(inString, parserSpec.format, parserSpec.unitConversions);
     }
     /** Method to generate a Quantity given a string that represents a quantity value and likely a unit label.
      *  @param inString A string that contains text represent a quantity.
@@ -539,6 +574,8 @@ export class Parser {
      *  @param unitsConversions dictionary of conversions used to convert from unit used in inString to output quantity
      */
     static parseToQuantityValue(inString, format, unitsConversions) {
+        // TODO: This method is not able to do bearing and azimuth formatting and is overlapping with parseQuantityString.
+        // We should consider deprecating and removing it, there do not seem to be any upstream callers at this moment
         // ensure any labels defined in composite unit definition are specified in unitConversions
         if (format.units) {
             format.units.forEach(([unit, label]) => {
@@ -551,6 +588,123 @@ export class Parser {
                 }
             });
         }
+        if (format.type === FormatType.Bearing || format.type === FormatType.Azimuth) {
+            // throw error indicating to call parseQuantityString instead
+            throw new QuantityError(QuantityStatus.UnsupportedUnit, `Bearing and Azimuth format must be parsed using a ParserSpec. Call parseQuantityString instead.`);
+        }
+        return this.parseAndProcessTokens(inString, format, unitsConversions);
+    }
+    static parseBearingFormat(inString, spec) {
+        // TODO: at some point we will want to open this for localization, in the first release it's going to be hard coded
+        let DirectionLabel;
+        (function (DirectionLabel) {
+            DirectionLabel["North"] = "N";
+            DirectionLabel["South"] = "S";
+            DirectionLabel["East"] = "E";
+            DirectionLabel["West"] = "W";
+        })(DirectionLabel || (DirectionLabel = {}));
+        let matchedPrefix = null;
+        let matchedSuffix = null;
+        // check if input string begins with northLabel or southLabel and strip it off
+        if (inString.startsWith(DirectionLabel.North)) {
+            inString = inString.substring(DirectionLabel.North.length);
+            matchedPrefix = DirectionLabel.North;
+        }
+        else if (inString.startsWith(DirectionLabel.South)) {
+            inString = inString.substring(DirectionLabel.South.length);
+            matchedPrefix = DirectionLabel.South;
+        }
+        // check if input string ends with eastLabel or westLabel and strip it off
+        if (inString.endsWith(DirectionLabel.East)) {
+            inString = inString.substring(0, inString.length - DirectionLabel.East.length);
+            matchedSuffix = DirectionLabel.East;
+        }
+        else if (inString.endsWith(DirectionLabel.West)) {
+            inString = inString.substring(0, inString.length - DirectionLabel.West.length);
+            matchedSuffix = DirectionLabel.West;
+        }
+        if (matchedPrefix === null && matchedSuffix === null) {
+            return { ok: false, error: ParseError.BearingPrefixOrSuffixMissing };
+        }
+        const parsedResult = this.parseAndProcessTokens(inString, spec.format, spec.unitConversions);
+        if (this.isParseError(parsedResult) || !parsedResult.ok) {
+            return parsedResult;
+        }
+        let magnitude = parsedResult.value;
+        const revolution = this.getRevolution(spec);
+        magnitude = this.normalizeAngle(magnitude, revolution);
+        const quarterRevolution = revolution / 4;
+        // we have to turn the value into an east base and counter clockwise (NW and SE are already counter clockwise)
+        if (matchedPrefix === DirectionLabel.North) {
+            if (matchedSuffix === DirectionLabel.West) {
+                magnitude = quarterRevolution + magnitude;
+            }
+            else if (matchedSuffix === DirectionLabel.East) {
+                magnitude = quarterRevolution - magnitude;
+            }
+        }
+        else if (matchedPrefix === DirectionLabel.South) {
+            if (matchedSuffix === DirectionLabel.West) {
+                magnitude = (3 * quarterRevolution) - magnitude;
+            }
+            else if (matchedSuffix === DirectionLabel.East) {
+                magnitude = (3 * quarterRevolution) + magnitude;
+            }
+        }
+        return { ok: true, value: magnitude };
+    }
+    static parseAzimuthFormat(inString, spec) {
+        const parsedResult = this.parseAndProcessTokens(inString, spec.format, spec.unitConversions);
+        if (this.isParseError(parsedResult) || !parsedResult.ok) {
+            return parsedResult;
+        }
+        let magnitude = parsedResult.value;
+        const revolution = this.getRevolution(spec);
+        magnitude = this.normalizeAngle(magnitude, revolution);
+        const quarterRevolution = revolution / 4;
+        let azimuthBase = quarterRevolution;
+        if (spec.format.azimuthBase !== undefined) {
+            if (spec.azimuthBaseConversion === undefined) {
+                throw new QuantityError(QuantityStatus.MissingRequiredProperty, `Missing azimuth base conversion for interpreting ${spec.format.name}'s azimuth base.`);
+            }
+            const azBaseQuantity = new Quantity(spec.format.azimuthBaseUnit, spec.format.azimuthBase);
+            const azBaseConverted = azBaseQuantity.convertTo(spec.outUnit, spec.azimuthBaseConversion);
+            if (azBaseConverted === undefined || !azBaseConverted.isValid) {
+                throw new QuantityError(QuantityStatus.UnsupportedUnit, `Failed to convert azimuth base unit to ${spec.outUnit.name}.`);
+            }
+            azimuthBase = this.normalizeAngle(azBaseConverted.magnitude, revolution);
+        }
+        const azimuthCounterClockwise = spec.format.azimuthCounterClockwiseOrDefault;
+        if (azimuthCounterClockwise && azimuthBase === 0) {
+            // parsed result already has the same base and orientation as our desired output
+            return parsedResult;
+        }
+        if (azimuthCounterClockwise)
+            magnitude = azimuthBase + magnitude;
+        else
+            magnitude = azimuthBase - magnitude;
+        magnitude = this.normalizeAngle(magnitude, revolution);
+        return { ok: true, value: magnitude };
+    }
+    // TODO: The following two methods are redundant with Formatter. We should consider consolidating them.
+    static normalizeAngle(magnitude, revolution) {
+        magnitude = magnitude % revolution; // Strip anything that goes around more than once
+        if (magnitude < 0) // If the value is negative, we want to normalize it to a positive angle
+            magnitude += revolution;
+        return magnitude;
+    }
+    static getRevolution(spec) {
+        if (spec.revolutionConversion === undefined) {
+            throw new QuantityError(QuantityStatus.MissingRequiredProperty, `Missing revolution unit conversion for calculating ${spec.format.name}'s revolution.`);
+        }
+        const revolution = new Quantity(spec.format.revolutionUnit, 1.0);
+        const converted = revolution.convertTo(spec.outUnit, spec.revolutionConversion);
+        if (converted === undefined || !converted.isValid) {
+            throw new QuantityError(QuantityStatus.UnsupportedUnit, `Failed to convert revolution unit to ${spec.outUnit.name} On format ${spec.format.name}.`);
+        }
+        return converted.magnitude;
+    }
+    static parseAndProcessTokens(inString, format, unitsConversions) {
         const tokens = Parser.parseQuantitySpecification(inString, format);
         if (tokens.length === 0)
             return { ok: false, error: ParseError.UnableToGenerateParseTokens };