@itwin/core-quantity 4.10.0-dev.2 → 4.10.0-dev.20

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

package/lib/esm/Interfaces.d.ts

@@ -46,13 +46,26 @@ export interface UnitConversionSpec {
     /** Labels that may be used to represent the unit in a string that is to be parsed. */
     parseLabels?: string[];
 }
+/** Indicates the way in which unit values are inverted during conversion
+ * @beta
+ */
+export declare enum UnitConversionInvert {
+    /** Invert value before applying the other conversion steps (the from-unit is the inverted unit) */
+    InvertPreConversion = "InvertPreConversion",
+    /** Invert value after applying the other conversion steps (the to-unit is the inverted unit) */
+    InvertPostConversion = "InvertPostConversion"
+}
 /** This interface defines the properties required to convert a quantity value from one unit to another such as from meters to feet
  * or from Celsius to Fahrenheit.
  * @beta
  */
 export interface UnitConversionProps {
+    /** The factor to multiply the input value by to convert to the output value. */
     factor: number;
+    /** The offset to add to the input value to convert to the output value. */
     offset: number;
+    /** If set, inverts the unit value (1/x) before or after conversion. */
+    inversion?: UnitConversionInvert;
 }
 /** Interface that defines potential parse units that may be found in user's string input of a quantity value.
  * @beta

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

@@ -1 +1 @@
-{"version":3,"file":"Interfaces.d.ts","sourceRoot":"","sources":["../../src/Interfaces.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,sBAAsB,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,MAAM,EAAE,GAAG,SAAS,CAAC;CACnE;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,4BAA4B;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,8BAA8B;IAC9B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,wHAAwH;IACxH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,qEAAqE;IACrE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,uGAAuG;IACvG,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,sEAAsE;IACtE,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,KAAK,EAAE,MAAM,CAAC;IACd,kEAAkE;IAClE,MAAM,EAAE,MAAM,CAAC;IACf,+EAA+E;IAC/E,UAAU,EAAE,mBAAmB,CAAC;IAChC,sFAAsF;IACtF,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAC/G,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAC3D,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACrD,aAAa,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;CACrF;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,UAAU,GAAG,aAAa,GAAG,UAAU,CAAC"}
+{"version":3,"file":"Interfaces.d.ts","sourceRoot":"","sources":["../../src/Interfaces.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,sBAAsB,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,MAAM,EAAE,GAAG,SAAS,CAAC;CACnE;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,4BAA4B;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,8BAA8B;IAC9B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,wHAAwH;IACxH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,qEAAqE;IACrE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,uGAAuG;IACvG,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,sEAAsE;IACtE,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,KAAK,EAAE,MAAM,CAAC;IACd,kEAAkE;IAClE,MAAM,EAAE,MAAM,CAAC;IACf,+EAA+E;IAC/E,UAAU,EAAE,mBAAmB,CAAC;IAChC,sFAAsF;IACtF,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,oBAAY,oBAAoB;IAC9B,mGAAmG;IACnG,mBAAmB,wBAAwB;IAC3C,gGAAgG;IAChG,oBAAoB,yBAAyB;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,gFAAgF;IAChF,MAAM,EAAE,MAAM,CAAC;IACf,2EAA2E;IAC3E,MAAM,EAAE,MAAM,CAAC;IACf,uEAAuE;IACvE,SAAS,CAAC,EAAE,oBAAoB,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAC/G,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAC3D,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACrD,aAAa,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;CACrF;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,UAAU,GAAG,aAAa,GAAG,UAAU,CAAC"}

package/lib/esm/Interfaces.js

@@ -5,5 +5,14 @@
 /** @packageDocumentation
  * @module Quantity
  */
-export {};
+/** Indicates the way in which unit values are inverted during conversion
+ * @beta
+ */
+export var UnitConversionInvert;
+(function (UnitConversionInvert) {
+    /** Invert value before applying the other conversion steps (the from-unit is the inverted unit) */
+    UnitConversionInvert["InvertPreConversion"] = "InvertPreConversion";
+    /** Invert value after applying the other conversion steps (the to-unit is the inverted unit) */
+    UnitConversionInvert["InvertPostConversion"] = "InvertPostConversion";
+})(UnitConversionInvert || (UnitConversionInvert = {}));
 //# sourceMappingURL=Interfaces.js.map

