@google/earthengine 0.1.378 → 0.1.381

package/package.json

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

package/src/apiclient.js

@@ -6,7 +6,6 @@ goog.module.declareLegacyNamespace();
 
 const GoogConst = goog.require('goog.string.Const');
 const Throttle = goog.require('goog.async.Throttle');
-const TrustedResourceUrl = goog.require('goog.html.TrustedResourceUrl');
 const Uri = goog.require('goog.Uri');
 const XhrIo = goog.require('goog.net.XhrIo');
 const XhrLike = goog.requireType('goog.net.XhrLike');
@@ -21,11 +20,12 @@ const jsloader = goog.require('goog.net.jsloader');
 const {MakeRequestParams, processParams} = goog.require('eeapiclient.request_params');
 const {NULL_VALUE, Serializable, SerializableCtor, deserialize, serialize} = goog.require('eeapiclient.domain_object');
 const {PromiseRequestService} = goog.require('eeapiclient.promise_request_service');
+const {trustedResourceUrl} = goog.require('safevalues');
 
 /** @namespace */
 const apiclient = {};
 
-const API_CLIENT_VERSION = '0.1.378';
+const API_CLIENT_VERSION = '0.1.381';
 
 exports.VERSION = apiVersion.VERSION;
 exports.API_CLIENT_VERSION = API_CLIENT_VERSION;
@@ -1147,8 +1147,9 @@ apiclient.ensureAuthLibLoaded_ = function(callback) {
       delete goog.global[callbackName];
       done();
     };
-    jsloader.safeLoad(TrustedResourceUrl.format(
-        apiclient.AUTH_LIBRARY_URL_, {'onload': callbackName}));
+    jsloader.safeLoad(
+        trustedResourceUrl`https://apis.google.com/js/client.js?onload=${
+            callbackName}`);
   }
 };
 

package/src/ee.js

