@itwin/core-quantity 3.0.0-extension.0 → 3.1.0-dev.5

package/lib/esm/ParserSpec.js.map

@@ -1 +1 @@
-{"version":3,"file":"ParserSpec.js","sourceRoot":"","sources":["../../src/ParserSpec.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH,OAAO,EAAE,MAAM,EAAuB,MAAM,UAAU,CAAC;AAEvD;;GAEG;AACH,MAAM,OAAO,UAAU;IAKrB;;;;OAIG;IACH,YAAY,OAAkB,EAAE,MAAc,EAAE,WAAiC;QARzE,iBAAY,GAAyB,EAAE,CAAC,CAAE,mBAAmB;QASnE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED,wGAAwG;IACxG,IAAW,eAAe,KAA2B,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAChF,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACpD,IAAW,OAAO,KAAgB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEzD;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAc,EAAE,aAA4B,EAAE,OAAkB;QACzF,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,gCAAgC,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC1F,OAAO,IAAI,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IACtD,CAAC;IAED,0HAA0H;IACnH,oBAAoB,CAAC,QAAgB;QAC1C,OAAO,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACpD,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 { Format } from \"./Formatter/Format\";\r\nimport { UnitConversionSpec, UnitProps, UnitsProvider } from \"./Interfaces\";\r\nimport { Parser, QuantityParseResult } from \"./Parser\";\r\n\r\n/** A ParserSpec holds information needed to parse a string into a quantity synchronously.\r\n * @beta\r\n */\r\nexport class ParserSpec {\r\n  private _outUnit: UnitProps;\r\n  private _conversions: UnitConversionSpec[] = [];  // max four entries\r\n  private _format: Format;\r\n\r\n  /** Constructor\r\n   *  @param outUnit     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   */\r\n  constructor(outUnit: UnitProps, format: Format, conversions: UnitConversionSpec[]) {\r\n    this._outUnit = outUnit;\r\n    this._format = format;\r\n    this._conversions = conversions;\r\n  }\r\n\r\n  /** Returns an array of UnitConversionSpecs for each unit label that may be used in the input string. */\r\n  public get unitConversions(): UnitConversionSpec[] { return this._conversions; }\r\n  public get format(): Format { return this._format; }\r\n  public get outUnit(): UnitProps { return this._outUnit; }\r\n\r\n  /** Static async method to create a ParserSpec given the format and unit of the quantity that will be passed to the Parser. 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 format     The 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 outUnit The unit the value to be formatted. This unit is often referred to as persistence unit.\r\n   */\r\n  public static async create(format: Format, unitsProvider: UnitsProvider, outUnit: UnitProps): Promise<ParserSpec> {\r\n    const conversions = await Parser.createUnitConversionSpecsForUnit(unitsProvider, outUnit);\r\n    return new ParserSpec(outUnit, format, conversions);\r\n  }\r\n\r\n  /** Do the parsing. Done this way to allow Custom Parser Specs to parse custom formatted strings into their quantities. */\r\n  public parseToQuantityValue(inString: string): QuantityParseResult {\r\n    return Parser.parseQuantityString(inString, this);\r\n  }\r\n}\r\n\r\n"]}
+{"version":3,"file":"ParserSpec.js","sourceRoot":"","sources":["../../src/ParserSpec.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH,OAAO,EAAE,MAAM,EAAuB,MAAM,UAAU,CAAC;AAEvD;;GAEG;AACH,MAAM,OAAO,UAAU;IAKrB;;;;OAIG;IACH,YAAY,OAAkB,EAAE,MAAc,EAAE,WAAiC;QARzE,iBAAY,GAAyB,EAAE,CAAC,CAAE,mBAAmB;QASnE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED,wGAAwG;IACxG,IAAW,eAAe,KAA2B,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAChF,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACpD,IAAW,OAAO,KAAgB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEzD;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAc,EAAE,aAA4B,EAAE,OAAkB,EAAE,qBAAmD;QAC9I,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,gCAAgC,CAAC,aAAa,EAAE,OAAO,EAAE,qBAAqB,CAAC,CAAC;QACjH,OAAO,IAAI,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IACtD,CAAC;IAED,0HAA0H;IACnH,oBAAoB,CAAC,QAAgB;QAC1C,OAAO,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACpD,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 { Format } from \"./Formatter/Format\";\r\nimport { AlternateUnitLabelsProvider, UnitConversionSpec, UnitProps, UnitsProvider } from \"./Interfaces\";\r\nimport { Parser, QuantityParseResult } from \"./Parser\";\r\n\r\n/** A ParserSpec holds information needed to parse a string into a quantity synchronously.\r\n * @beta\r\n */\r\nexport class ParserSpec {\r\n  private _outUnit: UnitProps;\r\n  private _conversions: UnitConversionSpec[] = [];  // max four entries\r\n  private _format: Format;\r\n\r\n  /** Constructor\r\n   *  @param outUnit     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   */\r\n  constructor(outUnit: UnitProps, format: Format, conversions: UnitConversionSpec[]) {\r\n    this._outUnit = outUnit;\r\n    this._format = format;\r\n    this._conversions = conversions;\r\n  }\r\n\r\n  /** Returns an array of UnitConversionSpecs for each unit label that may be used in the input string. */\r\n  public get unitConversions(): UnitConversionSpec[] { return this._conversions; }\r\n  public get format(): Format { return this._format; }\r\n  public get outUnit(): UnitProps { return this._outUnit; }\r\n\r\n  /** Static async method to create a ParserSpec given the format and unit of the quantity that will be passed to the Parser. 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 format     The 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 outUnit The unit the value to be formatted. This unit is often referred to as persistence unit.\r\n   */\r\n  public static async create(format: Format, unitsProvider: UnitsProvider, outUnit: UnitProps, altUnitLabelsProvider?: AlternateUnitLabelsProvider): Promise<ParserSpec> {\r\n    const conversions = await Parser.createUnitConversionSpecsForUnit(unitsProvider, outUnit, altUnitLabelsProvider);\r\n    return new ParserSpec(outUnit, format, conversions);\r\n  }\r\n\r\n  /** Do the parsing. Done this way to allow Custom Parser Specs to parse custom formatted strings into their quantities. */\r\n  public parseToQuantityValue(inString: string): QuantityParseResult {\r\n    return Parser.parseQuantityString(inString, this);\r\n  }\r\n}\r\n\r\n"]}