package/lib/esm/Interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"Interfaces.js","sourceRoot":"","sources":["../../src/Interfaces.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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\n/** This interface allows a provider to be specified that will define an array of alternate labels for a specific unit.\r\n * @beta\r\n */\r\nexport interface AlternateUnitLabelsProvider {\r\n  getAlternateUnitLabels: (unit: UnitProps) => string[] | undefined;\r\n}\r\n\r\n/** This interface provides basic information about a Unit that is return from a UnitProvider. This info\r\n * uniquely identifies a unit by its name.\r\n * @beta\r\n */\r\nexport interface UnitProps {\r\n  /** Unique name for unit. */\r\n  readonly name: string;\r\n  /** Default label for unit. */\r\n  readonly label: string;\r\n  /** Unique name of unit phenomenon. Example phenomenon names include 'Units.LENGTH', 'Units.AREA', and 'Units.VOLUME' */\r\n  readonly phenomenon: string;\r\n  /** This is set to true if the Unit is known by the UnitsProvider. */\r\n  readonly isValid: boolean;\r\n  /** Unique system name. Example \"Units.USCUSTOM\",\" Units.METRIC\", \"Units.USSURVEY\", \"Units.IMPERIAL\" */\r\n  readonly system: string;\r\n}\r\n\r\n/** This interface defines the required properties of a Quantity.\r\n * @beta\r\n */\r\nexport interface QuantityProps {\r\n  readonly magnitude: number;\r\n  readonly unit: UnitProps;\r\n  readonly isValid: boolean;\r\n}\r\n\r\n/** Interface that defines how to convert between a specific unit an another in synchronous formatting or parsing processing.\r\n * @beta\r\n */\r\nexport interface UnitConversionSpec {\r\n  /** Unit name that was used to locate the unit by the Unit Provider */\r\n  name: string;\r\n  /** The default label that is used to display unit */\r\n  label: string;\r\n  /** Unit system name, used to when finding preferred parse unit */\r\n  system: string;\r\n  /** the information necessary to convert the unit to a specific display unit */\r\n  conversion: UnitConversionProps;\r\n  /** Labels that may be used to represent the unit in a string that is to be parsed. */\r\n  parseLabels?: string[];\r\n}\r\n\r\n/** This interface defines the properties required to convert a quantity value from one unit to another such as from meters to feet\r\n * or from Celsius to Fahrenheit.\r\n * @beta\r\n */\r\nexport interface UnitConversionProps {\r\n  factor: number;\r\n  offset: number;\r\n}\r\n\r\n/** Interface that defines potential parse units that may be found in user's string input of a quantity value.\r\n * @beta\r\n */\r\nexport interface PotentialParseUnit {\r\n  unitName: string;\r\n  altLabels?: string[];\r\n}\r\n\r\n/**\r\n * This interface defines extra properties to be associated with Units from Units Schema by name\r\n * @alpha\r\n */\r\nexport interface UnitExtraData {\r\n  readonly name: string;\r\n  readonly altDisplayLabels: string[];\r\n}\r\n\r\n/** This interface is implemented by the class that is responsible for locating units by name or label and providing conversion values between units.\r\n * The methods to be implemented are async allowing the UnitsProvider to query the backend when necessary to look up unit definition and conversion rules.\r\n * @beta\r\n */\r\nexport interface UnitsProvider {\r\n  findUnit(unitLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps>;\r\n  getUnitsByFamily(phenomenon: string): Promise<UnitProps[]>;\r\n  findUnitByName(unitName: string): Promise<UnitProps>;\r\n  getConversion(fromUnit: UnitProps, toUnit: UnitProps): Promise<UnitConversionProps>;\r\n}\r\n\r\n/**\r\n * Used to uniquely identify a unit system.\r\n * @beta\r\n */\r\nexport type UnitSystemKey = \"metric\" | \"imperial\" | \"usCustomary\" | \"usSurvey\";\r\n"]}
+{"version":3,"file":"Interfaces.js","sourceRoot":"","sources":["../../src/Interfaces.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAmDH;;GAEG;AACH,MAAM,CAAN,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,mGAAmG;IACnG,mEAA2C,CAAA;IAC3C,gGAAgG;IAChG,qEAA6C,CAAA;AAC/C,CAAC,EALW,oBAAoB,KAApB,oBAAoB,QAK/B","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Quantity\n */\n\n/** This interface allows a provider to be specified that will define an array of alternate labels for a specific unit.\n * @beta\n */\nexport interface AlternateUnitLabelsProvider {\n  getAlternateUnitLabels: (unit: UnitProps) => string[] | undefined;\n}\n\n/** This interface provides basic information about a Unit that is return from a UnitProvider. This info\n * uniquely identifies a unit by its name.\n * @beta\n */\nexport interface UnitProps {\n  /** Unique name for unit. */\n  readonly name: string;\n  /** Default label for unit. */\n  readonly label: string;\n  /** Unique name of unit phenomenon. Example phenomenon names include 'Units.LENGTH', 'Units.AREA', and 'Units.VOLUME' */\n  readonly phenomenon: string;\n  /** This is set to true if the Unit is known by the UnitsProvider. */\n  readonly isValid: boolean;\n  /** Unique system name. Example \"Units.USCUSTOM\",\" Units.METRIC\", \"Units.USSURVEY\", \"Units.IMPERIAL\" */\n  readonly system: string;\n}\n\n/** This interface defines the required properties of a Quantity.\n * @beta\n */\nexport interface QuantityProps {\n  readonly magnitude: number;\n  readonly unit: UnitProps;\n  readonly isValid: boolean;\n}\n\n/** Interface that defines how to convert between a specific unit an another in synchronous formatting or parsing processing.\n * @beta\n */\nexport interface UnitConversionSpec {\n  /** Unit name that was used to locate the unit by the Unit Provider */\n  name: string;\n  /** The default label that is used to display unit */\n  label: string;\n  /** Unit system name, used to when finding preferred parse unit */\n  system: string;\n  /** the information necessary to convert the unit to a specific display unit */\n  conversion: UnitConversionProps;\n  /** Labels that may be used to represent the unit in a string that is to be parsed. */\n  parseLabels?: string[];\n}\n\n/** Indicates the way in which unit values are inverted during conversion\n * @beta\n */\nexport enum UnitConversionInvert {\n  /** Invert value before applying the other conversion steps (the from-unit is the inverted unit) */\n  InvertPreConversion = \"InvertPreConversion\",\n  /** Invert value after applying the other conversion steps (the to-unit is the inverted unit) */\n  InvertPostConversion = \"InvertPostConversion\"\n}\n\n/** This interface defines the properties required to convert a quantity value from one unit to another such as from meters to feet\n * or from Celsius to Fahrenheit.\n * @beta\n */\nexport interface UnitConversionProps {\n  /** The factor to multiply the input value by to convert to the output value. */\n  factor: number;\n  /** The offset to add to the input value to convert to the output value. */\n  offset: number;\n  /** If set, inverts the unit value (1/x) before or after conversion. */\n  inversion?: UnitConversionInvert;\n}\n\n/** Interface that defines potential parse units that may be found in user's string input of a quantity value.\n * @beta\n */\nexport interface PotentialParseUnit {\n  unitName: string;\n  altLabels?: string[];\n}\n\n/**\n * This interface defines extra properties to be associated with Units from Units Schema by name\n * @alpha\n */\nexport interface UnitExtraData {\n  readonly name: string;\n  readonly altDisplayLabels: string[];\n}\n\n/** This interface is implemented by the class that is responsible for locating units by name or label and providing conversion values between units.\n * The methods to be implemented are async allowing the UnitsProvider to query the backend when necessary to look up unit definition and conversion rules.\n * @beta\n */\nexport interface UnitsProvider {\n  findUnit(unitLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps>;\n  getUnitsByFamily(phenomenon: string): Promise<UnitProps[]>;\n  findUnitByName(unitName: string): Promise<UnitProps>;\n  getConversion(fromUnit: UnitProps, toUnit: UnitProps): Promise<UnitConversionProps>;\n}\n\n/**\n * Used to uniquely identify a unit system.\n * @beta\n */\nexport type UnitSystemKey = \"metric\" | \"imperial\" | \"usCustomary\" | \"usSurvey\";\n"]}

