@lhncbc/ucum-lhc 4.2.0 → 5.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lhncbc/ucum-lhc",
-  "version": "4.2.0",
+  "version": "5.0.2",
   "description": "Implements Unified Code for Units of Measure (UCUM) functions in a javascript library",
   "main": "source-cjs/ucumPkg.js",
   "homepage": "https://lhncbc.github.io/ucum-lhc/",

package/source/ucumLhcUtils.js

@@ -130,19 +130,12 @@ export class UcumLhcUtils {
 
     let resp = this.getSpecifiedUnit(uStr, valConv, suggest);
     let theUnit = resp['unit'];
-    let retObj = {};
-    if (!theUnit) {
-      retObj = {'status': (!resp['origString'] || resp['origString'] === null) ?
-                           'error' : 'invalid',
-                'ucumCode': null};
-    }
-    else {
-      retObj = {'status': resp['origString'] === uStr ? 'valid': 'invalid',
-                'ucumCode': resp['origString'],
-                'unit': {'code': theUnit.csCode_,
-                         'name': theUnit.name_,
-                         'guidance': theUnit.guidance_ }};
-    }
+    let retObj = !theUnit ? {'ucumCode': null} :
+      {'ucumCode': resp['origString'],
+       'unit': {'code': theUnit.csCode_,
+                'name': theUnit.name_,
+                'guidance': theUnit.guidance_ }};
+    retObj.status = resp.status;
     if (resp['suggestions']) {
       retObj['suggestions'] = resp['suggestions'];
     }
@@ -228,12 +221,7 @@ export class UcumLhcUtils {
       returnObj['status'] = 'error';
       returnObj['msg'].push('No "from" unit expression specified.');
     }
-    if (fromVal === null || isNaN(fromVal) || (typeof fromVal !== 'number' &&
-        !intUtils_.isNumericString(fromVal))) {
-      returnObj['status'] = 'error';
-      returnObj['msg'].push('No "from" value, or an invalid "from" value, ' +
-                         'was specified.');
-    }
+    this._checkFromVal(fromVal, returnObj);
     if (toUnitCode) {
       toUnitCode = toUnitCode.trim();
     }
@@ -343,63 +331,77 @@ export class UcumLhcUtils {
    * @param fromUnit the unit string to be converted to base units information
    * @param fromVal the number of "from" units to be converted
    * @returns an object with the properties:
-   *  'msg': an array of one or more messages, if the string is invalid or
+   *  'status' indicates whether the result succeeded.  The value will be one of:
+   *    'succeeded':  the conversion was successfully calculated (which can be
+   *      true even if it was already in base units);
+   *    'invalid':  fromUnit is not a valid UCUM code;
+   *    'failed':  the conversion could not be made (e.g., if it is an "arbitrary" unit);
+   *    'error':  if an error occurred (an input or programming error)
+   *  'msg': an array of messages (possibly empty) if the string is invalid or
    *        an error occurred, indicating the problem, or a suggestion of a
    *        substitution such as the substitution of 'G' for 'Gauss', or
-   *        an empty array if no messages were generated.  If this is not empty,
-   *        no other information will be returned.
+   *        an empty array if no messages were generated.  There can also be a
+   *        message that is just informational or warning.
    *  'magnitude': the new value when fromVal units of fromUnits is expressed in the base units.
    *  'fromUnitIsSpecial': whether the input unit fromUnit is a "special unit"
    *         as defined in UCUM.  This means there is some function applied to convert
    *         between fromUnit and the base units, so the returned magnitude is likely not
    *         useful as a scale factor for other conversions (i.e., it only has validity
    *         and usefulness for the input values that produced it).
-   *  'unitToExp': a map of base units in uStr to their exponent
+   *  'unitToExp': a map of base units in fromUnit to their exponent
    */
   convertToBaseUnits(fromUnit, fromVal) {
-    let inputUnitLookup = this.getSpecifiedUnit(fromUnit, 'validate');
     let retObj = {};
-    let unit = inputUnitLookup.unit;
-    retObj.msg = inputUnitLookup.retMsg || [];
-    if (!unit) {
-      if (inputUnitLookup.retMsg?.length == 0)
-        retObj.msg.push('Could not find unit information for '+fromUnit);
-    }
-    else if (unit.isArbitrary_) {
-      retObj.msg.push('Arbitrary units cannot be converted to base units or other units.');
-    }
-    else if (retObj.msg.length == 0) {
-      let unitToExp = {};
-      let dimVec = unit.dim_?.dimVec_
-      let baseUnitString = '1';
-      if (dimVec) {
-        let dimVecIndexToBaseUnit = UnitTables.getInstance().dimVecIndexToBaseUnit_;
-        for (let i=0, len=dimVec.length; i<len; ++i) {
-          let exp = dimVec[i];
-          if (exp) {
-            unitToExp[dimVecIndexToBaseUnit[i]] = exp;
-            baseUnitString += '.' + dimVecIndexToBaseUnit[i] + exp;
+    this._checkFromVal(fromVal, retObj);
+    if (!retObj.status) { // could be set to 'error' by _checkFromVal
+      let inputUnitLookup = this.getSpecifiedUnit(fromUnit, 'validate');
+      retObj = {status: inputUnitLookup.status == 'valid' ? 'succeeded' : inputUnitLookup.status};
+      let unit = inputUnitLookup.unit;
+      retObj.msg = inputUnitLookup.retMsg || [];
+      if (!unit) {
+        if (inputUnitLookup.retMsg?.length == 0)
+          retObj.msg.push('Could not find unit information for '+fromUnit);
+      }
+      else if (unit.isArbitrary_) {
+        retObj.msg.push('Arbitrary units cannot be converted to base units or other units.');
+        retObj.status = 'failed';
+      }
+      else if (retObj.status == 'succeeded') {
+        let unitToExp = {};
+        let dimVec = unit.dim_?.dimVec_
+        let baseUnitString = '1';
+        if (dimVec) {
+          let dimVecIndexToBaseUnit = UnitTables.getInstance().dimVecIndexToBaseUnit_;
+          for (let i=0, len=dimVec.length; i<len; ++i) {
+            let exp = dimVec[i];
+            if (exp) {
+              unitToExp[dimVecIndexToBaseUnit[i]] = exp;
+              baseUnitString += '.' + dimVecIndexToBaseUnit[i] + exp;
+            }
           }
         }
-      }
 
-      // The unit might have a conversion function, which has to be applied; we
-      // cannot just assume unit_.magnitude_ is the magnitude in base units.
-      let retUnitLookup = this.getSpecifiedUnit(baseUnitString, 'validate');
-      // There should not be any error in retUnitLookup, unless there is a bug.
-      let retUnit = retUnitLookup.unit;
-      if (!retUnit && retUnitLookup.retMsg?.length == 0)
-        retObj.msg.push('Unable construct base unit string; tried '+baseUnitString);
-      else {
-        try {
-          retObj.magnitude = retUnit.convertFrom(fromVal, unit);
-        }
-        catch (e) {
-          retObj.msg.push(e.toString());
+        // The unit might have a conversion function, which has to be applied; we
+        // cannot just assume unit_.magnitude_ is the magnitude in base units.
+        let retUnitLookup = this.getSpecifiedUnit(baseUnitString, 'validate');
+        // There should not be any error in retUnitLookup, unless there is a bug.
+        let retUnit = retUnitLookup.unit;
+        if (retUnitLookup.status !== 'valid') {
+          retObj.msg.push('Unable construct base unit string; tried '+baseUnitString);
+          retObj.status = 'error';
         }
-        if (retObj.msg.length == 0) {
-          retObj.unitToExp = unitToExp;
-          retObj.fromUnitIsSpecial = unit.isSpecial_;
+        else {
+          try {
+            retObj.magnitude = retUnit.convertFrom(fromVal, unit);
+          }
+          catch (e) {
+            retObj.msg.push(e.toString());
+            retObj.status = 'error';
+          }
+          if (retObj.status == 'succeeded') {
+            retObj.unitToExp = unitToExp;
+            retObj.fromUnitIsSpecial = unit.isSpecial_;
+          }
         }
       }
     }
@@ -407,6 +409,26 @@ export class UcumLhcUtils {
   }
 
 
+  /**
+   *  Checks the given value as to whether it is suitable as a "from" value in a
+   *  unit conversion.  If it is not, the responseObj will have its status set
+   *  to 'error' and a message added.
+   * @param fromVal The value to check
+   * @param responseObj the object that will be updated if the value is not
+   *  usable.
+   */
+  _checkFromVal(fromVal, responseObj) {
+    if (fromVal === null || isNaN(fromVal) || (typeof fromVal !== 'number' &&
+        !intUtils_.isNumericString(fromVal))) {
+      responseObj.status = 'error';
+      if (!responseObj.msg)
+        responseObj.msg = [];
+      responseObj.msg.push('No "from" value, or an invalid "from" value, ' +
+                         'was specified.');
+    }
+  }
+
+
   /**
    * This method accepts a term and looks for units that include it as
    * a synonym - or that include the term in its name.
@@ -450,13 +472,18 @@ export class UcumLhcUtils {
    *  true indicates suggestions are wanted; false indicates they are not,
    *  and is the default if the parameter is not specified;
    * @returns a hash containing:
+   *   'status' will be 'valid' (uName is a valid UCUM code), 'invalid'
+   *     (the uStr is not a valid UCUM code, and substitutions or
+   *     suggestions may or may not be returned, depending on what was
+   *     requested and found); or 'error' (an input or programming error
+   *     occurred);
    *   'unit' the unit object (or null if there were problems creating the
    *     unit);
    *   'origString' the possibly updated unit string passed in;
    *   'retMsg' an array of user messages (informational, error or warning) if
    *     any were generated (IF any were generated, otherwise will be an
    *     empty array); and
-   *  'suggestions' is an array of 1 or more hash objects.  Each hash
+   *   'suggestions' is an array of 1 or more hash objects.  Each hash
    *     contains three elements:
    *       'msg' which is a message indicating what unit expression the
    *          suggestions are for;
@@ -511,6 +538,17 @@ export class UcumLhcUtils {
       } // end if the unit was not found as a unit name
     } // end if a unit expression was specified
 
+    // Set the status field
+    if (!retObj.unit) {
+      // No unit was found; check whether origString has a value
+      retObj.status = !retObj.origString ? 'error' : 'invalid';
+    }
+    else {
+      // Check whether substitutions were made to the unit string in order to
+      // find the unit
+      retObj.status = retObj.origString === uName ? 'valid': 'invalid';
+    }
+
     return retObj;
 
   } // end getSpecifiedUnit
@@ -582,7 +620,3 @@ export class UcumLhcUtils {
 UcumLhcUtils.getInstance = function(){
   return new UcumLhcUtils();
 } ;
-
-
-
-

package/source/ucumXmlDocument.js

@@ -116,7 +116,10 @@ export class UcumXmlDocument {
       attrs["exp_"] = pValNode.childNamed('sup');
       if (attrs["exp_"] != null) {
         attrs["exp_"] = attrs["exp_"].val;
-        attrs["value_"] = Math.pow(10, attrs["exp_"]);
+        // Use parseFloat('1eSOMETHING') instead of Math.pow() to avoid
+        // small number changes like 1.0000000000000001e-21. See LF-2830.
+        // attrs["value_"] = Math.pow(10, attrs["exp_"]);
+        attrs["value_"] = parseFloat(`1e${attrs["exp_"]}`);
       }
       else {
         attrs["value_"] = pValNode.val;
@@ -519,4 +522,4 @@ UcumXmlDocument.getInstance = function(){
 
 // Perform the first request for the document object, to get the
 // getInstance method set.
-UcumXmlDocument.getInstance();
+UcumXmlDocument.getInstance();

package/source/unit.js

@@ -839,7 +839,8 @@ export class Unit {
   invertString(theString) {
 
     if (theString.length > 0) {
-      let stringRep = theString.replace('/', "!").replace('.', '/').replace("!", '.');
+      // replace('<!', '</') is here to make sure closing html tags like </sup> are intact. See LF-2830.
+      let stringRep = theString.replace('/', "!").replace('.', '/').replace('<!', '</').replace("!", '.');
       switch(stringRep.charAt(0)) {
         case '.' : theString = stringRep.substr(1); break;
         case '/' : theString = stringRep; break;

package/source/unitString.js

@@ -878,11 +878,16 @@ export class UnitString {
       else {
 
         if (intUtils_.isNumericString(aftText)) {
-          pStr += aftText;
-          retUnit = retUnit.power(Number(aftText));
-          this.retMsg_.push(`An exponent (${aftText}) following a parenthesis ` +
-            `is invalid as of revision 1.9 of the UCUM Specification.\n  ` +
-            this.vcMsgStart_ + pStr + this.vcMsgEnd_);
+          retUnit = null;
+          let msg = `An exponent (${aftText}) following a parenthesis ` +
+            `is invalid as of revision 1.9 of the UCUM Specification.`;
+          // Add the suggestion only if the string in the parenthesis don't end with a number.
+          if (!pStr.match(/\d$/)) {
+            pStr += aftText;
+            msg += '\n  ' + this.vcMsgStart_ + pStr + this.vcMsgEnd_;
+          }
+          this.retMsg_.push(msg);
+          endProcessing = true;
         }
         // else the text after the parentheses is neither a number nor
         // an annotation.  If suggestions were NOT requested, record an
@@ -1149,143 +1154,150 @@ export class UnitString {
           origUnit = this.utabs_.getUnitByCode(uCode);
         }
 
+        // If an exponent is found but it's not a valid number, e.g. "2-1",
+        // mark the unit invalid. Otherwise, the "-1" part will be ignored
+        // because parseInt("2-1") results in 2. See LF-2870.
+        if (exp && isNaN(exp)) {
+          retUnit = null;
+          this.retMsg_.push(`${origCode} is not a valid UCUM code.`);
+        }
+        else {
+          // If we still don't have a unit, separate out the prefix, if any,
+          // and try without it.
+          if (!origUnit) {
+            // Try for a single character prefix first.
+            pfxCode = uCode.charAt(0);
+            pfxObj = this.pfxTabs_.getPrefixByCode(pfxCode);
+
+            // if we got a prefix, get its info and remove it from the unit code
+            if (pfxObj) {
+              pfxVal = pfxObj.getValue();
+              pfxExp = pfxObj.getExp();
+              let pCodeLen = pfxCode.length;
+              uCode = uCode.substr(pCodeLen);
 
-        // If we still don't have a unit, separate out the prefix, if any,
-        // and try without it.
-        if (!origUnit) {
-          // Try for a single character prefix first.
-          pfxCode = uCode.charAt(0);
-          pfxObj = this.pfxTabs_.getPrefixByCode(pfxCode);
-
-          // if we got a prefix, get its info and remove it from the unit code
-          if (pfxObj) {
-            pfxVal = pfxObj.getValue();
-            pfxExp = pfxObj.getExp();
-            let pCodeLen = pfxCode.length;
-            uCode = uCode.substr(pCodeLen);
+              // try again for the unit
+              origUnit = this.utabs_.getUnitByCode(uCode);
 
-            // try again for the unit
-            origUnit = this.utabs_.getUnitByCode(uCode);
+              // If we still don't have a unit, see if the prefix could be the
+              // two character "da" (deka) prefix.  That's the only prefix with
+              // two characters, and without this check it's interpreted as "d"
+              // (deci) and the "a" is considered part of the unit code.
 
-            // If we still don't have a unit, see if the prefix could be the
-            // two character "da" (deka) prefix.  That's the only prefix with
-            // two characters, and without this check it's interpreted as "d"
-            // (deci) and the "a" is considered part of the unit code.
+              if (!origUnit && pfxCode == 'd' && uCode.substr(0, 1) == 'a') {
+                pfxCode = 'da';
+                pfxObj = this.pfxTabs_.getPrefixByCode(pfxCode);
+                pfxVal = pfxObj.getValue();
+                uCode = uCode.substr(1);
 
-            if (!origUnit && pfxCode == 'd' && uCode.substr(0, 1) == 'a') {
-              pfxCode = 'da';
-              pfxObj = this.pfxTabs_.getPrefixByCode(pfxCode);
-              pfxVal = pfxObj.getValue();
-              uCode = uCode.substr(1);
+                // try one more time for the unit
+                origUnit = this.utabs_.getUnitByCode(uCode);
+              }
 
-              // try one more time for the unit
-              origUnit = this.utabs_.getUnitByCode(uCode);
+              // Reject the unit we found if it might have another prefix.
+              // Such things are in our tables through the LOINC source_
+              // (ucum.csv) which has guidance and synonyms.  I think it should be
+              // safe to exclude anything whose source is LOINC from having a
+              // prefix.
+              if (origUnit && origUnit.source_ == 'LOINC')
+                origUnit = null;
+            } // end if we found a prefix
+          } // end if we didn't get a unit after removing an exponent
+
+          // If we still haven't found anything, we're done looking.
+          // (We tried with the full unit string, with the unit string
+          // without the exponent, the unit string without a prefix,
+          // common errors, etc. That's all we can try).
+          if (!origUnit) {
+            retUnit = null ;
+            // BUT if the user asked for suggestions, at least look for them
+            if (this.suggestions_) {
+              let suggestStat = this._getSuggestions(origCode);
+            }
+            else {
+              this.retMsg_.push(`${origCode} is not a valid UCUM code.`);
             }
-
-            // Reject the unit we found if it might have another prefix.
-            // Such things are in our tables through the LOINC source_
-            // (ucum.csv) which has guidance and synonyms.  I think it should be
-            // safe to exclude anything whose source is LOINC from having a
-            // prefix.
-            if (origUnit && origUnit.source_ == 'LOINC')
-              origUnit = null;
-          } // end if we found a prefix
-        } // end if we didn't get a unit after removing an exponent
-
-        // If we still haven't found anything, we're done looking.
-        // (We tried with the full unit string, with the unit string
-        // without the exponent, the unit string without a prefix,
-        // common errors, etc. That's all we can try).
-        if (!origUnit) {
-          retUnit = null ;
-          // BUT if the user asked for suggestions, at least look for them
-          if (this.suggestions_) {
-            let suggestStat = this._getSuggestions(origCode);
           }
           else {
-            this.retMsg_.push(`${origCode} is not a valid UCUM code.`);
-          }
-        }
-        else {
-          // Otherwise we found a unit object.  Clone it and then apply the
-          // prefix and exponent, if any, to it.  And remove the guidance.
-          retUnit = origUnit.clone();
-          // If we are here, this is only part of the full unit string, so it is
-          // not a base unit, and the synonyms will mostly likely not be correct for the full
-          // string.
-          retUnit.resetFieldsForDerivedUnit();
-          let theDim = retUnit.getProperty('dim_');
-          let theMag = retUnit.getProperty('magnitude_');
-          let theName = retUnit.getProperty('name_');
-          let theCiCode = retUnit.getProperty('ciCode_');
-          let thePrintSymbol = retUnit.getProperty('printSymbol_');
-          // If there is an exponent for the unit, apply it to the dimension
-          // and magnitude now
-          if (exp) {
-            exp = parseInt(exp);
-            let expMul = exp;
-            if (theDim)
-              theDim = theDim.mul(exp);
-            theMag = Math.pow(theMag, exp);
-            retUnit.assignVals({'magnitude_': theMag});
-
-            // If there is also a prefix, apply the exponent to the prefix.
+            // Otherwise we found a unit object.  Clone it and then apply the
+            // prefix and exponent, if any, to it.  And remove the guidance.
+            retUnit = origUnit.clone();
+            // If we are here, this is only part of the full unit string, so it is
+            // not a base unit, and the synonyms will mostly likely not be correct for the full
+            // string.
+            retUnit.resetFieldsForDerivedUnit();
+            let theDim = retUnit.getProperty('dim_');
+            let theMag = retUnit.getProperty('magnitude_');
+            let theName = retUnit.getProperty('name_');
+            let theCiCode = retUnit.getProperty('ciCode_');
+            let thePrintSymbol = retUnit.getProperty('printSymbol_');
+            // If there is an exponent for the unit, apply it to the dimension
+            // and magnitude now
+            if (exp) {
+              exp = parseInt(exp);
+              let expMul = exp;
+              if (theDim)
+                theDim = theDim.mul(exp);
+              theMag = Math.pow(theMag, exp);
+              retUnit.assignVals({'magnitude_': theMag});
+
+              // If there is also a prefix, apply the exponent to the prefix.
+              if (pfxObj) {
+
+                // if the prefix base is 10 it will have an exponent.  Multiply
+                // the current prefix exponent by the exponent for the unit
+                // we're working with.  Then raise the prefix value to the level
+                // defined by the exponent.
+                if (pfxExp) {
+                  expMul *= pfxObj.getExp();
+                  pfxVal = Math.pow(10, expMul);
+                }
+                // If the prefix base is not 10, it won't have an exponent.
+                // At the moment I don't see any units using the prefixes
+                // that aren't base 10.   But if we get one the prefix value
+                // will be applied to the magnitude (below) if the unit does
+                // not have a conversion function, and to the conversion prefix
+                // if it does.
+              } // end if there's a prefix as well as the exponent
+            } // end if there's an exponent
+
+            // Now apply the prefix, if there is one, to the conversion
+            // prefix or the magnitude
             if (pfxObj) {
-
-              // if the prefix base is 10 it will have an exponent.  Multiply
-              // the current prefix exponent by the exponent for the unit
-              // we're working with.  Then raise the prefix value to the level
-              // defined by the exponent.
-              if (pfxExp) {
-                expMul *= pfxObj.getExp();
-                pfxVal = Math.pow(10, expMul);
+              if (retUnit.cnv_) {
+                retUnit.assignVals({'cnvPfx_': pfxVal});
+              }
+              else {
+                theMag *= pfxVal;
+                retUnit.assignVals({'magnitude_': theMag})
               }
-              // If the prefix base is not 10, it won't have an exponent.
-              // At the moment I don't see any units using the prefixes
-              // that aren't base 10.   But if we get one the prefix value
-              // will be applied to the magnitude (below) if the unit does
-              // not have a conversion function, and to the conversion prefix
-              // if it does.
-            } // end if there's a prefix as well as the exponent
-          } // end if there's an exponent
-
-          // Now apply the prefix, if there is one, to the conversion
-          // prefix or the magnitude
-          if (pfxObj) {
-            if (retUnit.cnv_) {
-              retUnit.assignVals({'cnvPfx_': pfxVal});
             }
-            else {
-              theMag *= pfxVal;
-              retUnit.assignVals({'magnitude_': theMag})
+            // if we have a prefix and/or an exponent, add them to the unit
+            // attributes - name, csCode, ciCode and print symbol
+            let theCode = retUnit.csCode_;
+            if (pfxObj) {
+              theName = pfxObj.getName() + theName;
+              theCode = pfxCode + theCode;
+              theCiCode = pfxObj.getCiCode() + theCiCode;
+              thePrintSymbol = pfxObj.getPrintSymbol() + thePrintSymbol;
+              retUnit.assignVals({
+                'name_': theName,
+                'csCode_': theCode,
+                'ciCode_': theCiCode,
+                'printSymbol_': thePrintSymbol
+              });
             }
-          }
-          // if we have a prefix and/or an exponent, add them to the unit
-          // attributes - name, csCode, ciCode and print symbol
-          let theCode = retUnit.csCode_;
-          if (pfxObj) {
-            theName = pfxObj.getName() + theName;
-            theCode = pfxCode + theCode;
-            theCiCode = pfxObj.getCiCode() + theCiCode;
-            thePrintSymbol = pfxObj.getPrintSymbol() + thePrintSymbol;
-            retUnit.assignVals({
-              'name_': theName,
-              'csCode_': theCode,
-              'ciCode_': theCiCode,
-              'printSymbol_': thePrintSymbol
-            });
-          }
-          if (exp) {
-            let expStr = exp.toString();
-            retUnit.assignVals({
-              'name_': theName + '<sup>' + expStr + '</sup>',
-              'csCode_': theCode + expStr,
-              'ciCode_': theCiCode + expStr,
-              'printSymbol_': thePrintSymbol + '<sup>' + expStr + '</sup>'
-            });
-          }
-        } // end if an original unit was found (without prefix and/or exponent)
-
+            if (exp) {
+              let expStr = exp.toString();
+              retUnit.assignVals({
+                'name_': theName + '<sup>' + expStr + '</sup>',
+                'csCode_': theCode + expStr,
+                'ciCode_': theCiCode + expStr,
+                'printSymbol_': thePrintSymbol + '<sup>' + expStr + '</sup>'
+              });
+            }
+          } // end if an original unit was found (without prefix and/or exponent)
+        } // end if an invalid exponent wasn't found
       } // end if we didn't get a unit for the full unit code (w/out modifiers)
     } // end if we didn't find the unit on the first try, before parsing
     return [retUnit, origString];
@@ -1330,24 +1342,31 @@ export class UnitString {
       let tryBrackets = '[' + annoText.substring(1, annoText.length - 1) + ']';
       let mkUnitRet = this._makeUnit(tryBrackets, origString);
 
-      // If we got back a unit, assign it to the returned unit, and add
-      // a message to advise the user that brackets should enclose the code
+      // Nearly anything inside braces is valid, so we don't want to change the
+      // unit, but we can put the found unit in the message as a sort of
+      // warning.
       if (mkUnitRet[0]) {
-        retUnit = mkUnitRet[0];
-        origString = origString.replace(annoText, tryBrackets);
-        this.retMsg_.push(`${annoText} is not a valid unit expression, but ` +
-          `${tryBrackets} is.\n` + this.vcMsgStart_ +
-          `${tryBrackets} (${retUnit.name_})${this.vcMsgEnd_}`);
+        retUnit = uCode;
+        this.retMsg_.push(`${annoText} is a valid unit expression, but ` +
+          `did you mean ${tryBrackets} (${mkUnitRet[0].name_})?`);
       }
-      // Otherwise assume that this should be interpreted as a 1
       else {
         // remove error message generated for trybrackets
         if (this.retMsg_.length > msgLen) {
           this.retMsg_.pop();
         }
-        uCode = 1;
-        retUnit = 1;
       }
+
+      // This is the case where the string is only this annotation.
+      // Create and return a unit object, as we do for numeric units in
+      // parseString.
+      retUnit = new Unit({
+        'csCode_': annoText,
+        'ciCode_': annoText,
+        'magnitude_': 1,
+        'name_': annoText
+      });
+
     } // end if it's only an annotation
 
     else {