package/lib/esm/Unit.d.ts

@@ -10,9 +10,8 @@ export declare class BasicUnit implements UnitProps {
     label: string;
     phenomenon: string;
     isValid: boolean;
-    alternateLabels?: string[];
     system: string;
-    constructor(name: string, label: string, phenomenon: string, alternateLabels?: string[], system?: string);
+    constructor(name: string, label: string, phenomenon: string, system?: string);
 }
 /** This class is a convenience class that can be returned when a valid Unit cannot be determined.
  * @beta

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

@@ -1 +1 @@
-{"version":3,"file":"Unit.d.ts","sourceRoot":"","sources":["../../src/Unit.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC;;GAEG;AACH,qBAAa,SAAU,YAAW,SAAS;IAClC,IAAI,SAAM;IACV,KAAK,SAAM;IACX,UAAU,SAAM;IAChB,OAAO,UAAS;IAChB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAa;gBAEtB,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM;CAWzG;AAED;;GAEG;AACH,qBAAa,OAAQ,YAAW,SAAS;IAChC,IAAI,SAAM;IACV,KAAK,SAAM;IACX,UAAU,SAAM;IAChB,OAAO,UAAS;IAChB,MAAM,SAAa;CAC3B"}
+{"version":3,"file":"Unit.d.ts","sourceRoot":"","sources":["../../src/Unit.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC;;GAEG;AACH,qBAAa,SAAU,YAAW,SAAS;IAClC,IAAI,SAAM;IACV,KAAK,SAAM;IACX,UAAU,SAAM;IAChB,OAAO,UAAS;IAChB,MAAM,EAAE,MAAM,CAAa;gBAEtB,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;CAU7E;AAED;;GAEG;AACH,qBAAa,OAAQ,YAAW,SAAS;IAChC,IAAI,SAAM;IACV,KAAK,SAAM;IACX,UAAU,SAAM;IAChB,OAAO,UAAS;IAChB,MAAM,SAAa;CAC3B"}

package/lib/esm/Unit.js

@@ -9,7 +9,7 @@
  * @beta
  */
 export class BasicUnit {
-    constructor(name, label, phenomenon, alternateLabels, system) {
+    constructor(name, label, phenomenon, system) {
         this.name = "";
         this.label = "";
         this.phenomenon = "";
@@ -19,7 +19,6 @@ export class BasicUnit {
             this.name = name;
             this.label = label;
             this.phenomenon = phenomenon;
-            this.alternateLabels = alternateLabels;
             this.isValid = true;
             if (system)
                 this.system = system;

package/lib/esm/Unit.js.map

@@ -1 +1 @@
-{"version":3,"file":"Unit.js","sourceRoot":"","sources":["../../src/Unit.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH;;GAEG;AACH,MAAM,OAAO,SAAS;IAQpB,YAAY,IAAY,EAAE,KAAa,EAAE,UAAkB,EAAE,eAA0B,EAAE,MAAe;QAPjG,SAAI,GAAG,EAAE,CAAC;QACV,UAAK,GAAG,EAAE,CAAC;QACX,eAAU,GAAG,EAAE,CAAC;QAChB,YAAO,GAAG,KAAK,CAAC;QAEhB,WAAM,GAAW,SAAS,CAAC;QAGhC,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/F,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;YACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACnB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAC7B,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;YACvC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACpB,IAAI,MAAM;gBACR,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;SACxB;IACH,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,OAAO;IAApB;QACS,SAAI,GAAG,EAAE,CAAC;QACV,UAAK,GAAG,EAAE,CAAC;QACX,eAAU,GAAG,EAAE,CAAC;QAChB,YAAO,GAAG,KAAK,CAAC;QAChB,WAAM,GAAG,SAAS,CAAC;IAC5B,CAAC;CAAA","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\n\r\n/** This class provides basic implementation of UnitProps interface.\r\n * @beta\r\n */\r\nexport class BasicUnit implements UnitProps {\r\n  public name = \"\";\r\n  public label = \"\";\r\n  public phenomenon = \"\";\r\n  public isValid = false;\r\n  public alternateLabels?: string[];\r\n  public system: string = \"unknown\";\r\n\r\n  constructor(name: string, label: string, phenomenon: string, alternateLabels?: string[], system?: string) {\r\n    if (name && name.length > 0 && label && label.length > 0 && phenomenon && phenomenon.length > 0) {\r\n      this.name = name;\r\n      this.label = label;\r\n      this.phenomenon = phenomenon;\r\n      this.alternateLabels = alternateLabels;\r\n      this.isValid = true;\r\n      if (system)\r\n        this.system = system;\r\n    }\r\n  }\r\n}\r\n\r\n/** This class is a convenience class that can be returned when a valid Unit cannot be determined.\r\n * @beta\r\n */\r\nexport class BadUnit implements UnitProps {\r\n  public name = \"\";\r\n  public label = \"\";\r\n  public phenomenon = \"\";\r\n  public isValid = false;\r\n  public system = \"unknown\";\r\n}\r\n"]}
+{"version":3,"file":"Unit.js","sourceRoot":"","sources":["../../src/Unit.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH;;GAEG;AACH,MAAM,OAAO,SAAS;IAOpB,YAAY,IAAY,EAAE,KAAa,EAAE,UAAkB,EAAE,MAAe;QANrE,SAAI,GAAG,EAAE,CAAC;QACV,UAAK,GAAG,EAAE,CAAC;QACX,eAAU,GAAG,EAAE,CAAC;QAChB,YAAO,GAAG,KAAK,CAAC;QAChB,WAAM,GAAW,SAAS,CAAC;QAGhC,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/F,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;YACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACnB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAC7B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACpB,IAAI,MAAM;gBACR,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;SACxB;IACH,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,OAAO;IAApB;QACS,SAAI,GAAG,EAAE,CAAC;QACV,UAAK,GAAG,EAAE,CAAC;QACX,eAAU,GAAG,EAAE,CAAC;QAChB,YAAO,GAAG,KAAK,CAAC;QAChB,WAAM,GAAG,SAAS,CAAC;IAC5B,CAAC;CAAA","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\n\r\n/** This class provides basic implementation of UnitProps interface.\r\n * @beta\r\n */\r\nexport class BasicUnit implements UnitProps {\r\n  public name = \"\";\r\n  public label = \"\";\r\n  public phenomenon = \"\";\r\n  public isValid = false;\r\n  public system: string = \"unknown\";\r\n\r\n  constructor(name: string, label: string, phenomenon: string, system?: string) {\r\n    if (name && name.length > 0 && label && label.length > 0 && phenomenon && phenomenon.length > 0) {\r\n      this.name = name;\r\n      this.label = label;\r\n      this.phenomenon = phenomenon;\r\n      this.isValid = true;\r\n      if (system)\r\n        this.system = system;\r\n    }\r\n  }\r\n}\r\n\r\n/** This class is a convenience class that can be returned when a valid Unit cannot be determined.\r\n * @beta\r\n */\r\nexport class BadUnit implements UnitProps {\r\n  public name = \"\";\r\n  public label = \"\";\r\n  public phenomenon = \"\";\r\n  public isValid = false;\r\n  public system = \"unknown\";\r\n}\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/core-quantity",
-  "version": "3.0.0-extension.0",
+  "version": "3.1.0-dev.5",
   "description": "Quantity parsing, formatting and conversions for iModel.js",
   "main": "lib/cjs/core-quantity.js",
   "module": "lib/esm/core-quantity.js",
@@ -9,7 +9,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/imodeljs/imodeljs/tree/master/core/quantity"
+    "url": "https://github.com/iTwin/itwinjs-core/tree/master/core/quantity"
   },
   "keywords": [
     "Bentley",
@@ -21,9 +21,9 @@
     "url": "http://www.bentley.com"
   },
   "devDependencies": {
-    "@itwin/core-bentley": "3.0.0-extension.0",
-    "@itwin/build-tools": "3.0.0-extension.0",
-    "@itwin/eslint-plugin": "3.0.0-extension.0",
+    "@itwin/build-tools": "3.1.0-dev.5",
+    "@itwin/core-bentley": "3.1.0-dev.5",
+    "@itwin/eslint-plugin": "3.1.0-dev.5",
     "@types/chai": "^4.1.4",
     "@types/chai-as-promised": "^7",
     "@types/glob": "^5.0.35",
@@ -40,7 +40,7 @@
     "typescript": "~4.4.0"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "^3.0.0-extension.0"
+    "@itwin/core-bentley": "^3.1.0-dev.5"
   },
   "nyc": {
     "extends": "./node_modules/@itwin/build-tools/.nycrc"
@@ -63,5 +63,6 @@
     "docs": "betools docs --includes=../../generated-docs/extract --json=../../generated-docs/core/core-quantity/file.json --tsIndexFile=./core-quantity.ts --onlyJson",
     "cover": "nyc npm -s test",
     "start": "npm run -s lint && npm run -s clean && npm run -s build && npm run -s test & npm run -s cover & npm run -s docs"
-  }
+  },
+  "readme": "# @itwin/core-quantity\r\n\r\nCopyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.\r\n\r\n## Description\r\n\r\nThe __@itwin/core-quantity__ package contains classes for quantity formatting and parsing.\r\n\r\n## Documentation\r\n\r\nSee the [iTwin.js](https://www.itwinjs.org) documentation for more information.\r\n"
 }