package/lib/esm/Parser.d.ts

@@ -105,10 +105,12 @@ export declare class Parser {
      *  @param inString A string that contains text represent a quantity.
      *  @param format   Defines the likely format of inString. Primary unit serves as a default unit if no unit label found in string.
      *  @param unitsConversions dictionary of conversions used to convert from unit used in inString to output quantity
+     *  @deprecated in 4.10. Check [[Parser.parseQuantityString]] for replacements.
      */
     static parseToQuantityValue(inString: string, format: Format, unitsConversions: UnitConversionSpec[]): QuantityParseResult;
     private static parseBearingFormat;
     private static parseAzimuthFormat;
+    private static parseRatioFormat;
     private static normalizeAngle;
     private static getRevolution;
     private static parseAndProcessTokens;

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

@@ -1 +1 @@
-{"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"}
+{"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;IA4BhG;;;;;OAKG;WACW,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,GAAG,mBAAmB;IAyBjI,OAAO,CAAC,MAAM,CAAC,kBAAkB;IA0DjC,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAuCjC,OAAO,CAAC,MAAM,CAAC,gBAAgB;IA0D/B,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

@@ -8,7 +8,7 @@
 import { QuantityConstants } from "./Constants";
 import { QuantityError, QuantityStatus } from "./Exception";
 import { FormatTraits, FormatType } from "./Formatter/FormatEnums";
-import { Quantity } from "./Quantity";
+import { applyConversion, Quantity } from "./Quantity";
 /** Possible parser errors
  * @beta
  */
@@ -30,7 +30,7 @@ var Operator;
 })(Operator || (Operator = {}));
 function isOperator(char) {
     if (typeof char === "number") {
-        // Convert the charcode to string.
+        // Convert the CharCode to string.
         char = String.fromCharCode(char);
     }
     return Object.values(Operator).includes(char);
@@ -277,7 +277,7 @@ export class Parser {
                         continue;
                     }
                     if (wipToken.length === 0 && charCode === QuantityConstants.CHAR_SPACE) {
-                        // Dont add space when the wip token is empty.
+                        // Don't add space when the wip token is empty.
                         continue;
                     }
                     wipToken = wipToken.concat(str[i]);
@@ -527,7 +527,7 @@ export class Parser {
                     }
                 }
                 if (conversion) {
-                    value = (value * conversion.factor) + conversion.offset;
+                    value = applyConversion(value, conversion);
                 }
                 mag = mag + value;
                 compositeUnitIndex++;
