@isrd-isi-edu/ermrestjs 2.7.0 → 2.8.0

package/js/ag_reference.js

@@ -25,7 +25,8 @@ import {
 
 // legacy
 import { _convertSearchTermToFilter, _getSortModifier, _getPagingModifier } from '@isrd-isi-edu/ermrestjs/js/parser';
-import { _isValidSortElement, _formatValueByType, _extends } from '@isrd-isi-edu/ermrestjs/js/utils/helpers';
+import { _isValidSortElement, _extends } from '@isrd-isi-edu/ermrestjs/js/utils/helpers';
+import { _formatValueByType } from '@isrd-isi-edu/ermrestjs/src/utils/format-utils';
 import { _compressFacetObject } from '@isrd-isi-edu/ermrestjs/js/utils/pseudocolumn_helpers';
 
 import { Type } from '@isrd-isi-edu/ermrestjs/js/core';

package/js/core.js

@@ -48,14 +48,13 @@ import SourceObjectWrapper from '@isrd-isi-edu/ermrestjs/src/models/source-objec
 import { parse } from '@isrd-isi-edu/ermrestjs/js/parser';
 import {
   _isValidBulkCreateForeignKey,
-  _formatValueByType,
-  _formatUtils,
   _getFormattedKeyValues,
   _getNullValue,
   _processColumnOrderList,
   processMarkdownPattern,
   _renderTemplate,
 } from '@isrd-isi-edu/ermrestjs/js/utils/helpers';
+import { _formatUtils, _formatValueByType } from '@isrd-isi-edu/ermrestjs/src/utils/format-utils';
 import printf from '@isrd-isi-edu/ermrestjs/js/format';
 
 // legacy

package/js/utils/helpers.js

@@ -3,7 +3,6 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /* eslint-disable no-useless-escape */
 import { compressToEncodedURIComponent, decompressFromEncodedURIComponent } from 'lz-string';
-import moment from 'moment-timezone';
 import { default as mustache } from 'mustache';
 
 import $log from '@isrd-isi-edu/ermrestjs/src/services/logger';
@@ -12,12 +11,12 @@ import { InvalidFacetOperatorError } from '@isrd-isi-edu/ermrestjs/src/models/er
 import { Reference } from '@isrd-isi-edu/ermrestjs/src/models/reference';
 
 // legacy
-import { isObject, isObjectAndNotNull, isValidColorRGBHex, isStringAndNotEmpty } from '@isrd-isi-edu/ermrestjs/src/utils/type-utils';
+import { isObject, isObjectAndNotNull, isStringAndNotEmpty } from '@isrd-isi-edu/ermrestjs/src/utils/type-utils';
 import { fixedEncodeURIComponent } from '@isrd-isi-edu/ermrestjs/src/utils/value-utils';
 import { renderMarkdown } from '@isrd-isi-edu/ermrestjs/src/utils/markdown-utils';
+import { _formatUtils } from '@isrd-isi-edu/ermrestjs/src/utils/format-utils';
 import {
   _systemColumns,
-  _dataFormats,
   _contextArray,
   _contexts,
   _annotations,
@@ -27,8 +26,6 @@ import {
   URL_PATH_LENGTH_LIMIT,
   _ERMrestFeatures,
   _systemColumnNames,
-  _specialPresentation,
-  _classNames,
   TEMPLATE_ENGINES,
   _entryContexts,
   _compactContexts,
@@ -1341,461 +1338,6 @@ import AuthnService from '@isrd-isi-edu/ermrestjs/src/services/authn';
         return formatedDate;
     };
 
-    /**
-     * Given a number and precision, it will truncate it to show the given number
-     * of digits.
-     *
-     *
-     * @param {number} num
-     * @param {number} precision
-     * @param {number} minAllowedPrecision
-     */
-    export function _toPrecision(num, precision, minAllowedPrecision) {
-        precision = parseInt(precision);
-        precision = isNaN(precision) || precision < minAllowedPrecision ? minAllowedPrecision : precision;
-
-        var isNegative = num < 0;
-        if (isNegative) num = num * -1;
-
-        // this truncation logic only works because of the minimum precision that
-        // we're allowing. if we want to allow less than that, then we should change this.
-        var displayedNum = num.toString();
-        var f = displayedNum.indexOf('.');
-        if (f !== -1) {
-          // find the number of digits after decimal point
-          var decimalPlaces = Math.pow(10, precision - f);
-
-          // truncate the value
-          displayedNum = Math.floor(num * decimalPlaces) / decimalPlaces;
-        }
-
-        // if precision is too large, the calculation might return NaN.
-        if (isNaN(displayedNum)) {
-          return (isNegative ? '-' : '') + num;
-        }
-
-        return (isNegative ? '-' : '') + displayedNum;
-    };
-
-    /**
-     * @desc An object of pretty print utility functions
-     * @private
-     */
-    export const _formatUtils = {
-        /**
-         * @function
-         * @param {Object} value A boolean value to transform
-         * @param {Object} [options] Configuration options
-         * @return {string} A string representation of a boolean value
-         * @desc Formats a given boolean value into a string for display
-         */
-        printBoolean: function printBoolean(value, options) {
-            options = (typeof options === 'undefined') ? {} : options;
-            if (value === null) {
-                return '';
-            }
-            return Boolean(value).toString();
-        },
-
-        /**
-         * @function
-         * @param {Object} value An integer value to transform
-         * @param {Object} [options] Configuration options
-         * @return {string} A string representation of value
-         * @desc Formats a given integer value into a whole number (with a thousands
-         * separator if necessary), which is transformed into a string for display.
-         */
-        printInteger: function printInteger(value, options) {
-            options = (typeof options === 'undefined') ? {} : options;
-            if (value === null) {
-                return '';
-            }
-
-            // Remove fractional digits
-            value = Math.round(value);
-
-            // Add comma separators
-            return value.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ",");
-        },
-
-        /**
-         * @function
-         * @param {Object} value An timestamp value to transform
-         * @param {Object} [options] Configuration options. No options implemented so far.
-         * @return {string} A string representation of value. Default is ISO 8601-ish like 2017-01-08 15:06:02.
-         * @desc Formats a given timestamp value into a string for display.
-         */
-        printTimestamp: function printTimestamp(value, options) {
-            options = (typeof options === 'undefined') ? {} : options;
-            if (value === null) {
-                return '';
-            }
-
-            try {
-                value = value.toString();
-            } catch (exception) {
-                $log.error("Couldn't extract timestamp from input: " + value);
-                $log.error(exception);
-                return '';
-            }
-
-            if (!moment(value).isValid()) {
-                $log.error("Couldn't transform input to a valid timestamp: " + value);
-                return '';
-            }
-
-            return moment(value).format(_dataFormats.DATETIME.display);
-        },
-
-        /**
-         * @function
-         * @param {Object} value A date value to transform
-         * @param {Object} [options] Configuration options. No options implemented so far.
-         * @return {string} A string representation of value
-         * @desc Formats a given date[time] value into a date string for display.
-         * If any time information is provided, it will be left off.
-         */
-        printDate: function printDate(value, options) {
-            options = (typeof options === 'undefined') ? {} : options;
-            if (value === null) {
-                return '';
-            }
-            // var year, month, date;
-            try {
-                value = value.toString();
-            } catch (exception) {
-                $log.error("Couldn't extract date info from input: " + value);
-                $log.error(exception);
-                return '';
-            }
-
-            if (!moment(value).isValid()) {
-                $log.error("Couldn't transform input to a valid date: " + value);
-                return '';
-            }
-
-            return moment(value).format(_dataFormats.DATE);
-        },
-
-        /**
-         * @function
-         * @param {Object} value A float value to transform
-         * @param {Object} [options] Configuration options.
-         * - "numFracDigits" is the number of fractional digits to appear after the decimal point
-         * @return {string} A string representation of value
-         * @desc Formats a given float value into a string for display. Removes leading 0s; adds thousands separator.
-         */
-        printFloat: function printFloat(value, options) {
-            options = (typeof options === 'undefined') ? {} : options;
-
-            if (value === null) {
-                return '';
-            }
-
-            value = parseFloat(value);
-            if (options.numFracDigits) {
-                value = value.toFixed(options.numFracDigits); // toFixed() rounds the value, is ok?
-            } else {
-                // if the float has 13 digits or more (1 trillion or greater)
-                // or the float has 7 decimals or more, use scientific notation
-                //    NOTE: javascript in browser uses 22 as the threshold for large numbers
-                //          If there are 22 digits or more, then scientific notation is used
-                //          ecmascript language spec: https://262.ecma-international.org/5.1/#sec-9.8.1
-                if (Math.abs(value) >= 1000000000000 || Math.abs(value) < 0.000001) {
-                    // this also ensures there are more digits than the precision used
-                    // so the number will be converted to scientific notation instead of
-                    // being padded with zeroes with no conversion
-                    // for example: 0.000001.toPrecision(4) ==> '0.000001000'
-                    value = value.toPrecision(5);
-                } else {
-                    value = value.toFixed(4);
-                }
-
-            }
-
-            // Remove leading zeroes
-            value = value.toString().replace(/^0+(?!\.|$)/, '');
-
-            // Add comma separators
-            var parts = value.split(".");
-            parts[0] = parts[0].replace(/\B(?=(\d{3})+(?!\d))/g, ",");
-            return parts.join(".");
-        },
-
-        /**
-         * @function
-         * @param {Object} value A text value to transform
-         * @param {Object} [options] Configuration options.
-         * @return {string} A string representation of value
-         * @desc Formats a given text value into a string for display.
-         */
-        printText: function printText(value, options) {
-            options = (typeof options === 'undefined') ? {} : options;
-            if (value === null) {
-                return '';
-            }
-            if (typeof value === 'object') {
-                return JSON.stringify(value);
-            }
-            return value.toString();
-        },
-
-        /**
-         * @function
-         * @param {Object} value The Markdown to transform
-         * @param {Object} [options] Configuration options.
-         * @return {string} A string representation of value
-         * @desc Formats Markdown syntax into an HTML string for display.
-         */
-        printMarkdown: function printMarkdown(value, options) {
-            options = (typeof options === 'undefined') ? {} : options;
-            if (value === null) {
-                return '';
-            }
-
-            return renderMarkdown(value, options.inline);
-        },
-
-        /**
-        * @function
-        * @param {Object} value A json value to transform
-        * @return {string} A string representation of value based on different context
-        *                  The beautified version of JSON in other cases
-            *              A special case to show null if the value is blank string
-        * @desc Formats a given json value into a string for display.
-        */
-        printJSON: function printJSON(value, options) {
-            return value === "" ? JSON.stringify(null) : JSON.stringify(value, undefined, 2);
-       },
-
-        /**
-         * @function
-         * @param {string} value The gene sequence to transform
-         * @param {Object} [options] Configuration options. Accepted parameters
-         * are "increment" (desired number of characters in each segment) and
-         * "separator" (desired separator between segments).
-         * @return {string} A string representation of value
-         * @desc Formats a gene sequence into a string for display. By default,
-         * it will split gene sequence into an increment of 10 characters and
-         * insert an empty space in between each increment.
-         */
-
-        printGeneSeq: function printGeneSeq(value, options) {
-            options = (typeof options === 'undefined') ? {} : options;
-
-            if (value === null) {
-                return '';
-            }
-
-            try {
-                // Default separator is a space.
-                if (!options.separator) {
-                    options.separator = ' ';
-                }
-                // Default increment is 10
-                if (!options.increment) {
-                    options.increment = 10;
-                }
-                var inc = parseInt(options.increment, 10);
-
-                if (inc === 0) {
-                    return value.toString();
-                }
-
-                // Reset the increment if it's negative
-                if (inc <= -1) {
-                    inc = 1;
-                }
-
-                var formattedSeq = '`';
-                var separator = options.separator;
-                while (value.length >= inc) {
-                    // Get the first inc number of chars
-                    var chunk = value.slice(0, inc);
-                    // Append the chunk and separator
-                    formattedSeq += chunk + separator;
-                    // Remove this chunk from value
-                    value = value.slice(inc);
-                }
-
-                // Append any remaining chars from value that was too small to form an increment
-                formattedSeq += value;
-
-                // Slice off separator at the end
-                if (formattedSeq.slice(-1) == separator) {
-                    formattedSeq = formattedSeq.slice(0, -1);
-                }
-
-                // Add the ending backtick at the end
-                formattedSeq += '`';
-
-                // Run it through renderMarkdown to get the sequence in a fixed-width font
-                return renderMarkdown(formattedSeq, true);
-            } catch (e) {
-                $log.error("Couldn't parse the given markdown value: " + value);
-                $log.error(e);
-                return value;
-            }
-
-        },
-
-        /**
-         * @function
-         * @param  {Array} value the array of values
-         * @param  {Object} options Configuration options. Accepted parameters:
-         * - `isMarkdown`: if this is true, we will not esacpe markdown characters
-         * - `returnArray`: if this is true, it will return an array of strings.
-         * @return {string|string[]} A string represntation of array.
-         * @desc
-         * Will generate a comma seperated value for an array. It will also change `null` and `""`
-         * to their special presentation.
-         * The returned value might return markdown, which then should call printMarkdown on it.
-         */
-        printArray: function (value, options) {
-            options = (typeof options === 'undefined') ? {} : options;
-
-            if (!value || !Array.isArray(value) || value.length === 0) {
-                return '';
-            }
-
-            var arr = value.map(function (v) {
-                var isMarkdown = (options.isMarkdown === true);
-                var pv = v;
-                if (v === "") {
-                    pv = _specialPresentation.EMPTY_STR;
-                    isMarkdown = true;
-                }
-                else if (v == null) {
-                    pv = _specialPresentation.NULL;
-                    isMarkdown = true;
-                }
-
-                if (!isMarkdown) pv = _escapeMarkdownCharacters(pv);
-                return pv;
-            });
-
-            if (options.returnArray) return arr;
-            return arr.join(", ");
-        },
-
-        printColor: function (value, options) {
-            options = (typeof options === 'undefined') ? {} : options;
-
-            if (!isValidColorRGBHex(value)) {
-                return '';
-            }
-
-            value = value.toUpperCase();
-            return ':span: :/span:{.' + _classNames.colorPreview + ' style=background-color:' + value +'} ' + value;
-        },
-
-        /**
-         * Return the humanize value of byte count
-         *
-         * This function will not round up and will only truncate the number
-         * to honor the given precision. In 'si', precision below 3 is not allowed.
-         * Similarly, precision below 4 is not allowed in 'binary'.
-         * 'raw' will return the "formatted" value.
-         *
-         * @param {*} value
-         * @param {?string} mode either `raw`, `si`, or `binary` (if invalid or missing, 'si' will be used)
-         * @param {?number} precision An integer specifying the number of digits to be displayed
-         *                           (if invalid or missing, `3` will be used by default.)
-         * @param {?boolean} withTooltip whether we should return it with tooltip or just the value.
-         */
-        humanizeBytes: function (value, mode, precision, withTooltip) {
-            // we cannot use parseInt here since it won't allow larger numbers.
-            var v = parseFloat(value);
-             mode = ['raw', 'si', 'binary'].indexOf(mode) === -1 ? 'si' : mode;
-
-            if (isNaN(v)) return '';
-            if (v === 0 || mode === 'raw') {
-                return _formatUtils.printInteger(value);
-            }
-
-            var divisor = 1000, units = ['B', 'kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
-            if (mode === 'binary') {
-                divisor = 1024;
-                units = ['B', 'KiB', 'MiB', 'GiB', 'TiB', 'PiB', 'EiB', 'ZiB', 'YiB'];
-            }
-
-            // find the closest power of the divisor to the given number ('u').
-            // in the end, 'v' will be the number that we should display.
-            var u = 0;
-            while (v >= divisor || -v >= divisor) {
-                v /= divisor;
-                u++;
-            }
-
-            // our units don't support this, so just return the "raw" mode value.
-            if (u >= units.length) {
-                return _formatUtils.printInteger(value);
-            }
-
-            // we don't want to truncate the value, so we should set a minimum
-            var minP = mode === "si" ? 3 : 4;
-
-            var res = (u ? _toPrecision(v, precision, minP) : v) + ' ' + units[u];
-            if (typeof withTooltip === 'boolean' && withTooltip && u > 0) {
-                var numBytes = _formatUtils.printInteger(Math.pow(divisor, u));
-                var tooltip = _formatUtils.printInteger(value);
-                tooltip += ' bytes (1 ' + units[u] + ' = ' + numBytes + ' bytes)';
-                res = ':span:' + res + ':/span:{data-chaise-tooltip="' + tooltip + '"}';
-            }
-            return res;
-        }
-    };
-
-    /**
-     * format the raw value based on the column definition type, heuristics, annotations, etc.
-     * @param {Type} type - the type object of the column
-     * @param {Object} data - the 'raw' data value.
-     * @returns {string} The formatted value.
-     */
-    export function _formatValueByType(type, data, options) {
-        var utils = _formatUtils;
-        switch(type.name) {
-            case 'timestamp':
-            case 'timestamptz':
-                data = utils.printTimestamp(data, options);
-                break;
-            case 'date':
-                data = utils.printDate(data, options);
-                break;
-            case 'numeric':
-            case 'float4':
-            case 'float8':
-                data = utils.printFloat(data, options);
-                break;
-            case 'int2':
-            case 'int4':
-            case 'int8':
-                data = utils.printInteger(data, options);
-                break;
-            case 'boolean':
-                data = utils.printBoolean(data, options);
-                break;
-            case 'markdown':
-                // Do nothing as we will format markdown at the end of format
-                data = data.toString();
-                break;
-            case 'gene_sequence':
-                data = utils.printGeneSeq(data, options);
-                break;
-            //Cases to support json and jsonb columns
-            case 'json':
-            case 'jsonb':
-                data = utils.printJSON(data, options);
-                break;
-            case 'color_rgb_hex':
-                data = utils.printColor(data, options);
-                break;
-            default: // includes 'text' and 'longtext' cases
-                data = type.baseType ? _formatValueByType(type.baseType, data, options) : utils.printText(data, options);
-                break;
-        }
-        return data;
-    };
 
     export function _isValidSortElement(element, index, array) {
         return (typeof element == 'object' &&

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@isrd-isi-edu/ermrestjs",
   "description": "ERMrest client library in JavaScript",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "license": "Apache-2.0",
   "engines": {
     "node": ">= 20.0.0",

package/src/index.ts

@@ -60,12 +60,12 @@ import {
   decodeFacet,
   encodeFacet,
   encodeFacetString,
-  _formatUtils,
   processMarkdownPattern,
   renderMustacheTemplate,
   _validateMustacheTemplate,
   generateKeyValueFilters,
 } from '@isrd-isi-edu/ermrestjs/js/utils/helpers';
+import { _formatUtils } from '@isrd-isi-edu/ermrestjs/src/utils/format-utils';
 import {
   AttributeGroupColumn,
   AttributeGroupReference,

package/src/models/reference/tuple.ts

@@ -4,7 +4,7 @@ import { DisplayName } from '@isrd-isi-edu/ermrestjs/src/models/display-name';
 
 // utils
 import { fixedEncodeURIComponent, shallowCopy, simpleDeepCopy } from '@isrd-isi-edu/ermrestjs/src/utils/value-utils';
-import { isObjectAndNotNull } from '@isrd-isi-edu/ermrestjs/src/utils/type-utils';
+import { isObjectAndNotNull, isStringAndNotEmpty } from '@isrd-isi-edu/ermrestjs/src/utils/type-utils';
 import { _ERMrestACLs, _contexts, _permissionMessages } from '@isrd-isi-edu/ermrestjs/src/utils/constants';
 
 import { isAllOutboundColumn } from '@isrd-isi-edu/ermrestjs/src/utils/column-utils';
@@ -154,6 +154,13 @@ export class Tuple {
     return this._data;
   }
 
+  /**
+   *
+   * @param permission the ermrest permission that should be checked (refer to _ERMrestACLs constant for more details)
+   * @param colName the name of the column for which the permission should be checked
+   * @param isAssoc whether the permission check is for an association
+   * @returns a boolean indicating whether the permission is granted
+   */
   checkPermissions(permission: string, colName?: string, isAssoc = false): boolean {
     let sum = this._rightsSummary[permission];
     if (isAssoc) {
@@ -161,6 +168,12 @@ export class Tuple {
     }
 
     if (permission === _ERMrestACLs.COLUMN_UPDATE) {
+      // if the column is passed but doesn't exist in the table, return false
+      if (isStringAndNotEmpty(colName) && !this._pageRef.table.columns.has(colName!)) {
+        return false;
+      }
+
+      // if there aren't any column-level permissions, then allow it
       if (!isObjectAndNotNull(sum) || typeof sum[colName!] !== 'boolean') return true;
       return sum[colName!];
     }

package/src/services/handlebars.ts

@@ -12,11 +12,11 @@ import {
   _addErmrestVarsToTemplate,
   _addTemplateVars,
   _escapeMarkdownCharacters,
-  _formatUtils,
   _getPath,
   encodeFacet,
   encodeFacetString,
 } from '@isrd-isi-edu/ermrestjs/js/utils/helpers';
+import { _formatUtils } from '@isrd-isi-edu/ermrestjs/src/utils/format-utils';
 import AuthnService from '@isrd-isi-edu/ermrestjs/src/services/authn';
 import { isObjectAndNotNull } from '@isrd-isi-edu/ermrestjs/src/utils/type-utils';
 import { fixedEncodeURIComponent } from '@isrd-isi-edu/ermrestjs/src/utils/value-utils';
@@ -403,6 +403,28 @@ export default class HandlebarsService {
         return _formatUtils.humanizeBytes(value, mode, precision, tooltip);
       },
 
+      /**
+       * {{datetimeDuration start end}}
+       * {{datetimeDuration start end unit="month"}}
+       * {{datetimeDuration start end unit="auto" fraction=2}}
+       * {{datetimeDuration start end unit="multi"}}
+       * {{datetimeDuration start end unit="calendar"}}
+       * {{datetimeDuration start end direction="before/after"}}
+       * {{datetimeDuration start end unit="month" tooltip=true}}
+       * @ignore
+       * @returns human-readable duration between `start` and `end`
+       */
+      datetimeDuration: function (start: any, end: any, options: Handlebars.HelperOptions) {
+        let unit, fraction, direction, tooltip;
+        if (options && isObjectAndNotNull(options.hash)) {
+          unit = options.hash.unit;
+          fraction = options.hash.fraction;
+          direction = options.hash.direction;
+          tooltip = options.hash.tooltip;
+        }
+        return _formatUtils.datetimeDuration(start, end, unit, fraction, direction, tooltip);
+      },
+
       /**
        * {{stringLength value }}
        * @ignore

package/src/utils/column-utils.ts

@@ -18,12 +18,12 @@ import { isDefinedAndNotNull } from '@isrd-isi-edu/ermrestjs/src/utils/type-util
 
 // legacy
 import {
-  _formatUtils,
   _generateRowPresentation,
   _getRowTemplateVariables,
   _processColumnOrderList,
   _renderTemplate,
 } from '@isrd-isi-edu/ermrestjs/js/utils/helpers';
+import { _formatUtils } from '@isrd-isi-edu/ermrestjs/src/utils/format-utils';
 
 /**
  * Convert the raw value of an aggregate column to a formatted value.