@google/earthengine 1.7.20 → 1.7.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google/earthengine",
-  "version": "1.7.20",
+  "version": "1.7.22",
   "description": "JavaScript client for Google Earth Engine API.",
   "author": "Google LLC",
   "license": "Apache-2.0",

package/src/apiclient.js

@@ -24,7 +24,7 @@ const {trustedResourceUrl} = goog.require('safevalues.index');
 /** @namespace */
 const apiclient = {};
 
-const API_CLIENT_VERSION = '1.7.20';
+const API_CLIENT_VERSION = '1.7.22';
 
 exports.VERSION = apiVersion.VERSION;
 exports.API_CLIENT_VERSION = API_CLIENT_VERSION;

package/src/dictionary.js

@@ -90,13 +90,14 @@ ee.Dictionary.reset = function() {
 /**
  * @override
  * @param {function(*):*} encoder
- * @return {*}
+ * @return {!Object}
  */
 ee.Dictionary.prototype.encode = function(encoder) {
   if (this.dict_ !== null) {
-    return encoder(this.dict_);
+    return /** @type {!Object} */ (encoder(this.dict_));
   } else {
-    return ee.Dictionary.base(this, 'encode', encoder);
+    return /** @type {!Object} */ (
+        ee.Dictionary.base(this, 'encode', encoder));
   }
 };
 

package/src/featurecollection.js

@@ -27,8 +27,8 @@ goog.require('goog.array');
  *   - A GeoJSON FeatureCollection
  *   - A computed object: reinterpreted as a collection.
  *
- * @param {string|number|Array.<*>|ee.ComputedObject|
- *         ee.Geometry|ee.Feature|ee.FeatureCollection} args
+ * @param {string|number|!Array.<*>|!ee.ComputedObject|
+ *         !ee.Geometry|!ee.Feature|!ee.FeatureCollection|!ee.List} args
  *     The constructor arguments.
  * @param {string=} opt_column The name of the geometry column to use.  Only
  *     useful when working with a named collection.
@@ -64,7 +64,7 @@ ee.FeatureCollection = function(args, opt_column) {
 
   if (ee.Types.isString(args)) {
     // An ID.
-    var actualArgs = {'tableId': args};
+    const actualArgs = {'tableId': args};
     if (opt_column) {
       actualArgs['geometryColumn'] = opt_column;
     }
@@ -186,12 +186,12 @@ ee.FeatureCollection.prototype.getMap = ee.FeatureCollection.prototype.getMapId;
  * An imperative function that returns all the known information about this
  * collection via an AJAX call.
  *
- * @param {function(ee.data.FeatureCollectionDescription, string=)=}
+ * @param {function(!ee.data.FeatureCollectionDescription, string=)=}
  *     opt_callback An optional callback. If not supplied, the call is made
  *     synchronously. If supplied, will be called with the first parameter if
  *     successful and the second if unsuccessful.
- * @return {ee.data.FeatureCollectionDescription} A collection description
- *     whose fields include:
+ * @return {!ee.data.FeatureCollectionDescription|undefined} A collection
+ *     description whose fields include:
  *     - features: a list containing metadata about the features in the
  *           collection.
  *     - properties: an optional dictionary containing the collection's
@@ -200,7 +200,7 @@ ee.FeatureCollection.prototype.getMap = ee.FeatureCollection.prototype.getMapId;
  * @override
  */
 ee.FeatureCollection.prototype.getInfo = function(opt_callback) {
-  return /** @type {ee.data.FeatureCollectionDescription} */(
+  return /** @type {!ee.data.FeatureCollectionDescription|undefined} */ (
       ee.FeatureCollection.base(this, 'getInfo', opt_callback));
 };
 
@@ -273,13 +273,13 @@ ee.FeatureCollection.prototype.select = function(
     propertySelectors, opt_newProperties, opt_retainGeometry) {
   if (ee.Types.isString(propertySelectors)) {
     // Varargs.
-    var varargs = Array.prototype.slice.call(arguments);
+    const varargs = Array.prototype.slice.call(arguments);
     return /** @type {!ee.FeatureCollection} */ (this.map(function(feature) {
       return /** @type {!ee.Feature} */(feature).select(varargs);
     }));
   } else {
     // Translate the argument names.
-    var args = ee.arguments.extractFromFunction(
+    const args = ee.arguments.extractFromFunction(
         ee.FeatureCollection.prototype.select, arguments);
     return /** @type {!ee.FeatureCollection} */ (this.map(function(feature) {
       return /** @type {!ee.Feature} */(feature).select(args);
@@ -288,13 +288,20 @@ ee.FeatureCollection.prototype.select = function(
 };
 
 
-/** @override */
+/**
+ * @return {string}
+ * @override
+ */
 ee.FeatureCollection.prototype.name = function() {
   return 'FeatureCollection';
 };
 
 
-/** @override */
+/**
+ * @return {typeof ee.Feature}
+ * @protected
+ * @override
+ */
 ee.FeatureCollection.prototype.elementType = function() {
   return ee.Feature;
 };

package/src/filter.js

@@ -26,7 +26,7 @@ goog.requireType('ee.FeatureCollection');
  *    - A ComputedObject returning a filter. Users shouldn't be making these;
  *       they're produced by the generator functions below.
  *
- * @param {ee.Filter|Array.<*>|Object=} opt_filter Optional filter to add.
+ * @param {!ee.Filter|!Array.<*>|!Object=} opt_filter Optional filter to add.
  * @constructor
  * @extends {ee.ComputedObject}
  * @export
@@ -46,7 +46,7 @@ ee.Filter = function(opt_filter) {
    * The internal rerpresentation of this filter.  This is
    * a list of filter objects which are implicitly ANDed together.
    *
-   * @type {Array.<*>}
+   * @type {!Array.<*>}
    * @private
    */
   this.filter_;
@@ -108,7 +108,7 @@ ee.Filter.reset = function() {
  * A map from the deprecated old-style comparison operator names to API
  * function names, implicitly prefixed with "Filter.". Negative operators
  * (those starting with "not_") are not included.
- * @type {Object.<string>}
+ * @type {!Object.<string>}
  * @const
  * @private
  */
@@ -125,7 +125,7 @@ ee.Filter.functionNames_ = {
 /**
  * Append a predicate to a filter.  These are implicitly ANDed.
  *
- * @param {ee.Filter|Array.<ee.Filter|Object>|Object} newFilter The filter
+ * @param {!ee.Filter|!Array.<!ee.Filter|!Object>|!Object} newFilter The filter
  *     to append.  Possible types are:
  *     - another fully constructed ee.Filter,
  *     - a ComputedObject producing a filter,
@@ -135,7 +135,7 @@ ee.Filter.functionNames_ = {
  */
 ee.Filter.prototype.append_ = function(newFilter) {
   // Make a copy of the previous filter.
-  var prev = this.filter_.slice(0);
+  const prev = this.filter_.slice(0);
   if (newFilter instanceof ee.Filter) {
     goog.array.extend(prev, newFilter.filter_);
   } else if (newFilter instanceof Array) {
@@ -150,11 +150,11 @@ ee.Filter.prototype.append_ = function(newFilter) {
 /**
  * Returns the opposite of the input filter, i.e. the resulting filter will
  * match if and only if the input filter doesn't match.
- * @return {ee.Filter} The negated filter.
+ * @return {!ee.Filter} The negated filter.
  * @export
  */
 ee.Filter.prototype.not = function() {
-  return /** @type {ee.Filter} */ (ee.ApiFunction._call('Filter.not', this));
+  return /** @type {!ee.Filter} */ (ee.ApiFunction._call('Filter.not', this));
 };
 
 
@@ -163,12 +163,12 @@ ee.Filter.prototype.not = function() {
  *
  * @param {string} name The property name to filter on.
  * @param {*} value The value to compare against.
- * @return {ee.Filter} The constructed filter.
+ * @return {!ee.Filter} The constructed filter.
  * @export
  */
 ee.Filter.eq = function(name, value) {
-  var args = ee.arguments.extractFromFunction(ee.Filter.eq, arguments);
-  return /** @type {ee.Filter} */(
+  const args = ee.arguments.extractFromFunction(ee.Filter.eq, arguments);
+  return /** @type {!ee.Filter} */(
       ee.ApiFunction._call('Filter.equals', args['name'], args['value']));
 };
 
@@ -178,11 +178,11 @@ ee.Filter.eq = function(name, value) {
  *
  * @param {string} name The property name to filter on.
  * @param {*} value The value to compare against.
- * @return {ee.Filter} The constructed filter.
+ * @return {!ee.Filter} The constructed filter.
  * @export
  */
 ee.Filter.neq = function(name, value) {
-  var args = ee.arguments.extractFromFunction(ee.Filter.neq, arguments);
+  const args = ee.arguments.extractFromFunction(ee.Filter.neq, arguments);
   return ee.Filter.eq(args['name'], args['value']).not();
 };
 
@@ -192,12 +192,12 @@ ee.Filter.neq = function(name, value) {
  *
  * @param {string} name The property name to filter on.
  * @param {*} value The value to compare against.
- * @return {ee.Filter} The constructed filter.
+ * @return {!ee.Filter} The constructed filter.
  * @export
  */
 ee.Filter.lt = function(name, value) {
-  var args = ee.arguments.extractFromFunction(ee.Filter.lt, arguments);
-  return /** @type {ee.Filter} */(
+  const args = ee.arguments.extractFromFunction(ee.Filter.lt, arguments);
+  return /** @type {!ee.Filter} */(
       ee.ApiFunction._call('Filter.lessThan', args['name'], args['value']));
 };
 
@@ -207,11 +207,11 @@ ee.Filter.lt = function(name, value) {
  *
  * @param {string} name The property name to filter on.
  * @param {*} value The value to compare against.
- * @return {ee.Filter} The constructed filter.
+ * @return {!ee.Filter} The constructed filter.
  * @export
  */
 ee.Filter.gte = function(name, value) {
-  var args = ee.arguments.extractFromFunction(ee.Filter.gte, arguments);
+  const args = ee.arguments.extractFromFunction(ee.Filter.gte, arguments);
   return ee.Filter.lt(args['name'], args['value']).not();
 };
 
@@ -221,12 +221,12 @@ ee.Filter.gte = function(name, value) {
  *
  * @param {string} name The property name to filter on.
  * @param {*} value The value to compare against.
- * @return {ee.Filter} The constructed filter.
+ * @return {!ee.Filter} The constructed filter.
  * @export
  */
 ee.Filter.gt = function(name, value) {
-  var args = ee.arguments.extractFromFunction(ee.Filter.gt, arguments);
-  return /** @type {ee.Filter} */(
+  const args = ee.arguments.extractFromFunction(ee.Filter.gt, arguments);
+  return /** @type {!ee.Filter} */(
       ee.ApiFunction._call('Filter.greaterThan', args['name'], args['value']));
 };
 
@@ -236,11 +236,11 @@ ee.Filter.gt = function(name, value) {
  *
  * @param {string} name The property name to filter on.
  * @param {*} value The value to compare against.
- * @return {ee.Filter} The constructed filter.
+ * @return {!ee.Filter} The constructed filter.
  * @export
  */
 ee.Filter.lte = function(name, value) {
-  var args = ee.arguments.extractFromFunction(ee.Filter.lte, arguments);
+  const args = ee.arguments.extractFromFunction(ee.Filter.lte, arguments);
   return ee.Filter.gt(args['name'], args['value']).not();
 };
 
@@ -248,26 +248,26 @@ ee.Filter.lte = function(name, value) {
 /**
  * Combine two or more filters using boolean AND.
  *
- * @param {...ee.Filter} var_args The filters to combine.
- * @return {ee.Filter} The constructed filter.
+ * @param {...!ee.Filter} var_args The filters to combine.
+ * @return {!ee.Filter} The constructed filter.
  * @export
  */
 ee.Filter.and = function(var_args) {
-  var args = Array.prototype.slice.call(arguments);
-  return /** @type {ee.Filter} */(ee.ApiFunction._call('Filter.and', args));
+  const args = Array.prototype.slice.call(arguments);
+  return /** @type {!ee.Filter} */(ee.ApiFunction._call('Filter.and', args));
 };
 
 
 /**
  * Combine two or more filters using boolean OR.
  *
- * @param {...ee.Filter} var_args The filters to combine.
- * @return {ee.Filter} The constructed filter.
+ * @param {...!ee.Filter} var_args The filters to combine.
+ * @return {!ee.Filter} The constructed filter.
  * @export
  */
 ee.Filter.or = function(var_args) {
-  var args = Array.prototype.slice.call(arguments);
-  return /** @type {ee.Filter} */(ee.ApiFunction._call('Filter.or', args));
+  const args = Array.prototype.slice.call(arguments);
+  return /** @type {!ee.Filter} */(ee.ApiFunction._call('Filter.or', args));
 };
 
 
@@ -279,17 +279,17 @@ ee.Filter.or = function(var_args) {
  * @param {!Date|string|number} start The start date (inclusive).
  * @param {?Date|string|number=} opt_end The end date (exclusive). Optional. If
  *     not specified, a 1-millisecond range starting at 'start' is created.
- * @return {?ee.Filter} The constructed filter.
+ * @return {!ee.Filter} The constructed filter.
  * @export
  */
 ee.Filter.date = function(start, opt_end) {
-  var args = ee.arguments.extractFromFunction(ee.Filter.date, arguments);
-  var range = ee.ApiFunction._call('DateRange', args['start'], args['end']);
-  var filter = ee.ApiFunction._apply('Filter.dateRangeContains', {
+  const args = ee.arguments.extractFromFunction(ee.Filter.date, arguments);
+  const range = ee.ApiFunction._call('DateRange', args['start'], args['end']);
+  const filter = ee.ApiFunction._apply('Filter.dateRangeContains', {
     'leftValue': range,
     'rightField': 'system:time_start'
   });
-  return /** @type {ee.Filter} */ (filter);
+  return /** @type {!ee.Filter} */ (filter);
 };
 
 
@@ -298,28 +298,28 @@ ee.Filter.date = function(start, opt_end) {
  *
  * @param {string=} opt_leftField A selector for the left operand.
  *     Should not be specified if leftValue is specified.
- * @param {Array|Object=} opt_rightValue The value of the right operand.
+ * @param {!Array|!Object=} opt_rightValue The value of the right operand.
  *     Should not be specified if rightField is specified.
  * @param {string=} opt_rightField A selector for the right operand.
  *     Should not be specified if rightValue is specified.
- * @param {Array|Object=} opt_leftValue The value of the left operand.
+ * @param {!Array|!Object=} opt_leftValue The value of the left operand.
  *     Should not be specified if leftField is specified.
- * @return {ee.Filter} The constructed filter.
+ * @return {!ee.Filter} The constructed filter.
  * @export
  */
 ee.Filter.inList = function(
     opt_leftField, opt_rightValue, opt_rightField, opt_leftValue) {
-  var args = ee.arguments.extractFromFunction(ee.Filter.inList, arguments);
+  const args = ee.arguments.extractFromFunction(ee.Filter.inList, arguments);
   // Implement this in terms of listContains, with the arguments switched.
   // In listContains the list is on the left side, while in inList it's on
   // the right.
-  var filter = ee.ApiFunction._apply('Filter.listContains', {
+  const filter = ee.ApiFunction._apply('Filter.listContains', {
     'leftField': args['rightField'],
     'rightValue': args['leftValue'],
     'rightField': args['leftField'],
     'leftValue': args['rightValue']
   });
-  return /** @type {ee.Filter} */ (filter);
+  return /** @type {!ee.Filter} */ (filter);
 };
 
 
@@ -351,7 +351,10 @@ ee.Filter.bounds = function(geometry, opt_errorMargin) {
 };
 
 
-/** @override */
+/**
+ * @return {string}
+ * @override
+ */
 ee.Filter.prototype.name = function() {
   return 'Filter';
 };
@@ -370,7 +373,7 @@ ee.Filter.prototype.name = function() {
  *    "equals", "less_than", "greater_than", "contains", "begins_with",
  *    "ends_with", or any of these prefixed with "not_".
  * @param {*} value The value to compare against.
- * @return {ee.Filter} The constructed filter.
+ * @return {!ee.Filter} The constructed filter.
  * @export
  * @deprecated Use ee.Filter.eq(), ee.Filter.gte(), etc.
  */
@@ -378,7 +381,7 @@ ee.Filter.metadata = function(name, operator, value) {
   operator = operator.toLowerCase();
 
   // Check for negated filters.
-  var negated = false;
+  let negated = false;
   if (goog.string.startsWith(operator, 'not_')) {
     negated = true;
     operator = operator.substring(4);
@@ -388,8 +391,8 @@ ee.Filter.metadata = function(name, operator, value) {
   if (!(operator in ee.Filter.functionNames_)) {
     throw Error('Unknown filtering operator: ' + operator);
   }
-  var funcName = 'Filter.' + ee.Filter.functionNames_[operator];
-  var filter = /** @type {ee.Filter} */(
+  const funcName = 'Filter.' + ee.Filter.functionNames_[operator];
+  const filter = /** @type {!ee.Filter} */(
       ee.ApiFunction._call(funcName, name, value));
 
   return negated ? filter.not() : filter;

package/src/image.js

@@ -33,7 +33,7 @@ goog.require('goog.object');
  *   - An ee.Image: returns the argument,
  *   - Nothing: results in an empty transparent image.
  *
- * @param {number|string|Array.<*>|ee.Image|Object=} opt_args
+ * @param {number|string|!Array.<*>|!ee.Image|!Object|null=} opt_args
  *     Constructor argument.
  * @constructor
  * @extends {ee.Element}
@@ -66,7 +66,7 @@ ee.Image = function(opt_args) {
     } else if (Array.isArray(opt_args)) {
       // Make an image out of each element.
       return ee.Image.combine_(goog.array.map(
-          /** @type {Array.<*>} */ (opt_args),
+          /** @type {!Array.<*>} */ (opt_args),
           function(elem) {
             return new ee.Image(/** @type {?} */ (elem));
           }));
@@ -136,18 +136,19 @@ ee.Image.reset = function() {
  * An imperative function that returns information about this image via an
  * AJAX call.
  *
- * @param {function(ee.data.ImageDescription, string=)=} opt_callback
+ * @param {function(!ee.data.ImageDescription, string=)=} opt_callback
  *     An optional callback. If not supplied, the call is made synchronously.
  *     If supplied, will be called with the first parameter if successful and
  *     the second if unsuccessful.
- * @return {ee.data.ImageDescription} A description of the image. Includes:
+ * @return {!ee.data.ImageDescription|undefined} A description of the image, or
+ *     undefined if a callback is specified. Includes:
  *     - bands - a list containing metadata about the bands in the collection.
  *     - properties - a dictionary containing the image's metadata properties.
  * @export
  * @override
  */
 ee.Image.prototype.getInfo = function(opt_callback) {
-  return /** @type {ee.data.ImageDescription} */(
+  return /** @type {!ee.data.ImageDescription|undefined} */(
       ee.Image.base(this, 'getInfo', opt_callback));
 };
 
@@ -215,7 +216,7 @@ ee.Image.prototype.getMap = ee.Image.prototype.getMapId;
  * 10000.
  *
  * Use getThumbURL for RGB visualization formats PNG and JPG.
- * @param {Object} params An object containing download options with the
+ * @param {!Object} params An object containing download options with the
  *     following possible values:
  *   <table>
  *     <tr>
@@ -410,10 +411,10 @@ ee.Image.prototype.getThumbURL = function(params, opt_callback) {
  * Create a 3-band image specifically for visualization. This uses the first
  * band in each image.
  *
- * @param {ee.Image} r The red image.
- * @param {ee.Image} g The green image.
- * @param {ee.Image} b The blue image.
- * @return {ee.Image} The combined image.
+ * @param {!ee.Image} r The red image.
+ * @param {!ee.Image} g The green image.
+ * @param {!ee.Image} b The blue image.
+ * @return {!ee.Image} The combined image.
  * @export
  */
 ee.Image.rgb = function(r, g, b) {
@@ -435,8 +436,8 @@ ee.Image.rgb = function(r, g, b) {
  *
  * This function will promote constant values into constant images.
  *
- * @param {...ee.Image} var_args The images to be combined.
- * @return {ee.Image} The combined image.
+ * @param {...!ee.Image} var_args The images to be combined.
+ * @return {!ee.Image} The combined image.
  * @export
  */
 ee.Image.cat = function(var_args) {
@@ -449,14 +450,14 @@ ee.Image.cat = function(var_args) {
  * Combine all the bands from the given images into a single image, with
  * optional renaming.
  *
- * @param {Array.<ee.Image>} images The images to be combined.
- * @param {Array.<string>=} opt_names A list of names for the output bands.
- * @return {ee.Image} The combined image.
+ * @param {!Array.<!ee.Image>} images The images to be combined.
+ * @param {?Array.<string>=} opt_names A list of names for the output bands.
+ * @return {!ee.Image} The combined image.
  * @private
  */
 ee.Image.combine_ = function(images, opt_names) {
   if (images.length == 0) {
-    return /** @type {ee.Image} */ (ee.ApiFunction._call('Image.constant', []));
+    return /** @type {!ee.Image} */ (ee.ApiFunction._call('Image.constant', []));
   }
 
   // Append all the bands.
@@ -542,7 +543,7 @@ ee.Image.prototype.select = function(var_args) {
  * using the '=' operator (e.g.: x = a + b).
  *
  * @param {string} expression The expression to evaluate.
- * @param {Object.<ee.Image>=} opt_map A map of input images available by name.
+ * @param {!Object.<!ee.Image>=} opt_map A map of input images available by name.
  * @return {!ee.Image} The image computed by the provided expression.
  * @export
  */
@@ -580,7 +581,7 @@ ee.Image.prototype.expression = function(expression, opt_map) {
 
   /**
    * @this {ee.Function}
-   * @return {ee.Function.Signature}
+   * @return {!ee.Function.Signature}
    */
   func.getSignature = function() {
     return {
@@ -610,9 +611,9 @@ ee.Image.prototype.expression = function(expression, opt_map) {
  *
  * Use clipToCollection to clip an image to a FeatureCollection.
  *
- * @param {ee.Geometry|ee.Feature|Object} geometry
+ * @param {!ee.Geometry|!ee.Feature|!Object} geometry
  *     The Geometry or Feature to clip to.
- * @return {ee.Image} The clipped image.
+ * @return {!ee.Image} The clipped image.
  * @export
  */
 ee.Image.prototype.clip = function(geometry) {
@@ -623,7 +624,7 @@ ee.Image.prototype.clip = function(geometry) {
   } catch (e) {
     // Not an ee.Geometry or GeoJSON. Just pass it along.
   }
-  return /** @type {ee.Image} */(
+  return /** @type {!ee.Image} */(
       ee.ApiFunction._call('Image.clip', this, geometry));
 };
 
@@ -631,9 +632,9 @@ ee.Image.prototype.clip = function(geometry) {
 /**
  * Rename the bands of an image.
  *
- * @param {...string|Object|Array<string>} var_args The new names for the bands.
+ * @param {...string|!Object|!Array<string>} var_args The new names for the bands.
  *    Must match the number of bands in the Image.
- * @return {ee.Image} The renamed image.
+ * @return {!ee.Image} The renamed image.
  * @export
  */
 ee.Image.prototype.rename = function(var_args) {
@@ -645,12 +646,15 @@ ee.Image.prototype.rename = function(var_args) {
     // Varargs list of strings.
     names = Array.from(arguments);
   }
-  return /** @type {ee.Image} */(
+  return /** @type {!ee.Image} */(
       ee.ApiFunction._call('Image.rename', this, names));
 };
 
 
-/** @override */
+/**
+ * @return {string}
+ * @override
+ */
 ee.Image.prototype.name = function() {
   return 'Image';
 };

package/src/images.js

@@ -344,9 +344,9 @@ ee.data.images.applyVisualization = function(image, params) {
  * @return {!ee.data.ImageVisualizationParameters} Params for visualize()
  */
 ee.data.images.extractVisParams = function(params, outParams) {
-  var keysToExtract = ["bands", "gain", "bias", "min", "max",
+  const keysToExtract = ["bands", "gain", "bias", "min", "max",
       "gamma", "palette", "opacity", "forceRgbOutput"];
-  var visParams = {};
+  const visParams = {};
   goog.object.forEach(params, function(value, key) {
     if (goog.array.contains(keysToExtract, key)) {
       visParams[key] = value;