@@ -378,8 +378,7 @@ ee.promote_ = function(arg, klass) {
       return new ee.Image(/** @type {Object} */ (arg));
     case 'Feature':
       if (arg instanceof ee.Collection) {
-        // TODO(user): Decide whether we want to leave this in. It can be
-        //              quite dangerous on large collections.
+        // This can be quite dangerous on large collections.
         return ee.ApiFunction._call(
             'Feature', ee.ApiFunction._call('Collection.geometry', arg));
       } else {

package/src/eeapiclient/api_client.ts

@@ -1,3 +1,4 @@
+// g3-format-clang
 import {Serializable, serialize} from './domain_object';
 import {GeneratedRequestParams} from './generated_types';
 import {MultipartRequest} from './multipart_request';

package/src/eeapiclient/api_request_hook.ts

@@ -1,3 +1,4 @@
+// g3-format-clang
 import {GeneratedRequestParams} from './generated_types';
 
 export interface ApiClientRequestHook {

package/src/eeapiclient/domain_object.ts

@@ -1,4 +1,5 @@
 /**
+ * g3-format-clang
  * Utility map for ClassMetadata to describe how to create instances of child
  * properties.
  */

package/src/eeapiclient/generated_types.ts

@@ -1,3 +1,4 @@
+// g3-format-clang
 import {Serializable, SerializableCtor} from './domain_object';
 import {MultipartRequest} from './multipart_request';
 

package/src/eeapiclient/multipart_request.ts

@@ -1,3 +1,4 @@
+// g3-format-clang
 import {Serializable, serialize} from './domain_object';
 
 export class MultipartRequest {

package/src/eeapiclient/promise_api_client.ts

@@ -1,3 +1,4 @@
+// g3-format-clang
 import {ApiClient, toMakeRequestParams, toMultipartMakeRequestParams} from './api_client';
 import {ApiClientHookFactory, getRequestHook} from './api_request_hook';
 import {Serializable} from './domain_object';

package/src/eeapiclient/promise_request_service.ts

@@ -1,3 +1,4 @@
+// g3-format-clang
 import {deserialize, Serializable, SerializableCtor} from './domain_object';
 import {MakeRequestParams, processParams} from './request_params';
 

package/src/eeapiclient/request_params.ts

@@ -1,3 +1,4 @@
+// g3-format-clang
 import * as httpCors from 'goog:goog.net.rpc.HttpCors';
 
 import {GeneratedQueryParams} from './generated_types';

package/src/eeapiclient/request_params_test.ts

@@ -1,3 +1,4 @@
+// g3-format-clang
 import 'jasmine';
 
 import {buildQueryParams, bypassCorsPreflight, MakeRequestParams} from './request_params';

package/src/examples/CloudMasking/Sentinel2CloudScorePlus.js

@@ -0,0 +1,35 @@
+// This example demonstrates how to use Cloud Score+ QA bands to generate a
+// clear median composite for a specified date range.
+
+// Harmonized Sentinel-2 Level 2A collection.
+var s2 = ee.ImageCollection('COPERNICUS/S2_SR_HARMONIZED');
+
+// Cloud Score+ image collection. Note Cloud Score+ is produced from Sentinel-2
+// Level 1C data and can be applied to either L1C or L2A collections.
+var csPlus = ee.ImageCollection('GOOGLE/CLOUD_SCORE_PLUS/V1/S2_HARMONIZED');
+
+// Region of interest.
+var ROI = ee.Geometry.Point(-119.9087, 37.4159);
+
+// Use 'cs' or 'cs_cdf', depending on your use-case; see docs for guidance.
+var QA_BAND = 'cs_cdf';
+
+// The threshold for masking; values between 0.50 and 0.65 generally work well.
+// Higher values will remove thin clouds, haze & cirrus shadows.
+var CLEAR_THRESHOLD = 0.60;
+
+// Make composite.
+var composite = s2
+    .filterBounds(ROI)
+    .filterDate('2023-01-01', '2023-02-01')
+    .linkCollection(csPlus, [QA_BAND])
+    .map(function(img) {
+      return img.updateMask(img.select(QA_BAND).gte(CLEAR_THRESHOLD));
+    })
+    .median();
+
+// Sentinel-2 visualization parameters.
+var s2Viz = {bands: ['B4', 'B3', 'B2'], min: 0, max: 2500};
+
+Map.addLayer(composite, s2Viz, 'median composite');
+Map.centerObject(ROI, 11);

package/src/feature.js

@@ -135,8 +135,8 @@ ee.Feature.prototype.getInfo = function(opt_callback) {
  * generating a Map overlay.
  *
  * @param {?Object=} opt_visParams The visualization parameters. Currently only
- *     one parameter, 'color', containing an RGB color string is user.  If
- *     vis_params is null, black ("000000") is used.
+ *     one parameter, 'color', containing an RGB color string is allowed. If
+ *     visParams is not specified, black ("000000") is used.
  * @param {function(!Object, string=)=} opt_callback An async callback.
  * @return {!ee.data.MapId|undefined} An object which may be passed to
  *     ee.data.getTileUrl or ui.Map.addLayer, including an additional 'image'
@@ -144,15 +144,33 @@ ee.Feature.prototype.getInfo = function(opt_callback) {
  *     containing this feature. Undefined if a callback was specified.
  * @export
  */
-ee.Feature.prototype.getMap = function(opt_visParams, opt_callback) {
-  var args =
+ee.Feature.prototype.getMapId = function(opt_visParams, opt_callback) {
+  const args =
       ee.arguments.extractFromFunction(ee.Feature.prototype.getMap, arguments);
-  var collection = ee.ApiFunction._call('Collection', [this]);
-  return /** @type {ee.FeatureCollection} */(collection)
-      .getMap(args['visParams'], args['callback']);
+  const collection = ee.ApiFunction._call('Collection', [this]);
+  return /** @type {!ee.FeatureCollection} */(collection)
+      .getMapId(args['visParams'], args['callback']);
 };
 
 
+/**
+ * An imperative function that returns a map ID and optional token, suitable for
+ * generating a Map overlay.
+ *
+ * @deprecated Use getMapId() instead.
+ * @param {?Object=} opt_visParams The visualization parameters. Currently only
+ *     one parameter, 'color', containing an RGB color string is allowed. If
+ *     visParams is not specified, black ("000000") is used.
+ * @param {function(!Object, string=)=} opt_callback An async callback.
+ * @return {!ee.data.MapId|undefined} An object which may be passed to
+ *     ee.data.getTileUrl or ui.Map.addLayer, including an additional 'image'
+ *     field, containing a Collection.draw image wrapping a FeatureCollection
+ *     containing this feature. Undefined if a callback was specified.
+ * @export
+ */
+ee.Feature.prototype.getMap = ee.Feature.prototype.getMapId;
+
+
 /** @override */
 ee.Feature.prototype.name = function() {
   return 'Feature';

package/src/featurecollection.js

@@ -132,38 +132,56 @@ ee.FeatureCollection.reset = function() {
 
 
 /**
- * An imperative function that returns a map id and token, suitable for
+ * An imperative function that returns a map ID and optional token, suitable for
  * generating a Map overlay.
  *
  * @param {?Object=} opt_visParams The visualization parameters. Currently only
- *     one parameter, 'color', containing an RGB color string is allowed.  If
- *     vis_params isn't specified, then the color #000000 is used.
+ *     one parameter, 'color', containing an RGB color string is allowed. If
+ *     visParams is not specified, black ("000000") is used.
  * @param {function(!Object, string=)=} opt_callback An async callback.
- *     If not supplied, the call is made synchronously.
  * @return {!ee.data.MapId|undefined} An object which may be passed to
  *     ee.data.getTileUrl or ui.Map.addLayer, including an additional 'image'
  *     field, containing a Collection.draw image wrapping a FeatureCollection
  *     containing this feature. Undefined if a callback was specified.
  * @export
  */
-ee.FeatureCollection.prototype.getMap = function(opt_visParams, opt_callback) {
-  var args = ee.arguments.extractFromFunction(
-      ee.FeatureCollection.prototype.getMap, arguments);
+ee.FeatureCollection.prototype.getMapId = function(
+    opt_visParams, opt_callback) {
+  const args = ee.arguments.extractFromFunction(
+      ee.FeatureCollection.prototype.getMapId, arguments);
 
-  var painted = /** @type {!ee.Image} */(
-      ee.ApiFunction._apply('Collection.draw', {
+  const painted =
+      /** @type {!ee.Image} */ (ee.ApiFunction._apply('Collection.draw', {
         'collection': this,
         'color': (args['visParams'] || {})['color'] || '000000'
       }));
 
   if (args['callback']) {
-    painted.getMap(undefined, args['callback']);
+    painted.getMapId(undefined, args['callback']);
   } else {
-    return painted.getMap();
+    return painted.getMapId();
   }
 };
 
 
+/**
+ * An imperative function that returns a map ID and optional token, suitable for
+ * generating a Map overlay.
+ *
+ * @deprecated Use getMapId() instead.
+ * @param {?Object=} opt_visParams The visualization parameters. Currently only
+ *     one parameter, 'color', containing an RGB color string is allowed. If
+ *     visParams is not specified, black ("000000") is used.
+ * @param {function(!Object, string=)=} opt_callback An async callback.
+ * @return {!ee.data.MapId|undefined} An object which may be passed to
+ *     ee.data.getTileUrl or ui.Map.addLayer, including an additional 'image'
+ *     field, containing a Collection.draw image wrapping a FeatureCollection
+ *     containing this feature. Undefined if a callback was specified.
+ * @export
+ */
+ee.FeatureCollection.prototype.getMap = ee.FeatureCollection.prototype.getMapId;
+
+
 /**
  * An imperative function that returns all the known information about this
  * collection via an AJAX call.

package/src/image.js

@@ -153,7 +153,7 @@ ee.Image.prototype.getInfo = function(opt_callback) {
 
 
 /**
- * An imperative function that returns a map id and optional token, suitable for
+ * An imperative function that returns a map ID and optional token, suitable for
  * generating a Map overlay.
  *
  * @param {!ee.data.ImageVisualizationParameters=} opt_visParams
@@ -165,7 +165,7 @@ ee.Image.prototype.getInfo = function(opt_callback) {
  *     specified.
  * @export
  */
-ee.Image.prototype.getMap = function(opt_visParams, opt_callback) {
+ee.Image.prototype.getMapId = function(opt_visParams, opt_callback) {
   const args = ee.arguments.extractFromFunction(
       ee.Image.prototype.getMap, arguments);
 
@@ -192,6 +192,22 @@ ee.Image.prototype.getMap = function(opt_visParams, opt_callback) {
   }
 };
 
+/**
+ * An imperative function that returns a map ID and optional token, suitable for
+ * generating a Map overlay.
+ *
+ * @deprecated Use getMapId() instead.
+ * @param {!ee.data.ImageVisualizationParameters=} opt_visParams
+ *     The visualization parameters.
+ * @param {function(!ee.data.MapId, string=)=} opt_callback An async callback.
+ *     If not supplied, the call is made synchronously.
+ * @return {!ee.data.MapId|undefined} An object which may be passed to
+ *     ee.data.getTileUrl or ui.Map.addLayer. Undefined if a callback was
+ *     specified.
+ * @export
+ */
+ee.Image.prototype.getMap = ee.Image.prototype.getMapId;
+
 
 /**
  * Get a download URL for small chunks of image data in GeoTIFF or NumPy

package/src/imagecollection.js

@@ -255,31 +255,48 @@ ee.ImageCollection.prototype.getThumbURL_ = function(
 
 
 /**
- * An imperative function that returns a mapid via a synchronous AJAX call.
+ * An imperative function that returns a map ID via a synchronous AJAX call.
  *
- * This mosaics the collection to a single image and return a mapid suitable
+ * This mosaics the collection to a single image and return a map ID suitable
  * for building a Google Maps overlay.
  *
  * @param {?Object=} opt_visParams The visualization parameters.
  * @param {function(!Object, string=)=} opt_callback An async callback.
  *     If not supplied, the call is made synchronously.
- * @return {!ee.data.MapId|undefined} Returns a mapid and optional token, which
+ * @return {!ee.data.MapId|undefined} Returns a map ID and optional token, which
  *     may be passed to ee.data.getTileUrl or ui.Map.addLayer. Undefined if
  *     a callback was specified.
  * @export
  */
-ee.ImageCollection.prototype.getMap = function(opt_visParams, opt_callback) {
+ee.ImageCollection.prototype.getMapId = function(opt_visParams, opt_callback) {
   var args = ee.arguments.extractFromFunction(
-      ee.ImageCollection.prototype.getMap, arguments);
+      ee.ImageCollection.prototype.getMapId, arguments);
   var mosaic = /** @type {!ee.Image} */(
       ee.ApiFunction._call('ImageCollection.mosaic', this));
   if (args['callback']) {
-    mosaic.getMap(args['visParams'], args['callback']);
+    mosaic.getMapId(args['visParams'], args['callback']);
   } else {
-    return mosaic.getMap(args['visParams']);
+    return mosaic.getMapId(args['visParams']);
   }
 };
 
+/**
+ * An imperative function that returns a map ID via a synchronous AJAX call.
+ *
+ * This mosaics the collection to a single image and return a map ID suitable
+ * for building a Google Maps overlay.
+ *
+ * @deprecated Use getMapId() instead.
+ * @param {?Object=} opt_visParams The visualization parameters.
+ * @param {function(!Object, string=)=} opt_callback An async callback.
+ *     If not supplied, the call is made synchronously.
+ * @return {!ee.data.MapId|undefined} Returns a map ID and optional token, which
+ *     may be passed to ee.data.getTileUrl or ui.Map.addLayer. Undefined if
+ *     a callback was specified.
+ * @export
+ */
+ee.ImageCollection.prototype.getMap = ee.ImageCollection.prototype.getMapId;
+
 
 /**
  * An imperative function that returns all the known information about this

package/test/ee_test.js

@@ -14,13 +14,13 @@ describe('ee', function() {
 
   it('retrieves a map ID synchronously', function() {
     const image = new ee.Image('srtm90_v4');
-    const map = image.getMap({'min': 0, 'max': 1000});
+    const map = image.getMapId({'min': 0, 'max': 1000});
     expect(map.mapid).toMatch(/\w+/);
   });
 
   it('retrieves a map ID asynchronously', function(done) {
     const image = new ee.Image('srtm90_v4');
-    image.getMap({'min': 0, 'max': 1000}, ({mapid}) => {
+    image.getMapId({'min': 0, 'max': 1000}, ({mapid}) => {
       expect(mapid).toMatch(/\w+/);
       done();
     });