@@ -566,12 +566,16 @@ export class Parser {
         if (parserSpec.format.type === FormatType.Azimuth) {
             return this.parseAzimuthFormat(inString, parserSpec);
         }
+        if (parserSpec.format.type === FormatType.Ratio) {
+            return this.parseRatioFormat(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.
      *  @param format   Defines the likely format of inString. Primary unit serves as a default unit if no unit label found in string.
      *  @param unitsConversions dictionary of conversions used to convert from unit used in inString to output quantity
+     *  @deprecated in 4.10. Check [[Parser.parseQuantityString]] for replacements.
      */
     static parseToQuantityValue(inString, format, unitsConversions) {
         // TODO: This method is not able to do bearing and azimuth formatting and is overlapping with parseQuantityString.
@@ -588,9 +592,9 @@ export class Parser {
                 }
             });
         }
-        if (format.type === FormatType.Bearing || format.type === FormatType.Azimuth) {
+        if (format.type === FormatType.Bearing || format.type === FormatType.Azimuth || format.type === FormatType.Ratio) {
             // 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.`);
+            throw new QuantityError(QuantityStatus.UnsupportedUnit, `Bearing, Azimuth or Ratio format must be parsed using a ParserSpec. Call parseQuantityString instead.`);
         }
         return this.parseAndProcessTokens(inString, format, unitsConversions);
     }
@@ -637,18 +641,15 @@ export class Parser {
         // 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;
+                magnitude = revolution - magnitude;
             }
         }
         else if (matchedPrefix === DirectionLabel.South) {
             if (matchedSuffix === DirectionLabel.West) {
-                magnitude = (3 * quarterRevolution) - magnitude;
+                magnitude = (2 * quarterRevolution) + magnitude;
             }
             else if (matchedSuffix === DirectionLabel.East) {
-                magnitude = (3 * quarterRevolution) + magnitude;
+                magnitude = (2 * quarterRevolution) - magnitude;
             }
         }
         return { ok: true, value: magnitude };
@@ -661,8 +662,7 @@ export class Parser {
         let magnitude = parsedResult.value;
         const revolution = this.getRevolution(spec);
         magnitude = this.normalizeAngle(magnitude, revolution);
-        const quarterRevolution = revolution / 4;
-        let azimuthBase = quarterRevolution;
+        let azimuthBase = 0.0;
         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.`);
@@ -674,18 +674,67 @@ export class Parser {
             }
             azimuthBase = this.normalizeAngle(azBaseConverted.magnitude, revolution);
         }
-        const azimuthCounterClockwise = spec.format.azimuthCounterClockwiseOrDefault;
-        if (azimuthCounterClockwise && azimuthBase === 0) {
+        const inputIsClockwise = spec.format.azimuthClockwiseOrDefault;
+        if (inputIsClockwise && azimuthBase === 0) {
             // parsed result already has the same base and orientation as our desired output
             return parsedResult;
         }
-        if (azimuthCounterClockwise)
+        if (inputIsClockwise)
             magnitude = azimuthBase + magnitude;
         else
             magnitude = azimuthBase - magnitude;
         magnitude = this.normalizeAngle(magnitude, revolution);
         return { ok: true, value: magnitude };
     }
+    static parseRatioFormat(inString, spec) {
+        if (!inString)
+            return { ok: false, error: ParseError.NoValueOrUnitFoundInString };
+        const parts = inString.split(":");
+        if (parts.length > 2)
+            return { ok: false, error: ParseError.UnableToConvertParseTokensToQuantity };
+        const numerator = parseFloat(parts[0]);
+        let denominator;
+        if (parts.length === 1) {
+            denominator = 1.0;
+        }
+        else {
+            denominator = parseFloat(parts[1]);
+        }
+        if (isNaN(numerator) || isNaN(denominator))
+            return { ok: false, error: ParseError.NoValueOrUnitFoundInString };
+        const defaultUnit = spec.format.units && spec.format.units.length > 0 ? spec.format.units[0][0] : undefined;
+        const unitConversion = defaultUnit ? Parser.tryFindUnitConversion(defaultUnit.label, spec.unitConversions, defaultUnit) : undefined;
+        if (!unitConversion) {
+            throw new QuantityError(QuantityStatus.MissingRequiredProperty, `Missing input unit or unit conversion for interpreting ${spec.format.name}.`);
+        }
+        if (denominator === 0) {
+            if (unitConversion.inversion && numerator === 1)
+                return { ok: true, value: 0.0 };
+            else
+                return { ok: false, error: ParseError.MathematicOperationFoundButIsNotAllowed };
+        }
+        let quantity;
+        if (spec.format.units && spec.outUnit) {
+            quantity = new Quantity(spec.format.units[0][0], numerator / denominator);
+        }
+        else {
+            throw new QuantityError(QuantityStatus.MissingRequiredProperty, "Missing presentation unit or persistence unit for ratio format.");
+        }
+        let converted;
+        try {
+            converted = quantity.convertTo(spec.outUnit, unitConversion);
+        }
+        catch (err) {
+            // for input of "0:N" with reversed unit
+            if (err instanceof QuantityError && err.errorNumber === QuantityStatus.InvertingZero) {
+                return { ok: false, error: ParseError.MathematicOperationFoundButIsNotAllowed };
+            }
+        }
+        if (converted === undefined || !converted.isValid) {
+            throw new QuantityError(QuantityStatus.UnsupportedUnit, `Failed to convert from ${spec.format.units[0][0].name} to ${spec.outUnit.name} On format ${spec.format.name}.`);
+        }
+        return { ok: true, value: converted.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